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

   1 from distutils.version import Version\r
   2 from typing import Any, Callable, Dict, List, Optional, Type, TypeVar, Union, Text\r
   3 \r
   4 from click.core import Command, Group, Argument, Option, Parameter, Context, _ConvertibleType\r
   5 \r
   6 _T = TypeVar('_T')\r
   7 _Decorator = Callable[[_T], _T]\r
   8 \r
   9 _Callback = Callable[\r
  10     [Context, Union[Option, Parameter], Union[bool, int, str]],\r
  11     Any\r
  12 ]\r
  13 \r
  14 def pass_context(_T) -> _T:\r
  15     ...\r
  16 \r
  17 \r
  18 def pass_obj(_T) -> _T:\r
  19     ...\r
  20 \r
  21 \r
  22 def make_pass_decorator(\r
  23     object_type: type, ensure: bool = ...\r
  24 ) -> Callable[[_T], _T]:\r
  25     ...\r
  26 \r
  27 \r
  28 # NOTE: Decorators below have **attrs converted to concrete constructor\r
  29 # arguments from core.pyi to help with type checking.\r
  30 \r
  31 def command(\r
  32     name: Optional[str] = ...,\r
  33     cls: Optional[Type[Command]] = ...,\r
  34     # Command\r
  35     context_settings: Optional[Dict] = ...,\r
  36     help: Optional[str] = ...,\r
  37     epilog: Optional[str] = ...,\r
  38     short_help: Optional[str] = ...,\r
  39     options_metavar: str = ...,\r
  40     add_help_option: bool = ...,\r
  41 ) -> _Decorator:\r
  42     ...\r
  43 \r
  44 \r
  45 # This inherits attrs from Group, MultiCommand and Command.\r
  46 \r
  47 def group(\r
  48     name: Optional[str] = ...,\r
  49     cls: Type[Command] = ...,\r
  50     # Group\r
  51     commands: Optional[Dict[str, Command]] = ...,\r
  52     # MultiCommand\r
  53     invoke_without_command: bool = ...,\r
  54     no_args_is_help: Optional[bool] = ...,\r
  55     subcommand_metavar: Optional[str] = ...,\r
  56     chain: bool = ...,\r
  57     result_callback: Optional[Callable] = ...,\r
  58     # Command\r
  59     help: Optional[str] = ...,\r
  60     epilog: Optional[str] = ...,\r
  61     short_help: Optional[str] = ...,\r
  62     options_metavar: str = ...,\r
  63     add_help_option: bool = ...,\r
  64     # User-defined\r
  65     **kwargs: Any,\r
  66 ) -> _Decorator:\r
  67     ...\r
  68 \r
  69 \r
  70 def argument(\r
  71     *param_decls: str,\r
  72     cls: Type[Argument] = ...,\r
  73     # Argument\r
  74     required: Optional[bool] = ...,\r
  75     # Parameter\r
  76     type: Optional[_ConvertibleType] = ...,\r
  77     default: Optional[Any] = ...,\r
  78     callback: Optional[_Callback] = ...,\r
  79     nargs: Optional[int] = ...,\r
  80     metavar: Optional[str] = ...,\r
  81     expose_value: bool = ...,\r
  82     is_eager: bool = ...,\r
  83     envvar: Optional[Union[str, List[str]]] = ...\r
  84 ) -> _Decorator:\r
  85     ...\r
  86 \r
  87 \r
  88 def option(\r
  89     *param_decls: str,\r
  90     cls: Type[Option] = ...,\r
  91     # Option\r
  92     show_default: bool = ...,\r
  93     prompt: Union[bool, Text] = ...,\r
  94     confirmation_prompt: bool = ...,\r
  95     hide_input: bool = ...,\r
  96     is_flag: Optional[bool] = ...,\r
  97     flag_value: Optional[Any] = ...,\r
  98     multiple: bool = ...,\r
  99     count: bool = ...,\r
 100     allow_from_autoenv: bool = ...,\r
 101     type: Optional[_ConvertibleType] = ...,\r
 102     help: Optional[str] = ...,\r
 103     # Parameter\r
 104     default: Optional[Any] = ...,\r
 105     required: bool = ...,\r
 106     callback: Optional[_Callback] = ...,\r
 107     nargs: Optional[int] = ...,\r
 108     metavar: Optional[str] = ...,\r
 109     expose_value: bool = ...,\r
 110     is_eager: bool = ...,\r
 111     envvar: Optional[Union[str, List[str]]] = ...,\r
 112     # User-defined\r
 113     **kwargs: Any,\r
 114 ) -> _Decorator:\r
 115     ...\r
 116 \r
 117 \r
 118 def confirmation_option(\r
 119     *param_decls: str,\r
 120     cls: Type[Option] = ...,\r
 121     # Option\r
 122     show_default: bool = ...,\r
 123     prompt: Union[bool, Text] = ...,\r
 124     confirmation_prompt: bool = ...,\r
 125     hide_input: bool = ...,\r
 126     is_flag: bool = ...,\r
 127     flag_value: Optional[Any] = ...,\r
 128     multiple: bool = ...,\r
 129     count: bool = ...,\r
 130     allow_from_autoenv: bool = ...,\r
 131     type: Optional[_ConvertibleType] = ...,\r
 132     help: str = ...,\r
 133     # Parameter\r
 134     default: Optional[Any] = ...,\r
 135     callback: Optional[_Callback] = ...,\r
 136     nargs: Optional[int] = ...,\r
 137     metavar: Optional[str] = ...,\r
 138     expose_value: bool = ...,\r
 139     is_eager: bool = ...,\r
 140     envvar: Optional[Union[str, List[str]]] = ...\r
 141 ) -> _Decorator:\r
 142     ...\r
 143 \r
 144 \r
 145 def password_option(\r
 146     *param_decls: str,\r
 147     cls: Type[Option] = ...,\r
 148     # Option\r
 149     show_default: bool = ...,\r
 150     prompt: Union[bool, Text] = ...,\r
 151     confirmation_prompt: bool = ...,\r
 152     hide_input: bool = ...,\r
 153     is_flag: Optional[bool] = ...,\r
 154     flag_value: Optional[Any] = ...,\r
 155     multiple: bool = ...,\r
 156     count: bool = ...,\r
 157     allow_from_autoenv: bool = ...,\r
 158     type: Optional[_ConvertibleType] = ...,\r
 159     help: Optional[str] = ...,\r
 160     # Parameter\r
 161     default: Optional[Any] = ...,\r
 162     callback: Optional[_Callback] = ...,\r
 163     nargs: Optional[int] = ...,\r
 164     metavar: Optional[str] = ...,\r
 165     expose_value: bool = ...,\r
 166     is_eager: bool = ...,\r
 167     envvar: Optional[Union[str, List[str]]] = ...\r
 168 ) -> _Decorator:\r
 169     ...\r
 170 \r
 171 \r
 172 def version_option(\r
 173     version: Optional[Union[str, Version]] = ...,\r
 174     *param_decls: str,\r
 175     cls: Type[Option] = ...,\r
 176     # Option\r
 177     prog_name: Optional[str] = ...,\r
 178     message: Optional[str] = ...,\r
 179     show_default: bool = ...,\r
 180     prompt: Union[bool, Text] = ...,\r
 181     confirmation_prompt: bool = ...,\r
 182     hide_input: bool = ...,\r
 183     is_flag: bool = ...,\r
 184     flag_value: Optional[Any] = ...,\r
 185     multiple: bool = ...,\r
 186     count: bool = ...,\r
 187     allow_from_autoenv: bool = ...,\r
 188     type: Optional[_ConvertibleType] = ...,\r
 189     help: str = ...,\r
 190     # Parameter\r
 191     default: Optional[Any] = ...,\r
 192     callback: Optional[_Callback] = ...,\r
 193     nargs: Optional[int] = ...,\r
 194     metavar: Optional[str] = ...,\r
 195     expose_value: bool = ...,\r
 196     is_eager: bool = ...,\r
 197     envvar: Optional[Union[str, List[str]]] = ...\r
 198 ) -> _Decorator:\r
 199     ...\r
 200 \r
 201 \r
 202 def help_option(\r
 203     *param_decls: str,\r
 204     cls: Type[Option] = ...,\r
 205     # Option\r
 206     show_default: bool = ...,\r
 207     prompt: Union[bool, Text] = ...,\r
 208     confirmation_prompt: bool = ...,\r
 209     hide_input: bool = ...,\r
 210     is_flag: bool = ...,\r
 211     flag_value: Optional[Any] = ...,\r
 212     multiple: bool = ...,\r
 213     count: bool = ...,\r
 214     allow_from_autoenv: bool = ...,\r
 215     type: Optional[_ConvertibleType] = ...,\r
 216     help: str = ...,\r
 217     # Parameter\r
 218     default: Optional[Any] = ...,\r
 219     callback: Optional[_Callback] = ...,\r
 220     nargs: Optional[int] = ...,\r
 221     metavar: Optional[str] = ...,\r
 222     expose_value: bool = ...,\r
 223     is_eager: bool = ...,\r
 224     envvar: Optional[Union[str, List[str]]] = ...\r
 225 ) -> _Decorator:\r
 226     ...\r