#IGZ` @ sQ d Z d d l m Z m Z m Z d d l m Z m Z m Z m Z d d d d d g Z
e d
d d d
d d
Gd d d e Z d d Z
e d
d d d
d d
Gd d d e Z d d Z e d
d d d
d d
Gd d d e Z d d Z e d
d d d
d d
Gd d d e Z d d Z d S) z
Commonly useful validators.
)absolute_importdivisionprint_function )
_AndValidatorand_attribattrsr in_ instance_ofoptionalprovidesreprFslotsThashc @ s1 e Z d Z e Z d d Z d d Z d S)_InstanceOfValidatorc
C sU t | | j sQ t d j d | j d | j d | j d | | | j | d S)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 r /validators.py__call__ s z _InstanceOfValidator.__call__c C s d j d | j S)Nz)<instance_of validator for type {type!r}>r )r r )r r r r __repr__$ s z _InstanceOfValidator.__repr__N)__name__
__module__ __qualname__r r r r r r r r r s
r c C s
t | S)a
A validator that raises a :exc:`TypeError` if the initializer is called
with a wrong type for this particular attribute (checks are performed using
:func:`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 :class:`attr.Attribute`), the expected type, and the value it
got.
)r )r r r r r + s
c @ s1 e Z d Z e Z d d Z d d Z d S)_ProvidesValidatorc C sL | j j | sH t d j d | j d | j d | | | j | d S)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)r% Z
providedByr r r )r r r r r r r r ? s
z_ProvidesValidator.__call__c C s d j d | j S)Nz0<provides validator for interface {interface!r}>r% )r r% )r r r r r K s z_ProvidesValidator.__repr__N)r! r" r# r r% r r r r r r r$ ; s r$ c C s
t | S)a
A validator that raises a :exc:`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 zope.interface.Interface interface: The interface to check for.
:raises TypeError: With a human readable error message, the attribute
(of type :class:`attr.Attribute`), the expected interface, and the
value it got.
)r$ )r% r r r r
R s
c @ s1 e Z d Z e Z d d Z d d Z d S)_OptionalValidatorc C s' | d k r d S| j | | | d S)N) validator)r r r r r r r r f s z_OptionalValidator.__call__c C s d j d t | j S)Nz'<optional validator for {what} or None>Zwhat)r r r' )r r r r r l s z_OptionalValidator.__repr__N)r! r" r# r r' r r r r r r r& b s r& c C s) t | t r t t | 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 :class:`list` of callables.
.. versionadded:: 15.1.0
.. versionchanged:: 17.1.0 *validator* can be a list of validators.
)r listr& r )r' r r r r s s
c @ s1 e Z d Z e Z d d Z d d Z d S) _InValidatorc C s= | | j k r9 t d j d | j d | j d | d S)Nz/'{name}' must be in {options!r} (got {value!r})r optionsr )r*
ValueErrorr r )r r r r r r r r s z_InValidator.__call__c C s d j d | j S)Nz(<in_ validator with options {options!r}>r* )r r* )r r r r r s z_InValidator.__repr__N)r! r" r# r r* r r r r r r r) s r) c C s
t | S)a
A validator that raises a :exc:`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, :class:`enum.Enum`, ...
:raises ValueError: With a human readable error message, the attribute (of
type :class:`attr.Attribute`), the expected options, and the value it
got.
.. versionadded:: 17.1.0
)r) )r* r r r r
s N)__doc__Z
__future__r r r _maker r r r __all__objectr r r$ r
r& r r) r
r r r r <module> s& " % % % %