formencode_jsonschema package

Submodules

formencode_jsonschema.converters module

class formencode_jsonschema.converters.AllValidatorConverter

Bases: formencode_jsonschema.converters.ValidatorConverter

Convert All validator using first validator.

can_convert(validator: formencode.api.Validator, delegate: formencode_jsonschema.converters.SchemaDelegate)

convert(validator: formencode.api.Validator, delegate: formencode_jsonschema.converters.SchemaDelegate)

is_required(validator: formencode.api.Validator, delegate: formencode_jsonschema.converters.SchemaDelegate)

formencode_jsonschema.converters.DEFAULT_CONVERTERS = (<formencode_jsonschema.converters.SimpleValidatorConverter object at 0x7f5ca6402390>, <formencode_jsonschema.converters.SimpleValidatorConverter object at 0x7f5ca6402358>, <formencode_jsonschema.converters.SimpleValidatorConverter object at 0x7f5ca64023c8>, <formencode_jsonschema.converters.SimpleValidatorConverter object at 0x7f5ca6402940>, <formencode_jsonschema.converters.SimpleValidatorConverter object at 0x7f5ca6402908>, <formencode_jsonschema.converters.SimpleValidatorConverter object at 0x7f5ca6402978>, <formencode_jsonschema.converters.SimpleValidatorConverter object at 0x7f5ca64029e8>, <formencode_jsonschema.converters.TypedValidatorConverter object at 0x7f5ca64029b0>, <formencode_jsonschema.converters.AllValidatorConverter object at 0x7f5ca6402a20>, <formencode_jsonschema.converters.PipeValidatorConverter object at 0x7f5ca6402c50>)

Default converters

class formencode_jsonschema.converters.PipeValidatorConverter

Bases: formencode_jsonschema.converters.ValidatorConverter

Convert All validator using last validator.

can_convert(validator: formencode.api.Validator, delegate: formencode_jsonschema.converters.SchemaDelegate)

convert(validator: formencode.api.Validator, delegate: formencode_jsonschema.converters.SchemaDelegate)

is_required(validator: formencode.api.Validator, delegate: formencode_jsonschema.converters.SchemaDelegate)

formencode_jsonschema.converters.SIMPLE_CONVERTERS = (<formencode_jsonschema.converters.SimpleValidatorConverter object at 0x7f5ca6402390>, <formencode_jsonschema.converters.SimpleValidatorConverter object at 0x7f5ca6402358>, <formencode_jsonschema.converters.SimpleValidatorConverter object at 0x7f5ca64023c8>, <formencode_jsonschema.converters.SimpleValidatorConverter object at 0x7f5ca6402940>, <formencode_jsonschema.converters.SimpleValidatorConverter object at 0x7f5ca6402908>, <formencode_jsonschema.converters.SimpleValidatorConverter object at 0x7f5ca6402978>, <formencode_jsonschema.converters.SimpleValidatorConverter object at 0x7f5ca64029e8>)

Define simple converters

class formencode_jsonschema.converters.SchemaDelegate

Bases: object

Interface for delegating validator conversion to schema.

can_convert(validator: formencode.api.Validator)

convert_validator(validator: formencode.api.Validator)

is_required(validator: formencode.api.Validator)

class formencode_jsonschema.converters.SimpleValidatorConverter(validator_class, python_type)

Bases: formencode_jsonschema.converters.ValidatorConverter

Simple converter that convert specific validator into specific python type and, convert it to json schema

can_convert(validator: formencode.api.Validator, delegate: formencode_jsonschema.converters.SchemaDelegate)

convert(validator: formencode.api.Validator, delegate: formencode_jsonschema.converters.SchemaDelegate)

class formencode_jsonschema.converters.TypedValidatorConverter

Bases: formencode_jsonschema.converters.ValidatorConverter

Convert validator that wraped by typed validator.

can_convert(validator: formencode.api.Validator, delegate: formencode_jsonschema.converters.SchemaDelegate)

convert(validator: formencode.api.Validator, delegate: formencode_jsonschema.converters.SchemaDelegate)

is_required(validator: formencode.api.Validator, delegate: formencode_jsonschema.converters.SchemaDelegate)

class formencode_jsonschema.converters.ValidatorConverter

Bases: object

Base class for validator converters.

can_convert(validator: formencode.api.Validator, delegate: formencode_jsonschema.converters.SchemaDelegate)

Check acceptability.

convert(validator: formencode.api.Validator, delegate: formencode_jsonschema.converters.SchemaDelegate)

Excute conversion.

is_required(validator: formencode.api.Validator, delegate: formencode_jsonschema.converters.SchemaDelegate)

Get required flag from validator.

formencode_jsonschema.schema module

