U b^>@svdZddlmZmZmZddlZddlZddlmZddl m Z m Z ddl m Z mZmZmZddlmZz ejZWn"ek reed ZYnXd d d d dddddddddddddgZddZddZedd Zedddd Gd!d"d"eZd#dZedddd$Gd%d&d&eZdCd'dZedddd Gd(d)d)eZ d*dZ!edddd Gd+d,d,eZ"d-dZ#edddd Gd.d/d/eZ$d0dZ%edddd Gd1d2d2eZ&d3dZ'edddd Gd4d5d5eZ(dDd6d Z)edddd Gd7d8d8eZ*dEd9d Z+edddd$Gd:d;d;eZ,ddZ/d?dZ0edddd$Gd@dAdAeZ1dBdZ2dS)Fz Commonly useful validators. )absolute_importdivisionprint_functionN)contextmanager)get_run_validatorsset_run_validators) _AndValidatorand_attribattrs)NotCallableErrorr deep_iterable deep_mappingdisabledge get_disabledgtin_ instance_of is_callablelelt matches_remax_lenoptionalprovides 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 3/tmp/pip-unpacked-wheel-9rkxrohn/attr/validators.pyr.scCst 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@s ccs"tdz dVW5tdXdS)z Context manager that disables running validators within its context. .. warning:: This context manager is not thread-safe! .. versionadded:: 21.3.0 FTNrr r r r!rLs  FT)reprslotshashc@s"eZdZeZddZddZdS)_InstanceOfValidatorcCs4t||js0tdj|j|j|j|d||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( TypeErrorformatr' __class__selfinstattrr*r r r!__call__bs z_InstanceOfValidator.__call__cCsdj|jdS)Nz)r()r-r(r0r r r!__repr__tsz_InstanceOfValidator.__repr__N)__name__ __module__ __qualname__r r(r3r6r r r r!r%^sr%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). :param type: The type to check for. :type type: type or tuple of types :raises TypeError: With a human readable error message, the attribute (of type `attrs.Attribute`), the expected type, and the value it got. )r%r4r r r!rzs )r"frozenr#c@s(eZdZeZeZddZddZdS)_MatchesReValidatorcCs0||s,tdj|j|jj|d||j|dS)r&z9'{name}' must match regex {pattern!r} ({value!r} doesn't))r'patternr*N) match_func ValueErrorr-r'r<r/r r r!r3s z_MatchesReValidator.__call__cCsdj|jdS)Nz.)r<)r-r<r5r r r!r6sz_MatchesReValidator.__repr__N)r7r8r9r r<r=r3r6r r r r!r;sr;c Csttdd}|dtjtjf}||krJtddtddt|Dt |t rf|r`t d|}n t ||}|tjkr|j}n:|tjkr|j}n(|r|j }nt d|j|j}|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 (options are `re.fullmatch`, `re.search`, `re.match`, default is ``None`` which means either `re.fullmatch` or an emulation of it on Python 2). For performance reasons, they won't be used directly but on a pre-`re.compile`\ ed pattern. .. versionadded:: 19.2.0 .. versionchanged:: 21.3.0 *regex* can be a pre-compiled pattern. fullmatchNz'func' must be one of {}.z, css|]}|r|jpdVqdS)NoneN)r7).0er r r! szmatches_re..zR'flags' can only be used with a string pattern; pass flags to re.compile() insteadz(?:{})\Z)getattrresearchmatchr>r-joinsortedsetr+Patternr,compiler?r<flagsr;)regexrMfuncr?Z valid_funcsr<r=r r r!rs>      c@s"eZdZeZddZddZdS)_ProvidesValidatorcCs0|j|s,tdj|j|j|d||j|dS)r&z<'{name}' must provide {interface!r} which {value!r} doesn't.)r' interfacer*N)rQZ providedByr,r-r'r/r r r!r3s z_ProvidesValidator.__call__cCsdj|jdS)Nz0rQ)r-rQr5r r r!r6sz_ProvidesValidator.__repr__N)r7r8r9r rQr3r6r r r r!rPsrPcCst|S)a) 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. )rPrRr r r!rsc@s"eZdZeZddZddZdS)_OptionalValidatorcCs|dkr dS||||dS)N validatorr/r r r!r3 sz_OptionalValidator.__call__cCsdjt|jdS)Nz')what)r-r"rUr5r r r!r6sz_OptionalValidator.__repr__N)r7r8r9r rUr3r6r r r r!rSsrScCst|trtt|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 validator: A validator (or a list of validators) that is used for non-``None`` values. :type validator: callable or `list` of callables. .. versionadded:: 15.1.0 .. versionchanged:: 17.1.0 *validator* can be a list of validators. )r+listrSr rTr r r!rs  c@s"eZdZeZddZddZdS) _InValidatorcCsHz||jk}Wntk r&d}YnX|sDtdj|j|j|ddS)NFz/'{name}' must be in {options!r} (got {value!r}))r'optionsr*)rYr,r>r-r')r0r1r2r*Z in_optionsr r r!r3+s z_InValidator.__call__cCsdj|jdS)Nz(rY)r-rYr5r r r!r68sz_InValidator.__repr__N)r7r8r9r rYr3r6r r r r!rX's rXcCst|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``. :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 )rXrZr r r!r>sc@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'r*r))msgr*N)callabler r-r'r.)r0r1r2r*messager r r!r3Rsz_IsCallableValidator.__call__cCsdS)Nzr r5r r r!r6bsz_IsCallableValidator.__repr__N)r7r8r9r3r6r r r r!r[Psr[cCstS)ax A validator that raises a `attr.exceptions.NotCallableError` if the initializer is called with a value for this particular attribute that is not callable. .. versionadded:: 19.1.0 :raises `attr.exceptions.NotCallableError`: With a human readable error message containing the attribute (`attrs.Attribute`) name, and the value it got. )r[r r r r!rfs c@s:eZdZeedZedeedZddZddZ dS) _DeepIterablerTNdefaultrUcCs4|jdk r|||||D]}||||qdSr&N)iterable_validatormember_validator)r0r1r2r*memberr r r!r3|s z_DeepIterable.__call__cCs,|jdkrdn dj|jd}dj||jdS)Nrz {iterable!r})iterablezJ)iterable_identifierre)rcr-rd)r0rgr r r!r6s z_DeepIterable.__repr__) r7r8r9r rrdrrcr3r6r r r r!r_us  r_cCs t||S)a1 A validator that performs deep validation of an iterable. :param member_validator: Validator 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_)rdrcr r r!rs c@sFeZdZeedZeedZedeedZddZ ddZ dS) _DeepMappingrTNr`cCsF|jdk r|||||D]$}|||||||||qdSrb)mapping_validator key_validatorvalue_validator)r0r1r2r*keyr r r!r3s  z_DeepMapping.__call__cCsdj|j|jdS)NzA)rlr*)r-rjrkr5r r r!r6s z_DeepMapping.__repr__) r7r8r9r rrjrkrrir3r6r r r r!rhs    rhcCs 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 )rh)rjrkrir r r!rs c@s.eZdZeZeZeZddZddZdS)_NumberValidatorcCs.|||js*tdj|j|j|j|ddS)r&z&'{name}' must be {op} {bound}: {value})r'opboundr*N) compare_funcror>r-r' compare_opr/r r r!r3sz_NumberValidator.__call__cCsdj|j|jdS)Nz)rnro)r-rqror5r r r!r6sz_NumberValidator.__repr__N) r7r8r9r rorqrpr3r6r r r r!rms rmcCst|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 <)rmoperatorrvalr r r!rs cCst|dtjS)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<=)rmrsrrtr r r!rs cCst|dtjS)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>=)rmrsrrtr r r!rs cCst|dtjS)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 >)rmrsrrtr r r!r s c@s"eZdZeZddZddZdS)_MaxLengthValidatorcCs.t||jkr*tdj|j|jt|ddS)r&z*Length of '{name}' must be <= {max}: {len})r'maxlenN)ry max_lengthr>r-r'r/r r r!r3sz_MaxLengthValidator.__call__cCsdj|jdS)Nz)rx)r-rzr5r r r!r6$sz_MaxLengthValidator.__repr__N)r7r8r9r rzr3r6r r r r!rws rwcCst|S)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 )rw)lengthr r r!r(s )rN)N)N)3__doc__ __future__rrrrsrE contextlibr_configrr_maker r r r exceptionsr rKAttributeErrorr(rL__all__rrrobjectr%rr;rrPrrSrrXrr[rr_rrhrrmrrrrrwrr r r r!s        7