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

   1 # -*- coding: utf-8 -*-\r
   2 """\r
   3     click\r
   4     ~~~~~\r
   5 \r
   6     Click is a simple Python module that wraps the stdlib's optparse to make\r
   7     writing command line scripts fun.  Unlike other modules, it's based around\r
   8     a simple API that does not come with too much magic and is composable.\r
   9 \r
  10     In case optparse ever gets removed from the stdlib, it will be shipped by\r
  11     this module.\r
  12 \r
  13     :copyright: (c) 2014 by Armin Ronacher.\r
  14     :license: BSD, see LICENSE for more details.\r
  15 """\r
  16 \r
  17 # Core classes\r
  18 from .core import (\r
  19     Context as Context,\r
  20     BaseCommand as BaseCommand,\r
  21     Command as Command,\r
  22     MultiCommand as MultiCommand,\r
  23     Group as Group,\r
  24     CommandCollection as CommandCollection,\r
  25     Parameter as Parameter,\r
  26     Option as Option,\r
  27     Argument as Argument,\r
  28 )\r
  29 \r
  30 # Globals\r
  31 from .globals import get_current_context as get_current_context\r
  32 \r
  33 # Decorators\r
  34 from .decorators import (\r
  35     pass_context as pass_context,\r
  36     pass_obj as pass_obj,\r
  37     make_pass_decorator as make_pass_decorator,\r
  38     command as command,\r
  39     group as group,\r
  40     argument as argument,\r
  41     option as option,\r
  42     confirmation_option as confirmation_option,\r
  43     password_option as password_option,\r
  44     version_option as version_option,\r
  45     help_option as help_option,\r
  46 )\r
  47 \r
  48 # Types\r
  49 from .types import (\r
  50     ParamType as ParamType,\r
  51     File as File,\r
  52     Path as Path,\r
  53     Choice as Choice,\r
  54     IntRange as IntRange,\r
  55     Tuple as Tuple,\r
  56     STRING as STRING,\r
  57     INT as INT,\r
  58     FLOAT as FLOAT,\r
  59     BOOL as BOOL,\r
  60     UUID as UUID,\r
  61     UNPROCESSED as UNPROCESSED,\r
  62 )\r
  63 \r
  64 # Utilities\r
  65 from .utils import (\r
  66     echo as echo,\r
  67     get_binary_stream as get_binary_stream,\r
  68     get_text_stream as get_text_stream,\r
  69     open_file as open_file,\r
  70     format_filename as format_filename,\r
  71     get_app_dir as get_app_dir,\r
  72     get_os_args as get_os_args,\r
  73 )\r
  74 \r
  75 # Terminal functions\r
  76 from .termui import (\r
  77     prompt as prompt,\r
  78     confirm as confirm,\r
  79     get_terminal_size as get_terminal_size,\r
  80     echo_via_pager as echo_via_pager,\r
  81     progressbar as progressbar,\r
  82     clear as clear,\r
  83     style as style,\r
  84     unstyle as unstyle,\r
  85     secho as secho,\r
  86     edit as edit,\r
  87     launch as launch,\r
  88     getchar as getchar,\r
  89     pause as pause,\r
  90 )\r
  91 \r
  92 # Exceptions\r
  93 from .exceptions import (\r
  94     ClickException as ClickException,\r
  95     UsageError as UsageError,\r
  96     BadParameter as BadParameter,\r
  97     FileError as FileError,\r
  98     Abort as Abort,\r
  99     NoSuchOption as NoSuchOption,\r
 100     BadOptionUsage as BadOptionUsage,\r
 101     BadArgumentUsage as BadArgumentUsage,\r
 102     MissingParameter as MissingParameter,\r
 103 )\r
 104 \r
 105 # Formatting\r
 106 from .formatting import HelpFormatter as HelpFormatter, wrap_text as wrap_text\r
 107 \r
 108 # Parsing\r
 109 from .parser import OptionParser as OptionParser\r
 110 \r
 111 \r
 112 __all__ = [\r
 113     # Core classes\r
 114     'Context', 'BaseCommand', 'Command', 'MultiCommand', 'Group',\r
 115     'CommandCollection', 'Parameter', 'Option', 'Argument',\r
 116 \r
 117     # Globals\r
 118     'get_current_context',\r
 119 \r
 120     # Decorators\r
 121     'pass_context', 'pass_obj', 'make_pass_decorator', 'command', 'group',\r
 122     'argument', 'option', 'confirmation_option', 'password_option',\r
 123     'version_option', 'help_option',\r
 124 \r
 125     # Types\r
 126     'ParamType', 'File', 'Path', 'Choice', 'IntRange', 'Tuple', 'STRING',\r
 127     'INT', 'FLOAT', 'BOOL', 'UUID', 'UNPROCESSED',\r
 128 \r
 129     # Utilities\r
 130     'echo', 'get_binary_stream', 'get_text_stream', 'open_file',\r
 131     'format_filename', 'get_app_dir', 'get_os_args',\r
 132 \r
 133     # Terminal functions\r
 134     'prompt', 'confirm', 'get_terminal_size', 'echo_via_pager',\r
 135     'progressbar', 'clear', 'style', 'unstyle', 'secho', 'edit', 'launch',\r
 136     'getchar', 'pause',\r
 137 \r
 138     # Exceptions\r
 139     'ClickException', 'UsageError', 'BadParameter', 'FileError',\r
 140     'Abort', 'NoSuchOption', 'BadOptionUsage', 'BadArgumentUsage',\r
 141     'MissingParameter',\r
 142 \r
 143     # Formatting\r
 144     'HelpFormatter', 'wrap_text',\r
 145 \r
 146     # Parsing\r
 147     'OptionParser',\r
 148 ]\r
 149 \r
 150 \r
 151 # Controls if click should emit the warning about the use of unicode\r
 152 # literals.\r
 153 disable_unicode_literals_warning = False\r
 154 \r
 155 \r
 156 __version__ = '6.6'\r