class formencode_jsonschema.schema.JSONSchema(extra=None, only=(), exclude=(), prefix='', strict=False, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: marshmallow.schema.Schema, formencode_jsonschema.converters.SchemaDelegate

Marshmallow schema for convert Formencode’s schema to JSON schema.

You can add more converters by overriding __validator_converters__ field.

can_convert(validator: formencode.api.Validator)

convert_validator(validator: formencode.api.Validator)

get_properties(schema: formencode.schema.Schema)

get_required(schema: formencode.schema.Schema)

handle_unknown_validator(validator: formencode.api.Validator)

When schema found unknown validator, handle that here.

is_required(validator: formencode.api.Validator)

opts = <marshmallow.schema.SchemaOpts object>

formencode_jsonschema.typed module

class formencode_jsonschema.typed.ArrrayTyped(validator, *args, **kwargs)

Bases: formencode_jsonschema.typed.JSONTyped

Wrap formencode validator with array type of JSON Schema

Messages

badType:

The input must be a string (not a %(type)s: %(value)r)

empty:

Please enter a value

noneType:

The input must be a string (not None)

declarative_count = 66

class formencode_jsonschema.typed.BooleanTyped(validator, *args, **kwargs)

Bases: formencode_jsonschema.typed.JSONTyped

Wrap formencode validator with boolean type of JSON Schema

Messages

badType:

The input must be a string (not a %(type)s: %(value)r)

empty:

Please enter a value

noneType:

The input must be a string (not None)

declarative_count = 75

class formencode_jsonschema.typed.DateTimeTyped(validator, *args, **kwargs)

Bases: formencode_jsonschema.typed.JSONTyped

Wrap formencode validator with date-time type of JSON Schema

Messages

badType:

The input must be a string (not a %(type)s: %(value)r)

empty:

Please enter a value

noneType:

The input must be a string (not None)

declarative_count = 69

class formencode_jsonschema.typed.DateTyped(validator, *args, **kwargs)

Bases: formencode_jsonschema.typed.JSONTyped

Wrap formencode validator with date type of JSON Schema

Messages

badType:

The input must be a string (not a %(type)s: %(value)r)

empty:

Please enter a value

noneType:

The input must be a string (not None)

declarative_count = 67

class formencode_jsonschema.typed.DecimalTyped(validator, *args, **kwargs)

Bases: formencode_jsonschema.typed.JSONTyped

Wrap formencode validator with decimal type of JSON Schema

Messages

badType:

The input must be a string (not a %(type)s: %(value)r)

empty:

Please enter a value

noneType:

The input must be a string (not None)

declarative_count = 72

class formencode_jsonschema.typed.FloatTyped(validator, *args, **kwargs)

Bases: formencode_jsonschema.typed.JSONTyped

Wrap formencode validator with float type of JSON Schema

Messages

badType:

The input must be a string (not a %(type)s: %(value)r)

empty:

Please enter a value

noneType:

The input must be a string (not None)

declarative_count = 73

class formencode_jsonschema.typed.IntegerTyped(validator, *args, **kwargs)

Bases: formencode_jsonschema.typed.JSONTyped

Wrap formencode validator with integer type of JSON Schema

Messages

badType:

The input must be a string (not a %(type)s: %(value)r)

empty:

Please enter a value

noneType:

The input must be a string (not None)

declarative_count = 74

class formencode_jsonschema.typed.JSONTyped(*args, **kw)

Bases: formencode.api.FancyValidator

Wrap formencode validator with JSON schema’s types & properties.

validator = JSONTyped(
    {'type': 'string'},
    validators.UnicodeString(),
    required=True,
    description="Some important field",
)

Messages

badType:

The input must be a string (not a %(type)s: %(value)r)

empty:

Please enter a value

noneType:

The input must be a string (not None)

declarative_count = 64

description = None

required

alias of NoDefault

class formencode_jsonschema.typed.ObjectTyped(validator, *args, **kwargs)

Bases: formencode_jsonschema.typed.JSONTyped

Wrap formencode validator with object type of JSON Schema

Messages

badType:

The input must be a string (not a %(type)s: %(value)r)

empty:

Please enter a value

noneType:

The input must be a string (not None)

declarative_count = 65

class formencode_jsonschema.typed.StringTyped(validator, *args, **kwargs)

Bases: formencode_jsonschema.typed.JSONTyped

Wrap formencode validator with string type of JSON Schema

Messages

badType:

The input must be a string (not a %(type)s: %(value)r)

empty:

Please enter a value

noneType:

The input must be a string (not None)

declarative_count = 71

class formencode_jsonschema.typed.TimeTyped(validator, *args, **kwargs)

Bases: formencode_jsonschema.typed.JSONTyped

Wrap formencode validator with time type of JSON Schema

Messages

badType:

The input must be a string (not a %(type)s: %(value)r)

empty:

Please enter a value

noneType:

The input must be a string (not None)

declarative_count = 68

class formencode_jsonschema.typed.UUIDTyped(validator, *args, **kwargs)

Bases: formencode_jsonschema.typed.JSONTyped

Wrap formencode validator with uuid type of JSON Schema

Messages

badType:

The input must be a string (not a %(type)s: %(value)r)

empty:

Please enter a value

noneType:

The input must be a string (not None)

declarative_count = 70

formencode_jsonschema.utils module

formencode_jsonschema.utils.get_type_base(python_type) → dict

Get base schema for python type.

Module contents

class formencode_jsonschema.JSONSchema(extra=None, only=(), exclude=(), prefix='', strict=False, many=False, context=None, load_only=(), dump_only=(), partial=False)

Bases: marshmallow.schema.Schema, formencode_jsonschema.converters.SchemaDelegate

Marshmallow schema for convert Formencode’s schema to JSON schema.

You can add more converters by overriding __validator_converters__ field.

can_convert(validator: formencode.api.Validator)

convert_validator(validator: formencode.api.Validator)

get_properties(schema: formencode.schema.Schema)

get_required(schema: formencode.schema.Schema)

handle_unknown_validator(validator: formencode.api.Validator)

When schema found unknown validator, handle that here.

is_required(validator: formencode.api.Validator)

opts = <marshmallow.schema.SchemaOpts object>