B
pSer # @ s d Z ddlmZ ddlmZ ddlZddlZddlZddlm Z ddl
m Z m Z m
Z
mZmZ ddlmZmZmZmZmZmZmZmZmZmZ ddlm Z e G d d
d
e Z i Z e
Z!d/d d
Z"e#e$ee%dej&e'edZ(e j)e"e(dZ*dd Z+dd Z,G dd de%Z-dd Z.d ddde.fddZ/d0ddZ0e/e
1d ej2ej3ej4e j5e j6ej7ej8e j9ej:e j;ejej?ej@e jAejBejCe jDe jEejFd e jGd d d d ZHe/e
1d!ej2ej3ej4ejIejJejKej8ej:e j;ejej?ej@ejMe jAej7ejNejOejBejCejPejQej%ejFd"e jRd!d#d d ZSe/e
1d$ej2ej3ej4ejIejJejTejUejKej8ejVejWej:ejXej.gen_type_check..type_check)r flatten)r! r" r )r! r gen_type_checkI s
z4_generate_legacy_type_checks..gen_type_check)dictr )typesr$ definitionstypenamer! r r r _generate_legacy_type_checks9 s r) )arrayZbooleanintegernullnumberobjectstring)
type_checkersc s fdd}|S )a
Register the decorated validator for a ``version`` of the specification.
Registered validators and their meta schemas will be considered when
parsing ``$schema`` properties' URIs.
Arguments:
version (str):
An identifier to use as the version's name
Returns:
collections.Callable:
a class decorator to decorate the validator with the version
c s$ | t < | | j}|r | t|< | S )N)
validatorsID_OF META_SCHEMA meta_schemas)clsZmeta_schema_id)versionr r
_validates} s
z validates.._validatesr )r6 r7 r )r6 r validatesi s r8 c C s$ | j d krt tdtdd | jS )NzcThe DEFAULT_TYPES attribute is deprecated. See the type checker attached to this validator instead. )
stacklevel)_CREATED_WITH_DEFAULT_TYPESr r DeprecationWarning_DEFAULT_TYPES)r r r r r= s
r= c @ s e Zd ZeeZdS )!_DefaultTypesDeprecatingMetaClassN)r r r propertyr=
DEFAULT_TYPESr r r r r> s r> c C s | dks| dkrdS | ddS )NTF z$id)get)schemar r r _id_of s rD c s dk r<dk rt dd tdtdd tjtdn(tdkrRd tntkr`d nd tt G fd d
d
t
}|dk rt ||}|
d d d
|_|S )
a
Create a new validator class.
Arguments:
meta_schema (collections.Mapping):
the meta schema for the new validator class
validators (collections.Mapping):
a mapping from names to callables, where each callable will
validate the schema property with the given name.
Each callable should take 4 arguments:
1. a validator instance,
2. the value of the property being validated within the
instance
3. the instance
4. the schema
version (str):
an identifier for the version that this validator class will
validate. If provided, the returned validator class will
have its ``__name__`` set to include the version, and also
will have `jsonschema.validators.validates` automatically
called for the given version.
type_checker (jsonschema.TypeChecker):
a type checker, used when applying the :validator:`type` validator.
If unprovided, a `jsonschema.TypeChecker` will be created
with a set of default types typical of JSON Schema drafts.
default_types (collections.Mapping):
.. deprecated:: 3.0.0
Please use the type_checker argument instead.
If set, it provides mappings of JSON types to Python types
that will be converted to functions and redefined in this
object's `jsonschema.TypeChecker`.
id_of (collections.Callable):
A function that given a schema, returns its ID.
Returns:
a new `jsonschema.IValidator` class
Nz;Do not specify default_types when providing a type checker.TzPThe default_types argument is deprecated. Use the type_checker argument instead.r9 )r: )r0 Fc s e Zd ZeZeZZeZe e
Z eZ
Z dfdd Z
edd Zdfdd Zdd d
Zd d Zd
d ZdddZdS )zcreate..Validatorr Nc sP |r$t dtdd | jt|| _|d kr:tj| d}|| _|| _|| _ d S )NzaThe types argument is deprecated. Provide a type_checker to jsonschema.validators.extend instead.r9 )r: )id_of)
r r< TYPE_CHECKERZ
redefine_manyr) RefResolver from_schemaresolverformat_checkerrC )r rC r& rI rJ )rE r r __init__ s z"create..Validator.__init__c S s* x$| | j |D ]}tj|qW d S )N)r3 iter_errorsr Z SchemaErrorZ create_from)r5 rC errorr r r check_schema# s z&create..Validator.check_schemac 3 s |d kr| j }|dkrd S |dkrBtjd|f d d ||dV d S |}|rZ| j| z|d}|d k rzd|fg}nt|}xr|D ]j\}}| j|}|d krq|| |||pd} x8| D ]0}
|
j||||d |dkr|
j
| |
V qW qW W d |r
| j X d S )NTFz False schema does not allow %r) validatorZvalidator_valuer rC z$refr ) rC r ZValidationErrorrI
push_scoperB r
VALIDATORSZ_set schema_path
appendleft pop_scope) r r _schemascoperefr1 kvrO errorsrM )rE r r rL ( sH
z%create..Validator.iter_errorsc s sH xB| ||D ]2}|d k r&|j| |d k r:|j| |V qW d S )N)rL pathrS rR )r r rC r[ rR rM r r r descendW s z!create..Validator.descendc _ s x| j ||D ]}|qW d S )N)rL )r argskwargsrM r r r validate_ s z"create..Validator.validatec S s: y| j ||S tjk
r4 t||| jY nX d S )N)rF is_typer ZUndefinedTypeCheckZ UnknownTyperC )r r typer r r r` c s z!create..Validator.is_typec S s t | ||d }|d kS )N)nextrL )r r rU rM r r r is_validi s z"create..Validator.is_valid)r NN)N)NN)N)r r r r% rQ r3 rF staticmethodr2 r? r= r@ r; rK classmethodrN rL r\ r_ r` rc r )_created_with_default_types
default_typesrE meta_schema type_checkerr1 r r Validator s /
rj rA ) TypeErrorr r< r TypeCheckerr) _DEPRECATED_DEFAULT_TYPES*_TYPE_CHECKER_FOR_DEPRECATED_DEFAULT_TYPESr r> r. r8 titlereplacer )rh r1 r6 rg ri rE rj r )rf rg rE rh ri r1 r create s0 @ r rr c C sH t | j}|| |dkr$| j}n| jr2tdt| j|||| jdS )a
Create a new validator class by extending an existing one.
Arguments:
validator (jsonschema.IValidator):
an existing validator class
validators (collections.Mapping):
a mapping of new validator callables to extend with, whose
structure is as in `create`.
.. note::
Any validator callables with the same name as an
existing one will (silently) replace the old validator
callable entirely, effectively overriding any validation
done in the "parent" validator class.
If you wish to instead extend the behavior of a parent's
validator callable, delegate and call it directly in
the new validator function by retrieving it using
``OldValidator.VALIDATORS["validator_name"]``.
version (str):
a version for the new validator class
type_checker (jsonschema.TypeChecker):
a type checker, used when applying the :validator:`type` validator.
If unprovided, the type checker of the extended
`jsonschema.IValidator` will be carried along.`
Returns:
a new `jsonschema.IValidator` class extending the one provided
.. note:: Meta Schemas
The new validator class will have its parent's meta schema.
If you wish to change or extend the meta schema in the new
validator class, modify ``META_SCHEMA`` directly on the returned
class. Note that no implicit copying is done, so a copy should
likely be made before modifying it, in order to not affect the
old validator.
NzCannot extend a validator created with default_types with a type_checker. Update the validator to use a type_checker when created.)rh r1 r6 ri rE ) r% rQ updaterF r; rl rr r3 r2 )rO r1 r6 ri Zall_validatorsr r r extendt s 5
rt Zdraft3)z$refadditionalItemsadditionalProperties dependenciesZdisallowZ divisibleByenumZextendsformatitemsmaxItems maxLengthmaximumminItems minLengthminimumpatternpatternProperties
propertiesra uniqueItemsc C s | ddS )NidrA )rB )rC r r r r )rh r1 ri r6 rE Zdraft4)z$refru rv allOfanyOfrw rx ry rz r{ r|
maxPropertiesr} r~ r
minPropertiesr
multipleOfnotoneOfr r r requiredra r c C s | ddS )Nr rA )rB )rC r r r r r Zdraft6) z$refru rv r r constcontainsrw rx exclusiveMaximumexclusiveMinimumry rz r{ r| r r} r~ r r r r r r r r r
propertyNamesr ra r )rh r1 ri r6 Zdraft7) z$refru rv r r r r rw rx r r ry ifrz r{ r| r r} r~ r r r r r r r r r r r ra r c @ s e Zd ZdZd ddZeefddZd d
Zd d Z e
d
d Z e
dd Z e
jdd Ze
jdd Zdd Zdd Zdd Zdd ZdS ) rG a
Resolve JSON References.
Arguments:
base_uri (str):
The URI of the referring document
referrer:
The actual referring document
store (dict):
A mapping from URIs to documents to cache
cache_remote (bool):
Whether remote refs should be cached after first resolution
handlers (dict):
A mapping from URI schemes to functions that should be used
to retrieve them
urljoin_cache (:func:`functools.lru_cache`):
A cache that will be used for caching the results of joining
the resolution scope to subscopes.
remote_cache (:func:`functools.lru_cache`):
A cache that will be used for caching the results of
resolved remote URLs.
Attributes:
cache_remote (bool):
Whether remote refs should be cached after first resolution
r TNc C s |d krt dt}|d kr*t d| j}|| _|| _t|| _|g| _t dd t
t D | _ | j
| || j |< || _|| _d S )Ni c s s | ]\}}||j fV qd S )N)r3 ).0r rO r r r s z'RefResolver.__init__..)r
r resolve_from_urlreferrer cache_remoter% handlers
_scopes_stackr URIDictr r4 storers _urljoin_cache
_remote_cache)r base_urir r r r Z
urljoin_cacheZ remote_cacher r r rK | s
zRefResolver.__init__c O s | ||||d|S )z
Construct a resolver from a JSON schema object.
Arguments:
schema:
the referring schema
Returns:
`RefResolver`
)r r r )r5 rC rE r] r^ r r r rH s zRefResolver.from_schemac C s | j | | j| dS )z
Enter a given sub-scope.
Treats further dereferences as being performed underneath the
given scope.
N)r appendr resolution_scope)r rV r r r rP s zRefResolver.push_scopec C s2 y| j W n tk
r, tdY nX dS )z
Exit the most recent entered scope.
Treats further dereferences as being performed underneath the
original scope.
Don't call this method more times than `push_scope` has been
called.
znFailed to pop the scope from an empty stack. `pop_scope()` should only be called once for every `push_scope()`N)r pop
IndexErrorr RefResolutionError)r r r r rT s
zRefResolver.pop_scopec C s
| j d S )z8
Retrieve the current resolution scope.
)r )r r r r r s z RefResolver.resolution_scopec C s t | j\}}|S )zL
Retrieve the current base URI, not including any fragment.
)r r )r uri_r r r r s zRefResolver.base_uric c s$ | | z
dV W d| X dS )zT
Temporarily enter the given scope for the duration of the context.
N)rP rT )r rV r r r in_scope s
zRefResolver.in_scopec c s2 | |\}}| | z
|V W d| X dS )z
Resolve the given ``ref`` and enter its resolution scope.
Exits the scope on exit of this context manager.
Arguments:
ref (str):
The reference to resolve
N)resolverP rT )r rW urlZresolvedr r r resolving s
zRefResolver.resolvingc C s | | j|}|| |fS )z.
Resolve the given reference.
)r r r )r rW r r r r r s zRefResolver.resolvec
C sx t |\}}y| j| }W nP tk
rj y| |}W n, tk
rd } zt|W dd}~X Y nX Y nX | ||S )z/
Resolve the given remote URL.
N)r r KeyErrorresolve_remote Exceptionr r resolve_fragment)r r fragmentdocumentexcr r r r s "z RefResolver.resolve_from_urlc
C s | d}|r t|dng }x|D ]x}|dddd}t|trjy t|}W n tk
rh Y nX y || }W q& tt fk
r t
d| Y q&X q&W |S )z
Resolve a ``fragment`` within the referenced ``document``.
Arguments:
document:
The referent document
fragment (str):
a URI fragment to resolve within it
/z~1z~0~z Unresolvable JSON pointer: %r) lstripr splitrq r r
int
ValueErrorrl LookupErrorr r )r r r partspartr r r r s
z RefResolver.resolve_fragmentc C s y ddl }W n tk
r$ d}Y nX t|j}|| jkrJ| j| |}nD|dkrf|rf|| }n(t|}t|
d}W dQ R X | j r|| j |< |S )a
Resolve a remote ``uri``.
If called directly, does not check the store first, but after
retrieving the document at the specified URI it will be saved in
the store if :attr:`cache_remote` is True.
.. note::
If the requests_ library is present, ``jsonschema`` will use it to
request the remote ``uri``, so that the correct encoding is
detected and used.
If it isn't, or if the scheme of the ``uri`` is not ``http`` or
``https``, UTF-8 is assumed.
Arguments:
uri (str):
The URI to resolve
Returns:
The retrieved document
.. _requests: https://pypi.org/project/requests/
r N)httphttpszutf-8)
requests ImportErrorr schemer rB jsonr loadsreaddecoder r )r r r r resultr r r r r 3 s
zRefResolver.resolve_remote)r Tr NN)r r r r rK re rD rH rP rT r? r r
contextlibcontextmanagerr r r r r r r r r r rG P s$ *
$rG c O sJ |dkrt |}|| ||f||}t|| }|dk rF|dS )a
Validate an instance under the given schema.
>>> validate([2, 3, 4], {"maxItems": 2})
Traceback (most recent call last):
...
ValidationError: [2, 3, 4] is too long
:func:`validate` will first verify that the provided schema is
itself valid, since not doing so can lead to less obvious error
messages and fail in less obvious or consistent ways.
If you know you have a valid schema already, especially if you
intend to validate multiple instances with the same schema, you
likely would prefer using the `IValidator.validate` method directly
on a specific validator (e.g. ``Draft7Validator.validate``).
Arguments:
instance:
The instance to validate
schema:
The schema to validate with
cls (IValidator):
The class that will be used to validate the instance.
If the ``cls`` argument is not provided, two things will happen
in accordance with the specification. First, if the schema has a
:validator:`$schema` property containing a known meta-schema [#]_
then the proper validator will be used. The specification recommends
that all schemas contain :validator:`$schema` properties for this
reason. If no :validator:`$schema` property is found, the default
validator class is the latest released draft.
Any other provided positional and keyword arguments will be passed
on when instantiating the ``cls``.
Raises:
`jsonschema.exceptions.ValidationError` if the instance
is invalid
`jsonschema.exceptions.SchemaError` if the schema itself
is invalid
.. rubric:: Footnotes
.. [#] known by a validator registered with
`jsonschema.validators.validates`
N)
validator_forrN r
best_matchrL )r rC r5 r] r^ rO rM r r r r_ g s 8
r_ c C sF | dks| dksd| kr |S | d t kr6tdtdd t | d tS )a
Retrieve the validator class appropriate for validating the given schema.
Uses the :validator:`$schema` property that should be present in the
given schema to look up the appropriate validator class.
Arguments:
schema (collections.Mapping or bool):
the schema to look at
default:
the default to return if the appropriate validator class
cannot be determined.
If unprovided, the default is to return the latest supported
draft.
TFz$schemazThe metaschema specified by $schema was not found. Using the latest draft to validate, but this will raise an error in the future.r9 )r: )r4 r r< rB _LATEST_VERSION)rC defaultr r r r s r )r )r NN)N)fr
__future__r warningsr r r numbersZsixr Z
jsonschemar r r r r Zjsonschema.compatr
r r r
r r r r r r Zjsonschema.exceptionsr r r r1 r r4 r) listr ra Numberr% rn rm ro r8 r= r> rD rr rt Z load_schemarW ru rv Zdependencies_draft3Zdisallow_draft3r rx Zextends_draft3ry Zitems_draft3_draft4r{ r| Zmaximum_draft3_draft4r~ r Zminimum_draft3_draft4r r Zproperties_draft3Z type_draft3r Zdraft3_type_checkerZDraft3Validatorr r rw r r not_r r r Zdraft4_type_checkerZDraft4Validatorr r r r rz r} r r Zdraft6_type_checkerZDraft6ValidatorZif_Zdraft7_type_checkerZDraft7Validatorr r. rG r_ r r r r r sP 0
# P
I
B