breakdown#

Functions#

make_specific_breakdown_item

`make_specific_breakdown_item()`#

rootski.schemas.breakdown.make_specific_breakdown_item(morpheme: rootski.schemas.morpheme.Morpheme, position: int) → Union[rootski.schemas.breakdown.NullMorphemeBreakdownItem, rootski.schemas.breakdown.MorphemeBreakdownItemInResponse][source]#

Classes#

`Breakdown`
`BreakdownCommon`
`BreakdownInDB`
`BreakdownItem`	Contains attributes that are not in BreakdownItemInDb
`BreakdownItemCommon`
`BreakdownItemInDb`
`BreakdownUpsert`
`GetBreakdownResponse`
`MorphemeBreakdownItemInRequest`
`MorphemeBreakdownItemInResponse`	Use this type to include the morpheme associated with the given morpheme_id in the breakdown.
`NullMorphemeBreakdownItem`	Use this type to include a piece of text in a breakdown that does not have a morpheme id.
`SubmitBreakdownResponse`

`class Breakdown`#

class rootski.schemas.breakdown.Breakdown(*, word_id: int, word: rootski.schemas.breakdown.ConstrainedStrValue, is_verified: bool, is_inference: bool, date_submitted: datetime.datetime, date_verified: datetime.datetime = None, breakdown_items: List[rootski.schemas.breakdown.BreakdownItem], submitted_by_current_user: bool = False)[source]#

Bases: rootski.schemas.breakdown.BreakdownCommon

classmethod construct(_fields_set: Optional[SetStr] = None, **values: Any) → Model#: Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed. Behaves as if Config.extra = ‘allow’ was set since it adds all passed values

copy(*, include: Union[AbstractSetIntStr, MappingIntStrAny] = None, exclude: Union[AbstractSetIntStr, MappingIntStrAny] = None, update: DictStrAny = None, deep: bool = False) → Model#

Duplicate a model, optionally choose which fields to include, exclude and change.

Parameters

include – fields to include in new model
exclude – fields to exclude from new model, as with values this takes precedence over include
update – values to change/add in the new model. Note: the data is not validated before creating the new model: you should trust this data
deep – set to True to make a deep copy of the model

Returns

new model instance

dict(*, include: Union[AbstractSetIntStr, MappingIntStrAny] = None, exclude: Union[AbstractSetIntStr, MappingIntStrAny] = None, by_alias: bool = False, skip_defaults: bool = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False) → DictStrAny#: Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

static from_orm_breakdown(orm_breakdown: rootski.services.database.models.models.Breakdown)[source]#: Initialize a breakdown object from an orm.Breakdown object with the proper intermediate steps.

json(*, include: Union[AbstractSetIntStr, MappingIntStrAny] = None, exclude: Union[AbstractSetIntStr, MappingIntStrAny] = None, by_alias: bool = False, skip_defaults: bool = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False, encoder: Optional[Callable[[Any], Any]] = None, models_as_dict: bool = True, **dumps_kwargs: Any) → unicode#

Generate a JSON representation of the model, include and exclude arguments as per dict().

encoder is an optional function to supply as default to json.dumps(), other arguments as per json.dumps().

classmethod update_forward_refs(**localns: Any) → None#: Try to update ForwardRefs on fields based on this Model, globalns and localns.

`class BreakdownCommon`#

class rootski.schemas.breakdown.BreakdownCommon(*, word_id: int, word: rootski.schemas.breakdown.ConstrainedStrValue, is_verified: bool, is_inference: bool, date_submitted: datetime.datetime, date_verified: datetime.datetime = None, breakdown_items: List[rootski.schemas.breakdown.BreakdownItemCommon])[source]#

Bases: pydantic.main.BaseModel

classmethod construct(_fields_set: Optional[SetStr] = None, **values: Any) → Model#: Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed. Behaves as if Config.extra = ‘allow’ was set since it adds all passed values

copy(*, include: Union[AbstractSetIntStr, MappingIntStrAny] = None, exclude: Union[AbstractSetIntStr, MappingIntStrAny] = None, update: DictStrAny = None, deep: bool = False) → Model#

