L�X�� � @ sw d Z d d l m Z d d l m Z d d l m Z m Z m Z m Z d d l
m
Z
d d l m Z m Z d d l
Z
d d l m Z d d l m Z d d
l m Z m Z d d l m Z m Z m Z m Z d d l m Z m Z e j � Z d
d � Z Gd d � d e � Z! Gd d � d e � Z" Gd d � d e# � Z$ d Z% Gd d � d e& � Z' e' d e$ f i � Z$ d S)a
Extensible validation for Python dictionaries.
This module implements Cerberus Validator class
:copyright: 2012-2016 by Nicola Iarocci.
:license: ISC, see LICENSE for more details.
Full documentation is available at http://python-cerberus.org
� )�absolute_import)� literal_eval)�Hashable�Iterable�Mapping�Sequence)�copy)�date�datetimeN)�warn)�errors)�
_int_types� _str_type)�schema_registry�rules_set_registry�DefinitionSchema� SchemaError)�drop_item_from_tuple�isclassc C s d d � } | } | | _ | S)Nc S s t d � � d S)NzcDummy method called. Its purpose is to hold justvalidation constraints for a rule in its docstring.)� RuntimeError)�self�
constraint�field�value� r �
/validator.py�dummy s z(dummy_for_rule_validation.<locals>.dummy)�__doc__)Zrule_constraintsr �fr r r �dummy_for_rule_validation s r c @ s e Z d Z d Z d S)�
DocumentErrorzD Raised when the target document is missing or has the wrong format N)�__name__�
__module__� __qualname__r r r r r r ( s r c @ s e Z d Z d Z d S)�_SchemaRuleTypeErrorzs Raised when a schema (list) validation encounters a mapping.
Not supposed to be used outside this module. N)r! r" r# r r r r r r$ - s r$ c @ s8 e Z d Z d Z d� Z d� Z e � Z d d � Z d d � Z d d
� Z
e d d � � Z d
d � Z
d d d d � Z d d � Z d d � Z d d � Z d d � Z d d � Z e d d � � Z e j d d � � Z e d d � � Z e d! d" � � Z e j d# d" � � Z e d$ d% � � Z e d& d' � � Z e j d( d' � � Z e d) d* � � Z e j d+ d* � � Z e d, d- � � Z e d. d/ � � Z e d0 d1 � � Z e j d2 d1 � � Z e d3 d4 � � Z e d5 d6 � � Z e j d7 d6 � � Z e d8 d9 � � Z! e! j d: d9 � � Z! d d; d< � Z" d d= d> d? � Z# d@ dA � Z$ dB dC � Z% dD dE � Z& dF dG � Z' dH dI � Z( dJ dK � Z) dL dM � Z* dN dO � Z+ e, dP dQ � � Z- dR dS � Z. dT dU � Z/ dV dW � Z0 dX dY � Z1 dZ d[ � Z2 d\ d] � Z3 d^ d_ � Z4 d d= d` da db � Z5 e5 Z6 dc dd � Z7 de df � Z8 dg dh � Z9 e: di � Z; dj dk � Z< dl dm � Z= dn do � Z> dp dq � Z? dr ds � Z@ dt du � ZA dv dw � ZB dx dy � ZC dz d{ � ZD d| d} � ZE d~ d � ZF d� d� � ZG d� d� � ZH d� d� � ZI d� d� � ZJ d� d� � ZK d� d� � ZL d� d� � ZM d� d� � ZN d� d� � ZO d� d� � ZP e: d� � ZQ d� d� � ZR d� d� � ZS d� d� � ZT d� d� � ZU d� d� � ZV d� d� � ZW d� d� � ZX d� d� � ZY d� d� � ZZ d� d� � Z[ d� d� � Z\ d� d� � Z] d� d� � Z^ d� d� � Z_ d� d� � Z` d� d� � Za d� d� � Zb d� d� � Zc d S)�� Validatora6 Validator class. Normalizes and/or validates any mapping against a
validation-schema which is provided as an argument at class instantiation
or upon calling the :meth:`~cerberus.Validator.validate`,
:meth:`~cerberus.Validator.validated` or
:meth:`~cerberus.Validator.normalized` method. An instance itself is
callable and executes a validation.
All instantiation parameters are optional.
There are the introspective properties :attr:`types`, :attr:`validators`,
:attr:`coercers`, :attr:`default_setters`, :attr:`rules`,
:attr:`normalization_rules` and :attr:`validation_rules`.
The attributes reflecting the available rules are assembled considering
constraints that are defined in the docstrings of rules' methods and is
effectively used as validation schema for :attr:`schema`.
:param schema: See :attr:`~cerberus.Validator.schema`.
Defaults to :obj:`None`.
:type schema: any :term:`mapping`
:param ignore_none_values: See :attr:`~cerberus.Validator.ignore_none_values`.
Defaults to ``False``.
:type ignore_none_values: :class:`bool`
:param allow_unknown: See :attr:`~cerberus.Validator.allow_unknown`.
Defaults to ``False``.
:type allow_unknown: :class:`bool` or any :term:`mapping`
:param purge_unknown: See :attr:`~cerberus.Validator.purge_unknown`.
Defaults to to ``False``.
:type purge_unknown: :class:`bool`
:param error_handler: The error handler that formats the result of
:attr:`~cerberus.Validator.errors`.
When given as two-value tuple with an error-handler
class and a dictionary, the latter is passed to the
initialization of the error handler.
Default: :class:`~cerberus.errors.BasicErrorHandler`.
:type error_handler: class or instance based on
:class:`~cerberus.errors.BaseErrorHandler` or
:class:`tuple`
�nullable�readonly�typec O s� d | _ t j � | _ d | _ t j � | _ t j � | _ f | _ f | _
d | _ | j | � | _
| j | | � | j d d � | _ | j d d � | _ d S)z� The arguments will be treated as with this signature:
__init__(self, schema=None, ignore_none_values=False,
allow_unknown=False, purge_unknown=False,
error_handler=errors.BasicErrorHandler)
NF�schema�
allow_unknown)�documentr � ErrorList�_errors� recent_error�DocumentErrorTree�document_error_tree�SchemaErrorTree�schema_error_tree�
document_path� schema_path�update� _Validator__init_error_handler�
error_handler�_Validator__store_config�getr) r* )r �args�kwargsr r r �__init__h s zValidator.__init__c C s� | j d t j � } t | t � r3 | \ } } n i } t | � ra t | t j � ra | | � St | t j � rw | St d � � d S)Nr7 zInvalid error_handler.) �popr ZBasicErrorHandler�
isinstance�tupler �
issubclassZBaseErrorHandlerr )r r; r7 Z eh_configr r r Z__init_error_handler� s
z Validator.__init_error_handlerc C sm d } xW t | d t | � � � D]9 \ } } | | k rN t d | � � q# | | | | <q# W| | _ d S)z0 Assign args to kwargs and store configuration. r) �ignore_none_valuesr* �
purge_unknownNz.__init__ got multiple values for argument '%s')zschemazignore_none_valuesz
allow_unknownz
purge_unknown)� enumerate�len� TypeError�_config)r r: r; Z signature�i�pr r r Z__store_config� s )
zValidator.__store_configc C s | j j � d S)z) Purge the cache of known valid schemas. N)�_valid_schemas�clear)�clsr r r � clear_caches� s zValidator.clear_cachesc G s� t | � d k ry | j j | d � | j j � x�| d D]4 } | j | 7_ | j | 7_ | j j | � q> Wnlt | � d k r� t | d t � r� | j
| d t j | d � n&t | � d k r�| d } | d j
} | d j } | d d � } | j | f } | j } | t j j
k rL| d k rL| | | f 7} | s[d } nA | j | j | � }
| d k r�|
j | d � } n
|
| } | j j | � } t j | | | | | | | � | _ | j
| j g � d S)a� Creates and adds one or multiple errors.
:param args: Accepts different argument's signatures.
*1. Bulk addition of errors:*
- :term:`iterable` of
:class:`~cerberus.errors.ValidationError`-instances
The errors will be added to
:attr:`~cerberus.Validator._errors`.
*2. Custom error:*
- the invalid field's name
- the error message
A custom error containing the message will be created and
added to :attr:`~cerberus.Validator._errors`.
There will however be fewer information contained in the
error (no reference to the violated rule and its
constraint).
*3. Defined error:*
- the invalid field's name
- the error-reference, see :mod:`cerberus.errors`
- arbitrary, supplemental information about the error
A :class:`~cerberus.errors.ValidationError` instance will
be created and added to
:attr:`~cerberus.Validator._errors`.
� r � Nr& F)rD r- �extend�sortr0 r2 r7 �emitr> r �_errorr ZCUSTOM�code�ruler3 r4 �
UNKNOWN_FIELD�_resolve_rules_setr) r9 r+ ZValidationErrorr. ) r r: �errorr rS rT �infor3 r4 r Zfield_definitionsr r r r rR � s8 %
%!
zValidator._errorNc K s� | j j � } | j | � | j s` d | d <t | d <| j | d <| j | d <| j | d <| j | � } | d k r� | j | _ n( t
| t � s� | f } | j | | _ | d k r� | j | _ n( t
| t � s� | f } | j | | _ | S)a@ Creates a new instance of Validator-(sub-)class. All initial
parameters of the parent are passed to the initialization, unless
a parameter is given as an explicit *keyword*-parameter.
:param document_crumb: Extends the
:attr:`~cerberus.Validator.document_path`
of the child-validator.
:type document_crumb: :class:`tuple` or :term:`hashable`
:param schema_crumb: Extends the
:attr:`~cerberus.Validator.schema_path`
of the child-validator.
:type schema_crumb: :class:`tuple` or hashable
:param kwargs: Overriding keyword-arguments for initialization.
:type kwargs: :class:`dict`
:return: an instance of ``self.__class__``
T�is_childr7 �root_allow_unknown�
root_document� root_schemaN)
rF r r5 rY �toy_error_handlerr* r+ r) � __class__r3 r> r? r4 )r �document_crumb� schema_crumbr; Z child_configZchild_validatorr r r �_get_child_validator� s(
z Validator._get_child_validatorc C s. d j | | j d d � � } t | | d � S)Nz_{0}_{1}� �_)�format�replace�getattr)r ZdomainrT Z
methodnamer r r Z__get_rule_handler, s z Validator.__get_rule_handlerc C s� t | j � } t | j � } x� | D]� } x3 t | d d �D] } t | j | | � | _ q> Wx3 t | d d �D] } t | j | | � | _ qt W| j r% | j | j | | � q% Wd S)a Removes nodes by index from an errorpath, relatively to the
basepaths of self.
:param errors: A list of :class:`errors.ValidationError` instances.
:param dp_items: A list of integers, pointing at the nodes to drop from
the :attr:`document_path`.
:param sp_items: Alike ``dp_items``, but for :attr:`schema_path`.
�reverseTN)rD r3 r4 �sortedr Z child_errors�_drop_nodes_from_errorpaths)r r- Zdp_itemsZsp_itemsZ dp_basedepthZ sp_basedepthrW rG r r r ri 0 s
z%Validator._drop_nodes_from_errorpathsc C s� | j d � rC | d d � } | j d � r7 | j n | j } n | j } | j d � } x- | D]% } | j | � } | d k rb d Sqb W| d | f S)a� Searches for a field as defined by path. This method is used by the
``dependency`` evaluation logic.
:param path: Path elements are separated by a ``.``. A leading ``^``
indicates that the path relates to the document root,
otherwise it relates to the currently evaluated document,
which is possibly a subdocument.
The sequence ``^^`` at the start will be interpreted as a
literal ``^``.
:type path: :class:`str`
:returns: Either the found field name and its value or :obj:`None` for
both.
:rtype: A two-value :class:`tuple`.
�^rM N�.)NN���)�
startswithr+ r[ �splitr9 )r �path�context�parts�partr r r �
_lookup_fieldF s
zValidator._lookup_fieldc C s6 t | t � r | St | t � r2 | j j | � Sd S)N)r> r r r r9 )r Z rules_setr r r rV d s
z Validator._resolve_rules_setc C s6 t | t � r | St | t � r2 | j j | � Sd S)N)r> r r r r9 )r r) r r r �_resolve_schemak s
zValidator._resolve_schemac C s | j j d d � S)a: If ``True`` unknown fields that are not defined in the schema will
be ignored. If a mapping with a validation schema is given, any
undefined field will be validated against its rules.
Also see :ref:`allowing-the-unknown`.
Type: :class:`bool` or any :term:`mapping` r* F)rF r9 )r r r r r* t s zValidator.allow_unknownc C sB | j p t | t t f � s1 t | d | i � | | j d <d S)Nr* )rY r> �boolr rF )r r r r r r* } s c C s | j | j � S)z� The errors of the last processing formatted by the handler that is
bound to :attr:`~cerberus.Validator.error_handler`. )r7 r- )r r r r r � s zValidator.errorsc C s | j j d d � S)za Whether to not process :obj:`None`-values in a document or not.
Type: :class:`bool` rA F)rF r9 )r r r r rA � s z Validator.ignore_none_valuesc C s | | j d <d S)NrA )rF )r r r r r rA � s c C s | j j d d � S)z� ``True`` for child-validators obtained with
:meth:`~cerberus.Validator._get_child_validator`.
Type: :class:`bool` rY F)rF r9 )r r r r rY � s zValidator.is_childc C s | j j d d � S)z1 ``True`` if the document is already normalized. �
is_normalizedF)rF r9 )r r r r rv � s zValidator.is_normalizedc C s | | j d <d S)Nrv )rF )r r r r r rv � s c C s | j j d d � S)z� If ``True`` unknown fields will be deleted from the document
unless a validation is called with disabled normalization.
Also see :ref:`purging-unknown-fields`. Type: :class:`bool` rB F)rF r9 )r r r r rB � s zValidator.purge_unknownc C s | | j d <d S)NrB )rF )r r r r r rB � s c C s | j j d | j � S)zw The :attr:`~cerberus.Validator.allow_unknown` attribute of the
first level ancestor of a child validator. rZ )rF r9 r* )r r r r rZ � s z Validator.root_allow_unknownc C s | j j d | j � S)zr The :attr:`~cerberus.Validator.document` attribute of the
first level ancestor of a child validator. r[ )rF r9 r+ )r r r r r[ � s zValidator.root_documentc C s | j j d t � S)z^ The registry that holds referenced rules sets.
Type: :class:`~cerberus.Registry` r )rF r9 r )r r r r r � s z Validator.rules_set_registryc C s | | j d <d S)Nr )rF )r �registryr r r r � s c C s | j j d | j � S)zp The :attr:`~cerberus.Validator.schema` attribute of the
first level ancestor of a child validator. r\ )rF r9 r) )r r r r r\ � s zValidator.root_schemac C s | j S)z� The validation schema of a validator. When a schema is passed to
a method, it replaces this attribute.
Type: any :term:`mapping` or :obj:`None` )�_schema)r r r r r) � s zValidator.schemac C sR | d k r d | _ n6 | j s0 t | t � r< | | _ n t | | � | _ d S)N)rx rY r> r )r r) r r r r) � s
c C s | j j d t � S)zW The registry that holds referenced schemas.
Type: :class:`~cerberus.Registry` r )rF r9 r )r r r r r � s zValidator.schema_registryc C s | | j d <d S)Nr )rF )r rw r r r r � s c C s� t j � | _ d | _ t j � | _ t j � | _ t | � | _ | d k rf t
| | � | _ n< | j d k r� t | j
t � r� i | _ n t t j � � | d k r� t t j � � t | t � s� t t j j | � � � | j j | � d S)N)r r, r- r. r/ r0 r1 r2 r r+ r r) r> r* r rx r ZSCHEMA_ERROR_MISSINGr ZDOCUMENT_MISSINGZDOCUMENT_FORMATrd r7 �start)r r+ r) r r r Z__init_processing� s" zValidator.__init_processingFc C sU | j | | � | j | j | j � | j j | � | j rJ | rJ d S| j Sd S)a Returns the document normalized according to the specified rules
of a schema.
:param document: The document to normalize.
:type document: any :term:`mapping`
:param schema: The validation schema. Defaults to :obj:`None`. If not
provided here, the schema must have been provided at
class instantiation.
:type schema: any :term:`mapping`
:param always_return_document: Return the document, even if an error
occurred. Defaults to: ``False``.
:type always_return_document: :class:`bool`
:return: A normalized copy of the provided mapping or :obj:`None` if an
error occurred during normalization.
N)�_Validator__init_processing� _Validator__normalize_mappingr+ r) r7 �endr- )r r+ r) �always_return_documentr r r �
normalized� s zValidator.normalizedc C s� t | t � r | j | � } | j � } x% | D] } | j | | � | | <q1 W| j | | � | j r{ | j | | � | j | | � | j | | � | j
| | � | j | | � | S)N) r> r rt r rV �#_Validator__normalize_rename_fieldsrB �_normalize_purge_unknown�$_Validator__validate_readonly_fields�$_Validator__normalize_default_fields�_normalize_coerce� _Validator__normalize_containers)r �mappingr) r r r r Z__normalize_mapping s
z Validator.__normalize_mappingc C s� t j } x� | D]� } | | k r] d | | k r] | j | | d | | | | � | | <q t | j t � r d | j k r | j | j d | | | | � | | <q Wd S)a {'oneof': [
{'type': 'callable'},
{'type': 'list',
'schema': {'oneof': [{'type': 'callable'},
{'type': 'string'}]}},
{'type': 'string'}
]} �coerceN)r �COERCION_FAILED� _Validator__normalize_coercer> r* r )r r� r) rW r r r r r� ( s
%zValidator._normalize_coercec C s� t | t � r$ | j d | � } nh t | t � r� | } xL | D]D } | j | | | | � } t j | j j | j | f � k r@ Pq@ W| Sy | | � SWnB t
k
r� } z" | j | | t | � � | SWYd d } ~ Xn Xd S)NZnormalize_coerce)
r> r � _Validator__get_rule_handlerr r� r r� r0 �fetch_errors_fromr3 � ExceptionrR �str)r Z processorr r rW �resultrH �er r r Z__normalize_coerce; s
z Validator.__normalize_coercec C s% x | D]} | | k r q t | | t � r� d | | k rZ | j | | | | d � d | | k r� | j | | | | d � t | | � t d � @r y | j | | | � Wq t k
r� Yq Xq t | | t � r� q q t | | t � r d | | k r | j | | | � q Wd S)N� keyschema� valueschemar* rB r) )z
allow_unknownz
purge_unknownzschema)
r> r �+_Validator__normalize_mapping_per_keyschema�-_Validator__normalize_mapping_per_valueschema�set�(_Validator__normalize_mapping_per_schemar$ r r � _Validator__normalize_sequence)r r� r) r r r r Z__normalize_containersO s,
z Validator.__normalize_containersc s[ t � f d d � | | D� � } t d d � | | D� � } | j d | d | d f d | � } | j | d d �} | j r� | j | j g d
d g � | j | j � x� | D]� } | | | k r� q� | | | | k r.t d j d
d j | j | f � d | � � | | | | | | | <q� | | | | | | | <| | | =q� Wd S)Nc 3 s | ] } | � f Vq d S)Nr )�.0�k)�property_rulesr r � <genexpr>i s z>Validator.__normalize_mapping_per_keyschema.<locals>.<genexpr>c s s | ] } | | f Vq d S)Nr )r� r� r r r r� j s r_ r` r� r) r} TrN � zHNormalizing keys of {path}: {key} already exists, its value is replaced.ro rk �key)
�dictra r~ r- ri rR r rd �joinr3 ) r r r� r� r) r+ � validatorr� r� r )r� r Z!__normalize_mapping_per_keyschemah s& #
z+Validator.__normalize_mapping_per_keyschemac s� t � f d d � | | D� � } | j d | d | d f d | � } | j | | d d �| | <| j r� | j | j g d g � | j | j � d S)
Nc 3 s | ] } | � f Vq d S)Nr )r� r� )� value_rulesr r r� � s z@Validator.__normalize_mapping_per_valueschema.<locals>.<genexpr>r_ r` r� r) r} TrN )r� ra r~ r- ri rR )r r r� r� r) r� r )r� r Z#__normalize_mapping_per_valueschema s #
z-Validator.__normalize_mapping_per_valueschemac
C s� | j d | d | d f d | | d d | | j d | j � d | | j d | j � � } | j | | d d �| | <| j r� | j | j � d S)Nr_ r` r) r* rB r} T)ra r9 r* rB r~ r- rR )r r r� r) r� r r r Z __normalize_mapping_per_schema� s
z(Validator.__normalize_mapping_per_schemac s� t � � f d d � t t | � � � D� � � t d d � t | � � D� � } | j d � d � d f d � � } | j | d d �} x | D] } | | | � | <q� W| j r� | j | j g d g � | j | j � d S)
Nc 3 s# | ] } | � � d f Vq d S)r) Nr )r� r� )r r) r r r� � s z1Validator.__normalize_sequence.<locals>.<genexpr>c s s! | ] \ } } | | f Vq d S)Nr )r� r� �vr r r r� � s r_ r` r) r} TrN ) r� �rangerD rC ra r~ r- ri rR )r r r� r) r+ r� r� rG r )r r) r Z__normalize_sequence� s #
z Validator.__normalize_sequencec C s. x' t | � D] } | | k r
| | =q
W| S)z {'type': 'boolean'} )r? )r� r) r r r r r� � s z"Validator._normalize_purge_unknownc C s� x� t | � D]x } | | k rH | j | | | � | j | | | � q
t | j t � r
d | j k r
| j | | | j i | � q
W| S)N�rename_handler)r? �_normalize_rename�_normalize_rename_handlerr> r* r )r r� r) r r r r Z__normalize_rename_fields� s z#Validator.__normalize_rename_fieldsc C s1 d | | k r- | | | | | d <| | =d S)z {'type': 'hashable'} �renameNr )r r� r) r r r r r� � s zValidator._normalize_renamec C s\ d | | k r d S| j | | d | | t j � } | | k rX | | | | <| | =d S)a {'oneof': [
{'type': 'callable'},
{'type': 'list',
'schema': {'oneof': [{'type': 'callable'},
{'type': 'string'}]}},
{'type': 'string'}
]} r� N)r� r ZRENAMING_FAILED)r r� r) r �new_namer r r r� � s z#Validator._normalize_rename_handlerc sM xF � � � f d d � � D� D]% } � j � | d | � | � q Wd S)Nc 3 s= | ]3 } | � k r � j � | � j d � r | Vq d S)r' N)rV r9 )r� �x)r� r) r r r r� � s z7Validator.__validate_readonly_fields.<locals>.<genexpr>r' )�_validate_readonly)r r� r) r r )r� r) r r Z__validate_readonly_fields� s &z$Validator.__validate_readonly_fieldsc s� � � f d d � � D� } y � f d d � | D� } Wn t k
rS t � Yn Xx! | D] } | j � � | � q[ Wt � } � f d d � | D� } x� | r~| j d � } y | j � � | � Wn_ t k
r� | j | � YnA t k
r*} z! | j | t
j t | � � WYd d } ~ Xn Xt
| � } | | k rnx$ | D] } | j | t
j d � qJWPq� | j | � q� Wd S)Nc sI g | ]? } | � k s? � | d k r � | j d d � r | � q S)Nr& F)r9 )r� r� )r� r) r r �
<listcomp>� s z8Validator.__normalize_default_fields.<locals>.<listcomp>c s& g | ] } d � | k r | � q S)�defaultr )r� r� )r) r r r� � s c s& g | ] } d � | k r | � q S)�default_setterr )r� r� )r) r r r� � s r z)Circular dependencies of default setters.)rE r$ �_normalize_defaultr� r= �_normalize_default_setter�KeyError�appendr� rR r ZSETTING_DEFAULT_FAILEDr� r? �add) r r� r) �fieldsZfields_with_defaultr Zknown_fields_statesr� Z fields_stater )r� r) r Z__normalize_default_fields� s0
/
z$Validator.__normalize_default_fieldsc C s | | d | | <d S)z {'nullable': True} r� Nr )r r� r) r r r r r� � s z Validator._normalize_defaultc C sS d | | k rO | | d } t | t � r? | j d | � } | | � | | <d S)zi {'oneof': [
{'type': 'callable'},
{'type': 'string'}
]} r� Znormalize_default_setterN)r> r r� )r r� r) r �setterr r r r� � s z#Validator._normalize_default_setterTc C s� | | _ t � | _ | j | | � | rJ | j | j | j � d | _ xn | j D]c } | j ry | j | d k ry qT | j j | � } | d k r� | j
| | � qT | j | � qT W| j s� | j | j � | j
j | � t | j � S)aO Normalizes and validates a mapping against a validation-schema of
defined rules.
:param document: The document to normalize.
:type document: any :term:`mapping`
:param schema: The validation schema. Defaults to :obj:`None`. If not
provided here, the schema must have been provided at
class instantiation.
:type schema: any :term:`mapping`
:param update: If ``True``, required fields won't be checked.
:type update: :class:`bool`
:param normalize: If ``True``, normalize the document before validation.
:type normalize: :class:`bool`
:return: ``True`` if validation succeeds, otherwise ``False``. Check
the :func:`errors` property for a list of processing errors.
:rtype: :class:`bool`
TN)r5 r� �_unrequired_by_excludesrz r{ r+ r) rv rA r9 � _Validator__validate_definitions�#_Validator__validate_unknown_fields�$_Validator__validate_required_fieldsr7 r| ru r- )r r+ r) r5 � normalizer � definitionsr r r �validate s" zValidator.validatec O sA | j d d � } | j | | � | j r6 | r6 d S| j Sd S)z� Wrapper around :meth:`~cerberus.Validator.validate` that returns
the normalized and validated document or :obj:`None` if validation
failed. r} FN)r= r� r- r+ )r r: r; r} r r r � validated0 s
zValidator.validatedc C s� | j r� | j | } t | j t t f � r� | j r= d n d } | j d | d | | j i � } | | | i d d �s� | j | j � n | j | t j
� d S)Nr* Z__allow_unknown__r` r) r� F) r* r+ r> r r rY ra rR r- r rU )r r r r` r� r r r Z__validate_unknown_fields; s
z#Validator.__validate_unknown_fieldsc s� � � � � f d d � } � j � � � � j � � t � � f d d � � j D� � } x | D] } | | � rc d Sqc Wt � � } | t � j � O} | t | d � 8} | t � j � 8} x2 | D]* } y | | � Wq� t k
r� PYq� Xq� Wd S) z5 Validate a field's value against its defined rules. c s8 � j d | � } | r4 | � j | d � � � � Sd S)Nr� )r� r9 )rT r� )r� r r r r r �
validate_ruleQ s z7Validator.__validate_definitions.<locals>.validate_rulec 3 s0 | ]& } | � k s$ | � j k r | Vq d S)N)�mandatory_validations)r� r� )r� r r r r� Z s z3Validator.__validate_definitions.<locals>.<genexpr>Nr* �required)z
allow_unknownzrequired)rV r+ r? �priority_validationsr� r� �normalization_rulesr$ )r r� r r� Z prior_rulesrT �rulesr )r� r r r r Z__validate_definitionsN s
%
z Validator.__validate_definitionsz� {'oneof': [{'type': 'boolean'},
{'type': ['dict', 'string'],
'validator': 'bulk_schema'}]} c C s� t | t � rZ t | t � rZ t | � t | � } | r| | j | t j t | � � n" | | k r| | j | t j | � d S)z {'type': 'list'} N) r> r r r� rR r ZUNALLOWED_VALUES�listZUNALLOWED_VALUE)r Zallowed_valuesr r Z unallowedr r r �_validate_allowedp s zValidator._validate_allowedc C s� t | t � r | g } t | t � r: | j | | � n t | t � rY | j | | � | j j | j | d f � d k r� d Sd S)z- {'type': ['dict', 'hashable', 'hashables']} � dependenciesNT) r> r r �*_Validator__validate_dependencies_sequencer �)_Validator__validate_dependencies_mappingr0 Zfetch_node_fromr4 )r r� r r r r r �_validate_dependenciesz s z Validator._validate_dependenciesc C s� d } i } x� | j � D]u \ } } t | t � sD t | t � rM | g } | j | � \ } } | | k r{ | d 7} q | j | | i � q W| t | � k r� | j | t j | � d S)Nr rM )
�itemsr> r r rs r5 rD rR r ZDEPENDENCIES_FIELD_VALUE) r r� r Z validated_dependencies_counterZ
error_infoZdependency_nameZdependency_valuesZ wanted_fieldZwanted_field_valuer r r Z __validate_dependencies_mapping� s
z)Validator.__validate_dependencies_mappingc C sD x= | D]5 } | j | � d d k r | j | t j | � q Wd S)Nr )rs rR r ZDEPENDENCIES_FIELD)r r� r Z
dependencyr r r Z __validate_dependencies_sequence� s
z*Validator.__validate_dependencies_sequencec C s? t | t � r; t | � d k r; | r; | j | t j � d S)z {'type': 'boolean'} r N)r> r rD rR r ZEMPTY_NOT_ALLOWED)r �emptyr r r r r �_validate_empty� s (zValidator._validate_emptyc s� t | t � r | g } d � j | k rL � j | d rL � j j | � xQ | D]I } | � j k rS d � j | k rS � j | d rS � j j | � qS W� f d d � | D� r� d j d d � | D� � } � j | t j | � d S)z% {'type': ['hashable', 'hashables']} r� c s% g | ] } | � j k r d � q S)T)r+ )r� r� )r r r r� � s z0Validator._validate_excludes.<locals>.<listcomp>z, c s s | ] } d j | � Vq d S)z'{0}'N)rd )r� Zwordr r r r� � s z/Validator._validate_excludes.<locals>.<genexpr>N) r> r r) r� r� r� rR r ZEXCLUDES_FIELD)r Zexcludesr r �excludeZ
exclusion_strr )r r �_validate_excludes� s $
z Validator._validate_excludesc C s� t | t � r4 | | k r� | j | t j | � n{ t | t � r~ t | � t | � @} | r� | j | t j t | � � n1 t | t � r� | | k r� | j | t j | � d S)z {'type': 'list'} N)
r> r rR r ZFORBIDDEN_VALUEr r� ZFORBIDDEN_VALUESr� �int)r Zforbidden_valuesr r Z forbiddenr r r �_validate_forbidden� s z Validator._validate_forbiddenc C s� t | � t | � k r@ | j | t j t | � t | � � n� t d d � t | � D� � } | j d | d | d f d | � } | t d d � t | � D� � d | j d d
�s� | j | t j | j � d S) z( {'type': 'list', 'validator': 'items'} c s s! | ] \ } } | | f Vq d S)Nr )r� rG �
definitionr r r r� � s z,Validator._validate_items.<locals>.<genexpr>r_ r` r� r) c s s! | ] \ } } | | f Vq d S)Nr )r� rG r r r r r� � s r5 r� FN)
rD rR r Z ITEMS_LENGTHr� rC ra r5 Z BAD_ITEMSr- )r r� r �valuesr) r� r r r �_validate_items� s ( "zValidator._validate_itemsc C s4 d } t j � } xt | � D]\ } } | | j � i } xJ d D]B }
|
| | k rD |
| j | k rD | j | |
| | |
<qD Wd | | k r� | j | | d <| j d | | | f d | d d � } | | j d | j d d �r� | d
7} q | j | j
g d g � | j | j
� q W| | f S)
z` Validates value against all definitions and logs errors according
to the operator. r r* r( r` r) Tr5 r� FrM � )z
allow_unknownztype) r r, rC r r) r* ra r+ r5 ri r- rO ) r �operatorr� r r Z
valid_counterr- rG r� r) rT r� r r r Z__validate_logical� s"
#
z Validator.__validate_logicalc C sP | j d | | | � \ } } | d k rL | j | t j | | t | � � d S)z& {'type': 'list', 'logical': 'anyof'} ZanyofrM N)� _Validator__validate_logicalrR r ZANYOFrD )r r� r r �validsr- r r r �_validate_anyof� s zValidator._validate_anyofc C sV | j d | | | � \ } } | t | � k rR | j | t j | | t | � � d S)z& {'type': 'list', 'logical': 'allof'} ZallofN)r� rD rR r ZALLOF)r r� r r r� r- r r r �_validate_allof� s zValidator._validate_allofc C sP | j d | | | � \ } } | d k rL | j | t j | | t | � � d S)z' {'type': 'list', 'logical': 'noneof'} Znoneofr N)r� rR r ZNONEOFrD )r r� r r r� r- r r r �_validate_noneof� s zValidator._validate_noneofc C sP | j d | | | � \ } } | d k rL | j | t j | | t | � � d S)z& {'type': 'list', 'logical': 'oneof'} �oneofrM N)r� rR r ZONEOFrD )r r� r r r� r- r r r �_validate_oneof s zValidator._validate_oneofc C s< y# | | k r" | j | t j � Wn t k
r7 Yn Xd S)z {'nullable': False } N)rR r Z MAX_VALUErE )r Z max_valuer r r r r �
_validate_max s
zValidator._validate_maxc C s< y# | | k r" | j | t j � Wn t k
r7 Yn Xd S)z {'nullable': False } N)rR r Z MIN_VALUErE )r Z min_valuer r r r r �
_validate_min s
zValidator._validate_minc C sA t | t � r= t | � | k r= | j | t j t | � � d S)z {'type': 'integer'} N)r> r rD rR r Z
MAX_LENGTH)r Z
max_lengthr r r r r �_validate_maxlength s !z Validator._validate_maxlengthc C sA t | t � r= t | � | k r= | j | t j t | � � d S)z {'type': 'integer'} N)r> r rD rR r Z
MIN_LENGTH)r Z
min_lengthr r r r r �_validate_minlength! s !z Validator._validate_minlengthc C s1 | d k r- | r d S| j | t j � d Sd S)z {'type': 'boolean'} NT)rR r Z NOT_NULLABLE)r r& r r r r r �_validate_nullable& s
z Validator._validate_nullablec
s� t | t � r� | j d | d | d f d t � f d d � | j � D� � � } | t d d � | j � D� � d d �s� | j | j g d
d g � | j | t j | j � d S)
zq {'type': ['dict', 'string'], 'validator': 'bulk_schema',
'forbidden': ['rename', 'rename_handler']} r_ r` r� r) c 3 s | ] } | � f Vq d S)Nr )r� r� )r) r r r� 6 s z0Validator._validate_keyschema.<locals>.<genexpr>c s s | ] } | | f Vq d S)Nr )r� r� r r r r� 7 s r� FrN r� N)
r> r ra r� �keysri r- rR r Z KEYSCHEMA)r r) r r r� r )r) r �_validate_keyschema/ s (" z Validator._validate_keyschemac C sb | r^ | j s& | j | t j � d St j | j j | j | f � k } | j r^ | r^ d Sd S)z {'type': 'boolean'} TN)rv rR r ZREADONLY_FIELDr0 r� r3 )r r' r r Z has_errorr r r r� = s z Validator._validate_readonlyc C sa t | t � s d S| j d � s, | d 7} t j | � } | j | � s] | j | t j � d S)z {'type': 'string'} N�$) r> r �endswith�re�compile�matchrR r ZREGEX_MISMATCH)r �patternr r Zre_objr r r �_validate_regexL s
zValidator._validate_regexz {'type': 'boolean'} c
s) y, t � f d d � � j j � D� � } Wn: t k
rh � j ra � j d d k ra t � n � Yn X| � j 8} | t � � f d d � � D� � } x! | D] } � j | t j
� q� W� j r%t � f d d � � D� � } � j j | � r%x( � j | D] } � j | t j
� qWd S) zq Validates that required fields are not missing.
:param document: The document being validated.
c 3 s9 | ]/ \ } } � j | � j d � d k r | Vq d S)r� TN)rV r9 )r� r r� )r r r r� ^ s z7Validator.__validate_required_fields.<locals>.<genexpr>rM r) c 3 s4 | ]* } � j | � d k s( � j r | Vq d S)N)r9 rA )r� r )r+ r r r r� g s c 3 s* | ] } � j | � d k r | Vq d S)N)r9 )r� r )r+ r r r� q s Nrl ) r� r) r� �AttributeErrorrY r4 r$ r� rR r ZREQUIRED_FIELD�
isdisjoint)r r+ r� Zmissingr r� r )r+ r r Z__validate_required_fieldsX s ,
&
z$Validator.__validate_required_fieldsc C sk | d k r d St | t � rE t | t � rE | j | | | � n" t | t � rg | j | | | � d S)z� {'type': ['dict', 'string'],
'anyof': [{'validator': 'schema'},
{'validator': 'bulk_schema'}]} N)r> r r �$_Validator__validate_schema_sequencer �#_Validator__validate_schema_mapping)r r) r r r r r �_validate_schemaw s zValidator._validate_schemac C s� | j | � } | j | j d | j � } | j d | d | d f d | d | � } y/ | | d | j d d �s� | j | j � Wn( t k
r� | j | t j
� � Yn Xd S)Nr* r_ r` r) r5 r� F) rt r) r9 r* ra r5 rR r- r$ r ZBAD_TYPE_FOR_SCHEMA)r r r) r r* r� r r r Z__validate_schema_mapping� s
z#Validator.__validate_schema_mappingc s� t � f d d � t t | � � D� � � | j d | d | d f d � d | j � } | t d d � t | � D� � d | j d d
�| j r� | j | j g d g � | j | t
j | j � d S) Nc 3 s | ] } | � f Vq d S)Nr )r� rG )r) r r r� � s z7Validator.__validate_schema_sequence.<locals>.<genexpr>r_ r` r) r* c s s! | ] \ } } | | f Vq d S)Nr )r� rG r� r r r r� � s r5 r� FrN ) r� r� rD ra r* rC r5 r- ri rR r ZSEQUENCE_SCHEMA)r r r) r r� r )r) r Z__validate_schema_sequence� s + " z$Validator.__validate_schema_sequencec s_ t | t � r | g n | } t � � f d d � | D� � rD d S� j | t j � d Sd S)z {'type': ['string', 'list']} c 3 s' | ] } � j d | � � � Vq d S)Z
validate_typeN)r� )r� r� )r r r r r� � s z+Validator._validate_type.<locals>.<genexpr>NT)r> r �anyrR r ZBAD_TYPE)r Z data_typer r �typesr )r r r �_validate_type� s
zValidator._validate_typec C s t | t � r d Sd S)NT)r> ru )r r r r r �_validate_type_boolean� s z Validator._validate_type_booleanc C s t | t � r d Sd S)NT)r> r )r r r r r �_validate_type_date� s z Validator._validate_type_datec C s t | t � r d Sd S)NT)r> r
)r r r r r �_validate_type_datetime� s z!Validator._validate_type_datetimec C s t | t � r d Sd S)NT)r> r )r r r r r �_validate_type_dict� s z Validator._validate_type_dictc C s t | t t f � r d Sd S)NT)r> �floatr
)r r r r r �_validate_type_float� s z Validator._validate_type_floatc C s t | t � r d Sd S)NT)r> r
)r r r r r �_validate_type_integer� s z Validator._validate_type_integerc C s t | t t f � r d Sd S)NT)r> �bytes� bytearray)r r r r r �_validate_type_binary� s z Validator._validate_type_binaryc C s' t | t � r# t | t � r# d Sd S)NT)r> r r )r r r r r �_validate_type_list� s
z Validator._validate_type_listc C s- t | t t f � r) t | t � r) d Sd S)NT)r> r
r� ru )r r r r r �_validate_type_number� s z Validator._validate_type_numberc C s t | t � r d Sd S)NT)r> r� )r r r r r �_validate_type_set� s z Validator._validate_type_setc C s t | t � r d Sd S)NT)r> r )r r r r r �_validate_type_string� s z Validator._validate_type_stringc C s~ t | t � r1 | j d | � } | | | � nI t | t � rg x7 | D] } | j | | | � qG Wn | | | | j � d S)a {'oneof': [
{'type': 'callable'},
{'type': 'list',
'schema': {'oneof': [{'type': 'callable'},
{'type': 'string'}]}},
{'type': 'string'}
]} r� N)r> r r� r �_validate_validatorrR )r r� r r r� r r r r� � s
z Validator._validate_validatorc
s� | d f } t | t � r� | j d | d | d t � f d d � | D� � � } | | d | j d d �| j r� | j | j g d
g � | j | t j | j � d S) zq {'type': ['dict', 'string'], 'validator': 'bulk_schema',
'forbidden': ['rename', 'rename_handler']} r� r_ r` r) c 3 s | ] } | � f Vq d S)Nr )r� r� )r) r r r� � s z2Validator._validate_valueschema.<locals>.<genexpr>r5 r� FrN N)
r> r ra r� r5 r- ri rR r Z VALUESCHEMA)r r) r r r` r� r )r) r �_validate_valueschema� s " z Validator._validate_valueschema)�nullable)r zreadonlyztype)dr! r" r# r r� r� r� rI r< r6 r8 � classmethodrL rR ra r� ri rs rV rt �propertyr* r� r rA rY rv rB rZ r[ r r\ r) r rz r~ r{ r� r� r� r� r� r� r� � staticmethodr� r r� r� r� r� r� r� r� �__call__r� r� r� r Z_validate_allow_unknownr� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� Z_validate_requiredr� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r r r r r% 3 s� ' * J. +
r% z7The rule's arguments are validated against this schema:c sF e Z d Z d Z � f d d � Z � f d d � Z d d � Z � S)�InspectedValidatorz Metaclass for all validators c sK d | d k r2 | d j d | d d j i � t t | � j | | � S)Nr rN rM r )r5 r �superr �__new__)rK r: )r^ r r r � s "zInspectedValidator.__new__c s� � f d d � } t t � � j | � f i � _ � _ xb | d � D]T } | j d � r� � j | t d � d � f 7_ qH � j d | � � j | <qH W� j � j d d <t d d � | d
� D� � � _ � j d
d } � j | d d
d d d <| d d <x/ d d � � j
D� D] } d � j | d <q'Wf f i � _ � _ � _
x� | d � D]� } | j d � r�� j | t d � d � f 7_ ql| j d � r�� j | t d � d � f 7_ ql� j d | � � j
| <qlWxH d D]@ } � j
| d } � j | d d
d d d <| d d <q�W� j � j
d d d d <i � _ � j j � j � � j j � j
� d S)Nc s# t � f d d � t � � D� � S)Nc 3 s8 | ]. } | j d � � r | j d d � d Vq d S)rc rN rM Nrl )rm rn )r� r� )�prefixr r r� s zNInspectedValidator.__init__.<locals>.attributes_with_prefix.<locals>.<genexpr>)r? �dir)r )rK )r r �attributes_with_prefix s z;InspectedValidator.__init__.<locals>.attributes_with_prefixr� Ztype_Z
_validate_r( Zallowedc s s | ] } | Vq d S)Nr )r� r� r r r r� s z.InspectedValidator.__init__.<locals>.<genexpr>r� r� rM r) rN c s s! | ] } | d k r | Vq d S)r& Nr )r� r� r r r r� s Tr� r� Zcoerce_Zdefault_setter_Z _normalize_r� r� r� )zcoercezrename_handler)r r r< r� Zvalidation_rulesrm rD �$_InspectedValidator__get_rule_schemar? Z
validatorsr� ZcoercersZdefault_settersr� r� r5 )rK r: r
Z attributer� rT )r^ )rK r r< s6 % ") %%
- zInspectedValidator.__init__c
C s� t | | � j } | d k r' i } nP t | k rF | j t � d } y t | j � � } Wn t k
rv i } Yn X| s� t d | j d d � d � | S)NrM z>No validation schema is defined for the arguments of rule '%s'rc rN rl )rf r �RULE_SCHEMA_SEPARATORrn r �stripr� r )rK Z method_nameZ docstringr� r r r Z__get_rule_schema, s
z$InspectedValidator.__get_rule_schema)r! r" r# r r r< r r r )r^ r r � s ,r )(r Z
__future__r Zastr � collectionsr r r r r r
r r� �warningsr Zcerberusr Zcerberus.platformr
r Zcerberus.schemar r r r Zcerberus.utilsr r ZToyErrorHandlerr] r r� r r$ �objectr% r r( r r r r r �<module> s. " "
� � � � �F