orionis.foundation.directory.Directory

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

Constructor: Directory(app)

View In Hierarchy

Expose the configured application directories.

Method	`__init__`	Snapshot all resolved application paths from their shared mapping.
Method	`_path`	Return a cached path for a configured key.
Method	`app`	Return the application directory.
Method	`appConsole`	Return the application console directory.
Method	`appConsoleCommands`	Return the application console commands directory.
Method	`appConsoleListeners`	Return the application console listeners directory.
Method	`appContracts`	Return the application contracts directory.
Method	`appExceptions`	Return the application exceptions directory.
Method	`appFacades`	Return the application facades directory.
Method	`appHttp`	Return the application HTTP directory.
Method	`appHttpControllers`	Return the application controllers directory.
Method	`appHttpMiddleware`	Return the application HTTP middleware directory.
Method	`appHttpSchemas`	Return the application HTTP schemas directory.
Method	`appHttpSchemasRules`	Return the application HTTP schema rules directory.
Method	`appJobs`	Return the application jobs directory.
Method	`appMcp`	Return the MCP application directory.
Method	`appMcpPrompts`	Return the MCP prompt declaration directory.
Method	`appMcpResources`	Return the MCP resource declaration directory.
Method	`appMcpServers`	Return the MCP server declaration directory.
Method	`appMcpTools`	Return the MCP tool declaration directory.
Method	`appModels`	Return the application models directory.
Method	`appNotifications`	Return the application notifications directory.
Method	`appProviders`	Return the application providers directory.
Method	`appServices`	Return the application services directory.
Method	`bootstrap`	Return the bootstrap directory.
Method	`config`	Return the configuration directory.
Method	`database`	Return the database directory.
Method	`databaseFactories`	Return the database factories directory.
Method	`databaseMigrations`	Return the database migrations directory.
Method	`databaseSchemas`	Return the database schemas directory.
Method	`databaseSeeders`	Return the database seeders directory.
Method	`resources`	Return the resources directory.
Method	`resourcesCss`	Return the resources CSS directory.
Method	`resourcesJs`	Return the resources JavaScript directory.
Method	`resourcesLang`	Return the resources language directory.
Method	`resourcesViews`	Return the resources views directory.
Method	`root`	Return the application root directory.
Method	`routes`	Return the routes directory.
Method	`storage`	Return the storage directory.
Method	`storageApp`	Return the storage application directory.
Method	`storageAppPrivate`	Return the private storage application directory.
Method	`storageAppPublic`	Return the public storage application directory.
Method	`storageFramework`	Return the framework storage directory.
Method	`storageLogs`	Return the storage logs directory.
Method	`tests`	Return the tests directory.
Class Variable	`__slots__`	Undocumented
Instance Variable	`_all_paths`	Undocumented

def __init__(self, app: IApplication): (source) ¶

Snapshot all resolved application paths from their shared mapping.

Parameters
app:`IApplication`	Application instance that owns the configured paths.

Returns
`None`	Initialize directory accessors with an independent path mapping.

def _path(self, key: str) -> Path: (source) ¶

Return a cached path for a configured key.

Parameters
key:`str`	Key registered in the application path configuration.

Returns
`Path`	Configured path for `key`.

def app(self) -> Path: (source) ¶

overrides orionis.foundation.contracts.directory.IDirectory.app

Return the application directory.

Returns
`Path`	The configured application directory.

def appConsole(self) -> Path: (source) ¶

overrides orionis.foundation.contracts.directory.IDirectory.appConsole

Return the application console directory.

Returns
`Path`	The configured application console directory.

def appConsoleCommands(self) -> Path: (source) ¶

overrides orionis.foundation.contracts.directory.IDirectory.appConsoleCommands

Return the application console commands directory.

Returns
`Path`	The configured application console commands directory.

def appConsoleListeners(self) -> Path: (source) ¶

overrides orionis.foundation.contracts.directory.IDirectory.appConsoleListeners

Return the application console listeners directory.

Returns
`Path`	The configured application console listeners directory.

def appContracts(self) -> Path: (source) ¶

