k ju/DdZddlZddlmZmZmZmZmZmZm Z m Z m Z m Z m Z mZmZmZmZmZddlZddlZddlmZddlmZddlmZmZddlmZmZmZdd l m!Z!dd l"m#Z#dd lm$Z$e d ej% Z&e dej' Z(Gdde!eej%Z%Gddee%ej'Z'e dCddddddddddddddddde e)de ee)ddde ee)efde ee)efde e)de e)de e)de e)d e*d!e*d"e*d#e*d$e e*d%e e*d&e eej+d'ee$ge%ff"d(Z,e dCdddddddddddd) de e)de ee)de e&de ee)efde e)de e)de e)de e)d e*d!e*d"e*d#e*d&e eej+d*ed'ee$ge&ffd+Z, dCddd,de e)de ee)de e e&d*ed'ee$gee%e&fff d-Z,e dCddd.ddddidddddddddddd/de e)ddde ee)d0eed1e e*d2e*d!e*de ee)efdee)efde e)de e)de e)de e)d3e e)d e*d4e*d"e*d#e*d&e eej+d5e*d'ee$ge'ff*d6Z-e dCddddddddddddddd7de e)de e(de ee)d2e*d!e*de ee)efde e)de e)de e)de e)d3e e)d e*d4e*d"e*d#e*d&e eej+d*ed'ee$ge(ff$d8Z- dCdd9de e)de e e(d*ed'ee$gej'ffd:Z-Gd;de.d$ed>e.d%e!d>e.d1ed?fDZ/d@e0dAee)e.fde e%d'e0fdBZ1dS)Da~ This module contains Cloup command classes and decorators. Note that Cloup commands *are* Click commands. Apart from supporting more features, Cloup command decorators have detailed type hints and are generics so that type checkers can precisely infer the type of the returned command based on the ``cls`` argument. Why did you overload all decorators? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ I wanted that the return type of decorators depended from the ``cls`` argument but MyPy doesn't allow you to set a default value on a generic argument, see: https://github.com/python/mypy/issues/3737. So I had to resort to a workaround using @overload which makes things more verbose. '`@overload`` is on the ``cls`` argument: - in one signature, ``cls`` has type ``None`` and it's set to ``None``; in this case the type of the instantiated command is ``cloup.Command`` for ``@command`` and ``cloup.Group`` for ``@group`` - in the other signature, there's ``cls: C`` without a default, where ``C`` is a type variable; in this case the type of the instantiated command is ``C``. When and if the MyPy issue is resolved, the overloads will be removed. N)AnyCallableDictIterableList NamedTupleOptionalSequenceTupleTypeTypeVarUnioncastoverloadMutableMappingMapping)Context)OptionGroupMixin)Section SectionMixin)click_version_ge_8_1 first_boolreindent)ConstraintMixin) DEFAULT_THEME) AnyCallableC)boundGc 8eZdZUdZeZeeed<ddddede e e de e e efdeffd Z d e fd Zd ejd ejd dfdZd ejd ejd dfdZd ejd ejd dfdZd ejd ejd dfdZxZS)CommandaA ``click.Command`` supporting option groups and constraints. Refer to superclasses for the documentation of all accepted parameters: - :class:`ConstraintMixin` - :class:`OptionGroupMixin` - :class:`click.Command` Besides other things, this class also: * adds a ``formatter_settings`` instance attribute. Refer to :class:`click.Command` for the documentation of all parameters. .. versionadded:: 0.8.0 context_classN)aliasesformatter_settingsargsr$r%kwargsctj|i||gnt||_|in||_dSN)super__init__listr$r%)selfr$r%r&r' __class__s J/home/agentuser/manim-venv/lib/python3.11/site-packages/cloup/_commands.pyr+zCommand.__init__BsS $)&))))0""T']] $,BB2D returncb|jr trtj|jS|jpdS)N)epilogrinspectcleandoc)r-s r/get_normalized_epilogzCommand.get_normalized_epilogOs4 ; 1/ 1#DK00 0{ b r0ctx formatterc|jr[t|tjsJ|}|||dSdSr))r4 isinstancecloup HelpFormatterr7write_paragraph write_epilog)r-r8r9r4s r/ format_epilogzCommand.format_epilogUsl ; +i)<== = ==//11F  % % ' ' '  " "6 * * * * *  + +r0cht|tjsJ||dSr))r;r<r=write_command_help_textr-r8r9s r/format_help_textzCommand.format_help_text\s7)U%899999))$/////r0c|jsdSt|tjsJ||jdSr))r$r;r<r= write_aliasesrCs r/format_aliaseszCommand.format_aliasesbsF|  F)U%899999 -----r0c||||||||||||||r|||t |tjr| ||| ||dSr)) format_usagerGrD format_paramsmust_show_constraintsformat_constraintsr;click MultiCommandformat_commandsr@rCs r/ format_helpzCommand.format_helphs #y))) C+++ c9--- 3 ***  % %c * * 4  # #C 3 3 3 dE. / / 1  i 0 0 0 3 *****r0)__name__ __module__ __qualname____doc__rr#r __annotations__rr rstrrr+r7rMr=r@rDrGrP __classcell__r.s@r/r"r"/s $+M4=***,07; F F F F(3-( F%T#s(^4 F F F F F F F!s!!!! ++5;N+SW++++0=0-2-@0 0000 .%-.Ededd!ee(e,dee"e deed ed e%e&ge e j*e,fff d?Z+e-d ee(e j*fd@Z.xZ/S)CGroupa A ``click.Group`` that allows to organize its subcommands in multiple help sections and whose subcommands are, by default, of type :class:`cloup.Command`. Refer to superclasses for the documentation of all accepted parameters: - :class:`SectionMixin` - :class:`Command` - :class:`click.Group` Apart from superclasses arguments, the following is the only additional parameter: ``show_subcommand_aliases``: ``Optional[bool] = None`` whether to show subcommand aliases; aliases are shown by default and can be disabled using this argument or the homonym context setting. .. versionchanged:: 0.14.0 this class now supports option groups and constraints. .. versionadded:: 0.10.0 the "command aliases" feature, including the ``show_subcommand_aliases`` parameter/attribute. .. versionchanged:: 0.8.0 this class now inherits from :class:`cloup.BaseCommand`. FSHOW_SUBCOMMAND_ALIASESN)show_subcommand_aliasescommandsr&r\r]r'ctj|i|||_ i|_ |r||dSdSr))r*r+r\ alias2nameadd_multiple_commands)r-r\r]r&r'r.s r/r+zGroup.__init__sb $)&)))'>$1*,>  1  & &x 0 0 0 0 0 1 1r0r1ct|tr3|D]\}}|||dS|D]}||dS)N)name)r;ritems add_command)r-r]rbcmds r/r`zGroup.add_multiple_commandss h ( ( &%^^-- 1 1 c  4 0000 1 1  & &  %%%% & &r0Trerbsectionfallback_to_default_sectionct|||||tt|jn|}t |dg}|D] }||j|< dS)Nr$)r*rdrrVrbgetattrr_)r-rerbrfrgr$aliasr.s r/rdzGroup.add_commandsw Cw0KLLL&*ltC"""#y"-- * *E%)DOE " " * *r0r8c|jr||}||jvr|S|j|S)zMap a string supposed to be a command name or an alias to a normalized command name. If no match is found, it returns ``None``.)token_normalize_funcr]r_get)r-r8rbs r/resolve_command_namezGroup.resolve_command_namesJ  # 2++D11D 4= K""4(((r0c|||d}|r||d< t||S#tj$r3}||dg|j|j|}|d}~wwxYw)Nr)bad_name valid_nameserror)rnr*resolve_commandrM UsageErrorhandle_bad_command_namer]r_)r-r8r&normalized_namerr new_errorr.s r/rszGroup.resolve_commands33CaAA  & &DG 77**355 5   44a>dm>do>5I O  s!AB .BB rprqrrc:ddl}|||}|s|St|dkr d|dd}n$dd|D}d|z}t |d z|z}t j||jS) aThis method is called when a command name cannot be resolved. Useful to implement the "Did you mean ?" feature. :param bad_name: the command name that could not be resolved. :param valid_names: the list of valid command names, including aliases. :param error: the original error coming from Click. :return: the original error or a new one. rNrzDid you mean 'z'? c3 K|] }d|zV dS)z N).0matchs r/ z0Group.handle_bad_command_name..s&$H$HuUU]$H$H$H$H$H$Hr0zDid you mean one of these?  ) difflibget_close_matcheslenjoinrVrM exceptionsrtr8) r-rprqrrrmatches extra_msg matches_list error_msgs r/ruzGroup.handle_bad_command_names ++HkBB FL \\Q  7777II99$H$H$H$H$HHHL6EIJJ$y0 **9ei@@@r0c`t|jt|ddtjS)Nr\)rr\rirZr[)r-r8s r/must_show_subcommand_aliasesz"Group.must_show_subcommand_aliasess0  ( C2D 9 9  )   r0c8t|dd}|r||rqt|tjsJt tj|jdt}| ||}|d|S|S)Nr$themer) rirr;r<rr HelpThemer%rmrformat_subcommand_aliases)r-r8rbrer$r alias_lists r/format_subcommand_namezGroup.format_subcommand_names#y$//  *t88== *c5=11 1 11!7!;!;G]!S!SE77GGJ))Z)) ) r0r$rcj}| |jkr,dd|dS|d|dfd|Dz|dzS)N(z, )c3BK|]}|VdSr))rj)r|rjrs r/r~z2Group.format_subcommand_aliases.. s/,U,UEU[[-?-?,U,U,U,U,U,Ur0)alias_secondaryrjr)r$rsecondary_styles ` r/rzGroup.format_subcommand_aliasess/  "o&D&D;;8499W#5#588899 9 $$!/$'',,,U,U,U,UW,U,U,UUUV!/#&&' r0 [OPTIONS])r$clsrfcontext_settingsr%helpr4 short_helpoptions_metavaradd_help_optionno_args_is_helphidden deprecatedalign_option_groupsshow_constraintsparamsrrr%rr4rrrrrrrrrcdSr)r{)r-rbr$rrfrr%rr4rrrrrrrrrs r/commandz Group.command * r0) r$rfrrr4rrrrrrrc  dSr)r{)r-rbr$rrfrrr4rrrrrrrr's r/rz Group.command(s & r0)r$rrfc ttd||jn||d|dtdtjffd }|S)aReturn a decorator that creates a new subcommand of this ``Group`` using the decorated function as callback. It takes the same arguments of :func:`command` plus: ``section``: ``Optional[Section]`` if provided, put the subcommand in this section. .. versionchanged:: 0.10.0 all arguments but ``name`` are now keyword-only. Nrbrr$fr1cL|}||SN)rfrd)rre make_commandrfr-s r/ decoratorz Group.command..decoratorTs.,q//C   S'  2 2 2Jr0r{)r command_classrrMr")r-rbr$rrfr'rrs` ` @r/rz Group.command=s|$ #+D..3  %             r0r{)r$rrfsectionsalign_sectionsinvoke_without_commandrrr%rr4rrsubcommand_metavarrchainrrr\rrrrrcdSr)r{)r-rbr$rrfrrrrrr%rr4rrrrrrrr\s r/groupz Group.group^s 0 r0)r$rrfrrrrr4rrrrrrrrc dSr)r{)r-rbr$rrfrrrrr4rrrrrrrrr's r/rz Group.groupxrr0)rr$rfc td||p|d|dtdttjt fffd }|S)aReturn a decorator that creates a new subcommand of this ``Group`` using the decorated function as callback. It takes the same argument of :func:`group` plus: ``section``: ``Optional[Section]`` if provided, put the subcommand in this section. .. versionchanged:: 0.10.0 all arguments but ``name`` are now keyword-only. rrr1cL|}||Srr)rre make_grouprfr-s r/rzGroup.group..decorators.*Q--C   S'  2 2 2Jr0r{)r_default_group_classrrrMrZr )r-rbrr$rfr'rrs` ` @r/rz Group.groups& 3=$";";"="=w  RX    u{A~)>         r0c|jdS|jtur|Stttj|jSr)) group_classtyperr rMrZrs r/rzGroup._default_group_classs: ? "4 ?d " "JU[)3?;; ;r0)NNTr))0rQrRrSrTr[boolrUrr rrrVrMr"r r+rr`rrdrrnrr rsrtrurr staticmethodr<rrrrr Parameterrrrr rrZrr classmethodrrWrXs@r/rZrZts 4%*T)))37  1111!)$1 .em!34hu}6MM N 1  111111$&gc5=&898EM;RRS& &&&&#%),0 * *= *sm *'" *&* *  * * * * * *) )S)Xc]))))=(,S  x}hu}5tCy@ A(AA*.s)A2  %T#s(^4 sm   SM "#     &d^! "#4.# $eo./% & ;-. /'   X ,$( ,0%)59" $$()4 $ % 26   SM (3-( !W  '"  #4S>2  sm   SM "#     eo./ ! " ;-" ##   X *%)+/!%%) SM(3-(d1g '"    ;-u}a'7!88 9 B$( ,0%)&()-', %59-/" $$()4,0 $ (-+   SM (3-(   '"  7#  ! !%  #4S>2 !cN sm   SM "# %SM! "# $% &' () *"&+ , ;-, --   X 2$( +/!%%)', %59" $$()4,0 $ 26#   SM (3-( d1g  '"  !%    #4S>2 sm   SM "# %SM    ! "eo./# $% & ;-" #'   X .&*"&+/%) TNd1g (3-(  '"    ;-u{A~!66 7<= 8.1.0)** a list of parameters (:class:`Argument` and :class:`Option` instances). Params added with ``@option`` and ``@argument`` are appended to the end of the list if given. :param kwargs: any other argument accepted by the instantiated command class (``cls``). z5you forgot parenthesis in the command decorator for `zN`. While parenthesis are optional in Click >= 8.1, they are required in Cloup.rr1c t|drRr(ttstddt t |j}|`|d<tttnt} tttj fd|i|}rt|_|S#t$r}t|t |d}~wwxYw)N__cloup_constraints__zOa `Command` must inherit from `cloup.ConstraintMixin` to support constraints; `z ` doesn't constraintsr)hasattr issubclassr TypeErrortuplereversedrrr r"rrMrr,r$_process_unexpected_kwarg_error _ARGS_INFO) rrcmd_clsrerrr$rr'rbs r/rzcommand..decorator?s# 1- . . 0 5:c?;; 54%(444555 )@ A ABBK'$/F= !tG}S_cc'JJ NqD%-DD'DVDDQGGHHC ,"7mm J N N N1%WMM M NsAC C; C66C;)callable ExceptionrQrr)rbr$rr'rs```` r/rrsh~~  [DM [ [ [   N[NQNNNNNNNNN& r0r{)rr$rrrrrr%rrr4rrrrrrrr\rrrrrr\cdSr)r{)rbrr$rrrrrr%rrr4rrrrrrrr\s r/rrUs 0Cr0)r$rrrrrr4rrrrrrrc dSr)r{)rbrr$rrrrrr4rrrrrrrr's r/rrps *Cr0rc |td|td|St|tjrtd||d|St d)a Return a decorator that instantiates a ``Group`` (or a subclass of it) using the decorated function as callback. .. versionchanged:: 0.10.0 the ``cls`` argument can now be any ``click.Group`` (previously had to be a ``cloup.Group``) and the type of the instantiated command matches it (previously, the type was ``cloup.Group`` even if ``cls`` was a subclass of it). .. versionchanged:: 0.9.0 all arguments but ``name`` are now keyword-only arguments. :param name: the name of the command to use unless a group overrides it. :param cls: the ``click.Group`` (sub)class to instantiate. This is ``cloup.Group`` by default. Note that some of the arguments are only supported by ``cloup.Group``. :param sections: a list of Section objects containing the subcommands of this ``Group``. This argument is only supported by commands inheriting from :class:`cloup.SectionMixin`. :param align_sections: whether to align the columns of all subcommands' help sections. This is also available as a context setting having a lower priority than this attribute. Given that this setting should be consistent across all you commands, you should probably use the context setting only. :param context_settings: an optional dictionary with defaults that are passed to the context object. :param formatter_settings: arguments for the formatter; you can use :meth:`HelpFormatter.settings` to build this dictionary. :param help: the help string to use for this command. :param short_help: the short help to use for this command. This is shown on the command listing of the parent command. :param epilog: like the help string but it's printed at the end of the help page after everything else. :param options_metavar: metavar for options shown in the command's usage string. :param add_help_option: by default each command registers a ``--help`` option. This can be disabled by this parameter. :param hidden: hide this command from help outputs. :param deprecated: issues a message indicating that the command is deprecated. :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: string used in the command's usage string 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 params: **(click >= 8.1.0)** a list of parameters (:class:`Argument` and :class:`Option` instances). Params added with ``@option`` and ``@argument`` are appended to the end of the list if given. :param kwargs: any other argument accepted by the instantiated command class. N)rbrzCthis decorator requires `cls` to be a `click.Group` (or a subclass)r{)rrZrrMr)rbrr's r/rrsmV {6De66v666 C % %S4Dc44V444 QSS Sr0c>eZdZUeed<eeed<dZeed<dS)_ArgInfoarg_namerequiresr3 supported_byN)rQrRrSrVrUr rrr{r0r/rrs;MMM3iL#r0rci|] }|j| Sr{)r)r|infos r/ rs) DM4r0zboth `Command` and `Group`z`Group`rr args_infoc Tddl}t|}|dd|D|}||S|}||}t d|d|d|jd|jjd d }|d z|z} t| S) zCheck if the developer tried to pass a Cloup-specific argument to a ``cls`` that doesn't support it and if that's the case, augments the error message to provide useful more info about the error.rN|c3K|]}|VdSr)r{)r|rs r/r~z2_process_unexpected_kwarg_error..s"BBHxBBBBBBr0z Hint: you set `cls=z/` but this class doesn't support the argument `z4`. In Cloup, this argument is supported by `z` via `z`. ry) rerVsearchrrrrrrQr) rrrrrmessager}argr extra_info new_messages r/rrs III%jjG IIchhBB BBBBBG L LE } ++--C S>DPS262Cm$   J D.:-K [ ! !!r0r))2rTr5typingrrrrrrr r r r r rrrrrrMr<_contextr_option_groupsr _sectionsrr_utilrrrrrstylingrrr"rrZr rVrrrrrrrrr{r0r/rs 0  ,,,,,,,,,,,,,,==========(((((("""""" GCu}%%% GCu{###B+B+B+B+B+o/B+B+B+J@<@<@<@<@