marshmallow_configparser

class Boolean(section, *args, **kwargs)

Bases: marshmallow_configparser.fields.ConfigParserFieldMixin, marshmallow.fields.Boolean

class ConfigParserFieldMixin(*args, **kwargs)

Bases: object

dump_to

load_from

class Date(section, *args, **kwargs)

Bases: marshmallow_configparser.fields.ConfigParserFieldMixin, marshmallow.fields.Date

class DateTime(section, *args, **kwargs)

Bases: marshmallow_configparser.fields.ConfigParserFieldMixin, marshmallow.fields.DateTime

class Decimal(section, *args, **kwargs)

Bases: marshmallow_configparser.fields.ConfigParserFieldMixin, marshmallow.fields.Decimal

class Dict(section, *args, **kwargs)

Bases: marshmallow_configparser.fields.ConfigParserFieldMixin, marshmallow.fields.Dict

class Email(section, *args, **kwargs)

Bases: marshmallow_configparser.fields.ConfigParserFieldMixin, marshmallow.fields.Email

class Float(section, *args, **kwargs)

Bases: marshmallow_configparser.fields.ConfigParserFieldMixin, marshmallow.fields.Float

class FormattedString(section, *args, **kwargs)

Bases: marshmallow_configparser.fields.ConfigParserFieldMixin, marshmallow.fields.FormattedString

class Function(section, *args, **kwargs)

Bases: marshmallow_configparser.fields.ConfigParserFieldMixin, marshmallow.fields.Function

class Integer(section, *args, **kwargs)

Bases: marshmallow_configparser.fields.ConfigParserFieldMixin, marshmallow.fields.Integer

class List(section, *args, **kwargs)

Bases: marshmallow_configparser.fields.ConfigParserFieldMixin, marshmallow.fields.List

class LocalDateTime(section, *args, **kwargs)

Bases: marshmallow_configparser.fields.ConfigParserFieldMixin, marshmallow.fields.LocalDateTime

class Method(section, *args, **kwargs)

Bases: marshmallow_configparser.fields.ConfigParserFieldMixin, marshmallow.fields.Method

class Number(section, *args, **kwargs)

Bases: marshmallow_configparser.fields.ConfigParserFieldMixin, marshmallow.fields.Number

class String(section, *args, **kwargs)

Bases: marshmallow_configparser.fields.ConfigParserFieldMixin, marshmallow.fields.String

class Time(section, *args, **kwargs)

Bases: marshmallow_configparser.fields.ConfigParserFieldMixin, marshmallow.fields.Time

class TimeDelta(section, *args, **kwargs)

Bases: marshmallow_configparser.fields.ConfigParserFieldMixin, marshmallow.fields.TimeDelta

class UUID(section, *args, **kwargs)

Bases: marshmallow_configparser.fields.ConfigParserFieldMixin, marshmallow.fields.UUID

class Url(section, *args, **kwargs)

Bases: marshmallow_configparser.fields.ConfigParserFieldMixin, marshmallow.fields.Url

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

Bases: marshmallow.schema.Schema

OPTIONS_CLASS

alias of ModelOpts

dump(obj)

Dump object to list of strings representing INI file.

In marshmallow 2.x.x returns tuple of data, errors or raises depending on self.strict

In marshmallow 3.x.x always returns data or raises (schema is always strict in marshmallow 3.x.x)

dumps(obj)

Dump object to string representing INI file.

In marshmallow 2.x.x returns tuple of data, errors or raises depending on self.strict

In marshmallow 3.x.x always returns data or raises (schema is always strict in marshmallow 3.x.x)

load(config_files)

Load configuration from list of config file paths.

In marshmallow 2.x.x returns tuple of data, errors or raises depending on self.strict

In marshmallow 3.x.x always returns data or raises (schema is always strict in marshmallow 3.x.x)

loads(ini_file_data)

Load configuration from string representing INI file.

In marshmallow 2.x.x returns tuple of data, errors or raises depending on self.strict

In marshmallow 3.x.x always returns data or raises (schema is always strict in marshmallow 3.x.x)

make_config_object(data)

opts = <marshmallow_configparser.schema.ModelOpts object>

class ModelOpts(meta, **kwargs)

Bases: marshmallow.schema.SchemaOpts

is_blank(line)

class IsNotBlank

Bases: marshmallow.validate.Validator

Validator which succeeds if the value passed is not blank string.

error = None

class IsNotNone

Bases: marshmallow.validate.Validator

Validator which succeeds if the value passed is not blank string.

error = None

class ConfigBoolean(section, default=None, attribute=None, load_from=None, dump_to=None, error=None, error_messages=None, **metadata)

Bases: marshmallow_configparser.fields.Boolean

marshmallow.fields.Field that ensures:

• option is always present in deserialized data

This is pretty similar to Boolean, except this one assumes defaults for some of Integer attributes.

class ConfigInteger(section, default=None, attribute=None, load_from=None, dump_to=None, error=None, error_messages=None, as_string=False, validate=None, **metadata)

Bases: marshmallow_configparser.fields.Integer

marshmallow.fields.Field that ensures:

• option is always present in deserialized data
• deserialized value is either the one read from config file or one declared in default
• allows None as deserialized value (Integer raises ValidationError(‘Not a valid integer.’))

This is pretty similar to Integer, except this one assumes defaults for some of Integer attributes and changes treating of None values.

class ConfigString(section, default='', attribute=None, load_from=None, dump_to=None, error=None, load_only=False, dump_only=False, error_messages=None, validate=None, **metadata)

Bases: marshmallow_configparser.fields.String

marshmallow.fields.Field that ensures:

• option is always present in deserialized data
• deserialized value is either the one read from config file or one declared in default

This is pretty similar to String, except this one assumes defaults for some of String attributes.