o yAfL@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 d+d,Z!e ddddGd-d.d.Z"dQd/d0Z#e ddddGd1d2d2Z$dQd3d4Z%e ddddGd5d6d6Z&d7d8Z'd9d:Z(d;d<Z)d=d>Z*e ddddGd?d@d@Z+dAdBZ,e ddddGdCdDdDZ-dEdFZ.e ddddGdGdHdHZ/dIdJZ0e ddddGdKdLdLZ1de2e3fdMdNdOZ4dS)Rz Commonly useful validators. N)contextmanager)Pattern)get_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_optionalprovides set_disabledcCst| dS)a Globally disable or enable running validators. By default, they are run. :param disabled: If ``True``, disable running all validators. :type disabled: bool .. warning:: This function is not thread-safe! .. versionadded:: 21.3.0 Nr)rr 4/usr/lib/python3.10/site-packages/attr/validators.pyr+srcCst S)z Return a bool indicating whether validators are currently disabled or not. :return: ``True`` if validators are currently disabled. :rtype: bool .. versionadded:: 21.3.0 )rr r r r!r= rccs*tdz dVWtddStdw)z Context manager that disables running validators within its context. .. warning:: This context manager is not thread-safe! .. versionadded:: 21.3.0 FNTrr r r r!rIs  rFT)reprslotshashc@"eZdZeZddZddZdS)_InstanceOfValidatorcCs8t||jsdj|j|j|j|d}t|||j|dS)P We use a callable class to be able to change the ``__repr__``. z?'{name}' must be {type!r} (got {value!r} that is a {actual!r}).)nametypeactualvalueN) isinstancer*formatr) __class__ TypeErrorselfinstattrr,msgr r r!__call___s z_InstanceOfValidator.__call__cCd|jdS)Nz r*r2r r r!__repr__qz_InstanceOfValidator.__repr__N__name__ __module__ __qualname__r r*r6r;r r r r!r'[s r'cCt|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). :param type: The type to check for. :type type: type or tuple of type :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!ru r)r#frozenr$c@s(eZdZeZeZddZddZdS)_MatchesReValidatorcCs4||sdj|j|jj|d}t|||j|dS)r(z9'{name}' must match regex {pattern!r} ({value!r} doesn't))r)patternr,N) match_funcr.r)rE ValueErrorr1r r r!r6s  z_MatchesReValidator.__call__cCr7)Nz"r?r@r rErFr6r;r r r r!rDs  rDcCstjdtjtjf}||vr"ddtddt|D}t|t |t r2|r/d}t ||}nt ||}|tjurA|j}n |tjurJ|j}n|j}t ||S)a A validator that raises `ValueError` if the initializer is called with a string that doesn't match *regex*. :param regex: a regex string or precompiled pattern to match against :param int flags: flags that will be passed to the underlying re function (default 0) :param callable func: 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 |jp dVqdS)NoneN)r>).0er r r! szmatches_re..zR'flags' can only be used with a string pattern; pass flags to re.compile() instead)re fullmatchsearchmatchr.joinsortedsetrGr-rr0compilerD)regexflagsfuncZ valid_funcsr5rErFr r r!rs(     rc@r&)_ProvidesValidatorcCs4|j|sdj|j|j|d}t|||j|dS)r(z<'{name}' must provide {interface!r} which {value!r} doesn't.)r) interfacer,N)rXZ providedByr.r)r0r1r r r!r6s  z_ProvidesValidator.__call__cCr7)Nz"r?r@r rXr6r;r r r r!rW rWcCs ddl}|jdtddt|S)aE A validator that raises a `TypeError` if the initializer is called with an object that does not provide the requested *interface* (checks are performed using ``interface.providedBy(value)`` (see `zope.interface `_). :param interface: The interface to check for. :type interface: ``zope.interface.Interface`` :raises TypeError: With a human readable error message, the attribute (of type `attrs.Attribute`), the expected interface, and the value it got. .. deprecated:: 23.1.0 rNzZattrs's zope-interface support is deprecated and will be removed in, or after, April 2024.) stacklevel)warningswarnDeprecationWarningrW)rXr\r r r!rsrc@r&)_OptionalValidatorcCs|durdS||||dSN validatorr2r3r4r,r r r!r6sz_OptionalValidator.__call__cCr7)Nzrar:r r r!r;r<z_OptionalValidator.__repr__N)r>r?r@r rbr6r;r r r r!r_s r_cCs"t|ttfr tt|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. :param Callable | tuple[Callable] | list[Callable] validator: 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-listtupler_rrar r r!rs rc@r&) _InValidatorcCsZz||jv}Wn tyd}Ynw|s+d|jd|jd|d}t|||j|dS)NF'z ' must be in  (got ))optionsr0r)rG)r2r3r4r,Z in_optionsr5r r r!r6s z_InValidator.__call__cCr7)Nzr?r@r rjr6r;r r r r!rfrYrfcCrA)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``. :param options: Allowed options. :type options: list, tuple, `enum.Enum`, ... :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. )rfrkr r r!r2src@seZdZddZddZdS)_IsCallableValidatorcCs,t|sd}t|j|j||jd|ddS)r(z?'{name}' must be callable (got {value!r} that is a {actual!r}).)r)r,r+)r5r,N)callabler r.r)r/)r2r3r4r,messager r r!r6Js z_IsCallableValidator.__call__cCsdS)Nzr r:r r r!r;Zsz_IsCallableValidator.__repr__N)r>r?r@r6r;r r r r!rlHs rlcCstS)ax 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. )rlr r r r!r^s rc@s:eZdZeedZedeedZddZddZ dS) _DeepIterableraNdefaultrbcCs4|jdur |||||D] }||||qdSr(Niterable_validatormember_validator)r2r3r4r,memberr r r!r6ts z_DeepIterable.__call__cCs.|jdurdnd|j}d|d|jdS)N zr?r@r rrurrtr6r;r r r r!roms   rocCs t|ttfr t|}t||S)a4 A validator that performs deep validation of an iterable. :param member_validator: Validator(s) to apply to iterable members :param iterable_validator: Validator to apply to iterable itself (optional) .. versionadded:: 19.1.0 :raises TypeError: if any sub-validators fail )r-rdrerrorurtr r r!r s  r c@sFeZdZeedZeedZedeedZddZ ddZ dS) _DeepMappingraNrpcCsF|jdur |||||D]}|||||||||qdSrr)mapping_validator key_validatorvalue_validator)r2r3r4r,keyr r r!r6s z_DeepMapping.__call__cCdj|j|jdS)NzA)r~r,)r.r|r}r:r r r!r;s z_DeepMapping.__repr__) r>r?r@r rr|r}rr{r6r;r r r r!rzs    rzcCs t|||S)a} A validator that performs deep validation of a dictionary. :param key_validator: Validator to apply to dictionary keys :param value_validator: Validator to apply to dictionary values :param mapping_validator: Validator to apply to top-level mapping attribute (optional) .. versionadded:: 19.1.0 :raises TypeError: if any sub-validators fail )rz)r|r}r{r r r!rs rc@s.eZdZeZeZeZddZddZdS)_NumberValidatorcCs<|||jsd|jd|jd|jd|}t|dS)r(rgz ' must be rx: N) compare_funcboundr) compare_oprGr1r r r!r6s"z_NumberValidator.__call__cCsd|jd|jdS)Nzr?r@r rrrr6r;r r r r!rs  rcCt|dtjS)z A validator that raises `ValueError` if the initializer is called with a number larger or equal to *val*. :param val: Exclusive upper bound for values .. versionadded:: 21.3.0 <)roperatorrvalr r r!r rcCr)z A validator that raises `ValueError` if the initializer is called with a number greater than *val*. :param val: Inclusive upper bound for values .. versionadded:: 21.3.0 z<=)rrrrr r r!rrrcCr)z A validator that raises `ValueError` if the initializer is called with a number smaller than *val*. :param val: Inclusive lower bound for values .. versionadded:: 21.3.0 z>=)rrrrr r r!rrrcCr)z A validator that raises `ValueError` if the initializer is called with a number smaller or equal to *val*. :param val: Exclusive lower bound for values .. versionadded:: 21.3.0 r8)rrrrr r r!rrrc@r&)_MaxLengthValidatorcCs8t||jkrd|jd|jdt|}t|dS)r( Length of 'z ' must be <= rN)len max_lengthr)rGr1r r r!r6z_MaxLengthValidator.__call__cCd|jdS)Nzr?r@r rr6r;r r r r!r rcCrA)z A validator that raises `ValueError` if the initializer is called with a string or iterable that is longer than *length*. :param int length: Maximum length of the string or iterable .. versionadded:: 21.3.0 )rlengthr r r!rr"rc@r&)_MinLengthValidatorcCs8t||jkrd|jd|jdt|}t|dS)r(rz ' must be >= rN)r min_lengthr)rGr1r r r!r6$rz_MinLengthValidator.__call__cCr)Nzr?r@r rr6r;r r r r!r rrcCrA)z A validator that raises `ValueError` if the initializer is called with a string or iterable that is shorter than *length*. :param int length: Minimum length of the string or iterable .. versionadded:: 22.1.0 )rrr r r!r0r"rc@r&)_SubclassOfValidatorcCs<t||jsd|jd|jd|d}t|||j|dS)r(rgz' must be a subclass of rhz).N) issubclassr*r)r0r1r r r!r6@s z_SubclassOfValidator.__call__cCr7)Nz )whatr)r.rbrr:r r r!r;s z_NotValidator.__repr__N)r>r?r@r rbr r5r r Exceptionrrerr6r;r r r r!ras r)r5rcCs2zt|}Wn ty|f}Ynwt|||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_(...))``. :param validator: A validator to be logically inverted. :param msg: Message to raise if validator fails. Formatted with keys ``exc_types`` and ``validator``. :type msg: str :param exc_types: 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 )rer0r)rbr5rr r r!rs     r)rNr`)5__doc__rrL contextlibrr_configrr_makerrr r convertersr exceptionsr __all__rrrr'rrDrrWrr_rrfrrlrror rzrrrrrrrrrrrrrrGr0rr r r r!sp         +              )