Duplicate a model, optionally choose which fields to include, exclude and change.

Parameters

include – fields to include in new model
exclude – fields to exclude from new model, as with values this takes precedence over include
update – values to change/add in the new model. Note: the data is not validated before creating the new model: you should trust this data
deep – set to True to make a deep copy of the model

Returns

new model instance

dict(*, include: Union[AbstractSetIntStr, MappingIntStrAny] = None, exclude: Union[AbstractSetIntStr, MappingIntStrAny] = None, by_alias: bool = False, skip_defaults: bool = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False) → DictStrAny#: Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Generate a JSON representation of the model, include and exclude arguments as per dict().

encoder is an optional function to supply as default to json.dumps(), other arguments as per json.dumps().

classmethod update_forward_refs(**localns: Any) → None#: Try to update ForwardRefs on fields based on this Model, globalns and localns.

`class BreakdownInDB`#

class rootski.schemas.breakdown.BreakdownInDB(*, word_id: int, word: rootski.schemas.breakdown.ConstrainedStrValue, is_verified: bool, is_inference: bool, date_submitted: datetime.datetime, date_verified: datetime.datetime = None, breakdown_items: List[rootski.schemas.breakdown.BreakdownItemCommon], submitted_by_user_email: pydantic.networks.EmailStr = None, verified_by_user_email: pydantic.networks.EmailStr = None, id: int = None)[source]#

Bases: rootski.schemas.breakdown.BreakdownCommon

classmethod construct(_fields_set: Optional[SetStr] = None, **values: Any) → Model#: Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed. Behaves as if Config.extra = ‘allow’ was set since it adds all passed values

copy(*, include: Union[AbstractSetIntStr, MappingIntStrAny] = None, exclude: Union[AbstractSetIntStr, MappingIntStrAny] = None, update: DictStrAny = None, deep: bool = False) → Model#

Duplicate a model, optionally choose which fields to include, exclude and change.

Parameters

include – fields to include in new model
exclude – fields to exclude from new model, as with values this takes precedence over include
update – values to change/add in the new model. Note: the data is not validated before creating the new model: you should trust this data
deep – set to True to make a deep copy of the model

Returns

new model instance

dict(*, include: Union[AbstractSetIntStr, MappingIntStrAny] = None, exclude: Union[AbstractSetIntStr, MappingIntStrAny] = None, by_alias: bool = False, skip_defaults: bool = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False) → DictStrAny#: Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Generate a JSON representation of the model, include and exclude arguments as per dict().

encoder is an optional function to supply as default to json.dumps(), other arguments as per json.dumps().

classmethod update_forward_refs(**localns: Any) → None#: Try to update ForwardRefs on fields based on this Model, globalns and localns.

`class BreakdownItem`#

class rootski.schemas.breakdown.BreakdownItem(*, morpheme: rootski.schemas.breakdown.ConstrainedStrValue = None, position: int, family_id: int = None, family_meanings: List[str] = None, morpheme_id: int = None, type: Literal['prefix', 'root', 'suffix', 'link', None] = None, word_pos: Literal['any', 'adjective', 'noun', 'verb'] = None, level: int = None, family: str = None)[source]#

Bases: rootski.schemas.breakdown.BreakdownItemCommon

Contains attributes that are not in BreakdownItemInDb

classmethod construct(_fields_set: Optional[SetStr] = None, **values: Any) → Model#: Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed. Behaves as if Config.extra = ‘allow’ was set since it adds all passed values

copy(*, include: Union[AbstractSetIntStr, MappingIntStrAny] = None, exclude: Union[AbstractSetIntStr, MappingIntStrAny] = None, update: DictStrAny = None, deep: bool = False) → Model#

Duplicate a model, optionally choose which fields to include, exclude and change.

Parameters

include – fields to include in new model
exclude – fields to exclude from new model, as with values this takes precedence over include
update – values to change/add in the new model. Note: the data is not validated before creating the new model: you should trust this data
deep – set to True to make a deep copy of the model

Returns

new model instance

dict(*, include: Union[AbstractSetIntStr, MappingIntStrAny] = None, exclude: Union[AbstractSetIntStr, MappingIntStrAny] = None, by_alias: bool = False, skip_defaults: bool = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False) → DictStrAny#: Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

