U
W @ s d dl Z d dlZd dlmZ d dlmZ d dlmZ ddlm Z m
Z
m Z ddl m
Z
mZmZmZ ddlmZmZmZmZmZ dd lmZmZ dd
lmZm Z dd l m Z m Z dd l m!Z!m"Z" dd
l#m$Z$m%Z%m&Z& ddl'm(Z(m)Z) e* Z+dZ,dZ-d1ddZ.d2ddZ/dd Z0dd Z1ed3ddZ2d d Z3G d d d e*Z4G d d! d!e*Z5G d"d# d#e5Z6G d$d% d%e6Z7G d&d' d'e7Z8G d(d) d)e7Z9G d*d+ d+e*Z:G d,d- d-e:Z;G d.d/ d/e:Z<dd0l=m>Z>m?Z? dS )4 N)contextmanager)repeat)update_wrapper ) convert_typeIntRangeBOOL)make_strmake_default_short_helpecho get_os_args)ClickException
UsageError BadParameterAbortMissingParameter)promptconfirm)
HelpFormatter join_options) OptionParser split_opt) push_context pop_context)PY2 isidentifier iteritems)_check_for_unicode_literals_verify_python3_envzCOMMAND [ARGS]...z*COMMAND1 [ARGS]... [COMMAND2 [ARGS]...]...c C sX |dkr d| dd }tj|}|s0dS ddlm} || |||rTtd dS )z1Internal handler for the bash completion support.Nz _%s_COMPLETE-_r ) bashcomplete) replaceupperosenvironget
_bashcompleter! sysexit)cmd prog_name complete_varZcomplete_instrr! r- /core.pyr' s r' Fc C sL | j rt|tsd S |r d}nd}td|| j|||jj| jj| jf d S )NzcIt is not possible to add multi commands as children to another multi command that is in chain modezdFound a multi command as subcommand to a multi command that is in chain mode. This is not supporteda %s. Command "%s" is set to chain and "%s" was added as subcommand but it in itself is a multi command. ("%s" is a %s within a chained %s named "%s"). This restriction was supposed to be lifted in 6.0 but the fix was flawed. This will be fixed in Click 7.0)chain
isinstance MultiCommand RuntimeErrorname __class____name__)Z base_commandcmd_namer* registerZhintr- r- r. _check_multicommand( s r8 c C s t ttt| | S N)listzipr iter)iterableZ
batch_sizer- r- r. batch= s r> c C sV t | dd }t |dd}|dk rJddlm} |td| dd | ||S | |||S )N__code__ co_argcount r )warnz}Invoked legacy parameter callback "%s". The new signature for such callbacks starting with click 2.0 is (ctx, param, value).)
stacklevel)getattrwarningsrB Warning)callbackctxparamvaluecodeargsrB r- r- r. invoke_param_callbackA s
rM c
c s z
dV W n~ t k
rV } z.|jdkr,| |_|dk rD|jdkrD||_ W 5 d}~X Y n4 tk
r } z|jdkrv| |_ W 5 d}~X Y nX dS )zPContext manager that attaches extra information to exceptions that
fly.
N)r rH rI r )rH rI er- r- r. augment_usage_errorsP s
rO c s fdd}t ||dS )zGiven 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.
c s8 z | }W n tk
r* td}Y nX | j |fS )Ninf)index
ValueErrorfloatis_eager)itemidxinvocation_orderr- r. sort_keyh s
z,iter_params_for_processing.<locals>.sort_keykey)sorted)rX Zdeclaration_orderrY r- rW r. iter_params_for_processingc s r] c @ s e Zd ZdZd.ddZdd Zdd Zed/d d Ze d
d Z
dd Z dd Z dd Z
e dd Zdd Zdd Zdd Zd d Zd d Zd!d" Zd0d$d%Zd&d' Zd(d) Zd*d+ Zd,d- ZdS )1ContextaC 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.
.. versionadded:: 2.0
Added the `resilient_parsing`, `help_option_names`,
`token_normalize_func` parameters.
.. versionadded:: 3.0
Added the `allow_extra_args` and `allow_interspersed_args`
parameters.
.. versionadded:: 4.0
Added the `color`, `ignore_unknown_options`, and
`max_content_width` parameters.
: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. 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.
NFc C s || _ || _|| _i | _g | _g | _|d kr:|d k r:|j}|| _t|di | _|d krt|d k rt|j d k rt|j
|}|| _ d | _ |d kr|d k r|j }|| _ |d kr|d k r|j
}|| _
|
d kr|j}
|
| _| d kr|j} | | _| d kr|j} | | _|
d kr|d k r|j}
ndg}
|
| _|d kr6|d k r6|j}|| _| | _|d kr|d k r|jd k r| jd k rd|j| j f }n
| | _|| _|d kr|d k r|j}|| _g | _d| _d S )Nmetaz--help%s_%sr )parentcommand info_nameparamsrL protected_argsobjrD _meta default_mapr& invoked_subcommandterminal_widthmax_content_widthallow_extra_argsallow_interspersed_argsignore_unknown_optionshelp_option_namestoken_normalize_funcresilient_parsingauto_envvar_prefixr# color_close_callbacks_depth)selfrb ra rc rf rr rh rj rk rq rl rm rn ro rp rs r- r- r. __init__ st
zContext.__init__c C s | j d7 _ t| | S Nr )ru r rv r- r- r. __enter__B s zContext.__enter__c C s* | j d8 _ | j dkr | t d S Nr r )ru closer )rv exc_type exc_valuetbr- r- r. __exit__G s
zContext.__exit__Tc c sF |s| j d7 _ z| }|V W 5 Q R X W 5 |s@| j d8 _ X dS )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)ru )rv cleanuprvr- r- r. scopeM s z
Context.scopec C s | j S )a This is a dictionary which is shared with all the contexts
that are nested. It exists so that click utiltiies 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 = __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
)rg ry r- r- r. r_ s s z Context.metac C s t | j| jdS )z4Creates the formatter for the help and usage output.)widthZ max_width)r rj rk ry r- r- r. make_formatter s zContext.make_formatterc C s | j | |S )at This decorator remembers a function as callback that should be
executed when the context tears down. This is most useful to bind
resource handling to the script execution. For instance, file objects
opened by the :class:`File` type will register their close callbacks
here.
:param f: the function to execute on teardown.
)rt append)rv fr- r- r.
call_on_close s zContext.call_on_closec C s | j D ]
}| qg | _ dS )z Invokes all close callbacks.N)rt )rv cbr- r- r. r| s
z
Context.closec C s6 d}| j dk r| j }| jdk r.| jjd | }| S )zThe 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 )rc ra command_pathlstrip)rv r r- r- r. r s
zContext.command_pathc C s | }|j dk r|j }q|S )z Finds the outermost context.Nra )rv noder- r- r. find_root s
zContext.find_rootc C s* | }|dk r&t |j|r |jS |j}qdS )z)Finds the closest object of a given type.N)r0 rf ra )rv object_typer r- r- r. find_object s
zContext.find_objectc C s" | |}|dkr | | _}|S )zLike :meth:`find_object` but sets the innermost object to a
new instance of `object_type` if it does not exist.
N)r rf )rv r r r- r- r.
ensure_object s
zContext.ensure_objectc C s, | j dk r(| j |}t|r$| }|S dS )z}Looks up the default for a parameter name. This by default
looks into the :attr:`default_map` if available.
N)rh r& callable)rv r3 r r- r- r. lookup_default s
zContext.lookup_defaultc C s t || dS )zAborts the execution of the program with a specific error
message.
:param message: the error message to fail with.
N)r )rv messager- r- r. fail s z Context.failc C s
t dS )zAborts the script.N)r ry r- r- r. abort s z
Context.abortr c C s t | dS )z-Exits the application with a given exit code.N)r( r) )rv rK r- r- r. r) s z Context.exitc C s | j | S )zaHelper method to get formatted usage string for the current
context and command.
)rb get_usagery r- r- r. r s zContext.get_usagec C s | j | S )z^Helper method to get formatted help page for the current
context and command.
)rb get_helpry r- r- r. r s zContext.get_helpc O s | dd \}}|}t |trt|}|j}t||j|d}|dkrHtd|jD ]$}|j|krN|jrN||||j< qN| dd } t |4 |$ || |W 5 Q R W 5 Q R S Q R X W 5 Q R X 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`.
N rc ra z?The given command does not have a callback that can be invoked.)
r0 CommandrG r^ r3 TypeErrorrd expose_value get_defaultrO )rL kwargsrv rG rH Z other_cmdrI r- r- r. invoke s
zContext.invokec O sR | dd \}}t |ts"td|jD ]}||kr(|j| ||< q(|j|f|S )zSimilar 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.
Nr zCallback is not a command.)r0 r r rd r )rL r rv r* rI r- r- r. forward s
zContext.forward)NNNNNNNFNNNNNN)T)r )r5
__module__ __qualname____doc__rw rz r r r propertyr_ r r r| r r r r r r r r) r r r r r- r- r- r. r^ r sJ N
%
'r^ c @ sb e Zd ZdZdZdZdZdddZdd Zd d
Z dd d Z
d
d Z dd Z dddZ
dd ZdS ) 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.
FTNc C s || _ |d kri }|| _d S r9 )r3 context_settings)rv r3 r r- r- r. rw G s zBaseCommand.__init__c C s t dd S )Nz Base commands cannot get usageNotImplementedErrorrv rH r- r- r. r R s zBaseCommand.get_usagec C s t dd S )Nz Base commands cannot get helpr r r- r- r. r U s zBaseCommand.get_helpc K sb t | jD ]\}}||kr
|||< q
t| f||d|}|jdd | || W 5 Q R X |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.
:param info_name: the info name for this invokation. 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 script.
: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.
r F)r )r r r^ r
parse_args)rv rc rL ra extrar[ rJ rH r- r- r. make_contextX s
zBaseCommand.make_contextc C s t ddS )zGiven 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.Nr )rv rH rL r- r- r. r o s zBaseCommand.parse_argsc C s t ddS )z{Given a context, this invokes the command. The default
implementation is raising a not implemented error.
z*Base commands are not invokable by defaultNr r r- r- r. r w s zBaseCommand.invokec
K sP t s t nt |dkr"t }nt|}|dkrRttjt j
rJt j
d pLt }t | || zzJ| j
||f|0}| |}|s|W 5 Q R W W S | W 5 Q R X W nf ttfk
r tt jd t Y n> tk
r } z |s | t |j W 5 d}~X Y nX W n6 tk
rJ |s. tdt jd t d Y nX dS )a1 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`.
.. versionadded:: 3.0
Added the `standalone_mode` flag to control the standalone mode.
: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 extra: extra keyword arguments are forwarded to the context
constructor. See :class:`Context` for more information.
Nr )filezAborted!r )r r r r r: r r$ pathbasenamer( argv__file__r' r r r) EOFErrorKeyboardInterruptr stderrr r
ZshowZ exit_code) rv rL r+ r, Zstandalone_moder rH r rN r- r- r. main} s> %
"zBaseCommand.mainc O s | j ||S )zAlias for :meth:`main`.)r )rv rL r r- r- r. __call__ s zBaseCommand.__call__)N)N)NNNT)r5 r r r rl rm rn rw r r r r r r r r- r- r- r. r + s
Mr c @ s e Zd ZdZd#ddZdd Zd d
Zd d Zd
d Zdd Z dd Z
dd Z dd Z dd Z
dd Zdd Zd d Zd d Zd!d" ZdS )$r 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.
: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.
N [OPTIONS]Tc
C sT t | || || _|pg | _|| _|| _|| _|d krD|rDt|}|| _| | _ d S r9 )
r rw rG rd helpepilogoptions_metavarr
short_helpadd_help_option)
rv r3 r rG rd r r r r r r- r- r. rw s
zCommand.__init__c C s" | }| || | dS )N
)r format_usagegetvaluerstriprv rH formatterr- r- r. r s zCommand.get_usagec C s& | j }| |}|d k r"||g }|S r9 )rd get_help_option)rv rH r Z help_optionr- r- r.
get_params s
zCommand.get_paramsc C s" | |}||jd| dS )z)Writes the usage line into the formatter.r N)collect_usage_piecesZ write_usager join)rv rH r piecesr- r- r. r s
zCommand.format_usagec C s, | j g}| |D ]}||| q|S )zhReturns all the pieces that go into the usage line and returns
it as a list of strings.
)r r extendget_usage_pieces)rv rH r rI r- r- r. r
s z Command.collect_usage_piecesc C s2 t |j}| jD ] }||j ||j q|S )z&Returns the names for the help option.)setro rd difference_updateoptssecondary_opts)rv rH Z all_namesrI r- r- r. get_help_option_names s
z Command.get_help_option_namesc C s4 | |}|r| jsdS dd }t|ddd|ddS )z Returns the help option object.Nc S s( |r$| j s$t| | jd | d S )Nrs )rq r r rs r) )rH rI rJ r- r- r. show_help! s
z*Command.get_help_option.<locals>.show_helpTFzShow this message and exit.)is_flagrT r rG r )r r Option)rv rH Z help_optionsr r- r- r. r s
zCommand.get_help_optionc C s8 t |}|j|_|j|_| |D ]}||| q"|S )z6Creates the underlying option parser for this command.)r rm rn r
add_to_parser)rv rH parserrI r- r- r. make_parser* s zCommand.make_parserc C s" | }| || | dS )zFormats the help into a string and returns it. This creates a
formatter and will call into the following formatting methods:
r )r format_helpr r r r- r- r. r 3 s zCommand.get_helpc C s4 | || | || | || | || dS )zWrites the help into the formatter if it exists.
This calls into the following methods:
- :meth:`format_usage`
- :meth:`format_help_text`
- :meth:`format_options`
- :meth:`format_epilog`
N)r format_help_textformat_options
format_epilogr r- r- r. r ; s
zCommand.format_helpc C s2 | j r.| | || j W 5 Q R X dS )z3Writes the help text to the formatter if it exists.N)r write_paragraph indentation
write_textr r- r- r. r J s
zCommand.format_help_textc C sX g }| |D ] }||}|dk r|| q|rT|d || W 5 Q R X dS )z8Writes all the options into the formatter if they exist.NZOptions)r get_help_recordr sectionwrite_dl)rv rH r r rI r r- r- r. r Q s
zCommand.format_optionsc C s2 | j r.| | || j W 5 Q R X dS )z2Writes the epilog into the formatter if it exists.N)r r r r r r- r- r. r ] s
zCommand.format_epilogc C s | |}|j|d\}}}t|| |D ]}||||\}}q,|r|js|js|dt|dkrjdpldd t
t |f ||_ |S )N)rL z$Got unexpected extra argument%s (%s)r sr r )
r r r] r handle_parse_resultrl rq r lenr mapr rL )rv rH rL r r Z param_orderrI rJ r- r- r. r d s
zCommand.parse_argsc C s | j dk r |j| j f|jS dS )zeGiven a context, this invokes the attached callback (if it exists)
in the right way.
N)rG r rd r r- r- r. r t s
zCommand.invoke)NNNNNNr T)r5 r r r rw r r r r r r r r r r r r r r r- r- r- r. r s.
r c @ sl e Zd ZdZdZdZdddZdd Zd d
Zdd d Z d
d Z
dd Z dd Z dd Z
dd Zdd ZdS )r1 a 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.
TFNc K s t j| |f| |d kr | }|| _|| _|d kr@|r<t}nt}|| _|| _|| _| jr|| j D ] }t
|t r^|j s^t
dq^d S )Nz<Multi commands in chain mode cannot have optional arguments.)r rw no_args_is_helpinvoke_without_commandSUBCOMMANDS_METAVARSUBCOMMAND_METAVARsubcommand_metavarr/ result_callbackrd r0 Argumentrequiredr2 ) rv r3 r r r r/ r attrsrI r- r- r. rw s
zMultiCommand.__init__c C s t | |}|| j |S r9 )r r r r rv rH r r- r- r. r s z!MultiCommand.collect_usage_piecesc C s t | || | || d S r9 )r r format_commandsr r- r- r. r s zMultiCommand.format_optionsc s fdd}|S )am Adds a result callback to the chain 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.resultcallback()
def process_result(result, input):
return result + input
.. versionadded:: 3.0
:param replace: if set to `True` an already existing result
callback will be removed.
c s> j d ksr _ S fdd}t| _ }|S )Nc s | f||f||S r9 r- )Z_MultiCommand__valuerL r r Z old_callbackr- r. function s
z@MultiCommand.resultcallback.<locals>.decorator.<locals>.function)r r )r r r r" rv r r. decorator s z.MultiCommand.resultcallback.<locals>.decoratorr- )rv r" r r- r r. resultcallback s
zMultiCommand.resultcallbackc C sj g }| |D ]2}| ||}|dkr(q|jp0d}|||f q|rf|d || W 5 Q R X dS )zeExtra format methods for multi methods that adds all the commands
after the options.
Nr ZCommands)
list_commands get_commandr r r r )rv rH r ZrowsZ
subcommandr* r r- r- r. r s
z MultiCommand.format_commandsc C st |s*| j r*|js*t| |jd | t| ||}| jrL||_ g |_
n"|rn|d d |dd |_ |_
|j
S )Nr r ) r rq r r rs r) r r r/ re rL )rv rH rL restr- r- r. r s zMultiCommand.parse_argsc s fdd} j sbjrXjs,t S " t |g W 5 Q R S Q R X d j j }g _g _ j s n |\}}}| _t |j || d}|* ||j
|W 5 Q R W 5 Q R S Q R X W 5 Q R X |r dpd _t g }|rj |\}}}|j || ddd}| | |jg }|_q"g }|D ](}| | |j
| W 5 Q R X qr||W 5 Q R S Q R X d S ) Nc s" j d k r jj | f j} | S r9 )r r rd )rJ rH rv r- r. _process_result s
z,MultiCommand.invoke.<locals>._process_resultzMissing command.r *TF)ra rl rm ) re r r/ r r r rL resolve_commandri r rb r ) rv rH r rL r6 r* Zsub_ctxZcontextsr r- r r. r sJ
8
zMultiCommand.invokec C s t |d }|}| ||}|d krD|jd k rD||}| ||}|d krtt|d rf| ||j |d| |||dd fS )Nr zNo such command "%s".r )r r rp r r rL r )rv rH rL r6 Zoriginal_cmd_namer* r- r- r. r A s
z MultiCommand.resolve_commandc C s
t dS )z{Given a context and a command name, this returns a
:class:`Command` object if it exists or returns `None`.
Nr rv rH r6 r- r- r. r [ s zMultiCommand.get_commandc C s g S )zTReturns a list of subcommand names in the order they should
appear.
r- r r- r- r. r a s zMultiCommand.list_commands)NFNNFN)F)r5 r r r rl rm rw r r r r r r r r r r- r- r- r. r1 | s$
%Dr1 c @ sD e Zd ZdZdddZdddZdd Zd d
Zd d Zd
d Z dS )GroupzA group allows a command to have subcommands attached. This is the
most common way to implement nesting in Click.
:param commands: a dictionary of commands.
Nc K s t j| |f| |pi | _d S r9 )r1 rw commands)rv r3 r r r- r- r. rw o s zGroup.__init__c C s8 |p|j }|dkrtdt| ||dd || j|< dS )zRegisters another :class:`Command` with this group. If the name
is not provided, the name of the command is used.
NzCommand has no name.T)r7 )r3 r r8 r )rv r* r3 r- r- r. add_commandt s
zGroup.add_commandc s fdd}|S )a A shortcut decorator for declaring and attaching a command to
the group. This takes the same arguments as :func:`command` but
immediately registers the created command with this instance by
calling into :meth:`add_command`.
c s t | }| |S r9 )rb r r r* rL r rv r- r. r s
z Group.command.<locals>.decoratorr- rv rL r r r- r r. rb ~ s z
Group.commandc s fdd}|S )zA shortcut decorator for declaring and attaching a group to
the group. This takes the same arguments as :func:`group` but
immediately registers the created command with this instance by
calling into :meth:`add_command`.
c s t | }| |S r9 )groupr r r r- r. r s
z Group.group.<locals>.decoratorr- r r- r r. r s z Group.groupc C s | j |S r9 )r r& r r- r- r. r s zGroup.get_commandc C s
t | jS r9 )r\ r r r- r- r. r s zGroup.list_commands)NN)N)
r5 r r r rw r rb r r r r- r- r- r. r h s
r c @ s2 e Zd ZdZd ddZdd Zdd Zd d
ZdS ) 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.
Nc K s t j| |f| |pg | _d S r9 )r1 rw sources)rv r3 r r r- r- r. rw s zCommandCollection.__init__c C s | j | dS )z1Adds a new multi command to the chain dispatcher.N)r r )rv Z multi_cmdr- r- r.
add_source s z CommandCollection.add_sourcec C s> | j D ]2}|||}|d k r| jr0t| || | S qd S r9 )r r r/ r8 )rv rH r6 sourcer r- r- r. r s
z CommandCollection.get_commandc C s* t }| jD ]}||| q t|S r9 )r r updater r\ )rv rH r r r- r- r. r s
z CommandCollection.list_commands)NN)r5 r r r rw r r r r- r- r- r. r s
r c
@ s e Zd ZdZdZd$ddZedd Zd
d Zd d
Z dd Z
dd Z dd Z dd Z
dd Zdd Zdd Zd d Zd d Zd d! Zd"d# ZdS )% Parametera! 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.
.. versionchanged:: 2.0
Changed signature for parameter callback to also be passed the
parameter. In Click 2.0, the old callback format will still work,
but it will raise a warning to give you change to migrate the
code easier.
: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 callback that should be executed after the parameter
was matched. This is called as ``fn(ctx, param,
value)`` and needs to return the value. Before Click
2.0, the signature was ``(ctx, value)``.
: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).
: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.
Z parameterNFTc C s | |p
d|\| _| _| _t||| _|d krF| jjrB| jj}nd}|| _|| _ || _
d| _ || _ || _
| | _|| _|
| _d S )Nr- r F) _parse_declsr3 r r r type is_compositeZarityr rG nargsmultipler defaultrT metavarenvvar) rv param_declsr
r r rG r r r rT r r- r- r. rw s
zParameter.__init__c C s | j S )zReturns the human readable name of this parameter. This is the
same as the name for options, but the metavar for arguments.
)r3 ry r- r- r. human_readable_name s z Parameter.human_readable_namec C sF | j d k r| j S | j| }|d kr0| jj }| jdkrB|d7 }|S )Nr ...)r r
Z get_metavarr3 r# r )rv r r- r- r. make_metavar s
zParameter.make_metavarc C s& t | jr| }n| j}| ||S )z;Given a context variable this calculates the default value.)r r type_cast_valuer r- r- r. r s
zParameter.get_defaultc C s d S r9 r- rv r rH r- r- r. r s zParameter.add_to_parserc C s6 | | j}|d kr || j}|d kr2| |}|S r9 )r& r3 r value_from_envvar)rv rH r rJ r- r- r.
consume_value s
zParameter.consume_valuec s~ j jrTjdkr tdj jrBtfdd|p:dD S |pLdS fdd |jdktj S )zGiven a value this runs it properly through the type system.
This automatically handles things like `nargs` and `multiple` as
well as composite types.
r zAttempted to invoke composite type but nargs has been set to %s. This is not supported; nargs needs to be set to a fixed value > 1.c 3 s | ]} |pd V qdS )r- N)r
.0xr r- r. <genexpr>3 s z,Parameter.type_cast_value.<locals>.<genexpr>r- c s2 dkr | S t fdd| p*dD S )Nr c 3 s | ]} |d V qdS )r Nr- r )_convertlevelr- r. r 9 s z>Parameter.type_cast_value.<locals>._convert.<locals>.<genexpr>r- )r
tuple)rJ r! r rH rv )r! r. r 6 s z+Parameter.type_cast_value.<locals>._convert)r
r r r r r" boolrv rH rJ r- r# r. r ' s
zParameter.type_cast_valuec C s |dk r| ||S dS )zaGiven a value and context this runs the logic to convert the
value as necessary.
N)r r% r- r- r.
process_value< s zParameter.process_valuec C s, |d kr dS | j dks | jr(|dkr(dS dS )NTr r- F)r r )rv rJ r- r- r. value_is_missingG s
zParameter.value_is_missingc C s> | ||}|d kr | |}| jr:| |r:t|| d|S )N)rH rI )r& r r r' r r% r- r- r. full_process_valueN s
z Parameter.full_process_valuec C sZ | j d krd S t| j ttfrH| j D ] }tj|}|d k r$| S q$ntj| j S d S r9 )r r0 r" r: r$ r% r& )rv rH r r r- r- r. resolve_envvar_valueY s
z Parameter.resolve_envvar_valuec C s, | |}|d k r(| jdkr(| j|}|S rx )r) r r
split_envvar_valuer r- r- r. r d s
zParameter.value_from_envvarc C s t || d | ||}z| ||}W n tk
rJ |jsB d }Y nX | jd k rzt| j|| |}W n tk
r |js Y nX W 5 Q R X | jr||j| j < ||fS )N)rI )
rO r r( Exceptionrq rG rM r rd r3 )rv rH r rL rJ r- r- r. r j s,
z Parameter.handle_parse_resultc C s d S r9 r- r r- r- r. r s zParameter.get_help_recordc C s g S r9 r- r r- r- r. r s zParameter.get_usage_pieces)
NNFNNNNTFN)r5 r r r param_type_namerw r r r r r r r r& r' r( r) r r r r r- r- r- r. r s4 )
r c @ s^ e Zd ZdZdZdddZdd Zd
d Zd d
Zdd Z dd Z
dd Z dd Z dd Z
dS )r 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.
:param prompt: if set to `True` or a non empty string then the user will
be prompted for input if not set. If set to `True` the
prompt will be the option name capitalized.
:param confirmation_prompt: if set then the value will need to be confirmed
if it was prompted for.
: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.
ZoptionNFTc
K s* |
dttk}tj| |fd| i|
|dkrD| jdd }n|dkrRd }n|}|| _|| _|| _ |d kr|d k r~d}n
t
| j }|r|rd| _ |d kr| j }|| _
|| _| j
rt| jt
r| d krt| _d| _nd| _| | _| r| d krtdd| _|rd| _ || _|
| _| | _|| _d S ) Nr r
Tr r Fr )min)r& _missingr rw r3 r"
capitalizer confirmation_prompt
hide_inputr$ r r r
flag_valuer0 r r
is_bool_flagcountr r allow_from_autoenvr show_defaultr )rv r r6 r r0 r1 r r2 r r4 r5 r
r r Zdefault_is_missingZ prompt_textr- r- r. rw sJ
zOption.__init__c C sJ g }g }d }g }|D ]}t |r6|d k r0td|}q|d d dkrJdpLd}||kr||d\} }
| } | r|t| || |
}
|
r||
q|t| || q|d kr|r|jdd d |d d d d
}t |sd }|d kr(|s d ||fS td |s@|s@td | |||fS )
NzName defined twicer /;c S s t | d S )Nr )r r r- r- r. <lambda> z%Option._parse_decls.<locals>.<lambda>rZ r r z#Could not determine name for optionzhNo options defined but a name was passed (%s). Did you mean to declare an argument instead of an option?)
r r splitr r r r sortr" lower) rv declsr r r r3 Zpossible_namesZdeclZ
split_charfirstsecondr- r- r. r sF
zOption._parse_declsc C s | j | j| d}| jr d}n| jr(d}nd}| jr|dd | jr| jr|j| j f|d dd| |j| jf|d d d| q|j| j f|d | j
d| n||d
< |j| j f| d S ) Ndestr rf r r4 Zstorer Z_constT)actionconstFrE ) r3 r r r4 r popr3 r Z
add_optionr r2 )rv r rH r rE r- r- r. r s> zOption.add_to_parserc s g fdd}|j g}jr4||j jp<d}g }jd k rjr|dtjttfr~d dd jD njf j
r|d |rd |r|d
pdd |f } rd pd ||fS )
Nc s> t | \}}|r dg d d < js:js:|d 7 }|S )NTr )r r r4 r )r r Z any_slashesZany_prefix_is_slashrv r- r. _write_opts: s z+Option.get_help_record.<locals>._write_optsr z default: %sz, c s s | ]}d | V qdS )z%sNr- )r dr- r- r. r J s z)Option.get_help_record.<locals>.<genexpr>r z%s[%s]z z; z / ) r r r r r r6 r0 r: r" r r )rv rH rI r r r r- rH r. r 7 s$
zOption.get_help_recordc C sF | j r:| js:|jjD ] }|j| jkr|jr|j S qd S t| |S r9 ) r r3 rb rd r3 r r2 r r )rv rH rI r- r- r. r T s zOption.get_defaultc s> }jr tj|S tj|jj fdddS )zThis 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.
c s | S r9 )r& r9 r r- r. r: q r; z)Option.prompt_for_value.<locals>.<lambda>)r r1 r0 Z
value_proc)r r3 r r r1 r0 )rv rH r r- r r. prompt_for_value` s
zOption.prompt_for_valuec C sL t | |}|d k r|S | jrH|jd k rHd|j| j f }tj|S d S )Nr` ) r r) r5 rr r3 r# r$ r% r& )rv rH r r r- r- r. r) s s zOption.resolve_envvar_valuec C sf | |}|d krd S | jdkt| j }|dkrb|d k rb| j|}| jrb| jdkrbt|| j}|S r{ )r) r r$ r r
r* r> )rv rH r Z value_depthr- r- r. r | s
zOption.value_from_envvarc C s0 |d kr"| j d k r"|js"| |S t| ||S r9 )r rq rK r r( r% r- r- r. r( s
zOption.full_process_value) NFFFFNNFFTNN)r5 r r r r, rw r r r r rK r) r r( r- r- r- r. r s,
F, r c @ sJ e Zd ZdZdZdddZedd Zdd Zd
d Z d d
Z
dd Z dS )r zArguments 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.
ZargumentNc K sd |d kr,| dd k r d}n| dddk}tj| |fd|i| | jd k r`| jdk r`tdd S )Nr Fr r r r z>nargs=-1 in combination with a default value is not supported.)r& r rw r r r )rv r r r r- r- r. rw s zArgument.__init__c C s | j d k r| j S | j S r9 )r r3 r# ry r- r- r. r s
z Argument.human_readable_namec C s> | j d k r| j S | j }| js(d| }| jdkr:|d7 }|S )Nz[%s]r r )r r3 r# r r )rv varr- r- r. r s
zArgument.make_metavarc C sv |s|sd g g fS t dt|dkrD|d }}|dd }n&t|dkrZ|\}}nt dt| ||gg fS )Nz%Could not determine name for argumentr r r r r z@Arguments take exactly one or two parameter declarations, got %d)r r r" r? )rv r@ r r3 argr- r- r. r s
zArgument._parse_declsc C s
| gS r9 )r r r- r- r. r s zArgument.get_usage_piecesc C s |j | j| j| d d S )NrC ) add_argumentr3 r r r- r- r. r s zArgument.add_to_parser)N) r5 r r r r, rw r r r r r r r- r- r- r. r s
r )rb r )N)F)N)@r$ r(
contextlibr itertoolsr functoolsr typesr r r Zutilsr r
r r
exceptionsr
r r r r Ztermuir r Z
formattingr r r r r globalsr r Z_compatr r r Z _unicodefunr r objectr. r r r' r8 r> rM rO r] r^ r r r1 r r r r r Z
decoratorsrb r r- r- r- r. <module> sT
< % . m5 K
<