restapi.models.fields.String

class restapi.models.fields.String(*, load_default=<marshmallow.missing>, missing=<marshmallow.missing>, dump_default=<marshmallow.missing>, default=<marshmallow.missing>, data_key=None, attribute=None, validate=None, required=False, allow_none=None, load_only=False, dump_only=False, error_messages=None, metadata=None, **additional_metadata)[source]
Parameters:

  • load_default (Any, default: <marshmallow.missing>)

  • missing (Any, default: <marshmallow.missing>)

  • dump_default (Any, default: <marshmallow.missing>)

  • default (Any, default: <marshmallow.missing>)

  • data_key (str | None, default: None)

  • attribute (str | None, default: None)

  • validate (Union[None, Callable[[Any], Any], Iterable[Callable[[Any], Any]]], default: None)

  • required (bool, default: False)

  • allow_none (bool | None, default: None)

  • load_only (bool, default: False)

  • dump_only (bool, default: False)

  • error_messages (dict[str, str] | None, default: None)

  • metadata (Optional[Mapping[str, Any]], default: None)

__init__(*, load_default=<marshmallow.missing>, missing=<marshmallow.missing>, dump_default=<marshmallow.missing>, default=<marshmallow.missing>, data_key=None, attribute=None, validate=None, required=False, allow_none=None, load_only=False, dump_only=False, error_messages=None, metadata=None, **additional_metadata)
Parameters:

  • load_default (Any, default: <marshmallow.missing>)

  • missing (Any, default: <marshmallow.missing>)

  • dump_default (Any, default: <marshmallow.missing>)

  • default (Any, default: <marshmallow.missing>)

  • data_key (str | None, default: None)

  • attribute (str | None, default: None)

  • validate (Union[None, Callable[[Any], Any], Iterable[Callable[[Any], Any]]], default: None)

  • required (bool, default: False)

  • allow_none (bool | None, default: None)

  • load_only (bool, default: False)

  • dump_only (bool, default: False)

  • error_messages (dict[str, str] | None, default: None)

  • metadata (Optional[Mapping[str, Any]], default: None)

Return type:

None

Methods

__init__(*[, load_default, missing, ...])

deserialize(value[, attr, data])

Deserialize value.

fail(key, **kwargs)

Helper method that raises a ValidationError with an error message from self.error_messages.

get_value(obj, attr[, accessor, default])

Return the value for a given key from an object.

make_error(key, **kwargs)

Helper method to make a ValidationError with an error message from self.error_messages.

serialize(attr, obj[, accessor])

Pulls the value for the given key from the object, applies the field's formatting and returns the result.

Attributes

context

The context dictionary for the parent Schema.

default

default_error_messages

Default error messages.

missing

name

parent

root