Arguments.

This commit is contained in:
Julian Berman
2013-05-20 18:55:00 -04:00
parent 252fbedbd0
commit 7b3eec84cd
2 changed files with 15 additions and 4 deletions

View File

@@ -10,6 +10,19 @@ Creating or Extending Validators
Create a new validator.
:argument dict meta_schema: the meta schema for the new validator
:argument dict validators: a mapping from validator names to functions that
validate the given name. Each function should take 4 arguments: a
validator instance, the value of the current validator property in the
instance being validated, the instance, and the schema.
:argument str version: an identifier for the version that this validator
will validate. If provided, the returned validator class will have its
``__name__`` set to include the version, and also will have
:func:`validates` automatically called for the given version.
:argument dict default_types: a default mapping to use for instances of the
validator when mapping between JSON types to Python types. The default
for this argument is probably fine. Instances of the returned validator
can still have their types customized on a per-instance basis.
:returns: an :class:`jsonschema.IValidator`
.. autofunction:: validates

View File

@@ -96,10 +96,8 @@ adhere to.
.. attribute:: VALIDATORS
A mapping of validators (:class:`str`\s) to functions that validate the
validator property with that name. Each function should take 4
arguments: the validator instance, the value of the current validator
property in the instance, the instance, and the schema. For more
information see :ref:`creating-validators`.
validator property with that name. For more information see
:ref:`creating-validators`.
.. attribute:: schema