classmethod enforce_non_null_morpheme_data_is_set(values: Dict[str, Any])[source]#: If the morpheme ID is set, this is a non-null morpheme breakdown item.

static from_morpheme(morpheme: rootski.schemas.morpheme.Morpheme, position: int)#

If type is None, this is a “null” morpheme. It is not a morpheme, but we need to store the text.

Otherwise, this is a real morpheme. In this case, we only need the morpheme_id. The rest of the morpheme attributes can be looked up in the database.

In both cases, the morpheme position is required.

Generate a JSON representation of the model, include and exclude arguments as per dict().

encoder is an optional function to supply as default to json.dumps(), other arguments as per json.dumps().

to_null_or_morpheme_breakdown_item() → Union[rootski.schemas.breakdown.NullMorphemeBreakdownItem, rootski.schemas.breakdown.MorphemeBreakdownItemInResponse][source]#: Cast this BreakdownItem to the correct sub-type. This is useful for creating an API response.

classmethod update_forward_refs(**localns: Any) → None#: Try to update ForwardRefs on fields based on this Model, globalns and localns.

`class BreakdownItemCommon`#

class rootski.schemas.breakdown.BreakdownItemCommon(*, morpheme: rootski.schemas.breakdown.ConstrainedStrValue = None, position: int, family_id: int = None, family_meanings: List[str] = None, morpheme_id: int = None, type: Literal['prefix', 'root', 'suffix', 'link', None] = None)[source]#

Bases: pydantic.main.BaseModel

classmethod construct(_fields_set: Optional[SetStr] = None, **values: Any) → Model#: Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed. Behaves as if Config.extra = ‘allow’ was set since it adds all passed values

copy(*, include: Union[AbstractSetIntStr, MappingIntStrAny] = None, exclude: Union[AbstractSetIntStr, MappingIntStrAny] = None, update: DictStrAny = None, deep: bool = False) → Model#

Duplicate a model, optionally choose which fields to include, exclude and change.

Parameters

include – fields to include in new model
exclude – fields to exclude from new model, as with values this takes precedence over include
update – values to change/add in the new model. Note: the data is not validated before creating the new model: you should trust this data
deep – set to True to make a deep copy of the model

Returns

new model instance

dict(*, include: Union[AbstractSetIntStr, MappingIntStrAny] = None, exclude: Union[AbstractSetIntStr, MappingIntStrAny] = None, by_alias: bool = False, skip_defaults: bool = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False) → DictStrAny#: Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

static from_morpheme(morpheme: rootski.schemas.morpheme.Morpheme, position: int)[source]#

If type is None, this is a “null” morpheme. It is not a morpheme, but we need to store the text.

Otherwise, this is a real morpheme. In this case, we only need the morpheme_id. The rest of the morpheme attributes can be looked up in the database.

In both cases, the morpheme position is required.

Generate a JSON representation of the model, include and exclude arguments as per dict().

encoder is an optional function to supply as default to json.dumps(), other arguments as per json.dumps().

classmethod update_forward_refs(**localns: Any) → None#: Try to update ForwardRefs on fields based on this Model, globalns and localns.

`class BreakdownItemInDb`#

class rootski.schemas.breakdown.BreakdownItemInDb(*, morpheme: rootski.schemas.breakdown.ConstrainedStrValue = None, position: int, family_id: int = None, family_meanings: List[str] = None, morpheme_id: int = None, type: Literal['prefix', 'root', 'suffix', 'link', None] = None, breakdown_id: int = None)[source]#

Bases: rootski.schemas.breakdown.BreakdownItemCommon

classmethod construct(_fields_set: Optional[SetStr] = None, **values: Any) → Model#: Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed. Behaves as if Config.extra = ‘allow’ was set since it adds all passed values

copy(*, include: Union[AbstractSetIntStr, MappingIntStrAny] = None, exclude: Union[AbstractSetIntStr, MappingIntStrAny] = None, update: DictStrAny = None, deep: bool = False) → Model#

Duplicate a model, optionally choose which fields to include, exclude and change.

Parameters

