minos.aggregate.models.refs.models module

class minos.aggregate.models.refs.models.AggregateRef(uuid, *args, **kwargs)[source]

Bases: minos.aggregate.models.entities.Entity

Aggregate Ref class.

__init__(uuid, *args, **kwargs)[source]

Class constructor.

Parameters

kwargs – Named arguments to be set as model attributes.

property avro_bytes: bytes

Generate bytes representation of the current instance.

Return type

bytes

Returns

A bytes object.

property avro_data: dict[str, typing.Any]

Compute the avro data of the model.

Return type

dict[str, typing.Any]

Returns

A dictionary object.

property avro_str: str

Generate bytes representation of the current instance.

Return type

str

Returns

A bytes object.

classname = 'minos.aggregate.models.refs.models.AggregateRef'
classmethod decode_data(decoder, target, type_, **kwargs)

Decode data with the given decoder.

Parameters

  • decoder (minos.common.model.serializers.abc.DataDecoder) – The decoder instance.

  • target (typing.Any) – The data to be decoded.

  • type – The data type.

  • kwargs – Additional named arguments.

Return type

typing.Any

Returns

A decoded instance.

classmethod decode_schema(decoder, target, **kwargs)

Decode schema with the given encoder.

Parameters

  • decoder (minos.common.model.serializers.abc.SchemaDecoder) – The decoder instance.

  • target (typing.Any) – The schema to be decoded.

  • kwargs – Additional named arguments.

Return type

typing.Any

Returns

The decoded schema as a type.

encode_data(encoder, target, **kwargs)

Encode data with the given encoder.

Parameters

  • encoder (minos.common.model.serializers.abc.DataEncoder) – The encoder instance.

  • target (typing.Any) – An optional pre-encoded data.

  • kwargs – Additional named arguments.

Return type

typing.Any

Returns

The encoded data of the instance.

classmethod encode_schema(encoder, target, **kwargs)

Encode schema with the given encoder.

Parameters

  • encoder (minos.common.model.serializers.abc.SchemaEncoder) – The encoder instance.

  • target (typing.Any) – An optional pre-encoded schema.

  • kwargs – Additional named arguments.

Return type

typing.Any

Returns

The encoded schema of the instance.

property fields: dict[str, minos.common.model.fields.Field]

Fields getter

Return type

dict[str, minos.common.model.fields.Field]

classmethod from_avro(schema, data)

Build a new instance from the avro schema and data.

Parameters

  • schema (typing.Any) – The avro schema of the model.

  • data (typing.Any) – The avro data of the model.

Return type

~T

Returns

A new DynamicModel instance.

classmethod from_avro_bytes(raw, batch_mode=False, **kwargs)

Build a single instance or a sequence of instances from bytes

Parameters

  • raw (bytes) – A bytes representation of the model.

  • batch_mode (bool) – If True the data is processed as a list of models, otherwise the data is processed as a

single model. :param kwargs: Additional named arguments. :rtype: typing.Union[~T, list[~T]] :return: A single instance or a sequence of instances.

classmethod from_avro_str(raw, **kwargs)

Build a single instance or a sequence of instances from bytes

Parameters

raw (str) – A str representation of the model.

Return type

typing.Union[~T, list[~T]]

Returns

A single instance or a sequence of instances.

classmethod from_model_type(model_type, *args, **kwargs)

Build a DeclarativeModel from a ModelType.

Parameters

  • model_type (minos.common.model.types.model_types.ModelType) – ModelType object containing the model structure.

  • args – Positional arguments to be passed to the model constructor.

  • kwargs – Named arguments to be passed to the model constructor.

Return type

~T

Returns

A new DeclarativeModel instance.

classmethod from_typed_dict(typed_dict, *args, **kwargs)

Build a Model from a TypeDict and data.

Parameters

  • typed_dict (typing.TypedDict) – TypeDict object containing the DTO’s structure

  • args – Positional arguments to be passed to the model constructor.

  • kwargs – Named arguments to be passed to the model constructor.

Return type

~T

Returns

A new DataTransferObject instance.

get(k[, d]) → D[k] if k in D, else d.  d defaults to None.
items() → a set-like object providing a view on D's items
keys() → a set-like object providing a view on D's keys
classmethod to_avro_bytes(models)

Create a bytes representation of the given object instances.

Parameters

models (list[~T]) – A sequence of minos models.

Return type

bytes

Returns

A bytes object.

classmethod to_avro_str(models)

Build the avro string representation of the given object instances.

Parameters

models (list[~T]) – A sequence of minos models.

Return type

str

Returns

A bytes object.

type_hints_parameters = ()
uuid: UUID
values() → an object providing a view on D's values
version: int
class minos.aggregate.models.refs.models.ModelRef(data, *args, broker_pool=<dependency_injector.wiring.Provide object>, **kwargs)[source]

Bases: minos.common.model.declarative.DeclarativeModel, uuid.UUID, Generic[minos.aggregate.models.refs.models.MT]

Model Reference.

__init__(data, *args, broker_pool=<dependency_injector.wiring.Provide object>, **kwargs)[source]

Class constructor.

Parameters

kwargs – Named arguments to be set as model attributes.

property avro_bytes: bytes

Generate bytes representation of the current instance.

Return type

bytes

Returns

A bytes object.

