orionis.orm.attributes.AttributesMixin

THE ORIONIS API

Build with clarity.

Explore the building blocks of an async-first Python framework. Every module, class, and method — connected, searchable, and ready to build with.

Explore modules View classes

class documentation

class AttributesMixin: (source)

Known subclasses: orionis.orm.Model

View In Hierarchy

Attribute handling behavior shared by every model.

Provides mass assignment with fillable/guarded enforcement, cast application, and serialization helpers. The mixin operates on the _attributes mapping owned by the model instance.

Method	`exclude`	Return every attribute except the given keys.
Method	`fill`	Mass assign the given attributes honoring the assignment rules.
Method	`getAttribute`	Return a single attribute value through its accessor.
Method	`hasAccessor`	Report whether an attribute is served by an accessor.
Method	`only`	Return a subset of attributes limited to the given keys.
Method	`serialize`	Serialize the model for collection-level serialization.
Method	`setAttribute`	Assign a single attribute applying its mutator and cast.
Method	`toDict`	Serialize the visible attributes into a dictionary.
Method	`toJson`	Serialize the visible attributes into a JSON string.
Class Variable	`__slots__`	Undocumented

def exclude(self, *keys: str) -> dict[str, Any]: (source) ¶

Return every attribute except the given keys.

Parameters
*keys:`str`	Attribute names to exclude.

Returns
`dict`	Attribute values without the excluded keys.

def fill(self, attributes: dict[str, Any]) -> Any: (source) ¶

Mass assign the given attributes honoring the assignment rules.

Parameters
attributes:`dict`	Attribute values keyed by column name.

Returns
`Model`	The same instance, enabling fluent chaining.

Raises
`MassAssignmentException`	If a key is not a column or is guarded from mass assignment.

def getAttribute(self, key: str, default: Any = None) -> Any: (source) ¶

Return a single attribute value through its accessor.

A declared get<Name>Attribute accessor receives the stored value (None for computed attributes with no column) and its return value is what the caller sees.

Parameters
key:`str`	Attribute name.
default:`Any, optional`	Value returned when the attribute is absent.

Returns
`Any`	Attribute value, or the default when absent.

def hasAccessor(self, key: str) -> bool: (source) ¶

Report whether an attribute is served by an accessor.

Parameters
key:`str`	Attribute name.

Returns
`bool`	`True` when the model declares an accessor for the key.

def only(self, *keys: str) -> dict[str, Any]: (source) ¶

Return a subset of attributes limited to the given keys.

Parameters
*keys:`str`	Attribute names to include.

Returns
`dict`	Attribute values for the requested keys that exist.

def serialize(self) -> dict[str, Any]: (source) ¶

Serialize the model for collection-level serialization.

Returns
`dict`	Visible attribute values keyed by name.

def setAttribute(self, key: str, value: Any): (source) ¶

Assign a single attribute applying its mutator and cast.

A declared set<Name>Attribute mutator runs first and its return value is what gets stored; the declared cast is applied afterwards so both features compose.

Parameters
key:`str`	Attribute name.
value:`Any`	Raw value to assign.

Returns
`None`	This method does not return a value.

def toDict(self) -> dict[str, Any]: (source) ¶

Serialize the visible attributes into a dictionary.

Accessors are applied, attributes listed in hidden are omitted, and accessor-backed attributes listed in appends are added even though they have no column.

Returns
`dict`	Visible attribute values keyed by name.

def toJson(self, **kwargs: Any) -> str: (source) ¶

Serialize the visible attributes into a JSON string.

Parameters
**kwargs:`Any`	Additional keyword arguments forwarded to `json.dumps`.

Returns
`str`	JSON representation of the visible attributes.

__slots__: tuple = (source) ¶

overridden in orionis.orm.Model

Undocumented