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.
Define the contract for a directory on a storage disk.
A directory object encapsulates its canonical path and delegates every operation to the driver of the disk it belongs to. Listing methods always return domain objects — never plain strings.
| Async Method | all |
List every directory contained in the directory tree. |
| Async Method | all |
List every file contained in the directory tree. |
| Async Method | create |
Create the directory, including any missing parents. |
| Async Method | delete |
Recursively delete the directory and its contents. |
| Async Method | directories |
List the directories directly contained in the directory. |
| Async Method | exists |
Check whether the directory exists on its disk. |
| Async Method | files |
List the files directly contained in the directory. |
| Method | path |
Return the canonical root-relative path of the directory. |
| Class Variable | __slots__ |
Declare that this class introduces no additional instance slots. |
orionis.storage.DirectoryList every directory contained in the directory tree.
| Returns | |
list[orionis.storage.contracts.IDirectory] | Directory objects for all nested directories, sorted by path. |
orionis.storage.DirectoryList every file contained in the directory tree.
| Returns | |
list[orionis.storage.contracts.IFile] | File objects for all nested files, sorted by path. |
orionis.storage.DirectoryCreate the directory, including any missing parents.
| Returns | |
orionis.storage.contracts.IDirectory | The directory itself, enabling fluent chaining. |
orionis.storage.DirectoryRecursively delete the directory and its contents.
| Returns | |
bool | True if the directory existed and was removed. |
orionis.storage.DirectoryList the directories directly contained in the directory.
| Returns | |
list[orionis.storage.contracts.IDirectory] | Directory objects for every direct child directory, sorted by path. |
orionis.storage.DirectoryCheck whether the directory exists on its disk.
| Returns | |
bool | True if the directory exists. |
orionis.storage.DirectoryList the files directly contained in the directory.
| Returns | |
list[orionis.storage.contracts.IFile] | File objects for every direct child file, sorted by path. |
orionis.storage.DirectoryReturn the canonical root-relative path of the directory.
| Returns | |
str | Normalized path relative to the disk root. The empty string denotes the disk root itself. |
orionis.storage.DirectoryDeclare that this class introduces no additional instance slots.