k jSddlZddlmZmZmZmZmZmZmZm Z ddl Z ddl m Z m Z mZmZmZmZmZmZddlmZmZmZmZmZmZddlmZmZddlmZmZed d Z ee j!d ge"fZ#eege"fZ$Gd d ej%Z&Gdd e&ej%Z'Gdde'Z(Gdde'Z)Gdde Z*Gdde&Z+Gdde&ej,Z-Gdde&Z.Gdde&Z/Gdde&Z0Gd d!e-Z1Gd"d#e-Z2e.Z3 e0d4d$d%e*j5&Z6 e3e6z4d'd(e*j5&Z7 e0d4d)d*e*j5&Z8 e/dZ9 e1dZ:dS)+N)AnyCallableOptionalSequenceTypeVarUnioncastoverload) FrozenSpace check_arg class_name first_boolmake_one_line_repr make_repr pluralizereindent)format_param_listget_param_labelget_param_nameget_params_whose_value_is_setget_required_paramsparam_value_is_set)ConstraintViolatedUnsatisfiableConstraint) DecoratorFOpOperator)bound ConstraintcteZdZdZedejdefdZde de fdZ e j dejde fdZdeejdd fd Ze j deejdejdd fd Ze ddeejdeejdd fd Zeddee deejdd fd Z ddeeejee fdeejdd fdZ dded e efded e efddfdZddZdedeegeffdZddZd dZ de fdZ!d S)!r"a A constraint that can be checked against an arbitrary collection of CLI parameters with respect to a specific :class:`click.Context` (which contains the values assigned to the parameters in ``ctx.params``). .. versionchanged:: 0.9.0 calling a constraint, previously equivalent to :meth:`~Constraint.check`, is now equivalent to calling :func:`cloup.constrained_params` with this constraint as first argument. ctxreturnc@tt|dddS)zReturn ``True`` if consistency checks are enabled. .. versionchanged:: 0.9.0 this method now a static method and takes a ``click.Context`` in input. check_constraints_consistencyT)rgetattr)r$s R/home/agentuser/manim-venv/lib/python3.11/site-packages/cloup/constraints/_core.pymust_check_consistencyz!Constraint.must_check_consistency(s) C8$ ? ?    attrcRd}||vrtd|dt|)N)toggle_consistency_checksconsistency_checks_toggledz attribute `z` was removed in v0.9. You can now enable/disable consistency checks using the `click.Context` parameter `check_constraints_consistency`. Pass it as part of your `context_settings`.)AttributeError)selfr, removed_attrss r) __getattr__zConstraint.__getattr__4sJS =  ?d??? !&& &r+cdS)z!A description of the constraint. Nr1r$s r)helpzConstraint.help@r+paramsNcdS)a Perform some sanity checks that detect inconsistencies between these constraints and the properties of the input parameters (e.g. required). For example, a constraint that requires the parameters to be mutually exclusive is not consistent with a group of parameters with multiple required options. These sanity checks are meant to catch developer's mistakes and don't depend on the values assigned to the parameters; therefore: - they can be performed before any parameter parsing - they can be disabled in production (setting ``check_constraints_consistency=False`` in ``context_settings``) :param params: list of :class:`click.Parameter` instances :raises: :exc:`~cloup.constraints.errors.UnsatisfiableConstraint` if the constraint cannot be satisfied independently from the values provided by the user Nr5)r1r9s r)check_consistencyzConstraint.check_consistencyDr8r+cdS)a Check that the constraint is satisfied by the input parameters in the given context, which (among other things) contains the values assigned to the parameters in ``ctx.params``. You probably don't want to call this method directly. Use :meth:`check` instead. :param params: list of :class:`click.Parameter` instances :param ctx: :class:`click.Context` :raises: :exc:`~cloup.constraints.ConstraintViolated` Nr5r1r9r$s r) check_valueszConstraint.check_valuesZr8r+cdSNr5r=s r)checkzConstraint.checkjs  r+cdSr@r5r=s r)rAzConstraint.checkps r+c&ddlm}|std|tjn|}t |j|stdt |dtr;ttt|}|j |}n%tttj |}t|r|||||S)a Raise an exception if the constraint is not satisfied by the input parameters in the given (or current) context. This method calls both :meth:`check_consistency` (if enabled) and :meth:`check_values`. .. tip:: By default :meth:`check_consistency` is called since it shouldn't have any performance impact. Nonetheless, you can disable it in production passing ``check_constraints_consistency=False`` as part of your ``context_settings``. :param params: an iterable of parameter names or a sequence of :class:`click.Parameter` :param ctx: a `click.Context`; if not provided, :func:`click.get_current_context` is used :raises: :exc:`~cloup.constraints.ConstraintViolated` :exc:`~cloup.constraints.UnsatisfiableConstraint` r)ConstraintMixinz argument `params` can't be emptyNzDconstraints work only if the command inherits from `ConstraintMixin`r)_supportrD ValueErrorclickget_current_context isinstancecommand TypeErrorstrr rget_params_by_name Parameterr"r*r;r>)r1r9r$rD param_namesparams_objectss r)rAzConstraint.checkts 2 .----- A?@@ @-0[e')))c#+77 1011 1 fQi % % Ex}f55K [;;KHHNN!(5?";VDDN  , ,S 1 1 3  " "> 2 2 2  555r+r7error Rephraserc&t|||S)a Override the help string and/or the error message of this constraint wrapping it with a :class:`Rephraser`. :param help: if provided, overrides the help string of this constraint. It can be a string or a function ``(ctx: click.Context, constr: Constraint) -> str``. If you want to hide this constraint from the help, pass ``help=""``. :param error: if provided, overrides the error message of this constraint. It can be: - a string, eventually a ``format`` string supporting the replacement fields described in :class:`ErrorFmt`. - or a function ``(err: ConstraintViolated) -> str``; note that a :class:`ConstraintViolated` error has fields for ``ctx``, ``constraint`` and ``params``, so it's a complete description of what happened. r7rQrR)r1r7rQs r) rephrasedzConstraint.rephraseds2D6666r+c$t|dS)z+Hide this constraint from the command help.r7rUr1s r)hiddenzConstraint.hiddensB''''r+ param_adderscddlm}t|ds'ddlm}t t d|dd||g|RS)a]Equivalent to calling :func:`cloup.constrained_params` with this constraint as first argument. .. versionchanged:: 0.9.0 this method, previously equivalent to :meth:`~Constraint.check`, is now equivalent to calling :func:`cloup.constrained_params` with this constraint as first argument. r)constrained_paramsr) __version__z since Cloup v0.9, calling a constraint has a completely different semantics and takes parameter decorators as arguments, see: https://cloup.readthedocs.io/en/vz/pages/constraints.html#constraints-as-decorators To check a constraint imperatively, you can use the check() method. )rEr^callablecloupr_rKr)r1r\r^r_s r)__call__zConstraint.__call__s 100000 Q((  ) ) ) ) ) )H&3> &&& "!$66666r+otherOrc"t||Sr@)rer1rds r)__or__zConstraint.__or__s$r+Andc"t||Sr@)rirgs r)__and__zConstraint.__and__s4r+c&t|dS)Nz())r rZs r)__repr__zConstraint.__repr__sT""&&&&r+r@NN)r%rR)rdr"r%re)rdr"r%ri)"__name__ __module__ __qualname____doc__ staticmethodrGContextboolr*rLrr3abcabstractmethodr7rrNr;r>r rrAr HelpRephraserErrorRephraserrVr[rrrrcrhrkrmr5r+r)r"r"s    EM  d    \   ' ' ' ' ' ' 0 0#0000 (A d    ,   8EO#<  5=  UY      PT  u/ 6>u}6M    X   HSM 0G SW   X (,+6+6HU_5x}DE+6 em $+6 +6+6+6+6^152677D#},-7T3./7  77776((((7i7HaS!V4D7777.    '#''''''r+cxeZdZUdZeed< defdZdej defdZ de ej dd fd Z defd Zd S) r z;Base class for all n-ary operators defined on constraints. HELP_SEP constraintsc||_dS)zMN-ary operator for constraints. :param constraints: operands N)r|)r1r|s r)__init__zOperator.__init__s'r+r$r%cZ|jfd|jDS)Nc3K|]F}t|trd|zn|VGdS)z(%s)N)rIr r7).0cr$s r) z Operator.help..sd" " %/q($;$; LFQVVC[[ " " " " " " r+)r{joinr|r6s `r)r7z Operator.helpsF}!!" " " " %" " "    r+r9NcD|jD]}||dSr@)r|r;)r1r9rs r)r;zOperator.check_consistencys5! ( (A   ' ' ' ' ( (r+c&t|g|jRSr@)rr|rZs r)rmzOperator.__repr__s1 01111r+)rorprqrrrL__annotations__r"r~rGrtr7rrNr;rmr5r+r)r r sEEMMM='Z''''    #    ((A(d((((2#222222r+cZeZdZdZdZdeejdejddfdZ de ddfd Z dS) riz-It's satisfied if all operands are satisfied.z and r9r$r%NcF|jD]}|||dSr@)r|r>r1r9r$rs r)r>zAnd.check_valuess5! ( (A NN63 ' ' ' ' ( (r+rdct|trtg|j|jRStg|j|RSr@)rIrir|rgs r)rkz And.__and__sO eS ! ! >=(=5+<=== =,D$,e,,,,r+) rorprqrrr{rrGrNrtr>r"rkr5r+r)ririst77H(8EO#<(5=(UY((((-Z-E------r+ricZeZdZdZdZdeejdejddfdZ de ddfd Z dS) rezrdefaultr7rs r)r>zOr.check_values s!  A vs+++%     ( IIcNNV    s $ 11rdct|trtg|j|jRStg|j|RSr@)rIrer|rgs r)rhz Or.__or__sO eR  =r"rhr5r+r)rere stFFH  8EO#<  5=  UY     ,J,4,,,,,,r+receZdZdZdZ dZdS)ErrorFmtaV:class:`Rephraser` allows you to pass a ``format`` string as ``error`` argument; this class contains the "replacement fields" supported by such format string. You can use them as following:: mutually_exclusive.rephrased( error=f"{ErrorFmt.error}\n" f"Some extra information here." ) z{error}z {param_list}N)rorprqrrrQ param_listr5r+r)rrs. EH JLLr+rc eZdZdZ ddededeefdedeeffdZ de j defd Z d e deefd Zd ee jddfd Zd ee jde j ddfdZdefdZdS)rRaA constraint decorator that can override the help and/or the error message of the wrapped constraint. You'll rarely (if ever) use this class directly. In most cases, you'll use the method :meth:`Constraint.rephrased`. Refer to it for more info. .. seealso:: - :meth:`Constraint.rephrased` -- wraps a constraint with a ``Rephraser``. - :class:`WrapperConstraint` -- alternative to ``Rephraser``. - :class:`ErrorFmt` -- describes the keyword you can use in an error format string. Nrr7rQcV||td||_||_||_dS)Nz(`help` and `error` cannot both be `None`)rFr_help_error)r1rr7rQs r)r~zRephraser.__init__@s5 rr)r1r9r$rrephrased_errors r)r>zRephraser.check_valueses  O ( ( 5 5 5 5 5!   "77<rmr5r+r)rRrR1s3   1526  $ D#},- T3./    4 4#4444 $(: $x} $ $ $ $8(A8d88888EO#<5=UY9#999999r+rRceZdZdZdedefdZdejde fdZ de ej dd fd Z de ej dejdd fd Zde fd Zd S) WrapperConstraintaAbstract class that wraps another constraint and delegates all methods to it. Useful when you want to define a parametric constraint combining other existing constraints minimizing the boilerplate. This is an alternative to defining a function and using :class:`Rephraser`. Feel free to do that in your code, but cloup will stick to the convention that parametric constraints are defined as classes and written in camel-case.rattrsc "||_||_dS)z :param constraint: the constraint to wrap :param attrs: these are just used to generate a ``__repr__`` method N) _constraint_attrs)r1rrs r)r~zWrapperConstraint.__init__}s & r+r$r%c6|j|Sr@)rr7r6s r)r7zWrapperConstraint.helps$$S)))r+r9Nc |j|dS#t$r}t|||jd}~wwxYwr)rr;rrrs r)r;z#WrapperConstraint.check_consistencys_ R   . .v 6 6 6 6 6& R R R)$vcjQQQ Q Rrc<|j||dSr@)rr>r=s r)r>zWrapperConstraint.check_valuess! %%fc22222r+c&t|fi|jSr@)rrrZs r)rmzWrapperConstraint.__repr__s-----r+)rorprqrrr"rr~rGrtrLr7rrNr;r>rmr5r+r)rrss:* *#****R(ARdRRRR 38EO#<35=3UY3333.#......r+r) metaclassc`eZdZdZdejdefdZdeej dejddfdZ dS) _RequireAllz$Satisfied if all parameters are set.r$r%cdS)Nz all requiredr5r6s r)r7z_RequireAll.helps~r+r9Nc |jfd|D}t|rVttt |t |dddt ||||dS)Nc Zg|]'}t|t|%|(Sr5)rr)rparamvaluess r) z,_RequireAll.check_values..sKYYY%1%u@U@U9VWWYYYYr+rz is requiredz'the following parameters are required: )onemanyr)r9anyrrlenrr)r1r9r$ unset_paramsrs @r)r>z_RequireAll.check_valuessYYYY6YYY |   $ %%*<?;;III>-l;;>>???       r+) rorprqrrrGrtrLr7rrNr>r5r+r)rrsq.. #8EO#<5=UYr+rceZdZdZdefdZdejdefdZ de ej ddfd Z de ej dejddfd Z defd ZdS) RequireAtLeastz2Satisfied if the number of set parameters is >= n.nc:t|dk||_dSNr)r min_num_paramsr1rs r)r~zRequireAtLeast.__init__"!q&r+r$r%cd|jdS)N at least required)rr6s r)r7zRequireAtLeast.helps94.9999r+r9Nc|j}t||kr'd|dt|d}t|||dS)Nz%the constraint requires a minimum of z1 parameters but it is applied on a group of only z parameters!)rrr)r1r9rrs r)r;z RequireAtLeast.check_consistencysh   v;;??NNN47KKNNN *$?? ? ?r+c|j}t||j}t||kr&t d|dt ||||dS)Nr* of the following parameters must be set: r)rrr9rrrr1r9r$r given_paramss r)r>zRequireAtLeast.check_valuessz  4VSZHH |  q $/A//$V,,//D  ! r+c,t||jSr@)rrrZs r)rmzRequireAtLeast.__repr__t2333r+rorprqrrintr~rGrtrLr7rrNr;r>rmr5r+r)rrs<< #    : :#::::@(A@d@@@@8EO#<5=UY4#444444r+rceZdZdZdefdZdejdefdZ de ej ddfd Z de ej dejddfd Z defd ZdS) AcceptAtMostz2Satisfied if the number of set parameters is <= n.rc:t|dk||_dSr)r max_num_paramsrs r)r~zAcceptAtMost.__init__rr+r$r%cd|jdS)Nzat most accepted)rr6s r)r7zAcceptAtMost.helps8$-8888r+r9Nctt|}||jkr|d}t|||dS)Nz of the parameters are required)rrrr)r1r9num_required_paramsrs r)r;zAcceptAtMost.check_consistencysO!"5f"="=>> !4 4 4+LLLF)$?? ? 5 4r+c|j}t||j}t||kr&t d|dt ||||dS)Nz no more than z) of the following parameters can be set: r)rrr9rrrrs r)r>zAcceptAtMost.check_valuessz  4VSZHH |  q $///$V,,//D  ! r+c,t||jSr@)rrrZs r)rmzAcceptAtMost.__repr__rr+rr5r+r)rrs<< #    9 9#9999@(A@d@@@@ 8EO#<5=UY4#444444r+rceZdZdZdeffd ZdejdefdZ de ej dejddfd Z defd Z xZS) RequireExactlyz1Requires an exact number of parameters to be set.rct|dktt|t |z||_dSr)r superr~rr num_params)r1r __class__s r)r~zRequireExactly.__init__sK!a% **\!__<===r+r$r%cd|jdS)Nexactly r)rr6s r)r7zRequireExactly.helps4$/4444r+r9Nc|j}t||j}t||kr9t |dd|dt |z}t ||||dS)Nz.none of the following parameters must be set: rr)countzerorr)rrr9rrrr)r1r9r$rrrs r)r>zRequireExactly.check_valuess O4VSZHH |   ! !FNNNN"&)) *F %CDAAA A " !r+c,t||jSr@)rrrZs r)rmzRequireExactly.__repr__st///r+)rorprqrrrr~rGrtrLr7rrNr>rm __classcell__rs@r)rrs;;# 5 5#5555 A8EO#< A5= AUY A A A A0#00000000r+rcBeZdZdedeffd ZdejdefdZxZ S) AcceptBetweenminmaxct|dkd|t||kdtt|t |z||||_||_dS)zSatisfied if the number of set parameters is between ``min`` and ``max`` (included). :param min: must be an integer >= 0 :param max: must be an integer > min rzmin must be non-negativeNzmust be: min < max.)rr)r rr~rrrr)r1rrrs r)r~zAcceptBetween.__init__s~ #(6777 ? cCi!6 7 7 7 ,,|C/@/@@csSSS!!r+r$r%c(d|jd|jdS)Nrz required, at most r)rrr6s r)r7zAcceptBetween.helps094.99-999 9r+) rorprqrr~rGrtrLr7rrs@r)rrso "C "c " " " " " "9 9#99999999r+rz all forbiddenz1the following parameters should not be provided: rTzprovide all or nonez[the following parameters should be provided together (or none of them should be provided): zmutually exclusivez1the following parameters are mutually exclusive: );rvtypingrrrrrrr r rG cloup._utilr r r rrrrrcommonrrrrrr exceptionsrrrrrrtrLrxryABCr"r rirerrRABCMetarrrrrr require_allrVr accept_none all_or_nonemutually_exclusive require_any require_oner5r+r)rs  DCCCCCCC!!!!!!!! WT$$$%-6;< -.34B'B'B'B'B'B'B'B'J22222z372224 - - - - -( - - -,,,,,,,,*MMMMM{MMM&?9?9?9?9?9 ?9?9?9D..... ck....D*.44444Z444B44444:444<00000&000899999%999(kmm *l1oo''  #   # #( Z[(33  #   # #4 A!\!__..  #   # #/ 9nQ &nQ &&r+