0x1949 Team - FAZEMRX - MANAGER
Edit File: core.cpython-310.pyc
o �+cav� � @ sp d dl Z d dlZd dlZd dlZd dlZd dlZd dlmZ d dlm Z d dlm Z d dl m Z d dl m Z d dlmZ d dlmZ d d lmZ d d lmZ d d lmZ d d lmZ d dlmZ d dlmZ d dlmZ d dlm Z d dlm Z d dl m Z d dl m Z d dl!m"Z" d dl!m#Z# d dl$m%Z% d dl$m&Z& d dl$m'Z' d dl(m)Z) d dl(m*Z* d d l(m+Z+ d d l,m-Z- d d l,m.Z. d d l,m/Z/ d d l,m0Z0 d d!l,m1Z1 d d"l,m2Z2 ej3r�d dl4Z5d d#l6m7Z7 ej8d$ej9d%ej:f d&�Z;e�8d'�Z<d(d)d*e=d+ej>ej?e=d,f fd-d.�Z@ /dVd0d1d2e=d3d,d4eAd+df d5d6�ZBd7ejCe< d8eDd+ejEej?e<d%f fd9d:�ZFe dWd(d)d;ejGd< d+ej>d fd=d>��ZHd?ejId< d@ejId< d+ejEd< fdAdB�ZJG dCdD� dDe jK�ZLG dEd)� d)�ZMG dFdG� dG�ZNG dHd,� d,eN�ZOG dId1� d1eO�ZPG dJdK� dKeP�ZQG dLdM� dMeP�ZRdNej:d+ej>ej: fdOdP�ZSG dQd<� d<�ZTG dRdS� dSeT�ZUG dTdU� dUeT�ZVdS )X� N)�abc)�contextmanager)� ExitStack)�partial)�update_wrapper)�gettext)�ngettext)�repeat� )�types)�_verify_python_env��Abort)� BadParameter)�ClickException��Exit)�MissingParameter�� UsageError)� HelpFormatter)� join_options)� pop_context)� push_context��_flag_needs_value)� OptionParser)� split_opt)�confirm)�prompt)�style)�_detect_program_name)� _expand_args)�echo)�make_default_short_help)�make_str)�PacifyFlushWrapper��CompletionItem�F.)�bound�V�ctx�Context� incomplete�return�Commandc c sR � t �t| j�}|�| �D ]}|�|�r&|�| |�}|dur&|js&||fV q dS )z�List all the subcommands of a group that start with the incomplete value and aren't hidden. :param ctx: Invocation context for the group. :param incomplete: Value being completed. May be empty. N)�t�cast� MultiCommand�command� list_commands� startswith� get_command�hidden)r, r. �multi�namer4 � r; �,/usr/lib/python3/dist-packages/click/core.py�_complete_visible_commands1 s � ��r= F� base_commandr3 �cmd_name�cmd�registerc C sd | j rt|t�s d S |rd}nd}t|� d| j�d|�d|�dt|�j� dt| �j� d| j�d ���) NzdIt is not possible to add multi commands as children to another multi command that is in chain mode.zdFound a multi command as subcommand to a multi command that is in chain mode. This is not supported.z . Command z is set to chain and zA was added as a subcommand but it in itself is a multi command. (z is a z within a chained z named z).)�chain� isinstancer3 � RuntimeErrorr: �type�__name__)r> r? r@ rA �hintr; r; r< �_check_multicommandD s( ��������rH �iterable� batch_sizec C s t ttt| �|�� �S �N)�list�zipr �iter)rI rJ r; r; r< �batch\ s rO �param� Parameterc c sz � zdV W dS t y( } z|jdu r| |_|dur#|jdu r#||_� d}~w ty< } z |jdu r7| |_� d}~ww )z>Context manager that attaches extra information to exceptions.N)r r, rP r )r, rP �er; r; r< �augment_usage_errors` s � � ��rS �invocation_order�declaration_orderc s, dddt jttf f� fdd� }t||d�S )z�Given a sequence of parameters in the order as should be considered for processing and an iterable of parameters that exist, this returns a list in the correct order as they should be processed. �itemrQ r/ c s6 z� � | �}W n ty td�}Y nw | j |fS )N�inf)�index� ValueError�float�is_eager)rV �idx�rT r; r< �sort_key| s � z,iter_params_for_processing.<locals>.sort_key��key)r1 �Tuple�boolrZ �sorted)rT rU r^ r; r] r< �iter_params_for_processings s rd c @ s@ e Zd ZdZe�� Z e�� Z e�� Z e�� Z e�� Z dS )�ParameterSourcea\ This is an :class:`~enum.Enum` that indicates the source of a parameter's value. Use :meth:`click.Context.get_parameter_source` to get the source for a parameter by name. .. versionchanged:: 8.0 Use :class:`~enum.Enum` and drop the ``validate`` method. .. versionchanged:: 8.0 Added the ``PROMPT`` value. N) rF � __module__� __qualname__�__doc__�enum�auto� COMMANDLINE� ENVIRONMENT�DEFAULT� DEFAULT_MAP�PROMPTr; r; r; r< re � s re c # @ sz e Zd ZU dZeZejd ed< d_dddej d d ej e d ej ej d ej e d ej ej e ej f d ej e dej e dedej e dej e dej e dej eje dej eje ge f dej e dej e ddf"dd�Zdej e ej f fdd�Zd`d d �Zd d � Zedad!edejd fd"d#��Zedej e ej f fd$d%��Zdefd&d'�Zd(eje de fd)d*�Z d+ejd,ej f dejd,ej f fd-d.�Z dbd/d0�Z ede fd1d2��Z d`d3d4�Z!d5eje dej e fd6d7�Z"d5eje de fd8d9�Z#e$j% dad:e d;d<dej ej fd=d>��Z&e$j% ,dcd:e d;d?dej ej'ej ejg ej f f fd@d>��Z&dad:e d;edej ej fdAd>�Z&dBe ddCfdDdE�Z(dddFdG�Z)dedIe ddCfdJdK�Z*de fdLdM�Z+de fdNdO�Z,dfdPdQ�Z-dRej'dejd,ej f f dSej dTej dej fdUdV�Z.dWddSej dTej dej fdXdY�Z/d:e dZe0ddfd[d\�Z1d:e dej e0 fd]d^�Z2dS )gr- a The context is a special internal object that holds state relevant for the script execution at every single level. It's normally invisible to commands unless they opt-in to getting access to it. The context is useful as it can pass internal objects around and can control special execution features such as reading data from environment variables. A context can be used as context manager in which case it will call :meth:`close` on teardown. :param command: the command class for this context. :param parent: the parent context. :param info_name: the info name for this invocation. Generally this is the most descriptive name for the script or command. For the toplevel script it is usually the name of the script, for commands below it it's the name of the script. :param obj: an arbitrary object of user data. :param auto_envvar_prefix: the prefix to use for automatic environment variables. If this is `None` then reading from environment variables is disabled. This does not affect manually set environment variables which are always read. :param default_map: a dictionary (like object) with default values for parameters. :param terminal_width: the width of the terminal. The default is inherit from parent context. If no context defines the terminal width then auto detection will be applied. :param max_content_width: the maximum width for content rendered by Click (this currently only affects help pages). This defaults to 80 characters if not overridden. In other words: even if the terminal is larger than that, Click will not format things wider than 80 characters by default. In addition to that, formatters might add some safety mapping on the right. :param resilient_parsing: if this flag is enabled then Click will parse without any interactivity or callback invocation. Default values will also be ignored. This is useful for implementing things such as completion support. :param allow_extra_args: if this is set to `True` then extra arguments at the end will not raise an error and will be kept on the context. The default is to inherit from the command. :param allow_interspersed_args: if this is set to `False` then options and arguments cannot be mixed. The default is to inherit from the command. :param ignore_unknown_options: instructs click to ignore options it does not know and keeps them for later processing. :param help_option_names: optionally a list of strings that define how the default help parameter is named. The default is ``['--help']``. :param token_normalize_func: an optional function that is used to normalize tokens (options, choices, etc.). This for instance can be used to implement case insensitive behavior. :param color: controls if the terminal supports ANSI colors or not. The default is autodetection. This is only needed if ANSI codes are used in texts that Click prints which is by default not the case. This for instance would affect help output. :param show_default: Show defaults for all options. If not set, defaults to the value from a parent context. Overrides an option's ``show_default`` argument. .. versionchanged:: 8.0 The ``show_default`` parameter defaults to the value from the parent context. .. versionchanged:: 7.1 Added the ``show_default`` parameter. .. versionchanged:: 4.0 Added the ``color``, ``ignore_unknown_options``, and ``max_content_width`` parameters. .. versionchanged:: 3.0 Added the ``allow_extra_args`` and ``allow_interspersed_args`` parameters. .. versionchanged:: 2.0 Added the ``resilient_parsing``, ``help_option_names``, and ``token_normalize_func`` parameters. r �formatter_classNFr4 r0 �parent� info_name�obj�auto_envvar_prefix� default_map�terminal_width�max_content_width�resilient_parsing�allow_extra_args�allow_interspersed_args�ignore_unknown_options�help_option_names�token_normalize_func�color� show_defaultr/ c C s� || _ || _|| _i | _g | _g | _|d u r |d ur |j}|| _t|di �| _|d u r>|d ur>|d ur>|j d ur>|j � |�}|| _ d | _ |d u rO|d urO|j }|| _ |d u r]|d ur]|j }|| _ | d u rg|j} | | _| d u rq|j} | | _| d u r{|j} | | _| d u r�|d ur�|j} ndg} | | _|d u r�|d ur�|j}|| _| | _|d u r�|d ur�|jd ur�| jd ur�|j� d| j�� � �}n|�� }|d ur�|�dd�}|| _|d u r�|d ur�|j}|| _|d u r�|d ur�|j}|| _g | _d| _i | _t � | _ d S )N�metaz--help�_�-r ) rq r4 rr �params�args�protected_argsrs �getattr�_metaru �get�invoked_subcommandrv rw ry rz r{ r| r} rx rt �upper�replacer~ r �_close_callbacks�_depth�_parameter_sourcer � _exit_stack)�selfr4 rq rr rs rt ru rv rw rx ry rz r{ r| r} r~ r r; r; r< �__init__ s~ � �� zContext.__init__c C s$ | j �| �| j| j| j| j| jd�S )a* Gather information that could be useful for a tool generating user-facing documentation. This traverses the entire CLI structure. .. code-block:: python with Context(cli) as ctx: info = ctx.to_info_dict() .. versionadded:: 8.0 )r4 rr ry rz r{ rt )r4 � to_info_dictrr ry rz r{ rt �r� r; r; r< r� � s �zContext.to_info_dictc C s | j d7 _ t| � | S �Nr )r� r r� r; r; r< � __enter__� s zContext.__enter__c C s* | j d8 _ | j dkr| �� t� d S �Nr r )r� �closer )r� �exc_type� exc_value�tbr; r; r< �__exit__� s zContext.__exit__T�cleanupc c sp � |s | j d7 _ z#| � }|V W d � n1 sw Y W |s,| j d8 _ dS dS |s7| j d8 _ w )aI This helper method can be used with the context object to promote it to the current thread local (see :func:`get_current_context`). The default behavior of this is to invoke the cleanup functions which can be disabled by setting `cleanup` to `False`. The cleanup functions are typically used for things such as closing file handles. If the cleanup is intended the context object can also be directly used as a context manager. Example usage:: with ctx.scope(): assert get_current_context() is ctx This is equivalent:: with ctx: assert get_current_context() is ctx .. versionadded:: 5.0 :param cleanup: controls if the cleanup functions should be run or not. The default is to run these functions. In some situations the context only wants to be temporarily pushed in which case this can be disabled. Nested pushes automatically defer the cleanup. r N)r� )r� r� �rvr; r; r< �scope� s � ���z Context.scopec C � | j S )a� This is a dictionary which is shared with all the contexts that are nested. It exists so that click utilities can store some state here if they need to. It is however the responsibility of that code to manage this dictionary well. The keys are supposed to be unique dotted strings. For instance module paths are a good choice for it. What is stored in there is irrelevant for the operation of click. However what is important is that code that places data here adheres to the general semantics of the system. Example usage:: LANG_KEY = f'{__name__}.lang' def set_language(value): ctx = get_current_context() ctx.meta[LANG_KEY] = value def get_language(): return get_current_context().meta.get(LANG_KEY, 'en_US') .. versionadded:: 5.0 )r� r� r; r; r< r� � s z Context.metac C s | j | j| jd�S )a= Creates the :class:`~click.HelpFormatter` for the help and usage output. To quickly customize the formatter class used without overriding this method, set the :attr:`formatter_class` attribute. .. versionchanged:: 8.0 Added the :attr:`formatter_class` attribute. )�width� max_width)rp rv rw r� r; r; r< �make_formatter s �zContext.make_formatter�context_managerc C � | j �|�S )a� Register a resource as if it were used in a ``with`` statement. The resource will be cleaned up when the context is popped. Uses :meth:`contextlib.ExitStack.enter_context`. It calls the resource's ``__enter__()`` method and returns the result. When the context is popped, it closes the stack, which calls the resource's ``__exit__()`` method. To register a cleanup function for something that isn't a context manager, use :meth:`call_on_close`. Or use something from :mod:`contextlib` to turn it into a context manager first. .. code-block:: python @click.group() @click.option("--name") @click.pass_context def cli(ctx): ctx.obj = ctx.with_resource(connect_db(name)) :param context_manager: The context manager to enter. :return: Whatever ``context_manager.__enter__()`` returns. .. versionadded:: 8.0 )r� � enter_context)r� r� r; r; r< � with_resource s zContext.with_resource�f.c C r� )a� Register a function to be called when the context tears down. This can be used to close resources opened during the script execution. Resources that support Python's context manager protocol which would be used in a ``with`` statement should be registered with :meth:`with_resource` instead. :param f: The function to execute on teardown. )r� �callback)r� r� r; r; r< � call_on_close7 s zContext.call_on_closec C s | j �� t� | _ dS )z�Invoke all close callbacks registered with :meth:`call_on_close`, and exit all context managers entered with :meth:`with_resource`. N)r� r� r r� r; r; r< r� C s z Context.closec C sv d}| j dur | j }| jdur7| jjg}t| jjt�r-| jj�| �D ] }|�|�| �� q"d� |�� d|� �}|� � S )z�The computed command path. This is used for the ``usage`` information on the help page. It's automatically created by combining the info names of the chain of contexts to the root. � N� ) rr rq � command_pathrC r4 r0 � get_params�extend�get_usage_pieces�join�lstrip)r� r� �parent_command_pathrP r; r; r< r� L s zContext.command_pathc C s" | }|j dur|j }|j dus|S )z Finds the outermost context.N�rq )r� �noder; r; r< � find_root_ s �zContext.find_root� object_typec C s0 | }|durt |j|�r|jS |j}|dusdS )z)Finds the closest object of a given type.N)rC rs rq )r� r� r� r; r; r< � find_objectf s �zContext.find_objectc C s" | � |�}|du r|� | _}|S )z�Like :meth:`find_object` but sets the innermost object to a new instance of `object_type` if it does not exist. N)r� rs )r� r� r� r; r; r< � ensure_objectr s zContext.ensure_objectr: �call�te.Literal[True]c C � d S rK r; �r� r: r� r; r; r< �lookup_default{ � zContext.lookup_defaultzte.Literal[False]c C r� rK r; r� r; r; r< r� � r� c C s0 | j dur| j �|�}|rt|�r|� S |S dS )a* Get the default for a parameter from :attr:`default_map`. :param name: Name of the parameter. :param call: If the default is a callable, call it. Disable to return the callable instead. .. versionchanged:: 8.0 Added the ``call`` parameter. N)ru r� �callable)r� r: r� �valuer; r; r< r� � s �message� te.NoReturnc C s t || ��)z�Aborts the execution of the program with a specific error message. :param message: the error message to fail with. r )r� r� r; r; r< �fail� s z Context.failc C � t � �)zAborts the script.r r� r; r; r< �abort� s z Context.abortr �codec C s t |��)z-Exits the application with a given exit code.r )r� r� r; r; r< �exit� s z Context.exitc C � | j �| �S )zaHelper method to get formatted usage string for the current context and command. )r4 � get_usager� r; r; r< r� � � zContext.get_usagec C r� )z^Helper method to get formatted help page for the current context and command. )r4 �get_helpr� r; r; r< r� � r� zContext.get_helpc C s t | �||j| d�S )zvCreate a new context of the same type as this context, but for a new command. :meta private: �rr rq )rE r: )r� r4 r; r; r< �_make_sub_context� s zContext._make_sub_context�_Context__callbackr� �kwargsc O s� t |t�r9|}|jdu rtd��|j}| �|�}|jD ]}|j|vr1|jr1|�||� |��||j< q|j� |� n| }t | ��) |� ||i |��W d � W d � S 1 s[w Y W d � dS 1 skw Y dS )a� Invokes a command callback in exactly the way it expects. There are two ways to invoke this method: 1. the first argument can be a callback and all other arguments and keyword arguments are forwarded directly to the function. 2. the first argument is a click command object. In that case all arguments are forwarded as well but proper click parameters (options and click arguments) must be keyword arguments and Click will fill in defaults. Note that before Click 3.2 keyword arguments were not properly filled in against the intention of this code and no context was created. For more information about this change and why it was done in a bugfix release see :ref:`upgrade-to-3.2`. .. versionchanged:: 8.0 All ``kwargs`` are tracked in :attr:`params` so they will be passed if :meth:`forward` is called at multiple levels. Nz?The given command does not have a callback that can be invoked.) rC r0 r� � TypeErrorr� r� r: � expose_value�type_cast_value� get_default�updaterS )�_Context__selfr� r� r� � other_cmdr, rP r; r; r< �invoke� s. � �� ��"�zContext.invoke� _Context__cmdc O sL t |t�s td��| jD ] }||vr| j| ||< q | j|g|�R i |��S )az Similar to :meth:`invoke` but fills in default keyword arguments from the current context if the other command expects it. This cannot invoke callbacks directly, only other commands. .. versionchanged:: 8.0 All ``kwargs`` are tracked in :attr:`params` so they will be passed if ``forward`` is called at multiple levels. zCallback is not a command.)rC r0 r� r� r� )r� r� r� r� rP r; r; r< �forward� s �zContext.forward�sourcec C s || j |< dS )z�Set the source of a parameter. This indicates the location from which the value of the parameter was obtained. :param name: The name of the parameter. :param source: A member of :class:`~click.core.ParameterSource`. N)r� )r� r: r� r; r; r< �set_parameter_source s z Context.set_parameter_sourcec C r� )aX Get the source of a parameter. This indicates the location from which the value of the parameter was obtained. This can be useful for determining when a user specified a value on the command line that is the same as the default value. It will be :attr:`~click.core.ParameterSource.DEFAULT` only if the value was actually taken from the default. :param name: The name of the parameter. :rtype: ParameterSource .. versionchanged:: 8.0 Returns ``None`` if the parameter was not provided from any source. )r� r� )r� r: r; r; r< �get_parameter_source s z Context.get_parameter_source)NNNNNNNFNNNNNNN)r/ r- �T)r/ N�.)r/ r� )r )r4 r0 r/ r- )3rF rf rg rh r rp r1 �Type�__annotations__�Optional�str�Any�Dict�intrb �List�Callabler� r� r� r� r �Iteratorr� �propertyr� r� �ContextManagerr+ r� r� r� r� r� r� r� �typing�overloadr� �Unionr� r� r� r� r� r� r� r� re r� r� r; r; r; r< r- � s� \���� ���� � � � � ����� � + % * ��� ���� � ��� �5��� � c @ sn e Zd ZU dZeZeje ed< dZ dZ dZ d3dej e dej eje ejf ddfd d �Zd edeje ejf fd d �Zde fdd�Zd ede fdd�Zd ede fdd�Z d3dej e deje dej e dejdef dd�Zd edeje deje fdd�Zd edejfd d �Zd ed e dejd fd d!�Zej d4dej ej e d"ej e d#ej e d$d%dejdd&f d'd(��Z ej )d5dej ej e d"ej e d#ej e d$e dejdejf d*d(��Z d6dej ej e d"ej e d#ej e d$e d+e dejdejfd,d(�Z d3d-eje ejf d"e d#ej e ddfd.d/�Z dejd0ejdejfd1d2�Z dS )7� BaseCommanda� The base command implements the minimal API contract of commands. Most code will never use this as it does not implement a lot of useful functionality but it can act as the direct subclass of alternative parsing methods that do not depend on the Click parser. For instance, this can be used to bridge Click and other systems like argparse or docopt. Because base commands do not implement a lot of the API that other parts of Click take for granted, they are not supported for all operations. For instance, they cannot be used with the decorators usually and they have no built-in callback system. .. versionchanged:: 2.0 Added the `context_settings` parameter. :param name: the name of the command to use unless a group overrides it. :param context_settings: an optional dictionary with defaults that are passed to the context object. � context_classFTNr: �context_settingsr/ c C s || _ |d u r i }|| _d S rK )r: r� )r� r: r� r; r; r< r� F s zBaseCommand.__init__r, c C s d| j iS )ai Gather information that could be useful for a tool generating user-facing documentation. This traverses the entire structure below this command. Use :meth:`click.Context.to_info_dict` to traverse the entire CLI structure. :param ctx: A :class:`Context` representing this command. .. versionadded:: 8.0 r: �r: �r� r, r; r; r< r� W s zBaseCommand.to_info_dictc C � d| j j� d| j� d�S �N�<r� �>�� __class__rF r: r� r; r; r< �__repr__e � zBaseCommand.__repr__c C � t d��)Nz Base commands cannot get usage��NotImplementedErrorr� r; r; r< r� h � zBaseCommand.get_usagec C r� )Nz Base commands cannot get helpr� r� r; r; r< r� k r� zBaseCommand.get_helprr r� rq �extrac K sz | j �� D ] \}}||vr|||< q| j| f||d�|��}|jdd�� | �||� W d � |S 1 s6w Y |S )a� This function when given an info name and arguments will kick off the parsing and create a new :class:`Context`. It does not invoke the actual command callback though. To quickly customize the context class used without overriding this method, set the :attr:`context_class` attribute. :param info_name: the info name for this invocation. Generally this is the most descriptive name for the script or command. For the toplevel script it's usually the name of the script, for commands below it it's the name of the command. :param args: the arguments to parse as list of strings. :param parent: the parent context if available. :param extra: extra keyword arguments forwarded to the context constructor. .. versionchanged:: 8.0 Added the :attr:`context_class` attribute. r� F�r� N)r� �itemsr� r� � parse_args)r� rr r� rq r� r` r� r, r; r; r< � make_contextn s" ���� ��zBaseCommand.make_contextc C r� )z�Given a context and a list of arguments this creates the parser and parses the arguments, then modifies the context as necessary. This is automatically invoked by :meth:`make_context`. z1Base commands do not know how to parse arguments.r� )r� r, r� r; r; r< r � s zBaseCommand.parse_argsc C r� )z{Given a context, this invokes the command. The default implementation is raising a not implemented error. z*Base commands are not invokable by defaultr� r� r; r; r< r� � s zBaseCommand.invoker. r( c sb ddl m� g }�jdur/�j�t�jt�r*�jjr*|�� �fdd�t�|�D �� �jdus |S )a� Return a list of completions for the incomplete value. Looks at the names of chained multi-commands. Any command could be part of a chained multi-command, so sibling commands are valid at any point during command completion. Other command classes will return more completions. :param ctx: Invocation context for this command. :param incomplete: Value being completed. May be empty. .. versionadded:: 8.0 r r' Nc 3 s. � | ]\}}|�j vr� ||�� d �V qdS ���helpN)r� �get_short_help_str��.0r: r4 �r( r, r; r< � <genexpr>� s � ��z-BaseCommand.shell_complete.<locals>.<genexpr>) �click.shell_completionr( rq rC r4 r3 rB r� r= �r� r, r. �resultsr; r r< �shell_complete� s � � zBaseCommand.shell_complete� prog_name� complete_var�standalone_moder� r� c K r� rK r; �r� r� r r r r� r; r; r< �main� � zBaseCommand.main.c K r� rK r; r r; r; r< r � r �windows_expand_argsc K s t � |du rtjdd� }tjdkr|rt|�}nt|�}|du r%t� }| �|||� z�z8| j ||fi |��� }| � |�}|sK|W d � W W S |� � W d � n 1 sYw Y W W dS W W dS t t fyx ttjd� t� d� ty� } z|s�� | �� t� | j� W Y d} ~ W dS d} ~ w ty� } z+| jtjkr�t�tjttj��t_t�tjttj��t_t� d� n� W Y d} ~ W dS d} ~ ww t y� } z|r�t� | j� n | jW Y d} ~ S W Y d} ~ dS d} ~ w t�y |s�� tt d�tjd� t� d� Y dS w )a� This is the way to invoke a script with all the bells and whistles as a command line application. This will always terminate the application after a call. If this is not wanted, ``SystemExit`` needs to be caught. This method is also available by directly calling the instance of a :class:`Command`. :param args: the arguments that should be used for parsing. If not provided, ``sys.argv[1:]`` is used. :param prog_name: the program name that should be used. By default the program name is constructed by taking the file name from ``sys.argv[0]``. :param complete_var: the environment variable that controls the bash completion support. The default is ``"_<prog_name>_COMPLETE"`` with prog_name in uppercase. :param standalone_mode: the default behavior is to invoke the script in standalone mode. Click will then handle exceptions and convert them into error messages and the function will never return but shut down the interpreter. If this is set to `False` they will be propagated to the caller and the return value of this function is the return value of :meth:`invoke`. :param windows_expand_args: Expand glob patterns, user dir, and env vars in command line args on Windows. :param extra: extra keyword arguments are forwarded to the context constructor. See :class:`Context` for more information. .. versionchanged:: 8.0.1 Added the ``windows_expand_args`` parameter to allow disabling command line arg expansion on Windows. .. versionchanged:: 8.0 When taking arguments from ``sys.argv`` on Windows, glob patterns, user dir, and env vars are expanded. .. versionchanged:: 3.0 Added the ``standalone_mode`` parameter. Nr �nt)�filezAborted!) r �sys�argv�osr: r" rL r! �_main_shell_completionr r� r� �EOFError�KeyboardInterruptr# �stderrr r �show� exit_code�OSError�errno�EPIPEr1 r2 �TextIOr& �stdoutr r� ) r� r� r r r r r� r, r� rR r; r; r< r � sb 5� � ,� � ��� �� ��ctx_argsc C s^ |du rd|� d�� dd��� }tj�|�}|sdS ddlm} || ||||�}t�|� dS )a� Check if the shell is asking for tab completion, process that, then exit early. Called from :meth:`main` before the program is invoked. :param prog_name: Name of the executable in the shell. :param complete_var: Name of the environment variable that holds the completion instruction. Defaults to ``_{PROG_NAME}_COMPLETE``. Nr� � _COMPLETEr� r )r ) r� r� r �environr� �shell_completionr r r� )r� r' r r � instructionr r� r; r; r< r J s z"BaseCommand._main_shell_completionr� c O s | j |i |��S )zAlias for :meth:`main`.)r )r� r� r� r; r; r< �__call__f � zBaseCommand.__call__rK )NNNT)NNN.)NNNTT)!rF rf rg rh r- r� r1 r� r� ry rz r{ r� r� r� r� r� r� r� r� r� r� r r r� r r� r� �Sequencer rb r r, r; r; r; r< r� % s� ��� � ����� �"' ������ � ������ � ������� �y���� � r� c sL e Zd ZdZ dAdeje dejejeejf dejej d ejf d ejej d d eje d eje deje deje de de de de ddf� fdd� Z de dejeejf f� fdd� Zde defdd�Zde dej d fd d �Zde d eddfd d �Zde dej e fd!d"�Zde dej e fd#d$�Zde dejd% fd&d'�Zde defd(d)�Zde defd*d+�ZdBd-edefd.d/�Zde d eddfd0d1�Zde d eddfd2d3�Z de d eddfd4d5�Z de d eddfd6d7�Z de d8ej e dej e fd9d:�Z de dejfd;d<�Z de d=edej d> f� fd?d@� Z!� Z"S )Cr0 a� Commands are the basic building block of command line interfaces in Click. A basic command handles command line parsing and might dispatch more parsing to commands nested below it. .. versionchanged:: 2.0 Added the `context_settings` parameter. .. versionchanged:: 8.0 Added repr showing the command name .. versionchanged:: 7.1 Added the `no_args_is_help` parameter. :param name: the name of the command to use unless a group overrides it. :param context_settings: an optional dictionary with defaults that are passed to the context object. :param callback: the callback to invoke. This is optional. :param params: the parameters to register with this command. This can be either :class:`Option` or :class:`Argument` objects. :param help: the help string to use for this command. :param epilog: like the help string but it's printed at the end of the help page after everything else. :param short_help: the short help to use for this command. This is shown on the command listing of the parent command. :param add_help_option: by default each command registers a ``--help`` option. This can be disabled by this parameter. :param no_args_is_help: this controls what happens if no arguments are provided. This option is disabled by default. If enabled this will add ``--help`` as argument if no arguments are passed :param hidden: hide this command from help outputs. :param deprecated: issues a message indicating that the command is deprecated. N� [OPTIONS]TFr: r� r� .r� rQ r �epilog� short_help�options_metavar�add_help_option�no_args_is_helpr8 � deprecatedr/ c sn t � �||� || _|p g | _|r d|v r |�dd�d }|| _|| _|| _|| _| | _ | | _ | | _ | | _ d S )N� r r ) �superr� r� r� �splitr r0 r2 r1 r3 r4 r8 r5 ) r� r: r� r� r� r r0 r1 r2 r3 r4 r8 r5 �r� r; r< r� � s zCommand.__init__r, c s@ t � �|�}|jdd� | �|�D �| j| j| j| j| jd� |S )Nc S s g | ]}|� � �qS r; )r� )r rP r; r; r< � <listcomp>� � z(Command.to_info_dict.<locals>.<listcomp>)r� r r0 r1 r8 r5 ) r7 r� r� r� r r0 r1 r8 r5 )r� r, � info_dictr9 r; r< r� � s �zCommand.to_info_dictc C �" |� � }| �||� |�� �d�S )zmFormats the usage line into a string and returns it. Calls :meth:`format_usage` internally. � )r� � format_usage�getvalue�rstrip�r� r, � formatterr; r; r< r� � � zCommand.get_usagec C s( | j }| �|�}|d urg |�|�}|S rK )r� �get_help_option)r� r, r� � help_optionr; r; r< r� � s zCommand.get_paramsrC c C s" | � |�}|�|jd�|�� dS )zsWrites the usage line into the formatter. This is a low-level method called by :meth:`get_usage`. r� N)�collect_usage_pieces� write_usager� r� )r� r, rC �piecesr; r; r< r? � s zCommand.format_usagec C s6 | j r| j gng }| �|�D ] }|�|�|�� q|S )zhReturns all the pieces that go into the usage line and returns it as a list of strings. )r2 r� r� r� )r� r, r� rP r; r; r< rG � s z Command.collect_usage_piecesc C s6 t |j�}| jD ]}|�|j� |�|j� qt|�S )z&Returns the names for the help option.)�setr| r� �difference_update�opts�secondary_optsrL )r� r, � all_namesrP r; r; r< �get_help_option_names� s z Command.get_help_option_names�Optionc C sJ | � |�}|r | js dS dtdddtddfdd�}t|d d d |td �d �S ) z Returns the help option object.Nr, rP rQ r� r/ c S s0 |r| j st| �� | jd� | �� d S d S d S )N�r~ )rx r# r� r~ r� )r, rP r� r; r; r< � show_help� s �z*Command.get_help_option.<locals>.show_helpTFzShow this message and exit.)�is_flagr[ r� r� r )rO r3 r- r� rP r� )r� r, � help_optionsrR r; r; r< rE � s �zCommand.get_help_optionc C s( t |�}| �|�D ]}|�||� q |S )z6Creates the underlying option parser for this command.)r r� � add_to_parser)r� r, �parserrP r; r; r< � make_parser s zCommand.make_parserc C r= )zfFormats the help into a string and returns it. Calls :meth:`format_help` internally. r> )r� � format_helpr@ rA rB r; r; r< r� rD zCommand.get_help�- �limitc C s> | j pd}|s| jrt| j|�}| jrtd�j|d�}|�� S )z`Gets short help for the command or makes it by shortening the long help string. r� �(Deprecated) {text}��text)r1 r r$ r5 r� �format�strip)r� rZ r] r; r; r< r s zCommand.get_short_help_strc C s4 | � ||� | �||� | �||� | �||� dS )a0 Writes the help into the formatter if it exists. This is a low-level method called by :meth:`get_help`. This calls the following methods: - :meth:`format_usage` - :meth:`format_help_text` - :meth:`format_options` - :meth:`format_epilog` N)r? �format_help_text�format_options� format_epilogrB r; r; r< rX s zCommand.format_helpc C sh | j pd}| jrtd�j|d�}|r2|�� |�� � |�|� W d � dS 1 s+w Y dS dS )z3Writes the help text to the formatter if it exists.r� r[ r\ N)r r5 r� r^ �write_paragraph� indentation� write_text)r� r, rC r] r; r; r< r` 1 s "��zCommand.format_help_textc C sv g }| � |�D ]}|�|�}|dur|�|� q|r9|�td��� |�|� W d � dS 1 s2w Y dS dS )z8Writes all the options into the formatter if they exist.N�Options)r� �get_help_record�append�sectionr� �write_dl)r� r, rC rL rP r� r; r; r< ra > s � "��zCommand.format_optionsc C sL | j r$|�� |�� � |�| j � W d � dS 1 s w Y dS dS )z2Writes the epilog into the formatter if it exists.N)r0 rc rd re rB r; r; r< rb J s "��zCommand.format_epilogr� c C s� |s| j r|jst|�� |jd� |�� | �|�}|j|d�\}}}t|| � |��D ] }|� |||�\}}q+|rT|j sT|jsT|� t ddt|��jd�tt|��d�� ||_|S )NrQ )r� z&Got unexpected extra argument ({args})z'Got unexpected extra arguments ({args})r� )r4 rx r# r� r~ r� rW r rd r� �handle_parse_resultry r� r �lenr^ r� �mapr� r� )r� r, r� rV rL � param_orderrP r� r; r; r< r Q s& ���zCommand.parse_argsc C sP | j rtd�j| jd�}tt|dd�dd� | jdur&|j| jfi |j��S dS )zeGiven a context, this invokes the attached callback (if it exists) in the right way. z7DeprecationWarning: The command {name!r} is deprecated.r� �red)�fgT)�errN) r5 r� r^ r: r# r r� r� r� )r� r, r� r; r; r< r� h s �� �zCommand.invoker. r( c s� ddl m� g }�rA�d �� sA| �|�D ]+�t�t�r+�js+�js,|��j �t j u r,q|� � ��fdd�g �j ��j�D �� q|� t� �|��� |S )a Return a list of completions for the incomplete value. Looks at the names of options and chained multi-commands. :param ctx: Invocation context for this command. :param incomplete: Value being completed. May be empty. .. versionadded:: 8.0 r r' c 3 s( � | ]}|� ��r� |�jd �V qdS r )r6 r )r r: �r( r. rP r; r< r � s � � �z)Command.shell_complete.<locals>.<genexpr>)r r( �isalnumr� rC rP r8 �multipler� r: re rk r� rL rM r7 r r r9 rr r< r u s& ��� � �zCommand.shell_complete) NNNNNNr/ TFFF)rY )#rF rf rg rh r1 r� r� r� r� r� r� rb r� r- r� r� r� r r? rG rO rE r rW r� r� r rX r` ra rb r r� r � __classcell__r; r; r9 r< r0 k sr %�������� � � � � ��"& "( c s� e Zd ZdZdZdZ d/deje de deje deje d e d ejej d ej f d ej d df� fdd� Z de d ejeej f f� fdd� Zde d eje f� fdd� Zde ded df� fdd� Zd0de d ej egef fdd�Zd0de d ej egef fdd �Zde ded dfd d �Zde d eje d eje f� fd d!� Zde d ej f� fd"d#� Zde d eje d ejeje eje eje f fd$d%�Z de d&ed eje fd'd(�Z de d eje fd)d*�Z de d+ed ejd, f� fd-d.� Z � Z S )1r3 aY A multi command is the basic implementation of a command that dispatches to subcommands. The most common version is the :class:`Group`. :param invoke_without_command: this controls how the multi command itself is invoked. By default it's only invoked if a subcommand is provided. :param no_args_is_help: this controls what happens if no arguments are provided. This option is enabled by default if `invoke_without_command` is disabled or disabled if it's enabled. If enabled this will add ``--help`` as argument if no arguments are passed. :param subcommand_metavar: the string that is used in the documentation to indicate the subcommand place. :param chain: if this is set to `True` chaining of multiple subcommands is enabled. This restricts the form of commands in that they cannot have optional arguments but it allows multiple commands to be chained together. :param result_callback: The result callback to attach to this multi command. This can be set or changed later with the :meth:`result_callback` decorator. TFNr: �invoke_without_commandr4 �subcommand_metavarrB �result_callback.�attrsr/ c s� t � j|fi |�� |d u r| }|| _|| _|d u r"|r d}nd}|| _|| _|| _| jr@| jD ]}t|t �r?|j s?t d��q1d S d S )Nz*COMMAND1 [ARGS]... [COMMAND2 [ARGS]...]...zCOMMAND [ARGS]...z<Multi commands in chain mode cannot have optional arguments.) r7 r� r4 rv rw rB �_result_callbackr� rC �Argument�requiredrD ) r� r: rv r4 rw rB rx ry rP r9 r; r< r� � s* ���zMultiCommand.__init__r, c s� t � �|�}i }| �|�D ]/}| �||�}|d u rq |�|�}|jdd�� |�|�||< W d � n1 s7w Y q |j|| jd� |S )NFr )�commandsrB )r7 r� r5 r7 r� r� r� rB )r� r, r< r} r: r4 �sub_ctxr9 r; r< r� � s ��zMultiCommand.to_info_dictc s t � �|�}|�| j� |S rK )r7 rG rh rw �r� r, r� r9 r; r< rG � s z!MultiCommand.collect_usage_piecesrC c s t � �||� | �||� d S rK )r7 ra �format_commandsrB r9 r; r< ra � s zMultiCommand.format_optionsr� c s dt dt f� �fdd� }|S )a� Adds a result callback to the command. By default if a result callback is already registered this will chain them but this can be disabled with the `replace` parameter. The result callback is invoked with the return value of the subcommand (or the list of return values from all subcommands if chaining is enabled) as well as the parameters as they would be passed to the main callback. Example:: @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: if set to `True` an already existing result callback will be removed. .. versionchanged:: 8.0 Renamed from ``resultcallback``. .. versionadded:: 3.0 r� r/ c sF �j ��d u s �r� �_ � S � �fdd�}tt�t|�� � �_ }|S )Nc s, �| g|�R i |��}� |g|�R i |��S rK r; )�_MultiCommand__valuer� r� �inner�r� � old_callbackr; r< �function s zAMultiCommand.result_callback.<locals>.decorator.<locals>.function)rz r r1 r2 r) )r� r� r� �r� r� r� r< � decorator s z/MultiCommand.result_callback.<locals>.decorator)r) )r� r� r� r; r� r< rx � s z MultiCommand.result_callbackc C s$ dd l }|jdtdd� | j|d�S )Nr zb'resultcallback' has been renamed to 'result_callback'. The old name will be removed in Click 8.1.� �� stacklevel)r� )�warnings�warn�DeprecationWarningrx )r� r� r� r; r; r< �resultcallback# s � zMultiCommand.resultcallbackc C s� g }| � |�D ]}| �||�}|du rq|jrq|�||f� qt|�rh|jd tdd� |D �� }g }|D ]\}}|�|�}|�||f� q6|rj|�t d��� |� |� W d � dS 1 saw Y dS dS dS )zeExtra format methods for multi methods that adds all the commands after the options. N� c s s � | ] }t |d �V qdS )r N�rl )r r@ r; r; r< r ? � � z/MultiCommand.format_commands.<locals>.<genexpr>�Commands) r5 r7 r8 rh rl r� �maxr ri r� rj ) r� r, rC r} � subcommandr@ rZ �rowsr r; r; r< r� . s( "��z MultiCommand.format_commandsr� c sx |s| j r|jst|�� |jd� |�� t� �||�}| jr(||_ g |_ |j S |r9|d d� |dd � |_ |_ |j S )NrQ r ) r4 rx r# r� r~ r� r7 r rB r� r� )r� r, r� �restr9 r; r< r J s � zMultiCommand.parse_argsc s& dt jdt jf� �fdd� }� js<�jr5� � t� �� � |�jr#g nd �W d � S 1 s0w Y � �td�� g � j�� j �}g � _ g � _�js�� �I �� � |�\}}}|d us_J �|� _ t� �� � |j ||� d�}|� ||j �|��W d � W d � S 1 s�w Y W d � n1 s�w Y � �f |r�dnd � _ t� �� � g }|rۈ� � |�\}}}|d us�J �|j ||� dd d �}|�|� |j g }|_ |s�g }|D ] }|� |�|j �|�� W d � n1 s�w Y q�||�W d � S 1 �s w Y d S ) Nr� r/ c s& �j d ur� j�j | fi � j��} | S rK )rz r� r� �r� �r, r� r; r< �_process_resultZ s z,MultiCommand.invoke.<locals>._process_resultzMissing command.r� �*TF)rq ry rz )r1 r� r� rv r7 r� rB r� r� r� �resolve_commandr� r r4 rh ) r� r, r� r� r? r@ r~ �contextsr� r9 r� r< r� Y sb � �� � � � ��&�zMultiCommand.invokec C s� t |d �}|}| �||�}|d u r"|jd ur"|�|�}| �||�}|d u rA|jsAt|�d r6| �||j� |�td�j |d�� |rE|nd ||dd � fS )Nr zNo such command {name!r}.r� r ) r% r7 r} rx r r r� r� r� r^ )r� r, r� r? �original_cmd_namer@ r; r; r< r� � s z MultiCommand.resolve_commandr? c C s t �)z{Given a context and a command name, this returns a :class:`Command` object if it exists or returns `None`. r� �r� r, r? r; r; r< r7 � r� zMultiCommand.get_commandc C � g S )zTReturns a list of subcommand names in the order they should appear. r; r� r; r; r< r5 � r� zMultiCommand.list_commandsr. r( c s< ddl m� � fdd�t||�D �}|�t� �||�� |S )a0 Return a list of completions for the incomplete value. Looks at the names of options, subcommands, and chained multi-commands. :param ctx: Invocation context for this command. :param incomplete: Value being completed. May be empty. .. versionadded:: 8.0 r r' c s g | ] \}}� ||� � d ��qS )r )r r r' r; r< r: � s ��z/MultiCommand.shell_complete.<locals>.<listcomp>)r r( r= r� r7 r r r9 r' r< r � s �zMultiCommand.shell_complete)NFNNFN�F)!rF rf rg rh ry rz r1 r� r� rb r� r� r� r- r� r� r� rG r ra r) rx r� r� r r� ra r0 r� r7 r5 r ru r; r; r9 r< r3 � sZ �������� �"& - & D�� � (c sX e Zd ZU dZdZejeje e d< dZ ejej ejd eje f e d< ddeje dejej eje ef eje f dejddf� fd d � Zd d edeje ddfd d �Zdejdejdejejdejf gef fdd�Zdejdejdejejdejf gd f fdd�Zdede deje fdd�Zdedeje fdd�Z� ZS ) �GroupaN A group allows a command to have subcommands attached. This is the most common way to implement nesting in Click. :param name: The name of the group command. :param commands: A dict mapping names to :class:`Command` objects. Can also be a list of :class:`Command`, which will use :attr:`Command.name` to create the dict. :param attrs: Other command arguments described in :class:`MultiCommand`, :class:`Command`, and :class:`BaseCommand`. .. versionchanged:: 8.0 The ``commmands`` argument can be a list of command objects. N� command_class� group_classr: r} ry r/ c sF t � j|fi |�� |d u ri }n t|tj�r dd� |D �}|| _d S )Nc S s i | ] }|j d ur|j |�qS rK r� �r �cr; r; r< � <dictcomp> � z"Group.__init__.<locals>.<dictcomp>)r7 r� rC r r. r} )r� r: r} ry r9 r; r< r� � s zGroup.__init__r@ c C s8 |p|j }|du r td��t| ||dd� || j|< dS )z�Registers another :class:`Command` with this group. If the name is not provided, the name of the command is used. NzCommand has no name.T)rA )r: r� rH r} )r� r@ r: r; r; r< � add_command s zGroup.add_commandr� r� .c sT ddl m� �jdurd�vr�j�d< dtjdtjf dtf� ���fdd � }|S ) a� A shortcut decorator for declaring and attaching a command to the group. This takes the same arguments as :func:`command` and immediately registers the created command with this group by calling :meth:`add_command`. To customize the command class used, set the :attr:`command_class` attribute. .. versionchanged:: 8.0 Added the :attr:`command_class` attribute. r )r4 N�clsr� .r/ c � �� i ���| �}�� |� |S rK �r� �r� r@ �r� r4 r� r� r; r< r� ) � z Group.command.<locals>.decorator)� decoratorsr4 r� r1 r� r� r0 �r� r� r� r� r; r� r< r4 s (z Group.commandc sl ddl m� �jdur d�vr �jtu rt���d< n�j�d< dtjdtjf ddf� ���fd d � }|S ) a� A shortcut decorator for declaring and attaching a group to the group. This takes the same arguments as :func:`group` and immediately registers the created group with this group by calling :meth:`add_command`. To customize the group class used, set the :attr:`group_class` attribute. .. versionchanged:: 8.0 Added the :attr:`group_class` attribute. r )�groupNr� r� .r/ r� c r� rK r� r� �r� r� r� r� r; r< r� F r� z Group.group.<locals>.decorator)r� r� r� rE r1 r� r� r� r; r� r< r� 0 s (z Group.groupr, r? c C s | j �|�S rK )r} r� r� r; r; r< r7 M s zGroup.get_commandc C s t | j�S rK )rc r} r� r; r; r< r5 P � zGroup.list_commands�NNrK )rF rf rg rh r� r1 r� r� r0 r� r� r� rE r� r� r. r� r� r� r� r4 r� r- r7 r� r5 ru r; r; r9 r< r� � s@ ( ��"��� �� ��� � r� c s� e Zd ZdZ ddeje dejeje dej ddf� fdd� Z d eddfd d �Z d e d edeje fdd�Zd e deje fdd�Z� ZS )�CommandCollectiona A command collection is a multi command that merges multiple multi commands together into one. This is a straightforward implementation that accepts a list of different multi commands as sources and provides all the commands for each of them. Nr: �sourcesry r/ c s" t � j|fi |�� |p g | _d S rK )r7 r� r� )r� r: r� ry r9 r; r< r� [ s zCommandCollection.__init__� multi_cmdc C s | j �|� dS )z1Adds a new multi command to the chain dispatcher.N)r� rh )r� r� r; r; r< � add_sourcee r- z CommandCollection.add_sourcer, r? c C s> | j D ]}|�||�}|d ur | jrt| ||� | S qd S rK )r� r7 rB rH )r� r, r? r� r� r; r; r< r7 i s �z CommandCollection.get_commandc C s* t � }| jD ] }|�|�|�� qt|�S rK )rJ r� r� r5 rc )r� r, r� r� r; r; r< r5 u s z CommandCollection.list_commandsr� )rF rf rg rh r1 r� r� r� r3 r� r� r� r- r0 r7 r5 ru r; r; r9 r< r� T s ����� r� r� c C s t | t�rt�t| �S )ztCheck if the value is iterable but not a string. Raises a type error, or return an iterator over the value. )rC r� r� rN r� r; r; r< � _check_iter~ s r� c " @ s� e Zd ZdZdZ dGdejeje dejej e j ej f de d ejej ej ejg ej f f d ejejed ej gej f d eje d e d eje de de dejej eeje f dejejed egej ejd eje f f dejejeeje egejej ejeef ef f ddf dd�Zdejeej f fdd�Zdefdd�Zdeje de dejeje eje eje f fd d �Zedefd d ��Zdefd d!�Zej dHd"ed#d$dejej fd%d&��Z ej 'dId"ed#e dejej ej ejg ej f f fd(d&��Z dHd"ed#e dejej ej ejg ej f f fd)d&�Z d*e d"eddfd+d,�Z d"ed-ej eej f dejej e!f fd.d/�Z"d"ed0ej dej fd1d2�Z#d0ej de fd3d4�Z$d"ed0ej dej fd5d6�Z%d"edeje fd7d8�Z&d"edejej fd9d:�Z'd"ed-ej eej f d;eje dejej eje f fd<d=�Z(d"edejejeef fd>d?�Z)d"edeje fd@dA�Z*d"edefdBdC�Z+d"edDedejd fdEdF�Z,dS )JrQ a� A parameter to a command comes in two versions: they are either :class:`Option`\s or :class:`Argument`\s. Other subclasses are currently not supported by design as some of the internals for parsing are intentionally not finalized. Some settings are supported by both options and arguments. :param param_decls: the parameter declarations for this option or argument. This is a list of flags or argument names. :param type: the type that should be used. Either a :class:`ParamType` or a Python type. The later is converted into the former automatically if supported. :param required: controls if this is optional or not. :param default: the default value if omitted. This can also be a callable, in which case it's invoked when the default is needed without any arguments. :param callback: A function to further process or validate the value after type conversion. It is called as ``f(ctx, param, value)`` and must return the value. It is called for all sources, including prompts. :param nargs: the number of arguments to match. If not ``1`` the return value is a tuple instead of single value. The default for nargs is ``1`` (except if the type is a tuple, then it's the arity of the tuple). If ``nargs=-1``, all remaining parameters are collected. :param metavar: how the value is represented in the help page. :param expose_value: if this is `True` then the value is passed onwards to the command callback and stored on the context, otherwise it's skipped. :param is_eager: eager values are processed before non eager ones. This should not be set for arguments or it will inverse the order of processing. :param envvar: a string or list of strings that are environment variables that should be checked. :param shell_complete: A function that returns custom shell completions. Used instead of the param's type completion if given. Takes ``ctx, param, incomplete`` and must return a list of :class:`~click.shell_completion.CompletionItem` or a list of strings. .. versionchanged:: 8.0 ``process_value`` validates required parameters and bounded ``nargs``, and invokes the parameter callback before returning the value. This allows the callback to validate prompts. ``full_process_value`` is removed. .. versionchanged:: 8.0 ``autocompletion`` is renamed to ``shell_complete`` and has new semantics described above. The old name is deprecated and will be removed in 8.1, until then it will be wrapped to match the new requirements. .. versionchanged:: 8.0 For ``multiple=True, nargs>1``, the default must be a list of tuples. .. versionchanged:: 8.0 Setting a default is no longer required for ``nargs>1``, it will default to ``None``. ``multiple=True`` or ``nargs=-1`` will default to ``()``. .. versionchanged:: 7.1 Empty environment variables are ignored rather than taking the empty string value. This makes it possible for scripts to clear variables if they can't unset them. .. versionchanged:: 2.0 Changed signature for parameter callback to also be passed the parameter. The old callback format will still work, but it will raise a warning to give you a chance to migrate the code easier. � parameterNFT� param_declsrE r| �defaultr� �nargsrt �metavarr� r[ �envvarr r( �autocompletionr/ c s� | � |pd| �\| _| _| _t�||�| _|d u r$| jjr"| jj}nd}|| _ || _ || _ || _ | | _ || _| | _|| _| | _� d uradd l}|jdtdd� dtdd d td tjd f� fd d� } | | _ | jjr�|| jjkr�td| jj� d| j�d|� d���t|�s�|nd }|d ur�|r�z t t |�d �}W n t y� td�d �w |dkr�|d ur�zt |� W n t y� |r�d}nd}t|�d �w |dkr�t |�|kr�|r�dnd}td|� d|� d���d S d S d S d S d S )Nr; r r z�'autocompletion' is renamed to 'shell_complete'. The old name is deprecated and will be removed in Click 8.1. See the docs about 'Parameter' for information about new behavior.r� r� r, rP rQ r. r/ r( c sn ddl m} g }� | g |�D ]&}t|t�r ||d |d d�}n t|t�r)||�}|j�|�r4|�|� q|S )Nr r' r r )r r( rC �tupler� r� r6 rh )r, rP r. r( �outr� �r� r; r< r s �z*Parameter.__init__.<locals>.shell_completeTz'nargs' must be z (or None) for type z , but it was �.z1'default' must be a list when 'multiple' is true.zK'default' must be a list of lists when 'multiple' is true and 'nargs' != 1.z+'default' must be a list when 'nargs' != 1.z item length�lengthz 'default' z must match nargs=) � _parse_declsr: rL rM r � convert_typerE � is_composite�arityr| r� r� rt r� r� r[ r� r� r� r� r� r- r� r1 r� �_custom_shell_completerY r� �nextr� r� rl )r� r� rE r| r� r� r� rt r� r� r[ r� r r� r� � check_defaultr� �subjectr; r� r< r� � s� � ����� ��� ��� � � �� zParameter.__init__c C s2 | j | j| j| j| j�� | j| j| j| j | j d� S )z�Gather information that could be useful for a tool generating user-facing documentation. Use :meth:`click.Context.to_info_dict` to traverse the entire CLI structure. .. versionadded:: 8.0 ) r: �param_type_namerL rM rE r| r� rt r� r� ) r: r� rL rM rE r� r| r� rt r� r� r� r; r; r< r� L s �zParameter.to_info_dictc C r� r� r� r� r; r; r< r� b r� zParameter.__repr__�declsc C r� rK r� )r� r� r� r; r; r< r� e s zParameter._parse_declsc C r� )z�Returns the human readable name of this parameter. This is the same as the name for options, but the metavar for arguments. r� r� r; r; r< �human_readable_namej s z Parameter.human_readable_namec C sF | j d ur| j S | j�| �}|d u r| jj�� }| jdkr!|d7 }|S )Nr �...)r� rE � get_metavarr: r� r� )r� r� r; r; r< � make_metavarq s zParameter.make_metavarr, r� r� c C r� rK r; �r� r, r� r; r; r< r� r� zParameter.get_default.c C r� rK r; r� r; r; r< r� � r� c C s4 |j | jdd�}|du r| j}|rt|�r|� }|S )a� Get the default for the parameter. Tries :meth:`Context.lookup_default` first, then the local default. :param ctx: Current context. :param call: If the default is a callable, call it. Disable to return the callable instead. .. versionchanged:: 8.0.2 Type casting is no longer performed when getting a default. .. versionchanged:: 8.0.1 Type casting can fail in resilient parsing mode. Invalid defaults will not prevent showing help text. .. versionchanged:: 8.0 Looks at ``ctx.default_map`` first. .. versionchanged:: 8.0 Added the ``call`` parameter. F�r� N)r� r: r� r� )r� r, r� r� r; r; r< r� � s rV c C r� rK r� �r� rV r, r; r; r< rU � s zParameter.add_to_parserrL c C sd |� | j�}tj}|d u r| �|�}tj}|d u r"|�| j�}tj}|d u r.| �|�}tj }||fS rK ) r� r: re rk �value_from_envvarrl r� rn r� rm �r� r, rL r� r� r; r; r< � consume_value� s zParameter.consume_valuer� c s� |du r�j s �jdkrdS dS dtjdtjf��fdd� � �jdks'�jjr0t�j��d ��n$�jdkrEdtjdtjf� ��fd d � �ndtjdtjf� ��fd d � ��j rdt �fd d�� |�D ��S �|�S )zuConvert and validate a value against the option's :attr:`type`, :attr:`multiple`, and :attr:`nargs`. N���r; r� r/ c s. zt | �W S ty ttd�� �d�d �w )NzValue must be an iterable.�r, rP )r� r� r r� r� r� r; r< � check_iter� s ���z-Parameter.type_cast_value.<locals>.check_iterr )rP r, c s t ��fdd�� | �D ��S )Nc 3 � � | ] }�� |�� �V qd S rK �rE �r �xr� r; r< r � � � �=Parameter.type_cast_value.<locals>.convert.<locals>.<genexpr>)r� r� �r� r, r� r; r< �convert� s z*Parameter.type_cast_value.<locals>.convertc s\ t � | ��} t| ��jkr"ttddt| ��j�jt| �d���d��t ��fdd�| D ��S )Nz%Takes {nargs} values but 1 was given.z*Takes {nargs} values but {len} were given.)r� rl r� c 3 r� rK r� r� r� r; r< r � r� r� )r� rl r� r r r^ r� r� r; r< r� � s � �� c 3 s � | ]}� |�V qd S rK r; r� )r� r; r< r � � � z,Parameter.type_cast_value.<locals>.<genexpr>) rt r� r1 r� r� rE r� r ra r� �r� r, r� r; )r� r� r, r� r< r� � s � zParameter.type_cast_valuec C s, |d u rdS | j dks| jr|dkrdS dS )NTr r; F)r� rt )r� r� r; r; r< �value_is_missing� s zParameter.value_is_missingc C sD | � ||�}| jr| �|�rt|| d��| jd ur | �|| |�}|S )Nr� )r� r| r� r r� r� r; r; r< � process_value� s zParameter.process_valuec C s\ | j d u rd S t| j t�rtj�| j �}|r|S d S | j D ]}tj�|�}|r+| S q d S rK )r� rC r� r r) r� �r� r, r� r� r; r; r< �resolve_envvar_value s � �z Parameter.resolve_envvar_valuec C s, | � |�}|d ur| jdkr| j�|�}|S r� )r� r� rE �split_envvar_valuer r; r; r< r� s zParameter.value_from_envvarr� c C s� t || d��/ | �||�\}}|�| j|� z| �||�}W n ty- |js)� d }Y nw W d � n1 s8w Y | jrF||j| j< ||fS )N)rP ) rS r� r� r: r� � Exceptionrx r� r� )r� r, rL r� r� r� r; r; r< rk # s �� � z Parameter.handle_parse_resultc C r� rK r; r� r; r; r< rg 7 � zParameter.get_help_recordc C r� rK r; r� r; r; r< r� : r� zParameter.get_usage_piecesc C s" | j p| jg}d�dd� |D ��S )z{Get a stringified version of the param for use in error messages to indicate which param caused the error. � / c s s � | ] }d |� d �V qdS )�'Nr; r� r; r; r< r B r� z+Parameter.get_error_hint.<locals>.<genexpr>)rL r� r� )r� r, � hint_listr; r; r< �get_error_hint= s zParameter.get_error_hintr. c sj | j dur-| � || |�}|r$t|d t�r$ddlm� � fdd�|D �}t�tjd |�S | j� || |�S )a� Return a list of completions for the incomplete value. If a ``shell_complete`` function was given during init, it is used. Otherwise, the :attr:`type` :meth:`~click.types.ParamType.shell_complete` function is used. :param ctx: Invocation context for this command. :param incomplete: Value being completed. May be empty. .. versionadded:: 8.0 Nr r' c s g | ]}� |��qS r; r; r� r' r; r< r: U r; z,Parameter.shell_complete.<locals>.<listcomp>r( ) r� rC r� r r( r1 r2 r� rE r r r; r' r< r D s zParameter.shell_complete) NNFNNNFNTFNNNr� r� )-rF rf rg rh r� r1 r� r. r� r� r � ParamTyper� rb r� r- r� r� ra r� r� r� r� r� r� r� r� r� r� r� r rU �Mappingre r� r� r� r� r� r� rk rg r� r� r r; r; r; r< rQ � s� I���� � ��� � � � � ����,��� �x�� ���� ���� ���� �!�� �2 ��� �" c % s� e Zd ZdZdZ d7dejeje dej e ef dej e ef d ej e ef d e d e d eje d ejej de de de dejej e j ej f deje de de de dej ddf$� fdd� Zdejeej f f� fdd� Zd eje d e dejeje eje eje f fd d �Zd ed!eddfd"d#�Zd!edejejeef fd$d%�Zej d8d!ed&d'dejej fd(d)��Zej *d9d!ed&e dejej ej ejg ej f f fd+d)��Z d8d!ed&e dejej ej ejg ej f f f� fd,d)� Zd!edej fd-d.�Z d!edeje f� fd/d0� Z d!edejej fd1d2�Z d!ed3ej ed4f dejej e f f� fd5d6� Z!� Z"S ):rP a� Options are usually optional values on the command line and have some extra features that arguments don't have. All other parameters are passed onwards to the parameter constructor. :param show_default: controls if the default value should be shown on the help page. Normally, defaults are not shown. If this value is a string, it shows the string instead of the value. This is particularly useful for dynamic options. :param show_envvar: controls if an environment variable should be shown on the help page. Normally, environment variables are not shown. :param prompt: if set to `True` or a non empty string then the user will be prompted for input. If set to `True` the prompt will be the option name capitalized. :param confirmation_prompt: Prompt a second time to confirm the value if it was prompted for. Can be set to a string instead of ``True`` to customize the message. :param prompt_required: If set to ``False``, the user will be prompted for input only when the option was specified as a flag without a value. :param hide_input: if this is `True` then the input on the prompt will be hidden from the user. This is useful for password input. :param is_flag: forces this option to act as a flag. The default is auto detection. :param flag_value: which value should be used for this flag if it's enabled. This is set to a boolean automatically if the option string contains a slash to mark two options. :param multiple: if this is set to `True` then the argument is accepted multiple times and recorded. This is similar to ``nargs`` in how it works but supports arbitrary number of arguments. :param count: this flag makes an option increment an integer. :param allow_from_autoenv: if this is enabled then the value of this parameter will be pulled from an environment variable in case a prefix is defined on the context. :param help: the help string. :param hidden: hide this option from help outputs. .. versionchanged:: 8.0.1 ``type`` is detected from ``flag_value`` if given. �optionNFTr� r r �confirmation_prompt�prompt_required� hide_inputrS � flag_valuert �count�allow_from_autoenvrE r r8 � show_choices� show_envvarry r/ c s d|v}t � j|f| | d�|�� |du r(| jd u r td��| j�dd��� }n |du r/d }nt�t|�}|| _ || _ || _ || _ || _ | j d uoL| j | _|d u re|d urYd}n| jr_d}nt| j�}n |du rq| jsq|d u| _|rx|rxd| _|d u r�| j }|r�| d u r�t�d |�| _|| _|o�t| jtj�| _|| _| | _| r�| d u r�tjdd �| _|r�d| _| | _ | | _ || _ || _ || _ | j!d kr�td ��| j r�| jr�| js�td ��| js�| jr�td ��| jr�| j r�| j d ur�td��| j�r| j"r�td��| j�rtd��d S d S )Nr� )rE rt Tz&'name' is required with 'prompt=True'.r� r� Fr )�minr� z&nargs=-1 is not supported for options.z+'prompt' is not valid for non-boolean flag.z1Secondary flag is not valid for non-boolean flag.z9'prompt' with 'hide_input' is not valid for boolean flag.z%'count' is not valid with 'multiple'.z$'count' is not valid with 'is_flag'.)#r7 r� r: r� r� � capitalizer1 r2 r� r r� r� r� r8 r rb rM r� r r� rE rS rC � BoolParamType� is_bool_flagr� r� �IntRanger� r r r� r� r� rt )r� r� r r r� r� r� rS r� rt r� r� rE r r8 r� r� ry �default_is_missing� prompt_textr9 r; r< r� � sz ��zOption.__init__c s0 t � �� }|j| j| j| j| j| j| jd� |S )N)r r rS r� r� r8 ) r7 r� r� r r rS r� r� r8 )r� r< r9 r; r< r� � s �zOption.to_info_dictr� r� c C sf g }g }d }g }|D ]e}|� � r |d ur td|� d���|}q |d d� dkr)dnd}||v rc|�|d�\} } | �� } | rI|�t| �� |�| � | �� } | rV|�| �� � | | krbtd|�d���q |�t|�� |�|� q |d u r�|r�|jdd � d � |d d � d d �� � }|� � s�d }|d u r�|s�d ||fS td��|s�|s�td|� d|� d���|||fS )NzName 'z' defined twicer �/�;zBoolean option z) cannot use the same flag for true/false.c S s t | d � S )Nr r� �r� r; r; r< �<lambda>' s z%Option._parse_decls.<locals>.<lambda>r_ r r� r� z#Could not determine name for optionz*No options defined but a name was passed (zH). Did you mean to declare an argument instead? Did you mean to pass '--z'?) � isidentifierr� r8 rA rh r r� rY �sortr� �lower) r� r� r� rL rM r: �possible_names�decl� split_char�first�secondr; r; r< r� sT �� �� zOption._parse_declsrV r, c C s� | j rd}n| jr d}nd}| jrE|� d�}| jr6| jr6|j| | j| j|dd� |j| | j| j|dd� d S |j| | j| j|| jd� d S |j| | j| j|| j d� d S ) Nrh r� �store�_constT)rs rL �dest�action�constF)rs rL r r r� ) rt r� rS r rM � add_optionrL r: r� r� )r� rV r, r r; r; r< rU : s@ � � � �zOption.add_to_parserc st �j rd S d� dtjt dtf� �fdd� }|�j�g}�jr'|�|�j�� �jp+d}g }�jrp�j }|d u rP�j rP|j d urP�j d urP|j � d�j � � � �}|d urpt|t�r[|n d�d d � |D ��}|�td �j|d �� |j}d |_z �j|dd�} W ||_n||_w t�jt�} | s�| d ur�js�|jr�| r�d�j� d�} n5t| ttf�r�d�dd � | D ��} n#t| �r�td�} n�jrԈjr�t�jrˈjn�jd �d } nt| �} | r�|�td�j| d�� t�jt j ��r �j r��jj dkr��jj d u �s �j�!� } | �r |�| � �j"�r|�td�� |�r.d�|�} |�r(|� d| � d�nd| � d�}� �r3dnd �|�|fS ) NFrL r/ c s6 t | �\}}|r d� �js�js|d��� � �7 }|S )NTr� )r rS r� r� )rL r� � any_slashes��any_prefix_is_slashr� r; r< � _write_optsg s z+Option.get_help_record.<locals>._write_optsr� r� z, c s � � | ]}t |�V qd S rK �r� �r �dr; r; r< r � r� z)Option.get_help_record.<locals>.<genexpr>zenv var: {var})�varTr� �(�)c s r rK r r r; r; r< r � r� z (dynamic)r r zdefault: {default})r� r| z; z [�]�[r� )#r8 r1 r. r� rL rM rh r r� r� r� rt r: r� rC r� r� r^ rx r� r rL r� r� r r r� rE r �_NumberRangeBaser� r� r� �_describe_ranger| )r� r, r r� r r� r� �var_str� resilient� default_value�show_default_is_str�default_string� range_str� extra_strr; r r< rg a sx � �� �� �� "zOption.get_help_recordr� r� c C r� rK r; r� r; r; r< r� � r� zOption.get_default.c C r� rK r; r� r; r; r< r� � r� c sJ | j r | js |jjD ]}|j| jkr|jr|j S q d S t� j||d�S )Nr� ) rS r r4 r� r: r� r� r7 r� )r� r, r� rP r9 r; r< r� � s �c sT �j dusJ ���� �}�jrt�j |�S t �j |�j�j�j�j� �fdd�d�S )z�This is an alternative flow that can be activated in the full value processing if a value does not exist. It will prompt the user until a valid value exists and then returns the processed value as result. Nc s �� � | �S rK )r� r r� r; r< r � s z)Option.prompt_for_value.<locals>.<lambda>)r� rE r� r� r� � value_proc)r r� r r rE r� r� r� )r� r, r� r; r� r< �prompt_for_value� s �zOption.prompt_for_valuec sX t � �|�}|d ur |S | jr*|jd ur*| jd ur*|j� d| j�� � �}tj�|�}|S )Nr� ) r7 r� r� rt r: r� r r) r� r� r9 r; r< r� � s � zOption.resolve_envvar_valuec C s^ | � |�}|d u r d S | jdkt| j� }|dkr-| j�|�}| jr-| jdkr-t|| j�}|S r� )r� r� rb rt rE r� rO )r� r, r� � value_depthr; r; r< r� s zOption.value_from_envvarrL rQ c s� t � �||�\}}|tu r+� jd ur!|js!� �|�}tj}||fS � j}tj }||fS � j rK|d urKt dd� |D ��rK� fdd�|D �}tj }||fS |d tj hv rh� jd urh� j s]� jrh|jsh� �|�}tj}||fS )Nc s s � | ]}|t u V qd S rK r �r �vr; r; r< r - r� z'Option.consume_value.<locals>.<genexpr>c s g | ] }|t u r � jn|�qS r; )r r� r/ r� r; r< r: / r� z(Option.consume_value.<locals>.<listcomp>)r7 r� r r rx r- re ro r� rk rt �anyrm r| r� r� r9 r� r< r� s8 ���� � ��� zOption.consume_value)NFFFTFNNFFTNNFTFr� r� )#rF rf rg rh r� r1 r� r. r� r� rb r� r r� r� r� r� ra r� r� r r- rU rg r� r� r� r� r- r� r� r� re r� ru r; r; r9 r< rP \ s� -�� � � ���� � � � � ������� m �� �5"'c��� ���� ���� � � ��rP c s� e Zd ZdZdZ ddeje deje dej ddf� fdd � Z e defd d ��Z defd d �Zdeje de dejeje eje eje f fdd�Zdedeje fdd�Zdedefdd�Zdededdfdd�Z� ZS )r{ z�Arguments are positional parameters to a command. They generally provide fewer features than options but can have infinite ``nargs`` and are required by default. All parameters are passed onwards to the parameter constructor. �argumentNr� r| ry r/ c sz |d u r|� d�d urd}n|� dd�dk}d|v r td��t� j|fd|i|�� | jd ur9| jd kr;td ��d S d S ) Nr� Fr� r r rt z9__init__() got an unexpected keyword argument 'multiple'.r| Tr� z('default' is not supported for nargs=-1.)r� r� r7 r� r� r� )r� r� r| ry r9 r; r< r� J s �zArgument.__init__c C s | j d ur| j S | j�� S rK )r� r: r� r� r; r; r< r� _ s z Argument.human_readable_namec C sR | j d ur| j S | j�| �}|s| j�� }| js d|� d�}| jdkr'|d7 }|S )Nr" r! r r� )r� rE r� r: r� r| r� )r� r r; r; r< r� e s zArgument.make_metavarr� r� c C sd |s |s d g g fS t d��t|�dkr"|d }}|�dd��� }n t dt|�� d���||gg fS )Nz%Could not determine name for argumentr r r� r� z6Arguments take exactly one parameter declaration, got r� )r� rl r� r )r� r� r� r: �argr; r; r< r� q s �� zArgument._parse_declsr, c C s | � � gS rK �r� r� r; r; r< r� � r� zArgument.get_usage_piecesc C s d| � � � d�S )Nr� r4 r� r; r; r< r� � s zArgument.get_error_hintrV c C s |j | j| j| d� d S )N)r r� rs )� add_argumentr: r� r� r; r; r< rU � r� zArgument.add_to_parserrK )rF rf rg rh r� r1 r. r� r� rb r� r� r� r� r� ra r� r� r- r� r� r rU ru r; r; r9 r< r{ @ s4 ����� �� � r{ r� rK )Wri r# r r r� r1 � collectionsr � contextlibr r � functoolsr r r r� r � itertoolsr r� r � _unicodefunr � exceptionsr r r r r r � formattingr r �globalsr r rV r r r �termuir r r �utilsr! r" r# r$ r% r& � TYPE_CHECKING�typing_extensions�ter* r( �TypeVarr� r� r) r+ r� r� ra r= rb rH �Iterabler� r� rO r� rS r. rd �Enumre r- r� r0 r3 r� r� r� rQ rP r{ r; r; r; r< �<module> s� �� ������ �,��� ��� � H 0 A| * W g