a &j1T@sdZddlZddlZddlmZddlmZddlmZmZddl m Z m Z m Z m Z ddlmZdd lmZgd Zd d Zd dZeddZe ddddGdddZddZe ddddGdddZdPddZe ddddGdddZdd Ze ddddGd!d"d"Zd#d$Ze ddddGd%d&d&Zd'd(Ze ddddGd)d*d*Z dQd+d,Z!e ddddGd-d.d.Z"dRd/d0Z#e ddddGd1d2d2Z$d3d4Z%d5d6Z&d7d8Z'd9d:Z(e ddddGd;d<d<Z)d=d>Z*e ddddGd?d@d@Z+dAdBZ,e ddddGdCdDdDZ-dEdFZ.e ddddGdGdHdHZ/de0e1fdIdJdKZ2e ddddGdLdMdMZ3dNdOZ4dS)Sz Commonly useful validators. N)contextmanager)Patternget_run_validatorsset_run_validators) _AndValidatorand_attribattrs)default_if_none)NotCallableError)r deep_iterable deep_mappingdisabledge get_disabledgtin_ instance_of is_callablelelt matches_remax_lenmin_lennot_optionalor_ set_disabledcCst| dS)a Globally disable or enable running validators. By default, they are run. Args: disabled (bool): If `True`, disable running all validators. .. warning:: This function is not thread-safe! .. versionadded:: 21.3.0 N)r)rr 5E:\soccer\ml_env\Lib\site-packages\attr/validators.pyr*srcCst S)z Return a bool indicating whether validators are currently disabled or not. Returns: bool:`True` if validators are currently disabled. .. versionadded:: 21.3.0 )rr r r r!r<s rccs0t}tdzdVWt|n t|0dS)z Context manager that disables running validators within its context. .. warning:: This context manager is not thread-safe! .. versionadded:: 21.3.0 .. versionchanged:: 26.1.0 The contextmanager is nestable. FNr)prevr r r!rHs rFT)reprslots unsafe_hashc@s"eZdZeZddZddZdS)_InstanceOfValidatorc CsDt||js@d|jd|jd|d|jd }t|||j|dS)P We use a callable class to be able to change the ``__repr__``. ' ' must be  (got z that is a ).N) isinstancetypename __class__ TypeErrorselfinstattrvaluemsgr r r!__call__`s $z_InstanceOfValidator.__call__cCsd|jdS)Nz r-r2r r r!__repr__msz_InstanceOfValidator.__repr__N__name__ __module__ __qualname__r r-r7r;r r r r!r&\s r&cCst|S)a A validator that raises a `TypeError` if the initializer is called with a wrong type for this particular attribute (checks are performed using `isinstance` therefore it's also valid to pass a tuple of types). Args: type (type | tuple[type]): The type to check for. Raises: TypeError: With a human readable error message, the attribute (of type `attrs.Attribute`), the expected type, and the value it got. )r&r9r r r!rqsr)r#frozenr$c@s(eZdZeZeZddZddZdS)_MatchesReValidatorcCs<||s8d|jd|jjd|d}t|||j|dS)r'r(z' must match regex z (z doesn't)N) match_funcr.pattern ValueErrorr1r r r!r7s z_MatchesReValidator.__call__cCsd|jdS)Nz"r?r rCrBr7r;r r r r!rAs rAcCstjdtjtjf}||vrDddtddt|D}t|t |t rd|r^d}t ||}n t ||}|tjur|j}n|tjur|j}n|j}t ||S)a A validator that raises `ValueError` if the initializer is called with a string that doesn't match *regex*. Args: regex (str, re.Pattern): A regex string or precompiled pattern to match against flags (int): Flags that will be passed to the underlying re function (default 0) func (typing.Callable): Which underlying `re` function to call. Valid options are `re.fullmatch`, `re.search`, and `re.match`; the default `None` means `re.fullmatch`. For performance reasons, the pattern is always precompiled using `re.compile`. .. versionadded:: 19.2.0 .. versionchanged:: 21.3.0 *regex* can be a pre-compiled pattern. Nz'func' must be one of {}.z, css|]}|r|jpdVqdS)NoneN)r=).0er r r! zmatches_re..zR'flags' can only be used with a string pattern; pass flags to re.compile() instead)re fullmatchsearchmatchformatjoinsortedsetrDr,rr0compilerA)regexflagsfuncZ valid_funcsr6rCrBr r r!rs(    rc@s"eZdZeZddZddZdS)_OptionalValidatorcCs|dur dS||||dS)N validatorr2r3r4r5r r r!r7sz_OptionalValidator.__call__cCsd|jdS)NzrWr:r r r!r;sz_OptionalValidator.__repr__N)r=r>r?r rXr7r;r r r r!rVsrVcCs"t|ttfrtt|St|S)a& A validator that makes an attribute optional. An optional attribute is one which can be set to `None` in addition to satisfying the requirements of the sub-validator. Args: validator (typing.Callable | tuple[typing.Callable] | list[typing.Callable]): A validator (or validators) that is used for non-`None` values. .. versionadded:: 15.1.0 .. versionchanged:: 17.1.0 *validator* can be a list of validators. .. versionchanged:: 23.1.0 *validator* can also be a tuple of validators. )r,listtuplerVrrWr r r!rs rc@s,eZdZeZeddZddZddZdS) _InValidatorF)hashcCsZz||jv}Wnty$d}Yn0|sVd|jd|jd|d}t|||j|dS)NFr(z ' must be in r*))optionsr0r._original_optionsrD)r2r3r4r5Z in_optionsr6r r r!r7s  z_InValidator.__call__cCsd|jdS)Nzr?r r_r`r7r;r r r r!r\s r\cCs&|}t|tttfrt|}t||S)a A validator that raises a `ValueError` if the initializer is called with a value that does not belong in the *options* provided. The check is performed using ``value in options``, so *options* has to support that operation. To keep the validator hashable, dicts, lists, and sets are transparently transformed into a `tuple`. Args: options: Allowed options. Raises: ValueError: With a human readable error message, the attribute (of type `attrs.Attribute`), the expected options, and the value it got. .. versionadded:: 17.1.0 .. versionchanged:: 22.1.0 The ValueError was incomplete until now and only contained the human readable error message. Now it contains all the information that has been promised since 17.1.0. .. versionchanged:: 24.1.0 *options* that are a list, dict, or a set are now transformed into a tuple to keep the validator hashable. )r,rZdictrQr[r\)r_Z repr_optionsr r r!rsrc@seZdZddZddZdS)_IsCallableValidatorcCs,t|s(d}t|j|j||jd|ddS)r'z?'{name}' must be callable (got {value!r} that is a {actual!r}).)r.r5actual)r6r5N)callabler rNr.r/)r2r3r4r5messager r r!r7(s z_IsCallableValidator.__call__cCsdS)Nzr r:r r r!r;8sz_IsCallableValidator.__repr__N)r=r>r?r7r;r r r r!rb&srbcCstS)a A validator that raises a `attrs.exceptions.NotCallableError` if the initializer is called with a value for this particular attribute that is not callable. .. versionadded:: 19.1.0 Raises: attrs.exceptions.NotCallableError: With a human readable error message containing the attribute (`attrs.Attribute`) name, and the value it got. )rbr r r r!r<s rc@s:eZdZeedZedeedZddZddZ dS) _DeepIterablerWN)defaultrXcCs4|jdur|||||D]}||||qdSr'Niterable_validatormember_validator)r2r3r4r5memberr r r!r7Ss z_DeepIterable.__call__cCs.|jdurdn d|j}d|d|jdS)N zr?r rrkrrjr7r;r r r r!rfLs    rfcCs6t|ttfrt|}t|ttfr,t|}t||S)a A validator that performs deep validation of an iterable. Args: member_validator: Validator(s) to apply to iterable members. iterable_validator: Validator(s) to apply to iterable itself (optional). Raises TypeError: if any sub-validators fail .. versionadded:: 19.1.0 .. versionchanged:: 25.4.0 *member_validator* and *iterable_validator* can now be a list or tuple of validators. )r,rZr[r rfrkrjr r r!ris rc@sLeZdZeeedZeeedZeeedZddZ ddZ dS) _DeepMappingrWcCsZ|jdur|||||D]8}|jdur8|||||jdur|||||qdSrh)mapping_validator key_validatorvalue_validator)r2r3r4r5keyr r r!r7s   z_DeepMapping.__call__cCsd|jd|jdS)Nz,r?r rrrrrsrqr7r;r r r r!rps  rpcCsj|dur|durd}t|t|ttfr2t|}t|ttfrHt|}t|ttfr^t|}t|||S)a A validator that performs deep validation of a dictionary. All validators are optional, but at least one of *key_validator* or *value_validator* must be provided. Args: key_validator: Validator(s) to apply to dictionary keys. value_validator: Validator(s) to apply to dictionary values. mapping_validator: Validator(s) to apply to top-level mapping attribute. .. versionadded:: 19.1.0 .. versionchanged:: 25.4.0 *key_validator* and *value_validator* are now optional, but at least one of them must be provided. .. versionchanged:: 25.4.0 *key_validator*, *value_validator*, and *mapping_validator* can now be a list or tuple of validators. Raises: TypeError: If any sub-validator fails on validation. ValueError: If neither *key_validator* nor *value_validator* is provided on instantiation. NzAAt least one of key_validator or value_validator must be provided)rDr,rZr[r rp)rrrsrqr6r r r!rs"rc@s.eZdZeZeZeZddZddZdS)_NumberValidatorcCs<|||js8d|jd|jd|jd|}t|dS)r'r(r)rn: N) compare_funcboundr. compare_oprDr1r r r!r7s"z_NumberValidator.__call__cCsd|jd|jdS)Nzr?r rxryrwr7r;r r r r!rus rucCst|dtjS)a  A validator that raises `ValueError` if the initializer is called with a number larger or equal to *val*. The validator uses `operator.lt` to compare the values. Args: val: Exclusive upper bound for values. .. versionadded:: 21.3.0 <)ruoperatorrvalr r r!rs rcCst|dtjS)a A validator that raises `ValueError` if the initializer is called with a number greater than *val*. The validator uses `operator.le` to compare the values. Args: val: Inclusive upper bound for values. .. versionadded:: 21.3.0 z<=)rur{rr|r r r!rs rcCst|dtjS)a A validator that raises `ValueError` if the initializer is called with a number smaller than *val*. The validator uses `operator.ge` to compare the values. Args: val: Inclusive lower bound for values .. versionadded:: 21.3.0 z>=)rur{rr|r r r!rs rcCst|dtjS)a  A validator that raises `ValueError` if the initializer is called with a number smaller or equal to *val*. The validator uses `operator.gt` to compare the values. Args: val: Exclusive lower bound for values .. versionadded:: 21.3.0 r8)rur{rr|r r r!r s rc@s"eZdZeZddZddZdS)_MaxLengthValidatorcCs8t||jkr4d|jd|jdt|}t|dS)r' Length of 'z ' must be <= rvN)len max_lengthr.rDr1r r r!r7sz_MaxLengthValidator.__call__cCsd|jdS)Nzr?r rr7r;r r r r!r~sr~cCst|S)z A validator that raises `ValueError` if the initializer is called with a string or iterable that is longer than *length*. Args: length (int): Maximum length of the string or iterable .. versionadded:: 21.3.0 )r~lengthr r r!r*s rc@s"eZdZeZddZddZdS)_MinLengthValidatorcCs8t||jkr4d|jd|jdt|}t|dS)r'rz ' must be >= rvN)r min_lengthr.rDr1r r r!r7;sz_MinLengthValidator.__call__cCsd|jdS)Nzr?r rr7r;r r r r!r7srcCst|S)z A validator that raises `ValueError` if the initializer is called with a string or iterable that is shorter than *length*. Args: length (int): Minimum length of the string or iterable .. versionadded:: 22.1.0 )rrr r r!rGs rc@s"eZdZeZddZddZdS)_SubclassOfValidatorcCs<t||js8d|jd|jd|d}t|||j|dS)r'r(z' must be a subclass of r*r+N) issubclassr-r.r0r1r r r!r7Xs z_SubclassOfValidator.__call__cCsd|jdS)Nz r?r rXr r6rr Exceptionrr[rr7r;r r r r!rzsr)r6rcCs2z t|}Wnty$|f}Yn0t|||S)a: A validator that wraps and logically 'inverts' the validator passed to it. It will raise a `ValueError` if the provided validator *doesn't* raise a `ValueError` or `TypeError` (by default), and will suppress the exception if the provided validator *does*. Intended to be used with existing validators to compose logic without needing to create inverted variants, for example, ``not_(in_(...))``. Args: validator: A validator to be logically inverted. msg (str): Message to raise if validator fails. Formatted with keys ``exc_types`` and ``validator``. exc_types (tuple[type, ...]): Exception type(s) to capture. Other types raised by child validators will not be intercepted and pass through. Raises: ValueError: With a human readable error message, the attribute (of type `attrs.Attribute`), the validator that failed to raise an exception, the value it got, and the expected exception types. .. versionadded:: 22.2.0 )r[r0r)rXr6rr r r!rs    rc@s"eZdZeZddZddZdS) _OrValidatorc CsX|jD]2}z||||Wnty0YqYq0dSqd|jd|}t|dS)NzNone of z satisfied for value ) validatorsrrD)r2r3r4r5vr6r r r!r7s   z_OrValidator.__call__cCsd|jdS)Nzr?r rr7r;r r r r!rs rcGs6g}|D] }|t|tr |jn|gqtt|S)a A validator that composes multiple validators into one. When called on a value, it runs all wrapped validators until one of them is satisfied. Args: validators (~collections.abc.Iterable[typing.Callable]): Arbitrary number of validators. Raises: ValueError: If no validator is satisfied. Raised with a human-readable error message listing all the wrapped validators and the value that failed all of them. .. versionadded:: 24.1.0 )extendr,rrr[)rvalsrr r r!rsr)rN)N)NNN)5__doc__r{rJ contextlibrr_configrr_makerr r r convertersr exceptionsr __all__rrrr&rrArrVrr\rrbrrfrrprrurrrrr~rrrrrrrDr0rrrr r r r!sp         0   #     2     $$