overrides orionis.foundation.contracts.directory.IDirectory.appContracts

Return the application contracts directory.

Returns
`Path`	The configured application contracts directory.

def appExceptions(self) -> Path: (source) ¶

overrides orionis.foundation.contracts.directory.IDirectory.appExceptions

Return the application exceptions directory.

Returns
`Path`	The configured application exceptions directory.

def appFacades(self) -> Path: (source) ¶

overrides orionis.foundation.contracts.directory.IDirectory.appFacades

Return the application facades directory.

Returns
`Path`	The configured application facades directory.

def appHttp(self) -> Path: (source) ¶

overrides orionis.foundation.contracts.directory.IDirectory.appHttp

Return the application HTTP directory.

Returns
`Path`	The configured application HTTP directory.

def appHttpControllers(self) -> Path: (source) ¶

overrides orionis.foundation.contracts.directory.IDirectory.appHttpControllers

Return the application controllers directory.

Returns
`Path`	The configured application controllers directory.

def appHttpMiddleware(self) -> Path: (source) ¶

overrides orionis.foundation.contracts.directory.IDirectory.appHttpMiddleware

Return the application HTTP middleware directory.

Returns
`Path`	The configured application HTTP middleware directory.

def appHttpSchemas(self) -> Path: (source) ¶

overrides orionis.foundation.contracts.directory.IDirectory.appHttpSchemas

Return the application HTTP schemas directory.

Returns
`Path`	The configured application HTTP schemas directory.

def appHttpSchemasRules(self) -> Path: (source) ¶

overrides orionis.foundation.contracts.directory.IDirectory.appHttpSchemasRules

Return the application HTTP schema rules directory.

Returns
`Path`	The configured application HTTP schema rules directory.

def appJobs(self) -> Path: (source) ¶

overrides orionis.foundation.contracts.directory.IDirectory.appJobs

Return the application jobs directory.

Returns
`Path`	The configured application jobs directory.

def appMcp(self) -> Path: (source) ¶

overrides orionis.foundation.contracts.directory.IDirectory.appMcp

Return the MCP application directory.

Returns
`Path`	The configured application directory.

def appMcpPrompts(self) -> Path: (source) ¶

overrides orionis.foundation.contracts.directory.IDirectory.appMcpPrompts

Return the MCP prompt declaration directory.

Returns
`Path`	The configured MCP declarations directory.

def appMcpResources(self) -> Path: (source) ¶

overrides orionis.foundation.contracts.directory.IDirectory.appMcpResources

Return the MCP resource declaration directory.

Returns
`Path`	The configured MCP declarations directory.

def appMcpServers(self) -> Path: (source) ¶

overrides orionis.foundation.contracts.directory.IDirectory.appMcpServers

Return the MCP server declaration directory.

Returns
`Path`	The configured MCP declarations directory.

def appMcpTools(self) -> Path: (source) ¶

overrides orionis.foundation.contracts.directory.IDirectory.appMcpTools

Return the MCP tool declaration directory.

Returns
`Path`	The configured MCP declarations directory.

def appModels(self) -> Path: (source) ¶

overrides orionis.foundation.contracts.directory.IDirectory.appModels

Return the application models directory.

Returns
`Path`	The configured application models directory.

def appNotifications(self) -> Path: (source) ¶

overrides orionis.foundation.contracts.directory.IDirectory.appNotifications

Return the application notifications directory.

Returns
`Path`	The configured application notifications directory.

def appProviders(self) -> Path: (source) ¶

overrides orionis.foundation.contracts.directory.IDirectory.appProviders

Return the application providers directory.

Returns
`Path`	The configured application providers directory.

def appServices(self) -> Path: (source) ¶

overrides orionis.foundation.contracts.directory.IDirectory.appServices

Return the application services directory.

Returns
`Path`	The configured application services directory.

def bootstrap(self) -> Path: (source) ¶

overrides orionis.foundation.contracts.directory.IDirectory.bootstrap

Return the bootstrap directory.

Returns
`Path`	The configured bootstrap directory.

def config(self) -> Path: (source) ¶

overrides orionis.foundation.contracts.directory.IDirectory.config