include – fields to include in new model
exclude – fields to exclude from new model, as with values this takes precedence over include
update – values to change/add in the new model. Note: the data is not validated before creating the new model: you should trust this data
deep – set to True to make a deep copy of the model

Returns

new model instance

dict(*, include: Union[AbstractSetIntStr, MappingIntStrAny] = None, exclude: Union[AbstractSetIntStr, MappingIntStrAny] = None, by_alias: bool = False, skip_defaults: bool = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False) → DictStrAny#: Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

static from_morpheme(morpheme: rootski.schemas.morpheme.Morpheme, position: int)#

If type is None, this is a “null” morpheme. It is not a morpheme, but we need to store the text.

Otherwise, this is a real morpheme. In this case, we only need the morpheme_id. The rest of the morpheme attributes can be looked up in the database.

In both cases, the morpheme position is required.

Generate a JSON representation of the model, include and exclude arguments as per dict().

encoder is an optional function to supply as default to json.dumps(), other arguments as per json.dumps().

to_orm(breakdown_id: Optional[int] = None) → rootski.services.database.models.models.BreakdownItem[source]#

Returns an orm representation of the breakdown item.

Parameters: breakdown_id –

classmethod update_forward_refs(**localns: Any) → None#: Try to update ForwardRefs on fields based on this Model, globalns and localns.

`class BreakdownUpsert`#

class rootski.schemas.breakdown.BreakdownUpsert(*, word_id: int, breakdown_items: List[Union[rootski.schemas.breakdown.NullMorphemeBreakdownItem, rootski.schemas.breakdown.MorphemeBreakdownItemInRequest]])[source]#

Bases: pydantic.main.BaseModel

classmethod construct(_fields_set: Optional[SetStr] = None, **values: Any) → Model#: Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed. Behaves as if Config.extra = ‘allow’ was set since it adds all passed values

copy(*, include: Union[AbstractSetIntStr, MappingIntStrAny] = None, exclude: Union[AbstractSetIntStr, MappingIntStrAny] = None, update: DictStrAny = None, deep: bool = False) → Model#

Duplicate a model, optionally choose which fields to include, exclude and change.

Parameters

include – fields to include in new model
exclude – fields to exclude from new model, as with values this takes precedence over include
update – values to change/add in the new model. Note: the data is not validated before creating the new model: you should trust this data
deep – set to True to make a deep copy of the model

Returns

new model instance

dict(*, include: Union[AbstractSetIntStr, MappingIntStrAny] = None, exclude: Union[AbstractSetIntStr, MappingIntStrAny] = None, by_alias: bool = False, skip_defaults: bool = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False) → DictStrAny#: Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Generate a JSON representation of the model, include and exclude arguments as per dict().

encoder is an optional function to supply as default to json.dumps(), other arguments as per json.dumps().

classmethod update_forward_refs(**localns: Any) → None#: Try to update ForwardRefs on fields based on this Model, globalns and localns.

`class GetBreakdownResponse`#

class rootski.schemas.breakdown.GetBreakdownResponse(*, word_id: int, word: rootski.schemas.breakdown.ConstrainedStrValue, is_verified: bool, is_inference: bool, date_submitted: datetime.datetime, date_verified: datetime.datetime = None, breakdown_items: List[Union[rootski.schemas.breakdown.NullMorphemeBreakdownItem, rootski.schemas.breakdown.MorphemeBreakdownItemInResponse]], submitted_by_current_user: bool = False)[source]#

Bases: rootski.schemas.breakdown.Breakdown

classmethod construct(_fields_set: Optional[SetStr] = None, **values: Any) → Model#: Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed. Behaves as if Config.extra = ‘allow’ was set since it adds all passed values

copy(*, include: Union[AbstractSetIntStr, MappingIntStrAny] = None, exclude: Union[AbstractSetIntStr, MappingIntStrAny] = None, update: DictStrAny = None, deep: bool = False) → Model#

Duplicate a model, optionally choose which fields to include, exclude and change.

Parameters

include – fields to include in new model
exclude – fields to exclude from new model, as with values this takes precedence over include
update – values to change/add in the new model. Note: the data is not validated before creating the new model: you should trust this data
deep – set to True to make a deep copy of the model