property avro_data: dict[str, typing.Any]

Compute the avro data of the model.

Return type

dict[str, typing.Any]

Returns

A dictionary object.

avro_schema = {'logicalType': 'uuid', 'type': 'string'}
property avro_str: str

Generate bytes representation of the current instance.

Return type

str

Returns

A bytes object.

property bytes
property bytes_le
classname = 'minos.aggregate.models.refs.models.ModelRef'
property clock_seq
property clock_seq_hi_variant
property clock_seq_low
data: Union[MT, UUID]
property data_cls: Optional[type]

Get data class if available.

Return type

typing.Optional[type]

Returns

A model type.

classmethod decode_data(decoder, target, type_, **kwargs)[source]

Decode data with the given decoder.

Parameters

  • decoder (minos.common.model.serializers.abc.DataDecoder) – The decoder instance.

  • target (typing.Any) – The data to be decoded.

  • type – The data type.

Return type

minos.aggregate.models.refs.models.ModelRef

Returns

A decoded instance.

classmethod decode_schema(decoder, target, **kwargs)[source]

Decode schema with the given encoder.

Parameters

  • decoder (minos.common.model.serializers.abc.SchemaDecoder) – The decoder instance.

  • target (typing.Any) – The schema to be decoded.

Return type

minos.common.model.types.model_types.ModelType

Returns

The decoded schema as a type.

static encode_data(encoder, target, **kwargs)[source]

Encode data with the given encoder.

Parameters

  • encoder (minos.common.model.serializers.abc.DataEncoder) – The encoder instance.

  • target (typing.Any) – An optional pre-encoded data.

Return type

typing.Any

Returns

The encoded data of the instance.

classmethod encode_schema(encoder, target, **kwargs)[source]

Encode schema with the given encoder.

Parameters

  • encoder (minos.common.model.serializers.abc.SchemaEncoder) – The encoder instance.

  • target (typing.Any) – An optional pre-encoded schema.

Return type

typing.Any

Returns

The encoded schema of the instance.

property fields: dict[str, minos.common.model.fields.Field]

Fields getter

Return type

dict[str, minos.common.model.fields.Field]

classmethod from_avro(schema, data)

Build a new instance from the avro schema and data.

Parameters

  • schema (typing.Any) – The avro schema of the model.

  • data (typing.Any) – The avro data of the model.

Return type

~T

Returns

A new DynamicModel instance.

classmethod from_avro_bytes(raw, batch_mode=False, **kwargs)

Build a single instance or a sequence of instances from bytes

Parameters

  • raw (bytes) – A bytes representation of the model.

  • batch_mode (bool) – If True the data is processed as a list of models, otherwise the data is processed as a

single model. :param kwargs: Additional named arguments. :rtype: typing.Union[~T, list[~T]] :return: A single instance or a sequence of instances.

classmethod from_avro_str(raw, **kwargs)

Build a single instance or a sequence of instances from bytes

Parameters

raw (str) – A str representation of the model.

Return type

typing.Union[~T, list[~T]]

Returns

A single instance or a sequence of instances.

classmethod from_model_type(model_type, *args, **kwargs)

Build a DeclarativeModel from a ModelType.

Parameters

  • model_type (minos.common.model.types.model_types.ModelType) – ModelType object containing the model structure.

  • args – Positional arguments to be passed to the model constructor.

  • kwargs – Named arguments to be passed to the model constructor.

Return type

~T

Returns

A new DeclarativeModel instance.

classmethod from_typed_dict(typed_dict, *args, **kwargs)

Build a Model from a TypeDict and data.

Parameters

  • typed_dict (typing.TypedDict) – TypeDict object containing the DTO’s structure

  • args – Positional arguments to be passed to the model constructor.

  • kwargs – Named arguments to be passed to the model constructor.

Return type

~T

Returns

A new DataTransferObject instance.

get(k[, d]) → D[k] if k in D, else d.  d defaults to None.
property hex
property int: int

Get the UUID as a 128-bit integer.

Return type

int

Returns

An integer value.

property is_safe: uuid.SafeUUID

Get an enum indicating whether the UUID has been generated in a way that is safe.

Return type

uuid.SafeUUID

Returns

A SafeUUID value.

items() → a set-like object providing a view on D's items
keys() → a set-like object providing a view on D's keys
property node
async resolve(force=False, **kwargs)[source]

Resolve the instance.

Parameters

  • force (bool) – If True, the resolution will be performed also if it is not necessary.

  • kwargs – Additional named arguments.

Return type

None

Returns

This method does not return anything.

property resolved: bool

Check if the instance is already resolved.

Return type

bool

Returns

True if resolved or False otherwise.

property time
property time_hi_version
property time_low
property time_mid
classmethod to_avro_bytes(models)

Create a bytes representation of the given object instances.

Parameters

models (list[~T]) – A sequence of minos models.

Return type

bytes

Returns

A bytes object.

classmethod to_avro_str(models)

Build the avro string representation of the given object instances.

Parameters

models (list[~T]) – A sequence of minos models.

Return type

str

Returns

A bytes object.

type_hints
type_hints_parameters = (~MT,)
property urn
property uuid: uuid.UUID

Get the UUID that identifies the Model.

Return type

uuid.UUID

Returns

values() → an object providing a view on D's values
property variant
property version