.config/coc/extensions/coc-python-data/languageServer.0.5.59/Typeshed/third_party/2and3/click/types.pyi

   1 from typing import Any, Callable, IO, Iterable, List, Optional, TypeVar, Union, Tuple as _PyTuple, Type\r
   2 import uuid\r
   3 \r
   4 from click.core import Context, Parameter, _ParamType as ParamType, _ConvertibleType\r
   5 \r
   6 class BoolParamType(ParamType):\r
   7     def __call__(\r
   8         self,\r
   9         value: Optional[str],\r
  10         param: Optional[Parameter] = ...,\r
  11         ctx: Optional[Context] = ...,\r
  12     ) -> bool:\r
  13         ...\r
  14 \r
  15     def convert(\r
  16         self,\r
  17         value: str,\r
  18         param: Optional[Parameter],\r
  19         ctx: Optional[Context],\r
  20     ) -> bool:\r
  21         ...\r
  22 \r
  23 \r
  24 class CompositeParamType(ParamType):\r
  25     arity: int\r
  26 \r
  27 \r
  28 class Choice(ParamType):\r
  29     choices: Iterable[str]\r
  30     def __init__(self, choices: Iterable[str]) -> None:\r
  31         ...\r
  32 \r
  33 \r
  34 class FloatParamType(ParamType):\r
  35     def __call__(\r
  36         self,\r
  37         value: Optional[str],\r
  38         param: Optional[Parameter] = ...,\r
  39         ctx: Optional[Context] = ...,\r
  40     ) -> float:\r
  41         ...\r
  42 \r
  43     def convert(\r
  44         self,\r
  45         value: str,\r
  46         param: Optional[Parameter],\r
  47         ctx: Optional[Context],\r
  48     ) -> float:\r
  49         ...\r
  50 \r
  51 \r
  52 class FloatRange(FloatParamType):\r
  53     ...\r
  54 \r
  55 \r
  56 class File(ParamType):\r
  57     def __init__(\r
  58         self,\r
  59         mode: str = ...,\r
  60         encoding: Optional[str] = ...,\r
  61         errors: Optional[str] = ...,\r
  62         lazy: Optional[bool] = ...,\r
  63         atomic: Optional[bool] = ...,\r
  64     ) -> None:\r
  65         ...\r
  66 \r
  67     def __call__(\r
  68         self,\r
  69         value: Optional[str],\r
  70         param: Optional[Parameter] = ...,\r
  71         ctx: Optional[Context] = ...,\r
  72     ) -> IO:\r
  73         ...\r
  74 \r
  75     def convert(\r
  76         self,\r
  77         value: str,\r
  78         param: Optional[Parameter],\r
  79         ctx: Optional[Context],\r
  80     ) -> IO:\r
  81         ...\r
  82 \r
  83     def resolve_lazy_flag(self, value: str) -> bool:\r
  84         ...\r
  85 \r
  86 \r
  87 _F = TypeVar('_F')  # result of the function\r
  88 _Func = Callable[[Optional[str]], _F]\r
  89 \r
  90 \r
  91 class FuncParamType(ParamType):\r
  92     func: _Func\r
  93 \r
  94     def __init__(self, func: _Func) -> None:\r
  95         ...\r
  96 \r
  97     def __call__(\r
  98         self,\r
  99         value: Optional[str],\r
 100         param: Optional[Parameter] = ...,\r
 101         ctx: Optional[Context] = ...,\r
 102     ) -> _F:\r
 103         ...\r
 104 \r
 105     def convert(\r
 106         self,\r
 107         value: str,\r
 108         param: Optional[Parameter],\r
 109         ctx: Optional[Context],\r
 110     ) -> _F:\r
 111         ...\r
 112 \r
 113 \r
 114 class IntParamType(ParamType):\r
 115     def __call__(\r
 116         self,\r
 117         value: Optional[str],\r
 118         param: Optional[Parameter] = ...,\r
 119         ctx: Optional[Context] = ...,\r
 120     ) -> int:\r
 121         ...\r
 122 \r
 123     def convert(\r
 124         self,\r
 125         value: str,\r
 126         param: Optional[Parameter],\r
 127         ctx: Optional[Context],\r
 128     ) -> int:\r
 129         ...\r
 130 \r
 131 \r
 132 class IntRange(IntParamType):\r
 133     def __init__(\r
 134         self, min: Optional[int] = ..., max: Optional[int] = ..., clamp: bool = ...\r
 135     ) -> None:\r
 136         ...\r
 137 \r
 138 \r
 139 _PathType = TypeVar('_PathType', str, bytes)\r
 140 \r
 141 \r
 142 class Path(ParamType):\r
 143     def __init__(\r
 144         self,\r
 145         exists: bool = ...,\r
 146         file_okay: bool = ...,\r
 147         dir_okay: bool = ...,\r
 148         writable: bool = ...,\r
 149         readable: bool = ...,\r
 150         resolve_path: bool = ...,\r
 151         allow_dash: bool = ...,\r
 152         path_type: Optional[Type[_PathType]] = ...,\r
 153     ) -> None:\r
 154         ...\r
 155 \r
 156     def coerce_path_result(self, rv: Union[str, bytes]) -> _PathType:\r
 157         ...\r
 158 \r
 159     def __call__(\r
 160         self,\r
 161         value: Optional[str],\r
 162         param: Optional[Parameter] = ...,\r
 163         ctx: Optional[Context] = ...,\r
 164     ) -> _PathType:\r
 165         ...\r
 166 \r
 167     def convert(\r
 168         self,\r
 169         value: str,\r
 170         param: Optional[Parameter],\r
 171         ctx: Optional[Context],\r
 172     ) -> _PathType:\r
 173         ...\r
 174 \r
 175 class StringParamType(ParamType):\r
 176     def __call__(\r
 177         self,\r
 178         value: Optional[str],\r
 179         param: Optional[Parameter] = ...,\r
 180         ctx: Optional[Context] = ...,\r
 181     ) -> str:\r
 182         ...\r
 183 \r
 184     def convert(\r
 185         self,\r
 186         value: str,\r
 187         param: Optional[Parameter],\r
 188         ctx: Optional[Context],\r
 189     ) -> str:\r
 190         ...\r
 191 \r
 192 \r
 193 class Tuple(CompositeParamType):\r
 194     types: List[ParamType]\r
 195 \r
 196     def __init__(self, types: Iterable[Any]) -> None:\r
 197         ...\r
 198 \r
 199     def __call__(\r
 200         self,\r
 201         value: Optional[str],\r
 202         param: Optional[Parameter] = ...,\r
 203         ctx: Optional[Context] = ...,\r
 204     ) -> Tuple:\r
 205         ...\r
 206 \r
 207     def convert(\r
 208         self,\r
 209         value: str,\r
 210         param: Optional[Parameter],\r
 211         ctx: Optional[Context],\r
 212     ) -> Tuple:\r
 213         ...\r
 214 \r
 215 \r
 216 class UnprocessedParamType(ParamType):\r
 217     ...\r
 218 \r
 219 \r
 220 class UUIDParameterType(ParamType):\r
 221     def __call__(\r
 222         self,\r
 223         value: Optional[str],\r
 224         param: Optional[Parameter] = ...,\r
 225         ctx: Optional[Context] = ...,\r
 226     ) -> uuid.UUID:\r
 227         ...\r
 228 \r
 229     def convert(\r
 230         self,\r
 231         value: str,\r
 232         param: Optional[Parameter],\r
 233         ctx: Optional[Context],\r
 234     ) -> uuid.UUID:\r
 235         ...\r
 236 \r
 237 \r
 238 def convert_type(ty: Optional[_ConvertibleType], default: Optional[Any] = ...) -> ParamType:\r
 239     ...\r
 240 \r
 241 # parameter type shortcuts\r
 242 \r
 243 BOOL = BoolParamType()\r
 244 FLOAT = FloatParamType()\r
 245 INT = IntParamType()\r
 246 STRING = StringParamType()\r
 247 UNPROCESSED = UnprocessedParamType()\r
 248 UUID = UUIDParameterType()\r