Returns

new model instance

dict(*, include: Union[AbstractSetIntStr, MappingIntStrAny] = None, exclude: Union[AbstractSetIntStr, MappingIntStrAny] = None, by_alias: bool = False, skip_defaults: bool = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False) → DictStrAny#: Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

static from_orm_breakdown(orm_breakdown: rootski.services.database.models.models.Breakdown)#: Initialize a breakdown object from an orm.Breakdown object with the proper intermediate steps.

Generate a JSON representation of the model, include and exclude arguments as per dict().

encoder is an optional function to supply as default to json.dumps(), other arguments as per json.dumps().

classmethod update_forward_refs(**localns: Any) → None#: Try to update ForwardRefs on fields based on this Model, globalns and localns.

`class MorphemeBreakdownItemInRequest`#

class rootski.schemas.breakdown.MorphemeBreakdownItemInRequest(*, morpheme_id: int, position: int)[source]#

Bases: pydantic.main.BaseModel

classmethod construct(_fields_set: Optional[SetStr] = None, **values: Any) → Model#: Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed. Behaves as if Config.extra = ‘allow’ was set since it adds all passed values

copy(*, include: Union[AbstractSetIntStr, MappingIntStrAny] = None, exclude: Union[AbstractSetIntStr, MappingIntStrAny] = None, update: DictStrAny = None, deep: bool = False) → Model#

Duplicate a model, optionally choose which fields to include, exclude and change.

Parameters

include – fields to include in new model
exclude – fields to exclude from new model, as with values this takes precedence over include
update – values to change/add in the new model. Note: the data is not validated before creating the new model: you should trust this data
deep – set to True to make a deep copy of the model

Returns

new model instance

dict(*, include: Union[AbstractSetIntStr, MappingIntStrAny] = None, exclude: Union[AbstractSetIntStr, MappingIntStrAny] = None, by_alias: bool = False, skip_defaults: bool = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False) → DictStrAny#: Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Generate a JSON representation of the model, include and exclude arguments as per dict().

encoder is an optional function to supply as default to json.dumps(), other arguments as per json.dumps().

classmethod update_forward_refs(**localns: Any) → None#: Try to update ForwardRefs on fields based on this Model, globalns and localns.

`class MorphemeBreakdownItemInResponse`#

class rootski.schemas.breakdown.MorphemeBreakdownItemInResponse(*, morpheme_id: int, position: int, type: Literal['prefix', 'root', 'suffix', 'link', None] = None, word_pos: Literal['any', 'adjective', 'noun', 'verb'] = None, morpheme: str = None, family_id: int = None, family_meanings: List[str] = None, level: int = None, family: str = None)[source]#

Bases: rootski.schemas.breakdown.MorphemeBreakdownItemInRequest

Use this type to include the morpheme associated with the given morpheme_id in the breakdown.

Each of these fields are in BreakdownItem

classmethod construct(_fields_set: Optional[SetStr] = None, **values: Any) → Model#: Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed. Behaves as if Config.extra = ‘allow’ was set since it adds all passed values

copy(*, include: Union[AbstractSetIntStr, MappingIntStrAny] = None, exclude: Union[AbstractSetIntStr, MappingIntStrAny] = None, update: DictStrAny = None, deep: bool = False) → Model#

Duplicate a model, optionally choose which fields to include, exclude and change.

Parameters

include – fields to include in new model
exclude – fields to exclude from new model, as with values this takes precedence over include
update – values to change/add in the new model. Note: the data is not validated before creating the new model: you should trust this data
deep – set to True to make a deep copy of the model

Returns

new model instance

dict(*, include: Union[AbstractSetIntStr, MappingIntStrAny] = None, exclude: Union[AbstractSetIntStr, MappingIntStrAny] = None, by_alias: bool = False, skip_defaults: bool = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False) → DictStrAny#: Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Generate a JSON representation of the model, include and exclude arguments as per dict().

encoder is an optional function to supply as default to json.dumps(), other arguments as per json.dumps().

classmethod update_forward_refs(**localns: Any) → None#: Try to update ForwardRefs on fields based on this Model, globalns and localns.

