orionis.support.entities.BaseEntity

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

View In Hierarchy

Provide dictionary serialization and field metadata for dataclass entities.

Class Method	`_cachedFieldMetadata`	Retrieve field definitions and normalized types cached by class.
Method	`__post_init__`	Provide a no-op initialization hook for subclass validation.
Method	`getFields`	Describe field names, normalized types, defaults, and metadata.
Method	`toDict`	Convert the dataclass instance to a recursively copied dictionary.
Class Variable	`__slots__`	Undocumented

@classmethod

def _cachedFieldMetadata(cls) -> tuple[tuple[Field[Any], tuple[str, ...]], ...]: (source) ¶

Retrieve field definitions and normalized types cached by class.

Returns
`tuple[tuple[Field[Any], tuple[str, ...]], ...]`	Cached field definitions paired with their normalized type names.

def __post_init__(self): (source) ¶

overridden in orionis.console.Argument, orionis.console.entities.SchedulerEvent, orionis.console.entities.TaskEvent, orionis.container.entities.Binding, orionis.foundation.config.app.App, orionis.foundation.config.auth.Auth, orionis.foundation.config.auth.Identity, orionis.foundation.config.auth.PasswordReset, orionis.foundation.config.auth.RememberAuth, orionis.foundation.config.auth.SessionAuth, orionis.foundation.config.auth.Tokens, orionis.foundation.config.cache.Cache, orionis.foundation.config.cache.Database, orionis.foundation.config.cache.File, orionis.foundation.config.cache.Memcached, orionis.foundation.config.cache.Memory, orionis.foundation.config.cache.Redis, orionis.foundation.config.cache.Stores, orionis.foundation.config.database.Connections, orionis.foundation.config.database.Database, orionis.foundation.config.database.MySQL, orionis.foundation.config.database.Oracle, orionis.foundation.config.database.PGSQL, orionis.foundation.config.database.SQLite, orionis.foundation.config.database.SQLServer, orionis.foundation.config.filesystems.Azure, orionis.foundation.config.filesystems.Disks, orionis.foundation.config.filesystems.Filesystems, orionis.foundation.config.filesystems.GCS, orionis.foundation.config.filesystems.Local, orionis.foundation.config.filesystems.Public, orionis.foundation.config.filesystems.S3, orionis.foundation.config.hashing.Argon2, orionis.foundation.config.hashing.Bcrypt, orionis.foundation.config.hashing.Hashing, orionis.foundation.config.http.Cors, orionis.foundation.config.http.HTTP, orionis.foundation.config.http.HTTPBodyLimits, orionis.foundation.config.http.HTTPCsrf, orionis.foundation.config.http.HTTPProxies, orionis.foundation.config.http.HTTPRateLimit, orionis.foundation.config.http.HTTPSecurity, orionis.foundation.config.http.HTTPWebSocket, orionis.foundation.config.logging.Channels, orionis.foundation.config.logging.Chunked, orionis.foundation.config.logging.Daily, orionis.foundation.config.logging.Hourly, orionis.foundation.config.logging.Logging, orionis.foundation.config.logging.Monthly, orionis.foundation.config.logging.Stack, orionis.foundation.config.logging.Weekly, orionis.foundation.config.mail.File, orionis.foundation.config.mail.FromAddress, orionis.foundation.config.mail.Mail, orionis.foundation.config.mail.Mailers, orionis.foundation.config.mail.Smtp, orionis.foundation.config.queue.Connections, orionis.foundation.config.queue.Database, orionis.foundation.config.queue.Failed, orionis.foundation.config.queue.Queue, orionis.foundation.config.queue.Redis, orionis.foundation.config.queue.Sync, orionis.foundation.config.queue.Worker, orionis.foundation.config.scheduler.Database, orionis.foundation.config.scheduler.Memory, orionis.foundation.config.scheduler.Redis, orionis.foundation.config.scheduler.Scheduler, orionis.foundation.config.scheduler.Stores, orionis.foundation.config.session.Session, orionis.foundation.config.startup.Configuration, orionis.foundation.config.testing.Testing, orionis.foundation.config.view.View, orionis.introspection.dependencies.entities.signature.Signature, orionis.mcp.config.McpConfig, orionis.realtime.config.RealtimeConfig

Provide a no-op initialization hook for subclass validation.

Returns
`None`	No value; subclasses may override this hook for validation.

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

Describe field names, normalized types, defaults, and metadata.

Returns
`list[dict[str, Any]]`	Field descriptions containing names, types, defaults, and metadata.

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

overridden in orionis.introspection.dependencies.entities.signature.Signature, orionis.schemas.entities.failure.ValidationFailure

Convert the dataclass instance to a recursively copied dictionary.

Returns
`dict[str, Any]`	A recursively copied mapping of field names to values.

__slots__: tuple = (source) ¶

Undocumented