e([V* @ s9 d d l Z d d l Z d d l m Z d d l m Z d d l m Z d d l m Z d d l
m Z d d Z d
d Z
d d
d Z d d Z d d d d Z d d d Z d d Z d d Z d d Z d d Z d d Z d d d Z d! d" Z d d# l m Z m Z m Z m Z d S)$ N)update_wrapper ) iteritems)_check_for_unicode_literals)echo)get_current_contextc s f d d } t | S)z]Marks a callback as wanting to receive the current context
object as first argument.
c s t | | S)N)r )argskwargs)f /decorators.pynew_func s z pass_context.<locals>.new_func)r )r
r
r )r
r pass_context s r c s f d d } t | S)zSimilar to :func:`pass_context`, but only pass the object on the
context onwards (:attr:`Context.obj`). This is useful if that object
represents the state of a nested system.
c s t j | | S)N)r obj)r r )r
r r r
s zpass_obj.<locals>.new_func)r )r
r
r )r
r pass_obj s r Fc s f d d } | S)a. Given an object type this creates a decorator that will work
similar to :func:`pass_obj` but instead of passing the object of the
current context, it will find the innermost context of type
:func:`object_type`.
This generates a decorator that works roughly like this::
from functools import update_wrapper
def decorator(f):
@pass_context
def new_func(ctx, *args, **kwargs):
obj = ctx.find_object(object_type)
return ctx.invoke(f, obj, *args, **kwargs)
return update_wrapper(new_func, f)
return decorator
:param object_type: the type of the object to pass.
:param ensure: if set to `True`, a new object will be created and
remembered on the context if it's not there yet.
c s% f d d } t | S)Nc so t } r! | j } n | j } | d k rO t d j | j | | d d | S)NzGManaged to invoke callback without a context object of type %r existingr )r Z
ensure_objectZ find_object RuntimeError__name__Zinvoke)r r ctxr )ensurer
object_typer r r
6 s
z8make_pass_decorator.<locals>.decorator.<locals>.new_func)r )r
r
)r r )r
r decorator5 s z&make_pass_decorator.<locals>.decoratorr )r r r r )r r r make_pass_decorator s
r c C s t | t r t d y | j } | j | ` Wn t k
rR g } Yn X| j d } | d k r t j | } t | t r | j
d } n t j | } | | d <t | d | p | j
j d | d | | S)Nz5Attempted to convert a callback into a command twice.helpzutf-8namecallbackparams)
isinstanceCommand TypeError__click_params__reverseAttributeErrorgetinspectZgetdocbytesdecodecleandocr r lower)r
r attrsclsr r r r r
_make_commandE s$
r* c s. d k r t f d d } | S)a* Creates a new :class:`Command` and uses the decorated function as
callback. This will also automatically attach all decorated
:func:`option`\s and :func:`argument`\s as parameters to the command.
The name of the command defaults to the name of the function. If you
want to change that, you can pass the intended name as the first
argument.
All keyword arguments are forwarded to the underlying command class.
Once decorated the function turns into a :class:`Command` instance
that can be invoked as a command line utility or be attached to a
command :class:`Group`.
:param name: the name of the command. This defaults to the function
name.
:param cls: the command class to instantiate. This defaults to
:class:`Command`.
Nc s% t | } | j | _ | S)N)r* __doc__)r
cmd)r( r) r r r r r s zcommand.<locals>.decorator)r )r r) r( r r )r( r) r r command\ s r- c K s | j d t t | | S)zCreates a new :class:`Group` with a function as callback. This
works otherwise the same as :func:`command` just that the `cls`
parameter is set to :class:`Group`.
r) )
setdefaultGroupr- )r r( r r r groupy s r0 c C sN t | t r" | j j | n( t | d s: g | _ | j j | d S)Nr )r r r appendhasattrr )r
paramr r r _param_memo s
r4 c s f d d } | S)a Attaches an argument to the command. All positional arguments are
passed as parameter declarations to :class:`Argument`; all keyword
arguments are forwarded unchanged (except ``cls``).
This is equivalent to creating an :class:`Argument` instance manually
and attaching it to the :attr:`Command.params` list.
:param cls: the argument class to instantiate. This defaults to
:class:`Argument`.
c s, j d t } t | | | S)Nr) )popArgumentr4 )r
Z
ArgumentClass)r( param_declsr r r s zargument.<locals>.decoratorr )r7 r( r r )r( r7 r argument s
r8 c s f d d } | S)a Attaches an option to the command. All positional arguments are
passed as parameter declarations to :class:`Option`; all keyword
arguments are forwarded unchanged (except ``cls``).
This is equivalent to creating an :class:`Option` instance manually
and attaching it to the :attr:`Command.params` list.
:param cls: the option class to instantiate. This defaults to
:class:`Option`.
c sO d k r# t j d d < j d t } t | | | S)Nr r) )r# r& r5 Optionr4 )r
Z OptionClass)r( r7 r r r s
zoption.<locals>.decoratorr )r7 r( r r )r( r7 r option s
r: c s f d d } | S)a Shortcut for confirmation prompts that can be ignored by passing
``--yes`` as parameter.
This is equivalent to decorating a function with :func:`option` with
the following parameters::
def callback(ctx, param, value):
if not value:
ctx.abort()
@click.command()
@click.option('--yes', is_flag=True, callback=callback,
expose_value=False, prompt='Do you want to continue?')
def dropdb():
pass
c su d d } j d d j d | j d d j d d j d
d t ph d
| S)Nc S s | s | j d S)N)abort)r r3 valuer r r r s z8confirmation_option.<locals>.decorator.<locals>.callbackis_flagTr expose_valueFpromptzDo you want to continue?r z%Confirm the action without prompting.--yes)r@ )r. r: )r
r )r( r7 r r r s z&confirmation_option.<locals>.decoratorr )r7 r( r r )r( r7 r confirmation_option s
rA c s f d d } | S)aL Shortcut for password prompts.
This is equivalent to decorating a function with :func:`option` with
the following parameters::
@click.command()
@click.option('--password', prompt=True, confirmation_prompt=True,
hide_input=True)
def changeadmin(password):
pass
c sI j d d j d d j d d t p< d | S)Nr? TZconfirmation_promptZ
hide_input
--password)rB )r. r: )r
)r( r7 r r r s z"password_option.<locals>.decoratorr )r7 r( r r )r( r7 r password_option s rC c sF d k r' t j d j j d f d d } | S)ac Adds a ``--version`` option which immediately ends the program
printing out the version number. This is implemented as an eager
option that prints the version and exits the program in the callback.
:param version: the version number to show. If not provided Click
attempts an auto discovery via setuptools.
:param prog_name: the name of the program (defaults to autodetection)
:param message: custom message to show instead of the default
(``'%(prog)s, version %(version)s'``)
:param others: everything else is forwarded to :func:`option`.
Nr r c s j d d j d d f d d } j d d j d d j d
d j d d | d
<t p d | S)N prog_namemessagez %(prog)s, version %(version)sc
s | s | j r d S } | d k r5 | j j } } | d k r y d d l } Wn t k
rk Ynf Xxb | j D]W } | j j d p i } x3 t | D]% \ } } | j k r | j
} Pq Wqv W| d k r t d t d | d | i d | j
| j d S)Nr Zconsole_scriptszCould not determine versionprogversioncolor)resilient_parsingZ find_rootZ info_name
pkg_resources ImportErrorZ working_setZ
get_entry_mapr" r module_namerG r r rH exit)
r r3 r< rF ZverrJ ZdistscriptsZ script_nameZ entry_point)rE modulerD rG r r r s0
z3version_option.<locals>.decorator.<locals>.callbackr= Tr> Fis_eagerr zShow the version and exit.r --version)rQ )r5 r. r: )r
r )r( rO r7 rG )rE rD r r s
z!version_option.<locals>.decorator)sys _getframe f_globalsr" )rG r7 r( r r )r( rO r7 rG r version_option s %rU c s f d d } | S)al Adds a ``--help`` option which immediately ends the program
printing out the help page. This is usually unnecessary to add as
this is added by default to all commands unless suppressed.
Like :func:`version_option`, this is implemented as eager option that
prints in the callback and exits.
All arguments are forwarded to :func:`option`.
c so d d } j d d j d d j d d j d d | d
<t pb d | S)
Nc S s7 | r3 | j r3 t | j d | j | j d S)NrH )rI r Zget_helprH rM )r r3 r< r r r r " s z0help_option.<locals>.decorator.<locals>.callbackr= Tr> Fr zShow this message and exit.rP r --help)rV )r. r: )r
r )r( r7 r r r ! s
z help_option.<locals>.decoratorr )r7 r( r r )r( r7 r help_option s
rW )r r/ r6 r9 ) rR r# functoolsr Z_compatr Z _unicodefunr Zutilsr globalsr r r r r* r- r0 r4 r8 r: rA rC rU rW Zcorer r/ r6 r9 r r r r <module> s(
& 6