`class NullMorphemeBreakdownItem`#

class rootski.schemas.breakdown.NullMorphemeBreakdownItem(*, morpheme: rootski.schemas.breakdown.ConstrainedStrValue, position: int, morpheme_id: None = None)[source]#

Bases: pydantic.main.BaseModel

Use this type to include a piece of text in a breakdown that does not have a morpheme id.

classmethod construct(_fields_set: Optional[SetStr] = None, **values: Any) → Model#: Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed. Behaves as if Config.extra = ‘allow’ was set since it adds all passed values

copy(*, include: Union[AbstractSetIntStr, MappingIntStrAny] = None, exclude: Union[AbstractSetIntStr, MappingIntStrAny] = None, update: DictStrAny = None, deep: bool = False) → Model#

Duplicate a model, optionally choose which fields to include, exclude and change.

Parameters

include – fields to include in new model
exclude – fields to exclude from new model, as with values this takes precedence over include
update – values to change/add in the new model. Note: the data is not validated before creating the new model: you should trust this data
deep – set to True to make a deep copy of the model

Returns

new model instance

dict(*, include: Union[AbstractSetIntStr, MappingIntStrAny] = None, exclude: Union[AbstractSetIntStr, MappingIntStrAny] = None, by_alias: bool = False, skip_defaults: bool = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False) → DictStrAny#: Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Generate a JSON representation of the model, include and exclude arguments as per dict().

encoder is an optional function to supply as default to json.dumps(), other arguments as per json.dumps().

classmethod update_forward_refs(**localns: Any) → None#: Try to update ForwardRefs on fields based on this Model, globalns and localns.

`class SubmitBreakdownResponse`#

class rootski.schemas.breakdown.SubmitBreakdownResponse(*, word_id: int, breakdown_id: int, is_verified: bool)[source]#

Bases: pydantic.main.BaseModel

classmethod construct(_fields_set: Optional[SetStr] = None, **values: Any) → Model#: Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed. Behaves as if Config.extra = ‘allow’ was set since it adds all passed values

copy(*, include: Union[AbstractSetIntStr, MappingIntStrAny] = None, exclude: Union[AbstractSetIntStr, MappingIntStrAny] = None, update: DictStrAny = None, deep: bool = False) → Model#

Duplicate a model, optionally choose which fields to include, exclude and change.

Parameters

include – fields to include in new model
exclude – fields to exclude from new model, as with values this takes precedence over include
update – values to change/add in the new model. Note: the data is not validated before creating the new model: you should trust this data
deep – set to True to make a deep copy of the model

Returns

new model instance

dict(*, include: Union[AbstractSetIntStr, MappingIntStrAny] = None, exclude: Union[AbstractSetIntStr, MappingIntStrAny] = None, by_alias: bool = False, skip_defaults: bool = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False) → DictStrAny#: Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Generate a JSON representation of the model, include and exclude arguments as per dict().

encoder is an optional function to supply as default to json.dumps(), other arguments as per json.dumps().

classmethod update_forward_refs(**localns: Any) → None#: Try to update ForwardRefs on fields based on this Model, globalns and localns.

breakdown#

Functions#

make_specific_breakdown_item()#

Classes#

class Breakdown#

class BreakdownCommon#

class BreakdownInDB#

class BreakdownItem#

class BreakdownItemCommon#

class BreakdownItemInDb#

class BreakdownUpsert#

class GetBreakdownResponse#

class MorphemeBreakdownItemInRequest#

class MorphemeBreakdownItemInResponse#

class NullMorphemeBreakdownItem#

class SubmitBreakdownResponse#

`make_specific_breakdown_item()`#

`class Breakdown`#

`class BreakdownCommon`#

`class BreakdownInDB`#

`class BreakdownItem`#

`class BreakdownItemCommon`#

`class BreakdownItemInDb`#

`class BreakdownUpsert`#

`class GetBreakdownResponse`#

`class MorphemeBreakdownItemInRequest`#

`class MorphemeBreakdownItemInResponse`#

`class NullMorphemeBreakdownItem`#

`class SubmitBreakdownResponse`#