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.
class BaseEntity: (source)
Known subclasses: orionis.console.Argument, orionis.console.entities.Command, orionis.console.entities.SchedulerEvent, orionis.console.entities.Task, 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.Redshift, 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.http.Redis, 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, orionis.schemas.entities.failure.ValidationFailure, orionis.test.entities.result.TestResult
Constructor: BaseEntity(**kwargs)
Provide a shared constructor, serialization and dataclass metadata.
Notes
Use @dataclass(init=False) on each subclass that should inherit the shared constructor. It accepts only keyword arguments for ordinary fields and public extra attributes; InitVar parameters are not supported. Extras require an instance dictionary, normally provided by slots=False.
Fields marked init=False cannot be supplied by the caller. Their defaults are initialized, or __post_init__ must set them when no default exists. Subclasses are responsible for type validation.
| Class Method | _cached |
Retrieve field definitions and normalized types cached by class. |
| Method | __init__ |
Initialize declared fields and public extra attributes. |
| Method | __post |
Provide a no-op hook for subclass validation and normalization. |
| Method | _dynamic |
Return public instance attributes that are not declared fields. |
| Method | _validate |
Validate names and storage for public extra attributes. |
| Method | get |
Describe declared fields and, optionally, dynamic attributes. |
| Method | to |
Return a recursively copied dictionary of declared and extra values. |
| Class Variable | __slots__ |
Declare that this class introduces no additional instance slots. |
| Class Variable | _orionis |
Cache declared fields and normalized type names for each concrete class. |
Retrieve field definitions and normalized types cached by class.
| Returns | |
tuple[tuple[dataclasses.Field[Any], tuple[str, ...]], ...] | Cached field definitions paired with their normalized type names. |
Initialize declared fields and public extra attributes.
| Parameters | |
**kwargs:object | Values for declared init fields and public extra attributes. |
| Returns | |
None | Initialize declared fields and extras, then run subclass validation. |
| Raises | |
TypeError | If the subclass is not a dataclass, a required field is missing, a non-init field is supplied, an extra name is invalid or reserved, or extras cannot be stored because the instance has no dictionary. |
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.Redshift, 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.http.Redis, 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.RealtimeConfigProvide a no-op hook for subclass validation and normalization.
| Returns | |
None | Leave the initialized fields and extra attributes unchanged. |
Validate names and storage for public extra attributes.
| Parameters | |
names:list[str] | Supplied keyword names that are not declared fields. |
| Returns | |
None | Confirm that all supplied extras have valid names and storage. |
| Raises | |
TypeError | If a name is invalid, private or already defined on the class, or if the instance has no dictionary for the supplied extras. |
Describe declared fields and, optionally, dynamic attributes.
Notes
Declared defaults are evaluated and serialized on each call. Descriptions of dynamic attributes are not cached.
| Parameters | |
includebool, optional | Append descriptions of public extra attributes on this instance, using their current types, None for their defaults, and {"dynamic": True} for their metadata. Defaults to False. |
| Returns | |
list[dict[str, typing.Any]] | Field descriptions containing names, types, defaults, and metadata. |
orionis.introspection.dependencies.entities.signature.Signature, orionis.schemas.entities.failure.ValidationFailureReturn a recursively copied dictionary of declared and extra values.
Notes
Unlike dataclasses.asdict, nested entities include their own public extra attributes. Enum members are replaced by their values, including inside dictionaries, lists and tuples. Declared private fields are included; private extra attributes are not.
This method does not encode JSON or support cyclic entity or container graphs.
| Returns | |
dict[str, typing.Any] | Declared fields and public extra attributes mapped to their values. |