Return the configuration directory.

Returns
`Path`	The configured configuration directory.

def database(self) -> Path: (source) ¶

overrides orionis.foundation.contracts.directory.IDirectory.database

Return the database directory.

Returns
`Path`	The configured database directory.

def databaseFactories(self) -> Path: (source) ¶

overrides orionis.foundation.contracts.directory.IDirectory.databaseFactories

Return the database factories directory.

Returns
`Path`	The configured database factories directory.

def databaseMigrations(self) -> Path: (source) ¶

overrides orionis.foundation.contracts.directory.IDirectory.databaseMigrations

Return the database migrations directory.

Returns
`Path`	The configured database migrations directory.

def databaseSchemas(self) -> Path: (source) ¶

overrides orionis.foundation.contracts.directory.IDirectory.databaseSchemas

Return the database schemas directory.

Returns
`Path`	The configured database schemas directory.

def databaseSeeders(self) -> Path: (source) ¶

overrides orionis.foundation.contracts.directory.IDirectory.databaseSeeders

Return the database seeders directory.

Returns
`Path`	The configured database seeders directory.

def resources(self) -> Path: (source) ¶

overrides orionis.foundation.contracts.directory.IDirectory.resources

Return the resources directory.

Returns
`Path`	The configured resources directory.

def resourcesCss(self) -> Path: (source) ¶

overrides orionis.foundation.contracts.directory.IDirectory.resourcesCss

Return the resources CSS directory.

Returns
`Path`	The configured resources CSS directory.

def resourcesJs(self) -> Path: (source) ¶

overrides orionis.foundation.contracts.directory.IDirectory.resourcesJs

Return the resources JavaScript directory.

Returns
`Path`	The configured resources JavaScript directory.

def resourcesLang(self) -> Path: (source) ¶

overrides orionis.foundation.contracts.directory.IDirectory.resourcesLang

Return the resources language directory.

Returns
`Path`	The configured resources language directory.

def resourcesViews(self) -> Path: (source) ¶

overrides orionis.foundation.contracts.directory.IDirectory.resourcesViews

Return the resources views directory.

Returns
`Path`	The configured resources views directory.

def root(self) -> Path: (source) ¶

overrides orionis.foundation.contracts.directory.IDirectory.root

Return the application root directory.

Returns
`Path`	The configured application root directory.

def routes(self) -> Path: (source) ¶

overrides orionis.foundation.contracts.directory.IDirectory.routes

Return the routes directory.

Returns
`Path`	The configured routes directory.

def storage(self) -> Path: (source) ¶

overrides orionis.foundation.contracts.directory.IDirectory.storage

Return the storage directory.

Returns
`Path`	The configured storage directory.

def storageApp(self) -> Path: (source) ¶

overrides orionis.foundation.contracts.directory.IDirectory.storageApp

Return the storage application directory.

Returns
`Path`	The configured storage application directory.

def storageAppPrivate(self) -> Path: (source) ¶

overrides orionis.foundation.contracts.directory.IDirectory.storageAppPrivate

Return the private storage application directory.

Returns
`Path`	The configured private storage application directory.

def storageAppPublic(self) -> Path: (source) ¶

overrides orionis.foundation.contracts.directory.IDirectory.storageAppPublic

Return the public storage application directory.

Returns
`Path`	The configured public storage application directory.

def storageFramework(self) -> Path: (source) ¶

overrides orionis.foundation.contracts.directory.IDirectory.storageFramework

Return the framework storage directory.

Returns
`Path`	The configured framework storage directory.

def storageLogs(self) -> Path: (source) ¶

overrides orionis.foundation.contracts.directory.IDirectory.storageLogs

Return the storage logs directory.

Returns
`Path`	The configured storage logs directory.

def tests(self) -> Path: (source) ¶

overrides orionis.foundation.contracts.directory.IDirectory.tests

Return the tests directory.

Returns
`Path`	The configured tests directory.

__slots__: tuple[str, ...] = (source) ¶

overrides orionis.foundation.contracts.directory.IDirectory.__slots__

Undocumented

_all_paths = (source) ¶

Undocumented