orionis.support.types.StdClass

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 StdClass(IStdClass): (source)

Constructors: StdClass.fromDict(dictionary), StdClass(**kwargs)

View In Hierarchy

Undocumented

Class Method	`__init_subclass__`	Rebuild the reserved-names set for every subclass.
Class Method	`fromDict`	Create a StdClass instance from a dictionary.
Method	`__eq__`	Compare this object with another for attribute equality.
Method	`__hash__`	Compute the hash value of the object based on its attributes.
Method	`__init__`	Initialize attributes from keyword arguments.
Method	`__repr__`	Return an unambiguous string representation for debugging.
Method	`__str__`	Return a readable string representation of the object.
Method	`remove`	Remove one or more attributes from the object.
Method	`toDict`	Convert the object's attributes to a dictionary.
Method	`update`	Update the object's attributes dynamically.
Class Variable	`RESERVED`	Undocumented

Inherited from IStdClass:

Class Variable __slots__ Undocumented

@classmethod

def __init_subclass__(cls, **kwargs: object): (source) ¶

Rebuild the reserved-names set for every subclass.

Parameters
**kwargs:`object`	Keyword arguments forwarded to the parent hook.

Returns
`None`	Complete the documented operation without returning a value.

@classmethod

def fromDict(cls, dictionary: dict) -> StdClass: (source) ¶

Create a StdClass instance from a dictionary.

Parameters
dictionary:`dict`	Dictionary containing attribute names and values.

Returns
`StdClass`	A new StdClass instance with attributes set from the dictionary.

def __eq__(self, other: object) -> bool: (source) ¶

Compare this object with another for attribute equality.

Parameters
other:`object`	Object to compare with.

Returns
`bool`	True if both objects have the same attributes and values, otherwise False.

def __hash__(self) -> int: (source) ¶

Compute the hash value of the object based on its attributes.

Returns
`int`	Hash value computed from the object's attributes.

def __init__(self, **kwargs: object): (source) ¶

Initialize attributes from keyword arguments.

Parameters
**kwargs:`object`	Arbitrary keyword arguments to set as attributes.

Returns
`None`	This method does not return a value. The object is initialized in-place.

def __repr__(self) -> str: (source) ¶

Return an unambiguous string representation for debugging.

Returns
`str`	String representation of the object with its attributes.

def __str__(self) -> str: (source) ¶

Return a readable string representation of the object.

Returns
`str`	String showing the object's attributes.

def remove(self, *attributes: str): (source) ¶

overrides orionis.support.types.contracts.std.IStdClass.remove

Remove one or more attributes from the object.

Parameters
*attributes:`str`	Names of the attributes to remove.

Returns
`None`	This method does not return a value. Attributes are removed in-place.

Raises
`AttributeError`	If any of the specified attributes do not exist.

def toDict(self) -> dict: (source) ¶

overrides orionis.support.types.contracts.std.IStdClass.toDict

Convert the object's attributes to a dictionary.

Returns
`dict`	A shallow copy of the object's attributes.

def update(self, **kwargs: object): (source) ¶

overrides orionis.support.types.contracts.std.IStdClass.update

Update the object's attributes dynamically.

Parameters
**kwargs:`object`	Key-value pairs to update or add as attributes.

Returns
`None`	This method does not return a value. Attributes are updated in-place.

Raises
`ValueError`	If an attribute name is reserved or conflicts with a class method.

RESERVED: frozenset = (source) ¶

Undocumented