本文由 大侠(AhcaoZhu)原创，转载请声明。
链接: https://blog.csdn.net/Ahcao2008

🧊摘要

• 全文介绍python的 click 模块（一个通过组合的方式来创建精美命令行界面的包）、函数、类及类的方法和属性。
• 它通过代码抓取并经AI智能翻译和人工校对。
• 是一部不可多得的权威字典类工具书。它是系列集的一部分。后续陆续发布、敬请关注。【原创：AhcaoZhu大侠】

🧊模块图

clickclick._winconsole◆msvcrtclick._compatclick.globalsclick.utilsclick.exceptionsclick.typesclick.parserclick.formattingclick.termuiclick.coreclick.decorators

🧊类关系图

◆object◆BaseException◆Exception◆RuntimeErrorclick.exceptions.Abortclick.exceptions.Exitclick.exceptions.ClickExceptionclick.exceptions.FileErrorclick.exceptions.UsageErrorclick.exceptions.BadArgumentUsageclick.exceptions.BadOptionUsageclick.exceptions.BadParameterclick.exceptions.MissingParameterclick.exceptions.NoSuchOption◆_ctypes._CData◆_ctypes.Structureclick._winconsole.Py_buffer◆_io._IOBase◆_io._RawIOBase◆io.RawIOBaseclick._winconsole._WindowsConsoleRawIOBaseclick._winconsole._WindowsConsoleReaderclick._winconsole._WindowsConsoleWriter◆_io._TextIOBase◆_io.TextIOWrapperclick._compat._NonClosingTextIOWrapperclick._compat._AtomicFileclick._compat._FixupStreamclick._winconsole.ConsoleStreamclick.core.BaseCommandclick.core.Commandclick.core.MultiCommandclick.core.CommandCollectionclick.core.Groupclick.core.Contextclick.core.Parameterclick.core.Argumentclick.core.Optionclick.formatting.HelpFormatterclick.parser.Argumentclick.parser.Optionclick.parser.OptionParserclick.parser.ParsingStateclick.types.ParamTypeclick.types.BoolParamTypeclick.types.Choiceclick.types.CompositeParamTypeclick.types.Tupleclick.types.DateTimeclick.types.Fileclick.types.FuncParamTypeclick.types.Pathclick.types.StringParamTypeclick.types.UUIDParameterTypeclick.types.UnprocessedParamTypeclick.types._NumberParamTypeBaseclick.types.FloatParamTypeclick.types._NumberRangeBaseclick.types.FloatRangeclick.types.IntRangeclick.types.IntParamTypeclick.types._NumberRangeBaseclick.types._NumberRangeBaseclick.utils.KeepOpenFileclick.utils.LazyFileclick.utils.PacifyFlushWrapper◆EnumParameterSource

🧊模块全展开

☘️【click】

click, fullname=click, file=click_init_.py

Click是一个简单的Python模块，受标准库optparse的启发，使编写命令行脚本变得有趣。
与其他模块不同，它基于一个简单的API，没有太多的魔力，并且是可组合的。

🔵统计

序号	类别	数量
4	str	6
6	list	1
8	dict	1
9	module	11
10	class	28
11	function	31
13	residual	8
14	system	10
15	private	2
16	all	86

🔵模块

🌿1 click._winconsole

_winconsole, fullname=click._winconsole, file=click_winconsole.py

🌿2 click._compat

_compat, fullname=click._compat, file=click_compat.py

🌿3 click.globals

globals, fullname=click.globals, file=click\globals.py

🌿4 click.utils

utils, fullname=click.utils, file=click\utils.py

🌿5 click.exceptions

exceptions, fullname=click.exceptions, file=click\exceptions.py

🌿6 click.types

types, fullname=click.types, file=click\types.py

🌿7 click.parser

parser, fullname=click.parser, file=click\parser.py

这个模块最初主要是从stdlib的optparse模块复制粘贴过来的，删除了我们不需要的optparse模块的特性，
因为我们在更高的级别上实现了它们(例如实例类型处理，帮助格式化等等)。
计划是随着时间的推移，把越来越多的东西从这里移走。
这是一个不同的模块，而不是来自stdlib的optparse的原因是，在2.X 和 3.X 中生成的错误消息存在差异，
而stdlib中的optparse没有很好的理由使用gettext，可能会导致我们出现问题。
Click使用了由Gregory P. Ward编写并由Python软件基金会维护的optparse的部分内容。这仅限于parser.py中的代码。
版权所有2001-2006 Gregory P. Ward。版权所有。
Python软件基金会版权所有。版权所有。

🌿8 click.formatting

formatting, fullname=click.formatting, file=click\formatting.py

🌿9 click.termui

termui, fullname=click.termui, file=click\termui.py

🌿10 click.core

core, fullname=click.core, file=click\core.py

🌿11 click.decorators

decorators, fullname=click.decorators, file=click\decorators.py

🔵函数

🌿12 argument(*param_decls: str, **attrs: Any) -> Callable[[~FC], ~FC]

argument(*param_decls: str, **attrs: Any) -> Callable[[~FC], ~FC], module=click.decorators, line:274 at site-packages\click\decorators.py

将参数附加到命令。所有位置参数都作为形参声明传递给:class:`Argument`;所有关键字参数都被原封不动地转发(``cls``除外)。
这相当于手动创建一个:class:`Argument`实例并将其附加到:attr:`Command.params`。:param cls: 要实例化的参数类。默认为 :class:`Argument`。

🌿13 command(name: Union[str, Callable[…, Any], NoneType] = None, cls: Union[Type[click.core.Command], NoneType] = None, **attrs: Any) -> Union[click.core.Command, Callable[…, click.core.Command]]

command(name: Union[str, Callable[…, Any], NoneType] = None, cls: Union[Type[click.core.Command], NoneType] = None, **attrs: Any) -> Union[click.core.Command, Callable[…, click.core.Command]], module=click.decorators, line:151 at site-packages\click\decorators.py

创建一个新的 :class:`Command` 并使用装饰函数作为回调函数。
这也会自动将所有修饰过的 :func:`option`\s and :func:`argument`\s 作为参数附加到命令。
命令名默认为函数名，下划线被破折号替换。如果您想更改它，可以将预期的名称作为第一个参数传递。
所有关键字参数都转发给底层命令类。
对于``params``参数，任何修饰的参数都被附加到列表的末尾。
一旦被修饰，该函数就变成了一个 :class:`Command` 实例，可以作为命令行实用程序调用，也可以附加到命令 :class:`Group` 上。:param name:    命令名。这默认为函数名，下划线被破折号替换。:param cls:     要实例化的命令类。默认为 :class:`Command`。版本变化: 8.1这个装饰器可以不带括号地应用。版本变化: 8.1可以使用 ``params`` 参数。修饰参数被附加到列表的末尾。

🌿14 confirmation_option(*param_decls: str, **kwargs: Any) -> Callable[[~FC], ~FC]

confirmation_option(*param_decls: str, **kwargs: Any) -> Callable[[~FC], ~FC], module=click.decorators, line:314 at site-packages\click\decorators.py

添加“-yes”选项，如果未通过，则在继续之前显示提示。如果拒绝提示，程序将退出。:param param_decls: 一个或多个选项名。默认为单个值 ``"--yes"``。:param kwargs: 额外的参数传递给 :func:`option`。

🌿15 group(name: Union[str, Callable[…, Any], NoneType] = None, **attrs: Any) -> Union[click.core.Group, Callable[[~F], click.core.Group]]

group(name: Union[str, Callable[…, Any], NoneType] = None, **attrs: Any) -> Union[click.core.Group, Callable[[~F], click.core.Group]], module=click.decorators, line:244 at site-packages\click\decorators.py

创建一个新的 :class:`Group` 函数作为回调函数。
它的工作原理与 :func:`command` 相同，只是 `cls` 参数被设置为 :class:`Group`。版本变化: 8.1这个装饰器可以不带圆括号。

🌿16 help_option(*param_decls: str, **kwargs: Any) -> Callable[[~FC], ~FC]

help_option(*param_decls: str, **kwargs: Any) -> Callable[[~FC], ~FC], module=click.decorators, line:469 at site-packages\click\decorators.py

添加``--help``选项，立即打印帮助页并退出程序。
这通常是不必要的，因为 ``--help`` 选项会自动添加到每个命令中，除非传递``add_help_option=False``。:param param_decls: 一个或多个选项名。默认为单个值``"--help"``。:param kwargs:  额外的参数传递给 :func:`option` 。

🌿17 make_pass_decorator(object_type: Type, ensure: bool = False) -> ‘t.Callable[[F], F]’

make_pass_decorator(object_type: Type, ensure: bool = False) -> ‘t.Callable[[F], F]’, module=click.decorators, line:43 at site-packages\click\decorators.py

给定一个对象类型，这会创建一个装饰器，其工作原理类似于 :func:`pass_obj`，
但它不会传递当前上下文的对象，而是会找到 :func:`object_type` 的最内层上下文。这将生成一个工作原理大致如下的装饰器:from functools import update_wrapperdef decorator(f):@pass_contextdef new_func(ctx, *args, **kwargs):obj = ctx.find_object(object_type)return ctx.invoke(f, obj, *args, **kwargs)return update_wrapper(new_func, f)return decorator:param object_type: 要传递的对象类型。:param ensure:  如果设置为`True`，一个新对象将被创建，如果它还没有在上下文中，它将被记住。

🌿18 option(*param_decls: str, **attrs: Any) -> Callable[[~FC], ~FC]

option(*param_decls: str, **attrs: Any) -> Callable[[~FC], ~FC], module=click.decorators, line:293 at site-packages\click\decorators.py

将选项附加到命令。所有位置参数都作为形参声明传递给:class:`Option`;所有关键字参数都被原封不动地转发(``cls``除外)。
这相当于手动创建一个:class:`Option`实例，并将其附加到 :attr:`Command.params` 的列表。param cls:要实例化的选项类。默认为:class:`Option`。

🌿19 pass_context(f: ~F) -> ~F

pass_context(f: ~F) -> ~F, module=click.decorators, line:20 at site-packages\click\decorators.py

将回调标记为希望接收当前上下文对象作为第一个参数。

🌿20 pass_obj(f: ~F) -> ~F

pass_obj(f: ~F) -> ~F, module=click.decorators, line:31 at site-packages\click\decorators.py

类似于 :func:`pass_context` ，但只在上下文上传递对象(:attr:`Context.obj`)。
如果该对象表示嵌套系统的状态，这是有用的。

🌿21 password_option(*param_decls: str, **kwargs: Any) -> Callable[[~FC], ~FC]

password_option(*param_decls: str, **kwargs: Any) -> Callable[[~FC], ~FC], module=click.decorators, line:338 at site-packages\click\decorators.py

添加 ``--password`` 选项，提示输入密码，隐藏输入并要求再次输入值以进行确认。:param param decls: 一个或多个选项名。默认为单个值 ``--password``。:param kwargs:  额外的参数传递给:func:`option`。

🌿22 version_option(version: Union[str, NoneType] = None, *param_decls: str, package_name: Union[str, NoneType] = None, prog_name: Union[str, NoneType] = None, message: Union[str, NoneType] = None, **kwargs: Any) -> Callable[[~FC], ~FC]

version_option(version: Union[str, NoneType] = None, *param_decls: str, package_name: Union[str, NoneType] = None, prog_name: Union[str, NoneType] = None, message: Union[str, NoneType] = None, **kwargs: Any) -> Callable[[~FC], ~FC], module=click.decorators, line:355 at site-packages\click\decorators.py

添加``--version``选项，立即打印版本号并退出程序。如果没有提供``version``， Click将尝试使用:func:`importlib.metadata`检测它。获取``package_name`` 的版本。在Python < 3.8中，必须安装``importlib_metadata`` backport。如果没有提供``package_name``，Click将尝试通过检查堆栈帧来检测它。这将用于检测版本，因此它必须与安装包的名称匹配。:参数version:要显示的版本号。如果没有提供，Click将尝试检测它。:param param_decls:一个或多个选项名。默认为单个值``"--version"``。:param package name:要检测版本的包名。如果没有提供，Click将尝试检测它。:param prog_name:要在消息中显示的命令行CLI 名称。如果没有提供，它将从命令中检测到。:param message:要显示的消息。值``%(prog)s``, ``%(package)s``,和``%(version)s``是可用的。默认为 ``"%(prog)s, version %(version)s"``。:param kwargs:额外的参数传递给:func:`option`。:raise RuntimeError: ``version``无法被检测到。版本变更： 8.0添加``package_name``参数和``%(package)s``参数。消息变更： 8.0使用 :mod:`importlib.metadata` 而不是``pkg_resources``。版本是基于包名而不是入口点名来检测的。Python包名必须与已安装的包名匹配，或者使用``package name=``传递。

🌿23 wrap_text(text: str, width: int = 78, initial_indent: str = ‘’, subsequent_indent: str = ‘’, preserve_paragraphs: bool = False) -> str

wrap_text(text: str, width: int = 78, initial_indent: str = ‘’, subsequent_indent: str = ‘’, preserve_paragraphs: bool = False) -> str, module=click.formatting, line:29 at site-packages\click\formatting.py

智能地包装文本的辅助函数。
默认情况下，它假设它对单个文本段落进行操作，但如果提供了 `preserve_paragraphs` 参数，它将智能地处理段落(由两个空行定义)。
如果处理段落，段落可以用包含``\b``字符(``\x08``)的空行作为前缀，以表明不应该在该块中重新包装。:param text:    应该重新换行的文本。:param width:   文本的最大宽度。:param initial_indent:      作为字符串放置在第一行的初始缩进。:param subsequent_indent:   应放置在每个连续行的缩进字符串。:param preserve_paragraphs:     如果设置了这个标志，那么自动换行将智能地处理段落。

🌿24 get_current_context(silent: bool = False) -> Union[ForwardRef(‘Context’), NoneType]

get_current_context(silent: bool = False) -> Union[ForwardRef(‘Context’), NoneType], module=click.globals, line:21 at site-packages\click\globals.py

返回当前单击上下文。
这可以用作从任何地方访问当前上下文对象的一种方式。
这是对 :func:`pass_context` 装饰器的一种更隐式的替代。
此函数主要用于:func:`echo`等helper，这些helper可能有兴趣根据当前上下文更改其行为。
要推送当前上下文，:meth:`Context.scope` 可以使用。版本增加： 5.0:param silent:  如果设置为 `True`，如果没有上下文可用，返回值为 `None`。默认行为是引发 :exc:`RuntimeError`。

🌿25 clear() -> None

clear() -> None, module=click.termui, line:437 at site-packages\click\termui.py

清除终端屏幕。这将清除终端的整个可见空间，并将光标移动到左上角。
如果没有连接到终端，这不会做任何事情。版本增加： 2.0

🌿26 confirm(text: str, default: Union[bool, NoneType] = False, abort: bool = False, prompt_suffix: str = ': ', show_default: bool = True, err: bool = False) -> bool

confirm(text: str, default: Union[bool, NoneType] = False, abort: bool = False, prompt_suffix: str = ': ', show_default: bool = True, err: bool = False) -> bool, module=click.termui, line:192 at site-packages\click\termui.py

提示确认(yes/no问题)。
如果用户通过发送中断信号来中止输入，这个函数将捕获它并引发:exc:`Abort`异常。:param text:    要问的问题。:param default: 在没有输入时使用的默认值。如果``None``，则重复此操作，直到给出输入。:param abort:   如果将其设置为 `True`，则否定的答案将通过引发 :exc:`Abort`来终止异常。:param prompt_suffix:   提示符的后缀。:param show_default:    在提示符中显示或隐藏默认值。:param err:如果设置为true，文件默认为``stderr``而不是``stdout``，与echo相同。版本更改： 8.0   如果``default``为``None``，重复输入，直到输入。版本增加： 4.0   增加了``err``参数。

🌿27 echo_via_pager(text_or_generator: Union[Iterable[str], Callable[[], Iterable[str]], str], color: Union[bool, NoneType] = None) -> None

echo_via_pager(text_or_generator: Union[Iterable[str], Callable[[], Iterable[str]], str], color: Union[bool, NoneType] = None) -> None, module=click.termui, line:253 at site-packages\click\termui.py

这个函数接受一个文本，并在标准输出上通过环境特定的分页器显示它。版本变更： 3.0   增加了``color``标志。:param text_or_generator:   将文本发送到页面，或者，将文本发送到页面的生成器。:param color:       控制分页器是否支持ANSI颜色。默认是自动检测。

🌿28 edit(text: Union[~AnyStr, NoneType] = None, editor: Union[str, NoneType] = None, env: Union[Mapping[str, str], NoneType] = None, require_save: bool = True, extension: str = ‘.txt’, filename: Union[str, NoneType] = None) -> Union[~AnyStr, NoneType]

edit(text: Union[~AnyStr, NoneType] = None, editor: Union[str, NoneType] = None, env: Union[Mapping[str, str], NoneType] = None, require_save: bool = True, extension: str = ‘.txt’, filename: Union[str, NoneType] = None) -> Union[~AnyStr, NoneType], module=click.termui, line:640 at site-packages\click\termui.py

在定义的编辑器中编辑给定的文本。
如果给出了一个编辑器(应该是可执行文件的完整路径，但常规的操作系统搜索路径用于查找可执行文件)，它将覆盖检测到的编辑器。
可以选择使用一些环境变量。
如果编辑器在没有更改的情况下关闭，则返回 `None`。
在直接编辑文件的情况下，返回值总是 `None`， `require_save` 和 `extension` 被忽略。
如果无法打开编辑器，则会引发:exc:`UsageError`。
Windows注意:为了简化跨平台使用，换行符会自动从POSIX转换为Windows，反之亦然。
因此，这里的消息将使用``\n``作为换行标记。:param text:    要编辑的文本。:param editor:  可选使用的编辑器。默认为自动检测。:param env: 要转发给编辑器的环境变量。:param require_save:    如果这是true，那么不在编辑器中保存将使返回值变为 `None`。:param extension:   要告诉编辑器的扩展名。默认为 `.txt`，但更改它可能会更改语法高亮显示。:param filename:    如果提供，它将编辑此文件而不是提供的文本内容。在这种情况下，它不会使用临时文件作为间接文件。

🌿29 getchar(echo: bool = False) -> str

getchar(echo: bool = False) -> str, module=click.termui, line:720 at site-packages\click\termui.py

从终端获取单个字符并返回它。这将始终返回一个unicode字符，在某些罕见的情况下，它可能返回多个字符。返回多个字符的情况是，无论出于何种原因，多个字符最终在终端缓冲区中结束，或者标准输入实际上不是终端。注意，这将始终从终端读取，即使有东西通过管道进入标准输入。注意Windows:在极少数情况下，当输入非ascii字符时，此函数可能会等待第二个字符，然后同时返回两个字符。这是因为某些Unicode字符看起来像特殊键标记。版本增加： 2.0:param echo: 如果设置为 `True`，读取的字符也会显示在终端上。默认是不显示它。

🌿30 launch(url: str, wait: bool = False, locate: bool = False) -> int

launch(url: str, wait: bool = False, locate: bool = False) -> int, module=click.termui, line:686 at site-packages\click\termui.py

该函数在该文件类型的默认查看器应用程序中启动给定的URL(或文件名)。
如果这是一个可执行文件，它可能会在一个新的会话中启动可执行文件。
返回值是已启动应用程序的退出代码。通常，``0``表示成功。
示例:click.launch('https://click.palletsprojects.com/')click.launch('/my/downloaded/file', locate=True)版本增加： 2.0
:param url: 要启动的东西的url或文件名。
:param wait:    等待程序退出后返回。这只有在启动的程序阻塞时才有效。特别是，Linux上的``xdg-open``不会阻塞。
:param locate:  如果设置为`True`，则不会启动与该URL关联的应用程序，而是尝试启动带有该文件所在位置的文件管理器。如果URL没有指向文件系统，这可能会产生奇怪的效果。

🌿31 pause(info: Union[str, NoneType] = None, err: bool = False) -> None

pause(info: Union[str, NoneType] = None, err: bool = False) -> None, module=click.termui, line:756 at site-packages\click\termui.py

该命令停止执行，等待用户按下任意键继续执行。这类似于Windows批处理“暂停”命令。如果程序不是通过终端运行，则此命令将不执行任何操作。	版本增加： 2.0 ..	版本增加： 4.0增加 `err` 参数。:param info:暂停前要打印的信息。默认为“按任意键继续…”。:param err:如果设置为message转到``stderr``而不是``stdout``，与echo相同。

