confidant.schema package

Submodules

confidant.schema.auto_build_schema module

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

Bases: confidant.schema.auto_build_schema.StrictSchema

By default, calling load on a marshmallow schema will return a dictionary of field names mapped to their deserialized values. In order to deserialize to an object the official recommendation is to create a function decorated with a “post_load” function. [1]

Since we always want to deserialize to an object, adding this post_load function would lead to a lot of boilerplate. This class serves to reduce that boilerplate.

To use, subclass and set assign a _class_to_load class member variable to the class you want an instance of. That class will be constructed with keyword arguments resulting from the schema load.

[1] https://marshmallow.readthedocs.org/en/latest/quickstart.html#deserializing-to-objects # noqa:E501

Example:

from marshmallow import fields

class Foo(object):

   def __init__(self, bar=None):
       self.bar = bar

class FooSchema(AutobuildSchema):

   _class_to_load = Foo

   bar = fields.String()

schema = FooSchema()
foo = schema.load({'foo': 'bar'}).data

print foo.__class__.__name__
Foo

build_object(data)

opts = <marshmallow.schema.SchemaOpts object>

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

Bases: marshmallow.schema.Schema

Simple subclass of Schema that sets the strict setting to true. This means validation errors will raise an exception.

class Meta

Bases: object

strict = True

opts = <marshmallow.schema.SchemaOpts object>

confidant.schema.blind_credentials module

class confidant.schema.blind_credentials.BlindCredentialResponse(id, name, cipher_version, cipher_type, revision, enabled, documentation, modified_date, modified_by, metadata=<class 'dict'>, credential_keys=<class 'list'>, credential_pairs=<class 'dict'>, data_key=<class 'dict'>)

Bases: object

classmethod from_blind_credential(credential, include_credential_keys=False, include_credential_pairs=False, include_data_key=False)

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

Bases: confidant.schema.auto_build_schema.AutobuildSchema

class Meta

Bases: object

jit

alias of toastedmarshmallow.Jit

opts = <marshmallow.schema.SchemaOpts object>

confidant.schema.certificates module

class confidant.schema.certificates.CertificateAuthoritiesResponse(cas)

Bases: object

classmethod from_cas(cas)

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

Bases: confidant.schema.auto_build_schema.AutobuildSchema

class Meta

Bases: object

jit

alias of toastedmarshmallow.Jit

opts = <marshmallow.schema.SchemaOpts object>

class confidant.schema.certificates.CertificateAuthorityResponse(ca, certificate, certificate_chain, tags)

Bases: object

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

Bases: confidant.schema.auto_build_schema.AutobuildSchema

class Meta

Bases: object

jit

alias of toastedmarshmallow.Jit

opts = <marshmallow.schema.SchemaOpts object>

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

Bases: confidant.schema.auto_build_schema.AutobuildSchema

class Meta

Bases: object

jit

alias of toastedmarshmallow.Jit

opts = <marshmallow.schema.SchemaOpts object>

class confidant.schema.certificates.CertificateResponse(certificate, certificate_chain, key=None)

Bases: object

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

Bases: confidant.schema.auto_build_schema.AutobuildSchema

class Meta

Bases: object

jit

alias of toastedmarshmallow.Jit

opts = <marshmallow.schema.SchemaOpts object>

confidant.schema.credentials module

class confidant.schema.credentials.CredentialResponse(id, name, revision, enabled, modified_date, modified_by, documentation=None, metadata=<class 'dict'>, credential_keys=<class 'list'>, credential_pairs=<class 'dict'>, permissions=<class 'dict'>, tags=<class 'list'>, last_rotation_date=None, next_rotation_date=None)

Bases: object

classmethod from_credential(credential, include_credential_keys=False, include_credential_pairs=False)

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

Bases: confidant.schema.auto_build_schema.AutobuildSchema

class Meta

Bases: object

jit

alias of toastedmarshmallow.Jit

opts = <marshmallow.schema.SchemaOpts object>

class confidant.schema.credentials.CredentialsResponse(credentials, next_page)

Bases: object

classmethod from_credentials(credentials, next_page=None, include_credential_keys=False, include_credential_pairs=False)

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

Bases: marshmallow.schema.Schema

class Meta

Bases: object

jit

alias of toastedmarshmallow.Jit

encode_next_page(item)

opts = <marshmallow.schema.SchemaOpts object>

sort_credentials(item)

class confidant.schema.credentials.RevisionsResponse(revisions, next_page)

Bases: object

classmethod from_credentials(credentials, next_page=None, include_credential_keys=False, include_credential_pairs=False)

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

Bases: marshmallow.schema.Schema

class Meta

Bases: object

jit

alias of toastedmarshmallow.Jit

encode_next_page(item)

opts = <marshmallow.schema.SchemaOpts object>

sort_revisions(item)

confidant.schema.jwks module

class confidant.schema.jwks.JWKSListResponse(keys)

Bases: object

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

Bases: confidant.schema.auto_build_schema.AutobuildSchema

class Meta

Bases: object

jit

alias of toastedmarshmallow.Jit

opts = <marshmallow.schema.SchemaOpts object>

class confidant.schema.jwks.JWKSResponse(kty, kid, n, e)

Bases: object

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

Bases: confidant.schema.auto_build_schema.AutobuildSchema

class Meta

Bases: object

jit

alias of toastedmarshmallow.Jit

opts = <marshmallow.schema.SchemaOpts object>

class confidant.schema.jwks.JWTResponse(token)

Bases: object

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

Bases: confidant.schema.auto_build_schema.AutobuildSchema

class Meta

Bases: object

jit

alias of toastedmarshmallow.Jit

opts = <marshmallow.schema.SchemaOpts object>

confidant.schema.services module

class confidant.schema.services.RevisionsResponse(revisions, next_page)

Bases: object

classmethod from_services(services, include_credentials=False, include_blind_credentials=False, next_page=None)

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

Bases: marshmallow.schema.Schema

class Meta

Bases: object

jit

alias of toastedmarshmallow.Jit

encode_next_page(item)

opts = <marshmallow.schema.SchemaOpts object>

sort_revisions(item)

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

Bases: confidant.schema.auto_build_schema.AutobuildSchema

class Meta

Bases: object

jit

alias of toastedmarshmallow.Jit

opts = <marshmallow.schema.SchemaOpts object>

class confidant.schema.services.ServiceResponse(id, revision, enabled, modified_date, modified_by, account=None, credentials=<class 'list'>, blind_credentials=<class 'list'>, permissions=<class 'dict'>)

Bases: object

classmethod from_service(service, include_credentials=False, include_blind_credentials=False)

classmethod from_service_expanded(service, credentials, blind_credentials, metadata_only=True)

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

Bases: confidant.schema.auto_build_schema.AutobuildSchema

class Meta

Bases: object

jit

alias of toastedmarshmallow.Jit

opts = <marshmallow.schema.SchemaOpts object>

class confidant.schema.services.ServicesResponse(services, next_page)

Bases: object

classmethod from_services(services, next_page=None, include_credentials=False, include_blind_credentials=False)

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

Bases: marshmallow.schema.Schema

class Meta

Bases: object

jit

alias of toastedmarshmallow.Jit

encode_next_page(item)

opts = <marshmallow.schema.SchemaOpts object>

sort_services(item)

Module contents