minos.aggregate.entities.collections

Classes

EntitySet

Entity set class.
class EntitySet[source]

Bases: IncrementalSet[T]

Entity set class.

data: dict[str, T]
__init__(data=None, *args, **kwargs)[source]

Class constructor.

Parameters

  • kwargs – Named arguments to be set as model attributes.

  • data (Optional[Iterable[T]]) –

add(entity)[source]

Add an entity.

Parameters

entity (T) – The entity to be added.

Returns

This method does not return anything.

Return type

None

discard(entity)[source]

Discard an entity.

Parameters

entity (T) – The entity to be discarded.

Returns

This method does not return anything.

Return type

None

get(uuid)[source]

Get an entity by identifier.

Parameters

uuid (UUID) – The identifier of the entity.

Returns

A entity instance.

Return type

T

diff(another)[source]

Compute the difference between self and another entity set.

Parameters

another (EntitySet[T]) – Another entity set instance.

Returns

The difference between both entity sets.

Return type

IncrementalSetDiff

property data_cls: Optional[type]

Get data class if available.

Returns

A model type.

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

Encode schema with the given encoder.

Parameters

  • encoder (SchemaEncoder) – The encoder instance.

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

Returns

The encoded schema of the instance.

Return type

Any

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

Encode data with the given encoder.

Parameters

  • encoder (DataEncoder) – The encoder instance.

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

Returns

The encoded data of the instance.

Return type

Any

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

Decode data with the given decoder.

Parameters

  • decoder (DataDecoder) – The decoder instance.

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

  • type – The data type.

  • type_ (ModelType) –

Returns

A decoded instance.

Return type

IncrementalSet

property avro_bytes: bytes

Generate bytes representation of the current instance.

Returns

A bytes object.

property avro_data: dict[str, Any]

Compute the avro data of the model.

Returns

A dictionary object.

property avro_str: str

Generate bytes representation of the current instance.

Returns

A bytes object.

classname = 'minos.aggregate.entities.collections.EntitySet'
clear()

This is slow (creates N new iterators!) but effective.

classmethod decode_schema(decoder, target, **kwargs)

Decode schema with the given encoder.

Parameters

  • decoder (SchemaDecoder) – The decoder instance.

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

Returns

The decoded schema as a type.

Return type

ModelType

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

Fields getter

classmethod from_avro(schema, data)

Build a new instance from the avro schema and data.

Parameters

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

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

Returns

A new DynamicModel instance.

Return type

T

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.

  • kwargs – Additional named arguments.

Returns

A single instance or a sequence of instances.

Return type

Union[T, list[~T]]

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.

Returns

A single instance or a sequence of instances.

Return type

Union[T, list[~T]]

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

Build a DeclarativeModel from a ModelType.

Parameters

  • model_type (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.

Returns

A new DeclarativeModel instance.

Return type

T

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

Build a Model from a TypeDict and data.

Parameters

  • typed_dict (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.

Returns

A new DataTransferObject instance.

Return type

T

isdisjoint(other)

Return True if two sets have a null intersection.

items() → a set-like object providing a view on D's items
keys() → a set-like object providing a view on D's keys
pop()

Return the popped value. Raise KeyError if empty.

remove(value)

Remove an element. If not a member, raise a KeyError.

classmethod to_avro_bytes(models)

Create a bytes representation of the given object instances.

Parameters

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

Returns

A bytes object.

Return type

bytes

classmethod to_avro_str(models)

Build the avro string representation of the given object instances.

Parameters

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

Returns

A bytes object.

Return type

str

type_hints_parameters = (~T,)
values() → an object providing a view on D's values