splitiorequests.schemas.segments package

splitiorequests.schemas.segments.segment_schema module

Segment Schema

class splitiorequests.schemas.segments.segment_schema.SegmentSchema(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet = False, unknown: str | None = None)

Segment schema class

Raises exception when unknown field is detected

class Meta

load_segment(data, **kwargs)

Generates and returns Segment object

return_dict(data, **kwargs)

Converts Schema object into dictionary and removes empty fields

splitiorequests.schemas.segments.segment_schema_exclude module

Segment Schema with exclude

class splitiorequests.schemas.segments.segment_schema_exclude.SegmentSchemaExclude(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet = False, unknown: str | None = None)

Segment schema class

Ignores and exclude unknown fields

class Meta

load_segment(data, **kwargs)

Generates and returns Segment object

return_dict(data, **kwargs)

Converts Schema object into dictionary and removes empty fields

splitiorequests.schemas.segments.segment_keys_schema module

Segment Keys Schema

class splitiorequests.schemas.segments.segment_keys_schema.SegmentKeysSchema(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet = False, unknown: str | None = None)

Segment Keys schema class

Raises exception when unknown field is detected

class Meta

load_segment_keys(data, **kwargs)

Generates and returns Segment Keys object

return_dict(data, **kwargs)

Converts Schema object into dictionary and removes empty fields

splitiorequests.schemas.segments.segment_keys_schema_exclude module

Segment Keys Schema with exclude

class splitiorequests.schemas.segments.segment_keys_schema_exclude.SegmentKeysSchemaExclude(*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet = False, unknown: str | None = None)

Segment Keys schema class

Ignores and exclude unknown fields

class Meta

load_segment_keys(data, **kwargs)

Generates and returns Segment Keys object

return_dict(data, **kwargs)

Converts Schema object into dictionary and removes empty fields