U
|
L ±dÞP ã @ s´ d Z ddlZddlZddlmZ ddlmZ ddlmZmZ ddl m
|
Z
|
m Z m Z m Z ddlmZ dd lmZ d
|
d d d ddddddddddddddd gZd d Zd d Zed d Ze d d!d!d"G d#d$ d$Zd%d Ze d d!d!d&G d'd( d(ZdPd)dZe d d!d!d"G d*d+ d+Zd,d Ze d d!d!d"G d-d. d.Z d/d Z e d d!d!d"G d0d1 d1Z d2d Z e d d d!d"G d3d4 d4Z d5d Z!e d d!d!d"G d6d7 d7Z"dQd8d Z#e d d!d!d"G d9d: d:Z$dRd;d Z%e d d!d!d&G d<d= d=Z&d>d Z'd?d Z(d@d Z)dAd Z*e d d!d!d&G dBdC dCZ+dDd Z,e d d!d!d&G dEdF dFZ-dGd Z.e d d!d!d"G dHdI dIZ/dJdK Z0e d d!d!d"G dLdM dMZ1de2e3fdNdOdZ4dS )Sz
|
Commonly useful validators.
|
é N)Úcontextmanager)ÚPatterné )Úget_run_validatorsÚset_run_validators)Ú _AndValidatorÚand_ÚattribÚattrs)Údefault_if_none)ÚNotCallableErrorr Ú deep_iterableÚ deep_mappingÚdisabledÚgeÚ get_disabledÚgtÚin_Ú instance_ofÚ is_callableÚleÚltÚ
|
matches_reÚmax_lenÚmin_lenÚnot_ÚoptionalÚprovidesÚ set_disabledc C s t | 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 )r © r úFd:\z\workplace\vscode\pyvenv\venv\Lib\site-packages\attr/validators.pyr + s c C s t 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
|
)r r r r r! r = s c c s" t d z
|
dV W 5 t d X dS )z°
|
Context manager that disables running validators within its context.
|
|
.. warning::
|
|
This context manager is not thread-safe!
|
|
.. versionadded:: 21.3.0
|
FTNr r r r r! r I s
|
FT)ÚreprÚslotsÚhashc @ s" e Zd Ze Zdd Zdd ZdS )Ú_InstanceOfValidatorc C s4 t || 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}).)ÚnameÚtypeÚactualÚvalueN)Ú
|
isinstancer( Ú TypeErrorÚformatr' Ú __class__©ÚselfÚinstÚattrr* r r r! Ú__call___ s ûöz _InstanceOfValidator.__call__c C s dj | jdS )Nz)<instance_of validator for type {type!r}>©r( ©r- r( ©r0 r r r! Ú__repr__q s ÿz _InstanceOfValidator.__repr__N©Ú__name__Ú
|
__module__Ú __qualname__r r( r3 r7 r r r r! r% [ s r% c C s t | 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% r4 r r r! r w s )r" Úfrozenr# c @ s( e Zd Ze Ze Zdd Zdd ZdS )Ú_MatchesReValidatorc C s0 | |¡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! r3 s
|
þùz _MatchesReValidator.__call__c C s dj | jdS )Nz.<matches_re validator for pattern {pattern!r}>)r> )r- r> r6 r r r! r7 s ÿz _MatchesReValidator.__repr__N)r9 r: r; r r> r? r3 r7 r r r r! r= s r= c C s t jdt jt jf}||kr@td d tdd t|D ¡¡t | t
|
r\|rVt d| }n t | |¡}|t jkrz|j}n|t jkr|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, c s s | ]}|r|j pd V qdS )ÚNoneN)r9 )Ú.0Úer r r! Ú <genexpr>¶ s z matches_re.<locals>.<genexpr>zR'flags' can only be used with a string pattern; pass flags to re.compile() instead)ÚreÚ fullmatchÚsearchÚmatchr@ r- ÚjoinÚsortedÚsetr+ r r, Úcompiler= )ÚregexÚflagsÚfuncZ valid_funcsr> r? r r r! r ¡ s0 ÿÿÿÿ
|
|
ÿ
|
|
c @ s" e Zd Ze Zdd Zdd ZdS )Ú_ProvidesValidatorc C s0 | j |¡s,tdj|j| j |d|| j |dS )r& z<'{name}' must provide {interface!r} which {value!r} doesn't.)r' Ú interfacer* N)rQ Z
|
providedByr, r- r' r/ r r r! r3 Õ s þùz_ProvidesValidator.__call__c C s dj | jdS )Nz0<provides validator for interface {interface!r}>)rQ )r- rQ r6 r r r! r7 ä s ÿz_ProvidesValidator.__repr__N)r9 r: r; r rQ r3 r7 r r r r! rP Ñ s rP c C s ddl }|jdtdd t| 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
|
<https://zopeinterface.readthedocs.io/en/latest/>`_).
|
|
: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
|
r NzZattrs's zope-interface support is deprecated and will be removed in, or after, April 2024.é )Ú
|
stacklevel)ÚwarningsÚwarnÚDeprecationWarningrP )rQ rT r r r! r ê s üc @ s" e Zd Ze Zdd Zdd ZdS )Ú_OptionalValidatorc C s |d kr d S | |||¡ d S )N©Ú validatorr/ r r r! r3 s z_OptionalValidator.__call__c C s dj t| jdS )Nz'<optional validator for {what} or None>)Úwhat)r- r" rY r6 r r r! r7 s ÿz_OptionalValidator.__repr__N)r9 r: r; r rY r3 r7 r r r r! rW s rW c C s" t | ttfrtt| S t| 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+ ÚlistÚtuplerW r rX r r r! r s c @ s" e Zd Ze Zdd Zdd ZdS )Ú _InValidatorc C sP z|| j k}W n tk
|
r& d}Y nX |sLtdj|j| j |d|| j |d S )NFz/'{name}' must be in {options!r} (got {value!r}))r' Úoptionsr* )r^ r, r@ r- r' )r0 r1 r2 r* Z
|
in_optionsr r r! r3 , s
|
ÿúz_InValidator.__call__c C s dj | jdS )Nz(<in_ validator with options {options!r}>©r^ )r- r^ r6 r r r! r7 < s ÿz_InValidator.__repr__N)r9 r: r; r r^ r3 r7 r r r r! r] ( s r] c C s 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``.
|
|
: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.
|
)r] r_ r r r! r B s c @ s e Zd Zdd Zdd ZdS )Ú_IsCallableValidatorc C s, 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. )r0 r1 r2 r* Úmessager r r! r3 Z s ÿ ÿüz _IsCallableValidator.__call__c C s dS )Nz<is_callable validator>r r6 r r r! r7 j s z _IsCallableValidator.__repr__N)r9 r: r; r3 r7 r r r r! r` X s r` c C s t S )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.
|
)r` r r r r! r n s c @ s: e Zd Zee dZedee dZdd Zdd Z dS )Ú _DeepIterablerX N©ÚdefaultrY c C s4 | j dk r| |||¡ |D ]}| |||¡ q dS ©r& N)Úiterable_validatorÚmember_validator)r0 r1 r2 r* Úmemberr r r! r3 s
|
z_DeepIterable.__call__c C s* | j d krdn
|
d| j }dj|| jdS )NÚ ú zJ<deep_iterable validator for{iterable_identifier} iterables of {member!r}>)Úiterable_identifierrj )rh r- ri )r0 rm r r r! r7 s ÿ
|
ýÿûz_DeepIterable.__repr__)
|
r9 r: r; r r ri r rh r3 r7 r r r r! rd } s ÿ
|
rd c C s 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+ r[ r\ r rd ©ri rh r r r! r s c @ sF e Zd Zee dZee dZedee dZdd Z dd Z
|
dS )Ú _DeepMappingrX Nre c C sF | j dk r| |||¡ |D ]$}| |||¡ | |||| ¡ q dS rg )Úmapping_validatorÚ key_validatorÚvalue_validator)r0 r1 r2 r* Úkeyr r r! r3 ´ s
|
|
z_DeepMapping.__call__c C s dj | j| jdS )NzA<deep_mapping validator for objects mapping {key!r} to {value!r}>)rs r* )r- rq rr r6 r r r! r7 ¿ s
|
ÿ þz_DeepMapping.__repr__) r9 r: r; r r rq rr r rp r3 r7 r r r r! ro ® s
|
ro c C s 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
|
)ro )rq rr rp r r r! r Å s c @ s. e Zd Ze Ze Ze Zdd Zdd ZdS )Ú_NumberValidatorc C s. | || j¡s*tdj|j| j| j|ddS )r& z&'{name}' must be {op} {bound}: {value})r' ÚopÚboundr* N)Ú compare_funcrv r@ r- r' Ú
|
compare_opr/ r r r! r3 Û s üÿz_NumberValidator.__call__c C s dj | j| jdS )Nz <Validator for x {op} {bound}>)ru rv )r- rx rv r6 r r r! r7 é s ÿz_NumberValidator.__repr__N) r9 r: r; r rv rx rw r3 r7 r r r r! rt Õ s
|
rt c C s t | 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
|
ú<)rt Úoperatorr ©Úvalr r r! r ï s c C s t | 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<=)rt rz r r{ r r r! r û s c C s t | 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>=)rt rz r r{ r r r! r s c C s t | 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
|
ú>)rt rz r r{ r r r! r s c @ s" e Zd Ze Zdd Zdd ZdS )Ú_MaxLengthValidatorc C s. t || jkr*tdj|j| jt |ddS )r& z*Length of '{name}' must be <= {max}: {len})r' ÚmaxÚlenN)r Ú
|
max_lengthr@ r- r' r/ r r r! r3 # s ÿÿz _MaxLengthValidator.__call__c C s d| j dS )Nz<max_len validator for r} )r r6 r r r! r7 . s z _MaxLengthValidator.__repr__N)r9 r: r; r r r3 r7 r r r r! r~ s r~ c C s t | 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
|
)r~ ©Úlengthr r r! r 2 s c @ s" e Zd Ze Zdd Zdd ZdS )Ú_MinLengthValidatorc C s. t || jk r*tdj|j| jt |ddS )r& z*Length of '{name}' must be => {min}: {len})r' Úminr N)r Ú
|
min_lengthr@ r- r' r/ r r r! r3 B s ÿÿz _MinLengthValidator.__call__c C s d| j dS )Nz<min_len validator for r} )r r6 r r r! r7 M s z _MinLengthValidator.__repr__N)r9 r: r; r r r3 r7 r r r r! r > s r c C s t | 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
|
)r r r r r! r Q s c @ s" e Zd Ze Zdd Zdd ZdS )Ú_SubclassOfValidatorc C s0 t || js,tdj|j| j|d|| j|dS )r& z8'{name}' must be a subclass of {type!r} (got {value!r}).)r' r( r* N)Ú
|
issubclassr( r, r- r' r/ r r r! r3 a s ü÷z _SubclassOfValidator.__call__c C s dj | jdS )Nz)<subclass_of validator for type {type!r}>r4 r5 r6 r r r! r7 r s ÿz _SubclassOfValidator.__repr__Nr8 r r r r! r ] s r c C s t | 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
|
`issubclass` 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 r4 r r r! Ú _subclass_ofx s r c @ sJ e Zd Ze ZeeddZeeee e
|
e ddZ dd Z dd Zd S )
|
Ú _NotValidatorzCnot_ validator child '{validator!r}' did not raise a captured error)Ú converterrn rX c C sR z| |||¡ W n | jk
|
r( Y n&X t| jj| j | jd|| j || jd S )N)rY Ú exc_types)rY r r@ ra r- r/ r r r! r3 s þøz_NotValidator.__call__c C s dj | j| jdS )Nz;<not_ validator wrapping {what!r}, capturing {exc_types!r}>)rZ r )r- rY r r6 r r r! r7 © s
|
ÿüz_NotValidator.__repr__N)r9 r: r; r rY r ra r r Ú Exceptionr r\ r r3 r7 r r r r! r s ÿÿþÿr )ra r c C s4 z t |}W n tk
|
r& |f}Y nX t| ||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
|
)r\ r, r )rY ra r r r r! r ² s
|
)r N)N)N)5Ú__doc__rz rE Ú
|
contextlibr r Ú_configr r Ú_maker r r r
|
Ú
|
convertersr Ú
|
exceptionsr Ú__all__r r r r% r r= r rP r rW r r] r r` r rd r ro r rt r r r r r~ r r r r r r r@ r, r r r r r! Ú<module> s í
|
|
0
|
|
)
|