🌿32 progressbar(iterable: Union[Iterable[~V], NoneType] = None, length: Union[int, NoneType] = None, label: Union[str, NoneType] = None, show_eta: bool = True, show_percent: Union[bool, NoneType] = None, show_pos: bool = False, item_show_func: Union[Callable[[Union[~V, NoneType]], Union[str, NoneType]], NoneType] = None, fill_char: str = ‘#’, empty_char: str = ‘-’, bar_template: str = ‘%(label)s [%(bar)s] %(info)s’, info_sep: str = ’ ', width: int = 36, file: Union[TextIO, NoneType] = None, color: Union[bool, NoneType] = None, update_min_steps: int = 1) -> ‘ProgressBar[V]’

progressbar(iterable: Union[Iterable[~V], NoneType] = None, length: Union[int, NoneType] = None, label: Union[str, NoneType] = None, show_eta: bool = True, show_percent: Union[bool, NoneType] = None, show_pos: bool = False, item_show_func: Union[Callable[[Union[~V, NoneType]], Union[str, NoneType]], NoneType] = None, fill_char: str = ‘#’, empty_char: str = ‘-’, bar_template: str = ‘%(label)s [%(bar)s] %(info)s’, info_sep: str = ’ ', width: int = 36, file: Union[TextIO, NoneType] = None, color: Union[bool, NoneType] = None, update_min_steps: int = 1) -> ‘ProgressBar[V]’, module=click.termui, line:285 at site-packages\click\termui.py

这个函数创建一个可迭代的上下文管理器，可用于在显示进度条的同时迭代某些内容。它将迭代 `iterable` 或`length`项(被计数)。当迭代发生时，此函数将渲染的进度条打印到给定的`file`(默认为stdout)，并将尝试计算剩余时间等。默认情况下，如果文件不是终端，则不会呈现此进度条。上下文管理器创建进度条。当进入上下文管理器时，已经创建了进度条。随着进度条上的每次迭代，传递给进度条的可迭代对象被推进，并且进度条被更新。当上下文管理器退出时，将打印一个换行符，并最终在屏幕上显示进度条。注意:进度条目前是为总进度至少需要几秒钟的用例设计的。因此，ProgressBar类对象不会显示被认为太快的进度，也不会显示步数间隔时间少于一秒的进度。不能打印，否则进度条会被无意中破坏。示例用法：with progressbar(items) as bar:for item in bar:do_something_with(item)    或者，如果没有指定可迭代对象，可以通过`update()`方法手动更新进度条，而不是直接迭代进度条。更新方法接受用:with progressbar(length=chunks.total_bytes) as bar:for chunk in chunks:process_chunk(chunk)bar.update(chunks.bytes)``update()``方法也接受一个可选值来指定``当前项目``在新位置。当与``item_show_func``一起使用时，这很有用，可以使用click自定义每个手动步骤的输出。with click.progressbar(length=total_size,label='Unzipping archive',item_show_func=lambda a: a.filename) as bar:for archive in zip_file:archive.extract()bar.update(archive.size, archive)param iterable:     一个要迭代的可迭代对象。如果没有提供，则必须提供长度。:param length:      要迭代的项数。默认情况下，进度条将尝试向迭代器询问其长度，这可能有效，也可能无效。如果还提供了可迭代对象，则可以使用此参数覆盖长度。如果没有提供可迭代对象，则进度条将在该长度的范围内迭代。:param label:       进度条旁边要显示的标签。:param show_eta:    启用或禁用估计时间显示。如果无法确定长度，则自动禁用此功能。:param show_percent:    打开或关闭百分比显示。如果可迭代对象有长度，默认值为 `True`，否则为`False`。:param show_pos:        启用或禁用绝对位置显示。默认值为``False``。:param item_show_func:  一个用当前项调用的函数，它可以返回一个字符串在进度条旁边显示。如果函数返回``None``，则不会显示任何内容。当前项可以为``None``，例如在进入和退出栏时。:param fill_char:       用来显示进度条填充部分的字符。:empty_char:            用于显示进度条中未填充部分的字符。:param bar_template:    bar模板的格式字符串。其中的参数是`label`用于标签，`bar`用于进度条，`info`用于信息部分。:param info_sep:        多个信息项(eta等)之间的分隔符;param width:            进度条的宽度，以字符为单位，0表示完整的终端宽度;param file:             要写入的文件。如果这不是终端，则只打印标签。:param color:           控制终端是否支持ANSI颜色。默认是自动检测。只有在进度条输出中包含ANSI代码时才需要这样做，而默认情况下不是这样。:param update_min_steps:    仅在完成这么多更新时呈现。这允许对非常快的迭代器进行调优。版本变更： 8.0       即使执行时间小于0.5秒，也会显示输出。版本变更： 8.0       ``item_show_func``显示当前项，而不是前一个。版本变更： 8.0       如果输出不是TTY，则回显标签。恢复7.0中删除所有输出的更改。	版本增加： 8.0       增加了``update_min_steps``参数。版本变更： 4.0       增加了``color``参数。为对象添加了``update``方法。	版本增加： 2.0

🌿33 prompt(text: str, default: Union[Any, NoneType] = None, hide_input: bool = False, confirmation_prompt: Union[bool, str] = False, type: Union[click.types.ParamType, Any, NoneType] = None, value_proc: Union[Callable[[str], Any], NoneType] = None, prompt_suffix: str = ': ', show_default: bool = True, err: bool = False, show_choices: bool = True) -> Any

prompt(text: str, default: Union[Any, NoneType] = None, hide_input: bool = False, confirmation_prompt: Union[bool, str] = False, type: Union[click.types.ParamType, Any, NoneType] = None, value_proc: Union[Callable[[str], Any], NoneType] = None, prompt_suffix: str = ': ', show_default: bool = True, err: bool = False, show_choices: bool = True) -> Any, module=click.termui, line:81 at site-packages\click\termui.py

提示用户输入。这是一个方便的函数，可用于提示用户稍后进行输入。
如果用户通过发送中断信号来中止输入，这个函数将捕获它并引发:exc:`Abort`异常。:param text:    提示符显示的文本。:param default: 没有输入时使用的默认值。如果没有指定，它将提示直到中止。:param hide_input:  如果设置为true，那么输入值将被隐藏。:param confirmation_prompt:        第二次提示确认参数值。可以设置为字符串而不是``True``以自定义消息。:param type:            用来检查值的类型。:param value_proc:      如果提供了这个参数，它是一个被调用的函数，而不是用于转换值的类型转换。:param prompt_suffix:   提示符的后缀。:param show_default:    在提示符中显示或隐藏默认值。:param err:             如果设置为true，则文件默认为``stderr``而不是``stdout``，与echo相同。:param show_choices:    如果传递的类型是Choice，则显示或隐藏选择。例如，如果type是day或week的选项，show_choices为true, text为"Group by"，那么提示符将是"Group by (day, week): "。版本增加： 8.0   ``confirmation_prompt``可以是一个自定义字符串版本增加： 7.0   增加了``show_choices``参数。	版本增加： 6.0   在Windows上增加了对cmd.exe的unicode支持。	版本增加： 4.0   增加 `err` 参数。

🌿34 secho(message: Union[Any, NoneType] = None, file: Union[IO[~AnyStr], NoneType] = None, nl: bool = True, err: bool = False, color: Union[bool, NoneType] = None, **styles: Any) -> None

secho(message: Union[Any, NoneType] = None, file: Union[IO[~AnyStr], NoneType] = None, nl: bool = True, err: bool = False, color: Union[bool, NoneType] = None, **styles: Any) -> None, module=click.termui, line:606 at site-packages\click\termui.py

这个函数将:func:`echo`和:func:`style`合并为一个调用。
因此，下面两个调用是相同的:click.secho('Hello World!', fg='green')click.echo(click.style('Hello World!', fg='green'))所有关键字参数都被转发给底层函数，具体取决于它们使用的是哪个。非字符串类型将被转换为:class:`str`。然而，:class:`bytes`直接传递给:meth:`echo`而不应用style。如果要为表示文本的字节设置样式，请调用:meth:`bytes.decode`先。版本变更： 8.0   将非字符串的message转换为字符串。字节在不应用样式的情况下传递。	版本增加： 2.0

🌿35 style(text: Any, fg: Union[int, Tuple[int, int, int], str, NoneType] = None, bg: Union[int, Tuple[int, int, int], str, NoneType] = None, bold: Union[bool, NoneType] = None, dim: Union[bool, NoneType] = None, underline: Union[bool, NoneType] = None, overline: Union[bool, NoneType] = None, italic: Union[bool, NoneType] = None, blink: Union[bool, NoneType] = None, reverse: Union[bool, NoneType] = None, strikethrough: Union[bool, NoneType] = None, reset: bool = True) -> str

style(text: Any, fg: Union[int, Tuple[int, int, int], str, NoneType] = None, bg: Union[int, Tuple[int, int, int], str, NoneType] = None, bold: Union[bool, NoneType] = None, dim: Union[bool, NoneType] = None, underline: Union[bool, NoneType] = None, overline: Union[bool, NoneType] = None, italic: Union[bool, NoneType] = None, blink: Union[bool, NoneType] = None, reverse: Union[bool, NoneType] = None, strikethrough: Union[bool, NoneType] = None, reset: bool = True) -> str, module=click.termui, line:465 at site-packages\click\termui.py

使用ANSI样式设置文本并返回新字符串。
默认情况下，样式是自包含的，这意味着在字符串的末尾会发出一个重置代码。这可以通过传递`reset=False`来防止。例子:click.echo(click.style('Hello World!', fg='green'))click.echo(click.style('ATTENTION!', blink=True))click.echo(click.style('Some things', reverse=True, fg='cyan'))click.echo(click.style('More colors', fg=(255, 12, 128), bg=117))支持的颜色名称:* ``black`` (might be a gray)* ``red``* ``green``* ``yellow`` (might be an orange)* ``blue``* ``magenta``* ``cyan``* ``white`` (might be light gray)* ``bright_black``* ``bright_red``* ``bright_green``* ``bright_yellow``* ``bright_blue``* ``bright_magenta``* ``bright_cyan``* ``bright_white``* ``reset`` (reset the color code only)如果终端支持，颜色也可以指定为:-间隔[0,255]的整数。终端必须支持8位/256色模式。—由[0,255]范围内的三个整数组成的RGB元组。终端必须支持24位/真彩色模式。更多信息请参见:[链接一](https://en.wikipedia.org/wiki/ANSI_color) 和 [链接二](https://gist.github.com/XVilka/8346728)。:param text:    用ANSI代码样式的字符串。:param fg:      如果提供，这将成为前景色。参数bg:如果提供，这将成为背景色。:param bold:    如果提供，将启用或禁用粗体模式。:param dim:     如果提供，将启用或禁用dim模式。这一点得到了很好的支持。:param underline:   如果提供，将启用或禁用下划线。参数overline:如果提供，将启用或禁用overline。:param italic:  如果提供此选项，将启用或禁用斜体。:param blink:   如果提供，将启用或禁用闪烁。:param reverse: 如果提供，将启用或禁用反向渲染(前景变为背景，反之亦然)。:param strikethrough:   如果提供，将启用或禁用通过文本划线。:param reset:   默认情况下，在字符串的末尾添加reset-all代码，这意味着样式不会延续。这可以在组合样式时禁用。版本变更： 8.0   将非字符串的``message``转换为字符串。版本变更： 8.0   增加了对256和RGB色码的支持。版本变更： 8.0   增加了``strikethrough``，``italic``和``overline``参数。版本变更： 7.0   增加了对鲜艳颜色的支持…	版本增加： 2.0

🌿36 unstyle(text: str) -> str

unstyle(text: str) -> str, module=click.termui, line:594 at site-packages\click\termui.py

从字符串中删除ANSI样式信息。通常不需要使用这个函数，因为Click的echo函数会在必要时自动删除样式。版本增加： 2.0:param text:    要删除样式信息的文本。

🌿37 echo(message: Union[Any, NoneType] = None, file: Union[IO[Any], NoneType] = None, nl: bool = True, err: bool = False, color: Union[bool, NoneType] = None) -> None

echo(message: Union[Any, NoneType] = None, file: Union[IO[Any], NoneType] = None, nl: bool = True, err: bool = False, color: Union[bool, NoneType] = None) -> None, module=click.utils, line:205 at site-packages\click\utils.py

将消息和换行符打印到标准输出或文件。这应该用来代替:func:`print`，因为它可以更好地支持不同的数据、文件和环境。与:func:`print`相比，它做了以下事情:-确保在Linux上没有错误配置输出编码。-在Windows控制台中支持Unicode。-支持写入二进制输出，支持写入字节到文本输出。-支持Windows上的颜色和样式。-如果输出看起来不像交互式终端，则删除ANSI颜色和样式代码。-总是刷新输出。:param message: 要输出的字符串或字节。其他对象被转换为字符串。:param file:    要写入的文件。默认为``stdout``。:param err:     写入``stderr``而不是``stdout``。:param nl:      在消息后打印换行符。默认开启。:param color:   强制显示或隐藏颜色和其他样式。默认情况下，如果输出看起来不像交互式终端，Click将删除颜色。版本变更： 6.0   支持Windows控制台上的Unicode输出。单击不修改``sys``。stdout``，所以``sys.stdout.write()``和``print() ``仍然不支持Unicode。版本变更： 4.0   增加了``color``参数。	版本增加： 3.0   增加``err``参数。版本变更： 2.0   如果安装了colorama，则支持Windows上的颜色。

🌿38 format_filename(filename: Union[str, bytes, os.PathLike], shorten: bool = False) -> str

format_filename(filename: Union[str, bytes, os.PathLike], shorten: bool = False) -> str, module=click.utils, line:383 at site-packages\click\utils.py

为用户显示格式化文件名。
这个函数的主要目的是确保文件名可以被显示。
这将在必要时以一种不会失败的方式将文件名解码为unicode。
可选地，它可以缩短文件名以不包含文件名的完整路径。:param filename:    格式化UI显示的文件名。这也会将文件名转换为unicode而不会失败。:param shorten: 这可选地将文件名缩短为指向它的路径的条带。

🌿39 get_app_dir(app_name: str, roaming: bool = True, force_posix: bool = False) -> str

get_app_dir(app_name: str, roaming: bool = True, force_posix: bool = False) -> str, module=click.utils, line:403 at site-packages\click\utils.py

返回应用程序的配置文件夹。默认行为是返回最适合操作系统的内容。为了给你一个想法，对于一个名为``Foo Bar``的应用程序，可以返回如下文件夹:Mac OS X:``~/Library/Application Support/Foo Bar``Mac OS X (POSIX):``~/.foo-bar``Unix:``~/.config/foo-bar``Unix (POSIX):``~/.foo-bar``Windows (roaming):``C:\Users\<user>\AppData\Roaming\Foo Bar``Windows (not roaming):``C:\Users\<user>\AppData\Local\Foo Bar``版本增加： 2.0:param app_name:    应用程序名称。它应该正确地大写，并且可以包含空格。:param roaming:     控制文件夹在Windows上是否应该漫游。没有其他影响。:param force posix: 如果这被设置为``True``，那么在任何posix系统上，文件夹将存储在主文件夹中，并带有一个前导点，而不是XDG配置主页或达尔文的应用程序支持文件夹。

🌿40 get_binary_stream(name: “te.Literal[‘stdin’, ‘stdout’, ‘stderr’]”) -> <class ‘BinaryIO’>

get_binary_stream(name: “te.Literal[‘stdin’, ‘stdout’, ‘stderr’]”) -> <class ‘BinaryIO’>, module=click.utils, line:303 at site-packages\click\utils.py

返回用于字节处理的系统流。:param name:    要打开的流的名称。有效的名称是``stdin'``、``stdout'`` 和 ``stderr'``。

🌿41 get_text_stream(name: “te.Literal[‘stdin’, ‘stdout’, ‘stderr’]”, encoding: Union[str, NoneType] = None, errors: Union[str, NoneType] = ‘strict’) -> <class ‘TextIO’>

get_text_stream(name: “te.Literal[‘stdin’, ‘stdout’, ‘stderr’]”, encoding: Union[str, NoneType] = None, errors: Union[str, NoneType] = ‘strict’) -> <class ‘TextIO’>, module=click.utils, line:315 at site-packages\click\utils.py

返回用于文本处理的系统流。这通常会返回一个围绕:func:`get binary stream`返回的二进制流的包装流，但它也可以为已经正确配置的流采取快捷方式。:param name:        要打开的流的名称。有效的名称是``stdin````，``stdout````和``stderr``:param encoding:    覆盖检测到的默认编码。:param errors:      覆盖默认的错误模式。

🌿42 open_file(filename: str, mode: str = ‘r’, encoding: Union[str, NoneType] = None, errors: Union[str, NoneType] = ‘strict’, lazy: bool = False, atomic: bool = False) -> <class ‘IO’>

open_file(filename: str, mode: str = ‘r’, encoding: Union[str, NoneType] = None, errors: Union[str, NoneType] = ‘strict’, lazy: bool = False, atomic: bool = False) -> <class ‘IO’>, module=click.utils, line:336 at site-packages\click\utils.py

打开一个文件，使用额外的行为来处理``-'``来指示标准流，写时延迟打开和原子写。类似于:class:`~click的行为。文件参数类型。如果``-'``被指定为打开``stdout``或 ``stdin``，则流将被包装，以便在上下文管理器中使用它不会关闭它。这样就可以在不意外关闭标准流的情况下使用该函数:代码块:with open_file(filename) as f:...:param filename:    要打开的文件的名称，或者``stdin`` / ``stdout`` ``-'``。:param mode:    打开文件的模式。:param encoding:    对以文本方式打开的文件进行解码或编码的编码。:param errors:  错误处理方式。:param lazy:    等待打开文件，直到它被访问。对于读模式，文件被临时打开以提前引发访问错误，然后关闭，直到再次读取。:param atomic:  写入临时文件，并在关闭时替换给定的文件。版本增加： 3.0

🔵类

🌿43 click.core.Argument

Argument, click.core.Argument, module=click.core, line:2925 at site-packages\click\core.py

参数是命令的位置参数。它们通常提供的功能比选项少，但可以有无限的``nargs``，并且默认情况下是必需的。所有参数都传递给参数构造函数。

data

1 param_type_name=argument kind:data type:str class:<class ‘click.core.Argument’>

property

2 human_readable_name=<property object at 0x00000220464577C8> kind:property type:property class:<class ‘click.core.Argument’>

method

3 add_to_parser(self, parser: OptionParser, ctx: Context) -> None:

kind=method class=Argument objtype=function line:2997 at …\lib\site-packages\click\core.py

4 get_error_hint(self, ctx: Context) -> str:

kind=method class=Argument objtype=function line:2994 at …\lib\site-packages\click\core.py

5 get_usage_pieces(self, ctx: Context) -> t.List[str]:

kind=method class=Argument objtype=function line:2991 at …\lib\site-packages\click\core.py

6 make_metavar(self) -> str:

kind=method class=Argument objtype=function line:2962 at …\lib\site-packages\click\core.py

🌿44 click.core.BaseCommand

BaseCommand, click.core.BaseCommand, module=click.core, line:811 at site-packages\click\core.py

base命令实现命令的最小API契约。大多数代码永远不会使用它，因为它没有实现很多有用的功能，但它可以作为不依赖于Click解析器的其他解析方法的直接子类。例如，这可以用来桥接Click和其他系统，如argparse或docopt。由于基本命令没有实现Click的其他部分认为理所当然的许多API，因此并不是所有操作都支持它们。例如，它们通常不能与装饰器一起使用，而且它们没有内置的回调系统。版本变更： 2.0   增加了`context_settings`参数。:param name:    除非被组覆盖，否则要使用的命令名。:param context_settings:    一个可选的字典，带有传递给context对象的默认值。

data

1 allow_extra_args=False kind:data type:bool class:<class ‘click.core.BaseCommand’>
2 allow_interspersed_args=True kind:data type:bool class:<class ‘click.core.BaseCommand’>
3 context_class=<class ‘click.core.Context’> kind:data type:type class:<class ‘click.core.BaseCommand’>
4 ignore_unknown_options=False kind:data type:bool class:<class ‘click.core.BaseCommand’>

method

5 get_help(self, ctx: Context) -> str:

kind=method class=BaseCommand objtype=function line:881 at …\lib\site-packages\click\core.py

6 get_usage(self, ctx: Context) -> str:

kind=method class=BaseCommand objtype=function line:878 at …\lib\site-packages\click\core.py

7 invoke(self, ctx: Context) -> t.Any:

kind=method class=BaseCommand objtype=function line:930 at …\lib\site-packages\click\core.py

给定上下文，这将调用命令。默认实现会引发未实现错误。

8 main()

kind=method class=BaseCommand objtype=function line:966 at …\lib\site-packages\click\core.py

这是将脚本作为命令行应用程序调用的方法。这将总是在调用后终止应用程序。如果不需要，则需要捕获``SystemExit``。这个方法也可以通过直接调用:class:`Command`的实例来实现。:param args:            应该用于解析的参数。如果没有提供，``sys.argv[1:]``。:param program_name:    应该使用的程序名。默认情况下，程序名是通过从``sys.argv[0]``获取文件名来构造的。:param complete_var:    控制bash完成支持的环境变量。默认值是 ``"_<prog_name>_COMPLETE"`` ，其中proname为大写。:param standalone_mode: 默认以单机模式调用脚本。然后Click将处理异常并将其转换为错误消息，该函数将永远不会返回，而是关闭解释器。如果设置为`False`，它们将被传播给调用者，并且该函数的返回值是:meth:`invoke`的返回值。:param windows_expand_args: 在windows上展开命令行参数中的全局模式、用户目录和env变量。:param extra:           额外的关键字参数被转发给上下文构造函数。更多信息请参见:class:`Context`。版本变更： 8.0.1 增加了``windows_expand_args``参数，允许在windows上禁用命令行扩展参数。版本变更： 8.0.  当从 ``sys.argv`` 获取参数时。在Windows上全局模式，用户目录和envars被展开。版本变更： 3.0   增加了``standalone_mode`` 参数。

9 make_context(

kind=method class=BaseCommand objtype=function line:884 at …\lib\site-packages\click\core.py

当给定info名称和参数时，该函数将开始解析并创建一个新的:class:`Context`。但是，它并不调用实际的命令回调。要快速自定义使用的上下文类而不重写此方法，请设置:attr:`context_class`属性。:param info_name:   此调用的info名称。通常，这是脚本或命令最具描述性的名称。对于顶层脚本，它通常是脚本的名称，对于下面的命令，它是命令的名称。:param args:    作为字符串列表解析的参数。:param parent:  父上下文(如果可用)。:param extra:   转发给上下文构造函数的额外关键字参数版本变更： 8.0   增加:attr:`context_class`属性。

10 parse_args(self, ctx: Context, args: t.List[str]) -> t.List[str]:

kind=method class=BaseCommand objtype=function line:923 at …\lib\site-packages\click\core.py

给定上下文和参数列表，这将创建解析器并解析参数，然后根据需要修改上下文。
它会被:meth:`make_context`自动调用。

11 shell_complete(self, ctx: Context, incomplete: str) -> t.List[“CompletionItem”]:

kind=method class=BaseCommand objtype=function line:936 at …\lib\site-packages\click\core.py

返回不完整值的补全列表。查看链接的多命令的名称。任何命令都可以是链接的多命令的一部分，因此兄弟命令在命令完成期间的任何时候都是有效的。其他命令类将返回更多的补全。:param ctx: 该命令的调用上下文。:param incomplete: 正在完成的值。可能是空的。版本增加： 8.0

12 to_info_dict(self, ctx: Context) -> t.Dict[str, t.Any]:

kind=method class=BaseCommand objtype=function line:861 at …\lib\site-packages\click\core.py

收集可能对生成面向用户文档的工具有用的信息。这将遍历该命令下面的整个结构。使用 :meth:`click.Context.to_info_dict` 遍历整个CLI结构。:param ctx: :class:`Context`表示这个命令。版本增加： 8.0

🌿45 click.core.Command

Command, click.core.Command, module=click.core, line:1133 at site-packages\click\core.py

命令是Click中命令行接口的基本组成部分。基本命令处理命令行解析，并可能将更多解析分派给嵌套在它下面的命令。:param name:    除非被组覆盖，否则要使用的命令名。:param context_settings:一个可选的字典，带有传递给context对象的默认值。:param callback:    要调用的回调。这是可选的。:param params:  该命令注册的参数。这可以是:class:`Option`或:class:`Argument`对象。:param help:    该命令使用的帮助字符串。:param epilog:  类似于帮助字符串，但它打印在帮助页面的末尾，在其他内容之后。:param short_help:      该命令使用的简短帮助。这显示在父命令的命令列表中。默认情况下，每个命令注册一个``-help``选择。可以通过此参数禁用此功能。:param add_help_option: 这控制了如果没有提供参数会发生什么。默认情况下，该选项是禁用的。如果启用，如果没有传递参数，将添加``-help``作为参数:param hidden:      从帮助输出中隐藏此命令。:param deprecated:  表示该命令已弃用。版本变更： 8.1   ``help``， ``epilog``和``short help ``都是未经处理的存储，所有格式化都是在输出帮助文本时完成的，而不是在init时完成的，即使没有使用``@command``装饰器也会完成。版本变更： 8.0   增加了``repr``，显示命令名称。版本变更： 7.1   增加了``no args is help``参数。版本变更： 2.0   增加了``context_settings``参数。

method

1 collect_usage_pieces(self, ctx: Context) -> t.List[str]:

kind=method class=Command objtype=function line:1245 at …\lib\site-packages\click\core.py

返回进入用法行的所有部分，并将其作为字符串列表返回。

2 format_epilog(self, ctx: Context, formatter: HelpFormatter) -> None:

kind=method class=Command objtype=function line:1360 at …\lib\site-packages\click\core.py

将epilog写入格式化程序(如果存在)。

3 format_help(self, ctx: Context, formatter: HelpFormatter) -> None:

kind=method class=Command objtype=function line:1317 at …\lib\site-packages\click\core.py

将帮助写入格式化程序(如果存在)。这是一个低级方法，由 :meth:`get_help` 调用。这调用了以下方法:-   :meth:`format_usage`-   :meth:`format_help_text`-   :meth:`format_options`-   :meth:`format_epilog`

4 format_help_text(self, ctx: Context, formatter: HelpFormatter) -> None:

kind=method class=Command objtype=function line:1334 at …\lib\site-packages\click\core.py

将帮助文本写入格式化程序(如果存在)。

5 format_options(self, ctx: Context, formatter: HelpFormatter) -> None:

kind=method class=Command objtype=function line:1348 at …\lib\site-packages\click\core.py

如果存在，则将所有选项写入格式化程序。

6 format_usage(self, ctx: Context, formatter: HelpFormatter) -> None:

kind=method class=Command objtype=function line:1237 at …\lib\site-packages\click\core.py

将用法行写入格式化程序。这是一个低级方法，由:meth:`get usage`调用。

7 get_help(self, ctx: Context) -> str:

kind=method class=Command objtype=function line:1292 at …\lib\site-packages\click\core.py

将帮助格式化为字符串并返回它。内部调用:meth:`format_help`。

8 get_help_option(self, ctx: Context) -> t.Optional[“Option”]:

kind=method class=Command objtype=function line:1264 at …\lib\site-packages\click\core.py

返回帮助选项对象。

9 get_help_option_names(self, ctx: Context) -> t.List[str]:

kind=method class=Command objtype=function line:1256 at …\lib\site-packages\click\core.py

返回帮助选项的名称。

10 get_params(self, ctx: Context) -> t.List[“Parameter”]:

kind=method class=Command objtype=function line:1228 at …\lib\site-packages\click\core.py

11 get_short_help_str(self, limit: int = 45) -> str:

kind=method class=Command objtype=function line:1301 at …\lib\site-packages\click\core.py

获取命令的简短帮助，或通过缩短长帮助字符串生成帮助。

12 get_usage(self, ctx: Context) -> str:

kind=method class=Command objtype=function line:1219 at …\lib\site-packages\click\core.py

将用法行格式化为字符串并返回它。内部调用:meth:`format_usage`。

13 invoke(self, ctx: Context) -> t.Any:

kind=method class=Command objtype=function line:1393 at …\lib\site-packages\click\core.py

给定上下文，这将以正确的方式调用附加的回调(如果存在)。

14 make_parser(self, ctx: Context) -> OptionParser:

kind=method class=Command objtype=function line:1285 at …\lib\site-packages\click\core.py

创建此命令的基础选项解析器。

15 parse_args(self, ctx: Context, args: t.List[str]) -> t.List[str]:

kind=method class=Command objtype=function line:1369 at …\lib\site-packages\click\core.py

16 shell_complete(self, ctx: Context, incomplete: str) -> t.List[“CompletionItem”]:

kind=method class=Command objtype=function line:1406 at …\lib\site-packages\click\core.py

返回不完整值的补全列表。查看选项和链接的多命令的名称。:param ctx:       该命令的调用上下文。:参数incomplete:  正在完成的值。可能是空的。	
版本增加： 8.0

17 to_info_dict(self, ctx: Context) -> t.Dict[str, t.Any]:

kind=method class=Command objtype=function line:1207 at …\lib\site-packages\click\core.py

🌿46 click.core.CommandCollection

CommandCollection, click.core.CommandCollection, module=click.core, line:1924 at site-packages\click\core.py

命令集合是将多个多命令合并为一个命令的多命令。
这是一个简单的实现，它接受一系列不同的多命令作为源，并为每个命令提供所有命令。

method

1 add_source(self, multi_cmd: MultiCommand) -> None:

kind=method class=CommandCollection objtype=function line:1941 at …\lib\site-packages\click\core.py

向链调度程序添加一个新的多命令。

2 get_command(self, ctx: Context, cmd_name: str) -> t.Optional[Command]:

kind=method class=CommandCollection objtype=function line:1945 at …\lib\site-packages\click\core.py

3 list_commands(self, ctx: Context) -> t.List[str]:

kind=method class=CommandCollection objtype=function line:1957 at …\lib\site-packages\click\core.py

🌿47 click.core.Context

Context, click.core.Context, module=click.core, line:160 at site-packages\click\core.py

上下文是一个特殊的内部对象，它保存着与每个级别的脚本执行相关的状态。它通常对命令是不可见的，除非他们选择访问它。上下文很有用，因为它可以传递内部对象，并且可以控制特殊的执行特性，例如从环境变量中读取数据。上下文可以用作上下文管理器，在这种情况下，它将在teardown时调用:meth:`close`。:param command:             此上下文的命令类。:param parent:              父上下文。:param info_name:           此调用的info名称。通常，这是脚本或命令最具描述性的名称。对于顶层脚本，它通常是脚本的名称，对于下面的命令，它是脚本的名称。:param obj:                 用户数据的任意对象。:param auto_envvar_prefix:  用于自动环境变量的前缀。如果这是 `None`，则禁用从环境变量读取。这不会影响总是读取的手动设置的环境变量。:param default_map:         一个字典(类似于object)，具有默认的参数值。:参数终端宽度:终端的宽度。默认是继承自父上下文。如果没有上下文定义终端宽度，则将应用自动检测。:param max_content_width:   Click渲染内容的最大宽度(目前只影响帮助页面)。如果没有覆盖，默认为80个字符。换句话说:即使终端大于80个字符，默认情况下Click也不会格式化大于80个字符的内容。除此之外，格式化器可能会在右侧添加一些安全映射。:param resilient_parsing:   如果启用此标志，则Click将在没有任何交互或回调调用的情况下进行解析。默认值也将被忽略。这对于实现诸如补全支持之类的东西很有用。:param allow_extra_args:    如果将此设置为 `True`，则最后的额外参数不会引发错误，并将保留在上下文中。默认是从命令继承。:param allow_interspersed_args: 如果设置为`False`，则选项和参数不能混合。默认是从命令继承。:param ignore_unknown_options:  指示click忽略它不知道的选项，并保留它们以供以后处理。param help_option_names:        可选的字符串列表，这些字符串定义了默认帮助参数的命名方式。默认值是``['--help']``。:param token_normalize_func:        一个可选函数，用于规范化标记(选项，选择等)。例如，这可以用来实现不区分大小写的行为。:param color:   控制终端是否支持ANSI颜色。默认是自动检测。只有在Click打印的文本中使用ANSI代码时才需要这样做，这在默认情况下不是这种情况。例如，这将影响帮助输出。:param show_default:显示命令的默认值。如果未设置此值，则默认为来自父上下文的值。``Command.show_default`` 将覆盖特定命令的默认值。版本变更： 8.1   ``show_default``参数被``Command.show_default``覆盖，而不是相反。版本变更： 8.0   参数show_default默认为父上下文的值版本变更： 7.1   增加了``show_default``参数。版本变更： 4.0   增加了``color``， ``ignore_unknown_options``和 ``max_content_width``参数。版本变更： 3.0   增加了``allow_extra_args``和``allow_interspersed_args``版本变更： 2.0   增加了``resilient_parsing``，``help_option_names``和'token_normalize_func``参数。

data

1 formatter_class=<class ‘click.formatting.HelpFormatter’> kind:data type:type class:<class ‘click.core.Context’>

property

2 command_path=<property object at 0x0000022046440B38> kind:property type:property class:<class ‘click.core.Context’>
3 meta=<property object at 0x00000220464405E8> kind:property type:property class:<class ‘click.core.Context’>

method

4 abort(self) -> “te.NoReturn”:

kind=method class=Context objtype=function line:681 at …\lib\site-packages\click\core.py

中止脚本。

5 call_on_close(self, f: t.Callable[…, t.Any]) -> t.Callable[…, t.Any]:

kind=method class=Context objtype=function line:573 at …\lib\site-packages\click\core.py

注册一个在上下文断开时调用的函数。这可用于关闭在脚本执行期间打开的资源。
支持Python上下文管理器协议的资源应该在``with``语句中使用，而应该在:meth:`with_resource`中注册。
:param f:在teardown时执行的函数。

6 close(self) -> None:

kind=method class=Context objtype=function line:585 at …\lib\site-packages\click\core.py

调用所有用:meth:`call_on_close`注册的close回调，并退出所有用:meth:`with_resource`进入的上下文管理器。

7 ensure_object(self, object_type: t.Type[V]) -> V:

kind=method class=Context objtype=function line:632 at …\lib\site-packages\click\core.py

类似于:meth:`find_object '，但如果最里面的对象不存在，则将其设置为 `object_type` 的新实例。

8 exit(self, code: int = 0) -> “te.NoReturn”:

kind=method class=Context objtype=function line:685 at …\lib\site-packages\click\core.py

使用给定的退出代码退出应用程序。

9 fail(self, message: str) -> “te.NoReturn”:

kind=method class=Context objtype=function line:673 at …\lib\site-packages\click\core.py

用特定的错误消息中止程序的执行。
:param message:要失败的错误消息。

10 find_object(self, object_type: t.Type[V]) -> t.Optional[V]:

kind=method class=Context objtype=function line:620 at …\lib\site-packages\click\core.py

查找与给定类型最接近的对象。

11 find_root(self) -> “Context”:

kind=method class=Context objtype=function line:613 at …\lib\site-packages\click\core.py

查找最外层的上下文。

12 forward(

kind=method class=Context objtype=function line:762 at …\lib\site-packages\click\core.py

类似于:meth:`invoke`，但如果其他命令需要，则填充当前上下文中的默认关键字参数。这不能直接调用回调，只能调用其他命令版本更改： 8.0所有``kwargs``都在:attr:`params`中跟踪，因此如果``forward``在多个级别被调用，它们将被传递。

13 get_help(self) -> str:

kind=method class=Context objtype=function line:695 at …\lib\site-packages\click\core.py

方法获取当前上下文和命令的格式化帮助页。

14 get_parameter_source(self, name: str) -> t.Optional[ParameterSource]:

kind=method class=Context objtype=function line:792 at …\lib\site-packages\click\core.py

获取参数的来源。这表示获取参数值的位置。这对于确定用户何时在命令行上指定与默认值相同的值非常有用。它将是 :           attr:`~click.core.ParameterSource.DEFAULT` 只有当值实际上是从默认值中获取时才会使用。:param name:    参数名称。:rtype:     ParameterSource版本变更： 8.0   如果参数不是从任何来源提供的，则返回``None``。

15 get_usage(self) -> str:

kind=method class=Context objtype=function line:689 at …\lib\site-packages\click\core.py

方法获取当前上下文和命令的格式化用法字符串。

16 invoke()

kind=method class=Context objtype=function line:709 at …\lib\site-packages\click\core.py

以它期望的方式调用命令回调。有两种方法可以调用这个方法:1. 第一个参数可以是回调，所有其他参数和关键字参数都直接转发给函数。2. 第一个参数是一个click command对象。在这种情况下，所有的参数都被转发，但适当的点击参数(选项和点击参数)必须是关键字参数和点击将填写默认值。请注意，在Click 3.2之前，关键字参数没有正确填写，这违背了代码的意图，也没有创建上下文。有关此更改的更多信息以及为什么在错误修复版本中完成，请参阅 :ref:`upgrade-to-3.2`版本更改： 8.0    所有的``kwargs``都在:attr:`params`中跟踪，所以如果在多个级别调用:meth:`forward`，它们将被传递。

17 lookup_default(

kind=method class=Context objtype=function line:642 at …\lib\site-packages\click\core.py

从:attr:`default_map`中获取参数的默认值。
:param name:参数名称。
:param call:如果默认值是可调用的，调用它。禁用返回可调用对象…版本变更： 8.0增加了``call``参数。

18 make_formatter(self) -> HelpFormatter:

kind=method class=Context objtype=function line:530 at …\lib\site-packages\click\core.py

创建:类:`~click。用于帮助和用法输出的HelpFormatter。
要快速自定义使用的格式化器类而不重写此方法，请设置:attr:`formatter_class`属性。
版本变更： 8.0增加:attr:`formatter_class`属性。

19 scope(self, cleanup: bool = True) -> t.Iterator[“Context”]:

kind=method class=Context objtype=function line:465 at …\lib\site-packages\click\core.py

这个辅助方法可以与context对象一起使用，以将其提升到当前线程本地(参见:func:`get_current_context`)。它的默认行为是调用清理函数，可以通过将`cleanup`设置为`False`来禁用该函数。清理函数通常用于关闭文件句柄等操作。如果要进行清理，也可以直接将上下文对象用作上下文管理器。示例用法:with ctx.scope():assert get_current_context() is ctxwith ctx:assert get_current_context() is ctx版本增加： 5.0:param cleanup: 控制是否应该运行清理函数。默认是运行这些函数。在某些情况下，上下文只希望被临时推送，在这种情况下可以禁用此功能。嵌套推送自动延迟清理。

20 set_parameter_source(self, name: str, source: ParameterSource) -> None:

kind=method class=Context objtype=function line:783 at …\lib\site-packages\click\core.py

设置参数的来源。这表示获取参数值的位置。
:param name:参数名称。class:`~click.core.ParameterSource`的成员。

21 to_info_dict(self) -> t.Dict[str, t.Any]:

kind=method class=Context objtype=function line:432 at …\lib\site-packages\click\core.py

收集可能对生成面向用户文档的工具有用的信息。这遍历整个CLI结构。代码段：with Context(cli) as ctx:info = ctx.to_info_dict()版本增加： 8.0

22 with_resource(self, context_manager: t.ContextManager[V]) -> V:

kind=method class=Context objtype=function line:544 at …\lib\site-packages\click\core.py

注册一个资源，就像在``with``语句中使用它一样。当上下文弹出时，资源将被清理。用途:甲:“contextlib.ExitStack。输入上下文”。它调用资源的``__enter__()``方法并返回结果。当上下文弹出时，它关闭堆栈，调用资源的``__exit__()``方法。要为非上下文管理器注册一个清理函数，使用:meth:`call_on_close`。或者使用:mod:`contextlib`中的一些东西将其转换为上下文管理器。代码块:@click.group()@click.option("--name")@click.pass_contextdef cli(ctx):ctx.obj = ctx.with_resource(connect_db(name)):param context_manager:要进入的上下文管理器。:return: 无论如何返回 ``context_manager.__enter__()``。版本增加： 8.0

🌿48 click.core.Group

Group, click.core.Group, module=click.core, line:1750 at site-packages\click\core.py

组允许命令附加子命令。这是在Click中实现嵌套的最常用方法。:param name:        组命令名称。:param commands:一   个将名称映射到:class:`Command`对象的字典。也可以是:class:`Command`的列表，它将使用:attr:`Command.name`来创建字典。:param attrs:       在:class:`MultiCommand`，:class:`command`和:class:`BaseCommand`中描述的其他命令参数。版本变更： 8.0       ``commands``参数可以是一个命令对象列表。

data

1 command_class=None kind:data type:NoneType class:<class ‘click.core.Group’>
2 group_class=None kind:data type:NoneType class:<class ‘click.core.Group’>

method

3 add_command(self, cmd: Command, name: t.Optional[str] = None) -> None:

kind=method class=Group objtype=function line:1802 at …\lib\site-packages\click\core.py

向该组注册另一个:class:`Command`。如果未提供命令名，则使用命令名。

4 command(self, __func: t.Callable[…, t.Any]) -> Command:

kind=method class=Group objtype=function line:1813 at …\lib\site-packages\click\core.py

用于声明命令并将其附加到组的快捷装饰器。
它采用与:func:`command`相同的参数，并通过调用:meth:`add_command` 立即将创建的命令注册到该组。
要自定义所使用的命令类，请设置:attr:`command_class` 属性。
版本变更： 8.1   这个装饰器可以不带括号。
版本变更： 8.0   增加:attr:`command_class`属性。

5 get_command(self, ctx: Context, cmd_name: str) -> t.Optional[Command]:

kind=method class=Group objtype=function line:1917 at …\lib\site-packages\click\core.py

6 group(self, __func: t.Callable[…, t.Any]) -> “Group”:

kind=method class=Group objtype=function line:1864 at …\lib\site-packages\click\core.py

用于声明组和将组附加到组的快捷装饰器。它采用与:func:`group`相同的参数，并通过调用:meth:`add_command` 立即将创建的组注册到此组。
要自定义所使用的组类，请设置:attr:`group class` 属性。
版本变更： 8.1   这个装饰器可以不带括号。
版本变更： 8.0   增加:attr:`group class`属性。

7 list_commands(self, ctx: Context) -> t.List[str]:

kind=method class=Group objtype=function line:1920 at …\lib\site-packages\click\core.py

🌿49 click.core.MultiCommand

MultiCommand, click.core.MultiCommand, module=click.core, line:1442 at site-packages\click\core.py

多命令是将命令分派给子命令的命令的基本实现。最常见的版本是:class:`Group`。:param invoke_without_command:  控制如何调用多命令本身。默认情况下，它只在提供子命令时调用。:param add_help_option: 这控制了如果没有提供参数会发生什么。如果`invoke_without_command` 被禁用，则默认启用该选项;如果启用，则禁用该选项。如果启用，将添加，如果没有传递参数，则``-help ``作为参数。:param subcommand_metavar:  在文档中用于指示子命令位置的字符串。:param chain:               如果将此设置为``True``，则启用多个子命令的链接。这限制了命令的形式，因为它们不能有可选参数，但它允许多个命令链接在一起。:param result_callback:     此多命令附加的结果回调。控件设置或更改此属性:meth:`result_callback` 装饰器。

data

1 allow_extra_args=True kind:data type:bool class:<class ‘click.core.MultiCommand’>
2 allow_interspersed_args=False kind:data type:bool class:<class ‘click.core.MultiCommand’>

method

3 collect_usage_pieces(self, ctx: Context) -> t.List[str]:

kind=method class=MultiCommand objtype=function line:1526 at …\lib\site-packages\click\core.py

4 format_commands(self, ctx: Context, formatter: HelpFormatter) -> None:

kind=method class=MultiCommand objtype=function line:1580 at …\lib\site-packages\click\core.py

多方法的额外格式方法，在选项后添加所有命令。

5 format_options(self, ctx: Context, formatter: HelpFormatter) -> None:

kind=method class=MultiCommand objtype=function line:1531 at …\lib\site-packages\click\core.py

6 get_command(self, ctx: Context, cmd_name: str) -> t.Optional[Command]:

kind=method class=MultiCommand objtype=function line:1718 at …\lib\site-packages\click\core.py

给定上下文和命令名称，如果存在，则返回:class:`command`对象，或者返回 `None`。

7 invoke(self, ctx: Context) -> t.Any:

kind=method class=MultiCommand objtype=function line:1623 at …\lib\site-packages\click\core.py

8 list_commands(self, ctx: Context) -> t.List[str]:

kind=method class=MultiCommand objtype=function line:1724 at …\lib\site-packages\click\core.py

按应出现的顺序返回子命令名称的列表。

9 parse_args(self, ctx: Context, args: t.List[str]) -> t.List[str]:

kind=method class=MultiCommand objtype=function line:1608 at …\lib\site-packages\click\core.py

10 resolve_command(

kind=method class=MultiCommand objtype=function line:1691 at …\lib\site-packages\click\core.py

11 result_callback(self, replace: bool = False) -> t.Callable[[F], F]:

kind=method class=MultiCommand objtype=function line:1535 at …\lib\site-packages\click\core.py

向命令添加结果回调。默认情况下，如果一个结果回调已经注册，这将链接它们，但这可以通过`replace`参数禁用。使用子命令的返回值(如果启用了链接，则使用所有子命令的返回值列表)以及将传递给主回调的参数来调用结果回调。示例:@click.group()@click.option('-i', '--input', default=23)def cli(input):return 42@cli.result_callback()def process_result(result, input):return result + input:param replace:     如果设置为``True``，则已经存在的结果回调将被删除。版本更改： 8.0   版本变更： 8.0   从``resultcallback``重命名。版本增加： 3.0

12 shell_complete(self, ctx: Context, incomplete: str) -> t.List[“CompletionItem”]:

kind=method class=MultiCommand objtype=function line:1730 at …\lib\site-packages\click\core.py

返回不完整值的补全列表。查看选项、子命令和链接多命令的名称。:param ctx:该命令的调用上下文。:param incomplete:	正在完成的值。可能是空的。	版本增加： 8.0

13 to_info_dict(self, ctx: Context) -> t.Dict[str, t.Any]:

kind=method class=MultiCommand objtype=function line:1508 at …\lib\site-packages\click\core.py

🌿50 click.core.Option

Option, click.core.Option, module=click.core, line:2409 at site-packages\click\core.py

选项通常是命令行上的可选值，并且具有参数所不具备的一些额外特性。所有其他参数都传递给参数构造函数。:param show_default:    在帮助文本中显示该选项的默认值。默认情况下不显示值，除非:attr:`Context.show_default` is ``True``。如果此值是字符串，则在括号中显示该字符串，而不是实际值。这对于动态选项特别有用。对于单选项布尔标志，如果其值为``False``，则默认值保持隐藏。:param show_envvar:     控制是否在帮助页面上显示环境变量。通常，不显示环境变量。:param prompt:          如果设置为``True``或非空字符串，则会提示用户输入。如果设置为``True``，提示符将是大写的选项名。:param confirmation_prompt: 提示第二次确认的值，如果提示。可以设置为字符串而不是``True``以自定义消息。:param prompt_required: 如果设置为``False``，只有当该选项被指定为一个没有值的标志时，才会提示用户输入。:param hide_input:      如果这是``True``，那么提示符上的输入将对用户隐藏。这对于密码输入很有用。:param is_flag:         强制此选项作为标志。默认为自动检测。:param flag_value:      如果启用了该标志，应该使用哪个值。如果选项字符串包含标记两个选项的斜杠，则自动将其设置为布尔值。:param multiple:        如果设置为 `True`，则参数被多次接受并记录。这在工作方式上类似于``nargs``，但支持任意数量的参数。:param count:           该标志使选项增量为整数。:param allow_from_autoenv:  如果启用了此功能，则如果在上下文中定义了前缀，则该参数的值将从环境变量中提取。:param help:            帮助字符串。:param hidden:          在帮助输出中隐藏该选项。版本变更： 8.1.0     帮助文本缩进在这里被清除，而不是只在``@option``装饰器中。版本变更： 8.1.0     ``show_default``参数覆盖``Context.show_default``。版本变更： 8.1.0     如果默认值为``False``，则不显示单个选项布尔标志的默认值。版本变更： 8.0.1     如果给定，则从 ``flag_value`` 中检测``type``。

data

1 param_type_name=option kind:data type:str class:<class ‘click.core.Option’>

method

2 add_to_parser(self, parser: OptionParser, ctx: Context) -> None:

kind=method class=Option objtype=function line:2651 at …\lib\site-packages\click\core.py

3 consume_value(

kind=method class=Option objtype=function line:2887 at …\lib\site-packages\click\core.py

4 get_default(

kind=method class=Option objtype=function line:2799 at …\lib\site-packages\click\core.py

5 get_help_record(self, ctx: Context) -> t.Optional[t.Tuple[str, str]]:

kind=method class=Option objtype=function line:2690 at …\lib\site-packages\click\core.py

6 prompt_for_value(self, ctx: Context) -> t.Any:

kind=method class=Option objtype=function line:2826 at …\lib\site-packages\click\core.py

这是一个可选流，如果值不存在，则可以在完整值处理中激活它。它将提示用户，直到存在一个有效值，然后返回处理后的值作为结果。

7 resolve_envvar_value(self, ctx: Context) -> t.Optional[str]:

kind=method class=Option objtype=function line:2852 at …\lib\site-packages\click\core.py

8 to_info_dict(self) -> t.Dict[str, t.Any]:

kind=method class=Option objtype=function line:2586 at …\lib\site-packages\click\core.py

9 value_from_envvar(self, ctx: Context) -> t.Optional[t.Any]:

kind=method class=Option objtype=function line:2871 at …\lib\site-packages\click\core.py

🌿51 click.core.Parameter

Parameter, click.core.Parameter, module=click.core, line:134 at site-packages\click\core.py

命令的参数有两个版本:它们是:class:`Option` \s或:class:`Argument` \s。其他子类目前不受设计的支持，因为解析的一些内部结构有意没有最终确定。选项和参数都支持某些设置。:param param_decls: 该选项或实参的参数声明。这是一个标志或参数名称的列表。:param type:    应该使用的类型。a:class:`ParamType` 或Python类型。如果支持，后者将自动转换为前者。:param required:    控制该参数是否是可选的。:param default:     省略时使用默认值。这也可以是一个可调用对象，在这种情况下，当需要默认值而不需要任何参数时调用它。:param callback:    在类型转换后进一步处理或验证值的函数。它被称为``f(ctx, param, value) ``，并且必须返回值。所有源都调用它，包括提示符。:param nargs:   要匹配的参数数量。如果不是``1``，返回值是一个元组而不是单个值。nargs的默认值是``1``(除非类型是元组，那么它是元组的元数)。如果``nargs=-1 ``，则收集所有剩余参数。:param metavar: 该值在帮助页面中的表示方式。:param expose_value:    如果这是 `True`，那么该值将继续传递给命令回调并存储在上下文中，否则它将被跳过。:param is_eager:    在非急切值之前处理急切值。不应该为参数设置此值，否则将颠倒处理顺序。:param envvar:      需要检查的环境变量字符串或字符串列表。:param shell_complete:  一个返回自定义shell补全的函数。如果给定，用于代替参数的类型补全。接受 ``ctx, param, incomplete`` ，并且必须返回一个列表 :class:`~click.shell_completion.CompletionItem` 或字符串列表。版本变更： 8.0 ``process value``验证所需的参数和有界的``nargs``，并在返回值之前调用参数回调。这允许回调验证提示。``full_process_value`` 被删除。版本变更： 8.0 ``autocompletion``重命名为``shell_complete``，并具有上面描述的新语义。旧名称已被弃用，并将在8.1中删除，在此之前它将被包装以匹配新的要求。对于``multiple=True, nargs>1``，默认值必须是一个元组列表。不再需要为``nargs>1 ``设置默认值，它将默认为``None``。``multiple=True`` 或 ``nargs=-1`` 将默认为``()``。版本变更： 7.1   忽略空的环境变量，而不是接受空字符串值。这使得脚本可以在无法取消设置的情况下清除变量。版本变更： 2.0   修改了参数callback的签名，也传递给参数。旧的回调格式仍然可以工作，但它会引发一个警告，让您有机会更容易地迁移代码。

data

1 param_type_name=parameter kind:data type:str class:<class ‘click.core.Parameter’>

property

2 human_readable_name=<property object at 0x00000220464519A8> kind:property type:property class:<class ‘click.core.Parameter’>

method

3 add_to_parser(self, parser: OptionParser, ctx: Context) -> None:

kind=method class=Parameter objtype=function line:2233 at …\lib\site-packages\click\core.py

4 consume_value(

kind=method class=Parameter objtype=function line:2236 at …\lib\site-packages\click\core.py

5 get_default(

kind=method class=Parameter objtype=function line:2189 at …\lib\site-packages\click\core.py

获取参数的默认值。首先试:meth:`Context.lookup_default`，然后是本地默认值。:param ctx:     当前上下文。:param call:    如果默认值是可调用的，调用它。禁用返回可调用对象版本变更： 8.0.2 获取默认值时不再执行类型强制转换。版本变更： 8.0.1 类型转换在弹性解析模式下可能失败。无效的默认值不会阻止显示帮助文本。版本变更： 8.0   首先查看``ctx.default_map``。版本变更： 8.0   增加了``call``参数。

6 get_error_hint(self, ctx: Context) -> str:

kind=method class=Parameter objtype=function line:2378 at …\lib\site-packages\click\core.py

获取参数的字符串化版本，以便在错误消息中使用，以指示导致错误的参数。

7 get_help_record(self, ctx: Context) -> t.Optional[t.Tuple[str, str]]:

kind=method class=Parameter objtype=function line:2372 at …\lib\site-packages\click\core.py

8 get_usage_pieces(self, ctx: Context) -> t.List[str]:

kind=method class=Parameter objtype=function line:2375 at …\lib\site-packages\click\core.py

9 handle_parse_result(

kind=method class=Parameter objtype=function line:2352 at …\lib\site-packages\click\core.py

10 make_metavar(self) -> str:

kind=method class=Parameter objtype=function line:2174 at …\lib\site-packages\click\core.py

11 process_value(self, ctx: Context, value: t.Any) -> t.Any:

kind=method class=Parameter objtype=function line:2315 at …\lib\site-packages\click\core.py

12 resolve_envvar_value(self, ctx: Context) -> t.Optional[str]:

kind=method class=Parameter objtype=function line:2326 at …\lib\site-packages\click\core.py

13 shell_complete(self, ctx: Context, incomplete: str) -> t.List[“CompletionItem”]:

kind=method class=Parameter objtype=function line:936 at …\lib\site-packages\click\core.py

    返回不完整值的补全列表。如果在初始化过程中给出了``shell complete``函数，则使用它。否则，:attr:`type` :meth:`~click.types.ParamType.shell_complete`函数。:param ctx: 该命令的调用上下文。:param incomplete:	正在完成的值。可能是空的。版本增加： 8.0

14 to_info_dict(self) -> t.Dict[str, t.Any]:

kind=method class=Parameter objtype=function line:432 at …\lib\site-packages\click\core.py

收集可能对生成面向用户文档的工具有用的信息。
使用 :meth:`click.Context.to_info_dict`遍历整个CLI结构。	
版本增加： 8.0

15 type_cast_value(self, ctx: Context, value: t.Any) -> t.Any:

kind=method class=Parameter objtype=function line:2256 at …\lib\site-packages\click\core.py

根据选项:attr:`type`、:attr:`multiple`和:attr:`nargs`转换并验证值。

16 value_from_envvar(self, ctx: Context) -> t.Optional[t.Any]:

kind=method class=Parameter objtype=function line:2344 at …\lib\site-packages\click\core.py

17 value_is_missing(self, value: t.Any) -> bool:

kind=method class=Parameter objtype=function line:2306 at …\lib\site-packages\click\core.py

🌿52 click.exceptions.Abort

Abort, click.exceptions.Abort, module=click.exceptions, line:273 at site-packages\click\exceptions.py

内部信号异常，指示单击终止。

🌿53 click.exceptions.BadArgumentUsage

BadArgumentUsage, click.exceptions.BadArgumentUsage, module=click.exceptions, line:247 at site-packages\click\exceptions.py

如果通常提供了一个参数，但该参数的使用不正确，则会引发。例如，如果参数的值数量不正确，则会引发此问题。	
版本增加： 6.0

🌿54 click.exceptions.BadOptionUsage

BadOptionUsage, click.exceptions.BadOptionUsage, module=click.exceptions, line:230 at site-packages\click\exceptions.py

如果通常提供了一个选项，但该选项的使用不正确，则会引发。例如，如果选项的参数数量不正确，则会引发此问题。	
版本增加： 4.0
:param option_name:被错误使用的选项名。

🌿55 click.exceptions.BadParameter

BadParameter, click.exceptions.BadParameter, module=click.exceptions, line:85 at site-packages\click\exceptions.py

格式化错误参数的标准化错误消息的异常。当从回调或类型抛出时，这很有用，因为Click会将上下文信息附加到它(例如，它是哪个参数)。版本增加： 2.0:param param: 导致此错误的参数对象。这可以被遗漏，如果可能的话，点击将附加此信息本身。:param param_hint:  作为参数名显示的字符串。在需要进行自定义验证的情况下，这可以作为``param``的替代。如果它是一个字符串，那么它就是这样使用的，如果它是一个列表，那么每个项都被引用并分开。

method

1 format_message(self) -> str:

kind=method class=BadParameter objtype=function line:114 at …\lib\site-packages\click\exceptions.py

🌿56 click.exceptions.ClickException

ClickException, click.exceptions.ClickException, module=click.exceptions, line:23 at site-packages\click\exceptions.py

Click可以处理并显示给用户的异常。

data

1 exit_code=1 kind:data type:int class:<class ‘click.exceptions.ClickException’>

method

2 format_message(self) -> str:

kind=method class=ClickException objtype=function line:33 at …\lib\site-packages\click\exceptions.py

3 show(self, file: t.Optional[t.IO] = None) -> None:

kind=method class=ClickException objtype=function line:39 at …\lib\site-packages\click\exceptions.py

🌿57 click.exceptions.FileError

FileError, click.exceptions.FileError, module=click.exceptions, line:256 at site-packages\click\exceptions.py

当文件无法打开时引发。

method

1 format_message(self) -> str:

kind=method class=FileError objtype=function line:267 at …\lib\site-packages\click\exceptions.py

🌿58 click.exceptions.MissingParameter

MissingParameter, click.exceptions.MissingParameter, module=click.exceptions, line:127 at site-packages\click\exceptions.py

如果click需要一个选项或参数，但在调用脚本时没有提供，则会被引发。	版本增加： 4.0:param param type:  参数类型的字符串。默认是从给定的`param`继承参数类型。有效值是``parameter'``,``option'`` 或 ``argument'``。

method

1 format_message(self) -> str:

kind=method class=MissingParameter objtype=function line:150 at …\lib\site-packages\click\exceptions.py

🌿59 click.exceptions.NoSuchOption

NoSuchOption, click.exceptions.NoSuchOption, module=click.exceptions, line:196 at site-packages\click\exceptions.py

如果click试图处理一个不存在的选项，将被引发。	
版本增加： 4.0

method

1 format_message(self) -> str:

kind=method class=NoSuchOption objtype=function line:217 at …\lib\site-packages\click\exceptions.py

🌿60 click.exceptions.UsageError

UsageError, click.exceptions.UsageError, module=click.exceptions, line:46 at site-packages\click\exceptions.py

发出使用错误信号的内部异常。这通常会中止任何进一步的处理。
:param message:显示的错误信息。
:param ctx:可选的导致此错误的上下文。在某些情况下，单击将自动填充上下文。

data

1 exit_code=2 kind:data type:int class:<class ‘click.exceptions.UsageError’>

method

2 show(self, file: t.Optional[t.IO] = None) -> None:

kind=method class=UsageError objtype=function line:62 at …\lib\site-packages\click\exceptions.py

🌿61 click.formatting.HelpFormatter

HelpFormatter, click.formatting.HelpFormatter, module=click.formatting, line:102 at site-packages\click\formatting.py

这个类帮助格式化基于文本的帮助页面。它通常只在非常特殊的内部情况下才需要，但它也被公开，以便开发人员可以编写自己的花哨输出。目前，它总是写入内存。:param indent_increment:    每层的额外增量。:param width:               文本的宽度。默认情况下，终端宽度箝位为78。

method

1 dedent(self) -> None:

kind=method class=HelpFormatter objtype=function line:141 at …\lib\site-packages\click\formatting.py

减少缩进。

2 getvalue(self) -> str:

kind=method class=HelpFormatter objtype=function line:278 at …\lib\site-packages\click\formatting.py

返回缓冲区内容。

3 indent(self) -> None:

kind=method class=HelpFormatter objtype=function line:137 at …\lib\site-packages\click\formatting.py

增加缩进。

4 indentation(self) -> t.Iterator[None]:

kind=method class=HelpFormatter objtype=function line:270 at …\lib\site-packages\click\formatting.py

增加缩进的上下文管理器。

5 section(self, name: str) -> t.Iterator[None]:

kind=method class=HelpFormatter objtype=function line:255 at …\lib\site-packages\click\formatting.py

有用的上下文管理器，用于编写段落、标题和缩进。
:param name:作为标题书写的节名。

6 write(self, string: str) -> None:

kind=method class=HelpFormatter objtype=function line:133 at …\lib\site-packages\click\formatting.py

将unicode字符串写入内部缓冲区。

7 write_dl(

kind=method class=HelpFormatter objtype=function line:210 at …\lib\site-packages\click\formatting.py

将定义列表写入缓冲区。选项和命令通常是这样格式化的。
:param rows:包含两个项元组的列表，用于项和值。
:param col_max:第一列的最大宽度。
:param co_spacing:第一列和第二列之间的空格数。

8 write_heading(self, heading: str) -> None:

kind=method class=HelpFormatter objtype=function line:185 at …\lib\site-packages\click\formatting.py

将标题写入缓冲区。

9 write_paragraph(self) -> None:

kind=method class=HelpFormatter objtype=function line:189 at …\lib\site-packages\click\formatting.py

将一个段落写入缓冲区。

10 write_text(self, text: str) -> None:

kind=method class=HelpFormatter objtype=function line:194 at …\lib\site-packages\click\formatting.py

将重新缩进的文本写入缓冲区。这是对段落的重新包装和保留。

11 write_usage(

kind=method class=HelpFormatter objtype=function line:145 at …\lib\site-packages\click\formatting.py

将用法行写入缓冲区。
:param prog:程序名。
:param args:由空格分隔的参数列表。
param prefix:第一行的前缀。默认为``"Usage: "``。

🌿62 click.parser.OptionParser

OptionParser, click.parser.OptionParser, module=click.parser, line:253 at site-packages\click\parser.py

选项解析器是一个内部类，最终用于解析选项和参数。它是在optparse的基础上建模的，并提供了一个类似但大大简化的API。它通常不应直接用作高级Click类为您包装它。它的可扩展性不如optparse或argparse，因为它没有实现在更高级别上实现的特性(例如类型或默认值)。:param ctx: 可选 :class:`~click.Context`这个解析器应该使用。

method

1 add_argument(

kind=method class=OptionParser objtype=function line:316 at …\lib\site-packages\click\parser.py

向解析器添加名为`dest`的位置参数。`obj`可用于标识从解析器返回的顺序列表中的选项。

2 add_option(

kind=method class=OptionParser objtype=function line:291 at …\lib\site-packages\click\parser.py

向解析器添加一个名为`dest`的新选项。目标不是推断出来的(与optparse不同)，需要显式提供。
Action可以是 ``store``，`store const``，`append``，`append const``或 ``count``中的任何一个。
`obj`可用于标识从解析器返回的顺序列表中的选项。

3 parse_args(

kind=method class=OptionParser objtype=function line:326 at …\lib\site-packages\click\parser.py

解析位置参数并为已解析的选项和参数以及剩余参数返回``(values, args, order)``(如果有的话)。
顺序是在命令行中出现的对象列表。如果参数出现多次，它们也会被记忆多次。

🌿63 click.types.Choice

Choice, click.types.Choice, module=click.types, line:225 at site-packages\click\types.py

选择类型允许根据一组固定的支持值来检查一个值。所有这些值都必须是字符串。您应该只传递一个选择列表或元组。其他可迭代对象(如生成器)可能会导致令人惊讶的结果。结果值将始终是最初传递的选项之一，无论 ``case_sensitive`` 或任何 ``ctx.token_normalize_func`` 函数``被指定。参见: ref:`choice- options`的例子。:param case_sensitive:  设置为false以使选择不区分大小写。默认为true。

data

1 name=choice kind:data type:str class:<class ‘click.types.Choice’>

method

2 convert(

kind=method class=Choice objtype=function line:267 at …\lib\site-packages\click\types.py

3 get_metavar(self, param: “Parameter”) -> str:

kind=method class=Choice objtype=function line:254 at …\lib\site-packages\click\types.py

4 get_missing_message(self, param: “Parameter”) -> str:

kind=method class=Choice objtype=function line:264 at …\lib\site-packages\click\types.py

5 shell_complete(

kind=method class=Choice objtype=function line:308 at …\lib\site-packages\click\types.py

以不完整值开头的完整选项。:param ctx:该命令的调用上下文。:param param:请求补全的参数。:param incomplete:	正在完成的值。可能是空的。版本增加： 8.0

6 to_info_dict(self) -> t.Dict[str, t.Any]:

kind=method class=Choice objtype=function line:248 at …\lib\site-packages\click\types.py

🌿64 click.types.DateTime

DateTime, click.types.DateTime, module=click.types, line:332 at site-packages\click\types.py

DateTime类型将日期字符串转换为`DateTime`对象。被检查的格式字符串是可配置的，但默认为一些常见的(非时区感知的)ISO 8601格式。当指定*DateTime*格式时，您应该只传递一个列表或元组。其他可迭代对象，如生成器，可能会导致令人惊讶的结果。使用``datetime.strptime``处理格式字符串，因此定义了允许的格式字符串。按顺序使用每种格式尝试解析，并使用第一个解析成功的格式。:param formats:     日期格式字符串的列表或元组，按照应该尝试的顺序排列。默认为``%Y-%m-%d'``, ``%Y-%m-%dT%H:%M:%S'``, ``%Y-%m-%d %H:%M:%S'``。

data

1 name=datetime kind:data type:str class:<class ‘click.types.DateTime’>

method

2 convert(

kind=method class=DateTime objtype=function line:372 at …\lib\site-packages\click\types.py

3 get_metavar(self, param: “Parameter”) -> str:

kind=method class=DateTime objtype=function line:363 at …\lib\site-packages\click\types.py

4 to_info_dict(self) -> t.Dict[str, t.Any]:

kind=method class=DateTime objtype=function line:358 at …\lib\site-packages\click\types.py

🌿65 click.types.File

File, click.types.File, module=click.types, line:637 at site-packages\click\types.py

将参数声明为可读或可写的文件。一旦上下文关闭(在命令完成工作之后)，该文件将自动关闭。文件可以打开以进行读写。特殊值 ``-`` 表示取决于模式的标准输入或标准输出。默认情况下，打开该文件是为了读取文本数据，但也可以以二进制模式打开或用于写入。encoding参数可用于强制使用特定编码。`lazy`标志控制文件是应该立即打开还是在第一次IO时打开。对于标准输入和输出流以及为读取而打开的文件，默认为非惰性，否则为`lazy`。当惰性打开文件进行读取时，它仍然被暂时打开以进行验证，但直到第一次IO之前不会保持打开状态。Lazy主要用于打开并写入文件，以避免在需要之前创建文件。从Click 2.0开始，文件也可以自动打开，在这种情况下，所有写操作都将进入同一文件夹中的单独文件，完成后，文件将移动到原始位置。如果其他用户经常读取的文件被修改，这很有用。参见:ref:`file-args`了解更多信息。

data

1 envvar_list_splitter=; kind:data type:str class:<class ‘click.types.File’>
2 name=filename kind:data type:str class:<class ‘click.types.File’>

method

3 convert(

kind=method class=File objtype=function line:695 at …\lib\site-packages\click\types.py

4 resolve_lazy_flag(self, value: t.Any) -> bool:

kind=method class=File objtype=function line:686 at …\lib\site-packages\click\types.py

5 shell_complete(

kind=method class=File objtype=function line:736 at …\lib\site-packages\click\types.py

返回一个特殊的完成标记，告诉完成系统使用shell来提供文件路径完成。:param ctx:该命令的调用上下文。:param param:请求补全的参数。:param incomplete:	正在完成的值。可能是空的。版本增加： 8.0

6 to_info_dict(self) -> t.Dict[str, t.Any]:

kind=method class=File objtype=function line:681 at …\lib\site-packages\click\types.py

🌿66 click.types.FloatRange

FloatRange, click.types.FloatRange, module=click.types, line:545 at site-packages\click\types.py

限制:data:`click.FLOAT`值为可接受的值范围。参见:ref:`ranges`。如果没有传递``min``或``max``，则在该方向上接受任何值。如果启用了 ``min_open``  或 ``max_open``，则相应的边界不包括在范围内。如果启用了``clamp``，则范围外的值将被固定到边界上，而不是失败。如果任何一个边界标记为``open``，则不支持此操作。版本变更： 8.0   增加了``min_open``  或 ``max_open``参数。

data

1 name=float range kind:data type:str class:<class ‘click.types.FloatRange’>

🌿67 click.types.IntRange

IntRange, click.types.IntRange, module=click.types, line:511 at site-packages\click\types.py

限制:data:`click.FLOAT`值为可接受的值范围。参见:ref:`ranges`。如果没有传递``min``或``max``，则在该方向上接受任何值。如果启用了 ``min_open``  或 ``max_open``，则相应的边界不包括在范围内。如果启用了``clamp``，则范围外的值将被固定到边界上，而不是失败。如果任何一个边界标记为``open``，则不支持此操作。版本变更： 8.0   增加了``min_open``  或 ``max_open``参数。

data

1 name=integer range kind:data type:str class:<class ‘click.types.IntRange’>

🌿68 click.types.ParamType

ParamType, click.types.ParamType, module=click.types, line:22 at site-packages\click\types.py

表示参数的类型。验证命令行或Python中的值并将其转换为正确的类型。要实现自定义类型，必须创建子类并至少实现以下内容:-必须设置:attr:`name`类属性。-使用 `None`调用类型的实例必须返回 `None`。这在默认情况下已经实现了。-:meth:`convert`必须将字符串值转换为正确的类型。-:meth:`convert`必须接受已经是正确类型的值。-如果``ctx``和``param``参数为``None``，则必须能够转换值。在转换提示输入时可能发生这种情况。

data

1 arity=1 kind:data type:int class:<class ‘click.types.ParamType’>
2 envvar_list_splitter=None kind:data type:NoneType class:<class ‘click.types.ParamType’>
3 is_composite=False kind:data type:bool class:<class ‘click.types.ParamType’>

method

4 convert(

kind=method class=ParamType objtype=function line:94 at …\lib\site-packages\click\types.py

将值转换为正确的类型。如果值为``None``(缺失值)，则不会调用该函数。它必须接受来自命令行的字符串值，以及已经是正确类型的值。它还可以转换其他兼容类型。:param value:   要转换的值。:param param:   使用该类型转换其值的参数。可能是``None``。:param ctx:     到达此值的当前上下文。可能是``None``。

5 fail(

kind=method class=ParamType objtype=function line:128 at …\lib\site-packages\click\types.py

Helper方法因无效值消息而失败。

6 get_metavar(self, param: “Parameter”) -> t.Optional[str]:

kind=method class=ParamType objtype=function line:84 at …\lib\site-packages\click\types.py

如果此参数提供了默认元变量，则返回该参数的默认元变量。

7 get_missing_message(self, param: “Parameter”) -> t.Optional[str]:

kind=method class=ParamType objtype=function line:87 at …\lib\site-packages\click\types.py

可选地返回关于缺失参数的额外信息。	
版本增加： 2.0

8 shell_complete(

kind=method class=ParamType objtype=function line:137 at …\lib\site-packages\click\types.py

返回不完整值的补全列表。查看选项和链接的多命令的名称。:param ctx:该命令的调用上下文。:param incomplete:	正在完成的值。可能是空的。版本增加： 8.0

9 split_envvar_value(self, rv: str) -> t.Sequence[str]:

kind=method class=ParamType objtype=function line:118 at …\lib\site-packages\click\types.py

给定一个来自环境变量的值，它将根据定义的envvar列表分割器将其分割成小块。
如果分隔符设置为 `None`，这意味着空格分隔，则忽略前导和尾随空格。
否则，前导和尾随分隔符通常会导致包含空项。

10 to_info_dict(self) -> t.Dict[str, t.Any]:

kind=method class=ParamType objtype=function line:54 at …\lib\site-packages\click\types.py

收集可能对生成面向用户文档的工具有用的信息。
使用 :meth:`click.Context.to_info_dict`遍历整个CLI结构。	
版本增加： 8.0

🌿69 click.types.Path

Path, click.types.Path, module=click.types, line:753 at site-packages\click\types.py

``Path``类型类似于:class:`File`类型，但返回文件名而不是打开的文件。可以启用各种检查来验证文件类型和权限。:param exists:      文件或目录必须存在，该值才有效。如果该值未设置为``True``，并且该文件不存在，则所有进一步的检查都将被静默跳过。:param file_okay:   允许文件作为值。:param dir_okay:    允许一个目录作为值。:param readable:    如果为true，则执行可读检查。:param writable:    如果为true，则执行可写检查。:param executable:  如果为true，则执行可执行检查。:param resolve_path:    将值设为absolute并解析任何符号链接。``~ ``不会展开，因为这应该只由shell完成。:param allow_dash:    允许一个破折号作为值，它表示一个标准流(但不打开它)。使用:func:`~click.open_file`来处理这个值。:param path_type:   将传入的路径值转换为该类型。如果``None``，则保持Python的默认值``str``。转换为:class:`pathlib.Path`很有用。版本变更： 8.1   增加了``executable``参数。版本变更： 8.0   允许传入`type=pathlib.Path`版本变更： 6.0   增加了``allow dash``参数。

data

1 envvar_list_splitter=; kind:data type:str class:<class ‘click.types.Path’>

method

2 coerce_path_result(self, rv: t.Any) -> t.Any:

kind=method class=Path objtype=function line:829 at …\lib\site-packages\click\types.py

3 convert(

kind=method class=Path objtype=function line:840 at …\lib\site-packages\click\types.py

4 shell_complete(

kind=method class=Path objtype=function line:914 at …\lib\site-packages\click\types.py

返回一个特殊的补全标记，告诉补全系统使用shell只为目录或任何路径提供路径补全。:param ctx:     该命令的调用上下文。:param param:   请求补全的参数。:param incomplete:   正在完成的值。可能是空的。
版本增加： 8.0

5 to_info_dict(self) -> t.Dict[str, t.Any]:

kind=method class=Path objtype=function line:817 at …\lib\site-packages\click\types.py

🌿70 click.types.Tuple

Tuple, click.types.Tuple, module=click.types, line:933 at site-packages\click\types.py

Click的默认行为是直接对值应用类型。
这在大多数情况下都很有效，除非将`nargs`设置为固定计数，并且应该为不同的项目使用不同的类型。
在这种情况下，可以使用:class:`Tuple`类型。
此类型只能在`nargs`被设置为固定数字时使用。
有关更多信息，请参阅 :ref:`tuple-type`。这可以通过使用Python元组文字作为类型来选择。:param types:   应该用于元组项的类型列表。

property

1 arity=<property object at 0x0000022046416048> kind:property type:property class:<class ‘click.types.Tuple’>
2 name=<property object at 0x0000022046410F48> kind:property type:property class:<class ‘click.types.Tuple’>

method

3 convert(

kind=method class=Tuple objtype=function line:963 at …\lib\site-packages\click\types.py

4 to_info_dict(self) -> t.Dict[str, t.Any]:

kind=method class=Tuple objtype=function line:950 at …\lib\site-packages\click\types.py

🔵私有或局部

71 _winconsole <module ‘click._winconsolefrom…\lib\site-packages\click\_winconsole.py’>
72 _compat <module ‘click._compatfrom…\lib\site-packages\click\_compat.py’>

🔵剩余

73 loader <_frozen_importlib_external.SourceFileLoader object at 0x0000022046321208>
74 spec ModuleSpec(name=‘click’, loader=<_frozen_importlib_external.SourceFileLoader object at 0x0000022046321208>, origin=‘…\lib\site-packages\click\init.py’, submodule_search_locations=[‘…\lib\site-packages\click’])
75 BOOL BOOL
76 FLOAT FLOAT
77 INT INT
78 STRING STRING
79 UNPROCESSED UNPROCESSED
80 UUID UUID

☘️【click._winconsole】

_winconsole, fullname=click._winconsole, file=click_winconsole.py

☘️【click._compat】

_compat, fullname=click._compat, file=click_compat.py

☘️【click.globals】

globals, fullname=click.globals, file=click\globals.py

🔵统计

序号	类别	数量
4	str	4
8	dict	1
9	module	1
10	class	1
11	function	4
13	residual	4
14	system	8
15	private	1
16	all	15

🔵常量

🔵模块

🌿1 typing

typing, fullname=typing, file=typing.py

🔵函数

🌿2 get_current_context(silent: bool = False) -> Union[ForwardRef(‘Context’), NoneType]

get_current_context(silent: bool = False) -> Union[ForwardRef(‘Context’), NoneType], module=click.globals, line:21 at site-packages\click\globals.py

返回当前单击上下文。
这可以用作从任何地方访问当前上下文对象的一种方式。
这是对 :func:`pass_context` 装饰器的一种更隐式的替代。
此函数主要用于:func:`echo`等helper，这些helper可能有兴趣根据当前上下文更改其行为。
要推送当前上下文，:meth:`Context.scope` 可以使用。版本增加： 5.0:param silent:  如果设置为 `True`，如果没有上下文可用，返回值为 `None`。默认行为是引发 :exc:`RuntimeError`。

🌿3 push_context(ctx: ‘Context’) -> None

push_context(ctx: ‘Context’) -> None, module=click.globals, line:45 at site-packages\click\globals.py

将新上下文推入当前堆栈。

🌿4 pop_context() -> None

pop_context() -> None, module=click.globals, line:50 at site-packages\click\globals.py

从堆栈中删除顶层。

🌿5 resolve_color_default(color: Union[bool, NoneType] = None) -> Union[bool, NoneType]

resolve_color_default(color: Union[bool, NoneType] = None) -> Union[bool, NoneType], module=click.globals, line:55 at site-packages\click\globals.py

获取颜色标志的默认值的内部帮助器。如果传递了一个值，它将原封不动地返回，否则将从当前上下文中查找。

🔵类

🌿6 _thread._local

_local, _thread._local, module=_thread, line:0 at

线程本地数据

🔵私有或局部

7 _local <_thread._local object at 0x000001AF3B6DAA68>

🔵剩余

8 doc
9 loader <_frozen_importlib_external.SourceFileLoader object at 0x000001AF3B6E0B88>
10 spec ModuleSpec(name=‘click.globals’, loader=<_frozen_importlib_external.SourceFileLoader object at 0x000001AF3B6E0B88>, origin=‘…\lib\site-packages\click\globals.py’)
11 _local <_thread._local object at 0x000001AF3B6DAA68>

☘️【click.utils】

utils, fullname=click.utils, file=click\utils.py

🔵统计

序号	类别	数量
2	bool	1
4	str	4
8	dict	3
9	module	4
10	class	4
11	function	22
13	residual	4
14	system	8
15	private	6
16	all	42

🔵常量

🌿bool

1 WIN True

🌿dict

2 binary_streams {‘stdin’: <function get_binary_stdin at 0x000001F7AC9A5318>, ‘stdout’: <function get_binary_stdout at 0x000001F7AC9A53A8…
3 text_streams {‘stdin’: <function get_text_stdin at 0x000001F7AC9A54C8>, ‘stdout’: <function get_text_stdout at 0x000001F7AC9A5558>, '…

🔵模块

🌿4 os

os, fullname=os, file=os.py

🌿5 re

re, fullname=re, file=re.py

🌿6 sys

sys, fullname=sys

🌿7 typing

typing, fullname=typing, file=typing.py

🔵函数

🌿8 update_wrapper(wrapper, wrapped, assigned=(‘module’, ‘name’, ‘qualname’, ‘doc’, ‘annotations’), updated=(‘dict’,))

update_wrapper(wrapper, wrapped, assigned=(‘module’, ‘name’, ‘qualname’, ‘doc’, ‘annotations’), updated=(‘dict’,)), module=functools, line:37 at functools.py

更新包装器函数使其看起来像被包装的函数。
包装器是要更新的函数。包装器是分配的原始函数。
包装器是一个元组，命名从包装函数直接分配给包装器函数的属性(默认为 functools.WRAPPER_ASSIGNMENTS))是一个命名包装器属性的元组，
这些属性是用包装函数(默认为 functools.WRAPPER_UPDATES)

🌿9 func() -> <class ‘TextIO’>

func() -> <class ‘TextIO’>, module=click._compat, line:591 at site-packages\click_compat.py

🌿10 func() -> <class ‘TextIO’>

func() -> <class ‘TextIO’>, module=click._compat, line:591 at site-packages\click_compat.py

🌿11 _find_binary_writer(stream: <class ‘IO’>) -> Union[BinaryIO, NoneType]

_find_binary_writer(stream: <class ‘IO’>) -> Union[BinaryIO, NoneType], module=click._compat, line:196 at site-packages\click_compat.py

🌿12 auto_wrap_for_ansi(stream: <class ‘TextIO’>, color: Union[bool, NoneType] = None) -> <class ‘TextIO’>

auto_wrap_for_ansi(stream: <class ‘TextIO’>, color: Union[bool, NoneType] = None) -> <class ‘TextIO’>, module=click._compat, line:527 at site-packages\click_compat.py

在Windows上通过使用colorama包装流来支持ANSI颜色和样式代码。

🌿13 get_filesystem_encoding() -> str

get_filesystem_encoding() -> str, module=click._compat, line:20 at site-packages\click_compat.py

🌿14 open_stream(filename: str, mode: str = ‘r’, encoding: Union[str, NoneType] = None, errors: Union[str, NoneType] = ‘strict’, atomic: bool = False) -> Tuple[IO, bool]

open_stream(filename: str, mode: str = ‘r’, encoding: Union[str, NoneType] = None, errors: Union[str, NoneType] = ‘strict’, atomic: bool = False) -> Tuple[IO, bool], module=click._compat, line:382 at site-packages\click_compat.py

🌿15 should_strip_ansi(stream: Union[IO, NoneType] = None, color: Union[bool, NoneType] = None) -> bool

should_strip_ansi(stream: Union[IO, NoneType] = None, color: Union[bool, NoneType] = None) -> bool, module=click._compat, line:504 at site-packages\click_compat.py

🌿16 strip_ansi(value: str) -> str

strip_ansi(value: str) -> str, module=click._compat, line:493 at site-packages\click_compat.py

🌿17 resolve_color_default(color: Union[bool, NoneType] = None) -> Union[bool, NoneType]

resolve_color_default(color: Union[bool, NoneType] = None) -> Union[bool, NoneType], module=click.globals, line:55 at site-packages\click\globals.py

获取颜色标志的默认值的内部帮助器。如果传递了一个值，它将原封不动地返回，否则将从当前上下文中查找。

🌿18 _posixify(name: str) -> str

_posixify(name: str) -> str, module=click.utils, line:27 at site-packages\click\utils.py

🌿19 safecall(func: ~F) -> ~F

safecall(func: ~F) -> ~F, module=click.utils, line:31 at site-packages\click\utils.py

包装一个函数，使其能够吞下异常。

🌿20 make_str(value: Any) -> str

make_str(value: Any) -> str, module=click.utils, line:43 at site-packages\click\utils.py

将值转换为有效字符串。

🌿21 make_default_short_help(help: str, max_length: int = 45) -> str

make_default_short_help(help: str, max_length: int = 45) -> str, module=click.utils, line:53 at site-packages\click\utils.py

返回帮助字符串的精简版本。

🌿22 echo(message: Union[Any, NoneType] = None, file: Union[IO[Any], NoneType] = None, nl: bool = True, err: bool = False, color: Union[bool, NoneType] = None) -> None

echo(message: Union[Any, NoneType] = None, file: Union[IO[Any], NoneType] = None, nl: bool = True, err: bool = False, color: Union[bool, NoneType] = None) -> None, module=click.utils, line:205 at site-packages\click\utils.py

将消息和换行符打印到标准输出或文件。这应该用来代替:func:`print`，因为它可以更好地支持不同的数据、文件和环境。与:func:`print`相比，它做了以下事情:-确保在Linux上没有错误配置输出编码。-在Windows控制台中支持Unicode。-支持写入二进制输出，支持写入字节到文本输出。-支持Windows上的颜色和样式。-如果输出看起来不像交互式终端，则删除ANSI颜色和样式代码。-总是刷新输出。:param message: 要输出的字符串或字节。其他对象被转换为字符串。:param file:    要写入的文件。默认为``stdout``。:param err:     写入``stderr``而不是``stdout``。:param nl:  在消息后打印换行符。默认开启。:param color:       强制显示或隐藏颜色和其他样式。默认情况下，如果输出看起来不像交互式终端，Click将删除颜色。版本变更：   6.0 支持Windows控制台上的Unicode输出。单击不修改``sys``。stdout``，所以``sys.stdout.write()``和``print() ``仍然不支持Unicode。版本变更：   4.0 增加了``color``参数。版本增加： 3.0   增加``err``参数。版本变更： 2.0如果安装了colorama，则支持Windows上的颜色。

🌿23 get_binary_stream(name: “te.Literal[‘stdin’, ‘stdout’, ‘stderr’]”) -> <class ‘BinaryIO’>

get_binary_stream(name: “te.Literal[‘stdin’, ‘stdout’, ‘stderr’]”) -> <class ‘BinaryIO’>, module=click.utils, line:303 at site-packages\click\utils.py

返回用于字节处理的系统流。
:param name:要打开的流的名称。有效的名称是``stdin'``、``stdout'``和 ``stderr'``

🌿24 get_text_stream(name: “te.Literal[‘stdin’, ‘stdout’, ‘stderr’]”, encoding: Union[str, NoneType] = None, errors: Union[str, NoneType] = ‘strict’) -> <class ‘TextIO’>

get_text_stream(name: “te.Literal[‘stdin’, ‘stdout’, ‘stderr’]”, encoding: Union[str, NoneType] = None, errors: Union[str, NoneType] = ‘strict’) -> <class ‘TextIO’>, module=click.utils, line:315 at site-packages\click\utils.py

返回用于文本处理的系统流。这通常会返回一个围绕:func:`get binary stream`返回的二进制流的包装流，但它也可以为已经正确配置的流采取快捷方式。:param name:        要打开的流的名称。有效的名称是``stdin````，``stdout````和``stderr``:param encoding:    覆盖检测到的默认编码。:param errors:      覆盖默认的错误模式。

🌿25 open_file(filename: str, mode: str = ‘r’, encoding: Union[str, NoneType] = None, errors: Union[str, NoneType] = ‘strict’, lazy: bool = False, atomic: bool = False) -> <class ‘IO’>

open_file(filename: str, mode: str = ‘r’, encoding: Union[str, NoneType] = None, errors: Union[str, NoneType] = ‘strict’, lazy: bool = False, atomic: bool = False) -> <class ‘IO’>, module=click.utils, line:336 at site-packages\click\utils.py

打开一个文件，使用额外的行为来处理``-'``来指示标准流，写时延迟打开和原子写。类似于:class:`~click的行为。文件参数类型。如果``-'``被指定为打开``stdout``或 ``stdin``，则流将被包装，以便在上下文管理器中使用它不会关闭它。这样就可以在不意外关闭标准流的情况下使用该函数:代码块:with open_file(filename) as f:...:param filename:    要打开的文件的名称，或者``stdin`` / ``stdout`` ``-'``。:param mode:    打开文件的模式。:param encoding:    对以文本方式打开的文件进行解码或编码的编码。:param errors:  错误处理方式。:param lazy:    等待打开文件，直到它被访问。对于读模式，文件被临时打开以提前引发访问错误，然后关闭，直到再次读取。:param atomic:  写入临时文件，并在关闭时替换给定的文件。版本增加： 3.0

🌿26 format_filename(filename: Union[str, bytes, os.PathLike], shorten: bool = False) -> str

format_filename(filename: Union[str, bytes, os.PathLike], shorten: bool = False) -> str, module=click.utils, line:383 at site-packages\click\utils.py

为用户显示格式化文件名。
这个函数的主要目的是确保文件名可以被显示。
这将在必要时以一种不会失败的方式将文件名解码为unicode。
可选地，它可以缩短文件名以不包含文件名的完整路径。:param filename:    格式化UI显示的文件名。这也会将文件名转换为unicode而不会失败。:param shorten: 这可选地将文件名缩短为指向它的路径的条带。

🌿27 get_app_dir(app_name: str, roaming: bool = True, force_posix: bool = False) -> str

get_app_dir(app_name: str, roaming: bool = True, force_posix: bool = False) -> str, module=click.utils, line:403 at site-packages\click\utils.py

返回应用程序的配置文件夹。默认行为是返回最适合操作系统的内容。为了给你一个想法，对于一个名为``Foo Bar``的应用程序，可以返回如下文件夹:Mac OS X:``~/Library/Application Support/Foo Bar``Mac OS X (POSIX):``~/.foo-bar``Unix:``~/.config/foo-bar``Unix (POSIX):``~/.foo-bar``Windows (roaming):``C:\Users\<user>\AppData\Roaming\Foo Bar``Windows (not roaming):``C:\Users\<user>\AppData\Local\Foo Bar``版本增加： 2.0:param app_name:    应用程序名称。它应该正确地大写，并且可以包含空格。:param roaming:     控制文件夹在Windows上是否应该漫游。没有其他影响。:param force posix: 如果这被设置为``True``，那么在任何posix系统上，文件夹将存储在主文件夹中，并带有一个前导点，而不是XDG配置主页或达尔文的应用程序支持文件夹。

🌿28 _detect_program_name(path: Union[str, NoneType] = None, _main: Union[module, NoneType] = None) -> str

_detect_program_name(path: Union[str, NoneType] = None, _main: Union[module, NoneType] = None) -> str, module=click.utils, line:477 at site-packages\click\utils.py

确定用于运行程序的命令，以用于帮助文本。如果执行了文件或入口点，则返回文件名。如果``python -m``用于执行模块或包，则返回``python -m name``。这并不是要太精确，目标是为帮助文本提供一个简洁的名称。文件只显示其名称而不显示路径。``python``只在模块中显示，``sys.executable`` 没有显示。param path: 正在执行的Python文件。Python把它放在``sys.argv[0]``，默认使用``__main__``模块。这只能在内部测试中通过。版本增加： 8.0   基于Werkzeug reloader中的命令args检测。:meta private: 元私有。

🌿29 _expand_args(args: Iterable[str], *, user: bool = True, env: bool = True, glob_recursive: bool = True) -> List[str]

_expand_args(args: Iterable[str], *, user: bool = True, env: bool = True, glob_recursive: bool = True) -> List[str], module=click.utils, line:531 at site-packages\click\utils.py

用Python函数模拟Unix shell扩展。参见 :func:`glob.glob`, :func:`os.path.expanduser` 和 :func:`os.path.expandvars`。这是在Windows上使用的，shell不做任何扩展。它可能与Unix shell的功能不完全匹配。:param args:    要展开的命令行参数列表。:param user:    展开用户主目录。:param env: 展开环境变量。:param glob_recursive: ``**``递归匹配目录。版本变更： 8.1   无效的glob模式被视为空展开，而不是引发错误。版本增加： 8.0:meta private:

🔵类

🌿30 module

module, module, module=builtins, line:0 at

创建模块对象。名称必须是字符串;可选的doc参数可以是任何类型。

🌿31 click.utils.LazyFile

LazyFile, click.utils.LazyFile, module=click.utils, line:103 at site-packages\click\utils.py

惰性文件的工作方式与常规文件类似，但它不会完全打开文件，但它会提前执行一些基本检查，以查看filename参数是否有意义。这对于安全地打开文件进行写入非常有用。

method

1 close(self) -> None:

kind=method class=LazyFile objtype=function line:162 at …\lib\site-packages\click\utils.py

关闭底层文件，无论如何。

2 close_intelligently(self) -> None:

kind=method class=LazyFile objtype=function line:167 at …\lib\site-packages\click\utils.py

此函数仅在惰性文件包装器打开文件时关闭该文件。例如，这将永远不会关闭stdin。

3 open(self) -> t.IO:

kind=method class=LazyFile objtype=function line:144 at …\lib\site-packages\click\utils.py

如果文件尚未打开，则打开该文件。此调用可能会因:exc:`FileError`而失败。不处理此错误将产生Click显示的错误。

🌿32 click.utils.KeepOpenFile

KeepOpenFile, click.utils.KeepOpenFile, module=click.utils, line:185 at site-packages\click\utils.py

🌿33 click.utils.PacifyFlushWrapper

PacifyFlushWrapper, click.utils.PacifyFlushWrapper, module=click.utils, line:452 at site-packages\click\utils.py

此包装器用于捕获和抑制在Python解释器关闭/final-GC期间在损坏的管道上调用``.flush()``导致的BrokenPipeErrors。
值得注意的是，``.flush()``总是在``sys.Stdout``和``sys.stderr``。
为了将对任何其他清理代码的影响降到最低，并且在底层文件不是损坏的管道的情况下，所有调用和属性都被代理。

method

1 flush(self) -> None:

kind=method class=PacifyFlushWrapper objtype=function line:464 at …\lib\site-packages\click\utils.py

🔵私有或局部

34 _default_text_stderr <function _make_cached_stream_func..func at 0x000001F7AC9D15E8>
35 _default_text_stdout <function _make_cached_stream_func..func at 0x000001F7AC9D11F8>
36 _find_binary_writer <function _find_binary_writer at 0x000001F7AC9A1EE8>
37 _posixify <function _posixify at 0x000001F7AC9EBC18>
38 _detect_program_name <function _detect_program_name at 0x000001F7AC9F5798>
39 _expand_args <function _expand_args at 0x000001F7AC9F59D8>

🔵剩余

40 doc
41 loader <_frozen_importlib_external.SourceFileLoader object at 0x000001F7AC9E8208>
42 spec ModuleSpec(name=‘click.utils’, loader=<_frozen_importlib_external.SourceFileLoader object at 0x000001F7AC9E8208>, origin=‘…\lib\site-packages\click\utils.py’)
43 F ~F

☘️【click.exceptions】

exceptions, fullname=click.exceptions, file=click\exceptions.py

☘️【click.exceptions】

exceptions, fullname=click.exceptions, file=click\exceptions.py

🔵统计

序号	类别	数量
4	str	4
8	dict	1
9	module	2
10	class	10
11	function	5
13	residual	3
14	system	8
15	private	2
16	all	25

🔵常量

🔵模块

🌿1 os

os, fullname=os, file=os.py

🌿2 typing

typing, fullname=typing, file=typing.py

🔵函数

🌿3 gettext(message)

gettext(message), module=gettext, line:624 at gettext.py

🌿4 ngettext(msgid1, msgid2, n)

ngettext(msgid1, msgid2, n), module=gettext, line:630 at gettext.py

🌿5 get_text_stderr(encoding: Union[str, NoneType] = None, errors: Union[str, NoneType] = None) -> <class ‘TextIO’>

get_text_stderr(encoding: Union[str, NoneType] = None, errors: Union[str, NoneType] = None) -> <class ‘TextIO’>, module=click._compat, line:360 at site-packages\click_compat.py

🌿6 echo(message: Union[Any, NoneType] = None, file: Union[IO[Any], NoneType] = None, nl: bool = True, err: bool = False, color: Union[bool, NoneType] = None) -> None

echo(message: Union[Any, NoneType] = None, file: Union[IO[Any], NoneType] = None, nl: bool = True, err: bool = False, color: Union[bool, NoneType] = None) -> None, module=click.utils, line:205 at site-packages\click\utils.py

将消息和换行符打印到标准输出或文件。这应该用来代替:func:`print`，因为它可以更好地支持不同的数据、文件和环境。与:func:`print`相比，它做了以下事情:-确保在Linux上没有错误配置输出编码。-在Windows控制台中支持Unicode。-支持写入二进制输出，支持写入字节到文本输出。-支持Windows上的颜色和样式。-如果输出看起来不像交互式终端，则删除ANSI颜色和样式代码。-总是刷新输出。:param message: 要输出的字符串或字节。其他对象被转换为字符串。:param file:    要写入的文件。默认为``stdout``。:param err:     写入``stderr``而不是``stdout``。:param nl:  在消息后打印换行符。默认开启。:param color:       强制显示或隐藏颜色和其他样式。默认情况下，如果输出看起来不像交互式终端，Click将删除颜色。版本变更：   6.0 支持Windows控制台上的Unicode输出。单击不修改``sys``。stdout``，所以``sys.stdout.write()``和``print() ``仍然不支持Unicode。版本变更：   4.0 增加了``color``参数。版本增加： 3.0   增加``err``参数。版本变更： 2.0如果安装了colorama，则支持Windows上的颜色。

🌿7 _join_param_hints(param_hint: Union[Sequence[str], str, NoneType]) -> Union[str, NoneType]

_join_param_hints(param_hint: Union[Sequence[str], str, NoneType]) -> Union[str, NoneType], module=click.exceptions, line:14 at site-packages\click\exceptions.py

🔵类

🌿8 click.exceptions.ClickException

ClickException, click.exceptions.ClickException, module=click.exceptions, line:23 at site-packages\click\exceptions.py

Click可以处理并显示给用户的异常。

data

1 exit_code=1 kind:data type:int class:<class ‘click.exceptions.ClickException’>

method

2 format_message(self) -> str:

kind=method class=ClickException objtype=function line:33 at …\lib\site-packages\click\exceptions.py

3 show(self, file: t.Optional[t.IO] = None) -> None:

kind=method class=ClickException objtype=function line:39 at …\lib\site-packages\click\exceptions.py

🌿9 click.exceptions.UsageError

UsageError, click.exceptions.UsageError, module=click.exceptions, line:46 at site-packages\click\exceptions.py

发出使用错误信号的内部异常。这通常会中止任何进一步的处理。
:param message:显示的错误信息。
:param ctx:可选的导致此错误的上下文。在某些情况下，单击将自动填充上下文。

data

1 exit_code=2 kind:data type:int class:<class ‘click.exceptions.UsageError’>

method

2 show(self, file: t.Optional[t.IO] = None) -> None:

kind=method class=UsageError objtype=function line:62 at …\lib\site-packages\click\exceptions.py

🌿10 click.exceptions.BadParameter

BadParameter, click.exceptions.BadParameter, module=click.exceptions, line:85 at site-packages\click\exceptions.py

格式化错误参数的标准化错误消息的异常。当从回调或类型抛出时，这很有用，因为Click会将上下文信息附加到它(例如，它是哪个参数)。版本增加： 2.0:param param: 导致此错误的参数对象。这可以被遗漏，如果可能的话，点击将附加此信息本身。:param param_hint:  作为参数名显示的字符串。在需要进行自定义验证的情况下，这可以作为``param``的替代。如果它是一个字符串，那么它就是这样使用的，如果它是一个列表，那么每个项都被引用并分开。

method

1 format_message(self) -> str:

kind=method class=BadParameter objtype=function line:114 at …\lib\site-packages\click\exceptions.py

🌿11 click.exceptions.MissingParameter

MissingParameter, click.exceptions.MissingParameter, module=click.exceptions, line:127 at site-packages\click\exceptions.py

如果click需要一个选项或参数，但在调用脚本时没有提供，则会被引发。	
版本增加： 4.0
:param param type:参数类型的字符串。默认是从给定的`param`继承参数类型。有效值是``parameter'``,``option'`` 或 ``argument'``。

method

1 format_message(self) -> str:

kind=method class=MissingParameter objtype=function line:150 at …\lib\site-packages\click\exceptions.py

🌿12 click.exceptions.NoSuchOption

NoSuchOption, click.exceptions.NoSuchOption, module=click.exceptions, line:196 at site-packages\click\exceptions.py

如果click试图处理一个不存在的选项，将被引发。	
版本增加： 4.0

method

1 format_message(self) -> str:

kind=method class=NoSuchOption objtype=function line:217 at …\lib\site-packages\click\exceptions.py

🌿13 click.exceptions.BadOptionUsage

BadOptionUsage, click.exceptions.BadOptionUsage, module=click.exceptions, line:230 at site-packages\click\exceptions.py

如果通常提供了一个选项，但该选项的使用不正确，则会引发。
例如，如果选项的参数数量不正确，则会引发此问题。	
版本增加： 4.0
:param option_name:被错误使用的选项名。

🌿14 click.exceptions.BadArgumentUsage

BadArgumentUsage, click.exceptions.BadArgumentUsage, module=click.exceptions, line:247 at site-packages\click\exceptions.py

如果通常提供了一个参数，但该参数的使用不正确，则会引发。
例如，如果参数的值数量不正确，则会引发此问题。	
版本增加： 6.0

🌿15 click.exceptions.FileError

FileError, click.exceptions.FileError, module=click.exceptions, line:256 at site-packages\click\exceptions.py

当文件无法打开时引发。

method

1 format_message(self) -> str:

kind=method class=FileError objtype=function line:267 at …\lib\site-packages\click\exceptions.py

🌿16 click.exceptions.Abort

Abort, click.exceptions.Abort, module=click.exceptions, line:273 at site-packages\click\exceptions.py

内部信号异常，指示单击终止。

🌿17 click.exceptions.Exit

Exit, click.exceptions.Exit, module=click.exceptions, line:277 at site-packages\click\exceptions.py

指示应用程序应使用某些状态码退出的异常。
:param code:要退出的状态码。

data

1 exit_code=<member ‘exit_codeofExit’ objects> kind:data type:member_descriptor class:<class ‘click.exceptions.Exit’>

🔵私有或局部

18 _ <function gettext at 0x00000229B8CC5948>
19 _join_param_hints <function _join_param_hints at 0x00000229B8CD8C18>

☘️【click.types】

types, fullname=click.types, file=click\types.py

☘️【click.parser】

parser, fullname=click.parser, file=click\parser.py

这个模块最初主要是从stdlib的optparse模块复制粘贴过来的。详细解释见前。

🔵统计

序号	类别	数量
4	str	5
8	dict	1
9	module	1
10	class	9
11	function	6
13	residual	4
14	system	8
15	private	3
16	all	26

🔵常量

🔵模块

🌿1 typing

typing, fullname=typing, file=typing.py

🔵函数

🌿2 gettext(message)

gettext(message), module=gettext, line:624 at gettext.py

🌿3 ngettext(msgid1, msgid2, n)

ngettext(msgid1, msgid2, n), module=gettext, line:630 at gettext.py

🌿4 _unpack_args(args: Sequence[str], nargs_spec: Sequence[int]) -> Tuple[Sequence[Union[str, Sequence[Union[str, NoneType]], NoneType]], List[str]]

_unpack_args(args: Sequence[str], nargs_spec: Sequence[int]) -> Tuple[Sequence[Union[str, Sequence[Union[str, NoneType]], NoneType]], List[str]], module=click.parser, line:49 at site-packages\click\parser.py

给定一个参数的可迭代对象和一个nargs规范的可迭代对象，它返回一个元组，其中所有未打包的参数位于第一个索引，所有剩余的参数作为第二个索引。
nargs规范是应该消耗的参数数量，或者`-1`表示该位置应该吃掉所有剩余的参数。缺失的项目用``None``填充。

🌿5 split_opt(opt: str) -> Tuple[str, str]

split_opt(opt: str) -> Tuple[str, str], module=click.parser, line:109 at site-packages\click\parser.py

🌿6 normalize_opt(opt: str, ctx: Union[ForwardRef(‘Context’), NoneType]) -> str

normalize_opt(opt: str, ctx: Union[ForwardRef(‘Context’), NoneType]) -> str, module=click.parser, line:118 at site-packages\click\parser.py

🌿7 split_arg_string(string: str) -> List[str]

split_arg_string(string: str) -> List[str], module=click.parser, line:125 at site-packages\click\parser.py

使用 :func:`shlex.split`，但如果字符串不完整则不会失败。忽略缺少的右引号或不完整的转义序列，并按原样使用部分标记。代码段：split_arg_string("example 'my file")["example", "my file"]split_arg_string("example my\")["example", "my"]:param string: 要分割的字符串。

🔵类

🌿8 collections.deque

deque, collections.deque, module=collections, line:-1 at collections_init_.py

deque([iterable[， maxlen]]) -> deque object一个类似列表的序列，为其端点附近的数据访问进行了优化。

data

1 maxlen=<attribute ‘maxlenofcollections.deque’ objects> kind:data type:getset_descriptor class:<class ‘collections.deque’>

method

2 append()

kind=method class=deque objtype=method_descriptor

在deque的右侧添加一个元素。

3 appendleft()

kind=method class=deque objtype=method_descriptor

在deque的左侧添加一个元素。

4 clear()

kind=method class=deque objtype=method_descriptor

从deque中移除所有元素。

5 copy()

kind=method class=deque objtype=method_descriptor

返回deque的浅拷贝。

6 count()

kind=method class=deque objtype=method_descriptor

D.count(value) -> integer -返回value出现的次数

7 extend()

kind=method class=deque objtype=method_descriptor

用iterable中的元素扩展deque的右侧

8 extendleft()

kind=method class=deque objtype=method_descriptor

用iterable中的元素扩展deque的左侧

9 index()

kind=method class=deque objtype=method_descriptor

D.index(value， [start， [stop]]) -> integer -返回value的第一个索引。如果值不存在则引发ValueError。

10 insert()

kind=method class=deque objtype=method_descriptor

D.insert(index, object)——在索引之前插入对象

11 pop()

kind=method class=deque objtype=method_descriptor

移除并返回最右边的元素。

12 popleft()

kind=method class=deque objtype=method_descriptor

移除并返回最左边的元素。

13 remove()

kind=method class=deque objtype=method_descriptor

D.remove(value) -删除value的第一次出现。

14 reverse()

kind=method class=deque objtype=method_descriptor

D.reverse() -反向*IN PLACE*

15 rotate()

kind=method class=deque objtype=method_descriptor

将deque向右旋转n步(默认n=1)。如果n是负的，向左旋转。

🌿9 click.exceptions.BadArgumentUsage

BadArgumentUsage, click.exceptions.BadArgumentUsage, module=click.exceptions, line:247 at site-packages\click\exceptions.py

如果通常提供了一个参数，但该参数的使用不正确，则会引发。
例如，如果参数的值数量不正确，则会引发此问题。	
版本增加： 6.0

🌿10 click.exceptions.BadOptionUsage

BadOptionUsage, click.exceptions.BadOptionUsage, module=click.exceptions, line:230 at site-packages\click\exceptions.py

如果通常提供了一个选项，但该选项的使用不正确，则会引发。例如，如果选项的参数数量不正确，则会引发此问题。	
版本增加： 4.0
:param option_name:被错误使用的选项名。

🌿11 click.exceptions.NoSuchOption

NoSuchOption, click.exceptions.NoSuchOption, module=click.exceptions, line:196 at site-packages\click\exceptions.py

如果click试图处理一个不存在的选项，将被引发。	
版本增加： 4.0

method

1 format_message(self) -> str:

kind=method class=NoSuchOption objtype=function line:217 at …\lib\site-packages\click\exceptions.py

🌿12 click.exceptions.UsageError

UsageError, click.exceptions.UsageError, module=click.exceptions, line:46 at site-packages\click\exceptions.py

发出使用错误信号的内部异常。这通常会中止任何进一步的处理。
:param message:显示的错误信息。
:param ctx:可选的导致此错误的上下文。在某些情况下，单击将自动填充上下文。

data

1 exit_code=2 kind:data type:int class:<class ‘click.exceptions.UsageError’>

method

2 show(self, file: t.Optional[t.IO] = None) -> None:

kind=method class=UsageError objtype=function line:62 at …\lib\site-packages\click\exceptions.py

🌿13 click.parser.Option

Option, click.parser.Option, module=click.parser, line:159 at site-packages\click\parser.py

property

1 takes_value=<property object at 0x0000018B54B6F7C8> kind:property type:property class:<class ‘click.parser.Option’>

method

2 process(self, value: str, state: “ParsingState”) -> None:

kind=method class=Option objtype=function line:197 at …\lib\site-packages\click\parser.py

🌿14 click.parser.Argument

Argument, click.parser.Argument, module=click.parser, line:213 at site-packages\click\parser.py

method

1 process(

kind=method class=Argument objtype=function line:219 at …\lib\site-packages\click\parser.py

🌿15 click.parser.ParsingState

ParsingState, click.parser.ParsingState, module=click.parser, line:245 at site-packages\click\parser.py

🌿16 click.parser.OptionParser

OptionParser, click.parser.OptionParser, module=click.parser, line:253 at site-packages\click\parser.py

选项解析器是一个内部类，最终用于解析选项和参数。它是在optparse的基础上建模的，并提供了一个类似但大大简化的API。它通常不应直接用作高级Click类为您包装它。它的可扩展性不如optparse或argparse，因为它没有实现在更高级别上实现的特性(例如类型或默认值)。:param ctx: 可选 :class:`~click.Context`这个解析器应该使用。

method

1 add_argument(

kind=method class=OptionParser objtype=function line:316 at …\lib\site-packages\click\parser.py

向解析器添加名为`dest`的位置参数。`obj`可用于标识从解析器返回的顺序列表中的选项。

2 add_option(

kind=method class=OptionParser objtype=function line:291 at …\lib\site-packages\click\parser.py

向解析器添加一个名为`dest`的新选项。目标不是推断出来的(与optparse不同)，需要显式提供。
Action可以是 ``store``，`store const``，`append``，`append const``或 ``count``中的任何一个。
`obj`可用于标识从解析器返回的顺序列表中的选项。

3 parse_args(

kind=method class=OptionParser objtype=function line:326 at …\lib\site-packages\click\parser.py

解析位置参数并为已解析的选项和参数以及剩余参数返回``(values, args, order)``(如果有的话)。
顺序是在命令行中出现的对象列表。如果参数出现多次，它们也会被记忆多次。

🔵私有或局部

17 _ <function gettext at 0x0000018B54AE5948>
18 _flag_needs_value <object object at 0x0000018B53FB0EC0>
19 _unpack_args <function _unpack_args at 0x0000018B54B6C318>

🔵剩余

20 loader <_frozen_importlib_external.SourceFileLoader object at 0x0000018B54B68088>
21 spec ModuleSpec(name=‘click.parser’, loader=<_frozen_importlib_external.SourceFileLoader object at 0x0000018B54B68088>, origin=‘…\lib\site-packages\click\parser.py’)
22 V ~V
23 _flag_needs_value <object object at 0x0000018B53FB0EC0>

☘️【click.formatting】

formatting, fullname=click.formatting, file=click\formatting.py

🔵统计

序号	类别	数量
4	str	4
8	dict	2
9	module	1
10	class	1
11	function	8
13	residual	4
14	system	9
15	private	1
16	all	20

🔵常量

🔵模块

🌿1 typing

typing, fullname=typing, file=typing.py

🔵函数

🌿2 contextmanager(func)

contextmanager(func), module=contextlib, line:210 at contextlib.py

@contextmanager装饰器。典型用法:@contextmanagerdef some_generator(<arguments>):<setup>try:yield <value>finally:<cleanup>这使得这个:with some_generator(<arguments>) as <variable>:<body>等价于这个:<setup>try:<variable> = <value><body>finally:<cleanup>

🌿3 gettext(message)

gettext(message), module=gettext, line:624 at gettext.py

🌿4 term_len(x: str) -> int

term_len(x: str) -> int, module=click._compat, line:575 at site-packages\click_compat.py

🌿5 split_opt(opt: str) -> Tuple[str, str]

split_opt(opt: str) -> Tuple[str, str], module=click.parser, line:109 at site-packages\click\parser.py

🌿6 measure_table(rows: Iterable[Tuple[str, str]]) -> Tuple[int, …]

measure_table(rows: Iterable[Tuple[str, str]]) -> Tuple[int, …], module=click.formatting, line:12 at site-packages\click\formatting.py

🌿7 iter_rows(rows: Iterable[Tuple[str, str]], col_count: int) -> Iterator[Tuple[str, …]]

iter_rows(rows: Iterable[Tuple[str, str]], col_count: int) -> Iterator[Tuple[str, …]], module=click.formatting, line:22 at site-packages\click\formatting.py

🌿8 wrap_text(text: str, width: int = 78, initial_indent: str = ‘’, subsequent_indent: str = ‘’, preserve_paragraphs: bool = False) -> str

wrap_text(text: str, width: int = 78, initial_indent: str = ‘’, subsequent_indent: str = ‘’, preserve_paragraphs: bool = False) -> str, module=click.formatting, line:29 at site-packages\click\formatting.py

智能地包装文本的辅助函数。默认情况下，它假设它对单个文本段落进行操作，但如果提供了 `preserve_paragraphs` 参数，它将智能地处理段落(由两个空行定义)。如果处理段落，段落可以用包含``\b``字符(``\x08``)的空行作为前缀，以表明不应该在该块中重新包装。:param text:    应该重新换行的文本。:param width:   文本的最大宽度。:param initial_indent:  作为字符串放置在第一行的初始缩进。:param subsequent_indent:   应放置在每个连续行的缩进字符串。:param preserve_paragraphs:     如果设置了这个标志，那么自动换行将智能地处理段落。

🌿9 join_options(options: Sequence[str]) -> Tuple[str, bool]

join_options(options: Sequence[str]) -> Tuple[str, bool], module=click.formatting, line:283 at site-packages\click\formatting.py

给定一个选项字符串列表，它以最合适的方式将它们连接起来，并以 ``(formatted_string, any_prefix_is_slash)``的形式返回它们，
其中元组中的第二项是一个标志，表示是否有任何选项前缀是斜杠。

🔵类

🌿10 click.formatting.HelpFormatter

HelpFormatter, click.formatting.HelpFormatter, module=click.formatting, line:102 at site-packages\click\formatting.py

这个类帮助格式化基于文本的帮助页面。它通常只在非常特殊的内部情况下才需要，但它也被公开，以便开发人员可以编写自己的花哨输出。目前，它总是写入内存。:param indent_increment:    每层的额外增量。:param width:               文本的宽度。默认情况下，终端宽度箝位为78。

method

1 dedent(self) -> None:

kind=method class=HelpFormatter objtype=function line:141 at …\lib\site-packages\click\formatting.py

减少缩进。

2 getvalue(self) -> str:

kind=method class=HelpFormatter objtype=function line:278 at …\lib\site-packages\click\formatting.py

返回缓冲区内容。

3 indent(self) -> None:

kind=method class=HelpFormatter objtype=function line:137 at …\lib\site-packages\click\formatting.py

增加缩进。

4 indentation(self) -> t.Iterator[None]:

kind=method class=HelpFormatter objtype=function line:270 at …\lib\site-packages\click\formatting.py

增加缩进的上下文管理器。

5 section(self, name: str) -> t.Iterator[None]:

kind=method class=HelpFormatter objtype=function line:255 at …\lib\site-packages\click\formatting.py

有用的上下文管理器，用于编写段落、标题和缩进。:param name:    作为标题书写的节名。

6 write(self, string: str) -> None:

kind=method class=HelpFormatter objtype=function line:133 at …\lib\site-packages\click\formatting.py

将unicode字符串写入内部缓冲区。

7 write_dl(

kind=method class=HelpFormatter objtype=function line:210 at …\lib\site-packages\click\formatting.py

将定义列表写入缓冲区。选项和命令通常是这样格式化的。:param rows:包含两个项元组的列表，用于项和值。:param col_max:第一列的最大宽度。:param co_spacing:第一列和第二列之间的空格数。

8 write_heading(self, heading: str) -> None:

kind=method class=HelpFormatter objtype=function line:185 at …\lib\site-packages\click\formatting.py

将标题写入缓冲区。

9 write_paragraph(self) -> None:

kind=method class=HelpFormatter objtype=function line:189 at …\lib\site-packages\click\formatting.py

将一个段落写入缓冲区。

10 write_text(self, text: str) -> None:

kind=method class=HelpFormatter objtype=function line:194 at …\lib\site-packages\click\formatting.py

将重新缩进的文本写入缓冲区。这是对段落的重新包装和保留。

11 write_usage(

kind=method class=HelpFormatter objtype=function line:145 at …\lib\site-packages\click\formatting.py

将用法行写入缓冲区。
:param prog:程序名。
:param args:由空格分隔的参数列表。param prefix:第一行的前缀。默认为``"Usage: "``。

🔵私有或局部

11 _ <function gettext at 0x0000024669965948>

🔵剩余

12 doc
13 loader <_frozen_importlib_external.SourceFileLoader object at 0x000002466996DA48>
14 spec ModuleSpec(name=‘click.formatting’, loader=<_frozen_importlib_external.SourceFileLoader object at 0x000002466996DA48>, origin=‘…\lib\site-packages\click\formatting.py’)
15 FORCED_WIDTH

☘️【click.termui】

termui, fullname=click.termui, file=click\termui.py

🔵统计

序号	类别	数量
2	bool	1
4	str	5
8	dict	3
9	module	6
10	class	5
11	function	23
12	builtin_function_or_method	1
13	residual	5
14	system	9
15	private	7
16	all	49

🔵常量

🌿bool

1 WIN True

🌿str

2 _ansi_reset_all

🌿dict

3 _ansi_colors {‘black’: 30, ‘red’: 31, ‘green’: 32, ‘yellow’: 33, ‘blue’: 34, ‘magenta’: 35, ‘cyan’: 36, ‘white’: 37, ‘reset’: 39, 'br…

🔵模块

🌿4 inspect

inspect, fullname=inspect, file=inspect.py

🌿5 io

io, fullname=io, file=io.py

🌿6 itertools

itertools, fullname=itertools

🌿7 os

os, fullname=os, file=os.py

🌿8 sys

sys, fullname=sys

🌿9 typing

typing, fullname=typing, file=typing.py

🔵函数

🌿10 gettext(message)

gettext(message), module=gettext, line:624 at gettext.py

🌿11 isatty(stream: <class ‘IO’>) -> bool

isatty(stream: <class ‘IO’>) -> bool, module=click._compat, line:579 at site-packages\click_compat.py

🌿12 strip_ansi(value: str) -> str

strip_ansi(value: str) -> str, module=click._compat, line:493 at site-packages\click_compat.py

🌿13 resolve_color_default(color: Union[bool, NoneType] = None) -> Union[bool, NoneType]

resolve_color_default(color: Union[bool, NoneType] = None) -> Union[bool, NoneType], module=click.globals, line:55 at site-packages\click\globals.py

获取颜色标志的默认值的内部帮助器。如果传递了一个值，它将原封不动地返回，否则将从当前上下文中查找。

🌿14 convert_type(ty: Union[Any, NoneType], default: Union[Any, NoneType] = None) -> click.types.ParamType

convert_type(ty: Union[Any, NoneType], default: Union[Any, NoneType] = None) -> click.types.ParamType, module=click.types, line:983 at site-packages\click\types.py

为给定的Python类型找到最合适的:class:`ParamType`。如果没有提供类型，则可以从默认值推断出该类型。

🌿15 echo(message: Union[Any, NoneType] = None, file: Union[IO[Any], NoneType] = None, nl: bool = True, err: bool = False, color: Union[bool, NoneType] = None) -> None

echo(message: Union[Any, NoneType] = None, file: Union[IO[Any], NoneType] = None, nl: bool = True, err: bool = False, color: Union[bool, NoneType] = None) -> None, module=click.utils, line:205 at site-packages\click\utils.py

将消息和换行符打印到标准输出或文件。这应该用来代替:func:`print`，因为它可以更好地支持不同的数据、文件和环境。与:func:`print`相比，它做了以下事情:-确保在Linux上没有错误配置输出编码。-在Windows控制台中支持Unicode。-支持写入二进制输出，支持写入字节到文本输出。-支持Windows上的颜色和样式。-如果输出看起来不像交互式终端，则删除ANSI颜色和样式代码。-总是刷新输出。:param message: 要输出的字符串或字节。其他对象被转换为字符串。:param file:    要写入的文件。默认为``stdout``。:param err:     写入``stderr``而不是``stdout``。:param nl:  在消息后打印换行符。默认开启。:param color:       强制显示或隐藏颜色和其他样式。默认情况下，如果输出看起来不像交互式终端，Click将删除颜色。版本变更：   6.0 支持Windows控制台上的Unicode输出。单击不修改``sys``。stdout``，所以``sys.stdout.write()``和``print() ``仍然不支持Unicode。版本变更：   4.0 增加了``color``参数。版本增加： 3.0   增加``err``参数。版本变更： 2.0如果安装了colorama，则支持Windows上的颜色。

🌿16 hidden_prompt_func(prompt: str) -> str

hidden_prompt_func(prompt: str) -> str, module=click.termui, line:52 at site-packages\click\termui.py

🌿17 _build_prompt(text: str, suffix: str, show_default: bool = False, default: Union[Any, NoneType] = None, show_choices: bool = True, type: Union[click.types.ParamType, NoneType] = None) -> str

_build_prompt(text: str, suffix: str, show_default: bool = False, default: Union[Any, NoneType] = None, show_choices: bool = True, type: Union[click.types.ParamType, NoneType] = None) -> str, module=click.termui, line:58 at site-packages\click\termui.py

🌿18 _format_default(default: Any) -> Any

_format_default(default: Any) -> Any, module=click.termui, line:74 at site-packages\click\termui.py

🌿19 prompt(text: str, default: Union[Any, NoneType] = None, hide_input: bool = False, confirmation_prompt: Union[bool, str] = False, type: Union[click.types.ParamType, Any, NoneType] = None, value_proc: Union[Callable[[str], Any], NoneType] = None, prompt_suffix: str = ': ', show_default: bool = True, err: bool = False, show_choices: bool = True) -> Any

prompt(text: str, default: Union[Any, NoneType] = None, hide_input: bool = False, confirmation_prompt: Union[bool, str] = False, type: Union[click.types.ParamType, Any, NoneType] = None, value_proc: Union[Callable[[str], Any], NoneType] = None, prompt_suffix: str = ': ', show_default: bool = True, err: bool = False, show_choices: bool = True) -> Any, module=click.termui, line:81 at site-packages\click\termui.py

提示用户输入。这是一个方便的函数，可用于提示用户稍后进行输入。
如果用户通过发送中断信号来中止输入，这个函数将捕获它并引发:exc:`Abort`异常。:param text:    提示符显示的文本。:param default: 没有输入时使用的默认值。如果没有指定，它将提示直到中止。:param hide_input:  如果设置为true，那么输入值将被隐藏。::param confirmation_prompt:    第二次提示确认参数值。可以设置为字符串而不是``True``以自定义消息。:param type:        用来检查值的类型。:param value_proc:  如果提供了这个参数，它是一个被调用的函数，而不是用于转换值的类型转换。:param prompt_suffix:   提示符的后缀。:param show_default:    在提示符中显示或隐藏默认值。:param err:             如果设置为true，则文件默认为``stderr``而不是``stdout``，与echo相同。:param show_choices:    如果传递的类型是Choice，则显示或隐藏选择。例如，如果type是day或week的选项，show_choices为true, text为"Group by"，那么提示符将是"Group by (day, week): "。版本增加： 8.0   ``确认提示符``可以是一个自定义字符串版本增加： 7.0   增加了``show_choices``参数。版本增加： 6.0   在Windows上增加了对cmd.exe的unicode支持。版本增加： 4.0   增加err参数。

🌿20 confirm(text: str, default: Union[bool, NoneType] = False, abort: bool = False, prompt_suffix: str = ': ', show_default: bool = True, err: bool = False) -> bool

confirm(text: str, default: Union[bool, NoneType] = False, abort: bool = False, prompt_suffix: str = ': ', show_default: bool = True, err: bool = False) -> bool, module=click.termui, line:192 at site-packages\click\termui.py

提示确认(yes/no问题)。如果用户通过发送中断信号来中止输入，这个函数将捕获它并引发:exc:`Abort`异常。:param text:    要问的问题。:param default: 在没有输入时使用的默认值。如果``None``，则重复此操作，直到给出输入。:param abort:   如果将其设置为 `True`，则否定的答案将通过引发:exc:`abort`来终止异常。:param prompt_suffix:   提示符的后缀。:param show_default:    在提示符中显示或隐藏默认值。:param err:     如果设置为true，文件默认为``stderr``而不是``stdout``，与echo相同。如果``default``为 ``None``，重复输入，直到输入。版本增加： 4.0   增加了``err``参数。

🌿21 echo_via_pager(text_or_generator: Union[Iterable[str], Callable[[], Iterable[str]], str], color: Union[bool, NoneType] = None) -> None

echo_via_pager(text_or_generator: Union[Iterable[str], Callable[[], Iterable[str]], str], color: Union[bool, NoneType] = None) -> None, module=click.termui, line:253 at site-packages\click\termui.py

这个函数接受一个文本，并在标准输出上通过环境特定的分页器显示它。版本变更： 3.0   增加了``color``标志。:param text_or_generator:   将文本发送到页面，或者，将文本发送到页面的生成器。:param color:   控制分页器是否支持ANSI颜色。默认是自动检测。

🌿22 progressbar(iterable: Union[Iterable[~V], NoneType] = None, length: Union[int, NoneType] = None, label: Union[str, NoneType] = None, show_eta: bool = True, show_percent: Union[bool, NoneType] = None, show_pos: bool = False, item_show_func: Union[Callable[[Union[~V, NoneType]], Union[str, NoneType]], NoneType] = None, fill_char: str = ‘#’, empty_char: str = ‘-’, bar_template: str = ‘%(label)s [%(bar)s] %(info)s’, info_sep: str = ’ ', width: int = 36, file: Union[TextIO, NoneType] = None, color: Union[bool, NoneType] = None, update_min_steps: int = 1) -> ‘ProgressBar[V]’

progressbar(iterable: Union[Iterable[~V], NoneType] = None, length: Union[int, NoneType] = None, label: Union[str, NoneType] = None, show_eta: bool = True, show_percent: Union[bool, NoneType] = None, show_pos: bool = False, item_show_func: Union[Callable[[Union[~V, NoneType]], Union[str, NoneType]], NoneType] = None, fill_char: str = ‘#’, empty_char: str = ‘-’, bar_template: str = ‘%(label)s [%(bar)s] %(info)s’, info_sep: str = ’ ', width: int = 36, file: Union[TextIO, NoneType] = None, color: Union[bool, NoneType] = None, update_min_steps: int = 1) -> ‘ProgressBar[V]’, module=click.termui, line:285 at site-packages\click\termui.py

这个函数创建一个可迭代的上下文管理器，可用于在显示进度条的同时迭代某些内容。它将迭代`iterable`或`length`项(被计数)。当迭代发生时，此函数将渲染的进度条打印到给定的'文件'(默认为stdout)，并将尝试计算剩余时间等。默认情况下，如果文件不是终端，则不会呈现此进度条。上下文管理器创建进度条。当进入上下文管理器时，已经创建了进度条。随着进度条上的每次迭代，传递给进度条的可迭代对象被推进，并且进度条被更新。当上下文管理器退出时，将打印一个换行符，并最终在屏幕上显示进度条。注意:进度条目前是为总进度至少需要几秒钟的用例设计的。因此，ProgressBar类对象不会显示被认为太快的进度，也不会显示步数间隔时间少于一秒的进度。不能打印，否则进度条会被无意中破坏。with progressbar(items) as bar:for item in bar:do_something_with(item)或者，如果没有指定可迭代对象，可以通过`update()`方法手动更新进度条，而不是直接迭代进度条。更新方法接受用:with progressbar(length=chunks.total_bytes) as bar:for chunk in chunks:process_chunk(chunk)bar.update(chunks.bytes)``update()``方法也接受一个可选值来指定 ``current_item``在新位置。当与``item_show_func``一起使用时，这很有用，可以使用click自定义每个手动步骤的输出。with click.progressbar(length=total_size,label='Unzipping archive',item_show_func=lambda a: a.filename) as bar:for archive in zip_file:archive.extract()bar.update(archive.size, archive)：param iterable:    一个要迭代的可迭代对象。如果没有提供，则必须提供长度。:param length:      要迭代的项数。默认情况下，进度条将尝试向迭代器询问其长度，这可能有效，也可能无效。如果还提供了可迭代对象，则可以使用此参数覆盖长度。如果没有提供可迭代对象，则进度条将在该长度的范围内迭代。:param label:       进度条旁边要显示的标签。:param show_eta:    启用或禁用估计时间显示。如果无法确定长度，则自动禁用此功能。:param show_percent:    打开或关闭百分比显示。如果可迭代对象有长度，默认值为 `True`，否则为`False`。:param show_pos:        启用或禁用绝对位置显示。默认值为``False``。:param item_show_func:  一个用当前项调用的函数，它可以返回一个字符串在进度条旁边显示。如果函数返回``None``，则不会显示任何内容。当前项可以为``None``，例如在进入和退出栏时。填充字符:用来显示进度条填充部分的字符。:param empty_char:      用于显示进度条中未填充部分的字符。:param bar_template:    bar模板的格式字符串。其中的参数是`label`用于标签，`bar`用于进度条，`info`用于信息部分。:param info_sep:        多个信息项(eta等)之间的分隔符;:param width:           进度条的宽度，以字符为单位，0表示完整的终端宽度;:param file:            要写入的文件。如果这不是终端，则只打印标签。:param color:           控制终端是否支持ANSI颜色。默认是自动检测。只有在进度条输出中包含ANSI代码时才需要这样做，而默认情况下不是这样。:param update_min_steps:    仅在完成这么多更新时呈现。这允许对非常快的迭代器进行调优版本变更： 8.0   即使执行时间小于0.5秒，也会显示输出。版本变更： 8.0   ``item_show_func``显示当前项，而不是前一个。版本变更： 8.0   如果输出不是TTY，则回显标签。恢复7.0中删除所有输出的更改。版本增加： 8.0   增加了``update_min_steps``参数。版本变更： 4.0   增加了``color``参数。为对象添加了``update``方法。版本增加： 2.0

🌿23 clear() -> None

clear() -> None, module=click.termui, line:437 at site-packages\click\termui.py

清除终端屏幕。这将清除终端的整个可见空间，并将光标移动到左上角。
如果没有连接到终端，这不会做任何事情。	
版本增加： 2.0

🌿24 _interpret_color(color: Union[int, Tuple[int, int, int], str], offset: int = 0) -> str

_interpret_color(color: Union[int, Tuple[int, int, int], str], offset: int = 0) -> str, module=click.termui, line:452 at site-packages\click\termui.py

🌿25 style(text: Any, fg: Union[int, Tuple[int, int, int], str, NoneType] = None, bg: Union[int, Tuple[int, int, int], str, NoneType] = None, bold: Union[bool, NoneType] = None, dim: Union[bool, NoneType] = None, underline: Union[bool, NoneType] = None, overline: Union[bool, NoneType] = None, italic: Union[bool, NoneType] = None, blink: Union[bool, NoneType] = None, reverse: Union[bool, NoneType] = None, strikethrough: Union[bool, NoneType] = None, reset: bool = True) -> str

style(text: Any, fg: Union[int, Tuple[int, int, int], str, NoneType] = None, bg: Union[int, Tuple[int, int, int], str, NoneType] = None, bold: Union[bool, NoneType] = None, dim: Union[bool, NoneType] = None, underline: Union[bool, NoneType] = None, overline: Union[bool, NoneType] = None, italic: Union[bool, NoneType] = None, blink: Union[bool, NoneType] = None, reverse: Union[bool, NoneType] = None, strikethrough: Union[bool, NoneType] = None, reset: bool = True) -> str, module=click.termui, line:465 at site-packages\click\termui.py

使用ANSI样式设置文本并返回新字符串。默认情况下，样式是自包含的，这意味着在字符串的末尾会发出一个重置代码。这可以通过传递`reset=False`来防止。例子:click.echo(click.style('Hello World!', fg='green'))click.echo(click.style('ATTENTION!', blink=True))click.echo(click.style('Some things', reverse=True, fg='cyan'))click.echo(click.style('More colors', fg=(255, 12, 128), bg=117))支持的颜色名称:* ``black`` (might be a gray)* ``red``* ``green``* ``yellow`` (might be an orange)* ``blue``* ``magenta``* ``cyan``* ``white`` (might be light gray)* ``bright_black``* ``bright_red``* ``bright_green``* ``bright_yellow``* ``bright_blue``* ``bright_magenta``* ``bright_cyan``* ``bright_white``* ``reset`` (reset the color code only)如果终端支持，颜色也可以指定为:-间隔[0,255]的整数。终端必须支持8位/256色模式。—由[0,255]范围内的三个整数组成的RGB元组。终端必须支持24位/真彩色模式。更多信息请参见[链接一](https://en.wikipedia.org/wiki/ANSI_color) 和 [链接二](https://gist.github.com/XVilka/8346728)。:param text:    用ANSI代码样式的字符串。:param fg:      如果提供，这将成为前景色。参数bg:如果提供，这将成为背景色。:param bold:    如果提供，将启用或禁用粗体模式。:param dim:     如果提供，将启用或禁用dim模式。这一点得到了很好的支持。:param underline:   如果提供，将启用或禁用下划线。:param overline:    如果提供，将启用或禁用overline。:param italic:      如果提供此选项，将启用或禁用斜体。:param blink:       如果提供，将启用或禁用闪烁。:param reverse:     如果提供，将启用或禁用反向渲染(前景变为背景，反之亦然)。:param strikethrough:   如果提供，将启用或禁用通过文本划线。:param reset:       默认情况下，在字符串的末尾添加reset-all代码，这意味着样式不会延续。这可以在组合样式时禁用。版本变更： 8.0   将非字符串的``message``转换为字符串。版本变更： 8.0   增加了对256和RGB色码的支持。版本变更： 8.0   增加了``strikethrough``，``italic`` 和 ``overline``参数。版本变更： 7.0   增加了对鲜艳颜色的支持。版本增加： 2.0

🌿26 unstyle(text: str) -> str

unstyle(text: str) -> str, module=click.termui, line:594 at site-packages\click\termui.py

从字符串中删除ANSI样式信息。
通常不需要使用这个函数，因为Click的echo函数会在必要时自动删除样式。版本增加： 2.0
:param text:要删除样式信息的文本。

🌿27 secho(message: Union[Any, NoneType] = None, file: Union[IO[~AnyStr], NoneType] = None, nl: bool = True, err: bool = False, color: Union[bool, NoneType] = None, **styles: Any) -> None

secho(message: Union[Any, NoneType] = None, file: Union[IO[~AnyStr], NoneType] = None, nl: bool = True, err: bool = False, color: Union[bool, NoneType] = None, **styles: Any) -> None, module=click.termui, line:606 at site-packages\click\termui.py

这个函数将:func:`echo`和:func:`style`合并为一个调用。因此，下面两个调用是相同的:click.secho('Hello World!', fg='green')click.echo(click.style('Hello World!', fg='green'))所有关键字参数都被转发给底层函数，具体取决于它们使用的是哪个。非字符串类型将被转换为:class:`str`。然而，:class:`bytes`直接传递给:meth:`echo`而不应用style。如果要为表示文本的字节设置样式，请调用:meth:`bytes.decode`先版本变更： 8.0将非字符串的message转换为字符串。字节在不应用样式的情况下传递。版本增加： 2.0

🌿28 edit(text: Union[~AnyStr, NoneType] = None, editor: Union[str, NoneType] = None, env: Union[Mapping[str, str], NoneType] = None, require_save: bool = True, extension: str = ‘.txt’, filename: Union[str, NoneType] = None) -> Union[~AnyStr, NoneType]

edit(text: Union[~AnyStr, NoneType] = None, editor: Union[str, NoneType] = None, env: Union[Mapping[str, str], NoneType] = None, require_save: bool = True, extension: str = ‘.txt’, filename: Union[str, NoneType] = None) -> Union[~AnyStr, NoneType], module=click.termui, line:640 at site-packages\click\termui.py

在定义的编辑器中编辑给定的文本。如果给出了一个编辑器(应该是可执行文件的完整路径，但常规的操作系统搜索路径用于查找可执行文件)，它将覆盖检测到的编辑器。可以选择使用一些环境变量。如果编辑器在没有更改的情况下关闭，则返回 `None`。在直接编辑文件的情况下，返回值总是 `None`， `require save`和`extension`被忽略。如果无法打开编辑器，则会引发:exc:`UsageError`。Windows注意:为了简化跨平台使用，换行符会自动从POSIX转换为Windows，反之亦然。因此，这里的消息将使用``\n``作为换行标记。:param text:    要编辑的文本。:param editor:  可选使用的编辑器。默认为自动检测。:param env: 要转发给编辑器的环境变量。:param require_save:    如果这是true，那么不在编辑器中保存将使返回值变为 `None`。:param extension:   要告诉编辑器的扩展名。默认为`.txt`，但更改它可能会更改语法高亮显示。如果提供，它将编辑此文件而不是提供的文本内容。在这种情况下，它不会使用临时文件作为间接文件。

🌿29 launch(url: str, wait: bool = False, locate: bool = False) -> int

launch(url: str, wait: bool = False, locate: bool = False) -> int, module=click.termui, line:686 at site-packages\click\termui.py

该函数在该文件类型的默认查看器应用程序中启动给定的URL(或文件名)。如果这是一个可执行文件，它可能会在一个新的会话中启动可执行文件。返回值是已启动应用程序的退出代码。通常，“0”表示成功。示例:click.launch('https://click.palletsprojects.com/')click.launch('/my/downloaded/file', locate=True):param url:     要启动的东西的url或文件名。:param wait:    等待程序退出后返回。这只有在启动的程序阻塞时才有效。特别是，Linux上的``xdg-open``不会阻塞。:param locate:  如果设置为``True``，则不会启动与该URL关联的应用程序，而是尝试启动带有该文件所在位置的文件管理器。如果URL没有指向文件系统，这可能会产生奇怪的效果。

🌿30 getchar(echo: bool = False) -> str

getchar(echo: bool = False) -> str, module=click.termui, line:720 at site-packages\click\termui.py

从终端获取单个字符并返回它。这将始终返回一个unicode字符，在某些罕见的情况下，它可能返回多个字符。返回多个字符的情况是，无论出于何种原因，多个字符最终在终端缓冲区中结束，或者标准输入实际上不是终端。注意，这将始终从终端读取，即使有东西通过管道进入标准输入。Windows注意:  在极少数情况下，当输入非ascii字符时，此函数可能会等待第二个字符，然后同时返回两个字符。这是因为某些Unicode字符看起来像特殊键标记。版本增加： 2.0:param echo:如果设置为 `True`，读取的字符也会显示在终端上。默认是不显示它。

🌿31 raw_terminal() -> AbstractContextManager[int]

raw_terminal() -> AbstractContextManager[int], module=click.termui, line:750 at site-packages\click\termui.py

🌿32 pause(info: Union[str, NoneType] = None, err: bool = False) -> None

pause(info: Union[str, NoneType] = None, err: bool = False) -> None, module=click.termui, line:756 at site-packages\click\termui.py

该命令停止执行，等待用户按下任意键继续执行。这类似于Windows批处理“暂停”命令。如果程序不是通过终端运行，则此命令将不执行任何操作。版本增加： 2.0版本增加： 4.0   增加err参数。:param info:    暂停前要打印的信息。默认为“按任意键继续…”。:param err:     如果设置为message转到``stderr``而不是``stdout``，与echo相同。

🔵类

🌿33 click.exceptions.Abort

Abort, click.exceptions.Abort, module=click.exceptions, line:273 at site-packages\click\exceptions.py

内部信号异常，指示单击终止。

🌿34 click.exceptions.UsageError

UsageError, click.exceptions.UsageError, module=click.exceptions, line:46 at site-packages\click\exceptions.py

发出使用错误信号的内部异常。这通常会中止任何进一步的处理。:param message: 显示的错误信息。:param ctx:     可选的导致此错误的上下文。在某些情况下，单击将自动填充上下文。

data

1 exit_code=2 kind:data type:int class:<class ‘click.exceptions.UsageError’>

method

2 show(self, file: t.Optional[t.IO] = None) -> None:

kind=method class=UsageError objtype=function line:62 at …\lib\site-packages\click\exceptions.py

🌿35 click.types.Choice

Choice, click.types.Choice, module=click.types, line:225 at site-packages\click\types.py

选择类型允许根据一组固定的支持值来检查一个值。所有这些值都必须是字符串。您应该只传递一个选择列表或元组。其他可迭代对象(如生成器)可能会导致令人惊讶的结果。结果值将始终是最初传递的选项之一，无论 ``case_sensitive`` 或任何 ``ctx.token_normalize_func`` 函数``被指定。参见: ref:`choice- options`的例子。:param case_sensitive:  设置为false以使选择不区分大小写。默认为true。

data

1 name=choice kind:data type:str class:<class ‘click.types.Choice’>

method

2 convert(

kind=method class=Choice objtype=function line:267 at …\lib\site-packages\click\types.py

3 get_metavar(self, param: “Parameter”) -> str:

kind=method class=Choice objtype=function line:254 at …\lib\site-packages\click\types.py

4 get_missing_message(self, param: “Parameter”) -> str:

kind=method class=Choice objtype=function line:264 at …\lib\site-packages\click\types.py

5 shell_complete(

kind=method class=Choice objtype=function line:308 at …\lib\site-packages\click\types.py

以不完整值开头的完整选项。:param ctx:该命令的调用上下文。:param param:请求补全的参数。:param incomplete:	正在完成的值。可能是空的。版本增加： 8.0

6 to_info_dict(self) -> t.Dict[str, t.Any]:

kind=method class=Choice objtype=function line:248 at …\lib\site-packages\click\types.py

🌿36 click.types.ParamType

ParamType, click.types.ParamType, module=click.types, line:22 at site-packages\click\types.py

表示参数的类型。验证命令行或Python中的值并将其转换为正确的类型。要实现自定义类型，必须创建子类并至少实现以下内容:-必须设置:attr:`name`类属性。-使用 `None`调用类型的实例必须返回 `None`。这在默认情况下已经实现了。-:meth:`convert`必须将字符串值转换为正确的类型。-:meth:`convert`必须接受已经是正确类型的值。-如果``ctx``和``param``参数为``None``，则必须能够转换值。在转换提示输入时可能发生这种情况。

data

1 arity=1 kind:data type:int class:<class ‘click.types.ParamType’>
2 envvar_list_splitter=None kind:data type:NoneType class:<class ‘click.types.ParamType’>
3 is_composite=False kind:data type:bool class:<class ‘click.types.ParamType’>

method

4 convert(

kind=method class=ParamType objtype=function line:94 at …\lib\site-packages\click\types.py

将值转换为正确的类型。如果值为``None``(缺失值)，则不会调用该函数。它必须接受来自命令行的字符串值，以及已经是正确类型的值。它还可以转换其他兼容类型。:param value:   要转换的值。:param param:   使用该类型转换其值的参数。可能是``None``。:param ctx:     到达此值的当前上下文。可能是``None``。

5 fail(

kind=method class=ParamType objtype=function line:128 at …\lib\site-packages\click\types.py

Helper方法因无效值消息而失败。

6 get_metavar(self, param: “Parameter”) -> t.Optional[str]:

kind=method class=ParamType objtype=function line:84 at …\lib\site-packages\click\types.py

如果此参数提供了默认元变量，则返回该参数的默认元变量。

7 get_missing_message(self, param: “Parameter”) -> t.Optional[str]:

kind=method class=ParamType objtype=function line:87 at …\lib\site-packages\click\types.py

可选地返回关于缺失参数的额外信息。	
版本增加： 2.0

8 shell_complete(

kind=method class=ParamType objtype=function line:137 at …\lib\site-packages\click\types.py

返回 :class:`~click.shell_completion.CompletionItem` 对象的不完整值。大多数类型不提供补全，但有些类型提供，这使得自定义类型也可以提供自定义补全。:param ctx:     该命令的调用上下文。:param param:   请求补全的参数。:param incomplete:	正在完成的值。可能是空的。版本增加： 8.0

9 split_envvar_value(self, rv: str) -> t.Sequence[str]:

kind=method class=ParamType objtype=function line:118 at …\lib\site-packages\click\types.py

给定一个来自环境变量的值，它将根据定义的envvar列表分割器将其分割成小块。
如果分隔符设置为 `None`，这意味着空格分隔，则忽略前导和尾随空格。
否则，前导和尾随分隔符通常会导致包含空项。

10 to_info_dict(self) -> t.Dict[str, t.Any]:

kind=method class=ParamType objtype=function line:54 at …\lib\site-packages\click\types.py

收集可能对生成面向用户文档的工具有用的信息。
使用 :meth:`click.Context.to_info_dict`遍历整个CLI结构。	
版本增加： 8.0

🌿37 click.utils.LazyFile

LazyFile, click.utils.LazyFile, module=click.utils, line:103 at site-packages\click\utils.py

惰性文件的工作方式与常规文件类似，但它不会完全打开文件，但它会提前执行一些基本检查，以查看filename参数是否有意义。这对于安全地打开文件进行写入非常有用。

method

1 close(self) -> None:

kind=method class=LazyFile objtype=function line:162 at …\lib\site-packages\click\utils.py

关闭底层文件，无论如何。

2 close_intelligently(self) -> None:

kind=method class=LazyFile objtype=function line:167 at …\lib\site-packages\click\utils.py

此函数仅在惰性文件包装器打开文件时关闭该文件。例如，这将永远不会关闭stdin。

3 open(self) -> t.IO:

kind=method class=LazyFile objtype=function line:144 at …\lib\site-packages\click\utils.py

如果文件尚未打开，则打开该文件。此调用可能会因:exc:`FileError`而失败。不处理此错误将产生Click显示的错误。

🔵内嵌函数或方法

38 visible_prompt_func

🔵私有或局部

39 _ <function gettext at 0x00000275AC024948>
40 _ansi_colors {‘black’: 30, ‘red’: 31, ‘green’: 32, ‘yellow’: 33, ‘blue’: 34, ‘magenta’: 35, ‘cyan’: 36, ‘white’: 37, ‘reset’: 39, 'br…
41 _ansi_reset_all
42 _build_prompt <function _build_prompt at 0x00000275AC0AB288>
43 _format_default <function _format_default at 0x00000275AC0C84C8>
44 _interpret_color <function _interpret_color at 0x00000275AC0C8828>
45 _getchar

🔵剩余

46 doc
47 loader <_frozen_importlib_external.SourceFileLoader object at 0x00000275AC0A50C8>
48 spec ModuleSpec(name=‘click.termui’, loader=<_frozen_importlib_external.SourceFileLoader object at 0x00000275AC0A50C8>, origin=‘…\lib\site-packages\click\termui.py’)
49 V ~V
50 _getchar

☘️【click.core】

core, fullname=click.core, file=click\core.py

🔵统计

序号	类别	数量
4	str	4
8	dict	1
9	module	8
10	class	22
11	function	22
13	residual	6
14	system	8
15	private	7
16	all	63

🔵常量

🔵模块

🌿1 enum

enum, fullname=enum, file=enum.py

🌿2 errno

errno, fullname=errno

🌿3 inspect

inspect, fullname=inspect, file=inspect.py

🌿4 os

os, fullname=os, file=os.py

🌿5 sys

sys, fullname=sys

🌿6 typing

typing, fullname=typing, file=typing.py

🌿7 collections.abc

abc, fullname=collections.abc, file=collections\abc.py

🌿8 click.types

types, fullname=click.types, file=click\types.py

🔵函数

🌿9 contextmanager(func)

contextmanager(func), module=contextlib, line:210 at contextlib.py

@contextmanager装饰。典型用法:@contextmanagerdef some_generator(<arguments>):<setup>try:yield <value>finally:<cleanup>这使得这个:with some_generator(<arguments>) as <variable>:<body>等价于这个:<setup>try:<variable> = <value><body>finally:<cleanup>

🌿10 update_wrapper(wrapper, wrapped, assigned=(‘module’, ‘name’, ‘qualname’, ‘doc’, ‘annotations’), updated=(‘dict’,))

update_wrapper(wrapper, wrapped, assigned=(‘module’, ‘name’, ‘qualname’, ‘doc’, ‘annotations’), updated=(‘dict’,)), module=functools, line:37 at functools.py

更新包装器函数使其看起来像被包装的函数。
包装器是要更新的函数。包装器是分配的原始函数。
包装器是一个元组，命名从包装函数直接分配给包装器函数的属性(默认为 functools.WRAPPER_ASSIGNMENTS))是一个命名包装器属性的元组，
这些属性是用包装函数(默认为 functools.WRAPPER_UPDATES)

🌿11 gettext(message)

gettext(message), module=gettext, line:624 at gettext.py

🌿12 ngettext(msgid1, msgid2, n)

ngettext(msgid1, msgid2, n), module=gettext, line:630 at gettext.py

🌿13 join_options(options: Sequence[str]) -> Tuple[str, bool]

join_options(options: Sequence[str]) -> Tuple[str, bool], module=click.formatting, line:283 at site-packages\click\formatting.py

给定一个选项字符串列表，它以最合适的方式将它们连接起来，并以 ``(formatted_string, any_prefix_is_slash)`` 的形式返回它们，
其中元组中的第二个项是一个标志指示是否有任何选项前缀是斜杠。

🌿14 pop_context() -> None

pop_context() -> None, module=click.globals, line:50 at site-packages\click\globals.py

从堆栈中删除顶层。

🌿15 push_context(ctx: ‘Context’) -> None

push_context(ctx: ‘Context’) -> None, module=click.globals, line:45 at site-packages\click\globals.py

将新上下文推入当前堆栈。

🌿16 split_opt(opt: str) -> Tuple[str, str]

split_opt(opt: str) -> Tuple[str, str], module=click.parser, line:109 at site-packages\click\parser.py

🌿17 confirm(text: str, default: Union[bool, NoneType] = False, abort: bool = False, prompt_suffix: str = ': ', show_default: bool = True, err: bool = False) -> bool

confirm(text: str, default: Union[bool, NoneType] = False, abort: bool = False, prompt_suffix: str = ': ', show_default: bool = True, err: bool = False) -> bool, module=click.termui, line:192 at site-packages\click\termui.py

提示确认(yes/no问题)。如果用户通过发送中断信号来中止输入，这个函数将捕获它并引发:exc:`Abort`异常。:param text:    要问的问题。:param default: 在没有输入时使用的默认值。如果``None``，则重复此操作，直到给出输入。:param abort:   如果将其设置为 `True`，则否定的答案将通过引发:exc:`abort`来终止异常。:param prompt_suffix:   提示符的后缀。:param show_default:    在提示符中显示或隐藏默认值。:param err:     如果设置为true，文件默认为``stderr``而不是``stdout``，与echo相同。如果``default``为 ``None``，重复输入，直到输入。版本增加： 4.0   增加了``err``参数。

🌿18 prompt(text: str, default: Union[Any, NoneType] = None, hide_input: bool = False, confirmation_prompt: Union[bool, str] = False, type: Union[click.types.ParamType, Any, NoneType] = None, value_proc: Union[Callable[[str], Any], NoneType] = None, prompt_suffix: str = ': ', show_default: bool = True, err: bool = False, show_choices: bool = True) -> Any

prompt(text: str, default: Union[Any, NoneType] = None, hide_input: bool = False, confirmation_prompt: Union[bool, str] = False, type: Union[click.types.ParamType, Any, NoneType] = None, value_proc: Union[Callable[[str], Any], NoneType] = None, prompt_suffix: str = ': ', show_default: bool = True, err: bool = False, show_choices: bool = True) -> Any, module=click.termui, line:81 at site-packages\click\termui.py

提示用户输入。这是一个方便的函数，可用于提示用户稍后进行输入。
如果用户通过发送中断信号来中止输入，这个函数将捕获它并引发:exc:`Abort`异常。:param text:    提示符显示的文本。:param default: 没有输入时使用的默认值。如果没有指定，它将提示直到中止。:param hide_input:  如果设置为true，那么输入值将被隐藏。:param confirmation_prompt:        第二次提示确认参数值。可以设置为字符串而不是``True``以自定义消息。:param type:            用来检查值的类型。:param value_proc:      如果提供了这个参数，它是一个被调用的函数，而不是用于转换值的类型转换。:param prompt_suffix:   提示符的后缀。:param show_default:    在提示符中显示或隐藏默认值。:param err:             如果设置为true，则文件默认为``stderr``而不是``stdout``，与echo相同。:param show_choices:    如果传递的类型是Choice，则显示或隐藏选择。例如，如果type是day或week的选项，show_choices为true, text为"Group by"，那么提示符将是"Group by (day, week): "。版本增加： 8.0   ``confirmation_prompt``可以是一个自定义字符串版本增加： 7.0   增加了``show_choices``参数。版本增加： 6.0   在Windows上增加了对cmd.exe的unicode支持。版本增加： 4.0   增加 `err` 参数。

🌿19 style(text: Any, fg: Union[int, Tuple[int, int, int], str, NoneType] = None, bg: Union[int, Tuple[int, int, int], str, NoneType] = None, bold: Union[bool, NoneType] = None, dim: Union[bool, NoneType] = None, underline: Union[bool, NoneType] = None, overline: Union[bool, NoneType] = None, italic: Union[bool, NoneType] = None, blink: Union[bool, NoneType] = None, reverse: Union[bool, NoneType] = None, strikethrough: Union[bool, NoneType] = None, reset: bool = True) -> str

style(text: Any, fg: Union[int, Tuple[int, int, int], str, NoneType] = None, bg: Union[int, Tuple[int, int, int], str, NoneType] = None, bold: Union[bool, NoneType] = None, dim: Union[bool, NoneType] = None, underline: Union[bool, NoneType] = None, overline: Union[bool, NoneType] = None, italic: Union[bool, NoneType] = None, blink: Union[bool, NoneType] = None, reverse: Union[bool, NoneType] = None, strikethrough: Union[bool, NoneType] = None, reset: bool = True) -> str, module=click.termui, line:465 at site-packages\click\termui.py

使用ANSI样式设置文本并返回新字符串。
默认情况下，样式是自包含的，这意味着在字符串的末尾会发出一个重置代码。这可以通过传递`reset=False`来防止。例子:click.echo(click.style('Hello World!', fg='green'))click.echo(click.style('ATTENTION!', blink=True))click.echo(click.style('Some things', reverse=True, fg='cyan'))click.echo(click.style('More colors', fg=(255, 12, 128), bg=117))支持的颜色名称:* ``black`` (might be a gray)* ``red``* ``green``* ``yellow`` (might be an orange)* ``blue``* ``magenta``* ``cyan``* ``white`` (might be light gray)* ``bright_black``* ``bright_red``* ``bright_green``* ``bright_yellow``* ``bright_blue``* ``bright_magenta``* ``bright_cyan``* ``bright_white``* ``reset`` (reset the color code only)如果终端支持，颜色也可以指定为:-间隔[0,255]的整数。终端必须支持8位/256色模式。—由[0,255]范围内的三个整数组成的RGB元组。终端必须支持24位/真彩色模式。更多信息请参见:[链接一](https://en.wikipedia.org/wiki/ANSI_color) 和 [链接二](https://gist.github.com/XVilka/8346728)。:param text:    用ANSI代码样式的字符串。:param fg:      如果提供，这将成为前景色。参数bg:如果提供，这将成为背景色。:param bold:    如果提供，将启用或禁用粗体模式。:param dim:     如果提供，将启用或禁用dim模式。这一点得到了很好的支持。:param underline:   如果提供，将启用或禁用下划线。参数overline:如果提供，将启用或禁用overline。:param italic:  如果提供此选项，将启用或禁用斜体。:param blink:   如果提供，将启用或禁用闪烁。:param reverse: 如果提供，将启用或禁用反向渲染(前景变为背景，反之亦然)。:param strikethrough:   如果提供，将启用或禁用通过文本划线。:param reset:   默认情况下，在字符串的末尾添加reset-all代码，这意味着样式不会延续。这可以在组合样式时禁用。版本变更： 8.0   将非字符串的``message``转换为字符串。版本变更： 8.0   增加了对256和RGB色码的支持。版本变更： 8.0   增加了``strikethrough``，``italic``和``overline``参数。版本变更： 7.0   增加了对鲜艳颜色的支持…版本增加： 2.0

🌿20 _detect_program_name(path: Union[str, NoneType] = None, _main: Union[module, NoneType] = None) -> str

_detect_program_name(path: Union[str, NoneType] = None, _main: Union[module, NoneType] = None) -> str, module=click.utils, line:477 at site-packages\click\utils.py

确定用于运行程序的命令，以用于帮助文本。如果执行了文件或入口点，则返回文件名。如果``python -m``用于执行模块或包，则返回``python -m name``。这并不是要太精确，目标是为帮助文本提供一个简洁的名称。文件只显示其名称而不显示路径。``python``只在模块中显示，``sys.executable`` 没有显示。param path: 正在执行的Python文件。Python把它放在``sys.argv[0]``，默认使用``__main__``模块。这只能在内部测试中通过。版本增加： 8.0   基于Werkzeug reloader中的命令args检测。:meta private: 元私有。

🌿21 _expand_args(args: Iterable[str], *, user: bool = True, env: bool = True, glob_recursive: bool = True) -> List[str]

_expand_args(args: Iterable[str], *, user: bool = True, env: bool = True, glob_recursive: bool = True) -> List[str], module=click.utils, line:531 at site-packages\click\utils.py

用Python函数模拟Unix shell扩展。参见 :func:`glob.glob`, :func:`os.path.expanduser` 和 :func:`os.path.expandvars`。这是在Windows上使用的，shell不做任何扩展。它可能与Unix shell的功能不完全匹配。:param args:    要展开的命令行参数列表。:param user:    展开用户主目录。:param env: 展开环境变量。:param glob_recursive: ``**``递归匹配目录。版本变更： 8.1   无效的glob模式被视为空展开，而不是引发错误。版本增加： 8.0:meta private:

🌿22 echo(message: Union[Any, NoneType] = None, file: Union[IO[Any], NoneType] = None, nl: bool = True, err: bool = False, color: Union[bool, NoneType] = None) -> None

echo(message: Union[Any, NoneType] = None, file: Union[IO[Any], NoneType] = None, nl: bool = True, err: bool = False, color: Union[bool, NoneType] = None) -> None, module=click.utils, line:205 at site-packages\click\utils.py

将消息和换行符打印到标准输出或文件。这应该用来代替:func:`print`，因为它可以更好地支持不同的数据、文件和环境。与:func:`print`相比，它做了以下事情:-确保在Linux上没有错误配置输出编码。-在Windows控制台中支持Unicode。-支持写入二进制输出，支持写入字节到文本输出。-支持Windows上的颜色和样式。-如果输出看起来不像交互式终端，则删除ANSI颜色和样式代码。-总是刷新输出。:param message: 要输出的字符串或字节。其他对象被转换为字符串。:param file:    要写入的文件。默认为``stdout``。:param err:     写入``stderr``而不是``stdout``。:param nl:  在消息后打印换行符。默认开启。:param color:       强制显示或隐藏颜色和其他样式。默认情况下，如果输出看起来不像交互式终端，Click将删除颜色。版本变更：   6.0 支持Windows控制台上的Unicode输出。单击不修改``sys``。stdout``，所以``sys.stdout.write()``和``print() ``仍然不支持Unicode。版本变更：   4.0 增加了``color``参数。版本增加： 3.0   增加``err``参数。版本变更： 2.0如果安装了colorama，则支持Windows上的颜色。

🌿23 make_default_short_help(help: str, max_length: int = 45) -> str

make_default_short_help(help: str, max_length: int = 45) -> str, module=click.utils, line:53 at site-packages\click\utils.py

返回帮助字符串的精简版本。

🌿24 make_str(value: Any) -> str

make_str(value: Any) -> str, module=click.utils, line:43 at site-packages\click\utils.py

将值转换为有效字符串。

🌿25 _complete_visible_commands(ctx: ‘Context’, incomplete: str) -> Iterator[Tuple[str, ForwardRef(‘Command’)]]

_complete_visible_commands(ctx: ‘Context’, incomplete: str) -> Iterator[Tuple[str, ForwardRef(‘Command’)]], module=click.core, line:48 at site-packages\click\core.py

列出组中以不完整值开头且未隐藏的所有子命令。
:param ctx:组的调用上下文。
:param incomplete:	正在完成的值。可能是空的。

🌿26 _check_multicommand(base_command: ‘MultiCommand’, cmd_name: str, cmd: ‘Command’, register: bool = False) -> None

_check_multicommand(base_command: ‘MultiCommand’, cmd_name: str, cmd: ‘Command’, register: bool = False) -> None, module=click.core, line:67 at site-packages\click\core.py

🌿27 batch(iterable: Iterable[~V], batch_size: int) -> List[Tuple[~V, …]]

batch(iterable: Iterable[~V], batch_size: int) -> List[Tuple[~V, …]], module=click.core, line:91 at site-packages\click\core.py

🌿28 augment_usage_errors(ctx: ‘Context’, param: Union[ForwardRef(‘Parameter’), NoneType] = None) -> Iterator[NoneType]

augment_usage_errors(ctx: ‘Context’, param: Union[ForwardRef(‘Parameter’), NoneType] = None) -> Iterator[NoneType], module=click.core, line:237 at contextlib.py

将额外信息附加到异常的上下文管理器。

🌿29 iter_params_for_processing(invocation_order: Sequence[ForwardRef(‘Parameter’)], declaration_order: Sequence[ForwardRef(‘Parameter’)]) -> List[ForwardRef(‘Parameter’)]

iter_params_for_processing(invocation_order: Sequence[ForwardRef(‘Parameter’)], declaration_order: Sequence[ForwardRef(‘Parameter’)]) -> List[ForwardRef(‘Parameter’)], module=click.core, line:114 at site-packages\click\core.py

给定一个按处理顺序排列的参数序列和一个现有参数的可迭代对象，这将返回一个按处理顺序排列的列表。

🌿30 _check_iter(value: Any) -> Iterator[Any]

_check_iter(value: Any) -> Iterator[Any], module=click.core, line:1966 at site-packages\click\core.py

检查该值是否是可迭代的，但不是字符串。引发类型错误，或返回该值的迭代器。

🔵类

🌿31 contextlib.ExitStack

ExitStack, contextlib.ExitStack, module=contextlib, line:0 at

上下文管理器，用于动态管理退出回调堆栈。
例如:with ExitStack() as stack:files = [stack.enter_context(open(fname)) for fname in filenames]# All opened files will automatically be closed at the end of# the with statement, even if attempts to open files later# in the list raise an exception.

method

1 close(self)

kind=method class=ExitStack objtype=function line:530 at …\contextlib.py

立即展开上下文堆栈。

🌿32 functools.partial

partial, functools.partial, module=functools, line:234 at functools.py

Partial(func， *args， **keywords) -部分应用给定参数和关键字的新函数。

data

1 args=<member ‘argsoffunctools.partial’ objects> kind:data type:member_descriptor class:<class ‘functools.partial’>
2 func=<member ‘funcoffunctools.partial’ objects> kind:data type:member_descriptor class:<class ‘functools.partial’>
3 keywords=<member ‘keywordsoffunctools.partial’ objects> kind:data type:member_descriptor class:<class ‘functools.partial’>

🌿33 itertools.repeat

repeat, itertools.repeat, module=itertools, line:0 at

repeat(object [，times]) ->创建一个迭代器，该迭代器返回指定次数的对象。如果未指定，则无限返回对象。

🌿34 click.exceptions.Abort

Abort, click.exceptions.Abort, module=click.exceptions, line:273 at site-packages\click\exceptions.py

内部信号异常，指示单击终止。

🌿35 click.exceptions.BadParameter

BadParameter, click.exceptions.BadParameter, module=click.exceptions, line:85 at site-packages\click\exceptions.py

格式化错误参数的标准化错误消息的异常。当从回调或类型抛出时，这很有用，因为Click会将上下文信息附加到它(例如，它是哪个参数)。版本增加： 2.0:param param: 导致此错误的参数对象。这可以被遗漏，如果可能的话，点击将附加此信息本身。:param param_hint:  作为参数名显示的字符串。在需要进行自定义验证的情况下，这可以作为``param``的替代。如果它是一个字符串，那么它就是这样使用的，如果它是一个列表，那么每个项都被引用并分开。

method

1 format_message(self) -> str:

kind=method class=BadParameter objtype=function line:114 at …\lib\site-packages\click\exceptions.py

🌿36 click.exceptions.ClickException

ClickException, click.exceptions.ClickException, module=click.exceptions, line:23 at site-packages\click\exceptions.py

Click可以处理并显示给用户的异常。

data

1 exit_code=1 kind:data type:int class:<class ‘click.exceptions.ClickException’>

method

2 format_message(self) -> str:

kind=method class=ClickException objtype=function line:33 at …\lib\site-packages\click\exceptions.py

3 show(self, file: t.Optional[t.IO] = None) -> None:

kind=method class=ClickException objtype=function line:39 at …\lib\site-packages\click\exceptions.py

🌿37 click.exceptions.Exit

Exit, click.exceptions.Exit, module=click.exceptions, line:277 at site-packages\click\exceptions.py

指示应用程序应使用某些状态码退出的异常。
:param code:    要退出的状态码。
:param code:```
#### data
> 1	exit_code=<member 'exit_code`of`Exit' objects>	kind:data	type:member_descriptor	class:<class 'click.exceptions.Exit'>
### 🌿38 click.exceptions.MissingParameter
> MissingParameter, click.exceptions.MissingParameter, module=click.exceptions, line:127 at site-packages\click\exceptions.py

如果click需要一个选项或参数，但在调用脚本时没有提供，则会被引发。
版本增加： 4.0
:param param type: 参数类型的字符串。默认是从给定的param继承参数类型。
有效值是parameter',option' 或 argument'。

#### method
> #### 1	format_message(self) -> str:
> kind=method	class=MissingParameter	objtype=function	line:150 at ...\lib\site-packages\click\exceptions.py
### 🌿39 click.exceptions.UsageError
> UsageError, click.exceptions.UsageError, module=click.exceptions, line:46 at site-packages\click\exceptions.py

发出使用错误信号的内部异常。这通常会中止任何进一步的处理。
:param message:显示的错误信息。
:param ctx:可选的导致此错误的上下文。在某些情况下，单击将自动填充上下文。

#### data
> 1	exit_code=2	kind:data	type:int	class:<class 'click.exceptions.UsageError'>
#### method
> #### 2	show(self, file: t.Optional[t.IO] = None) -> None:
> kind=method	class=UsageError	objtype=function	line:62 at ...\lib\site-packages\click\exceptions.py
### 🌿40 click.formatting.HelpFormatter
> HelpFormatter, click.formatting.HelpFormatter, module=click.formatting, line:102 at site-packages\click\formatting.py

这个类帮助格式化基于文本的帮助页面。
它通常只在非常特殊的内部情况下才需要，但它也被公开，以便开发人员可以编写自己的花哨输出。
目前，它总是写入内存。
:param indent_increment: 每层的额外增量。
:param width: 文本的宽度。默认情况下，终端宽度箝位为78。

#### method
> #### 1	dedent(self) -> None:
> kind=method	class=HelpFormatter	objtype=function	line:141 at ...\lib\site-packages\click\formatting.py

减少缩进。

> #### 2	getvalue(self) -> str:
> kind=method	class=HelpFormatter	objtype=function	line:278 at ...\lib\site-packages\click\formatting.py

返回缓冲区内容。

> #### 3	indent(self) -> None:
> kind=method	class=HelpFormatter	objtype=function	line:137 at ...\lib\site-packages\click\formatting.py

增加缩进。

> #### 4	indentation(self) -> t.Iterator[None]:
> kind=method	class=HelpFormatter	objtype=function	line:270 at ...\lib\site-packages\click\formatting.py

增加缩进的上下文管理器。

> #### 5	section(self, name: str) -> t.Iterator[None]:
> kind=method	class=HelpFormatter	objtype=function	line:255 at ...\lib\site-packages\click\formatting.py

有用的上下文管理器，用于编写段落、标题和缩进。
:param name:作为标题书写的节名。
:param code:```

6 write(self, string: str) -> None:

kind=method class=HelpFormatter objtype=function line:133 at …\lib\site-packages\click\formatting.py

将unicode字符串写入内部缓冲区。

7 write_dl(

kind=method class=HelpFormatter objtype=function line:210 at …\lib\site-packages\click\formatting.py

将定义列表写入缓冲区。选项和命令通常是这样格式化的。
:param rows:包含两个项元组的列表，用于项和值。
:param col_max:第一列的最大宽度。
:param co_spacing:第一列和第二列之间的空格数。

8 write_heading(self, heading: str) -> None:

kind=method class=HelpFormatter objtype=function line:185 at …\lib\site-packages\click\formatting.py

将标题写入缓冲区。

9 write_paragraph(self) -> None:

kind=method class=HelpFormatter objtype=function line:189 at …\lib\site-packages\click\formatting.py

将一个段落写入缓冲区。

10 write_text(self, text: str) -> None:

kind=method class=HelpFormatter objtype=function line:194 at …\lib\site-packages\click\formatting.py

将重新缩进的文本写入缓冲区。这是对段落的重新包装和保留。
:param code:```
> #### 11	write_usage(
> kind=method	class=HelpFormatter	objtype=function	line:145 at ...\lib\site-packages\click\formatting.py

将用法行写入缓冲区。
:param prog:程序名。
:param args:由空格分隔的参数列表。
param prefix:第一行的前缀。默认为 "Usage: "。

### 🌿41 click.parser.OptionParser
> OptionParser, click.parser.OptionParser, module=click.parser, line:253 at site-packages\click\parser.py

选项解析器是一个内部类，最终用于解析选项和参数。
它是在optparse的基础上建模的，并提供了一个类似但大大简化的API。
它通常不应直接用作高级Click类为您包装它。它的可扩展性不如optparse或argparse，因为它没有实现在更高级别上实现的特性(例如类型或默认值)。
:param ctx: 可选 :class:~click.Context这个解析器应该使用。

#### method
> #### 1	add_argument(
> kind=method	class=OptionParser	objtype=function	line:316 at ...\lib\site-packages\click\parser.py

向解析器添加名为dest的位置参数。obj可用于标识从解析器返回的顺序列表中的选项。
:param code:```

2 add_option(

kind=method class=OptionParser objtype=function line:291 at …\lib\site-packages\click\parser.py

向解析器添加一个名为`dest`的新选项。目标不是推断出来的(与optparse不同)，需要显式提供。
Action可以是 ``store``，`store_const``，`append``，`append_const``或 ``count``中的任何一个。`obj`可用于标识从解析器返回的顺序列表中的选项。

3 parse_args(

kind=method class=OptionParser objtype=function line:326 at …\lib\site-packages\click\parser.py

解析位置参数并为已解析的选项和参数以及剩余参数返回``(values, args, order)``(如果有的话)。
顺序是在命令行中出现的对象列表。如果参数出现多次，它们也会被记忆多次。

🌿42 click.utils.PacifyFlushWrapper

PacifyFlushWrapper, click.utils.PacifyFlushWrapper, module=click.utils, line:452 at site-packages\click\utils.py

此包装器用于捕获和抑制在Python解释器关闭/final-GC期间在损坏的管道上调用``.flush()``导致的BrokenPipeErrors。
值得注意的是，``.flush()``总是在``sys.Stdout``和``sys.stderr``。
为了将对任何其他清理代码的影响降到最低，并且在底层文件不是损坏的管道的情况下，所有调用和属性都被代理。

method

1 flush(self) -> None:

kind=method class=PacifyFlushWrapper objtype=function line:464 at …\lib\site-packages\click\utils.py

🌿43 ParameterSource

ParameterSource, ParameterSource, module=click.core, line:134 at site-packages\click\core.py

这是一个 :class:`~enum.Enum` 指定参数值的来源。使用 :meth:`click.Context.get_parameter_source`按名称获取参数的源。版本变更： 8.0   使用 :class:`~enum.Enum`，并删除``validate``方法。版本变更： 8.0   增加了``PROMPT``值。

data

1 COMMANDLINE=ParameterSource.COMMANDLINE kind:data type:ParameterSource class:<enum ‘ParameterSource’>
2 DEFAULT=ParameterSource.DEFAULT kind:data type:ParameterSource class:<enum ‘ParameterSource’>
3 DEFAULT_MAP=ParameterSource.DEFAULT_MAP kind:data type:ParameterSource class:<enum ‘ParameterSource’>
4 ENVIRONMENT=ParameterSource.ENVIRONMENT kind:data type:ParameterSource class:<enum ‘ParameterSource’>
5 PROMPT=ParameterSource.PROMPT kind:data type:ParameterSource class:<enum ‘ParameterSource’>

🌿44 click.core.Context

Context, click.core.Context, module=click.core, line:160 at site-packages\click\core.py

上下文是一个特殊的内部对象，它保存着与每个级别的脚本执行相关的状态。它通常对命令是不可见的，除非他们选择访问它。上下文很有用，因为它可以传递内部对象，并且可以控制特殊的执行特性，例如从环境变量中读取数据。上下文可以用作上下文管理器，在这种情况下，它将在teardown时调用:meth:`close`。:param command:             此上下文的命令类。:param parent:              父上下文。:param info_name:           此调用的info名称。通常，这是脚本或命令最具描述性的名称。对于顶层脚本，它通常是脚本的名称，对于下面的命令，它是脚本的名称。:param obj:                 用户数据的任意对象。:param auto_envvar_prefix:  用于自动环境变量的前缀。如果这是 `None`，则禁用从环境变量读取。这不会影响总是读取的手动设置的环境变量。:param default_map:         一个字典(类似于object)，具有默认的参数值。:参数终端宽度:终端的宽度。默认是继承自父上下文。如果没有上下文定义终端宽度，则将应用自动检测。:param max_content_width:   Click渲染内容的最大宽度(目前只影响帮助页面)。如果没有覆盖，默认为80个字符。换句话说:即使终端大于80个字符，默认情况下Click也不会格式化大于80个字符的内容。除此之外，格式化器可能会在右侧添加一些安全映射。:param resilient_parsing:   如果启用此标志，则Click将在没有任何交互或回调调用的情况下进行解析。默认值也将被忽略。这对于实现诸如补全支持之类的东西很有用。:param allow_extra_args:    如果将此设置为 `True`，则最后的额外参数不会引发错误，并将保留在上下文中。默认是从命令继承。:param allow_interspersed_args: 如果设置为`False`，则选项和参数不能混合。默认是从命令继承。:param ignore_unknown_options:  指示click忽略它不知道的选项，并保留它们以供以后处理。param help_option_names:        可选的字符串列表，这些字符串定义了默认帮助参数的命名方式。默认值是``['--help']``。:param token_normalize_func:        一个可选函数，用于规范化标记(选项，选择等)。例如，这可以用来实现不区分大小写的行为。:param color:   控制终端是否支持ANSI颜色。默认是自动检测。只有在Click打印的文本中使用ANSI代码时才需要这样做，这在默认情况下不是这种情况。例如，这将影响帮助输出。:param show_default:显示命令的默认值。如果未设置此值，则默认为来自父上下文的值。``Command.show_default`` 将覆盖特定命令的默认值。版本变更： 8.1   ``show_default``参数被``Command.show_default``覆盖，而不是相反。版本变更： 8.0   参数show_default默认为父上下文的值版本变更： 7.1   增加了``show_default``参数。版本变更： 4.0   增加了``color``， ``ignore_unknown_options``和 ``max_content_width``参数。版本变更： 3.0   增加了``allow_extra_args``和``allow_interspersed_args``版本变更： 2.0   增加了``resilient_parsing``，``help_option_names``和'token_normalize_func``参数。

data

1 formatter_class=<class ‘click.formatting.HelpFormatter’> kind:data type:type class:<class ‘click.core.Context’>

property

2 command_path=<property object at 0x000002B715540DB8> kind:property type:property class:<class ‘click.core.Context’>
3 meta=<property object at 0x000002B715540868> kind:property type:property class:<class ‘click.core.Context’>

method

4 abort(self) -> “te.NoReturn”:

kind=method class=Context objtype=function line:681 at …\lib\site-packages\click\core.py

中止脚本。

5 call_on_close(self, f: t.Callable[…, t.Any]) -> t.Callable[…, t.Any]:

kind=method class=Context objtype=function line:573 at …\lib\site-packages\click\core.py

注册一个在上下文断开时调用的函数。
这可用于关闭在脚本执行期间打开的资源。
支持Python上下文管理器协议的资源应该在``with``语句中使用，而应该在:meth:`with_resource`中注册。
:param f:在teardown时执行的函数。

6 close(self) -> None:

kind=method class=Context objtype=function line:585 at …\lib\site-packages\click\core.py

调用所有用:meth:`call_on_close` 注册的close回调，并退出所有用:meth:`with_resource` 进入的上下文管理器。
:param code:```
> #### 7	ensure_object(self, object_type: t.Type[V]) -> V:
> kind=method	class=Context	objtype=function	line:632 at ...\lib\site-packages\click\core.py

类似于:meth:find_object '，但如果最里面的对象不存在，则将其设置为 ``object_type 的新实例。
:param code:```

8 exit(self, code: int = 0) -> “te.NoReturn”:

kind=method class=Context objtype=function line:685 at …\lib\site-packages\click\core.py

使用给定的退出代码退出应用程序。

9 fail(self, message: str) -> “te.NoReturn”:

kind=method class=Context objtype=function line:673 at …\lib\site-packages\click\core.py

用特定的错误消息中止程序的执行。
:param message:要失败的错误消息。
:param code:```
> #### 10	find_object(self, object_type: t.Type[V]) -> t.Optional[V]:
> kind=method	class=Context	objtype=function	line:620 at ...\lib\site-packages\click\core.py

查找与给定类型最接近的对象。

> #### 11	find_root(self) -> "Context":
> kind=method	class=Context	objtype=function	line:613 at ...\lib\site-packages\click\core.py

查找最外层的上下文。

> #### 12	forward(
> kind=method	class=Context	objtype=function	line:762 at ...\lib\site-packages\click\core.py

类似于:meth:invoke，但如果其他命令需要，则填充当前上下文中的默认关键字参数。
这不能直接调用回调，只能调用其他命令
版本更改： 8.0
所有kwargs都在:attr:params中跟踪，
因此如果forward在多个级别被调用，它们将被传递。

> #### 13	get_help(self) -> str:
> kind=method	class=Context	objtype=function	line:695 at ...\lib\site-packages\click\core.py

方法获取当前上下文和命令的格式化帮助页。
:param code:```

14 get_parameter_source(self, name: str) -> t.Optional[ParameterSource]:

kind=method class=Context objtype=function line:792 at …\lib\site-packages\click\core.py

获取参数的来源。这表示获取参数值的位置。这对于确定用户何时在命令行上指定与默认值相同的值非常有用。它将是 :           attr:`~click.core.ParameterSource.DEFAULT` 只有当值实际上是从默认值中获取时才会使用。:param name:    参数名称。:rtype:     ParameterSource版本变更： 8.0   如果参数不是从任何来源提供的，则返回``None``。

15 get_usage(self) -> str:

kind=method class=Context objtype=function line:689 at …\lib\site-packages\click\core.py

方法获取当前上下文和命令的格式化用法字符串。
:param code:```
> #### 16	invoke(
> kind=method	class=Context	objtype=function	line:709 at ...\lib\site-packages\click\core.py

以它期望的方式调用命令回调。
有两种方法可以调用这个方法:
1. 第一个参数可以是回调，所有其他参数和关键字参数都直接转发给函数。
2. 第一个参数是一个click command对象。在这种情况下，所有的参数都被转发，但适当的点击参数(选项和点击参数)必须是关键字参数和点击将填写默认值。
请注意，在Click 3.2之前，关键字参数没有正确填写，这违背了代码的意图，也没有创建上下文。
有关此更改的更多信息以及为什么在错误修复版本中完成，请参阅 :ref:upgrade-to-3.2
版本更改： 8.0
所有的kwargs都在:attr:params中跟踪，所以如果在多个级别调用:meth:forward，它们将被传递。

> #### 17	lookup_default(
> kind=method	class=Context	objtype=function	line:642 at ...\lib\site-packages\click\core.py

从:attr:default_map中获取参数的默认值。
:param name:参数名称。
:param call:如果默认值是可调用的，调用它。禁用返回可调用对象
版本变更： 8.0增加了call参数。

> #### 18	make_formatter(self) -> HelpFormatter:
> kind=method	class=Context	objtype=function	line:530 at ...\lib\site-packages\click\core.py

创建:类:class:~click.HelpFormatter 用于帮助和用法输出的HelpFormatter。
要快速自定义使用的格式化器类而不重写此方法，请设置:attr:formatter_class属性。
版本变更： 8.0增加:attr:formatter_class属性。

> #### 19	scope(self, cleanup: bool = True) -> t.Iterator["Context"]:
> kind=method	class=Context	objtype=function	line:465 at ...\lib\site-packages\click\core.py

这个辅助方法可以与context对象一起使用，以将其提升到当前线程本地(参见:func:get_current_context)。
它的默认行为是调用清理函数，可以通过将cleanup设置为False来禁用该函数。
清理函数通常用于关闭文件句柄等操作。如果要进行清理，也可以直接将上下文对象用作上下文管理器。
示例用法:
with ctx.scope():
assert get_current_context() is ctx
与ctx等价:
with ctx:
assert get_current_context() is ctx
版本增加： 5.0:
:param cleanup: 控制是否应该运行清理函数。默认是运行这些函数。
在某些情况下，上下文只希望被临时推送，在这种情况下可以禁用此功能。嵌套推送自动延迟清理。

> #### 20	set_parameter_source(self, name: str, source: ParameterSource) -> None:
> kind=method	class=Context	objtype=function	line:783 at ...\lib\site-packages\click\core.py

设置参数的来源。这表示获取参数值的位置。
:param name:参数名称。
:param source: ~click.core.ParameterSource的成员。

> #### 21	to_info_dict(self) -> t.Dict[str, t.Any]:
> kind=method	class=Context	objtype=function	line:432 at ...\lib\site-packages\click\core.py

收集可能对生成面向用户文档的工具有用的信息。
这将遍历该命令下面的整个结构。
使用 :meth:click.Context.to_info_dict 遍历整个CLI结构。
:param ctx: :class:Context表示这个命令。
版本增加： 8.0

> #### 22	with_resource(self, context_manager: t.ContextManager[V]) -> V:
> kind=method	class=Context	objtype=function	line:544 at ...\lib\site-packages\click\core.py

注册一个资源，就像在with语句中使用它一样。
当上下文弹出时，资源将被清理。用途:甲:“contextlib.ExitStack。输入上下文”。
它调用资源的__enter__()方法并返回结果。当上下文弹出时，它关闭堆栈，调用资源的__exit__()方法。
要为非上下文管理器注册一个清理函数，使用:meth:call_on_close。或者使用:mod:contextlib中的一些东西将其转换为上下文管理器。
代码块:
@click.group()
@click.option(“–name”)
@click.pass_context
def cli(ctx):
ctx.obj = ctx.with_resource(connect_db(name))
:param context_manager:要进入的上下文管理器。
:return: 无论如何返回 context_manager.__enter__()。
版本增加： 8.0

### 🌿45 click.core.BaseCommand
> BaseCommand, click.core.BaseCommand, module=click.core, line:811 at site-packages\click\core.py

base命令实现命令的最小API契约。
大多数代码永远不会使用它，因为它没有实现很多有用的功能，但它可以作为不依赖于Click解析器的其他解析方法的直接子类。
例如，这可以用来桥接Click和其他系统，如argparse或docopt。
由于基本命令没有实现Click的其他部分认为理所当然的许多API，因此并不是所有操作都支持它们。
例如，它们通常不能与装饰器一起使用，而且它们没有内置的回调系统。
版本变更： 2.0 增加了context_settings参数。
:param name: 除非被组覆盖，否则要使用的命令名。
:param context_settings: 一个可选的字典，带有传递给context对象的默认值。

#### data
> 1	allow_extra_args=False	kind:data	type:bool	class:<class 'click.core.BaseCommand'>
> 2	allow_interspersed_args=True	kind:data	type:bool	class:<class 'click.core.BaseCommand'>
> 3	context_class=<class 'click.core.Context'>	kind:data	type:type	class:<class 'click.core.BaseCommand'>
> 4	ignore_unknown_options=False	kind:data	type:bool	class:<class 'click.core.BaseCommand'>
#### method
> #### 5	get_help(self, ctx: Context) -> str:
> kind=method	class=BaseCommand	objtype=function	line:881 at ...\lib\site-packages\click\core.py
> #### 6	get_usage(self, ctx: Context) -> str:
> kind=method	class=BaseCommand	objtype=function	line:878 at ...\lib\site-packages\click\core.py
> #### 7	invoke(self, ctx: Context) -> t.Any:
> kind=method	class=BaseCommand	objtype=function	line:930 at ...\lib\site-packages\click\core.py

给定上下文，这将调用命令。默认实现会引发未实现错误。

> #### 8	main(
> kind=method	class=BaseCommand	objtype=function	line:966 at ...\lib\site-packages\click\core.py

这是将脚本作为命令行应用程序调用的方法。
这将总是在调用后终止应用程序。如果不需要，则需要捕获SystemExit。
这个方法也可以通过直接调用:class:Command的实例来实现。
:param args: 应该用于解析的参数。如果没有提供，sys.argv[1:]。
:param program_name: 应该使用的程序名。默认情况下，程序名是通过从sys.argv[0]获取文件名来构造的。
:param complete_var: 控制bash完成支持的环境变量。默认值是 "_<prog_name>_COMPLETE" ，其中proname为大写。
:param standalone_mode: 默认以单机模式调用脚本。然后Click将处理异常并将其转换为错误消息，该函数将永远不会返回，而是关闭解释器。
如果设置为False，它们将被传播给调用者，并且该函数的返回值是:meth:invoke的返回值。
:param windows_expand_args: 在windows上展开命令行参数中的全局模式、用户目录和env变量。
:param extra: 额外的关键字参数被转发给上下文构造函数。更多信息请参见:class:Context。
版本变更： 8.0.1 增加了windows_expand_args参数，允许在windows上禁用命令行扩展参数。
版本变更： 8.0. 当从 sys.argv 获取参数时。在Windows上全局模式，用户目录和envars被展开。
版本变更： 3.0 增加了standalone_mode 参数。

> #### 9	make_context(
> kind=method	class=BaseCommand	objtype=function	line:884 at ...\lib\site-packages\click\core.py

当给定info名称和参数时，该函数将开始解析并创建一个新的:class:Context。
但是，它并不调用实际的命令回调。
要快速自定义使用的上下文类而不重写此方法，请设置:attr:context_class属性。
:param info_name: 此调用的info名称。通常，这是脚本或命令最具描述性的名称。对于顶层脚本，它通常是脚本的名称，对于下面的命令，它是命令的名称。
:param args: 作为字符串列表解析的参数。
:param parent: 父上下文(如果可用)。
:param extra: 转发给上下文构造函数的额外关键字参数
版本变更： 8.0 增加:attr:context_class属性。

> #### 10	parse_args(self, ctx: Context, args: t.List[str]) -> t.List[str]:
> kind=method	class=BaseCommand	objtype=function	line:923 at ...\lib\site-packages\click\core.py

给定上下文和参数列表，这将创建解析器并解析参数，然后根据需要修改上下文。它会被:meth:make_context自动调用。
:param code:```

11 shell_complete(self, ctx: Context, incomplete: str) -> t.List[“CompletionItem”]:

kind=method class=BaseCommand objtype=function line:936 at …\lib\site-packages\click\core.py

返回不完整值的补全列表。查看选项和链接的多命令的名称。:param ctx:该命令的调用上下文。:param incomplete:	正在完成的值。可能是空的。版本增加： 8.0

12 to_info_dict(self, ctx: Context) -> t.Dict[str, t.Any]:

kind=method class=BaseCommand objtype=function line:861 at …\lib\site-packages\click\core.py

收集可能对生成面向用户文档的工具有用的信息。这将遍历该命令下面的整个结构。使用 :meth:`click.Context.to_info_dict` 遍历整个CLI结构。:param ctx: :class:`Context`表示这个命令。版本增加： 8.0

🌿46 click.core.Command

Command, click.core.Command, module=click.core, line:1133 at site-packages\click\core.py

命令是Click中命令行接口的基本组成部分。基本命令处理命令行解析，并可能将更多解析分派给嵌套在它下面的命令。:param name:    除非被组覆盖，否则要使用的命令名。:param context_settings:一个可选的字典，带有传递给context对象的默认值。:param callback:    要调用的回调。这是可选的。:param params:  该命令注册的参数。这可以是:class:`Option`或:class:`Argument`对象。:param help:    该命令使用的帮助字符串。:param epilog:  类似于帮助字符串，但它打印在帮助页面的末尾，在其他内容之后。:param short_help:      该命令使用的简短帮助。这显示在父命令的命令列表中。默认情况下，每个命令注册一个``-help``选择。可以通过此参数禁用此功能。:param add_help_option: 这控制了如果没有提供参数会发生什么。默认情况下，该选项是禁用的。如果启用，如果没有传递参数，将添加``-help``作为参数:param hidden:      从帮助输出中隐藏此命令。:param deprecated:  表示该命令已弃用。版本变更： 8.1   ``help``， ``epilog``和``short help ``都是未经处理的存储，所有格式化都是在输出帮助文本时完成的，而不是在init时完成的，即使没有使用``@command``装饰器也会完成。版本变更： 8.0   增加了``repr``，显示命令名称。版本变更： 7.1   增加了``no args is help``参数。版本变更： 2.0   增加了``context_settings``参数。

method

1 collect_usage_pieces(self, ctx: Context) -> t.List[str]:

kind=method class=Command objtype=function line:1245 at …\lib\site-packages\click\core.py

返回进入用法行的所有部分，并将其作为字符串列表返回。
:param code:```
> #### 2	format_epilog(self, ctx: Context, formatter: HelpFormatter) -> None:
> kind=method	class=Command	objtype=function	line:1360 at ...\lib\site-packages\click\core.py

将epilog写入格式化程序(如果存在)。

> #### 3	format_help(self, ctx: Context, formatter: HelpFormatter) -> None:
> kind=method	class=Command	objtype=function	line:1317 at ...\lib\site-packages\click\core.py

将帮助写入格式化程序(如果存在)。
这是一个低级方法，由 :meth:get_help 调用。
这调用了以下方法:
- :meth:format_usage
- :meth:format_help_text
- :meth:format_options
- :meth:format_epilog

> #### 4	format_help_text(self, ctx: Context, formatter: HelpFormatter) -> None:
> kind=method	class=Command	objtype=function	line:1334 at ...\lib\site-packages\click\core.py

将帮助文本写入格式化程序(如果存在)。

> #### 5	format_options(self, ctx: Context, formatter: HelpFormatter) -> None:
> kind=method	class=Command	objtype=function	line:1348 at ...\lib\site-packages\click\core.py

如果存在，则将所有选项写入格式化程序。

> #### 6	format_usage(self, ctx: Context, formatter: HelpFormatter) -> None:
> kind=method	class=Command	objtype=function	line:1237 at ...\lib\site-packages\click\core.py

将用法行写入格式化程序。这是一个低级方法，由:meth:get usage调用。
:param code:```

7 get_help(self, ctx: Context) -> str:

kind=method class=Command objtype=function line:1292 at …\lib\site-packages\click\core.py

将帮助格式化为字符串并返回它。内部调用:meth:`format_help`。

8 get_help_option(self, ctx: Context) -> t.Optional[“Option”]:

kind=method class=Command objtype=function line:1264 at …\lib\site-packages\click\core.py

返回帮助选项对象。

9 get_help_option_names(self, ctx: Context) -> t.List[str]:

kind=method class=Command objtype=function line:1256 at …\lib\site-packages\click\core.py

返回帮助选项的名称。

10 get_params(self, ctx: Context) -> t.List[“Parameter”]:

kind=method class=Command objtype=function line:1228 at …\lib\site-packages\click\core.py

11 get_short_help_str(self, limit: int = 45) -> str:

kind=method class=Command objtype=function line:1301 at …\lib\site-packages\click\core.py

获取命令的简短帮助，或通过缩短长帮助字符串生成帮助。

12 get_usage(self, ctx: Context) -> str:

kind=method class=Command objtype=function line:1219 at …\lib\site-packages\click\core.py

将用法行格式化为字符串并返回它。内部调用:meth:`format_usage`。

13 invoke(self, ctx: Context) -> t.Any:

kind=method class=Command objtype=function line:1393 at …\lib\site-packages\click\core.py

给定上下文，这将以正确的方式调用附加的回调(如果存在)。

14 make_parser(self, ctx: Context) -> OptionParser:

kind=method class=Command objtype=function line:1285 at …\lib\site-packages\click\core.py

创建此命令的基础选项解析器。

15 parse_args(self, ctx: Context, args: t.List[str]) -> t.List[str]:

kind=method class=Command objtype=function line:1369 at …\lib\site-packages\click\core.py

16 shell_complete(self, ctx: Context, incomplete: str) -> t.List[“CompletionItem”]:

kind=method class=Command objtype=function line:1406 at …\lib\site-packages\click\core.py

返回不完整值的补全列表。查看选项和链接的多命令的名称。:param ctx:该命令的调用上下文。:param incomplete:	正在完成的值。可能是空的。版本增加： 8.0

17 to_info_dict(self, ctx: Context) -> t.Dict[str, t.Any]:

kind=method class=Command objtype=function line:1207 at …\lib\site-packages\click\core.py

🌿47 click.core.MultiCommand

MultiCommand, click.core.MultiCommand, module=click.core, line:1442 at site-packages\click\core.py

多命令是将命令分派给子命令的命令的基本实现。最常见的版本是:class:`Group`。:param invoke_without_command:  控制如何调用多命令本身。默认情况下，它只在提供子命令时调用。:param add_help_option: 这控制了如果没有提供参数会发生什么。如果 ``invoke_without_command` 被禁用，则默认启用该选项;如果启用，则禁用该选项。如果启用，将添加，如果没有传递参数，则``-help ``作为参数。:param subcommand_metavar:  在文档中用于指示子命令位置的字符串。:param chain:               如果将此设置为``True``，则启用多个子命令的链接。这限制了命令的形式，因为它们不能有可选参数，但它允许多个命令链接在一起。:param result_callback:     此多命令附加的结果回调。控件设置或更改此属性:meth:`result_callback` 装饰器。

data

1 allow_extra_args=True kind:data type:bool class:<class ‘click.core.MultiCommand’>
2 allow_interspersed_args=False kind:data type:bool class:<class ‘click.core.MultiCommand’>

method

3 collect_usage_pieces(self, ctx: Context) -> t.List[str]:

kind=method class=MultiCommand objtype=function line:1526 at …\lib\site-packages\click\core.py

4 format_commands(self, ctx: Context, formatter: HelpFormatter) -> None:

kind=method class=MultiCommand objtype=function line:1580 at …\lib\site-packages\click\core.py

多方法的额外格式方法，在选项后添加所有命令。

5 format_options(self, ctx: Context, formatter: HelpFormatter) -> None:

kind=method class=MultiCommand objtype=function line:1531 at …\lib\site-packages\click\core.py

6 get_command(self, ctx: Context, cmd_name: str) -> t.Optional[Command]:

kind=method class=MultiCommand objtype=function line:1718 at …\lib\site-packages\click\core.py

给定上下文和命令名称，如果存在，则返回:class:`command`对象，或者返回 `None`。

7 invoke(self, ctx: Context) -> t.Any:

kind=method class=MultiCommand objtype=function line:1623 at …\lib\site-packages\click\core.py

8 list_commands(self, ctx: Context) -> t.List[str]:

kind=method class=MultiCommand objtype=function line:1724 at …\lib\site-packages\click\core.py

按应出现的顺序返回子命令名称的列表。

9 parse_args(self, ctx: Context, args: t.List[str]) -> t.List[str]:

kind=method class=MultiCommand objtype=function line:1608 at …\lib\site-packages\click\core.py

10 resolve_command(

kind=method class=MultiCommand objtype=function line:1691 at …\lib\site-packages\click\core.py

11 result_callback(self, replace: bool = False) -> t.Callable[[F], F]:

kind=method class=MultiCommand objtype=function line:1535 at …\lib\site-packages\click\core.py

向命令添加结果回调。默认情况下，如果一个结果回调已经注册，这将链接它们，但这可以通过`replace`参数禁用。使用子命令的返回值(如果启用了链接，则使用所有子命令的返回值列表)以及将传递给主回调的参数来调用结果回调。示例:@click.group()@click.option('-i', '--input', default=23)def cli(input):return 42@cli.result_callback()def process_result(result, input):return result + input:param replace:     如果设置为``True``，则已经存在的结果回调将被删除。版本更改： 8.0版本变更： 8.0   从``resultcallback``重命名。版本增加： 3.0

12 shell_complete(self, ctx: Context, incomplete: str) -> t.List[“CompletionItem”]:

kind=method class=MultiCommand objtype=function line:1730 at …\lib\site-packages\click\core.py

返回不完整值的补全列表。查看选项、子命令和链接多命令的名称。:param ctx:该命令的调用上下文。:param incomplete:	正在完成的值。可能是空的。版本增加： 8.0

13 to_info_dict(self, ctx: Context) -> t.Dict[str, t.Any]:

kind=method class=MultiCommand objtype=function line:1508 at …\lib\site-packages\click\core.py

🌿48 click.core.Group

Group, click.core.Group, module=click.core, line:1750 at site-packages\click\core.py

组允许命令附加子命令。这是在Click中实现嵌套的最常用方法。:param name:        组命令名称。:param commands:一   个将名称映射到:class:`Command`对象的字典。也可以是:class:`Command`的列表，它将使用:attr:`Command.name`来创建字典。:param attrs:       在:class:`MultiCommand`，:class:`command`和:class:`BaseCommand`中描述的其他命令参数。版本变更： 8.0       ``commands``参数可以是一个命令对象列表。

data

1 command_class=None kind:data type:NoneType class:<class ‘click.core.Group’>
2 group_class=None kind:data type:NoneType class:<class ‘click.core.Group’>

method

3 add_command(self, cmd: Command, name: t.Optional[str] = None) -> None:

kind=method class=Group objtype=function line:1802 at …\lib\site-packages\click\core.py

向该组注册另一个:class:`Command`。如果未提供命令名，则使用命令名。

4 command(self, __func: t.Callable[…, t.Any]) -> Command:

kind=method class=Group objtype=function line:1813 at …\lib\site-packages\click\core.py

用于声明命令并将其附加到组的快捷装饰器。
它采用与:func:`command`相同的参数，并通过调用:meth:`add_command` 立即将创建的命令注册到该组。
要自定义所使用的命令类，请设置:attr:`command_class` 属性。
版本变更： 8.1   这个装饰器可以不带括号。
版本变更： 8.0   增加:attr:`command_class`属性。

5 get_command(self, ctx: Context, cmd_name: str) -> t.Optional[Command]:

kind=method class=Group objtype=function line:1917 at …\lib\site-packages\click\core.py

6 group(self, __func: t.Callable[…, t.Any]) -> “Group”:

kind=method class=Group objtype=function line:1864 at …\lib\site-packages\click\core.py

用于声明组和将组附加到组的快捷装饰器。它采用与:func:`group`相同的参数，并通过调用:meth:`add_command` 立即将创建的组注册到此组。
要自定义所使用的组类，请设置:attr:`group class` 属性。
版本变更： 8.1   这个装饰器可以不带括号。
版本变更： 8.0   增加:attr:`group class`属性。

7 list_commands(self, ctx: Context) -> t.List[str]:

kind=method class=Group objtype=function line:1920 at …\lib\site-packages\click\core.py

🌿49 click.core.CommandCollection

CommandCollection, click.core.CommandCollection, module=click.core, line:1924 at site-packages\click\core.py

命令集合是将多个多命令合并为一个命令的多命令。这是一个简单的实现，它接受一系列不同的多命令作为源，并为每个命令提供所有命令。

method

1 add_source(self, multi_cmd: MultiCommand) -> None:

kind=method class=CommandCollection objtype=function line:1941 at …\lib\site-packages\click\core.py

向链调度程序添加一个新的多命令。

2 get_command(self, ctx: Context, cmd_name: str) -> t.Optional[Command]:

kind=method class=CommandCollection objtype=function line:1945 at …\lib\site-packages\click\core.py

3 list_commands(self, ctx: Context) -> t.List[str]:

kind=method class=CommandCollection objtype=function line:1957 at …\lib\site-packages\click\core.py

🌿50 click.core.Parameter

Parameter, click.core.Parameter, module=click.core, line:134 at site-packages\click\core.py

命令的参数有两个版本:它们是:class:`Option` \s或:class:`Argument` \s。其他子类目前不受设计的支持，因为解析的一些内部结构有意没有最终确定。选项和参数都支持某些设置。:param param_decls: 该选项或实参的参数声明。这是一个标志或参数名称的列表。:param type:    应该使用的类型。a:class:`ParamType` 或Python类型。如果支持，后者将自动转换为前者。:param required:    控制该参数是否是可选的。:param default:     省略时使用默认值。这也可以是一个可调用对象，在这种情况下，当需要默认值而不需要任何参数时调用它。:param callback:    在类型转换后进一步处理或验证值的函数。它被称为``f(ctx, param, value) ``，并且必须返回值。所有源都调用它，包括提示符。:param nargs:   要匹配的参数数量。如果不是``1``，返回值是一个元组而不是单个值。nargs的默认值是``1``(除非类型是元组，那么它是元组的元数)。如果``nargs=-1 ``，则收集所有剩余参数。:param metavar: 该值在帮助页面中的表示方式。:param expose_value:    如果这是 `True`，那么该值将继续传递给命令回调并存储在上下文中，否则它将被跳过。:param is_eager:    在非急切值之前处理急切值。不应该为参数设置此值，否则将颠倒处理顺序。:param envvar:      需要检查的环境变量字符串或字符串列表。:param shell_complete:  一个返回自定义shell补全的函数。如果给定，用于代替参数的类型补全。接受 ``ctx, param, incomplete`` ，并且必须返回一个列表 :class:`~click.shell_completion.CompletionItem` 或字符串列表。版本变更： 8.0 ``process value``验证所需的参数和有界的``nargs``，并在返回值之前调用参数回调。这允许回调验证提示。``full_process_value`` 被删除。版本变更： 8.0 ``autocompletion``重命名为``shell_complete``，并具有上面描述的新语义。旧名称已被弃用，并将在8.1中删除，在此之前它将被包装以匹配新的要求。对于``multiple=True, nargs>1``，默认值必须是一个元组列表。不再需要为``nargs>1 ``设置默认值，它将默认为``None``。``multiple=True`` 或 ``nargs=-1`` 将默认为``()``。版本变更： 7.1   忽略空的环境变量，而不是接受空字符串值。这使得脚本可以在无法取消设置的情况下清除变量。版本变更： 2.0   修改了参数callback的签名，也传递给参数。旧的回调格式仍然可以工作，但它会引发一个警告，让您有机会更容易地迁移代码。

data

1 param_type_name=parameter kind:data type:str class:<class ‘click.core.Parameter’>

property

2 human_readable_name=<property object at 0x000002B715551C28> kind:property type:property class:<class ‘click.core.Parameter’>

method

3 add_to_parser(self, parser: OptionParser, ctx: Context) -> None:

kind=method class=Parameter objtype=function line:2233 at …\lib\site-packages\click\core.py

4 consume_value(

kind=method class=Parameter objtype=function line:2236 at …\lib\site-packages\click\core.py

5 get_default(

kind=method class=Parameter objtype=function line:2189 at …\lib\site-packages\click\core.py

获取参数的默认值。首先试 :meth:`Context.lookup_default`，然后查找本地默认值。:param ctx: 当前上下文。:param call:如果默认值是可调用的，调用它。禁用返回可调用对象。版本变更： 8.0.2 获取默认值时不再执行类型强制转换。版本变更： 8.0.1 类型转换在弹性解析模式下可能失败。无效的默认值不会阻止显示帮助文本。版本变更： 8.0   首先查看``ctx.default_map`` 。版本变更： 8.0   增加了``call``参数。

6 get_error_hint(self, ctx: Context) -> str:

kind=method class=Parameter objtype=function line:2378 at …\lib\site-packages\click\core.py

获取参数的字符串化版本，以便在错误消息中使用，以指示导致错误的参数。

7 get_help_record(self, ctx: Context) -> t.Optional[t.Tuple[str, str]]:

kind=method class=Parameter objtype=function line:2372 at …\lib\site-packages\click\core.py

8 get_usage_pieces(self, ctx: Context) -> t.List[str]:

kind=method class=Parameter objtype=function line:2375 at …\lib\site-packages\click\core.py

9 handle_parse_result(

kind=method class=Parameter objtype=function line:2352 at …\lib\site-packages\click\core.py

10 make_metavar(self) -> str:

kind=method class=Parameter objtype=function line:2174 at …\lib\site-packages\click\core.py

11 process_value(self, ctx: Context, value: t.Any) -> t.Any:

kind=method class=Parameter objtype=function line:2315 at …\lib\site-packages\click\core.py

12 resolve_envvar_value(self, ctx: Context) -> t.Optional[str]:

kind=method class=Parameter objtype=function line:2326 at …\lib\site-packages\click\core.py

13 shell_complete(self, ctx: Context, incomplete: str) -> t.List[“CompletionItem”]:

kind=method class=Parameter objtype=function line:936 at …\lib\site-packages\click\core.py

返回不完整值的补全列表。查看选项和链接的多命令的名称。:param ctx:该命令的调用上下文。:param incomplete:	正在完成的值。可能是空的。版本增加： 8.0

14 to_info_dict(self) -> t.Dict[str, t.Any]:

kind=method class=Parameter objtype=function line:432 at …\lib\site-packages\click\core.py

收集可能对生成面向用户文档的工具有用的信息。
使用 :meth:`click.Context.to_info_dict`遍历整个CLI结构。	
版本增加： 8.0

15 type_cast_value(self, ctx: Context, value: t.Any) -> t.Any:

kind=method class=Parameter objtype=function line:2256 at …\lib\site-packages\click\core.py

根据选项:attr:`type`、:attr:`multiple`和:attr:`nargs`转换并验证值。

16 value_from_envvar(self, ctx: Context) -> t.Optional[t.Any]:

kind=method class=Parameter objtype=function line:2344 at …\lib\site-packages\click\core.py

17 value_is_missing(self, value: t.Any) -> bool:

kind=method class=Parameter objtype=function line:2306 at …\lib\site-packages\click\core.py

🌿51 click.core.Option

Option, click.core.Option, module=click.core, line:2409 at site-packages\click\core.py

选项通常是命令行上的可选值，并且具有参数所不具备的一些额外特性。所有其他参数都传递给参数构造函数。:param show_default:    在帮助文本中显示该选项的默认值。默认情况下不显示值，除非:attr:`Context.show_default` is ``True``。如果此值是字符串，则在括号中显示该字符串，而不是实际值。这对于动态选项特别有用。对于单选项布尔标志，如果其值为``False``，则默认值保持隐藏。:param show_envvar:     控制是否在帮助页面上显示环境变量。通常，不显示环境变量。:param prompt:          如果设置为``True``或非空字符串，则会提示用户输入。如果设置为``True``，提示符将是大写的选项名。:param confirmation_prompt: 提示第二次确认的值，如果提示。可以设置为字符串而不是``True``以自定义消息。:param prompt_required: 如果设置为``False``，只有当该选项被指定为一个没有值的标志时，才会提示用户输入。:param hide_input:      如果这是``True``，那么提示符上的输入将对用户隐藏。这对于密码输入很有用。:param is_flag:         强制此选项作为标志。默认为自动检测。:param flag_value:      如果启用了该标志，应该使用哪个值。如果选项字符串包含标记两个选项的斜杠，则自动将其设置为布尔值。:param multiple:        如果设置为 `True`，则参数被多次接受并记录。这在工作方式上类似于``nargs``，但支持任意数量的参数。:param count:           该标志使选项增量为整数。:param allow_from_autoenv:  如果启用了此功能，则如果在上下文中定义了前缀，则该参数的值将从环境变量中提取。:param help:            帮助字符串。:param hidden:          在帮助输出中隐藏该选项。版本变更： 8.1.0     帮助文本缩进在这里被清除，而不是只在``@option``装饰器中。版本变更： 8.1.0     ``show_default``参数覆盖``Context.show_default``。版本变更： 8.1.0     如果默认值为``False``，则不显示单个选项布尔标志的默认值。版本变更： 8.0.1     如果给定，则从 ``flag_value`` 中检测``type``。

data

1 param_type_name=option kind:data type:str class:<class ‘click.core.Option’>

method

2 add_to_parser(self, parser: OptionParser, ctx: Context) -> None:

kind=method class=Option objtype=function line:2651 at …\lib\site-packages\click\core.py

3 consume_value(

kind=method class=Option objtype=function line:2887 at …\lib\site-packages\click\core.py

4 get_default(

kind=method class=Option objtype=function line:2799 at …\lib\site-packages\click\core.py

5 get_help_record(self, ctx: Context) -> t.Optional[t.Tuple[str, str]]:

kind=method class=Option objtype=function line:2690 at …\lib\site-packages\click\core.py

6 prompt_for_value(self, ctx: Context) -> t.Any:

kind=method class=Option objtype=function line:2826 at …\lib\site-packages\click\core.py

这是一个可选流，如果值不存在，则可以在完整值处理中激活它。它将提示用户，直到存在一个有效值，然后返回处理后的值作为结果。

7 resolve_envvar_value(self, ctx: Context) -> t.Optional[str]:

kind=method class=Option objtype=function line:2852 at …\lib\site-packages\click\core.py

8 to_info_dict(self) -> t.Dict[str, t.Any]:

kind=method class=Option objtype=function line:2586 at …\lib\site-packages\click\core.py

9 value_from_envvar(self, ctx: Context) -> t.Optional[t.Any]:

kind=method class=Option objtype=function line:2871 at …\lib\site-packages\click\core.py

🌿52 click.core.Argument

Argument, click.core.Argument, module=click.core, line:2925 at site-packages\click\core.py

参数是命令的位置参数。
它们通常提供的功能比选项少，但可以有无限的``nargs``，并且默认情况下是必需的。
所有参数都传递给参数构造函数。

data

1 param_type_name=argument kind:data type:str class:<class ‘click.core.Argument’>

property

2 human_readable_name=<property object at 0x000002B715556A48> kind:property type:property class:<class ‘click.core.Argument’>

method

3 add_to_parser(self, parser: OptionParser, ctx: Context) -> None:

kind=method class=Argument objtype=function line:2997 at …\lib\site-packages\click\core.py

4 get_error_hint(self, ctx: Context) -> str:

kind=method class=Argument objtype=function line:2994 at …\lib\site-packages\click\core.py

5 get_usage_pieces(self, ctx: Context) -> t.List[str]:

kind=method class=Argument objtype=function line:2991 at …\lib\site-packages\click\core.py

6 make_metavar(self) -> str:

kind=method class=Argument objtype=function line:2962 at …\lib\site-packages\click\core.py

🔵私有或局部

53 _ <function gettext at 0x000002B7154958B8>
54 _flag_needs_value <object object at 0x000002B714960EC0>
55 _detect_program_name <function _detect_program_name at 0x000002B715504798>
56 _expand_args <function _expand_args at 0x000002B7155049D8>
57 _complete_visible_commands <function _complete_visible_commands at 0x000002B715538438>
58 _check_multicommand <function _check_multicommand at 0x000002B715538D38>
59 _check_iter <function _check_iter at 0x000002B715543168>

🔵剩余

60 doc
61 loader <_frozen_importlib_external.SourceFileLoader object at 0x000002B715460508>
62 spec ModuleSpec(name=‘click.core’, loader=<_frozen_importlib_external.SourceFileLoader object at 0x000002B715460508>, origin=‘…\lib\site-packages\click\core.py’)
63 _flag_needs_value <object object at 0x000002B714960EC0>
64 F ~F
65 V ~V

☘️【click.decorators】

decorators, fullname=click.decorators, file=click\decorators.py

🔵统计

序号	类别	数量
4	str	4
8	dict	1
9	module	3
10	class	6
11	function	17
13	residual	6
14	system	8
15	private	2
16	all	37

🔵模块

🌿1 inspect

inspect, fullname=inspect, file=inspect.py

🌿2 types

types, fullname=types, file=types.py

🌿3 typing

typing, fullname=typing, file=typing.py

🔵函数

🌿4 update_wrapper(wrapper, wrapped, assigned=(‘module’, ‘name’, ‘qualname’, ‘doc’, ‘annotations’), updated=(‘dict’,))

update_wrapper(wrapper, wrapped, assigned=(‘module’, ‘name’, ‘qualname’, ‘doc’, ‘annotations’), updated=(‘dict’,)), module=functools, line:37 at functools.py

更新包装器函数使其看起来像被包装的函数。
包装器是要更新的函数。包装器是分配的原始函数。
包装器是一个元组，命名从包装函数直接分配给包装器函数的属性(默认为 functools.WRAPPER_ASSIGNMENTS))是一个命名包装器属性的元组，
这些属性是用包装函数(默认为 functools.WRAPPER_UPDATES)

🌿5 gettext(message)

gettext(message), module=gettext, line:624 at gettext.py

🌿6 get_current_context(silent: bool = False) -> Union[ForwardRef(‘Context’), NoneType]

get_current_context(silent: bool = False) -> Union[ForwardRef(‘Context’), NoneType], module=click.globals, line:21 at site-packages\click\globals.py

返回当前单击上下文。
这可以用作从任何地方访问当前上下文对象的一种方式。
这是对 :func:`pass_context` 装饰器的一种更隐式的替代。
此函数主要用于:func:`echo`等helper，这些helper可能有兴趣根据当前上下文更改其行为。
要推送当前上下文，:meth:`Context.scope` 可以使用。版本增加： 5.0:param silent:  如果设置为 `True`，如果没有上下文可用，返回值为 `None`。默认行为是引发 :exc:`RuntimeError`。

🌿7 echo(message: Union[Any, NoneType] = None, file: Union[IO[Any], NoneType] = None, nl: bool = True, err: bool = False, color: Union[bool, NoneType] = None) -> None

echo(message: Union[Any, NoneType] = None, file: Union[IO[Any], NoneType] = None, nl: bool = True, err: bool = False, color: Union[bool, NoneType] = None) -> None, module=click.utils, line:205 at site-packages\click\utils.py

将消息和换行符打印到标准输出或文件。这应该用来代替:func:`print`，因为它可以更好地支持不同的数据、文件和环境。与:func:`print`相比，它做了以下事情:-确保在Linux上没有错误配置输出编码。-在Windows控制台中支持Unicode。-支持写入二进制输出，支持写入字节到文本输出。-支持Windows上的颜色和样式。-如果输出看起来不像交互式终端，则删除ANSI颜色和样式代码。-总是刷新输出。:param message: 要输出的字符串或字节。其他对象被转换为字符串。:param file:    要写入的文件。默认为``stdout``。:param err:     写入``stderr``而不是``stdout``。:param nl:  在消息后打印换行符。默认开启。:param color:       强制显示或隐藏颜色和其他样式。默认情况下，如果输出看起来不像交互式终端，Click将删除颜色。版本变更：   6.0 支持Windows控制台上的Unicode输出。单击不修改``sys``。stdout``，所以``sys.stdout.write()``和``print() ``仍然不支持Unicode。版本变更：   4.0 增加了``color``参数。版本增加： 3.0   增加``err``参数。版本变更： 2.0如果安装了colorama，则支持Windows上的颜色。

🌿8 pass_context(f: ~F) -> ~F

pass_context(f: ~F) -> ~F, module=click.decorators, line:20 at site-packages\click\decorators.py

将回调标记为希望接收当前上下文对象作为第一个参数。

🌿9 pass_obj(f: ~F) -> ~F

pass_obj(f: ~F) -> ~F, module=click.decorators, line:31 at site-packages\click\decorators.py

类似于:func:`传递context`，但只在上下文上传递对象(:attr:`context.obj`)。如果该对象表示嵌套系统的状态，这是有用的。

🌿10 make_pass_decorator(object_type: Type, ensure: bool = False) -> ‘t.Callable[[F], F]’

make_pass_decorator(object_type: Type, ensure: bool = False) -> ‘t.Callable[[F], F]’, module=click.decorators, line:43 at site-packages\click\decorators.py

给定一个对象类型，这会创建一个装饰器，其工作原理类似于 :func:`pass_obj`，
但它不会传递当前上下文的对象，而是会找到 :func:`object_type` 的最内层上下文。这将生成一个工作原理大致如下的装饰器:from functools import update_wrapperdef decorator(f):@pass_contextdef new_func(ctx, *args, **kwargs):obj = ctx.find_object(object_type)return ctx.invoke(f, obj, *args, **kwargs)return update_wrapper(new_func, f)return decorator:param object_type: 要传递的对象类型。:param ensure:  如果设置为`True`，一个新对象将被创建，如果它还没有在上下文中，它将被记住。

🌿11 pass_meta_key(key: str, *, doc_description: Union[str, NoneType] = None) -> ‘t.Callable[[F], F]’

pass_meta_key(key: str, *, doc_description: Union[str, NoneType] = None) -> ‘t.Callable[[F], F]’, module=click.decorators, line:91 at site-packages\click\decorators.py

创建一个从:attr:`click.Context.meta` 传入一个键作为修饰函数的第一个参数。:param key:  ``Context.meta``传递。:param doc_description:插入到装饰器的文档字符串中。默认为" Context.meta中的'key'键"。版本增加： 8.0

🌿12 command(name: Union[str, Callable[…, Any], NoneType] = None, cls: Union[Type[click.core.Command], NoneType] = None, **attrs: Any) -> Union[click.core.Command, Callable[…, click.core.Command]]

command(name: Union[str, Callable[…, Any], NoneType] = None, cls: Union[Type[click.core.Command], NoneType] = None, **attrs: Any) -> Union[click.core.Command, Callable[…, click.core.Command]], module=click.decorators, line:151 at site-packages\click\decorators.py

创建一个新的 :class:`Command` 并使用装饰函数作为回调函数。
这也会自动将所有修饰过的 :func:`option`\s and :func:`argument`\s 作为参数附加到命令。
命令名默认为函数名，下划线被破折号替换。如果您想更改它，可以将预期的名称作为第一个参数传递。
所有关键字参数都转发给底层命令类。
对于``params``参数，任何修饰的参数都被附加到列表的末尾。
一旦被修饰，该函数就变成了一个 :class:`Command` 实例，可以作为命令行实用程序调用，也可以附加到命令 :class:`Group` 上。:param name:    命令名。这默认为函数名，下划线被破折号替换。:param cls:     要实例化的命令类。默认为 :class:`Command`。版本变化: 8.1这个装饰器可以不带括号地应用。版本变化: 8.1可以使用 ``params`` 参数。修饰参数被附加到列表的末尾。

🌿13 group(name: Union[str, Callable[…, Any], NoneType] = None, **attrs: Any) -> Union[click.core.Group, Callable[[~F], click.core.Group]]

group(name: Union[str, Callable[…, Any], NoneType] = None, **attrs: Any) -> Union[click.core.Group, Callable[[~F], click.core.Group]], module=click.decorators, line:244 at site-packages\click\decorators.py

创建一个新的:class:`Group`函数作为回调函数。
它的工作原理与:func:`command`相同，只是`cls`参数被设置为:class:`Group`。版本更改： 8.1
这个装饰器可以不带圆括号。

🌿14 _param_memo(f: ~FC, param: click.core.Parameter) -> None

_param_memo(f: ~FC, param: click.core.Parameter) -> None, module=click.decorators, line:264 at site-packages\click\decorators.py

🌿15 argument(*param_decls: str, **attrs: Any) -> Callable[[~FC], ~FC]

argument(*param_decls: str, **attrs: Any) -> Callable[[~FC], ~FC], module=click.decorators, line:274 at site-packages\click\decorators.py

将参数附加到命令。所有位置参数都作为形参声明传递给:class:`Argument`;所有关键字参数都被原封不动地转发(``cls``除外)。
这相当于手动创建一个:class:`Argument`实例并将其附加到 :attr:`Command.params` 列表。param cls:要实例化的参数类。默认为:class:`Argument`。

🌿16 option(*param_decls: str, **attrs: Any) -> Callable[[~FC], ~FC]

option(*param_decls: str, **attrs: Any) -> Callable[[~FC], ~FC], module=click.decorators, line:293 at site-packages\click\decorators.py

将选项附加到命令。所有位置参数都作为形参声明传递给:class:`Option`;所有关键字参数都被原封不动地转发(``cls``除外)。
这相当于手动创建一个:class:`Option`实例，并将其附加到 :attr:`Command.params` 列表。
param cls:要实例化的选项类。默认为:class:`Option`。

🌿17 confirmation_option(*param_decls: str, **kwargs: Any) -> Callable[[~FC], ~FC]

confirmation_option(*param_decls: str, **kwargs: Any) -> Callable[[~FC], ~FC], module=click.decorators, line:314 at site-packages\click\decorators.py

添加“-yes”选项，如果未通过，则在继续之前显示提示。如果拒绝提示，程序将退出。
:param param_decls:一个或多个选项名。默认为单个值``"--yes"``。
:param kwargs:额外的参数传递给:func:`option`。

🌿18 password_option(*param_decls: str, **kwargs: Any) -> Callable[[~FC], ~FC]

password_option(*param_decls: str, **kwargs: Any) -> Callable[[~FC], ~FC], module=click.decorators, line:338 at site-packages\click\decorators.py

添加``-password``选项，提示输入密码，隐藏输入并要求再次输入值以进行确认。
:param param_decls:一个或多个选项名。默认为单个值 ``"--password"``。
:param kwargs:额外的参数传递给:func:`option`。

🌿19 version_option(version: Union[str, NoneType] = None, *param_decls: str, package_name: Union[str, NoneType] = None, prog_name: Union[str, NoneType] = None, message: Union[str, NoneType] = None, **kwargs: Any) -> Callable[[~FC], ~FC]

version_option(version: Union[str, NoneType] = None, *param_decls: str, package_name: Union[str, NoneType] = None, prog_name: Union[str, NoneType] = None, message: Union[str, NoneType] = None, **kwargs: Any) -> Callable[[~FC], ~FC], module=click.decorators, line:355 at site-packages\click\decorators.py

添加``--version``选项，立即打印版本号并退出程序。如果没有提供``version``， Click将尝试使用:func:`importlib.metadata`检测它。获取``package_name`` 的版本。在Python < 3.8中，必须安装``importlib_metadata`` backport。如果没有提供``package_name``，Click将尝试通过检查堆栈帧来检测它。这将用于检测版本，因此它必须与安装包的名称匹配。:参数version:要显示的版本号。如果没有提供，Click将尝试检测它。:param param_decls:一个或多个选项名。默认为单个值``"--version"``。:param package name:要检测版本的包名。如果没有提供，Click将尝试检测它。:param prog_name:要在消息中显示的命令行CLI 名称。如果没有提供，它将从命令中检测到。:param message:要显示的消息。值``%(prog)s``, ``%(package)s``,和``%(version)s``是可用的。默认为 ``"%(prog)s, version %(version)s"``。:param kwargs:额外的参数传递给:func:`option`。:raise RuntimeError: ``version``无法被检测到。版本变更： 8.0添加``package_name``参数和``%(package)s``参数。消息变更： 8.0使用 :mod:`importlib.metadata` 而不是``pkg_resources``。版本是基于包名而不是入口点名来检测的。Python包名必须与已安装的包名匹配，或者使用``package name=``传递。

🌿20 help_option(*param_decls: str, **kwargs: Any) -> Callable[[~FC], ~FC]

help_option(*param_decls: str, **kwargs: Any) -> Callable[[~FC], ~FC], module=click.decorators, line:469 at site-packages\click\decorators.py

添加``--help``选项，立即打印帮助页并退出程序。
这通常是不必要的，因为 ``--help`` 选项会自动添加到每个命令中，除非传递``add_help_option=False``。:param param_decls: 一个或多个选项名。默认为单个值``"--help"``。:param kwargs:  额外的参数传递给 :func:`option` 。

🔵类

🌿21 click.core.Argument

Argument, click.core.Argument, module=click.core, line:2925 at site-packages\click\core.py

参数是命令的位置参数。
它们通常提供的功能比选项少，但可以有无限的``nargs``，并且默认情况下是必需的。
所有参数都传递给参数构造函数。

data

1 param_type_name=argument kind:data type:str class:<class ‘click.core.Argument’>

property

2 human_readable_name=<property object at 0x0000026F3E9A5C78> kind:property type:property class:<class ‘click.core.Argument’>

method

3 add_to_parser(self, parser: OptionParser, ctx: Context) -> None:

kind=method class=Argument objtype=function line:2997 at …\lib\site-packages\click\core.py

4 get_error_hint(self, ctx: Context) -> str:

kind=method class=Argument objtype=function line:2994 at …\lib\site-packages\click\core.py

5 get_usage_pieces(self, ctx: Context) -> t.List[str]:

kind=method class=Argument objtype=function line:2991 at …\lib\site-packages\click\core.py

6 make_metavar(self) -> str:

kind=method class=Argument objtype=function line:2962 at …\lib\site-packages\click\core.py

🌿22 click.core.Command

Command, click.core.Command, module=click.core, line:1133 at site-packages\click\core.py

命令是Click中命令行接口的基本组成部分。基本命令处理命令行解析，并可能将更多解析分派给嵌套在它下面的命令。:param name:    除非被组覆盖，否则要使用的命令名。:param context_settings:一个可选的字典，带有传递给context对象的默认值。:param callback:    要调用的回调。这是可选的。:param params:  该命令注册的参数。这可以是:class:`Option`或:class:`Argument`对象。:param help:    该命令使用的帮助字符串。:param epilog:  类似于帮助字符串，但它打印在帮助页面的末尾，在其他内容之后。:param short_help:      该命令使用的简短帮助。这显示在父命令的命令列表中。默认情况下，每个命令注册一个``-help``选择。可以通过此参数禁用此功能。:param add_help_option: 这控制了如果没有提供参数会发生什么。默认情况下，该选项是禁用的。如果启用，如果没有传递参数，将添加``-help``作为参数:param hidden:      从帮助输出中隐藏此命令。:param deprecated:  表示该命令已弃用。版本变更： 8.1   ``help``， ``epilog``和``short help ``都是未经处理的存储，所有格式化都是在输出帮助文本时完成的，而不是在init时完成的，即使没有使用``@command``装饰器也会完成。版本变更： 8.0   增加了``repr``，显示命令名称。版本变更： 7.1   增加了``no args is help``参数。版本变更： 2.0   增加了``context_settings``参数。

method

1 collect_usage_pieces(self, ctx: Context) -> t.List[str]:

kind=method class=Command objtype=function line:1245 at …\lib\site-packages\click\core.py

返回进入用法行的所有部分，并将其作为字符串列表返回。

2 format_epilog(self, ctx: Context, formatter: HelpFormatter) -> None:

kind=method class=Command objtype=function line:1360 at …\lib\site-packages\click\core.py

将epilog写入格式化程序(如果存在)。

3 format_help(self, ctx: Context, formatter: HelpFormatter) -> None:

kind=method class=Command objtype=function line:1317 at …\lib\site-packages\click\core.py

将帮助写入格式化程序(如果存在)。这是一个低级方法，由 :meth:`get_help` 调用。这调用了以下方法:-   :meth:`format_usage`-   :meth:`format_help_text`-   :meth:`format_options`-   :meth:`format_epilog`

4 format_help_text(self, ctx: Context, formatter: HelpFormatter) -> None:

kind=method class=Command objtype=function line:1334 at …\lib\site-packages\click\core.py

将帮助文本写入格式化程序(如果存在)。

5 format_options(self, ctx: Context, formatter: HelpFormatter) -> None:

kind=method class=Command objtype=function line:1348 at …\lib\site-packages\click\core.py

如果存在，则将所有选项写入格式化程序。

6 format_usage(self, ctx: Context, formatter: HelpFormatter) -> None:

kind=method class=Command objtype=function line:1237 at …\lib\site-packages\click\core.py

将用法行写入格式化程序。这是一个低级方法，由:meth:`get usage`调用。

7 get_help(self, ctx: Context) -> str:

kind=method class=Command objtype=function line:1292 at …\lib\site-packages\click\core.py

将帮助格式化为字符串并返回它。内部调用:meth:`format_help`。
format_help```
> #### 8	get_help_option(self, ctx: Context) -> t.Optional["Option"]:
> kind=method	class=Command	objtype=function	line:1264 at ...\lib\site-packages\click\core.py

返回帮助选项对象。

> #### 9	get_help_option_names(self, ctx: Context) -> t.List[str]:
> kind=method	class=Command	objtype=function	line:1256 at ...\lib\site-packages\click\core.py

返回帮助选项的名称。

> #### 10	get_params(self, ctx: Context) -> t.List["Parameter"]:
> kind=method	class=Command	objtype=function	line:1228 at ...\lib\site-packages\click\core.py
> #### 11	get_short_help_str(self, limit: int = 45) -> str:
> kind=method	class=Command	objtype=function	line:1301 at ...\lib\site-packages\click\core.py

获取命令的简短帮助，或通过缩短长帮助字符串生成帮助。
format_help```

12 get_usage(self, ctx: Context) -> str:

kind=method class=Command objtype=function line:1219 at …\lib\site-packages\click\core.py

将用法行格式化为字符串并返回它。内部调用:meth:`format_usage`。

13 invoke(self, ctx: Context) -> t.Any:

kind=method class=Command objtype=function line:1393 at …\lib\site-packages\click\core.py

给定上下文，这将以正确的方式调用附加的回调(如果存在)。

14 make_parser(self, ctx: Context) -> OptionParser:

kind=method class=Command objtype=function line:1285 at …\lib\site-packages\click\core.py

创建此命令的基础选项解析器。

15 parse_args(self, ctx: Context, args: t.List[str]) -> t.List[str]:

kind=method class=Command objtype=function line:1369 at …\lib\site-packages\click\core.py

16 shell_complete(self, ctx: Context, incomplete: str) -> t.List[“CompletionItem”]:

kind=method class=Command objtype=function line:1406 at …\lib\site-packages\click\core.py

返回不完整值的补全列表。查看选项和链接的多命令的名称。:param ctx:该命令的调用上下文。:param incomplete:	正在完成的值。可能是空的。版本增加： 8.0

17 to_info_dict(self, ctx: Context) -> t.Dict[str, t.Any]:

kind=method class=Command objtype=function line:1207 at …\lib\site-packages\click\core.py

🌿23 click.core.Context

Context, click.core.Context, module=click.core, line:160 at site-packages\click\core.py

上下文是一个特殊的内部对象，它保存着与每个级别的脚本执行相关的状态。它通常对命令是不可见的，除非他们选择访问它。上下文很有用，因为它可以传递内部对象，并且可以控制特殊的执行特性，例如从环境变量中读取数据。上下文可以用作上下文管理器，在这种情况下，它将在teardown时调用:meth:`close`。:param command:             此上下文的命令类。:param parent:              父上下文。:param info_name:           此调用的info名称。通常，这是脚本或命令最具描述性的名称。对于顶层脚本，它通常是脚本的名称，对于下面的命令，它是脚本的名称。:param obj:                 用户数据的任意对象。:param auto_envvar_prefix:  用于自动环境变量的前缀。如果这是 `None`，则禁用从环境变量读取。这不会影响总是读取的手动设置的环境变量。:param default_map:         一个字典(类似于object)，具有默认的参数值。:参数终端宽度:终端的宽度。默认是继承自父上下文。如果没有上下文定义终端宽度，则将应用自动检测。:param max_content_width:   Click渲染内容的最大宽度(目前只影响帮助页面)。如果没有覆盖，默认为80个字符。换句话说:即使终端大于80个字符，默认情况下Click也不会格式化大于80个字符的内容。除此之外，格式化器可能会在右侧添加一些安全映射。:param resilient_parsing:   如果启用此标志，则Click将在没有任何交互或回调调用的情况下进行解析。默认值也将被忽略。这对于实现诸如补全支持之类的东西很有用。:param allow_extra_args:    如果将此设置为 `True`，则最后的额外参数不会引发错误，并将保留在上下文中。默认是从命令继承。:param allow_interspersed_args: 如果设置为`False`，则选项和参数不能混合。默认是从命令继承。:param ignore_unknown_options:  指示click忽略它不知道的选项，并保留它们以供以后处理。param help_option_names:        可选的字符串列表，这些字符串定义了默认帮助参数的命名方式。默认值是``['--help']``。:param token_normalize_func:        一个可选函数，用于规范化标记(选项，选择等)。例如，这可以用来实现不区分大小写的行为。:param color:   控制终端是否支持ANSI颜色。默认是自动检测。只有在Click打印的文本中使用ANSI代码时才需要这样做，这在默认情况下不是这种情况。例如，这将影响帮助输出。:param show_default:显示命令的默认值。如果未设置此值，则默认为来自父上下文的值。``Command.show_default`` 将覆盖特定命令的默认值。版本变更： 8.1   ``show_default``参数被``Command.show_default``覆盖，而不是相反。版本变更： 8.0   参数show_default默认为父上下文的值版本变更： 7.1   增加了``show_default``参数。版本变更： 4.0   增加了``color``， ``ignore_unknown_options``和 ``max_content_width``参数。版本变更： 3.0   增加了``allow_extra_args``和``allow_interspersed_args``版本变更： 2.0   增加了``resilient_parsing``，``help_option_names``和'token_normalize_func``参数。

data

1 formatter_class=<class ‘click.formatting.HelpFormatter’> kind:data type:type class:<class ‘click.core.Context’>

property

2 command_path=<property object at 0x0000026F3E995048> kind:property type:property class:<class ‘click.core.Context’>
3 meta=<property object at 0x0000026F3E98FA98> kind:property type:property class:<class ‘click.core.Context’>

method

4 abort(self) -> “te.NoReturn”:

kind=method class=Context objtype=function line:681 at …\lib\site-packages\click\core.py

中止脚本。

5 call_on_close(self, f: t.Callable[…, t.Any]) -> t.Callable[…, t.Any]:

kind=method class=Context objtype=function line:573 at …\lib\site-packages\click\core.py

注册一个在上下文断开时调用的函数。这可用于关闭在脚本执行期间打开的资源。
支持Python上下文管理器协议的资源应该在``with``语句中使用，而应该在:meth:`with_resource`中注册。
:param f:在teardown时执行的函数。

6 close(self) -> None:

kind=method class=Context objtype=function line:585 at …\lib\site-packages\click\core.py

调用所有用:meth:`call_on_close` 注册的close回调，并退出所有用:meth:`with_resource` 进入的上下文管理器。

7 ensure_object(self, object_type: t.Type[V]) -> V:

kind=method class=Context objtype=function line:632 at …\lib\site-packages\click\core.py

类似于:meth:`find_object '，但如果最里面的对象不存在，则将其设置为 `object_type` 的新实例。

8 exit(self, code: int = 0) -> “te.NoReturn”:

kind=method class=Context objtype=function line:685 at …\lib\site-packages\click\core.py

使用给定的退出代码退出应用程序。

9 fail(self, message: str) -> “te.NoReturn”:

kind=method class=Context objtype=function line:673 at …\lib\site-packages\click\core.py

用特定的错误消息中止程序的执行。
:param message:要失败的错误消息。

10 find_object(self, object_type: t.Type[V]) -> t.Optional[V]:

kind=method class=Context objtype=function line:620 at …\lib\site-packages\click\core.py

查找与给定类型最接近的对象。

11 find_root(self) -> “Context”:

kind=method class=Context objtype=function line:613 at …\lib\site-packages\click\core.py

查找最外层的上下文。

12 forward(

kind=method class=Context objtype=function line:762 at …\lib\site-packages\click\core.py

类似于:meth:`invoke`，但如果其他命令需要，则填充当前上下文中的默认关键字参数。这不能直接调用回调，只能调用其他命令。版本更改： 8.0
所有``kwargs``都在:attr:`params`中跟踪，因此如果``forward``在多个级别被调用，它们将被传递。

13 get_help(self) -> str:

kind=method class=Context objtype=function line:695 at …\lib\site-packages\click\core.py

方法获取当前上下文和命令的格式化帮助页。

14 get_parameter_source(self, name: str) -> t.Optional[ParameterSource]:

kind=method class=Context objtype=function line:792 at …\lib\site-packages\click\core.py

获取参数的来源。这表示获取参数值的位置。这对于确定用户何时在命令行上指定与默认值相同的值非常有用。它将是 :           attr:`~click.core.ParameterSource.DEFAULT` 只有当值实际上是从默认值中获取时才会使用。:param name:    参数名称。:rtype:     ParameterSource版本变更： 8.0   如果参数不是从任何来源提供的，则返回``None``。

15 get_usage(self) -> str:

kind=method class=Context objtype=function line:689 at …\lib\site-packages\click\core.py

方法获取当前上下文和命令的格式化用法字符串。

16 invoke()

kind=method class=Context objtype=function line:709 at …\lib\site-packages\click\core.py

以它期望的方式调用命令回调。有两种方法可以调用这个方法:1. 第一个参数可以是回调，所有其他参数和关键字参数都直接转发给函数。2. 第一个参数是一个click command对象。在这种情况下，所有的参数都被转发，但适当的点击参数(选项和点击参数)必须是关键字参数和点击将填写默认值。请注意，在Click 3.2之前，关键字参数没有正确填写，这违背了代码的意图，也没有创建上下文。有关此更改的更多信息以及为什么在错误修复版本中完成，请参阅 :ref:`upgrade-to-3.2`版本更改： 8.0所有的``kwargs``都在:attr:`params`中跟踪，所以如果在多个级别调用:meth:`forward`，它们将被传递。

17 lookup_default(

kind=method class=Context objtype=function line:642 at …\lib\site-packages\click\core.py

从:attr:`default_map`中获取参数的默认值。
:param name:参数名称。
:param call:如果默认值是可调用的，调用它。禁用返回可调用对象
版本变更： 8.0增加了``call``参数。

18 make_formatter(self) -> HelpFormatter:

kind=method class=Context objtype=function line:530 at …\lib\site-packages\click\core.py

创建:类:`~click。用于帮助和用法输出的HelpFormatter。
要快速自定义使用的格式化器类而不重写此方法，请设置:attr:`formatter_class`属性。
版本变更： 8.0增加:attr:`formatter_class`属性。

19 scope(self, cleanup: bool = True) -> t.Iterator[“Context”]:

kind=method class=Context objtype=function line:465 at …\lib\site-packages\click\core.py

这个辅助方法可以与context对象一起使用，以将其提升到当前线程本地(参见:func:`get_current_context`)。它的默认行为是调用清理函数，可以通过将`cleanup`设置为`False`来禁用该函数。清理函数通常用于关闭文件句柄等操作。如果要进行清理，也可以直接将上下文对象用作上下文管理器。示例用法:with ctx.scope():assert get_current_context() is ctx与ctx等价:with ctx:assert get_current_context() is ctx版本增加： 5.0::param cleanup: 控制是否应该运行清理函数。默认是运行这些函数。在某些情况下，上下文只希望被临时推送，在这种情况下可以禁用此功能。嵌套推送自动延迟清理。

20 set_parameter_source(self, name: str, source: ParameterSource) -> None:

kind=method class=Context objtype=function line:783 at …\lib\site-packages\click\core.py

设置参数的来源。这表示获取参数值的位置。
:param name:参数名称。class:`~click.core.ParameterSource`的成员。

21 to_info_dict(self) -> t.Dict[str, t.Any]:

kind=method class=Context objtype=function line:432 at …\lib\site-packages\click\core.py

收集可能对生成面向用户文档的工具有用的信息。这遍历整个CLI结构。代码段：with Context(cli) as ctx:info = ctx.to_info_dict()版本增加： 8.0

22 with_resource(self, context_manager: t.ContextManager[V]) -> V:

kind=method class=Context objtype=function line:544 at …\lib\site-packages\click\core.py

注册一个资源，就像在``with``语句中使用它一样。当上下文弹出时，资源将被清理。用途:甲:“contextlib.ExitStack。输入上下文”。它调用资源的``__enter__()``方法并返回结果。当上下文弹出时，它关闭堆栈，调用资源的``__exit__()``方法。要为非上下文管理器注册一个清理函数，使用:meth:`call_on_close`。或者使用:mod:`contextlib`中的一些东西将其转换为上下文管理器。代码块:@click.group()@click.option("--name")@click.pass_contextdef cli(ctx):ctx.obj = ctx.with_resource(connect_db(name)):param context_manager:要进入的上下文管理器。:return: 无论如何返回 ``context_manager.__enter__()``。版本增加： 8.0

🌿24 click.core.Group

Group, click.core.Group, module=click.core, line:1750 at site-packages\click\core.py

组允许命令附加子命令。这是在Click中实现嵌套的最常用方法。:param name:        组命令名称。:param commands:一   个将名称映射到:class:`Command`对象的字典。也可以是:class:`Command`的列表，它将使用:attr:`Command.name`来创建字典。:param attrs:       在:class:`MultiCommand`，:class:`command`和:class:`BaseCommand`中描述的其他命令参数。版本变更： 8.0       ``commands``参数可以是一个命令对象列表。

data

1 command_class=None kind:data type:NoneType class:<class ‘click.core.Group’>
2 group_class=None kind:data type:NoneType class:<class ‘click.core.Group’>

method

3 add_command(self, cmd: Command, name: t.Optional[str] = None) -> None:

kind=method class=Group objtype=function line:1802 at …\lib\site-packages\click\core.py

向该组注册另一个:class:`Command`。如果未提供命令名，则使用命令名。

4 command(self, __func: t.Callable[…, t.Any]) -> Command:

kind=method class=Group objtype=function line:1813 at …\lib\site-packages\click\core.py

用于声明命令并将其附加到组的快捷装饰器。
它采用与:func:`command`相同的参数，并通过调用:meth:`add_command` 立即将创建的命令注册到该组。
要自定义所使用的命令类，请设置:attr:`command_class` 属性。
版本变更： 8.1   这个装饰器可以不带括号。
版本变更： 8.0   增加:attr:`command_class`属性。

5 get_command(self, ctx: Context, cmd_name: str) -> t.Optional[Command]:

kind=method class=Group objtype=function line:1917 at …\lib\site-packages\click\core.py

6 group(self, __func: t.Callable[…, t.Any]) -> “Group”:

kind=method class=Group objtype=function line:1864 at …\lib\site-packages\click\core.py

用于声明组和将组附加到组的快捷装饰器。它采用与:func:`group`相同的参数，并通过调用:meth:`add_command` 立即将创建的组注册到此组。
要自定义所使用的组类，请设置:attr:`group class`属性。
版本变更： 8.1   这个装饰器可以不带括号。
版本变更： 8.0   增加:attr:`group class`属性。

7 list_commands(self, ctx: Context) -> t.List[str]:

kind=method class=Group objtype=function line:1920 at …\lib\site-packages\click\core.py

🌿25 click.core.Option

Option, click.core.Option, module=click.core, line:2409 at site-packages\click\core.py

选项通常是命令行上的可选值，并且具有参数所不具备的一些额外特性。所有其他参数都传递给参数构造函数。:param show_default:    在帮助文本中显示该选项的默认值。默认情况下不显示值，除非:attr:`Context.show_default` is ``True``。如果此值是字符串，则在括号中显示该字符串，而不是实际值。这对于动态选项特别有用。对于单选项布尔标志，如果其值为``False``，则默认值保持隐藏。:param show_envvar:     控制是否在帮助页面上显示环境变量。通常，不显示环境变量。:param prompt:          如果设置为``True``或非空字符串，则会提示用户输入。如果设置为``True``，提示符将是大写的选项名。:param confirmation_prompt: 提示第二次确认的值，如果提示。可以设置为字符串而不是``True``以自定义消息。:param prompt_required: 如果设置为``False``，只有当该选项被指定为一个没有值的标志时，才会提示用户输入。:param hide_input:      如果这是``True``，那么提示符上的输入将对用户隐藏。这对于密码输入很有用。:param is_flag:         强制此选项作为标志。默认为自动检测。:param flag_value:      如果启用了该标志，应该使用哪个值。如果选项字符串包含标记两个选项的斜杠，则自动将其设置为布尔值。:param multiple:        如果设置为 `True`，则参数被多次接受并记录。这在工作方式上类似于``nargs``，但支持任意数量的参数。:param count:           该标志使选项增量为整数。:param allow_from_autoenv:  如果启用了此功能，则如果在上下文中定义了前缀，则该参数的值将从环境变量中提取。:param help:            帮助字符串。:param hidden:          在帮助输出中隐藏该选项。版本变更： 8.1.0     帮助文本缩进在这里被清除，而不是只在``@option``装饰器中。版本变更： 8.1.0     ``show_default``参数覆盖``Context.show_default``。版本变更： 8.1.0     如果默认值为``False``，则不显示单个选项布尔标志的默认值。版本变更： 8.0.1     如果给定，则从 ``flag_value`` 中检测``type``。

data

1 param_type_name=option kind:data type:str class:<class ‘click.core.Option’>

method

2 add_to_parser(self, parser: OptionParser, ctx: Context) -> None:

kind=method class=Option objtype=function line:2651 at …\lib\site-packages\click\core.py

3 consume_value(

kind=method class=Option objtype=function line:2887 at …\lib\site-packages\click\core.py

4 get_default(

kind=method class=Option objtype=function line:2799 at …\lib\site-packages\click\core.py

5 get_help_record(self, ctx: Context) -> t.Optional[t.Tuple[str, str]]:

kind=method class=Option objtype=function line:2690 at …\lib\site-packages\click\core.py

6 prompt_for_value(self, ctx: Context) -> t.Any:

kind=method class=Option objtype=function line:2826 at …\lib\site-packages\click\core.py

这是一个可选流，如果值不存在，则可以在完整值处理中激活它。
它将提示用户，直到存在一个有效值，然后返回处理后的值作为结果。

7 resolve_envvar_value(self, ctx: Context) -> t.Optional[str]:

kind=method class=Option objtype=function line:2852 at …\lib\site-packages\click\core.py

8 to_info_dict(self) -> t.Dict[str, t.Any]:

kind=method class=Option objtype=function line:2586 at …\lib\site-packages\click\core.py

9 value_from_envvar(self, ctx: Context) -> t.Optional[t.Any]:

kind=method class=Option objtype=function line:2871 at …\lib\site-packages\click\core.py

🌿26 click.core.Parameter

Parameter, click.core.Parameter, module=click.core, line:134 at site-packages\click\core.py

命令的参数有两个版本:它们是:class:`Option` \s或:class:`Argument` \s。其他子类目前不受设计的支持，因为解析的一些内部结构有意没有最终确定。选项和参数都支持某些设置。:param param_decls: 该选项或实参的参数声明。这是一个标志或参数名称的列表。:param type:    应该使用的类型。a:class:`ParamType` 或Python类型。如果支持，后者将自动转换为前者。:param required:    控制该参数是否是可选的。:param default:     省略时使用默认值。这也可以是一个可调用对象，在这种情况下，当需要默认值而不需要任何参数时调用它。:param callback:    在类型转换后进一步处理或验证值的函数。它被称为``f(ctx, param, value) ``，并且必须返回值。所有源都调用它，包括提示符。:param nargs:   要匹配的参数数量。如果不是``1``，返回值是一个元组而不是单个值。nargs的默认值是``1``(除非类型是元组，那么它是元组的元数)。如果``nargs=-1 ``，则收集所有剩余参数。:param metavar: 该值在帮助页面中的表示方式。:param expose_value:    如果这是 `True`，那么该值将继续传递给命令回调并存储在上下文中，否则它将被跳过。:param is_eager:    在非急切值之前处理急切值。不应该为参数设置此值，否则将颠倒处理顺序。:param envvar:      需要检查的环境变量字符串或字符串列表。:param shell_complete:  一个返回自定义shell补全的函数。如果给定，用于代替参数的类型补全。接受 ``ctx, param, incomplete`` ，并且必须返回一个列表 :class:`~click.shell_completion.CompletionItem` 或字符串列表。版本变更： 8.0 ``process value``验证所需的参数和有界的``nargs``，并在返回值之前调用参数回调。这允许回调验证提示。``full_process_value`` 被删除。版本变更： 8.0 ``autocompletion``重命名为``shell_complete``，并具有上面描述的新语义。旧名称已被弃用，并将在8.1中删除，在此之前它将被包装以匹配新的要求。对于``multiple=True, nargs>1``，默认值必须是一个元组列表。不再需要为``nargs>1 ``设置默认值，它将默认为``None``。``multiple=True`` 或 ``nargs=-1`` 将默认为``()``。版本变更： 7.1   忽略空的环境变量，而不是接受空字符串值。这使得脚本可以在无法取消设置的情况下清除变量。版本变更： 2.0   修改了参数callback的签名，也传递给参数。旧的回调格式仍然可以工作，但它会引发一个警告，让您有机会更容易地迁移代码。

data

1 param_type_name=parameter kind:data type:str class:<class ‘click.core.Parameter’>

property

2 human_readable_name=<property object at 0x0000026F3E9A1E58> kind:property type:property class:<class ‘click.core.Parameter’>

method

3 add_to_parser(self, parser: OptionParser, ctx: Context) -> None:

kind=method class=Parameter objtype=function line:2233 at …\lib\site-packages\click\core.py

4 consume_value(

kind=method class=Parameter objtype=function line:2236 at …\lib\site-packages\click\core.py

5 get_default(

kind=method class=Parameter objtype=function line:2189 at …\lib\site-packages\click\core.py

获取参数的默认值。首先试 :meth:`Context.lookup_default`，然后查找本地默认值。:param ctx: 当前上下文。:param call:如果默认值是可调用的，调用它。禁用返回可调用对象。版本变更： 8.0.2 获取默认值时不再执行类型强制转换。版本变更： 8.0.1 类型转换在弹性解析模式下可能失败。无效的默认值不会阻止显示帮助文本。版本变更： 8.0   首先查看``ctx.default_map`` 。版本变更： 8.0   增加了``call``参数。

6 get_error_hint(self, ctx: Context) -> str:

kind=method class=Parameter objtype=function line:2378 at …\lib\site-packages\click\core.py

获取参数的字符串化版本，以便在错误消息中使用，以指示导致错误的参数。

7 get_help_record(self, ctx: Context) -> t.Optional[t.Tuple[str, str]]:

kind=method class=Parameter objtype=function line:2372 at …\lib\site-packages\click\core.py

8 get_usage_pieces(self, ctx: Context) -> t.List[str]:

kind=method class=Parameter objtype=function line:2375 at …\lib\site-packages\click\core.py

9 handle_parse_result(

kind=method class=Parameter objtype=function line:2352 at …\lib\site-packages\click\core.py

10 make_metavar(self) -> str:

kind=method class=Parameter objtype=function line:2174 at …\lib\site-packages\click\core.py

11 process_value(self, ctx: Context, value: t.Any) -> t.Any:

kind=method class=Parameter objtype=function line:2315 at …\lib\site-packages\click\core.py

12 resolve_envvar_value(self, ctx: Context) -> t.Optional[str]:

kind=method class=Parameter objtype=function line:2326 at …\lib\site-packages\click\core.py

13 shell_complete(self, ctx: Context, incomplete: str) -> t.List[“CompletionItem”]:

kind=method class=Parameter objtype=function line:936 at …\lib\site-packages\click\core.py

返回不完整值的补全列表。
如果在初始化过程中给出了 ``shell_complete`` 函数，则使用它。否则，:attr:`type`:meth:`~click.types.ParamType.shell_complete` 将使用。:param ctx: 该命令的调用上下文。:param incomplete:  正在完成的值。可能是空的。版本增加： 8.0

14 to_info_dict(self) -> t.Dict[str, t.Any]:

kind=method class=Parameter objtype=function line:432 at …\lib\site-packages\click\core.py

收集可能对生成面向用户文档的工具有用的信息。
使用 :meth:`click.Context.to_info_dict` 遍历整个CLI结构。
版本增加： 8.0

15 type_cast_value(self, ctx: Context, value: t.Any) -> t.Any:

kind=method class=Parameter objtype=function line:2256 at …\lib\site-packages\click\core.py

根据选项:attr:`type`、:attr:`multiple`和:attr:`nargs`转换并验证值。

16 value_from_envvar(self, ctx: Context) -> t.Optional[t.Any]:

kind=method class=Parameter objtype=function line:2344 at …\lib\site-packages\click\core.py

17 value_is_missing(self, value: t.Any) -> bool:

kind=method class=Parameter objtype=function line:2306 at …\lib\site-packages\click\core.py

🔵私有或局部

27 _ <function gettext at 0x0000026F3E8E5948>
28 _param_memo <function _param_memo at 0x0000026F3E9AD4C8>

🔵剩余

29 doc
30 loader <_frozen_importlib_external.SourceFileLoader object at 0x0000026F3E8D38C8>
31 spec ModuleSpec(name=‘click.decorators’, loader=<_frozen_importlib_external.SourceFileLoader object at 0x0000026F3E8D38C8>, origin=‘…\lib\site-packages\click\decorators.py’)
32 F ~F
33 FC ~FC
34 CmdType ~CmdType

☘️【io】

io, fullname=io, file=io.py

☘️【sys】

sys, fullname=sys

☘️【time】

time, fullname=time

☘️【typing】

typing, fullname=typing, file=typing.py

☘️【msvcrt】

msvcrt, fullname=msvcrt

☘️【codecs】

codecs, fullname=codecs, file=codecs.py

☘️【os】

os, fullname=os, file=os.py

☘️【re】

re, fullname=re, file=re.py

☘️【stat】

stat, fullname=stat, file=stat.py

☘️【inspect】

inspect, fullname=inspect, file=inspect.py

☘️【itertools】

itertools, fullname=itertools

☘️【enum】

enum, fullname=enum, file=enum.py

☘️【errno】

errno, fullname=errno

☘️【collections.abc】

abc, fullname=collections.abc, file=collections\abc.py

☘️【types】

types, fullname=types, file=types.py