LXK @ s d Z d d l m Z d d l m Z m Z m Z d d l m Z m Z d d l m
Z
d d l m Z d d l
m Z d d l m Z m Z e d d
Z e d d Z e d d Z d
Z e d d Z e d d Z e d d Z e d d Z e d d Z e d d Z d Z e d d Z e d d Z e d d Z e d d Z e d d! Z e d" d# Z e d$ d% Z! e d& d' Z" e d( d) Z# e d* d+ Z$ e d, d- Z% e d. d- Z& e d/ d0 Z' e d1 d0 Z( e d2 d Z) e d3 d4 Z* e d5 d6 Z+ e d7 d8 Z, e d9 d: Z- e d; d Z. e d< d Z/ e d= d Z0 e d> d? Z1 e d@ dA Z2 e dB d! Z3 e dC d Z4 e dD dE Z5 e dF dG Z6 e dH dI Z7 e dJ dK Z8 dL Z9 dM Z: GdN dO dO e; Z< GdP dQ dQ e= Z> GdR dS dS e Z? GdT dU dU e? Z@ GdV dW dW e@ ZA GdX dY dY e@ ZB GdZ d[ d[ e; ZC Gd\ d] d] eC ZD d^ d_ ZE Gd` da da eC ZF Gdb dc dc eF ZG d S)dz? This module contains the error-related constants and classes. )absolute_import) defaultdict
namedtupleMutableMapping)copydeepcopy)wraps)pformat)PYTHON_VERSION)compare_paths_lt quote_stringZcerberus_errorz
code, ruleN zdocument is missing Zrequired Z dependencies Zexcludes! z''{0}' is not a document, must be a dict" empty# Znullable$ type% schema& items' Z minlength( maxlengthA regexB minC maxD ZallowedE F Z forbiddenG ` a Zcoerceb Zrename_handlerc readonlyd Zdefault_setter Z keyschema Z valueschema Znoneof Zoneof Zanyof Zallofz0schema definition for field '{0}' must be a dictzvalidation schema missingc @ s e Z d Z d Z d d Z d d Z d d Z d d Z d
d Z e d d
Z
e d d Z e d d Z e d d Z
e d d Z e d d Z d S)ValidationErrorz< A simple class to store and query basic error information. c C sC | | _ | | _ | | _ | | _ | | _ | | _ | | _ d S)N)
document_path schema_pathcoderule
constraintvalueinfo)selfr< r= r> r? r@ rA rB rD
/errors.py__init__^ s zValidationError.__init__c C s t | t | k S)z< Assumes the errors relate to the same document and schema. )hash)rC otherrD rD rE __eq__r s zValidationError.__eq__c C s' t | j t | j At | j AS)z@ Expects that all other properties are transitively determined. )rG r< r= r> )rC rD rD rE __hash__v s zValidationError.__hash__c C s< | j | j k r% t | j | j St | j | j Sd S)N)r< r r= )rC rH rD rD rE __lt__{ s zValidationError.__lt__c C sp d j d | j j d t t | d | j d | j d t | j d t | j d t | j
d | j S)
Nz{class_name} @ {memptr} ( document_path={document_path},schema_path={schema_path},code={code},constraint={constraint},value={value},info={info} )
class_nameZmemptrr< r= r> r@ rA rB ) format __class____name__hexidr< r= r> r r@ rA rB )rC rD rD rE __repr__ s zValidationError.__repr__c C s | j r | j d Sd S)zX
A list that contains the individual errors of a bulk validation error.
r N)is_group_errorrB )rC rD rD rE child_errors s z ValidationError.child_errorsc C sX | j s
d St t } x8 | j D]- } | j t | j } | | j | q# W| S)z Dictionary with errors of an *of-rule mapped to the index of the
definition it occurred in. Returns :obj:`None` if not applicable.
N)is_logic_errorr listrT r= lenappend)rC resulterrorirD rD rE definitions_errors s z"ValidationError.definitions_errorsc C s | j r | j d Sd Sd S)z8 Field of the contextual mapping, possibly :obj:`None`. r
N)r< )rC rD rD rE field s zValidationError.fieldc C s t | j t j @ S)z* ``True`` for errors of bulk validations. )boolr> ERROR_GROUP)rC rD rD rE rS s z ValidationError.is_group_errorc C s t | j t j t j @ S)zV ``True`` for validation errors against different schemas with
*of-rules. )r_ r> LOGICALr` )rC rD rD rE rU s z ValidationError.is_logic_errorc C s t | j t j @ S)z$ ``True`` for normalization errors. )r_ r>
NORMALIZATION)rC rD rD rE is_normalization_error s z&ValidationError.is_normalization_errorN)rO
__module__ __qualname____doc__rF rI rJ rK rR propertyrT r\ r^ rS rU rc rD rD rD rE r; \ s r; c @ s" e Z d Z d Z d d Z d S) ErrorListz A list for :class:`~cerberus.errrors.ValidationError` instances that
can be queried with the ``in`` keyword for a particular error code. c C s5 x. d d | D D] } | | j k r d Sq Wd S)Nc s s | ] } | j Vq d S)N)r> ).0xrD rD rE <genexpr> s z)ErrorList.__contains__.<locals>.<genexpr>TF)r> )rC Zerror_definitionr> rD rD rE __contains__ s zErrorList.__contains__N)rO rd re rf rl rD rD rD rE rh s rh c @ s e Z d Z d Z d d Z d d Z d
d Z d d
Z d d Z d d Z d d Z
d d Z e d d Z
e d d Z d d Z d d Z d S)
ErrorTreeNode descendantserrors parent_nodepath tree_rootc C sN | | _ | j j | _ | d | j j d | _ t | _ i | _ d S)Nr
)rp rr depthrq rh ro rn )rC rq rp rD rD rE rF s
zErrorTreeNode.__init__c C s | j | | S)N)add)rC rZ rD rD rE __add__ s
zErrorTreeNode.__add__c C s | j | =d S)N)rn )rC keyrD rD rE __delitem__ s zErrorTreeNode.__delitem__c C s
t | j S)N)iterro )rC rD rD rE __iter__ s zErrorTreeNode.__iter__c C s | j j | S)N)rn get)rC itemrD rD rE __getitem__ s zErrorTreeNode.__getitem__c C s
t | j S)N)rW ro )rC rD rD rE __len__ s zErrorTreeNode.__len__c C s | | j | <d S)N)rn )rC rv rA rD rD rE __setitem__ s zErrorTreeNode.__setitem__c C s t | j d t | j S)N,)strro rn )rC rD rD rE __str__ s zErrorTreeNode.__str__c C s
t | j S)N)rW rq )rC rD rD rE rs s zErrorTreeNode.depthc C s
| j j S)N)rr tree_type)rC rD rD rE r s zErrorTreeNode.tree_typec C s | j | } | | j } | | j k r> t | | | | <t | | j d k r | | j j | | | j j | j r x1 | j D] } | j
| 7_
q Wn | | | 7<d S)Nr
) _path_of_rs rn rm rW ro rX sortrS rT rr )rC rZ Z
error_pathrv child_errorrD rD rE rt s
zErrorTreeNode.addc C s t | | j d S)N_path)getattrr )rC rZ rD rD rE r s zErrorTreeNode._path_of_N)z descendantszerrorsz parent_nodezpathz tree_root)rO rd re __slots__rF ru rw ry r| r} r~ r rg rs r rt r rD rD rD rE rm s rm c sO e Z d Z d Z g d d Z f d d Z d d Z d d Z S)
ErrorTreezs Base class for :class:`~cerberus.errors.DocumentErrorTree` and
:class:`~cerberus.errors.SchemaErrorTree`. c C sO d | _ | | _ f | _ t | _ i | _ x | D] } | | 7} q7 Wd S)N)rp rr rq rh ro rn )rC ro rZ rD rD rE rF s
zErrorTree.__init__c sI | j | s/ | j j | | j j n t t | j | d S)zd Add an error to the tree.
:param error: :class:`~cerberus.errors.ValidationError`
N)r ro rX r superr rt )rC rZ )rN rD rE rt s z
ErrorTree.addc C s- | j | } | d k r" | j St Sd S)z Returns all errors for a particular path.
:param path: :class:`tuple` of :term:`hashable` s.
:rtype: :class:`~cerberus.errors.ErrorList`
N)fetch_node_fromro rh )rC rq noderD rD rE fetch_errors_from s zErrorTree.fetch_errors_fromc C s2 | } x% | D] } | | } | d k r
Pq
W| S)z Returns a node for a path.
:param path: Tuple of :term:`hashable` s.
:rtype: :class:`~cerberus.errors.ErrorTreeNode` or :obj:`None`
NrD )rC rq contextrv rD rD rE r ( s
zErrorTree.fetch_node_from)rO rd re rf rF rt r r rD rD )rN rE r s
r c @ s e Z d Z d Z d Z d S)DocumentErrorTreezr Implements a dict-like class to query errors by indexes following the
structure of a validated document. ZdocumentN)rO rd re rf r rD rD rD rE r 6 s r c @ s e Z d Z d Z d Z d S)SchemaErrorTreezm Implements a dict-like class to query errors by indexes following the
structure of the used schema. r N)rO rd re rf r rD rD rD rE r < s r c @ sv e Z d Z d Z d d Z d d Z d d Z d d Z d
d Z d d
Z d d Z
d d Z d S)BaseErrorHandlerzo Base class for all error handlers.
Subclasses are identified as error-handlers with an instance-test. c O s d S)z' Optionally initialize a new instance. NrD )rC argskwargsrD rD rE rF E s zBaseErrorHandler.__init__c C s
t d S)a$ Returns errors in a handler-specific format.
:param errors: An object containing the errors.
:type errors: :term:`iterable` of
:class:`~cerberus.errors.ValidationError` instances or a
:class:`~cerberus.Validator` instance
N)NotImplementedError)rC ro rD rD rE __call__I s zBaseErrorHandler.__call__c C s
t d S)z7 Be a superhero and implement an iterator over errors. N)r )rC rD rD rE ry S s zBaseErrorHandler.__iter__c C s
t d S)z Add an error to the errors' container object of a handler.
:param error: The error to add.
:type error: :class:`~cerberus.errors.ValidationError`
N)r )rC rZ rD rD rE rt W s zBaseErrorHandler.addc C s d S)z Optionally emits an error in the handler's format to a stream.
Or light a LED, or even shut down a power plant.
:param error: The error to emit.
:type error: :class:`~cerberus.errors.ValidationError`
NrD )rC rZ rD rD rE emit_ s zBaseErrorHandler.emitc C s d S)z Gets called when a validation ends.
:param validator: The calling validator.
:type validator: :class:`~cerberus.Validator` NrD )rC validatorrD rD rE endh s zBaseErrorHandler.endc C s" x | D] } | j | q Wd S)z Adds all errors to the handler's container object.
:param errors: The errors to add.
:type errors: :term:`iterable` of
:class:`~cerberus.errors.ValidationError` instances
N)rt )rC ro rZ rD rD rE extendo s
zBaseErrorHandler.extendc C s d S)z Gets called when a validation starts.
:param validator: The calling validator.
:type validator: :class:`~cerberus.Validator`
NrD )rC r rD rD rE starty s zBaseErrorHandler.startN) rO rd re rf rF r ry rt r r r r rD rD rD rE r B s
r c @ s( e Z d Z d d Z d d Z d S)ToyErrorHandlerc O s t d d S)Nz This is not supposed to happen.) RuntimeError)rC r r rD rD rE r s zToyErrorHandler.__call__c C s d S)NrD )rC rD rD rE clear s zToyErrorHandler.clearN)rO rd re r r rD rD rD rE r s r c s2 t f d d } t d k r. | S S)zCerberus error messages expect regular binary strings.
If unicode is used in a ValidationError message can't be printed.
This decorator ensures that if legacy Python is used unicode
strings are encoded before passing to a function.
c s d d } t | } | | j | _ | | j | _ | | j | _ | | j | _ | | j | _ | | S)Nc S s t | t r | j d S| S)z1Helper encoding unicode strings into binary utf-8zutf-8)
isinstanceunicodeencode)rA rD rD rE _encode s
z0encode_unicode.<locals>.wrapped.<locals>._encode)r r< r= r@ rA rB )objrZ r )frD rE wrapped s z encode_unicode.<locals>.wrappedr )r r
)r r rD )r rE encode_unicode s r c F @ s e Z d Z d Z d d d d d d d d d
d d d
d d d d d d d d d d d d d d d d d d d d! d" d# d$ d% d& d' d( d) d* d' d+ d) d, d- d. d/ d0 d1 d2 d3 d4 d5 d6 d7 d8 d9 d: d; d< d7 d= d> d? d@ dA dB dC dD i# Z dE dF dG Z dE dH dI Z dJ dK Z e dL dM Z dN dO Z
dP dQ Z dR dS Z dT dU Z
dV dW Z e dX dY Z dZ d[ Z d\ d] Z dE S)^BasicErrorHandlerz3 Models cerberus' legacy. Returns a :class:`dict`. r z{0}r
zdocument is missingr zrequired fieldr z
unknown fieldr zfield '{0}' is requiredr z%depends on these values: {constraint}r z&{0} must not be present with '{field}'r z''{0}' is not a document, must be a dictr zempty values not allowedr znull value not allowedr z must be of {constraint} typer zmust be of dict typer z0length of list should be {constraint}, it is {0}r zmin length is {constraint}r zmax length is {constraint}r z)value does not match regex '{constraint}'r" zmin value is {constraint}r$ zmax value is {constraint}r& zunallowed value {value}r' zunallowed values {0}r( r) r+ z&field '{field}' cannot be coerced: {0}r, z&field '{field}' cannot be renamed: {0}r- zfield is read-onlyr/ z.default value for '{field}' cannot be set: {0}r1 z'mapping doesn't validate subschema: {0}r2 z.one or more sequence-items don't validate: {0}r3 z2one or more keys of a mapping don't validate: {0}r4 z3one or more values in a mapping don't validate: {0} r7 z one or more definitions validater8 z#none or more than one rule validater9 zno definitions validater: z&one or more definitions don't validateNc C s | d k r i n | | _ d S)N)tree)rC r rD rD rE rF s zBasicErrorHandler.__init__c C s* | d k r# | j | j | | j S)N)r r pretty_tree)rC ro rD rD rE r s
zBasicErrorHandler.__call__c C s
t | j S)N)r r )rC rD rD rE r s zBasicErrorHandler.__str__c C sj | j r | j | nM | j r2 | j | n4 | j | j k rf | j | j | j | j | d S)N)
rU insert_logic_errorrS insert_group_errorr> messages insert_errorr< format_messager^ )rC rZ rD rD rE rt s zBasicErrorHandler.addc C s
i | _ d S)N)r )rC rD rD rE r s zBasicErrorHandler.clearc C s2 | j | j j | j d | j d | d | j S)Nr@ r^ rA )r r> rM rB r@ rA )rC r^ rZ rD rD rE r s z BasicErrorHandler.format_messagec C s | d } t | d k rn | | j k rX | j | j } | j | | | g 7<q| i g | j | <n t | d k r| | j k r i g | j | <| j | d } | r | j d t | } n | j } | j | d d | | j | j d S)z Adds an error or sub-tree to :attr:tree.
:param path: Path to the error.
:type path: Tuple of strings and integers.
:param node: An error message or a sub-tree.
:type node: String or dictionary.
r r
r Nr] )rW r poprN r r update)rC rq r r^ subtreenewrD rD rE r s
z BasicErrorHandler.insert_errorc C sl xe | j D]Z } | j r) | j | q
| j rB | j | q
| j | j | j | j | q
Wd S)N) rT rU r rS r r r< r r^ )rC rZ rD rD rE r s z$BasicErrorHandler.insert_group_errorc C s | j | j f } | j } | j | | j | | x | j D] } | j | } | s^ qB d | j | f } xU | D]M } | j r t qx | j r t qx | j | | f | j | | qx WqB Wd S)Nz%s definition %s) r< r? r^ r r r\ rU r rS )rC rZ rq r^ r[ rT nodenamer rD rD rE r s
z$BasicErrorHandler.insert_logic_errorc C s5 t | j } x | D] } | j | | q W| S)N)r r _purge_empty_dicts)rC Zprettyr^ rD rD rE r * s
z BasicErrorHandler.pretty_treec C sG | d } | d s! | j n" x | D] } | j | | q( Wd S)Nr
r] r] )r r )rC Z
error_listr rv rD rD rE r 1 s
z$BasicErrorHandler._purge_empty_dictsc C s | j d S)N)r )rC r rD rD rE r 9 s zBasicErrorHandler.start)rO rd re rf r rF r r r rt r r r r r rg r r r rD rD rD rE r s`
r c @ s) e Z d Z e j j Z d e d <d S)SchemaErrorHandlerz unknown ruler N)rO rd re r r r rD rD rD rE r = s r )Hrf Z
__future__r collectionsr r r r r functoolsr pprintr Zcerberus.platformr
Zcerberus.utilsr r ZErrorDefinitionZCUSTOMZDOCUMENT_MISSINGZREQUIRED_FIELDZ
UNKNOWN_FIELDZDEPENDENCIES_FIELDZDEPENDENCIES_FIELD_VALUEZEXCLUDES_FIELDZDOCUMENT_FORMATZEMPTY_NOT_ALLOWEDZ NOT_NULLABLEZBAD_TYPEZBAD_TYPE_FOR_SCHEMAZ ITEMS_LENGTHZ
MIN_LENGTHZ
MAX_LENGTHZREGEX_MISMATCHZ MIN_VALUEZ MAX_VALUEZUNALLOWED_VALUEZUNALLOWED_VALUESZFORBIDDEN_VALUEZFORBIDDEN_VALUESrb ZCOERCION_FAILEDZRENAMING_FAILEDZREADONLY_FIELDZSETTING_DEFAULT_FAILEDr` ZMAPPING_SCHEMAZSEQUENCE_SCHEMAZ KEYSCHEMAZ VALUESCHEMAZ BAD_ITEMSra ZNONEOFZONEOFZANYOFZALLOFZ SCHEMA_ERROR_DEFINITION_TYPEZSCHEMA_ERROR_MISSINGobjectr; rV rh rm r r r r r r r r rD rD rD rE <module> sz
c
<1@