:3Y}IJc h d Z ddlZddlZddlmZ ddlmZ ddlmZmZ ddl m
Z
m Z m Z m
Z
ddlmZ dd lmZ g d
Zd Zd Zed
Z e
ddd G d d Zd Z e
ddd G d d Zd=dZ e
ddd G d d Zd Z e
ddd G d d Z d Z e
ddd G d d Z d Z e
ddd G d! d" Z d# Z! e
ddd G d$ d% Z"d>d&Z# e
ddd G d' d( Z$d>d)Z% e
ddd G d* d+ Z&d, Z'd- Z(d. Z)d/ Z* e
ddd G d0 d1 Z+d2 Z, e
ddd G d3 d4 Z-d5 Z. e
ddd G d6 d7 Z/d8 Z0 e
ddd G d9 d: Z1de2e3fd;d<Z4dS )?z
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_disabledc & 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
Nr )r s a/builddir/build/BUILD/cloudlinux-venv-1.0.10/venv/lib/python3.11/site-packages/attr/validators.pyr r + s 8|$$$$$ c 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 = s "## ##r# c # x K t d dV t d dS # t d w xY w)z
Context manager that disables running validators within its context.
.. warning::
This context manager is not thread-safe!
.. versionadded:: 21.3.0
FNTr! r% r# r" r r I sM u !
4 4 s ( 9FT)reprslotshashc . e Zd Z e Zd Zd ZdS )_InstanceOfValidatorc t || j s=t d |j | j |j | || 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__selfinstattrr1 s r" __call__z _InstanceOfValidator.__call___ sl %++ %v ? &
r# c 8 d | j S )Nz)r/ r4 r/ r7 s r" __repr__z _InstanceOfValidator.__repr__q % :AA B
r# N__name__
__module__ __qualname__r
r/ r: r? r% r# r" r+ r+ [ s= 688D $
r# r+ c 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+ r< s r" r r w % %%r# )r' frozenr( c B e Zd Z e Z e Zd Zd ZdS )_MatchesReValidatorc | | s)rK )r4 rK r> s r" r? z _MatchesReValidator.__repr__ s% ?FFL G
r# N)rB rC rD r
rK rL r: r? r% r# r" rI rI sH fhhGJ
r# rI c t j dt j t j f}||vrYt d d t d t | D t | t r|rt d | }nt j | | }|t j u r|j }n |t j u r|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 3 , K | ]}|r|j pd V dS )NoneN)rB ).0es r" z matches_re.. s? 78(aj2F r# zR'flags' can only be used with a string pattern; pass flags to re.compile() instead)re fullmatchsearchmatchrM r4 joinsortedsetr2 r r3 compilerI )regexflagsfunc valid_funcsrK rL s r" r r s <ry"(;K ; ' . . )rd )r4 rd r> s r" r? z_ProvidesValidator.__repr__ s% AHHn I
r# N)rB rC rD r
rd r: r? r% r# r" rb rb s= I
r# rb c b ddl }| dt d 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
`_).
: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)warningswarnDeprecationWarningrb )rd rj s r" r r sC OOO MM i ( ((r# c . e Zd Z e Zd Zd ZdS )_OptionalValidatorc < |d S | ||| d S N validatorr6 s r" r: z_OptionalValidator.__call__ s( = F tT5)))))r# c R d t | j S )Nz')what)r4 r' rr r> s r" r? z_OptionalValidator.__repr__ s- 8??dn%% @
r# N)rB rC rD r
rr r: r? r% r# r" rn rn s= I* * *
r# rn c t | t t f r t t | 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.
)r2 listtuplern r rq s r" r r s> )dE]++ <!- ":":;;; i ( ((r# c . e Zd Z e Zd Zd ZdS ) _InValidatorc || j v }n# t $ r d}Y nw xY w|s7t d |j | j | || j | d S )NFz/'{name}' must be in {options!r} (got {value!r}))r. optionsr1 )r{ r3 rM r4 r. )r7 r8 r9 r1
in_optionss r" r: z_InValidator.__call__, s $,.JJ JJJ AHH DL I
s c 8 d | j S )Nz(r{ )r4 r{ r> s r" r? z_InValidator.__repr__< s% 9@@L A
r# N)rB rC rD r
r{ r: r? r% r# r" ry ry ( s= fhhG
r# ry c 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.
)ry r~ s r" r r B s & r# c e Zd Zd Zd ZdS )_IsCallableValidatorc t | s3d}t | |j ||j | dS )r- z?'{name}' must be callable (got {value!r} that is a {actual!r}).)r. r1 r0 )msgr1 N)callabler
r4 r. r5 )r7 r8 r9 r1 messages r" r: z _IsCallableValidator.__call__Z se
8
#NN % #
r# c dS )Nzr% r> s r" r? z _IsCallableValidator.__repr__j s ((r# N)rB rC rD r: r? r% r# r" r r X s2 ) ) ) ) )r# r c 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 ! !!r# c ~ e Zd Z e e Z ed e e Zd Zd Z dS )
_DeepIterablerq Ndefaultrr c z | j | ||| |D ]}| ||| dS r- N)iterable_validatormember_validator)r7 r8 r9 r1 members r" r: z_DeepIterable.__call__ sY " . # #D$ 6 6 6 6 6F ! !$f 5 5 5 5 6 6r# c ` | j dn d| j }d || j S )N zJ)iterable_identifierr )r r4 r )r7 r s r" r? z_DeepIterable.__repr__ sN &.
B0T,00
(
& 3(
r# )
rB rC rD r
r r r r r: r? r% r# r" r r } sw v
666 7 7 6 6 6
r# r c l t | t t f r 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
)r2 rv rw r r r r s r" r r s9 "T5M22 3 !12 )+= > >>r# c e Zd Z e e Z e e Z ed e e Zd Z d Z
dS ) _DeepMappingrq Nr c | j | ||| |D ]6}| ||| | |||| 7dS r )mapping_validator
key_validatorvalue_validator)r7 r8 r9 r1 keys r" r: z_DeepMapping.__call__ su ! - " "4u 5 5 5 9 9C tT3 / / / tU3Z 8 8 8 8 9 9r# c D d | j | j S )NzA)r r1 )r4 r r r> s r" r? z_DeepMapping.__repr__ s" O
&T't/C&
D
D Er# ) rB rC rD r
r r r r r r: r? r% r# r" r r s F[[]]333M f{{}}555O txx
7N7NOOO 9 9 9E E E E Er# r c $ 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
)r )r r r s r" r r s
8I J JJr# c V e Zd Z e Z e Z e Zd Zd ZdS )_NumberValidatorc | || j s5t d |j | j | j | dS )r- z&'{name}' must be {op} {bound}: {value})r. opboundr1 N) compare_funcr rM r4 r.
compare_opr6 s r" r: z_NumberValidator.__call__ se
33 8?? * @
r# c D d | j | j S )Nz )r r )r4 r r r> s r" r? z_NumberValidator.__repr__ s( /66dj 7
r# N) rB rC rD r
r r r r: r? r% r# r" r r sS FHHEJ688L
r# r c 8 t | dt j S )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 vals r" r r Chk 2 22r# c 8 t | dt j S )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 r r r s r" r r Cx{ 3 33r# c 8 t | dt j S )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 r r r s r" r r r r# c 8 t | dt j S )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 r r r s r" r r r r# c . e Zd Z e Zd Zd ZdS )_MaxLengthValidatorc t | | j k r s r" r? z _MaxLengthValidator.__repr__. ; ;;;;r# N)rB rC rD r
r r: r? r% r# r" r r = J < < < < {min}: {len})r. minr N)r
min_lengthrM r4 r. r6 s r" r: z _MinLengthValidator.__call__B r r# c d| j dS )Nz s r" r? z _MinLengthValidator.__repr__M r r# N)rB rC rD r
r r: r? r% r# r" r r > r r# r c 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 s r" r r Q r r# c . e Zd Z e Zd Zd ZdS )_SubclassOfValidatorc t || j s7t d |j | j | || j | dS )r- z8'{name}' must be a subclass of {type!r} (got {value!r}).)r. r/ r1 N)
issubclassr/ r3 r4 r. r6 s r" r: z _SubclassOfValidator.__call__a sg %++ ##)6 $* $ $
r# c 8 d | j S )Nz)r< r= r> s r" r? z _SubclassOfValidator.__repr__r r@ r# NrA r% r# r" r r ] s= 688D "
r# r c 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 r< s r" _subclass_ofr x rF r# c e Zd Z e Z e ed Z e e ee e
e Z d Z
d ZdS )
_NotValidatorzCnot_ validator child '{validator!r}' did not raise a captured error) converterr rq c | ||| t | j | j | j || j || j # | j $ r Y d S w xY w)N)rr exc_types)rr rM r r4 r r6 s r" r: z_NotValidator.__call__ s NN4u - - - "n "n
~ DD s A
A('A(c D d | j | j S )Nz;)rt r )r4 rr r r> s r" r? z_NotValidator.__repr__ s( L
& n
r# N)rB rC rD r
rr r r r r Exceptionr rw r r: r? r% r# r" r r s I
&!/
-
C - )\) 4 4 *{5 1 1
I "
r# r )r r c l t | }n# t $ r |f}Y nw xY wt | || 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
)rw r3 r )rr r r s r" r r sN 4!)$$ ! ! ! L ! C 3 33s
"")r Nrp )5__doc__r rU
contextlibr r _configr r _maker r r
r
convertersr
exceptionsr
__all__r r r r+ r rI r rb r rn r ry r r r r r r r r r r r r r r r r r r r rM r3 r r% r# r" r s
% % % % % % ; ; ; ; ; ; ; ; 5 5 5 5 5 5 5 5 5 5 5 5 ' ' ' ' ' ' ( ( ( ( ( ( .% % %$ $ $ $ ! ! !" ED)))
*)
6
&
&
& E$d+++
,+
2-4 -4 -4 -4` ED)))
*)
0) ) )6 ED)))
*)
) ) )& ED)))
*)
2! ! !, ET***) ) ) ) ) ) ) +*)* " " " ED)))
*)
>? ? ? ?" ED)))E E E E E E E *)E,
K
K
K
K E$d+++
,+
2 3 3 3 4 4 4 4 4 4 3 3 3 E$d+++< < < < < < < ,+<$ ' ' ' E$d+++< < < < < < < ,+<$ ' ' ' ED)))
*)
4
&
&
& ED)))&
&
&
&
&
&
&
*)&
R J +B 4 4 4 4 4 4 4r#