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 documentation
class File(BaseEntity): (source)
Represent the configuration entity for a file-based cache store.
| Method | __post |
Validate and initialise the path attribute after dataclass init. |
| Instance Variable | driver |
The driver type for the cache store. Defaults to 'file'. |
| Instance Variable | path |
The filesystem path where cache data will be stored. Defaults to 'storage/framework/cache/data'. |
Inherited from BaseEntity:
| Class Method | _cached |
Retrieve field definitions and normalized types cached by class. |
| Method | get |
Describe field names, normalized types, defaults, and metadata. |
| Method | to |
Convert the dataclass instance to a recursively copied dictionary. |
| Class Variable | __slots__ |
Undocumented |
Validate and initialise the path attribute after dataclass init.
Ensure path is a non-empty string. The selected cache driver creates the backing directory when it is initialized.
| Returns | |
None | Validate the configuration without changing the filesystem. |
| Raises | |
TypeError | If path is not a str. |
ValueError | If path is an empty string. |