B hbA@stdZddlZddlZddlmZddlmZmZddlm Z m Z m Z m Z ddl mZy ejZWn"ek reedZYnXd d d d d dddddddddddddgZddZddZedd Ze dddd Gd!d"d"Zd#dZe dddd$Gd%d&d&ZdFd'dZe dddd Gd(d)d)Zd*dZe dddd Gd+d,d,Zd-dZe dddd Gd.d/d/Zd0dZ e dddd Gd1d2d2Z!d3dZ"e dddd Gd4d5d5Z#dGd6d Z$e dddd Gd7d8d8Z%dHd9d Z&e dddd$Gd:d;d;Z'dd Z*d?dZ+e dddd$Gd@dAdAZ,dBdZ-e dddd$GdCdDdDZ.dEdZ/dS)Iz Commonly useful validators. N)contextmanager)get_run_validatorsset_run_validators) _AndValidatorand_attribattrs)NotCallableErrorr deep_iterable deep_mappingdisabledge get_disabledgtin_ instance_of is_callablelelt matches_remax_lenmin_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 N)r)rr.lib/python3.7/site-packages/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 )rrrrrr@s ccs"tdz dVWdtdXdS)z Context manager that disables running validators within its context. .. warning:: This context manager is not thread-safe! .. versionadded:: 21.3.0 FNT)rrrrrrLs  FT)reprslotshashc@s"eZdZeZddZddZdS)_InstanceOfValidatorcCs4t||js0tdj|j|j|j|d||j|dS)zP 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&rrr__call__bs z_InstanceOfValidator.__call__cCsdj|jdS)Nz))r$)r)r$)r+rrr__repr__tsz_InstanceOfValidator.__repr__N)__name__ __module__ __qualname__rr$r.r/rrrrr"^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")r$rrrrzs )rfrozenr c@s(eZdZeZeZddZddZdS)_MatchesReValidatorcCs0||s,tdj|j|jj|d||j|dS)zP We use a callable class to be able to change the ``__repr__``. z9'{name}' must match regex {pattern!r} ({value!r} doesn't))r#patternr&N) match_func ValueErrorr)r#r5)r+r,r-r&rrrr.s z_MatchesReValidator.__call__cCsdj|jdS)Nz.)r5)r)r5)r+rrrr/sz_MatchesReValidator.__repr__N)r0r1r2rr5r6r.r/rrrrr4sr4c Cstjdtjtjf}||kr@tddtddt|Dt |t r\|rVt d|}n t ||}|tjkrz|j}n|tjkr|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|jpdVqdS)NoneN)r0).0errr szmatches_re..zR'flags' can only be used with a string pattern; pass flags to re.compile() instead)re fullmatchsearchmatchr7r)joinsortedsetr'Patternr(compiler4)ZregexflagsfuncZ valid_funcsr5r6rrrrs&    c@s"eZdZeZddZddZdS)_ProvidesValidatorcCs0|j|s,tdj|j|j|d||j|dS)zP We use a callable class to be able to change the ``__repr__``. z<'{name}' must provide {interface!r} which {value!r} doesn't.)r# interfacer&N)rHZ providedByr(r)r#)r+r,r-r&rrrr.s z_ProvidesValidator.__call__cCsdj|jdS)Nz0)rH)r)rH)r+rrrr/sz_ProvidesValidator.__repr__N)r0r1r2rrHr.r/rrrrrGsrGcCst|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. )rG)rHrrrrsc@s"eZdZeZddZddZdS)_OptionalValidatorcCs|dkr dS||||dS)N) validator)r+r,r-r&rrrr.sz_OptionalValidator.__call__cCsdjt|jdS)Nz')Zwhat)r)rrJ)r+rrrr/sz_OptionalValidator.__repr__N)r0r1r2rrJr.r/rrrrrIsrIcCst|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'listrIr)rJrrrrs  c@s"eZdZeZddZddZdS) _InValidatorcCsPy||jk}Wntk r&d}YnX|sLtdj|j|j|d||j|dS)NFz/'{name}' must be in {options!r} (got {value!r}))r#optionsr&)rMr(r7r)r#)r+r,r-r&Z in_optionsrrrr.$s z_InValidator.__call__cCsdj|jdS)Nz()rM)r)rM)r+rrrr/4sz_InValidator.__repr__N)r0r1r2rrMr.r/rrrrrL srLcCst|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 .. 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. )rL)rMrrrr:sc@seZdZddZddZdS)_IsCallableValidatorcCs,t|s(d}t|j|j||jd|ddS)zP We use a callable class to be able to change the ``__repr__``. z?'{name}' must be callable (got {value!r} that is a {actual!r}).)r#r&r%)msgr&N)callabler r)r#r*)r+r,r-r&messagerrrr.Rs z_IsCallableValidator.__call__cCsdS)Nzr)r+rrrr/bsz_IsCallableValidator.__repr__N)r0r1r2r.r/rrrrrNPsrNcCstS)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. )rNrrrrrfs c@s:eZdZeedZedeedZddZddZ dS) _DeepIterable)rJN)defaultrJcCs8|jdk r||||x|D]}||||qWdS)zP We use a callable class to be able to change the ``__repr__``. N)iterable_validatormember_validator)r+r,r-r&memberrrrr.|s  z_DeepIterable.__call__cCs,|jdkrdn dj|jd}dj||jdS)Nr z {iterable!r})iterablezJ)iterable_identifierrV)rTr)rU)r+rXrrrr/s z_DeepIterable.__repr__) r0r1r2rrrUrrTr.r/rrrrrRus   rRcCs t|ttfrt|}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'rKtuplerrR)rUrTrrrr s c@sFeZdZeedZeedZedeedZddZ ddZ dS) _DeepMapping)rJN)rSrJcCsJ|jdk r||||x,|D]$}|||||||||qWdS)zP We use a callable class to be able to change the ``__repr__``. N)mapping_validator key_validatorvalue_validator)r+r,r-r&keyrrrr.s   z_DeepMapping.__call__cCsdj|j|jdS)NzA)r^r&)r)r\r])r+rrrr/sz_DeepMapping.__repr__) r0r1r2rrr\r]rr[r.r/rrrrrZs    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[rrrr s c@s.eZdZeZeZeZddZddZdS)_NumberValidatorcCs.|||js*tdj|j|j|j|ddS)zP We use a callable class to be able to change the ``__repr__``. z&'{name}' must be {op} {bound}: {value})r#opboundr&N) compare_funcrar7r)r# compare_op)r+r,r-r&rrrr.sz_NumberValidator.__call__cCsdj|j|jdS)Nz)r`ra)r)rcra)r+rrrr/sz_NumberValidator.__repr__N) r0r1r2rrarcrbr.r/rrrrr_s r_cCst|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 <)r_operatorr)valrrrrs 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<=)r_rer)rfrrrrs 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>=)r_rer)rfrrrrs 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 >)r_rer)rfrrrr s c@s"eZdZeZddZddZdS)_MaxLengthValidatorcCs.t||jkr*tdj|j|jt|ddS)zP We use a callable class to be able to change the ``__repr__``. z*Length of '{name}' must be <= {max}: {len})r#maxlenN)rj max_lengthr7r)r#)r+r,r-r&rrrr.sz_MaxLengthValidator.__call__cCsdj|jdS)Nz)ri)r)rk)r+rrrr/&sz_MaxLengthValidator.__repr__N)r0r1r2rrkr.r/rrrrrhs rhcCst|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 )rh)lengthrrrr*s c@s"eZdZeZddZddZdS)_MinLengthValidatorcCs.t||jkr*tdj|j|jt|ddS)zP We use a callable class to be able to change the ``__repr__``. z*Length of '{name}' must be => {min}: {len})r#minrjN)rj min_lengthr7r)r#)r+r,r-r&rrrr.:sz_MinLengthValidator.__call__cCsdj|jdS)Nz)rn)r)ro)r+rrrr/Esz_MinLengthValidator.__repr__N)r0r1r2rror.r/rrrrrm6s rmcCst|S)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 )rm)rlrrrrIs )rN)N)N)0__doc__rer< contextlibrZ_configrr_makerrrr exceptionsr rCAttributeErrorr$rD__all__rrrr"rr4rrGrrIrrLrrNrrRr rZr r_rrrrrhrrmrrrrrsp     0