-
orionis
index.html
Package
Package
PUBLIC
Expose Orionis framework services through lazy public imports.
-
orionis._exports
orionis._exports.html
Module
Module
PUBLIC
Resolve public package exports lazily and retain their original identities.
-
orionis.aio
orionis.aio.html
Package
Package
PUBLIC
Group the aio components and public imports.
-
orionis.aio.loop
orionis.aio.loop.module.html
Module
Module
PUBLIC
Thread-safe, platform-aware asyncio event loop manager for the Orionis Framework.
-
orionis.auth
orionis.auth.html
Package
Package
PUBLIC
Group the auth components and public imports.
-
orionis.auth.authorization
orionis.auth.authorization.html
Package
Package
PUBLIC
Group the auth authorization components and public imports.
-
orionis.auth.authorization.authorizer
orionis.auth.authorization.authorizer.html
Module
Module
PUBLIC
Answer authorization questions for a given request context.
-
orionis.auth.authorization.policy
orionis.auth.authorization.policy.module.html
Module
Module
PUBLIC
Base class for resource policies.
-
orionis.auth.authorization.registrar
orionis.auth.authorization.registrar.html
Module
Module
PUBLIC
Create permissions and roles, and attach them to identities.
-
orionis.auth.authorization.registry
orionis.auth.authorization.registry.html
Module
Module
PUBLIC
Map resource classes to the policy classes protecting them.
-
orionis.auth.authorization.repository
orionis.auth.authorization.repository.html
Module
Module
PUBLIC
Load permissions and roles from the framework authorization tables.
-
orionis.auth.authorization.schema
orionis.auth.authorization.schema.html
Module
Module
PUBLIC
Build the framework-owned role and permission storage definitions.
-
orionis.auth.authorization.snapshot
orionis.auth.authorization.snapshot.html
Module
Module
PUBLIC
Hold the immutable authorization picture of a single request.
-
orionis.auth.concerns
orionis.auth.concerns.html
Package
Package
PUBLIC
Group the auth concerns components and public imports.
-
orionis.auth.concerns.authenticatable
orionis.auth.concerns.authenticatable.module.html
Module
Module
PUBLIC
Turn any Orionis model into an authenticatable identity.
-
orionis.auth.concerns.authorizable
orionis.auth.concerns.authorizable.module.html
Module
Module
PUBLIC
Let any Orionis model own permissions and roles.
-
orionis.auth.concerns.functions
orionis.auth.concerns.functions.html
Module
Module
PUBLIC
Provide auth concerns operations.
-
orionis.auth.concerns.must_verify_email
orionis.auth.concerns.must_verify_email.html
Module
Module
PUBLIC
Require identities to verify their email address before activation.
-
orionis.auth.context
orionis.auth.context.html
Package
Package
PUBLIC
Group the auth context components and public imports.
-
orionis.auth.context.context
orionis.auth.context.context.html
Module
Module
PUBLIC
Hold the authenticated state of one request.
-
orionis.auth.context.functions
orionis.auth.context.functions.html
Module
Module
PUBLIC
Provide auth context operations.
-
orionis.auth.contracts
orionis.auth.contracts.html
Package
Package
PUBLIC
Resolve authentication contracts without creating entity import cycles.
-
orionis.auth.contracts.authenticatable
orionis.auth.contracts.authenticatable.html
Module
Module
PUBLIC
Define the minimum surface an application identity must expose.
-
orionis.auth.contracts.authorizable
orionis.auth.contracts.authorizable.html
Module
Module
PUBLIC
Define how an identity is addressed by the authorization tables.
-
orionis.auth.contracts.authorizer
orionis.auth.contracts.authorizer.html
Module
Module
PUBLIC
Define the component answering authorization questions.
-
orionis.auth.contracts.context
orionis.auth.contracts.context.html
Module
Module
PUBLIC
Define the authenticated state bound to a single request.
-
orionis.auth.contracts.guard
orionis.auth.contracts.guard.html
Module
Module
PUBLIC
Define how an authenticated identity is extracted from a request.
-
orionis.auth.contracts.identity_provider
orionis.auth.contracts.identity_provider.html
Module
Module
PUBLIC
Define how a persisted identity becomes an application object.
-
orionis.auth.contracts.manager
orionis.auth.contracts.manager.html
Module
Module
PUBLIC
Define the public entry point of the authentication module.
-
orionis.auth.contracts.permission_repository
orionis.auth.contracts.permission_repository.html
Module
Module
PUBLIC
Define how the effective permissions of an identity are loaded.
-
orionis.auth.contracts.policy
orionis.auth.contracts.policy.html
Module
Module
PUBLIC
Define the contract shared by every resource policy.
-
orionis.auth.contracts.session_guard
orionis.auth.contracts.session_guard.html
Module
Module
PUBLIC
Define the stateful operations supported by session authentication.
-
orionis.auth.contracts.snapshot
orionis.auth.contracts.snapshot.html
Module
Module
PUBLIC
Define the immutable authorization picture of a single request.
-
orionis.auth.contracts.token_repository
orionis.auth.contracts.token_repository.html
Module
Module
PUBLIC
Define the persistence operations of personal access tokens.
-
orionis.auth.entities
orionis.auth.entities.html
Package
Package
PUBLIC
Group the auth entities components and public imports.
-
orionis.auth.entities.access_token
orionis.auth.entities.access_token.html
Module
Module
PUBLIC
Describe a stored personal access token.
-
orionis.auth.entities.guard_result
orionis.auth.entities.guard_result.html
Module
Module
PUBLIC
Carry what a guard learned about the incoming request.
-
orionis.auth.entities.new_access_token
orionis.auth.entities.new_access_token.html
Module
Module
PUBLIC
Pair a freshly issued token with its plain text value.
-
orionis.auth.exceptions
orionis.auth.exceptions.html
Module
Module
PUBLIC
Provide auth operations.
-
orionis.auth.guards
orionis.auth.guards.html
Package
Package
PUBLIC
Group the auth guards components and public imports.
-
orionis.auth.guards.session_guard
orionis.auth.guards.session_guard.html
Module
Module
PUBLIC
Resolve the identity of web requests from the HTTP session.
-
orionis.auth.guards.token_guard
orionis.auth.guards.token_guard.html
Module
Module
PUBLIC
Resolve the identity of API requests from a personal access token.
-
orionis.auth.identity
orionis.auth.identity.html
Package
Package
PUBLIC
Group the auth identity components and public imports.
-
orionis.auth.identity.provider
orionis.auth.identity.provider.html
Module
Module
PUBLIC
Resolve identities from an Orionis model declared in configuration.
-
orionis.auth.manager
orionis.auth.manager.html
Module
Module
PUBLIC
Expose authentication and authorization to application code.
-
orionis.auth.middleware
orionis.auth.middleware.html
Package
Package
PUBLIC
Group the auth middleware components and public imports.
-
orionis.auth.middleware.authenticate
orionis.auth.middleware.authenticate.html
Module
Module
PUBLIC
Provide auth middleware operations.
-
orionis.auth.middleware.authorize
orionis.auth.middleware.authorize.html
Module
Module
PUBLIC
Provide auth middleware operations.
-
orionis.auth.middleware.guest
orionis.auth.middleware.guest.html
Module
Module
PUBLIC
Keep web login and registration routes restricted to guests.
-
orionis.auth.middleware.policy
orionis.auth.middleware.policy.html
Module
Module
PUBLIC
Gate a route behind a policy ability declared on a resource class.
-
orionis.auth.middleware.resolve_identity
orionis.auth.middleware.resolve_identity.html
Module
Module
PUBLIC
Provide auth middleware operations.
-
orionis.auth.passwords
orionis.auth.passwords.html
Package
Package
PUBLIC
Group the auth passwords components and public imports.
-
orionis.auth.passwords.broker
orionis.auth.passwords.broker.html
Module
Module
PUBLIC
Issue hashed credentials and consume them with the password atomically.
-
orionis.auth.passwords.schema
orionis.auth.passwords.schema.html
Module
Module
PUBLIC
Build the framework-owned password-reset token storage definition.
-
orionis.auth.provider
orionis.auth.provider.html
Module
Module
PUBLIC
Service provider wiring the authentication module.
-
orionis.auth.remember
orionis.auth.remember.html
Module
Module
PUBLIC
Store expiring token digests and rotate them on persistent login.
-
orionis.auth.tokens
orionis.auth.tokens.html
Package
Package
PUBLIC
Group the auth tokens components and public imports.
-
orionis.auth.tokens.functions
orionis.auth.tokens.functions.html
Module
Module
PUBLIC
Provide auth tokens operations.
-
orionis.auth.tokens.lookup
orionis.auth.tokens.lookup.html
Module
Module
PUBLIC
Provide auth tokens operations through lookup_owner.
-
orionis.auth.tokens.repository
orionis.auth.tokens.repository.html
Module
Module
PUBLIC
Persist personal access tokens through the Orionis query builder.
-
orionis.auth.tokens.schema
orionis.auth.tokens.schema.html
Module
Module
PUBLIC
Provide auth tokens operations through build_tokens_table.
-
orionis.background
orionis.background.html
Package
Package
PUBLIC
Group the background components and public imports.
-
orionis.background.contracts
orionis.background.contracts.html
Package
Package
PUBLIC
Group the background contracts components and public imports.
-
orionis.background.contracts.task
orionis.background.contracts.task.html
Module
Module
PUBLIC
Define the interface for background task execution.
-
orionis.background.task
orionis.background.task.html
Module
Module
PUBLIC
Represent a background task that can be executed asynchronously.
-
orionis.background.tasks
orionis.background.tasks.html
Module
Module
PUBLIC
Manage and execute a collection of background tasks sequentially.
-
orionis.cache
orionis.cache.html
Package
Package
PUBLIC
Group the cache components and public imports.
-
orionis.cache.cache_manager
orionis.cache.cache_manager.html
Module
Module
PUBLIC
Resolve configured cache stores and reuse their repositories.
-
orionis.cache.contracts
orionis.cache.contracts.html
Package
Package
PUBLIC
Group the cache contracts components and public imports.
-
orionis.cache.contracts.cache_manager
orionis.cache.contracts.cache_manager.html
Module
Module
PUBLIC
Define the contract for cache manager implementations.
-
orionis.cache.contracts.file_based_cache
orionis.cache.contracts.file_based_cache.html
Module
Module
PUBLIC
Define the contract for file based cache implementations.
-
orionis.cache.contracts.repository
orionis.cache.contracts.repository.html
Module
Module
PUBLIC
Define the contract for cache repository implementations.
-
orionis.cache.exceptions
orionis.cache.exceptions.html
Module
Module
PUBLIC
Provide cache operations through CacheException, CacheStoreException.
-
orionis.cache.file_based_cache
orionis.cache.file_based_cache.html
Module
Module
PUBLIC
Persist named cache entries in a filesystem directory.
-
orionis.cache.locks
orionis.cache.locks.html
Package
Package
PUBLIC
Group the cache locks components and public imports.
-
orionis.cache.locks.coalescing
orionis.cache.locks.coalescing.html
Module
Module
PUBLIC
Poll a Redis NX lease rather than relying on process-local waiter events.
-
orionis.cache.locks.lock
orionis.cache.locks.lock.html
Module
Module
PUBLIC
Coordinate cache access through local locks or distributed leases.
-
orionis.cache.provider
orionis.cache.provider.html
Module
Module
PUBLIC
Service provider for the Orionis cache system.
-
orionis.cache.repository
orionis.cache.repository.html
Module
Module
PUBLIC
Async cache repository backed by a configurable storage backend.
-
orionis.cache.serializer
orionis.cache.serializer.html
Module
Module
PUBLIC
Encode and decode cache values with the configured serialization format.
-
orionis.cache.serializers
orionis.cache.serializers.html
Package
Package
PUBLIC
Group the cache serializers components and public imports.
-
orionis.cache.serializers.json
orionis.cache.serializers.json.html
Module
Module
PUBLIC
Serialize cache payloads through msgspec JSON encoding.
-
orionis.cache.stores
orionis.cache.stores.html
Package
Package
PUBLIC
Group the cache stores components and public imports.
-
orionis.cache.stores.database
orionis.cache.stores.database.html
Module
Module
PUBLIC
Store cache entries and atomic lock owners in relational tables.
-
orionis.cache.stores.file
orionis.cache.stores.file.html
Module
Module
PUBLIC
Implement asynchronous cache operations over filesystem entries.
-
orionis.cache.stores.memcached
orionis.cache.stores.memcached.html
Module
Module
PUBLIC
Provide cache stores operations through build.
-
orionis.cache.stores.memory
orionis.cache.stores.memory.html
Module
Module
PUBLIC
Provide cache stores operations through build.
-
orionis.cache.stores.redis
orionis.cache.stores.redis.html
Module
Module
PUBLIC
Provide cache stores operations through build.
-
orionis.console
orionis.console.html
Package
Package
PUBLIC
Group the console components and public imports.
-
orionis.console.args
orionis.console.args.html
Package
Package
PUBLIC
Group the console args components and public imports.
-
orionis.console.args.argument
orionis.console.args.argument.html
Module
Module
PUBLIC
Represent a command-line argument definition.
-
orionis.console.base
orionis.console.base.html
Package
Package
PUBLIC
Group the console base components and public imports.
-
orionis.console.base.command
orionis.console.base.command.html
Module
Module
PUBLIC
Define the metadata and execution hooks shared by console commands.
-
orionis.console.base.contracts
orionis.console.base.contracts.html
Package
Package
PUBLIC
Group the console base contracts components and public imports.
-
orionis.console.base.contracts.command
orionis.console.base.contracts.command.html
Module
Module
PUBLIC
Define the contract for base command implementations.
-
orionis.console.base.contracts.listener
orionis.console.base.contracts.listener.html
Module
Module
PUBLIC
Define the contract for base task listener implementations.
-
orionis.console.base.contracts.scheduler
orionis.console.base.contracts.scheduler.html
Module
Module
PUBLIC
Define the contract for base scheduler implementations.
-
orionis.console.base.listener
orionis.console.base.listener.html
Module
Module
PUBLIC
Provide lifecycle hooks for scheduled task events.
-
orionis.console.base.scheduler
orionis.console.base.scheduler.html
Module
Module
PUBLIC
Provide the base declaration interface for application schedules.
-
orionis.console.bootstrap
orionis.console.bootstrap.html
Module
Module
PUBLIC
Provide console operations.
-
orionis.console.cli
orionis.console.cli.html
Module
Module
PUBLIC
Provide console operations through main.
-
orionis.console.commands
orionis.console.commands.html
Package
Package
PUBLIC
Group the console commands components and public imports.
-
orionis.console.commands.auth
orionis.console.commands.auth.html
Package
Package
PUBLIC
Provide authentication storage administration commands.
-
orionis.console.commands.auth.migrate
orionis.console.commands.auth.migrate.html
Module
Module
PUBLIC
Create the framework authentication tables without removing data.
-
orionis.console.commands.bootstrap
orionis.console.commands.bootstrap.html
Package
Package
PUBLIC
Progressively enable optional application components through Reactor.
-
orionis.console.commands.bootstrap._base
orionis.console.commands.bootstrap._base.html
Module
Module
PUBLIC
Run component bootstrapping through native Reactor output and injection.
-
orionis.console.commands.bootstrap._config
orionis.console.commands.bootstrap._config.html
Module
Module
PUBLIC
Download and validate missing configuration before creating local files.
-
orionis.console.commands.bootstrap._editor
orionis.console.commands.bootstrap._editor.html
Module
Module
PUBLIC
Provide console commands bootstrap operations.
-
orionis.console.commands.bootstrap._paths
orionis.console.commands.bootstrap._paths.html
Module
Module
PUBLIC
Provide console commands bootstrap operations.
-
orionis.console.commands.bootstrap._service
orionis.console.commands.bootstrap._service.html
Module
Module
PUBLIC
Plan bootstrap integration before creating optional project resources.
-
orionis.console.commands.bootstrap.config
orionis.console.commands.bootstrap.config.html
Module
Module
PUBLIC
Recover missing official configuration files from the master branch.
-
orionis.console.commands.bootstrap.lifespan
orionis.console.commands.bootstrap.lifespan.html
Module
Module
PUBLIC
Enable native application lifespan callbacks.
-
orionis.console.commands.bootstrap.routes
orionis.console.commands.bootstrap.routes.html
Module
Module
PUBLIC
Provide console commands bootstrap operations.
-
orionis.console.commands.cache
orionis.console.commands.cache.html
Package
Package
PUBLIC
Provide cache storage administration commands.
-
orionis.console.commands.cache.migrate
orionis.console.commands.cache.migrate.html
Module
Module
PUBLIC
Create the configured framework cache tables without removing data.
-
orionis.console.commands.db
orionis.console.commands.db.html
Package
Package
PUBLIC
Group the console commands db components and public imports.
-
orionis.console.commands.db._inspection
orionis.console.commands.db._inspection.html
Module
Module
PUBLIC
Inspect user objects without opening a separate database engine.
-
orionis.console.commands.db.seed
orionis.console.commands.db.seed.html
Module
Module
PUBLIC
Run pending seeders through the db:seed command.
-
orionis.console.commands.db.show
orionis.console.commands.db.show.html
Module
Module
PUBLIC
Render connection details and a table summary.
-
orionis.console.commands.db.table
orionis.console.commands.db.table.html
Module
Module
PUBLIC
Render a table schema summary.
-
orionis.console.commands.db.wipe
orionis.console.commands.db.wipe.html
Module
Module
PUBLIC
Provide console commands db operations.
-
orionis.console.commands.make
orionis.console.commands.make.html
Package
Package
PUBLIC
Group the console commands make components and public imports.
-
orionis.console.commands.make._base
orionis.console.commands.make._base.html
Module
Module
PUBLIC
Create application files from packaged stubs.
-
orionis.console.commands.make.console
orionis.console.commands.make.console.html
Module
Module
PUBLIC
Generate a custom command for the Orionis CLI.
-
orionis.console.commands.make.console_listener
orionis.console.commands.make.console_listener.html
Module
Module
PUBLIC
Generate a console task listener class.
-
orionis.console.commands.make.contract
orionis.console.commands.make.contract.html
Module
Module
PUBLIC
Generate an application contract class.
-
orionis.console.commands.make.database_migration
orionis.console.commands.make.database_migration.html
Module
Module
PUBLIC
Generate a migration named for its creation date and time.
-
orionis.console.commands.make.database_schema
orionis.console.commands.make.database_schema.html
Module
Module
PUBLIC
Generate a reusable database table definition module.
-
orionis.console.commands.make.database_seeder
orionis.console.commands.make.database_seeder.html
Module
Module
PUBLIC
Generate an application database seeder.
-
orionis.console.commands.make.facade
orionis.console.commands.make.facade.html
Module
Module
PUBLIC
Generate a facade and its typing interface.
-
orionis.console.commands.make.factory
orionis.console.commands.make.factory.html
Module
Module
PUBLIC
Generate an explicitly imported factory for an application model.
-
orionis.console.commands.make.http_controller
orionis.console.commands.make.http_controller.html
Module
Module
PUBLIC
Generate an invokable or resource HTTP controller.
-
orionis.console.commands.make.http_middleware
orionis.console.commands.make.http_middleware.html
Module
Module
PUBLIC
Generate an HTTP middleware class.
-
orionis.console.commands.make.http_schema
orionis.console.commands.make.http_schema.html
Module
Module
PUBLIC
Generate an HTTP validation schema class.
-
orionis.console.commands.make.http_schema_rule
orionis.console.commands.make.http_schema_rule.html
Module
Module
PUBLIC
Generate a custom HTTP validation rule class.
-
orionis.console.commands.make.job
orionis.console.commands.make.job.html
Module
Module
PUBLIC
Generate a serializable application job.
-
orionis.console.commands.make.mail
orionis.console.commands.make.mail.html
Module
Module
PUBLIC
Generate a reusable Mailable class.
-
orionis.console.commands.make.mcp
orionis.console.commands.make.mcp.html
Module
Module
PUBLIC
Provide console commands make operations.
-
orionis.console.commands.make.model
orionis.console.commands.make.model.html
Module
Module
PUBLIC
Generate an ORM model class.
-
orionis.console.commands.make.provider
orionis.console.commands.make.provider.html
Module
Module
PUBLIC
Generate an eager or deferred application provider.
-
orionis.console.commands.make.realtime
orionis.console.commands.make.realtime.html
Module
Module
PUBLIC
Provide console commands make operations.
-
orionis.console.commands.make.service
orionis.console.commands.make.service.html
Module
Module
PUBLIC
Generate an application service class.
-
orionis.console.commands.make.test
orionis.console.commands.make.test.html
Module
Module
PUBLIC
Generate an application test case.
-
orionis.console.commands.mcp
orionis.console.commands.mcp.html
Package
Package
PUBLIC
Group the console commands mcp components and public imports.
-
orionis.console.commands.mcp.list
orionis.console.commands.mcp.list.html
Module
Module
PUBLIC
Describe registered servers without opening their transports.
-
orionis.console.commands.mcp.start
orionis.console.commands.mcp.start.html
Module
Module
PUBLIC
Run one explicitly registered local MCP server.
-
orionis.console.commands.migrate
orionis.console.commands.migrate.html
Package
Package
PUBLIC
Group the console commands migrate components and public imports.
-
orionis.console.commands.migrate.base
orionis.console.commands.migrate.base.html
Module
Module
PUBLIC
Base class shared by every migration console command.
-
orionis.console.commands.migrate.fresh
orionis.console.commands.migrate.fresh.html
Module
Module
PUBLIC
Clear migration and seeder history, then rebuild the schema.
-
orionis.console.commands.migrate.migrate
orionis.console.commands.migrate.migrate.html
Module
Module
PUBLIC
Apply every migration that has not been run yet.
-
orionis.console.commands.migrate.refresh
orionis.console.commands.migrate.refresh.html
Module
Module
PUBLIC
Roll back migrations and immediately apply them again.
-
orionis.console.commands.migrate.reset
orionis.console.commands.migrate.reset.html
Module
Module
PUBLIC
Revert every migration recorded on the connection.
-
orionis.console.commands.migrate.rollback
orionis.console.commands.migrate.rollback.html
Module
Module
PUBLIC
Revert the most recently applied migration batches.
-
orionis.console.commands.migrate.status
orionis.console.commands.migrate.status.html
Module
Module
PUBLIC
Report which migrations are applied and which are pending.
-
orionis.console.commands.queue
orionis.console.commands.queue.html
Package
Package
PUBLIC
Provide queue lifecycle commands for Reactor.
-
orionis.console.commands.queue._signals
orionis.console.commands.queue._signals.html
Module
Module
PUBLIC
Install temporary worker shutdown handlers on the main thread.
-
orionis.console.commands.queue.clear
orionis.console.commands.queue.clear.html
Module
Module
PUBLIC
Clear every pending state from one logical queue.
-
orionis.console.commands.queue.failed
orionis.console.commands.queue.failed.html
Module
Module
PUBLIC
List persistent failed jobs and their original exceptions.
-
orionis.console.commands.queue.forget
orionis.console.commands.queue.forget.html
Module
Module
PUBLIC
Remove one failed job record.
-
orionis.console.commands.queue.migrate
orionis.console.commands.queue.migrate.html
Module
Module
PUBLIC
Create all configured queue tables without removing existing data.
-
orionis.console.commands.queue.retry
orionis.console.commands.queue.retry.html
Module
Module
PUBLIC
Redispatch one failed job through its original connection.
-
orionis.console.commands.queue.work
orionis.console.commands.queue.work.html
Module
Module
PUBLIC
Run an asynchronous worker over prioritized logical queues.
-
orionis.console.commands.route
orionis.console.commands.route.html
Package
Package
PUBLIC
Group the console commands route components and public imports.
-
orionis.console.commands.route.list
orionis.console.commands.route.list.html
Module
Module
PUBLIC
Display registered HTTP routes in URI order.
-
orionis.console.commands.schedule
orionis.console.commands.schedule.html
Package
Package
PUBLIC
Group the console commands schedule components and public imports.
-
orionis.console.commands.schedule.list
orionis.console.commands.schedule.list.html
Module
Module
PUBLIC
Display the application's registered scheduled tasks.
-
orionis.console.commands.schedule.migrate
orionis.console.commands.schedule.migrate.html
Module
Module
PUBLIC
Create the native scheduler task table without starting scheduled tasks.
-
orionis.console.commands.schedule.work
orionis.console.commands.schedule.work.html
Module
Module
PUBLIC
Register and run the application's scheduled tasks.
-
orionis.console.commands.seed
orionis.console.commands.seed.html
Package
Package
PUBLIC
Console commands for database seeders.
-
orionis.console.commands.seed.seed
orionis.console.commands.seed.seed.html
Module
Module
PUBLIC
Apply every database seeder that has not been run yet.
-
orionis.console.commands.serve
orionis.console.commands.serve.html
Package
Package
PUBLIC
Group the console commands serve components and public imports.
-
orionis.console.commands.serve.serve
orionis.console.commands.serve.serve.html
Module
Module
PUBLIC
Start the application server using the selected runtime options.
-
orionis.console.commands.session
orionis.console.commands.session.html
Package
Package
PUBLIC
Provide session storage administration commands.
-
orionis.console.commands.session.migrate
orionis.console.commands.session.migrate.html
Module
Module
PUBLIC
Create the configured framework session table without removing data.
-
orionis.console.commands.support
orionis.console.commands.support.html
Package
Package
PUBLIC
Group the console commands support components and public imports.
-
orionis.console.commands.support._clear
orionis.console.commands.support._clear.html
Module
Module
PUBLIC
Provide console commands support operations through clear_files.
-
orionis.console.commands.support.about
orionis.console.commands.support.about.html
Module
Module
PUBLIC
Display the installed framework and runtime version information.
-
orionis.console.commands.support.clear_cache
orionis.console.commands.support.clear_cache.html
Module
Module
PUBLIC
Clear entries from the application's configured default cache store.
-
orionis.console.commands.support.clear_logs
orionis.console.commands.support.clear_logs.html
Module
Module
PUBLIC
Remove files generated by the application's logging channels.
-
orionis.console.commands.support.clear_testing
orionis.console.commands.support.clear_testing.html
Module
Module
PUBLIC
Remove saved test-run result files.
-
orionis.console.commands.support.clear_views
orionis.console.commands.support.clear_views.html
Module
Module
PUBLIC
Remove compiled template bytecode from the configured view cache.
-
orionis.console.commands.support.down
orionis.console.commands.support.down.html
Module
Module
PUBLIC
Place the application in runtime maintenance mode.
-
orionis.console.commands.support.environment
orionis.console.commands.support.environment.html
Module
Module
PUBLIC
Display the active application environment.
-
orionis.console.commands.support.install
orionis.console.commands.support.install.html
Module
Module
PUBLIC
Install optional features declared by the resolved project manifest.
-
orionis.console.commands.support.key_generate
orionis.console.commands.support.key_generate.html
Module
Module
PUBLIC
Generate and persist an application encryption key.
-
orionis.console.commands.support.list
orionis.console.commands.support.list.html
Module
Module
PUBLIC
Display available commands and their usage information.
-
orionis.console.commands.support.maintenance
orionis.console.commands.support.maintenance.html
Module
Module
PUBLIC
Write a runtime-visible maintenance state for HTTP workers.
-
orionis.console.commands.support.optimize
orionis.console.commands.support.optimize.html
Module
Module
PUBLIC
Validate application Python sources without writing bytecode.
-
orionis.console.commands.support.optimize_clear
orionis.console.commands.support.optimize_clear.html
Module
Module
PUBLIC
Remove generated optimization artifacts from the application.
-
orionis.console.commands.support.up
orionis.console.commands.support.up.html
Module
Module
PUBLIC
Restore normal application traffic after maintenance.
-
orionis.console.commands.test
orionis.console.commands.test.html
Package
Package
PUBLIC
Group the console commands test components and public imports.
-
orionis.console.commands.test.test
orionis.console.commands.test.test.html
Module
Module
PUBLIC
Run the configured application test suite from the console.
-
orionis.console.contracts
orionis.console.contracts.html
Package
Package
PUBLIC
Group the console contracts components and public imports.
-
orionis.console.contracts.kernel
orionis.console.contracts.kernel.html
Module
Module
PUBLIC
Define the contract for kernel cli implementations.
-
orionis.console.contracts.schedule
orionis.console.contracts.schedule.html
Module
Module
PUBLIC
Define the contract for schedule implementations.
-
orionis.console.contracts.store
orionis.console.contracts.store.html
Module
Module
PUBLIC
Define the contract for schedule store implementations.
-
orionis.console.core
orionis.console.core.html
Package
Package
PUBLIC
Group the console core components and public imports.
-
orionis.console.core.commands
orionis.console.core.commands.html
Module
Module
PUBLIC
Provide console core operations through get_core_commands_mapping.
-
orionis.console.core.contracts
orionis.console.core.contracts.html
Package
Package
PUBLIC
Group the console core contracts components and public imports.
-
orionis.console.core.contracts.loader
orionis.console.core.contracts.loader.html
Module
Module
PUBLIC
Define the contract for loader implementations.
-
orionis.console.core.contracts.reactor
orionis.console.core.contracts.reactor.html
Module
Module
PUBLIC
Define the contract for reactor implementations.
-
orionis.console.core.loader
orionis.console.core.loader.html
Module
Module
PUBLIC
Discover command classes and prepare their runtime registrations.
-
orionis.console.core.reactor
orionis.console.core.reactor.html
Module
Module
PUBLIC
Resolve and execute registered console commands.
-
orionis.console.debug
orionis.console.debug.html
Package
Package
PUBLIC
Group the console debug components and public imports.
-
orionis.console.debug.contracts
orionis.console.debug.contracts.html
Package
Package
PUBLIC
Group the console debug contracts components and public imports.
-
orionis.console.debug.contracts.dumper
orionis.console.debug.contracts.dumper.html
Module
Module
PUBLIC
Define the contract for dumper implementations.
-
orionis.console.debug.dumper
orionis.console.debug.dumper.html
Module
Module
PUBLIC
Provide console debug operations through HttpDump, Dumper.
-
orionis.console.debug.provider
orionis.console.debug.provider.html
Module
Module
PUBLIC
Register dumper services in the application container.
-
orionis.console.dynamic
orionis.console.dynamic.html
Package
Package
PUBLIC
Group the console dynamic components and public imports.
-
orionis.console.dynamic.contracts
orionis.console.dynamic.contracts.html
Package
Package
PUBLIC
Group the console dynamic contracts components and public imports.
-
orionis.console.dynamic.contracts.progress_bar
orionis.console.dynamic.contracts.progress_bar.html
Module
Module
PUBLIC
Define the contract for progress bar implementations.
-
orionis.console.dynamic.progress_bar
orionis.console.dynamic.progress_bar.html
Module
Module
PUBLIC
Manage console progress tasks and their displayed state.
-
orionis.console.entities
orionis.console.entities.html
Package
Package
PUBLIC
Group the console entities components and public imports.
-
orionis.console.entities.command
orionis.console.entities.command.module.html
Module
Module
PUBLIC
Represent a console command and its metadata.
-
orionis.console.entities.scheduler_event
orionis.console.entities.scheduler_event.html
Module
Module
PUBLIC
Represent a scheduler event entity.
-
orionis.console.entities.task
orionis.console.entities.task.module.html
Module
Module
PUBLIC
Represent a scheduled event and configure its execution and timing.
-
orionis.console.entities.task_event
orionis.console.entities.task_event.html
Module
Module
PUBLIC
Represent a task execution event with scheduling and result information.
-
orionis.console.enums
orionis.console.enums.html
Package
Package
PUBLIC
Group the console enums components and public imports.
-
orionis.console.enums.actions
orionis.console.enums.actions.html
Module
Module
PUBLIC
Define valid action types for use with Python's argparse module.
-
orionis.console.enums.events
orionis.console.enums.events.html
Module
Module
PUBLIC
Provide console enums operations through TaskEvent, SchedulerEvent.
-
orionis.console.enums.states
orionis.console.enums.states.html
Module
Module
PUBLIC
Represent the possible states of a schedule.
-
orionis.console.enums.styles
orionis.console.enums.styles.html
Module
Module
PUBLIC
Define ANSI escape codes for styling terminal text and backgrounds.
-
orionis.console.fluent
orionis.console.fluent.html
Package
Package
PUBLIC
Group the console fluent components and public imports.
-
orionis.console.fluent.command
orionis.console.fluent.command.module.html
Module
Module
PUBLIC
Build console command registrations through a fluent interface.
-
orionis.console.fluent.contracts
orionis.console.fluent.contracts.html
Package
Package
PUBLIC
Group the console fluent contracts components and public imports.
-
orionis.console.fluent.contracts.command
orionis.console.fluent.contracts.command.html
Module
Module
PUBLIC
Define the contract for command implementations.
-
orionis.console.fluent.contracts.task
orionis.console.fluent.contracts.task.html
Module
Module
PUBLIC
Define the contract for task implementations.
-
orionis.console.fluent.task
orionis.console.fluent.task.module.html
Module
Module
PUBLIC
Configure scheduled command execution with fluent scheduling options.
-
orionis.console.kernel
orionis.console.kernel.html
Module
Module
PUBLIC
Bootstrap the console runtime and dispatch command invocations.
-
orionis.console.output
orionis.console.output.html
Package
Package
PUBLIC
Group the console output components and public imports.
-
orionis.console.output.console
orionis.console.output.console.html
Module
Module
PUBLIC
Provide formatted console output, prompts and interactive utilities.
-
orionis.console.output.contracts
orionis.console.output.contracts.html
Package
Package
PUBLIC
Group the console output contracts components and public imports.
-
orionis.console.output.contracts.console
orionis.console.output.contracts.console.html
Module
Module
PUBLIC
Define the contract for console implementations.
-
orionis.console.output.contracts.executor
orionis.console.output.contracts.executor.html
Module
Module
PUBLIC
Define the contract for executor implementations.
-
orionis.console.output.contracts.help_command
orionis.console.output.contracts.help_command.html
Module
Module
PUBLIC
Define the contract for help command implementations.
-
orionis.console.output.contracts.http_request
orionis.console.output.contracts.http_request.html
Module
Module
PUBLIC
Define the contract for http request printer implementations.
-
orionis.console.output.contracts.var_dumper
orionis.console.output.contracts.var_dumper.html
Module
Module
PUBLIC
Define the contract for var dumper implementations.
-
orionis.console.output.executor
orionis.console.output.executor.html
Module
Module
PUBLIC
Execute external commands and expose their console results.
-
orionis.console.output.help_command
orionis.console.output.help_command.html
Module
Module
PUBLIC
Display available commands and their usage information.
-
orionis.console.output.http_request
orionis.console.output.http_request.html
Module
Module
PUBLIC
Queue and display formatted HTTP request timing information.
-
orionis.console.output.var_dumper
orionis.console.output.var_dumper.html
Module
Module
PUBLIC
Format Python values for structured console inspection.
-
orionis.console.reactor_provider
orionis.console.reactor_provider.html
Module
Module
PUBLIC
Register reactor services in the application container.
-
orionis.console.scheduler_provider
orionis.console.scheduler_provider.html
Module
Module
PUBLIC
Register schedule services in the application container.
-
orionis.console.startup
orionis.console.startup.html
Module
Module
PUBLIC
Provide startup feedback for console commands.
-
orionis.console.stdio
orionis.console.stdio.html
Module
Module
PUBLIC
Provide console operations through protocol_stdout, protocol_stdio.
-
orionis.console.tasks
orionis.console.tasks.html
Package
Package
PUBLIC
Group the console tasks components and public imports.
-
orionis.console.tasks._backend
orionis.console.tasks._backend.html
Module
Module
PUBLIC
Own APScheduler 3 shutdown callbacks and their asynchronous jobs.
-
orionis.console.tasks.schedule
orionis.console.tasks.schedule.html
Module
Module
PUBLIC
Register scheduled tasks and coordinate their scheduler integration.
-
orionis.console.tasks.store
orionis.console.tasks.store.html
Module
Module
PUBLIC
Construct scheduler job stores from application configuration.
-
orionis.console.templates
orionis.console.templates.html
Package
Package
PUBLIC
Group the console templates components and public imports.
-
orionis.console.templates.stub
orionis.console.templates.stub.html
Module
Module
PUBLIC
Load and render source templates used by code-generation commands.
-
orionis.container
orionis.container.html
Package
Package
PUBLIC
Group the container components and public imports.
-
orionis.container.container
orionis.container.container.html
Module
Module
PUBLIC
Resolve services from contracts, aliases and constructor signatures.
-
orionis.container.context
orionis.container.context.html
Package
Package
PUBLIC
Group the container context components and public imports.
-
orionis.container.context.manager
orionis.container.context.manager.html
Module
Module
PUBLIC
Own scoped service instances and their creation and cleanup lifecycle.
-
orionis.container.context.scope
orionis.container.context.scope.html
Module
Module
PUBLIC
Store the active dependency-injection scope in a context variable.
-
orionis.container.contracts
orionis.container.contracts.html
Package
Package
PUBLIC
Group the container contracts components and public imports.
-
orionis.container.contracts.container
orionis.container.contracts.container.html
Module
Module
PUBLIC
Define the contract for container implementations.
-
orionis.container.contracts.deferrable_provider
orionis.container.contracts.deferrable_provider.html
Module
Module
PUBLIC
Define the contract for deferrable provider implementations.
-
orionis.container.contracts.facade
orionis.container.contracts.facade.html
Module
Module
PUBLIC
Define the contract for facade implementations.
-
orionis.container.contracts.service_provider
orionis.container.contracts.service_provider.html
Module
Module
PUBLIC
Define the contract for service provider implementations.
-
orionis.container.entities
orionis.container.entities.html
Package
Package
PUBLIC
Group the container entities components and public imports.
-
orionis.container.entities.binding
orionis.container.entities.binding.module.html
Module
Module
PUBLIC
Represent a binding between a contract and its implementation.
-
orionis.container.entities.invocation
orionis.container.entities.invocation.html
Module
Module
PUBLIC
Describe the immutable metadata needed to invoke one callable.
-
orionis.container.enums
orionis.container.enums.html
Package
Package
PUBLIC
Group the container enums components and public imports.
-
orionis.container.enums.lifetimes
orionis.container.enums.lifetimes.html
Module
Module
PUBLIC
Define lifecycle types for dependency injection.
-
orionis.container.exceptions
orionis.container.exceptions.html
Package
Package
PUBLIC
Group the container exceptions components and public imports.
-
orionis.container.exceptions.container
orionis.container.exceptions.container.html
Module
Module
PUBLIC
Raise when a circular dependency is detected in the Orionis container.
-
orionis.container.facades
orionis.container.facades.html
Package
Package
PUBLIC
Group the container facades components and public imports.
-
orionis.container.facades.facade
orionis.container.facades.facade.module.html
Module
Module
PUBLIC
Resolve global or scoped services through class-level facades.
-
orionis.container.facades.meta
orionis.container.facades.meta.html
Module
Module
PUBLIC
Dispatch facade attributes while preserving Python introspection protocols.
-
orionis.container.providers
orionis.container.providers.html
Package
Package
PUBLIC
Group the container providers components and public imports.
-
orionis.container.providers.deferrable_provider
orionis.container.providers.deferrable_provider.html
Module
Module
PUBLIC
Mark service providers that support deferred loading.
-
orionis.container.providers.service_provider
orionis.container.providers.service_provider.html
Module
Module
PUBLIC
Define optional registration and startup hooks for service providers.
-
orionis.database
orionis.database.html
Package
Package
PUBLIC
Group the database components and public imports.
-
orionis.database.compiler
orionis.database.compiler.html
Module
Module
PUBLIC
Translate Orionis query plans into engine-executable statements.
-
orionis.database.connection
orionis.database.connection.module.html
Module
Module
PUBLIC
Named database connection encapsulating the SQL engine.
-
orionis.database.connection_manager
orionis.database.connection_manager.html
Module
Module
PUBLIC
Resolve named database connections and manage their lifecycle.
-
orionis.database.contracts
orionis.database.contracts.html
Package
Package
PUBLIC
Group the database contracts components and public imports.
-
orionis.database.contracts.connection
orionis.database.contracts.connection.html
Module
Module
PUBLIC
Contract for a single named database connection.
-
orionis.database.contracts.connection_manager
orionis.database.contracts.connection_manager.html
Module
Module
PUBLIC
Define the contract for connection manager implementations.
-
orionis.database.contracts.migration
orionis.database.contracts.migration.html
Module
Module
PUBLIC
Abstract base class for all database migrations.
-
orionis.database.contracts.migrator
orionis.database.contracts.migrator.html
Module
Module
PUBLIC
Contract for the database migration runner.
-
orionis.database.contracts.schema
orionis.database.contracts.schema.html
Module
Module
PUBLIC
Define the contract for schema implementations.
-
orionis.database.contracts.transaction
orionis.database.contracts.transaction.html
Module
Module
PUBLIC
Contract for a database transaction usable as an async context manager.
-
orionis.database.dialect
orionis.database.dialect.html
Module
Module
PUBLIC
Provide database operations.
-
orionis.database.entities
orionis.database.entities.html
Package
Package
PUBLIC
Group the database entities components and public imports.
-
orionis.database.entities.result
orionis.database.entities.result.html
Module
Module
PUBLIC
Outcome of an INSERT statement executed through a connection.
-
orionis.database.exceptions
orionis.database.exceptions.html
Module
Module
PUBLIC
Provide database operations.
-
orionis.database.migrations
orionis.database.migrations.html
Package
Package
PUBLIC
Group the database migrations components and public imports.
-
orionis.database.migrations.context
orionis.database.migrations.context.html
Module
Module
PUBLIC
Provide database migrations operations.
-
orionis.database.migrations.discovery
orionis.database.migrations.discovery.html
Module
Module
PUBLIC
Discover file-owned migration and seeder classes with stable persisted names.
-
orionis.database.migrations.events
orionis.database.migrations.events.html
Module
Module
PUBLIC
Progress callbacks reported while migrations run.
-
orionis.database.migrations.migrator
orionis.database.migrations.migrator.module.html
Module
Module
PUBLIC
Runner applying and reverting the application migrations.
-
orionis.database.provider
orionis.database.provider.html
Module
Module
PUBLIC
Register connection manager services in the application container.
-
orionis.database.redshift
orionis.database.redshift.html
Module
Module
PUBLIC
Define redshift for database.
-
orionis.database.schema
orionis.database.schema.html
Package
Package
PUBLIC
Group the database schema components and public imports.
-
orionis.database.schema.blueprint
orionis.database.schema.blueprint.module.html
Module
Module
PUBLIC
Fluent collector of column definitions for a single table.
-
orionis.database.schema.column
orionis.database.schema.column.module.html
Module
Module
PUBLIC
Create column definitions for database schema declarations.
-
orionis.database.schema.definition_bucket
orionis.database.schema.definition_bucket.html
Module
Module
PUBLIC
Mutable accumulator used while classifying schema definitions.
-
orionis.database.schema.definitions
orionis.database.schema.definitions.html
Module
Module
PUBLIC
Define definitions for database schema.
-
orionis.database.schema.foreign
orionis.database.schema.foreign.html
Module
Module
PUBLIC
Describe a foreign-key constraint and its referential actions.
-
orionis.database.schema.index
orionis.database.schema.index.module.html
Module
Module
PUBLIC
Describe a database index and its indexed columns.
-
orionis.database.schema.primary
orionis.database.schema.primary.html
Module
Module
PUBLIC
Describe a primary-key constraint on a table.
-
orionis.database.schema.schema
orionis.database.schema.schema.html
Module
Module
PUBLIC
Apply database schema operations to the selected connection.
-
orionis.database.schema.table_creation
orionis.database.schema.table_creation.html
Module
Module
PUBLIC
Async context manager returned by Schema.create.
-
orionis.database.schema.timestamp
orionis.database.schema.timestamp.html
Module
Module
PUBLIC
Describe the standard creation and update timestamp columns.
-
orionis.database.schema.unique
orionis.database.schema.unique.module.html
Module
Module
PUBLIC
Describe a uniqueness constraint on table columns.
-
orionis.database.schema_provider
orionis.database.schema_provider.html
Module
Module
PUBLIC
Register schema services in the application container.
-
orionis.database.seeders
orionis.database.seeders.html
Package
Package
PUBLIC
Group the database seeders components and public imports.
-
orionis.database.seeders.events
orionis.database.seeders.events.html
Module
Module
PUBLIC
Define events for database seeders.
-
orionis.database.seeders.runner
orionis.database.seeders.runner.html
Module
Module
PUBLIC
Apply new seeders exactly once on the selected database connection.
-
orionis.database.seeders.seeder
orionis.database.seeders.seeder.module.html
Module
Module
PUBLIC
Base class for asynchronous application database seeders.
-
orionis.database.threaded
orionis.database.threaded.html
Package
Package
PUBLIC
Thread-backed SQLAlchemy Core execution for blocking database connectors.
-
orionis.database.threaded.connection
orionis.database.threaded.connection.html
Module
Module
PUBLIC
Execute one Core checkout and buffer its results on a reserved thread.
-
orionis.database.threaded.engine
orionis.database.threaded.engine.html
Module
Module
PUBLIC
Expose asynchronous checkouts without claiming a blocking driver is async.
-
orionis.database.threaded.result
orionis.database.threaded.result.html
Module
Module
PUBLIC
Retain materialized Core results without exposing a live DBAPI cursor.
-
orionis.database.threaded.transaction
orionis.database.threaded.transaction.html
Module
Module
PUBLIC
Settle a Core transaction on its connection's reserved worker.
-
orionis.database.threaded.worker
orionis.database.threaded.worker.html
Module
Module
PUBLIC
Serialize one checked-out DBAPI connection on one worker thread.
-
orionis.database.transaction
orionis.database.transaction.module.html
Module
Module
PUBLIC
Async context manager driving a connection-level transaction.
-
orionis.encrypter
orionis.encrypter.html
Package
Package
PUBLIC
Group the encrypter components and public imports.
-
orionis.encrypter.contracts
orionis.encrypter.contracts.html
Package
Package
PUBLIC
Group the encrypter contracts components and public imports.
-
orionis.encrypter.contracts.encrypter
orionis.encrypter.contracts.encrypter.html
Module
Module
PUBLIC
Define the contract for encrypter implementations.
-
orionis.encrypter.encrypter
orionis.encrypter.encrypter.module.html
Module
Module
PUBLIC
Encrypt and decrypt application payloads using configured cipher keys.
-
orionis.encrypter.provider
orionis.encrypter.provider.html
Module
Module
PUBLIC
Service provider for the Orionis encryption system.
-
orionis.environment
orionis.environment.html
Package
Package
PUBLIC
Group the environment components and public imports.
-
orionis.environment.contracts
orionis.environment.contracts.html
Package
Package
PUBLIC
Group the environment contracts components and public imports.
-
orionis.environment.contracts.caster
orionis.environment.contracts.caster.html
Module
Module
PUBLIC
Define the contract for environment caster implementations.
-
orionis.environment.contracts.env
orionis.environment.contracts.env.html
Module
Module
PUBLIC
Define the contract for env implementations.
-
orionis.environment.core
orionis.environment.core.html
Package
Package
PUBLIC
Group the environment core components and public imports.
-
orionis.environment.core.dot_env
orionis.environment.core.dot_env.html
Module
Module
PUBLIC
Load and cache values from a resolved dotenv file.
-
orionis.environment.dynamic
orionis.environment.dynamic.html
Package
Package
PUBLIC
Group the environment dynamic components and public imports.
-
orionis.environment.dynamic.caster
orionis.environment.dynamic.caster.html
Module
Module
PUBLIC
Convert raw environment strings to the requested Python value type.
-
orionis.environment.enums
orionis.environment.enums.html
Package
Package
PUBLIC
Group the environment enums components and public imports.
-
orionis.environment.enums.value_type
orionis.environment.enums.value_type.html
Module
Module
PUBLIC
Define supported types for casting environment variable values.
-
orionis.environment.facade
orionis.environment.facade.html
Module
Module
PUBLIC
Read typed environment values through the environment service facade.
-
orionis.environment.functions
orionis.environment.functions.html
Module
Module
PUBLIC
Provide environment operations through env.
-
orionis.environment.key
orionis.environment.key.html
Package
Package
PUBLIC
Group the environment key components and public imports.
-
orionis.environment.key.key_generator
orionis.environment.key.key_generator.html
Module
Module
PUBLIC
Generate cryptographically secure application secret keys.
-
orionis.environment.validators
orionis.environment.validators.html
Package
Package
PUBLIC
Group the environment validators components and public imports.
-
orionis.environment.validators.key_name
orionis.environment.validators.key_name.html
Module
Module
PUBLIC
Provide environment validators operations through _validate_key_name.
-
orionis.environment.validators.types
orionis.environment.validators.types.html
Module
Module
PUBLIC
Validate supported environment type hints before values are cast.
-
orionis.failure
orionis.failure.html
Package
Package
PUBLIC
Group the failure components and public imports.
-
orionis.failure.base
orionis.failure.base.html
Package
Package
PUBLIC
Group the failure base components and public imports.
-
orionis.failure.base.handler
orionis.failure.base.handler.html
Module
Module
PUBLIC
Select default logging and deferred presentation for application failures.
-
orionis.failure.catch
orionis.failure.catch.module.html
Module
Module
PUBLIC
Resolve exception handling and reporting for application failures.
-
orionis.failure.contracts
orionis.failure.contracts.html
Package
Package
PUBLIC
Group the failure contracts components and public imports.
-
orionis.failure.contracts.catch
orionis.failure.contracts.catch.html
Module
Module
PUBLIC
Define the contract for catch implementations.
-
orionis.failure.contracts.handler
orionis.failure.contracts.handler.html
Module
Module
PUBLIC
Define the unified application failure handler contract.
-
orionis.failure.entities
orionis.failure.entities.html
Package
Package
PUBLIC
Group the failure entities components and public imports.
-
orionis.failure.entities.context
orionis.failure.entities.context.html
Module
Module
PUBLIC
Describe failures without retaining a request, scope or transport.
-
orionis.failure.entities.handling
orionis.failure.entities.handling.html
Module
Module
PUBLIC
Keep deferred failure effects separate from immutable incident metadata.
-
orionis.failure.entities.throwable
orionis.failure.entities.throwable.module.html
Module
Module
PUBLIC
Represent a throwable entity within the framework.
-
orionis.failure.enums
orionis.failure.enums.html
Package
Package
PUBLIC
Group the failure enums components and public imports.
-
orionis.failure.enums.kernel_type
orionis.failure.enums.kernel_type.html
Module
Module
PUBLIC
Define available kernel types in the system.
-
orionis.failure.provider
orionis.failure.provider.html
Module
Module
PUBLIC
Register catch services in the application container.
-
orionis.failure.runtime
orionis.failure.runtime.html
Module
Module
PUBLIC
Observe failures only inside an activated application runtime.
-
orionis.foundation
orionis.foundation.html
Package
Package
PUBLIC
Group the foundation components and public imports.
-
orionis.foundation.application
orionis.foundation.application.html
Module
Module
PUBLIC
Configure the container and serve requests within one worker event loop.
-
orionis.foundation.config
orionis.foundation.config.html
Package
Package
PUBLIC
Group the foundation config components and public imports.
-
orionis.foundation.config.app
orionis.foundation.config.app.html
Package
Package
PUBLIC
Group the foundation config app components and public imports.
-
orionis.foundation.config.app.entities
orionis.foundation.config.app.entities.html
Package
Package
PUBLIC
Group the foundation config app entities components and public imports.
-
orionis.foundation.config.app.entities.app
orionis.foundation.config.app.entities.app.html
Module
Module
PUBLIC
Represent application configuration settings.
-
orionis.foundation.config.app.enums
orionis.foundation.config.app.enums.html
Package
Package
PUBLIC
Group the foundation config app enums components and public imports.
-
orionis.foundation.config.app.enums.ciphers
orionis.foundation.config.app.enums.ciphers.html
Module
Module
PUBLIC
Enumerate authenticated AES modes and retained legacy identifiers.
-
orionis.foundation.config.app.enums.environments
orionis.foundation.config.app.enums.environments.html
Module
Module
PUBLIC
Enumerate possible application environments.
-
orionis.foundation.config.auth
orionis.foundation.config.auth.html
Package
Package
PUBLIC
Group the foundation config auth components and public imports.
-
orionis.foundation.config.auth.entities
orionis.foundation.config.auth.entities.html
Package
Package
PUBLIC
Group the foundation config auth entities components and public imports.
-
orionis.foundation.config.auth.entities.auth
orionis.foundation.config.auth.entities.auth.html
Module
Module
PUBLIC
Represent the authentication and authorization configuration.
-
orionis.foundation.config.auth.entities.identity
orionis.foundation.config.auth.entities.identity.html
Module
Module
PUBLIC
Represent how the application identity is located and verified.
-
orionis.foundation.config.auth.entities.password_reset
orionis.foundation.config.auth.entities.password_reset.html
Module
Module
PUBLIC
Represent the configuration of password reset functionality.
-
orionis.foundation.config.auth.entities.remember
orionis.foundation.config.auth.entities.remember.html
Module
Module
PUBLIC
Configure the optional persistent login cookie separately from sessions.
-
orionis.foundation.config.auth.entities.session
orionis.foundation.config.auth.entities.session.html
Module
Module
PUBLIC
Represent the configuration of session based authentication.
-
orionis.foundation.config.auth.entities.tokens
orionis.foundation.config.auth.entities.tokens.html
Module
Module
PUBLIC
Represent the configuration of personal access token authentication.
-
orionis.foundation.config.auth.enums
orionis.foundation.config.auth.enums.html
Package
Package
PUBLIC
Group the foundation config auth enums components and public imports.
-
orionis.foundation.config.auth.enums.guards
orionis.foundation.config.auth.enums.guards.module.html
Module
Module
PUBLIC
Enumerate the authentication guards shipped with the framework.
-
orionis.foundation.config.cache
orionis.foundation.config.cache.html
Package
Package
PUBLIC
Group the foundation config cache components and public imports.
-
orionis.foundation.config.cache.entities
orionis.foundation.config.cache.entities.html
Package
Package
PUBLIC
Group the foundation config cache entities components and public imports.
-
orionis.foundation.config.cache.entities.cache
orionis.foundation.config.cache.entities.cache.html
Module
Module
PUBLIC
Represent the cache configuration for the application.
-
orionis.foundation.config.cache.entities.database
orionis.foundation.config.cache.entities.database.html
Module
Module
PUBLIC
Represent the configuration entity for a database-backed cache store.
-
orionis.foundation.config.cache.entities.file
orionis.foundation.config.cache.entities.file.html
Module
Module
PUBLIC
Represent the configuration entity for a file-based cache store.
-
orionis.foundation.config.cache.entities.memcached
orionis.foundation.config.cache.entities.memcached.html
Module
Module
PUBLIC
Represent the configuration entity for a Memcached cache store.
-
orionis.foundation.config.cache.entities.memory
orionis.foundation.config.cache.entities.memory.html
Module
Module
PUBLIC
Represent the configuration entity for an in-memory cache store.
-
orionis.foundation.config.cache.entities.redis
orionis.foundation.config.cache.entities.redis.html
Module
Module
PUBLIC
Represent the configuration entity for a Redis cache store.
-
orionis.foundation.config.cache.entities.stores
orionis.foundation.config.cache.entities.stores.html
Module
Module
PUBLIC
Represent a collection of cache storage backends for the application.
-
orionis.foundation.config.cache.enums
orionis.foundation.config.cache.enums.html
Package
Package
PUBLIC
Group the foundation config cache enums components and public imports.
-
orionis.foundation.config.cache.enums.drivers
orionis.foundation.config.cache.enums.drivers.html
Module
Module
PUBLIC
Enumerate supported cache drivers.
-
orionis.foundation.config.database
orionis.foundation.config.database.html
Package
Package
PUBLIC
Group the foundation config database components and public imports.
-
orionis.foundation.config.database.entities
orionis.foundation.config.database.entities.html
Package
Package
PUBLIC
Group the foundation config database entities components and public imports.
-
orionis.foundation.config.database.entities.connections
orionis.foundation.config.database.entities.connections.html
Module
Module
PUBLIC
Represent all database connections used by the application.
-
orionis.foundation.config.database.entities.database
orionis.foundation.config.database.entities.database.html
Module
Module
PUBLIC
Represent the general database configuration.
-
orionis.foundation.config.database.entities.mysql
orionis.foundation.config.database.entities.mysql.html
Module
Module
PUBLIC
Data class to represent the MySQL database configuration.
-
orionis.foundation.config.database.entities.oracle
orionis.foundation.config.database.entities.oracle.html
Module
Module
PUBLIC
Represent Oracle database configuration for oracledb.
-
orionis.foundation.config.database.entities.pgsql
orionis.foundation.config.database.entities.pgsql.html
Module
Module
PUBLIC
Represent a PostgreSQL database configuration entity.
-
orionis.foundation.config.database.entities.redshift
orionis.foundation.config.database.entities.redshift.html
Module
Module
PUBLIC
Configure Amazon Redshift with the official AWS Python connector.
-
orionis.foundation.config.database.entities.sqlite
orionis.foundation.config.database.entities.sqlite.html
Module
Module
PUBLIC
Represent the SQLite database configuration.
-
orionis.foundation.config.database.entities.sqlserver
orionis.foundation.config.database.entities.sqlserver.html
Module
Module
PUBLIC
Represent the Microsoft SQL Server database configuration.
-
orionis.foundation.config.database.enums
orionis.foundation.config.database.enums.html
Package
Package
PUBLIC
Group the foundation config database enums components and public imports.
-
orionis.foundation.config.database.enums.connection_name
orionis.foundation.config.database.enums.connection_name.html
Module
Module
PUBLIC
Enumerate the built-in database connection names supported by Orionis.
-
orionis.foundation.config.database.enums.mysql_charsets
orionis.foundation.config.database.enums.mysql_charsets.html
Module
Module
PUBLIC
Enumerate MySQL character sets usable by the configured connection drivers.
-
orionis.foundation.config.database.enums.mysql_collations
orionis.foundation.config.database.enums.mysql_collations.html
Module
Module
PUBLIC
Enumerate common MySQL collations.
-
orionis.foundation.config.database.enums.mysql_engine
orionis.foundation.config.database.enums.mysql_engine.html
Module
Module
PUBLIC
Enumerate supported MySQL storage engines.
-
orionis.foundation.config.database.enums.oracle_encoding
orionis.foundation.config.database.enums.oracle_encoding.html
Module
Module
PUBLIC
Enumerate Oracle database character encodings.
-
orionis.foundation.config.database.enums.oracle_nencoding
orionis.foundation.config.database.enums.oracle_nencoding.html
Module
Module
PUBLIC
Represent Oracle national character sets supported by Oracle Database.
-
orionis.foundation.config.database.enums.pgsql_charsets
orionis.foundation.config.database.enums.pgsql_charsets.html
Module
Module
PUBLIC
Enumerate PostgreSQL encodings supported for database storage.
-
orionis.foundation.config.database.enums.pgsql_collations
orionis.foundation.config.database.enums.pgsql_collations.html
Module
Module
PUBLIC
Enumerate common PostgreSQL collations.
-
orionis.foundation.config.database.enums.pgsql_mode
orionis.foundation.config.database.enums.pgsql_mode.html
Module
Module
PUBLIC
Define SSL modes for PostgreSQL connections.
-
orionis.foundation.config.database.enums.redshift_mode
orionis.foundation.config.database.enums.redshift_mode.html
Module
Module
PUBLIC
Enumerate certificate verification modes supported by the AWS connector.
-
orionis.foundation.config.database.enums.sqlite_foreign_key
orionis.foundation.config.database.enums.sqlite_foreign_key.html
Module
Module
PUBLIC
Represent the state of foreign key constraints in SQLite.
-
orionis.foundation.config.database.enums.sqlite_journal
orionis.foundation.config.database.enums.sqlite_journal.html
Module
Module
PUBLIC
Enumerate SQLite journal modes.
-
orionis.foundation.config.database.enums.sqlite_synchronous
orionis.foundation.config.database.enums.sqlite_synchronous.html
Module
Module
PUBLIC
Represent SQLite synchronous settings for transaction durability.
-
orionis.foundation.config.database.enums.sqlserver_charset
orionis.foundation.config.database.enums.sqlserver_charset.html
Module
Module
PUBLIC
Enumerate SQLCHAR encodings documented for SQL Server ODBC on Linux and macOS.
-
orionis.foundation.config.filesystems
orionis.foundation.config.filesystems.html
Package
Package
PUBLIC
Group the foundation config filesystems components and public imports.
-
orionis.foundation.config.filesystems.entitites
orionis.foundation.config.filesystems.entitites.html
Package
Package
PUBLIC
Group the foundation config filesystems entitites components and public imports.
-
orionis.foundation.config.filesystems.entitites.aws
orionis.foundation.config.filesystems.entitites.aws.html
Module
Module
PUBLIC
Represent an AWS S3 storage configuration.
-
orionis.foundation.config.filesystems.entitites.azure
orionis.foundation.config.filesystems.entitites.azure.html
Module
Module
PUBLIC
Represent an Azure Blob Storage configuration.
-
orionis.foundation.config.filesystems.entitites.disks
orionis.foundation.config.filesystems.entitites.disks.html
Module
Module
PUBLIC
Represent the configuration for different filesystem disks.
-
orionis.foundation.config.filesystems.entitites.filesystems
orionis.foundation.config.filesystems.entitites.filesystems.html
Module
Module
PUBLIC
Represent the filesystems configuration.
-
orionis.foundation.config.filesystems.entitites.gcs
orionis.foundation.config.filesystems.entitites.gcs.html
Module
Module
PUBLIC
Represent a Google Cloud Storage configuration.
-
orionis.foundation.config.filesystems.entitites.local
orionis.foundation.config.filesystems.entitites.local.html
Module
Module
PUBLIC
Represent a local filesystem configuration.
-
orionis.foundation.config.filesystems.entitites.public
orionis.foundation.config.filesystems.entitites.public.html
Module
Module
PUBLIC
Represent a local filesystem configuration.
-
orionis.foundation.config.filesystems.enums
orionis.foundation.config.filesystems.enums.html
Package
Package
PUBLIC
Group the foundation config filesystems enums components and public imports.
-
orionis.foundation.config.filesystems.enums.disk_name
orionis.foundation.config.filesystems.enums.disk_name.html
Module
Module
PUBLIC
Enumerate the built-in filesystem disk names supported by Orionis.
-
orionis.foundation.config.hashing
orionis.foundation.config.hashing.html
Package
Package
PUBLIC
Group the foundation config hashing components and public imports.
-
orionis.foundation.config.hashing.entities
orionis.foundation.config.hashing.entities.html
Package
Package
PUBLIC
Group the foundation config hashing entities components and public imports.
-
orionis.foundation.config.hashing.entities.argon2
orionis.foundation.config.hashing.entities.argon2.html
Module
Module
PUBLIC
Represent the configuration entity for the Argon2id hashing driver.
-
orionis.foundation.config.hashing.entities.bcrypt
orionis.foundation.config.hashing.entities.bcrypt.html
Module
Module
PUBLIC
Represent the configuration entity for the bcrypt hashing driver.
-
orionis.foundation.config.hashing.entities.hashing
orionis.foundation.config.hashing.entities.hashing.html
Module
Module
PUBLIC
Represent the password hashing configuration for the application.
-
orionis.foundation.config.hashing.enums
orionis.foundation.config.hashing.enums.html
Package
Package
PUBLIC
Group the foundation config hashing enums components and public imports.
-
orionis.foundation.config.hashing.enums.drivers
orionis.foundation.config.hashing.enums.drivers.html
Module
Module
PUBLIC
Enumerate supported password hashing drivers.
-
orionis.foundation.config.http
orionis.foundation.config.http.html
Package
Package
PUBLIC
Group the foundation config http components and public imports.
-
orionis.foundation.config.http.entitites
orionis.foundation.config.http.entitites.html
Package
Package
PUBLIC
Group the foundation config http entitites components and public imports.
-
orionis.foundation.config.http.entitites.body
orionis.foundation.config.http.entitites.body.html
Module
Module
PUBLIC
Configure finite request, buffering, multipart and concurrency budgets.
-
orionis.foundation.config.http.entitites.cors
orionis.foundation.config.http.entitites.cors.html
Module
Module
PUBLIC
Represent a CORS configuration compatible with Starlette CORSMiddleware.
-
orionis.foundation.config.http.entitites.csrf
orionis.foundation.config.http.entitites.csrf.html
Module
Module
PUBLIC
CSRF protection configuration for web routes.
-
orionis.foundation.config.http.entitites.http
orionis.foundation.config.http.entitites.http.html
Module
Module
PUBLIC
Configure HTTP request handling and security.
-
orionis.foundation.config.http.entitites.proxies
orionis.foundation.config.http.entitites.proxies.html
Module
Module
PUBLIC
Represent the configuration for trusted HTTP proxies.
-
orionis.foundation.config.http.entitites.rate_limit
orionis.foundation.config.http.entitites.rate_limit.html
Module
Module
PUBLIC
Represent the rate-limiting configuration for HTTP.
-
orionis.foundation.config.http.entitites.redis
orionis.foundation.config.http.entitites.redis.html
Module
Module
PUBLIC
Configure the Redis connection used by HTTP rate limiting.
-
orionis.foundation.config.http.entitites.security
orionis.foundation.config.http.entitites.security.html
Module
Module
PUBLIC
Represent the security-related configuration for HTTP.
-
orionis.foundation.config.http.entitites.websocket
orionis.foundation.config.http.entitites.websocket.html
Module
Module
PUBLIC
Configure connection admission, inbound messages and browser origins.
-
orionis.foundation.config.logging
orionis.foundation.config.logging.html
Package
Package
PUBLIC
Group the foundation config logging components and public imports.
-
orionis.foundation.config.logging.entities
orionis.foundation.config.logging.entities.html
Package
Package
PUBLIC
Group the foundation config logging entities components and public imports.
-
orionis.foundation.config.logging.entities.channels
orionis.foundation.config.logging.entities.channels.html
Module
Module
PUBLIC
Represent the available logging channels and their configurations.
-
orionis.foundation.config.logging.entities.chunked
orionis.foundation.config.logging.entities.chunked.html
Module
Module
PUBLIC
Configure chunked log file rotation.
-
orionis.foundation.config.logging.entities.daily
orionis.foundation.config.logging.entities.daily.html
Module
Module
PUBLIC
Represent the configuration for daily log file rotation.
-
orionis.foundation.config.logging.entities.hourly
orionis.foundation.config.logging.entities.hourly.html
Module
Module
PUBLIC
Represent the configuration for hourly log file management.
-
orionis.foundation.config.logging.entities.logging
orionis.foundation.config.logging.entities.logging.html
Module
Module
PUBLIC
Represent the logging system configuration.
-
orionis.foundation.config.logging.entities.monthly
orionis.foundation.config.logging.entities.monthly.html
Module
Module
PUBLIC
Represent the configuration for monthly log file management.
-
orionis.foundation.config.logging.entities.stack
orionis.foundation.config.logging.entities.stack.html
Module
Module
PUBLIC
Represent the configuration for a logging stack.
-
orionis.foundation.config.logging.entities.weekly
orionis.foundation.config.logging.entities.weekly.html
Module
Module
PUBLIC
Represent the configuration for weekly log file management.
-
orionis.foundation.config.logging.enums
orionis.foundation.config.logging.enums.html
Package
Package
PUBLIC
Group the foundation config logging enums components and public imports.
-
orionis.foundation.config.logging.enums.levels
orionis.foundation.config.logging.enums.levels.html
Module
Module
PUBLIC
Enumerate standard logging levels.
-
orionis.foundation.config.logging.validators
orionis.foundation.config.logging.validators.html
Package
Package
PUBLIC
Group the foundation config logging validators components and public imports.
-
orionis.foundation.config.logging.validators.level
orionis.foundation.config.logging.validators.level.html
Module
Module
PUBLIC
Validate if a value is a valid logging level.
-
orionis.foundation.config.logging.validators.path
orionis.foundation.config.logging.validators.path.html
Module
Module
PUBLIC
Validate logging paths without storing per-call state.
-
orionis.foundation.config.mail
orionis.foundation.config.mail.html
Package
Package
PUBLIC
Group the foundation config mail components and public imports.
-
orionis.foundation.config.mail.entities
orionis.foundation.config.mail.entities.html
Package
Package
PUBLIC
Group the foundation config mail entities components and public imports.
-
orionis.foundation.config.mail.entities.file
orionis.foundation.config.mail.entities.file.html
Module
Module
PUBLIC
Represent a file configuration entity for storing outgoing emails.
-
orionis.foundation.config.mail.entities.from_address
orionis.foundation.config.mail.entities.from_address.html
Module
Module
PUBLIC
Represent the global sender applied to messages that declare no From.
-
orionis.foundation.config.mail.entities.mail
orionis.foundation.config.mail.entities.mail.html
Module
Module
PUBLIC
Represent the mail configuration entity.
-
orionis.foundation.config.mail.entities.mailers
orionis.foundation.config.mail.entities.mailers.html
Module
Module
PUBLIC
Represent mail transport configurations for the application.
-
orionis.foundation.config.mail.entities.smtp
orionis.foundation.config.mail.entities.smtp.html
Module
Module
PUBLIC
Represent SMTP configuration settings.
-
orionis.foundation.config.mail.enums
orionis.foundation.config.mail.enums.html
Package
Package
PUBLIC
Group the foundation config mail enums components and public imports.
-
orionis.foundation.config.mail.enums.drivers
orionis.foundation.config.mail.enums.drivers.html
Module
Module
PUBLIC
Enumeration of supported mail drivers.
-
orionis.foundation.config.mcp
orionis.foundation.config.mcp.html
Package
Package
PUBLIC
Group the foundation config mcp components and public imports.
-
orionis.foundation.config.mcp.entities
orionis.foundation.config.mcp.entities.html
Package
Package
PUBLIC
Group the foundation config mcp entities components and public imports.
-
orionis.foundation.config.mcp.entities.mcp
orionis.foundation.config.mcp.entities.mcp.html
Module
Module
PUBLIC
Bound MCP work and explicitly allow trusted HTTP browser origins.
-
orionis.foundation.config.queue
orionis.foundation.config.queue.html
Package
Package
PUBLIC
Group the foundation config queue components and public imports.
-
orionis.foundation.config.queue.entities
orionis.foundation.config.queue.entities.html
Package
Package
PUBLIC
Group the foundation config queue entities components and public imports.
-
orionis.foundation.config.queue.entities.connections
orionis.foundation.config.queue.entities.connections.html
Module
Module
PUBLIC
Group the conventional validated queue connections.
-
orionis.foundation.config.queue.entities.database
orionis.foundation.config.queue.entities.database.html
Module
Module
PUBLIC
Configure a durable database queue connection.
-
orionis.foundation.config.queue.entities.failed
orionis.foundation.config.queue.entities.failed.html
Module
Module
PUBLIC
Configure database storage for failed jobs.
-
orionis.foundation.config.queue.entities.queue
orionis.foundation.config.queue.entities.queue.html
Module
Module
PUBLIC
Configure named queue connections, failure storage, and workers.
-
orionis.foundation.config.queue.entities.redis
orionis.foundation.config.queue.entities.redis.html
Module
Module
PUBLIC
Configure a durable Redis queue connection.
-
orionis.foundation.config.queue.entities.sync
orionis.foundation.config.queue.entities.sync.html
Module
Module
PUBLIC
Configure the synchronous queue connection.
-
orionis.foundation.config.queue.entities.worker
orionis.foundation.config.queue.entities.worker.html
Module
Module
PUBLIC
Configure strictly validated queue worker defaults.
-
orionis.foundation.config.queue.enums
orionis.foundation.config.queue.enums.html
Package
Package
PUBLIC
Group the foundation config queue enums components and public imports.
-
orionis.foundation.config.queue.enums.drivers
orionis.foundation.config.queue.enums.drivers.module.html
Module
Module
PUBLIC
Enumerate supported queue connection drivers.
-
orionis.foundation.config.realtime
orionis.foundation.config.realtime.html
Package
Package
PUBLIC
Group the foundation config realtime components and public imports.
-
orionis.foundation.config.realtime.entities
orionis.foundation.config.realtime.entities.html
Package
Package
PUBLIC
Group the foundation config realtime entities components and public imports.
-
orionis.foundation.config.realtime.entities.realtime
orionis.foundation.config.realtime.entities.realtime.html
Module
Module
PUBLIC
Configure finite per-connection RPC budgets and broadcast concurrency.
-
orionis.foundation.config.scheduler
orionis.foundation.config.scheduler.html
Package
Package
PUBLIC
Group the foundation config scheduler components and public imports.
-
orionis.foundation.config.scheduler.entities
orionis.foundation.config.scheduler.entities.html
Package
Package
PUBLIC
Group the foundation config scheduler entities components and public imports.
-
orionis.foundation.config.scheduler.entities.database
orionis.foundation.config.scheduler.entities.database.html
Module
Module
PUBLIC
Represent the configuration entity for a database-backed job store.
-
orionis.foundation.config.scheduler.entities.memory
orionis.foundation.config.scheduler.entities.memory.html
Module
Module
PUBLIC
Represent the configuration entity for an in-memory job store.
-
orionis.foundation.config.scheduler.entities.redis
orionis.foundation.config.scheduler.entities.redis.html
Module
Module
PUBLIC
Represent the configuration entity for a Redis job store.
-
orionis.foundation.config.scheduler.entities.scheduler
orionis.foundation.config.scheduler.entities.scheduler.html
Module
Module
PUBLIC
Represent the task scheduler configuration for the application.
-
orionis.foundation.config.scheduler.entities.stores
orionis.foundation.config.scheduler.entities.stores.html
Module
Module
PUBLIC
Represent a collection of scheduler job store backends.
-
orionis.foundation.config.scheduler.enums
orionis.foundation.config.scheduler.enums.html
Package
Package
PUBLIC
Group the foundation config scheduler enums components and public imports.
-
orionis.foundation.config.scheduler.enums.drivers
orionis.foundation.config.scheduler.enums.drivers.module.html
Module
Module
PUBLIC
Enumerate supported scheduler job store drivers.
-
orionis.foundation.config.session
orionis.foundation.config.session.html
Package
Package
PUBLIC
Group the foundation config session components and public imports.
-
orionis.foundation.config.session.entities
orionis.foundation.config.session.entities.html
Package
Package
PUBLIC
Group the foundation config session entities components and public imports.
-
orionis.foundation.config.session.entities.session
orionis.foundation.config.session.entities.session.html
Module
Module
PUBLIC
Configure the session middleware.
-
orionis.foundation.config.session.enums
orionis.foundation.config.session.enums.html
Package
Package
PUBLIC
Group the foundation config session enums components and public imports.
-
orionis.foundation.config.session.enums.drivers
orionis.foundation.config.session.enums.drivers.html
Module
Module
PUBLIC
Enumeration of supported session storage drivers.
-
orionis.foundation.config.session.enums.same_site_policy
orionis.foundation.config.session.enums.same_site_policy.html
Module
Module
PUBLIC
Represent possible values for the SameSite attribute of cookies.
-
orionis.foundation.config.session.helpers
orionis.foundation.config.session.helpers.html
Package
Package
PUBLIC
Group the foundation config session helpers components and public imports.
-
orionis.foundation.config.session.helpers.secret_key
orionis.foundation.config.session.helpers.secret_key.html
Module
Module
PUBLIC
Resolve and validate the key used to protect session data.
-
orionis.foundation.config.startup
orionis.foundation.config.startup.html
Module
Module
PUBLIC
Represent the main configuration for Orionis Framework startup.
-
orionis.foundation.config.testing
orionis.foundation.config.testing.html
Package
Package
PUBLIC
Group the foundation config testing components and public imports.
-
orionis.foundation.config.testing.entities
orionis.foundation.config.testing.entities.html
Package
Package
PUBLIC
Group the foundation config testing entities components and public imports.
-
orionis.foundation.config.testing.entities.testing
orionis.foundation.config.testing.entities.testing.html
Module
Module
PUBLIC
Configure testing settings.
-
orionis.foundation.config.testing.enums
orionis.foundation.config.testing.enums.html
Package
Package
PUBLIC
Group the foundation config testing enums components and public imports.
-
orionis.foundation.config.testing.enums.verbosity
orionis.foundation.config.testing.enums.verbosity.html
Module
Module
PUBLIC
Enumerate verbosity levels for test output.
-
orionis.foundation.config.validation
orionis.foundation.config.validation.html
Module
Module
PUBLIC
Provide foundation config operations.
-
orionis.foundation.config.view
orionis.foundation.config.view.html
Package
Package
PUBLIC
Group the foundation config view components and public imports.
-
orionis.foundation.config.view.entities
orionis.foundation.config.view.entities.html
Package
Package
PUBLIC
Group the foundation config view entities components and public imports.
-
orionis.foundation.config.view.entities.view
orionis.foundation.config.view.entities.view.html
Module
Module
PUBLIC
Represent view engine configuration for the application.
-
orionis.foundation.contracts
orionis.foundation.contracts.html
Package
Package
PUBLIC
Group the foundation contracts components and public imports.
-
orionis.foundation.contracts.application
orionis.foundation.contracts.application.html
Module
Module
PUBLIC
Define application configuration, lifecycle and runtime entry points.
-
orionis.foundation.contracts.directory
orionis.foundation.contracts.directory.html
Module
Module
PUBLIC
Define access to the application directory paths.
-
orionis.foundation.core_config
orionis.foundation.core_config.html
Module
Module
PUBLIC
Provide foundation operations through get_core_config_mapping.
-
orionis.foundation.core_exception_handler
orionis.foundation.core_exception_handler.html
Module
Module
PUBLIC
Provide foundation operations through get_core_exception_handler_mapping.
-
orionis.foundation.core_kernels
orionis.foundation.core_kernels.html
Module
Module
PUBLIC
Provide foundation operations through get_core_kernels_mapping.
-
orionis.foundation.core_paths
orionis.foundation.core_paths.html
Module
Module
PUBLIC
Define core paths for foundation.
-
orionis.foundation.core_providers
orionis.foundation.core_providers.html
Module
Module
PUBLIC
Provide foundation operations through get_core_providers_mapping.
-
orionis.foundation.core_scheduler
orionis.foundation.core_scheduler.html
Module
Module
PUBLIC
Provide foundation operations through get_core_scheduler_mapping.
-
orionis.foundation.directory
orionis.foundation.directory.html
Module
Module
PUBLIC
Expose the configured application directories.
-
orionis.foundation.enums
orionis.foundation.enums.html
Package
Package
PUBLIC
Group the foundation enums components and public imports.
-
orionis.foundation.enums.lifespan
orionis.foundation.enums.lifespan.module.html
Module
Module
PUBLIC
Define the possible lifespan events for the application.
-
orionis.foundation.enums.runtimes
orionis.foundation.enums.runtimes.html
Module
Module
PUBLIC
Define runtime environments for the framework.
-
orionis.foundation.lifespan
orionis.foundation.lifespan.html
Package
Package
PUBLIC
Group the foundation lifespan components and public imports.
-
orionis.foundation.lifespan.shutdown
orionis.foundation.lifespan.shutdown.html
Module
Module
PUBLIC
Provide foundation lifespan operations.
-
orionis.foundation.lifespan.startup
orionis.foundation.lifespan.startup.html
Module
Module
PUBLIC
Provide foundation lifespan operations.
-
orionis.hashing
orionis.hashing.html
Package
Package
PUBLIC
Group the hashing components and public imports.
-
orionis.hashing.contracts
orionis.hashing.contracts.html
Package
Package
PUBLIC
Group the hashing contracts components and public imports.
-
orionis.hashing.contracts.hash_manager
orionis.hashing.contracts.hash_manager.html
Module
Module
PUBLIC
Define the contract for the hashing manager.
-
orionis.hashing.contracts.hasher
orionis.hashing.contracts.hasher.html
Module
Module
PUBLIC
Define the contract implemented by every password hashing driver.
-
orionis.hashing.exceptions
orionis.hashing.exceptions.html
Module
Module
PUBLIC
Provide hashing operations.
-
orionis.hashing.execution
orionis.hashing.execution.html
Module
Module
PUBLIC
Share bounded native workers across password hashing drivers.
-
orionis.hashing.hash_manager
orionis.hashing.hash_manager.html
Module
Module
PUBLIC
Expose an algorithm-agnostic hashing API.
-
orionis.hashing.hashers
orionis.hashing.hashers.html
Package
Package
PUBLIC
Group the hashing hashers components and public imports.
-
orionis.hashing.hashers.argon2_hasher
orionis.hashing.hashers.argon2_hasher.html
Module
Module
PUBLIC
Hash passwords with Argon2id.
-
orionis.hashing.hashers.bcrypt_hasher
orionis.hashing.hashers.bcrypt_hasher.html
Module
Module
PUBLIC
Hash passwords with bcrypt.
-
orionis.hashing.hashers.functions
orionis.hashing.hashers.functions.html
Module
Module
PUBLIC
Provide shared hashing limits and lazy backend resolution.
-
orionis.hashing.provider
orionis.hashing.provider.html
Module
Module
PUBLIC
Service provider for the Orionis hashing system.
-
orionis.http
orionis.http.html
Package
Package
PUBLIC
Group the http components and public imports.
-
orionis.http.adapters
orionis.http.adapters.html
Package
Package
PUBLIC
Group the http adapters components and public imports.
-
orionis.http.adapters.request
orionis.http.adapters.request.html
Package
Package
PUBLIC
Group the http adapters request components and public imports.
-
orionis.http.adapters.request.asgi
orionis.http.adapters.request.asgi.html
Module
Module
PUBLIC
Adapt an ASGI scope dictionary to the transport adapter contract.
-
orionis.http.adapters.request.contracts
orionis.http.adapters.request.contracts.html
Package
Package
PUBLIC
Group the http adapters request contracts components and public imports.
-
orionis.http.adapters.request.contracts.transport
orionis.http.adapters.request.contracts.transport.html
Module
Module
PUBLIC
Read/write abstraction over a protocol scope (ASGI or RSGI).
-
orionis.http.adapters.request.rsgi
orionis.http.adapters.request.rsgi.html
Module
Module
PUBLIC
Adapt a Granian RSGI scope to the transport adapter contract.
-
orionis.http.adapters.response
orionis.http.adapters.response.html
Package
Package
PUBLIC
Group the http adapters response components and public imports.
-
orionis.http.adapters.response.asgi
orionis.http.adapters.response.asgi.html
Module
Module
PUBLIC
Translate HTTP responses into ASGI protocol messages.
-
orionis.http.adapters.response.contracts
orionis.http.adapters.response.contracts.html
Package
Package
PUBLIC
Group the http adapters response contracts components and public imports.
-
orionis.http.adapters.response.contracts.response
orionis.http.adapters.response.contracts.response.html
Module
Module
PUBLIC
Write abstraction for sending an HTTP response over a protocol transport.
-
orionis.http.adapters.response.files
orionis.http.adapters.response.files.html
Module
Module
PUBLIC
Provide http adapters response operations.
-
orionis.http.adapters.response.ranges
orionis.http.adapters.response.ranges.html
Module
Module
PUBLIC
Provide http adapters response operations through parse_range.
-
orionis.http.adapters.response.rsgi
orionis.http.adapters.response.rsgi.html
Module
Module
PUBLIC
Translate HTTP responses into Granian RSGI operations.
-
orionis.http.adapters.response.streams
orionis.http.adapters.response.streams.html
Module
Module
PUBLIC
Provide http adapters response operations.
-
orionis.http.adapters.websocket
orionis.http.adapters.websocket.html
Package
Package
PUBLIC
Group the http adapters websocket components and public imports.
-
orionis.http.adapters.websocket.asgi
orionis.http.adapters.websocket.asgi.html
Module
Module
PUBLIC
Translate the ASGI WebSocket protocol into normalized operations.
-
orionis.http.adapters.websocket.contracts
orionis.http.adapters.websocket.contracts.html
Package
Package
PUBLIC
Group the http adapters websocket contracts components and public imports.
-
orionis.http.adapters.websocket.contracts.transport
orionis.http.adapters.websocket.contracts.transport.html
Module
Module
PUBLIC
Normalize server operations without owning application lifecycle state.
-
orionis.http.adapters.websocket.failure
orionis.http.adapters.websocket.failure.html
Module
Module
PUBLIC
Preserve transport incidents when exposing WebSocket disconnect controls.
-
orionis.http.adapters.websocket.rsgi
orionis.http.adapters.websocket.rsgi.html
Module
Module
PUBLIC
Adapt Granian's actual RSGI WebsocketProtocol and accepted transport.
-
orionis.http.base
orionis.http.base.html
Package
Package
PUBLIC
Group the http base components and public imports.
-
orionis.http.base.controller
orionis.http.base.controller.html
Module
Module
PUBLIC
Provide a base class for HTTP controllers.
-
orionis.http.contracts
orionis.http.contracts.html
Package
Package
PUBLIC
Group the http contracts components and public imports.
-
orionis.http.contracts.endpoint_policy
orionis.http.contracts.endpoint_policy.html
Module
Module
PUBLIC
Customize endpoint framing without replacing routing or middleware.
-
orionis.http.contracts.kernel
orionis.http.contracts.kernel.html
Module
Module
PUBLIC
Define the contract for kernel http implementations.
-
orionis.http.contracts.request
orionis.http.contracts.request.html
Module
Module
PUBLIC
Define the contract for request implementations.
-
orionis.http.contracts.response
orionis.http.contracts.response.html
Module
Module
PUBLIC
Define the contract for response implementations.
-
orionis.http.default
orionis.http.default.html
Package
Package
PUBLIC
Group the http default components and public imports.
-
orionis.http.default.assistance
orionis.http.default.assistance.html
Module
Module
PUBLIC
Provide http default operations through build_chatgpt_url.
-
orionis.http.default.contracts
orionis.http.default.contracts.html
Package
Package
PUBLIC
Group the http default contracts components and public imports.
-
orionis.http.default.contracts.responses
orionis.http.default.contracts.responses.html
Module
Module
PUBLIC
Define the contract for default responses implementations.
-
orionis.http.default.controllers
orionis.http.default.controllers.html
Package
Package
PUBLIC
Group the http default controllers components and public imports.
-
orionis.http.default.controllers.forgot_password_controller
orionis.http.default.controllers.forgot_password_controller.html
Module
Module
PUBLIC
Handle the built-in password-reset request endpoints.
-
orionis.http.default.controllers.login_controller
orionis.http.default.controllers.login_controller.html
Module
Module
PUBLIC
Handle the built-in sign-in and sign-out endpoints.
-
orionis.http.default.controllers.profile_controller
orionis.http.default.controllers.profile_controller.html
Module
Module
PUBLIC
Handle built-in profile and password-management endpoints.
-
orionis.http.default.controllers.register_controller
orionis.http.default.controllers.register_controller.html
Module
Module
PUBLIC
Handle the built-in account-registration endpoints.
-
orionis.http.default.responses
orionis.http.default.responses.html
Module
Module
PUBLIC
Render the framework default HTTP error and status responses.
-
orionis.http.default.schemas
orionis.http.default.schemas.html
Package
Package
PUBLIC
Group the http default schemas components and public imports.
-
orionis.http.default.schemas.change_password
orionis.http.default.schemas.change_password.html
Module
Module
PUBLIC
Validate the current password and its proposed replacement.
-
orionis.http.default.schemas.forgot_password
orionis.http.default.schemas.forgot_password.html
Module
Module
PUBLIC
Validate the email address used to request a password reset.
-
orionis.http.default.schemas.login
orionis.http.default.schemas.login.html
Module
Module
PUBLIC
Validate sign-in credentials and the remember-session option.
-
orionis.http.default.schemas.register
orionis.http.default.schemas.register.html
Module
Module
PUBLIC
Validate the account details required for user registration.
-
orionis.http.default.schemas.reset_password
orionis.http.default.schemas.reset_password.html
Module
Module
PUBLIC
Validate password-reset credentials and the replacement password.
-
orionis.http.enums
orionis.http.enums.html
Package
Package
PUBLIC
Group the http enums components and public imports.
-
orionis.http.enums.interfaces
orionis.http.enums.interfaces.html
Module
Module
PUBLIC
Represent the supported HTTP interface types.
-
orionis.http.enums.status
orionis.http.enums.status.html
Module
Module
PUBLIC
Provide http enums operations through HTTPStatus, WebSocketStatus.
-
orionis.http.exceptions
orionis.http.exceptions.html
Package
Package
PUBLIC
Group the http exceptions components and public imports.
-
orionis.http.exceptions.response_validation
orionis.http.exceptions.response_validation.html
Module
Module
PUBLIC
Report an invalid schema returned by an HTTP handler.
-
orionis.http.exceptions.websocket
orionis.http.exceptions.websocket.html
Module
Module
PUBLIC
Report a terminal connection failure with available close details.
-
orionis.http.factory
orionis.http.factory.html
Module
Module
PUBLIC
Build every kind of HTTP response from a single entry-point.
-
orionis.http.kernel
orionis.http.kernel.html
Module
Module
PUBLIC
Serve concurrent requests within one worker event loop.
-
orionis.http.layer
orionis.http.layer.html
Package
Package
PUBLIC
Group the http layer components and public imports.
-
orionis.http.layer.api
orionis.http.layer.api.html
Package
Package
PUBLIC
Group the http layer api components and public imports.
-
orionis.http.layer.contracts
orionis.http.layer.contracts.html
Package
Package
PUBLIC
Group the http layer contracts components and public imports.
-
orionis.http.layer.contracts.middleware
orionis.http.layer.contracts.middleware.html
Module
Module
PUBLIC
Define the base contract for all HTTP middlewares in the pipeline.
-
orionis.http.layer.shared
orionis.http.layer.shared.html
Package
Package
PUBLIC
Group the http layer shared components and public imports.
-
orionis.http.layer.shared.cors
orionis.http.layer.shared.cors.html
Module
Module
PUBLIC
Validate cross-origin HTTP requests and attach CORS response headers.
-
orionis.http.layer.shared.maintenance
orionis.http.layer.shared.maintenance.html
Module
Module
PUBLIC
Reject every incoming request with 503 while in maintenance mode.
-
orionis.http.layer.shared.proxies
orionis.http.layer.shared.proxies.html
Module
Module
PUBLIC
Normalize client IP and scheme using trusted proxy headers.
-
orionis.http.layer.shared.rate_limit
orionis.http.layer.shared.rate_limit.html
Module
Module
PUBLIC
Apply configured request-rate limits before dispatch.
-
orionis.http.layer.shared.security
orionis.http.layer.shared.security.html
Module
Module
PUBLIC
Enforce baseline HTTP security policies on every request.
-
orionis.http.layer.store
orionis.http.layer.store.html
Package
Package
PUBLIC
Group the http layer store components and public imports.
-
orionis.http.layer.store.memory_rate_limit
orionis.http.layer.store.memory_rate_limit.html
Module
Module
PUBLIC
Track rate-limit counters in process-local memory.
-
orionis.http.layer.store.redis_rate_limit
orionis.http.layer.store.redis_rate_limit.html
Module
Module
PUBLIC
Share sliding-window quotas using a single-key atomic Redis script.
-
orionis.http.layer.web
orionis.http.layer.web.html
Package
Package
PUBLIC
Group the http layer web components and public imports.
-
orionis.http.layer.web.csrf_token
orionis.http.layer.web.csrf_token.html
Module
Module
PUBLIC
Web-layer middleware that enforces Cross-Site Request Forgery protection.
-
orionis.http.layer.web.exceptions
orionis.http.layer.web.exceptions.html
Module
Module
PUBLIC
Raised when the CSRF token does not match the session token.
-
orionis.http.layer.web.start_session
orionis.http.layer.web.start_session.html
Module
Module
PUBLIC
Open request sessions and persist their response-side changes.
-
orionis.http.middleware
orionis.http.middleware.html
Module
Module
PUBLIC
Base class for HTTP middleware implementations.
-
orionis.http.payload
orionis.http.payload.html
Package
Package
PUBLIC
Group the http payload components and public imports.
-
orionis.http.payload.body
orionis.http.payload.body.html
Module
Module
PUBLIC
Provide http payload operations.
-
orionis.http.payload.contracts
orionis.http.payload.contracts.html
Package
Package
PUBLIC
Group the http payload contracts components and public imports.
-
orionis.http.payload.contracts.body_stream
orionis.http.payload.contracts.body_stream.html
Module
Module
PUBLIC
Define the minimal contract for reading an HTTP request body.
-
orionis.http.payload.contracts.form_data
orionis.http.payload.contracts.form_data.html
Module
Module
PUBLIC
Define the contract for parsed multipart form data.
-
orionis.http.payload.contracts.media_types
orionis.http.payload.contracts.media_types.html
Module
Module
PUBLIC
Define the contract for a media-type-to-parser registry.
-
orionis.http.payload.contracts.part
orionis.http.payload.contracts.part.html
Module
Module
PUBLIC
Define the contract for a single part within a multipart HTTP request body.
-
orionis.http.payload.contracts.stream_parser
orionis.http.payload.contracts.stream_parser.html
Module
Module
PUBLIC
Define the contract for parsing a multipart byte stream.
-
orionis.http.payload.contracts.uploaded_file
orionis.http.payload.contracts.uploaded_file.html
Module
Module
PUBLIC
Define the contract for an uploaded file held in memory or on disk.
-
orionis.http.payload.estructures
orionis.http.payload.estructures.html
Package
Package
PUBLIC
Group the http payload estructures components and public imports.
-
orionis.http.payload.estructures.cookies
orionis.http.payload.estructures.cookies.html
Module
Module
PUBLIC
Parse request cookies and expose their decoded values.
-
orionis.http.payload.estructures.query_params
orionis.http.payload.estructures.query_params.html
Module
Module
PUBLIC
Parse query-string pairs while preserving repeated parameter values.
-
orionis.http.payload.form_data
orionis.http.payload.form_data.html
Module
Module
PUBLIC
Hold parsed multipart form fields and uploaded files.
-
orionis.http.payload.media_types
orionis.http.payload.media_types.html
Module
Module
PUBLIC
Map lowercased media-type strings to synchronous BodyParser callables.
-
orionis.http.payload.parsers
orionis.http.payload.parsers.html
Module
Module
PUBLIC
Provide http payload operations.
-
orionis.http.payload.part
orionis.http.payload.part.html
Module
Module
PUBLIC
Represent a single part within a multipart HTTP request body.
-
orionis.http.payload.stream_parser
orionis.http.payload.stream_parser.html
Module
Module
PUBLIC
Parse a multipart byte stream into form fields and uploaded files.
-
orionis.http.payload.uploaded_file
orionis.http.payload.uploaded_file.html
Module
Module
PUBLIC
Hold an uploaded file in memory or spill it to a temporary file on disk.
-
orionis.http.request
orionis.http.request.module.html
Module
Module
PUBLIC
Provide http operations through UnsupportedMediaTypeException, Request.
-
orionis.http.responses
orionis.http.responses.html
Module
Module
PUBLIC
Provide http operations.
-
orionis.http.routes
orionis.http.routes.html
Package
Package
PUBLIC
Group the http routes components and public imports.
-
orionis.http.routes.auth
orionis.http.routes.auth.html
Module
Module
PUBLIC
Provide http routes operations through build_auth_routes.
-
orionis.http.routes.contracts
orionis.http.routes.contracts.html
Package
Package
PUBLIC
Group the http routes contracts components and public imports.
-
orionis.http.routes.contracts.fluent
orionis.http.routes.contracts.fluent.html
Module
Module
PUBLIC
Define the contract for fluent route implementations.
-
orionis.http.routes.contracts.loader
orionis.http.routes.contracts.loader.html
Module
Module
PUBLIC
Define the contract for route loader implementations.
-
orionis.http.routes.contracts.route_cache
orionis.http.routes.contracts.route_cache.html
Module
Module
PUBLIC
Define the contract for route cache implementations.
-
orionis.http.routes.contracts.route_compiler
orionis.http.routes.contracts.route_compiler.html
Module
Module
PUBLIC
Define the contract for route compiler implementations.
-
orionis.http.routes.contracts.route_resolver
orionis.http.routes.contracts.route_resolver.html
Module
Module
PUBLIC
Define the contract for route resolver implementations.
-
orionis.http.routes.contracts.router
orionis.http.routes.contracts.router.html
Module
Module
PUBLIC
Define the contract for router implementations.
-
orionis.http.routes.entities
orionis.http.routes.entities.html
Package
Package
PUBLIC
Group the http routes entities components and public imports.
-
orionis.http.routes.entities.compiled_route
orionis.http.routes.entities.compiled_route.html
Module
Module
PUBLIC
Represent a runtime-ready compiled HTTP or WebSocket route.
-
orionis.http.routes.entities.resolved_route
orionis.http.routes.entities.resolved_route.html
Module
Module
PUBLIC
Represent the immutable result of a successful route resolution.
-
orionis.http.routes.enums
orionis.http.routes.enums.html
Package
Package
PUBLIC
Group the http routes enums components and public imports.
-
orionis.http.routes.enums.protocols
orionis.http.routes.enums.protocols.html
Module
Module
PUBLIC
Identify a route's transport independently of its handler action type.
-
orionis.http.routes.enums.route_types
orionis.http.routes.enums.route_types.html
Module
Module
PUBLIC
Define enumeration of route types for the framework.
-
orionis.http.routes.exceptions
orionis.http.routes.exceptions.html
Package
Package
PUBLIC
Group the http routes exceptions components and public imports.
-
orionis.http.routes.exceptions.fallback_route_already_registered
orionis.http.routes.exceptions.fallback_route_already_registered.html
Module
Module
PUBLIC
Raised when a second fallback route is registered.
-
orionis.http.routes.exceptions.method_not_allowed
orionis.http.routes.exceptions.method_not_allowed.html
Module
Module
PUBLIC
Signal that the requested path exists under a different HTTP method.
-
orionis.http.routes.exceptions.route_not_found
orionis.http.routes.exceptions.route_not_found.html
Module
Module
PUBLIC
Signal that no route matches the requested path under any HTTP method.
-
orionis.http.routes.fluent
orionis.http.routes.fluent.html
Module
Module
PUBLIC
Build route definitions through chainable routing options.
-
orionis.http.routes.functions
orionis.http.routes.functions.html
Module
Module
PUBLIC
Provide http routes operations.
-
orionis.http.routes.group
orionis.http.routes.group.html
Module
Module
PUBLIC
Hold already registered routes so a parent can compose their context.
-
orionis.http.routes.loader
orionis.http.routes.loader.html
Module
Module
PUBLIC
Load route declarations from configured application modules.
-
orionis.http.routes.params_types
orionis.http.routes.params_types.html
Module
Module
PUBLIC
Define params types for http routes.
-
orionis.http.routes.provider
orionis.http.routes.provider.html
Module
Module
PUBLIC
Register router services in the application container.
-
orionis.http.routes.route_cache
orionis.http.routes.route_cache.html
Module
Module
PUBLIC
Read and write compiled routing metadata for application startup.
-
orionis.http.routes.route_compiler
orionis.http.routes.route_compiler.html
Module
Module
PUBLIC
Compile declared routes into runtime dispatch metadata.
-
orionis.http.routes.route_id
orionis.http.routes.route_id.html
Module
Module
PUBLIC
Generate process-qualified identifiers for registered routes.
-
orionis.http.routes.route_resolver
orionis.http.routes.route_resolver.html
Module
Module
PUBLIC
Resolve compiled routes using static maps and ordered dynamic buckets.
-
orionis.http.routes.router
orionis.http.routes.router.html
Module
Module
PUBLIC
Register application routes and configure their shared dispatch options.
-
orionis.http.routes.types
orionis.http.routes.types.html
Module
Module
PUBLIC
Define types for http routes.
-
orionis.http.sse
orionis.http.sse.html
Module
Module
PUBLIC
Represent one immutable UTF-8 server-sent event.
-
orionis.http.types
orionis.http.types.html
Module
Module
PUBLIC
Define types for http.
-
orionis.http.validation
orionis.http.validation.html
Module
Module
PUBLIC
Provide http operations through validation_response, previous_url.
-
orionis.http.websocket
orionis.http.websocket.module.html
Module
Module
PUBLIC
Own one server-independent connection with direct awaited messaging.
-
orionis.http.websocket_message
orionis.http.websocket_message.html
Module
Module
PUBLIC
Provide http operations.
-
orionis.http.websocket_middleware
orionis.http.websocket_middleware.html
Module
Module
PUBLIC
Define a connection middleware resolved inside each WebSocket scope.
-
orionis.introspection
orionis.introspection.html
Package
Package
PUBLIC
Group the introspection components and public imports.
-
orionis.introspection.abstract
orionis.introspection.abstract.html
Package
Package
PUBLIC
Group the introspection abstract components and public imports.
-
orionis.introspection.abstract.contracts
orionis.introspection.abstract.contracts.html
Package
Package
PUBLIC
Group the introspection abstract contracts components and public imports.
-
orionis.introspection.abstract.contracts.reflection
orionis.introspection.abstract.contracts.reflection.html
Module
Module
PUBLIC
Define the contract for reflection abstract implementations.
-
orionis.introspection.abstract.reflection
orionis.introspection.abstract.reflection.html
Module
Module
PUBLIC
Inspect abstract class declarations and their members.
-
orionis.introspection.callables
orionis.introspection.callables.html
Package
Package
PUBLIC
Group the introspection callables components and public imports.
-
orionis.introspection.callables.contracts
orionis.introspection.callables.contracts.html
Package
Package
PUBLIC
Group the introspection callables contracts components and public imports.
-
orionis.introspection.callables.contracts.reflection
orionis.introspection.callables.contracts.reflection.html
Module
Module
PUBLIC
Define the contract for reflection callable implementations.
-
orionis.introspection.callables.reflection
orionis.introspection.callables.reflection.html
Module
Module
PUBLIC
Inspect callable signatures, parameters and invocation metadata.
-
orionis.introspection.concretes
orionis.introspection.concretes.html
Package
Package
PUBLIC
Group the introspection concretes components and public imports.
-
orionis.introspection.concretes.contracts
orionis.introspection.concretes.contracts.html
Package
Package
PUBLIC
Group the introspection concretes contracts components and public imports.
-
orionis.introspection.concretes.contracts.reflection
orionis.introspection.concretes.contracts.reflection.html
Module
Module
PUBLIC
Define the contract for reflection concrete implementations.
-
orionis.introspection.concretes.reflection
orionis.introspection.concretes.reflection.html
Module
Module
PUBLIC
Inspect concrete classes and their construction requirements.
-
orionis.introspection.dependencies
orionis.introspection.dependencies.html
Package
Package
PUBLIC
Group the introspection dependencies components and public imports.
-
orionis.introspection.dependencies.contracts
orionis.introspection.dependencies.contracts.html
Package
Package
PUBLIC
Group the introspection dependencies contracts components and public imports.
-
orionis.introspection.dependencies.contracts.reflection
orionis.introspection.dependencies.contracts.reflection.html
Module
Module
PUBLIC
Define the contract for dependency-reflection implementations.
-
orionis.introspection.dependencies.entities
orionis.introspection.dependencies.entities.html
Package
Package
PUBLIC
Group the introspection dependencies entities components and public imports.
-
orionis.introspection.dependencies.entities.argument
orionis.introspection.dependencies.entities.argument.html
Module
Module
PUBLIC
Represent a function or method argument with type and resolution metadata.
-
orionis.introspection.dependencies.entities.signature
orionis.introspection.dependencies.entities.signature.html
Module
Module
PUBLIC
Represent the categorized dependency signature of a callable.
-
orionis.introspection.dependencies.reflection
orionis.introspection.dependencies.reflection.html
Module
Module
PUBLIC
Reflect dependency metadata from callables, constructors, and methods.
-
orionis.introspection.instances
orionis.introspection.instances.html
Package
Package
PUBLIC
Group the introspection instances components and public imports.
-
orionis.introspection.instances.contracts
orionis.introspection.instances.contracts.html
Package
Package
PUBLIC
Group the introspection instances contracts components and public imports.
-
orionis.introspection.instances.contracts.reflection
orionis.introspection.instances.contracts.reflection.html
Module
Module
PUBLIC
Define the contract for reflection instance implementations.
-
orionis.introspection.instances.reflection
orionis.introspection.instances.reflection.html
Module
Module
PUBLIC
Inspect the class and members of an existing object.
-
orionis.introspection.modules
orionis.introspection.modules.html
Package
Package
PUBLIC
Group the introspection modules components and public imports.
-
orionis.introspection.modules.contracts
orionis.introspection.modules.contracts.html
Package
Package
PUBLIC
Group the introspection modules contracts components and public imports.
-
orionis.introspection.modules.contracts.reflection
orionis.introspection.modules.contracts.reflection.html
Module
Module
PUBLIC
Define the contract for reflection module implementations.
-
orionis.introspection.modules.inspector
orionis.introspection.modules.inspector.html
Module
Module
PUBLIC
Load modules and inspect their exported definitions.
-
orionis.introspection.modules.reflection
orionis.introspection.modules.reflection.html
Module
Module
PUBLIC
Inspect Python modules and the definitions they contain.
-
orionis.introspection.reflection
orionis.introspection.reflection.module.html
Module
Module
PUBLIC
Select reflection helpers for classes, instances, functions and modules.
-
orionis.localization
orionis.localization.html
Package
Package
PUBLIC
Group the localization components and public imports.
-
orionis.localization.contracts
orionis.localization.contracts.html
Package
Package
PUBLIC
Group the localization contracts components and public imports.
-
orionis.localization.contracts.loader
orionis.localization.contracts.loader.html
Module
Module
PUBLIC
Define the contract for translation file loaders.
-
orionis.localization.contracts.manager
orionis.localization.contracts.manager.html
Module
Module
PUBLIC
Define the contract for the localization manager.
-
orionis.localization.contracts.repository
orionis.localization.contracts.repository.html
Module
Module
PUBLIC
Define the contract for the in-memory translation cache.
-
orionis.localization.contracts.translator
orionis.localization.contracts.translator.html
Module
Module
PUBLIC
Define the contract for the translation service.
-
orionis.localization.exceptions
orionis.localization.exceptions.html
Module
Module
PUBLIC
Provide localization operations.
-
orionis.localization.loader
orionis.localization.loader.html
Module
Module
PUBLIC
Load translation sources from the configured language path.
-
orionis.localization.manager
orionis.localization.manager.html
Module
Module
PUBLIC
Wire the localization component from the application configuration.
-
orionis.localization.provider
orionis.localization.provider.html
Module
Module
PUBLIC
Service provider for the Orionis localization system.
-
orionis.localization.repository
orionis.localization.repository.html
Module
Module
PUBLIC
Cache translation maps in memory by locale.
-
orionis.localization.translator
orionis.localization.translator.module.html
Module
Module
PUBLIC
Resolve translation lines for the active locale.
-
orionis.localization.types
orionis.localization.types.html
Module
Module
PUBLIC
Define types for localization.
-
orionis.localization.validators
orionis.localization.validators.html
Module
Module
PUBLIC
Validate locale codes shared by translators and filesystem loaders.
-
orionis.logging
orionis.logging.html
Package
Package
PUBLIC
Group the logging components and public imports.
-
orionis.logging.contracts
orionis.logging.contracts.html
Package
Package
PUBLIC
Group the logging contracts components and public imports.
-
orionis.logging.contracts.logger
orionis.logging.contracts.logger.html
Module
Module
PUBLIC
Define the contract for logger implementations.
-
orionis.logging.contracts.suffix_resolver
orionis.logging.contracts.suffix_resolver.html
Module
Module
PUBLIC
Define how rotating log files derive their time-based suffixes.
-
orionis.logging.handlers
orionis.logging.handlers.html
Package
Package
PUBLIC
Group the logging handlers components and public imports.
-
orionis.logging.handlers.advanced_rotating_file_handler
orionis.logging.handlers.advanced_rotating_file_handler.html
Module
Module
PUBLIC
Rotate log files using size limits and resolved time suffixes.
-
orionis.logging.handlers.chunked_suffix_resolver
orionis.logging.handlers.chunked_suffix_resolver.html
Module
Module
PUBLIC
Resolve log suffixes for configured time chunks.
-
orionis.logging.handlers.daily_suffix_resolver
orionis.logging.handlers.daily_suffix_resolver.html
Module
Module
PUBLIC
Resolve log suffixes for daily rotation windows.
-
orionis.logging.handlers.hourly_suffix_resolver
orionis.logging.handlers.hourly_suffix_resolver.html
Module
Module
PUBLIC
Resolve log suffixes for hourly rotation windows.
-
orionis.logging.handlers.monthly_suffix_resolver
orionis.logging.handlers.monthly_suffix_resolver.html
Module
Module
PUBLIC
Resolve log suffixes for monthly rotation windows.
-
orionis.logging.handlers.queued
orionis.logging.handlers.queued.html
Module
Module
PUBLIC
Queue log records and observe sink delivery or cleanup failures.
-
orionis.logging.handlers.rotating_handler_factory
orionis.logging.handlers.rotating_handler_factory.html
Module
Module
PUBLIC
Construct rotating log handlers from channel configuration.
-
orionis.logging.handlers.weekly_suffix_resolver
orionis.logging.handlers.weekly_suffix_resolver.html
Module
Module
PUBLIC
Resolve log suffixes for weekly rotation windows.
-
orionis.logging.logger
orionis.logging.logger.module.html
Module
Module
PUBLIC
Resolve logging channels and dispatch structured log records.
-
orionis.logging.provider
orionis.logging.provider.html
Module
Module
PUBLIC
Register logger services in the application container.
-
orionis.mail
orionis.mail.html
Package
Package
PUBLIC
Group the mail components and public imports.
-
orionis.mail.composer
orionis.mail.composer.html
Module
Module
PUBLIC
Prepare all bodies and attachments before any transport side effect.
-
orionis.mail.contracts
orionis.mail.contracts.html
Package
Package
PUBLIC
Group the mail contracts components and public imports.
-
orionis.mail.contracts.manager
orionis.mail.contracts.manager.html
Module
Module
PUBLIC
Expose independent composition and centrally configured mail delivery.
-
orionis.mail.contracts.transport
orionis.mail.contracts.transport.html
Module
Module
PUBLIC
Send already prepared mail without knowing views or storage declarations.
-
orionis.mail.entities
orionis.mail.entities.html
Package
Package
PUBLIC
Group the mail entities components and public imports.
-
orionis.mail.entities.address
orionis.mail.entities.address.module.html
Module
Module
PUBLIC
Represent one mailbox with an optional Unicode display name.
-
orionis.mail.entities.attachment
orionis.mail.entities.attachment.module.html
Module
Module
PUBLIC
Describe a storage attachment without opening it or resolving a disk.
-
orionis.mail.entities.content
orionis.mail.entities.content.module.html
Module
Module
PUBLIC
Declare literal bodies or views with one explicit isolated context.
-
orionis.mail.entities.envelope
orionis.mail.entities.envelope.module.html
Module
Module
PUBLIC
Store normalized immutable headers and intended recipients.
-
orionis.mail.entities.options
orionis.mail.entities.options.html
Module
Module
PUBLIC
Snapshot the explicitly supplied options of one independent chain.
-
orionis.mail.entities.prepared
orionis.mail.entities.prepared.html
Module
Module
PUBLIC
Carry immutable MIME bytes and a separate validated transport envelope.
-
orionis.mail.entities.result
orionis.mail.entities.result.html
Module
Module
PUBLIC
Report SMTP acceptance or file storage, never final mailbox delivery.
-
orionis.mail.entities.smtp_settings
orionis.mail.entities.smtp_settings.html
Module
Module
PUBLIC
Store effective SMTP settings without exposing credentials in repr.
-
orionis.mail.enums
orionis.mail.enums.html
Package
Package
PUBLIC
Group the mail enums components and public imports.
-
orionis.mail.enums.encryption
orionis.mail.enums.encryption.html
Module
Module
PUBLIC
Enumerate the transport security modes accepted by the SMTP driver.
-
orionis.mail.enums.status
orionis.mail.enums.status.html
Module
Module
PUBLIC
Enumerate the outcomes a transport can confirm for one operation.
-
orionis.mail.exceptions
orionis.mail.exceptions.html
Module
Module
PUBLIC
Provide mail operations.
-
orionis.mail.functions
orionis.mail.functions.html
Module
Module
PUBLIC
Provide mail operations.
-
orionis.mail.mailable
orionis.mail.mailable.module.html
Module
Module
PUBLIC
Declare reusable mail without I/O or per-send mutation.
-
orionis.mail.manager
orionis.mail.manager.html
Module
Module
PUBLIC
Resolve central mail configuration and delegate the shared fluent pipeline.
-
orionis.mail.message
orionis.mail.message.module.html
Module
Module
PUBLIC
Configure one direct send without exposing a mutable MIME message.
-
orionis.mail.pending
orionis.mail.pending.html
Module
Module
PUBLIC
Build independent chains; every fluent call returns a new operation.
-
orionis.mail.provider
orionis.mail.provider.html
Module
Module
PUBLIC
Register mail eagerly so synchronous fluent facade entries work immediately.
-
orionis.mail.transports
orionis.mail.transports.html
Package
Package
PUBLIC
Group the mail transports components and public imports.
-
orionis.mail.transports.file
orionis.mail.transports.file.html
Module
Module
PUBLIC
Publish complete private .eml files atomically without overwriting.
-
orionis.mail.transports.smtp
orionis.mail.transports.smtp.html
Module
Module
PUBLIC
Use one verified SMTP connection per message, entirely on a worker.
-
orionis.mail.types
orionis.mail.types.html
Module
Module
PUBLIC
Define types for mail.
-
orionis.mcp
orionis.mcp.html
Package
Package
PUBLIC
Native, stateless MCP server support for Orionis.
-
orionis.mcp.config
orionis.mcp.config.html
Module
Module
PUBLIC
Define config for mcp.
-
orionis.mcp.context
orionis.mcp.context.html
Module
Module
PUBLIC
Hold only explicit input and native context for one independent call.
-
orionis.mcp.contracts
orionis.mcp.contracts.html
Package
Package
PUBLIC
Replaceable MCP runtime services.
-
orionis.mcp.contracts.event_bus
orionis.mcp.contracts.event_bus.html
Module
Module
PUBLIC
Publish server changes without retaining identities or requests.
-
orionis.mcp.contracts.manager
orionis.mcp.contracts.manager.html
Module
Module
PUBLIC
Share compiled servers, native routes, local transports, and change events.
-
orionis.mcp.dispatcher
orionis.mcp.dispatcher.html
Module
Module
PUBLIC
Provide mcp operations through DispatchResult, McpDispatcher.
-
orionis.mcp.exceptions
orionis.mcp.exceptions.html
Module
Module
PUBLIC
Provide mcp operations.
-
orionis.mcp.invoker
orionis.mcp.invoker.html
Module
Module
PUBLIC
A reusable unbound handler plan; payloads never become keyword mappings.
-
orionis.mcp.manager
orionis.mcp.manager.html
Module
Module
PUBLIC
Own one compiled registry shared by native HTTP, STDIO, DI and the facade.
-
orionis.mcp.normalization
orionis.mcp.normalization.html
Module
Module
PUBLIC
Describe MCP response cache lifetime and visibility options.
-
orionis.mcp.protocol
orionis.mcp.protocol.html
Package
Package
PUBLIC
Wire types and codecs for MCP 2026-07-28.
-
orionis.mcp.protocol.codecs
orionis.mcp.protocol.codecs.html
Module
Module
PUBLIC
Provide mcp protocol operations.
-
orionis.mcp.protocol.constants
orionis.mcp.protocol.constants.html
Module
Module
PUBLIC
Version and metadata names from the official MCP schema.
-
orionis.mcp.protocol.content
orionis.mcp.protocol.content.html
Module
Module
PUBLIC
Provide mcp protocol operations.
-
orionis.mcp.protocol.input_shapes
orionis.mcp.protocol.input_shapes.html
Module
Module
PUBLIC
Provide mcp protocol operations.
-
orionis.mcp.protocol.metadata
orionis.mcp.protocol.metadata.html
Module
Module
PUBLIC
Provide mcp protocol operations.
-
orionis.mcp.protocol.metavalidation
orionis.mcp.protocol.metavalidation.html
Module
Module
PUBLIC
Provide mcp protocol operations.
-
orionis.mcp.protocol.mrtr
orionis.mcp.protocol.mrtr.html
Module
Module
PUBLIC
Provide mcp protocol operations.
-
orionis.mcp.protocol.requests
orionis.mcp.protocol.requests.html
Module
Module
PUBLIC
Provide mcp protocol operations.
-
orionis.mcp.protocol.results
orionis.mcp.protocol.results.html
Module
Module
PUBLIC
Provide mcp protocol operations.
-
orionis.mcp.protocol.validation
orionis.mcp.protocol.validation.html
Module
Module
PUBLIC
Provide mcp protocol operations.
-
orionis.mcp.provider
orionis.mcp.provider.html
Module
Module
PUBLIC
Register one manager and load declarations before either runtime starts.
-
orionis.mcp.reporting
orionis.mcp.reporting.html
Module
Module
PUBLIC
Adapt MCP failure observation without invoking protocol presentation.
-
orionis.mcp.responses
orionis.mcp.responses.html
Module
Module
PUBLIC
Provide mcp operations through mime_format, Progress, McpResponse.
-
orionis.mcp.routing
orionis.mcp.routing.html
Module
Module
PUBLIC
An importable native HTTP handler, including after route-cache restore.
-
orionis.mcp.server
orionis.mcp.server.package.html
Package
Package
PUBLIC
Declarative MCP servers and their immutable compiled definitions.
-
orionis.mcp.server.catalog
orionis.mcp.server.catalog.html
Module
Module
PUBLIC
Hide catalog tools behind bounded search_tools and execute_tools tools.
-
orionis.mcp.server.compiler
orionis.mcp.server.compiler.html
Module
Module
PUBLIC
Provide mcp server operations.
-
orionis.mcp.server.extension
orionis.mcp.server.extension.html
Module
Module
PUBLIC
Declare negotiated capabilities and extension-owned method/schema hooks.
-
orionis.mcp.server.primitives
orionis.mcp.server.primitives.html
Module
Module
PUBLIC
Provide mcp server operations.
-
orionis.mcp.server.schemas
orionis.mcp.server.schemas.html
Module
Module
PUBLIC
Provide mcp server operations through compile_schema, convert_payload.
-
orionis.mcp.server.templates
orionis.mcp.server.templates.html
Module
Module
PUBLIC
Compile expansion once and verify every inverse result by expansion.
-
orionis.mcp.state
orionis.mcp.state.html
Module
Module
PUBLIC
Seal state across workers sharing an application key and GCM cipher.
-
orionis.mcp.streams
orionis.mcp.streams.html
Module
Module
PUBLIC
Provide mcp operations through AsyncClosable, OwnedStream.
-
orionis.mcp.subscriptions
orionis.mcp.subscriptions.html
Package
Package
PUBLIC
Bounded request-scoped notification delivery.
-
orionis.mcp.subscriptions.event_bus
orionis.mcp.subscriptions.event_bus.html
Module
Module
PUBLIC
Coalesce duplicate changes and close overloaded listeners gracefully.
-
orionis.mcp.transport
orionis.mcp.transport.html
Package
Package
PUBLIC
Native transport bindings for the MCP dispatcher.
-
orionis.mcp.transport.http
orionis.mcp.transport.http.html
Module
Module
PUBLIC
Serve a registered endpoint without owning routes, sessions or identities.
-
orionis.mcp.transport.policy
orionis.mcp.transport.policy.html
Module
Module
PUBLIC
Provide mcp transport operations.
-
orionis.mcp.transport.standard_io
orionis.mcp.transport.standard_io.html
Module
Module
PUBLIC
Provide mcp transport operations through StandardReader, StandardWriter.
-
orionis.mcp.transport.stdio
orionis.mcp.transport.stdio.html
Module
Module
PUBLIC
Provide mcp transport operations.
-
orionis.metadata
orionis.metadata.html
Package
Package
PUBLIC
Group the metadata components and public imports.
-
orionis.metadata.framework
orionis.metadata.framework.html
Module
Module
PUBLIC
Expose runtime identity and release metadata without importing services.
-
orionis.orm
orionis.orm.html
Package
Package
PUBLIC
Group the orm components and public imports.
-
orionis.orm.attributes
orionis.orm.attributes.html
Module
Module
PUBLIC
Attribute handling behavior shared by every model.
-
orionis.orm.collections
orionis.orm.collections.html
Package
Package
PUBLIC
Group the orm collections components and public imports.
-
orionis.orm.collections.collection
orionis.orm.collections.collection.html
Module
Module
PUBLIC
Define collection for orm collections.
-
orionis.orm.collections.paginator
orionis.orm.collections.paginator.module.html
Module
Module
PUBLIC
Length-aware page of query results.
-
orionis.orm.contracts
orionis.orm.contracts.html
Package
Package
PUBLIC
Group the orm contracts components and public imports.
-
orionis.orm.contracts.base_builder
orionis.orm.contracts.base_builder.html
Module
Module
PUBLIC
Contract of the query language shared by every Orionis builder.
-
orionis.orm.contracts.belongs_to_many_relation
orionis.orm.contracts.belongs_to_many_relation.html
Module
Module
PUBLIC
Contract for a many-to-many relationship backed by a pivot table.
-
orionis.orm.contracts.builder
orionis.orm.contracts.builder.html
Module
Module
PUBLIC
Contract for the query builder bound to a model class.
-
orionis.orm.contracts.query_builder
orionis.orm.contracts.query_builder.html
Module
Module
PUBLIC
Contract of the entry point backing the DB facade.
-
orionis.orm.contracts.raw_builder
orionis.orm.contracts.raw_builder.html
Module
Module
PUBLIC
Contract for the model-less query builder over a plain table name.
-
orionis.orm.contracts.relation
orionis.orm.contracts.relation.html
Module
Module
PUBLIC
Contract for a query builder bound to a parent model instance.
-
orionis.orm.events
orionis.orm.events.html
Module
Module
PUBLIC
Lifecycle event behavior shared by every model.
-
orionis.orm.exceptions
orionis.orm.exceptions.html
Package
Package
PUBLIC
Group the orm exceptions components and public imports.
-
orionis.orm.factories
orionis.orm.factories.html
Package
Package
PUBLIC
Group the orm factories components and public imports.
-
orionis.orm.factories._attributes
orionis.orm.factories._attributes.html
Module
Module
PUBLIC
Provide orm factories operations through copy_attributes.
-
orionis.orm.factories._faker
orionis.orm.factories._faker.html
Module
Module
PUBLIC
Provide orm factories operations through create_faker.
-
orionis.orm.factories.exceptions
orionis.orm.factories.exceptions.html
Module
Module
PUBLIC
Provide orm factories operations.
-
orionis.orm.factories.factory
orionis.orm.factories.factory.module.html
Module
Module
PUBLIC
Build and persist model instances from reusable attribute definitions.
-
orionis.orm.factories.fake
orionis.orm.factories.fake.module.html
Module
Module
PUBLIC
Generate fake data with optional and unique value constraints.
-
orionis.orm.factories.sequence
orionis.orm.factories.sequence.module.html
Module
Module
PUBLIC
Describe cycling attributes without owning a shared counter.
-
orionis.orm.metaclass
orionis.orm.metaclass.html
Module
Module
PUBLIC
Provide orm operations.
-
orionis.orm.model
orionis.orm.model.module.html
Module
Module
PUBLIC
Base class of the Orionis active-record models.
-
orionis.orm.provider
orionis.orm.provider.html
Module
Module
PUBLIC
Register query builder services in the application container.
-
orionis.orm.query
orionis.orm.query.html
Package
Package
PUBLIC
Group the orm query components and public imports.
-
orionis.orm.query.base_builder
orionis.orm.query.base_builder.html
Module
Module
PUBLIC
Engine shared by every Orionis query builder.
-
orionis.orm.query.builder
orionis.orm.query.builder.html
Module
Module
PUBLIC
Fluent query builder bound to a model class.
-
orionis.orm.query.expressions
orionis.orm.query.expressions.html
Module
Module
PUBLIC
Provide orm query operations.
-
orionis.orm.query.join_clause
orionis.orm.query.join_clause.html
Module
Module
PUBLIC
Accumulator of ON conditions for a join declared with a callback.
-
orionis.orm.query.raw_builder
orionis.orm.query.raw_builder.html
Module
Module
PUBLIC
Fluent query builder over a plain table name.
-
orionis.orm.query_builder
orionis.orm.query_builder.html
Module
Module
PUBLIC
Entry point of the model-less query API, backing the DB facade.
-
orionis.orm.relations
orionis.orm.relations.html
Package
Package
PUBLIC
Group the orm relations components and public imports.
-
orionis.orm.relations.belongs_to
orionis.orm.relations.belongs_to.html
Module
Module
PUBLIC
Inverse relationship: the foreign key lives on the parent row.
-
orionis.orm.relations.belongs_to_many
orionis.orm.relations.belongs_to_many.html
Module
Module
PUBLIC
Many-to-many relationship backed by an intermediate pivot table.
-
orionis.orm.relations.has_many
orionis.orm.relations.has_many.html
Module
Module
PUBLIC
One-to-many relationship: the related table owns the foreign key.
-
orionis.orm.relations.has_one
orionis.orm.relations.has_one.html
Module
Module
PUBLIC
One-to-one relationship: the related table owns the foreign key.
-
orionis.orm.relations.has_one_or_many
orionis.orm.relations.has_one_or_many.html
Module
Module
PUBLIC
Shared machinery for the hasOne/hasMany relationship kinds.
-
orionis.orm.relations.mixin
orionis.orm.relations.mixin.html
Module
Module
PUBLIC
Relationship factories and loaded-relation storage for every model.
-
orionis.orm.relations.relation
orionis.orm.relations.relation.module.html
Module
Module
PUBLIC
Base class for every query builder bound to a parent model instance.
-
orionis.orm.resolver
orionis.orm.resolver.html
Module
Module
PUBLIC
Static bridge between the ORM and the database connection manager.
-
orionis.orm.schema
orionis.orm.schema.html
Package
Package
PUBLIC
Group the orm schema components and public imports.
-
orionis.orm.schema.column
orionis.orm.schema.column.html
Package
Package
PUBLIC
Group the orm schema column components and public imports.
-
orionis.orm.schema.column.definition
orionis.orm.schema.column.definition.html
Module
Module
PUBLIC
Framework-agnostic description of a database column.
-
orionis.orm.schema.column.options
orionis.orm.schema.column.options.html
Module
Module
PUBLIC
Secondary, type-specific knobs mirroring SQLAlchemy constructor args.
-
orionis.orm.schema.constraints
orionis.orm.schema.constraints.html
Package
Package
PUBLIC
Group the orm schema constraints components and public imports.
-
orionis.orm.schema.constraints.composite_foreign_key
orionis.orm.schema.constraints.composite_foreign_key.html
Module
Module
PUBLIC
Multi-column foreign key constraint.
-
orionis.orm.schema.constraints.foreign_reference
orionis.orm.schema.constraints.foreign_reference.html
Module
Module
PUBLIC
Immutable value object describing a foreign key reference.
-
orionis.orm.schema.constraints.table_index
orionis.orm.schema.constraints.table_index.html
Module
Module
PUBLIC
Composite index spanning one or more columns.
-
orionis.orm.schema.constraints.unique_constraint
orionis.orm.schema.constraints.unique_constraint.html
Module
Module
PUBLIC
Composite UNIQUE constraint spanning one or more columns.
-
orionis.orm.schema.table
orionis.orm.schema.table.html
Module
Module
PUBLIC
Framework-agnostic description of a database table.
-
orionis.orm.schema.types
orionis.orm.schema.types.html
Package
Package
PUBLIC
Group the orm schema types components and public imports.
-
orionis.orm.schema.types._constants
orionis.orm.schema.types._constants.html
Module
Module
PUBLIC
Define constants for orm schema types.
-
orionis.orm.schema.types.big_integer
orionis.orm.schema.types.big_integer.html
Module
Module
PUBLIC
A type for bigger int integers. Typically generates BIGINT.
-
orionis.orm.schema.types.boolean
orionis.orm.schema.types.boolean.module.html
Module
Module
PUBLIC
A bool datatype, typically BOOLEAN or SMALLINT in DDL.
-
orionis.orm.schema.types.column_type
orionis.orm.schema.types.column_type.html
Module
Module
PUBLIC
Logical column types understood by the Orionis SQL compiler.
-
orionis.orm.schema.types.date
orionis.orm.schema.types.date.module.html
Module
Module
PUBLIC
A type for datetime.date() objects.
-
orionis.orm.schema.types.date_time
orionis.orm.schema.types.date_time.html
Module
Module
PUBLIC
A type for datetime.datetime() objects.
-
orionis.orm.schema.types.double
orionis.orm.schema.types.double.module.html
Module
Module
PUBLIC
A type for double FLOAT. Typically generates DOUBLE.
-
orionis.orm.schema.types.enum_type
orionis.orm.schema.types.enum_type.html
Module
Module
PUBLIC
String-backed enumeration column.
-
orionis.orm.schema.types.float_type
orionis.orm.schema.types.float_type.html
Module
Module
PUBLIC
Type representing floating point types, such as FLOAT or REAL.
-
orionis.orm.schema.types.integer
orionis.orm.schema.types.integer.module.html
Module
Module
PUBLIC
A type for int integers.
-
orionis.orm.schema.types.interval
orionis.orm.schema.types.interval.module.html
Module
Module
PUBLIC
A type for datetime.timedelta() objects.
-
orionis.orm.schema.types.large_binary
orionis.orm.schema.types.large_binary.html
Module
Module
PUBLIC
A type for large binary byte data, such as BLOB/BYTEA.
-
orionis.orm.schema.types.match_type
orionis.orm.schema.types.match_type.html
Module
Module
PUBLIC
Refers to the return type of the MATCH operator.
-
orionis.orm.schema.types.numeric
orionis.orm.schema.types.numeric.module.html
Module
Module
PUBLIC
Declare a non-integer numeric column using the logical NUMERIC kind.
-
orionis.orm.schema.types.numeric_common
orionis.orm.schema.types.numeric_common.html
Module
Module
PUBLIC
Describe the numeric-common placeholder kind.
-
orionis.orm.schema.types.pickle_type
orionis.orm.schema.types.pickle_type.html
Module
Module
PUBLIC
Holds Python objects, serialized using pickle.
-
orionis.orm.schema.types.schema_type
orionis.orm.schema.types.schema_type.html
Module
Module
PUBLIC
Describe the schema-level placeholder kind.
-
orionis.orm.schema.types.small_integer
orionis.orm.schema.types.small_integer.html
Module
Module
PUBLIC
A type for smaller int integers. Typically generates SMALLINT.
-
orionis.orm.schema.types.strict_array
orionis.orm.schema.types.strict_array.html
Module
Module
PUBLIC
Represent a SQL ARRAY type.
-
orionis.orm.schema.types.strict_big_int
orionis.orm.schema.types.strict_big_int.html
Module
Module
PUBLIC
The SQL BIGINT type.
-
orionis.orm.schema.types.strict_binary
orionis.orm.schema.types.strict_binary.html
Module
Module
PUBLIC
The SQL BINARY type.
-
orionis.orm.schema.types.strict_blob
orionis.orm.schema.types.strict_blob.html
Module
Module
PUBLIC
The SQL BLOB type.
-
orionis.orm.schema.types.strict_char
orionis.orm.schema.types.strict_char.html
Module
Module
PUBLIC
The SQL CHAR type.
-
orionis.orm.schema.types.strict_clob
orionis.orm.schema.types.strict_clob.html
Module
Module
PUBLIC
The CLOB type, found in Oracle Database and Informix.
-
orionis.orm.schema.types.strict_decimal
orionis.orm.schema.types.strict_decimal.html
Module
Module
PUBLIC
The SQL DECIMAL type.
-
orionis.orm.schema.types.strict_double_precision
orionis.orm.schema.types.strict_double_precision.html
Module
Module
PUBLIC
The SQL DOUBLE PRECISION type.
-
orionis.orm.schema.types.strict_int
orionis.orm.schema.types.strict_int.html
Module
Module
PUBLIC
Alias of INTEGER.
-
orionis.orm.schema.types.strict_json
orionis.orm.schema.types.strict_json.html
Module
Module
PUBLIC
Represent a SQL JSON type.
-
orionis.orm.schema.types.strict_nchar
orionis.orm.schema.types.strict_nchar.html
Module
Module
PUBLIC
The SQL NCHAR type.
-
orionis.orm.schema.types.strict_nvarchar
orionis.orm.schema.types.strict_nvarchar.html
Module
Module
PUBLIC
The SQL NVARCHAR type.
-
orionis.orm.schema.types.strict_real
orionis.orm.schema.types.strict_real.html
Module
Module
PUBLIC
The SQL REAL type.
-
orionis.orm.schema.types.strict_small_int
orionis.orm.schema.types.strict_small_int.html
Module
Module
PUBLIC
The SQL SMALLINT type.
-
orionis.orm.schema.types.strict_timestamp
orionis.orm.schema.types.strict_timestamp.html
Module
Module
PUBLIC
The SQL TIMESTAMP type.
-
orionis.orm.schema.types.strict_var_binary
orionis.orm.schema.types.strict_var_binary.html
Module
Module
PUBLIC
The SQL VARBINARY type.
-
orionis.orm.schema.types.strict_varchar
orionis.orm.schema.types.strict_varchar.html
Module
Module
PUBLIC
The SQL VARCHAR type.
-
orionis.orm.schema.types.string_type
orionis.orm.schema.types.string_type.html
Module
Module
PUBLIC
Declare a variable-length SQL string using the logical VARCHAR kind.
-
orionis.orm.schema.types.text
orionis.orm.schema.types.text.module.html
Module
Module
PUBLIC
A variably sized string type. In SQL, usually CLOB/TEXT.
-
orionis.orm.schema.types.time_type
orionis.orm.schema.types.time_type.html
Module
Module
PUBLIC
A type for datetime.time() objects.
-
orionis.orm.schema.types.unicode
orionis.orm.schema.types.unicode.module.html
Module
Module
PUBLIC
A variable length Unicode string type, e.g. NVARCHAR.
-
orionis.orm.schema.types.unicode_text
orionis.orm.schema.types.unicode_text.html
Module
Module
PUBLIC
An unbounded-length Unicode string type, e.g. NCLOB/NTEXT.
-
orionis.orm.schema.types.uuid_type
orionis.orm.schema.types.uuid_type.html
Module
Module
PUBLIC
Represent a database agnostic UUID datatype.
-
orionis.orm.soft_deletes
orionis.orm.soft_deletes.html
Module
Module
PUBLIC
Soft delete behavior shared by every model.
-
orionis.orm.state
orionis.orm.state.html
Module
Module
PUBLIC
Attribute state tracking behavior shared by every model.
-
orionis.queues
orionis.queues.html
Package
Package
PUBLIC
Group the queues components and public imports.
-
orionis.queues._database
orionis.queues._database.html
Module
Module
PUBLIC
Share concurrent schema bootstrap for queue and failed-job storage.
-
orionis.queues.context
orionis.queues.context.html
Module
Module
PUBLIC
Expose the current reservation and explicit lifecycle operations.
-
orionis.queues.contracts
orionis.queues.contracts.html
Package
Package
PUBLIC
Group the queues contracts components and public imports.
-
orionis.queues.contracts.driver
orionis.queues.contracts.driver.html
Module
Module
PUBLIC
Declare persistence and fenced transitions for a queue connection.
-
orionis.queues.contracts.failed_repository
orionis.queues.contracts.failed_repository.html
Module
Module
PUBLIC
Declare durable terminal failure inspection and removal.
-
orionis.queues.contracts.job
orionis.queues.contracts.job.html
Module
Module
PUBLIC
Declare the asynchronous entry point of a persistent job.
-
orionis.queues.contracts.manager
orionis.queues.contracts.manager.html
Module
Module
PUBLIC
Declare the canonical dispatch and queue administration API.
-
orionis.queues.contracts.serializer
orionis.queues.contracts.serializer.html
Module
Module
PUBLIC
Declare explicit state serialization and trusted job registration.
-
orionis.queues.contracts.worker
orionis.queues.contracts.worker.html
Module
Module
PUBLIC
Declare asynchronous consumption and graceful stopping.
-
orionis.queues.drivers
orionis.queues.drivers.html
Package
Package
PUBLIC
Group the queues drivers components and public imports.
-
orionis.queues.drivers.database
orionis.queues.drivers.database.html
Module
Module
PUBLIC
Persist queued jobs using atomic conditional updates and expiring leases.
-
orionis.queues.drivers.redis
orionis.queues.drivers.redis.html
Module
Module
PUBLIC
Persist delayed jobs and fenced reservations through atomic Lua scripts.
-
orionis.queues.drivers.sync
orionis.queues.drivers.sync.html
Module
Module
PUBLIC
Execute one immediate attempt through the shared worker pipeline.
-
orionis.queues.entities
orionis.queues.entities.html
Package
Package
PUBLIC
Group the queues entities components and public imports.
-
orionis.queues.entities.envelope
orionis.queues.entities.envelope.html
Module
Module
PUBLIC
Carry immutable, versioned job data independently of backend state.
-
orionis.queues.entities.failed_job
orionis.queues.entities.failed_job.html
Module
Module
PUBLIC
Preserve the payload and exception associated with terminal failure.
-
orionis.queues.entities.reserved_job
orionis.queues.entities.reserved_job.html
Module
Module
PUBLIC
Describe a backend claim and its opaque fencing token.
-
orionis.queues.exceptions
orionis.queues.exceptions.html
Module
Module
PUBLIC
Provide queues operations.
-
orionis.queues.failed
orionis.queues.failed.html
Package
Package
PUBLIC
Group the queues failed components and public imports.
-
orionis.queues.failed.repository
orionis.queues.failed.repository.html
Module
Module
PUBLIC
Retain failed envelopes and diagnostics in framework-owned DB storage.
-
orionis.queues.functions
orionis.queues.functions.html
Module
Module
PUBLIC
Provide queues operations.
-
orionis.queues.job
orionis.queues.job.html
Module
Module
PUBLIC
Declare serializable job fields and asynchronous service dependencies.
-
orionis.queues.manager
orionis.queues.manager.html
Module
Module
PUBLIC
Resolve lazy connections and expose the canonical deferred dispatch API.
-
orionis.queues.pending
orionis.queues.pending.html
Module
Module
PUBLIC
Defer a single dispatch until awaited and allow options before submission.
-
orionis.queues.provider
orionis.queues.provider.html
Module
Module
PUBLIC
Register queue services eagerly while keeping backend I/O lazy.
-
orionis.queues.schema
orionis.queues.schema.html
Module
Module
PUBLIC
Provide queues operations.
-
orionis.queues.serializer
orionis.queues.serializer.html
Module
Module
PUBLIC
Serialize explicit job state through a registry of application-trusted types.
-
orionis.queues.types
orionis.queues.types.html
Module
Module
PUBLIC
Define types for queues.
-
orionis.queues.worker
orionis.queues.worker.html
Module
Module
PUBLIC
Provide queues operations through WorkerOptions, Worker.
-
orionis.realtime
orionis.realtime.html
Package
Package
PUBLIC
Group the realtime components and public imports.
-
orionis.realtime.clients
orionis.realtime.clients.html
Module
Module
PUBLIC
Provide realtime operations.
-
orionis.realtime.config
orionis.realtime.config.html
Module
Module
PUBLIC
Define config for realtime.
-
orionis.realtime.connection
orionis.realtime.connection.html
Module
Module
PUBLIC
Own tasks and pending client results for exactly one connection.
-
orionis.realtime.contracts
orionis.realtime.contracts.html
Package
Package
PUBLIC
Group the realtime contracts components and public imports.
-
orionis.realtime.contracts.connection
orionis.realtime.contracts.connection.html
Module
Module
PUBLIC
Describe the connection surface required by the worker-local registry.
-
orionis.realtime.contracts.manager
orionis.realtime.contracts.manager.html
Module
Module
PUBLIC
Define connection ownership and Hub delivery for registry providers.
-
orionis.realtime.decorators
orionis.realtime.decorators.html
Module
Module
PUBLIC
Provide realtime operations.
-
orionis.realtime.entities
orionis.realtime.entities.html
Module
Module
PUBLIC
Count delivered and failed recipients without retaining connections.
-
orionis.realtime.errors
orionis.realtime.errors.html
Module
Module
PUBLIC
Provide realtime operations.
-
orionis.realtime.groups
orionis.realtime.groups.html
Module
Module
PUBLIC
Manage group membership owned by the current Hub connection.
-
orionis.realtime.hub
orionis.realtime.hub.module.html
Module
Module
PUBLIC
Provide realtime operations through HubContext, Hub.
-
orionis.realtime.manager
orionis.realtime.manager.html
Module
Module
PUBLIC
Own worker-local connections and isolate every group by Hub class.
-
orionis.realtime.metadata
orionis.realtime.metadata.html
Module
Module
PUBLIC
Describe one pre-authorized method without retaining a Hub instance.
-
orionis.realtime.protocol
orionis.realtime.protocol.html
Module
Module
PUBLIC
Provide realtime operations.
-
orionis.realtime.provider
orionis.realtime.provider.html
Module
Module
PUBLIC
Register one worker-local registry and pin the synchronous target facade.
-
orionis.realtime.runtime
orionis.realtime.runtime.html
Module
Module
PUBLIC
Execute a precompiled Hub using the existing application and scopes.
-
orionis.schemas
orionis.schemas.html
Package
Package
PUBLIC
Group the schemas components and public imports.
-
orionis.schemas.coercion
orionis.schemas.coercion.html
Module
Module
PUBLIC
Prepare explicitly coercible values without changing the source payload.
-
orionis.schemas.compiler
orionis.schemas.compiler.html
Module
Module
PUBLIC
Compile metadata into native constraints and reject incompatible declarations.
-
orionis.schemas.constraint_plan
orionis.schemas.constraint_plan.html
Module
Module
PUBLIC
Provide schemas operations.
-
orionis.schemas.constraints
orionis.schemas.constraints.html
Module
Module
PUBLIC
Provide schemas operations.
-
orionis.schemas.contracts
orionis.schemas.contracts.html
Package
Package
PUBLIC
Group the schemas contracts components and public imports.
-
orionis.schemas.contracts.constraint
orionis.schemas.contracts.constraint.html
Module
Module
PUBLIC
Define the contract for rule implementations.
-
orionis.schemas.entities
orionis.schemas.entities.html
Package
Package
PUBLIC
Group the schemas entities components and public imports.
-
orionis.schemas.entities.failure
orionis.schemas.entities.failure.html
Module
Module
PUBLIC
Represent a validation failure.
-
orionis.schemas.exception_parser
orionis.schemas.exception_parser.html
Module
Module
PUBLIC
Translate validation exceptions into structured field errors.
-
orionis.schemas.exceptions
orionis.schemas.exceptions.html
Package
Package
PUBLIC
Group the schemas exceptions components and public imports.
-
orionis.schemas.exceptions.validation
orionis.schemas.exceptions.validation.html
Module
Module
PUBLIC
Carry structured schema-validation failures.
-
orionis.schemas.failure_collector
orionis.schemas.failure_collector.html
Module
Module
PUBLIC
Collect and organize validation failures by field path.
-
orionis.schemas.fields
orionis.schemas.fields.html
Module
Module
PUBLIC
Define fields for schemas.
-
orionis.schemas.instance_payload
orionis.schemas.instance_payload.html
Module
Module
PUBLIC
Provide schemas operations through instance_payload.
-
orionis.schemas.meta
orionis.schemas.meta.html
Package
Package
PUBLIC
Group the schemas meta components and public imports.
-
orionis.schemas.meta.constraint
orionis.schemas.meta.constraint.html
Module
Module
PUBLIC
Intermediate marker for validation constraints.
-
orionis.schemas.meta.document
orionis.schemas.meta.document.html
Module
Module
PUBLIC
Intermediate marker for documentation / JSON Schema metadata.
-
orionis.schemas.meta.validation
orionis.schemas.meta.validation.html
Module
Module
PUBLIC
Root marker for all Orionis field-level annotations.
-
orionis.schemas.metadata
orionis.schemas.metadata.html
Module
Module
PUBLIC
Declare field conversion markers and documentation metadata.
-
orionis.schemas.rule
orionis.schemas.rule.html
Module
Module
PUBLIC
Define a reusable validation rule and its failure message.
-
orionis.schemas.rules
orionis.schemas.rules.html
Package
Package
PUBLIC
Group the schemas rules components and public imports.
-
orionis.schemas.rules.accepted
orionis.schemas.rules.accepted.module.html
Module
Module
PUBLIC
Ensure a value expresses an explicit acceptance.
-
orionis.schemas.rules.active_url
orionis.schemas.rules.active_url.html
Module
Module
PUBLIC
Ensure a URL points at a hostname that currently resolves.
-
orionis.schemas.rules.after
orionis.schemas.rules.after.module.html
Module
Module
PUBLIC
Ensure a date comes strictly after a reference moment.
-
orionis.schemas.rules.after_or_equal
orionis.schemas.rules.after_or_equal.html
Module
Module
PUBLIC
Ensure a date is equal to or comes after a reference moment.
-
orionis.schemas.rules.alpha
orionis.schemas.rules.alpha.module.html
Module
Module
PUBLIC
Ensure a string contains only alphabetic characters.
-
orionis.schemas.rules.ascii
orionis.schemas.rules.ascii.module.html
Module
Module
PUBLIC
Ensure a string contains only 7-bit ASCII characters.
-
orionis.schemas.rules.before
orionis.schemas.rules.before.module.html
Module
Module
PUBLIC
Ensure a date comes strictly before a reference moment.
-
orionis.schemas.rules.before_or_equal
orionis.schemas.rules.before_or_equal.html
Module
Module
PUBLIC
Ensure a date is equal to or comes before a reference moment.
-
orionis.schemas.rules.between
orionis.schemas.rules.between.module.html
Module
Module
PUBLIC
Ensure a value's size falls within an inclusive range.
-
orionis.schemas.rules.confirm_password
orionis.schemas.rules.confirm_password.html
Module
Module
PUBLIC
Ensure a value matches the password supplied in a sibling field.
-
orionis.schemas.rules.date_format
orionis.schemas.rules.date_format.html
Module
Module
PUBLIC
Ensure a date string matches one of the accepted formats.
-
orionis.schemas.rules.decimal_places
orionis.schemas.rules.decimal_places.html
Module
Module
PUBLIC
Ensure a numeric value carries a given number of decimal places.
-
orionis.schemas.rules.different
orionis.schemas.rules.different.module.html
Module
Module
PUBLIC
Ensure a value differs from every value supplied to the rule.
-
orionis.schemas.rules.dimensions
orionis.schemas.rules.dimensions.module.html
Module
Module
PUBLIC
Ensure an uploaded image satisfies the given dimension constraints.
-
orionis.schemas.rules.doesnt_end_with
orionis.schemas.rules.doesnt_end_with.html
Module
Module
PUBLIC
Ensure a string does not end with any of the given suffixes.
-
orionis.schemas.rules.doesnt_start_with
orionis.schemas.rules.doesnt_start_with.html
Module
Module
PUBLIC
Ensure a string does not start with any of the given prefixes.
-
orionis.schemas.rules.email
orionis.schemas.rules.email.module.html
Module
Module
PUBLIC
Ensure a string is a valid email address.
-
orionis.schemas.rules.empty
orionis.schemas.rules.empty.module.html
Module
Module
PUBLIC
Ensure a field contains an empty value.
-
orionis.schemas.rules.encoding
orionis.schemas.rules.encoding.module.html
Module
Module
PUBLIC
Ensure a value can be represented in a given character encoding.
-
orionis.schemas.rules.ends_with
orionis.schemas.rules.ends_with.html
Module
Module
PUBLIC
Ensure a string ends with one of the given suffixes.
-
orionis.schemas.rules.file
orionis.schemas.rules.file.module.html
Module
Module
PUBLIC
Ensure a value is a successfully uploaded file.
-
orionis.schemas.rules.greater_than_or_equal_field
orionis.schemas.rules.greater_than_or_equal_field.html
Module
Module
PUBLIC
Ensure a value is greater than or equal to a sibling field.
-
orionis.schemas.rules.image
orionis.schemas.rules.image.module.html
Module
Module
PUBLIC
Ensure an uploaded file has a supported raster image header.
-
orionis.schemas.rules.image_probe
orionis.schemas.rules.image_probe.html
Module
Module
PUBLIC
Read supported raster headers without decoding image pixels.
-
orionis.schemas.rules.integer
orionis.schemas.rules.integer.module.html
Module
Module
PUBLIC
Ensure a value represents a whole number.
-
orionis.schemas.rules.ip_address
orionis.schemas.rules.ip_address.html
Module
Module
PUBLIC
Ensure a string is a valid IP address.
-
orionis.schemas.rules.json_string
orionis.schemas.rules.json_string.html
Module
Module
PUBLIC
Ensure a string holds a syntactically valid JSON document.
-
orionis.schemas.rules.less_than_or_equal_field
orionis.schemas.rules.less_than_or_equal_field.html
Module
Module
PUBLIC
Ensure a value is less than or equal to a sibling field.
-
orionis.schemas.rules.lowercase
orionis.schemas.rules.lowercase.module.html
Module
Module
PUBLIC
Ensure a string contains no uppercase characters.
-
orionis.schemas.rules.mac_address
orionis.schemas.rules.mac_address.html
Module
Module
PUBLIC
Ensure a string is a valid MAC address.
-
orionis.schemas.rules.max_digits
orionis.schemas.rules.max_digits.html
Module
Module
PUBLIC
Ensure an integer is written with at most a given number of digits.
-
orionis.schemas.rules.measure
orionis.schemas.rules.measure.html
Module
Module
PUBLIC
Measure field values, inspect emptiness and read uploaded file content.
-
orionis.schemas.rules.mime_types
orionis.schemas.rules.mime_types.html
Module
Module
PUBLIC
Ensure an uploaded file declares one of the accepted MIME types.
-
orionis.schemas.rules.no_empty
orionis.schemas.rules.no_empty.html
Module
Module
PUBLIC
Ensure a field contains a non-empty value.
-
orionis.schemas.rules.size
orionis.schemas.rules.size.module.html
Module
Module
PUBLIC
Ensure a value has an exact size.
-
orionis.schemas.rules.starts_with
orionis.schemas.rules.starts_with.html
Module
Module
PUBLIC
Ensure a string starts with one of the given prefixes.
-
orionis.schemas.rules.strong_password
orionis.schemas.rules.strong_password.html
Module
Module
PUBLIC
Ensure a string is strong enough to be used as a password.
-
orionis.schemas.rules.temporal
orionis.schemas.rules.temporal.html
Module
Module
PUBLIC
Provide schemas rules operations.
-
orionis.schemas.rules.ulid
orionis.schemas.rules.ulid.module.html
Module
Module
PUBLIC
Ensure a string is a valid lexicographically sortable identifier.
-
orionis.schemas.rules.unique
orionis.schemas.rules.unique.module.html
Module
Module
PUBLIC
Ensure a value is not already stored in a database column.
-
orionis.schemas.rules.uppercase
orionis.schemas.rules.uppercase.module.html
Module
Module
PUBLIC
Ensure a string contains no lowercase characters.
-
orionis.schemas.rules.uuid_string
orionis.schemas.rules.uuid_string.html
Module
Module
PUBLIC
Ensure a string is a valid RFC 9562 universally unique identifier.
-
orionis.schemas.rules_executor
orionis.schemas.rules_executor.html
Module
Module
PUBLIC
Compile bounded rule plans and collect nested validation failures.
-
orionis.schemas.schema
orionis.schemas.schema.module.html
Module
Module
PUBLIC
Compile schema declarations and provide their structured representation.
-
orionis.schemas.validator
orionis.schemas.validator.html
Module
Module
PUBLIC
Validate structured input against declared fields and validation rules.
-
orionis.session
orionis.session.html
Package
Package
PUBLIC
Group the session components and public imports.
-
orionis.session.contracts
orionis.session.contracts.html
Package
Package
PUBLIC
Group the session contracts components and public imports.
-
orionis.session.contracts.session
orionis.session.contracts.session.html
Module
Module
PUBLIC
Contract for a single HTTP session runtime object.
-
orionis.session.contracts.store
orionis.session.contracts.store.html
Module
Module
PUBLIC
Contract every session backing-store must satisfy.
-
orionis.session.entities
orionis.session.entities.html
Package
Package
PUBLIC
Group the session entities components and public imports.
-
orionis.session.entities.record
orionis.session.entities.record.html
Module
Module
PUBLIC
Persistent representation of a single session.
-
orionis.session.exceptions
orionis.session.exceptions.html
Module
Module
PUBLIC
Provide session operations.
-
orionis.session.flash
orionis.session.flash.html
Module
Module
PUBLIC
Provide session operations.
-
orionis.session.manager
orionis.session.manager.html
Module
Module
PUBLIC
Coordinate the session lifecycle for every HTTP request.
-
orionis.session.session
orionis.session.session.html
Module
Module
PUBLIC
Runtime representation of a single HTTP session.
-
orionis.session.stores
orionis.session.stores.html
Package
Package
PUBLIC
Group the session stores components and public imports.
-
orionis.session.stores.cache
orionis.session.stores.cache.html
Module
Module
PUBLIC
Session store backed by the framework's cache system.
-
orionis.session.stores.database
orionis.session.stores.database.html
Module
Module
PUBLIC
Session store that persists each session as a row in a database table.
-
orionis.session.stores.file
orionis.session.stores.file.html
Module
Module
PUBLIC
Session store that persists each session as a JSON file on disk.
-
orionis.session.stores.memory
orionis.session.stores.memory.html
Module
Module
PUBLIC
In-process session store backed by a plain dictionary.
-
orionis.storage
orionis.storage.html
Package
Package
PUBLIC
Group the storage components and public imports.
-
orionis.storage.buffering
orionis.storage.buffering.html
Module
Module
PUBLIC
Provide storage operations.
-
orionis.storage.contracts
orionis.storage.contracts.html
Package
Package
PUBLIC
Group the storage contracts components and public imports.
-
orionis.storage.contracts.directory
orionis.storage.contracts.directory.html
Module
Module
PUBLIC
Define the contract for a directory on a storage disk.
-
orionis.storage.contracts.disk
orionis.storage.contracts.disk.html
Module
Module
PUBLIC
Define the contract for a configured storage disk.
-
orionis.storage.contracts.driver
orionis.storage.contracts.driver.html
Module
Module
PUBLIC
Define the low-level contract every storage backend must implement.
-
orionis.storage.contracts.file
orionis.storage.contracts.file.html
Module
Module
PUBLIC
Define the contract for a single file on a storage disk.
-
orionis.storage.contracts.manager
orionis.storage.contracts.manager.html
Module
Module
PUBLIC
Define the contract for the storage manager.
-
orionis.storage.contracts.stream
orionis.storage.contracts.stream.html
Module
Module
PUBLIC
Define the contract for an asynchronous binary stream handle.
-
orionis.storage.contracts.uploaded_file
orionis.storage.contracts.uploaded_file.html
Module
Module
PUBLIC
Define the contract for a file received through HTTP.
-
orionis.storage.directory
orionis.storage.directory.module.html
Module
Module
PUBLIC
Represent a directory on a storage disk.
-
orionis.storage.disk
orionis.storage.disk.module.html
Module
Module
PUBLIC
Represent a configured storage disk.
-
orionis.storage.drivers
orionis.storage.drivers.html
Package
Package
PUBLIC
Expose storage drivers on first access.
-
orionis.storage.drivers.azure
orionis.storage.drivers.azure.html
Module
Module
PUBLIC
Storage driver backed by Azure Blob Storage.
-
orionis.storage.drivers.functions
orionis.storage.drivers.functions.html
Module
Module
PUBLIC
Provide shared binary buffers, dependency loading and object-key helpers.
-
orionis.storage.drivers.gcs
orionis.storage.drivers.gcs.html
Module
Module
PUBLIC
Storage driver backed by Google Cloud Storage.
-
orionis.storage.drivers.local
orionis.storage.drivers.local.html
Module
Module
PUBLIC
Storage driver backed by the local filesystem.
-
orionis.storage.drivers.memory
orionis.storage.drivers.memory.html
Module
Module
PUBLIC
Storage driver keeping every object in process memory.
-
orionis.storage.drivers.s3
orionis.storage.drivers.s3.html
Module
Module
PUBLIC
Storage driver backed by Amazon S3 (or S3-compatible services).
-
orionis.storage.entities
orionis.storage.entities.html
Package
Package
PUBLIC
Group the storage entities components and public imports.
-
orionis.storage.entities.file_info
orionis.storage.entities.file_info.html
Module
Module
PUBLIC
Immutable snapshot of a stored file's metadata.
-
orionis.storage.enums
orionis.storage.enums.html
Package
Package
PUBLIC
Group the storage enums components and public imports.
-
orionis.storage.enums.visibility
orionis.storage.enums.visibility.module.html
Module
Module
PUBLIC
Enumerate the visibility levels supported by storage drivers.
-
orionis.storage.exceptions
orionis.storage.exceptions.html
Module
Module
PUBLIC
Provide storage operations.
-
orionis.storage.file
orionis.storage.file.module.html
Module
Module
PUBLIC
Represent a single file on a storage disk.
-
orionis.storage.manager
orionis.storage.manager.html
Module
Module
PUBLIC
Coordinate disk resolution for the storage component.
-
orionis.storage.paths
orionis.storage.paths.html
Module
Module
PUBLIC
Provide storage operations through normalize_path, normalize_file_path.
-
orionis.storage.provider
orionis.storage.provider.html
Module
Module
PUBLIC
Service provider for the Orionis storage system.
-
orionis.storage.stream
orionis.storage.stream.html
Module
Module
PUBLIC
Asynchronous wrapper around a lazily opened binary handle.
-
orionis.storage.uploaded_file
orionis.storage.uploaded_file.html
Module
Module
PUBLIC
Represent a file received through HTTP, ready to be stored.
-
orionis.support
orionis.support.html
Package
Package
PUBLIC
Group the support components and public imports.
-
orionis.support.concurrency
orionis.support.concurrency.html
Module
Module
PUBLIC
Provide support operations.
-
orionis.support.entities
orionis.support.entities.html
Package
Package
PUBLIC
Group the support entities components and public imports.
-
orionis.support.entities.base
orionis.support.entities.base.html
Module
Module
PUBLIC
Initialize, serialize and describe dataclass entities with extra attributes.
-
orionis.support.facades
orionis.support.facades.html
Package
Package
PUBLIC
Group the support facades components and public imports.
-
orionis.support.facades.application
orionis.support.facades.application.module.html
Module
Module
PUBLIC
Resolve the application service through the application facade.
-
orionis.support.facades.auth
orionis.support.facades.auth.module.html
Module
Module
PUBLIC
Resolve the auth service through the application facade.
-
orionis.support.facades.cache
orionis.support.facades.cache.module.html
Module
Module
PUBLIC
Facade for the cache system.
-
orionis.support.facades.catch
orionis.support.facades.catch.module.html
Module
Module
PUBLIC
Resolve the catch service through the application facade.
-
orionis.support.facades.datetime
orionis.support.facades.datetime.module.html
Module
Module
PUBLIC
Provide a high-level interface for date and time operations.
-
orionis.support.facades.db
orionis.support.facades.db.module.html
Module
Module
PUBLIC
Resolve the db service through the application facade.
-
orionis.support.facades.debug
orionis.support.facades.debug.module.html
Module
Module
PUBLIC
Resolve the debug service through the application facade.
-
orionis.support.facades.encrypter
orionis.support.facades.encrypter.html
Module
Module
PUBLIC
Resolve the crypt service through the application facade.
-
orionis.support.facades.hash
orionis.support.facades.hash.module.html
Module
Module
PUBLIC
Resolve the hash service through the application facade.
-
orionis.support.facades.lang
orionis.support.facades.lang.module.html
Module
Module
PUBLIC
Resolve the lang service through the application facade.
-
orionis.support.facades.logger
orionis.support.facades.logger.html
Module
Module
PUBLIC
Resolve the log service through the application facade.
-
orionis.support.facades.mail
orionis.support.facades.mail.module.html
Module
Module
PUBLIC
Resolve the mail service through the application facade.
-
orionis.support.facades.mcp
orionis.support.facades.mcp.module.html
Module
Module
PUBLIC
Expose the same MCP manager that application services receive through DI.
-
orionis.support.facades.queue
orionis.support.facades.queue.module.html
Module
Module
PUBLIC
Resolve the queue service through the application facade.
-
orionis.support.facades.reactor
orionis.support.facades.reactor.module.html
Module
Module
PUBLIC
Resolve the reactor service through the application facade.
-
orionis.support.facades.realtime
orionis.support.facades.realtime.module.html
Module
Module
PUBLIC
Expose worker-local Hub targeting from ordinary application services.
-
orionis.support.facades.router
orionis.support.facades.router.html
Module
Module
PUBLIC
Resolve the route service through the application facade.
-
orionis.support.facades.schedule
orionis.support.facades.schedule.module.html
Module
Module
PUBLIC
Resolve the schedule service through the application facade.
-
orionis.support.facades.schema
orionis.support.facades.schema.module.html
Module
Module
PUBLIC
Resolve the schema service through the application facade.
-
orionis.support.facades.session
orionis.support.facades.session.module.html
Module
Module
PUBLIC
Resolve the session service through the application facade.
-
orionis.support.facades.storage
orionis.support.facades.storage.module.html
Module
Module
PUBLIC
Resolve the storage service through the application facade.
-
orionis.support.facades.testing
orionis.support.facades.testing.html
Module
Module
PUBLIC
Resolve the test service through the application facade.
-
orionis.support.facades.view
orionis.support.facades.view.module.html
Module
Module
PUBLIC
Resolve the view service through the application facade.
-
orionis.support.formatter
orionis.support.formatter.html
Package
Package
PUBLIC
Group the support formatter components and public imports.
-
orionis.support.formatter.exceptions
orionis.support.formatter.exceptions.html
Package
Package
PUBLIC
Group the support formatter exceptions components and public imports.
-
orionis.support.formatter.exceptions.contracts
orionis.support.formatter.exceptions.contracts.html
Package
Package
PUBLIC
Group the support formatter exceptions contracts components and public imports.
-
orionis.support.formatter.exceptions.contracts.parser
orionis.support.formatter.exceptions.contracts.parser.html
Module
Module
PUBLIC
Define the contract for exception parser implementations.
-
orionis.support.formatter.exceptions.parser
orionis.support.formatter.exceptions.parser.html
Module
Module
PUBLIC
Extract structured details from exceptions and tracebacks.
-
orionis.support.formatter.serializer
orionis.support.formatter.serializer.html
Module
Module
PUBLIC
Convert supported Python values into serializable representations.
-
orionis.support.inspirational
orionis.support.inspirational.html
Package
Package
PUBLIC
Group the support inspirational components and public imports.
-
orionis.support.inspirational.contracts
orionis.support.inspirational.contracts.html
Package
Package
PUBLIC
Group the support inspirational contracts components and public imports.
-
orionis.support.inspirational.contracts.inspire
orionis.support.inspirational.contracts.inspire.html
Module
Module
PUBLIC
Define the contract for inspire implementations.
-
orionis.support.inspirational.inspire
orionis.support.inspirational.inspire.module.html
Module
Module
PUBLIC
Select inspirational quotations for console output.
-
orionis.support.inspirational.quotes
orionis.support.inspirational.quotes.html
Module
Module
PUBLIC
Define quotes for support inspirational.
-
orionis.support.patterns
orionis.support.patterns.html
Package
Package
PUBLIC
Group the support patterns components and public imports.
-
orionis.support.patterns.final
orionis.support.patterns.final.html
Package
Package
PUBLIC
Group the support patterns final components and public imports.
-
orionis.support.patterns.final.meta
orionis.support.patterns.final.meta.html
Module
Module
PUBLIC
Prevent subclassing of classes marked final by this metaclass.
-
orionis.support.patterns.singleton
orionis.support.patterns.singleton.html
Package
Package
PUBLIC
Group the support patterns singleton components and public imports.
-
orionis.support.patterns.singleton.meta
orionis.support.patterns.singleton.meta.html
Module
Module
PUBLIC
Create one instance per class with synchronous and asynchronous access.
-
orionis.support.performance
orionis.support.performance.html
Package
Package
PUBLIC
Group the support performance components and public imports.
-
orionis.support.performance.contracts
orionis.support.performance.contracts.html
Package
Package
PUBLIC
Group the support performance contracts components and public imports.
-
orionis.support.performance.contracts.counter
orionis.support.performance.contracts.counter.html
Module
Module
PUBLIC
Define the contract for performance counter implementations.
-
orionis.support.performance.counter
orionis.support.performance.counter.html
Module
Module
PUBLIC
Measure elapsed execution time with a high-resolution counter.
-
orionis.support.structures
orionis.support.structures.html
Package
Package
PUBLIC
Group the support structures components and public imports.
-
orionis.support.structures.freezer
orionis.support.structures.freezer.html
Module
Module
PUBLIC
Convert nested mutable structures to immutable snapshots and back.
-
orionis.support.system
orionis.support.system.html
Package
Package
PUBLIC
Group the support system components and public imports.
-
orionis.support.system.contracts
orionis.support.system.contracts.html
Package
Package
PUBLIC
Group the support system contracts components and public imports.
-
orionis.support.system.contracts.workers
orionis.support.system.contracts.workers.html
Module
Module
PUBLIC
Define the contract for workers implementations.
-
orionis.support.system.workers
orionis.support.system.workers.module.html
Module
Module
PUBLIC
Calculate worker counts from the current process and CPU environment.
-
orionis.support.types
orionis.support.types.html
Package
Package
PUBLIC
Group the support types components and public imports.
-
orionis.support.types._html
orionis.support.types._html.html
Module
Module
PUBLIC
Strip markup using the standard HTML parser while preserving allowed tags.
-
orionis.support.types.collection
orionis.support.types.collection.module.html
Module
Module
PUBLIC
Provide collection operations over an ordered sequence of values.
-
orionis.support.types.contracts
orionis.support.types.contracts.html
Package
Package
PUBLIC
Group the support types contracts components and public imports.
-
orionis.support.types.contracts.collection
orionis.support.types.contracts.collection.html
Module
Module
PUBLIC
Define the contract for collection implementations.
-
orionis.support.types.contracts.std
orionis.support.types.contracts.std.html
Module
Module
PUBLIC
Define the contract for std class implementations.
-
orionis.support.types.dot_dict
orionis.support.types.dot_dict.html
Module
Module
PUBLIC
Expose nested dictionary values through attribute access.
-
orionis.support.types.sentinel
orionis.support.types.sentinel.html
Module
Module
PUBLIC
Represent the absence of a value without conflating it with None.
-
orionis.support.types.std
orionis.support.types.std.html
Module
Module
PUBLIC
Represent dynamically assigned attributes as a simple data object.
-
orionis.support.types.stringable
orionis.support.types.stringable.module.html
Module
Module
PUBLIC
Provide chainable operations over a string value.
-
orionis.support.types.uniqueness
orionis.support.types.uniqueness.html
Module
Module
PUBLIC
Provide support types operations through unique_items.
-
orionis.test
orionis.test.html
Package
Package
PUBLIC
Group the test components and public imports.
-
orionis.test.cases
orionis.test.cases.html
Package
Package
PUBLIC
Group the test cases components and public imports.
-
orionis.test.cases.case
orionis.test.cases.case.html
Module
Module
PUBLIC
Run synchronous and asynchronous tests through the application container.
-
orionis.test.clients
orionis.test.clients.html
Package
Package
PUBLIC
Provide in-process protocol clients for Orionis test cases.
-
orionis.test.clients.mcp
orionis.test.clients.mcp.html
Module
Module
PUBLIC
Exercise MCP requests through the native dispatcher and JSON serialization.
-
orionis.test.contracts
orionis.test.contracts.html
Package
Package
PUBLIC
Group the test contracts components and public imports.
-
orionis.test.contracts.engine
orionis.test.contracts.engine.html
Module
Module
PUBLIC
Define the contract for testing engine implementations.
-
orionis.test.core
orionis.test.core.html
Package
Package
PUBLIC
Group the test core components and public imports.
-
orionis.test.core.engine
orionis.test.core.engine.html
Module
Module
PUBLIC
Discover configured tests, execute them and persist optional result caches.
-
orionis.test.entities
orionis.test.entities.html
Package
Package
PUBLIC
Group the test entities components and public imports.
-
orionis.test.entities.result
orionis.test.entities.result.html
Module
Module
PUBLIC
Represent the outcome of a test execution.
-
orionis.test.enums
orionis.test.enums.html
Package
Package
PUBLIC
Group the test enums components and public imports.
-
orionis.test.enums.status
orionis.test.enums.status.html
Module
Module
PUBLIC
Represent possible statuses for a test during execution.
-
orionis.test.executors
orionis.test.executors.html
Package
Package
PUBLIC
Group the test executors components and public imports.
-
orionis.test.executors.results
orionis.test.executors.results.html
Module
Module
PUBLIC
Collect test outcomes and render configured console feedback.
-
orionis.test.executors.runner
orionis.test.executors.runner.html
Module
Module
PUBLIC
Execute test suites and report their structured results.
-
orionis.test.provider
orionis.test.provider.html
Module
Module
PUBLIC
Register testing services in the application container.
-
orionis.view
orionis.view.html
Package
Package
PUBLIC
Group the view components and public imports.
-
orionis.view._failures
orionis.view._failures.html
Module
Module
PUBLIC
Observe broken optional view services without reporting missing scopes.
-
orionis.view.cache
orionis.view.cache.html
Module
Module
PUBLIC
Store compiled Jinja templates in the configured bytecode directory.
-
orionis.view.contracts
orionis.view.contracts.html
Package
Package
PUBLIC
Group the view contracts components and public imports.
-
orionis.view.contracts.engine
orionis.view.contracts.engine.html
Module
Module
PUBLIC
Define the contract for view engine implementations.
-
orionis.view.contracts.environment
orionis.view.contracts.environment.html
Module
Module
PUBLIC
Define the contract for the view-environment wrapper.
-
orionis.view.contracts.factory
orionis.view.contracts.factory.html
Module
Module
PUBLIC
Contract for the view factory.
-
orionis.view.engine
orionis.view.engine.html
Module
Module
PUBLIC
Render templates asynchronously through the configured Jinja2 environment.
-
orionis.view.environment
orionis.view.environment.html
Module
Module
PUBLIC
Encapsulate and configure a Jinja2 Environment instance.
-
orionis.view.exceptions
orionis.view.exceptions.html
Module
Module
PUBLIC
Provide view operations.
-
orionis.view.extensions
orionis.view.extensions.html
Package
Package
PUBLIC
Group the view extensions components and public imports.
-
orionis.view.extensions.csrf
orionis.view.extensions.csrf.html
Module
Module
PUBLIC
Provide the {% csrf %} statement tag.
-
orionis.view.factory
orionis.view.factory.html
Module
Module
PUBLIC
Prepare named templates for deferred rendering into HTML responses.
-
orionis.view.filters
orionis.view.filters.html
Package
Package
PUBLIC
Group the view filters components and public imports.
-
orionis.view.filters.json
orionis.view.filters.json.html
Module
Module
PUBLIC
Provide view filters operations through _filter_json.
-
orionis.view.filters.markdown
orionis.view.filters.markdown.html
Module
Module
PUBLIC
Provide view filters operations through _filter_markdown.
-
orionis.view.globals
orionis.view.globals.html
Package
Package
PUBLIC
Group the view globals components and public imports.
-
orionis.view.globals.app
orionis.view.globals.app.html
Module
Module
PUBLIC
Provide view globals operations through _global_app.
-
orionis.view.globals.asset
orionis.view.globals.asset.html
Module
Module
PUBLIC
Provide view globals operations.
-
orionis.view.globals.auth
orionis.view.globals.auth.html
Module
Module
PUBLIC
Provide view globals operations through _global_auth.
-
orionis.view.globals.bcrypt
orionis.view.globals.bcrypt.html
Module
Module
PUBLIC
Provide view globals operations through _global_encrypt, _global_decrypt.
-
orionis.view.globals.cache
orionis.view.globals.cache.html
Module
Module
PUBLIC
Provide view globals operations through _global_cache.
-
orionis.view.globals.collection
orionis.view.globals.collection.html
Module
Module
PUBLIC
Provide view globals operations through _global_collect.
-
orionis.view.globals.config
orionis.view.globals.config.html
Module
Module
PUBLIC
Provide view globals operations through _global_config.
-
orionis.view.globals.csrf
orionis.view.globals.csrf.html
Module
Module
PUBLIC
Provide view globals operations.
-
orionis.view.globals.datetime
orionis.view.globals.datetime.html
Module
Module
PUBLIC
Provide view globals operations through _global_now, _global_today.
-
orionis.view.globals.dump
orionis.view.globals.dump.html
Module
Module
PUBLIC
Provide view globals operations through _global_dump.
-
orionis.view.globals.errors
orionis.view.globals.errors.html
Module
Module
PUBLIC
Expose validation errors from the current request session.
-
orionis.view.globals.flash
orionis.view.globals.flash.html
Module
Module
PUBLIC
Provide view globals operations through _global_flash.
-
orionis.view.globals.lang
orionis.view.globals.lang.html
Module
Module
PUBLIC
Provide view globals operations.
-
orionis.view.globals.old
orionis.view.globals.old.html
Module
Module
PUBLIC
Provide view globals operations through _global_old.
-
orionis.view.globals.request
orionis.view.globals.request.html
Module
Module
PUBLIC
Provide view globals operations through _global_request.
-
orionis.view.globals.route
orionis.view.globals.route.html
Module
Module
PUBLIC
Provide view globals operations.
-
orionis.view.globals.session
orionis.view.globals.session.html
Module
Module
PUBLIC
Provide view globals operations through _global_session.
-
orionis.view.globals.stringable
orionis.view.globals.stringable.html
Module
Module
PUBLIC
Provide view globals operations through _global_stringable.
-
orionis.view.globals.url
orionis.view.globals.url.html
Module
Module
PUBLIC
Provide view globals operations.
-
orionis.view.globals.version
orionis.view.globals.version.html
Module
Module
PUBLIC
Provide view globals operations.
-
orionis.view.pending
orionis.view.pending.html
Module
Module
PUBLIC
Provide awaitable, chainable results of template rendering.
-
orionis.view.provider
orionis.view.provider.html
Module
Module
PUBLIC
Register and boot the view system into the application container.
-
orionis._exports.resolve_export
orionis._exports.html#resolve_export
Function
Function
PUBLIC
Import an exported object and store it in its package namespace.
-
orionis.cache.exceptions.CacheException
orionis.cache.exceptions.CacheException.html
Class
Exception
PUBLIC
Base exception for all cache-related errors.
-
orionis.cache.exceptions.CacheStoreException
orionis.cache.exceptions.CacheStoreException.html
Class
Exception
PUBLIC
Raised when an unknown or misconfigured cache store is requested.
-
orionis.support.concurrency.WorkQueueFullError
orionis.support.concurrency.WorkQueueFullError.html
Class
Exception
PUBLIC
Signal that a bounded worker pool cannot admit another operation.
-
orionis.support.concurrency._cancel_abandoned_future
orionis.support.concurrency.html#_cancel_abandoned_future
Function
Function
PUBLIC
Cancel an abandoned future or raise its already completed failure.
-
orionis.support.concurrency.close_abandoned_awaitable
orionis.support.concurrency.html#close_abandoned_awaitable
Function
Function
PUBLIC
Release an awaitable that its cancelled owner cannot consume.
-
orionis.support.concurrency.wait_for_completion
orionis.support.concurrency.html#wait_for_completion
Function
Function
PUBLIC
Await completion without cancelling work or copying its exception.
-
orionis.support.concurrency.complete_on_cancel
orionis.support.concurrency.html#complete_on_cancel
Function
Function
PUBLIC
Wait for owned work before propagating caller cancellation.
-
orionis.support.concurrency.BoundedExecutor
orionis.support.concurrency.BoundedExecutor.html
Class
Class
PUBLIC
Own a lazy thread pool with bounded running and queued work.
-
orionis.support.concurrency.BoundedExecutor.__init__
orionis.support.concurrency.BoundedExecutor.html#__init__
Function
Method
PUBLIC
Configure a lazy worker pool.
-
orionis.support.concurrency.BoundedExecutor._workers
orionis.support.concurrency.BoundedExecutor.html#_workers
Attribute
Instance Variable
PUBLIC
Maximum simultaneous native calls.
-
orionis.support.concurrency.BoundedExecutor._name
orionis.support.concurrency.BoundedExecutor.html#_name
Attribute
Instance Variable
PUBLIC
Prefix used for worker thread names.
-
orionis.support.concurrency.BoundedExecutor._capacity
orionis.support.concurrency.BoundedExecutor.html#_capacity
Attribute
Instance Variable
PUBLIC
Synchronization primitive controlling access to capacity.
-
orionis.support.concurrency.BoundedExecutor._lock
orionis.support.concurrency.BoundedExecutor.html#_lock
Attribute
Instance Variable
PUBLIC
Lock protecting concurrent access to shared state.
-
orionis.support.concurrency.BoundedExecutor._pool
orionis.support.concurrency.BoundedExecutor.html#_pool
Attribute
Instance Variable
PUBLIC
Thread pool used to execute admitted blocking operations.
-
orionis.support.concurrency.BoundedExecutor._closed
orionis.support.concurrency.BoundedExecutor.html#_closed
Attribute
Instance Variable
PUBLIC
Whether this resource has completed its close lifecycle.
-
orionis.support.concurrency.BoundedExecutor.run
orionis.support.concurrency.BoundedExecutor.html#run
Function
Method
PUBLIC
Execute a synchronous callable with copied context and bounded admission.
-
orionis.support.concurrency.BoundedExecutor.close
orionis.support.concurrency.BoundedExecutor.html#close
Function
Method
PUBLIC
Drain accepted work and release the pool's threads.
-
orionis.support.concurrency.BoundedExecutor.aclose
orionis.support.concurrency.BoundedExecutor.html#aclose
Function
Method
PUBLIC
Close without blocking the event loop.
-
orionis.support.concurrency._CALLBACK_WORKERS
orionis.support.concurrency.html#_CALLBACK_WORKERS
Attribute
Constant
PUBLIC
Callback workers used by concurrency.
-
orionis.support.concurrency.threaded
orionis.support.concurrency.html#threaded
Function
Function
PUBLIC
Opt a synchronous handler into bounded thread execution.
-
orionis.cache.locks.lock._is_backend
orionis.cache.locks.lock.html#_is_backend
Function
Function
PUBLIC
Check backend identity without importing an unused store.
-
orionis.cache.locks.lock._FILE_LOCKS
orionis.cache.locks.lock.html#_FILE_LOCKS
Attribute
Constant
PUBLIC
Share active file-cache locks within each event loop and storage directory.
-
orionis.cache.locks.lock._DEFAULT_LEASE
orionis.cache.locks.lock.html#_DEFAULT_LEASE
Attribute
Constant
PUBLIC
Default lease applied when no timeout is given, matching the Redis branch.
-
orionis.cache.locks.lock._POLL_INTERVAL
orionis.cache.locks.lock.html#_POLL_INTERVAL
Attribute
Constant
PUBLIC
Delay between acquisition attempts while polling the database backend.
-
orionis.cache.locks.lock.CacheLock
orionis.cache.locks.lock.CacheLock.html
Class
Class
PUBLIC
Coordinate cache access through local locks or distributed leases.
-
orionis.cache.locks.lock.CacheLock.__slots__
orionis.cache.locks.lock.CacheLock.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.cache.locks.lock.CacheLock.__init__
orionis.cache.locks.lock.CacheLock.html#__init__
Function
Method
PUBLIC
Initialize the lock for key on backend.
-
orionis.cache.locks.lock.CacheLock._backend
orionis.cache.locks.lock.CacheLock.html#_backend
Attribute
Instance Variable
PUBLIC
Raw cache backend.
-
orionis.cache.locks.lock.CacheLock._key
orionis.cache.locks.lock.CacheLock.html#_key
Attribute
Instance Variable
PUBLIC
Cache key to lock on.
-
orionis.cache.locks.lock.CacheLock._timeout
orionis.cache.locks.lock.CacheLock.html#_timeout
Attribute
Instance Variable
PUBLIC
Store-specific acquisition timeout or lease duration in seconds.
-
orionis.cache.locks.lock.CacheLock._impl
orionis.cache.locks.lock.CacheLock.html#_impl
Attribute
Instance Variable
PUBLIC
Underlying lock implementation selected for the cache backend.
-
orionis.cache.locks.lock.CacheLock._owner
orionis.cache.locks.lock.CacheLock.html#_owner
Attribute
Instance Variable
PUBLIC
Ownership token used to identify the current holder.
-
orionis.cache.locks.lock.CacheLock.__aenter__
orionis.cache.locks.lock.CacheLock.html#__aenter__
Function
Method
PUBLIC
Acquire the lock before entering the protected block.
-
orionis.cache.locks.lock.CacheLock.__acquireDatabaseLock
orionis.cache.locks.lock.CacheLock.html#__acquireDatabaseLock
Function
Method
PUBLIC
Acquire the row-based database lock, polling until available.
-
orionis.cache.locks.lock.CacheLock.__aexit__
orionis.cache.locks.lock.CacheLock.html#__aexit__
Function
Method
PUBLIC
Release the lock after leaving the protected block.
-
orionis.cache.locks.coalescing.RedisResolverLease
orionis.cache.locks.coalescing.RedisResolverLease.html
Class
Class
PUBLIC
Poll a Redis NX lease rather than relying on process-local waiter events.
-
orionis.cache.locks.coalescing.RedisResolverLease.__init__
orionis.cache.locks.coalescing.RedisResolverLease.html#__init__
Function
Method
PUBLIC
Retain bounded acquisition settings and a unique release token.
-
orionis.cache.locks.coalescing.RedisResolverLease._backend
orionis.cache.locks.coalescing.RedisResolverLease.html#_backend
Attribute
Instance Variable
PUBLIC
Storage backend implementing the cache operations.
-
orionis.cache.locks.coalescing.RedisResolverLease._key
orionis.cache.locks.coalescing.RedisResolverLease.html#_key
Attribute
Instance Variable
PUBLIC
Cache or lease key to access.
-
orionis.cache.locks.coalescing.RedisResolverLease._lease
orionis.cache.locks.coalescing.RedisResolverLease.html#_lease
Attribute
Instance Variable
PUBLIC
Lease lifetime in seconds; use the store default when omitted.
-
orionis.cache.locks.coalescing.RedisResolverLease._wait
orionis.cache.locks.coalescing.RedisResolverLease.html#_wait
Attribute
Instance Variable
PUBLIC
Maximum number of seconds to wait for ownership.
-
orionis.cache.locks.coalescing.RedisResolverLease._owner
orionis.cache.locks.coalescing.RedisResolverLease.html#_owner
Attribute
Instance Variable
PUBLIC
Ownership token used to identify the current holder.
-
orionis.cache.locks.coalescing.RedisResolverLease._acquire
orionis.cache.locks.coalescing.RedisResolverLease.html#_acquire
Function
Method
PUBLIC
Poll atomic acquisition until cancellation or the outer timeout.
-
orionis.cache.locks.coalescing.RedisResolverLease._release
orionis.cache.locks.coalescing.RedisResolverLease.html#_release
Function
Method
PUBLIC
Delete only this owner's lease, including after an uncertain acquisition.
-
orionis.cache.locks.coalescing.RedisResolverLease.__aenter__
orionis.cache.locks.coalescing.RedisResolverLease.html#__aenter__
Function
Method
PUBLIC
Acquire a distributed lease with a finite waiting budget.
-
orionis.cache.locks.coalescing.RedisResolverLease.__aexit__
orionis.cache.locks.coalescing.RedisResolverLease.html#__aexit__
Function
Method
PUBLIC
Finish bounded ownership cleanup before propagating cancellation.
-
orionis.cache.locks.coalescing.resolver_lease
orionis.cache.locks.coalescing.html#resolver_lease
Function
Function
PUBLIC
Choose Redis polling or preserve the native lock of another backend.
-
orionis.cache.repository._MISSING
orionis.cache.repository.html#_MISSING
Attribute
Constant
PUBLIC
Sentinel that distinguishes a missing cache key from a stored None value.
-
orionis.cache.repository._Flight
orionis.cache.repository._Flight.html
Class
Class
PUBLIC
Retain a completed result only while its concurrent waiters exist.
-
orionis.cache.repository._Flight.__init__
orionis.cache.repository._Flight.html#__init__
Function
Method
PUBLIC
Initialize the lock and unresolved value for concurrent cache callers.
-
orionis.cache.repository._Flight.lock
orionis.cache.repository._Flight.html#lock
Attribute
Instance Variable
PUBLIC
Synchronization primitive controlling access to lock.
-
orionis.cache.repository._Flight.value
orionis.cache.repository._Flight.html#value
Attribute
Instance Variable
PUBLIC
Payload retained for subsequent resolution or restoration.
-
orionis.cache.repository._FLIGHTS
orionis.cache.repository.html#_FLIGHTS
Attribute
Constant
PUBLIC
Flights used by repository.
-
orionis.cache.repository._Resolution
orionis.cache.repository._Resolution.html
Class
Class
PUBLIC
Mark one active resolver without retaining its result in child contexts.
-
orionis.cache.repository._Resolution.__init__
orionis.cache.repository._Resolution.html#__init__
Function
Method
PUBLIC
Retain the resolver identity and its current ownership state.
-
orionis.cache.repository._Resolution.identity
orionis.cache.repository._Resolution.html#identity
Attribute
Instance Variable
PUBLIC
Loop, backend identity and key belonging to this resolver.
-
orionis.cache.repository._Resolution.active
orionis.cache.repository._Resolution.html#active
Attribute
Instance Variable
PUBLIC
Whether the originating resolver still owns the coalesced call.
-
orionis.cache.repository._RESOLVING
orionis.cache.repository.html#_RESOLVING
Attribute
Constant
PUBLIC
Context-local resolving isolated between asynchronous tasks.
-
orionis.environment.contracts.env.IEnv
orionis.environment.contracts.env.IEnv.html
Class
Class
PUBLIC
Define the contract for env implementations.
-
orionis.environment.contracts.env.IEnv.__slots__
orionis.environment.contracts.env.IEnv.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.environment.contracts.env.IEnv.get
orionis.environment.contracts.env.IEnv.html#get
Function
Class Method
PUBLIC
Get the value of an environment variable by key.
-
orionis.environment.contracts.env.IEnv.set
orionis.environment.contracts.env.IEnv.html#set
Function
Class Method
PUBLIC
Set or update an environment variable.
-
orionis.environment.contracts.env.IEnv.unset
orionis.environment.contracts.env.IEnv.html#unset
Function
Class Method
PUBLIC
Remove an environment variable from the .env file.
-
orionis.environment.contracts.env.IEnv.all
orionis.environment.contracts.env.IEnv.html#all
Function
Class Method
PUBLIC
Retrieve all environment variables as a dictionary.
-
orionis.environment.contracts.env.IEnv.reload
orionis.environment.contracts.env.IEnv.html#reload
Function
Class Method
PUBLIC
Reload environment variables from the .env file.
-
orionis.environment.enums.EnvironmentValueType
orionis.environment.enums.EnvironmentValueType.html
Class
Class
PUBLIC
Define supported types for casting environment variable values.
-
orionis.environment.enums.EnvironmentValueType.BASE64
orionis.environment.enums.EnvironmentValueType.html#BASE64
Attribute
Constant
PUBLIC
Base64 encoded value type.
-
orionis.environment.enums.EnvironmentValueType.PATH
orionis.environment.enums.EnvironmentValueType.html#PATH
Attribute
Constant
PUBLIC
File system path type.
-
orionis.environment.enums.EnvironmentValueType.STR
orionis.environment.enums.EnvironmentValueType.html#STR
Attribute
Constant
PUBLIC
String value type.
-
orionis.environment.enums.EnvironmentValueType.INT
orionis.environment.enums.EnvironmentValueType.html#INT
Attribute
Constant
PUBLIC
Integer value type.
-
orionis.environment.enums.EnvironmentValueType.FLOAT
orionis.environment.enums.EnvironmentValueType.html#FLOAT
Attribute
Constant
PUBLIC
Floating-point value type.
-
orionis.environment.enums.EnvironmentValueType.BOOL
orionis.environment.enums.EnvironmentValueType.html#BOOL
Attribute
Constant
PUBLIC
Boolean value type.
-
orionis.environment.enums.EnvironmentValueType.LIST
orionis.environment.enums.EnvironmentValueType.html#LIST
Attribute
Constant
PUBLIC
List value type.
-
orionis.environment.enums.EnvironmentValueType.DICT
orionis.environment.enums.EnvironmentValueType.html#DICT
Attribute
Constant
PUBLIC
Dictionary value type.
-
orionis.environment.enums.EnvironmentValueType.TUPLE
orionis.environment.enums.EnvironmentValueType.html#TUPLE
Attribute
Constant
PUBLIC
Tuple value type.
-
orionis.environment.enums.EnvironmentValueType.SET
orionis.environment.enums.EnvironmentValueType.html#SET
Attribute
Constant
PUBLIC
Set value type.
-
orionis.environment.validators.key_name._pattern
orionis.environment.validators.key_name.html#_pattern
Attribute
Variable
PUBLIC
Precompile the regex pattern for validating environment variable names.
-
orionis.environment.validators.ValidateKeyName
orionis.environment.validators.html#ValidateKeyName
Function
Function
PUBLIC
Validate that the provided environment variable name meets requirements.
-
orionis.environment.validators.types._ALLOWED_TYPE_HINT_VALUES
orionis.environment.validators.types.html#_ALLOWED_TYPE_HINT_VALUES
Attribute
Constant
PUBLIC
Pre-build allowed types list once — avoids repeated list comprehension in error paths.
-
orionis.environment.validators.types._normalize_type_hint
orionis.environment.validators.types.html#_normalize_type_hint
Function
Function
PUBLIC
Normalize and validate a type hint, returning its canonical string value.
-
orionis.environment.validators.types.__ValidateTypes
orionis.environment.validators.types.__ValidateTypes.html
Class
Class
PUBLIC
Validate supported environment type hints before values are cast.
-
orionis.environment.validators.types.__ValidateTypes.__call__
orionis.environment.validators.types.__ValidateTypes.html#__call__
Function
Method
PUBLIC
Validate and determine the type of a given value.
-
orionis.environment.validators.ValidateTypes
orionis.environment.validators.html#ValidateTypes
Attribute
Variable
PUBLIC
Validate and infer the canonical type of an environment value.
-
orionis.support.patterns.singleton.meta._MISSING
orionis.support.patterns.singleton.meta.html#_MISSING
Attribute
Constant
PUBLIC
Sentinel distinguishing missing from ordinary values.
-
orionis.support.patterns.singleton.Singleton
orionis.support.patterns.singleton.Singleton.html
Class
Class
PUBLIC
Create one instance per class with synchronous and asynchronous access.
-
orionis.support.patterns.singleton.Singleton.__init__
orionis.support.patterns.singleton.Singleton.html#__init__
Function
Method
PUBLIC
Initialize per-class singleton state with a sentinel and lock.
-
orionis.support.patterns.singleton.Singleton.__call__
orionis.support.patterns.singleton.Singleton.html#__call__
Function
Method
PUBLIC
Create or retrieve the thread-safe singleton instance.
-
orionis.support.patterns.singleton.Singleton.__acall__
orionis.support.patterns.singleton.Singleton.html#__acall__
Function
Method
PUBLIC
Create or retrieve the singleton instance through an awaitable API.
-
orionis.environment.contracts.caster.IEnvironmentCaster
orionis.environment.contracts.caster.IEnvironmentCaster.html
Class
Class
PUBLIC
Define the contract for environment caster implementations.
-
orionis.environment.contracts.caster.IEnvironmentCaster.__slots__
orionis.environment.contracts.caster.IEnvironmentCaster.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.environment.contracts.caster.IEnvironmentCaster.get
orionis.environment.contracts.caster.IEnvironmentCaster.html#get
Function
Method
PUBLIC
Return the processed value according to the type hint.
-
orionis.environment.contracts.caster.IEnvironmentCaster.to
orionis.environment.contracts.caster.IEnvironmentCaster.html#to
Function
Method
PUBLIC
Convert the internal value to the specified type and return as a string.
-
orionis.environment.dynamic.caster.EnvironmentCaster
orionis.environment.dynamic.caster.EnvironmentCaster.html
Class
Class
PUBLIC
Convert raw environment strings to the requested Python value type.
-
orionis.environment.dynamic.caster.EnvironmentCaster.OPTIONS
orionis.environment.dynamic.caster.EnvironmentCaster.html#OPTIONS
Attribute
Constant
PUBLIC
Precompute the set of valid type hints from the EnvironmentValueType enum for fast membership checks.
-
orionis.environment.dynamic.caster.EnvironmentCaster.__slots__
orionis.environment.dynamic.caster.EnvironmentCaster.html#__slots__
Attribute
Class Variable
PUBLIC
Restrict instances to the declared attributes.
-
orionis.environment.dynamic.caster.EnvironmentCaster.supportedTypes
orionis.environment.dynamic.caster.EnvironmentCaster.html#supportedTypes
Function
Static Method
PUBLIC
Return the set of valid type hints supported by this class.
-
orionis.environment.dynamic.caster.EnvironmentCaster.parseTyped
orionis.environment.dynamic.caster.EnvironmentCaster.html#parseTyped
Function
Static Method
PUBLIC
Parse a typed string (e.g. 'int:42') without full object construction.
-
orionis.environment.dynamic.caster.EnvironmentCaster.__init__
orionis.environment.dynamic.caster.EnvironmentCaster.html#__init__
Function
Method
PUBLIC
Initialize the caster by parsing input to extract type hint and value.
-
orionis.environment.dynamic.caster.EnvironmentCaster.__type_hint
orionis.environment.dynamic.caster.EnvironmentCaster.html#__type_hint
Attribute
Instance Variable
PUBLIC
Initialize type hint and value to default None.
-
orionis.environment.dynamic.caster.EnvironmentCaster.__value_raw
orionis.environment.dynamic.caster.EnvironmentCaster.html#__value_raw
Attribute
Instance Variable
PUBLIC
Raw environment value before conversion to the requested type.
-
orionis.environment.dynamic.caster.EnvironmentCaster.get
orionis.environment.dynamic.caster.EnvironmentCaster.html#get
Function
Method
PUBLIC
Return the processed value according to the type hint.
-
orionis.environment.dynamic.caster.EnvironmentCaster.to
orionis.environment.dynamic.caster.EnvironmentCaster.html#to
Function
Method
PUBLIC
Convert the internal value to the specified type and return as a string.
-
orionis.environment.dynamic.caster.EnvironmentCaster.__toBase64
orionis.environment.dynamic.caster.EnvironmentCaster.html#__toBase64
Function
Method
PUBLIC
Convert internal value to Base64 encoded string with type hint prefix.
-
orionis.environment.dynamic.caster.EnvironmentCaster.__parseBase64
orionis.environment.dynamic.caster.EnvironmentCaster.html#__parseBase64
Function
Method
PUBLIC
Decode the internal raw value from Base64 encoding.
-
orionis.environment.dynamic.caster.EnvironmentCaster.__parsePath
orionis.environment.dynamic.caster.EnvironmentCaster.html#__parsePath
Function
Method
PUBLIC
Convert the internal raw value to a normalized POSIX path string.
-
orionis.environment.dynamic.caster.EnvironmentCaster.__toPath
orionis.environment.dynamic.caster.EnvironmentCaster.html#__toPath
Function
Method
PUBLIC
Convert internal value to absolute POSIX path string with type hint prefix.
-
orionis.environment.dynamic.caster.EnvironmentCaster.__parseStr
orionis.environment.dynamic.caster.EnvironmentCaster.html#__parseStr
Function
Method
PUBLIC
Return the internal raw value as a string with leading whitespace removed.
-
orionis.environment.dynamic.caster.EnvironmentCaster.__toStr
orionis.environment.dynamic.caster.EnvironmentCaster.html#__toStr
Function
Method
PUBLIC
Return the internal value as a string prefixed by the type hint.
-
orionis.environment.dynamic.caster.EnvironmentCaster.__parseInt
orionis.environment.dynamic.caster.EnvironmentCaster.html#__parseInt
Function
Method
PUBLIC
Convert the internal raw value to an integer.
-
orionis.environment.dynamic.caster.EnvironmentCaster.__toInt
orionis.environment.dynamic.caster.EnvironmentCaster.html#__toInt
Function
Method
PUBLIC
Convert the internal value to a string with the integer type hint prefix.
-
orionis.environment.dynamic.caster.EnvironmentCaster.__parseFloat
orionis.environment.dynamic.caster.EnvironmentCaster.html#__parseFloat
Function
Method
PUBLIC
Convert the internal raw value to a float.
-
orionis.environment.dynamic.caster.EnvironmentCaster.__toFloat
orionis.environment.dynamic.caster.EnvironmentCaster.html#__toFloat
Function
Method
PUBLIC
Convert the internal value to a string with the float type hint prefix.
-
orionis.environment.dynamic.caster.EnvironmentCaster.__parseBool
orionis.environment.dynamic.caster.EnvironmentCaster.html#__parseBool
Function
Method
PUBLIC
Convert the internal raw value to a boolean.
-
orionis.environment.dynamic.caster.EnvironmentCaster.__booleanValue
orionis.environment.dynamic.caster.EnvironmentCaster.html#__booleanValue
Function
Static Method
PUBLIC
Parse the shared vocabulary for an explicitly typed boolean.
-
orionis.environment.dynamic.caster.EnvironmentCaster.__toBool
orionis.environment.dynamic.caster.EnvironmentCaster.html#__toBool
Function
Method
PUBLIC
Convert the internal value to a boolean string with type hint prefix.
-
orionis.environment.dynamic.caster.EnvironmentCaster.__parseList
orionis.environment.dynamic.caster.EnvironmentCaster.html#__parseList
Function
Method
PUBLIC
Parse the internal raw value and convert it to a Python list.
-
orionis.environment.dynamic.caster.EnvironmentCaster.__toList
orionis.environment.dynamic.caster.EnvironmentCaster.html#__toList
Function
Method
PUBLIC
Convert the internal value to a string representation with list type hint.
-
orionis.environment.dynamic.caster.EnvironmentCaster.__parseDict
orionis.environment.dynamic.caster.EnvironmentCaster.html#__parseDict
Function
Method
PUBLIC
Parse the internal raw value and convert it to a Python dictionary.
-
orionis.environment.dynamic.caster.EnvironmentCaster.__toDict
orionis.environment.dynamic.caster.EnvironmentCaster.html#__toDict
Function
Method
PUBLIC
Convert the internal value to a string with dictionary type hint prefix.
-
orionis.environment.dynamic.caster.EnvironmentCaster.__parseTuple
orionis.environment.dynamic.caster.EnvironmentCaster.html#__parseTuple
Function
Method
PUBLIC
Parse the internal raw value and convert it to a Python tuple.
-
orionis.environment.dynamic.caster.EnvironmentCaster.__toTuple
orionis.environment.dynamic.caster.EnvironmentCaster.html#__toTuple
Function
Method
PUBLIC
Convert the internal value to a string with the tuple type hint prefix.
-
orionis.environment.dynamic.caster.EnvironmentCaster.__parseSet
orionis.environment.dynamic.caster.EnvironmentCaster.html#__parseSet
Function
Method
PUBLIC
Parse the internal raw value and convert it to a Python set.
-
orionis.environment.dynamic.caster.EnvironmentCaster.__toSet
orionis.environment.dynamic.caster.EnvironmentCaster.html#__toSet
Function
Method
PUBLIC
Convert the internal value to a string with the set type hint prefix.
-
orionis.environment.core.dot_env._NULL_VALUES
orionis.environment.core.dot_env.html#_NULL_VALUES
Attribute
Constant
PUBLIC
Module-level constants computed once — eliminates per-call allocations.
-
orionis.environment.core.dot_env._ENV_TYPE_PREFIXES
orionis.environment.core.dot_env.html#_ENV_TYPE_PREFIXES
Attribute
Constant
PUBLIC
Env type prefixes used by dot_env.
-
orionis.environment.core.dot_env._DISABLED_VALUES
orionis.environment.core.dot_env.html#_DISABLED_VALUES
Attribute
Constant
PUBLIC
Truthy values recognized by python-dotenv's process-loading switch.
-
orionis.environment.core.dot_env._WINDOWS_ENV_LIMIT
orionis.environment.core.dot_env.html#_WINDOWS_ENV_LIMIT
Attribute
Constant
PUBLIC
Maximum UTF-16 length of a Windows process assignment including its equals sign.
-
orionis.environment.core.dot_env.DotEnv
orionis.environment.core.dot_env.DotEnv.html
Class
Class
PUBLIC
Load and cache values from a resolved dotenv file.
-
orionis.environment.core.dot_env.DotEnv.__slots__
orionis.environment.core.dot_env.DotEnv.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.environment.core.dot_env.DotEnv._lock
orionis.environment.core.dot_env.DotEnv.html#_lock
Attribute
Class Variable
PUBLIC
Lock to ensure thread safety during initialization and operations that modify the .env file.
-
orionis.environment.core.dot_env.DotEnv.__init__
orionis.environment.core.dot_env.DotEnv.html#__init__
Function
Method
PUBLIC
Initialize the DotEnv service and prepare the .env file.
-
orionis.environment.core.dot_env.DotEnv.__resolved_path
orionis.environment.core.dot_env.DotEnv.html#__resolved_path
Attribute
Instance Variable
PUBLIC
Resolved backing file selected by the singleton's first caller.
-
orionis.environment.core.dot_env.DotEnv.__cache
orionis.environment.core.dot_env.DotEnv.html#__cache
Attribute
Instance Variable
PUBLIC
Single parsed snapshot used for file-backed values.
-
orionis.environment.core.dot_env.DotEnv.set
orionis.environment.core.dot_env.DotEnv.html#set
Function
Method
PUBLIC
Set an environment variable in the .env file and process environment.
-
orionis.environment.core.dot_env.DotEnv.get
orionis.environment.core.dot_env.DotEnv.html#get
Function
Method
PUBLIC
Retrieve the value of an environment variable.
-
orionis.environment.core.dot_env.DotEnv.unset
orionis.environment.core.dot_env.DotEnv.html#unset
Function
Method
PUBLIC
Remove an environment variable from the .env file and process environment.
-
orionis.environment.core.dot_env.DotEnv.all
orionis.environment.core.dot_env.DotEnv.html#all
Function
Method
PUBLIC
Return all environment variables from the resolved .env file.
-
orionis.environment.core.dot_env.DotEnv.__validateProcessValue
orionis.environment.core.dot_env.DotEnv.html#__validateProcessValue
Function
Static Method
PUBLIC
Reject a serialized value that cannot enter the process environment.
-
orionis.environment.core.dot_env.DotEnv.__loadValues
orionis.environment.core.dot_env.DotEnv.html#__loadValues
Function
Method
PUBLIC
Parse the file once and publish its validated process values.
-
orionis.environment.core.dot_env.DotEnv.__serializeValue
orionis.environment.core.dot_env.DotEnv.html#__serializeValue
Function
Method
PUBLIC
Serialize a Python value for storage in a .env file.
-
orionis.environment.core.dot_env.DotEnv.__parseValue
orionis.environment.core.dot_env.DotEnv.html#__parseValue
Function
Method
PUBLIC
Parse a value from the .env file into its corresponding Python type.
-
orionis.environment.core.dot_env.DotEnv.reload
orionis.environment.core.dot_env.DotEnv.html#reload
Function
Method
PUBLIC
Reload environment variables from the .env file.
-
orionis.environment.Env
orionis.environment.Env.html
Class
Class
PUBLIC
Read typed environment values through the environment service facade.
-
orionis.environment.Env.__slots__
orionis.environment.Env.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.environment.Env.get
orionis.environment.Env.html#get
Function
Class Method
PUBLIC
Get the value of an environment variable by key.
-
orionis.environment.Env.set
orionis.environment.Env.html#set
Function
Class Method
PUBLIC
Set or update an environment variable.
-
orionis.environment.Env.unset
orionis.environment.Env.html#unset
Function
Class Method
PUBLIC
Remove an environment variable from the .env file.
-
orionis.environment.Env.all
orionis.environment.Env.html#all
Function
Class Method
PUBLIC
Retrieve all environment variables as a dictionary.
-
orionis.environment.Env.reload
orionis.environment.Env.html#reload
Function
Class Method
PUBLIC
Reload environment variables from the .env file.
-
orionis.environment.env
orionis.environment.html#env
Function
Function
PUBLIC
Retrieve the value of an environment variable using the Env facade.
-
orionis.environment._EXPORTS
orionis.environment.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.environment.__getattr__
orionis.environment.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.environment.__dir__
orionis.environment.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.foundation.config.validation._NAME_PATTERN
orionis.foundation.config.validation.html#_NAME_PATTERN
Attribute
Constant
PUBLIC
Compiled pattern used to recognize name pattern.
-
orionis.foundation.config.validation._TABLE_PATTERN
orionis.foundation.config.validation.html#_TABLE_PATTERN
Attribute
Constant
PUBLIC
Compiled pattern used to recognize table pattern.
-
orionis.foundation.config.validation._STORE_TABLE_PATTERN
orionis.foundation.config.validation.html#_STORE_TABLE_PATTERN
Attribute
Constant
PUBLIC
Compiled pattern used to recognize store table pattern.
-
orionis.foundation.config.validation._MAX_STORE_PORT
orionis.foundation.config.validation.html#_MAX_STORE_PORT
Attribute
Constant
PUBLIC
Max store port value used by validation.
-
orionis.foundation.config.validation._ENUM_SCALAR_TYPES
orionis.foundation.config.validation.html#_ENUM_SCALAR_TYPES
Attribute
Constant
PUBLIC
Enum scalar types used by validation.
-
orionis.foundation.config.validation.validate_integer
orionis.foundation.config.validation.html#validate_integer
Function
Function
PUBLIC
Validate an integer within an inclusive range.
-
orionis.foundation.config.validation.validate_string
orionis.foundation.config.validation.html#validate_string
Function
Function
PUBLIC
Validate a string and optionally allow blank values.
-
orionis.foundation.config.validation.validate_boolean
orionis.foundation.config.validation.html#validate_boolean
Function
Function
PUBLIC
Require a boolean without coercing truthy values.
-
orionis.foundation.config.validation._enum_values
orionis.foundation.config.validation.html#_enum_values
Function
Function
PUBLIC
Index enum names and values in declaration order.
-
orionis.foundation.config.validation.normalize_enum
orionis.foundation.config.validation.html#normalize_enum
Function
Function
PUBLIC
Normalize an enum member, member name, or string value.
-
orionis.foundation.config.validation.copy_string_list
orionis.foundation.config.validation.html#copy_string_list
Function
Function
PUBLIC
Validate a list of non-empty strings and return an independent copy.
-
orionis.foundation.config.validation.validate_cookie_name
orionis.foundation.config.validation.html#validate_cookie_name
Function
Function
PUBLIC
Validate a cookie name with the HTTP response serializer.
-
orionis.foundation.config.validation.validate_name
orionis.foundation.config.validation.html#validate_name
Function
Function
PUBLIC
Require a safe connection, queue, or SQL table identifier.
-
orionis.foundation.config.validation.validate_seconds
orionis.foundation.config.validation.html#validate_seconds
Function
Function
PUBLIC
Require finite nonnegative or strictly positive seconds.
-
orionis.foundation.config.validation.validate_driver
orionis.foundation.config.validation.html#validate_driver
Function
Function
PUBLIC
Require the driver implemented by a connection entity.
-
orionis.foundation.config.validation.validate_http_origin
orionis.foundation.config.validation.html#validate_http_origin
Function
Function
PUBLIC
Require an explicit serialized HTTP(S) origin without wildcards.
-
orionis.foundation.config.validation.validate_store_table
orionis.foundation.config.validation.html#validate_store_table
Function
Function
PUBLIC
Validate cache/scheduler table names without widening their accepted syntax.
-
orionis.foundation.config.validation.validate_store_port
orionis.foundation.config.validation.html#validate_store_port
Function
Function
PUBLIC
Validate Redis/Memcached ports using the existing store error messages.
-
orionis.foundation.config.validation.validate_store_db
orionis.foundation.config.validation.html#validate_store_db
Function
Function
PUBLIC
Validate the Redis database index for cache and scheduler stores.
-
orionis.foundation.config.validation.normalize_optional_store
orionis.foundation.config.validation.html#normalize_optional_store
Function
Function
PUBLIC
Convert optional cache/scheduler store dictionaries into typed entities.
-
orionis.support.entities.base._serialize_value
orionis.support.entities.base.html#_serialize_value
Function
Function
PUBLIC
Recursively copy configuration values, entities and enum members.
-
orionis.support.entities.base._default_value
orionis.support.entities.base.html#_default_value
Function
Function
PUBLIC
Evaluate a declared default and serialize the resulting value.
-
orionis.foundation.config.cache.entities.cache._DRIVER_NAMES
orionis.foundation.config.cache.entities.cache.html#_DRIVER_NAMES
Attribute
Constant
PUBLIC
Define the supported cache driver names.
-
orionis.container.context.scope.ScopedContext
orionis.container.context.scope.ScopedContext.html
Class
Class
PUBLIC
Store the active dependency-injection scope in a context variable.
-
orionis.container.context.scope.ScopedContext._active_scope
orionis.container.context.scope.ScopedContext.html#_active_scope
Attribute
Class Variable
PUBLIC
Define a context variable to hold the active scope. The default value is None, indicating no active scope.
-
orionis.container.context.scope.ScopedContext.getCurrentScope
orionis.container.context.scope.ScopedContext.html#getCurrentScope
Function
Class Method
PUBLIC
Retrieve the current active scope.
-
orionis.container.context.scope.ScopedContext.setCurrentScope
orionis.container.context.scope.ScopedContext.html#setCurrentScope
Function
Class Method
PUBLIC
Set the current active scope.
-
orionis.container.context.scope.ScopedContext.reset
orionis.container.context.scope.ScopedContext.html#reset
Function
Class Method
PUBLIC
Reset the active scope to a previous state.
-
orionis.container.context.manager._close_unstarted_coroutine
orionis.container.context.manager.html#_close_unstarted_coroutine
Function
Function
PUBLIC
Release a stored native coroutine which the scope never started.
-
orionis.container.context.manager.ScopeManager
orionis.container.context.manager.ScopeManager.html
Class
Class
PUBLIC
Own scoped service instances and their creation and cleanup lifecycle.
-
orionis.container.context.manager.ScopeManager.__slots__
orionis.container.context.manager.ScopeManager.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.container.context.manager.ScopeManager.__init__
orionis.container.context.manager.ScopeManager.html#__init__
Function
Method
PUBLIC
Initialize the ScopeManager.
-
orionis.container.context.manager.ScopeManager._instances
orionis.container.context.manager.ScopeManager.html#_instances
Attribute
Instance Variable
PUBLIC
Dictionary to hold instances for the current scope.
-
orionis.container.context.manager.ScopeManager.__active
orionis.container.context.manager.ScopeManager.html#__active
Attribute
Instance Variable
PUBLIC
Active flag used by ScopeManager.
-
orionis.container.context.manager.ScopeManager.__closed
orionis.container.context.manager.ScopeManager.html#__closed
Attribute
Instance Variable
PUBLIC
Whether this resource has completed its close lifecycle.
-
orionis.container.context.manager.ScopeManager.__creation_locks
orionis.container.context.manager.ScopeManager.html#__creation_locks
Attribute
Instance Variable
PUBLIC
Locks coordinating concurrent creation of the same scoped service.
-
orionis.container.context.manager.ScopeManager.creationLock
orionis.container.context.manager.ScopeManager.html#creationLock
Function
Method
PUBLIC
Return the construction lock owned by this scope and service key.
-
orionis.container.context.manager.ScopeManager.isActive
orionis.container.context.manager.ScopeManager.html#isActive
Attribute
Property
PUBLIC
Report whether the owning scope is still open.
-
orionis.container.context.manager.ScopeManager.__getitem__
orionis.container.context.manager.ScopeManager.html#__getitem__
Function
Method
PUBLIC
Retrieve the instance associated with the given key.
-
orionis.container.context.manager.ScopeManager.__setitem__
orionis.container.context.manager.ScopeManager.html#__setitem__
Function
Method
PUBLIC
Store an instance under the specified key.
-
orionis.container.context.manager.ScopeManager.__contains__
orionis.container.context.manager.ScopeManager.html#__contains__
Function
Method
PUBLIC
Check whether the given key exists in the scope.
-
orionis.container.context.manager.ScopeManager.clear
orionis.container.context.manager.ScopeManager.html#clear
Function
Method
PUBLIC
Remove all instances from the current scope.
-
orionis.container.context.manager.ScopeManager.__aenter__
orionis.container.context.manager.ScopeManager.html#__aenter__
Function
Method
PUBLIC
Enter the asynchronous context and set the current scope.
-
orionis.container.context.manager.ScopeManager._token
orionis.container.context.manager.ScopeManager.html#_token
Attribute
Instance Variable
PUBLIC
Context-variable token used to restore the previous scope.
-
orionis.container.context.manager.ScopeManager.__aexit__
orionis.container.context.manager.ScopeManager.html#__aexit__
Function
Method
PUBLIC
Exit the asynchronous context and clear the current scope.
-
orionis.container.context.manager.ScopeManager.get
orionis.container.context.manager.ScopeManager.html#get
Function
Method
PUBLIC
Retrieve the instance associated with the given key asynchronously.
-
orionis.container.context.manager.ScopeManager.set
orionis.container.context.manager.ScopeManager.html#set
Function
Method
PUBLIC
Store an instance in the scope.
-
orionis.container.context.manager.ScopeManager.resolve
orionis.container.context.manager.ScopeManager.html#resolve
Function
Method
PUBLIC
Resolve and return the instance for a given key.
-
orionis.container.contracts.container.IContainer
orionis.container.contracts.container.IContainer.html
Class
Class
PUBLIC
Define the contract for container implementations.
-
orionis.container.contracts.container.IContainer.instance
orionis.container.contracts.container.IContainer.html#instance
Function
Method
PUBLIC
Register an existing object globally or in the active scope.
-
orionis.container.contracts.container.IContainer.transient
orionis.container.contracts.container.IContainer.html#transient
Function
Method
PUBLIC
Register a transient service binding.
-
orionis.container.contracts.container.IContainer.singleton
orionis.container.contracts.container.IContainer.html#singleton
Function
Method
PUBLIC
Register a singleton service binding.
-
orionis.container.contracts.container.IContainer.scoped
orionis.container.contracts.container.IContainer.html#scoped
Function
Method
PUBLIC
Register a scoped service binding.
-
orionis.container.contracts.container.IContainer.bound
orionis.container.contracts.container.IContainer.html#bound
Function
Method
PUBLIC
Determine if a key is bound in the container or current scope.
-
orionis.container.contracts.container.IContainer.beginScope
orionis.container.contracts.container.IContainer.html#beginScope
Function
Method
PUBLIC
Begin a new scope context manager for scoped services.
-
orionis.container.contracts.container.IContainer.getCurrentScope
orionis.container.contracts.container.IContainer.html#getCurrentScope
Function
Method
PUBLIC
Get the current active scope context for scoped services.
-
orionis.container.contracts.container.IContainer.make
orionis.container.contracts.container.IContainer.html#make
Function
Method
PUBLIC
Resolve and return a service instance by key.
-
orionis.container.contracts.container.IContainer.build
orionis.container.contracts.container.IContainer.html#build
Function
Method
PUBLIC
Build and return an instance of the specified type.
-
orionis.container.contracts.container.IContainer.invoke
orionis.container.contracts.container.IContainer.html#invoke
Function
Method
PUBLIC
Invoke a callable with automatic dependency injection.
-
orionis.container.contracts.container.IContainer.call
orionis.container.contracts.container.IContainer.html#call
Function
Method
PUBLIC
Invoke a method on an object instance with automatic dependency injection.
-
orionis.console.base.contracts.listener.IBaseTaskListener
orionis.console.base.contracts.listener.IBaseTaskListener.html
Class
Class
PUBLIC
Define the contract for base task listener implementations.
-
orionis.console.base.contracts.listener.IBaseTaskListener.onTaskAdded
orionis.console.base.contracts.listener.IBaseTaskListener.html#onTaskAdded
Function
Method
PUBLIC
Handle the event when a task is added.
-
orionis.console.base.contracts.listener.IBaseTaskListener.onTaskRemoved
orionis.console.base.contracts.listener.IBaseTaskListener.html#onTaskRemoved
Function
Method
PUBLIC
Handle the event when a task is removed.
-
orionis.console.base.contracts.listener.IBaseTaskListener.onTaskExecuted
orionis.console.base.contracts.listener.IBaseTaskListener.html#onTaskExecuted
Function
Method
PUBLIC
Handle the event when a task is executed.
-
orionis.console.base.contracts.listener.IBaseTaskListener.onTaskError
orionis.console.base.contracts.listener.IBaseTaskListener.html#onTaskError
Function
Method
PUBLIC
Handle the event when a task encounters an error.
-
orionis.console.base.contracts.listener.IBaseTaskListener.onTaskMissed
orionis.console.base.contracts.listener.IBaseTaskListener.html#onTaskMissed
Function
Method
PUBLIC
Handle the event when a task is missed.
-
orionis.console.base.contracts.listener.IBaseTaskListener.onTaskSubmitted
orionis.console.base.contracts.listener.IBaseTaskListener.html#onTaskSubmitted
Function
Method
PUBLIC
Handle the event when a task is submitted.
-
orionis.console.base.contracts.listener.IBaseTaskListener.onTaskMaxInstances
orionis.console.base.contracts.listener.IBaseTaskListener.html#onTaskMaxInstances
Function
Method
PUBLIC
Handle the event when a task reaches its maximum allowed instances.
-
orionis.console.fluent.contracts.task.ITask
orionis.console.fluent.contracts.task.ITask.html
Class
Class
PUBLIC
Define the contract for task implementations.
-
orionis.console.fluent.contracts.task.ITask.entity
orionis.console.fluent.contracts.task.ITask.html#entity
Function
Method
PUBLIC
Create and return a TaskEntity instance from the current Task.
-
orionis.console.fluent.contracts.task.ITask.coalesce
orionis.console.fluent.contracts.task.ITask.html#coalesce
Function
Method
PUBLIC
Set the coalesce behavior for missed task executions.
-
orionis.console.fluent.contracts.task.ITask.misfireGraceTime
orionis.console.fluent.contracts.task.ITask.html#misfireGraceTime
Function
Method
PUBLIC
Set the misfire grace time in seconds.
-
orionis.console.fluent.contracts.task.ITask.purpose
orionis.console.fluent.contracts.task.ITask.html#purpose
Function
Method
PUBLIC
Set the purpose or description for the scheduled command.
-
orionis.console.fluent.contracts.task.ITask.startDate
orionis.console.fluent.contracts.task.ITask.html#startDate
Function
Method
PUBLIC
Set the start date for task execution.
-
orionis.console.fluent.contracts.task.ITask.endDate
orionis.console.fluent.contracts.task.ITask.html#endDate
Function
Method
PUBLIC
Set the end date for task execution.
-
orionis.console.fluent.contracts.task.ITask.randomDelay
orionis.console.fluent.contracts.task.ITask.html#randomDelay
Function
Method
PUBLIC
Configure a random delay before task execution.
-
orionis.console.fluent.contracts.task.ITask.maxInstances
orionis.console.fluent.contracts.task.ITask.html#maxInstances
Function
Method
PUBLIC
Set the maximum number of concurrent task instances.
-
orionis.console.fluent.contracts.task.ITask.on
orionis.console.fluent.contracts.task.ITask.html#on
Function
Method
PUBLIC
Register a callback for a specific task event.
-
orionis.console.fluent.contracts.task.ITask.registerListener
orionis.console.fluent.contracts.task.ITask.html#registerListener
Function
Method
PUBLIC
Register a task listener for task events.
-
orionis.console.fluent.contracts.task.ITask.onceAt
orionis.console.fluent.contracts.task.ITask.html#onceAt
Function
Method
PUBLIC
Schedule the task to execute once at a specific date and time.
-
orionis.console.fluent.contracts.task.ITask.everySeconds
orionis.console.fluent.contracts.task.ITask.html#everySeconds
Function
Method
PUBLIC
Schedule the task to run at fixed intervals in seconds.
-
orionis.console.fluent.contracts.task.ITask.everyFiveSeconds
orionis.console.fluent.contracts.task.ITask.html#everyFiveSeconds
Function
Method
PUBLIC
Schedule the task to run every five seconds.
-
orionis.console.fluent.contracts.task.ITask.everyTenSeconds
orionis.console.fluent.contracts.task.ITask.html#everyTenSeconds
Function
Method
PUBLIC
Schedule the task to run every ten seconds.
-
orionis.console.fluent.contracts.task.ITask.everyFifteenSeconds
orionis.console.fluent.contracts.task.ITask.html#everyFifteenSeconds
Function
Method
PUBLIC
Schedule the task to run every fifteen seconds.
-
orionis.console.fluent.contracts.task.ITask.everyTwentySeconds
orionis.console.fluent.contracts.task.ITask.html#everyTwentySeconds
Function
Method
PUBLIC
Schedule the task to run every twenty seconds.
-
orionis.console.fluent.contracts.task.ITask.everyTwentyFiveSeconds
orionis.console.fluent.contracts.task.ITask.html#everyTwentyFiveSeconds
Function
Method
PUBLIC
Schedule the task to run every twenty-five seconds.
-
orionis.console.fluent.contracts.task.ITask.everyThirtySeconds
orionis.console.fluent.contracts.task.ITask.html#everyThirtySeconds
Function
Method
PUBLIC
Schedule the task to run every thirty seconds.
-
orionis.console.fluent.contracts.task.ITask.everyThirtyFiveSeconds
orionis.console.fluent.contracts.task.ITask.html#everyThirtyFiveSeconds
Function
Method
PUBLIC
Schedule the task to run every thirty-five seconds.
-
orionis.console.fluent.contracts.task.ITask.everyFortySeconds
orionis.console.fluent.contracts.task.ITask.html#everyFortySeconds
Function
Method
PUBLIC
Schedule the task to run every forty seconds.
-
orionis.console.fluent.contracts.task.ITask.everyFortyFiveSeconds
orionis.console.fluent.contracts.task.ITask.html#everyFortyFiveSeconds
Function
Method
PUBLIC
Schedule the task to run every forty-five seconds.
-
orionis.console.fluent.contracts.task.ITask.everyFiftySeconds
orionis.console.fluent.contracts.task.ITask.html#everyFiftySeconds
Function
Method
PUBLIC
Schedule the task to run every fifty seconds.
-
orionis.console.fluent.contracts.task.ITask.everyFiftyFiveSeconds
orionis.console.fluent.contracts.task.ITask.html#everyFiftyFiveSeconds
Function
Method
PUBLIC
Schedule the task to run every fifty-five seconds.
-
orionis.console.fluent.contracts.task.ITask.everyMinutes
orionis.console.fluent.contracts.task.ITask.html#everyMinutes
Function
Method
PUBLIC
Schedule the task to run at fixed intervals in minutes.
-
orionis.console.fluent.contracts.task.ITask.everyMinuteAt
orionis.console.fluent.contracts.task.ITask.html#everyMinuteAt
Function
Method
PUBLIC
Schedule the task to run every minute at a specific second.
-
orionis.console.fluent.contracts.task.ITask.everyMinutesAt
orionis.console.fluent.contracts.task.ITask.html#everyMinutesAt
Function
Method
PUBLIC
Schedule to run at a specific second of every N-minute interval.
-
orionis.console.fluent.contracts.task.ITask.everyFiveMinutes
orionis.console.fluent.contracts.task.ITask.html#everyFiveMinutes
Function
Method
PUBLIC
Schedule the task to run every five minutes.
-
orionis.console.fluent.contracts.task.ITask.everyFiveMinutesAt
orionis.console.fluent.contracts.task.ITask.html#everyFiveMinutesAt
Function
Method
PUBLIC
Schedule the task to run every five minutes at a specific second.
-
orionis.console.fluent.contracts.task.ITask.everyTenMinutes
orionis.console.fluent.contracts.task.ITask.html#everyTenMinutes
Function
Method
PUBLIC
Schedule to run every ten minutes.
-
orionis.console.fluent.contracts.task.ITask.everyTenMinutesAt
orionis.console.fluent.contracts.task.ITask.html#everyTenMinutesAt
Function
Method
PUBLIC
Schedule to run every ten minutes at a specific second.
-
orionis.console.fluent.contracts.task.ITask.everyFifteenMinutes
orionis.console.fluent.contracts.task.ITask.html#everyFifteenMinutes
Function
Method
PUBLIC
Schedule the task to run every fifteen minutes.
-
orionis.console.fluent.contracts.task.ITask.everyFifteenMinutesAt
orionis.console.fluent.contracts.task.ITask.html#everyFifteenMinutesAt
Function
Method
PUBLIC
Schedule to run every fifteen minutes at a specific second.
-
orionis.console.fluent.contracts.task.ITask.everyTwentyMinutes
orionis.console.fluent.contracts.task.ITask.html#everyTwentyMinutes
Function
Method
PUBLIC
Schedule to run every twenty minutes.
-
orionis.console.fluent.contracts.task.ITask.everyTwentyMinutesAt
orionis.console.fluent.contracts.task.ITask.html#everyTwentyMinutesAt
Function
Method
PUBLIC
Schedule to run every twenty minutes at a specific second.
-
orionis.console.fluent.contracts.task.ITask.everyTwentyFiveMinutes
orionis.console.fluent.contracts.task.ITask.html#everyTwentyFiveMinutes
Function
Method
PUBLIC
Schedule the task to run every twenty-five minutes.
-
orionis.console.fluent.contracts.task.ITask.everyTwentyFiveMinutesAt
orionis.console.fluent.contracts.task.ITask.html#everyTwentyFiveMinutesAt
Function
Method
PUBLIC
Schedule to run every twenty-five minutes at a specific second.
-
orionis.console.fluent.contracts.task.ITask.everyThirtyMinutes
orionis.console.fluent.contracts.task.ITask.html#everyThirtyMinutes
Function
Method
PUBLIC
Schedule the task to run every thirty minutes.
-
orionis.console.fluent.contracts.task.ITask.everyThirtyMinutesAt
orionis.console.fluent.contracts.task.ITask.html#everyThirtyMinutesAt
Function
Method
PUBLIC
Schedule to run every thirty minutes at a specific second.
-
orionis.console.fluent.contracts.task.ITask.everyThirtyFiveMinutes
orionis.console.fluent.contracts.task.ITask.html#everyThirtyFiveMinutes
Function
Method
PUBLIC
Schedule to run every thirty-five minutes.
-
orionis.console.fluent.contracts.task.ITask.everyThirtyFiveMinutesAt
orionis.console.fluent.contracts.task.ITask.html#everyThirtyFiveMinutesAt
Function
Method
PUBLIC
Schedule to run every 35 minutes at a specific second.
-
orionis.console.fluent.contracts.task.ITask.everyFortyMinutes
orionis.console.fluent.contracts.task.ITask.html#everyFortyMinutes
Function
Method
PUBLIC
Schedule the task to run every forty minutes.
-
orionis.console.fluent.contracts.task.ITask.everyFortyMinutesAt
orionis.console.fluent.contracts.task.ITask.html#everyFortyMinutesAt
Function
Method
PUBLIC
Schedule to run every forty minutes at a specific second.
-
orionis.console.fluent.contracts.task.ITask.everyFortyFiveMinutes
orionis.console.fluent.contracts.task.ITask.html#everyFortyFiveMinutes
Function
Method
PUBLIC
Schedule the task to run every forty-five minutes.
-
orionis.console.fluent.contracts.task.ITask.everyFortyFiveMinutesAt
orionis.console.fluent.contracts.task.ITask.html#everyFortyFiveMinutesAt
Function
Method
PUBLIC
Schedule the task to run every forty-five minutes at a specific second.
-
orionis.console.fluent.contracts.task.ITask.everyFiftyMinutes
orionis.console.fluent.contracts.task.ITask.html#everyFiftyMinutes
Function
Method
PUBLIC
Schedule to run every fifty minutes.
-
orionis.console.fluent.contracts.task.ITask.everyFiftyMinutesAt
orionis.console.fluent.contracts.task.ITask.html#everyFiftyMinutesAt
Function
Method
PUBLIC
Schedule to run every fifty minutes at a specific second.
-
orionis.console.fluent.contracts.task.ITask.everyFiftyFiveMinutes
orionis.console.fluent.contracts.task.ITask.html#everyFiftyFiveMinutes
Function
Method
PUBLIC
Schedule the task to run every fifty-five minutes.
-
orionis.console.fluent.contracts.task.ITask.everyFiftyFiveMinutesAt
orionis.console.fluent.contracts.task.ITask.html#everyFiftyFiveMinutesAt
Function
Method
PUBLIC
Schedule the task to run every fifty-five minutes at a specific second.
-
orionis.console.fluent.contracts.task.ITask.hourly
orionis.console.fluent.contracts.task.ITask.html#hourly
Function
Method
PUBLIC
Schedule the task to run every hour.
-
orionis.console.fluent.contracts.task.ITask.hourlyAt
orionis.console.fluent.contracts.task.ITask.html#hourlyAt
Function
Method
PUBLIC
Schedule the task to run every hour at a specific minute and second.
-
orionis.console.fluent.contracts.task.ITask.everyOddHours
orionis.console.fluent.contracts.task.ITask.html#everyOddHours
Function
Method
PUBLIC
Schedule the task to run at every odd hour of the day.
-
orionis.console.fluent.contracts.task.ITask.everyEvenHours
orionis.console.fluent.contracts.task.ITask.html#everyEvenHours
Function
Method
PUBLIC
Schedule the task to run at every even hour of the day.
-
orionis.console.fluent.contracts.task.ITask.everyHours
orionis.console.fluent.contracts.task.ITask.html#everyHours
Function
Method
PUBLIC
Schedule the task to run at fixed intervals in hours.
-
orionis.console.fluent.contracts.task.ITask.everyHoursAt
orionis.console.fluent.contracts.task.ITask.html#everyHoursAt
Function
Method
PUBLIC
Schedule the task to run every N hours at a specific minute and second.
-
orionis.console.fluent.contracts.task.ITask.everyTwoHours
orionis.console.fluent.contracts.task.ITask.html#everyTwoHours
Function
Method
PUBLIC
Schedule the task to run every two hours.
-
orionis.console.fluent.contracts.task.ITask.everyTwoHoursAt
orionis.console.fluent.contracts.task.ITask.html#everyTwoHoursAt
Function
Method
PUBLIC
Schedule to run every two hours at a specific minute and second.
-
orionis.console.fluent.contracts.task.ITask.everyThreeHours
orionis.console.fluent.contracts.task.ITask.html#everyThreeHours
Function
Method
PUBLIC
Schedule the task to run every three hours.
-
orionis.console.fluent.contracts.task.ITask.everyThreeHoursAt
orionis.console.fluent.contracts.task.ITask.html#everyThreeHoursAt
Function
Method
PUBLIC
Schedule to run every three hours at a specific minute and second.
-
orionis.console.fluent.contracts.task.ITask.everyFourHours
orionis.console.fluent.contracts.task.ITask.html#everyFourHours
Function
Method
PUBLIC
Schedule the task to run every four hours.
-
orionis.console.fluent.contracts.task.ITask.everyFourHoursAt
orionis.console.fluent.contracts.task.ITask.html#everyFourHoursAt
Function
Method
PUBLIC
Schedule to run every four hours at a specific minute and second.
-
orionis.console.fluent.contracts.task.ITask.everyFiveHours
orionis.console.fluent.contracts.task.ITask.html#everyFiveHours
Function
Method
PUBLIC
Schedule the task to run every five hours.
-
orionis.console.fluent.contracts.task.ITask.everyFiveHoursAt
orionis.console.fluent.contracts.task.ITask.html#everyFiveHoursAt
Function
Method
PUBLIC
Schedule to run every five hours at a specific minute and second.
-
orionis.console.fluent.contracts.task.ITask.everySixHours
orionis.console.fluent.contracts.task.ITask.html#everySixHours
Function
Method
PUBLIC
Schedule to run every six hours.
-
orionis.console.fluent.contracts.task.ITask.everySixHoursAt
orionis.console.fluent.contracts.task.ITask.html#everySixHoursAt
Function
Method
PUBLIC
Schedule to run every six hours at a specific minute and second.
-
orionis.console.fluent.contracts.task.ITask.everySevenHours
orionis.console.fluent.contracts.task.ITask.html#everySevenHours
Function
Method
PUBLIC
Schedule to run every seven hours.
-
orionis.console.fluent.contracts.task.ITask.everySevenHoursAt
orionis.console.fluent.contracts.task.ITask.html#everySevenHoursAt
Function
Method
PUBLIC
Schedule to run every seven hours at a specific minute and second.
-
orionis.console.fluent.contracts.task.ITask.everyEightHours
orionis.console.fluent.contracts.task.ITask.html#everyEightHours
Function
Method
PUBLIC
Schedule to run every eight hours.
-
orionis.console.fluent.contracts.task.ITask.everyEightHoursAt
orionis.console.fluent.contracts.task.ITask.html#everyEightHoursAt
Function
Method
PUBLIC
Schedule to run every eight hours at a specific minute and second.
-
orionis.console.fluent.contracts.task.ITask.everyNineHours
orionis.console.fluent.contracts.task.ITask.html#everyNineHours
Function
Method
PUBLIC
Schedule to run every nine hours.
-
orionis.console.fluent.contracts.task.ITask.everyNineHoursAt
orionis.console.fluent.contracts.task.ITask.html#everyNineHoursAt
Function
Method
PUBLIC
Schedule to run every nine hours at a specific minute and second.
-
orionis.console.fluent.contracts.task.ITask.everyTenHours
orionis.console.fluent.contracts.task.ITask.html#everyTenHours
Function
Method
PUBLIC
Schedule to run every ten hours.
-
orionis.console.fluent.contracts.task.ITask.everyTenHoursAt
orionis.console.fluent.contracts.task.ITask.html#everyTenHoursAt
Function
Method
PUBLIC
Schedule to run every ten hours at a specific minute and second.
-
orionis.console.fluent.contracts.task.ITask.everyElevenHours
orionis.console.fluent.contracts.task.ITask.html#everyElevenHours
Function
Method
PUBLIC
Schedule to run every eleven hours.
-
orionis.console.fluent.contracts.task.ITask.everyElevenHoursAt
orionis.console.fluent.contracts.task.ITask.html#everyElevenHoursAt
Function
Method
PUBLIC
Schedule to run every eleven hours at a specific minute and second.
-
orionis.console.fluent.contracts.task.ITask.everyTwelveHours
orionis.console.fluent.contracts.task.ITask.html#everyTwelveHours
Function
Method
PUBLIC
Schedule to run every twelve hours.
-
orionis.console.fluent.contracts.task.ITask.everyTwelveHoursAt
orionis.console.fluent.contracts.task.ITask.html#everyTwelveHoursAt
Function
Method
PUBLIC
Schedule to run every twelve hours at a specific minute and second.
-
orionis.console.fluent.contracts.task.ITask.daily
orionis.console.fluent.contracts.task.ITask.html#daily
Function
Method
PUBLIC
Schedule the task to run once per day.
-
orionis.console.fluent.contracts.task.ITask.dailyAt
orionis.console.fluent.contracts.task.ITask.html#dailyAt
Function
Method
PUBLIC
Schedule the task to run daily at a specific hour, minute, and second.
-
orionis.console.fluent.contracts.task.ITask.everyDays
orionis.console.fluent.contracts.task.ITask.html#everyDays
Function
Method
PUBLIC
Schedule to run at fixed intervals measured in days.
-
orionis.console.fluent.contracts.task.ITask.everyDaysAt
orionis.console.fluent.contracts.task.ITask.html#everyDaysAt
Function
Method
PUBLIC
Schedule to run every N days at a specific hour, minute, and second.
-
orionis.console.fluent.contracts.task.ITask.everyTwoDays
orionis.console.fluent.contracts.task.ITask.html#everyTwoDays
Function
Method
PUBLIC
Schedule to run every two days.
-
orionis.console.fluent.contracts.task.ITask.everyTwoDaysAt
orionis.console.fluent.contracts.task.ITask.html#everyTwoDaysAt
Function
Method
PUBLIC
Schedule to run every two days at a specific hour, minute, and second.
-
orionis.console.fluent.contracts.task.ITask.everyThreeDays
orionis.console.fluent.contracts.task.ITask.html#everyThreeDays
Function
Method
PUBLIC
Schedule to run every three days.
-
orionis.console.fluent.contracts.task.ITask.everyThreeDaysAt
orionis.console.fluent.contracts.task.ITask.html#everyThreeDaysAt
Function
Method
PUBLIC
Schedule to run every three days at a specific hour, minute, and second.
-
orionis.console.fluent.contracts.task.ITask.everyFourDays
orionis.console.fluent.contracts.task.ITask.html#everyFourDays
Function
Method
PUBLIC
Schedule to run every four days.
-
orionis.console.fluent.contracts.task.ITask.everyFourDaysAt
orionis.console.fluent.contracts.task.ITask.html#everyFourDaysAt
Function
Method
PUBLIC
Schedule to run every four days at a specific hour, minute, and second.
-
orionis.console.fluent.contracts.task.ITask.everyFiveDays
orionis.console.fluent.contracts.task.ITask.html#everyFiveDays
Function
Method
PUBLIC
Schedule to run every five days.
-
orionis.console.fluent.contracts.task.ITask.everyFiveDaysAt
orionis.console.fluent.contracts.task.ITask.html#everyFiveDaysAt
Function
Method
PUBLIC
Schedule event to run every five days at a specific hour, minute, and second.
-
orionis.console.fluent.contracts.task.ITask.everySixDays
orionis.console.fluent.contracts.task.ITask.html#everySixDays
Function
Method
PUBLIC
Schedule the task to run every six days.
-
orionis.console.fluent.contracts.task.ITask.everySixDaysAt
orionis.console.fluent.contracts.task.ITask.html#everySixDaysAt
Function
Method
PUBLIC
Schedule event to run every six days at a specific hour, minute, and second.
-
orionis.console.fluent.contracts.task.ITask.everySevenDays
orionis.console.fluent.contracts.task.ITask.html#everySevenDays
Function
Method
PUBLIC
Schedule the task to run every seven days.
-
orionis.console.fluent.contracts.task.ITask.everySevenDaysAt
orionis.console.fluent.contracts.task.ITask.html#everySevenDaysAt
Function
Method
PUBLIC
Schedule event to run every seven days at a specific hour, minute, and second.
-
orionis.console.fluent.contracts.task.ITask.everyMondayAt
orionis.console.fluent.contracts.task.ITask.html#everyMondayAt
Function
Method
PUBLIC
Schedule event to run every Monday at a specific hour, minute, and second.
-
orionis.console.fluent.contracts.task.ITask.everyTuesdayAt
orionis.console.fluent.contracts.task.ITask.html#everyTuesdayAt
Function
Method
PUBLIC
Schedule event to run every Tuesday at a specific hour, minute, and second.
-
orionis.console.fluent.contracts.task.ITask.everyWednesdayAt
orionis.console.fluent.contracts.task.ITask.html#everyWednesdayAt
Function
Method
PUBLIC
Schedule event to run every Wednesday at a specific hour, minute, and second.
-
orionis.console.fluent.contracts.task.ITask.everyThursdayAt
orionis.console.fluent.contracts.task.ITask.html#everyThursdayAt
Function
Method
PUBLIC
Schedule event to run every Thursday at a specific hour, minute, and second.
-
orionis.console.fluent.contracts.task.ITask.everyFridayAt
orionis.console.fluent.contracts.task.ITask.html#everyFridayAt
Function
Method
PUBLIC
Schedule the task to run every Friday at a specific hour, minute, and second.
-
orionis.console.fluent.contracts.task.ITask.everySaturdayAt
orionis.console.fluent.contracts.task.ITask.html#everySaturdayAt
Function
Method
PUBLIC
Schedule the task to run every Saturday at a specific hour, minute, and second.
-
orionis.console.fluent.contracts.task.ITask.everySundayAt
orionis.console.fluent.contracts.task.ITask.html#everySundayAt
Function
Method
PUBLIC
Schedule the task to run every Sunday at a specific hour, minute, and second.
-
orionis.console.fluent.contracts.task.ITask.weekly
orionis.console.fluent.contracts.task.ITask.html#weekly
Function
Method
PUBLIC
Schedule the task to run every week.
-
orionis.console.fluent.contracts.task.ITask.everyWeeks
orionis.console.fluent.contracts.task.ITask.html#everyWeeks
Function
Method
PUBLIC
Configure the event to run at fixed intervals measured in weeks.
-
orionis.console.fluent.contracts.task.ITask.every
orionis.console.fluent.contracts.task.ITask.html#every
Function
Method
PUBLIC
Configure the event to run at a custom interval.
-
orionis.console.fluent.contracts.task.ITask.cron
orionis.console.fluent.contracts.task.ITask.html#cron
Function
Method
PUBLIC
Schedule the task using a CRON-like expression.
-
orionis.console.base.contracts.scheduler.IBaseScheduler
orionis.console.base.contracts.scheduler.IBaseScheduler.html
Class
Class
PUBLIC
Define the contract for base scheduler implementations.
-
orionis.console.base.contracts.scheduler.IBaseScheduler.tasks
orionis.console.base.contracts.scheduler.IBaseScheduler.html#tasks
Function
Method
PUBLIC
Register scheduled tasks for the application.
-
orionis.console.base.contracts.scheduler.IBaseScheduler.onStarted
orionis.console.base.contracts.scheduler.IBaseScheduler.html#onStarted
Function
Method
PUBLIC
Handle the scheduler start event.
-
orionis.console.base.contracts.scheduler.IBaseScheduler.onPaused
orionis.console.base.contracts.scheduler.IBaseScheduler.html#onPaused
Function
Method
PUBLIC
Handle the scheduler pause event.
-
orionis.console.base.contracts.scheduler.IBaseScheduler.onResumed
orionis.console.base.contracts.scheduler.IBaseScheduler.html#onResumed
Function
Method
PUBLIC
Handle the scheduler resumption event.
-
orionis.console.base.contracts.scheduler.IBaseScheduler.onShutdown
orionis.console.base.contracts.scheduler.IBaseScheduler.html#onShutdown
Function
Method
PUBLIC
Handle the scheduler finalization event.
-
orionis.container.contracts.service_provider.IServiceProvider
orionis.container.contracts.service_provider.IServiceProvider.html
Class
Class
PUBLIC
Define the contract for service provider implementations.
-
orionis.container.contracts.service_provider.IServiceProvider.register
orionis.container.contracts.service_provider.IServiceProvider.html#register
Function
Method
PUBLIC
Register services and components into the application container.
-
orionis.container.contracts.service_provider.IServiceProvider.boot
orionis.container.contracts.service_provider.IServiceProvider.html#boot
Function
Method
PUBLIC
Perform post-registration initialization tasks.
-
orionis.failure.entities.context._SECRET_KEYS
orionis.failure.entities.context.html#_SECRET_KEYS
Attribute
Constant
PUBLIC
Credential-like key fragments whose metadata values are redacted.
-
orionis.failure.entities.context._MAX_METADATA_FIELDS
orionis.failure.entities.context.html#_MAX_METADATA_FIELDS
Attribute
Constant
PUBLIC
Maximum scalar metadata entries retained by one failure context.
-
orionis.failure.contracts.handler.IBaseExceptionHandler
orionis.failure.contracts.handler.IBaseExceptionHandler.html
Class
Class
PUBLIC
Receive original failures and declared failed outcomes exactly once.
-
orionis.failure.contracts.handler.IBaseExceptionHandler.handleFailure
orionis.failure.contracts.handler.IBaseExceptionHandler.html#handleFailure
Function
Method
PUBLIC
Select deferred effects for the original exception.
-
orionis.failure.contracts.handler.IBaseExceptionHandler.handleResult
orionis.failure.contracts.handler.IBaseExceptionHandler.html#handleResult
Function
Method
PUBLIC
Select deferred effects for a declared failed result.
-
orionis.http.payload.estructures.cookies.Cookies
orionis.http.payload.estructures.cookies.Cookies.html
Class
Class
PUBLIC
Parse request cookies and expose their decoded values.
-
orionis.http.payload.estructures.cookies.Cookies.__slots__
orionis.http.payload.estructures.cookies.Cookies.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.http.payload.estructures.cookies.Cookies.__init__
orionis.http.payload.estructures.cookies.Cookies.html#__init__
Function
Method
PUBLIC
Initialize the Cookies object by parsing the Cookie header.
-
orionis.http.payload.estructures.cookies.Cookies._data
orionis.http.payload.estructures.cookies.Cookies.html#_data
Attribute
Instance Variable
PUBLIC
Decoded content carried by this message or request.
-
orionis.http.payload.estructures.cookies.Cookies.get
orionis.http.payload.estructures.cookies.Cookies.html#get
Function
Method
PUBLIC
Retrieve the value of a cookie by key.
-
orionis.http.payload.estructures.cookies.Cookies.getAll
orionis.http.payload.estructures.cookies.Cookies.html#getAll
Function
Method
PUBLIC
Return a copy of all cookies as a dictionary.
-
orionis.http.payload.estructures.cookies.Cookies.__getitem__
orionis.http.payload.estructures.cookies.Cookies.html#__getitem__
Function
Method
PUBLIC
Retrieve the value of a cookie by key using the indexing operator.
-
orionis.http.payload.estructures.cookies.Cookies.__contains__
orionis.http.payload.estructures.cookies.Cookies.html#__contains__
Function
Method
PUBLIC
Check if a cookie key exists in the container.
-
orionis.http.payload.estructures.cookies.Cookies.items
orionis.http.payload.estructures.cookies.Cookies.html#items
Function
Method
PUBLIC
Return a view of the cookie container's items.
-
orionis.http.payload.estructures.cookies.Cookies.keys
orionis.http.payload.estructures.cookies.Cookies.html#keys
Function
Method
PUBLIC
Return a view of the cookie container's keys.
-
orionis.http.payload.estructures.cookies.Cookies.values
orionis.http.payload.estructures.cookies.Cookies.html#values
Function
Method
PUBLIC
Return a view of the cookie container's values.
-
orionis.http.payload.estructures.cookies.Cookies.__iter__
orionis.http.payload.estructures.cookies.Cookies.html#__iter__
Function
Method
PUBLIC
Iterate over the cookie container's key-value pairs.
-
orionis.http.payload.estructures.cookies.Cookies.__len__
orionis.http.payload.estructures.cookies.Cookies.html#__len__
Function
Method
PUBLIC
Return the number of cookies in the container.
-
orionis.http.payload.estructures.cookies.Cookies.__repr__
orionis.http.payload.estructures.cookies.Cookies.html#__repr__
Function
Method
PUBLIC
Return the string representation of the Cookies object.
-
orionis.http.payload.estructures.query_params.QueryParams
orionis.http.payload.estructures.query_params.QueryParams.html
Class
Class
PUBLIC
Parse query-string pairs while preserving repeated parameter values.
-
orionis.http.payload.estructures.query_params.QueryParams.__slots__
orionis.http.payload.estructures.query_params.QueryParams.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.http.payload.estructures.query_params.QueryParams.__init__
orionis.http.payload.estructures.query_params.QueryParams.html#__init__
Function
Method
PUBLIC
Initialize QueryParams with a query string.
-
orionis.http.payload.estructures.query_params.QueryParams._items
orionis.http.payload.estructures.query_params.QueryParams.html#_items
Attribute
Instance Variable
PUBLIC
Parse the query string into an ordered list of key-value pairs.
-
orionis.http.payload.estructures.query_params.QueryParams._index
orionis.http.payload.estructures.query_params.QueryParams.html#_index
Attribute
Instance Variable
PUBLIC
Lookup index used to resolve registered entries.
-
orionis.http.payload.estructures.query_params.QueryParams.get
orionis.http.payload.estructures.query_params.QueryParams.html#get
Function
Method
PUBLIC
Retrieve the last value for a given key.
-
orionis.http.payload.estructures.query_params.QueryParams.getAll
orionis.http.payload.estructures.query_params.QueryParams.html#getAll
Function
Method
PUBLIC
Return every value for key in insertion order.
-
orionis.http.payload.estructures.query_params.QueryParams.getList
orionis.http.payload.estructures.query_params.QueryParams.html#getList
Function
Method
PUBLIC
Alias for getAll().
-
orionis.http.payload.estructures.query_params.QueryParams.multiItems
orionis.http.payload.estructures.query_params.QueryParams.html#multiItems
Function
Method
PUBLIC
Return all (key, value) pairs in insertion order.
-
orionis.http.payload.estructures.query_params.QueryParams.__contains__
orionis.http.payload.estructures.query_params.QueryParams.html#__contains__
Function
Method
PUBLIC
Check if the key exists in the query parameters.
-
orionis.http.payload.estructures.query_params.QueryParams.__getitem__
orionis.http.payload.estructures.query_params.QueryParams.html#__getitem__
Function
Method
PUBLIC
Retrieve the last value for a given key or raise KeyError.
-
orionis.http.payload.estructures.query_params.QueryParams.items
orionis.http.payload.estructures.query_params.QueryParams.html#items
Function
Method
PUBLIC
Return all key-value pairs as a list.
-
orionis.http.payload.estructures.query_params.QueryParams.keys
orionis.http.payload.estructures.query_params.QueryParams.html#keys
Function
Method
PUBLIC
Return all keys in the query parameters.
-
orionis.http.payload.estructures.query_params.QueryParams.values
orionis.http.payload.estructures.query_params.QueryParams.html#values
Function
Method
PUBLIC
Return all values in the query parameters.
-
orionis.http.payload.estructures.query_params.QueryParams.__iter__
orionis.http.payload.estructures.query_params.QueryParams.html#__iter__
Function
Method
PUBLIC
Return an iterator over the key-value pairs.
-
orionis.http.payload.estructures.query_params.QueryParams.__len__
orionis.http.payload.estructures.query_params.QueryParams.html#__len__
Function
Method
PUBLIC
Return the number of key-value pairs.
-
orionis.http.payload.estructures.query_params.QueryParams.__repr__
orionis.http.payload.estructures.query_params.QueryParams.html#__repr__
Function
Method
PUBLIC
Return the string representation of the QueryParams object.
-
orionis.http.payload.contracts.uploaded_file.IUploadedFile
orionis.http.payload.contracts.uploaded_file.IUploadedFile.html
Class
Class
PUBLIC
Define the contract for an uploaded file held in memory or on disk.
-
orionis.http.payload.contracts.uploaded_file.IUploadedFile.__slots__
orionis.http.payload.contracts.uploaded_file.IUploadedFile.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.http.payload.contracts.uploaded_file.IUploadedFile.size
orionis.http.payload.contracts.uploaded_file.IUploadedFile.html#size
Attribute
Property
PUBLIC
Return the total number of bytes written so far.
-
orionis.http.payload.contracts.uploaded_file.IUploadedFile.extension
orionis.http.payload.contracts.uploaded_file.IUploadedFile.html#extension
Attribute
Property
PUBLIC
Return the file extension derived from filename, in lowercase.
-
orionis.http.payload.contracts.uploaded_file.IUploadedFile.write
orionis.http.payload.contracts.uploaded_file.IUploadedFile.html#write
Function
Method
PUBLIC
Append chunk to the file buffer.
-
orionis.http.payload.contracts.uploaded_file.IUploadedFile.read
orionis.http.payload.contracts.uploaded_file.IUploadedFile.html#read
Function
Method
PUBLIC
Read the entire file content from the beginning.
-
orionis.http.payload.contracts.uploaded_file.IUploadedFile.chunks
orionis.http.payload.contracts.uploaded_file.IUploadedFile.html#chunks
Function
Method
PUBLIC
Iterate over the file content in fixed-size chunks.
-
orionis.http.payload.contracts.uploaded_file.IUploadedFile.replace
orionis.http.payload.contracts.uploaded_file.IUploadedFile.html#replace
Function
Method
PUBLIC
Replace the file content with data and update the byte counter.
-
orionis.http.payload.contracts.uploaded_file.IUploadedFile.save
orionis.http.payload.contracts.uploaded_file.IUploadedFile.html#save
Function
Method
PUBLIC
Write the file contents to path on the local filesystem.
-
orionis.http.payload.contracts.uploaded_file.IUploadedFile.close
orionis.http.payload.contracts.uploaded_file.IUploadedFile.html#close
Function
Method
PUBLIC
Close the file handle and release all associated resources.
-
orionis.http.payload.uploaded_file._UNSAFE_FILENAME_RE
orionis.http.payload.uploaded_file.html#_UNSAFE_FILENAME_RE
Attribute
Constant
PUBLIC
Forbidden filename characters on POSIX and Windows systems.
-
orionis.http.payload.uploaded_file._DOTFILE_RE
orionis.http.payload.uploaded_file.html#_DOTFILE_RE
Attribute
Constant
PUBLIC
Pattern to detect dotfiles and path-traversal prefixes.
-
orionis.http.payload.uploaded_file._CHUNK_SIZE
orionis.http.payload.uploaded_file.html#_CHUNK_SIZE
Attribute
Constant
PUBLIC
Maximum chunk size for streaming file saves to disk (64 KiB).
-
orionis.http.payload.uploaded_file.UploadedFile
orionis.http.payload.uploaded_file.UploadedFile.html
Class
Class
PUBLIC
Hold an uploaded file in memory or spill it to a temporary file on disk.
-
orionis.http.payload.uploaded_file.UploadedFile.filename
orionis.http.payload.uploaded_file.UploadedFile.html#filename
Attribute
Instance Variable
PUBLIC
Original name of the uploaded file as reported by the client.
-
orionis.http.payload.uploaded_file.UploadedFile.content_type
orionis.http.payload.uploaded_file.UploadedFile.html#content_type
Attribute
Instance Variable
PUBLIC
MIME type declared by the client, or None if absent.
-
orionis.http.payload.uploaded_file.UploadedFile.__slots__
orionis.http.payload.uploaded_file.UploadedFile.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.http.payload.uploaded_file.UploadedFile.__init__
orionis.http.payload.uploaded_file.UploadedFile.html#__init__
Function
Method
PUBLIC
Initialize a new UploadedFile for an incoming multipart part.
-
orionis.http.payload.uploaded_file.UploadedFile._size
orionis.http.payload.uploaded_file.UploadedFile.html#_size
Attribute
Instance Variable
PUBLIC
Size value used by UploadedFile.
-
orionis.http.payload.uploaded_file.UploadedFile._memory_threshold
orionis.http.payload.uploaded_file.UploadedFile.html#_memory_threshold
Attribute
Instance Variable
PUBLIC
Maximum in-memory bytes before spilling to disk (default 1 MiB).
-
orionis.http.payload.uploaded_file.UploadedFile._rolled
orionis.http.payload.uploaded_file.UploadedFile.html#_rolled
Attribute
Instance Variable
PUBLIC
Rolled flag used by UploadedFile.
-
orionis.http.payload.uploaded_file.UploadedFile._file
orionis.http.payload.uploaded_file.UploadedFile.html#_file
Attribute
Instance Variable
PUBLIC
SpooledTemporaryFile spills to disk once memory_threshold is exceeded.
-
orionis.http.payload.uploaded_file.UploadedFile._extension
orionis.http.payload.uploaded_file.UploadedFile.html#_extension
Attribute
Instance Variable
PUBLIC
Normalized extension derived from the uploaded filename.
-
orionis.http.payload.uploaded_file.UploadedFile._sanitizeFilename
orionis.http.payload.uploaded_file.UploadedFile.html#_sanitizeFilename
Function
Static Method
PUBLIC
Return a safe version of filename suitable for use on the filesystem.
-
orionis.http.payload.uploaded_file.UploadedFile.requiresDiskWrite
orionis.http.payload.uploaded_file.UploadedFile.html#requiresDiskWrite
Function
Method
PUBLIC
Determine whether the next write spills to the backing disk file.
-
orionis.http.payload.uploaded_file.UploadedFile.write
orionis.http.payload.uploaded_file.UploadedFile.html#write
Function
Method
PUBLIC
Append chunk to the file buffer.
-
orionis.http.payload.uploaded_file.UploadedFile.size
orionis.http.payload.uploaded_file.UploadedFile.html#size
Attribute
Property
PUBLIC
Return the total number of bytes written so far.
-
orionis.http.payload.uploaded_file.UploadedFile.extension
orionis.http.payload.uploaded_file.UploadedFile.html#extension
Attribute
Property
PUBLIC
Return the file extension derived from filename, in lowercase.
-
orionis.http.payload.uploaded_file.UploadedFile.read
orionis.http.payload.uploaded_file.UploadedFile.html#read
Function
Method
PUBLIC
Read the entire file content from the beginning.
-
orionis.http.payload.uploaded_file.UploadedFile.chunks
orionis.http.payload.uploaded_file.UploadedFile.html#chunks
Function
Method
PUBLIC
Iterate over the file content in fixed-size chunks.
-
orionis.http.payload.uploaded_file.UploadedFile.replace
orionis.http.payload.uploaded_file.UploadedFile.html#replace
Function
Method
PUBLIC
Replace the file content with data and update the byte counter.
-
orionis.http.payload.uploaded_file.UploadedFile.save
orionis.http.payload.uploaded_file.UploadedFile.html#save
Function
Method
PUBLIC
Write the file contents to path on the local filesystem.
-
orionis.http.payload.uploaded_file.UploadedFile.close
orionis.http.payload.uploaded_file.UploadedFile.html#close
Function
Method
PUBLIC
Close the file handle and release all associated resources.
-
orionis.http.payload.uploaded_file.UploadedFile.__del__
orionis.http.payload.uploaded_file.UploadedFile.html#__del__
Function
Method
PUBLIC
Release resources when the object is garbage collected.
-
orionis.http.payload.contracts.form_data.IFormData
orionis.http.payload.contracts.form_data.IFormData.html
Class
Class
PUBLIC
Define the contract for parsed multipart form data.
-
orionis.http.payload.contracts.form_data.IFormData.__slots__
orionis.http.payload.contracts.form_data.IFormData.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.http.payload.contracts.form_data.IFormData.fields
orionis.http.payload.contracts.form_data.IFormData.html#fields
Attribute
Property
PUBLIC
Return all text field values grouped by name.
-
orionis.http.payload.contracts.form_data.IFormData.files
orionis.http.payload.contracts.form_data.IFormData.html#files
Attribute
Property
PUBLIC
Return all uploaded file values grouped by name.
-
orionis.http.payload.contracts.form_data.IFormData.allItems
orionis.http.payload.contracts.form_data.IFormData.html#allItems
Attribute
Property
PUBLIC
Return all (name, value) pairs in insertion order.
-
orionis.http.payload.contracts.form_data.IFormData.get
orionis.http.payload.contracts.form_data.IFormData.html#get
Function
Method
PUBLIC
Return the last value for key, or default.
-
orionis.http.payload.contracts.form_data.IFormData.getAll
orionis.http.payload.contracts.form_data.IFormData.html#getAll
Function
Method
PUBLIC
Return every value for key in insertion order.
-
orionis.http.payload.contracts.form_data.IFormData.multiItems
orionis.http.payload.contracts.form_data.IFormData.html#multiItems
Function
Method
PUBLIC
Return all (name, value) pairs in insertion order.
-
orionis.http.payload.contracts.form_data.IFormData.close
orionis.http.payload.contracts.form_data.IFormData.html#close
Function
Method
PUBLIC
Close all uploaded file handles to release resources.
-
orionis.http.payload.contracts.form_data.IFormData.__getitem__
orionis.http.payload.contracts.form_data.IFormData.html#__getitem__
Function
Method
PUBLIC
Return the last value for key using subscript notation.
-
orionis.http.payload.contracts.form_data.IFormData.__contains__
orionis.http.payload.contracts.form_data.IFormData.html#__contains__
Function
Method
PUBLIC
Return True if at least one item with key exists.
-
orionis.http.payload.contracts.form_data.IFormData.__iter__
orionis.http.payload.contracts.form_data.IFormData.html#__iter__
Function
Method
PUBLIC
Iterate over unique field names in first-seen insertion order.
-
orionis.http.payload.contracts.form_data.IFormData.__len__
orionis.http.payload.contracts.form_data.IFormData.html#__len__
Function
Method
PUBLIC
Return the number of unique field names.
-
orionis.http.payload.contracts.form_data.IFormData.__repr__
orionis.http.payload.contracts.form_data.IFormData.html#__repr__
Function
Method
PUBLIC
Return the canonical string representation.
-
orionis.http.payload.contracts.form_data.IFormData.__enter__
orionis.http.payload.contracts.form_data.IFormData.html#__enter__
Function
Method
PUBLIC
Enter the context manager and return this instance.
-
orionis.http.payload.contracts.form_data.IFormData.__exit__
orionis.http.payload.contracts.form_data.IFormData.html#__exit__
Function
Method
PUBLIC
Exit the context manager and close all uploaded file handles.
-
orionis.http.payload.form_data.FormData
orionis.http.payload.form_data.FormData.html
Class
Class
PUBLIC
Hold parsed multipart form fields and uploaded files.
-
orionis.http.payload.form_data.FormData.__slots__
orionis.http.payload.form_data.FormData.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.http.payload.form_data.FormData.__init__
orionis.http.payload.form_data.FormData.html#__init__
Function
Method
PUBLIC
Initialize FormData from an ordered list of (name, value) pairs.
-
orionis.http.payload.form_data.FormData._items
orionis.http.payload.form_data.FormData.html#_items
Attribute
Instance Variable
PUBLIC
Ordered (field_name, value) pairs from the multipart stream parser. Multiple pairs with the same name are preserved in insertion order.
-
orionis.http.payload.form_data.FormData._index
orionis.http.payload.form_data.FormData.html#_index
Attribute
Instance Variable
PUBLIC
Lookup index used to resolve registered entries.
-
orionis.http.payload.form_data.FormData.fields
orionis.http.payload.form_data.FormData.html#fields
Attribute
Property
PUBLIC
Return all text field values grouped by name.
-
orionis.http.payload.form_data.FormData.files
orionis.http.payload.form_data.FormData.html#files
Attribute
Property
PUBLIC
Return all uploaded file values grouped by name.
-
orionis.http.payload.form_data.FormData.get
orionis.http.payload.form_data.FormData.html#get
Function
Method
PUBLIC
Return the last value for key, or default.
-
orionis.http.payload.form_data.FormData.getAll
orionis.http.payload.form_data.FormData.html#getAll
Function
Method
PUBLIC
Return every value for key in insertion order.
-
orionis.http.payload.form_data.FormData.allItems
orionis.http.payload.form_data.FormData.html#allItems
Attribute
Property
PUBLIC
Return all (name, value) pairs in insertion order.
-
orionis.http.payload.form_data.FormData.multiItems
orionis.http.payload.form_data.FormData.html#multiItems
Function
Method
PUBLIC
Return all (name, value) pairs in insertion order.
-
orionis.http.payload.form_data.FormData.__getitem__
orionis.http.payload.form_data.FormData.html#__getitem__
Function
Method
PUBLIC
Return the last value for key using subscript notation.
-
orionis.http.payload.form_data.FormData.__contains__
orionis.http.payload.form_data.FormData.html#__contains__
Function
Method
PUBLIC
Return True if at least one item with key exists.
-
orionis.http.payload.form_data.FormData.__iter__
orionis.http.payload.form_data.FormData.html#__iter__
Function
Method
PUBLIC
Iterate over unique field names in first-seen insertion order.
-
orionis.http.payload.form_data.FormData.__len__
orionis.http.payload.form_data.FormData.html#__len__
Function
Method
PUBLIC
Return the number of unique field names.
-
orionis.http.payload.form_data.FormData.__repr__
orionis.http.payload.form_data.FormData.html#__repr__
Function
Method
PUBLIC
Return the canonical string representation.
-
orionis.http.payload.form_data.FormData.close
orionis.http.payload.form_data.FormData.html#close
Function
Method
PUBLIC
Close all uploaded file handles to release resources.
-
orionis.http.payload.form_data.FormData.__enter__
orionis.http.payload.form_data.FormData.html#__enter__
Function
Method
PUBLIC
Enter the context manager and return this instance.
-
orionis.http.payload.form_data.FormData.__exit__
orionis.http.payload.form_data.FormData.html#__exit__
Function
Method
PUBLIC
Exit the context manager and close all uploaded file handles.
-
orionis.http.contracts.request.IRequest
orionis.http.contracts.request.IRequest.html
Class
Class
PUBLIC
Define the contract for request implementations.
-
orionis.http.contracts.request.IRequest.__slots__
orionis.http.contracts.request.IRequest.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.http.contracts.request.IRequest.close
orionis.http.contracts.request.IRequest.html#close
Function
Method
PUBLIC
Close request-owned uploaded file handles after response delivery.
-
orionis.http.contracts.request.IRequest.url
orionis.http.contracts.request.IRequest.html#url
Attribute
Property
PUBLIC
Return the full request URL.
-
orionis.http.contracts.request.IRequest.baseUrl
orionis.http.contracts.request.IRequest.html#baseUrl
Attribute
Property
PUBLIC
Return the base URL for the request.
-
orionis.http.contracts.request.IRequest.queryParams
orionis.http.contracts.request.IRequest.html#queryParams
Attribute
Property
PUBLIC
Return parsed query parameters from the request.
-
orionis.http.contracts.request.IRequest.cookies
orionis.http.contracts.request.IRequest.html#cookies
Attribute
Property
PUBLIC
Return parsed cookies from the request.
-
orionis.http.contracts.request.IRequest.ip
orionis.http.contracts.request.IRequest.html#ip
Attribute
Property
PUBLIC
Return the client's IP address from the request scope.
-
orionis.http.contracts.request.IRequest.port
orionis.http.contracts.request.IRequest.html#port
Attribute
Property
PUBLIC
Return the client's port number from the request scope.
-
orionis.http.contracts.request.IRequest.forwarded
orionis.http.contracts.request.IRequest.html#forwarded
Attribute
Property
PUBLIC
Return the forwarded information from the request scope.
-
orionis.http.contracts.request.IRequest.method
orionis.http.contracts.request.IRequest.html#method
Attribute
Property
PUBLIC
Return the HTTP request method.
-
orionis.http.contracts.request.IRequest.scheme
orionis.http.contracts.request.IRequest.html#scheme
Attribute
Property
PUBLIC
Return the URL scheme (e.g., 'http' or 'https') of the request.
-
orionis.http.contracts.request.IRequest.path
orionis.http.contracts.request.IRequest.html#path
Attribute
Property
PUBLIC
Return the request path.
-
orionis.http.contracts.request.IRequest.interface
orionis.http.contracts.request.IRequest.html#interface
Attribute
Property
PUBLIC
Return the interface type of the request (ASGI or RSGI).
-
orionis.http.contracts.request.IRequest.httpVersion
orionis.http.contracts.request.IRequest.html#httpVersion
Attribute
Property
PUBLIC
Return the HTTP version of the request.
-
orionis.http.contracts.request.IRequest.userAgent
orionis.http.contracts.request.IRequest.html#userAgent
Attribute
Property
PUBLIC
Return the User-Agent string from the request headers.
-
orionis.http.contracts.request.IRequest.apiKey
orionis.http.contracts.request.IRequest.html#apiKey
Attribute
Property
PUBLIC
Return the API key from the request headers if present.
-
orionis.http.contracts.request.IRequest.bearerToken
orionis.http.contracts.request.IRequest.html#bearerToken
Attribute
Property
PUBLIC
Return the bearer token from the Authorization header if present.
-
orionis.http.contracts.request.IRequest.authorization
orionis.http.contracts.request.IRequest.html#authorization
Attribute
Property
PUBLIC
Return the Authorization header value if present.
-
orionis.http.contracts.request.IRequest.accept
orionis.http.contracts.request.IRequest.html#accept
Attribute
Property
PUBLIC
Return the value of the Accept header.
-
orionis.http.contracts.request.IRequest.wantsJson
orionis.http.contracts.request.IRequest.html#wantsJson
Function
Method
PUBLIC
Determine if the client prefers a JSON response based on the Accept header.
-
orionis.http.contracts.request.IRequest.accepts
orionis.http.contracts.request.IRequest.html#accepts
Function
Method
PUBLIC
Check if the client accepts a specific MIME type.
-
orionis.http.contracts.request.IRequest.isAjax
orionis.http.contracts.request.IRequest.html#isAjax
Function
Method
PUBLIC
Determine if the request was made via AJAX.
-
orionis.http.contracts.request.IRequest.wantsHtml
orionis.http.contracts.request.IRequest.html#wantsHtml
Function
Method
PUBLIC
Determine if the client expects an HTML response based on the Accept header.
-
orionis.http.contracts.request.IRequest.wantsXml
orionis.http.contracts.request.IRequest.html#wantsXml
Function
Method
PUBLIC
Determine if the client prefers an XML response based on the Accept header.
-
orionis.http.contracts.request.IRequest.stream
orionis.http.contracts.request.IRequest.html#stream
Function
Method
PUBLIC
Yield chunks of the request body as they arrive.
-
orionis.http.contracts.request.IRequest.body
orionis.http.contracts.request.IRequest.html#body
Function
Method
PUBLIC
Return the full request body as bytes.
-
orionis.http.contracts.request.IRequest.json
orionis.http.contracts.request.IRequest.html#json
Function
Method
PUBLIC
Parse the request body as JSON.
-
orionis.http.contracts.request.IRequest.payload
orionis.http.contracts.request.IRequest.html#payload
Function
Method
PUBLIC
Parse and return structured request data based on Content-Type.
-
orionis.http.contracts.request.IRequest.formUrlEncoded
orionis.http.contracts.request.IRequest.html#formUrlEncoded
Function
Method
PUBLIC
Parse the request body as URL-encoded form data.
-
orionis.http.contracts.request.IRequest.raw
orionis.http.contracts.request.IRequest.html#raw
Function
Method
PUBLIC
Return the request body as raw bytes.
-
orionis.http.contracts.request.IRequest.text
orionis.http.contracts.request.IRequest.html#text
Function
Method
PUBLIC
Decode the request body as UTF-8 text.
-
orionis.http.contracts.request.IRequest.xml
orionis.http.contracts.request.IRequest.html#xml
Function
Method
PUBLIC
Parse the request body as XML and return the root element.
-
orionis.http.contracts.request.IRequest.msgpack
orionis.http.contracts.request.IRequest.html#msgpack
Function
Method
PUBLIC
Decode the request body as MessagePack.
-
orionis.http.contracts.request.IRequest.form
orionis.http.contracts.request.IRequest.html#form
Function
Method
PUBLIC
Parse and return multipart form data.
-
orionis.http.contracts.request.IRequest.data
orionis.http.contracts.request.IRequest.html#data
Function
Method
PUBLIC
Return a flat, validatable dictionary built from the request body.
-
orionis.http.contracts.request.IRequest.state
orionis.http.contracts.request.IRequest.html#state
Attribute
Property
PUBLIC
Return the mutable per-request state namespace.
-
orionis.http.contracts.request.IRequest.scope
orionis.http.contracts.request.IRequest.html#scope
Attribute
Property
PUBLIC
Return the raw ASGI / RSGI connection scope.
-
orionis.http.contracts.request.IRequest.routeParam
orionis.http.contracts.request.IRequest.html#routeParam
Function
Method
PUBLIC
Return a specific path parameter by key.
-
orionis.http.contracts.request.IRequest.routeParams
orionis.http.contracts.request.IRequest.html#routeParams
Function
Method
PUBLIC
Return all path parameters as a dictionary.
-
orionis.http.contracts.request.IRequest.csrfToken
orionis.http.contracts.request.IRequest.html#csrfToken
Function
Method
PUBLIC
Return the CSRF token for the current request.
-
orionis.http.contracts.request.IRequest.csrf_token
orionis.http.contracts.request.IRequest.html#csrf_token
Attribute
Class Variable
PUBLIC
Template-facing attribute shares the camelCase contract.
-
orionis.http.payload.contracts.body_stream.IBodyStream
orionis.http.payload.contracts.body_stream.IBodyStream.html
Class
Class
PUBLIC
Define the minimal contract for reading an HTTP request body.
-
orionis.http.payload.contracts.body_stream.IBodyStream.__slots__
orionis.http.payload.contracts.body_stream.IBodyStream.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.http.payload.contracts.body_stream.IBodyStream.isBuffered
orionis.http.payload.contracts.body_stream.IBodyStream.html#isBuffered
Attribute
Property
PUBLIC
Return True when the full body has been cached by read().
-
orionis.http.payload.contracts.body_stream.IBodyStream.isConsumed
orionis.http.payload.contracts.body_stream.IBodyStream.html#isConsumed
Attribute
Property
PUBLIC
Return True when the raw transport stream has been consumed.
-
orionis.http.payload.contracts.body_stream.IBodyStream.stream
orionis.http.payload.contracts.body_stream.IBodyStream.html#stream
Function
Method
PUBLIC
Yield successive byte chunks from the request body.
-
orionis.http.payload.contracts.body_stream.IBodyStream.read
orionis.http.payload.contracts.body_stream.IBodyStream.html#read
Function
Method
PUBLIC
Buffer and return the full request body. Idempotent.
-
orionis.http.payload.body._DEFAULT_LIMITS
orionis.http.payload.body.html#_DEFAULT_LIMITS
Attribute
Constant
PUBLIC
Default limits used by body.
-
orionis.http.payload.body.PayloadTooLargeException
orionis.http.payload.body.PayloadTooLargeException.html
Class
Exception
PUBLIC
Raise when the request body exceeds the configured size limit.
-
orionis.http.payload.body.BodyStream
orionis.http.payload.body.BodyStream.html
Class
Class
PUBLIC
Own and manage the raw HTTP request body stream.
-
orionis.http.payload.body.BodyStream.__slots__
orionis.http.payload.body.BodyStream.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.http.payload.body.BodyStream.__init__
orionis.http.payload.body.BodyStream.html#__init__
Function
Method
PUBLIC
Initialize a BodyStream for the given transport interface.
-
orionis.http.payload.body.BodyStream.__body
orionis.http.payload.body.BodyStream.html#__body
Attribute
Instance Variable
PUBLIC
Initialize the body buffer to None (not yet read).
-
orionis.http.payload.body.BodyStream.__consumed
orionis.http.payload.body.BodyStream.html#__consumed
Attribute
Instance Variable
PUBLIC
Track whether the raw transport stream has been consumed.
-
orionis.http.payload.body.BodyStream.__is_rsgi
orionis.http.payload.body.BodyStream.html#__is_rsgi
Attribute
Instance Variable
PUBLIC
Record which transport provides the body chunks.
-
orionis.http.payload.body.BodyStream.__max_size
orionis.http.payload.body.BodyStream.html#__max_size
Attribute
Instance Variable
PUBLIC
Maximum allowed body size in bytes (default 16 MiB). An explicit None disables the transport limit for a manually built stream.
-
orionis.http.payload.body.BodyStream.__max_buffer_size
orionis.http.payload.body.BodyStream.html#__max_buffer_size
Attribute
Instance Variable
PUBLIC
Maximum bytes buffered by read() (default 2 MiB). An explicit None disables this limit for a manually built stream.
-
orionis.http.payload.body.BodyStream.__receive
orionis.http.payload.body.BodyStream.html#__receive
Attribute
Instance Variable
PUBLIC
ASGI receive callable or RSGI HTTPProtocol instance.
-
orionis.http.payload.body.BodyStream.isBuffered
orionis.http.payload.body.BodyStream.html#isBuffered
Attribute
Property
PUBLIC
Return True when the full body has been cached by read().
-
orionis.http.payload.body.BodyStream.isConsumed
orionis.http.payload.body.BodyStream.html#isConsumed
Attribute
Property
PUBLIC
Return True when the raw transport stream has been consumed.
-
orionis.http.payload.body.BodyStream.stream
orionis.http.payload.body.BodyStream.html#stream
Function
Method
PUBLIC
Yield body chunks from the transport.
-
orionis.http.payload.body.BodyStream.read
orionis.http.payload.body.BodyStream.html#read
Function
Method
PUBLIC
Buffer and return the full request body. Idempotent.
-
orionis.http.payload.contracts.media_types.BodyParser
orionis.http.payload.contracts.media_types.html#BodyParser
Attribute
Type Alias
PUBLIC
Special type alias for synchronous body parsers.
-
orionis.http.payload.contracts.media_types.IMediaTypeRegistry
orionis.http.payload.contracts.media_types.IMediaTypeRegistry.html
Class
Class
PUBLIC
Define the contract for a media-type-to-parser registry.
-
orionis.http.payload.contracts.media_types.IMediaTypeRegistry.__slots__
orionis.http.payload.contracts.media_types.IMediaTypeRegistry.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.http.payload.contracts.media_types.IMediaTypeRegistry.register
orionis.http.payload.contracts.media_types.IMediaTypeRegistry.html#register
Function
Method
PUBLIC
Add or replace the parser for media_type in place.
-
orionis.http.payload.contracts.media_types.IMediaTypeRegistry.get
orionis.http.payload.contracts.media_types.IMediaTypeRegistry.html#get
Function
Method
PUBLIC
Return the parser registered for media_type, or None.
-
orionis.http.payload.contracts.media_types.IMediaTypeRegistry.extend
orionis.http.payload.contracts.media_types.IMediaTypeRegistry.html#extend
Function
Method
PUBLIC
Return a new registry that merges parsers over a copy of self.
-
orionis.http.payload.parsers.parse_content_type
orionis.http.payload.parsers.html#parse_content_type
Function
Function
PUBLIC
Parse a Content-Type header into a media-type and parameter dict.
-
orionis.http.payload.parsers.parse_json
orionis.http.payload.parsers.html#parse_json
Function
Function
PUBLIC
Decode a JSON payload using msgspec.
-
orionis.http.payload.parsers.parse_msgpack
orionis.http.payload.parsers.html#parse_msgpack
Function
Function
PUBLIC
Decode a MessagePack payload using msgspec.
-
orionis.http.payload.parsers.parse_urlencoded
orionis.http.payload.parsers.html#parse_urlencoded
Function
Function
PUBLIC
Decode an application/x-www-form-urlencoded payload.
-
orionis.http.payload.parsers.parse_urlencoded_multi
orionis.http.payload.parsers.html#parse_urlencoded_multi
Function
Function
PUBLIC
Decode a URL-encoded payload, preserving duplicate-key semantics.
-
orionis.http.payload.parsers.parse_xml
orionis.http.payload.parsers.html#parse_xml
Function
Function
PUBLIC
Parse an XML payload with entity declarations disabled.
-
orionis.http.payload.parsers.parse_text
orionis.http.payload.parsers.html#parse_text
Function
Function
PUBLIC
Decode a UTF-8 text payload.
-
orionis.http.payload.parsers.parse_binary
orionis.http.payload.parsers.html#parse_binary
Function
Function
PUBLIC
Return a binary payload unchanged.
-
orionis.http.payload.media_types.BodyParser
orionis.http.payload.media_types.html#BodyParser
Attribute
Type Alias
PUBLIC
Special type alias for synchronous body parsers that take a bytes payload and return a parsed object.
-
orionis.http.payload.media_types.MediaTypeRegistry
orionis.http.payload.media_types.MediaTypeRegistry.html
Class
Class
PUBLIC
Map lowercased media-type strings to synchronous BodyParser callables.
-
orionis.http.payload.media_types.MediaTypeRegistry.__slots__
orionis.http.payload.media_types.MediaTypeRegistry.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.http.payload.media_types.MediaTypeRegistry.__init__
orionis.http.payload.media_types.MediaTypeRegistry.html#__init__
Function
Method
PUBLIC
Initialise the registry with an optional media-type mapping.
-
orionis.http.payload.media_types.MediaTypeRegistry._parsers
orionis.http.payload.media_types.MediaTypeRegistry.html#_parsers
Attribute
Instance Variable
PUBLIC
Initial media-type-to-parser mapping. Keys are lowercased on ingestion. Pass None to start with an empty registry.
-
orionis.http.payload.media_types.MediaTypeRegistry.register
orionis.http.payload.media_types.MediaTypeRegistry.html#register
Function
Method
PUBLIC
Add or replace the parser for media_type in place.
-
orionis.http.payload.media_types.MediaTypeRegistry.get
orionis.http.payload.media_types.MediaTypeRegistry.html#get
Function
Method
PUBLIC
Return the parser registered for media_type, or None.
-
orionis.http.payload.media_types.MediaTypeRegistry.extend
orionis.http.payload.media_types.MediaTypeRegistry.html#extend
Function
Method
PUBLIC
Return a new registry that merges parsers over a copy of self.
-
orionis.http.payload.media_types.DEFAULT_MEDIA_TYPES
orionis.http.payload.media_types.html#DEFAULT_MEDIA_TYPES
Attribute
Constant
PUBLIC
Pre-built registry covering the most common HTTP content types.
-
orionis.failure.runtime._CONTROL_EXCEPTIONS
orionis.failure.runtime.html#_CONTROL_EXCEPTIONS
Attribute
Constant
PUBLIC
Control-flow signals excluded from application failure reporting.
-
orionis.failure.runtime._current
orionis.failure.runtime.html#_current
Attribute
Variable
PUBLIC
Current operation carrying the application-local incident ledger.
-
orionis.failure.runtime._reporting
orionis.failure.runtime.html#_reporting
Attribute
Variable
PUBLIC
Runtime executing reporting effects, used to prevent recursive delivery.
-
orionis.failure.runtime._emergency
orionis.failure.runtime.html#_emergency
Function
Function
PUBLIC
Write fallback diagnostics without exposing exception messages.
-
orionis.failure.runtime._cancellation_checkpoint
orionis.failure.runtime.html#_cancellation_checkpoint
Function
Function
PUBLIC
Deliver pending caller cancellation before entering a protected reporter.
-
orionis.failure.runtime._find_runtime
orionis.failure.runtime.html#_find_runtime
Function
Function
PUBLIC
Find an owned runtime without resolving a global facade.
-
orionis.failure.runtime.get_runtime
orionis.failure.runtime.html#get_runtime
Function
Function
PUBLIC
Return the active runtime for an application or current operation.
-
orionis.failure.runtime._handler_dependencies
orionis.failure.runtime.html#_handler_dependencies
Function
Function
PUBLIC
Detach request and operation scopes while resolving shared handlers.
-
orionis.failure.runtime._Incident
orionis.failure.runtime._Incident.html
Class
Class
PUBLIC
Keep deferred effects and their completion inside an operation ledger.
-
orionis.failure.runtime._Incident.__slots__
orionis.failure.runtime._Incident.html#__slots__
Attribute
Class Variable
PUBLIC
Incident fields retained only for the owning operation's lifetime.
-
orionis.failure.runtime._Incident.__init__
orionis.failure.runtime._Incident.html#__init__
Function
Method
PUBLIC
Initialize an incident with its original exception and delivery status.
-
orionis.failure.runtime._Incident.exception
orionis.failure.runtime._Incident.html#exception
Attribute
Instance Variable
PUBLIC
Original exception used for incident identity and native traceback.
-
orionis.failure.runtime._Incident.receipt
orionis.failure.runtime._Incident.html#receipt
Attribute
Instance Variable
PUBLIC
Immutable delivery status shared by duplicate notifications.
-
orionis.failure.runtime._Incident.context
orionis.failure.runtime._Incident.html#context
Attribute
Instance Variable
PUBLIC
Metadata supplied to the hook when delivery starts.
-
orionis.failure.runtime._Incident.handling
orionis.failure.runtime._Incident.html#handling
Attribute
Instance Variable
PUBLIC
Selected deferred effects shared by incident consumers.
-
orionis.failure.runtime._Incident.ready
orionis.failure.runtime._Incident.html#ready
Attribute
Instance Variable
PUBLIC
Thread-safe completion notice without an exception-valued result.
-
orionis.failure.runtime._Incident.started
orionis.failure.runtime._Incident.html#started
Attribute
Instance Variable
PUBLIC
Whether delivery has started and may already have performed effects.
-
orionis.failure.runtime._Incident.abandoned
orionis.failure.runtime._Incident.html#abandoned
Attribute
Instance Variable
PUBLIC
Whether delivery was cancelled before starting and can be reclaimed.
-
orionis.failure.runtime._Incident.abandon
orionis.failure.runtime._Incident.html#abandon
Function
Method
PUBLIC
Mark unstarted delivery as abandoned and notify waiting owners.
-
orionis.failure.runtime._Incident.reclaim
orionis.failure.runtime._Incident.html#reclaim
Function
Method
PUBLIC
Reset an abandoned incident for another delivery attempt.
-
orionis.failure.runtime._Incident.finish
orionis.failure.runtime._Incident.html#finish
Function
Method
PUBLIC
Store the selected handling plan and notify incident waiters.
-
orionis.failure.runtime._Incident.wait
orionis.failure.runtime._Incident.html#wait
Function
Method
PUBLIC
Await incident completion without cancelling its delivery.
-
orionis.failure.runtime._Operation
orionis.failure.runtime._Operation.html
Class
Class
PUBLIC
Own an error-only ledger for one execution and its nested boundaries.
-
orionis.failure.runtime._Operation.__slots__
orionis.failure.runtime._Operation.html#__slots__
Attribute
Class Variable
PUBLIC
Bounded operation state with lazy allocation of its incident ledger.
-
orionis.failure.runtime._Operation.__init__
orionis.failure.runtime._Operation.html#__init__
Function
Method
PUBLIC
Initialize operation metadata and select its ledger owner.
-
orionis.failure.runtime._Operation.runtime
orionis.failure.runtime._Operation.html#runtime
Attribute
Instance Variable
PUBLIC
Application coordinator associated with this execution boundary.
-
orionis.failure.runtime._Operation.flow
orionis.failure.runtime._Operation.html#flow
Attribute
Instance Variable
PUBLIC
Execution flow used to enrich incident metadata.
-
orionis.failure.runtime._Operation.name
orionis.failure.runtime._Operation.html#name
Attribute
Instance Variable
PUBLIC
Logical operation name supplied by its owner.
-
orionis.failure.runtime._Operation.correlation_id
orionis.failure.runtime._Operation.html#correlation_id
Attribute
Instance Variable
PUBLIC
Correlation identifier allocated lazily when an incident occurs.
-
orionis.failure.runtime._Operation.parent
orionis.failure.runtime._Operation.html#parent
Attribute
Instance Variable
PUBLIC
Live enclosing operation belonging to the same runtime, if any.
-
orionis.failure.runtime._Operation.owns
orionis.failure.runtime._Operation.html#owns
Attribute
Instance Variable
PUBLIC
Whether this boundary owns and releases an independent ledger.
-
orionis.failure.runtime._Operation.ledger
orionis.failure.runtime._Operation.html#ledger
Attribute
Instance Variable
PUBLIC
Incident identity registry, allocated only after a failure.
-
orionis.failure.runtime._Operation.token
orionis.failure.runtime._Operation.html#token
Attribute
Instance Variable
PUBLIC
Context-variable token restored when this boundary exits.
-
orionis.failure.runtime._Operation.closed
orionis.failure.runtime._Operation.html#closed
Attribute
Instance Variable
PUBLIC
Whether this boundary has released its incident references.
-
orionis.failure.runtime._Operation.__enter__
orionis.failure.runtime._Operation.html#__enter__
Function
Method
PUBLIC
Bind this operation to the current context.
-
orionis.failure.runtime._Operation._owner
orionis.failure.runtime._Operation.html#_owner
Function
Method
PUBLIC
Return the nearest operation that owns the shared incident ledger.
-
orionis.failure.runtime._Operation.incident
orionis.failure.runtime._Operation.html#incident
Function
Method
PUBLIC
Find the recorded incident for an exception by object identity.
-
orionis.failure.runtime._Operation.lookup
orionis.failure.runtime._Operation.html#lookup
Function
Method
PUBLIC
Find a receipt for an exception or an entirely observed group.
-
orionis.failure.runtime._Operation.adopt
orionis.failure.runtime._Operation.html#adopt
Function
Method
PUBLIC
Add an incident to the live ledger owner.
-
orionis.failure.runtime._Operation._propagate
orionis.failure.runtime._Operation.html#_propagate
Function
Method
PUBLIC
Transfer escaping incidents to the parent operation.
-
orionis.failure.runtime._Operation.__exit__
orionis.failure.runtime._Operation.html#__exit__
Function
Method
PUBLIC
Restore the parent context and release this operation's ledger.
-
orionis.failure.runtime._InactiveOperation
orionis.failure.runtime._InactiveOperation.html
Class
Class
PUBLIC
Allocation-free context when no application observation is active.
-
orionis.failure.runtime._InactiveOperation.__slots__
orionis.failure.runtime._InactiveOperation.html#__slots__
Attribute
Class Variable
PUBLIC
The shared inactive sentinel stores no per-operation state.
-
orionis.failure.runtime._InactiveOperation.closed
orionis.failure.runtime._InactiveOperation.html#closed
Attribute
Class Variable
PUBLIC
Inactive boundaries never expose a live operation.
-
orionis.failure.runtime._InactiveOperation.ledger
orionis.failure.runtime._InactiveOperation.html#ledger
Attribute
Class Variable
PUBLIC
Inactive boundaries never allocate an incident ledger.
-
orionis.failure.runtime._InactiveOperation.runtime
orionis.failure.runtime._InactiveOperation.html#runtime
Attribute
Class Variable
PUBLIC
Inactive boundaries have no application coordinator.
-
orionis.failure.runtime._InactiveOperation.__enter__
orionis.failure.runtime._InactiveOperation.html#__enter__
Function
Method
PUBLIC
Enter the shared no-op operation context.
-
orionis.failure.runtime._InactiveOperation.__exit__
orionis.failure.runtime._InactiveOperation.html#__exit__
Function
Method
PUBLIC
Leave the inactive context without suppressing exceptions.
-
orionis.failure.runtime._inactive_operation
orionis.failure.runtime.html#_inactive_operation
Attribute
Variable
PUBLIC
Shared no-op boundary used when observation is inactive.
-
orionis.failure.runtime._BorrowedOperation
orionis.failure.runtime._BorrowedOperation.html
Class
Class
PUBLIC
Reuse identical nested metadata without replacing or closing its owner.
-
orionis.failure.runtime._BorrowedOperation.__slots__
orionis.failure.runtime._BorrowedOperation.html#__slots__
Attribute
Class Variable
PUBLIC
Borrowed boundaries retain no state beyond the current context.
-
orionis.failure.runtime._BorrowedOperation.__enter__
orionis.failure.runtime._BorrowedOperation.html#__enter__
Function
Method
PUBLIC
Return the operation already bound to the current context.
-
orionis.failure.runtime._BorrowedOperation.__exit__
orionis.failure.runtime._BorrowedOperation.html#__exit__
Function
Method
PUBLIC
Leave the borrowed context without closing its owner.
-
orionis.failure.runtime._borrowed_operation
orionis.failure.runtime.html#_borrowed_operation
Attribute
Variable
PUBLIC
Shared context manager for an identical nested operation.
-
orionis.failure.runtime.operation
orionis.failure.runtime.html#operation
Function
Function
PUBLIC
Bind or reuse an execution context for failure observation.
-
orionis.failure.runtime.current_operation
orionis.failure.runtime.html#current_operation
Function
Function
PUBLIC
Return the live operation bound to the current context.
-
orionis.failure.runtime._runtime_operation
orionis.failure.runtime.html#_runtime_operation
Function
Function
PUBLIC
Return the live operation only when it belongs to the supplied runtime.
-
orionis.failure.runtime._previous_receipt
orionis.failure.runtime.html#_previous_receipt
Function
Function
PUBLIC
Reuse a direct incident receipt or an already observed group's receipt.
-
orionis.failure.runtime._parent_context
orionis.failure.runtime.html#_parent_context
Function
Function
PUBLIC
Link a secondary failure to an already observed cause.
-
orionis.failure.runtime.handoff
orionis.failure.runtime.html#handoff
Function
Function
PUBLIC
Transfer an observed incident to its awaiting operation owner.
-
orionis.failure.runtime.FailureRuntime
orionis.failure.runtime.FailureRuntime.html
Class
Class
PUBLIC
Own one application's handler, active lifetimes and pending reports.
-
orionis.failure.runtime.FailureRuntime.__init__
orionis.failure.runtime.FailureRuntime.html#__init__
Function
Method
PUBLIC
Initialize runtime ownership, reporting state, and task registries.
-
orionis.failure.runtime.FailureRuntime.app
orionis.failure.runtime.FailureRuntime.html#app
Attribute
Instance Variable
PUBLIC
Application providing dependency resolution and hook invocation.
-
orionis.failure.runtime.FailureRuntime.handler
orionis.failure.runtime.FailureRuntime.html#handler
Attribute
Instance Variable
PUBLIC
Prepared shared application handler, resolved lazily when absent.
-
orionis.failure.runtime.FailureRuntime.timeout
orionis.failure.runtime.FailureRuntime.html#timeout
Attribute
Instance Variable
PUBLIC
Cooperative timeout in seconds for a reporting operation.
-
orionis.failure.runtime.FailureRuntime._owners
orionis.failure.runtime.FailureRuntime.html#_owners
Attribute
Instance Variable
PUBLIC
Active owners retaining the runtime's shared resources.
-
orionis.failure.runtime.FailureRuntime._closing_owners
orionis.failure.runtime.FailureRuntime.html#_closing_owners
Attribute
Instance Variable
PUBLIC
Owners retaining observation while final resource closure completes.
-
orionis.failure.runtime.FailureRuntime._loop
orionis.failure.runtime.FailureRuntime.html#_loop
Attribute
Instance Variable
PUBLIC
Serving loop used to schedule notification from native threads.
-
orionis.failure.runtime.FailureRuntime._pending
orionis.failure.runtime.FailureRuntime.html#_pending
Attribute
Instance Variable
PUBLIC
Loop-local reports and abandoned futures retained through cleanup.
-
orionis.failure.runtime.FailureRuntime._tasks
orionis.failure.runtime.FailureRuntime.html#_tasks
Attribute
Instance Variable
PUBLIC
Supervised application tasks cancelled and drained at final shutdown.
-
orionis.failure.runtime.FailureRuntime._shutting_down
orionis.failure.runtime.FailureRuntime.html#_shutting_down
Attribute
Instance Variable
PUBLIC
Reject new work until a valid activation reopens task admission.
-
orionis.failure.runtime.FailureRuntime._shutdown_pending
orionis.failure.runtime.FailureRuntime.html#_shutdown_pending
Attribute
Instance Variable
PUBLIC
Shared shutdown coordinator retained only while cleanup is pending.
-
orionis.failure.runtime.FailureRuntime._thread_pending
orionis.failure.runtime.FailureRuntime.html#_thread_pending
Attribute
Instance Variable
PUBLIC
Submissions retained until ownership transfers to a loop-side task.
-
orionis.failure.runtime.FailureRuntime._pending_lock
orionis.failure.runtime.FailureRuntime.html#_pending_lock
Attribute
Instance Variable
PUBLIC
Serialize incident reservation and pending cross-thread registries.
-
orionis.failure.runtime.FailureRuntime._prepare_lock
orionis.failure.runtime.FailureRuntime.html#_prepare_lock
Attribute
Instance Variable
PUBLIC
Serialize preparation of the shared application handler.
-
orionis.failure.runtime.FailureRuntime.lifecycle_lock
orionis.failure.runtime.FailureRuntime.html#lifecycle_lock
Attribute
Instance Variable
PUBLIC
Coordinate runtime activation with final shared-resource closure.
-
orionis.failure.runtime.FailureRuntime._reporting_enabled
orionis.failure.runtime.FailureRuntime.html#_reporting_enabled
Attribute
Instance Variable
PUBLIC
Whether ordinary logging resources remain safe to use.
-
orionis.failure.runtime.FailureRuntime._fallback_handler
orionis.failure.runtime.FailureRuntime.html#_fallback_handler
Attribute
Instance Variable
PUBLIC
Scope-free native policy selected after custom handling fails.
-
orionis.failure.runtime.FailureRuntime.active
orionis.failure.runtime.FailureRuntime.html#active
Attribute
Property
PUBLIC
Check whether active or closing owners keep observation enabled.
-
orionis.failure.runtime.FailureRuntime.ownerCount
orionis.failure.runtime.FailureRuntime.html#ownerCount
Attribute
Property
PUBLIC
Return the number of owners still holding resource ownership.
-
orionis.failure.runtime.FailureRuntime.hasOwner
orionis.failure.runtime.FailureRuntime.html#hasOwner
Function
Method
PUBLIC
Check whether an owner is active or still completing shutdown.
-
orionis.failure.runtime.FailureRuntime.prepare
orionis.failure.runtime.FailureRuntime.html#prepare
Function
Method
PUBLIC
Resolve the application handler once outside operational scopes.
-
orionis.failure.runtime.FailureRuntime.activate
orionis.failure.runtime.FailureRuntime.html#activate
Function
Method
PUBLIC
Register a started owner and record the current event loop.
-
orionis.failure.runtime.FailureRuntime.start
orionis.failure.runtime.FailureRuntime.html#start
Function
Method
PUBLIC
Activate an owner after earlier lifecycle transitions complete.
-
orionis.failure.runtime.FailureRuntime.deactivate
orionis.failure.runtime.FailureRuntime.html#deactivate
Function
Method
PUBLIC
Release active and closing ownership for a lifecycle token.
-
orionis.failure.runtime.FailureRuntime.beginClosing
orionis.failure.runtime.FailureRuntime.html#beginClosing
Function
Method
PUBLIC
Move an owner into closing while retaining cleanup observation.
-
orionis.failure.runtime.FailureRuntime.stopReporting
orionis.failure.runtime.FailureRuntime.html#stopReporting
Function
Method
PUBLIC
Disable logging effects while retaining owner-based observation.
-
orionis.failure.runtime.FailureRuntime._invoke
orionis.failure.runtime.FailureRuntime.html#_invoke
Function
Method
PUBLIC
Invoke an application handler method within the reporting timeout.
-
orionis.failure.runtime.FailureRuntime._attempt
orionis.failure.runtime.FailureRuntime.html#_attempt
Function
Method
PUBLIC
Select and validate deferred effects through an application hook.
-
orionis.failure.runtime.FailureRuntime._defaultHandling
orionis.failure.runtime.FailureRuntime.html#_defaultHandling
Function
Method
PUBLIC
Select native failure effects after application policy fails.
-
orionis.failure.runtime.FailureRuntime._correlate
orionis.failure.runtime.FailureRuntime.html#_correlate
Function
Method
PUBLIC
Assign operation correlation lazily when recording a failure.
-
orionis.failure.runtime.FailureRuntime._begin
orionis.failure.runtime.FailureRuntime.html#_begin
Function
Method
PUBLIC
Claim or reuse an incident before handler execution can suspend.
-
orionis.failure.runtime.FailureRuntime._recordIncident
orionis.failure.runtime.FailureRuntime.html#_recordIncident
Function
Method
PUBLIC
Record a new or reclaimed incident before invoking a handler.
-
orionis.failure.runtime.FailureRuntime._completeHandling
orionis.failure.runtime.FailureRuntime.html#_completeHandling
Function
Method
PUBLIC
Complete selected logging effects without requesting presentation.
-
orionis.failure.runtime.FailureRuntime.capture
orionis.failure.runtime.FailureRuntime.html#capture
Function
Method
PUBLIC
Observe an original exception once per operation.
-
orionis.failure.runtime.FailureRuntime.dispatchFailure
orionis.failure.runtime.FailureRuntime.html#dispatchFailure
Function
Method
PUBLIC
Select and complete failure effects without requesting presentation.
-
orionis.failure.runtime.FailureRuntime.handlingFor
orionis.failure.runtime.FailureRuntime.html#handlingFor
Function
Method
PUBLIC
Return the selected plan without observing the exception twice.
-
orionis.failure.runtime.FailureRuntime._fallbackPresentation
orionis.failure.runtime.FailureRuntime.html#_fallbackPresentation
Function
Method
PUBLIC
Share native presentation planning for an incident without a plan.
-
orionis.failure.runtime.FailureRuntime.captureResult
orionis.failure.runtime.FailureRuntime.html#captureResult
Function
Method
PUBLIC
Observe a declared failed result without constructing an exception.
-
orionis.failure.runtime.FailureRuntime.presentHandling
orionis.failure.runtime.FailureRuntime.html#presentHandling
Function
Method
PUBLIC
Present a selected plan with bounded, nonrecursive failure handling.
-
orionis.failure.runtime.FailureRuntime.drain
orionis.failure.runtime.FailureRuntime.html#drain
Function
Method
PUBLIC
Await owned callback reports until no pending report remains.
-
orionis.failure.runtime.FailureRuntime.createTask
orionis.failure.runtime.FailureRuntime.html#createTask
Function
Method
PUBLIC
Create and supervise application work until shutdown.
-
orionis.failure.runtime.FailureRuntime._finishCancelledWork
orionis.failure.runtime.FailureRuntime.html#_finishCancelledWork
Function
Method
PUBLIC
Cancel abandoned work and retain local futures until cleanup completes.
-
orionis.failure.runtime.FailureRuntime._settleCancelledFuture
orionis.failure.runtime.FailureRuntime.html#_settleCancelledFuture
Function
Method
PUBLIC
Release completed cleanup and observe only unsupervised failures.
-
orionis.failure.runtime.FailureRuntime.shutdown
orionis.failure.runtime.FailureRuntime.html#shutdown
Function
Method
PUBLIC
Cancel owned application tasks and drain their failure reports.
-
orionis.failure.runtime.FailureRuntime._drainShutdown
orionis.failure.runtime.FailureRuntime.html#_drainShutdown
Function
Method
PUBLIC
Settle owned work and reports while admission remains closed.
-
orionis.failure.runtime.FailureRuntime._shutdownFinished
orionis.failure.runtime.FailureRuntime.html#_shutdownFinished
Function
Method
PUBLIC
Release the coordinator context and retrieve an unclaimed failure.
-
orionis.failure.runtime.prepare
orionis.failure.runtime.html#prepare
Function
Function
PUBLIC
Resolve an application's failure runtime without activating observation.
-
orionis.failure.runtime._context
orionis.failure.runtime.html#_context
Function
Function
PUBLIC
Build failure metadata using compatible operation defaults.
-
orionis.failure.runtime.capture
orionis.failure.runtime.html#capture
Function
Function
PUBLIC
Observe an exception through an active application runtime.
-
orionis.failure.runtime.capture_result
orionis.failure.runtime.html#capture_result
Function
Function
PUBLIC
Observe a declared failed result through an active runtime.
-
orionis.failure.runtime._completed_receipt
orionis.failure.runtime.html#_completed_receipt
Function
Function
PUBLIC
Return a completed receipt future for the caller's event-loop context.
-
orionis.failure.runtime._pending_incident
orionis.failure.runtime.html#_pending_incident
Function
Function
PUBLIC
Claim or reuse callback incident identity while its operation is live.
-
orionis.failure.runtime.capture_nowait
orionis.failure.runtime.html#capture_nowait
Function
Function
PUBLIC
Schedule supervised exception observation from a callback or worker.
-
orionis.failure.runtime._submit_loop
orionis.failure.runtime.html#_submit_loop
Function
Function
PUBLIC
Admit a callback report on its running loop and retain task ownership.
-
orionis.failure.runtime._ThreadReport
orionis.failure.runtime._ThreadReport.html
Class
Class
PUBLIC
Transfer report ownership from a worker submission to its loop task.
-
orionis.failure.runtime._ThreadReport.__slots__
orionis.failure.runtime._ThreadReport.html#__slots__
Attribute
Class Variable
PUBLIC
Submission state retained through admission and terminal delivery.
-
orionis.failure.runtime._ThreadReport.__init__
orionis.failure.runtime._ThreadReport.html#__init__
Function
Method
PUBLIC
Retain one submission until admission and terminal task completion.
-
orionis.failure.runtime._ThreadReport._runtime
orionis.failure.runtime._ThreadReport.html#_runtime
Attribute
Instance Variable
PUBLIC
Runtime retaining pending report ownership.
-
orionis.failure.runtime._ThreadReport._loop
orionis.failure.runtime._ThreadReport.html#_loop
Attribute
Instance Variable
PUBLIC
Event loop receiving the reporting coroutine.
-
orionis.failure.runtime._ThreadReport._exception
orionis.failure.runtime._ThreadReport.html#_exception
Attribute
Instance Variable
PUBLIC
Original application failure.
-
orionis.failure.runtime._ThreadReport._context
orionis.failure.runtime._ThreadReport.html#_context
Attribute
Instance Variable
PUBLIC
Incident metadata shared by admission and diagnosis.
-
orionis.failure.runtime._ThreadReport._incident
orionis.failure.runtime._ThreadReport.html#_incident
Attribute
Instance Variable
PUBLIC
Claim whose unused delivery must be abandoned.
-
orionis.failure.runtime._ThreadReport._coroutine
orionis.failure.runtime._ThreadReport.html#_coroutine
Attribute
Instance Variable
PUBLIC
Reporting coroutine owned until admitted or closed.
-
orionis.failure.runtime._ThreadReport._future
orionis.failure.runtime._ThreadReport.html#_future
Attribute
Instance Variable
PUBLIC
Public future that stays cancellable until task completion.
-
orionis.failure.runtime._ThreadReport._releaseSubmission
orionis.failure.runtime._ThreadReport.html#_releaseSubmission
Function
Method
PUBLIC
Release a submission after admission or a terminal scheduling failure.
-
orionis.failure.runtime._ThreadReport._reject
orionis.failure.runtime._ThreadReport.html#_reject
Function
Method
PUBLIC
Close unadmitted work and settle its public future before diagnosis.
-
orionis.failure.runtime._ThreadReport._finished
orionis.failure.runtime._ThreadReport.html#_finished
Function
Method
PUBLIC
Transfer a terminal task outcome and release loop-side ownership.
-
orionis.failure.runtime._ThreadReport._admit
orionis.failure.runtime._ThreadReport.html#_admit
Function
Method
PUBLIC
Transfer a published submission to a real task on the owning loop.
-
orionis.failure.runtime._ThreadReport._cancelTask
orionis.failure.runtime._ThreadReport.html#_cancelTask
Function
Static Method
PUBLIC
Forward public cancellation without releasing task ownership.
-
orionis.failure.runtime._ThreadReport.submit
orionis.failure.runtime._ThreadReport.html#submit
Function
Method
PUBLIC
Publish ownership before enqueueing the loop-side admission callback.
-
orionis.failure.runtime.is_reporting
orionis.failure.runtime.html#is_reporting
Function
Function
PUBLIC
Check whether the current context is executing a failure reporter.
-
orionis.failure.runtime.reporting_runtime
orionis.failure.runtime.html#reporting_runtime
Function
Function
PUBLIC
Return the reporter identity bound to the current context.
-
orionis.failure.runtime.reporting_from
orionis.failure.runtime.html#reporting_from
Function
Function
PUBLIC
Bind a reporter identity while processing its queued log record.
-
orionis.http.payload.contracts.stream_parser.IMultipartStreamParser
orionis.http.payload.contracts.stream_parser.IMultipartStreamParser.html
Class
Class
PUBLIC
Define the contract for parsing a multipart byte stream.
-
orionis.http.payload.contracts.stream_parser.IMultipartStreamParser.__slots__
orionis.http.payload.contracts.stream_parser.IMultipartStreamParser.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.http.payload.contracts.stream_parser.IMultipartStreamParser.parse
orionis.http.payload.contracts.stream_parser.IMultipartStreamParser.html#parse
Function
Method
PUBLIC
Parse the multipart stream and return all form fields and files.
-
orionis.http.payload.contracts.part.IMultipartPart
orionis.http.payload.contracts.part.IMultipartPart.html
Class
Class
PUBLIC
Define the contract for a single part within a multipart HTTP request body.
-
orionis.http.payload.contracts.part.IMultipartPart.__slots__
orionis.http.payload.contracts.part.IMultipartPart.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.http.payload.contracts.part.IMultipartPart.write
orionis.http.payload.contracts.part.IMultipartPart.html#write
Function
Method
PUBLIC
Append chunk to this part's data buffer.
-
orionis.http.payload.contracts.part.IMultipartPart.finalize
orionis.http.payload.contracts.part.IMultipartPart.html#finalize
Function
Method
PUBLIC
Return this part's content in its final form.
-
orionis.http.payload.part.MultipartPart
orionis.http.payload.part.MultipartPart.html
Class
Class
PUBLIC
Represent a single part within a multipart HTTP request body.
-
orionis.http.payload.part.MultipartPart.__slots__
orionis.http.payload.part.MultipartPart.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.http.payload.part.MultipartPart.__init__
orionis.http.payload.part.MultipartPart.html#__init__
Function
Method
PUBLIC
Initialize a new MultipartPart from its MIME headers.
-
orionis.http.payload.part.MultipartPart.name
orionis.http.payload.part.MultipartPart.html#name
Attribute
Instance Variable
PUBLIC
Assign field metadata extracted from the disposition attributes.
-
orionis.http.payload.part.MultipartPart.filename
orionis.http.payload.part.MultipartPart.html#filename
Attribute
Instance Variable
PUBLIC
Filename used when rendering or storing the resource.
-
orionis.http.payload.part.MultipartPart.content_type
orionis.http.payload.part.MultipartPart.html#content_type
Attribute
Instance Variable
PUBLIC
Content type produced by headers.get.
-
orionis.http.payload.part.MultipartPart.is_file
orionis.http.payload.part.MultipartPart.html#is_file
Attribute
Instance Variable
PUBLIC
A part is treated as a file upload when a filename is declared.
-
orionis.http.payload.part.MultipartPart.data
orionis.http.payload.part.MultipartPart.html#data
Attribute
Instance Variable
PUBLIC
Select the file or field buffer writer for this part.
-
orionis.http.payload.part.MultipartPart._write
orionis.http.payload.part.MultipartPart.html#_write
Attribute
Instance Variable
PUBLIC
Callable used to append bytes to the current multipart part.
-
orionis.http.payload.part.MultipartPart._parseContentDisposition
orionis.http.payload.part.MultipartPart.html#_parseContentDisposition
Function
Method
PUBLIC
Parse a Content-Disposition header into a key-value dict.
-
orionis.http.payload.part.MultipartPart.write
orionis.http.payload.part.MultipartPart.html#write
Function
Method
PUBLIC
Append chunk to this part's data buffer.
-
orionis.http.payload.part.MultipartPart.finalize
orionis.http.payload.part.MultipartPart.html#finalize
Function
Method
PUBLIC
Return this part's content in its final form.
-
orionis.http.payload.stream_parser._DEFAULT_LIMITS
orionis.http.payload.stream_parser.html#_DEFAULT_LIMITS
Attribute
Constant
PUBLIC
Default limits used by stream_parser.
-
orionis.http.payload.stream_parser._STATE_SEARCH_BOUNDARY
orionis.http.payload.stream_parser.html#_STATE_SEARCH_BOUNDARY
Attribute
Constant
PUBLIC
Integer constants for the parser state machine.
-
orionis.http.payload.stream_parser._STATE_READ_BODY
orionis.http.payload.stream_parser.html#_STATE_READ_BODY
Attribute
Constant
PUBLIC
State read body value used by stream_parser.
-
orionis.http.payload.stream_parser._STATE_FINISHED
orionis.http.payload.stream_parser.html#_STATE_FINISHED
Attribute
Constant
PUBLIC
State finished value used by stream_parser.
-
orionis.http.payload.stream_parser._DELIMITER_INVALID
orionis.http.payload.stream_parser.html#_DELIMITER_INVALID
Attribute
Constant
PUBLIC
Delimiter invalid used by stream_parser.
-
orionis.http.payload.stream_parser._BYTE_DASH
orionis.http.payload.stream_parser.html#_BYTE_DASH
Attribute
Constant
PUBLIC
Byte values for RFC 2046 protocol characters.
-
orionis.http.payload.stream_parser._MAX_BOUNDARY_SIZE
orionis.http.payload.stream_parser.html#_MAX_BOUNDARY_SIZE
Attribute
Constant
PUBLIC
Max boundary size value used by stream_parser.
-
orionis.http.payload.stream_parser._CHUNK_SIZE
orionis.http.payload.stream_parser.html#_CHUNK_SIZE
Attribute
Constant
PUBLIC
Chunk size used by stream_parser.
-
orionis.http.payload.stream_parser._CLEANUP_PHASE
orionis.http.payload.stream_parser.html#_CLEANUP_PHASE
Attribute
Constant
PUBLIC
Failure phase shared by multipart upload cleanup operations.
-
orionis.http.payload.stream_parser.complete_in_thread
orionis.http.payload.stream_parser.html#complete_in_thread
Function
Function
PUBLIC
Run a blocking function in a worker thread without losing cancellation state.
-
orionis.http.payload.stream_parser.MultipartStreamParser
orionis.http.payload.stream_parser.MultipartStreamParser.html
Class
Class
PUBLIC
Parse a multipart byte stream into form fields and uploaded files.
-
orionis.http.payload.stream_parser.MultipartStreamParser.stream
orionis.http.payload.stream_parser.MultipartStreamParser.html#stream
Attribute
Instance Variable
PUBLIC
Async byte stream produced by the transport layer.
-
orionis.http.payload.stream_parser.MultipartStreamParser.boundary
orionis.http.payload.stream_parser.MultipartStreamParser.html#boundary
Attribute
Instance Variable
PUBLIC
Raw multipart boundary token (without leading --).
-
orionis.http.payload.stream_parser.MultipartStreamParser.buffer
orionis.http.payload.stream_parser.MultipartStreamParser.html#buffer
Attribute
Instance Variable
PUBLIC
Allocate the working buffer for incoming byte chunks.
-
orionis.http.payload.stream_parser.MultipartStreamParser.max_files
orionis.http.payload.stream_parser.MultipartStreamParser.html#max_files
Attribute
Instance Variable
PUBLIC
Maximum number of file parts accepted (default 32).
-
orionis.http.payload.stream_parser.MultipartStreamParser.max_fields
orionis.http.payload.stream_parser.MultipartStreamParser.html#max_fields
Attribute
Instance Variable
PUBLIC
Maximum number of field parts accepted (default 128).
-
orionis.http.payload.stream_parser.MultipartStreamParser.max_part_size
orionis.http.payload.stream_parser.MultipartStreamParser.html#max_part_size
Attribute
Instance Variable
PUBLIC
Maximum byte size of a single part (default 10 MiB).
-
orionis.http.payload.stream_parser.MultipartStreamParser.memory_threshold
orionis.http.payload.stream_parser.MultipartStreamParser.html#memory_threshold
Attribute
Instance Variable
PUBLIC
Bytes before a file part spills to disk (default 256 KiB).
-
orionis.http.payload.stream_parser.MultipartStreamParser.max_body_size
orionis.http.payload.stream_parser.MultipartStreamParser.html#max_body_size
Attribute
Instance Variable
PUBLIC
Maximum transport bytes, including preamble and epilogue (16 MiB).
-
orionis.http.payload.stream_parser.MultipartStreamParser.max_field_size
orionis.http.payload.stream_parser.MultipartStreamParser.html#max_field_size
Attribute
Instance Variable
PUBLIC
Maximum raw bytes of a single text field (default 1 MiB).
-
orionis.http.payload.stream_parser.MultipartStreamParser.max_memory_size
orionis.http.payload.stream_parser.MultipartStreamParser.html#max_memory_size
Attribute
Instance Variable
PUBLIC
Retained field/file memory budget (default 8 MiB), excluding transport buffers, object metadata and temporary copies.
-
orionis.http.payload.stream_parser.MultipartStreamParser.files_count
orionis.http.payload.stream_parser.MultipartStreamParser.html#files_count
Attribute
Instance Variable
PUBLIC
Initialize runtime counters to zero.
-
orionis.http.payload.stream_parser.MultipartStreamParser.fields_count
orionis.http.payload.stream_parser.MultipartStreamParser.html#fields_count
Attribute
Instance Variable
PUBLIC
Fields count value used by MultipartStreamParser.
-
orionis.http.payload.stream_parser.MultipartStreamParser.current_part_size
orionis.http.payload.stream_parser.MultipartStreamParser.html#current_part_size
Attribute
Instance Variable
PUBLIC
Current part size value used by MultipartStreamParser.
-
orionis.http.payload.stream_parser.MultipartStreamParser._totalSize
orionis.http.payload.stream_parser.MultipartStreamParser.html#_totalSize
Attribute
Instance Variable
PUBLIC
Total size value used by MultipartStreamParser.
-
orionis.http.payload.stream_parser.MultipartStreamParser._memorySize
orionis.http.payload.stream_parser.MultipartStreamParser.html#_memorySize
Attribute
Instance Variable
PUBLIC
Memory size value used by MultipartStreamParser.
-
orionis.http.payload.stream_parser.MultipartStreamParser._partMemorySize
orionis.http.payload.stream_parser.MultipartStreamParser.html#_partMemorySize
Attribute
Instance Variable
PUBLIC
Part memory size value used by MultipartStreamParser.
-
orionis.http.payload.stream_parser.MultipartStreamParser._pendingChunk
orionis.http.payload.stream_parser.MultipartStreamParser.html#_pendingChunk
Attribute
Instance Variable
PUBLIC
Pending chunk value used by MultipartStreamParser.
-
orionis.http.payload.stream_parser.MultipartStreamParser._pendingOffset
orionis.http.payload.stream_parser.MultipartStreamParser.html#_pendingOffset
Attribute
Instance Variable
PUBLIC
Pending offset value used by MultipartStreamParser.
-
orionis.http.payload.stream_parser.MultipartStreamParser._atStart
orionis.http.payload.stream_parser.MultipartStreamParser.html#_atStart
Attribute
Instance Variable
PUBLIC
At start flag used by MultipartStreamParser.
-
orionis.http.payload.stream_parser.MultipartStreamParser._eof
orionis.http.payload.stream_parser.MultipartStreamParser.html#_eof
Attribute
Instance Variable
PUBLIC
Eof flag used by MultipartStreamParser.
-
orionis.http.payload.stream_parser.MultipartStreamParser._paddingStart
orionis.http.payload.stream_parser.MultipartStreamParser.html#_paddingStart
Attribute
Instance Variable
PUBLIC
Position at which multipart boundary padding begins.
-
orionis.http.payload.stream_parser.MultipartStreamParser._paddingEnd
orionis.http.payload.stream_parser.MultipartStreamParser.html#_paddingEnd
Attribute
Instance Variable
PUBLIC
Padding end value used by MultipartStreamParser.
-
orionis.http.payload.stream_parser.MultipartStreamParser._currentPart
orionis.http.payload.stream_parser.MultipartStreamParser.html#_currentPart
Attribute
Instance Variable
PUBLIC
Multipart part currently receiving parsed headers or body bytes.
-
orionis.http.payload.stream_parser.MultipartStreamParser.__slots__
orionis.http.payload.stream_parser.MultipartStreamParser.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.http.payload.stream_parser.MultipartStreamParser.__init__
orionis.http.payload.stream_parser.MultipartStreamParser.html#__init__
Function
Method
PUBLIC
Initialize a new MultipartStreamParser instance.
-
orionis.http.payload.stream_parser.MultipartStreamParser._discardPrefix
orionis.http.payload.stream_parser.MultipartStreamParser.html#_discardPrefix
Function
Method
PUBLIC
Discard consumed bytes and realign the delimiter padding cursor.
-
orionis.http.payload.stream_parser.MultipartStreamParser._delimiterEnd
orionis.http.payload.stream_parser.MultipartStreamParser.html#_delimiterEnd
Function
Method
PUBLIC
Resolve the end of a multipart delimiter line.
-
orionis.http.payload.stream_parser.MultipartStreamParser._findBoundary
orionis.http.payload.stream_parser.MultipartStreamParser.html#_findBoundary
Function
Method
PUBLIC
Find a complete multipart delimiter or an incomplete suffix.
-
orionis.http.payload.stream_parser.MultipartStreamParser._writePart
orionis.http.payload.stream_parser.MultipartStreamParser.html#_writePart
Function
Method
PUBLIC
Write a buffer prefix into the active part and enforce size limits.
-
orionis.http.payload.stream_parser.MultipartStreamParser._closeRejectedPart
orionis.http.payload.stream_parser.MultipartStreamParser.html#_closeRejectedPart
Function
Method
PUBLIC
Close a rejected upload and report cleanup failures.
-
orionis.http.payload.stream_parser.MultipartStreamParser._newPart
orionis.http.payload.stream_parser.MultipartStreamParser.html#_newPart
Function
Method
PUBLIC
Create a multipart part from the parsed MIME headers.
-
orionis.http.payload.stream_parser.MultipartStreamParser._searchBoundary
orionis.http.payload.stream_parser.MultipartStreamParser.html#_searchBoundary
Function
Method
PUBLIC
Search for the next multipart boundary and decide the parser state.
-
orionis.http.payload.stream_parser.MultipartStreamParser._finishPart
orionis.http.payload.stream_parser.MultipartStreamParser.html#_finishPart
Function
Method
PUBLIC
Finalize a part body or decode transfer-encoded file content.
-
orionis.http.payload.stream_parser.MultipartStreamParser._receiveChunk
orionis.http.payload.stream_parser.MultipartStreamParser.html#_receiveChunk
Function
Method
PUBLIC
Read the next chunk from the stream and track end-of-stream.
-
orionis.http.payload.stream_parser.MultipartStreamParser._consumeBody
orionis.http.payload.stream_parser.MultipartStreamParser.html#_consumeBody
Function
Method
PUBLIC
Consume a body segment and advance the parser to the next state.
-
orionis.http.payload.stream_parser.MultipartStreamParser._advanceState
orionis.http.payload.stream_parser.MultipartStreamParser.html#_advanceState
Function
Method
PUBLIC
Advance the parser according to the current state.
-
orionis.http.payload.stream_parser.MultipartStreamParser._parseParts
orionis.http.payload.stream_parser.MultipartStreamParser.html#_parseParts
Function
Method
PUBLIC
Parse all parts until the multipart stream ends or fails.
-
orionis.http.payload.stream_parser.MultipartStreamParser._closeFailedParts
orionis.http.payload.stream_parser.MultipartStreamParser.html#_closeFailedParts
Function
Method
PUBLIC
Close every failed upload before error reporting can be cancelled.
-
orionis.http.payload.stream_parser.MultipartStreamParser.parse
orionis.http.payload.stream_parser.MultipartStreamParser.html#parse
Function
Method
PUBLIC
Parse the multipart stream and return the collected form data.
-
orionis.http.request._MIME_JSON
orionis.http.request.module.html#_MIME_JSON
Attribute
Constant
PUBLIC
application/json.
-
orionis.http.request._MIME_MULTIPART
orionis.http.request.module.html#_MIME_MULTIPART
Attribute
Constant
PUBLIC
multipart/form-data.
-
orionis.http.request._MIME_MSGPACK
orionis.http.request.module.html#_MIME_MSGPACK
Attribute
Constant
PUBLIC
application/msgpack.
-
orionis.http.request._MIME_URLENCODED
orionis.http.request.module.html#_MIME_URLENCODED
Attribute
Constant
PUBLIC
application/x-www-form-urlencoded.
-
orionis.http.request._BEARER_PREFIX
orionis.http.request.module.html#_BEARER_PREFIX
Attribute
Constant
PUBLIC
Authorization scheme prefix recognized for bearer-token authentication.
-
orionis.http.request._BEARER_PREFIX_LEN
orionis.http.request.module.html#_BEARER_PREFIX_LEN
Attribute
Constant
PUBLIC
Bearer prefix len value used by request.
-
orionis.http.request._asgi_server_authority
orionis.http.request.module.html#_asgi_server_authority
Function
Function
PUBLIC
Format an ASGI server address for use as a URL authority.
-
orionis.http.adapters.request.contracts.transport.TransportAdapter
orionis.http.adapters.request.contracts.transport.TransportAdapter.html
Class
Class
PUBLIC
Read/write abstraction over a protocol scope (ASGI or RSGI).
-
orionis.http.adapters.request.contracts.transport.TransportAdapter.__slots__
orionis.http.adapters.request.contracts.transport.TransportAdapter.html#__slots__
Attribute
Class Variable
PUBLIC
Define the transport interface without instance state.
-
orionis.http.adapters.request.contracts.transport.TransportAdapter.client
orionis.http.adapters.request.contracts.transport.TransportAdapter.html#client
Function
Method
PUBLIC
Return the remote client address parsed from the RSGI/ASGI scope.
-
orionis.http.adapters.request.contracts.transport.TransportAdapter.setClient
orionis.http.adapters.request.contracts.transport.TransportAdapter.html#setClient
Function
Method
PUBLIC
Set the remote client address in the scope.
-
orionis.http.adapters.request.contracts.transport.TransportAdapter.scheme
orionis.http.adapters.request.contracts.transport.TransportAdapter.html#scheme
Function
Method
PUBLIC
Return the URL scheme of the current request.
-
orionis.http.adapters.request.contracts.transport.TransportAdapter.setScheme
orionis.http.adapters.request.contracts.transport.TransportAdapter.html#setScheme
Function
Method
PUBLIC
Set the URL scheme of the current request.
-
orionis.http.adapters.request.contracts.transport.TransportAdapter.method
orionis.http.adapters.request.contracts.transport.TransportAdapter.html#method
Function
Method
PUBLIC
Return the HTTP method of the current request.
-
orionis.http.adapters.request.contracts.transport.TransportAdapter.path
orionis.http.adapters.request.contracts.transport.TransportAdapter.html#path
Function
Method
PUBLIC
Return the URL path of the current request.
-
orionis.http.adapters.request.contracts.transport.TransportAdapter.setState
orionis.http.adapters.request.contracts.transport.TransportAdapter.html#setState
Function
Method
PUBLIC
Store an arbitrary value in the scope under the given key.
-
orionis.http.adapters.request.contracts.transport.TransportAdapter.wantsJson
orionis.http.adapters.request.contracts.transport.TransportAdapter.html#wantsJson
Function
Method
PUBLIC
Determine if the client prefers a JSON response based on the Accept header.
-
orionis.http.adapters.request.contracts.transport.TransportAdapter.getScope
orionis.http.adapters.request.contracts.transport.TransportAdapter.html#getScope
Function
Method
PUBLIC
Return the underlying protocol scope object.
-
orionis.http.request.UnsupportedMediaTypeException
orionis.http.request.UnsupportedMediaTypeException.html
Class
Exception
PUBLIC
Raise when the request Content-Type is unsupported by the parser.
-
orionis.background.contracts.task.IBackgroundTask
orionis.background.contracts.task.IBackgroundTask.html
Class
Class
PUBLIC
Define the interface for background task execution.
-
orionis.background.contracts.task.IBackgroundTask.__slots__
orionis.background.contracts.task.IBackgroundTask.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.background.contracts.task.IBackgroundTask.run
orionis.background.contracts.task.IBackgroundTask.html#run
Function
Method
PUBLIC
Run the background task.
-
orionis.container.facades.meta._FacadeDispatch
orionis.container.facades.meta._FacadeDispatch.html
Class
Class
PUBLIC
Deferred facade call, awaitable and usable as an async context manager.
-
orionis.container.facades.meta._FacadeDispatch.__slots__
orionis.container.facades.meta._FacadeDispatch.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.container.facades.meta._FacadeDispatch.__init__
orionis.container.facades.meta._FacadeDispatch.html#__init__
Function
Method
PUBLIC
Store the pending call until it is awaited or entered.
-
orionis.container.facades.meta._FacadeDispatch._cls
orionis.container.facades.meta._FacadeDispatch.html#_cls
Attribute
Instance Variable
PUBLIC
Facade class the attribute was requested on.
-
orionis.container.facades.meta._FacadeDispatch._name
orionis.container.facades.meta._FacadeDispatch.html#_name
Attribute
Instance Variable
PUBLIC
Name of the attribute requested on the resolved service.
-
orionis.container.facades.meta._FacadeDispatch._args
orionis.container.facades.meta._FacadeDispatch.html#_args
Attribute
Instance Variable
PUBLIC
Positional arguments to forward to the resolved attribute.
-
orionis.container.facades.meta._FacadeDispatch._kwargs
orionis.container.facades.meta._FacadeDispatch.html#_kwargs
Attribute
Instance Variable
PUBLIC
Keyword arguments to forward to the resolved attribute.
-
orionis.container.facades.meta._FacadeDispatch._context
orionis.container.facades.meta._FacadeDispatch.html#_context
Attribute
Instance Variable
PUBLIC
Runtime context made available to the operation and its callbacks.
-
orionis.container.facades.meta._FacadeDispatch.__resolve
orionis.container.facades.meta._FacadeDispatch.html#__resolve
Function
Method
PUBLIC
Resolve the service and evaluate the requested attribute.
-
orionis.container.facades.meta._FacadeDispatch.__await__
orionis.container.facades.meta._FacadeDispatch.html#__await__
Function
Method
PUBLIC
Drive the deferred call to completion when awaited directly.
-
orionis.container.facades.meta._FacadeDispatch.__awaitImpl
orionis.container.facades.meta._FacadeDispatch.html#__awaitImpl
Function
Method
PUBLIC
Resolve the call and transparently await an awaitable result.
-
orionis.container.facades.meta._FacadeDispatch.__aenter__
orionis.container.facades.meta._FacadeDispatch.html#__aenter__
Function
Method
PUBLIC
Resolve the call and enter the resulting async context manager.
-
orionis.container.facades.meta._FacadeDispatch.__aexit__
orionis.container.facades.meta._FacadeDispatch.html#__aexit__
Function
Method
PUBLIC
Exit the async context manager entered by __aenter__.
-
orionis.container.facades.meta._dispatcher_for
orionis.container.facades.meta.html#_dispatcher_for
Function
Function
PUBLIC
Reuse a dispatcher within a bounded cache of facade attributes.
-
orionis.container.facades.meta.FacadeMeta
orionis.container.facades.meta.FacadeMeta.html
Class
Class
PUBLIC
Resolve the facade meta service through the application facade.
-
orionis.container.facades.meta.FacadeMeta.__getattr__
orionis.container.facades.meta.FacadeMeta.html#__getattr__
Function
Method
PUBLIC
Return a proxy for a facade attribute.
-
orionis.container.facades.meta.ScopedFacadeMeta
orionis.container.facades.meta.ScopedFacadeMeta.html
Class
Class
PUBLIC
Dispatch attributes exclusively to the active scope's service.
-
orionis.container.facades.meta.ScopedFacadeMeta.__getattr__
orionis.container.facades.meta.ScopedFacadeMeta.html#__getattr__
Function
Method
PUBLIC
Return an attribute from the current scoped service.
-
orionis.container.facades.facade.ScopedFacade
orionis.container.facades.facade.ScopedFacade.html
Class
Class
PUBLIC
Expose a service already bound to the caller's active scope.
-
orionis.container.facades.facade.ScopedFacade.scopedInstance
orionis.container.facades.facade.ScopedFacade.html#scopedInstance
Function
Class Method
PUBLIC
Return the service bound to the active scope.
-
orionis.container.facades.facade.ScopedFacade.resolve
orionis.container.facades.facade.ScopedFacade.html#resolve
Function
Class Method
PUBLIC
Resolve the current instance without constructing a global service.
-
orionis.container.facades.facade.ScopedFacade.pin
orionis.container.facades.facade.ScopedFacade.html#pin
Function
Class Method
PUBLIC
Validate scope availability without retaining the service globally.
-
orionis.container.facades.facade.ScopedFacade.unpin
orionis.container.facades.facade.ScopedFacade.html#unpin
Function
Class Method
PUBLIC
Leave lifetime management to the owning scope.
-
orionis.background.task.is_async_callable
orionis.background.task.html#is_async_callable
Function
Function
PUBLIC
Detect coroutine functions and callable instances with asynchronous calls.
-
orionis.http.adapters.response.files._drain_future
orionis.http.adapters.response.files.html#_drain_future
Function
Function
PUBLIC
Wait through repeated cancellation until the worker operation finishes.
-
orionis.http.adapters.response.files.open_file
orionis.http.adapters.response.files.html#open_file
Function
Function
PUBLIC
Open a file in a worker thread.
-
orionis.http.adapters.response.files.complete_file_read
orionis.http.adapters.response.files.html#complete_file_read
Function
Function
PUBLIC
Complete a pending worker read before propagating cancellation.
-
orionis.http.adapters.response.streams._CLEANUP_PHASE
orionis.http.adapters.response.streams.html#_CLEANUP_PHASE
Attribute
Constant
PUBLIC
Central reporting phase shared by response-stream finalizers.
-
orionis.http.adapters.response.streams._SyncStreamIterator
orionis.http.adapters.response.streams._SyncStreamIterator.html
Class
Class
PUBLIC
Own a synchronous byte source before its first asynchronous read.
-
orionis.http.adapters.response.streams._SyncStreamIterator.__slots__
orionis.http.adapters.response.streams._SyncStreamIterator.html#__slots__
Attribute
Class Variable
PUBLIC
Retain the source and its lazily initialized iterator.
-
orionis.http.adapters.response.streams._SyncStreamIterator.__init__
orionis.http.adapters.response.streams._SyncStreamIterator.html#__init__
Function
Method
PUBLIC
Retain the source without starting iteration.
-
orionis.http.adapters.response.streams._SyncStreamIterator._source
orionis.http.adapters.response.streams._SyncStreamIterator.html#_source
Attribute
Instance Variable
PUBLIC
Owned source, cleared when cleanup begins.
-
orionis.http.adapters.response.streams._SyncStreamIterator._iterator
orionis.http.adapters.response.streams._SyncStreamIterator.html#_iterator
Attribute
Instance Variable
PUBLIC
Iterator created only when the first body chunk is requested.
-
orionis.http.adapters.response.streams._SyncStreamIterator.__anext__
orionis.http.adapters.response.streams._SyncStreamIterator.html#__anext__
Function
Method
PUBLIC
Read one byte chunk and close the source on exhaustion.
-
orionis.http.adapters.response.streams._SyncStreamIterator.aclose
orionis.http.adapters.response.streams._SyncStreamIterator.html#aclose
Function
Method
PUBLIC
Close the active iterator or the unstarted source exactly once.
-
orionis.http.adapters.response.streams.close_stream
orionis.http.adapters.response.streams.html#close_stream
Function
Function
PUBLIC
Close an iterator without letting cleanup erase a delivery failure.
-
orionis.http.adapters.response.streams._finish_cancelled_cleanup
orionis.http.adapters.response.streams.html#_finish_cancelled_cleanup
Function
Function
PUBLIC
Join owned cleanup after cancellation and retain its failure cause.
-
orionis.http.adapters.response.streams.await_cleanup
orionis.http.adapters.response.streams.html#await_cleanup
Function
Function
PUBLIC
Await owned cleanup before propagating cancellation to its caller.
-
orionis.http.adapters.response.streams._raise_task_errors
orionis.http.adapters.response.streams.html#_raise_task_errors
Function
Function
PUBLIC
Propagate real sender and watcher failures after both tasks finish.
-
orionis.http.adapters.response.streams._cancel_tasks
orionis.http.adapters.response.streams.html#_cancel_tasks
Function
Function
PUBLIC
Cancel and join both owned tasks without abandoning asynchronous cleanup.
-
orionis.http.adapters.response.streams._record_completion
orionis.http.adapters.response.streams.html#_record_completion
Function
Function
PUBLIC
Record the first completed future in event-loop callback order.
-
orionis.http.adapters.response.streams.send_until_disconnect
orionis.http.adapters.response.streams.html#send_until_disconnect
Function
Function
PUBLIC
Race a stream delivery against the transport's disconnect notification.
-
orionis.http.contracts.response.IResponse
orionis.http.contracts.response.IResponse.html
Class
Class
PUBLIC
Define the contract for response implementations.
-
orionis.http.contracts.response.IResponse.__slots__
orionis.http.contracts.response.IResponse.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.http.contracts.response.IResponse.withStatusCode
orionis.http.contracts.response.IResponse.html#withStatusCode
Function
Method
PUBLIC
Set the HTTP status code and return the response.
-
orionis.http.contracts.response.IResponse.withBackground
orionis.http.contracts.response.IResponse.html#withBackground
Function
Method
PUBLIC
Set the background task and return the response.
-
orionis.http.contracts.response.IResponse.render
orionis.http.contracts.response.IResponse.html#render
Function
Method
PUBLIC
Render the content to bytes.
-
orionis.http.contracts.response.IResponse.setCookie
orionis.http.contracts.response.IResponse.html#setCookie
Function
Method
PUBLIC
Set a cookie header in the response.
-
orionis.http.contracts.response.IResponse.deleteCookie
orionis.http.contracts.response.IResponse.html#deleteCookie
Function
Method
PUBLIC
Delete a cookie by setting its expiration to the past.
-
orionis.http.contracts.response.IResponse.withCookie
orionis.http.contracts.response.IResponse.html#withCookie
Function
Method
PUBLIC
Attach a cookie and return the response for chaining.
-
orionis.http.contracts.response.IResponse.withCookies
orionis.http.contracts.response.IResponse.html#withCookies
Function
Method
PUBLIC
Attach several cookies at once and return the response.
-
orionis.http.contracts.response.IResponse.withoutCookie
orionis.http.contracts.response.IResponse.html#withoutCookie
Function
Method
PUBLIC
Expire a cookie and return the response for chaining.
-
orionis.http.contracts.response.IResponse.withFlash
orionis.http.contracts.response.IResponse.html#withFlash
Function
Method
PUBLIC
Flash a status message into the session and return the response.
-
orionis.http.contracts.response.IResponse.withInput
orionis.http.contracts.response.IResponse.html#withInput
Function
Method
PUBLIC
Flash the submitted payload so the next request can repopulate it.
-
orionis.http.contracts.response.IResponse.withErrors
orionis.http.contracts.response.IResponse.html#withErrors
Function
Method
PUBLIC
Flash validation errors for the next request.
-
orionis.http.contracts.response.IResponse.getFlashData
orionis.http.contracts.response.IResponse.html#getFlashData
Function
Method
PUBLIC
Return the data queued by withFlash() for the session flash bag.
-
orionis.http.contracts.response.IResponse.getBody
orionis.http.contracts.response.IResponse.html#getBody
Function
Method
PUBLIC
Return the response body as bytes.
-
orionis.http.contracts.response.IResponse.getStream
orionis.http.contracts.response.IResponse.html#getStream
Function
Method
PUBLIC
Return the response stream if present.
-
orionis.http.contracts.response.IResponse.hasStream
orionis.http.contracts.response.IResponse.html#hasStream
Function
Method
PUBLIC
Check if the response has a stream.
-
orionis.http.contracts.response.IResponse.runBackground
orionis.http.contracts.response.IResponse.html#runBackground
Function
Method
PUBLIC
Run the background task if it exists.
-
orionis.http.contracts.response.IResponse.getStatusCode
orionis.http.contracts.response.IResponse.html#getStatusCode
Function
Method
PUBLIC
Return the HTTP status code of the response.
-
orionis.http.contracts.response.IResponse.getMediaType
orionis.http.contracts.response.IResponse.html#getMediaType
Function
Method
PUBLIC
Return the media type of the response.
-
orionis.http.sse._encode_data
orionis.http.sse.html#_encode_data
Function
Function
PUBLIC
Encode a text payload as one UTF-8 server-sent event.
-
orionis.http.sse._EventStreamIterator
orionis.http.sse._EventStreamIterator.html
Class
Class
PUBLIC
Encode an owned event source without prefetching or buffering events.
-
orionis.http.sse._EventStreamIterator.__slots__
orionis.http.sse._EventStreamIterator.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.http.sse._EventStreamIterator.__init__
orionis.http.sse._EventStreamIterator.html#__init__
Function
Method
PUBLIC
Retain a source without starting its iterator.
-
orionis.http.sse._EventStreamIterator._asynchronous
orionis.http.sse._EventStreamIterator.html#_asynchronous
Attribute
Instance Variable
PUBLIC
Asynchronous produced by isinstance.
-
orionis.http.sse._EventStreamIterator._source
orionis.http.sse._EventStreamIterator.html#_source
Attribute
Instance Variable
PUBLIC
Event source owned until the response adapter closes this wrapper.
-
orionis.http.sse._EventStreamIterator._close_task
orionis.http.sse._EventStreamIterator.html#_close_task
Attribute
Instance Variable
PUBLIC
Shared task coordinating stream closure across concurrent callers.
-
orionis.http.sse._EventStreamIterator._iterator
orionis.http.sse._EventStreamIterator.html#_iterator
Attribute
Instance Variable
PUBLIC
Underlying iterator supplying stream items.
-
orionis.http.sse._EventStreamIterator.__aiter__
orionis.http.sse._EventStreamIterator.html#__aiter__
Function
Method
PUBLIC
Return this single-use byte iterator.
-
orionis.http.sse._EventStreamIterator.__anext__
orionis.http.sse._EventStreamIterator.html#__anext__
Function
Method
PUBLIC
Pull and encode exactly one event when the transport is ready.
-
orionis.http.sse._EventStreamIterator._startClose
orionis.http.sse._EventStreamIterator.html#_startClose
Function
Method
PUBLIC
Release source references and schedule its asynchronous finalizer.
-
orionis.http.sse._EventStreamIterator.aclose
orionis.http.sse._EventStreamIterator.html#aclose
Function
Method
PUBLIC
Close the owned iterator once and release its source references.
-
orionis.session.flash.OLD_INPUT_KEY
orionis.session.flash.html#OLD_INPUT_KEY
Attribute
Constant
PUBLIC
Reserved flash-bag keys owned by the framework. Application code must never write them directly; use withInput() / withErrors() instead.
-
orionis.session.flash.ERRORS_KEY
orionis.session.flash.html#ERRORS_KEY
Attribute
Constant
PUBLIC
Session key containing flashed validation errors.
-
orionis.session.flash.PREVIOUS_URL_KEY
orionis.session.flash.html#PREVIOUS_URL_KEY
Attribute
Constant
PUBLIC
Reserved session key holding the last page the user navigated to.
-
orionis.session.flash.SENSITIVE_INPUT_FIELDS
orionis.session.flash.html#SENSITIVE_INPUT_FIELDS
Attribute
Constant
PUBLIC
Never carried over when repopulating a form.
-
orionis.session.flash._SEQUENCE_TYPES
orionis.session.flash.html#_SEQUENCE_TYPES
Attribute
Constant
PUBLIC
Hoisted so the isinstance check does not rebuild the tuple on every field.
-
orionis.session.flash.filter_input
orionis.session.flash.html#filter_input
Function
Function
PUBLIC
Drop credential-like fields from a form payload before flashing it.
-
orionis.session.flash._normalize_message
orionis.session.flash.html#_normalize_message
Function
Function
PUBLIC
Extract a structured message or stringify a scalar value.
-
orionis.session.flash.normalize_errors
orionis.session.flash.html#normalize_errors
Function
Function
PUBLIC
Normalize validation errors into field-indexed message lists.
-
orionis.session.flash.queue_bag
orionis.session.flash.html#queue_bag
Function
Function
PUBLIC
Merge values into the reserved bag key of a pending flash payload.
-
orionis.session.flash.apply_flash
orionis.session.flash.html#apply_flash
Function
Function
PUBLIC
Write a pending flash payload into the session.
-
orionis.session.flash._FlashData
orionis.session.flash._FlashData.html
Class
Class
PUBLIC
Queue flash payloads for responses and deferred views.
-
orionis.session.flash._FlashData.__slots__
orionis.session.flash._FlashData.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.session.flash._FlashData._flash
orionis.session.flash._FlashData.html#_flash
Attribute
Instance Variable
PUBLIC
Session values scheduled for availability during the next request.
-
orionis.session.flash._FlashData.withFlash
orionis.session.flash._FlashData.html#withFlash
Function
Method
PUBLIC
Queue a status message for the owning response or pending view.
-
orionis.session.flash._FlashData.withInput
orionis.session.flash._FlashData.html#withInput
Function
Method
PUBLIC
Flash the submitted payload so the next request can repopulate it.
-
orionis.session.flash._FlashData.withErrors
orionis.session.flash._FlashData.html#withErrors
Function
Method
PUBLIC
Flash validation errors for the next request.
-
orionis.http.responses._STATUS_CODE_TYPE_ERROR
orionis.http.responses.html#_STATUS_CODE_TYPE_ERROR
Attribute
Constant
PUBLIC
Describe the required integer status-code type.
-
orionis.http.layer.contracts.middleware.IBaseMiddleware
orionis.http.layer.contracts.middleware.IBaseMiddleware.html
Class
Class
PUBLIC
Define the base contract for all HTTP middlewares in the pipeline.
-
orionis.http.layer.contracts.middleware.IBaseMiddleware.__slots__
orionis.http.layer.contracts.middleware.IBaseMiddleware.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.http.layer.contracts.middleware.IBaseMiddleware.handle
orionis.http.layer.contracts.middleware.IBaseMiddleware.html#handle
Function
Method
PUBLIC
Process an incoming HTTP request and delegate to next handler.
-
orionis.foundation.contracts.application._SENTINEL
orionis.foundation.contracts.application.html#_SENTINEL
Attribute
Constant
PUBLIC
Sentinel distinguishing sentinel from ordinary values.
-
orionis.cache.CacheManager
orionis.cache.CacheManager.html
Class
Class
PUBLIC
Resolve configured cache stores and reuse their repositories.
-
orionis.cache.CacheManager.__slots__
orionis.cache.CacheManager.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.cache.CacheManager.__init__
orionis.cache.CacheManager.html#__init__
Function
Method
PUBLIC
Initialize the manager and resolve the active cache configuration.
-
orionis.cache.CacheManager._app
orionis.cache.CacheManager.html#_app
Attribute
Instance Variable
PUBLIC
Application container used to read config and the base path.
-
orionis.cache.CacheManager._base_path
orionis.cache.CacheManager.html#_base_path
Attribute
Instance Variable
PUBLIC
Base path obtained from app.basePath.
-
orionis.cache.CacheManager._config
orionis.cache.CacheManager.html#_config
Attribute
Instance Variable
PUBLIC
Validated configuration used to construct and operate the service.
-
orionis.cache.CacheManager._default
orionis.cache.CacheManager.html#_default
Attribute
Instance Variable
PUBLIC
Value used when the client omits this argument.
-
orionis.cache.CacheManager._prefix
orionis.cache.CacheManager.html#_prefix
Attribute
Instance Variable
PUBLIC
Prefix applied when constructing names or storage keys.
-
orionis.cache.CacheManager._repositories
orionis.cache.CacheManager.html#_repositories
Attribute
Instance Variable
PUBLIC
Cache repositories already resolved, indexed by store name.
-
orionis.cache.CacheManager._repositories_lock
orionis.cache.CacheManager.html#_repositories_lock
Attribute
Instance Variable
PUBLIC
Serialize initial repository construction across calling threads.
-
orionis.cache.CacheManager.store
orionis.cache.CacheManager.html#store
Function
Method
PUBLIC
Return the named or default cache repository.
-
orionis.cache.CacheManager._buildBackend
orionis.cache.CacheManager.html#_buildBackend
Function
Method
PUBLIC
Instantiate and return the raw backend for name.
-
orionis.cache.CacheManager._buildDatabaseBackend
orionis.cache.CacheManager.html#_buildDatabaseBackend
Function
Method
PUBLIC
Instantiate and return the database cache backend.
-
orionis.cache.CacheManager.get
orionis.cache.CacheManager.html#get
Function
Method
PUBLIC
Retrieve the value for key from the default store.
-
orionis.cache.CacheManager.set
orionis.cache.CacheManager.html#set
Function
Method
PUBLIC
Store value under key in the default store.
-
orionis.cache.CacheManager.has
orionis.cache.CacheManager.html#has
Function
Method
PUBLIC
Check whether key exists and has not expired in the default store.
-
orionis.cache.CacheManager.delete
orionis.cache.CacheManager.html#delete
Function
Method
PUBLIC
Remove key from the default store.
-
orionis.cache.CacheManager.clear
orionis.cache.CacheManager.html#clear
Function
Method
PUBLIC
Remove all entries from the default store.
-
orionis.cache.CacheManager.getMany
orionis.cache.CacheManager.html#getMany
Function
Method
PUBLIC
Retrieve multiple values from the default store.
-
orionis.cache.CacheManager.setMany
orionis.cache.CacheManager.html#setMany
Function
Method
PUBLIC
Store multiple key/value pairs in the default store.
-
orionis.cache.CacheManager.remember
orionis.cache.CacheManager.html#remember
Function
Method
PUBLIC
Return the cached value for key; resolve and cache if absent.
-
orionis.cache.CacheManager.rememberOnce
orionis.cache.CacheManager.html#rememberOnce
Function
Method
PUBLIC
Coalesce misses in the default store with explicit admission bounds.
-
orionis.cache.CacheManager.rememberForever
orionis.cache.CacheManager.html#rememberForever
Function
Method
PUBLIC
Return the cached value for key; resolve and cache forever if absent.
-
orionis.cache.CacheManager.pull
orionis.cache.CacheManager.html#pull
Function
Method
PUBLIC
Return and immediately delete key from the default store.
-
orionis.cache.CacheManager.add
orionis.cache.CacheManager.html#add
Function
Method
PUBLIC
Store value only if key is absent in the default store.
-
orionis.cache.CacheManager.increment
orionis.cache.CacheManager.html#increment
Function
Method
PUBLIC
Increment the integer at key by amount in the default store.
-
orionis.cache.CacheManager.decrement
orionis.cache.CacheManager.html#decrement
Function
Method
PUBLIC
Decrement the integer at key by amount in the default store.
-
orionis.cache.CacheManager.lock
orionis.cache.CacheManager.html#lock
Function
Method
PUBLIC
Return an async context-manager lock for key on the default store.
-
orionis.support.types.sentinel._MissingType
orionis.support.types.sentinel._MissingType.html
Class
Class
PUBLIC
Represent the absence of a value without conflating it with None.
-
orionis.support.types.sentinel._MissingType.__repr__
orionis.support.types.sentinel._MissingType.html#__repr__
Function
Method
PUBLIC
Return a string representation of the sentinel.
-
orionis.support.types.sentinel._MissingType.__bool__
orionis.support.types.sentinel._MissingType.html#__bool__
Function
Method
PUBLIC
Return False to indicate the sentinel is falsy.
-
orionis.support.types.sentinel._MissingType.__copy__
orionis.support.types.sentinel._MissingType.html#__copy__
Function
Method
PUBLIC
Preserve this immutable marker when copied.
-
orionis.support.types.sentinel._MissingType.__deepcopy__
orionis.support.types.sentinel._MissingType.html#__deepcopy__
Function
Method
PUBLIC
Preserve this immutable marker when copying an object graph.
-
orionis.support.types.sentinel._MissingType.__reduce__
orionis.support.types.sentinel._MissingType.html#__reduce__
Function
Method
PUBLIC
Resolve the canonical marker by its module global during unpickling.
-
orionis.cache.serializer._TK
orionis.cache.serializer.html#_TK
Attribute
Constant
PUBLIC
Keys for type-discriminated payloads in the encoder output.
-
orionis.cache.serializer._VK
orionis.cache.serializer.html#_VK
Attribute
Constant
PUBLIC
__value__.
-
orionis.cache.serializer._identity
orionis.cache.serializer.html#_identity
Function
Function
PUBLIC
Return o unchanged.
-
orionis.cache.serializer._encode_subclass
orionis.cache.serializer.html#_encode_subclass
Function
Function
PUBLIC
Encode subclass instances not covered by the exact-type dispatch table.
-
orionis.cache.serializer._ENCODE_EXACT
orionis.cache.serializer.html#_ENCODE_EXACT
Attribute
Constant
PUBLIC
Map supported types to their encoder functions.
-
orionis.cache.serializer._encode
orionis.cache.serializer.html#_encode
Function
Function
PUBLIC
Encode a Python object into a JSON-compatible structure.
-
orionis.cache.serializer._dec_missing
orionis.cache.serializer.html#_dec_missing
Function
Function
PUBLIC
Return the singleton marker for missing values.
-
orionis.cache.serializer._dec_type
orionis.cache.serializer.html#_dec_type
Function
Function
PUBLIC
Resolve a dotted class path to the corresponding type object.
-
orionis.cache.serializer._dec_enum
orionis.cache.serializer.html#_dec_enum
Function
Function
PUBLIC
Reconstruct an enum member from its serialized class path and value.
-
orionis.cache.serializer._dec_timedelta
orionis.cache.serializer.html#_dec_timedelta
Function
Function
PUBLIC
Decode a mapping into a datetime.timedelta.
-
orionis.cache.serializer._dec_tuple
orionis.cache.serializer.html#_dec_tuple
Function
Function
PUBLIC
Decode an iterable payload into a tuple.
-
orionis.cache.serializer._dec_set
orionis.cache.serializer.html#_dec_set
Function
Function
PUBLIC
Decode an iterable payload into a set.
-
orionis.cache.serializer._dec_frozenset
orionis.cache.serializer.html#_dec_frozenset
Function
Function
PUBLIC
Decode an iterable payload into a frozenset.
-
orionis.cache.serializer._dec_complex
orionis.cache.serializer.html#_dec_complex
Function
Function
PUBLIC
Decode a mapping payload into a complex number.
-
orionis.cache.serializer._DECODE_DISPATCH
orionis.cache.serializer.html#_DECODE_DISPATCH
Attribute
Constant
PUBLIC
keyed by the type string written by the encoder.
-
orionis.cache.serializer._decode
orionis.cache.serializer.html#_decode
Function
Function
PUBLIC
Decode recursively serialized cache payloads into Python objects.
-
orionis.cache.serializer.Serializer
orionis.cache.serializer.Serializer.html
Class
Class
PUBLIC
Encode and decode cache values with the configured serialization format.
-
orionis.cache.serializer.Serializer.dumps
orionis.cache.serializer.Serializer.html#dumps
Function
Static Method
PUBLIC
Serialize an object to a JSON-formatted string.
-
orionis.cache.serializer.Serializer.loads
orionis.cache.serializer.Serializer.html#loads
Function
Static Method
PUBLIC
Deserialize a JSON-formatted string to a Python object.
-
orionis.cache.serializer.Serializer.dumpToFile
orionis.cache.serializer.Serializer.html#dumpToFile
Function
Static Method
PUBLIC
Write serialized data to a file atomically.
-
orionis.cache.serializer.Serializer.loadFromFile
orionis.cache.serializer.Serializer.html#loadFromFile
Function
Static Method
PUBLIC
Load and deserialize data from a file.
-
orionis.cache.FileBasedCache
orionis.cache.FileBasedCache.html
Class
Class
PUBLIC
Persist named cache entries in a filesystem directory.
-
orionis.cache.FileBasedCache.__slots__
orionis.cache.FileBasedCache.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.cache.FileBasedCache.CACHE_VERSION
orionis.cache.FileBasedCache.html#CACHE_VERSION
Attribute
Constant
PUBLIC
Cache version value used by FileBasedCache.
-
orionis.cache.FileBasedCache.__init__
orionis.cache.FileBasedCache.html#__init__
Function
Method
PUBLIC
Initialize the FileBasedCache instance.
-
orionis.cache.FileBasedCache.__path
orionis.cache.FileBasedCache.html#__path
Attribute
Instance Variable
PUBLIC
Directory path where the cache file will be stored.
-
orionis.cache.FileBasedCache.__file
orionis.cache.FileBasedCache.html#__file
Attribute
Instance Variable
PUBLIC
Resolved filesystem path of the persistent cache entry.
-
orionis.cache.FileBasedCache.__file_resolved
orionis.cache.FileBasedCache.html#__file_resolved
Attribute
Instance Variable
PUBLIC
Store the resolved cache file path for later access.
-
orionis.cache.FileBasedCache.__monitored_dirs
orionis.cache.FileBasedCache.html#__monitored_dirs
Attribute
Instance Variable
PUBLIC
List of directories to monitor for changes.
-
orionis.cache.FileBasedCache.__monitored_files
orionis.cache.FileBasedCache.html#__monitored_files
Attribute
Instance Variable
PUBLIC
List of files to monitor for changes.
-
orionis.cache.FileBasedCache.__sourceshashcache
orionis.cache.FileBasedCache.html#__sourceshashcache
Attribute
Instance Variable
PUBLIC
Internal cache for source hash and timing.
-
orionis.cache.FileBasedCache.__lasthashcheck
orionis.cache.FileBasedCache.html#__lasthashcheck
Attribute
Instance Variable
PUBLIC
Lasthashcheck value used by FileBasedCache.
-
orionis.cache.FileBasedCache.__hashInterval
orionis.cache.FileBasedCache.html#__hashInterval
Attribute
Instance Variable
PUBLIC
Hash interval value used by FileBasedCache.
-
orionis.cache.FileBasedCache.get
orionis.cache.FileBasedCache.html#get
Function
Method
PUBLIC
Retrieve cached data if valid.
-
orionis.cache.FileBasedCache.save
orionis.cache.FileBasedCache.html#save
Function
Method
PUBLIC
Save the provided data to the cache file if it has changed.
-
orionis.cache.FileBasedCache.clear
orionis.cache.FileBasedCache.html#clear
Function
Method
PUBLIC
Remove the cache file if it exists.
-
orionis.cache.FileBasedCache.__collectFromDirs
orionis.cache.FileBasedCache.html#__collectFromDirs
Function
Method
PUBLIC
Collect deduplicated Python files from monitored directories.
-
orionis.cache.FileBasedCache.__collectFromFiles
orionis.cache.FileBasedCache.html#__collectFromFiles
Function
Method
PUBLIC
Add deduplicated monitored files to the result list.
-
orionis.cache.FileBasedCache.__collectFiles
orionis.cache.FileBasedCache.html#__collectFiles
Function
Method
PUBLIC
Collect monitored files for hashing and deduplicate them.
-
orionis.cache.FileBasedCache.__computeSourcesHash
orionis.cache.FileBasedCache.html#__computeSourcesHash
Function
Method
PUBLIC
Compute and return a hash representing the state of monitored sources.
-
orionis.cache.CacheRepository
orionis.cache.CacheRepository.html
Class
Class
PUBLIC
Async cache repository backed by a configurable storage backend.
-
orionis.cache.CacheRepository.__slots__
orionis.cache.CacheRepository.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.cache.CacheRepository.__init__
orionis.cache.CacheRepository.html#__init__
Function
Method
PUBLIC
Initialise the repository with a backend and an optional key prefix.
-
orionis.cache.CacheRepository._backend
orionis.cache.CacheRepository.html#_backend
Attribute
Instance Variable
PUBLIC
Storage backend implementing the low-level cache protocol.
-
orionis.cache.CacheRepository._prefix
orionis.cache.CacheRepository.html#_prefix
Attribute
Instance Variable
PUBLIC
String prepended to every key, separated by :.
-
orionis.cache.CacheRepository._k
orionis.cache.CacheRepository.html#_k
Function
Method
PUBLIC
Return the prefixed form of key.
-
orionis.cache.CacheRepository.replace
orionis.cache.CacheRepository.html#replace
Function
Method
PUBLIC
Replace a live entry without resurrecting a deleted key.
-
orionis.cache.CacheRepository.get
orionis.cache.CacheRepository.html#get
Function
Method
PUBLIC
Return the cached value for key, or None when absent.
-
orionis.cache.CacheRepository.set
orionis.cache.CacheRepository.html#set
Function
Method
PUBLIC
Store value under key with an optional time-to-live.
-
orionis.cache.CacheRepository.has
orionis.cache.CacheRepository.html#has
Function
Method
PUBLIC
Return True if key exists and has not expired.
-
orionis.cache.CacheRepository.delete
orionis.cache.CacheRepository.html#delete
Function
Method
PUBLIC
Remove key from the cache store.
-
orionis.cache.CacheRepository.clear
orionis.cache.CacheRepository.html#clear
Function
Method
PUBLIC
Remove all entries from the cache store.
-
orionis.cache.CacheRepository.getMany
orionis.cache.CacheRepository.html#getMany
Function
Method
PUBLIC
Return a mapping of key → value for all requested keys.
-
orionis.cache.CacheRepository.setMany
orionis.cache.CacheRepository.html#setMany
Function
Method
PUBLIC
Store multiple key/value pairs with an optional shared TTL.
-
orionis.cache.CacheRepository.remember
orionis.cache.CacheRepository.html#remember
Function
Method
PUBLIC
Return the cached value for key, computing it on a cache miss.
-
orionis.cache.CacheRepository._getCached
orionis.cache.CacheRepository.html#_getCached
Function
Method
PUBLIC
Read a value without confusing serialized null with a missing key.
-
orionis.cache.CacheRepository.rememberOnce
orionis.cache.CacheRepository.html#rememberOnce
Function
Method
PUBLIC
Coalesce concurrent misses without changing remember semantics.
-
orionis.cache.CacheRepository.rememberForever
orionis.cache.CacheRepository.html#rememberForever
Function
Method
PUBLIC
Cache the value for key indefinitely, resolving on a miss.
-
orionis.cache.CacheRepository.pull
orionis.cache.CacheRepository.html#pull
Function
Method
PUBLIC
Return the cached value for key and immediately remove it.
-
orionis.cache.CacheRepository.add
orionis.cache.CacheRepository.html#add
Function
Method
PUBLIC
Store value under key only when the key does not already exist.
-
orionis.cache.CacheRepository.increment
orionis.cache.CacheRepository.html#increment
Function
Method
PUBLIC
Increment the integer stored at key by amount.
-
orionis.cache.CacheRepository.decrement
orionis.cache.CacheRepository.html#decrement
Function
Method
PUBLIC
Decrement the integer stored at key by amount.
-
orionis.cache.CacheRepository.lock
orionis.cache.CacheRepository.html#lock
Function
Method
PUBLIC
Return an async context manager that acquires a distributed lock.
-
orionis.cache._EXPORTS
orionis.cache.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.cache.__getattr__
orionis.cache.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.cache.__dir__
orionis.cache.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.console.contracts.kernel.IKernelCLI
orionis.console.contracts.kernel.IKernelCLI.html
Class
Class
PUBLIC
Define the contract for kernel cli implementations.
-
orionis.console.contracts.kernel.IKernelCLI.__slots__
orionis.console.contracts.kernel.IKernelCLI.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.console.contracts.kernel.IKernelCLI.boot
orionis.console.contracts.kernel.IKernelCLI.html#boot
Function
Method
PUBLIC
Initialize the kernel CLI and register commands with the reactor.
-
orionis.console.contracts.kernel.IKernelCLI.handle
orionis.console.contracts.kernel.IKernelCLI.html#handle
Function
Method
PUBLIC
Process and dispatch command line arguments to the appropriate handler.
-
orionis.console.stdio._PROTOCOL_STDOUT
orionis.console.stdio.html#_PROTOCOL_STDOUT
Attribute
Constant
PUBLIC
Context-local protocol stdout isolated between asynchronous tasks.
-
orionis.console.stdio.protocol_stdout
orionis.console.stdio.html#protocol_stdout
Function
Function
PUBLIC
Return the original protocol writer while diagnostic stdout is redirected.
-
orionis.console.stdio.protocol_stdio
orionis.console.stdio.html#protocol_stdio
Function
Function
PUBLIC
Route MCP bootstrap, command, and shutdown diagnostics to STDERR.
-
orionis.introspection.dependencies.entities.argument.Argument
orionis.introspection.dependencies.entities.argument.Argument.html
Class
Class
PUBLIC
Represent a function or method argument with type and resolution metadata.
-
orionis.introspection.dependencies.entities.argument.Argument.name
orionis.introspection.dependencies.entities.argument.Argument.html#name
Attribute
Instance Variable
PUBLIC
The name of the argument.
-
orionis.introspection.dependencies.entities.argument.Argument.resolved
orionis.introspection.dependencies.entities.argument.Argument.html#resolved
Attribute
Instance Variable
PUBLIC
Indicates whether the argument has been resolved or processed.
-
orionis.introspection.dependencies.entities.argument.Argument.module_name
orionis.introspection.dependencies.entities.argument.Argument.html#module_name
Attribute
Instance Variable
PUBLIC
The module where the argument's type is defined.
-
orionis.introspection.dependencies.entities.argument.Argument.class_name
orionis.introspection.dependencies.entities.argument.Argument.html#class_name
Attribute
Instance Variable
PUBLIC
The class representing the argument's type.
-
orionis.introspection.dependencies.entities.argument.Argument.type
orionis.introspection.dependencies.entities.argument.Argument.html#type
Attribute
Instance Variable
PUBLIC
The Python type object for the argument's type.
-
orionis.introspection.dependencies.entities.argument.Argument.full_class_path
orionis.introspection.dependencies.entities.argument.Argument.html#full_class_path
Attribute
Instance Variable
PUBLIC
The complete dotted path to the argument's type (module.class).
-
orionis.introspection.dependencies.entities.argument.Argument.is_keyword_only
orionis.introspection.dependencies.entities.argument.Argument.html#is_keyword_only
Attribute
Instance Variable
PUBLIC
Indicates if the argument is keyword-only (default is False).
-
orionis.introspection.dependencies.entities.argument.Argument.is_schema
orionis.introspection.dependencies.entities.argument.Argument.html#is_schema
Attribute
Instance Variable
PUBLIC
Indicates if the argument is a schema (default is False).
-
orionis.introspection.dependencies.entities.argument.Argument.default
orionis.introspection.dependencies.entities.argument.Argument.html#default
Attribute
Instance Variable
PUBLIC
The default value of the argument, if any (default is None).
-
orionis.introspection.dependencies.entities.argument.Argument.__post_init__
orionis.introspection.dependencies.entities.argument.Argument.html#__post_init__
Function
Method
PUBLIC
Validate field types after dataclass initialisation.
-
orionis.introspection.dependencies.entities.signature.Signature
orionis.introspection.dependencies.entities.signature.Signature.html
Class
Class
PUBLIC
Represent the categorized dependency signature of a callable.
-
orionis.introspection.dependencies.entities.signature.Signature.resolved
orionis.introspection.dependencies.entities.signature.Signature.html#resolved
Attribute
Instance Variable
PUBLIC
Parameters whose types or defaults are fully known.
-
orionis.introspection.dependencies.entities.signature.Signature.unresolved
orionis.introspection.dependencies.entities.signature.Signature.html#unresolved
Attribute
Instance Variable
PUBLIC
Parameters that lack sufficient type or default information.
-
orionis.introspection.dependencies.entities.signature.Signature.ordered
orionis.introspection.dependencies.entities.signature.Signature.html#ordered
Attribute
Instance Variable
PUBLIC
All parameters in their original declaration order.
-
orionis.introspection.dependencies.entities.signature.Signature.__post_init__
orionis.introspection.dependencies.entities.signature.Signature.html#__post_init__
Function
Method
PUBLIC
Validate that all three bucket fields are dictionaries.
-
orionis.introspection.dependencies.entities.signature.Signature.hasParameters
orionis.introspection.dependencies.entities.signature.Signature.html#hasParameters
Function
Method
PUBLIC
Determine whether the callable defines any parameters.
-
orionis.introspection.dependencies.entities.signature.Signature.noArgumentsRequired
orionis.introspection.dependencies.entities.signature.Signature.html#noArgumentsRequired
Function
Method
PUBLIC
Determine whether the callable requires no arguments.
-
orionis.introspection.dependencies.entities.signature.Signature.hasUnresolvedArguments
orionis.introspection.dependencies.entities.signature.Signature.html#hasUnresolvedArguments
Function
Method
PUBLIC
Determine whether any unresolved parameters exist.
-
orionis.introspection.dependencies.entities.signature.Signature.getResolved
orionis.introspection.dependencies.entities.signature.Signature.html#getResolved
Function
Method
PUBLIC
Return the resolved parameter dictionary.
-
orionis.introspection.dependencies.entities.signature.Signature.getUnresolved
orionis.introspection.dependencies.entities.signature.Signature.html#getUnresolved
Function
Method
PUBLIC
Return the unresolved parameter dictionary.
-
orionis.introspection.dependencies.entities.signature.Signature.getAllOrdered
orionis.introspection.dependencies.entities.signature.Signature.html#getAllOrdered
Function
Method
PUBLIC
Return all parameters in their original declaration order.
-
orionis.introspection.dependencies.entities.signature.Signature.getPositionalOnly
orionis.introspection.dependencies.entities.signature.Signature.html#getPositionalOnly
Function
Method
PUBLIC
Return parameters that are not keyword-only.
-
orionis.introspection.dependencies.entities.signature.Signature.getKeywordOnly
orionis.introspection.dependencies.entities.signature.Signature.html#getKeywordOnly
Function
Method
PUBLIC
Return parameters that are keyword-only.
-
orionis.introspection.dependencies.entities.signature.Signature.toDict
orionis.introspection.dependencies.entities.signature.Signature.html#toDict
Function
Method
PUBLIC
Return the ordered parameters as a plain dictionary.
-
orionis.introspection.dependencies.entities.signature.Signature.resolvedToDict
orionis.introspection.dependencies.entities.signature.Signature.html#resolvedToDict
Function
Method
PUBLIC
Return the resolved parameters as a plain dictionary.
-
orionis.introspection.dependencies.entities.signature.Signature.unresolvedToDict
orionis.introspection.dependencies.entities.signature.Signature.html#unresolvedToDict
Function
Method
PUBLIC
Return the unresolved parameters as a plain dictionary.
-
orionis.introspection.dependencies.entities.signature.Signature.arguments
orionis.introspection.dependencies.entities.signature.Signature.html#arguments
Function
Method
PUBLIC
Return an iterable view of all parameters in declaration order.
-
orionis.introspection.callables.contracts.reflection.IReflectionCallable
orionis.introspection.callables.contracts.reflection.IReflectionCallable.html
Class
Class
PUBLIC
Define the contract for reflection callable implementations.
-
orionis.introspection.callables.contracts.reflection.IReflectionCallable.__slots__
orionis.introspection.callables.contracts.reflection.IReflectionCallable.html#__slots__
Attribute
Class Variable
PUBLIC
Empty slots so subclasses can define __slots__ without inheriting __dict__.
-
orionis.introspection.callables.contracts.reflection.IReflectionCallable.getCallable
orionis.introspection.callables.contracts.reflection.IReflectionCallable.html#getCallable
Function
Method
PUBLIC
Return the callable function associated with this instance.
-
orionis.introspection.callables.contracts.reflection.IReflectionCallable.getName
orionis.introspection.callables.contracts.reflection.IReflectionCallable.html#getName
Function
Method
PUBLIC
Return the name of the callable.
-
orionis.introspection.callables.contracts.reflection.IReflectionCallable.getModuleName
orionis.introspection.callables.contracts.reflection.IReflectionCallable.html#getModuleName
Function
Method
PUBLIC
Return the module name where the callable is defined.
-
orionis.introspection.callables.contracts.reflection.IReflectionCallable.getModuleWithCallableName
orionis.introspection.callables.contracts.reflection.IReflectionCallable.html#getModuleWithCallableName
Function
Method
PUBLIC
Return the fully qualified name of the callable.
-
orionis.introspection.callables.contracts.reflection.IReflectionCallable.getDocstring
orionis.introspection.callables.contracts.reflection.IReflectionCallable.html#getDocstring
Function
Method
PUBLIC
Return the docstring of the callable.
-
orionis.introspection.callables.contracts.reflection.IReflectionCallable.getSourceCode
orionis.introspection.callables.contracts.reflection.IReflectionCallable.html#getSourceCode
Function
Method
PUBLIC
Retrieve the source code of the wrapped callable.
-
orionis.introspection.callables.contracts.reflection.IReflectionCallable.getFile
orionis.introspection.callables.contracts.reflection.IReflectionCallable.html#getFile
Function
Method
PUBLIC
Retrieve the absolute path to the source file of the callable.
-
orionis.introspection.callables.contracts.reflection.IReflectionCallable.getSignature
orionis.introspection.callables.contracts.reflection.IReflectionCallable.html#getSignature
Function
Method
PUBLIC
Return the signature of the callable.
-
orionis.introspection.callables.contracts.reflection.IReflectionCallable.getDependencies
orionis.introspection.callables.contracts.reflection.IReflectionCallable.html#getDependencies
Function
Method
PUBLIC
Analyze and return the dependency signature of the wrapped callable.
-
orionis.introspection.callables.contracts.reflection.IReflectionCallable.clearCache
orionis.introspection.callables.contracts.reflection.IReflectionCallable.html#clearCache
Function
Method
PUBLIC
Clear all cached reflection data.
-
orionis.introspection.dependencies.contracts.reflection.IReflectDependencies
orionis.introspection.dependencies.contracts.reflection.IReflectDependencies.html
Class
Class
PUBLIC
Define the contract for dependency-reflection implementations.
-
orionis.introspection.dependencies.contracts.reflection.IReflectDependencies.__slots__
orionis.introspection.dependencies.contracts.reflection.IReflectDependencies.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.introspection.dependencies.contracts.reflection.IReflectDependencies.constructorSignature
orionis.introspection.dependencies.contracts.reflection.IReflectDependencies.html#constructorSignature
Function
Method
PUBLIC
Inspect the constructor (__init__) and categorize parameter dependencies.
-
orionis.introspection.dependencies.contracts.reflection.IReflectDependencies.methodSignature
orionis.introspection.dependencies.contracts.reflection.IReflectDependencies.html#methodSignature
Function
Method
PUBLIC
Inspect a named method and categorize its parameter dependencies.
-
orionis.introspection.dependencies.contracts.reflection.IReflectDependencies.callableSignature
orionis.introspection.dependencies.contracts.reflection.IReflectDependencies.html#callableSignature
Function
Method
PUBLIC
Inspect the callable target and categorize its parameter dependencies.
-
orionis.introspection.dependencies.reflection._SKIP_KINDS
orionis.introspection.dependencies.reflection.html#_SKIP_KINDS
Attribute
Constant
PUBLIC
Skip kinds used by reflection.
-
orionis.introspection.dependencies.reflection._ANY_TYPE
orionis.introspection.dependencies.reflection.html#_ANY_TYPE
Attribute
Constant
PUBLIC
Any type used by reflection.
-
orionis.introspection.dependencies.reflection._ANY_FULL_PATH
orionis.introspection.dependencies.reflection.html#_ANY_FULL_PATH
Attribute
Constant
PUBLIC
Any full path used by reflection.
-
orionis.introspection.dependencies.reflection._signature_invalidators
orionis.introspection.dependencies.reflection.html#_signature_invalidators
Attribute
Variable
PUBLIC
Dependent cache clearers keyed by stable consumer identifiers.
-
orionis.introspection.dependencies.reflection._register_signature_invalidator
orionis.introspection.dependencies.reflection.html#_register_signature_invalidator
Function
Function
PUBLIC
Register one dependent cache clearer without retaining reloaded callbacks.
-
orionis.introspection.dependencies.reflection._clear_dependency_caches
orionis.introspection.dependencies.reflection.html#_clear_dependency_caches
Function
Function
PUBLIC
Invalidate shared signatures and registered derived metadata explicitly.
-
orionis.introspection.dependencies.reflection._inspect_annotations
orionis.introspection.dependencies.reflection.html#_inspect_annotations
Function
Function
PUBLIC
Read annotations while preserving unknown native deferred references.
-
orionis.introspection.dependencies.reflection._inspect_signature
orionis.introspection.dependencies.reflection.html#_inspect_signature
Function
Function
PUBLIC
Inspect a signature while preserving unavailable native annotations.
-
orionis.introspection.dependencies.reflection._get_signature
orionis.introspection.dependencies.reflection.html#_get_signature
Function
Function
PUBLIC
Return the cached inspect signature for a target.
-
orionis.introspection.dependencies.reflection._resolve_parameter_hint
orionis.introspection.dependencies.reflection.html#_resolve_parameter_hint
Function
Function
PUBLIC
Resolve one string hint independently of other unavailable references.
-
orionis.introspection.dependencies.reflection._resolve_future_annotations
orionis.introspection.dependencies.reflection.html#_resolve_future_annotations
Function
Function
PUBLIC
Resolve available string annotations in a callable signature.
-
orionis.introspection.dependencies.reflection._resolve_annotation
orionis.introspection.dependencies.reflection.html#_resolve_annotation
Function
Function
PUBLIC
Resolve a parameter annotation into its module, name, and type components.
-
orionis.introspection.dependencies.reflection._parameter_dependency
orionis.introspection.dependencies.reflection.html#_parameter_dependency
Function
Function
PUBLIC
Describe one non-variadic parameter using its default or annotation.
-
orionis.introspection.dependencies.reflection._build_dependencies
orionis.introspection.dependencies.reflection.html#_build_dependencies
Function
Function
PUBLIC
Categorize explicit parameters after descriptor binding has been applied.
-
orionis.introspection.dependencies.reflection._cached_resolved_signature
orionis.introspection.dependencies.reflection.html#_cached_resolved_signature
Function
Function
PUBLIC
Return the cached dependency signature for target.
-
orionis.introspection.dependencies.reflection._get_resolved_signature
orionis.introspection.dependencies.reflection.html#_get_resolved_signature
Function
Function
PUBLIC
Return dependency metadata without caching a bound method's receiver.
-
orionis.introspection.callables.reflection._UNSET
orionis.introspection.callables.reflection.html#_UNSET
Attribute
Constant
PUBLIC
distinguishes "not yet cached" from None as a legitimate cached value.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html
Class
Class
PUBLIC
Define the contract for reflection concrete implementations.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getClass
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getClass
Function
Method
PUBLIC
Return the class type being reflected.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getClassName
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getClassName
Function
Method
PUBLIC
Return the name of the reflected class.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getModuleName
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getModuleName
Function
Method
PUBLIC
Return the module name where the reflected class is defined.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getModuleWithClassName
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getModuleWithClassName
Function
Method
PUBLIC
Return the fully qualified class name with module path.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getDocstring
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getDocstring
Function
Method
PUBLIC
Return the docstring of the reflected class.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getBaseClasses
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getBaseClasses
Function
Method
PUBLIC
Return all base classes of the reflected class.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getSourceCode
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getSourceCode
Function
Method
PUBLIC
Retrieve the source code for the class or a specific method.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getFile
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getFile
Function
Method
PUBLIC
Return the absolute file path of the reflected class.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getAnnotations
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getAnnotations
Function
Method
PUBLIC
Retrieve type annotations defined on the reflected class.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.hasAttribute
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#hasAttribute
Function
Method
PUBLIC
Determine if the reflected class has a specific attribute.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getAttribute
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getAttribute
Function
Method
PUBLIC
Retrieve the value of a class attribute.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.setAttribute
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#setAttribute
Function
Method
PUBLIC
Set a class attribute to the specified value.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.removeAttribute
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#removeAttribute
Function
Method
PUBLIC
Remove an attribute from the reflected class.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getAttributes
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getAttributes
Function
Method
PUBLIC
Aggregate all class attributes of all visibility levels.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getPublicAttributes
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getPublicAttributes
Function
Method
PUBLIC
Retrieve all public class attributes.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getProtectedAttributes
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getProtectedAttributes
Function
Method
PUBLIC
Retrieve all protected class attributes.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getPrivateAttributes
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getPrivateAttributes
Function
Method
PUBLIC
Retrieve all private class attributes.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getDunderAttributes
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getDunderAttributes
Function
Method
PUBLIC
Retrieve all dunder (magic) class attributes.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getMagicAttributes
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getMagicAttributes
Function
Method
PUBLIC
Return all magic (dunder) class attributes.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.hasMethod
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#hasMethod
Function
Method
PUBLIC
Determine if the class defines a method with the given name.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.setMethod
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#setMethod
Function
Method
PUBLIC
Add a method to the reflected class.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.removeMethod
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#removeMethod
Function
Method
PUBLIC
Remove a method from the reflected class.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getMethodSignature
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getMethodSignature
Function
Method
PUBLIC
Retrieve the signature of a specific method.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getMethods
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getMethods
Function
Method
PUBLIC
Retrieve all method names defined in the reflected class.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getPublicMethods
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getPublicMethods
Function
Method
PUBLIC
Return all public instance method names of the reflected class.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getPublicSyncMethods
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getPublicSyncMethods
Function
Method
PUBLIC
Return all public synchronous method names of the reflected class.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getPublicAsyncMethods
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getPublicAsyncMethods
Function
Method
PUBLIC
Return all public asynchronous method names of the reflected class.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getProtectedMethods
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getProtectedMethods
Function
Method
PUBLIC
Return all protected instance method names.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getProtectedSyncMethods
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getProtectedSyncMethods
Function
Method
PUBLIC
Return all protected synchronous method names.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getProtectedAsyncMethods
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getProtectedAsyncMethods
Function
Method
PUBLIC
Retrieve all protected asynchronous method names.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getPrivateMethods
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getPrivateMethods
Function
Method
PUBLIC
Retrieve all private instance method names.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getPrivateSyncMethods
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getPrivateSyncMethods
Function
Method
PUBLIC
Return all private synchronous method names of the class.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getPrivateAsyncMethods
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getPrivateAsyncMethods
Function
Method
PUBLIC
Return all private asynchronous method names of the class.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getPublicClassMethods
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getPublicClassMethods
Function
Method
PUBLIC
Return a list of public class method names.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getPublicClassSyncMethods
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getPublicClassSyncMethods
Function
Method
PUBLIC
Return all public synchronous class method names.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getPublicClassAsyncMethods
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getPublicClassAsyncMethods
Function
Method
PUBLIC
Return all public asynchronous class method names.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getProtectedClassMethods
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getProtectedClassMethods
Function
Method
PUBLIC
Return a list of protected class method names.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getProtectedClassSyncMethods
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getProtectedClassSyncMethods
Function
Method
PUBLIC
Return all protected synchronous class method names.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getProtectedClassAsyncMethods
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getProtectedClassAsyncMethods
Function
Method
PUBLIC
Return all protected asynchronous class method names.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getPrivateClassMethods
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getPrivateClassMethods
Function
Method
PUBLIC
Return a list of private class method names.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getPrivateClassSyncMethods
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getPrivateClassSyncMethods
Function
Method
PUBLIC
Return all private synchronous class method names.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getPrivateClassAsyncMethods
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getPrivateClassAsyncMethods
Function
Method
PUBLIC
Return all private asynchronous class method names.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getPublicStaticMethods
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getPublicStaticMethods
Function
Method
PUBLIC
Return a list of public static method names.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getPublicStaticSyncMethods
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getPublicStaticSyncMethods
Function
Method
PUBLIC
Return all public synchronous static method names of the class.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getPublicStaticAsyncMethods
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getPublicStaticAsyncMethods
Function
Method
PUBLIC
Return all public asynchronous static method names of the class.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getProtectedStaticMethods
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getProtectedStaticMethods
Function
Method
PUBLIC
Return a list of protected static method names.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getProtectedStaticSyncMethods
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getProtectedStaticSyncMethods
Function
Method
PUBLIC
Return all protected synchronous static method names of the class.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getProtectedStaticAsyncMethods
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getProtectedStaticAsyncMethods
Function
Method
PUBLIC
Retrieve all protected asynchronous static method names.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getPrivateStaticMethods
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getPrivateStaticMethods
Function
Method
PUBLIC
Return the names of all private static methods of the class.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getPrivateStaticSyncMethods
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getPrivateStaticSyncMethods
Function
Method
PUBLIC
Return all private synchronous static method names of the class.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getPrivateStaticAsyncMethods
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getPrivateStaticAsyncMethods
Function
Method
PUBLIC
Retrieve all private asynchronous static method names of the class.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getDunderMethods
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getDunderMethods
Function
Method
PUBLIC
Retrieve all dunder (magic) method names from the reflected class.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getMagicMethods
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getMagicMethods
Function
Method
PUBLIC
Return all magic (dunder) method names from the reflected class.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getProperties
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getProperties
Function
Method
PUBLIC
Return all property names defined in the reflected class.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getPublicProperties
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getPublicProperties
Function
Method
PUBLIC
Return all public property names of the reflected class.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getProtectedProperties
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getProtectedProperties
Function
Method
PUBLIC
Retrieve all protected property names from the reflected class.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getPrivateProperties
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getPrivateProperties
Function
Method
PUBLIC
Return all private property names of the reflected class.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getProperty
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getProperty
Function
Method
PUBLIC
Retrieve the value of a property from the reflected class.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getPropertySignature
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getPropertySignature
Function
Method
PUBLIC
Return the signature of a property's getter method.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getPropertyDocstring
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getPropertyDocstring
Function
Method
PUBLIC
Retrieve the docstring of a property's getter method.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.getConstructorSignature
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#getConstructorSignature
Function
Method
PUBLIC
Return the signature of the class constructor.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.constructorSignature
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#constructorSignature
Function
Method
PUBLIC
Analyze the constructor's dependencies.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.methodSignature
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#methodSignature
Function
Method
PUBLIC
Analyze the dependencies of a specific method.
-
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.clearCache
orionis.introspection.concretes.contracts.reflection.IReflectionConcrete.html#clearCache
Function
Method
PUBLIC
Clear the internal memory cache.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html
Class
Class
PUBLIC
Define the contract for reflection abstract implementations.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getClass
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getClass
Function
Method
PUBLIC
Return the class type associated with this reflection instance.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getClassName
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getClassName
Function
Method
PUBLIC
Return the name of the reflected abstract class.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getModuleName
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getModuleName
Function
Method
PUBLIC
Return the module name of the reflected abstract class.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getModuleWithClassName
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getModuleWithClassName
Function
Method
PUBLIC
Return the fully qualified name of the abstract class.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getDocstring
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getDocstring
Function
Method
PUBLIC
Retrieve the docstring for the reflected abstract class.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getBaseClasses
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getBaseClasses
Function
Method
PUBLIC
Return the direct base classes of the reflected abstract class.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getSourceCode
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getSourceCode
Function
Method
PUBLIC
Retrieve the source code of the reflected abstract class.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getFile
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getFile
Function
Method
PUBLIC
Retrieve the absolute file path of the reflected abstract class.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getAnnotations
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getAnnotations
Function
Method
PUBLIC
Retrieve type annotations for class attributes.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.hasAttribute
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#hasAttribute
Function
Method
PUBLIC
Check if the class has a specific attribute.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getAttribute
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getAttribute
Function
Method
PUBLIC
Retrieve the value of a class attribute.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.setAttribute
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#setAttribute
Function
Method
PUBLIC
Set the value of a class attribute.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.removeAttribute
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#removeAttribute
Function
Method
PUBLIC
Remove an attribute from the reflected abstract class.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getAttributes
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getAttributes
Function
Method
PUBLIC
Aggregate all class-level attributes.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getPublicAttributes
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getPublicAttributes
Function
Method
PUBLIC
Retrieve all public class-level attributes.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getProtectedAttributes
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getProtectedAttributes
Function
Method
PUBLIC
Retrieve all protected class-level attributes.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getPrivateAttributes
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getPrivateAttributes
Function
Method
PUBLIC
Retrieve all private class-level attributes.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getDunderAttributes
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getDunderAttributes
Function
Method
PUBLIC
Retrieve dunder (double underscore) class-level attributes.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getMagicAttributes
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getMagicAttributes
Function
Method
PUBLIC
Return a dictionary of magic (dunder) class attributes.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.hasMethod
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#hasMethod
Function
Method
PUBLIC
Determine if the abstract class contains a method with the given name.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.removeMethod
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#removeMethod
Function
Method
PUBLIC
Remove a method from the abstract class.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getMethodSignature
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getMethodSignature
Function
Method
PUBLIC
Retrieve the signature of a method in the abstract class.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getMethods
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getMethods
Function
Method
PUBLIC
Return all method names defined in the abstract class.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getPublicMethods
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getPublicMethods
Function
Method
PUBLIC
Return all public instance method names.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getPublicSyncMethods
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getPublicSyncMethods
Function
Method
PUBLIC
Return all public synchronous method names from the abstract class.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getPublicAsyncMethods
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getPublicAsyncMethods
Function
Method
PUBLIC
Return all public asynchronous method names.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getProtectedMethods
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getProtectedMethods
Function
Method
PUBLIC
Return all protected instance method names.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getProtectedSyncMethods
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getProtectedSyncMethods
Function
Method
PUBLIC
Return all protected synchronous method names.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getProtectedAsyncMethods
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getProtectedAsyncMethods
Function
Method
PUBLIC
Return all protected asynchronous method names.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getPrivateMethods
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getPrivateMethods
Function
Method
PUBLIC
Return all private instance method names.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getPrivateSyncMethods
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getPrivateSyncMethods
Function
Method
PUBLIC
Return all private synchronous method names.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getPrivateAsyncMethods
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getPrivateAsyncMethods
Function
Method
PUBLIC
Retrieve private asynchronous method names.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getPublicClassMethods
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getPublicClassMethods
Function
Method
PUBLIC
Return all public class method names.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getPublicClassSyncMethods
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getPublicClassSyncMethods
Function
Method
PUBLIC
Return all public synchronous class method names.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getPublicClassAsyncMethods
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getPublicClassAsyncMethods
Function
Method
PUBLIC
Return all public asynchronous class method names.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getProtectedClassMethods
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getProtectedClassMethods
Function
Method
PUBLIC
Return a list of protected class methods.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getProtectedClassSyncMethods
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getProtectedClassSyncMethods
Function
Method
PUBLIC
Return all protected synchronous class method names.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getProtectedClassAsyncMethods
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getProtectedClassAsyncMethods
Function
Method
PUBLIC
Return all protected asynchronous class method names.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getPrivateClassMethods
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getPrivateClassMethods
Function
Method
PUBLIC
Return a list of private class methods.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getPrivateClassSyncMethods
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getPrivateClassSyncMethods
Function
Method
PUBLIC
Return all private synchronous class method names.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getPrivateClassAsyncMethods
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getPrivateClassAsyncMethods
Function
Method
PUBLIC
Return all private asynchronous class method names.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getPublicStaticMethods
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getPublicStaticMethods
Function
Method
PUBLIC
Return all public static method names.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getPublicStaticSyncMethods
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getPublicStaticSyncMethods
Function
Method
PUBLIC
Return all public synchronous static method names.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getPublicStaticAsyncMethods
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getPublicStaticAsyncMethods
Function
Method
PUBLIC
Return all public asynchronous static method names.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getProtectedStaticMethods
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getProtectedStaticMethods
Function
Method
PUBLIC
Return a list of protected static method names.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getProtectedStaticSyncMethods
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getProtectedStaticSyncMethods
Function
Method
PUBLIC
Return all protected synchronous static method names.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getProtectedStaticAsyncMethods
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getProtectedStaticAsyncMethods
Function
Method
PUBLIC
Return all protected asynchronous static method names.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getPrivateStaticMethods
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getPrivateStaticMethods
Function
Method
PUBLIC
Return a list of private static method names.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getPrivateStaticSyncMethods
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getPrivateStaticSyncMethods
Function
Method
PUBLIC
Return all private synchronous static method names.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getPrivateStaticAsyncMethods
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getPrivateStaticAsyncMethods
Function
Method
PUBLIC
Return all private asynchronous static method names.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getDunderMethods
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getDunderMethods
Function
Method
PUBLIC
Return all dunder (double underscore) method names in the abstract class.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getMagicMethods
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getMagicMethods
Function
Method
PUBLIC
Return all magic (dunder) methods from the abstract class.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getProperties
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getProperties
Function
Method
PUBLIC
Retrieve all property names from the abstract class.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getPublicProperties
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getPublicProperties
Function
Method
PUBLIC
Return all public property names from the abstract class.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getProtectedProperties
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getProtectedProperties
Function
Method
PUBLIC
Retrieve all protected properties from the abstract class.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getPrivateProperties
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getPrivateProperties
Function
Method
PUBLIC
Retrieve all private properties from the abstract class.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getPropertySignature
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getPropertySignature
Function
Method
PUBLIC
Retrieve the signature of a property's getter method.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.getPropertyDocstring
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#getPropertyDocstring
Function
Method
PUBLIC
Retrieve the docstring of a property's getter method.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.constructorSignature
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#constructorSignature
Function
Method
PUBLIC
Retrieve constructor dependencies for the reflected class.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.methodSignature
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#methodSignature
Function
Method
PUBLIC
Retrieve resolved and unresolved dependencies for a method.
-
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.clearCache
orionis.introspection.abstract.contracts.reflection.IReflectionAbstract.html#clearCache
Function
Method
PUBLIC
Clear all cached reflection data.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html
Class
Class
PUBLIC
Define the contract for reflection instance implementations.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getInstance
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getInstance
Function
Method
PUBLIC
Return the reflected object instance.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getClass
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getClass
Function
Method
PUBLIC
Return the class of the instance.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getClassName
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getClassName
Function
Method
PUBLIC
Return the name of the instance's class.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getModuleName
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getModuleName
Function
Method
PUBLIC
Return the name of the module where the class is defined.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getModuleWithClassName
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getModuleWithClassName
Function
Method
PUBLIC
Return the module and class name as a single string.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getDocstring
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getDocstring
Function
Method
PUBLIC
Return the docstring of the instance's class.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getBaseClasses
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getBaseClasses
Function
Method
PUBLIC
Return the base classes of the instance's class.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getSourceCode
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getSourceCode
Function
Method
PUBLIC
Retrieve the source code for the class or a specific method.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getFile
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getFile
Function
Method
PUBLIC
Return the file path where the class is defined.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getAnnotations
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getAnnotations
Function
Method
PUBLIC
Retrieve type annotations of the class.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.hasAttribute
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#hasAttribute
Function
Method
PUBLIC
Check if the instance has a specific attribute.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getAttribute
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getAttribute
Function
Method
PUBLIC
Retrieve the value of an attribute by name from the instance.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.setAttribute
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#setAttribute
Function
Method
PUBLIC
Set the value of an attribute on the instance.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.removeAttribute
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#removeAttribute
Function
Method
PUBLIC
Remove an attribute from the instance.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getAttributes
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getAttributes
Function
Method
PUBLIC
Aggregate all attributes of the instance.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getPublicAttributes
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getPublicAttributes
Function
Method
PUBLIC
Return all public attributes of the instance.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getProtectedAttributes
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getProtectedAttributes
Function
Method
PUBLIC
Return all protected attributes of the instance.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getPrivateAttributes
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getPrivateAttributes
Function
Method
PUBLIC
Retrieve all private attributes of the instance.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getDunderAttributes
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getDunderAttributes
Function
Method
PUBLIC
Retrieve all dunder (double underscore) attributes of the instance.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getMagicAttributes
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getMagicAttributes
Function
Method
PUBLIC
Return all magic attributes of the instance.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.hasMethod
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#hasMethod
Function
Method
PUBLIC
Determine if the instance has a specific method.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.setMethod
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#setMethod
Function
Method
PUBLIC
Set a callable attribute as a method.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.removeMethod
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#removeMethod
Function
Method
PUBLIC
Remove an instance override or a method declared on its class.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getMethodSignature
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getMethodSignature
Function
Method
PUBLIC
Retrieve the signature of a method.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getMethodDocstring
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getMethodDocstring
Function
Method
PUBLIC
Retrieve the docstring of a method.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getMethods
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getMethods
Function
Method
PUBLIC
Retrieve all method names associated with the instance.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getPublicMethods
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getPublicMethods
Function
Method
PUBLIC
Return all public method names of the instance.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getPublicSyncMethods
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getPublicSyncMethods
Function
Method
PUBLIC
Return all public synchronous method names of the instance.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getPublicAsyncMethods
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getPublicAsyncMethods
Function
Method
PUBLIC
Return all public asynchronous method names of the instance.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getProtectedMethods
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getProtectedMethods
Function
Method
PUBLIC
Return all protected method names of the instance.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getProtectedSyncMethods
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getProtectedSyncMethods
Function
Method
PUBLIC
Return all protected synchronous method names of the instance.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getProtectedAsyncMethods
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getProtectedAsyncMethods
Function
Method
PUBLIC
Retrieve all protected asynchronous method names of the instance.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getPrivateMethods
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getPrivateMethods
Function
Method
PUBLIC
Return all private method names of the instance.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getPrivateSyncMethods
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getPrivateSyncMethods
Function
Method
PUBLIC
Retrieve all private synchronous method names of the instance.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getPrivateAsyncMethods
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getPrivateAsyncMethods
Function
Method
PUBLIC
Retrieve all private asynchronous method names of the instance.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getPublicClassMethods
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getPublicClassMethods
Function
Method
PUBLIC
Return all public class method names of the instance.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getPublicClassSyncMethods
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getPublicClassSyncMethods
Function
Method
PUBLIC
Return all public synchronous class method names of the instance.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getPublicClassAsyncMethods
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getPublicClassAsyncMethods
Function
Method
PUBLIC
Return all public asynchronous class method names of the instance.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getProtectedClassMethods
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getProtectedClassMethods
Function
Method
PUBLIC
Return all protected class method names of the instance.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getProtectedClassSyncMethods
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getProtectedClassSyncMethods
Function
Method
PUBLIC
Return all protected synchronous class method names of the instance.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getProtectedClassAsyncMethods
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getProtectedClassAsyncMethods
Function
Method
PUBLIC
Retrieve all protected asynchronous class method names of the instance.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getPrivateClassMethods
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getPrivateClassMethods
Function
Method
PUBLIC
Return all private class method names of the instance.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getPrivateClassSyncMethods
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getPrivateClassSyncMethods
Function
Method
PUBLIC
Retrieve all private synchronous class method names of the instance.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getPrivateClassAsyncMethods
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getPrivateClassAsyncMethods
Function
Method
PUBLIC
Retrieve all private asynchronous class method names of the instance.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getPublicStaticMethods
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getPublicStaticMethods
Function
Method
PUBLIC
Return the names of all public static methods of the instance's class.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getPublicStaticSyncMethods
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getPublicStaticSyncMethods
Function
Method
PUBLIC
Return all public synchronous static method names of the instance.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getPublicStaticAsyncMethods
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getPublicStaticAsyncMethods
Function
Method
PUBLIC
Retrieve all public asynchronous static method names of the instance.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getProtectedStaticMethods
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getProtectedStaticMethods
Function
Method
PUBLIC
Return all protected static method names of the instance.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getProtectedStaticSyncMethods
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getProtectedStaticSyncMethods
Function
Method
PUBLIC
Retrieve all protected synchronous static method names.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getProtectedStaticAsyncMethods
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getProtectedStaticAsyncMethods
Function
Method
PUBLIC
Retrieve all protected asynchronous static method names.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getPrivateStaticMethods
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getPrivateStaticMethods
Function
Method
PUBLIC
Return all private static method names of the instance.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getPrivateStaticSyncMethods
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getPrivateStaticSyncMethods
Function
Method
PUBLIC
Retrieve all private synchronous static method names of the instance.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getPrivateStaticAsyncMethods
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getPrivateStaticAsyncMethods
Function
Method
PUBLIC
Retrieve all private asynchronous static method names of the instance.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getDunderMethods
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getDunderMethods
Function
Method
PUBLIC
Return all dunder (double underscore) method names of the instance.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getMagicMethods
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getMagicMethods
Function
Method
PUBLIC
Return all magic method names of the instance.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getProperties
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getProperties
Function
Method
PUBLIC
Return all property names of the instance.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getPublicProperties
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getPublicProperties
Function
Method
PUBLIC
Return all public properties of the instance.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getProtectedProperties
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getProtectedProperties
Function
Method
PUBLIC
Retrieve all protected properties of the instance.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getPrivateProperties
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getPrivateProperties
Function
Method
PUBLIC
Retrieve all private properties of the instance.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getProperty
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getProperty
Function
Method
PUBLIC
Retrieve the value of a property from the instance.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getPropertySignature
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getPropertySignature
Function
Method
PUBLIC
Return the signature of a property getter.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.getPropertyDocstring
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#getPropertyDocstring
Function
Method
PUBLIC
Retrieve the docstring for a property.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.constructorSignature
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#constructorSignature
Function
Method
PUBLIC
Analyze and return constructor dependencies of the instance's class.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.methodSignature
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#methodSignature
Function
Method
PUBLIC
Analyze and return dependencies for a method of the instance's class.
-
orionis.introspection.instances.contracts.reflection.IReflectionInstance.clearCache
orionis.introspection.instances.contracts.reflection.IReflectionInstance.html#clearCache
Function
Method
PUBLIC
Clear the internal memory cache.
-
orionis.introspection.modules.contracts.reflection.IReflectionModule
orionis.introspection.modules.contracts.reflection.IReflectionModule.html
Class
Class
PUBLIC
Define the contract for reflection module implementations.
-
orionis.introspection.modules.contracts.reflection.IReflectionModule.getModule
orionis.introspection.modules.contracts.reflection.IReflectionModule.html#getModule
Function
Method
PUBLIC
Return the imported module object.
-
orionis.introspection.modules.contracts.reflection.IReflectionModule.hasClass
orionis.introspection.modules.contracts.reflection.IReflectionModule.html#hasClass
Function
Method
PUBLIC
Check if a class with the specified name exists in the module.
-
orionis.introspection.modules.contracts.reflection.IReflectionModule.getClass
orionis.introspection.modules.contracts.reflection.IReflectionModule.html#getClass
Function
Method
PUBLIC
Retrieve a class object by its name from the module.
-
orionis.introspection.modules.contracts.reflection.IReflectionModule.setClass
orionis.introspection.modules.contracts.reflection.IReflectionModule.html#setClass
Function
Method
PUBLIC
Set a class in the module.
-
orionis.introspection.modules.contracts.reflection.IReflectionModule.removeClass
orionis.introspection.modules.contracts.reflection.IReflectionModule.html#removeClass
Function
Method
PUBLIC
Remove a class from the module.
-
orionis.introspection.modules.contracts.reflection.IReflectionModule.getClasses
orionis.introspection.modules.contracts.reflection.IReflectionModule.html#getClasses
Function
Method
PUBLIC
Return a dictionary of classes defined in the module.
-
orionis.introspection.modules.contracts.reflection.IReflectionModule.getPublicClasses
orionis.introspection.modules.contracts.reflection.IReflectionModule.html#getPublicClasses
Function
Method
PUBLIC
Return a dictionary of public classes defined in the module.
-
orionis.introspection.modules.contracts.reflection.IReflectionModule.getProtectedClasses
orionis.introspection.modules.contracts.reflection.IReflectionModule.html#getProtectedClasses
Function
Method
PUBLIC
Return a dictionary of protected classes defined in the module.
-
orionis.introspection.modules.contracts.reflection.IReflectionModule.getPrivateClasses
orionis.introspection.modules.contracts.reflection.IReflectionModule.html#getPrivateClasses
Function
Method
PUBLIC
Return a dictionary of private classes defined in the module.
-
orionis.introspection.modules.contracts.reflection.IReflectionModule.getConstant
orionis.introspection.modules.contracts.reflection.IReflectionModule.html#getConstant
Function
Method
PUBLIC
Retrieve a constant value by name from the module.
-
orionis.introspection.modules.contracts.reflection.IReflectionModule.getConstants
orionis.introspection.modules.contracts.reflection.IReflectionModule.html#getConstants
Function
Method
PUBLIC
Retrieve constants defined in the module.
-
orionis.introspection.modules.contracts.reflection.IReflectionModule.getPublicConstants
orionis.introspection.modules.contracts.reflection.IReflectionModule.html#getPublicConstants
Function
Method
PUBLIC
Retrieve public constants defined in the module.
-
orionis.introspection.modules.contracts.reflection.IReflectionModule.getProtectedConstants
orionis.introspection.modules.contracts.reflection.IReflectionModule.html#getProtectedConstants
Function
Method
PUBLIC
Return protected constants defined in the module.
-
orionis.introspection.modules.contracts.reflection.IReflectionModule.getPrivateConstants
orionis.introspection.modules.contracts.reflection.IReflectionModule.html#getPrivateConstants
Function
Method
PUBLIC
Retrieve private constants defined in the module.
-
orionis.introspection.modules.contracts.reflection.IReflectionModule.getFunctions
orionis.introspection.modules.contracts.reflection.IReflectionModule.html#getFunctions
Function
Method
PUBLIC
Return a dictionary of functions defined in the module.
-
orionis.introspection.modules.contracts.reflection.IReflectionModule.getPublicFunctions
orionis.introspection.modules.contracts.reflection.IReflectionModule.html#getPublicFunctions
Function
Method
PUBLIC
Return a dictionary of public functions defined in the module.
-
orionis.introspection.modules.contracts.reflection.IReflectionModule.getPublicSyncFunctions
orionis.introspection.modules.contracts.reflection.IReflectionModule.html#getPublicSyncFunctions
Function
Method
PUBLIC
Return a dictionary of public synchronous functions in the module.
-
orionis.introspection.modules.contracts.reflection.IReflectionModule.getPublicAsyncFunctions
orionis.introspection.modules.contracts.reflection.IReflectionModule.html#getPublicAsyncFunctions
Function
Method
PUBLIC
Return a dictionary of public asynchronous functions in the module.
-
orionis.introspection.modules.contracts.reflection.IReflectionModule.getProtectedFunctions
orionis.introspection.modules.contracts.reflection.IReflectionModule.html#getProtectedFunctions
Function
Method
PUBLIC
Return a dictionary of protected functions defined in the module.
-
orionis.introspection.modules.contracts.reflection.IReflectionModule.getProtectedSyncFunctions
orionis.introspection.modules.contracts.reflection.IReflectionModule.html#getProtectedSyncFunctions
Function
Method
PUBLIC
Return protected synchronous functions defined in the module.
-
orionis.introspection.modules.contracts.reflection.IReflectionModule.getProtectedAsyncFunctions
orionis.introspection.modules.contracts.reflection.IReflectionModule.html#getProtectedAsyncFunctions
Function
Method
PUBLIC
Return protected asynchronous functions defined in the module.
-
orionis.introspection.modules.contracts.reflection.IReflectionModule.getPrivateFunctions
orionis.introspection.modules.contracts.reflection.IReflectionModule.html#getPrivateFunctions
Function
Method
PUBLIC
Return private functions defined in the module.
-
orionis.introspection.modules.contracts.reflection.IReflectionModule.getPrivateSyncFunctions
orionis.introspection.modules.contracts.reflection.IReflectionModule.html#getPrivateSyncFunctions
Function
Method
PUBLIC
Return private synchronous functions defined in the module.
-
orionis.introspection.modules.contracts.reflection.IReflectionModule.getPrivateAsyncFunctions
orionis.introspection.modules.contracts.reflection.IReflectionModule.html#getPrivateAsyncFunctions
Function
Method
PUBLIC
Return private asynchronous functions defined in the module.
-
orionis.introspection.modules.contracts.reflection.IReflectionModule.getImports
orionis.introspection.modules.contracts.reflection.IReflectionModule.html#getImports
Function
Method
PUBLIC
Retrieve imported modules from the module.
-
orionis.introspection.modules.contracts.reflection.IReflectionModule.getFile
orionis.introspection.modules.contracts.reflection.IReflectionModule.html#getFile
Function
Method
PUBLIC
Return the file path of the module.
-
orionis.introspection.modules.contracts.reflection.IReflectionModule.getSourceCode
orionis.introspection.modules.contracts.reflection.IReflectionModule.html#getSourceCode
Function
Method
PUBLIC
Retrieve the source code of the module.
-
orionis.introspection.modules.contracts.reflection.IReflectionModule.clearCache
orionis.introspection.modules.contracts.reflection.IReflectionModule.html#clearCache
Function
Method
PUBLIC
Clear all cached reflection data.
-
orionis.introspection.concretes.reflection._DUNDER_ATTR_EXCLUDE
orionis.introspection.concretes.reflection.html#_DUNDER_ATTR_EXCLUDE
Attribute
Constant
PUBLIC
Standard dunder names excluded from non-callable attribute introspection results.
-
orionis.introspection.concretes.reflection._ScanBuffers
orionis.introspection.concretes.reflection._ScanBuffers.html
Class
Class
PUBLIC
Collect mutable scan buckets for ReflectionConcrete._scanClass.
-
orionis.introspection.concretes.reflection._ScanBuffers.pub_attrs
orionis.introspection.concretes.reflection._ScanBuffers.html#pub_attrs
Attribute
Instance Variable
PUBLIC
Initialize all mutable buckets used during class scanning. Attribute buckets partitioned by visibility.
-
orionis.introspection.concretes.reflection._ScanBuffers.prot_attrs
orionis.introspection.concretes.reflection._ScanBuffers.html#prot_attrs
Attribute
Instance Variable
PUBLIC
Collected protected attributes.
-
orionis.introspection.concretes.reflection._ScanBuffers.priv_attrs
orionis.introspection.concretes.reflection._ScanBuffers.html#priv_attrs
Attribute
Instance Variable
PUBLIC
Collected private attributes.
-
orionis.introspection.concretes.reflection._ScanBuffers.dunder_attrs
orionis.introspection.concretes.reflection._ScanBuffers.html#dunder_attrs
Attribute
Instance Variable
PUBLIC
Collected special attributes.
-
orionis.introspection.concretes.reflection._ScanBuffers.pub_m
orionis.introspection.concretes.reflection._ScanBuffers.html#pub_m
Attribute
Instance Variable
PUBLIC
Instance method buckets partitioned by visibility and sync/async.
-
orionis.introspection.concretes.reflection._ScanBuffers.pub_sync_m
orionis.introspection.concretes.reflection._ScanBuffers.html#pub_sync_m
Attribute
Instance Variable
PUBLIC
Collected public synchronous instance methods.
-
orionis.introspection.concretes.reflection._ScanBuffers.pub_async_m
orionis.introspection.concretes.reflection._ScanBuffers.html#pub_async_m
Attribute
Instance Variable
PUBLIC
Collected public asynchronous instance methods.
-
orionis.introspection.concretes.reflection._ScanBuffers.prot_m
orionis.introspection.concretes.reflection._ScanBuffers.html#prot_m
Attribute
Instance Variable
PUBLIC
Collected protected instance methods.
-
orionis.introspection.concretes.reflection._ScanBuffers.prot_sync_m
orionis.introspection.concretes.reflection._ScanBuffers.html#prot_sync_m
Attribute
Instance Variable
PUBLIC
Collected protected synchronous instance methods.
-
orionis.introspection.concretes.reflection._ScanBuffers.prot_async_m
orionis.introspection.concretes.reflection._ScanBuffers.html#prot_async_m
Attribute
Instance Variable
PUBLIC
Collected protected asynchronous instance methods.
-
orionis.introspection.concretes.reflection._ScanBuffers.priv_m
orionis.introspection.concretes.reflection._ScanBuffers.html#priv_m
Attribute
Instance Variable
PUBLIC
Collected private instance methods.
-
orionis.introspection.concretes.reflection._ScanBuffers.priv_sync_m
orionis.introspection.concretes.reflection._ScanBuffers.html#priv_sync_m
Attribute
Instance Variable
PUBLIC
Collected private synchronous instance methods.
-
orionis.introspection.concretes.reflection._ScanBuffers.priv_async_m
orionis.introspection.concretes.reflection._ScanBuffers.html#priv_async_m
Attribute
Instance Variable
PUBLIC
Collected private asynchronous instance methods.
-
orionis.introspection.concretes.reflection._ScanBuffers.dunder_m
orionis.introspection.concretes.reflection._ScanBuffers.html#dunder_m
Attribute
Instance Variable
PUBLIC
Collected special instance methods.
-
orionis.introspection.concretes.reflection._ScanBuffers.pub_cm
orionis.introspection.concretes.reflection._ScanBuffers.html#pub_cm
Attribute
Instance Variable
PUBLIC
Class method buckets partitioned by visibility and sync/async.
-
orionis.introspection.concretes.reflection._ScanBuffers.pub_sync_cm
orionis.introspection.concretes.reflection._ScanBuffers.html#pub_sync_cm
Attribute
Instance Variable
PUBLIC
Collected public synchronous class methods.
-
orionis.introspection.concretes.reflection._ScanBuffers.pub_async_cm
orionis.introspection.concretes.reflection._ScanBuffers.html#pub_async_cm
Attribute
Instance Variable
PUBLIC
Collected public asynchronous class methods.
-
orionis.introspection.concretes.reflection._ScanBuffers.prot_cm
orionis.introspection.concretes.reflection._ScanBuffers.html#prot_cm
Attribute
Instance Variable
PUBLIC
Collected protected class methods.
-
orionis.introspection.concretes.reflection._ScanBuffers.prot_sync_cm
orionis.introspection.concretes.reflection._ScanBuffers.html#prot_sync_cm
Attribute
Instance Variable
PUBLIC
Collected protected synchronous class methods.
-
orionis.introspection.concretes.reflection._ScanBuffers.prot_async_cm
orionis.introspection.concretes.reflection._ScanBuffers.html#prot_async_cm
Attribute
Instance Variable
PUBLIC
Collected protected asynchronous class methods.
-
orionis.introspection.concretes.reflection._ScanBuffers.priv_cm
orionis.introspection.concretes.reflection._ScanBuffers.html#priv_cm
Attribute
Instance Variable
PUBLIC
Collected private class methods.
-
orionis.introspection.concretes.reflection._ScanBuffers.priv_sync_cm
orionis.introspection.concretes.reflection._ScanBuffers.html#priv_sync_cm
Attribute
Instance Variable
PUBLIC
Collected private synchronous class methods.
-
orionis.introspection.concretes.reflection._ScanBuffers.priv_async_cm
orionis.introspection.concretes.reflection._ScanBuffers.html#priv_async_cm
Attribute
Instance Variable
PUBLIC
Collected private asynchronous class methods.
-
orionis.introspection.concretes.reflection._ScanBuffers.pub_sm
orionis.introspection.concretes.reflection._ScanBuffers.html#pub_sm
Attribute
Instance Variable
PUBLIC
Static method buckets partitioned by visibility and sync/async.
-
orionis.introspection.concretes.reflection._ScanBuffers.pub_sync_sm
orionis.introspection.concretes.reflection._ScanBuffers.html#pub_sync_sm
Attribute
Instance Variable
PUBLIC
Collected public synchronous static methods.
-
orionis.introspection.concretes.reflection._ScanBuffers.pub_async_sm
orionis.introspection.concretes.reflection._ScanBuffers.html#pub_async_sm
Attribute
Instance Variable
PUBLIC
Collected public asynchronous static methods.
-
orionis.introspection.concretes.reflection._ScanBuffers.prot_sm
orionis.introspection.concretes.reflection._ScanBuffers.html#prot_sm
Attribute
Instance Variable
PUBLIC
Collected protected static methods.
-
orionis.introspection.concretes.reflection._ScanBuffers.prot_sync_sm
orionis.introspection.concretes.reflection._ScanBuffers.html#prot_sync_sm
Attribute
Instance Variable
PUBLIC
Collected protected synchronous static methods.
-
orionis.introspection.concretes.reflection._ScanBuffers.prot_async_sm
orionis.introspection.concretes.reflection._ScanBuffers.html#prot_async_sm
Attribute
Instance Variable
PUBLIC
Collected protected asynchronous static methods.
-
orionis.introspection.concretes.reflection._ScanBuffers.priv_sm
orionis.introspection.concretes.reflection._ScanBuffers.html#priv_sm
Attribute
Instance Variable
PUBLIC
Collected private static methods.
-
orionis.introspection.concretes.reflection._ScanBuffers.priv_sync_sm
orionis.introspection.concretes.reflection._ScanBuffers.html#priv_sync_sm
Attribute
Instance Variable
PUBLIC
Collected private synchronous static methods.
-
orionis.introspection.concretes.reflection._ScanBuffers.priv_async_sm
orionis.introspection.concretes.reflection._ScanBuffers.html#priv_async_sm
Attribute
Instance Variable
PUBLIC
Collected private asynchronous static methods.
-
orionis.introspection.concretes.reflection._ScanBuffers.all_props
orionis.introspection.concretes.reflection._ScanBuffers.html#all_props
Attribute
Instance Variable
PUBLIC
Property buckets partitioned by visibility.
-
orionis.introspection.concretes.reflection._ScanBuffers.pub_props
orionis.introspection.concretes.reflection._ScanBuffers.html#pub_props
Attribute
Instance Variable
PUBLIC
Collected public properties.
-
orionis.introspection.concretes.reflection._ScanBuffers.prot_props
orionis.introspection.concretes.reflection._ScanBuffers.html#prot_props
Attribute
Instance Variable
PUBLIC
Collected protected properties.
-
orionis.introspection.concretes.reflection._ScanBuffers.priv_props
orionis.introspection.concretes.reflection._ScanBuffers.html#priv_props
Attribute
Instance Variable
PUBLIC
Collected private properties.
-
orionis.introspection.concretes.reflection._ScanBuffers.__slots__
orionis.introspection.concretes.reflection._ScanBuffers.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.introspection.concretes.reflection._ScanBuffers.__init__
orionis.introspection.concretes.reflection._ScanBuffers.html#__init__
Function
Method
PUBLIC
Initialize all classification buckets with empty containers.
-
orionis.container.entities.invocation.InvocationPlan
orionis.container.entities.invocation.InvocationPlan.html
Class
Class
PUBLIC
Describe the immutable metadata needed to invoke one callable.
-
orionis.container.entities.invocation.InvocationPlan.arguments
orionis.container.entities.invocation.InvocationPlan.html#arguments
Attribute
Instance Variable
PUBLIC
Parameters in declaration order, excluding a bound receiver.
-
orionis.container.entities.invocation.InvocationPlan.is_async
orionis.container.entities.invocation.InvocationPlan.html#is_async
Attribute
Instance Variable
PUBLIC
Whether invocation requires awaiting the callable's result.
-
orionis.container.entities.invocation.InvocationPlan.positional_only
orionis.container.entities.invocation.InvocationPlan.html#positional_only
Attribute
Instance Variable
PUBLIC
Names whose matching keyword arguments belong to **kwargs instead.
-
orionis.container.entities.invocation.InvocationPlan.has_keyword_only
orionis.container.entities.invocation.InvocationPlan.html#has_keyword_only
Attribute
Instance Variable
PUBLIC
Whether resolution needs keyword arguments even for positional calls.
-
orionis.container.entities.invocation.InvocationPlan.__post_init__
orionis.container.entities.invocation.InvocationPlan.html#__post_init__
Function
Method
PUBLIC
Cache argument shape without retaining resolved dependencies.
-
orionis.container.entities.invocation._positional_only_names
orionis.container.entities.invocation.html#_positional_only_names
Function
Function
PUBLIC
Read positional-only names from the shared signature cache.
-
orionis.container.entities.invocation._callable_plan
orionis.container.entities.invocation.html#_callable_plan
Function
Function
PUBLIC
Validate a callable and retain its parameter and coroutine metadata.
-
orionis.container.entities.invocation.callable_plan
orionis.container.entities.invocation.html#callable_plan
Function
Function
PUBLIC
Select a plan using the callable's function and receiver mode.
-
orionis.container.entities.invocation._resolve_constructor_annotation
orionis.container.entities.invocation.html#_resolve_constructor_annotation
Function
Function
PUBLIC
Resolve one class-local constructor hint without rejecting other parameters.
-
orionis.container.entities.invocation.constructor_plan
orionis.container.entities.invocation.html#constructor_plan
Function
Function
PUBLIC
Validate a concrete class and prepare its constructor metadata.
-
orionis.container.entities.invocation._clear_invocation_plans
orionis.container.entities.invocation.html#_clear_invocation_plans
Function
Function
PUBLIC
Discard plans derived from explicitly invalidated reflection metadata.
-
orionis.container.entities.invocation.warm_controller_plan
orionis.container.entities.invocation.html#warm_controller_plan
Function
Function
PUBLIC
Prepare ordinary controller descriptors without creating an instance.
-
orionis.container.exceptions.CircularDependencyException
orionis.container.exceptions.CircularDependencyException.html
Class
Exception
PUBLIC
Raise when a circular dependency is detected in the Orionis container.
-
orionis.container.container._resolution_stack
orionis.container.container.html#_resolution_stack
Attribute
Variable
PUBLIC
Resolution stack identifying both the owning container and concrete type.
-
orionis.container.container._provider_stack
orionis.container.container.html#_provider_stack
Attribute
Variable
PUBLIC
Context-local provider stack isolated between asynchronous tasks.
-
orionis.container.container._MISSING
orionis.container.container.html#_MISSING
Attribute
Constant
PUBLIC
Sentinel distinguishing missing from ordinary values.
-
orionis.container.container.Container
orionis.container.container.Container.html
Class
Class
PUBLIC
Resolve services from contracts, aliases and constructor signatures.
-
orionis.container.container.Container._instances
orionis.container.container.Container.html#_instances
Attribute
Class Variable
PUBLIC
Dictionary to hold singleton instances for each class This allows proper inheritance of the singleton pattern.
-
orionis.container.container.Container._lock
orionis.container.container.Container.html#_lock
Attribute
Class Variable
PUBLIC
Lock for thread-safe singleton instantiation and access This lock ensures that only one thread can create or access instances at a time.
-
orionis.container.container.Container.__new__
orionis.container.container.Container.html#__new__
Function
Method
PUBLIC
Create and return a singleton instance for each class in the hierarchy.
-
orionis.container.container.Container.__init__
orionis.container.container.Container.html#__init__
Function
Method
PUBLIC
Initialize the internal state of the container.
-
orionis.container.container.Container._deferred_providers
orionis.container.container.Container.html#_deferred_providers
Attribute
Instance Variable
PUBLIC
Deferred providers for lazy loading.
-
orionis.container.container.Container.__singleton_cache
orionis.container.container.Container.html#__singleton_cache
Attribute
Instance Variable
PUBLIC
Cache for singleton instances.
-
orionis.container.container.Container.__aliases
orionis.container.container.Container.html#__aliases
Attribute
Instance Variable
PUBLIC
Aliases mapping for service resolution.
-
orionis.container.container.Container.__bindings
orionis.container.container.Container.html#__bindings
Attribute
Instance Variable
PUBLIC
Registered bindings for services.
-
orionis.container.container.Container.__cache_resolve_deferred_providers
orionis.container.container.Container.html#__cache_resolve_deferred_providers
Attribute
Instance Variable
PUBLIC
Tracks resolved deferred providers.
-
orionis.container.container.Container.__registered_deferred
orionis.container.container.Container.html#__registered_deferred
Attribute
Instance Variable
PUBLIC
Deferred providers whose bindings have already been registered.
-
orionis.container.container.Container.__pending_deferred
orionis.container.container.Container.html#__pending_deferred
Attribute
Instance Variable
PUBLIC
Deferred providers with boot work that is still pending.
-
orionis.container.container.Container.__creation_locks
orionis.container.container.Container.html#__creation_locks
Attribute
Instance Variable
PUBLIC
Per-key locks serialising one-shot construction, paired with the loop they were created on so a second loop never awaits a foreign lock.
-
orionis.container.container.Container._Container__initialized
orionis.container.container.Container.html#_Container__initialized
Attribute
Instance Variable
PUBLIC
Mark as initialized to prevent re-initialization.
-
orionis.container.container.Container.__creationLock
orionis.container.container.Container.html#__creationLock
Function
Method
PUBLIC
Return the creation lock for a key, bound to the running loop.
-
orionis.container.container.Container.__isBeingResolved
orionis.container.container.Container.html#__isBeingResolved
Function
Method
PUBLIC
Determine whether a concrete type is already resolving in this task.
-
orionis.container.container.Container.__aliasService
orionis.container.container.Container.html#__aliasService
Function
Method
PUBLIC
Validate and normalize a service alias string.
-
orionis.container.container.Container.__ensureCanOverrideScope
orionis.container.container.Container.html#__ensureCanOverrideScope
Function
Method
PUBLIC
Ensure that a service can be overridden in the current scope.
-
orionis.container.container.Container.__ensureCanOverrideGlobal
orionis.container.container.Container.html#__ensureCanOverrideGlobal
Function
Method
PUBLIC
Ensure that a service or alias can be overridden globally.
-
orionis.container.container.Container.__ensureInstanceImplements
orionis.container.container.Container.html#__ensureInstanceImplements
Function
Method
PUBLIC
Ensure that an instance implements the specified abstract class.
-
orionis.container.container.Container.__ensureConcreteImplements
orionis.container.container.Container.html#__ensureConcreteImplements
Function
Method
PUBLIC
Ensure that a concrete class implements the specified abstract class.
-
orionis.container.container.Container.__bind
orionis.container.container.Container.html#__bind
Function
Method
PUBLIC
Bind a concrete implementation to an abstract contract with a given lifetime.
-
orionis.container.container.Container.instance
orionis.container.container.Container.html#instance
Function
Method
PUBLIC
Register an existing object globally or in the active scope.
-
orionis.container.container.Container.transient
orionis.container.container.Container.html#transient
Function
Method
PUBLIC
Register a transient service binding.
-
orionis.container.container.Container.singleton
orionis.container.container.Container.html#singleton
Function
Method
PUBLIC
Register a singleton service binding.
-
orionis.container.container.Container.scoped
orionis.container.container.Container.html#scoped
Function
Method
PUBLIC
Register a scoped service binding.
-
orionis.container.container.Container.bound
orionis.container.container.Container.html#bound
Function
Method
PUBLIC
Determine if a key is bound in the container or current scope.
-
orionis.container.container.Container.beginScope
orionis.container.container.Container.html#beginScope
Function
Method
PUBLIC
Begin a new scope context manager for scoped services.
-
orionis.container.container.Container.getCurrentScope
orionis.container.container.Container.html#getCurrentScope
Function
Method
PUBLIC
Get the current active scope context for scoped services.
-
orionis.container.container.Container.__resolveDeferredProvider
orionis.container.container.Container.html#__resolveDeferredProvider
Function
Method
PUBLIC
Resolve and register a deferred service provider for a given service.
-
orionis.container.container.Container.__bootDeferredProvider
orionis.container.container.Container.html#__bootDeferredProvider
Function
Method
PUBLIC
Register a deferred provider once and complete its boot hook.
-
orionis.container.container.Container.__awaitPendingProvider
orionis.container.container.Container.html#__awaitPendingProvider
Function
Method
PUBLIC
Wait for a provider that has registered services but is still booting.
-
orionis.container.container.Container.__resolveKey
orionis.container.container.Container.html#__resolveKey
Function
Method
PUBLIC
Resolve a service key to its abstract type.
-
orionis.container.container.Container.__resolveOrBuild
orionis.container.container.Container.html#__resolveOrBuild
Function
Method
PUBLIC
Resolve a binding for an abstract service or build it when unbound.
-
orionis.container.container.Container.make
orionis.container.container.Container.html#make
Function
Method
PUBLIC
Resolve and return a service instance by key.
-
orionis.container.container.Container.__resolve
orionis.container.container.Container.html#__resolve
Function
Method
PUBLIC
Resolve an instance from a binding according to its lifetime.
-
orionis.container.container.Container.__createSingleton
orionis.container.container.Container.html#__createSingleton
Function
Method
PUBLIC
Build and cache the single instance backing a singleton binding.
-
orionis.container.container.Container.__createScoped
orionis.container.container.Container.html#__createScoped
Function
Method
PUBLIC
Build and store the instance backing a scoped binding.
-
orionis.container.container.Container.__autoResolveClass
orionis.container.container.Container.html#__autoResolveClass
Function
Method
PUBLIC
Automatically instantiate a class with injected dependencies.
-
orionis.container.container.Container.build
orionis.container.container.Container.html#build
Function
Method
PUBLIC
Build and return an instance of the specified type.
-
orionis.container.container.Container.invoke
orionis.container.container.Container.html#invoke
Function
Method
PUBLIC
Invoke a callable with automatic dependency injection.
-
orionis.container.container.Container.call
orionis.container.container.Container.html#call
Function
Method
PUBLIC
Invoke a method on an object instance with automatic dependency injection.
-
orionis.container.container.Container.__autoResolveCallable
orionis.container.container.Container.html#__autoResolveCallable
Function
Method
PUBLIC
Resolve and invoke a callable, injecting dependencies.
-
orionis.container.container.Container.__resolvePositionalArguments
orionis.container.container.Container.html#__resolvePositionalArguments
Function
Method
PUBLIC
Resolve a positional call using the current bindings and scope.
-
orionis.container.container.Container.__resolveMissingParameter
orionis.container.container.Container.html#__resolveMissingParameter
Function
Method
PUBLIC
Resolve a parameter whose value was omitted from a keyword call.
-
orionis.container.container.Container.__resolveSignature
orionis.container.container.Container.html#__resolveSignature
Function
Method
PUBLIC
Resolve arguments for a callable signature using dependency injection.
-
orionis.container.container.Container.__resolveSchemaArgument
orionis.container.container.Container.html#__resolveSchemaArgument
Function
Method
PUBLIC
Validate a schema argument using the active HTTP request payload.
-
orionis.container.container.Container.__resolveArgument
orionis.container.container.Container.html#__resolveArgument
Function
Method
PUBLIC
Resolve a single argument for dependency injection.
-
orionis.container.contracts.deferrable_provider.IDeferrableProvider
orionis.container.contracts.deferrable_provider.IDeferrableProvider.html
Class
Class
PUBLIC
Define the contract for deferrable provider implementations.
-
orionis.container.contracts.deferrable_provider.IDeferrableProvider.provides
orionis.container.contracts.deferrable_provider.IDeferrableProvider.html#provides
Function
Class Method
PUBLIC
Return the services provided by this provider.
-
orionis.foundation.core_config._CONFIG_ENTITIES
orionis.foundation.core_config.html#_CONFIG_ENTITIES
Attribute
Constant
PUBLIC
Config entities definitions used by core_config.
-
orionis.foundation.core_config.get_core_config_mapping
orionis.foundation.core_config.html#get_core_config_mapping
Function
Function
PUBLIC
Build independent configuration defaults from their declared entities.
-
orionis.foundation.core_config.__getattr__
orionis.foundation.core_config.html#__getattr__
Function
Function
PUBLIC
Build and cache the compatibility configuration export on first access.
-
orionis.foundation.core_config.__dir__
orionis.foundation.core_config.html#__dir__
Function
Function
PUBLIC
List loaded attributes and configuration exports.
-
orionis.foundation.core_exception_handler.get_core_exception_handler_mapping
orionis.foundation.core_exception_handler.html#get_core_exception_handler_mapping
Function
Function
PUBLIC
Return an immutable mapping for the default exception handler.
-
orionis.foundation.core_exception_handler.CORE_EXCEPTION_HANDLER
orionis.foundation.core_exception_handler.html#CORE_EXCEPTION_HANDLER
Attribute
Constant
PUBLIC
Core exception handler used by core_exception_handler.
-
orionis.foundation.core_kernels.get_core_kernels_mapping
orionis.foundation.core_kernels.html#get_core_kernels_mapping
Function
Function
PUBLIC
Return an immutable mapping of core kernel class metadata.
-
orionis.foundation.core_kernels.CORE_KERNELS
orionis.foundation.core_kernels.html#CORE_KERNELS
Attribute
Constant
PUBLIC
Core kernels used by core_kernels.
-
orionis.foundation.core_paths.CORE_APP_PATHS
orionis.foundation.core_paths.html#CORE_APP_PATHS
Attribute
Constant
PUBLIC
Core app paths used by core_paths.
-
orionis.foundation.core_providers.CORE_PROVIDER_METADATA
orionis.foundation.core_providers.html#CORE_PROVIDER_METADATA
Attribute
Constant
PUBLIC
Core provider metadata definitions used by core_providers.
-
orionis.foundation.core_providers.get_core_providers_mapping
orionis.foundation.core_providers.html#get_core_providers_mapping
Function
Function
PUBLIC
Load the built-in provider classes in registration order.
-
orionis.foundation.core_providers.__getattr__
orionis.foundation.core_providers.html#__getattr__
Function
Function
PUBLIC
Expose the built-in provider tuple on its first explicit access.
-
orionis.foundation.core_providers.__dir__
orionis.foundation.core_providers.html#__dir__
Function
Function
PUBLIC
List loaded attributes and provider exports.
-
orionis.foundation.core_scheduler.get_core_scheduler_mapping
orionis.foundation.core_scheduler.html#get_core_scheduler_mapping
Function
Function
PUBLIC
Return an immutable mapping with core scheduler module and class information.
-
orionis.foundation.core_scheduler.CORE_SCHEDULER
orionis.foundation.core_scheduler.html#CORE_SCHEDULER
Attribute
Constant
PUBLIC
Core scheduler used by core_scheduler.
-
orionis.http.contracts.kernel.IKernelHTTP
orionis.http.contracts.kernel.IKernelHTTP.html
Class
Class
PUBLIC
Define the contract for kernel http implementations.
-
orionis.http.contracts.kernel.IKernelHTTP.__slots__
orionis.http.contracts.kernel.IKernelHTTP.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.http.contracts.kernel.IKernelHTTP.disconnectPaths
orionis.http.contracts.kernel.IKernelHTTP.html#disconnectPaths
Function
Method
PUBLIC
Return static protocol endpoints requiring proactive cancellation.
-
orionis.http.contracts.kernel.IKernelHTTP.boot
orionis.http.contracts.kernel.IKernelHTTP.html#boot
Function
Method
PUBLIC
Boot the HTTP kernel by initializing core components.
-
orionis.http.contracts.kernel.IKernelHTTP.handleRSGI
orionis.http.contracts.kernel.IKernelHTTP.html#handleRSGI
Function
Method
PUBLIC
Handle an incoming RSGI HTTP request end-to-end.
-
orionis.http.contracts.kernel.IKernelHTTP.handleASGI
orionis.http.contracts.kernel.IKernelHTTP.html#handleASGI
Function
Method
PUBLIC
Handle an incoming ASGI HTTP request end-to-end.
-
orionis.http.adapters.websocket.contracts.transport.IWebSocketTransport
orionis.http.adapters.websocket.contracts.transport.IWebSocketTransport.html
Class
Class
PUBLIC
Normalize server operations without owning application lifecycle state.
-
orionis.http.adapters.websocket.contracts.transport.IWebSocketTransport.__slots__
orionis.http.adapters.websocket.contracts.transport.IWebSocketTransport.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.http.adapters.websocket.contracts.transport.IWebSocketTransport.supportsCloseDetails
orionis.http.adapters.websocket.contracts.transport.IWebSocketTransport.html#supportsCloseDetails
Attribute
Property
PUBLIC
Declare whether custom close details can reach the wire.
-
orionis.http.adapters.websocket.contracts.transport.IWebSocketTransport.accept
orionis.http.adapters.websocket.contracts.transport.IWebSocketTransport.html#accept
Function
Method
PUBLIC
Complete the pending handshake.
-
orionis.http.adapters.websocket.contracts.transport.IWebSocketTransport.receive
orionis.http.adapters.websocket.contracts.transport.IWebSocketTransport.html#receive
Function
Method
PUBLIC
Receive one normalized server event.
-
orionis.http.adapters.websocket.contracts.transport.IWebSocketTransport.sendText
orionis.http.adapters.websocket.contracts.transport.IWebSocketTransport.html#sendText
Function
Method
PUBLIC
Await text delivery and server backpressure.
-
orionis.http.adapters.websocket.contracts.transport.IWebSocketTransport.sendBytes
orionis.http.adapters.websocket.contracts.transport.IWebSocketTransport.html#sendBytes
Function
Method
PUBLIC
Await binary delivery and server backpressure.
-
orionis.http.adapters.websocket.contracts.transport.IWebSocketTransport.close
orionis.http.adapters.websocket.contracts.transport.IWebSocketTransport.html#close
Function
Method
PUBLIC
Close the underlying connection.
-
orionis.http.adapters.websocket.contracts.transport.IWebSocketTransport.reject
orionis.http.adapters.websocket.contracts.transport.IWebSocketTransport.html#reject
Function
Method
PUBLIC
Reject an unaccepted handshake.
-
orionis.http.websocket._DEFAULT_MESSAGE_LIMIT
orionis.http.websocket.module.html#_DEFAULT_MESSAGE_LIMIT
Attribute
Constant
PUBLIC
Default message limit used by websocket.
-
orionis.http.websocket._MIN_HTTP_ERROR
orionis.http.websocket.module.html#_MIN_HTTP_ERROR
Attribute
Constant
PUBLIC
Min http error value used by websocket.
-
orionis.http.websocket._MAX_HTTP_ERROR
orionis.http.websocket.module.html#_MAX_HTTP_ERROR
Attribute
Constant
PUBLIC
Max http error value used by websocket.
-
orionis.http.websocket._MIN_CUSTOM_CLOSE
orionis.http.websocket.module.html#_MIN_CUSTOM_CLOSE
Attribute
Constant
PUBLIC
Min custom close value used by websocket.
-
orionis.http.websocket._MAX_CUSTOM_CLOSE
orionis.http.websocket.module.html#_MAX_CUSTOM_CLOSE
Attribute
Constant
PUBLIC
Max custom close value used by websocket.
-
orionis.http.websocket._MAX_CLOSE_REASON
orionis.http.websocket.module.html#_MAX_CLOSE_REASON
Attribute
Constant
PUBLIC
Max close reason value used by websocket.
-
orionis.http.websocket._VALID_CLOSE_CODES
orionis.http.websocket.module.html#_VALID_CLOSE_CODES
Attribute
Constant
PUBLIC
Valid close codes used by websocket.
-
orionis.http.routes.types.RouteAction
orionis.http.routes.types.html#RouteAction
Attribute
Type Alias
PUBLIC
Callable represents Python functions here; parse_action rejects callable instances, bound methods, builtins and lambdas during registration.
-
orionis.http.routes.types.MiddlewareInput
orionis.http.routes.types.html#MiddlewareInput
Attribute
Type Alias
PUBLIC
Type alias for type[BaseMiddleware | WebSocketMiddleware] |
Sequence[type[BaseMiddleware | WebSocketMiddleware]] |
AbstractSet[type[BaseMiddleware | WebSocketMiddleware]].
-
orionis.http.routes.functions._ACTION_LIST_LENGTH
orionis.http.routes.functions.html#_ACTION_LIST_LENGTH
Attribute
Constant
PUBLIC
Expected number of elements in a [Controller, method_name] action list.
-
orionis.http.routes.functions._MULTI_SLASH_RE
orionis.http.routes.functions.html#_MULTI_SLASH_RE
Attribute
Constant
PUBLIC
Matches one or more consecutive forward slashes anywhere in a path.
-
orionis.http.routes.functions.normalize_path
orionis.http.routes.functions.html#normalize_path
Function
Function
PUBLIC
Normalise an HTTP route path to a canonical form.
-
orionis.http.routes.functions.normalize_request_path
orionis.http.routes.functions.html#normalize_request_path
Function
Function
PUBLIC
Normalise a request path for route resolution.
-
orionis.http.routes.functions.strip_regex_anchors
orionis.http.routes.functions.html#strip_regex_anchors
Function
Function
PUBLIC
Remove start and end anchors from a regex pattern.
-
orionis.http.routes.functions.flatten_middleware
orionis.http.routes.functions.html#flatten_middleware
Function
Function
PUBLIC
Flatten and validate middleware arguments into a plain list.
-
orionis.http.routes.functions._middleware_key
orionis.http.routes.functions.html#_middleware_key
Function
Function
PUBLIC
Return a stable ordering key for middleware supplied in sets.
-
orionis.http.routes.functions.is_valid_handler
orionis.http.routes.functions.html#is_valid_handler
Function
Function
PUBLIC
Check whether the route action parser accepts a candidate.
-
orionis.http.routes.functions.parse_action
orionis.http.routes.functions.html#parse_action
Function
Function
PUBLIC
Parse and validate a route action into a normalised tuple.
-
orionis.introspection.modules.inspector._EXCLUDED_DIRECTORIES
orionis.introspection.modules.inspector.html#_EXCLUDED_DIRECTORIES
Attribute
Constant
PUBLIC
Excluded directories used by inspector.
-
orionis.introspection.modules.inspector._VENV_DIRECTORIES
orionis.introspection.modules.inspector.html#_VENV_DIRECTORIES
Attribute
Constant
PUBLIC
Venv directories used by inspector.
-
orionis.introspection.modules.inspector._raise_discovery_error
orionis.introspection.modules.inspector.html#_raise_discovery_error
Function
Function
PUBLIC
Propagate a failed directory traversal instead of reporting partial results.
-
orionis.support.structures.freezer._CONTAINER_TYPES
orionis.support.structures.freezer.html#_CONTAINER_TYPES
Attribute
Constant
PUBLIC
Container types traversed when constructing a mutable snapshot.
-
orionis.support.structures.freezer._MUTABLE_TYPES
orionis.support.structures.freezer.html#_MUTABLE_TYPES
Attribute
Constant
PUBLIC
Mutable types definitions used by freezer.
-
orionis.support.structures.freezer._mutable_graph
orionis.support.structures.freezer.html#_mutable_graph
Function
Function
PUBLIC
Copy graph containers and record edges that require reference updates.
-
orionis.support.structures.freezer._freeze_sequences
orionis.support.structures.freezer.html#_freeze_sequences
Function
Function
PUBLIC
Resolve sequence dependencies and cache their immutable tuple snapshots.
-
orionis.support.structures.freezer.FreezeThaw
orionis.support.structures.freezer.FreezeThaw.html
Class
Class
PUBLIC
Convert nested mutable structures to immutable snapshots and back.
-
orionis.support.structures.freezer.FreezeThaw.thaw
orionis.support.structures.freezer.FreezeThaw.html#thaw
Function
Static Method
PUBLIC
Recursively convert frozen containers to mutable equivalents.
-
orionis.support.structures.freezer.FreezeThaw.freeze
orionis.support.structures.freezer.FreezeThaw.html#freeze
Function
Static Method
PUBLIC
Convert mutable containers to immutable equivalents recursively.
-
orionis.foundation.application._SENTINEL
orionis.foundation.application.html#_SENTINEL
Attribute
Constant
PUBLIC
Sentinel distinguishing sentinel from ordinary values.
-
orionis.foundation.application._ASGI_BODY_QUEUE_SIZE
orionis.foundation.application.html#_ASGI_BODY_QUEUE_SIZE
Attribute
Constant
PUBLIC
Asgi body queue size value used by application.
-
orionis.foundation.application._CWD
orionis.foundation.application.html#_CWD
Attribute
Constant
PUBLIC
Cwd used by application.
-
orionis.foundation.application._CORE_PATHS_PATH
orionis.foundation.application.html#_CORE_PATHS_PATH
Attribute
Constant
PUBLIC
Core paths path used by application.
-
orionis.foundation.application._CONFIG_KEY_CACHE_SIZE
orionis.foundation.application.html#_CONFIG_KEY_CACHE_SIZE
Attribute
Constant
PUBLIC
Config key cache size value used by application.
-
orionis.foundation.application._MAINTENANCE_REFRESH_NS
orionis.foundation.application.html#_MAINTENANCE_REFRESH_NS
Attribute
Constant
PUBLIC
Maintenance refresh ns value used by application.
-
orionis.foundation.application._HTTP_FAILURE_OWNER
orionis.foundation.application.html#_HTTP_FAILURE_OWNER
Attribute
Constant
PUBLIC
Owner retaining failure reporting for the HTTP server lifetime.
-
orionis.foundation.application._HEADLESS_FAILURE_OWNER
orionis.foundation.application.html#_HEADLESS_FAILURE_OWNER
Attribute
Constant
PUBLIC
Owner retaining failure reporting after explicit headless boot.
-
orionis.foundation.application._ROUTER_FACADE_MODULE
orionis.foundation.application.html#_ROUTER_FACADE_MODULE
Attribute
Constant
PUBLIC
orionis.support.facades.
-
orionis.foundation.application._ERR_NOT_CONFIGURED
orionis.foundation.application.html#_ERR_NOT_CONFIGURED
Attribute
Constant
PUBLIC
Application configuration is not initialized.
Please call create() first..
-
orionis.foundation.application._parse_config_key
orionis.foundation.application.html#_parse_config_key
Function
Function
PUBLIC
Split a dot-notated configuration key into immutable path components.
-
orionis.foundation.application._create_http_handler_task
orionis.foundation.application.html#_create_http_handler_task
Function
Function
PUBLIC
Schedule an HTTP handler through the event loop's task factory.
-
orionis.foundation.application._asgi_receive_dispatcher
orionis.foundation.application.html#_asgi_receive_dispatcher
Function
Function
PUBLIC
Dispatch ASGI body messages and cancel the handler on disconnect.
-
orionis.foundation.application._rsgi_disconnect_watcher
orionis.foundation.application.html#_rsgi_disconnect_watcher
Function
Function
PUBLIC
Cancel the RSGI handler when the client disconnects.
-
orionis.foundation.application._await_http_tasks
orionis.foundation.application.html#_await_http_tasks
Function
Function
PUBLIC
Await an HTTP handler and clean up its disconnect monitor.
-
orionis.foundation.application._monitor_http_handler
orionis.foundation.application.html#_monitor_http_handler
Function
Function
PUBLIC
Admit a disconnect monitor or roll back the already admitted handler.
-
orionis.foundation.application._retire_shared_runtime
orionis.foundation.application.html#_retire_shared_runtime
Function
Function
PUBLIC
Retire a shared runtime owner under the caller's lifecycle lock.
-
orionis.Application
orionis.Application.html
Class
Class
PUBLIC
Configure the container and serve requests within one worker event loop.
-
orionis.Application.__start_at
orionis.Application.html#__start_at
Attribute
Instance Variable
PUBLIC
Store the application startup timestamp in nanoseconds.
-
orionis.Application.__basePath
orionis.Application.html#__basePath
Attribute
Instance Variable
PUBLIC
Validate and store the basePath as the application root.
-
orionis.Application.__is_compiled
orionis.Application.html#__is_compiled
Attribute
Instance Variable
PUBLIC
Flag to determine if working with previously compiled state.
-
orionis.Application.__compiled_state_store
orionis.Application.html#__compiled_state_store
Attribute
Instance Variable
PUBLIC
Cache driver for storing compiled configuration.
-
orionis.Application.__hook_events
orionis.Application.html#__hook_events
Attribute
Instance Variable
PUBLIC
Lifecycle event callbacks for each runtime (HTTP/CLI/global). These are not cached and execute on each lifecycle event.
-
orionis.Application.__scheduler_resolved
orionis.Application.html#__scheduler_resolved
Attribute
Instance Variable
PUBLIC
Initialize references to resolved service classes.
-
orionis.Application.__exception_handler_resolved
orionis.Application.html#__exception_handler_resolved
Attribute
Instance Variable
PUBLIC
Exception-handler instance cached after its first resolution.
-
orionis.Application.__booted
orionis.Application.html#__booted
Attribute
Instance Variable
PUBLIC
Initialize application state flags.
-
orionis.Application.__configured
orionis.Application.html#__configured
Attribute
Instance Variable
PUBLIC
Configured flag used by Application.
-
orionis.Application.__runtime_config_initialized
orionis.Application.html#__runtime_config_initialized
Attribute
Instance Variable
PUBLIC
Runtime config initialized flag used by Application.
-
orionis.Application.__is_production_cache
orionis.Application.html#__is_production_cache
Attribute
Instance Variable
PUBLIC
Is production cache flag used by Application.
-
orionis.Application.__is_debug_cache
orionis.Application.html#__is_debug_cache
Attribute
Instance Variable
PUBLIC
Is debug cache flag used by Application.
-
orionis.Application.__maintenance_marker
orionis.Application.html#__maintenance_marker
Attribute
Instance Variable
PUBLIC
Store the shared maintenance marker and its last observed state.
-
orionis.Application.__maintenance_cache
orionis.Application.html#__maintenance_cache
Attribute
Instance Variable
PUBLIC
Most recently observed maintenance-mode state.
-
orionis.Application.__maintenance_lock
orionis.Application.html#__maintenance_lock
Attribute
Instance Variable
PUBLIC
Synchronization primitive controlling access to maintenance lock.
-
orionis.Application.__bootstrap
orionis.Application.html#__bootstrap
Attribute
Instance Variable
PUBLIC
Initialize configuration dictionaries.
-
orionis.Application.__runtime_config
orionis.Application.html#__runtime_config
Attribute
Instance Variable
PUBLIC
Mutable runtime view of the committed application configuration.
-
orionis.Application.__http_disconnect_monitoring
orionis.Application.html#__http_disconnect_monitoring
Attribute
Instance Variable
PUBLIC
Http disconnect monitoring flag used by Application.
-
orionis.Application.__kernel_http_lock
orionis.Application.html#__kernel_http_lock
Attribute
Instance Variable
PUBLIC
Synchronization primitive controlling access to kernel http lock.
-
orionis.Application.__kernel_cli_lock
orionis.Application.html#__kernel_cli_lock
Attribute
Instance Variable
PUBLIC
Synchronization primitive controlling access to kernel cli lock.
-
orionis.Application.__cache_resolved_providers
orionis.Application.html#__cache_resolved_providers
Attribute
Instance Variable
PUBLIC
Initialize deferred providers cache.
-
orionis.Application.__pending_boot_providers
orionis.Application.html#__pending_boot_providers
Attribute
Instance Variable
PUBLIC
Pending boot providers produced by deque.
-
orionis.Application.__provider_boot_lock
orionis.Application.html#__provider_boot_lock
Attribute
Instance Variable
PUBLIC
Synchronization primitive controlling access to provider boot lock.
-
orionis.Application.__providers_registry_initialized
orionis.Application.html#__providers_registry_initialized
Attribute
Instance Variable
PUBLIC
Initialize providers registry sentinel.
-
orionis.Application.__entry_point
orionis.Application.html#__entry_point
Attribute
Instance Variable
PUBLIC
Store the file path where the application was started.
-
orionis.Application._deferred_providers
orionis.Application.html#_deferred_providers
Attribute
Instance Variable
PUBLIC
Initialize deferred providers storage for tracking.
-
orionis.Application.__compiled
orionis.Application.html#__compiled
Attribute
Instance Variable
PUBLIC
Compilation and configuration caching logic.
-
orionis.Application.__compiled_path
orionis.Application.html#__compiled_path
Attribute
Instance Variable
PUBLIC
Directory containing compiled application bootstrap metadata.
-
orionis.Application.__compiled_invalidation_paths_dirs
orionis.Application.html#__compiled_invalidation_paths_dirs
Attribute
Instance Variable
PUBLIC
Compiled invalidation paths dirs produced by set.
-
orionis.Application.__compiled_invalidation_paths_files
orionis.Application.html#__compiled_invalidation_paths_files
Attribute
Instance Variable
PUBLIC
Compiled invalidation paths files produced by set.
-
orionis.Application._Application__initialized
orionis.Application.html#_Application__initialized
Attribute
Instance Variable
PUBLIC
Mark the Application as initialized to enforce singleton behavior.
-
orionis.Application.__call__
orionis.Application.html#__call__
Function
Method
PUBLIC
Route ASGI HTTP, WebSocket, and lifespan scopes to their handlers.
-
orionis.Application.__asgiLifespan
orionis.Application.html#__asgiLifespan
Function
Method
PUBLIC
Receive ASGI lifespan messages until shutdown or disconnect.
-
orionis.Application.__handleLifespanEvent
orionis.Application.html#__handleLifespanEvent
Function
Method
PUBLIC
Process one ASGI lifespan event and report its outcome.
-
orionis.Application.__runLifespanEvent
orionis.Application.html#__runLifespanEvent
Function
Method
PUBLIC
Run lifespan callbacks and acknowledge successful completion.
-
orionis.Application.__sendLifespanFailure
orionis.Application.html#__sendLifespanFailure
Function
Method
PUBLIC
Report a lifespan failure and send the ASGI failure response.
-
orionis.Application.__handleHttpAsgi
orionis.Application.html#__handleHttpAsgi
Function
Method
PUBLIC
Dispatch ASGI connections under the configured disconnect policy.
-
orionis.Application.__rsgi__
orionis.Application.html#__rsgi__
Function
Method
PUBLIC
Route RSGI HTTP and WebSocket connections to the HTTP kernel.
-
orionis.Application.__rsgi_init__
orionis.Application.html#__rsgi_init__
Function
Method
PUBLIC
Run RSGI startup on the server's event loop.
-
orionis.Application.__startRsgi
orionis.Application.html#__startRsgi
Function
Method
PUBLIC
Complete RSGI startup before activating failure reporting.
-
orionis.Application.__rsgi_del__
orionis.Application.html#__rsgi_del__
Function
Method
PUBLIC
Run RSGI shutdown on the server's event loop.
-
orionis.Application.__stopRsgi
orionis.Application.html#__stopRsgi
Function
Method
PUBLIC
Run RSGI shutdown before releasing failure-reporting ownership.
-
orionis.Application.__handleHttpRsgi
orionis.Application.html#__handleHttpRsgi
Function
Method
PUBLIC
Dispatch RSGI connections under the configured disconnect policy.
-
orionis.Application.__initializeHttpKernel
orionis.Application.html#__initializeHttpKernel
Function
Method
PUBLIC
Initialize both HTTP handlers under a shared startup lock.
-
orionis.Application.__http_disconnect_paths
orionis.Application.html#__http_disconnect_paths
Attribute
Instance Variable
PUBLIC
Http disconnect paths produced by kernel.disconnectPaths.
-
orionis.Application.__kernel_http_asgi
orionis.Application.html#__kernel_http_asgi
Attribute
Instance Variable
PUBLIC
Kernel http asgi supplied through asgi_handler.
-
orionis.Application.__kernel_http_rsgi
orionis.Application.html#__kernel_http_rsgi
Attribute
Instance Variable
PUBLIC
Kernel http rsgi supplied through rsgi_handler.
-
orionis.Application.__loadHTTPKernel
orionis.Application.html#__loadHTTPKernel
Function
Method
PUBLIC
Build and boot the configured HTTP kernel.
-
orionis.Application.__loadCLIKernel
orionis.Application.html#__loadCLIKernel
Function
Method
PUBLIC
Build and validate the configured CLI kernel.
-
orionis.Application.handleCommand
orionis.Application.html#handleCommand
Function
Method
PUBLIC
Run a CLI command within its startup and shutdown lifecycle.
-
orionis.Application.__initializeCliKernel
orionis.Application.html#__initializeCliKernel
Function
Method
PUBLIC
Boot the CLI kernel and cache its handler under a shared lock.
-
orionis.Application.__kernel_cli
orionis.Application.html#__kernel_cli
Attribute
Instance Variable
PUBLIC
Kernel cli obtained from kernel.handle.
-
orionis.Application.current
orionis.Application.html#current
Function
Class Method
PUBLIC
Return this class's existing singleton without initializing it.
-
orionis.Application.isBooted
orionis.Application.html#isBooted
Attribute
Property
PUBLIC
Report whether configuration and eager registration are complete.
-
orionis.Application.isCreated
orionis.Application.html#isCreated
Attribute
Property
PUBLIC
Report the configuration-stage state exposed by isBooted.
-
orionis.Application.areProvidersBooted
orionis.Application.html#areProvidersBooted
Attribute
Property
PUBLIC
Check whether all eager providers have finished booting.
-
orionis.Application.isHttpReady
orionis.Application.html#isHttpReady
Attribute
Property
PUBLIC
Check whether eager providers and both HTTP handlers are ready.
-
orionis.Application.startAt
orionis.Application.html#startAt
Attribute
Property
PUBLIC
Return the instance initialization timestamp in Unix nanoseconds.
-
orionis.Application.routeHealthCheck
orionis.Application.html#routeHealthCheck
Attribute
Property
PUBLIC
Return the configured health-check URL path.
-
orionis.Application.entryPoint
orionis.Application.html#entryPoint
Attribute
Property
PUBLIC
Return the creation entry point as a module path with an app suffix.
-
orionis.Application.basePath
orionis.Application.html#basePath
Attribute
Property
PUBLIC
Return the resolved application root directory.
-
orionis.Application.compiled
orionis.Application.html#compiled
Attribute
Property
PUBLIC
Check whether compiled bootstrap caching is enabled.
-
orionis.Application.compiledPath
orionis.Application.html#compiledPath
Attribute
Property
PUBLIC
Return the configured bootstrap cache directory.
-
orionis.Application.compiledInvalidationPathsDirs
orionis.Application.html#compiledInvalidationPathsDirs
Attribute
Property
PUBLIC
Return configured directories used for bootstrap cache invalidation.
-
orionis.Application.compiledInvalidationPathsFiles
orionis.Application.html#compiledInvalidationPathsFiles
Attribute
Property
PUBLIC
Return configured files used for bootstrap cache invalidation.
-
orionis.Application.__init__
orionis.Application.html#__init__
Function
Method
PUBLIC
Initialize the application singleton and its lifecycle state once.
-
orionis.Application.__exception_handler_instance
orionis.Application.html#__exception_handler_instance
Attribute
Instance Variable
PUBLIC
Shared handler constructed outside request and operation scopes.
-
orionis.Application.__exception_handler_lock
orionis.Application.html#__exception_handler_lock
Attribute
Instance Variable
PUBLIC
Serialize construction of the application exception handler.
-
orionis.Application.__headless_close_lock
orionis.Application.html#__headless_close_lock
Attribute
Instance Variable
PUBLIC
Coordinate explicit headless startup and final resource closure.
-
orionis.Application._failure_runtime
orionis.Application.html#_failure_runtime
Attribute
Instance Variable
PUBLIC
Prepared coordinator activated by successful runtime owners.
-
orionis.Application.compile
orionis.Application.html#compile
Function
Method
PUBLIC
Configure bootstrap caching and restore any valid compiled state.
-
orionis.Application.__assertPythonVersion
orionis.Application.html#__assertPythonVersion
Function
Method
PUBLIC
Reject Python runtimes below the framework's minimum version.
-
orionis.Application.__validateAndReturnPath
orionis.Application.html#__validateAndReturnPath
Function
Method
PUBLIC
Resolve a supported path to an absolute filesystem path.
-
orionis.Application.on
orionis.Application.html#on
Function
Method
PUBLIC
Register unique callbacks for a runtime's startup or shutdown event.
-
orionis.Application.__onStartup
orionis.Application.html#__onStartup
Function
Method
PUBLIC
Boot eager providers and run runtime-specific startup hooks.
-
orionis.Application.__onShutdown
orionis.Application.html#__onShutdown
Function
Method
PUBLIC
Run shutdown hooks before draining runtime resources.
-
orionis.Application.__runShutdownCallbacks
orionis.Application.html#__runShutdownCallbacks
Function
Method
PUBLIC
Attempt every shutdown callback and propagate its first failure.
-
orionis.Application.__closeRuntimeResources
orionis.Application.html#__closeRuntimeResources
Function
Method
PUBLIC
Drain runtime tasks and close the logging sink for its final owner.
-
orionis.Application.__closeRuntimeLogger
orionis.Application.html#__closeRuntimeLogger
Function
Method
PUBLIC
Close the bound logger under the final owner's lifecycle lock.
-
orionis.Application.__defaultBootstrap
orionis.Application.html#__defaultBootstrap
Function
Method
PUBLIC
Build a fresh bootstrap mapping from core framework metadata.
-
orionis.Application.__ensureDefaultBootstrap
orionis.Application.html#__ensureDefaultBootstrap
Function
Method
PUBLIC
Populate an empty bootstrap mapping with core defaults.
-
orionis.Application.__ensureDefaultPaths
orionis.Application.html#__ensureDefaultPaths
Function
Method
PUBLIC
Populate missing bootstrap paths from the application defaults.
-
orionis.Application.__assertConfigMutable
orionis.Application.html#__assertConfigMutable
Function
Method
PUBLIC
Reject locked bootstrap changes and initialize mutable defaults.
-
orionis.Application.__lockConfig
orionis.Application.html#__lockConfig
Function
Method
PUBLIC
Recursively freeze the bootstrap configuration.
-
orionis.Application.__bootCompiledState
orionis.Application.html#__bootCompiledState
Function
Method
PUBLIC
Configure bootstrap caching and restore a valid cached snapshot.
-
orionis.Application.__persistCompiledState
orionis.Application.html#__persistCompiledState
Function
Method
PUBLIC
Save bootstrap metadata when compiled caching is active.
-
orionis.Application.withMiddleware
orionis.Application.html#withMiddleware
Function
Method
PUBLIC
Register unique middleware classes in application execution order.
-
orionis.Application.getMiddleware
orionis.Application.html#getMiddleware
Function
Method
PUBLIC
Resolve registered middleware classes in application execution order.
-
orionis.Application.withProviders
orionis.Application.html#withProviders
Function
Method
PUBLIC
Register eager or deferred service provider classes for bootstrap.
-
orionis.Application.__loadCoreProviders
orionis.Application.html#__loadCoreProviders
Function
Method
PUBLIC
Register the framework's core service provider classes.
-
orionis.Application.__ensureProvidersRegistryStructure
orionis.Application.html#__ensureProvidersRegistryStructure
Function
Method
PUBLIC
Initialize eager and deferred provider registries once.
-
orionis.Application.__validateProviderClass
orionis.Application.html#__validateProviderClass
Function
Method
PUBLIC
Require a service provider class implementing IServiceProvider.
-
orionis.Application.__storeEagerProviderClass
orionis.Application.html#__storeEagerProviderClass
Function
Method
PUBLIC
Prepend validated provider metadata to the eager registry.
-
orionis.Application.__storeDeferredProviderClass
orionis.Application.html#__storeDeferredProviderClass
Function
Method
PUBLIC
Map each deferred service identifier to its provider metadata.
-
orionis.Application.__storeProviderClass
orionis.Application.html#__storeProviderClass
Function
Method
PUBLIC
Validate and store a provider class in its matching registry.
-
orionis.Application.__discoverProviders
orionis.Application.html#__discoverProviders
Function
Method
PUBLIC
Import concrete providers declared by the discovered modules.
-
orionis.Application.__loadProviders
orionis.Application.html#__loadProviders
Function
Method
PUBLIC
Discover application providers, then register core framework providers.
-
orionis.Application.__resolveEagerProvider
orionis.Application.html#__resolveEagerProvider
Function
Method
PUBLIC
Register eager providers and queue their asynchronous boot methods.
-
orionis.Application.__bootEagerProviders
orionis.Application.html#__bootEagerProviders
Function
Method
PUBLIC
Await pending eager providers under a shared startup lock.
-
orionis.Application.withRouting
orionis.Application.html#withRouting
Function
Method
PUBLIC
Configure route files and the health-check path for each protocol.
-
orionis.Application.__resolveAndValidateRoutingFiles
orionis.Application.html#__resolveAndValidateRoutingFiles
Function
Method
PUBLIC
Resolve route files and verify their required imports.
-
orionis.Application.withExceptionHandler
orionis.Application.html#withExceptionHandler
Function
Method
PUBLIC
Set the exception handler class used for lazy singleton resolution.
-
orionis.Application.getExceptionHandler
orionis.Application.html#getExceptionHandler
Function
Method
PUBLIC
Resolve and cache the configured exception handler instance.
-
orionis.Application.withScheduler
orionis.Application.html#withScheduler
Function
Method
PUBLIC
Set the scheduler class built by getScheduler.
-
orionis.Application.getScheduler
orionis.Application.html#getScheduler
Function
Method
PUBLIC
Resolve the scheduler class and build its instance.
-
orionis.Application.withConfigApp
orionis.Application.html#withConfigApp
Function
Method
PUBLIC
Set application configuration overrides for bootstrap.
-
orionis.Application.withConfigAuth
orionis.Application.html#withConfigAuth
Function
Method
PUBLIC
Set authentication configuration overrides for bootstrap.
-
orionis.Application.withConfigMcp
orionis.Application.html#withConfigMcp
Function
Method
PUBLIC
Set MCP protocol limits and allowed origins for bootstrap.
-
orionis.Application.withConfigCache
orionis.Application.html#withConfigCache
Function
Method
PUBLIC
Set cache configuration overrides for bootstrap.
-
orionis.Application.withConfigHttp
orionis.Application.html#withConfigHttp
Function
Method
PUBLIC
Set HTTP configuration overrides for bootstrap.
-
orionis.Application.withConfigDatabase
orionis.Application.html#withConfigDatabase
Function
Method
PUBLIC
Set database configuration overrides for bootstrap.
-
orionis.Application.withConfigFilesystems
orionis.Application.html#withConfigFilesystems
Function
Method
PUBLIC
Set filesystem configuration overrides for bootstrap.
-
orionis.Application.withConfigLogging
orionis.Application.html#withConfigLogging
Function
Method
PUBLIC
Set logging configuration overrides for bootstrap.
-
orionis.Application.withConfigMail
orionis.Application.html#withConfigMail
Function
Method
PUBLIC
Set mail configuration overrides for bootstrap.
-
orionis.Application.withConfigQueue
orionis.Application.html#withConfigQueue
Function
Method
PUBLIC
Set queue configuration overrides for bootstrap.
-
orionis.Application.withConfigSession
orionis.Application.html#withConfigSession
Function
Method
PUBLIC
Set session configuration overrides for bootstrap.
-
orionis.Application.withConfigTesting
orionis.Application.html#withConfigTesting
Function
Method
PUBLIC
Set testing configuration overrides for bootstrap.
-
orionis.Application.withConfigPaths
orionis.Application.html#withConfigPaths
Function
Method
PUBLIC
Configure resolved application directories with core path overrides.
-
orionis.Application.__loadCustomConfig
orionis.Application.html#__loadCustomConfig
Function
Method
PUBLIC
Merge custom sections and discovered dataclasses into the defaults.
-
orionis.Application.__loadConfig
orionis.Application.html#__loadConfig
Function
Method
PUBLIC
Load core defaults, custom sections, and discovered configuration data.
-
orionis.Application.__commitConfig
orionis.Application.html#__commitConfig
Function
Method
PUBLIC
Freeze bootstrap metadata and mark configuration initialized.
-
orionis.Application.__setTimezoneAndLocale
orionis.Application.html#__setTimezoneAndLocale
Function
Method
PUBLIC
Apply configured timezone and locale settings to runtime services.
-
orionis.Application.__load
orionis.Application.html#__load
Function
Method
PUBLIC
Load bootstrap state and register providers without awaiting async boots.
-
orionis.Application.create
orionis.Application.html#create
Function
Method
PUBLIC
Create application configuration and register eager services once.
-
orionis.Application.boot
orionis.Application.html#boot
Function
Method
PUBLIC
Create the application and start eager providers for headless use.
-
orionis.Application.aclose
orionis.Application.html#aclose
Function
Method
PUBLIC
Close the headless reporting lifetime acquired by boot.
-
orionis.Application.config
orionis.Application.html#config
Function
Method
PUBLIC
Read or update the mutable runtime configuration.
-
orionis.Application.resetRuntimeConfig
orionis.Application.html#resetRuntimeConfig
Function
Method
PUBLIC
Restore mutable runtime settings from the bootstrap configuration.
-
orionis.Application.__getRuntimeConfigValue
orionis.Application.html#__getRuntimeConfigValue
Function
Method
PUBLIC
Read a runtime value through pre-parsed configuration components.
-
orionis.Application.__setRuntimeConfigValue
orionis.Application.html#__setRuntimeConfigValue
Function
Method
PUBLIC
Write a runtime value, replacing non-dictionary parents as needed.
-
orionis.Application.path
orionis.Application.html#path
Function
Method
PUBLIC
Return one configured application path or the read-only path mapping.
-
orionis.Application.routingPaths
orionis.Application.html#routingPaths
Function
Method
PUBLIC
Return mutable copies of configured routing paths.
-
orionis.Application.isProduction
orionis.Application.html#isProduction
Function
Method
PUBLIC
Check the production flag cached during application creation.
-
orionis.Application.isDebug
orionis.Application.html#isDebug
Function
Method
PUBLIC
Check the debug flag cached during application creation.
-
orionis.Application.underMaintenance
orionis.Application.html#underMaintenance
Function
Method
PUBLIC
Check effective maintenance mode using a short-lived worker cache.
-
orionis.IApplication
orionis.IApplication.html
Class
Class
PUBLIC
Define application configuration, lifecycle and runtime entry points.
-
orionis.IApplication.__slots__
orionis.IApplication.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.IApplication.isBooted
orionis.IApplication.html#isBooted
Attribute
Property
PUBLIC
Report whether configuration and eager registration are complete.
-
orionis.IApplication.isCreated
orionis.IApplication.html#isCreated
Attribute
Property
PUBLIC
Report the configuration-stage state exposed by isBooted.
-
orionis.IApplication.areProvidersBooted
orionis.IApplication.html#areProvidersBooted
Attribute
Property
PUBLIC
Check whether all eager providers have finished booting.
-
orionis.IApplication.isHttpReady
orionis.IApplication.html#isHttpReady
Attribute
Property
PUBLIC
Check whether eager providers and both HTTP handlers are ready.
-
orionis.IApplication.startAt
orionis.IApplication.html#startAt
Attribute
Property
PUBLIC
Return the instance initialization timestamp in Unix nanoseconds.
-
orionis.IApplication.routeHealthCheck
orionis.IApplication.html#routeHealthCheck
Attribute
Property
PUBLIC
Return the configured health-check URL path.
-
orionis.IApplication.entryPoint
orionis.IApplication.html#entryPoint
Attribute
Property
PUBLIC
Return the creation entry point as a module path with an app suffix.
-
orionis.IApplication.basePath
orionis.IApplication.html#basePath
Attribute
Property
PUBLIC
Return the resolved application root directory.
-
orionis.IApplication.compiled
orionis.IApplication.html#compiled
Attribute
Property
PUBLIC
Check whether compiled bootstrap caching is enabled.
-
orionis.IApplication.compiledPath
orionis.IApplication.html#compiledPath
Attribute
Property
PUBLIC
Return the configured bootstrap cache directory.
-
orionis.IApplication.compiledInvalidationPathsDirs
orionis.IApplication.html#compiledInvalidationPathsDirs
Attribute
Property
PUBLIC
Return configured directories used for bootstrap cache invalidation.
-
orionis.IApplication.compiledInvalidationPathsFiles
orionis.IApplication.html#compiledInvalidationPathsFiles
Attribute
Property
PUBLIC
Return configured files used for bootstrap cache invalidation.
-
orionis.IApplication.compile
orionis.IApplication.html#compile
Function
Method
PUBLIC
Configure bootstrap caching and restore any valid compiled state.
-
orionis.IApplication.on
orionis.IApplication.html#on
Function
Method
PUBLIC
Register unique callbacks for a runtime's startup or shutdown event.
-
orionis.IApplication.withMiddleware
orionis.IApplication.html#withMiddleware
Function
Method
PUBLIC
Register unique middleware classes in application execution order.
-
orionis.IApplication.getMiddleware
orionis.IApplication.html#getMiddleware
Function
Method
PUBLIC
Resolve registered middleware classes in application execution order.
-
orionis.IApplication.withProviders
orionis.IApplication.html#withProviders
Function
Method
PUBLIC
Register eager or deferred service provider classes for bootstrap.
-
orionis.IApplication.withRouting
orionis.IApplication.html#withRouting
Function
Method
PUBLIC
Configure route files and the health-check path for each protocol.
-
orionis.IApplication.withExceptionHandler
orionis.IApplication.html#withExceptionHandler
Function
Method
PUBLIC
Set the exception handler class used for lazy singleton resolution.
-
orionis.IApplication.getExceptionHandler
orionis.IApplication.html#getExceptionHandler
Function
Method
PUBLIC
Resolve and cache the configured exception handler instance.
-
orionis.IApplication.withScheduler
orionis.IApplication.html#withScheduler
Function
Method
PUBLIC
Set the scheduler class built by getScheduler.
-
orionis.IApplication.getScheduler
orionis.IApplication.html#getScheduler
Function
Method
PUBLIC
Resolve the scheduler class and build its instance.
-
orionis.IApplication.withConfigApp
orionis.IApplication.html#withConfigApp
Function
Method
PUBLIC
Set application configuration overrides for bootstrap.
-
orionis.IApplication.withConfigMcp
orionis.IApplication.html#withConfigMcp
Function
Method
PUBLIC
Set MCP protocol limits and allowed origins for bootstrap.
-
orionis.IApplication.withConfigAuth
orionis.IApplication.html#withConfigAuth
Function
Method
PUBLIC
Set authentication configuration overrides for bootstrap.
-
orionis.IApplication.withConfigCache
orionis.IApplication.html#withConfigCache
Function
Method
PUBLIC
Set cache configuration overrides for bootstrap.
-
orionis.IApplication.withConfigHttp
orionis.IApplication.html#withConfigHttp
Function
Method
PUBLIC
Set HTTP configuration overrides for bootstrap.
-
orionis.IApplication.withConfigDatabase
orionis.IApplication.html#withConfigDatabase
Function
Method
PUBLIC
Set database configuration overrides for bootstrap.
-
orionis.IApplication.withConfigFilesystems
orionis.IApplication.html#withConfigFilesystems
Function
Method
PUBLIC
Set filesystem configuration overrides for bootstrap.
-
orionis.IApplication.withConfigLogging
orionis.IApplication.html#withConfigLogging
Function
Method
PUBLIC
Set logging configuration overrides for bootstrap.
-
orionis.IApplication.withConfigMail
orionis.IApplication.html#withConfigMail
Function
Method
PUBLIC
Set mail configuration overrides for bootstrap.
-
orionis.IApplication.withConfigQueue
orionis.IApplication.html#withConfigQueue
Function
Method
PUBLIC
Set queue configuration overrides for bootstrap.
-
orionis.IApplication.withConfigSession
orionis.IApplication.html#withConfigSession
Function
Method
PUBLIC
Set session configuration overrides for bootstrap.
-
orionis.IApplication.withConfigTesting
orionis.IApplication.html#withConfigTesting
Function
Method
PUBLIC
Set testing configuration overrides for bootstrap.
-
orionis.IApplication.withConfigPaths
orionis.IApplication.html#withConfigPaths
Function
Method
PUBLIC
Configure resolved application directories with core path overrides.
-
orionis.IApplication.create
orionis.IApplication.html#create
Function
Method
PUBLIC
Create application configuration and register eager services once.
-
orionis.IApplication.boot
orionis.IApplication.html#boot
Function
Method
PUBLIC
Create the application and start eager providers for headless use.
-
orionis.IApplication.aclose
orionis.IApplication.html#aclose
Function
Method
PUBLIC
Close a headless lifetime when the implementation owns one.
-
orionis.IApplication.handleCommand
orionis.IApplication.html#handleCommand
Function
Method
PUBLIC
Run a CLI command within its startup and shutdown lifecycle.
-
orionis.IApplication.config
orionis.IApplication.html#config
Function
Method
PUBLIC
Read or update the mutable runtime configuration.
-
orionis.IApplication.resetRuntimeConfig
orionis.IApplication.html#resetRuntimeConfig
Function
Method
PUBLIC
Restore mutable runtime settings from the bootstrap configuration.
-
orionis.IApplication.path
orionis.IApplication.html#path
Function
Method
PUBLIC
Return one configured application path or the read-only path mapping.
-
orionis.IApplication.routingPaths
orionis.IApplication.html#routingPaths
Function
Method
PUBLIC
Return mutable copies of configured routing paths.
-
orionis.IApplication.isProduction
orionis.IApplication.html#isProduction
Function
Method
PUBLIC
Check the production flag cached during application creation.
-
orionis.IApplication.isDebug
orionis.IApplication.html#isDebug
Function
Method
PUBLIC
Check the debug flag cached during application creation.
-
orionis.IApplication.underMaintenance
orionis.IApplication.html#underMaintenance
Function
Method
PUBLIC
Check effective maintenance mode using a short-lived worker cache.
-
orionis._EXPORTS
index.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.__getattr__
index.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.__dir__
index.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.aio.Loop
orionis.aio.Loop.html
Class
Class
PUBLIC
Thread-safe, platform-aware asyncio event loop manager for the Orionis Framework.
-
orionis.aio.Loop._IS_WIN32
orionis.aio.Loop.html#_IS_WIN32
Attribute
Constant
PUBLIC
True when running on Windows; evaluated once at class definition.
-
orionis.aio.Loop._uvloop_factory
orionis.aio.Loop.html#_uvloop_factory
Attribute
Class Variable
PUBLIC
Cached uvloop factory; None until detection completes.
-
orionis.aio.Loop._uvloop_checked
orionis.aio.Loop.html#_uvloop_checked
Attribute
Class Variable
PUBLIC
ensures uvloop detection runs at most once across all threads.
-
orionis.aio.Loop._loop_lock
orionis.aio.Loop.html#_loop_lock
Attribute
Class Variable
PUBLIC
Serialises uvloop detection to prevent duplicate work under concurrency.
-
orionis.aio.Loop._loop_factory_resolved
orionis.aio.Loop.html#_loop_factory_resolved
Attribute
Class Variable
PUBLIC
Whether the optimal loop factory has been resolved yet.
-
orionis.aio.Loop._loop_factory_cached
orionis.aio.Loop.html#_loop_factory_cached
Attribute
Class Variable
PUBLIC
Cached optimal loop factory; None means "use asyncio default". Only valid when _loop_factory_resolved is True.
-
orionis.aio.Loop._getRunningLoop
orionis.aio.Loop.html#_getRunningLoop
Function
Static Method
PUBLIC
Return the event loop currently running in this thread, or None.
-
orionis.aio.Loop._getRegisteredLoop
orionis.aio.Loop.html#_getRegisteredLoop
Function
Static Method
PUBLIC
Return the thread's registered loop if it is still open.
-
orionis.aio.Loop._detectUvloop
orionis.aio.Loop.html#_detectUvloop
Function
Class Method
PUBLIC
Detect and cache the uvloop event loop factory, if available.
-
orionis.aio.Loop._getLoopFactory
orionis.aio.Loop.html#_getLoopFactory
Function
Class Method
PUBLIC
Return the best available event loop factory for the current platform.
-
orionis.aio.Loop._newEventLoop
orionis.aio.Loop.html#_newEventLoop
Function
Class Method
PUBLIC
Create and register a loop using the selected platform factory.
-
orionis.aio.Loop._runnerContext
orionis.aio.Loop.html#_runnerContext
Function
Class Method
PUBLIC
Own a Runner and restore the thread's previous loop on exit.
-
orionis.aio.Loop.getEventLoop
orionis.aio.Loop.html#getEventLoop
Function
Class Method
PUBLIC
Return the event loop for the current thread, creating one if necessary.
-
orionis.aio.Loop.run
orionis.aio.Loop.html#run
Function
Class Method
PUBLIC
Execute a coroutine as the application entry point.
-
orionis.aio.Loop._reportAbandonedError
orionis.aio.Loop.html#_reportAbandonedError
Function
Static Method
PUBLIC
Observe an unconsumed worker or cleanup failure through its owner.
-
orionis.aio.Loop._discardResult
orionis.aio.Loop.html#_discardResult
Function
Static Method
PUBLIC
Release a worker result abandoned by a cancelled caller.
-
orionis.aio.Loop.execute
orionis.aio.Loop.html#execute
Function
Static Method
PUBLIC
Execute a sync or async callable while preserving the calling context.
-
orionis.aio.Loop.eventLoopContext
orionis.aio.Loop.html#eventLoopContext
Function
Class Method
PUBLIC
Borrow the current open loop, or create and own one for the block.
-
orionis.aio.Loop.isLoopRunning
orionis.aio.Loop.html#isLoopRunning
Function
Static Method
PUBLIC
Return True if an event loop is currently running in the calling thread.
-
orionis.aio.Loop.createTask
orionis.aio.Loop.html#createTask
Function
Static Method
PUBLIC
Create and schedule a new asyncio task for coro immediately.
-
orionis.aio.Loop.runSync
orionis.aio.Loop.html#runSync
Function
Class Method
PUBLIC
Run a coroutine synchronously from a thread without a running loop.
-
orionis.aio._EXPORTS
orionis.aio.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.aio.__getattr__
orionis.aio.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.aio.__dir__
orionis.aio.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.auth.concerns.functions._FALLBACK_PRIMARY_KEY
orionis.auth.concerns.functions.html#_FALLBACK_PRIMARY_KEY
Attribute
Constant
PUBLIC
Attribute used when the object does not expose ORM metadata.
-
orionis.auth.concerns.functions._MAX_KEY_LENGTH
orionis.auth.concerns.functions.html#_MAX_KEY_LENGTH
Attribute
Constant
PUBLIC
Max key length value used by functions.
-
orionis.auth.concerns.functions.authorizable_key
orionis.auth.concerns.functions.html#authorizable_key
Function
Function
PUBLIC
Normalize a persisted identity's polymorphic authorization key.
-
orionis.auth.AuthConfigurationException
orionis.auth.AuthConfigurationException.html
Class
Exception
PUBLIC
Raise when the authentication configuration is missing or invalid.
-
orionis.auth.AuthenticationException
orionis.auth.AuthenticationException.html
Class
Exception
PUBLIC
Raise when the current request carries no valid authenticated identity.
-
orionis.auth.AuthException
orionis.auth.AuthException.html
Class
Exception
PUBLIC
Base exception for every failure raised by the authentication module.
-
orionis.auth.AuthorizationException
orionis.auth.AuthorizationException.html
Class
Exception
PUBLIC
Raise when an authenticated identity lacks the required authorization.
-
orionis.auth.GuardNotFoundException
orionis.auth.GuardNotFoundException.html
Class
Exception
PUBLIC
Raise when the requested authentication guard is not registered.
-
orionis.auth.IdentityProviderException
orionis.auth.IdentityProviderException.html
Class
Exception
PUBLIC
Raise when the identity provider cannot resolve the application identity.
-
orionis.auth.PolicyNotFoundException
orionis.auth.PolicyNotFoundException.html
Class
Exception
PUBLIC
Raise when no policy is registered for the requested resource type.
-
orionis.auth.TokenException
orionis.auth.TokenException.html
Class
Exception
PUBLIC
Raise when a personal access token cannot be issued or verified.
-
orionis.auth._EXCEPTIONS_MODULE
orionis.auth.html#_EXCEPTIONS_MODULE
Attribute
Constant
PUBLIC
Locate the shared module defining authentication failures.
-
orionis.auth._EXPORTS
orionis.auth.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.auth.__getattr__
orionis.auth.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.auth.__dir__
orionis.auth.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.auth.authorization.Policy
orionis.auth.authorization.Policy.html
Class
Class
PUBLIC
Base class for resource policies.
-
orionis.auth.authorization.Policy.__slots__
orionis.auth.authorization.Policy.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.auth.authorization.Policy.before
orionis.auth.authorization.Policy.html#before
Function
Method
PUBLIC
Short circuit the policy before the ability method runs.
-
orionis.auth.authorization.registry._MISSING
orionis.auth.authorization.registry.html#_MISSING
Attribute
Constant
PUBLIC
Sentinel distinguishing "not cached yet" from a cached None result.
-
orionis.auth.authorization.PolicyRegistry
orionis.auth.authorization.PolicyRegistry.html
Class
Class
PUBLIC
Map resource classes to the policy classes protecting them.
-
orionis.auth.authorization.PolicyRegistry.__slots__
orionis.auth.authorization.PolicyRegistry.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.auth.authorization.PolicyRegistry.__init__
orionis.auth.authorization.PolicyRegistry.html#__init__
Function
Method
PUBLIC
Initialise an empty registry.
-
orionis.auth.authorization.PolicyRegistry.__policies
orionis.auth.authorization.PolicyRegistry.html#__policies
Attribute
Instance Variable
PUBLIC
Policy classes registered for each protected resource type.
-
orionis.auth.authorization.PolicyRegistry.__lookup
orionis.auth.authorization.PolicyRegistry.html#__lookup
Attribute
Instance Variable
PUBLIC
Weakly keyed resolutions that do not retain unregistered resource classes.
-
orionis.auth.authorization.PolicyRegistry.register
orionis.auth.authorization.PolicyRegistry.html#register
Function
Method
PUBLIC
Bind a policy class to a resource class.
-
orionis.auth.authorization.PolicyRegistry.policyFor
orionis.auth.authorization.PolicyRegistry.html#policyFor
Function
Method
PUBLIC
Return the policy protecting a resource class.
-
orionis.auth.authorization.PolicyRegistry.bindings
orionis.auth.authorization.PolicyRegistry.html#bindings
Function
Method
PUBLIC
Return a copy of the registered resource to policy bindings.
-
orionis.auth.authorization.EMPTY_SNAPSHOT
orionis.auth.authorization.html#EMPTY_SNAPSHOT
Attribute
Constant
PUBLIC
no permissions, no roles.
-
orionis.auth.authorization.AuthorizationSnapshot
orionis.auth.authorization.AuthorizationSnapshot.html
Class
Class
PUBLIC
Hold the immutable authorization picture of a single request.
-
orionis.auth.authorization.AuthorizationSnapshot.__slots__
orionis.auth.authorization.AuthorizationSnapshot.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.auth.authorization.AuthorizationSnapshot.__init__
orionis.auth.authorization.AuthorizationSnapshot.html#__init__
Function
Method
PUBLIC
Build a snapshot from the resolved authorization sources.
-
orionis.auth.authorization.AuthorizationSnapshot.__permissions
orionis.auth.authorization.AuthorizationSnapshot.html#__permissions
Attribute
Instance Variable
PUBLIC
Permission names owned by the identity, direct ones and the ones inherited from its roles.
-
orionis.auth.authorization.AuthorizationSnapshot.__roles
orionis.auth.authorization.AuthorizationSnapshot.html#__roles
Attribute
Instance Variable
PUBLIC
Role names assigned to the identity.
-
orionis.auth.authorization.AuthorizationSnapshot.__abilities
orionis.auth.authorization.AuthorizationSnapshot.html#__abilities
Attribute
Instance Variable
PUBLIC
Abilities restricting the presented credential.
-
orionis.auth.authorization.AuthorizationSnapshot.permissions
orionis.auth.authorization.AuthorizationSnapshot.html#permissions
Attribute
Property
PUBLIC
Return the permissions owned by the identity.
-
orionis.auth.authorization.AuthorizationSnapshot.roles
orionis.auth.authorization.AuthorizationSnapshot.html#roles
Attribute
Property
PUBLIC
Return the roles assigned to the identity.
-
orionis.auth.authorization.AuthorizationSnapshot.abilities
orionis.auth.authorization.AuthorizationSnapshot.html#abilities
Attribute
Property
PUBLIC
Return the abilities restricting the presented credential.
-
orionis.auth.authorization.AuthorizationSnapshot.can
orionis.auth.authorization.AuthorizationSnapshot.html#can
Function
Method
PUBLIC
Report whether the effective authorization grants a permission.
-
orionis.auth.authorization.AuthorizationSnapshot.hasRole
orionis.auth.authorization.AuthorizationSnapshot.html#hasRole
Function
Method
PUBLIC
Report whether the identity owns a role.
-
orionis.auth.authorization.AuthorizationSnapshot.__repr__
orionis.auth.authorization.AuthorizationSnapshot.html#__repr__
Function
Method
PUBLIC
Return a debugging representation of the snapshot.
-
orionis.auth.authorization.authorizer.Authorizer
orionis.auth.authorization.authorizer.Authorizer.html
Class
Class
PUBLIC
Answer authorization questions for a given request context.
-
orionis.auth.authorization.authorizer.Authorizer.__slots__
orionis.auth.authorization.authorizer.Authorizer.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.auth.authorization.authorizer.Authorizer.__init__
orionis.auth.authorization.authorizer.Authorizer.html#__init__
Function
Method
PUBLIC
Initialise the authorizer with the application container.
-
orionis.auth.authorization.authorizer.Authorizer.__app
orionis.auth.authorization.authorizer.Authorizer.html#__app
Attribute
Instance Variable
PUBLIC
Container used to build policy instances with their own dependencies injected.
-
orionis.auth.authorization.authorizer.Authorizer.__registry
orionis.auth.authorization.authorizer.Authorizer.html#__registry
Attribute
Instance Variable
PUBLIC
Registered implementations indexed by their public identifiers.
-
orionis.auth.authorization.authorizer.Authorizer.registry
orionis.auth.authorization.authorizer.Authorizer.html#registry
Function
Method
PUBLIC
Return the policy registry backing this authorizer.
-
orionis.auth.authorization.authorizer.Authorizer.registerPolicy
orionis.auth.authorization.authorizer.Authorizer.html#registerPolicy
Function
Method
PUBLIC
Bind a policy class to a resource type.
-
orionis.auth.authorization.authorizer.Authorizer.can
orionis.auth.authorization.authorizer.Authorizer.html#can
Function
Method
PUBLIC
Report whether the context grants a permission.
-
orionis.auth.authorization.authorizer.Authorizer.canAny
orionis.auth.authorization.authorizer.Authorizer.html#canAny
Function
Method
PUBLIC
Report whether the context grants at least one permission.
-
orionis.auth.authorization.authorizer.Authorizer.canAll
orionis.auth.authorization.authorizer.Authorizer.html#canAll
Function
Method
PUBLIC
Report whether the context grants every permission.
-
orionis.auth.authorization.authorizer.Authorizer.hasRole
orionis.auth.authorization.authorizer.Authorizer.html#hasRole
Function
Method
PUBLIC
Report whether the context owns a role.
-
orionis.auth.authorization.authorizer.Authorizer.allows
orionis.auth.authorization.authorizer.Authorizer.html#allows
Function
Method
PUBLIC
Evaluate a policy ability against a concrete resource.
-
orionis.support.types.contracts.collection.ICollection
orionis.support.types.contracts.collection.ICollection.html
Class
Class
PUBLIC
Define the contract for collection implementations.
-
orionis.support.types.contracts.collection.ICollection.take
orionis.support.types.contracts.collection.ICollection.html#take
Function
Method
PUBLIC
Take a specific number of items from the collection.
-
orionis.support.types.contracts.collection.ICollection.first
orionis.support.types.contracts.collection.ICollection.html#first
Function
Method
PUBLIC
Return the first item in the collection, optionally filtered by a callback.
-
orionis.support.types.contracts.collection.ICollection.last
orionis.support.types.contracts.collection.ICollection.html#last
Function
Method
PUBLIC
Return the last item in the collection, optionally filtered by a callback.
-
orionis.support.types.contracts.collection.ICollection.all
orionis.support.types.contracts.collection.ICollection.html#all
Function
Method
PUBLIC
Return all items in the collection.
-
orionis.support.types.contracts.collection.ICollection.avg
orionis.support.types.contracts.collection.ICollection.html#avg
Function
Method
PUBLIC
Compute the average of the items.
-
orionis.support.types.contracts.collection.ICollection.max
orionis.support.types.contracts.collection.ICollection.html#max
Function
Method
PUBLIC
Return the maximum value from the items.
-
orionis.support.types.contracts.collection.ICollection.min
orionis.support.types.contracts.collection.ICollection.html#min
Function
Method
PUBLIC
Return the minimum value from the items.
-
orionis.support.types.contracts.collection.ICollection.chunk
orionis.support.types.contracts.collection.ICollection.html#chunk
Function
Method
PUBLIC
Divide the collection into smaller collections of a specified size.
-
orionis.support.types.contracts.collection.ICollection.collapse
orionis.support.types.contracts.collection.ICollection.html#collapse
Function
Method
PUBLIC
Collapse the collection of arrays into a single, flat collection.
-
orionis.support.types.contracts.collection.ICollection.contains
orionis.support.types.contracts.collection.ICollection.html#contains
Function
Method
PUBLIC
Check if the collection contains a given item.
-
orionis.support.types.contracts.collection.ICollection.count
orionis.support.types.contracts.collection.ICollection.html#count
Function
Method
PUBLIC
Return the number of items in the collection.
-
orionis.support.types.contracts.collection.ICollection.diff
orionis.support.types.contracts.collection.ICollection.html#diff
Function
Method
PUBLIC
Return items not present in the given collection.
-
orionis.support.types.contracts.collection.ICollection.each
orionis.support.types.contracts.collection.ICollection.html#each
Function
Method
PUBLIC
Iterate over items and apply the callback to each.
-
orionis.support.types.contracts.collection.ICollection.every
orionis.support.types.contracts.collection.ICollection.html#every
Function
Method
PUBLIC
Determine whether all items satisfy the given callback condition.
-
orionis.support.types.contracts.collection.ICollection.filter
orionis.support.types.contracts.collection.ICollection.html#filter
Function
Method
PUBLIC
Filter items in the collection using a callback.
-
orionis.support.types.contracts.collection.ICollection.flatten
orionis.support.types.contracts.collection.ICollection.html#flatten
Function
Method
PUBLIC
Flatten the collection into a single dimension.
-
orionis.support.types.contracts.collection.ICollection.forget
orionis.support.types.contracts.collection.ICollection.html#forget
Function
Method
PUBLIC
Remove items from the collection by their keys.
-
orionis.support.types.contracts.collection.ICollection.forPage
orionis.support.types.contracts.collection.ICollection.html#forPage
Function
Method
PUBLIC
Slice the collection for pagination.
-
orionis.support.types.contracts.collection.ICollection.get
orionis.support.types.contracts.collection.ICollection.html#get
Function
Method
PUBLIC
Retrieve an item from the collection by key.
-
orionis.support.types.contracts.collection.ICollection.implode
orionis.support.types.contracts.collection.ICollection.html#implode
Function
Method
PUBLIC
Join all items in the collection into a single string.
-
orionis.support.types.contracts.collection.ICollection.isEmpty
orionis.support.types.contracts.collection.ICollection.html#isEmpty
Function
Method
PUBLIC
Check if the collection is empty.
-
orionis.support.types.contracts.collection.ICollection.map
orionis.support.types.contracts.collection.ICollection.html#map
Function
Method
PUBLIC
Apply a function to each item in the collection.
-
orionis.support.types.contracts.collection.ICollection.mapInto
orionis.support.types.contracts.collection.ICollection.html#mapInto
Function
Method
PUBLIC
Map items into instances of the given class.
-
orionis.support.types.contracts.collection.ICollection.merge
orionis.support.types.contracts.collection.ICollection.html#merge
Function
Method
PUBLIC
Merge the collection with the given items.
-
orionis.support.types.contracts.collection.ICollection.pluck
orionis.support.types.contracts.collection.ICollection.html#pluck
Function
Method
PUBLIC
Extract values for a given key from all items.
-
orionis.support.types.contracts.collection.ICollection.pop
orionis.support.types.contracts.collection.ICollection.html#pop
Function
Method
PUBLIC
Remove and return the last item from the collection.
-
orionis.support.types.contracts.collection.ICollection.prepend
orionis.support.types.contracts.collection.ICollection.html#prepend
Function
Method
PUBLIC
Prepend an item to the beginning of the collection.
-
orionis.support.types.contracts.collection.ICollection.pull
orionis.support.types.contracts.collection.ICollection.html#pull
Function
Method
PUBLIC
Remove and return an item from the collection by key.
-
orionis.support.types.contracts.collection.ICollection.push
orionis.support.types.contracts.collection.ICollection.html#push
Function
Method
PUBLIC
Add an item to the end of the collection.
-
orionis.support.types.contracts.collection.ICollection.put
orionis.support.types.contracts.collection.ICollection.html#put
Function
Method
PUBLIC
Insert or update an item in the collection at the specified key.
-
orionis.support.types.contracts.collection.ICollection.random
orionis.support.types.contracts.collection.ICollection.html#random
Function
Method
PUBLIC
Return one or more random items from the collection.
-
orionis.support.types.contracts.collection.ICollection.reduce
orionis.support.types.contracts.collection.ICollection.html#reduce
Function
Method
PUBLIC
Reduce the collection to a single value using a callback.
-
orionis.support.types.contracts.collection.ICollection.reject
orionis.support.types.contracts.collection.ICollection.html#reject
Function
Method
PUBLIC
Reject items that pass a given truth test.
-
orionis.support.types.contracts.collection.ICollection.reverse
orionis.support.types.contracts.collection.ICollection.html#reverse
Function
Method
PUBLIC
Reverse the order of items in the collection.
-
orionis.support.types.contracts.collection.ICollection.serialize
orionis.support.types.contracts.collection.ICollection.html#serialize
Function
Method
PUBLIC
Serialize the collection items as a list.
-
orionis.support.types.contracts.collection.ICollection.shift
orionis.support.types.contracts.collection.ICollection.html#shift
Function
Method
PUBLIC
Remove and return the first item from the collection.
-
orionis.support.types.contracts.collection.ICollection.sort
orionis.support.types.contracts.collection.ICollection.html#sort
Function
Method
PUBLIC
Sort the items in the collection.
-
orionis.support.types.contracts.collection.ICollection.sum
orionis.support.types.contracts.collection.ICollection.html#sum
Function
Method
PUBLIC
Compute the sum of the given values.
-
orionis.support.types.contracts.collection.ICollection.toJson
orionis.support.types.contracts.collection.ICollection.html#toJson
Function
Method
PUBLIC
Return the collection items as a JSON string.
-
orionis.support.types.contracts.collection.ICollection.groupBy
orionis.support.types.contracts.collection.ICollection.html#groupBy
Function
Method
PUBLIC
Group items in the collection by a specified key.
-
orionis.support.types.contracts.collection.ICollection.transform
orionis.support.types.contracts.collection.ICollection.html#transform
Function
Method
PUBLIC
Transform each item in the collection using a callback.
-
orionis.support.types.contracts.collection.ICollection.unique
orionis.support.types.contracts.collection.ICollection.html#unique
Function
Method
PUBLIC
Return unique items from the collection.
-
orionis.support.types.contracts.collection.ICollection.where
orionis.support.types.contracts.collection.ICollection.html#where
Function
Method
PUBLIC
Filter items by a given key-value pair or comparison.
-
orionis.support.types.contracts.collection.ICollection.whereIn
orionis.support.types.contracts.collection.ICollection.html#whereIn
Function
Method
PUBLIC
Filter items where a given key's value is in a list of values.
-
orionis.support.types.contracts.collection.ICollection.whereNotIn
orionis.support.types.contracts.collection.ICollection.html#whereNotIn
Function
Method
PUBLIC
Filter items where a given key's value is not in a list of values.
-
orionis.support.types.contracts.collection.ICollection.zip
orionis.support.types.contracts.collection.ICollection.html#zip
Function
Method
PUBLIC
Zip the collection with the given items by index.
-
orionis.support.types.contracts.collection.ICollection.setAppends
orionis.support.types.contracts.collection.ICollection.html#setAppends
Function
Method
PUBLIC
Set the attributes to append to the Collection.
-
orionis.support.types.uniqueness._UNSUPPORTED
orionis.support.types.uniqueness.html#_UNSUPPORTED
Attribute
Constant
PUBLIC
Sentinel distinguishing unsupported from ordinary values.
-
orionis.support.types.uniqueness._SCALARS
orionis.support.types.uniqueness.html#_SCALARS
Attribute
Constant
PUBLIC
Exact scalar types whose native equality supports structural indexing.
-
orionis.support.types.uniqueness._SMALL_INPUT
orionis.support.types.uniqueness.html#_SMALL_INPUT
Attribute
Constant
PUBLIC
Maximum input size for which linear unhashable comparison avoids index overhead.
-
orionis.support.types.uniqueness._structural_key
orionis.support.types.uniqueness.html#_structural_key
Function
Function
PUBLIC
Build equality-compatible keys only for exact built-in value trees.
-
orionis.support.types.uniqueness.unique_items
orionis.support.types.uniqueness.html#unique_items
Function
Function
PUBLIC
Preserve the first item for each equality key, with a safe tree fast path.
-
orionis.support.types.uniqueness._comparison_keys
orionis.support.types.uniqueness.html#_comparison_keys
Function
Function
PUBLIC
Build hashable equality keys or select the linear comparison fallback.
-
orionis.support.types.collection._OPERATORS
orionis.support.types.collection.module.html#_OPERATORS
Attribute
Constant
PUBLIC
Map comparison names to their implementations.
-
orionis.support.types.collection._MISSING
orionis.support.types.collection.module.html#_MISSING
Attribute
Constant
PUBLIC
distinguishes "attribute absent" from a legitimate None value in getattr calls, eliminating the hasattr+getattr double-lookup.
-
orionis.orm.schema.constraints.CompositeForeignKey
orionis.orm.schema.constraints.CompositeForeignKey.html
Class
Class
PUBLIC
Multi-column foreign key constraint.
-
orionis.orm.schema.constraints.CompositeForeignKey.columns
orionis.orm.schema.constraints.CompositeForeignKey.html#columns
Attribute
Instance Variable
PUBLIC
Local column names, in the same order as ref_columns.
-
orionis.orm.schema.constraints.CompositeForeignKey.ref_table
orionis.orm.schema.constraints.CompositeForeignKey.html#ref_table
Attribute
Instance Variable
PUBLIC
Name of the referenced table.
-
orionis.orm.schema.constraints.CompositeForeignKey.ref_columns
orionis.orm.schema.constraints.CompositeForeignKey.html#ref_columns
Attribute
Instance Variable
PUBLIC
Referenced column names, aligned positionally with columns.
-
orionis.orm.schema.constraints.CompositeForeignKey.name
orionis.orm.schema.constraints.CompositeForeignKey.html#name
Attribute
Instance Variable
PUBLIC
Explicit constraint name, or None to let the engine assign one.
-
orionis.orm.schema.constraints.foreign_reference._REFERENCE_PARTS
orionis.orm.schema.constraints.foreign_reference.html#_REFERENCE_PARTS
Attribute
Constant
PUBLIC
Number of segments expected in a qualified reference such as "companies.id".
-
orionis.orm.schema.constraints.ForeignReference
orionis.orm.schema.constraints.ForeignReference.html
Class
Class
PUBLIC
Immutable value object describing a foreign key reference.
-
orionis.orm.schema.constraints.ForeignReference.table
orionis.orm.schema.constraints.ForeignReference.html#table
Attribute
Instance Variable
PUBLIC
Name of the referenced table.
-
orionis.orm.schema.constraints.ForeignReference.column
orionis.orm.schema.constraints.ForeignReference.html#column
Attribute
Instance Variable
PUBLIC
Name of the referenced column.
-
orionis.orm.schema.constraints.ForeignReference.parse
orionis.orm.schema.constraints.ForeignReference.html#parse
Function
Class Method
PUBLIC
Build a reference from a "table.column" qualified string.
-
orionis.orm.schema.constraints.ForeignReference.qualified
orionis.orm.schema.constraints.ForeignReference.html#qualified
Function
Method
PUBLIC
Return the reference in its qualified "table.column" form.
-
orionis.orm.schema.constraints.TableIndex
orionis.orm.schema.constraints.TableIndex.html
Class
Class
PUBLIC
Composite index spanning one or more columns.
-
orionis.orm.schema.constraints.TableIndex.columns
orionis.orm.schema.constraints.TableIndex.html#columns
Attribute
Instance Variable
PUBLIC
Column names covered by the index, in declaration order.
-
orionis.orm.schema.constraints.TableIndex.name
orionis.orm.schema.constraints.TableIndex.html#name
Attribute
Instance Variable
PUBLIC
Explicit index name, or None to derive one from the table.
-
orionis.orm.schema.constraints.TableIndex.unique
orionis.orm.schema.constraints.TableIndex.html#unique
Attribute
Instance Variable
PUBLIC
Whether the index also enforces uniqueness.
-
orionis.orm.schema.constraints.UniqueConstraint
orionis.orm.schema.constraints.UniqueConstraint.html
Class
Class
PUBLIC
Composite UNIQUE constraint spanning one or more columns.
-
orionis.orm.schema.constraints.UniqueConstraint.columns
orionis.orm.schema.constraints.UniqueConstraint.html#columns
Attribute
Instance Variable
PUBLIC
Column names covered by the constraint, in declaration order.
-
orionis.orm.schema.constraints.UniqueConstraint.name
orionis.orm.schema.constraints.UniqueConstraint.html#name
Attribute
Instance Variable
PUBLIC
Explicit constraint name, or None to let the engine assign one.
-
orionis.orm.schema.constraints._EXPORTS
orionis.orm.schema.constraints.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.orm.schema.constraints.__getattr__
orionis.orm.schema.constraints.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.orm.schema.constraints.__dir__
orionis.orm.schema.constraints.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.orm.schema.types.BigInteger
orionis.orm.schema.types.BigInteger.html
Class
Class
PUBLIC
A type for bigger int integers. Typically generates BIGINT.
-
orionis.orm.schema.types.BigInteger.__slots__
orionis.orm.schema.types.BigInteger.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.schema.types.BigInteger.__init__
orionis.orm.schema.types.BigInteger.html#__init__
Function
Method
PUBLIC
Initialize a big integer column definition.
-
orionis.orm.schema.types.Boolean
orionis.orm.schema.types.Boolean.html
Class
Class
PUBLIC
A bool datatype, typically BOOLEAN or SMALLINT in DDL.
-
orionis.orm.schema.types.Boolean.__slots__
orionis.orm.schema.types.Boolean.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.schema.types.Boolean.__init__
orionis.orm.schema.types.Boolean.html#__init__
Function
Method
PUBLIC
Construct a Boolean.
-
orionis.orm.schema.types.ColumnType
orionis.orm.schema.types.ColumnType.html
Class
Class
PUBLIC
Logical column types understood by the Orionis SQL compiler.
-
orionis.orm.schema.types.ColumnType.BIG_INTEGER
orionis.orm.schema.types.ColumnType.html#BIG_INTEGER
Attribute
Constant
PUBLIC
Generic Types.
-
orionis.orm.schema.types.ColumnType.BOOLEAN
orionis.orm.schema.types.ColumnType.html#BOOLEAN
Attribute
Constant
PUBLIC
boolean.
-
orionis.orm.schema.types.ColumnType.DATE
orionis.orm.schema.types.ColumnType.html#DATE
Attribute
Constant
PUBLIC
date.
-
orionis.orm.schema.types.ColumnType.DATETIME
orionis.orm.schema.types.ColumnType.html#DATETIME
Attribute
Constant
PUBLIC
datetime.
-
orionis.orm.schema.types.ColumnType.DOUBLE
orionis.orm.schema.types.ColumnType.html#DOUBLE
Attribute
Constant
PUBLIC
double.
-
orionis.orm.schema.types.ColumnType.ENUM
orionis.orm.schema.types.ColumnType.html#ENUM
Attribute
Constant
PUBLIC
enum.
-
orionis.orm.schema.types.ColumnType.FLOAT
orionis.orm.schema.types.ColumnType.html#FLOAT
Attribute
Constant
PUBLIC
float.
-
orionis.orm.schema.types.ColumnType.INTEGER
orionis.orm.schema.types.ColumnType.html#INTEGER
Attribute
Constant
PUBLIC
integer.
-
orionis.orm.schema.types.ColumnType.INTERVAL
orionis.orm.schema.types.ColumnType.html#INTERVAL
Attribute
Constant
PUBLIC
interval.
-
orionis.orm.schema.types.ColumnType.LARGE_BINARY
orionis.orm.schema.types.ColumnType.html#LARGE_BINARY
Attribute
Constant
PUBLIC
large_binary.
-
orionis.orm.schema.types.ColumnType.MATCH_TYPE
orionis.orm.schema.types.ColumnType.html#MATCH_TYPE
Attribute
Constant
PUBLIC
match_type.
-
orionis.orm.schema.types.ColumnType.NUMERIC
orionis.orm.schema.types.ColumnType.html#NUMERIC
Attribute
Constant
PUBLIC
numeric.
-
orionis.orm.schema.types.ColumnType.NUMERIC_COMMON
orionis.orm.schema.types.ColumnType.html#NUMERIC_COMMON
Attribute
Constant
PUBLIC
numeric_common.
-
orionis.orm.schema.types.ColumnType.PICKLE_TYPE
orionis.orm.schema.types.ColumnType.html#PICKLE_TYPE
Attribute
Constant
PUBLIC
pickle_type.
-
orionis.orm.schema.types.ColumnType.SCHEMA_TYPE
orionis.orm.schema.types.ColumnType.html#SCHEMA_TYPE
Attribute
Constant
PUBLIC
schema_type.
-
orionis.orm.schema.types.ColumnType.SMALL_INTEGER
orionis.orm.schema.types.ColumnType.html#SMALL_INTEGER
Attribute
Constant
PUBLIC
small_integer.
-
orionis.orm.schema.types.ColumnType.STRING
orionis.orm.schema.types.ColumnType.html#STRING
Attribute
Constant
PUBLIC
string.
-
orionis.orm.schema.types.ColumnType.TEXT
orionis.orm.schema.types.ColumnType.html#TEXT
Attribute
Constant
PUBLIC
text.
-
orionis.orm.schema.types.ColumnType.TIME
orionis.orm.schema.types.ColumnType.html#TIME
Attribute
Constant
PUBLIC
time.
-
orionis.orm.schema.types.ColumnType.UNICODE
orionis.orm.schema.types.ColumnType.html#UNICODE
Attribute
Constant
PUBLIC
unicode.
-
orionis.orm.schema.types.ColumnType.UNICODE_TEXT
orionis.orm.schema.types.ColumnType.html#UNICODE_TEXT
Attribute
Constant
PUBLIC
unicode_text.
-
orionis.orm.schema.types.ColumnType.UUID
orionis.orm.schema.types.ColumnType.html#UUID
Attribute
Constant
PUBLIC
uuid.
-
orionis.orm.schema.types.ColumnType.ARRAY
orionis.orm.schema.types.ColumnType.html#ARRAY
Attribute
Constant
PUBLIC
Specific Types.
-
orionis.orm.schema.types.ColumnType.BIGINT
orionis.orm.schema.types.ColumnType.html#BIGINT
Attribute
Constant
PUBLIC
bigint.
-
orionis.orm.schema.types.ColumnType.BINARY
orionis.orm.schema.types.ColumnType.html#BINARY
Attribute
Constant
PUBLIC
binary.
-
orionis.orm.schema.types.ColumnType.BLOB
orionis.orm.schema.types.ColumnType.html#BLOB
Attribute
Constant
PUBLIC
blob.
-
orionis.orm.schema.types.ColumnType.CHAR
orionis.orm.schema.types.ColumnType.html#CHAR
Attribute
Constant
PUBLIC
char.
-
orionis.orm.schema.types.ColumnType.CLOB
orionis.orm.schema.types.ColumnType.html#CLOB
Attribute
Constant
PUBLIC
clob.
-
orionis.orm.schema.types.ColumnType.DECIMAL
orionis.orm.schema.types.ColumnType.html#DECIMAL
Attribute
Constant
PUBLIC
decimal.
-
orionis.orm.schema.types.ColumnType.DOUBLE_PRECISION
orionis.orm.schema.types.ColumnType.html#DOUBLE_PRECISION
Attribute
Constant
PUBLIC
double_precision.
-
orionis.orm.schema.types.ColumnType.INT
orionis.orm.schema.types.ColumnType.html#INT
Attribute
Constant
PUBLIC
int.
-
orionis.orm.schema.types.ColumnType.JSON
orionis.orm.schema.types.ColumnType.html#JSON
Attribute
Constant
PUBLIC
json.
-
orionis.orm.schema.types.ColumnType.NCHAR
orionis.orm.schema.types.ColumnType.html#NCHAR
Attribute
Constant
PUBLIC
nchar.
-
orionis.orm.schema.types.ColumnType.NVARCHAR
orionis.orm.schema.types.ColumnType.html#NVARCHAR
Attribute
Constant
PUBLIC
nvarchar.
-
orionis.orm.schema.types.ColumnType.REAL
orionis.orm.schema.types.ColumnType.html#REAL
Attribute
Constant
PUBLIC
real.
-
orionis.orm.schema.types.ColumnType.SMALLINT
orionis.orm.schema.types.ColumnType.html#SMALLINT
Attribute
Constant
PUBLIC
smallint.
-
orionis.orm.schema.types.ColumnType.TIMESTAMP
orionis.orm.schema.types.ColumnType.html#TIMESTAMP
Attribute
Constant
PUBLIC
timestamp.
-
orionis.orm.schema.types.ColumnType.VARBINARY
orionis.orm.schema.types.ColumnType.html#VARBINARY
Attribute
Constant
PUBLIC
varbinary.
-
orionis.orm.schema.types.ColumnType.VARCHAR
orionis.orm.schema.types.ColumnType.html#VARCHAR
Attribute
Constant
PUBLIC
varchar.
-
orionis.orm.schema.types.Date
orionis.orm.schema.types.Date.html
Class
Class
PUBLIC
A type for datetime.date() objects.
-
orionis.orm.schema.types.Date.__slots__
orionis.orm.schema.types.Date.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.schema.types.Date.__init__
orionis.orm.schema.types.Date.html#__init__
Function
Method
PUBLIC
Initialize a date column definition.
-
orionis.orm.schema.types.DateTime
orionis.orm.schema.types.DateTime.html
Class
Class
PUBLIC
A type for datetime.datetime() objects.
-
orionis.orm.schema.types.DateTime.__slots__
orionis.orm.schema.types.DateTime.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.schema.types.DateTime.__init__
orionis.orm.schema.types.DateTime.html#__init__
Function
Method
PUBLIC
Construct a new DateTime.
-
orionis.orm.schema.types.Double
orionis.orm.schema.types.Double.html
Class
Class
PUBLIC
A type for double FLOAT. Typically generates DOUBLE.
-
orionis.orm.schema.types.Double.__slots__
orionis.orm.schema.types.Double.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.schema.types.Double.__init__
orionis.orm.schema.types.Double.html#__init__
Function
Method
PUBLIC
Construct a Double.
-
orionis.orm.schema.types.Enum
orionis.orm.schema.types.Enum.html
Class
Class
PUBLIC
String-backed enumeration column.
-
orionis.orm.schema.types.Enum.__slots__
orionis.orm.schema.types.Enum.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.schema.types.Enum.__init__
orionis.orm.schema.types.Enum.html#__init__
Function
Method
PUBLIC
Construct an enum.
-
orionis.orm.schema.types.Float
orionis.orm.schema.types.Float.html
Class
Class
PUBLIC
Type representing floating point types, such as FLOAT or REAL.
-
orionis.orm.schema.types.Float.__slots__
orionis.orm.schema.types.Float.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.schema.types.Float.__init__
orionis.orm.schema.types.Float.html#__init__
Function
Method
PUBLIC
Construct a Float.
-
orionis.orm.schema.types.Integer
orionis.orm.schema.types.Integer.html
Class
Class
PUBLIC
A type for int integers.
-
orionis.orm.schema.types.Integer.__slots__
orionis.orm.schema.types.Integer.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.schema.types.Integer.__init__
orionis.orm.schema.types.Integer.html#__init__
Function
Method
PUBLIC
Initialize an integer column definition.
-
orionis.orm.schema.types.Interval
orionis.orm.schema.types.Interval.html
Class
Class
PUBLIC
A type for datetime.timedelta() objects.
-
orionis.orm.schema.types.Interval.__slots__
orionis.orm.schema.types.Interval.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.schema.types.Interval.__init__
orionis.orm.schema.types.Interval.html#__init__
Function
Method
PUBLIC
Construct an Interval object.
-
orionis.orm.schema.types.LargeBinary
orionis.orm.schema.types.LargeBinary.html
Class
Class
PUBLIC
A type for large binary byte data, such as BLOB/BYTEA.
-
orionis.orm.schema.types.LargeBinary.__slots__
orionis.orm.schema.types.LargeBinary.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.schema.types.LargeBinary.__init__
orionis.orm.schema.types.LargeBinary.html#__init__
Function
Method
PUBLIC
Construct a LargeBinary type.
-
orionis.orm.schema.types.MatchType
orionis.orm.schema.types.MatchType.html
Class
Class
PUBLIC
Refers to the return type of the MATCH operator.
-
orionis.orm.schema.types.MatchType.__slots__
orionis.orm.schema.types.MatchType.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.schema.types.MatchType.__init__
orionis.orm.schema.types.MatchType.html#__init__
Function
Method
PUBLIC
Initialize a match type column definition.
-
orionis.orm.schema.types.Numeric
orionis.orm.schema.types.Numeric.html
Class
Class
PUBLIC
Declare a non-integer numeric column using the logical NUMERIC kind.
-
orionis.orm.schema.types.Numeric.__slots__
orionis.orm.schema.types.Numeric.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.schema.types.Numeric.__init__
orionis.orm.schema.types.Numeric.html#__init__
Function
Method
PUBLIC
Construct a Numeric.
-
orionis.orm.schema.types.NumericCommon
orionis.orm.schema.types.NumericCommon.html
Class
Class
PUBLIC
Describe the numeric-common placeholder kind.
-
orionis.orm.schema.types.NumericCommon.__slots__
orionis.orm.schema.types.NumericCommon.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.schema.types.NumericCommon.__init__
orionis.orm.schema.types.NumericCommon.html#__init__
Function
Method
PUBLIC
Initialize the numeric-common placeholder definition.
-
orionis.orm.schema.types.PickleType
orionis.orm.schema.types.PickleType.html
Class
Class
PUBLIC
Holds Python objects, serialized using pickle.
-
orionis.orm.schema.types.PickleType.__slots__
orionis.orm.schema.types.PickleType.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.schema.types.PickleType.__init__
orionis.orm.schema.types.PickleType.html#__init__
Function
Method
PUBLIC
Construct a PickleType.
-
orionis.orm.schema.types.SchemaType
orionis.orm.schema.types.SchemaType.html
Class
Class
PUBLIC
Describe the schema-level placeholder kind.
-
orionis.orm.schema.types.SchemaType.__slots__
orionis.orm.schema.types.SchemaType.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.schema.types.SchemaType.__init__
orionis.orm.schema.types.SchemaType.html#__init__
Function
Method
PUBLIC
Initialize the schema-type placeholder definition.
-
orionis.orm.schema.types.SmallInteger
orionis.orm.schema.types.SmallInteger.html
Class
Class
PUBLIC
A type for smaller int integers. Typically generates SMALLINT.
-
orionis.orm.schema.types.SmallInteger.__slots__
orionis.orm.schema.types.SmallInteger.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.schema.types.SmallInteger.__init__
orionis.orm.schema.types.SmallInteger.html#__init__
Function
Method
PUBLIC
Initialize a small integer column definition.
-
orionis.orm.schema.types.StrictArray
orionis.orm.schema.types.StrictArray.html
Class
Class
PUBLIC
Represent a SQL ARRAY type.
-
orionis.orm.schema.types.StrictArray.__slots__
orionis.orm.schema.types.StrictArray.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.schema.types.StrictArray.__init__
orionis.orm.schema.types.StrictArray.html#__init__
Function
Method
PUBLIC
Construct an ARRAY.
-
orionis.orm.schema.types.StrictBigInt
orionis.orm.schema.types.StrictBigInt.html
Class
Class
PUBLIC
The SQL BIGINT type.
-
orionis.orm.schema.types.StrictBigInt.__slots__
orionis.orm.schema.types.StrictBigInt.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.schema.types.StrictBigInt.__init__
orionis.orm.schema.types.StrictBigInt.html#__init__
Function
Method
PUBLIC
Initialize a BIGINT column definition.
-
orionis.orm.schema.types.StrictBinary
orionis.orm.schema.types.StrictBinary.html
Class
Class
PUBLIC
The SQL BINARY type.
-
orionis.orm.schema.types.StrictBinary.__slots__
orionis.orm.schema.types.StrictBinary.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.schema.types.StrictBinary.__init__
orionis.orm.schema.types.StrictBinary.html#__init__
Function
Method
PUBLIC
Construct a BINARY type.
-
orionis.orm.schema.types.StrictBlob
orionis.orm.schema.types.StrictBlob.html
Class
Class
PUBLIC
The SQL BLOB type.
-
orionis.orm.schema.types.StrictBlob.__slots__
orionis.orm.schema.types.StrictBlob.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.schema.types.StrictBlob.__init__
orionis.orm.schema.types.StrictBlob.html#__init__
Function
Method
PUBLIC
Construct a LargeBinary type.
-
orionis.orm.schema.types.StrictChar
orionis.orm.schema.types.StrictChar.html
Class
Class
PUBLIC
The SQL CHAR type.
-
orionis.orm.schema.types.StrictChar.__slots__
orionis.orm.schema.types.StrictChar.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.schema.types.StrictChar.__init__
orionis.orm.schema.types.StrictChar.html#__init__
Function
Method
PUBLIC
Create a string-holding type.
-
orionis.orm.schema.types.StrictClob
orionis.orm.schema.types.StrictClob.html
Class
Class
PUBLIC
The CLOB type, found in Oracle Database and Informix.
-
orionis.orm.schema.types.StrictClob.__slots__
orionis.orm.schema.types.StrictClob.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.schema.types.StrictClob.__init__
orionis.orm.schema.types.StrictClob.html#__init__
Function
Method
PUBLIC
Create a string-holding type.
-
orionis.orm.schema.types._constants.DEFAULT_STRING_LENGTH
orionis.orm.schema.types._constants.html#DEFAULT_STRING_LENGTH
Attribute
Constant
PUBLIC
Default maximum length applied to VARCHAR-like columns.
-
orionis.orm.schema.types._constants.DEFAULT_DECIMAL_PRECISION
orionis.orm.schema.types._constants.html#DEFAULT_DECIMAL_PRECISION
Attribute
Constant
PUBLIC
Default precision and scale applied to decimal columns.
-
orionis.orm.schema.types._constants.DEFAULT_DECIMAL_SCALE
orionis.orm.schema.types._constants.html#DEFAULT_DECIMAL_SCALE
Attribute
Constant
PUBLIC
Default decimal scale value used by _constants.
-
orionis.orm.schema.types.StrictDecimal
orionis.orm.schema.types.StrictDecimal.html
Class
Class
PUBLIC
The SQL DECIMAL type.
-
orionis.orm.schema.types.StrictDecimal.__slots__
orionis.orm.schema.types.StrictDecimal.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.schema.types.StrictDecimal.__init__
orionis.orm.schema.types.StrictDecimal.html#__init__
Function
Method
PUBLIC
Construct a fixed-point decimal declaration.
-
orionis.orm.schema.types.StrictDoublePrecision
orionis.orm.schema.types.StrictDoublePrecision.html
Class
Class
PUBLIC
The SQL DOUBLE PRECISION type.
-
orionis.orm.schema.types.StrictDoublePrecision.__slots__
orionis.orm.schema.types.StrictDoublePrecision.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.schema.types.StrictDoublePrecision.__init__
orionis.orm.schema.types.StrictDoublePrecision.html#__init__
Function
Method
PUBLIC
Construct a Float.
-
orionis.orm.schema.types.StrictInt
orionis.orm.schema.types.StrictInt.html
Class
Class
PUBLIC
Alias of INTEGER.
-
orionis.orm.schema.types.StrictInt.__slots__
orionis.orm.schema.types.StrictInt.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.schema.types.StrictInt.__init__
orionis.orm.schema.types.StrictInt.html#__init__
Function
Method
PUBLIC
Initialize an INT column definition.
-
orionis.orm.schema.types.StrictJson
orionis.orm.schema.types.StrictJson.html
Class
Class
PUBLIC
Represent a SQL JSON type.
-
orionis.orm.schema.types.StrictJson.__slots__
orionis.orm.schema.types.StrictJson.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.schema.types.StrictJson.__init__
orionis.orm.schema.types.StrictJson.html#__init__
Function
Method
PUBLIC
Construct a JSON type.
-
orionis.orm.schema.types.StrictNChar
orionis.orm.schema.types.StrictNChar.html
Class
Class
PUBLIC
The SQL NCHAR type.
-
orionis.orm.schema.types.StrictNChar.__slots__
orionis.orm.schema.types.StrictNChar.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.schema.types.StrictNChar.__init__
orionis.orm.schema.types.StrictNChar.html#__init__
Function
Method
PUBLIC
Create a string-holding type.
-
orionis.orm.schema.types.StrictNVarChar
orionis.orm.schema.types.StrictNVarChar.html
Class
Class
PUBLIC
The SQL NVARCHAR type.
-
orionis.orm.schema.types.StrictNVarChar.__slots__
orionis.orm.schema.types.StrictNVarChar.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.schema.types.StrictNVarChar.__init__
orionis.orm.schema.types.StrictNVarChar.html#__init__
Function
Method
PUBLIC
Create a string-holding type.
-
orionis.orm.schema.types.StrictReal
orionis.orm.schema.types.StrictReal.html
Class
Class
PUBLIC
The SQL REAL type.
-
orionis.orm.schema.types.StrictReal.__slots__
orionis.orm.schema.types.StrictReal.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.schema.types.StrictReal.__init__
orionis.orm.schema.types.StrictReal.html#__init__
Function
Method
PUBLIC
Construct a Float.
-
orionis.orm.schema.types.StrictSmallInt
orionis.orm.schema.types.StrictSmallInt.html
Class
Class
PUBLIC
The SQL SMALLINT type.
-
orionis.orm.schema.types.StrictSmallInt.__slots__
orionis.orm.schema.types.StrictSmallInt.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.schema.types.StrictSmallInt.__init__
orionis.orm.schema.types.StrictSmallInt.html#__init__
Function
Method
PUBLIC
Initialize a SMALLINT column definition.
-
orionis.orm.schema.types.StrictTimestamp
orionis.orm.schema.types.StrictTimestamp.html
Class
Class
PUBLIC
The SQL TIMESTAMP type.
-
orionis.orm.schema.types.StrictTimestamp.__slots__
orionis.orm.schema.types.StrictTimestamp.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.schema.types.StrictTimestamp.__init__
orionis.orm.schema.types.StrictTimestamp.html#__init__
Function
Method
PUBLIC
Construct a new TIMESTAMP.
-
orionis.orm.schema.types.StrictVarBinary
orionis.orm.schema.types.StrictVarBinary.html
Class
Class
PUBLIC
The SQL VARBINARY type.
-
orionis.orm.schema.types.StrictVarBinary.__slots__
orionis.orm.schema.types.StrictVarBinary.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.schema.types.StrictVarBinary.__init__
orionis.orm.schema.types.StrictVarBinary.html#__init__
Function
Method
PUBLIC
Construct a VARBINARY type.
-
orionis.orm.schema.types.StrictVarChar
orionis.orm.schema.types.StrictVarChar.html
Class
Class
PUBLIC
The SQL VARCHAR type.
-
orionis.orm.schema.types.StrictVarChar.__slots__
orionis.orm.schema.types.StrictVarChar.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.schema.types.StrictVarChar.__init__
orionis.orm.schema.types.StrictVarChar.html#__init__
Function
Method
PUBLIC
Create a string-holding type.
-
orionis.orm.schema.types.String
orionis.orm.schema.types.String.html
Class
Class
PUBLIC
Declare a variable-length SQL string using the logical VARCHAR kind.
-
orionis.orm.schema.types.String.__slots__
orionis.orm.schema.types.String.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.schema.types.String.__init__
orionis.orm.schema.types.String.html#__init__
Function
Method
PUBLIC
Create a string-holding type.
-
orionis.orm.schema.types.Text
orionis.orm.schema.types.Text.html
Class
Class
PUBLIC
A variably sized string type. In SQL, usually CLOB/TEXT.
-
orionis.orm.schema.types.Text.__slots__
orionis.orm.schema.types.Text.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.schema.types.Text.__init__
orionis.orm.schema.types.Text.html#__init__
Function
Method
PUBLIC
Create a string-holding type.
-
orionis.orm.schema.types.Time
orionis.orm.schema.types.Time.html
Class
Class
PUBLIC
A type for datetime.time() objects.
-
orionis.orm.schema.types.Time.__slots__
orionis.orm.schema.types.Time.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.schema.types.Time.__init__
orionis.orm.schema.types.Time.html#__init__
Function
Method
PUBLIC
Initialize a time column definition.
-
orionis.orm.schema.types.Unicode
orionis.orm.schema.types.Unicode.html
Class
Class
PUBLIC
A variable length Unicode string type, e.g. NVARCHAR.
-
orionis.orm.schema.types.Unicode.__slots__
orionis.orm.schema.types.Unicode.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.schema.types.Unicode.__init__
orionis.orm.schema.types.Unicode.html#__init__
Function
Method
PUBLIC
Create a string-holding type.
-
orionis.orm.schema.types.UnicodeText
orionis.orm.schema.types.UnicodeText.html
Class
Class
PUBLIC
An unbounded-length Unicode string type, e.g. NCLOB/NTEXT.
-
orionis.orm.schema.types.UnicodeText.__slots__
orionis.orm.schema.types.UnicodeText.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.schema.types.UnicodeText.__init__
orionis.orm.schema.types.UnicodeText.html#__init__
Function
Method
PUBLIC
Create a string-holding type.
-
orionis.orm.schema.types.Uuid
orionis.orm.schema.types.Uuid.html
Class
Class
PUBLIC
Represent a database agnostic UUID datatype.
-
orionis.orm.schema.types.Uuid.__slots__
orionis.orm.schema.types.Uuid.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.schema.types.Uuid.__init__
orionis.orm.schema.types.Uuid.html#__init__
Function
Method
PUBLIC
Construct a Uuid type.
-
orionis.orm.schema.types._EXPORTS
orionis.orm.schema.types.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.orm.schema.types.__getattr__
orionis.orm.schema.types.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.orm.schema.types.__dir__
orionis.orm.schema.types.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.orm.schema._TYPES_MODULE
orionis.orm.schema.html#_TYPES_MODULE
Attribute
Constant
PUBLIC
Module exporting logical column declarations.
-
orionis.orm.schema._CONSTRAINTS_MODULE
orionis.orm.schema.html#_CONSTRAINTS_MODULE
Attribute
Constant
PUBLIC
Module exporting table and foreign-key constraints.
-
orionis.orm.schema._EXPORTS
orionis.orm.schema.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.orm.schema.__getattr__
orionis.orm.schema.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.orm.schema.__dir__
orionis.orm.schema.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.orm.schema.column.definition._NO_DEFAULT
orionis.orm.schema.column.definition.html#_NO_DEFAULT
Attribute
Constant
PUBLIC
Sentinel used to distinguish "no default" from a legitimate None default.
-
orionis.orm.schema.column.definition._OPTION_FIELDS
orionis.orm.schema.column.definition.html#_OPTION_FIELDS
Attribute
Constant
PUBLIC
Field names copied from ColumnOptions onto every ColumnDefinition instance.
-
orionis.orm.schema.column.definition._OPTION_GETTER
orionis.orm.schema.column.definition.html#_OPTION_GETTER
Attribute
Constant
PUBLIC
Read every declared column option in declaration order.
-
orionis.orm.schema.column.definition._DEFAULT_OPTION_VALUES
orionis.orm.schema.column.definition.html#_DEFAULT_OPTION_VALUES
Attribute
Constant
PUBLIC
Store the values used by columns with no type-specific options.
-
orionis.orm.schema.column.ColumnDefinition
orionis.orm.schema.column.ColumnDefinition.html
Class
Class
PUBLIC
Framework-agnostic description of a database column.
-
orionis.orm.schema.column.ColumnDefinition.__slots__
orionis.orm.schema.column.ColumnDefinition.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.orm.schema.column.ColumnDefinition.__init__
orionis.orm.schema.column.ColumnDefinition.html#__init__
Function
Method
PUBLIC
Initialize the column definition with its type metadata.
-
orionis.orm.schema.column.ColumnDefinition.name
orionis.orm.schema.column.ColumnDefinition.html#name
Attribute
Instance Variable
PUBLIC
Attribute name is attached later by the model metaclass.
-
orionis.orm.schema.column.ColumnDefinition.column_type
orionis.orm.schema.column.ColumnDefinition.html#column_type
Attribute
Instance Variable
PUBLIC
Logical column type used by the SQL compiler.
-
orionis.orm.schema.column.ColumnDefinition.is_primary
orionis.orm.schema.column.ColumnDefinition.html#is_primary
Attribute
Instance Variable
PUBLIC
Is primary flag used by ColumnDefinition.
-
orionis.orm.schema.column.ColumnDefinition.is_nullable
orionis.orm.schema.column.ColumnDefinition.html#is_nullable
Attribute
Instance Variable
PUBLIC
Is nullable flag used by ColumnDefinition.
-
orionis.orm.schema.column.ColumnDefinition.is_unique
orionis.orm.schema.column.ColumnDefinition.html#is_unique
Attribute
Instance Variable
PUBLIC
Is unique flag used by ColumnDefinition.
-
orionis.orm.schema.column.ColumnDefinition.has_index
orionis.orm.schema.column.ColumnDefinition.html#has_index
Attribute
Instance Variable
PUBLIC
Has index flag used by ColumnDefinition.
-
orionis.orm.schema.column.ColumnDefinition.is_auto_increment
orionis.orm.schema.column.ColumnDefinition.html#is_auto_increment
Attribute
Instance Variable
PUBLIC
Is auto increment flag used by ColumnDefinition.
-
orionis.orm.schema.column.ColumnDefinition.default_value
orionis.orm.schema.column.ColumnDefinition.html#default_value
Attribute
Instance Variable
PUBLIC
Default value supplied through _NO_DEFAULT.
-
orionis.orm.schema.column.ColumnDefinition.foreign_ref
orionis.orm.schema.column.ColumnDefinition.html#foreign_ref
Attribute
Instance Variable
PUBLIC
Foreign-key target referenced by this column.
-
orionis.orm.schema.column.ColumnDefinition.comment_text
orionis.orm.schema.column.ColumnDefinition.html#comment_text
Attribute
Instance Variable
PUBLIC
Comment attached to the column definition.
-
orionis.orm.schema.column.ColumnDefinition.primary
orionis.orm.schema.column.ColumnDefinition.html#primary
Function
Method
PUBLIC
Mark the column as the primary key of the table.
-
orionis.orm.schema.column.ColumnDefinition.nullable
orionis.orm.schema.column.ColumnDefinition.html#nullable
Function
Method
PUBLIC
Allow the column to store NULL values.
-
orionis.orm.schema.column.ColumnDefinition.default
orionis.orm.schema.column.ColumnDefinition.html#default
Function
Method
PUBLIC
Assign a default value applied when no value is provided on insert.
-
orionis.orm.schema.column.ColumnDefinition.unique
orionis.orm.schema.column.ColumnDefinition.html#unique
Function
Method
PUBLIC
Add a unique constraint to the column.
-
orionis.orm.schema.column.ColumnDefinition.index
orionis.orm.schema.column.ColumnDefinition.html#index
Function
Method
PUBLIC
Create a non-unique index on the column.
-
orionis.orm.schema.column.ColumnDefinition.foreign
orionis.orm.schema.column.ColumnDefinition.html#foreign
Function
Method
PUBLIC
Declare a foreign key pointing at another table column.
-
orionis.orm.schema.column.ColumnDefinition.autoIncrement
orionis.orm.schema.column.ColumnDefinition.html#autoIncrement
Function
Method
PUBLIC
Mark the column as auto-incrementing.
-
orionis.orm.schema.column.ColumnDefinition.comment
orionis.orm.schema.column.ColumnDefinition.html#comment
Function
Method
PUBLIC
Attach a descriptive comment rendered alongside the column DDL.
-
orionis.orm.schema.column.ColumnDefinition.hasDefault
orionis.orm.schema.column.ColumnDefinition.html#hasDefault
Function
Method
PUBLIC
Report whether a default value has been assigned.
-
orionis.orm.schema.column.ColumnDefinition.__repr__
orionis.orm.schema.column.ColumnDefinition.html#__repr__
Function
Method
PUBLIC
Return a concise developer representation of the column.
-
orionis.orm.schema.column.ColumnOptions
orionis.orm.schema.column.ColumnOptions.html
Class
Class
PUBLIC
Secondary, type-specific knobs mirroring SQLAlchemy constructor args.
-
orionis.orm.schema.column.ColumnOptions.length
orionis.orm.schema.column.ColumnOptions.html#length
Attribute
Instance Variable
PUBLIC
Maximum length for string-like or binary columns.
-
orionis.orm.schema.column.ColumnOptions.precision
orionis.orm.schema.column.ColumnOptions.html#precision
Attribute
Instance Variable
PUBLIC
Total digits for numeric/decimal columns.
-
orionis.orm.schema.column.ColumnOptions.scale
orionis.orm.schema.column.ColumnOptions.html#scale
Attribute
Instance Variable
PUBLIC
Decimal digits for numeric/decimal columns.
-
orionis.orm.schema.column.ColumnOptions.decimal_return_scale
orionis.orm.schema.column.ColumnOptions.html#decimal_return_scale
Attribute
Instance Variable
PUBLIC
Default scale applied when converting floats to decimals.
-
orionis.orm.schema.column.ColumnOptions.as_decimal
orionis.orm.schema.column.ColumnOptions.html#as_decimal
Attribute
Instance Variable
PUBLIC
Whether numeric values are returned as Decimal.
-
orionis.orm.schema.column.ColumnOptions.enum_values
orionis.orm.schema.column.ColumnOptions.html#enum_values
Attribute
Instance Variable
PUBLIC
Allowed values for enum columns.
-
orionis.orm.schema.column.ColumnOptions.enum_name
orionis.orm.schema.column.ColumnOptions.html#enum_name
Attribute
Instance Variable
PUBLIC
Name of the enumerated database type, when applicable.
-
orionis.orm.schema.column.ColumnOptions.native_enum
orionis.orm.schema.column.ColumnOptions.html#native_enum
Attribute
Instance Variable
PUBLIC
Whether to use the backend's native ENUM type.
-
orionis.orm.schema.column.ColumnOptions.validate_strings
orionis.orm.schema.column.ColumnOptions.html#validate_strings
Attribute
Instance Variable
PUBLIC
Whether to validate string values against enum members.
-
orionis.orm.schema.column.ColumnOptions.create_constraint
orionis.orm.schema.column.ColumnOptions.html#create_constraint
Attribute
Instance Variable
PUBLIC
Whether to add a CHECK constraint for non-native enum/boolean.
-
orionis.orm.schema.column.ColumnOptions.constraint_name
orionis.orm.schema.column.ColumnOptions.html#constraint_name
Attribute
Instance Variable
PUBLIC
Explicit name for the generated CHECK constraint.
-
orionis.orm.schema.column.ColumnOptions.timezone
orionis.orm.schema.column.ColumnOptions.html#timezone
Attribute
Instance Variable
PUBLIC
Whether the datetime column is timezone-aware.
-
orionis.orm.schema.column.ColumnOptions.collation
orionis.orm.schema.column.ColumnOptions.html#collation
Attribute
Instance Variable
PUBLIC
Column-level collation for string columns.
-
orionis.orm.schema.column.ColumnOptions.as_uuid
orionis.orm.schema.column.ColumnOptions.html#as_uuid
Attribute
Instance Variable
PUBLIC
Whether UUID values are interpreted as uuid.UUID objects.
-
orionis.orm.schema.column.ColumnOptions.native_uuid
orionis.orm.schema.column.ColumnOptions.html#native_uuid
Attribute
Instance Variable
PUBLIC
Whether to use the backend's native UUID-storing type.
-
orionis.orm.schema.column.ColumnOptions.item_type
orionis.orm.schema.column.ColumnOptions.html#item_type
Attribute
Instance Variable
PUBLIC
Element type declaration for array columns.
-
orionis.orm.schema.column.ColumnOptions.dimensions
orionis.orm.schema.column.ColumnOptions.html#dimensions
Attribute
Instance Variable
PUBLIC
Fixed number of dimensions for array columns.
-
orionis.orm.schema.column.ColumnOptions.as_tuple
orionis.orm.schema.column.ColumnOptions.html#as_tuple
Attribute
Instance Variable
PUBLIC
Whether array results are converted to tuples.
-
orionis.orm.schema.column.ColumnOptions.zero_indexes
orionis.orm.schema.column.ColumnOptions.html#zero_indexes
Attribute
Instance Variable
PUBLIC
Whether array indexes convert between zero- and one-based conventions.
-
orionis.orm.schema.column.ColumnOptions.none_as_null
orionis.orm.schema.column.ColumnOptions.html#none_as_null
Attribute
Instance Variable
PUBLIC
Whether None persists as SQL NULL in JSON columns.
-
orionis.orm.schema.column.ColumnOptions.native
orionis.orm.schema.column.ColumnOptions.html#native
Attribute
Instance Variable
PUBLIC
Whether to use the backend's native INTERVAL type.
-
orionis.orm.schema.column.ColumnOptions.second_precision
orionis.orm.schema.column.ColumnOptions.html#second_precision
Attribute
Instance Variable
PUBLIC
Fractional seconds precision for native interval columns.
-
orionis.orm.schema.column.ColumnOptions.day_precision
orionis.orm.schema.column.ColumnOptions.html#day_precision
Attribute
Instance Variable
PUBLIC
Day precision for native interval columns.
-
orionis.orm.schema.column.ColumnOptions.protocol
orionis.orm.schema.column.ColumnOptions.html#protocol
Attribute
Instance Variable
PUBLIC
Pickle protocol used by pickle-backed columns.
-
orionis.orm.schema.column.ColumnOptions.pickler
orionis.orm.schema.column.ColumnOptions.html#pickler
Attribute
Instance Variable
PUBLIC
Object exposing dumps/loads, defaults to pickle.
-
orionis.orm.schema.column.ColumnOptions.comparator
orionis.orm.schema.column.ColumnOptions.html#comparator
Attribute
Instance Variable
PUBLIC
Predicate used to compare pickled values for equality.
-
orionis.orm.schema.column.ColumnOptions.impl
orionis.orm.schema.column.ColumnOptions.html#impl
Attribute
Instance Variable
PUBLIC
Binary-storing type used in place of the default.
-
orionis.orm.schema.column._EXPORTS
orionis.orm.schema.column.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.orm.schema.column.__getattr__
orionis.orm.schema.column.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.orm.schema.column.__dir__
orionis.orm.schema.column.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.orm.schema.table.TableDefinition
orionis.orm.schema.table.TableDefinition.html
Class
Class
PUBLIC
Framework-agnostic description of a database table.
-
orionis.orm.schema.table.TableDefinition.name
orionis.orm.schema.table.TableDefinition.html#name
Attribute
Instance Variable
PUBLIC
Logical table name without any connection prefix.
-
orionis.orm.schema.table.TableDefinition.columns
orionis.orm.schema.table.TableDefinition.html#columns
Attribute
Instance Variable
PUBLIC
Column definitions keyed by attribute name.
-
orionis.orm.schema.table.TableDefinition.primary_key
orionis.orm.schema.table.TableDefinition.html#primary_key
Attribute
Instance Variable
PUBLIC
Name of the primary key column, when it is a single column.
-
orionis.orm.schema.table.TableDefinition.schema
orionis.orm.schema.table.TableDefinition.html#schema
Attribute
Instance Variable
PUBLIC
Database schema owning the table, or None for the default.
-
orionis.orm.schema.table.TableDefinition.composite_primary_key
orionis.orm.schema.table.TableDefinition.html#composite_primary_key
Attribute
Instance Variable
PUBLIC
Column names forming a multi-column primary key. When set, it takes precedence over the single-column primary_key.
-
orionis.orm.schema.table.TableDefinition.unique_constraints
orionis.orm.schema.table.TableDefinition.html#unique_constraints
Attribute
Instance Variable
PUBLIC
Composite UNIQUE constraints spanning multiple columns.
-
orionis.orm.schema.table.TableDefinition.foreign_keys
orionis.orm.schema.table.TableDefinition.html#foreign_keys
Attribute
Instance Variable
PUBLIC
Multi-column foreign key constraints.
-
orionis.orm.schema.table.TableDefinition.indexes
orionis.orm.schema.table.TableDefinition.html#indexes
Attribute
Instance Variable
PUBLIC
Composite indexes spanning multiple columns.
-
orionis.orm.schema.table.TableDefinition.columnNames
orionis.orm.schema.table.TableDefinition.html#columnNames
Function
Method
PUBLIC
Return the declared column names in definition order.
-
orionis.orm.schema.table.TableDefinition.hasColumn
orionis.orm.schema.table.TableDefinition.html#hasColumn
Function
Method
PUBLIC
Report whether a column is declared on the table.
-
orionis.orm.query.expressions.SUPPORTED_OPERATORS
orionis.orm.query.expressions.html#SUPPORTED_OPERATORS
Attribute
Constant
PUBLIC
Comparison operators accepted by basic where clauses.
-
orionis.orm.query.expressions.COLUMNLESS_WHERE_TYPES
orionis.orm.query.expressions.html#COLUMNLESS_WHERE_TYPES
Attribute
Constant
PUBLIC
Clause kinds whose column field carries no column reference.
-
orionis.orm.query.expressions.LockMode
orionis.orm.query.expressions.LockMode.html
Class
Class
PUBLIC
Row locking modes supported by select plans.
-
orionis.orm.query.expressions.LockMode.UPDATE
orionis.orm.query.expressions.LockMode.html#UPDATE
Attribute
Constant
PUBLIC
update.
-
orionis.orm.query.expressions.LockMode.SHARE
orionis.orm.query.expressions.LockMode.html#SHARE
Attribute
Constant
PUBLIC
share.
-
orionis.orm.query.expressions.JoinType
orionis.orm.query.expressions.JoinType.html
Class
Class
PUBLIC
Join kinds supported by the query language.
-
orionis.orm.query.expressions.JoinType.INNER
orionis.orm.query.expressions.JoinType.html#INNER
Attribute
Constant
PUBLIC
inner.
-
orionis.orm.query.expressions.JoinType.LEFT
orionis.orm.query.expressions.JoinType.html#LEFT
Attribute
Constant
PUBLIC
left.
-
orionis.orm.query.expressions.JoinType.RIGHT
orionis.orm.query.expressions.JoinType.html#RIGHT
Attribute
Constant
PUBLIC
right.
-
orionis.orm.query.expressions.JoinType.FULL
orionis.orm.query.expressions.JoinType.html#FULL
Attribute
Constant
PUBLIC
full.
-
orionis.orm.query.expressions.JoinType.CROSS
orionis.orm.query.expressions.JoinType.html#CROSS
Attribute
Constant
PUBLIC
cross.
-
orionis.orm.query.expressions.RawExpression
orionis.orm.query.expressions.RawExpression.html
Class
Class
PUBLIC
Developer-authored SQL fragment with its bound parameters.
-
orionis.orm.query.expressions.RawExpression.sql
orionis.orm.query.expressions.RawExpression.html#sql
Attribute
Instance Variable
PUBLIC
SQL fragment using named :param placeholders.
-
orionis.orm.query.expressions.RawExpression.bindings
orionis.orm.query.expressions.RawExpression.html#bindings
Attribute
Instance Variable
PUBLIC
Values bound to the placeholders of the fragment.
-
orionis.orm.query.expressions.RawExpression.alias
orionis.orm.query.expressions.RawExpression.html#alias
Attribute
Instance Variable
PUBLIC
Name the fragment is projected under; required for the value to stay addressable when the query becomes a derived table.
-
orionis.orm.query.expressions.SubQueryColumn
orionis.orm.query.expressions.SubQueryColumn.html
Class
Class
PUBLIC
Scalar subquery projected as a single aliased column.
-
orionis.orm.query.expressions.SubQueryColumn.plan
orionis.orm.query.expressions.SubQueryColumn.html#plan
Attribute
Instance Variable
PUBLIC
Subquery producing exactly one column and one row.
-
orionis.orm.query.expressions.SubQueryColumn.alias
orionis.orm.query.expressions.SubQueryColumn.html#alias
Attribute
Instance Variable
PUBLIC
Name the projected value is exposed under.
-
orionis.orm.query.expressions.JoinCondition
orionis.orm.query.expressions.JoinCondition.html
Class
Class
PUBLIC
Single ON condition comparing two column references.
-
orionis.orm.query.expressions.JoinCondition.first
orionis.orm.query.expressions.JoinCondition.html#first
Attribute
Instance Variable
PUBLIC
Left-hand column reference.
-
orionis.orm.query.expressions.JoinCondition.operator
orionis.orm.query.expressions.JoinCondition.html#operator
Attribute
Instance Variable
PUBLIC
Comparison operator relating both sides.
-
orionis.orm.query.expressions.JoinCondition.second
orionis.orm.query.expressions.JoinCondition.html#second
Attribute
Instance Variable
PUBLIC
Right-hand column reference.
-
orionis.orm.query.expressions.JoinCondition.boolean
orionis.orm.query.expressions.JoinCondition.html#boolean
Attribute
Instance Variable
PUBLIC
Logical connector with the previous condition: "and" or "or".
-
orionis.orm.query.expressions.JoinExpression
orionis.orm.query.expressions.JoinExpression.html
Class
Class
PUBLIC
Single JOIN source attached to a select plan.
-
orionis.orm.query.expressions.JoinExpression.join_type
orionis.orm.query.expressions.JoinExpression.html#join_type
Attribute
Instance Variable
PUBLIC
Kind of join to perform.
-
orionis.orm.query.expressions.JoinExpression.table
orionis.orm.query.expressions.JoinExpression.html#table
Attribute
Instance Variable
PUBLIC
Joined table description, or a subquery joined as a derived table. A table definition carries its own columns so the compiler can resolve qualified references without guessing.
-
orionis.orm.query.expressions.JoinExpression.alias
orionis.orm.query.expressions.JoinExpression.html#alias
Attribute
Instance Variable
PUBLIC
Name the joined source is referred to by inside the query, or None to use its logical table name. Required for subqueries.
-
orionis.orm.query.expressions.JoinExpression.conditions
orionis.orm.query.expressions.JoinExpression.html#conditions
Attribute
Instance Variable
PUBLIC
ON conditions combined left to right.
-
orionis.orm.query.expressions.UnionClause
orionis.orm.query.expressions.UnionClause.html
Class
Class
PUBLIC
Select plan combined with the owning query through UNION.
-
orionis.orm.query.expressions.UnionClause.plan
orionis.orm.query.expressions.UnionClause.html#plan
Attribute
Instance Variable
PUBLIC
Query whose rows are appended to the owning query.
-
orionis.orm.query.expressions.UnionClause.all_rows
orionis.orm.query.expressions.UnionClause.html#all_rows
Attribute
Instance Variable
PUBLIC
Whether duplicates are kept (UNION ALL) or collapsed.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase
orionis.orm.contracts.base_builder.IQueryBuilderBase.html
Class
Class
PUBLIC
Contract of the query language shared by every Orionis builder.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.__slots__
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.chunks
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#chunks
Function
Method
PUBLIC
Iterate bounded, explicitly ordered result batches when supported.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.toPlan
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#toPlan
Function
Method
PUBLIC
Return the engine-agnostic plan assembled so far.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.toSql
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#toSql
Function
Method
PUBLIC
Render the current SELECT query without executing or mutating it.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.clone
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#clone
Function
Method
PUBLIC
Return an independent copy of this builder.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.select
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#select
Function
Method
PUBLIC
Restrict the query projection to the given columns.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.addSelect
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#addSelect
Function
Method
PUBLIC
Append columns to the current projection.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.selectRaw
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#selectRaw
Function
Method
PUBLIC
Append a raw SQL fragment to the projection.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.selectSub
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#selectSub
Function
Method
PUBLIC
Append a scalar subquery to the projection under an alias.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.distinct
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#distinct
Function
Method
PUBLIC
Collapse duplicate rows from the query results.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.where
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#where
Function
Method
PUBLIC
Add an AND-combined filtering condition.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.orWhere
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#orWhere
Function
Method
PUBLIC
Add an OR-combined filtering condition.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.whereIn
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#whereIn
Function
Method
PUBLIC
Filter rows whose column value belongs to the given set.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.orWhereIn
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#orWhereIn
Function
Method
PUBLIC
Add an OR-combined set-membership condition.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.whereNotIn
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#whereNotIn
Function
Method
PUBLIC
Filter rows whose column value is outside the given set.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.orWhereNotIn
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#orWhereNotIn
Function
Method
PUBLIC
Add an OR-combined set-exclusion condition.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.whereNull
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#whereNull
Function
Method
PUBLIC
Filter rows whose column value is NULL.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.orWhereNull
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#orWhereNull
Function
Method
PUBLIC
Add an OR-combined IS NULL condition.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.whereNotNull
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#whereNotNull
Function
Method
PUBLIC
Filter rows whose column value is not NULL.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.orWhereNotNull
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#orWhereNotNull
Function
Method
PUBLIC
Add an OR-combined IS NOT NULL condition.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.whereBetween
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#whereBetween
Function
Method
PUBLIC
Filter rows whose column value lies between two boundaries.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.whereNotBetween
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#whereNotBetween
Function
Method
PUBLIC
Filter rows whose column value lies outside two boundaries.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.whereLike
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#whereLike
Function
Method
PUBLIC
Filter rows whose column value matches an SQL LIKE pattern.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.whereNotLike
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#whereNotLike
Function
Method
PUBLIC
Filter rows not matching an SQL LIKE pattern.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.whereILike
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#whereILike
Function
Method
PUBLIC
Filter rows matching a case-insensitive SQL LIKE pattern.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.whereNotILike
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#whereNotILike
Function
Method
PUBLIC
Filter rows not matching a case-insensitive LIKE pattern.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.whereStartsWith
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#whereStartsWith
Function
Method
PUBLIC
Filter rows whose column value starts with the given text.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.whereEndsWith
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#whereEndsWith
Function
Method
PUBLIC
Filter rows whose column value ends with the given text.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.whereContains
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#whereContains
Function
Method
PUBLIC
Filter rows whose column value contains the given text.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.whereRegexpMatch
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#whereRegexpMatch
Function
Method
PUBLIC
Filter rows whose column value matches a regular expression.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.whereColumn
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#whereColumn
Function
Method
PUBLIC
Compare two columns of the query against each other.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.orWhereColumn
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#orWhereColumn
Function
Method
PUBLIC
Add an OR-combined comparison between two columns.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.whereRaw
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#whereRaw
Function
Method
PUBLIC
Add an AND-combined raw SQL condition.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.orWhereRaw
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#orWhereRaw
Function
Method
PUBLIC
Add an OR-combined raw SQL condition.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.whereExists
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#whereExists
Function
Method
PUBLIC
Keep rows for which a correlated subquery returns any row.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.orWhereExists
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#orWhereExists
Function
Method
PUBLIC
Add an OR-combined EXISTS condition.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.whereNotExists
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#whereNotExists
Function
Method
PUBLIC
Keep rows for which a correlated subquery returns no row.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.orWhereNotExists
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#orWhereNotExists
Function
Method
PUBLIC
Add an OR-combined NOT EXISTS condition.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.join
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#join
Function
Method
PUBLIC
Add an INNER JOIN to the query.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.leftJoin
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#leftJoin
Function
Method
PUBLIC
Add a LEFT OUTER JOIN to the query.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.rightJoin
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#rightJoin
Function
Method
PUBLIC
Add a RIGHT OUTER JOIN to the query.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.fullJoin
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#fullJoin
Function
Method
PUBLIC
Add a FULL OUTER JOIN to the query.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.crossJoin
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#crossJoin
Function
Method
PUBLIC
Add a CROSS JOIN to the query.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.joinSub
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#joinSub
Function
Method
PUBLIC
Join a subquery as a derived table with an INNER JOIN.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.leftJoinSub
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#leftJoinSub
Function
Method
PUBLIC
Join a subquery as a derived table with a LEFT OUTER JOIN.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.rightJoinSub
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#rightJoinSub
Function
Method
PUBLIC
Join a subquery as a derived table with a RIGHT OUTER JOIN.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.orderBy
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#orderBy
Function
Method
PUBLIC
Add an ordering rule to the query.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.latest
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#latest
Function
Method
PUBLIC
Order the query by a timestamp column in descending order.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.oldest
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#oldest
Function
Method
PUBLIC
Order the query by a timestamp column in ascending order.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.groupBy
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#groupBy
Function
Method
PUBLIC
Add grouping columns to the query.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.having
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#having
Function
Method
PUBLIC
Add a post-grouping condition to the query.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.orHaving
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#orHaving
Function
Method
PUBLIC
Add an OR-combined post-grouping condition to the query.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.havingRaw
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#havingRaw
Function
Method
PUBLIC
Add a raw SQL post-grouping condition.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.limit
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#limit
Function
Method
PUBLIC
Limit the number of rows returned by the query.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.offset
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#offset
Function
Method
PUBLIC
Skip the given number of rows before returning results.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.take
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#take
Function
Method
PUBLIC
Limit the number of rows returned; alias of limit.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.skip
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#skip
Function
Method
PUBLIC
Skip the given number of rows; alias of offset.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.forPage
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#forPage
Function
Method
PUBLIC
Limit the query to a single page of results.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.lockForUpdate
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#lockForUpdate
Function
Method
PUBLIC
Lock the selected rows against concurrent writes.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.sharedLock
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#sharedLock
Function
Method
PUBLIC
Lock the selected rows in shared mode.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.union
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#union
Function
Method
PUBLIC
Append another query's rows, collapsing duplicates.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.unionAll
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#unionAll
Function
Method
PUBLIC
Append another query's rows, keeping duplicates.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.count
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#count
Function
Method
PUBLIC
Count the rows matched by the query.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.exists
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#exists
Function
Method
PUBLIC
Report whether the query matches at least one row.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.doesntExist
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#doesntExist
Function
Method
PUBLIC
Report whether the query matches no rows.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.max
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#max
Function
Method
PUBLIC
Return the maximum value of a column among matching rows.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.min
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#min
Function
Method
PUBLIC
Return the minimum value of a column among matching rows.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.avg
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#avg
Function
Method
PUBLIC
Return the average value of a column among matching rows.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.sum
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#sum
Function
Method
PUBLIC
Return the sum of a column among matching rows.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.insert
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#insert
Function
Method
PUBLIC
Insert one or many rows into the target table.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.update
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#update
Function
Method
PUBLIC
Mass update the rows matched by the query.
-
orionis.orm.contracts.base_builder.IQueryBuilderBase.delete
orionis.orm.contracts.base_builder.IQueryBuilderBase.html#delete
Function
Method
PUBLIC
Delete the rows matched by the query.
-
orionis.orm.contracts.raw_builder.IRawQueryBuilder
orionis.orm.contracts.raw_builder.IRawQueryBuilder.html
Class
Class
PUBLIC
Contract for the model-less query builder over a plain table name.
-
orionis.orm.contracts.raw_builder.IRawQueryBuilder.__slots__
orionis.orm.contracts.raw_builder.IRawQueryBuilder.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.contracts.raw_builder.IRawQueryBuilder.connection
orionis.orm.contracts.raw_builder.IRawQueryBuilder.html#connection
Function
Method
PUBLIC
Change the connection this builder runs against.
-
orionis.orm.contracts.raw_builder.IRawQueryBuilder.table
orionis.orm.contracts.raw_builder.IRawQueryBuilder.html#table
Function
Method
PUBLIC
Change the table this builder queries against.
-
orionis.orm.contracts.raw_builder.IRawQueryBuilder.get
orionis.orm.contracts.raw_builder.IRawQueryBuilder.html#get
Function
Method
PUBLIC
Execute the query and return every matching row.
-
orionis.orm.contracts.raw_builder.IRawQueryBuilder.first
orionis.orm.contracts.raw_builder.IRawQueryBuilder.html#first
Function
Method
PUBLIC
Execute the query and return only the first matching row.
-
orionis.orm.contracts.raw_builder.IRawQueryBuilder.value
orionis.orm.contracts.raw_builder.IRawQueryBuilder.html#value
Function
Method
PUBLIC
Return a single column value of the first matching row.
-
orionis.orm.contracts.raw_builder.IRawQueryBuilder.pluck
orionis.orm.contracts.raw_builder.IRawQueryBuilder.html#pluck
Function
Method
PUBLIC
Return one column of every matching row.
-
orionis.orm.contracts.raw_builder.IRawQueryBuilder.paginate
orionis.orm.contracts.raw_builder.IRawQueryBuilder.html#paginate
Function
Method
PUBLIC
Execute the query returning a length-aware page of results.
-
orionis.orm.contracts.query_builder.IQueryBuilder
orionis.orm.contracts.query_builder.IQueryBuilder.html
Class
Class
PUBLIC
Contract of the entry point backing the DB facade.
-
orionis.orm.contracts.query_builder.IQueryBuilder.__slots__
orionis.orm.contracts.query_builder.IQueryBuilder.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.contracts.query_builder.IQueryBuilder.connection
orionis.orm.contracts.query_builder.IQueryBuilder.html#connection
Function
Method
PUBLIC
Return a gateway scoped to the connection with the given name.
-
orionis.orm.contracts.query_builder.IQueryBuilder.table
orionis.orm.contracts.query_builder.IQueryBuilder.html#table
Function
Method
PUBLIC
Build a fluent, model-less query over a plain table name.
-
orionis.orm.contracts.query_builder.IQueryBuilder.beginTransaction
orionis.orm.contracts.query_builder.IQueryBuilder.html#beginTransaction
Function
Method
PUBLIC
Begin a transaction, or a savepoint when one is already active.
-
orionis.orm.contracts.query_builder.IQueryBuilder.commit
orionis.orm.contracts.query_builder.IQueryBuilder.html#commit
Function
Method
PUBLIC
Commit the innermost active transaction or savepoint.
-
orionis.orm.contracts.query_builder.IQueryBuilder.rollback
orionis.orm.contracts.query_builder.IQueryBuilder.html#rollback
Function
Method
PUBLIC
Roll back the innermost active transaction or savepoint.
-
orionis.orm.contracts.query_builder.IQueryBuilder.transaction
orionis.orm.contracts.query_builder.IQueryBuilder.html#transaction
Function
Method
PUBLIC
Return a transaction usable as an async context manager.
-
orionis.orm.contracts.query_builder.IQueryBuilder.getDefaultName
orionis.orm.contracts.query_builder.IQueryBuilder.html#getDefaultName
Function
Method
PUBLIC
Return the name of the default connection.
-
orionis.orm.contracts.query_builder.IQueryBuilder.setDefaultName
orionis.orm.contracts.query_builder.IQueryBuilder.html#setDefaultName
Function
Method
PUBLIC
Change the connection used when none is specified.
-
orionis.orm.contracts.query_builder.IQueryBuilder.select
orionis.orm.contracts.query_builder.IQueryBuilder.html#select
Function
Method
PUBLIC
Run a raw SELECT statement and return its rows.
-
orionis.orm.contracts.query_builder.IQueryBuilder.execute
orionis.orm.contracts.query_builder.IQueryBuilder.html#execute
Function
Method
PUBLIC
Run a raw data-modifying statement and return the affected rows.
-
orionis.orm.contracts.query_builder.IQueryBuilder.statement
orionis.orm.contracts.query_builder.IQueryBuilder.html#statement
Function
Method
PUBLIC
Run a raw statement without inspecting its result.
-
orionis.auth.authorization.registrar._PERMISSIONS_TABLE
orionis.auth.authorization.registrar.html#_PERMISSIONS_TABLE
Attribute
Constant
PUBLIC
Tables shipped by the framework migrations.
-
orionis.auth.authorization.registrar._ROLES_TABLE
orionis.auth.authorization.registrar.html#_ROLES_TABLE
Attribute
Constant
PUBLIC
roles.
-
orionis.auth.authorization.registrar._MODEL_PERMISSIONS_TABLE
orionis.auth.authorization.registrar.html#_MODEL_PERMISSIONS_TABLE
Attribute
Constant
PUBLIC
model_has_permissions.
-
orionis.auth.authorization.registrar._MODEL_ROLES_TABLE
orionis.auth.authorization.registrar.html#_MODEL_ROLES_TABLE
Attribute
Constant
PUBLIC
model_has_roles.
-
orionis.auth.authorization.registrar._ROLE_PERMISSIONS_TABLE
orionis.auth.authorization.registrar.html#_ROLE_PERMISSIONS_TABLE
Attribute
Constant
PUBLIC
role_has_permissions.
-
orionis.auth.authorization.registrar._MAX_NAME_LENGTH
orionis.auth.authorization.registrar.html#_MAX_NAME_LENGTH
Attribute
Constant
PUBLIC
Max name length value used by registrar.
-
orionis.auth.authorization.registrar.PermissionRegistrar
orionis.auth.authorization.registrar.PermissionRegistrar.html
Class
Class
PUBLIC
Create permissions and roles, and attach them to identities.
-
orionis.auth.authorization.registrar.PermissionRegistrar.__slots__
orionis.auth.authorization.registrar.PermissionRegistrar.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.auth.authorization.registrar.PermissionRegistrar.__init__
orionis.auth.authorization.registrar.PermissionRegistrar.html#__init__
Function
Method
PUBLIC
Initialise the registrar with the model-less query gateway.
-
orionis.auth.authorization.registrar.PermissionRegistrar.__db
orionis.auth.authorization.registrar.PermissionRegistrar.html#__db
Attribute
Instance Variable
PUBLIC
Gateway used to build queries over the authorization tables.
-
orionis.auth.authorization.registrar.PermissionRegistrar.createPermission
orionis.auth.authorization.registrar.PermissionRegistrar.html#createPermission
Function
Method
PUBLIC
Create a permission, or return the existing one.
-
orionis.auth.authorization.registrar.PermissionRegistrar.createRole
orionis.auth.authorization.registrar.PermissionRegistrar.html#createRole
Function
Method
PUBLIC
Create a role, or return the existing one.
-
orionis.auth.authorization.registrar.PermissionRegistrar.givePermissionTo
orionis.auth.authorization.registrar.PermissionRegistrar.html#givePermissionTo
Function
Method
PUBLIC
Attach direct permissions to an identity.
-
orionis.auth.authorization.registrar.PermissionRegistrar.revokePermissionFrom
orionis.auth.authorization.registrar.PermissionRegistrar.html#revokePermissionFrom
Function
Method
PUBLIC
Detach direct permissions from an identity.
-
orionis.auth.authorization.registrar.PermissionRegistrar.assignRole
orionis.auth.authorization.registrar.PermissionRegistrar.html#assignRole
Function
Method
PUBLIC
Attach roles to an identity.
-
orionis.auth.authorization.registrar.PermissionRegistrar.removeRole
orionis.auth.authorization.registrar.PermissionRegistrar.html#removeRole
Function
Method
PUBLIC
Detach roles from an identity.
-
orionis.auth.authorization.registrar.PermissionRegistrar.grantToRole
orionis.auth.authorization.registrar.PermissionRegistrar.html#grantToRole
Function
Method
PUBLIC
Attach permissions to a role.
-
orionis.auth.authorization.registrar.PermissionRegistrar.revokeFromRole
orionis.auth.authorization.registrar.PermissionRegistrar.html#revokeFromRole
Function
Method
PUBLIC
Detach permissions from a role.
-
orionis.auth.authorization.registrar.PermissionRegistrar.__findId
orionis.auth.authorization.registrar.PermissionRegistrar.html#__findId
Function
Method
PUBLIC
Return the identifier of a named permission or role.
-
orionis.auth.authorization.registrar.PermissionRegistrar.__recover
orionis.auth.authorization.registrar.PermissionRegistrar.html#__recover
Function
Method
PUBLIC
Observe a failed recovery query while preserving the write failure.
-
orionis.auth.authorization.registrar.PermissionRegistrar.__firstOrCreate
orionis.auth.authorization.registrar.PermissionRegistrar.html#__firstOrCreate
Function
Method
PUBLIC
Return the identifier of a row, inserting it when missing.
-
orionis.auth.authorization.registrar.PermissionRegistrar.__attach
orionis.auth.authorization.registrar.PermissionRegistrar.html#__attach
Function
Method
PUBLIC
Insert a pivot row, ignoring an already existing one.
-
orionis.auth.authorization.repository._PERMISSIONS_TABLE
orionis.auth.authorization.repository.html#_PERMISSIONS_TABLE
Attribute
Constant
PUBLIC
Tables shipped by the framework migrations. They follow the polymorphic layout so any model can own permissions and roles.
-
orionis.auth.authorization.repository._ROLES_TABLE
orionis.auth.authorization.repository.html#_ROLES_TABLE
Attribute
Constant
PUBLIC
roles.
-
orionis.auth.authorization.repository._MODEL_PERMISSIONS_TABLE
orionis.auth.authorization.repository.html#_MODEL_PERMISSIONS_TABLE
Attribute
Constant
PUBLIC
model_has_permissions.
-
orionis.auth.authorization.repository._MODEL_ROLES_TABLE
orionis.auth.authorization.repository.html#_MODEL_ROLES_TABLE
Attribute
Constant
PUBLIC
model_has_roles.
-
orionis.auth.authorization.repository._ROLE_PERMISSIONS_TABLE
orionis.auth.authorization.repository.html#_ROLE_PERMISSIONS_TABLE
Attribute
Constant
PUBLIC
role_has_permissions.
-
orionis.auth.authorization.repository._MODEL_TYPE
orionis.auth.authorization.repository.html#_MODEL_TYPE
Attribute
Constant
PUBLIC
Column names reused across the three queries below.
-
orionis.auth.authorization.repository._MODEL_ID
orionis.auth.authorization.repository.html#_MODEL_ID
Attribute
Constant
PUBLIC
model_id.
-
orionis.auth.authorization.repository._ROLE_ID
orionis.auth.authorization.repository.html#_ROLE_ID
Attribute
Constant
PUBLIC
role_id.
-
orionis.auth.authorization.repository._PERMISSION_ID
orionis.auth.authorization.repository.html#_PERMISSION_ID
Attribute
Constant
PUBLIC
permission_id.
-
orionis.auth.authorization.repository.DatabasePermissionRepository
orionis.auth.authorization.repository.DatabasePermissionRepository.html
Class
Class
PUBLIC
Load permissions and roles from the framework authorization tables.
-
orionis.auth.authorization.repository.DatabasePermissionRepository.__slots__
orionis.auth.authorization.repository.DatabasePermissionRepository.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.auth.authorization.repository.DatabasePermissionRepository.__init__
orionis.auth.authorization.repository.DatabasePermissionRepository.html#__init__
Function
Method
PUBLIC
Initialise the repository with the model-less query gateway.
-
orionis.auth.authorization.repository.DatabasePermissionRepository.__db
orionis.auth.authorization.repository.DatabasePermissionRepository.html#__db
Attribute
Instance Variable
PUBLIC
Gateway used to build queries over the authorization tables.
-
orionis.auth.authorization.repository.DatabasePermissionRepository.loadFor
orionis.auth.authorization.repository.DatabasePermissionRepository.html#loadFor
Function
Method
PUBLIC
Load the permissions and roles owned by an identity.
-
orionis.auth.authorization.repository.DatabasePermissionRepository.__rolesOf
orionis.auth.authorization.repository.DatabasePermissionRepository.html#__rolesOf
Function
Method
PUBLIC
Build the role arm of the authorization statement.
-
orionis.auth.authorization.repository.DatabasePermissionRepository.__directPermissionsOf
orionis.auth.authorization.repository.DatabasePermissionRepository.html#__directPermissionsOf
Function
Method
PUBLIC
Build the direct-permission arm of the authorization statement.
-
orionis.auth.authorization.repository.DatabasePermissionRepository.__rolePermissionsOf
orionis.auth.authorization.repository.DatabasePermissionRepository.html#__rolePermissionsOf
Function
Method
PUBLIC
Build inherited permissions constrained to the current owner's roles.
-
orionis.auth.authorization.schema.build_authorization_tables
orionis.auth.authorization.schema.html#build_authorization_tables
Function
Function
PUBLIC
Build role and permission storage in foreign-key dependency order.
-
orionis.auth.concerns.Authenticatable
orionis.auth.concerns.Authenticatable.html
Class
Class
PUBLIC
Turn any Orionis model into an authenticatable identity.
-
orionis.auth.concerns.Authenticatable.__slots__
orionis.auth.concerns.Authenticatable.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.auth.concerns.Authenticatable.AUTH_PASSWORD
orionis.auth.concerns.Authenticatable.html#AUTH_PASSWORD
Attribute
Constant
PUBLIC
Attribute holding the password hash. Override it when the model stores the hash under a different name.
-
orionis.auth.concerns.Authenticatable.getAuthIdentifierName
orionis.auth.concerns.Authenticatable.html#getAuthIdentifierName
Function
Method
PUBLIC
Return the attribute holding the unique identifier.
-
orionis.auth.concerns.Authenticatable.getAuthIdentifier
orionis.auth.concerns.Authenticatable.html#getAuthIdentifier
Function
Method
PUBLIC
Return the value uniquely identifying this identity.
-
orionis.auth.concerns.Authenticatable.getAuthPassword
orionis.auth.concerns.Authenticatable.html#getAuthPassword
Function
Method
PUBLIC
Return the stored password hash of this identity.
-
orionis.auth.concerns.Authorizable
orionis.auth.concerns.Authorizable.html
Class
Class
PUBLIC
Let any Orionis model own permissions and roles.
-
orionis.auth.concerns.Authorizable.__slots__
orionis.auth.concerns.Authorizable.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.auth.concerns.Authorizable.AUTHORIZABLE_TYPE
orionis.auth.concerns.Authorizable.html#AUTHORIZABLE_TYPE
Attribute
Constant
PUBLIC
Value stored in the model_type column. Leave it as None to derive a stable dotted path from the class itself.
-
orionis.auth.concerns.Authorizable.getAuthorizableType
orionis.auth.concerns.Authorizable.html#getAuthorizableType
Function
Method
PUBLIC
Return the polymorphic type stored with the identifier.
-
orionis.auth.concerns.Authorizable.getAuthorizableId
orionis.auth.concerns.Authorizable.html#getAuthorizableId
Function
Method
PUBLIC
Return the identifier stored in the authorization tables.
-
orionis.auth.concerns.model_primary_key
orionis.auth.concerns.html#model_primary_key
Function
Function
PUBLIC
Return the primary key attribute of a model instance.
-
orionis.auth.concerns.MustVerifyEmail
orionis.auth.concerns.MustVerifyEmail.html
Class
Class
PUBLIC
Require identities to verify their email address before activation.
-
orionis.auth.context.GUEST_CONTEXT
orionis.auth.context.html#GUEST_CONTEXT
Attribute
Constant
PUBLIC
Shared context handed to every request nobody authenticated. It carries no identity and resolves to the empty snapshot, so sharing is safe.
-
orionis.auth.context.AuthenticationContext
orionis.auth.context.AuthenticationContext.html
Class
Class
PUBLIC
Hold the authenticated state of one request.
-
orionis.auth.context.AuthenticationContext.__slots__
orionis.auth.context.AuthenticationContext.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.auth.context.AuthenticationContext.__init__
orionis.auth.context.AuthenticationContext.html#__init__
Function
Method
PUBLIC
Build the authentication context of a request.
-
orionis.auth.context.AuthenticationContext.__identity
orionis.auth.context.AuthenticationContext.html#__identity
Attribute
Instance Variable
PUBLIC
Identity resolved by a guard, or None for a guest.
-
orionis.auth.context.AuthenticationContext.__guard
orionis.auth.context.AuthenticationContext.html#__guard
Attribute
Instance Variable
PUBLIC
Name of the guard that resolved the identity.
-
orionis.auth.context.AuthenticationContext.__abilities
orionis.auth.context.AuthenticationContext.html#__abilities
Attribute
Instance Variable
PUBLIC
Abilities restricting the presented credential.
-
orionis.auth.context.AuthenticationContext.__repository
orionis.auth.context.AuthenticationContext.html#__repository
Attribute
Instance Variable
PUBLIC
Source used to resolve the authorization snapshot. It is only required for authenticated contexts.
-
orionis.auth.context.AuthenticationContext.__credential_id
orionis.auth.context.AuthenticationContext.html#__credential_id
Attribute
Instance Variable
PUBLIC
Identifier of the revocable credential that authenticated the request, such as a personal access token.
-
orionis.auth.context.AuthenticationContext.__snapshot
orionis.auth.context.AuthenticationContext.html#__snapshot
Attribute
Instance Variable
PUBLIC
Authentication state captured for the current request.
-
orionis.auth.context.AuthenticationContext.__scope
orionis.auth.context.AuthenticationContext.html#__scope
Attribute
Instance Variable
PUBLIC
Dependency-injection scope associated with the current operation.
-
orionis.auth.context.AuthenticationContext.__lock
orionis.auth.context.AuthenticationContext.html#__lock
Attribute
Instance Variable
PUBLIC
Lock protecting concurrent access to shared state.
-
orionis.auth.context.AuthenticationContext._bindToScope
orionis.auth.context.AuthenticationContext.html#_bindToScope
Function
Method
PUBLIC
Associate this context with one scope for its remaining lifetime.
-
orionis.auth.context.AuthenticationContext._fork
orionis.auth.context.AuthenticationContext.html#_fork
Function
Method
PUBLIC
Copy the current identity into a fresh, independently scoped context.
-
orionis.auth.context.AuthenticationContext.__isCurrent
orionis.auth.context.AuthenticationContext.html#__isCurrent
Function
Method
PUBLIC
Report whether this context still belongs to a live request.
-
orionis.auth.context.AuthenticationContext.identity
orionis.auth.context.AuthenticationContext.html#identity
Attribute
Property
PUBLIC
Return the authenticated identity of the request.
-
orionis.auth.context.AuthenticationContext.guard
orionis.auth.context.AuthenticationContext.html#guard
Attribute
Property
PUBLIC
Return the name of the guard that resolved the identity.
-
orionis.auth.context.AuthenticationContext.abilities
orionis.auth.context.AuthenticationContext.html#abilities
Attribute
Property
PUBLIC
Return the abilities carried by the presented credential.
-
orionis.auth.context.AuthenticationContext.credentialId
orionis.auth.context.AuthenticationContext.html#credentialId
Attribute
Property
PUBLIC
Return the identifier of the credential that authenticated.
-
orionis.auth.context.AuthenticationContext.isAuthenticated
orionis.auth.context.AuthenticationContext.html#isAuthenticated
Attribute
Property
PUBLIC
Report whether the request carries an authenticated identity.
-
orionis.auth.context.AuthenticationContext.isGuest
orionis.auth.context.AuthenticationContext.html#isGuest
Attribute
Property
PUBLIC
Report whether the request is anonymous.
-
orionis.auth.context.AuthenticationContext.identifier
orionis.auth.context.AuthenticationContext.html#identifier
Function
Method
PUBLIC
Return the unique identifier of the authenticated identity.
-
orionis.auth.context.AuthenticationContext.authorization
orionis.auth.context.AuthenticationContext.html#authorization
Function
Method
PUBLIC
Return the effective authorization snapshot of the request.
-
orionis.auth.context.AuthenticationContext.__repr__
orionis.auth.context.AuthenticationContext.html#__repr__
Function
Method
PUBLIC
Return a debugging representation of the context.
-
orionis.auth.context.functions._AUTH_LOCK
orionis.auth.context.functions.html#_AUTH_LOCK
Attribute
Constant
PUBLIC
Sentinel distinguishing auth lock from ordinary values.
-
orionis.auth.context.functions.authentication_lock
orionis.auth.context.functions.html#authentication_lock
Function
Function
PUBLIC
Return the lock serializing authentication transitions in this scope.
-
orionis.auth.context.bind_auth_context
orionis.auth.context.html#bind_auth_context
Function
Function
PUBLIC
Bind an authentication context to the current scope.
-
orionis.auth.context.current_auth_context
orionis.auth.context.html#current_auth_context
Function
Function
PUBLIC
Return the authentication context bound to the current scope.
-
orionis.auth.context._EXPORTS
orionis.auth.context.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.auth.context.__getattr__
orionis.auth.context.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.auth.context.__dir__
orionis.auth.context.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.auth.contracts.IAuthenticatable
orionis.auth.contracts.IAuthenticatable.html
Class
Class
PUBLIC
Define the minimum surface an application identity must expose.
-
orionis.auth.contracts.IAuthenticatable.__slots__
orionis.auth.contracts.IAuthenticatable.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.auth.contracts.IAuthenticatable.getAuthIdentifierName
orionis.auth.contracts.IAuthenticatable.html#getAuthIdentifierName
Function
Method
PUBLIC
Return the attribute holding the unique identifier.
-
orionis.auth.contracts.IAuthenticatable.getAuthIdentifier
orionis.auth.contracts.IAuthenticatable.html#getAuthIdentifier
Function
Method
PUBLIC
Return the value uniquely identifying this identity.
-
orionis.auth.contracts.IAuthenticatable.getAuthPassword
orionis.auth.contracts.IAuthenticatable.html#getAuthPassword
Function
Method
PUBLIC
Return the stored password hash of this identity.
-
orionis.auth.contracts.IAuthorizable
orionis.auth.contracts.IAuthorizable.html
Class
Class
PUBLIC
Define how an identity is addressed by the authorization tables.
-
orionis.auth.contracts.IAuthorizable.__slots__
orionis.auth.contracts.IAuthorizable.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.auth.contracts.IAuthorizable.getAuthorizableType
orionis.auth.contracts.IAuthorizable.html#getAuthorizableType
Function
Method
PUBLIC
Return the polymorphic type stored alongside the identifier.
-
orionis.auth.contracts.IAuthorizable.getAuthorizableId
orionis.auth.contracts.IAuthorizable.html#getAuthorizableId
Function
Method
PUBLIC
Return the identifier stored in the authorization pivot tables.
-
orionis.auth.contracts.IAuthorizer
orionis.auth.contracts.IAuthorizer.html
Class
Class
PUBLIC
Define the component answering authorization questions.
-
orionis.auth.contracts.IAuthorizer.__slots__
orionis.auth.contracts.IAuthorizer.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.auth.contracts.IAuthorizer.can
orionis.auth.contracts.IAuthorizer.html#can
Function
Method
PUBLIC
Report whether the context grants a permission.
-
orionis.auth.contracts.IAuthorizer.canAny
orionis.auth.contracts.IAuthorizer.html#canAny
Function
Method
PUBLIC
Report whether the context grants at least one permission.
-
orionis.auth.contracts.IAuthorizer.canAll
orionis.auth.contracts.IAuthorizer.html#canAll
Function
Method
PUBLIC
Report whether the context grants every permission.
-
orionis.auth.contracts.IAuthorizer.hasRole
orionis.auth.contracts.IAuthorizer.html#hasRole
Function
Method
PUBLIC
Report whether the context owns a role.
-
orionis.auth.contracts.IAuthorizer.allows
orionis.auth.contracts.IAuthorizer.html#allows
Function
Method
PUBLIC
Evaluate a policy ability against a concrete resource.
-
orionis.auth.contracts.IAuthorizer.registerPolicy
orionis.auth.contracts.IAuthorizer.html#registerPolicy
Function
Method
PUBLIC
Bind a policy class to a resource type.
-
orionis.auth.contracts.IAuthenticationContext
orionis.auth.contracts.IAuthenticationContext.html
Class
Class
PUBLIC
Define the authenticated state bound to a single request.
-
orionis.auth.contracts.IAuthenticationContext.__slots__
orionis.auth.contracts.IAuthenticationContext.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.auth.contracts.IAuthenticationContext.identity
orionis.auth.contracts.IAuthenticationContext.html#identity
Attribute
Property
PUBLIC
Return the authenticated identity of the request.
-
orionis.auth.contracts.IAuthenticationContext.guard
orionis.auth.contracts.IAuthenticationContext.html#guard
Attribute
Property
PUBLIC
Return the name of the guard that resolved the identity.
-
orionis.auth.contracts.IAuthenticationContext.abilities
orionis.auth.contracts.IAuthenticationContext.html#abilities
Attribute
Property
PUBLIC
Return the abilities carried by the presented credential.
-
orionis.auth.contracts.IAuthenticationContext.credentialId
orionis.auth.contracts.IAuthenticationContext.html#credentialId
Attribute
Property
PUBLIC
Return the identifier of the credential that authenticated.
-
orionis.auth.contracts.IAuthenticationContext.isAuthenticated
orionis.auth.contracts.IAuthenticationContext.html#isAuthenticated
Attribute
Property
PUBLIC
Report whether the request carries an authenticated identity.
-
orionis.auth.contracts.IAuthenticationContext.isGuest
orionis.auth.contracts.IAuthenticationContext.html#isGuest
Attribute
Property
PUBLIC
Report whether the request is anonymous.
-
orionis.auth.contracts.IAuthenticationContext.identifier
orionis.auth.contracts.IAuthenticationContext.html#identifier
Function
Method
PUBLIC
Return the unique identifier of the authenticated identity.
-
orionis.auth.contracts.IAuthenticationContext.authorization
orionis.auth.contracts.IAuthenticationContext.html#authorization
Function
Method
PUBLIC
Return the effective authorization snapshot of the request.
-
orionis.auth.contracts.IGuard
orionis.auth.contracts.IGuard.html
Class
Class
PUBLIC
Define how an authenticated identity is extracted from a request.
-
orionis.auth.contracts.IGuard.__slots__
orionis.auth.contracts.IGuard.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.auth.contracts.IGuard.name
orionis.auth.contracts.IGuard.html#name
Attribute
Property
PUBLIC
Return the configuration name of this guard.
-
orionis.auth.contracts.IGuard.resolve
orionis.auth.contracts.IGuard.html#resolve
Function
Method
PUBLIC
Resolve the identity backing the incoming request.
-
orionis.auth.contracts.IIdentityProvider
orionis.auth.contracts.IIdentityProvider.html
Class
Class
PUBLIC
Define how a persisted identity becomes an application object.
-
orionis.auth.contracts.IIdentityProvider.__slots__
orionis.auth.contracts.IIdentityProvider.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.auth.contracts.IIdentityProvider.updateRememberToken
orionis.auth.contracts.IIdentityProvider.html#updateRememberToken
Function
Method
PUBLIC
Optionally compare and replace a persistent credential atomically.
-
orionis.auth.contracts.IIdentityProvider.retrieveById
orionis.auth.contracts.IIdentityProvider.html#retrieveById
Function
Method
PUBLIC
Retrieve an identity by its unique identifier.
-
orionis.auth.contracts.IIdentityProvider.retrieveByCredentials
orionis.auth.contracts.IIdentityProvider.html#retrieveByCredentials
Function
Method
PUBLIC
Retrieve an identity matching the non secret credentials.
-
orionis.auth.contracts.IIdentityProvider.validateCredentials
orionis.auth.contracts.IIdentityProvider.html#validateCredentials
Function
Method
PUBLIC
Verify credentials without blocking the event loop.
-
orionis.auth.contracts.IAuthManager
orionis.auth.contracts.IAuthManager.html
Class
Class
PUBLIC
Define the public entry point of the authentication module.
-
orionis.auth.contracts.IAuthManager.__slots__
orionis.auth.contracts.IAuthManager.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.auth.contracts.IAuthManager.context
orionis.auth.contracts.IAuthManager.html#context
Function
Method
PUBLIC
Return the authentication context of the current request.
-
orionis.auth.contracts.IAuthManager.user
orionis.auth.contracts.IAuthManager.html#user
Function
Method
PUBLIC
Return the identity authenticated for the current request.
-
orionis.auth.contracts.IAuthManager.identifier
orionis.auth.contracts.IAuthManager.html#identifier
Function
Method
PUBLIC
Return the identifier of the authenticated identity.
-
orionis.auth.contracts.IAuthManager.check
orionis.auth.contracts.IAuthManager.html#check
Function
Method
PUBLIC
Report whether the current request is authenticated.
-
orionis.auth.contracts.IAuthManager.guest
orionis.auth.contracts.IAuthManager.html#guest
Function
Method
PUBLIC
Report whether the current request is anonymous.
-
orionis.auth.contracts.IAuthManager.guard
orionis.auth.contracts.IAuthManager.html#guard
Function
Method
PUBLIC
Return a configured guard by name.
-
orionis.auth.contracts.IAuthManager.attempt
orionis.auth.contracts.IAuthManager.html#attempt
Function
Method
PUBLIC
Authenticate the current request from submitted credentials.
-
orionis.auth.contracts.IAuthManager.login
orionis.auth.contracts.IAuthManager.html#login
Function
Method
PUBLIC
Authenticate an identity without verifying credentials.
-
orionis.auth.contracts.IAuthManager.logout
orionis.auth.contracts.IAuthManager.html#logout
Function
Method
PUBLIC
Drop the authenticated state of the current request.
-
orionis.auth.contracts.IAuthManager.authorization
orionis.auth.contracts.IAuthManager.html#authorization
Function
Method
PUBLIC
Return the effective authorization snapshot of the request.
-
orionis.auth.contracts.IAuthManager.can
orionis.auth.contracts.IAuthManager.html#can
Function
Method
PUBLIC
Report whether the current request grants a permission.
-
orionis.auth.contracts.IAuthManager.cannot
orionis.auth.contracts.IAuthManager.html#cannot
Function
Method
PUBLIC
Report whether the current request lacks a permission.
-
orionis.auth.contracts.IAuthManager.canAny
orionis.auth.contracts.IAuthManager.html#canAny
Function
Method
PUBLIC
Report whether at least one permission is granted.
-
orionis.auth.contracts.IAuthManager.canAll
orionis.auth.contracts.IAuthManager.html#canAll
Function
Method
PUBLIC
Report whether every permission is granted.
-
orionis.auth.contracts.IAuthManager.hasRole
orionis.auth.contracts.IAuthManager.html#hasRole
Function
Method
PUBLIC
Report whether the identity owns a role.
-
orionis.auth.contracts.IAuthManager.authorize
orionis.auth.contracts.IAuthManager.html#authorize
Function
Method
PUBLIC
Require a permission or abort the current operation.
-
orionis.auth.contracts.IAuthManager.allows
orionis.auth.contracts.IAuthManager.html#allows
Function
Method
PUBLIC
Evaluate a policy ability against a resource.
-
orionis.auth.contracts.IAuthManager.denies
orionis.auth.contracts.IAuthManager.html#denies
Function
Method
PUBLIC
Report whether a policy ability is denied for a resource.
-
orionis.auth.contracts.IAuthManager.authorizeResource
orionis.auth.contracts.IAuthManager.html#authorizeResource
Function
Method
PUBLIC
Require a policy ability or abort the current operation.
-
orionis.auth.contracts.IAuthManager.registerPolicy
orionis.auth.contracts.IAuthManager.html#registerPolicy
Function
Method
PUBLIC
Bind a policy class to a resource type.
-
orionis.auth.contracts.IAuthManager.createToken
orionis.auth.contracts.IAuthManager.html#createToken
Function
Method
PUBLIC
Issue a personal access token.
-
orionis.auth.contracts.IAuthManager.revokeCurrentToken
orionis.auth.contracts.IAuthManager.html#revokeCurrentToken
Function
Method
PUBLIC
Revoke the presented token and clear this request's identity.
-
orionis.auth.contracts.IPermissionRepository
orionis.auth.contracts.IPermissionRepository.html
Class
Class
PUBLIC
Define how the effective permissions of an identity are loaded.
-
orionis.auth.contracts.IPermissionRepository.__slots__
orionis.auth.contracts.IPermissionRepository.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.auth.contracts.IPermissionRepository.loadFor
orionis.auth.contracts.IPermissionRepository.html#loadFor
Function
Method
PUBLIC
Load the permissions and roles owned by an identity.
-
orionis.auth.contracts.IPolicy
orionis.auth.contracts.IPolicy.html
Class
Class
PUBLIC
Define the contract shared by every resource policy.
-
orionis.auth.contracts.IPolicy.__slots__
orionis.auth.contracts.IPolicy.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.auth.contracts.IPolicy.before
orionis.auth.contracts.IPolicy.html#before
Function
Method
PUBLIC
Short circuit the policy before the ability method runs.
-
orionis.auth.contracts.ISessionGuard
orionis.auth.contracts.ISessionGuard.html
Class
Class
PUBLIC
Define the stateful operations supported by session authentication.
-
orionis.auth.contracts.ISessionGuard.__slots__
orionis.auth.contracts.ISessionGuard.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.auth.contracts.ISessionGuard.attempt
orionis.auth.contracts.ISessionGuard.html#attempt
Function
Method
PUBLIC
Validate credentials and start an authenticated session.
-
orionis.auth.contracts.ISessionGuard.login
orionis.auth.contracts.ISessionGuard.html#login
Function
Method
PUBLIC
Persist an identity in the session of the current request.
-
orionis.auth.contracts.ISessionGuard.logout
orionis.auth.contracts.ISessionGuard.html#logout
Function
Method
PUBLIC
Drop the authenticated state from the session.
-
orionis.auth.contracts.IAuthorizationSnapshot
orionis.auth.contracts.IAuthorizationSnapshot.html
Class
Class
PUBLIC
Define the immutable authorization picture of a single request.
-
orionis.auth.contracts.IAuthorizationSnapshot.__slots__
orionis.auth.contracts.IAuthorizationSnapshot.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.auth.contracts.IAuthorizationSnapshot.permissions
orionis.auth.contracts.IAuthorizationSnapshot.html#permissions
Attribute
Property
PUBLIC
Return the permissions granted to the identity.
-
orionis.auth.contracts.IAuthorizationSnapshot.roles
orionis.auth.contracts.IAuthorizationSnapshot.html#roles
Attribute
Property
PUBLIC
Return the role names assigned to the identity.
-
orionis.auth.contracts.IAuthorizationSnapshot.abilities
orionis.auth.contracts.IAuthorizationSnapshot.html#abilities
Attribute
Property
PUBLIC
Return the abilities restricting the current credential.
-
orionis.auth.contracts.IAuthorizationSnapshot.can
orionis.auth.contracts.IAuthorizationSnapshot.html#can
Function
Method
PUBLIC
Report whether the effective authorization grants a permission.
-
orionis.auth.contracts.IAuthorizationSnapshot.hasRole
orionis.auth.contracts.IAuthorizationSnapshot.html#hasRole
Function
Method
PUBLIC
Report whether the identity owns a role.
-
orionis.auth.contracts.IAccessTokenRepository
orionis.auth.contracts.IAccessTokenRepository.html
Class
Class
PUBLIC
Define the persistence operations of personal access tokens.
-
orionis.auth.contracts.IAccessTokenRepository.__slots__
orionis.auth.contracts.IAccessTokenRepository.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.auth.contracts.IAccessTokenRepository.create
orionis.auth.contracts.IAccessTokenRepository.html#create
Function
Method
PUBLIC
Issue a new personal access token for an identity.
-
orionis.auth.contracts.IAccessTokenRepository.findByPlainText
orionis.auth.contracts.IAccessTokenRepository.html#findByPlainText
Function
Method
PUBLIC
Resolve a token from the value presented by the client.
-
orionis.auth.contracts.IAccessTokenRepository.touch
orionis.auth.contracts.IAccessTokenRepository.html#touch
Function
Method
PUBLIC
Confirm token validity and record its use atomically.
-
orionis.auth.contracts.IAccessTokenRepository.revoke
orionis.auth.contracts.IAccessTokenRepository.html#revoke
Function
Method
PUBLIC
Revoke a single token.
-
orionis.auth.contracts.IAccessTokenRepository.revokeAll
orionis.auth.contracts.IAccessTokenRepository.html#revokeAll
Function
Method
PUBLIC
Revoke every active token of an identity.
-
orionis.auth.contracts.IAccessTokenRepository.purgeExpired
orionis.auth.contracts.IAccessTokenRepository.html#purgeExpired
Function
Method
PUBLIC
Delete tokens that expired or were revoked.
-
orionis.auth.contracts._EXPORTS
orionis.auth.contracts.html#_EXPORTS
Attribute
Constant
PUBLIC
Public contract names mapped to their defining modules and attributes.
-
orionis.auth.contracts.__getattr__
orionis.auth.contracts.html#__getattr__
Function
Function
PUBLIC
Resolve a public contract on first access.
-
orionis.auth.contracts.__dir__
orionis.auth.contracts.html#__dir__
Function
Function
PUBLIC
Include unloaded contracts in package introspection.
-
orionis.auth.entities.AccessToken
orionis.auth.entities.AccessToken.html
Class
Class
PUBLIC
Describe a stored personal access token.
-
orionis.auth.entities.AccessToken.id
orionis.auth.entities.AccessToken.html#id
Attribute
Instance Variable
PUBLIC
Primary key of the token row.
-
orionis.auth.entities.AccessToken.tokenable_type
orionis.auth.entities.AccessToken.html#tokenable_type
Attribute
Instance Variable
PUBLIC
Polymorphic type of the identity owning the token.
-
orionis.auth.entities.AccessToken.tokenable_id
orionis.auth.entities.AccessToken.html#tokenable_id
Attribute
Instance Variable
PUBLIC
Identifier of the identity owning the token.
-
orionis.auth.entities.AccessToken.name
orionis.auth.entities.AccessToken.html#name
Attribute
Instance Variable
PUBLIC
Human readable label describing the token.
-
orionis.auth.entities.AccessToken.abilities
orionis.auth.entities.AccessToken.html#abilities
Attribute
Instance Variable
PUBLIC
Abilities the token may use, or None when the token keeps the full authorization of the identity.
-
orionis.auth.entities.AccessToken.created_at
orionis.auth.entities.AccessToken.html#created_at
Attribute
Instance Variable
PUBLIC
Moment the token was issued.
-
orionis.auth.entities.AccessToken.expires_at
orionis.auth.entities.AccessToken.html#expires_at
Attribute
Instance Variable
PUBLIC
Moment the token stops being accepted.
-
orionis.auth.entities.AccessToken.last_used_at
orionis.auth.entities.AccessToken.html#last_used_at
Attribute
Instance Variable
PUBLIC
Moment the token was last presented on a request.
-
orionis.auth.entities.AccessToken.revoked_at
orionis.auth.entities.AccessToken.html#revoked_at
Attribute
Instance Variable
PUBLIC
Moment the token was revoked.
-
orionis.auth.entities.AccessToken.toDict
orionis.auth.entities.AccessToken.html#toDict
Function
Method
PUBLIC
Serialize token metadata without any usable credential material.
-
orionis.auth.entities.GuardResult
orionis.auth.entities.GuardResult.html
Class
Class
PUBLIC
Carry what a guard learned about the incoming request.
-
orionis.auth.entities.GuardResult.identity
orionis.auth.entities.GuardResult.html#identity
Attribute
Instance Variable
PUBLIC
Identity resolved from the presented credential.
-
orionis.auth.entities.GuardResult.guard
orionis.auth.entities.GuardResult.html#guard
Attribute
Instance Variable
PUBLIC
Name of the guard that resolved the identity.
-
orionis.auth.entities.GuardResult.abilities
orionis.auth.entities.GuardResult.html#abilities
Attribute
Instance Variable
PUBLIC
Abilities restricting the presented credential, or None when the credential keeps the full authorization of the identity.
-
orionis.auth.entities.GuardResult.credential_id
orionis.auth.entities.GuardResult.html#credential_id
Attribute
Instance Variable
PUBLIC
Identifier of the credential used, when the guard works with revocable credentials such as personal access tokens.
-
orionis.auth.entities.NewAccessToken
orionis.auth.entities.NewAccessToken.html
Class
Class
PUBLIC
Pair a freshly issued token with its plain text value.
-
orionis.auth.entities.NewAccessToken.access_token
orionis.auth.entities.NewAccessToken.html#access_token
Attribute
Instance Variable
PUBLIC
Metadata of the stored token.
-
orionis.auth.entities.NewAccessToken.plain_text
orionis.auth.entities.NewAccessToken.html#plain_text
Attribute
Instance Variable
PUBLIC
Value the client must send in the Authorization header. It is excluded from repr() so it never leaks into logs or tracebacks.
-
orionis.auth.entities.NewAccessToken.toDict
orionis.auth.entities.NewAccessToken.html#toDict
Function
Method
PUBLIC
Serialize only public metadata; access plain_text explicitly to issue it.
-
orionis.auth.remember._MAX_COOKIE_LENGTH
orionis.auth.remember.html#_MAX_COOKIE_LENGTH
Attribute
Constant
PUBLIC
Max cookie length value used by remember.
-
orionis.auth.remember._COOKIE_STATE
orionis.auth.remember.html#_COOKIE_STATE
Attribute
Constant
PUBLIC
_auth_remember_cookie.
-
orionis.auth.remember._COOKIE_PATTERN
orionis.auth.remember.html#_COOKIE_PATTERN
Attribute
Constant
PUBLIC
Compiled pattern used to recognize cookie pattern.
-
orionis.auth.remember.RememberMe
orionis.auth.remember.RememberMe.html
Class
Class
PUBLIC
Store expiring token digests and rotate them on persistent login.
-
orionis.auth.remember.RememberMe.__init__
orionis.auth.remember.RememberMe.html#__init__
Function
Method
PUBLIC
Initialize persistent-login settings and dependencies.
-
orionis.auth.remember.RememberMe.settings
orionis.auth.remember.RememberMe.html#settings
Attribute
Instance Variable
PUBLIC
Settings produced by RememberAuth.
-
orionis.auth.remember.RememberMe.identities
orionis.auth.remember.RememberMe.html#identities
Attribute
Instance Variable
PUBLIC
Provider used to retrieve identities and update remember tokens.
-
orionis.auth.remember.RememberMe._stored
orionis.auth.remember.RememberMe.html#_stored
Function
Static Method
PUBLIC
Bind a credential to its identity, expiry, and password hash.
-
orionis.auth.remember.RememberMe._queue
orionis.auth.remember.RememberMe.html#_queue
Function
Method
PUBLIC
Queue a cookie change on the current request.
-
orionis.auth.remember.RememberMe.clearCookie
orionis.auth.remember.RememberMe.html#clearCookie
Function
Method
PUBLIC
Queue expiration of the current browser's persistent credential.
-
orionis.auth.remember.RememberMe.issue
orionis.auth.remember.RememberMe.html#issue
Function
Method
PUBLIC
Issue a persistent credential after password verification.
-
orionis.auth.remember.RememberMe._generate
orionis.auth.remember.RememberMe.html#_generate
Function
Static Method
PUBLIC
Create a cookie value containing an identity, expiry, and secret.
-
orionis.auth.remember.RememberMe.restore
orionis.auth.remember.RememberMe.html#restore
Function
Method
PUBLIC
Restore an identity by validating and rotating its cookie.
-
orionis.auth.remember.RememberMe.revoke
orionis.auth.remember.RememberMe.html#revoke
Function
Method
PUBLIC
Revoke a remembered credential and clear the browser cookie.
-
orionis.auth.remember.RememberMe.forget
orionis.auth.remember.RememberMe.html#forget
Function
Method
PUBLIC
Forget an identity's persistent credential.
-
orionis.auth.remember.apply_remember_cookie
orionis.auth.remember.html#apply_remember_cookie
Function
Function
PUBLIC
Apply a queued remember-cookie change to the outgoing response.
-
orionis.auth.guards.session_guard._DEFAULT_SESSION_KEY
orionis.auth.guards.session_guard.html#_DEFAULT_SESSION_KEY
Attribute
Constant
PUBLIC
Fallback applied when the configuration section is absent.
-
orionis.auth.guards.SessionGuard
orionis.auth.guards.SessionGuard.html
Class
Class
PUBLIC
Resolve the identity of web requests from the HTTP session.
-
orionis.auth.guards.SessionGuard.__slots__
orionis.auth.guards.SessionGuard.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.auth.guards.SessionGuard.__init__
orionis.auth.guards.SessionGuard.html#__init__
Function
Method
PUBLIC
Initialise the guard from the authentication configuration.
-
orionis.auth.guards.SessionGuard.__session_key
orionis.auth.guards.SessionGuard.html#__session_key
Attribute
Instance Variable
PUBLIC
Session key under which the authenticated identity is stored.
-
orionis.auth.guards.SessionGuard.__password_key
orionis.auth.guards.SessionGuard.html#__password_key
Attribute
Instance Variable
PUBLIC
Session key used to retain the authenticated password fingerprint.
-
orionis.auth.guards.SessionGuard.__identities
orionis.auth.guards.SessionGuard.html#__identities
Attribute
Instance Variable
PUBLIC
Provider turning a stored identifier into an identity.
-
orionis.auth.guards.SessionGuard.__csrf_key
orionis.auth.guards.SessionGuard.html#__csrf_key
Attribute
Instance Variable
PUBLIC
Session key containing the CSRF token.
-
orionis.auth.guards.SessionGuard.__csrf_length
orionis.auth.guards.SessionGuard.html#__csrf_length
Attribute
Instance Variable
PUBLIC
Length of newly generated CSRF tokens.
-
orionis.auth.guards.SessionGuard.__remember
orionis.auth.guards.SessionGuard.html#__remember
Attribute
Instance Variable
PUBLIC
Optional request value enabling persistent authentication.
-
orionis.auth.guards.SessionGuard.name
orionis.auth.guards.SessionGuard.html#name
Attribute
Property
PUBLIC
Return the configuration name of this guard.
-
orionis.auth.guards.SessionGuard.resolve
orionis.auth.guards.SessionGuard.html#resolve
Function
Method
PUBLIC
Resolve the identity remembered in the session.
-
orionis.auth.guards.SessionGuard.attempt
orionis.auth.guards.SessionGuard.html#attempt
Function
Method
PUBLIC
Validate credentials and start an authenticated session.
-
orionis.auth.guards.SessionGuard.__restoreRemembered
orionis.auth.guards.SessionGuard.html#__restoreRemembered
Function
Method
PUBLIC
Restore an identity from a persistent credential.
-
orionis.auth.guards.SessionGuard.login
orionis.auth.guards.SessionGuard.html#login
Function
Method
PUBLIC
Persist an identity in the session of the current request.
-
orionis.auth.guards.SessionGuard.logout
orionis.auth.guards.SessionGuard.html#logout
Function
Method
PUBLIC
Drop the authenticated state from the session.
-
orionis.auth.guards.SessionGuard.__session
orionis.auth.guards.SessionGuard.html#__session
Function
Static Method
PUBLIC
Return the session attached to a request, when present.
-
orionis.auth.guards.TokenGuard
orionis.auth.guards.TokenGuard.html
Class
Class
PUBLIC
Resolve the identity of API requests from a personal access token.
-
orionis.auth.guards.TokenGuard.__slots__
orionis.auth.guards.TokenGuard.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.auth.guards.TokenGuard.__init__
orionis.auth.guards.TokenGuard.html#__init__
Function
Method
PUBLIC
Initialise the guard with its collaborators.
-
orionis.auth.guards.TokenGuard.__tokens
orionis.auth.guards.TokenGuard.html#__tokens
Attribute
Instance Variable
PUBLIC
Store used to look tokens up and mark them as used.
-
orionis.auth.guards.TokenGuard.__identities
orionis.auth.guards.TokenGuard.html#__identities
Attribute
Instance Variable
PUBLIC
Provider turning a token owner into an identity.
-
orionis.auth.guards.TokenGuard.name
orionis.auth.guards.TokenGuard.html#name
Attribute
Property
PUBLIC
Return the configuration name of this guard.
-
orionis.auth.guards.TokenGuard.resolve
orionis.auth.guards.TokenGuard.html#resolve
Function
Method
PUBLIC
Resolve the identity owning the presented access token.
-
orionis.auth.guards._EXPORTS
orionis.auth.guards.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.auth.guards.__getattr__
orionis.auth.guards.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.auth.guards.__dir__
orionis.auth.guards.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.auth.identity.provider._DEFAULT_MODEL
orionis.auth.identity.provider.html#_DEFAULT_MODEL
Attribute
Constant
PUBLIC
Fallbacks applied when the configuration section is absent.
-
orionis.auth.identity.provider._DEFAULT_USERNAME
orionis.auth.identity.provider.html#_DEFAULT_USERNAME
Attribute
Constant
PUBLIC
email.
-
orionis.auth.identity.provider._DEFAULT_PASSWORD
orionis.auth.identity.provider.html#_DEFAULT_PASSWORD
Attribute
Constant
PUBLIC
Submitted credential field holding the plaintext password.
-
orionis.auth.identity.provider._INTEGER_KEY_TYPES
orionis.auth.identity.provider.html#_INTEGER_KEY_TYPES
Attribute
Constant
PUBLIC
Column types restored to integer keys before identity lookup.
-
orionis.auth.identity.provider._MAX_IDENTIFIER_LENGTH
orionis.auth.identity.provider.html#_MAX_IDENTIFIER_LENGTH
Attribute
Constant
PUBLIC
Maximum character count accepted in a stored identity key.
-
orionis.auth.identity.provider._MAX_PASSWORD_LENGTH
orionis.auth.identity.provider.html#_MAX_PASSWORD_LENGTH
Attribute
Constant
PUBLIC
Maximum submitted password character count before invoking the hasher.
-
orionis.auth.identity.ModelIdentityProvider
orionis.auth.identity.ModelIdentityProvider.html
Class
Class
PUBLIC
Resolve identities from an Orionis model declared in configuration.
-
orionis.auth.identity.ModelIdentityProvider.__slots__
orionis.auth.identity.ModelIdentityProvider.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.auth.identity.ModelIdentityProvider.__init__
orionis.auth.identity.ModelIdentityProvider.html#__init__
Function
Method
PUBLIC
Initialise the provider from the authentication configuration.
-
orionis.auth.identity.ModelIdentityProvider.__model_path
orionis.auth.identity.ModelIdentityProvider.html#__model_path
Attribute
Instance Variable
PUBLIC
Import path of the configured authenticatable model.
-
orionis.auth.identity.ModelIdentityProvider.__username_field
orionis.auth.identity.ModelIdentityProvider.html#__username_field
Attribute
Instance Variable
PUBLIC
Model field used to locate an identity by username.
-
orionis.auth.identity.ModelIdentityProvider.__hasher
orionis.auth.identity.ModelIdentityProvider.html#__hasher
Attribute
Instance Variable
PUBLIC
Hashing service used to verify submitted passwords.
-
orionis.auth.identity.ModelIdentityProvider.__model
orionis.auth.identity.ModelIdentityProvider.html#__model
Attribute
Instance Variable
PUBLIC
Cached concrete identity model, resolved on the first lookup.
-
orionis.auth.identity.ModelIdentityProvider.model
orionis.auth.identity.ModelIdentityProvider.html#model
Function
Method
PUBLIC
Return the model class backing the authenticated identity.
-
orionis.auth.identity.ModelIdentityProvider.retrieveById
orionis.auth.identity.ModelIdentityProvider.html#retrieveById
Function
Method
PUBLIC
Retrieve an identity by its primary key.
-
orionis.auth.identity.ModelIdentityProvider.__normalizeIdentifier
orionis.auth.identity.ModelIdentityProvider.html#__normalizeIdentifier
Function
Method
PUBLIC
Restore a stored scalar key to the model column's native type.
-
orionis.auth.identity.ModelIdentityProvider.retrieveByCredentials
orionis.auth.identity.ModelIdentityProvider.html#retrieveByCredentials
Function
Method
PUBLIC
Retrieve an identity matching the public credential.
-
orionis.auth.identity.ModelIdentityProvider.updateRememberToken
orionis.auth.identity.ModelIdentityProvider.html#updateRememberToken
Function
Method
PUBLIC
Compare and replace an identity's remember token atomically.
-
orionis.auth.identity.ModelIdentityProvider.validateCredentials
orionis.auth.identity.ModelIdentityProvider.html#validateCredentials
Function
Method
PUBLIC
Verify the submitted password against the stored hash.
-
orionis.auth.identity._EXPORTS
orionis.auth.identity.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.auth.identity.__getattr__
orionis.auth.identity.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.auth.identity.__dir__
orionis.auth.identity.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.auth.manager._UNAUTHENTICATED
orionis.auth.manager.html#_UNAUTHENTICATED
Attribute
Constant
PUBLIC
Describe the absence of a current authenticated identity.
-
orionis.auth.manager.AuthManager
orionis.auth.manager.AuthManager.html
Class
Class
PUBLIC
Expose authentication and authorization to application code.
-
orionis.auth.manager.AuthManager.__slots__
orionis.auth.manager.AuthManager.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.auth.manager.AuthManager.__init__
orionis.auth.manager.AuthManager.html#__init__
Function
Method
PUBLIC
Initialise the manager with the configured collaborators.
-
orionis.auth.manager.AuthManager.__authorizer
orionis.auth.manager.AuthManager.html#__authorizer
Attribute
Instance Variable
PUBLIC
Component answering permission, role and policy questions.
-
orionis.auth.manager.AuthManager.__permissions
orionis.auth.manager.AuthManager.html#__permissions
Attribute
Instance Variable
PUBLIC
Source the authorization snapshot is built from.
-
orionis.auth.manager.AuthManager.__tokens
orionis.auth.manager.AuthManager.html#__tokens
Attribute
Instance Variable
PUBLIC
Store used to issue and revoke personal access tokens.
-
orionis.auth.manager.AuthManager.__session_guard
orionis.auth.manager.AuthManager.html#__session_guard
Attribute
Instance Variable
PUBLIC
Guard backing web authentication.
-
orionis.auth.manager.AuthManager.__guards
orionis.auth.manager.AuthManager.html#__guards
Attribute
Instance Variable
PUBLIC
Register the configured guard classes by name.
-
orionis.auth.manager.AuthManager.__default_guard
orionis.auth.manager.AuthManager.html#__default_guard
Attribute
Instance Variable
PUBLIC
Name of the authentication guard selected when none is specified.
-
orionis.auth.manager.AuthManager.context
orionis.auth.manager.AuthManager.html#context
Function
Method
PUBLIC
Return the authentication context of the current request.
-
orionis.auth.manager.AuthManager.user
orionis.auth.manager.AuthManager.html#user
Function
Method
PUBLIC
Return the identity authenticated for the current request.
-
orionis.auth.manager.AuthManager.identifier
orionis.auth.manager.AuthManager.html#identifier
Function
Method
PUBLIC
Return the identifier of the authenticated identity.
-
orionis.auth.manager.AuthManager.check
orionis.auth.manager.AuthManager.html#check
Function
Method
PUBLIC
Report whether the current request is authenticated.
-
orionis.auth.manager.AuthManager.guest
orionis.auth.manager.AuthManager.html#guest
Function
Method
PUBLIC
Report whether the current request is anonymous.
-
orionis.auth.manager.AuthManager.guard
orionis.auth.manager.AuthManager.html#guard
Function
Method
PUBLIC
Return a configured guard by name.
-
orionis.auth.manager.AuthManager.attempt
orionis.auth.manager.AuthManager.html#attempt
Function
Method
PUBLIC
Authenticate the current request from submitted credentials.
-
orionis.auth.manager.AuthManager.login
orionis.auth.manager.AuthManager.html#login
Function
Method
PUBLIC
Authenticate an identity without verifying credentials.
-
orionis.auth.manager.AuthManager.logout
orionis.auth.manager.AuthManager.html#logout
Function
Method
PUBLIC
Drop the authenticated state of the current request.
-
orionis.auth.manager.AuthManager.authorization
orionis.auth.manager.AuthManager.html#authorization
Function
Method
PUBLIC
Return the effective authorization snapshot of the request.
-
orionis.auth.manager.AuthManager.can
orionis.auth.manager.AuthManager.html#can
Function
Method
PUBLIC
Report whether the current request grants a permission.
-
orionis.auth.manager.AuthManager.cannot
orionis.auth.manager.AuthManager.html#cannot
Function
Method
PUBLIC
Report whether the current request lacks a permission.
-
orionis.auth.manager.AuthManager.canAny
orionis.auth.manager.AuthManager.html#canAny
Function
Method
PUBLIC
Report whether at least one permission is granted.
-
orionis.auth.manager.AuthManager.canAll
orionis.auth.manager.AuthManager.html#canAll
Function
Method
PUBLIC
Report whether every permission is granted.
-
orionis.auth.manager.AuthManager.hasRole
orionis.auth.manager.AuthManager.html#hasRole
Function
Method
PUBLIC
Report whether the identity owns a role.
-
orionis.auth.manager.AuthManager.authorize
orionis.auth.manager.AuthManager.html#authorize
Function
Method
PUBLIC
Require a permission or abort the current operation.
-
orionis.auth.manager.AuthManager.allows
orionis.auth.manager.AuthManager.html#allows
Function
Method
PUBLIC
Evaluate a policy ability against a resource.
-
orionis.auth.manager.AuthManager.denies
orionis.auth.manager.AuthManager.html#denies
Function
Method
PUBLIC
Report whether a policy ability is denied for a resource.
-
orionis.auth.manager.AuthManager.authorizeResource
orionis.auth.manager.AuthManager.html#authorizeResource
Function
Method
PUBLIC
Require a policy ability or abort the current operation.
-
orionis.auth.manager.AuthManager.registerPolicy
orionis.auth.manager.AuthManager.html#registerPolicy
Function
Method
PUBLIC
Bind a policy class to a resource type.
-
orionis.auth.manager.AuthManager.createToken
orionis.auth.manager.AuthManager.html#createToken
Function
Method
PUBLIC
Issue a personal access token.
-
orionis.auth.manager.AuthManager.revokeCurrentToken
orionis.auth.manager.AuthManager.html#revokeCurrentToken
Function
Method
PUBLIC
Revoke the token that authenticated the current request.
-
orionis.auth.manager.AuthManager.__rebind
orionis.auth.manager.AuthManager.html#__rebind
Function
Method
PUBLIC
Bind a freshly authenticated identity to the current scope.
-
orionis.auth.manager.AuthManager.__request
orionis.auth.manager.AuthManager.html#__request
Function
Static Method
PUBLIC
Return the request bound to the current container scope.
-
orionis.auth.middleware.authenticate._REDIRECT_STATUS
orionis.auth.middleware.authenticate.html#_REDIRECT_STATUS
Attribute
Constant
PUBLIC
Status used when a browser is sent to the login page instead of receiving the plain 401 error document.
-
orionis.auth.middleware.AuthenticateMiddleware
orionis.auth.middleware.AuthenticateMiddleware.html
Class
Class
PUBLIC
Require an authenticated identity before reaching the controller.
-
orionis.auth.middleware.AuthenticateMiddleware.__slots__
orionis.auth.middleware.AuthenticateMiddleware.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.auth.middleware.AuthenticateMiddleware.cache_control
orionis.auth.middleware.AuthenticateMiddleware.html#cache_control
Attribute
Class Variable
PUBLIC
Cache-Control applied to every answer of a protected route.
-
orionis.auth.middleware.AuthenticateMiddleware.__init__
orionis.auth.middleware.AuthenticateMiddleware.html#__init__
Function
Method
PUBLIC
Initialise the middleware with its collaborators.
-
orionis.auth.middleware.AuthenticateMiddleware._redirect_to
orionis.auth.middleware.AuthenticateMiddleware.html#_redirect_to
Attribute
Instance Variable
PUBLIC
Redirect to produced by app.config.
-
orionis.auth.middleware.AuthenticateMiddleware.handle
orionis.auth.middleware.AuthenticateMiddleware.html#handle
Function
Method
PUBLIC
Reject anonymous requests and continue authenticated ones.
-
orionis.auth.middleware.AuthenticateMiddleware._unauthenticated
orionis.auth.middleware.AuthenticateMiddleware.html#_unauthenticated
Function
Method
PUBLIC
Build the answer given to an anonymous request.
-
orionis.auth.middleware.AuthenticateSessionMiddleware
orionis.auth.middleware.AuthenticateSessionMiddleware.html
Class
Class
PUBLIC
Require an identity authenticated through the HTTP session.
-
orionis.auth.middleware.AuthenticateSessionMiddleware.__slots__
orionis.auth.middleware.AuthenticateSessionMiddleware.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.auth.middleware.AuthenticateTokenMiddleware
orionis.auth.middleware.AuthenticateTokenMiddleware.html
Class
Class
PUBLIC
Require an identity authenticated through a personal access token.
-
orionis.auth.middleware.AuthenticateTokenMiddleware.__slots__
orionis.auth.middleware.AuthenticateTokenMiddleware.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.auth.middleware.RequirePermissionMiddleware
orionis.auth.middleware.RequirePermissionMiddleware.html
Class
Class
PUBLIC
Require one or more permissions before reaching the controller.
-
orionis.auth.middleware.RequirePermissionMiddleware.__slots__
orionis.auth.middleware.RequirePermissionMiddleware.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.auth.middleware.RequirePermissionMiddleware.permissions
orionis.auth.middleware.RequirePermissionMiddleware.html#permissions
Attribute
Class Variable
PUBLIC
Permissions the identity must hold.
-
orionis.auth.middleware.RequirePermissionMiddleware.requires_all
orionis.auth.middleware.RequirePermissionMiddleware.html#requires_all
Attribute
Class Variable
PUBLIC
Whether every permission is required, or just one of them.
-
orionis.auth.middleware.RequirePermissionMiddleware.__init__
orionis.auth.middleware.RequirePermissionMiddleware.html#__init__
Function
Method
PUBLIC
Initialise the middleware with the authorizer.
-
orionis.auth.middleware.RequirePermissionMiddleware._authorizer
orionis.auth.middleware.RequirePermissionMiddleware.html#_authorizer
Attribute
Instance Variable
PUBLIC
Component evaluating the permissions of the request context.
-
orionis.auth.middleware.RequirePermissionMiddleware.handle
orionis.auth.middleware.RequirePermissionMiddleware.html#handle
Function
Method
PUBLIC
Evaluate the permissions and continue when they are granted.
-
orionis.auth.middleware.RequireRoleMiddleware
orionis.auth.middleware.RequireRoleMiddleware.html
Class
Class
PUBLIC
Require one or more roles before reaching the controller.
-
orionis.auth.middleware.RequireRoleMiddleware.__slots__
orionis.auth.middleware.RequireRoleMiddleware.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.auth.middleware.RequireRoleMiddleware.roles
orionis.auth.middleware.RequireRoleMiddleware.html#roles
Attribute
Class Variable
PUBLIC
Roles the identity must hold.
-
orionis.auth.middleware.RequireRoleMiddleware.requires_all
orionis.auth.middleware.RequireRoleMiddleware.html#requires_all
Attribute
Class Variable
PUBLIC
Whether every role is required, or just one of them.
-
orionis.auth.middleware.RequireRoleMiddleware.__init__
orionis.auth.middleware.RequireRoleMiddleware.html#__init__
Function
Method
PUBLIC
Initialise the middleware with the authorizer.
-
orionis.auth.middleware.RequireRoleMiddleware._authorizer
orionis.auth.middleware.RequireRoleMiddleware.html#_authorizer
Attribute
Instance Variable
PUBLIC
Component evaluating the roles of the request context.
-
orionis.auth.middleware.RequireRoleMiddleware.handle
orionis.auth.middleware.RequireRoleMiddleware.html#handle
Function
Method
PUBLIC
Evaluate the roles and continue when they are granted.
-
orionis.auth.middleware.RequireRoleMiddleware.__evaluate
orionis.auth.middleware.RequireRoleMiddleware.html#__evaluate
Function
Method
PUBLIC
Report whether the context satisfies the role requirement.
-
orionis.auth.middleware.guest._DEFAULT_HOME
orionis.auth.middleware.guest.html#_DEFAULT_HOME
Attribute
Constant
PUBLIC
Target used when auth.session.home is absent from the configuration.
-
orionis.auth.middleware.GuestMiddleware
orionis.auth.middleware.GuestMiddleware.html
Class
Class
PUBLIC
Keep web login and registration routes restricted to guests.
-
orionis.auth.middleware.GuestMiddleware.__slots__
orionis.auth.middleware.GuestMiddleware.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.auth.middleware.GuestMiddleware.redirect_to
orionis.auth.middleware.GuestMiddleware.html#redirect_to
Attribute
Class Variable
PUBLIC
Explicit destination replacing the configured home page.
-
orionis.auth.middleware.GuestMiddleware.__init__
orionis.auth.middleware.GuestMiddleware.html#__init__
Function
Method
PUBLIC
Initialise the middleware with its collaborators.
-
orionis.auth.middleware.GuestMiddleware._home
orionis.auth.middleware.GuestMiddleware.html#_home
Attribute
Instance Variable
PUBLIC
Redirect destination for users who are already authenticated.
-
orionis.auth.middleware.GuestMiddleware.handle
orionis.auth.middleware.GuestMiddleware.html#handle
Function
Method
PUBLIC
Continue for guests and reject authenticated access to guest routes.
-
orionis.auth.middleware.RequirePolicyMiddleware
orionis.auth.middleware.RequirePolicyMiddleware.html
Class
Class
PUBLIC
Gate a route behind a policy ability declared on a resource class.
-
orionis.auth.middleware.RequirePolicyMiddleware.__slots__
orionis.auth.middleware.RequirePolicyMiddleware.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.auth.middleware.RequirePolicyMiddleware.ability
orionis.auth.middleware.RequirePolicyMiddleware.html#ability
Attribute
Class Variable
PUBLIC
Ability declared by the policy of the resource.
-
orionis.auth.middleware.RequirePolicyMiddleware.resource
orionis.auth.middleware.RequirePolicyMiddleware.html#resource
Attribute
Class Variable
PUBLIC
Resource class protected by the policy.
-
orionis.auth.middleware.RequirePolicyMiddleware.__init__
orionis.auth.middleware.RequirePolicyMiddleware.html#__init__
Function
Method
PUBLIC
Initialise the middleware with the authorizer.
-
orionis.auth.middleware.RequirePolicyMiddleware._authorizer
orionis.auth.middleware.RequirePolicyMiddleware.html#_authorizer
Attribute
Instance Variable
PUBLIC
Component resolving and running the policy.
-
orionis.auth.middleware.RequirePolicyMiddleware.handle
orionis.auth.middleware.RequirePolicyMiddleware.html#handle
Function
Method
PUBLIC
Evaluate the policy and continue when it allows the operation.
-
orionis.auth.middleware.ResolveIdentityMiddleware
orionis.auth.middleware.ResolveIdentityMiddleware.html
Class
Class
PUBLIC
Establish authentication while allowing anonymous requests to continue.
-
orionis.auth.middleware.ResolveIdentityMiddleware.__slots__
orionis.auth.middleware.ResolveIdentityMiddleware.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.auth.middleware.ResolveIdentityMiddleware.guard
orionis.auth.middleware.ResolveIdentityMiddleware.html#guard
Attribute
Class Variable
PUBLIC
An unpinned middleware reuses the request guard. Before any resolution, None falls back to the configured default guard.
-
orionis.auth.middleware.ResolveIdentityMiddleware.__init__
orionis.auth.middleware.ResolveIdentityMiddleware.html#__init__
Function
Method
PUBLIC
Initialise the middleware with its collaborators.
-
orionis.auth.middleware.ResolveIdentityMiddleware._manager
orionis.auth.middleware.ResolveIdentityMiddleware.html#_manager
Attribute
Instance Variable
PUBLIC
Manager exposing the configured guards.
-
orionis.auth.middleware.ResolveIdentityMiddleware._permissions
orionis.auth.middleware.ResolveIdentityMiddleware.html#_permissions
Attribute
Instance Variable
PUBLIC
Source the authorization snapshot is built from.
-
orionis.auth.middleware.ResolveIdentityMiddleware.handle
orionis.auth.middleware.ResolveIdentityMiddleware.html#handle
Function
Method
PUBLIC
Bind the authentication context and continue the pipeline.
-
orionis.auth.middleware.ResolveIdentityMiddleware._establish
orionis.auth.middleware.ResolveIdentityMiddleware.html#_establish
Function
Method
PUBLIC
Resolve the identity and bind the resulting context.
-
orionis.auth.middleware.ResolveSessionIdentityMiddleware
orionis.auth.middleware.ResolveSessionIdentityMiddleware.html
Class
Class
PUBLIC
Resolve a web identity from the session without requiring a login.
-
orionis.auth.middleware.ResolveSessionIdentityMiddleware.__slots__
orionis.auth.middleware.ResolveSessionIdentityMiddleware.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.auth.middleware.ResolveSessionIdentityMiddleware.handle
orionis.auth.middleware.ResolveSessionIdentityMiddleware.html#handle
Function
Method
PUBLIC
Resolve the session and apply queued cookie changes.
-
orionis.auth.middleware.ResolveTokenIdentityMiddleware
orionis.auth.middleware.ResolveTokenIdentityMiddleware.html
Class
Class
PUBLIC
Resolve an API identity from a Bearer token while allowing guests.
-
orionis.auth.middleware.ResolveTokenIdentityMiddleware.__slots__
orionis.auth.middleware.ResolveTokenIdentityMiddleware.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.auth.middleware._AUTHENTICATE_MODULE
orionis.auth.middleware.html#_AUTHENTICATE_MODULE
Attribute
Constant
PUBLIC
Module defining authentication-required middleware variants.
-
orionis.auth.middleware._RESOLVE_MODULE
orionis.auth.middleware.html#_RESOLVE_MODULE
Attribute
Constant
PUBLIC
Module defining optional identity-resolution middleware variants.
-
orionis.auth.middleware._EXPORTS
orionis.auth.middleware.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.auth.middleware.__getattr__
orionis.auth.middleware.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.auth.middleware.__dir__
orionis.auth.middleware.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.orm.exceptions.OrmException
orionis.orm.exceptions.OrmException.html
Class
Exception
PUBLIC
Base exception for all ORM-related errors.
-
orionis.orm.exceptions.OrmConfigurationException
orionis.orm.exceptions.OrmConfigurationException.html
Class
Exception
PUBLIC
Raised when the ORM is used before its wiring is complete.
-
orionis.orm.exceptions.ModelNotFoundException
orionis.orm.exceptions.ModelNotFoundException.html
Class
Exception
PUBLIC
Raised when a model lookup that must succeed finds no records.
-
orionis.orm.exceptions.MassAssignmentException
orionis.orm.exceptions.MassAssignmentException.html
Class
Exception
PUBLIC
Raised when a mass assignment violates the fillable/guarded rules.
-
orionis.orm.exceptions.InvalidQueryException
orionis.orm.exceptions.InvalidQueryException.html
Class
Exception
PUBLIC
Raised when a query builder call receives invalid arguments.
-
orionis.orm.exceptions.RelationNotFoundException
orionis.orm.exceptions.RelationNotFoundException.html
Class
Exception
PUBLIC
Raised when a relationship name cannot be resolved on a model.
-
orionis.orm.exceptions.ScopeNotFoundException
orionis.orm.exceptions.ScopeNotFoundException.html
Class
Exception
PUBLIC
Raised when a query scope name is not declared by the model.
-
orionis.orm.query.join_clause.JoinClause
orionis.orm.query.join_clause.JoinClause.html
Class
Class
PUBLIC
Accumulator of ON conditions for a join declared with a callback.
-
orionis.orm.query.join_clause.JoinClause.__slots__
orionis.orm.query.join_clause.JoinClause.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.orm.query.join_clause.JoinClause.__init__
orionis.orm.query.join_clause.JoinClause.html#__init__
Function
Method
PUBLIC
Initialize an empty set of ON conditions.
-
orionis.orm.query.join_clause.JoinClause._conditions
orionis.orm.query.join_clause.JoinClause.html#_conditions
Attribute
Instance Variable
PUBLIC
Predicates composing the join condition.
-
orionis.orm.query.join_clause.JoinClause.on
orionis.orm.query.join_clause.JoinClause.html#on
Function
Method
PUBLIC
Add an AND-combined column comparison to the ON clause.
-
orionis.orm.query.join_clause.JoinClause.orOn
orionis.orm.query.join_clause.JoinClause.html#orOn
Function
Method
PUBLIC
Add an OR-combined column comparison to the ON clause.
-
orionis.orm.query.join_clause.JoinClause.conditions
orionis.orm.query.join_clause.JoinClause.html#conditions
Function
Method
PUBLIC
Return the ON conditions collected so far.
-
orionis.orm.query.base_builder._WHERE_WITH_OPERATOR
orionis.orm.query.base_builder.html#_WHERE_WITH_OPERATOR
Attribute
Constant
PUBLIC
Number of arguments in the (operator, value) where form.
-
orionis.orm.query.base_builder._BETWEEN_BOUNDS
orionis.orm.query.base_builder.html#_BETWEEN_BOUNDS
Attribute
Constant
PUBLIC
Number of values required by a BETWEEN boundary pair.
-
orionis.orm.query.base_builder._DEFAULT_PER_PAGE
orionis.orm.query.base_builder.html#_DEFAULT_PER_PAGE
Attribute
Constant
PUBLIC
Default page size used by pagination.
-
orionis.orm.query.base_builder._DEFAULT_TIMESTAMP_COLUMN
orionis.orm.query.base_builder.html#_DEFAULT_TIMESTAMP_COLUMN
Attribute
Constant
PUBLIC
Column name assumed by latest()/oldest() without a declared timestamp.
-
orionis.orm.query.base_builder.QueryBuilderBase
orionis.orm.query.base_builder.QueryBuilderBase.html
Class
Class
PUBLIC
Engine shared by every Orionis query builder.
-
orionis.orm.query.base_builder.QueryBuilderBase.__slots__
orionis.orm.query.base_builder.QueryBuilderBase.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.orm.query.base_builder.QueryBuilderBase.__init__
orionis.orm.query.base_builder.QueryBuilderBase.html#__init__
Function
Method
PUBLIC
Initialize the builder with a plan for the supplied table.
-
orionis.orm.query.base_builder.QueryBuilderBase._connection_name
orionis.orm.query.base_builder.QueryBuilderBase.html#_connection_name
Attribute
Instance Variable
PUBLIC
Name of the configured database connection to use.
-
orionis.orm.query.base_builder.QueryBuilderBase._connection_manager
orionis.orm.query.base_builder.QueryBuilderBase.html#_connection_manager
Attribute
Instance Variable
PUBLIC
Gateway manager retained independently of the process-wide resolver.
-
orionis.orm.query.base_builder.QueryBuilderBase._resolved_connection
orionis.orm.query.base_builder.QueryBuilderBase.html#_resolved_connection
Attribute
Instance Variable
PUBLIC
Exact migration checkout retained until explicitly retargeted.
-
orionis.orm.query.base_builder.QueryBuilderBase._plan
orionis.orm.query.base_builder.QueryBuilderBase.html#_plan
Attribute
Instance Variable
PUBLIC
Plan produced by SelectPlan.
-
orionis.orm.query.base_builder.QueryBuilderBase.toPlan
orionis.orm.query.base_builder.QueryBuilderBase.html#toPlan
Function
Method
PUBLIC
Return the engine-agnostic plan assembled so far.
-
orionis.orm.query.base_builder.QueryBuilderBase.toSql
orionis.orm.query.base_builder.QueryBuilderBase.html#toSql
Function
Method
PUBLIC
Render the current SELECT query without executing or mutating it.
-
orionis.orm.query.base_builder.QueryBuilderBase.clone
orionis.orm.query.base_builder.QueryBuilderBase.html#clone
Function
Method
PUBLIC
Return an independent copy of this builder.
-
orionis.orm.query.base_builder.QueryBuilderBase.adoptPlan
orionis.orm.query.base_builder.QueryBuilderBase.html#adoptPlan
Function
Method
PUBLIC
Replace the plan this builder assembles.
-
orionis.orm.query.base_builder.QueryBuilderBase._shallowCopy
orionis.orm.query.base_builder.QueryBuilderBase.html#_shallowCopy
Function
Method
PUBLIC
Build a twin of this builder still sharing its plan.
-
orionis.orm.query.base_builder.QueryBuilderBase.adoptConnection
orionis.orm.query.base_builder.QueryBuilderBase.html#adoptConnection
Function
Method
PUBLIC
Bind the builder to a named connection.
-
orionis.orm.query.base_builder.QueryBuilderBase._bindConnectionManager
orionis.orm.query.base_builder.QueryBuilderBase.html#_bindConnectionManager
Function
Method
PUBLIC
Retain the gateway owner and an optional exact migration connection.
-
orionis.orm.query.base_builder.QueryBuilderBase._connection
orionis.orm.query.base_builder.QueryBuilderBase.html#_connection
Function
Method
PUBLIC
Resolve the database connection this builder runs against.
-
orionis.orm.query.base_builder.QueryBuilderBase._newQuery
orionis.orm.query.base_builder.QueryBuilderBase.html#_newQuery
Function
Method
PUBLIC
Create a sibling builder used for nested groups and subqueries.
-
orionis.orm.query.base_builder.QueryBuilderBase._serializeValues
orionis.orm.query.base_builder.QueryBuilderBase.html#_serializeValues
Function
Method
PUBLIC
Prepare a value mapping for storage.
-
orionis.orm.query.base_builder.QueryBuilderBase._prepareUpdate
orionis.orm.query.base_builder.QueryBuilderBase.html#_prepareUpdate
Function
Method
PUBLIC
Adjust an update payload before it is serialized.
-
orionis.orm.query.base_builder.QueryBuilderBase._existsColumns
orionis.orm.query.base_builder.QueryBuilderBase.html#_existsColumns
Function
Method
PUBLIC
Return the projection used by existence probes.
-
orionis.orm.query.base_builder.QueryBuilderBase._defaultTimestampColumn
orionis.orm.query.base_builder.QueryBuilderBase.html#_defaultTimestampColumn
Function
Method
PUBLIC
Return the default timestamp column.
-
orionis.orm.query.base_builder.QueryBuilderBase._beforeExecute
orionis.orm.query.base_builder.QueryBuilderBase.html#_beforeExecute
Function
Method
PUBLIC
Finalize the plan right before a terminal runs it.
-
orionis.orm.query.base_builder.QueryBuilderBase.select
orionis.orm.query.base_builder.QueryBuilderBase.html#select
Function
Method
PUBLIC
Restrict the query projection to the given columns.
-
orionis.orm.query.base_builder.QueryBuilderBase.addSelect
orionis.orm.query.base_builder.QueryBuilderBase.html#addSelect
Function
Method
PUBLIC
Append columns to the current projection.
-
orionis.orm.query.base_builder.QueryBuilderBase.selectRaw
orionis.orm.query.base_builder.QueryBuilderBase.html#selectRaw
Function
Method
PUBLIC
Append a raw SQL fragment to the projection.
-
orionis.orm.query.base_builder.QueryBuilderBase.selectSub
orionis.orm.query.base_builder.QueryBuilderBase.html#selectSub
Function
Method
PUBLIC
Append a scalar subquery to the projection under an alias.
-
orionis.orm.query.base_builder.QueryBuilderBase.distinct
orionis.orm.query.base_builder.QueryBuilderBase.html#distinct
Function
Method
PUBLIC
Collapse duplicate rows from the query results.
-
orionis.orm.query.base_builder.QueryBuilderBase.where
orionis.orm.query.base_builder.QueryBuilderBase.html#where
Function
Method
PUBLIC
Add an AND-combined filtering condition.
-
orionis.orm.query.base_builder.QueryBuilderBase.orWhere
orionis.orm.query.base_builder.QueryBuilderBase.html#orWhere
Function
Method
PUBLIC
Add an OR-combined filtering condition.
-
orionis.orm.query.base_builder.QueryBuilderBase.whereIn
orionis.orm.query.base_builder.QueryBuilderBase.html#whereIn
Function
Method
PUBLIC
Filter rows whose column value belongs to the given set.
-
orionis.orm.query.base_builder.QueryBuilderBase.orWhereIn
orionis.orm.query.base_builder.QueryBuilderBase.html#orWhereIn
Function
Method
PUBLIC
Add an OR-combined set-membership condition.
-
orionis.orm.query.base_builder.QueryBuilderBase.whereNotIn
orionis.orm.query.base_builder.QueryBuilderBase.html#whereNotIn
Function
Method
PUBLIC
Filter rows whose column value is outside the given set.
-
orionis.orm.query.base_builder.QueryBuilderBase.orWhereNotIn
orionis.orm.query.base_builder.QueryBuilderBase.html#orWhereNotIn
Function
Method
PUBLIC
Add an OR-combined set-exclusion condition.
-
orionis.orm.query.base_builder.QueryBuilderBase.whereNull
orionis.orm.query.base_builder.QueryBuilderBase.html#whereNull
Function
Method
PUBLIC
Filter rows whose column value is NULL.
-
orionis.orm.query.base_builder.QueryBuilderBase.orWhereNull
orionis.orm.query.base_builder.QueryBuilderBase.html#orWhereNull
Function
Method
PUBLIC
Add an OR-combined IS NULL condition.
-
orionis.orm.query.base_builder.QueryBuilderBase.whereNotNull
orionis.orm.query.base_builder.QueryBuilderBase.html#whereNotNull
Function
Method
PUBLIC
Filter rows whose column value is not NULL.
-
orionis.orm.query.base_builder.QueryBuilderBase.orWhereNotNull
orionis.orm.query.base_builder.QueryBuilderBase.html#orWhereNotNull
Function
Method
PUBLIC
Add an OR-combined IS NOT NULL condition.
-
orionis.orm.query.base_builder.QueryBuilderBase.whereBetween
orionis.orm.query.base_builder.QueryBuilderBase.html#whereBetween
Function
Method
PUBLIC
Filter rows whose column value lies between two boundaries.
-
orionis.orm.query.base_builder.QueryBuilderBase.whereNotBetween
orionis.orm.query.base_builder.QueryBuilderBase.html#whereNotBetween
Function
Method
PUBLIC
Filter rows whose column value lies outside two boundaries.
-
orionis.orm.query.base_builder.QueryBuilderBase.whereLike
orionis.orm.query.base_builder.QueryBuilderBase.html#whereLike
Function
Method
PUBLIC
Filter rows whose column value matches an SQL LIKE pattern.
-
orionis.orm.query.base_builder.QueryBuilderBase.whereNotLike
orionis.orm.query.base_builder.QueryBuilderBase.html#whereNotLike
Function
Method
PUBLIC
Filter rows whose column value does not match an SQL LIKE pattern.
-
orionis.orm.query.base_builder.QueryBuilderBase.whereILike
orionis.orm.query.base_builder.QueryBuilderBase.html#whereILike
Function
Method
PUBLIC
Filter rows matching a case-insensitive SQL LIKE pattern.
-
orionis.orm.query.base_builder.QueryBuilderBase.whereNotILike
orionis.orm.query.base_builder.QueryBuilderBase.html#whereNotILike
Function
Method
PUBLIC
Filter rows not matching a case-insensitive SQL LIKE pattern.
-
orionis.orm.query.base_builder.QueryBuilderBase.whereStartsWith
orionis.orm.query.base_builder.QueryBuilderBase.html#whereStartsWith
Function
Method
PUBLIC
Filter rows whose column value starts with the given text.
-
orionis.orm.query.base_builder.QueryBuilderBase.whereEndsWith
orionis.orm.query.base_builder.QueryBuilderBase.html#whereEndsWith
Function
Method
PUBLIC
Filter rows whose column value ends with the given text.
-
orionis.orm.query.base_builder.QueryBuilderBase.whereContains
orionis.orm.query.base_builder.QueryBuilderBase.html#whereContains
Function
Method
PUBLIC
Filter rows whose column value contains the given text.
-
orionis.orm.query.base_builder.QueryBuilderBase.whereRegexpMatch
orionis.orm.query.base_builder.QueryBuilderBase.html#whereRegexpMatch
Function
Method
PUBLIC
Filter rows whose column value matches a regular expression.
-
orionis.orm.query.base_builder.QueryBuilderBase.whereColumn
orionis.orm.query.base_builder.QueryBuilderBase.html#whereColumn
Function
Method
PUBLIC
Compare two columns of the query against each other.
-
orionis.orm.query.base_builder.QueryBuilderBase.orWhereColumn
orionis.orm.query.base_builder.QueryBuilderBase.html#orWhereColumn
Function
Method
PUBLIC
Add an OR-combined comparison between two columns.
-
orionis.orm.query.base_builder.QueryBuilderBase.whereRaw
orionis.orm.query.base_builder.QueryBuilderBase.html#whereRaw
Function
Method
PUBLIC
Add an AND-combined raw SQL condition.
-
orionis.orm.query.base_builder.QueryBuilderBase.orWhereRaw
orionis.orm.query.base_builder.QueryBuilderBase.html#orWhereRaw
Function
Method
PUBLIC
Add an OR-combined raw SQL condition.
-
orionis.orm.query.base_builder.QueryBuilderBase.whereExists
orionis.orm.query.base_builder.QueryBuilderBase.html#whereExists
Function
Method
PUBLIC
Keep rows for which a correlated subquery returns any row.
-
orionis.orm.query.base_builder.QueryBuilderBase.orWhereExists
orionis.orm.query.base_builder.QueryBuilderBase.html#orWhereExists
Function
Method
PUBLIC
Add an OR-combined EXISTS condition.
-
orionis.orm.query.base_builder.QueryBuilderBase.whereNotExists
orionis.orm.query.base_builder.QueryBuilderBase.html#whereNotExists
Function
Method
PUBLIC
Keep rows for which a correlated subquery returns no row.
-
orionis.orm.query.base_builder.QueryBuilderBase.orWhereNotExists
orionis.orm.query.base_builder.QueryBuilderBase.html#orWhereNotExists
Function
Method
PUBLIC
Add an OR-combined NOT EXISTS condition.
-
orionis.orm.query.base_builder.QueryBuilderBase.join
orionis.orm.query.base_builder.QueryBuilderBase.html#join
Function
Method
PUBLIC
Add an INNER JOIN to the query.
-
orionis.orm.query.base_builder.QueryBuilderBase.leftJoin
orionis.orm.query.base_builder.QueryBuilderBase.html#leftJoin
Function
Method
PUBLIC
Add a LEFT OUTER JOIN to the query.
-
orionis.orm.query.base_builder.QueryBuilderBase.rightJoin
orionis.orm.query.base_builder.QueryBuilderBase.html#rightJoin
Function
Method
PUBLIC
Add a RIGHT OUTER JOIN to the query.
-
orionis.orm.query.base_builder.QueryBuilderBase.fullJoin
orionis.orm.query.base_builder.QueryBuilderBase.html#fullJoin
Function
Method
PUBLIC
Add a FULL OUTER JOIN to the query.
-
orionis.orm.query.base_builder.QueryBuilderBase.crossJoin
orionis.orm.query.base_builder.QueryBuilderBase.html#crossJoin
Function
Method
PUBLIC
Add a CROSS JOIN to the query.
-
orionis.orm.query.base_builder.QueryBuilderBase.joinSub
orionis.orm.query.base_builder.QueryBuilderBase.html#joinSub
Function
Method
PUBLIC
Join a subquery as a derived table with an INNER JOIN.
-
orionis.orm.query.base_builder.QueryBuilderBase.leftJoinSub
orionis.orm.query.base_builder.QueryBuilderBase.html#leftJoinSub
Function
Method
PUBLIC
Join a subquery as a derived table with a LEFT OUTER JOIN.
-
orionis.orm.query.base_builder.QueryBuilderBase.rightJoinSub
orionis.orm.query.base_builder.QueryBuilderBase.html#rightJoinSub
Function
Method
PUBLIC
Join a subquery as a derived table with a RIGHT OUTER JOIN.
-
orionis.orm.query.base_builder.QueryBuilderBase.orderBy
orionis.orm.query.base_builder.QueryBuilderBase.html#orderBy
Function
Method
PUBLIC
Add an ordering rule to the query.
-
orionis.orm.query.base_builder.QueryBuilderBase.latest
orionis.orm.query.base_builder.QueryBuilderBase.html#latest
Function
Method
PUBLIC
Order the query by a timestamp column in descending order.
-
orionis.orm.query.base_builder.QueryBuilderBase.oldest
orionis.orm.query.base_builder.QueryBuilderBase.html#oldest
Function
Method
PUBLIC
Order the query by a timestamp column in ascending order.
-
orionis.orm.query.base_builder.QueryBuilderBase.groupBy
orionis.orm.query.base_builder.QueryBuilderBase.html#groupBy
Function
Method
PUBLIC
Add grouping columns to the query.
-
orionis.orm.query.base_builder.QueryBuilderBase.having
orionis.orm.query.base_builder.QueryBuilderBase.html#having
Function
Method
PUBLIC
Add a post-grouping condition to the query.
-
orionis.orm.query.base_builder.QueryBuilderBase.orHaving
orionis.orm.query.base_builder.QueryBuilderBase.html#orHaving
Function
Method
PUBLIC
Add an OR-combined post-grouping condition to the query.
-
orionis.orm.query.base_builder.QueryBuilderBase.havingRaw
orionis.orm.query.base_builder.QueryBuilderBase.html#havingRaw
Function
Method
PUBLIC
Add a raw SQL post-grouping condition.
-
orionis.orm.query.base_builder.QueryBuilderBase.limit
orionis.orm.query.base_builder.QueryBuilderBase.html#limit
Function
Method
PUBLIC
Limit the number of rows returned by the query.
-
orionis.orm.query.base_builder.QueryBuilderBase.offset
orionis.orm.query.base_builder.QueryBuilderBase.html#offset
Function
Method
PUBLIC
Skip the given number of rows before returning results.
-
orionis.orm.query.base_builder.QueryBuilderBase.take
orionis.orm.query.base_builder.QueryBuilderBase.html#take
Function
Method
PUBLIC
Limit the number of rows returned.
-
orionis.orm.query.base_builder.QueryBuilderBase.skip
orionis.orm.query.base_builder.QueryBuilderBase.html#skip
Function
Method
PUBLIC
Skip the given number of rows.
-
orionis.orm.query.base_builder.QueryBuilderBase.forPage
orionis.orm.query.base_builder.QueryBuilderBase.html#forPage
Function
Method
PUBLIC
Limit the query to a single page of results.
-
orionis.orm.query.base_builder.QueryBuilderBase.lockForUpdate
orionis.orm.query.base_builder.QueryBuilderBase.html#lockForUpdate
Function
Method
PUBLIC
Lock the selected rows against concurrent writes.
-
orionis.orm.query.base_builder.QueryBuilderBase.sharedLock
orionis.orm.query.base_builder.QueryBuilderBase.html#sharedLock
Function
Method
PUBLIC
Lock the selected rows in shared mode.
-
orionis.orm.query.base_builder.QueryBuilderBase.union
orionis.orm.query.base_builder.QueryBuilderBase.html#union
Function
Method
PUBLIC
Append another query's rows, collapsing duplicates.
-
orionis.orm.query.base_builder.QueryBuilderBase.unionAll
orionis.orm.query.base_builder.QueryBuilderBase.html#unionAll
Function
Method
PUBLIC
Append another query's rows, keeping duplicates.
-
orionis.orm.query.base_builder.QueryBuilderBase.count
orionis.orm.query.base_builder.QueryBuilderBase.html#count
Function
Method
PUBLIC
Count the rows matched by the query.
-
orionis.orm.query.base_builder.QueryBuilderBase.exists
orionis.orm.query.base_builder.QueryBuilderBase.html#exists
Function
Method
PUBLIC
Report whether the query matches at least one row.
-
orionis.orm.query.base_builder.QueryBuilderBase.doesntExist
orionis.orm.query.base_builder.QueryBuilderBase.html#doesntExist
Function
Method
PUBLIC
Report whether the query matches no rows.
-
orionis.orm.query.base_builder.QueryBuilderBase.max
orionis.orm.query.base_builder.QueryBuilderBase.html#max
Function
Method
PUBLIC
Return the maximum value of a column among matching rows.
-
orionis.orm.query.base_builder.QueryBuilderBase.min
orionis.orm.query.base_builder.QueryBuilderBase.html#min
Function
Method
PUBLIC
Return the minimum value of a column among matching rows.
-
orionis.orm.query.base_builder.QueryBuilderBase.avg
orionis.orm.query.base_builder.QueryBuilderBase.html#avg
Function
Method
PUBLIC
Return the average value of a column among matching rows.
-
orionis.orm.query.base_builder.QueryBuilderBase.sum
orionis.orm.query.base_builder.QueryBuilderBase.html#sum
Function
Method
PUBLIC
Return the sum of a column among matching rows.
-
orionis.orm.query.base_builder.QueryBuilderBase.insert
orionis.orm.query.base_builder.QueryBuilderBase.html#insert
Function
Method
PUBLIC
Insert one or many rows into the target table.
-
orionis.orm.query.base_builder.QueryBuilderBase.chunks
orionis.orm.query.base_builder.QueryBuilderBase.html#chunks
Function
Method
PUBLIC
Read bounded result batches without changing the materializing get API.
-
orionis.orm.query.base_builder.QueryBuilderBase.update
orionis.orm.query.base_builder.QueryBuilderBase.html#update
Function
Method
PUBLIC
Mass update the rows matched by the query.
-
orionis.orm.query.base_builder.QueryBuilderBase.delete
orionis.orm.query.base_builder.QueryBuilderBase.html#delete
Function
Method
PUBLIC
Delete the rows matched by the query.
-
orionis.orm.query.base_builder.QueryBuilderBase._paginator
orionis.orm.query.base_builder.QueryBuilderBase.html#_paginator
Function
Method
PUBLIC
Wrap a page of results together with its pagination metadata.
-
orionis.orm.query.base_builder.QueryBuilderBase._aggregate
orionis.orm.query.base_builder.QueryBuilderBase.html#_aggregate
Function
Method
PUBLIC
Execute an aggregate projection over the current plan.
-
orionis.orm.query.base_builder.QueryBuilderBase._resolvePlan
orionis.orm.query.base_builder.QueryBuilderBase.html#_resolvePlan
Function
Method
PUBLIC
Normalize a subquery argument into a select plan.
-
orionis.orm.query.base_builder.QueryBuilderBase._resolveJoinTable
orionis.orm.query.base_builder.QueryBuilderBase.html#_resolveJoinTable
Function
Static Method
PUBLIC
-
orionis.orm.query.base_builder.QueryBuilderBase._addJoin
orionis.orm.query.base_builder.QueryBuilderBase.html#_addJoin
Function
Method
PUBLIC
Append a join expression built from either calling convention.
-
orionis.orm.query.base_builder.QueryBuilderBase._addTyped
orionis.orm.query.base_builder.QueryBuilderBase.html#_addTyped
Function
Method
PUBLIC
Append a single-column condition of the given kind.
-
orionis.orm.query.base_builder.QueryBuilderBase._addMembership
orionis.orm.query.base_builder.QueryBuilderBase.html#_addMembership
Function
Method
PUBLIC
Append a set-membership condition backed by values or a subquery.
-
orionis.orm.query.base_builder.QueryBuilderBase._addColumnComparison
orionis.orm.query.base_builder.QueryBuilderBase.html#_addColumnComparison
Function
Method
PUBLIC
Append a comparison between two columns of the query.
-
orionis.orm.query.base_builder.QueryBuilderBase._addRaw
orionis.orm.query.base_builder.QueryBuilderBase.html#_addRaw
Function
Method
PUBLIC
Append a raw SQL condition to a clause list.
-
orionis.orm.query.base_builder.QueryBuilderBase._addExists
orionis.orm.query.base_builder.QueryBuilderBase.html#_addExists
Function
Method
PUBLIC
Append an EXISTS or NOT EXISTS condition.
-
orionis.orm.query.base_builder.QueryBuilderBase._addWhere
orionis.orm.query.base_builder.QueryBuilderBase.html#_addWhere
Function
Method
PUBLIC
Parse and append a condition to a clause list.
-
orionis.orm.query.base_builder.QueryBuilderBase._nestedClauses
orionis.orm.query.base_builder.QueryBuilderBase.html#_nestedClauses
Function
Method
PUBLIC
Run a grouping callback and collect the conditions it declared.
-
orionis.orm.query.base_builder.QueryBuilderBase._normalizeOperator
orionis.orm.query.base_builder.QueryBuilderBase.html#_normalizeOperator
Function
Static Method
PUBLIC
Validate and normalize a comparison operator.
-
orionis.orm.query.base_builder.QueryBuilderBase._boundaryPair
orionis.orm.query.base_builder.QueryBuilderBase.html#_boundaryPair
Function
Static Method
PUBLIC
Validate that a range condition carries exactly two boundaries.
-
orionis.orm.query.base_builder.QueryBuilderBase._materializeValues
orionis.orm.query.base_builder.QueryBuilderBase.html#_materializeValues
Function
Static Method
PUBLIC
Materialize an iterable of bound values into a tuple.
-
orionis.auth.tokens.repository._DEFAULT_TABLE
orionis.auth.tokens.repository.html#_DEFAULT_TABLE
Attribute
Constant
PUBLIC
Fallbacks applied when the configuration section is absent.
-
orionis.auth.tokens.repository._DEFAULT_SECRET_BYTES
orionis.auth.tokens.repository.html#_DEFAULT_SECRET_BYTES
Attribute
Constant
PUBLIC
Default secret bytes value used by repository.
-
orionis.auth.tokens.repository._MAX_TOKEN_LENGTH
orionis.auth.tokens.repository.html#_MAX_TOKEN_LENGTH
Attribute
Constant
PUBLIC
Max token length value used by repository.
-
orionis.auth.tokens.repository._MAX_NAME_LENGTH
orionis.auth.tokens.repository.html#_MAX_NAME_LENGTH
Attribute
Constant
PUBLIC
Max name length value used by repository.
-
orionis.auth.tokens.repository._MAX_ABILITIES
orionis.auth.tokens.repository.html#_MAX_ABILITIES
Attribute
Constant
PUBLIC
Max abilities value used by repository.
-
orionis.auth.tokens.repository._TOKEN_COLUMN
orionis.auth.tokens.repository.html#_TOKEN_COLUMN
Attribute
Constant
PUBLIC
Column holding the digest of the presented secret.
-
orionis.auth.tokens.repository._utc_now
orionis.auth.tokens.repository.html#_utc_now
Function
Function
PUBLIC
Return the current UTC moment as a naive datetime.
-
orionis.auth.tokens.repository._as_datetime
orionis.auth.tokens.repository.html#_as_datetime
Function
Function
PUBLIC
Coerce a stored timestamp into a datetime.
-
orionis.auth.tokens.repository._unexpired_tokens
orionis.auth.tokens.repository.html#_unexpired_tokens
Function
Function
PUBLIC
Group the nullable expiration constraint for token use.
-
orionis.auth.tokens.repository._is_expired
orionis.auth.tokens.repository.html#_is_expired
Function
Function
PUBLIC
Report whether an expiration moment already elapsed.
-
orionis.auth.tokens.repository._encode_abilities
orionis.auth.tokens.repository.html#_encode_abilities
Function
Function
PUBLIC
Serialise the abilities of a token for storage.
-
orionis.auth.tokens.repository._decode_abilities
orionis.auth.tokens.repository.html#_decode_abilities
Function
Function
PUBLIC
Deserialise the abilities stored for a token.
-
orionis.auth.tokens.repository._normalize_abilities
orionis.auth.tokens.repository.html#_normalize_abilities
Function
Function
PUBLIC
Validate credential restrictions without coercing malformed values.
-
orionis.auth.passwords.broker._StalePassword
orionis.auth.passwords.broker._StalePassword.html
Class
Exception
PUBLIC
Roll back consumption if the identity changed during reset.
-
orionis.auth.passwords.broker.PasswordBroker
orionis.auth.passwords.broker.PasswordBroker.html
Class
Class
PUBLIC
Issue hashed credentials and consume them with the password atomically.
-
orionis.auth.passwords.broker.PasswordBroker.__init__
orionis.auth.passwords.broker.PasswordBroker.html#__init__
Function
Method
PUBLIC
Initialize the broker with the configured identity and services.
-
orionis.auth.passwords.broker.PasswordBroker.settings
orionis.auth.passwords.broker.PasswordBroker.html#settings
Attribute
Instance Variable
PUBLIC
Resolve the configured identity once for this broker.
-
orionis.auth.passwords.broker.PasswordBroker.model
orionis.auth.passwords.broker.PasswordBroker.html#model
Attribute
Instance Variable
PUBLIC
Model selected for generation or persistence.
-
orionis.auth.passwords.broker.PasswordBroker.db
orionis.auth.passwords.broker.PasswordBroker.html#db
Attribute
Instance Variable
PUBLIC
Query builder used to access the reset table.
-
orionis.auth.passwords.broker.PasswordBroker.hashing
orionis.auth.passwords.broker.PasswordBroker.html#hashing
Attribute
Instance Variable
PUBLIC
Password hasher used to fingerprint and replace passwords.
-
orionis.auth.passwords.broker.PasswordBroker.tokens
orionis.auth.passwords.broker.PasswordBroker.html#tokens
Attribute
Instance Variable
PUBLIC
Tokens produced by AccessTokenRepository.
-
orionis.auth.passwords.broker.PasswordBroker._records
orionis.auth.passwords.broker.PasswordBroker.html#_records
Function
Method
PUBLIC
Build a query for the account's password-reset record.
-
orionis.auth.passwords.broker.PasswordBroker._query
orionis.auth.passwords.broker.PasswordBroker.html#_query
Function
Method
PUBLIC
Build an identity query on the reset store's exact connection.
-
orionis.auth.passwords.broker.PasswordBroker._creationConflict
orionis.auth.passwords.broker.PasswordBroker.html#_creationConflict
Function
Method
PUBLIC
Check an insert conflict without replacing its original failure.
-
orionis.auth.passwords.broker.PasswordBroker.issue
orionis.auth.passwords.broker.PasswordBroker.html#issue
Function
Method
PUBLIC
Issue a reset token when the account's cooldown has elapsed.
-
orionis.auth.passwords.broker.PasswordBroker._resolve
orionis.auth.passwords.broker.PasswordBroker.html#_resolve
Function
Method
PUBLIC
Resolve a current reset token to its identity.
-
orionis.auth.passwords.broker.PasswordBroker.valid
orionis.auth.passwords.broker.PasswordBroker.html#valid
Function
Method
PUBLIC
Validate a reset link without consuming its token.
-
orionis.auth.passwords.broker.PasswordBroker.reset
orionis.auth.passwords.broker.PasswordBroker.html#reset
Function
Method
PUBLIC
Consume a reset token and atomically replace the password.
-
orionis.auth.passwords.schema.build_password_reset_table
orionis.auth.passwords.schema.html#build_password_reset_table
Function
Function
PUBLIC
Build the schema consumed by the password-reset broker.
-
orionis.auth.provider.AuthProvider
orionis.auth.provider.AuthProvider.html
Class
Class
PUBLIC
Service provider wiring the authentication module.
-
orionis.auth.provider.AuthProvider.register
orionis.auth.provider.AuthProvider.html#register
Function
Method
PUBLIC
Bind stateless services and the request-scoped authentication context.
-
orionis.auth.provider.AuthProvider.boot
orionis.auth.provider.AuthProvider.html#boot
Function
Method
PUBLIC
Pin the Auth facade once every service is registered.
-
orionis.auth.tokens.generate_token_secret
orionis.auth.tokens.html#generate_token_secret
Function
Function
PUBLIC
Generate the plain text secret of a personal access token.
-
orionis.auth.tokens.hash_token_secret
orionis.auth.tokens.html#hash_token_secret
Function
Function
PUBLIC
Derive the value persisted for a personal access token.
-
orionis.auth.tokens.AccessTokenRepository
orionis.auth.tokens.AccessTokenRepository.html
Class
Class
PUBLIC
Persist personal access tokens through the Orionis query builder.
-
orionis.auth.tokens.AccessTokenRepository.__slots__
orionis.auth.tokens.AccessTokenRepository.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.auth.tokens.AccessTokenRepository.__init__
orionis.auth.tokens.AccessTokenRepository.html#__init__
Function
Method
PUBLIC
Initialise the repository from the token configuration.
-
orionis.auth.tokens.AccessTokenRepository.__db
orionis.auth.tokens.AccessTokenRepository.html#__db
Attribute
Instance Variable
PUBLIC
Gateway used to build queries over the token table.
-
orionis.auth.tokens.AccessTokenRepository.__table
orionis.auth.tokens.AccessTokenRepository.html#__table
Attribute
Instance Variable
PUBLIC
Database table used to persist access-token records.
-
orionis.auth.tokens.AccessTokenRepository.__expiration
orionis.auth.tokens.AccessTokenRepository.html#__expiration
Attribute
Instance Variable
PUBLIC
Expiration produced by app.config.
-
orionis.auth.tokens.AccessTokenRepository.__secret_bytes
orionis.auth.tokens.AccessTokenRepository.html#__secret_bytes
Attribute
Instance Variable
PUBLIC
Encoded application secret used to protect token lookups.
-
orionis.auth.tokens.AccessTokenRepository.create
orionis.auth.tokens.AccessTokenRepository.html#create
Function
Method
PUBLIC
Issue a new personal access token for an identity.
-
orionis.auth.tokens.AccessTokenRepository.findByPlainText
orionis.auth.tokens.AccessTokenRepository.html#findByPlainText
Function
Method
PUBLIC
Resolve a token from the value presented by the client.
-
orionis.auth.tokens.AccessTokenRepository.findWithIdentity
orionis.auth.tokens.AccessTokenRepository.html#findWithIdentity
Function
Method
PUBLIC
Combine native ORM reads, or opt out for custom implementations.
-
orionis.auth.tokens.AccessTokenRepository._fromRow
orionis.auth.tokens.AccessTokenRepository.html#_fromRow
Function
Static Method
PUBLIC
Validate stored metadata equally for separate and combined reads.
-
orionis.auth.tokens.AccessTokenRepository.touch
orionis.auth.tokens.AccessTokenRepository.html#touch
Function
Method
PUBLIC
Confirm token validity and record its use atomically.
-
orionis.auth.tokens.AccessTokenRepository.revoke
orionis.auth.tokens.AccessTokenRepository.html#revoke
Function
Method
PUBLIC
Revoke a single token.
-
orionis.auth.tokens.AccessTokenRepository.revokeAll
orionis.auth.tokens.AccessTokenRepository.html#revokeAll
Function
Method
PUBLIC
Revoke every active token of an identity.
-
orionis.auth.tokens.AccessTokenRepository.purgeExpired
orionis.auth.tokens.AccessTokenRepository.html#purgeExpired
Function
Method
PUBLIC
Delete tokens that expired or were revoked.
-
orionis.auth.tokens._EXPORTS
orionis.auth.tokens.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.auth.tokens.__getattr__
orionis.auth.tokens.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.auth.tokens.__dir__
orionis.auth.tokens.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.database.threaded.worker._diagnostic_error
orionis.database.threaded.worker.html#_diagnostic_error
Function
Function
PUBLIC
Redact native SQL diagnostics before passing them to failure reporting.
-
orionis.database.threaded.worker._complete_cleanup
orionis.database.threaded.worker.html#_complete_cleanup
Function
Function
PUBLIC
Complete database cleanup without replacing an existing ordinary failure.
-
orionis.database.threaded.worker._rollback_or_invalidate
orionis.database.threaded.worker.html#_rollback_or_invalidate
Function
Function
PUBLIC
Discard a checkout when rollback fails before its release to the pool.
-
orionis.database.threaded.worker._wait_for_completion
orionis.database.threaded.worker.html#_wait_for_completion
Function
Function
PUBLIC
Drain a worker result while shielding only a successful completion notice.
-
orionis.database.threaded.worker.ThreadedWorker
orionis.database.threaded.worker.ThreadedWorker.html
Class
Class
PUBLIC
Serialize one checked-out DBAPI connection on one worker thread.
-
orionis.database.threaded.worker.ThreadedWorker.__slots__
orionis.database.threaded.worker.ThreadedWorker.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.database.threaded.worker.ThreadedWorker.__init__
orionis.database.threaded.worker.ThreadedWorker.html#__init__
Function
Method
PUBLIC
Prepare a worker without starting a thread or opening a connection.
-
orionis.database.threaded.worker.ThreadedWorker._closed
orionis.database.threaded.worker.ThreadedWorker.html#_closed
Attribute
Instance Variable
PUBLIC
Whether admission has closed, including while shutdown is pending.
-
orionis.database.threaded.worker.ThreadedWorker._close_task
orionis.database.threaded.worker.ThreadedWorker.html#_close_task
Attribute
Instance Variable
PUBLIC
Shared shutdown operation while owned work is being drained.
-
orionis.database.threaded.worker.ThreadedWorker._pending
orionis.database.threaded.worker.ThreadedWorker.html#_pending
Attribute
Instance Variable
PUBLIC
Completion notices including each operation's late-result cleanup.
-
orionis.database.threaded.worker.ThreadedWorker._executor
orionis.database.threaded.worker.ThreadedWorker.html#_executor
Attribute
Instance Variable
PUBLIC
Executor produced by ThreadPoolExecutor.
-
orionis.database.threaded.worker.ThreadedWorker.run
orionis.database.threaded.worker.ThreadedWorker.html#run
Function
Method
PUBLIC
Execute blocking work and settle it before propagating cancellation.
-
orionis.database.threaded.worker.ThreadedWorker.close
orionis.database.threaded.worker.ThreadedWorker.html#close
Function
Method
PUBLIC
Join this worker without blocking the event loop.
-
orionis.database.threaded.worker.ThreadedWorker._closedTask
orionis.database.threaded.worker.ThreadedWorker.html#_closedTask
Function
Method
PUBLIC
Release the completed coordinator and its copied execution context.
-
orionis.database.threaded.worker.ThreadedWorker._shutdown
orionis.database.threaded.worker.ThreadedWorker.html#_shutdown
Function
Method
PUBLIC
Drain logical operations before shutting down their reserved executor.
-
orionis.database.threaded.result.ThreadedResult
orionis.database.threaded.result.ThreadedResult.html
Class
Class
PUBLIC
Retain materialized Core results without exposing a live DBAPI cursor.
-
orionis.database.threaded.result.ThreadedResult.__slots__
orionis.database.threaded.result.ThreadedResult.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.database.threaded.result.ThreadedResult.__init__
orionis.database.threaded.result.ThreadedResult.html#__init__
Function
Method
PUBLIC
Buffer rows and generated-key metadata on the connection's worker.
-
orionis.database.threaded.result.ThreadedResult.rowcount
orionis.database.threaded.result.ThreadedResult.html#rowcount
Attribute
Instance Variable
PUBLIC
Rowcount obtained from result.rowcount.
-
orionis.database.threaded.result.ThreadedResult.inserted_primary_key
orionis.database.threaded.result.ThreadedResult.html#inserted_primary_key
Attribute
Instance Variable
PUBLIC
Primary-key values returned for the inserted row.
-
orionis.database.threaded.result.ThreadedResult._result
orionis.database.threaded.result.ThreadedResult.html#_result
Attribute
Instance Variable
PUBLIC
Buffered rows retained after the live cursor has been closed.
-
orionis.database.threaded.result.ThreadedResult.mappings
orionis.database.threaded.result.ThreadedResult.html#mappings
Function
Method
PUBLIC
Expose materialized rows without another driver call.
-
orionis.database.threaded.result.ThreadedResult.scalar
orionis.database.threaded.result.ThreadedResult.html#scalar
Function
Method
PUBLIC
Return the first column of the first materialized row.
-
orionis.database.threaded.transaction.ThreadedTransaction
orionis.database.threaded.transaction.ThreadedTransaction.html
Class
Class
PUBLIC
Settle a Core transaction on its connection's reserved worker.
-
orionis.database.threaded.transaction.ThreadedTransaction.__slots__
orionis.database.threaded.transaction.ThreadedTransaction.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.database.threaded.transaction.ThreadedTransaction.__init__
orionis.database.threaded.transaction.ThreadedTransaction.html#__init__
Function
Method
PUBLIC
Retain the Core transaction and its owning worker.
-
orionis.database.threaded.transaction.ThreadedTransaction._transaction
orionis.database.threaded.transaction.ThreadedTransaction.html#_transaction
Attribute
Instance Variable
PUBLIC
Open Core transaction.
-
orionis.database.threaded.transaction.ThreadedTransaction._worker
orionis.database.threaded.transaction.ThreadedTransaction.html#_worker
Attribute
Instance Variable
PUBLIC
Worker owning the associated DBAPI checkout.
-
orionis.database.threaded.transaction.ThreadedTransaction.commit
orionis.database.threaded.transaction.ThreadedTransaction.html#commit
Function
Method
PUBLIC
Commit before allowing the connection to return to the pool.
-
orionis.database.threaded.transaction.ThreadedTransaction.rollback
orionis.database.threaded.transaction.ThreadedTransaction.html#rollback
Function
Method
PUBLIC
Roll back before allowing the connection to return to the pool.
-
orionis.database.threaded.connection.ThreadedConnection
orionis.database.threaded.connection.ThreadedConnection.html
Class
Class
PUBLIC
Execute one Core checkout and buffer its results on a reserved thread.
-
orionis.database.threaded.connection.ThreadedConnection.__slots__
orionis.database.threaded.connection.ThreadedConnection.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.database.threaded.connection.ThreadedConnection.__init__
orionis.database.threaded.connection.ThreadedConnection.html#__init__
Function
Method
PUBLIC
Retain an open Core connection and the worker that opened it.
-
orionis.database.threaded.connection.ThreadedConnection._connection
orionis.database.threaded.connection.ThreadedConnection.html#_connection
Attribute
Instance Variable
PUBLIC
Open blocking Core connection.
-
orionis.database.threaded.connection.ThreadedConnection._worker
orionis.database.threaded.connection.ThreadedConnection.html#_worker
Attribute
Instance Variable
PUBLIC
Worker reserved for this checkout.
-
orionis.database.threaded.connection.ThreadedConnection._closed
orionis.database.threaded.connection.ThreadedConnection.html#_closed
Attribute
Instance Variable
PUBLIC
Whether checkout release has started or already completed.
-
orionis.database.threaded.connection.ThreadedConnection._close_task
orionis.database.threaded.connection.ThreadedConnection.html#_close_task
Attribute
Instance Variable
PUBLIC
Shared checkout release coordinator while cleanup remains pending.
-
orionis.database.threaded.connection.ThreadedConnection.open
orionis.database.threaded.connection.ThreadedConnection.html#open
Function
Class Method
PUBLIC
Open a checkout and release late resources if the caller is cancelled.
-
orionis.database.threaded.connection.ThreadedConnection.begin
orionis.database.threaded.connection.ThreadedConnection.html#begin
Function
Method
PUBLIC
Begin a root transaction on the reserved worker.
-
orionis.database.threaded.connection.ThreadedConnection.execute
orionis.database.threaded.connection.ThreadedConnection.html#execute
Function
Method
PUBLIC
Execute and materialize a statement entirely outside the event loop.
-
orionis.database.threaded.connection.ThreadedConnection._execute
orionis.database.threaded.connection.ThreadedConnection.html#_execute
Function
Method
PUBLIC
Consume the live cursor before the worker completes its operation.
-
orionis.database.threaded.connection.ThreadedConnection.runSync
orionis.database.threaded.connection.ThreadedConnection.html#runSync
Function
Method
PUBLIC
Execute a Core schema callback on the connection's reserved worker.
-
orionis.database.threaded.connection.ThreadedConnection.close
orionis.database.threaded.connection.ThreadedConnection.html#close
Function
Method
PUBLIC
Return the checkout and join its worker, including during cancellation.
-
orionis.database.threaded.connection.ThreadedConnection._closedTask
orionis.database.threaded.connection.ThreadedConnection.html#_closedTask
Function
Method
PUBLIC
Release the completed coordinator and its copied execution context.
-
orionis.database.threaded.connection.ThreadedConnection._release
orionis.database.threaded.connection.ThreadedConnection.html#_release
Function
Method
PUBLIC
Return the native checkout before joining its reserved worker.
-
orionis.database.threaded.connection.ThreadedConnection.invalidate
orionis.database.threaded.connection.ThreadedConnection.html#invalidate
Function
Method
PUBLIC
Discard a connection whose transaction could not be settled.
-
orionis.database.threaded.engine.ThreadedEngine
orionis.database.threaded.engine.ThreadedEngine.html
Class
Class
PUBLIC
Expose asynchronous checkouts without claiming a blocking driver is async.
-
orionis.database.threaded.engine.ThreadedEngine.__slots__
orionis.database.threaded.engine.ThreadedEngine.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.database.threaded.engine.ThreadedEngine.__init__
orionis.database.threaded.engine.ThreadedEngine.html#__init__
Function
Method
PUBLIC
Retain a lazy blocking engine without opening any connections.
-
orionis.database.threaded.engine.ThreadedEngine.sync_engine
orionis.database.threaded.engine.ThreadedEngine.html#sync_engine
Attribute
Instance Variable
PUBLIC
Blocking Core engine backed by the official connector dialect.
-
orionis.database.threaded.engine.ThreadedEngine._name
orionis.database.threaded.engine.ThreadedEngine.html#_name
Attribute
Instance Variable
PUBLIC
Connection name used in sanitized opening errors.
-
orionis.database.threaded.engine.ThreadedEngine.connect
orionis.database.threaded.engine.ThreadedEngine.html#connect
Function
Method
PUBLIC
Open one checkout without blocking the event loop.
-
orionis.database.threaded.engine.ThreadedEngine.begin
orionis.database.threaded.engine.ThreadedEngine.html#begin
Function
Method
PUBLIC
Own a checkout and commit or roll back before returning it to the pool.
-
orionis.database.threaded.engine.ThreadedEngine.dispose
orionis.database.threaded.engine.ThreadedEngine.html#dispose
Function
Method
PUBLIC
Close idle pooled connections outside the event loop.
-
orionis.database.dialect._ASYNC_DIALECTS
orionis.database.dialect.html#_ASYNC_DIALECTS
Attribute
Constant
PUBLIC
Map of Orionis driver names to SQLAlchemy async dialect names.
-
orionis.database.dialect._ASYNC_DRIVER_PACKAGES
orionis.database.dialect.html#_ASYNC_DRIVER_PACKAGES
Attribute
Constant
PUBLIC
Map of Orionis driver names to (driver package, install extra) hints.
-
orionis.database.dialect._SYNC_DIALECTS
orionis.database.dialect.html#_SYNC_DIALECTS
Attribute
Constant
PUBLIC
Map of Orionis driver names to SQLAlchemy dialects backed by a blocking (synchronous) DBAPI driver. Used to build engines for consumers that cannot use the async engine, such as APScheduler's scheduleTaskStore.
-
orionis.database.dialect._SYNC_DRIVER_PACKAGES
orionis.database.dialect.html#_SYNC_DRIVER_PACKAGES
Attribute
Constant
PUBLIC
Map of Orionis driver names to (driver package, install extra) hints for the synchronous DBAPI drivers above. SQLite needs nothing extra (stdlib sqlite3); Oracle reuses the async package, which also works synchronously...
-
orionis.database.dialect._DEFAULT_ODBC_DRIVER
orionis.database.dialect.html#_DEFAULT_ODBC_DRIVER
Attribute
Constant
PUBLIC
Default ODBC driver used for SQL Server connections.
-
orionis.database.dialect._IDENTIFIER_PATTERN
orionis.database.dialect.html#_IDENTIFIER_PATTERN
Attribute
Constant
PUBLIC
Charset and collation identifiers accepted in session commands.
-
orionis.database.dialect._MYSQL_STRICT_MODE
orionis.database.dialect.html#_MYSQL_STRICT_MODE
Attribute
Constant
PUBLIC
MySQL strict sql_mode flags.
-
orionis.database.dialect._MYSQL_RELAXED_MODE
orionis.database.dialect.html#_MYSQL_RELAXED_MODE
Attribute
Constant
PUBLIC
MySQL relaxed sql_mode applied when strict mode is disabled.
-
orionis.database.dialect._SQLITE_MEMORY_MARKERS
orionis.database.dialect.html#_SQLITE_MEMORY_MARKERS
Attribute
Constant
PUBLIC
SQLite database markers that identify an in-memory database.
-
orionis.database.dialect._REDSHIFT_CONNECT_OPTIONS
orionis.database.dialect.html#_REDSHIFT_CONNECT_OPTIONS
Attribute
Constant
PUBLIC
Redshift connect options definitions used by dialect.
-
orionis.database.dialect._MySQLParameterEscaper
orionis.database.dialect._MySQLParameterEscaper.html
Class
Class
PUBLIC
Escape binary parameters independently of aiomysql's removed converter.
-
orionis.database.dialect._MySQLParameterEscaper.__slots__
orionis.database.dialect._MySQLParameterEscaper.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.database.dialect._MySQLParameterEscaper.__init__
orionis.database.dialect._MySQLParameterEscaper.html#__init__
Function
Method
PUBLIC
Retain the connection's existing nonbinary parameter conversion.
-
orionis.database.dialect._MySQLParameterEscaper._original
orionis.database.dialect._MySQLParameterEscaper.html#_original
Attribute
Instance Variable
PUBLIC
Original escape method owned by this connection.
-
orionis.database.dialect._MySQLParameterEscaper.__call__
orionis.database.dialect._MySQLParameterEscaper.html#__call__
Function
Method
PUBLIC
Convert binary values to charset-independent MySQL hex literals.
-
orionis.database.dialect._configure_mysql_binary_parameters
orionis.database.dialect.html#_configure_mysql_binary_parameters
Function
Function
PUBLIC
Install safe binary conversion on one adapted aiomysql connection.
-
orionis.database.dialect.resolve_driver
orionis.database.dialect.html#resolve_driver
Function
Function
PUBLIC
Extract and validate the driver name from a connection configuration.
-
orionis.database.dialect.missing_dependency_error
orionis.database.dialect.html#missing_dependency_error
Function
Function
PUBLIC
Build the exception raised when a DB driver package is absent.
-
orionis.database.dialect.build_engine_url
orionis.database.dialect.html#build_engine_url
Function
Function
PUBLIC
Build the engine URL for a connection configuration.
-
orionis.database.dialect.engine_options
orionis.database.dialect.html#engine_options
Function
Function
PUBLIC
Build keyword options for an engine factory.
-
orionis.database.dialect._pgsql_connect_args
orionis.database.dialect.html#_pgsql_connect_args
Function
Function
PUBLIC
Build asyncpg or libpq connect arguments for PostgreSQL.
-
orionis.database.dialect._pgsql_sync_connect_args
orionis.database.dialect.html#_pgsql_sync_connect_args
Function
Function
PUBLIC
Build libpq connection arguments with one escaped search-path option.
-
orionis.database.dialect.configure_engine
orionis.database.dialect.html#configure_engine
Function
Function
PUBLIC
Apply driver-specific session settings to a freshly built engine.
-
orionis.database.dialect._begin_sqlite_transaction
orionis.database.dialect.html#_begin_sqlite_transaction
Function
Function
PUBLIC
Start a SQLite transaction using the requested write reservation.
-
orionis.database.dialect._AsyncDBAPIClient
orionis.database.dialect._AsyncDBAPIClient.html
Class
Class
PUBLIC
Native async client whose close operation must settle after cancellation.
-
orionis.database.dialect._AsyncDBAPIClient.close
orionis.database.dialect._AsyncDBAPIClient.html#close
Function
Method
PUBLIC
Release the underlying native database handle.
-
orionis.database.dialect._AsyncNativeCreator
orionis.database.dialect._AsyncNativeCreator.html
Class
Class
PUBLIC
Collect a late native client before propagating caller cancellation.
-
orionis.database.dialect._AsyncNativeCreator.__slots__
orionis.database.dialect._AsyncNativeCreator.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.database.dialect._AsyncNativeCreator.__init__
orionis.database.dialect._AsyncNativeCreator.html#__init__
Function
Method
PUBLIC
Store the native database client factory.
-
orionis.database.dialect._AsyncNativeCreator._creator
orionis.database.dialect._AsyncNativeCreator.html#_creator
Attribute
Instance Variable
PUBLIC
Factory that asynchronously creates a native database client.
-
orionis.database.dialect._AsyncNativeCreator.__call__
orionis.database.dialect._AsyncNativeCreator.html#__call__
Function
Method
PUBLIC
Create a native client and collect it if cancellation arrives late.
-
orionis.database.dialect._configure_async_native_creation
orionis.database.dialect.html#_configure_async_native_creation
Function
Function
PUBLIC
Protect native client creation while keeping pool waiters cancellable.
-
orionis.database.dialect._session_statements
orionis.database.dialect.html#_session_statements
Function
Function
PUBLIC
Build the per-connection session statements for a configuration.
-
orionis.database.dialect._mysql_session_commands
orionis.database.dialect.html#_mysql_session_commands
Function
Function
PUBLIC
Build the MySQL session commands for a configuration.
-
orionis.database.dialect._sqlite_url
orionis.database.dialect.html#_sqlite_url
Function
Function
PUBLIC
Build the engine URL for a SQLite connection.
-
orionis.database.dialect._config_text
orionis.database.dialect.html#_config_text
Function
Function
PUBLIC
Extract a trimmed text value from a configuration mapping.
-
orionis.database.dialect._server_url
orionis.database.dialect.html#_server_url
Function
Function
PUBLIC
Build the engine URL for host-based drivers.
-
orionis.database.dialect._server_query
orionis.database.dialect.html#_server_query
Function
Function
PUBLIC
Build the URL query parameters for host-based drivers.
-
orionis.database.dialect._oracle_url
orionis.database.dialect.html#_oracle_url
Function
Function
PUBLIC
Build the engine URL for an Oracle connection.
-
orionis.database.dialect._oracle_query
orionis.database.dialect.html#_oracle_query
Function
Function
PUBLIC
Build the URL query parameters for an Oracle connection.
-
orionis.database.dialect._is_sqlite_memory
orionis.database.dialect.html#_is_sqlite_memory
Function
Function
PUBLIC
Report whether a SQLite configuration targets an in-memory database.
-
orionis.database.dialect._sqlite_pragmas
orionis.database.dialect.html#_sqlite_pragmas
Function
Function
PUBLIC
Build the PRAGMA statements for a SQLite configuration.
-
orionis.database.dialect._normalize_switch
orionis.database.dialect.html#_normalize_switch
Function
Function
PUBLIC
Normalize a boolean-like configuration value to ON or OFF.
-
orionis.database.dialect._yes_no
orionis.database.dialect.html#_yes_no
Function
Function
PUBLIC
Normalize a boolean-like configuration value to yes or no.
-
orionis.database.dialect._enum_value
orionis.database.dialect.html#_enum_value
Function
Function
PUBLIC
Extract the primitive value from a possible enum member.
-
orionis.database.compiler.SqlSource
orionis.database.compiler.html#SqlSource
Attribute
Type Alias
PUBLIC
either the raw engine Table or an aliased projection of it (Table.alias(name)).
-
orionis.database.compiler.SourceMap
orionis.database.compiler.html#SourceMap
Attribute
Type Alias
PUBLIC
Table sources reachable by qualified column references, keyed by alias when present or by logical table name otherwise.
-
orionis.database.compiler._COMPARATORS
orionis.database.compiler.html#_COMPARATORS
Attribute
Constant
PUBLIC
Comparison operators for basic where clauses.
-
orionis.database.compiler._EQUALITY_OPERATORS
orionis.database.compiler.html#_EQUALITY_OPERATORS
Attribute
Constant
PUBLIC
Operators whose NULL comparison must compile to IS / IS NOT.
-
orionis.database.compiler._INEQUALITY_OPERATORS
orionis.database.compiler.html#_INEQUALITY_OPERATORS
Attribute
Constant
PUBLIC
Inequality operators used by compiler.
-
orionis.database.compiler._PATTERN_OPERATORS
orionis.database.compiler.html#_PATTERN_OPERATORS
Attribute
Constant
PUBLIC
Pattern-matching operators accepted by basic where clauses.
-
orionis.database.compiler._BETWEEN_BOUNDS
orionis.database.compiler.html#_BETWEEN_BOUNDS
Attribute
Constant
PUBLIC
Number of boundaries required by a BETWEEN condition.
-
orionis.database.compiler._SIMPLE_CLAUSES
orionis.database.compiler.html#_SIMPLE_CLAUSES
Attribute
Constant
PUBLIC
Handlers for where clause kinds with a single-expression translation.
-
orionis.database.connection._NO_ACTIVE_TRANSACTION
orionis.database.connection.module.html#_NO_ACTIVE_TRANSACTION
Attribute
Constant
PUBLIC
Error message used when transaction control has no active transaction.
-
orionis.database.connection._text_statement
orionis.database.connection.module.html#_text_statement
Function
Function
PUBLIC
Parse and cache a SQL string as a reusable textual statement.
-
orionis.database.connection._TransactionState
orionis.database.connection._TransactionState.html
Class
Class
PUBLIC
Per-task stack of open transactions bound to one raw connection.
-
orionis.database.connection._TransactionState.__slots__
orionis.database.connection._TransactionState.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.database.connection._TransactionState.__init__
orionis.database.connection._TransactionState.html#__init__
Function
Method
PUBLIC
Bind a raw connection and root transaction to the current task.
-
orionis.database.connection._TransactionState.connection
orionis.database.connection._TransactionState.html#connection
Attribute
Instance Variable
PUBLIC
Open connection shared by all transaction levels.
-
orionis.database.connection._TransactionState.owner
orionis.database.connection._TransactionState.html#owner
Attribute
Instance Variable
PUBLIC
Owner produced by current_task.
-
orionis.database.connection._TransactionState.transactions
orionis.database.connection._TransactionState.html#transactions
Attribute
Instance Variable
PUBLIC
Transaction scopes currently associated with the connection context.
-
orionis.database.connection._TransactionState.__aenter__
orionis.database.connection._TransactionState.html#__aenter__
Function
Method
PUBLIC
Return the existing raw connection without acquiring another one.
-
orionis.database.connection._TransactionState.__aexit__
orionis.database.connection._TransactionState.html#__aexit__
Function
Method
PUBLIC
Leave transaction control and cleanup to the owning task.
-
orionis.orm.metaclass._CAMEL_BOUNDARY
orionis.orm.metaclass.html#_CAMEL_BOUNDARY
Attribute
Constant
PUBLIC
Pattern splitting CamelCase words for snake_case conversion.
-
orionis.orm.metaclass._ES_SUFFIXES
orionis.orm.metaclass.html#_ES_SUFFIXES
Attribute
Constant
PUBLIC
Suffixes that pluralize with "es".
-
orionis.orm.metaclass._VOWELS
orionis.orm.metaclass.html#_VOWELS
Attribute
Constant
PUBLIC
English vowels used by the pluralization heuristic.
-
orionis.orm.metaclass._GUARD_ALL
orionis.orm.metaclass.html#_GUARD_ALL
Attribute
Constant
PUBLIC
Wildcard marking every attribute as guarded.
-
orionis.orm.metaclass._ACCESSOR_PREFIX
orionis.orm.metaclass.html#_ACCESSOR_PREFIX
Attribute
Constant
PUBLIC
Prefixes and suffix identifying the accessor/mutator naming convention.
-
orionis.orm.metaclass._MUTATOR_PREFIX
orionis.orm.metaclass.html#_MUTATOR_PREFIX
Attribute
Constant
PUBLIC
set.
-
orionis.orm.metaclass._ACCESSOR_SUFFIX
orionis.orm.metaclass.html#_ACCESSOR_SUFFIX
Attribute
Constant
PUBLIC
Attribute.
-
orionis.orm.metaclass._SCOPE_PREFIX
orionis.orm.metaclass.html#_SCOPE_PREFIX
Attribute
Constant
PUBLIC
Prefix identifying a local query scope declared on a model.
-
orionis.orm.metaclass.MODEL_EVENTS
orionis.orm.metaclass.html#MODEL_EVENTS
Attribute
Constant
PUBLIC
Lifecycle events a model can dispatch.
-
orionis.orm.metaclass._FORWARDED_BUILDER_METHODS
orionis.orm.metaclass.html#_FORWARDED_BUILDER_METHODS
Attribute
Constant
PUBLIC
Builder entry points forwarded from the model class via the metaclass.
-
orionis.orm.metaclass.snake_case
orionis.orm.metaclass.html#snake_case
Function
Function
PUBLIC
Convert a CamelCase class name into snake_case.
-
orionis.orm.metaclass.pluralize
orionis.orm.metaclass.html#pluralize
Function
Function
PUBLIC
Pluralize an English word using conventional heuristics.
-
orionis.orm.metaclass.ModelMetadata
orionis.orm.metaclass.ModelMetadata.html
Class
Class
PUBLIC
Precomputed metadata describing a model class.
-
orionis.orm.metaclass.ModelMetadata.table_name
orionis.orm.metaclass.ModelMetadata.html#table_name
Attribute
Instance Variable
PUBLIC
Logical table name of the model.
-
orionis.orm.metaclass.ModelMetadata.table
orionis.orm.metaclass.ModelMetadata.html#table
Attribute
Instance Variable
PUBLIC
Table definition consumed by the SQL compiler.
-
orionis.orm.metaclass.ModelMetadata.columns
orionis.orm.metaclass.ModelMetadata.html#columns
Attribute
Instance Variable
PUBLIC
Column definitions keyed by attribute name.
-
orionis.orm.metaclass.ModelMetadata.primary_key
orionis.orm.metaclass.ModelMetadata.html#primary_key
Attribute
Instance Variable
PUBLIC
Name of the primary key column.
-
orionis.orm.metaclass.ModelMetadata.casts
orionis.orm.metaclass.ModelMetadata.html#casts
Attribute
Instance Variable
PUBLIC
Declared cast names keyed by attribute name.
-
orionis.orm.metaclass.ModelMetadata.cast_lookup
orionis.orm.metaclass.ModelMetadata.html#cast_lookup
Attribute
Instance Variable
PUBLIC
Precompiled cast handlers keyed by attribute name.
-
orionis.orm.metaclass.ModelMetadata.fillable
orionis.orm.metaclass.ModelMetadata.html#fillable
Attribute
Instance Variable
PUBLIC
Attributes allowed for mass assignment.
-
orionis.orm.metaclass.ModelMetadata.guarded
orionis.orm.metaclass.ModelMetadata.html#guarded
Attribute
Instance Variable
PUBLIC
Attributes blocked from mass assignment.
-
orionis.orm.metaclass.ModelMetadata.hidden
orionis.orm.metaclass.ModelMetadata.html#hidden
Attribute
Instance Variable
PUBLIC
Attributes omitted from serialization.
-
orionis.orm.metaclass.ModelMetadata.timestamps
orionis.orm.metaclass.ModelMetadata.html#timestamps
Attribute
Instance Variable
PUBLIC
Whether the model maintains creation/update timestamps.
-
orionis.orm.metaclass.ModelMetadata.incrementing
orionis.orm.metaclass.ModelMetadata.html#incrementing
Attribute
Instance Variable
PUBLIC
Whether the primary key is auto-incrementing.
-
orionis.orm.metaclass.ModelMetadata.connection
orionis.orm.metaclass.ModelMetadata.html#connection
Attribute
Instance Variable
PUBLIC
Named connection used by the model, or None for default.
-
orionis.orm.metaclass.ModelMetadata.created_column
orionis.orm.metaclass.ModelMetadata.html#created_column
Attribute
Instance Variable
PUBLIC
Creation timestamp column, when present.
-
orionis.orm.metaclass.ModelMetadata.updated_column
orionis.orm.metaclass.ModelMetadata.html#updated_column
Attribute
Instance Variable
PUBLIC
Update timestamp column, when present.
-
orionis.orm.metaclass.ModelMetadata.deleted_column
orionis.orm.metaclass.ModelMetadata.html#deleted_column
Attribute
Instance Variable
PUBLIC
Soft delete timestamp column, when the model soft deletes.
-
orionis.orm.metaclass.ModelMetadata.uses_unique_ids
orionis.orm.metaclass.ModelMetadata.html#uses_unique_ids
Attribute
Instance Variable
PUBLIC
Whether the primary key is a client-generated unique identifier.
-
orionis.orm.metaclass.ModelMetadata.accessors
orionis.orm.metaclass.ModelMetadata.html#accessors
Attribute
Instance Variable
PUBLIC
Accessor method names keyed by the attribute they expose.
-
orionis.orm.metaclass.ModelMetadata.mutators
orionis.orm.metaclass.ModelMetadata.html#mutators
Attribute
Instance Variable
PUBLIC
Mutator method names keyed by the attribute they transform.
-
orionis.orm.metaclass.ModelMetadata.appends
orionis.orm.metaclass.ModelMetadata.html#appends
Attribute
Instance Variable
PUBLIC
Accessor-backed attributes added to the serialized output.
-
orionis.orm.metaclass.ModelMetadata.scopes
orionis.orm.metaclass.ModelMetadata.html#scopes
Attribute
Instance Variable
PUBLIC
Local scope method names keyed by their fluent call name.
-
orionis.orm.metaclass.ModelMetadata.global_scopes
orionis.orm.metaclass.ModelMetadata.html#global_scopes
Attribute
Instance Variable
PUBLIC
Constraints applied to every query, keyed by scope name.
-
orionis.orm.metaclass.ModelMetadata.events
orionis.orm.metaclass.ModelMetadata.html#events
Attribute
Instance Variable
PUBLIC
Immutable (registration identity, listener) pairs keyed by event name.
-
orionis.orm.metaclass.ModelMetadata.isFillable
orionis.orm.metaclass.ModelMetadata.html#isFillable
Function
Method
PUBLIC
Report whether an attribute accepts mass assignment.
-
orionis.orm.metaclass.ModelMetadata.applyCasts
orionis.orm.metaclass.ModelMetadata.html#applyCasts
Function
Method
PUBLIC
Apply the declared casts to a raw attribute mapping in place.
-
orionis.orm.metaclass.ModelMeta
orionis.orm.metaclass.ModelMeta.html
Class
Class
PUBLIC
Metaclass discovering model columns and building their metadata.
-
orionis.orm.metaclass.ModelMeta.__new__
orionis.orm.metaclass.ModelMeta.html#__new__
Function
Method
PUBLIC
Create the model class and attach its metadata.
-
orionis.orm.metaclass.ModelMeta.__getattr__
orionis.orm.metaclass.ModelMeta.html#__getattr__
Function
Method
PUBLIC
Forward chainable builder entry points from the model class.
-
orionis.orm.metaclass.ModelMeta._resolveTable
orionis.orm.metaclass.ModelMeta.html#_resolveTable
Function
Static Method
PUBLIC
Resolve the shared table definition or inline model columns.
-
orionis.orm.metaclass.ModelMeta._resolveDeletedColumn
orionis.orm.metaclass.ModelMeta.html#_resolveDeletedColumn
Function
Static Method
PUBLIC
Resolve a nullable delete column without modifying a shared schema.
-
orionis.orm.metaclass.ModelMeta._collectPending
orionis.orm.metaclass.ModelMeta.html#_collectPending
Function
Static Method
PUBLIC
Collect and detach column declarations from an abstract class.
-
orionis.orm.metaclass.ModelMeta._collectColumns
orionis.orm.metaclass.ModelMeta.html#_collectColumns
Function
Static Method
PUBLIC
Collect column definitions from bases and the class namespace.
-
orionis.orm.metaclass.ModelMeta._resolveTableName
orionis.orm.metaclass.ModelMeta.html#_resolveTableName
Function
Static Method
PUBLIC
Resolve the table name from the declaration or the class name.
-
orionis.orm.metaclass.ModelMeta._resolvePrimaryKey
orionis.orm.metaclass.ModelMeta.html#_resolvePrimaryKey
Function
Static Method
PUBLIC
Resolve the primary key from declarations or column flags.
-
orionis.orm.metaclass.ModelMeta._collectCasts
orionis.orm.metaclass.ModelMeta.html#_collectCasts
Function
Static Method
PUBLIC
Merge cast declarations across the model hierarchy.
-
orionis.orm.metaclass.ModelMeta._behaviourEntry
orionis.orm.metaclass.ModelMeta.html#_behaviourEntry
Function
Static Method
PUBLIC
Classify a method name as an accessor, mutator, or local scope.
-
orionis.orm.metaclass.ModelMeta._collectBehaviours
orionis.orm.metaclass.ModelMeta.html#_collectBehaviours
Function
Static Method
PUBLIC
Discover accessors, mutators, and local scopes of a model.
-
orionis.orm.metaclass.ModelMeta._inheritGlobalScopes
orionis.orm.metaclass.ModelMeta.html#_inheritGlobalScopes
Function
Static Method
PUBLIC
Copy the global scopes declared by ancestor models.
-
orionis.orm.metaclass.ModelMeta._inheritEvents
orionis.orm.metaclass.ModelMeta.html#_inheritEvents
Function
Static Method
PUBLIC
Copy the lifecycle listeners declared by ancestor models.
-
orionis.orm.events._HALTABLE_EVENTS
orionis.orm.events.html#_HALTABLE_EVENTS
Attribute
Constant
PUBLIC
Events whose listeners can abort the operation by returning False.
-
orionis.orm.events.EventsMixin
orionis.orm.events.EventsMixin.html
Class
Class
PUBLIC
Lifecycle event behavior shared by every model.
-
orionis.orm.events.EventsMixin.__slots__
orionis.orm.events.EventsMixin.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.events.EventsMixin.registerEvent
orionis.orm.events.EventsMixin.html#registerEvent
Function
Class Method
PUBLIC
Register a listener for a model lifecycle event.
-
orionis.orm.events.EventsMixin.observe
orionis.orm.events.EventsMixin.html#observe
Function
Class Method
PUBLIC
Register every lifecycle method exposed by an observer.
-
orionis.orm.events.EventsMixin.flushEvents
orionis.orm.events.EventsMixin.html#flushEvents
Function
Class Method
PUBLIC
Remove registered listeners from the model.
-
orionis.orm.events.EventsMixin.fireEvent
orionis.orm.events.EventsMixin.html#fireEvent
Function
Method
PUBLIC
Dispatch a lifecycle event to its listeners.
-
orionis.orm.contracts.relation.IRelation
orionis.orm.contracts.relation.IRelation.html
Class
Class
PUBLIC
Contract for a query builder bound to a parent model instance.
-
orionis.orm.contracts.relation.IRelation.__slots__
orionis.orm.contracts.relation.IRelation.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.contracts.relation.IRelation.addConstraints
orionis.orm.contracts.relation.IRelation.html#addConstraints
Function
Method
PUBLIC
Constrain the query to the bound parent instance.
-
orionis.orm.contracts.relation.IRelation.addEagerConstraints
orionis.orm.contracts.relation.IRelation.html#addEagerConstraints
Function
Method
PUBLIC
Constrain the query to every parent instance of an eager batch.
-
orionis.orm.contracts.relation.IRelation.getResults
orionis.orm.contracts.relation.IRelation.html#getResults
Function
Method
PUBLIC
Execute the relationship query for its bound parent instance.
-
orionis.orm.contracts.relation.IRelation.getEager
orionis.orm.contracts.relation.IRelation.html#getEager
Function
Method
PUBLIC
Execute the relationship query assembled for eager loading.
-
orionis.orm.contracts.relation.IRelation.match
orionis.orm.contracts.relation.IRelation.html#match
Function
Method
PUBLIC
Group eager-loaded results and attach them to their parents.
-
orionis.orm.relations.relation._ConstraintScope
orionis.orm.relations.relation._ConstraintScope.html
Class
Class
PUBLIC
Limit inherited constraint suppression to its owner's active callback.
-
orionis.orm.relations.relation._ConstraintScope.__slots__
orionis.orm.relations.relation._ConstraintScope.html#__slots__
Attribute
Class Variable
PUBLIC
Reserve the active lifetime flag without a per-instance dictionary.
-
orionis.orm.relations.relation._ConstraintScope.__init__
orionis.orm.relations.relation._ConstraintScope.html#__init__
Function
Method
PUBLIC
Start an active suppression scope.
-
orionis.orm.relations.relation._ConstraintScope.active
orionis.orm.relations.relation._ConstraintScope.html#active
Attribute
Instance Variable
PUBLIC
Indicate whether the owning callback is still executing.
-
orionis.orm.relations.relation._CONSTRAINTS
orionis.orm.relations.relation.module.html#_CONSTRAINTS
Attribute
Constant
PUBLIC
Context-local scope whose lifetime also applies to inherited contexts.
-
orionis.orm.contracts.belongs_to_many_relation.IBelongsToManyRelation
orionis.orm.contracts.belongs_to_many_relation.IBelongsToManyRelation.html
Class
Class
PUBLIC
Contract for a many-to-many relationship backed by a pivot table.
-
orionis.orm.contracts.belongs_to_many_relation.IBelongsToManyRelation.__slots__
orionis.orm.contracts.belongs_to_many_relation.IBelongsToManyRelation.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.contracts.belongs_to_many_relation.IBelongsToManyRelation.getResults
orionis.orm.contracts.belongs_to_many_relation.IBelongsToManyRelation.html#getResults
Function
Method
PUBLIC
Retrieve every related model linked to the bound parent.
-
orionis.orm.contracts.belongs_to_many_relation.IBelongsToManyRelation.wherePivot
orionis.orm.contracts.belongs_to_many_relation.IBelongsToManyRelation.html#wherePivot
Function
Method
PUBLIC
Filter the pivot rows considered by this relationship query.
-
orionis.orm.contracts.belongs_to_many_relation.IBelongsToManyRelation.attach
orionis.orm.contracts.belongs_to_many_relation.IBelongsToManyRelation.html#attach
Function
Method
PUBLIC
Link the parent to the given related records via the pivot table.
-
orionis.orm.contracts.belongs_to_many_relation.IBelongsToManyRelation.detach
orionis.orm.contracts.belongs_to_many_relation.IBelongsToManyRelation.html#detach
Function
Method
PUBLIC
Unlink the parent from the given related records.
-
orionis.orm.contracts.belongs_to_many_relation.IBelongsToManyRelation.sync
orionis.orm.contracts.belongs_to_many_relation.IBelongsToManyRelation.html#sync
Function
Method
PUBLIC
Attach exactly the given records, detaching every other one.
-
orionis.orm.contracts.belongs_to_many_relation.IBelongsToManyRelation.toggle
orionis.orm.contracts.belongs_to_many_relation.IBelongsToManyRelation.html#toggle
Function
Method
PUBLIC
Attach ids not currently linked, detach ids that already are.
-
orionis.database.migrations.context._MigrationBinding
orionis.database.migrations.context._MigrationBinding.html
Class
Class
PUBLIC
Invalidate inherited connection selection when its owning scope ends.
-
orionis.database.migrations.context._MigrationBinding.connection
orionis.database.migrations.context._MigrationBinding.html#connection
Attribute
Class Variable
PUBLIC
Connection selected by the active migration or seeder.
-
orionis.database.migrations.context._MigrationBinding.active
orionis.database.migrations.context._MigrationBinding.html#active
Attribute
Class Variable
PUBLIC
Whether the owning scope is still running.
-
orionis.database.migrations.context._MIGRATION_CONNECTION
orionis.database.migrations.context.html#_MIGRATION_CONNECTION
Attribute
Constant
PUBLIC
Context-local migration connection isolated between asynchronous tasks.
-
orionis.database.migrations.context.current_migration_connection
orionis.database.migrations.context.html#current_migration_connection
Function
Function
PUBLIC
Return the connection selected by the current migration step.
-
orionis.database.migrations.context.migration_connection_scope
orionis.database.migrations.context.html#migration_connection_scope
Function
Function
PUBLIC
Bind unqualified migration operations to their tracking transaction.
-
orionis.orm.query.raw_builder._DEFAULT_PER_PAGE
orionis.orm.query.raw_builder.html#_DEFAULT_PER_PAGE
Attribute
Constant
PUBLIC
Default page size used by pagination.
-
orionis.orm.query.raw_builder.RawQueryBuilder
orionis.orm.query.raw_builder.RawQueryBuilder.html
Class
Class
PUBLIC
Fluent query builder over a plain table name.
-
orionis.orm.query.raw_builder.RawQueryBuilder.__slots__
orionis.orm.query.raw_builder.RawQueryBuilder.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.query.raw_builder.RawQueryBuilder.connection
orionis.orm.query.raw_builder.RawQueryBuilder.html#connection
Function
Method
PUBLIC
Change the connection this builder runs against.
-
orionis.orm.query.raw_builder.RawQueryBuilder.table
orionis.orm.query.raw_builder.RawQueryBuilder.html#table
Function
Method
PUBLIC
Change the table this builder queries against.
-
orionis.orm.query.raw_builder.RawQueryBuilder.get
orionis.orm.query.raw_builder.RawQueryBuilder.html#get
Function
Method
PUBLIC
Execute the query and return every matching row.
-
orionis.orm.query.raw_builder.RawQueryBuilder.first
orionis.orm.query.raw_builder.RawQueryBuilder.html#first
Function
Method
PUBLIC
Execute the query and return only the first matching row.
-
orionis.orm.query.raw_builder.RawQueryBuilder.value
orionis.orm.query.raw_builder.RawQueryBuilder.html#value
Function
Method
PUBLIC
Return a single column value of the first matching row.
-
orionis.orm.query.raw_builder.RawQueryBuilder.pluck
orionis.orm.query.raw_builder.RawQueryBuilder.html#pluck
Function
Method
PUBLIC
Return one column of every matching row.
-
orionis.orm.query.raw_builder.RawQueryBuilder.paginate
orionis.orm.query.raw_builder.RawQueryBuilder.html#paginate
Function
Method
PUBLIC
Execute the query returning a length-aware page of results.
-
orionis.orm.query.raw_builder.RawQueryBuilder._connection
orionis.orm.query.raw_builder.RawQueryBuilder.html#_connection
Function
Method
PUBLIC
Resolve the database connection this builder runs against.
-
orionis.orm.query.raw_builder.RawQueryBuilder._assertTarget
orionis.orm.query.raw_builder.RawQueryBuilder.html#_assertTarget
Function
Method
PUBLIC
Ensure a table was selected before executing the query.
-
orionis.orm.soft_deletes.SoftDeletesMixin
orionis.orm.soft_deletes.SoftDeletesMixin.html
Class
Class
PUBLIC
Soft delete behavior shared by every model.
-
orionis.orm.soft_deletes.SoftDeletesMixin.__slots__
orionis.orm.soft_deletes.SoftDeletesMixin.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.soft_deletes.SoftDeletesMixin.trashed
orionis.orm.soft_deletes.SoftDeletesMixin.html#trashed
Function
Method
PUBLIC
Report whether the instance is currently soft deleted.
-
orionis.orm.soft_deletes.SoftDeletesMixin.restore
orionis.orm.soft_deletes.SoftDeletesMixin.html#restore
Function
Method
PUBLIC
Bring a soft deleted row back by clearing its delete stamp.
-
orionis.orm.soft_deletes.SoftDeletesMixin.forceDelete
orionis.orm.soft_deletes.SoftDeletesMixin.html#forceDelete
Function
Method
PUBLIC
Delete the row permanently, ignoring soft deletes.
-
orionis.orm.soft_deletes.SoftDeletesMixin._performSoftDelete
orionis.orm.soft_deletes.SoftDeletesMixin.html#_performSoftDelete
Function
Method
PUBLIC
Stamp the soft delete column of the persisted row.
-
orionis.orm.state.StateMixin
orionis.orm.state.StateMixin.html
Class
Class
PUBLIC
Attribute state tracking behavior shared by every model.
-
orionis.orm.state.StateMixin.__slots__
orionis.orm.state.StateMixin.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.state.StateMixin.getDirty
orionis.orm.state.StateMixin.html#getDirty
Function
Method
PUBLIC
Return the attributes modified since the last sync.
-
orionis.orm.state.StateMixin.isDirty
orionis.orm.state.StateMixin.html#isDirty
Function
Method
PUBLIC
Report whether any attribute changed since the last sync.
-
orionis.orm.state.StateMixin.isClean
orionis.orm.state.StateMixin.html#isClean
Function
Method
PUBLIC
Report whether no attribute changed since the last sync.
-
orionis.orm.state.StateMixin.wasChanged
orionis.orm.state.StateMixin.html#wasChanged
Function
Method
PUBLIC
Report whether the last save operation changed any attribute.
-
orionis.orm.state.StateMixin.getChanges
orionis.orm.state.StateMixin.html#getChanges
Function
Method
PUBLIC
Return the attributes persisted by the last save operation.
-
orionis.orm.state.StateMixin.getOriginal
orionis.orm.state.StateMixin.html#getOriginal
Function
Method
PUBLIC
Return the original attribute snapshot or a single original value.
-
orionis.orm.state.StateMixin.syncOriginal
orionis.orm.state.StateMixin.html#syncOriginal
Function
Method
PUBLIC
Snapshot the current attributes as the new original state.
-
orionis.orm.model._INTERNAL_ATTRIBUTES
orionis.orm.model.module.html#_INTERNAL_ATTRIBUTES
Attribute
Constant
PUBLIC
Instance slots managed directly by the model machinery.
-
orionis.orm.Model
orionis.orm.Model.html
Class
Class
PUBLIC
Base class of the Orionis active-record models.
-
orionis.orm.Model.__abstract__
orionis.orm.Model.html#__abstract__
Attribute
Class Variable
PUBLIC
Abstract flag used by Model.
-
orionis.orm.Model.__slots__
orionis.orm.Model.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.orm.Model.table
orionis.orm.Model.html#table
Attribute
Class Variable
PUBLIC
Logical table name; derived from the class name when None.
-
orionis.orm.Model.table_definition
orionis.orm.Model.html#table_definition
Attribute
Class Variable
PUBLIC
Versioned table definition shared with schema migrations.
-
orionis.orm.Model.connection
orionis.orm.Model.html#connection
Attribute
Class Variable
PUBLIC
Named connection; the default connection is used when None.
-
orionis.orm.Model.fillable
orionis.orm.Model.html#fillable
Attribute
Class Variable
PUBLIC
Mass assignment whitelist; every column is fillable when empty.
-
orionis.orm.Model.guarded
orionis.orm.Model.html#guarded
Attribute
Class Variable
PUBLIC
Mass assignment blacklist; supports the "*" wildcard.
-
orionis.orm.Model.hidden
orionis.orm.Model.html#hidden
Attribute
Class Variable
PUBLIC
Attributes omitted from serialization.
-
orionis.orm.Model.casts
orionis.orm.Model.html#casts
Attribute
Class Variable
PUBLIC
Attribute casts applied on hydration and assignment.
-
orionis.orm.Model.primary_key
orionis.orm.Model.html#primary_key
Attribute
Class Variable
PUBLIC
Primary key name; discovered from column flags when None.
-
orionis.orm.Model.incrementing
orionis.orm.Model.html#incrementing
Attribute
Class Variable
PUBLIC
Whether the primary key is generated by the database.
-
orionis.orm.Model.timestamps
orionis.orm.Model.html#timestamps
Attribute
Class Variable
PUBLIC
Whether creation/update timestamps are maintained automatically.
-
orionis.orm.Model.soft_deletes
orionis.orm.Model.html#soft_deletes
Attribute
Class Variable
PUBLIC
Whether deletes stamp a column instead of removing the row.
-
orionis.orm.Model.uuids
orionis.orm.Model.html#uuids
Attribute
Class Variable
PUBLIC
Whether the primary key is a client-generated unique identifier.
-
orionis.orm.Model.appends
orionis.orm.Model.html#appends
Attribute
Class Variable
PUBLIC
Accessor-backed attributes added to the serialized output.
-
orionis.orm.Model.CREATED_AT
orionis.orm.Model.html#CREATED_AT
Attribute
Constant
PUBLIC
Timestamp column names, overridable per model.
-
orionis.orm.Model.UPDATED_AT
orionis.orm.Model.html#UPDATED_AT
Attribute
Constant
PUBLIC
updated_at.
-
orionis.orm.Model.DELETED_AT
orionis.orm.Model.html#DELETED_AT
Attribute
Constant
PUBLIC
deleted_at.
-
orionis.orm.Model.__meta__
orionis.orm.Model.html#__meta__
Attribute
Class Variable
PUBLIC
Metadata attached by the metaclass.
-
orionis.orm.Model.__init__
orionis.orm.Model.html#__init__
Function
Method
PUBLIC
Initialize a new, unsaved model instance.
-
orionis.orm.Model.__getattr__
orionis.orm.Model.html#__getattr__
Function
Method
PUBLIC
Serve column values and accessor-backed attributes.
-
orionis.orm.Model.__setattr__
orionis.orm.Model.html#__setattr__
Function
Method
PUBLIC
Route column assignments into the attribute store.
-
orionis.orm.Model.__repr__
orionis.orm.Model.html#__repr__
Function
Method
PUBLIC
Return a concise developer representation of the model.
-
orionis.orm.Model._newFromDatabase
orionis.orm.Model.html#_newFromDatabase
Function
Class Method
PUBLIC
Hydrate a model instance from a database row.
-
orionis.orm.Model.query
orionis.orm.Model.html#query
Function
Class Method
PUBLIC
Start a new query builder bound to this model.
-
orionis.orm.Model.getConnection
orionis.orm.Model.html#getConnection
Function
Class Method
PUBLIC
Resolve the connection configured for this model.
-
orionis.orm.Model.addGlobalScope
orionis.orm.Model.html#addGlobalScope
Function
Class Method
PUBLIC
Register a constraint applied to every query of this model.
-
orionis.orm.Model.removeGlobalScope
orionis.orm.Model.html#removeGlobalScope
Function
Class Method
PUBLIC
Unregister a previously added global scope.
-
orionis.orm.Model.all
orionis.orm.Model.html#all
Function
Class Method
PUBLIC
Retrieve every row of the model table.
-
orionis.orm.Model.find
orionis.orm.Model.html#find
Function
Class Method
PUBLIC
Retrieve a model by its primary key.
-
orionis.orm.Model.findOrFail
orionis.orm.Model.html#findOrFail
Function
Class Method
PUBLIC
Retrieve a model by primary key or raise when absent.
-
orionis.orm.Model.first
orionis.orm.Model.html#first
Function
Class Method
PUBLIC
Retrieve the first row of the model table.
-
orionis.orm.Model.firstOrFail
orionis.orm.Model.html#firstOrFail
Function
Class Method
PUBLIC
Retrieve the first row or raise when the table is empty.
-
orionis.orm.Model.create
orionis.orm.Model.html#create
Function
Class Method
PUBLIC
Create, persist, and return a new model.
-
orionis.orm.Model.destroy
orionis.orm.Model.html#destroy
Function
Class Method
PUBLIC
Delete the models matching the given primary keys.
-
orionis.orm.Model.save
orionis.orm.Model.html#save
Function
Method
PUBLIC
Persist the model, inserting or updating as appropriate.
-
orionis.orm.Model.update
orionis.orm.Model.html#update
Function
Method
PUBLIC
Mass assign the given attributes and persist the model.
-
orionis.orm.Model.delete
orionis.orm.Model.html#delete
Function
Method
PUBLIC
Delete the model row, honoring soft deletes when enabled.
-
orionis.orm.Model._performForceDelete
orionis.orm.Model.html#_performForceDelete
Function
Method
PUBLIC
Remove the persisted row permanently.
-
orionis.orm.Model._exists
orionis.orm.Model.html#_exists
Attribute
Instance Variable
PUBLIC
Exists flag used by Model.
-
orionis.orm.Model.freshTimestamp
orionis.orm.Model.html#freshTimestamp
Function
Class Method
PUBLIC
Produce the current timestamp for persistence operations.
-
orionis.orm.Model.newUniqueId
orionis.orm.Model.html#newUniqueId
Function
Class Method
PUBLIC
Produce a client-generated primary key value.
-
orionis.orm.Model._persistenceConnection
orionis.orm.Model.html#_persistenceConnection
Function
Method
PUBLIC
Keep a hydrated row's writes on the connection that supplied it.
-
orionis.orm.Model._primaryKeyValue
orionis.orm.Model.html#_primaryKeyValue
Function
Method
PUBLIC
Return the primary key value identifying the stored row.
-
orionis.orm.Model._performInsert
orionis.orm.Model.html#_performInsert
Function
Method
PUBLIC
Insert the model attributes as a new row.
-
orionis.orm.Model._changes
orionis.orm.Model.html#_changes
Attribute
Instance Variable
PUBLIC
Changes produced by deepcopy.
-
orionis.orm.Model._performUpdate
orionis.orm.Model.html#_performUpdate
Function
Method
PUBLIC
Write the dirty attributes of an existing model.
-
orionis.orm.relations.BelongsToRelation
orionis.orm.relations.BelongsToRelation.html
Class
Class
PUBLIC
Inverse relationship: the foreign key lives on the parent row.
-
orionis.orm.relations.BelongsToRelation.__slots__
orionis.orm.relations.BelongsToRelation.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.orm.relations.BelongsToRelation.__init__
orionis.orm.relations.BelongsToRelation.html#__init__
Function
Method
PUBLIC
Bind the relationship.
-
orionis.orm.relations.BelongsToRelation._foreign_key
orionis.orm.relations.BelongsToRelation.html#_foreign_key
Attribute
Instance Variable
PUBLIC
Column on the parent referencing the related row; defaults to snake_case(RelatedClass) + "_id".
-
orionis.orm.relations.BelongsToRelation._owner_key
orionis.orm.relations.BelongsToRelation.html#_owner_key
Attribute
Instance Variable
PUBLIC
Column on the related table identifying the owning row; defaults to the related model's primary key.
-
orionis.orm.relations.BelongsToRelation.addConstraints
orionis.orm.relations.BelongsToRelation.html#addConstraints
Function
Method
PUBLIC
Constrain the query to the row owning the parent's foreign key.
-
orionis.orm.relations.BelongsToRelation.addEagerConstraints
orionis.orm.relations.BelongsToRelation.html#addEagerConstraints
Function
Method
PUBLIC
Constrain the query to the rows owning every child's foreign key.
-
orionis.orm.relations.BelongsToRelation._eager_keys_empty
orionis.orm.relations.BelongsToRelation.html#_eager_keys_empty
Attribute
Instance Variable
PUBLIC
Whether eager loading has no parent keys to query.
-
orionis.orm.relations.BelongsToRelation.getResults
orionis.orm.relations.BelongsToRelation.html#getResults
Function
Method
PUBLIC
Retrieve the owning row referenced by the parent's foreign key.
-
orionis.orm.relations.BelongsToRelation.match
orionis.orm.relations.BelongsToRelation.html#match
Function
Method
PUBLIC
Attach the owning row to each child instance.
-
orionis.orm.relations.BelongsToManyRelation
orionis.orm.relations.BelongsToManyRelation.html
Class
Class
PUBLIC
Many-to-many relationship backed by an intermediate pivot table.
-
orionis.orm.relations.BelongsToManyRelation.__slots__
orionis.orm.relations.BelongsToManyRelation.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.orm.relations.BelongsToManyRelation.__init__
orionis.orm.relations.BelongsToManyRelation.html#__init__
Function
Method
PUBLIC
Bind the relationship.
-
orionis.orm.relations.BelongsToManyRelation._table
orionis.orm.relations.BelongsToManyRelation.html#_table
Attribute
Instance Variable
PUBLIC
Pivot table name; defaults to both model names in snake_case, singular, joined by "_" in alphabetical order (for instance role_user).
-
orionis.orm.relations.BelongsToManyRelation._foreign_pivot_key
orionis.orm.relations.BelongsToManyRelation.html#_foreign_pivot_key
Attribute
Instance Variable
PUBLIC
Pivot column referencing the parent; defaults to snake_case(ParentClass) +
"_id".
-
orionis.orm.relations.BelongsToManyRelation._related_pivot_key
orionis.orm.relations.BelongsToManyRelation.html#_related_pivot_key
Attribute
Instance Variable
PUBLIC
Pivot column referencing the related row; defaults to snake_case(RelatedClass) + "_id".
-
orionis.orm.relations.BelongsToManyRelation._parent_key
orionis.orm.relations.BelongsToManyRelation.html#_parent_key
Attribute
Instance Variable
PUBLIC
Column on the parent matched against foreign_pivot_key; defaults to the parent's primary key.
-
orionis.orm.relations.BelongsToManyRelation._related_key
orionis.orm.relations.BelongsToManyRelation.html#_related_key
Attribute
Instance Variable
PUBLIC
Column on the related table matched against related_pivot_key; defaults to the related model's primary key.
-
orionis.orm.relations.BelongsToManyRelation._parent_keys
orionis.orm.relations.BelongsToManyRelation.html#_parent_keys
Attribute
Instance Variable
PUBLIC
Parent identifiers participating in the relation query.
-
orionis.orm.relations.BelongsToManyRelation._pivot_wheres
orionis.orm.relations.BelongsToManyRelation.html#_pivot_wheres
Attribute
Instance Variable
PUBLIC
Predicates applied to the relation pivot table.
-
orionis.orm.relations.BelongsToManyRelation._related_map
orionis.orm.relations.BelongsToManyRelation.html#_related_map
Attribute
Instance Variable
PUBLIC
Related models indexed for assignment to their parent objects.
-
orionis.orm.relations.BelongsToManyRelation._pivot_constraint
orionis.orm.relations.BelongsToManyRelation.html#_pivot_constraint
Attribute
Instance Variable
PUBLIC
Constraint used to scope the pivot-table query.
-
orionis.orm.relations.BelongsToManyRelation._prepare_lock
orionis.orm.relations.BelongsToManyRelation.html#_prepare_lock
Attribute
Instance Variable
PUBLIC
Lock coordinating one-time preparation of the relation query.
-
orionis.orm.relations.BelongsToManyRelation._prepared
orionis.orm.relations.BelongsToManyRelation.html#_prepared
Attribute
Instance Variable
PUBLIC
Prepared flag used by BelongsToManyRelation.
-
orionis.orm.relations.BelongsToManyRelation._defaultPivotTable
orionis.orm.relations.BelongsToManyRelation.html#_defaultPivotTable
Function
Static Method
PUBLIC
Derive the conventional pivot table name for two model classes.
-
orionis.orm.relations.BelongsToManyRelation.addConstraints
orionis.orm.relations.BelongsToManyRelation.html#addConstraints
Function
Method
PUBLIC
Capture the parent key used to resolve the pivot rows.
-
orionis.orm.relations.BelongsToManyRelation.addEagerConstraints
orionis.orm.relations.BelongsToManyRelation.html#addEagerConstraints
Function
Method
PUBLIC
Capture every parent key involved in an eager-loaded batch.
-
orionis.orm.relations.BelongsToManyRelation._eager_keys_empty
orionis.orm.relations.BelongsToManyRelation.html#_eager_keys_empty
Attribute
Instance Variable
PUBLIC
Whether eager loading has no parent keys to query.
-
orionis.orm.relations.BelongsToManyRelation._pivotQuery
orionis.orm.relations.BelongsToManyRelation.html#_pivotQuery
Function
Method
PUBLIC
Build a model-less query targeting the pivot table.
-
orionis.orm.relations.BelongsToManyRelation.getResults
orionis.orm.relations.BelongsToManyRelation.html#getResults
Function
Method
PUBLIC
Retrieve every related row linked to the parent instance.
-
orionis.orm.relations.BelongsToManyRelation.match
orionis.orm.relations.BelongsToManyRelation.html#match
Function
Method
PUBLIC
Attach the matching related rows to each parent instance.
-
orionis.orm.relations.BelongsToManyRelation._prepare
orionis.orm.relations.BelongsToManyRelation.html#_prepare
Function
Method
PUBLIC
Resolve the pivot rows once and constrain the query to their ids.
-
orionis.orm.relations.BelongsToManyRelation._invalidatePivot
orionis.orm.relations.BelongsToManyRelation.html#_invalidatePivot
Function
Method
PUBLIC
Discard the resolved pivot rows and generated membership clause.
-
orionis.orm.relations.BelongsToManyRelation.clone
orionis.orm.relations.BelongsToManyRelation.html#clone
Function
Method
PUBLIC
Copy query clauses and pivot filters into an independent builder.
-
orionis.orm.relations.BelongsToManyRelation._resolvePivotMap
orionis.orm.relations.BelongsToManyRelation.html#_resolvePivotMap
Function
Method
PUBLIC
Query the pivot table for the rows linking the captured parents.
-
orionis.orm.relations.BelongsToManyRelation.get
orionis.orm.relations.BelongsToManyRelation.html#get
Function
Method
PUBLIC
Execute the query and hydrate every linked related row.
-
orionis.orm.relations.BelongsToManyRelation.first
orionis.orm.relations.BelongsToManyRelation.html#first
Function
Method
PUBLIC
Execute the query and hydrate only the first linked related row.
-
orionis.orm.relations.BelongsToManyRelation._aggregate
orionis.orm.relations.BelongsToManyRelation.html#_aggregate
Function
Method
PUBLIC
Constrain an aggregate query to the resolved pivot membership.
-
orionis.orm.relations.BelongsToManyRelation.update
orionis.orm.relations.BelongsToManyRelation.html#update
Function
Method
PUBLIC
Update related records linked through the pivot table.
-
orionis.orm.relations.BelongsToManyRelation.delete
orionis.orm.relations.BelongsToManyRelation.html#delete
Function
Method
PUBLIC
Delete related records linked through the pivot table.
-
orionis.orm.relations.BelongsToManyRelation.forceDelete
orionis.orm.relations.BelongsToManyRelation.html#forceDelete
Function
Method
PUBLIC
Permanently delete records linked through the pivot table.
-
orionis.orm.relations.BelongsToManyRelation.exists
orionis.orm.relations.BelongsToManyRelation.html#exists
Function
Method
PUBLIC
Report whether at least one related row is linked.
-
orionis.orm.relations.BelongsToManyRelation.wherePivot
orionis.orm.relations.BelongsToManyRelation.html#wherePivot
Function
Method
PUBLIC
Filter the pivot rows considered by this relationship query.
-
orionis.orm.relations.BelongsToManyRelation.attach
orionis.orm.relations.BelongsToManyRelation.html#attach
Function
Method
PUBLIC
Link the parent to the given related records via the pivot table.
-
orionis.orm.relations.BelongsToManyRelation.detach
orionis.orm.relations.BelongsToManyRelation.html#detach
Function
Method
PUBLIC
Unlink the parent from the given related records.
-
orionis.orm.relations.BelongsToManyRelation.sync
orionis.orm.relations.BelongsToManyRelation.html#sync
Function
Method
PUBLIC
Attach exactly the given records, detaching every other one.
-
orionis.orm.relations.BelongsToManyRelation.toggle
orionis.orm.relations.BelongsToManyRelation.html#toggle
Function
Method
PUBLIC
Attach ids not currently linked, detach ids that already are.
-
orionis.orm.relations.BelongsToManyRelation._currentRelatedIds
orionis.orm.relations.BelongsToManyRelation.html#_currentRelatedIds
Function
Method
PUBLIC
Query the pivot table for the related ids currently linked.
-
orionis.orm.relations.BelongsToManyRelation._normalizeIds
orionis.orm.relations.BelongsToManyRelation.html#_normalizeIds
Function
Method
PUBLIC
Normalize a scalar, model, or iterable of either into id values.
-
orionis.orm.relations.HasManyRelation
orionis.orm.relations.HasManyRelation.html
Class
Class
PUBLIC
One-to-many relationship: the related table owns the foreign key.
-
orionis.orm.relations.HasManyRelation.__slots__
orionis.orm.relations.HasManyRelation.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.relations.HasManyRelation.getResults
orionis.orm.relations.HasManyRelation.html#getResults
Function
Method
PUBLIC
Retrieve every related row owned by the parent instance.
-
orionis.orm.relations.HasManyRelation.match
orionis.orm.relations.HasManyRelation.html#match
Function
Method
PUBLIC
Attach every matching related row to each parent instance.
-
orionis.orm.relations.HasOneRelation
orionis.orm.relations.HasOneRelation.html
Class
Class
PUBLIC
One-to-one relationship: the related table owns the foreign key.
-
orionis.orm.relations.HasOneRelation.__slots__
orionis.orm.relations.HasOneRelation.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.relations.HasOneRelation.getResults
orionis.orm.relations.HasOneRelation.html#getResults
Function
Method
PUBLIC
Retrieve the single related row owned by the parent instance.
-
orionis.orm.relations.HasOneRelation.match
orionis.orm.relations.HasOneRelation.html#match
Function
Method
PUBLIC
Attach the first matching related row to each parent instance.
-
orionis.orm.relations.HasOneOrManyRelation
orionis.orm.relations.HasOneOrManyRelation.html
Class
Class
PUBLIC
Shared machinery for the hasOne/hasMany relationship kinds.
-
orionis.orm.relations.HasOneOrManyRelation.__slots__
orionis.orm.relations.HasOneOrManyRelation.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.orm.relations.HasOneOrManyRelation.__init__
orionis.orm.relations.HasOneOrManyRelation.html#__init__
Function
Method
PUBLIC
Bind the relationship.
-
orionis.orm.relations.HasOneOrManyRelation._foreign_key
orionis.orm.relations.HasOneOrManyRelation.html#_foreign_key
Attribute
Instance Variable
PUBLIC
Column on the related table referencing the parent; defaults to snake_case(ParentClass) + "_id".
-
orionis.orm.relations.HasOneOrManyRelation._local_key
orionis.orm.relations.HasOneOrManyRelation.html#_local_key
Attribute
Instance Variable
PUBLIC
Column on the parent compared against the foreign key; defaults to the parent's primary key.
-
orionis.orm.relations.HasOneOrManyRelation.addConstraints
orionis.orm.relations.HasOneOrManyRelation.html#addConstraints
Function
Method
PUBLIC
Constrain the query to the rows owned by the parent instance.
-
orionis.orm.relations.HasOneOrManyRelation.addEagerConstraints
orionis.orm.relations.HasOneOrManyRelation.html#addEagerConstraints
Function
Method
PUBLIC
Constrain the query to the rows owned by every parent instance.
-
orionis.orm.relations.HasOneOrManyRelation._eager_keys_empty
orionis.orm.relations.HasOneOrManyRelation.html#_eager_keys_empty
Attribute
Instance Variable
PUBLIC
Whether eager loading has no parent keys to query.
-
orionis.orm.relations.HasOneOrManyRelation._groupByForeignKey
orionis.orm.relations.HasOneOrManyRelation.html#_groupByForeignKey
Function
Method
PUBLIC
Group related rows by their foreign key value.
-
orionis.orm.relations.HasOneOrManyRelation.create
orionis.orm.relations.HasOneOrManyRelation.html#create
Function
Method
PUBLIC
Create and persist a new related model, auto-linking it via the foreign key.
-
orionis.orm.relations.RelationsMixin
orionis.orm.relations.RelationsMixin.html
Class
Class
PUBLIC
Relationship factories and loaded-relation storage for every model.
-
orionis.orm.relations.RelationsMixin.__slots__
orionis.orm.relations.RelationsMixin.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.relations.RelationsMixin.hasOne
orionis.orm.relations.RelationsMixin.html#hasOne
Function
Method
PUBLIC
Define a one-to-one relationship owned by the related table.
-
orionis.orm.relations.RelationsMixin.hasMany
orionis.orm.relations.RelationsMixin.html#hasMany
Function
Method
PUBLIC
Define a one-to-many relationship owned by the related table.
-
orionis.orm.relations.RelationsMixin.belongsTo
orionis.orm.relations.RelationsMixin.html#belongsTo
Function
Method
PUBLIC
Define the inverse of a hasOne/hasMany relationship.
-
orionis.orm.relations.RelationsMixin.belongsToMany
orionis.orm.relations.RelationsMixin.html#belongsToMany
Function
Method
PUBLIC
Define a many-to-many relationship backed by a pivot table.
-
orionis.orm.relations.RelationsMixin.setRelation
orionis.orm.relations.RelationsMixin.html#setRelation
Function
Method
PUBLIC
Store an already-resolved relationship result.
-
orionis.orm.relations.RelationsMixin.getRelation
orionis.orm.relations.RelationsMixin.html#getRelation
Function
Method
PUBLIC
Return an already-resolved relationship result.
-
orionis.orm.relations.RelationsMixin.relationLoaded
orionis.orm.relations.RelationsMixin.html#relationLoaded
Function
Method
PUBLIC
Report whether a relationship result has already been resolved.
-
orionis.orm.relations.Relation
orionis.orm.relations.Relation.html
Class
Class
PUBLIC
Base class for every query builder bound to a parent model instance.
-
orionis.orm.relations.Relation.__slots__
orionis.orm.relations.Relation.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.orm.relations.Relation.__init__
orionis.orm.relations.Relation.html#__init__
Function
Method
PUBLIC
Bind a relationship query builder to its parent instance.
-
orionis.orm.relations.Relation._resolved_connection
orionis.orm.relations.Relation.html#_resolved_connection
Attribute
Instance Variable
PUBLIC
Retain the connection that owns the parent model's loaded state.
-
orionis.orm.relations.Relation._connection_name
orionis.orm.relations.Relation.html#_connection_name
Attribute
Instance Variable
PUBLIC
Use the parent's configured connection for an unbound related model.
-
orionis.orm.relations.Relation._parent
orionis.orm.relations.Relation.html#_parent
Attribute
Instance Variable
PUBLIC
Model instance the relationship is accessed from.
-
orionis.orm.relations.Relation._eager_keys_empty
orionis.orm.relations.Relation.html#_eager_keys_empty
Attribute
Instance Variable
PUBLIC
Eager keys empty flag used by Relation.
-
orionis.orm.relations.Relation.addConstraints
orionis.orm.relations.Relation.html#addConstraints
Function
Method
PUBLIC
Constrain the query to the bound parent instance.
-
orionis.orm.relations.Relation.addEagerConstraints
orionis.orm.relations.Relation.html#addEagerConstraints
Function
Method
PUBLIC
Constrain the query to every parent instance of an eager batch.
-
orionis.orm.relations.Relation.getResults
orionis.orm.relations.Relation.html#getResults
Function
Method
PUBLIC
Execute the relationship query for its bound parent instance.
-
orionis.orm.relations.Relation.getEager
orionis.orm.relations.Relation.html#getEager
Function
Method
PUBLIC
Execute the relationship query assembled for eager loading.
-
orionis.orm.relations.Relation.match
orionis.orm.relations.Relation.html#match
Function
Method
PUBLIC
Group eager-loaded results and attach them to their parents.
-
orionis.orm.relations.Relation.__await__
orionis.orm.relations.Relation.html#__await__
Function
Method
PUBLIC
Allow await directly on a relationship without a terminal.
-
orionis.orm.relations.Relation.noConstraints
orionis.orm.relations.Relation.html#noConstraints
Function
Class Method
PUBLIC
Build a relationship instance without its single-parent constraint.
-
orionis.orm.relations._EXPORTS
orionis.orm.relations.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.orm.relations.__getattr__
orionis.orm.relations.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.orm.relations.__dir__
orionis.orm.relations.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.orm.ConnectionResolver
orionis.orm.ConnectionResolver.html
Class
Class
PUBLIC
Static bridge between the ORM and the database connection manager.
-
orionis.orm.ConnectionResolver._manager
orionis.orm.ConnectionResolver.html#_manager
Attribute
Class Variable
PUBLIC
Connection manager used to resolve database services.
-
orionis.orm.ConnectionResolver.setManager
orionis.orm.ConnectionResolver.html#setManager
Function
Class Method
PUBLIC
Install the connection manager used by every model.
-
orionis.orm.ConnectionResolver.manager
orionis.orm.ConnectionResolver.html#manager
Function
Class Method
PUBLIC
Return the installed connection manager.
-
orionis.orm.ConnectionResolver.connection
orionis.orm.ConnectionResolver.html#connection
Function
Class Method
PUBLIC
Resolve a database connection by name.
-
orionis.orm.ConnectionResolver.clear
orionis.orm.ConnectionResolver.html#clear
Function
Class Method
PUBLIC
Remove the installed manager, mainly for test isolation.
-
orionis.orm._RELATIONS_MODULE
orionis.orm.html#_RELATIONS_MODULE
Attribute
Constant
PUBLIC
Module defining the public relation classes.
-
orionis.orm._TYPES_MODULE
orionis.orm.html#_TYPES_MODULE
Attribute
Constant
PUBLIC
Module defining the public column types.
-
orionis.orm._EXCEPTIONS_MODULE
orionis.orm.html#_EXCEPTIONS_MODULE
Attribute
Constant
PUBLIC
Module defining the public ORM exceptions.
-
orionis.orm._EXPORTS
orionis.orm.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.orm.__getattr__
orionis.orm.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.orm.__dir__
orionis.orm.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.orm.attributes._TRUTHY_STRINGS
orionis.orm.attributes.html#_TRUTHY_STRINGS
Attribute
Constant
PUBLIC
Strings interpreted as truthy when casting to bool.
-
orionis.orm.attributes._cast_bool
orionis.orm.attributes.html#_cast_bool
Function
Function
PUBLIC
Cast a raw value to bool handling common textual forms.
-
orionis.orm.attributes._cast_datetime
orionis.orm.attributes.html#_cast_datetime
Function
Function
PUBLIC
Cast a raw value to datetime.
-
orionis.orm.attributes._cast_date
orionis.orm.attributes.html#_cast_date
Function
Function
PUBLIC
Cast a raw value to date.
-
orionis.orm.attributes._cast_json
orionis.orm.attributes.html#_cast_json
Function
Function
PUBLIC
Cast a raw value to a JSON-decoded Python structure.
-
orionis.orm.attributes._cast_uuid
orionis.orm.attributes.html#_cast_uuid
Function
Function
PUBLIC
Cast a raw value to uuid.UUID.
-
orionis.orm.attributes._CAST_HANDLERS
orionis.orm.attributes.html#_CAST_HANDLERS
Attribute
Constant
PUBLIC
Registry of supported cast names.
-
orionis.orm.attributes.get_cast_handler
orionis.orm.attributes.html#get_cast_handler
Function
Function
PUBLIC
Return the cast handler registered under the given name.
-
orionis.orm.attributes.serialize_for_storage
orionis.orm.attributes.html#serialize_for_storage
Function
Function
PUBLIC
Convert attribute values into driver-friendly storage values.
-
orionis.orm.attributes.AttributesMixin
orionis.orm.attributes.AttributesMixin.html
Class
Class
PUBLIC
Attribute handling behavior shared by every model.
-
orionis.orm.attributes.AttributesMixin.__slots__
orionis.orm.attributes.AttributesMixin.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.attributes.AttributesMixin.fill
orionis.orm.attributes.AttributesMixin.html#fill
Function
Method
PUBLIC
Mass assign the given attributes honoring the assignment rules.
-
orionis.orm.attributes.AttributesMixin.setAttribute
orionis.orm.attributes.AttributesMixin.html#setAttribute
Function
Method
PUBLIC
Assign a single attribute applying its mutator and cast.
-
orionis.orm.attributes.AttributesMixin.getAttribute
orionis.orm.attributes.AttributesMixin.html#getAttribute
Function
Method
PUBLIC
Return a single attribute value through its accessor.
-
orionis.orm.attributes.AttributesMixin.hasAccessor
orionis.orm.attributes.AttributesMixin.html#hasAccessor
Function
Method
PUBLIC
Report whether an attribute is served by an accessor.
-
orionis.orm.attributes.AttributesMixin.toDict
orionis.orm.attributes.AttributesMixin.html#toDict
Function
Method
PUBLIC
Serialize the visible attributes into a dictionary.
-
orionis.orm.attributes.AttributesMixin.serialize
orionis.orm.attributes.AttributesMixin.html#serialize
Function
Method
PUBLIC
Serialize the model for collection-level serialization.
-
orionis.orm.attributes.AttributesMixin.toJson
orionis.orm.attributes.AttributesMixin.html#toJson
Function
Method
PUBLIC
Serialize the visible attributes into a JSON string.
-
orionis.orm.attributes.AttributesMixin.only
orionis.orm.attributes.AttributesMixin.html#only
Function
Method
PUBLIC
Return a subset of attributes limited to the given keys.
-
orionis.orm.attributes.AttributesMixin.exclude
orionis.orm.attributes.AttributesMixin.html#exclude
Function
Method
PUBLIC
Return every attribute except the given keys.
-
orionis.orm.query.builder._DEFAULT_PER_PAGE
orionis.orm.query.builder.html#_DEFAULT_PER_PAGE
Attribute
Constant
PUBLIC
Default page size used by pagination.
-
orionis.orm.query.builder._TRASHED_EXCLUDE
orionis.orm.query.builder.html#_TRASHED_EXCLUDE
Attribute
Constant
PUBLIC
Soft delete visibility modes a model query can run under.
-
orionis.orm.query.builder._TRASHED_INCLUDE
orionis.orm.query.builder.html#_TRASHED_INCLUDE
Attribute
Constant
PUBLIC
with.
-
orionis.orm.query.builder._TRASHED_ONLY
orionis.orm.query.builder.html#_TRASHED_ONLY
Attribute
Constant
PUBLIC
only.
-
orionis.auth.tokens.lookup._INTEGER_DIGITS
orionis.auth.tokens.lookup.html#_INTEGER_DIGITS
Attribute
Constant
PUBLIC
Integer digits value used by lookup.
-
orionis.auth.tokens.lookup._INTEGERS
orionis.auth.tokens.lookup.html#_INTEGERS
Attribute
Constant
PUBLIC
Integers used by lookup.
-
orionis.auth.tokens.lookup._STRINGS
orionis.auth.tokens.lookup.html#_STRINGS
Attribute
Constant
PUBLIC
Strings used by lookup.
-
orionis.auth.tokens.lookup._COLUMNS
orionis.auth.tokens.lookup.html#_COLUMNS
Attribute
Constant
PUBLIC
Columns definitions used by lookup.
-
orionis.auth.tokens.lookup._integer_key
orionis.auth.tokens.lookup.html#_integer_key
Function
Function
PUBLIC
Cast only bounded decimal strings, including on strict SQL engines.
-
orionis.auth.tokens.lookup.lookup_owner
orionis.auth.tokens.lookup.html#lookup_owner
Function
Function
PUBLIC
Read a token and a native ORM identity in one bounded SELECT.
-
orionis.auth.tokens.schema.build_tokens_table
orionis.auth.tokens.schema.html#build_tokens_table
Function
Function
PUBLIC
Build the framework schema consumed by the personal access token repository.
-
orionis.background.BackgroundTask
orionis.background.BackgroundTask.html
Class
Class
PUBLIC
Represent a background task that can be executed asynchronously.
-
orionis.background.BackgroundTask.__slots__
orionis.background.BackgroundTask.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.background.BackgroundTask.__init__
orionis.background.BackgroundTask.html#__init__
Function
Method
PUBLIC
Initialize the BackgroundTask instance.
-
orionis.background.BackgroundTask.__func
orionis.background.BackgroundTask.html#__func
Attribute
Instance Variable
PUBLIC
The function to be executed in the background.
-
orionis.background.BackgroundTask.__args
orionis.background.BackgroundTask.html#__args
Attribute
Instance Variable
PUBLIC
Positional arguments to pass to the function.
-
orionis.background.BackgroundTask.__kwargs
orionis.background.BackgroundTask.html#__kwargs
Attribute
Instance Variable
PUBLIC
Keyword arguments to pass to the function.
-
orionis.background.BackgroundTask.__is_async
orionis.background.BackgroundTask.html#__is_async
Attribute
Instance Variable
PUBLIC
Is async produced by is_async_callable.
-
orionis.background.BackgroundTask.__executeSync
orionis.background.BackgroundTask.html#__executeSync
Function
Method
PUBLIC
Run synchronous work and release its result if the caller cancels.
-
orionis.background.BackgroundTask.__call__
orionis.background.BackgroundTask.html#__call__
Function
Method
PUBLIC
Execute the background task, handling both sync and async functions.
-
orionis.background.BackgroundTask.run
orionis.background.BackgroundTask.html#run
Function
Method
PUBLIC
Run the background task.
-
orionis.background.BackgroundTasks
orionis.background.BackgroundTasks.html
Class
Class
PUBLIC
Manage and execute a collection of background tasks sequentially.
-
orionis.background.BackgroundTasks.__slots__
orionis.background.BackgroundTasks.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.background.BackgroundTasks.__init__
orionis.background.BackgroundTasks.html#__init__
Function
Method
PUBLIC
Initialize BackgroundTasks with an optional sequence of tasks.
-
orionis.background.BackgroundTasks.tasks
orionis.background.BackgroundTasks.html#tasks
Attribute
Instance Variable
PUBLIC
Optional sequence of BackgroundTask instances to initialize with.
-
orionis.background.BackgroundTasks.addTask
orionis.background.BackgroundTasks.html#addTask
Function
Method
PUBLIC
Add a new BackgroundTask to the task list.
-
orionis.background.BackgroundTasks.__call__
orionis.background.BackgroundTasks.html#__call__
Function
Method
PUBLIC
Execute all background tasks sequentially.
-
orionis.background._EXPORTS
orionis.background.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.background.__getattr__
orionis.background.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.background.__dir__
orionis.background.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.cache.contracts.IFileBasedCache
orionis.cache.contracts.IFileBasedCache.html
Class
Class
PUBLIC
Define the contract for file based cache implementations.
-
orionis.cache.contracts.IFileBasedCache.get
orionis.cache.contracts.IFileBasedCache.html#get
Function
Method
PUBLIC
Retrieve cached data if valid.
-
orionis.cache.contracts.IFileBasedCache.save
orionis.cache.contracts.IFileBasedCache.html#save
Function
Method
PUBLIC
Save data to the cache file with metadata.
-
orionis.cache.contracts.IFileBasedCache.clear
orionis.cache.contracts.IFileBasedCache.html#clear
Function
Method
PUBLIC
Remove the cache file if it exists.
-
orionis.cache.contracts.ICacheManager
orionis.cache.contracts.ICacheManager.html
Class
Class
PUBLIC
Define the contract for cache manager implementations.
-
orionis.cache.contracts.ICacheManager.rememberOnce
orionis.cache.contracts.ICacheManager.html#rememberOnce
Function
Method
PUBLIC
Coalesce misses using the configured default store when supported.
-
orionis.cache.contracts.ICacheManager.store
orionis.cache.contracts.ICacheManager.html#store
Function
Method
PUBLIC
Return the repository for the named (or default) store.
-
orionis.cache.contracts.ICacheManager.get
orionis.cache.contracts.ICacheManager.html#get
Function
Method
PUBLIC
Retrieve the value for key from the default store.
-
orionis.cache.contracts.ICacheManager.set
orionis.cache.contracts.ICacheManager.html#set
Function
Method
PUBLIC
Store value under key in the default store.
-
orionis.cache.contracts.ICacheManager.has
orionis.cache.contracts.ICacheManager.html#has
Function
Method
PUBLIC
Check whether key exists in the default store.
-
orionis.cache.contracts.ICacheManager.delete
orionis.cache.contracts.ICacheManager.html#delete
Function
Method
PUBLIC
Remove key from the default store.
-
orionis.cache.contracts.ICacheManager.clear
orionis.cache.contracts.ICacheManager.html#clear
Function
Method
PUBLIC
Remove all entries from the default store.
-
orionis.cache.contracts.ICacheManager.getMany
orionis.cache.contracts.ICacheManager.html#getMany
Function
Method
PUBLIC
Retrieve multiple values from the default store.
-
orionis.cache.contracts.ICacheManager.setMany
orionis.cache.contracts.ICacheManager.html#setMany
Function
Method
PUBLIC
Store multiple key/value pairs in the default store.
-
orionis.cache.contracts.ICacheManager.remember
orionis.cache.contracts.ICacheManager.html#remember
Function
Method
PUBLIC
Return the cached value; resolve and cache if absent.
-
orionis.cache.contracts.ICacheManager.rememberForever
orionis.cache.contracts.ICacheManager.html#rememberForever
Function
Method
PUBLIC
Return the cached value; resolve and cache forever if absent.
-
orionis.cache.contracts.ICacheManager.pull
orionis.cache.contracts.ICacheManager.html#pull
Function
Method
PUBLIC
Return and immediately delete key from the default store.
-
orionis.cache.contracts.ICacheManager.add
orionis.cache.contracts.ICacheManager.html#add
Function
Method
PUBLIC
Store value only if key is absent in the default store.
-
orionis.cache.contracts.ICacheManager.increment
orionis.cache.contracts.ICacheManager.html#increment
Function
Method
PUBLIC
Increment the integer at key in the default store.
-
orionis.cache.contracts.ICacheManager.decrement
orionis.cache.contracts.ICacheManager.html#decrement
Function
Method
PUBLIC
Decrement the integer at key in the default store.
-
orionis.cache.contracts.ICacheRepository
orionis.cache.contracts.ICacheRepository.html
Class
Class
PUBLIC
Define the contract for cache repository implementations.
-
orionis.cache.contracts.ICacheRepository.__slots__
orionis.cache.contracts.ICacheRepository.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.cache.contracts.ICacheRepository.rememberOnce
orionis.cache.contracts.ICacheRepository.html#rememberOnce
Function
Method
PUBLIC
Coalesce overlapping misses, or explicitly reject unsupported stores.
-
orionis.cache.contracts.ICacheRepository.replace
orionis.cache.contracts.ICacheRepository.html#replace
Function
Method
PUBLIC
Replace a live entry atomically without creating a missing key.
-
orionis.cache.contracts.ICacheRepository.get
orionis.cache.contracts.ICacheRepository.html#get
Function
Method
PUBLIC
Retrieve the cached value for key.
-
orionis.cache.contracts.ICacheRepository.set
orionis.cache.contracts.ICacheRepository.html#set
Function
Method
PUBLIC
Store value under key with an optional TTL.
-
orionis.cache.contracts.ICacheRepository.has
orionis.cache.contracts.ICacheRepository.html#has
Function
Method
PUBLIC
Check whether key exists and has not expired.
-
orionis.cache.contracts.ICacheRepository.delete
orionis.cache.contracts.ICacheRepository.html#delete
Function
Method
PUBLIC
Remove key from the store.
-
orionis.cache.contracts.ICacheRepository.clear
orionis.cache.contracts.ICacheRepository.html#clear
Function
Method
PUBLIC
Remove all entries from the store.
-
orionis.cache.contracts.ICacheRepository.getMany
orionis.cache.contracts.ICacheRepository.html#getMany
Function
Method
PUBLIC
Retrieve multiple values at once.
-
orionis.cache.contracts.ICacheRepository.setMany
orionis.cache.contracts.ICacheRepository.html#setMany
Function
Method
PUBLIC
Store multiple key/value pairs with an optional TTL.
-
orionis.cache.contracts.ICacheRepository.remember
orionis.cache.contracts.ICacheRepository.html#remember
Function
Method
PUBLIC
Return the cached value; resolve and cache if absent.
-
orionis.cache.contracts.ICacheRepository.rememberForever
orionis.cache.contracts.ICacheRepository.html#rememberForever
Function
Method
PUBLIC
Return the cached value; resolve and cache forever if absent.
-
orionis.cache.contracts.ICacheRepository.pull
orionis.cache.contracts.ICacheRepository.html#pull
Function
Method
PUBLIC
Return and immediately delete key from the store.
-
orionis.cache.contracts.ICacheRepository.add
orionis.cache.contracts.ICacheRepository.html#add
Function
Method
PUBLIC
Store value only if key does not already exist.
-
orionis.cache.contracts.ICacheRepository.increment
orionis.cache.contracts.ICacheRepository.html#increment
Function
Method
PUBLIC
Increment the integer stored at key by amount.
-
orionis.cache.contracts.ICacheRepository.decrement
orionis.cache.contracts.ICacheRepository.html#decrement
Function
Method
PUBLIC
Decrement the integer stored at key by amount.
-
orionis.cache.provider.CacheProvider
orionis.cache.provider.CacheProvider.html
Class
Class
PUBLIC
Service provider for the Orionis cache system.
-
orionis.cache.provider.CacheProvider.provides
orionis.cache.provider.CacheProvider.html#provides
Function
Class Method
PUBLIC
Return the services registered by this provider.
-
orionis.cache.provider.CacheProvider.register
orionis.cache.provider.CacheProvider.html#register
Function
Method
PUBLIC
Bind ICacheManager to CacheManager as a singleton.
-
orionis.cache.provider.CacheProvider.boot
orionis.cache.provider.CacheProvider.html#boot
Function
Method
PUBLIC
Pin the Cache facade after all services are registered.
-
orionis.cache.serializers.json.MsgspecSerializer
orionis.cache.serializers.json.MsgspecSerializer.html
Class
Class
PUBLIC
Serialize cache payloads through msgspec JSON encoding.
-
orionis.cache.serializers.json.MsgspecSerializer.DEFAULT_ENCODING
orionis.cache.serializers.json.MsgspecSerializer.html#DEFAULT_ENCODING
Attribute
Constant
PUBLIC
Default encoding used by MsgspecSerializer.
-
orionis.cache.serializers.json.MsgspecSerializer.dumps
orionis.cache.serializers.json.MsgspecSerializer.html#dumps
Function
Method
PUBLIC
Serialize value to UTF-8 encoded JSON bytes.
-
orionis.cache.serializers.json.MsgspecSerializer.loads
orionis.cache.serializers.json.MsgspecSerializer.html#loads
Function
Method
PUBLIC
Deserialize JSON data back to a Python object.
-
orionis.cache.stores.database._MISSING
orionis.cache.stores.database.html#_MISSING
Attribute
Constant
PUBLIC
Sentinel object to distinguish "key not found" from a stored None value.
-
orionis.cache.stores.database._DEFAULT_LOCK_TABLE
orionis.cache.stores.database.html#_DEFAULT_LOCK_TABLE
Attribute
Constant
PUBLIC
Default lock table used when the config does not declare one explicitly.
-
orionis.cache.stores.database._INCREMENT_ATTEMPTS
orionis.cache.stores.database.html#_INCREMENT_ATTEMPTS
Attribute
Constant
PUBLIC
Compare-and-swap rounds allowed before an increment gives up on contention.
-
orionis.cache.stores.database._build_entries_table
orionis.cache.stores.database.html#_build_entries_table
Function
Function
PUBLIC
Build the table definition for the cache entries table.
-
orionis.cache.stores.database._build_locks_table
orionis.cache.stores.database.html#_build_locks_table
Function
Function
PUBLIC
Build the table definition for the atomic-locks table.
-
orionis.cache.stores.database.DatabaseCacheBackend
orionis.cache.stores.database.DatabaseCacheBackend.html
Class
Class
PUBLIC
Cache backend that stores entries in a relational database table.
-
orionis.cache.stores.database.DatabaseCacheBackend.__slots__
orionis.cache.stores.database.DatabaseCacheBackend.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.cache.stores.database.DatabaseCacheBackend.__init__
orionis.cache.stores.database.DatabaseCacheBackend.html#__init__
Function
Method
PUBLIC
Initialize the backend bound to a connection and table names.
-
orionis.cache.stores.database.DatabaseCacheBackend._connection
orionis.cache.stores.database.DatabaseCacheBackend.html#_connection
Attribute
Instance Variable
PUBLIC
Database connection used to store cache entries and locks.
-
orionis.cache.stores.database.DatabaseCacheBackend._table
orionis.cache.stores.database.DatabaseCacheBackend.html#_table
Attribute
Instance Variable
PUBLIC
Table name used to store cache entries.
-
orionis.cache.stores.database.DatabaseCacheBackend._lock_table
orionis.cache.stores.database.DatabaseCacheBackend.html#_lock_table
Attribute
Instance Variable
PUBLIC
Table name used to store atomic locks. Defaults to 'cache_locks' when not provided.
-
orionis.cache.stores.database.DatabaseCacheBackend._entry_definition
orionis.cache.stores.database.DatabaseCacheBackend.html#_entry_definition
Attribute
Instance Variable
PUBLIC
Entry definition produced by _build_entries_table.
-
orionis.cache.stores.database.DatabaseCacheBackend._lock_definition
orionis.cache.stores.database.DatabaseCacheBackend.html#_lock_definition
Attribute
Instance Variable
PUBLIC
Lock definition produced by _build_locks_table.
-
orionis.cache.stores.database.DatabaseCacheBackend._ready
orionis.cache.stores.database.DatabaseCacheBackend.html#_ready
Attribute
Instance Variable
PUBLIC
Ready flag used by DatabaseCacheBackend.
-
orionis.cache.stores.database.DatabaseCacheBackend._ready_lock
orionis.cache.stores.database.DatabaseCacheBackend.html#_ready_lock
Attribute
Instance Variable
PUBLIC
Synchronization primitive controlling access to ready lock.
-
orionis.cache.stores.database.DatabaseCacheBackend.migrate
orionis.cache.stores.database.DatabaseCacheBackend.html#migrate
Function
Method
PUBLIC
Create the framework cache and lock tables without removing existing data.
-
orionis.cache.stores.database.DatabaseCacheBackend._ensureSchema
orionis.cache.stores.database.DatabaseCacheBackend.html#_ensureSchema
Function
Method
PUBLIC
Create the cache and lock tables on first use, if missing.
-
orionis.cache.stores.database.DatabaseCacheBackend.__encode
orionis.cache.stores.database.DatabaseCacheBackend.html#__encode
Function
Method
PUBLIC
Serialize value to a JSON string suitable for storage.
-
orionis.cache.stores.database.DatabaseCacheBackend.__decode
orionis.cache.stores.database.DatabaseCacheBackend.html#__decode
Function
Method
PUBLIC
Deserialize a stored JSON payload back into a Python object.
-
orionis.cache.stores.database.DatabaseCacheBackend.get
orionis.cache.stores.database.DatabaseCacheBackend.html#get
Function
Method
PUBLIC
Return the cached value for key, or default when absent/expired.
-
orionis.cache.stores.database.DatabaseCacheBackend.set
orionis.cache.stores.database.DatabaseCacheBackend.html#set
Function
Method
PUBLIC
Store value under key with an optional TTL in seconds.
-
orionis.cache.stores.database.DatabaseCacheBackend.__insertOrRetryUpdate
orionis.cache.stores.database.DatabaseCacheBackend.html#__insertOrRetryUpdate
Function
Method
PUBLIC
Insert a new cache row, falling back to an update on conflict.
-
orionis.cache.stores.database.DatabaseCacheBackend.replace
orionis.cache.stores.database.DatabaseCacheBackend.html#replace
Function
Method
PUBLIC
Replace a live cache row with a single conditional update.
-
orionis.cache.stores.database.DatabaseCacheBackend.exists
orionis.cache.stores.database.DatabaseCacheBackend.html#exists
Function
Method
PUBLIC
Return True if key exists and has not expired.
-
orionis.cache.stores.database.DatabaseCacheBackend.delete
orionis.cache.stores.database.DatabaseCacheBackend.html#delete
Function
Method
PUBLIC
Remove key from the store.
-
orionis.cache.stores.database.DatabaseCacheBackend.clear
orionis.cache.stores.database.DatabaseCacheBackend.html#clear
Function
Method
PUBLIC
Remove all cache entries from the store table.
-
orionis.cache.stores.database.DatabaseCacheBackend.multiGet
orionis.cache.stores.database.DatabaseCacheBackend.html#multiGet
Function
Method
PUBLIC
Return a list of values for keys in the same order.
-
orionis.cache.stores.database.DatabaseCacheBackend.multiSet
orionis.cache.stores.database.DatabaseCacheBackend.html#multiSet
Function
Method
PUBLIC
Store multiple key/value pairs with an optional shared TTL.
-
orionis.cache.stores.database.DatabaseCacheBackend.add
orionis.cache.stores.database.DatabaseCacheBackend.html#add
Function
Method
PUBLIC
Store value under key only if the key does not already exist.
-
orionis.cache.stores.database.DatabaseCacheBackend.increment
orionis.cache.stores.database.DatabaseCacheBackend.html#increment
Function
Method
PUBLIC
Increment the integer stored at key by delta.
-
orionis.cache.stores.database.DatabaseCacheBackend.__currentCounter
orionis.cache.stores.database.DatabaseCacheBackend.html#__currentCounter
Function
Method
PUBLIC
Return the raw payload and integer value stored at key.
-
orionis.cache.stores.database.DatabaseCacheBackend.acquireLock
orionis.cache.stores.database.DatabaseCacheBackend.html#acquireLock
Function
Method
PUBLIC
Attempt to acquire the row-based lock for key in a single try.
-
orionis.cache.stores.database.DatabaseCacheBackend.releaseLock
orionis.cache.stores.database.DatabaseCacheBackend.html#releaseLock
Function
Method
PUBLIC
Release the row-based lock for key when still owned by owner.
-
orionis.cache.stores.database.build
orionis.cache.stores.database.html#build
Function
Function
PUBLIC
Build and return a DatabaseCacheBackend.
-
orionis.cache.stores.file._MISSING
orionis.cache.stores.file.html#_MISSING
Attribute
Constant
PUBLIC
Sentinel object to distinguish "key not found" from a stored None value.
-
orionis.cache.stores.file._REPLACE_ATTEMPTS
orionis.cache.stores.file.html#_REPLACE_ATTEMPTS
Attribute
Constant
PUBLIC
Retry budget for a rename refused because another process holds the target.
-
orionis.cache.stores.file._REPLACE_BACKOFF_SECONDS
orionis.cache.stores.file.html#_REPLACE_BACKOFF_SECONDS
Attribute
Constant
PUBLIC
Replace backoff seconds value used by file.
-
orionis.cache.stores.file._LOCK_STRIPES
orionis.cache.stores.file.html#_LOCK_STRIPES
Attribute
Constant
PUBLIC
Lock stripes value used by file.
-
orionis.cache.stores.file.FileCacheBackend
orionis.cache.stores.file.FileCacheBackend.html
Class
Class
PUBLIC
Implement asynchronous cache operations over filesystem entries.
-
orionis.cache.stores.file.FileCacheBackend.__slots__
orionis.cache.stores.file.FileCacheBackend.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.cache.stores.file.FileCacheBackend.__init__
orionis.cache.stores.file.FileCacheBackend.html#__init__
Function
Method
PUBLIC
Initialize the backend and create the cache directory if needed.
-
orionis.cache.stores.file.FileCacheBackend._path
orionis.cache.stores.file.FileCacheBackend.html#_path
Attribute
Instance Variable
PUBLIC
Directory where cache files will be stored.
-
orionis.cache.stores.file.FileCacheBackend._counter_lock
orionis.cache.stores.file.FileCacheBackend.html#_counter_lock
Attribute
Instance Variable
PUBLIC
Queue counter updates made through this backend instance.
-
orionis.cache.stores.file.FileCacheBackend._rename_lock
orionis.cache.stores.file.FileCacheBackend.html#_rename_lock
Attribute
Instance Variable
PUBLIC
Writes run in worker threads, so the rename needs a thread lock.
-
orionis.cache.stores.file.FileCacheBackend._locks
orionis.cache.stores.file.FileCacheBackend.html#_locks
Attribute
Instance Variable
PUBLIC
Locks produced by tuple.
-
orionis.cache.stores.file.FileCacheBackend.lockNamespace
orionis.cache.stores.file.FileCacheBackend.html#lockNamespace
Attribute
Property
PUBLIC
Return the canonical directory used to identify cache locks.
-
orionis.cache.stores.file.FileCacheBackend.__lock
orionis.cache.stores.file.FileCacheBackend.html#__lock
Function
Method
PUBLIC
Select the stable cross-process lock stripe for a cache file.
-
orionis.cache.stores.file.FileCacheBackend.__file
orionis.cache.stores.file.FileCacheBackend.html#__file
Function
Method
PUBLIC
Return the filesystem path for key.
-
orionis.cache.stores.file.FileCacheBackend.__tempPath
orionis.cache.stores.file.FileCacheBackend.html#__tempPath
Function
Static Method
PUBLIC
Return a unique staging path for file.
-
orionis.cache.stores.file.FileCacheBackend.__readSync
orionis.cache.stores.file.FileCacheBackend.html#__readSync
Function
Method
PUBLIC
Read and decode a cache file synchronously.
-
orionis.cache.stores.file.FileCacheBackend.__readEntryUnlocked
orionis.cache.stores.file.FileCacheBackend.html#__readEntryUnlocked
Function
Static Method
PUBLIC
Read a cache entry while its file lock is held.
-
orionis.cache.stores.file.FileCacheBackend.__writeSync
orionis.cache.stores.file.FileCacheBackend.html#__writeSync
Function
Method
PUBLIC
Atomically write entry to file via tmp-then-rename.
-
orionis.cache.stores.file.FileCacheBackend.__writeEntryUnlocked
orionis.cache.stores.file.FileCacheBackend.html#__writeEntryUnlocked
Function
Method
PUBLIC
Publish a cache entry while its file lock is held.
-
orionis.cache.stores.file.FileCacheBackend.__replaceSync
orionis.cache.stores.file.FileCacheBackend.html#__replaceSync
Function
Method
PUBLIC
Publish tmp as file, retrying a transient sharing violation.
-
orionis.cache.stores.file.FileCacheBackend.__createSync
orionis.cache.stores.file.FileCacheBackend.html#__createSync
Function
Method
PUBLIC
Publish entry atomically only when its locked path is absent.
-
orionis.cache.stores.file.FileCacheBackend.__unlinkSync
orionis.cache.stores.file.FileCacheBackend.html#__unlinkSync
Function
Method
PUBLIC
Remove file, ignoring missing-file errors.
-
orionis.cache.stores.file.FileCacheBackend.__replaceIfPresent
orionis.cache.stores.file.FileCacheBackend.html#__replaceIfPresent
Function
Method
PUBLIC
Replace a live entry while holding its cross-process lock.
-
orionis.cache.stores.file.FileCacheBackend.get
orionis.cache.stores.file.FileCacheBackend.html#get
Function
Method
PUBLIC
Return the cached value for key, or default when absent/expired.
-
orionis.cache.stores.file.FileCacheBackend.replace
orionis.cache.stores.file.FileCacheBackend.html#replace
Function
Method
PUBLIC
Replace an existing live key without recreating a deleted entry.
-
orionis.cache.stores.file.FileCacheBackend.set
orionis.cache.stores.file.FileCacheBackend.html#set
Function
Method
PUBLIC
Store value under key with an optional TTL in seconds.
-
orionis.cache.stores.file.FileCacheBackend.exists
orionis.cache.stores.file.FileCacheBackend.html#exists
Function
Method
PUBLIC
Return True if key exists and has not expired.
-
orionis.cache.stores.file.FileCacheBackend.delete
orionis.cache.stores.file.FileCacheBackend.html#delete
Function
Method
PUBLIC
Remove key from the store.
-
orionis.cache.stores.file.FileCacheBackend.clear
orionis.cache.stores.file.FileCacheBackend.html#clear
Function
Method
PUBLIC
Remove all cache entries from the store directory.
-
orionis.cache.stores.file.FileCacheBackend.multiGet
orionis.cache.stores.file.FileCacheBackend.html#multiGet
Function
Method
PUBLIC
Return a list of values for keys in the same order.
-
orionis.cache.stores.file.FileCacheBackend.multiSet
orionis.cache.stores.file.FileCacheBackend.html#multiSet
Function
Method
PUBLIC
Store multiple key/value pairs with an optional TTL.
-
orionis.cache.stores.file.FileCacheBackend.add
orionis.cache.stores.file.FileCacheBackend.html#add
Function
Method
PUBLIC
Store value under key only if the key does not already exist.
-
orionis.cache.stores.file.FileCacheBackend.increment
orionis.cache.stores.file.FileCacheBackend.html#increment
Function
Method
PUBLIC
Increment the integer stored at key by delta.
-
orionis.cache.stores.file.FileCacheBackend.__incrementSync
orionis.cache.stores.file.FileCacheBackend.html#__incrementSync
Function
Method
PUBLIC
Update a counter while holding its file lock.
-
orionis.cache.stores.memcached.build
orionis.cache.stores.memcached.html#build
Function
Function
PUBLIC
Build and return a MemcachedCache backend.
-
orionis.cache.stores.memory._MemoryCache
orionis.cache.stores.memory._MemoryCache.html
Class
Class
PUBLIC
Cancel retired expiration callbacks when clearing the memory store.
-
orionis.cache.stores.memory._MemoryCache._clear
orionis.cache.stores.memory._MemoryCache.html#_clear
Function
Method
PUBLIC
Clear entries and release timers before their keys can be reused.
-
orionis.cache.stores.memory.build
orionis.cache.stores.memory.html#build
Function
Function
PUBLIC
Build and return a SimpleMemoryCache backend.
-
orionis.cache.stores.redis.build
orionis.cache.stores.redis.html#build
Function
Function
PUBLIC
Build and return a RedisCache backend.
-
orionis.console.args.argument._VALID_NARGS
orionis.console.args.argument.html#_VALID_NARGS
Attribute
Constant
PUBLIC
Valid nargs values for argparse.
-
orionis.console.args.argument._ACTIONS_WITHOUT_TYPE
orionis.console.args.argument.html#_ACTIONS_WITHOUT_TYPE
Attribute
Constant
PUBLIC
Actions that do not support type conversion and should not have a 'type_' parameter.
-
orionis.console.Argument
orionis.console.Argument.html
Class
Class
PUBLIC
Represent a command-line argument definition.
-
orionis.console.Argument.name_or_flags
orionis.console.Argument.html#name_or_flags
Attribute
Instance Variable
PUBLIC
Name or flags for the argument (e.g. "--file" or ("-f", "--file")).
-
orionis.console.Argument.action
orionis.console.Argument.html#action
Attribute
Instance Variable
PUBLIC
Action to perform when the argument is encountered.
-
orionis.console.Argument.nargs
orionis.console.Argument.html#nargs
Attribute
Instance Variable
PUBLIC
Number of arguments to consume ('?', '*', '+', or integer).
-
orionis.console.Argument.const
orionis.console.Argument.html#const
Attribute
Instance Variable
PUBLIC
Constant value used by actions like 'store_const'.
-
orionis.console.Argument.default
orionis.console.Argument.html#default
Attribute
Instance Variable
PUBLIC
Default value if the argument is not provided.
-
orionis.console.Argument.type_
orionis.console.Argument.html#type_
Attribute
Instance Variable
PUBLIC
Function used to convert the argument value.
-
orionis.console.Argument.choices
orionis.console.Argument.html#choices
Attribute
Instance Variable
PUBLIC
Allowed values for the argument.
-
orionis.console.Argument.required
orionis.console.Argument.html#required
Attribute
Instance Variable
PUBLIC
Whether the argument is required.
-
orionis.console.Argument.help
orionis.console.Argument.html#help
Attribute
Instance Variable
PUBLIC
Help text for the argument.
-
orionis.console.Argument.metavar
orionis.console.Argument.html#metavar
Attribute
Instance Variable
PUBLIC
Name used in help messages.
-
orionis.console.Argument.dest
orionis.console.Argument.html#dest
Attribute
Instance Variable
PUBLIC
Attribute name where the parsed value is stored.
-
orionis.console.Argument.version
orionis.console.Argument.html#version
Attribute
Instance Variable
PUBLIC
Version string used with action="version".
-
orionis.console.Argument.__post_init__
orionis.console.Argument.html#__post_init__
Function
Method
PUBLIC
Validate and normalize the argument definition.
-
orionis.console.Argument.addToParser
orionis.console.Argument.html#addToParser
Function
Method
PUBLIC
Add this argument to an ArgumentParser.
-
orionis.console.debug.contracts.dumper.IDumper
orionis.console.debug.contracts.dumper.IDumper.html
Class
Class
PUBLIC
Define the contract for dumper implementations.
-
orionis.console.debug.contracts.dumper.IDumper.dd
orionis.console.debug.contracts.dumper.IDumper.html#dd
Function
Static Method
PUBLIC
Dump variables and stop the current execution context.
-
orionis.console.debug.contracts.dumper.IDumper.dump
orionis.console.debug.contracts.dumper.IDumper.html#dump
Function
Static Method
PUBLIC
Dump variables to the console for debugging.
-
orionis.console.output.contracts.var_dumper.T
orionis.console.output.contracts.var_dumper.html#T
Attribute
Type Variable
PUBLIC
Type parameter preserving the value type across var dumper operations.
-
orionis.console.output.contracts.var_dumper.IVarDumper
orionis.console.output.contracts.var_dumper.IVarDumper.html
Class
Class
PUBLIC
Define the contract for var dumper implementations.
-
orionis.console.output.contracts.var_dumper.IVarDumper.showTypes
orionis.console.output.contracts.var_dumper.IVarDumper.html#showTypes
Function
Method
PUBLIC
Set whether to display the type of each argument in the panel title.
-
orionis.console.output.contracts.var_dumper.IVarDumper.showIndex
orionis.console.output.contracts.var_dumper.IVarDumper.html#showIndex
Function
Method
PUBLIC
Set whether to display an index number for each argument.
-
orionis.console.output.contracts.var_dumper.IVarDumper.expandAll
orionis.console.output.contracts.var_dumper.IVarDumper.html#expandAll
Function
Method
PUBLIC
Set whether to expand all nested data structures.
-
orionis.console.output.contracts.var_dumper.IVarDumper.maxDepth
orionis.console.output.contracts.var_dumper.IVarDumper.html#maxDepth
Function
Method
PUBLIC
Set the maximum depth for nested structures.
-
orionis.console.output.contracts.var_dumper.IVarDumper.modulePath
orionis.console.output.contracts.var_dumper.IVarDumper.html#modulePath
Function
Method
PUBLIC
Set the module path to display in the header.
-
orionis.console.output.contracts.var_dumper.IVarDumper.lineNumber
orionis.console.output.contracts.var_dumper.IVarDumper.html#lineNumber
Function
Method
PUBLIC
Set the line number for header display.
-
orionis.console.output.contracts.var_dumper.IVarDumper.forceExit
orionis.console.output.contracts.var_dumper.IVarDumper.html#forceExit
Function
Method
PUBLIC
Set whether to terminate the program after dumping.
-
orionis.console.output.contracts.var_dumper.IVarDumper.redirectOutput
orionis.console.output.contracts.var_dumper.IVarDumper.html#redirectOutput
Function
Method
PUBLIC
Set whether to temporarily restore stdout/stderr during output.
-
orionis.console.output.contracts.var_dumper.IVarDumper.values
orionis.console.output.contracts.var_dumper.IVarDumper.html#values
Function
Method
PUBLIC
Receive and store multiple values to be dumped.
-
orionis.console.output.contracts.var_dumper.IVarDumper.value
orionis.console.output.contracts.var_dumper.IVarDumper.html#value
Function
Method
PUBLIC
Add a value to be dumped.
-
orionis.console.output.contracts.var_dumper.IVarDumper.print
orionis.console.output.contracts.var_dumper.IVarDumper.html#print
Function
Method
PUBLIC
Print the stored values to the console in a formatted manner.
-
orionis.console.output.contracts.var_dumper.IVarDumper.toHtml
orionis.console.output.contracts.var_dumper.IVarDumper.html#toHtml
Function
Method
PUBLIC
Generate the HTML representation of the dumped output.
-
orionis.console.output.var_dumper.T
orionis.console.output.var_dumper.html#T
Attribute
Type Variable
PUBLIC
Type parameter preserving the value type across var dumper operations.
-
orionis.console.output.var_dumper._HTML_TERMINAL_THEME
orionis.console.output.var_dumper.html#_HTML_TERMINAL_THEME
Attribute
Constant
PUBLIC
Match the diagnostic pages without changing the terminal's palette.
-
orionis.console.output.var_dumper._HTML_DUMP_FORMAT
orionis.console.output.var_dumper.html#_HTML_DUMP_FORMAT
Attribute
Constant
PUBLIC
<pre class="dump-output" tabindex="0" role="region"
aria-label="Dumped value"
style="margin:0;padding:16px;overflow:auto;background-color:var(--orionis-surface,#fff);color:var(--orionis-text,#182433);font-family:var(--orionis-mono,'Fira
Code','Cascadia
Code',Consolas,monospace);font-size:13px;line-height:1.75;white-space:pre;overflow-wrap:normal;scrollbar-width:thin"><code
style="font:inherit">{code}</code></pre>...
-
orionis.console.output.var_dumper._HTML_DUMP_PANEL_FORMAT
orionis.console.output.var_dumper.html#_HTML_DUMP_PANEL_FORMAT
Attribute
Constant
PUBLIC
<section class="code-container dump-panel"
style="min-width:0;border:1px solid
var(--orionis-border,#dce1e7);border-radius:var(--orionis-radius,6px);overflow:hidden;background-color:var(--orionis-surface,#fff);box-shadow:0
1px 3px rgb(24 36 51 / 4%)"><div class="code-header"
style="display:flex;align-items:center;justify-content:space-between;flex-wrap:nowrap;gap:12px;padding:12px
16px;border-bottom:1px solid
var(--orionis-border,#dce1e7);background-color:var(--orionis-soft,#edf3f9);font-family:var(--orionis-font,'Titillium
Web',sans-serif);font-size:12px"><span class="code-filename"
style="min-width:0;max-width:100%;overflow-wrap:anywhere;color:var(--orionis-primary-hover,#1a569d);font-weight:600">{source}</span><span
class="code-header-info"
style="display:flex;align-items:center;min-width:min-content;gap:10px;color:var(--orionis-muted,#626e7f);font-family:var(--orionis-mono,'Fira
Code','Cascadia
Code',Consolas,monospace);overflow-wrap:anywhere">{title}</span></div>{code}</section>...
-
orionis.console.output.var_dumper.VarDumper
orionis.console.output.var_dumper.VarDumper.html
Class
Class
PUBLIC
Format Python values for structured console inspection.
-
orionis.console.output.var_dumper.VarDumper.__init__
orionis.console.output.var_dumper.VarDumper.html#__init__
Function
Method
PUBLIC
Initialize the VarDumper instance with default configuration.
-
orionis.console.output.var_dumper.VarDumper.__show_types
orionis.console.output.var_dumper.VarDumper.html#__show_types
Attribute
Instance Variable
PUBLIC
Set whether to show types in output.
-
orionis.console.output.var_dumper.VarDumper.__show_index
orionis.console.output.var_dumper.VarDumper.html#__show_index
Attribute
Instance Variable
PUBLIC
Set whether to show index numbers in output.
-
orionis.console.output.var_dumper.VarDumper.__expand_all
orionis.console.output.var_dumper.VarDumper.html#__expand_all
Attribute
Instance Variable
PUBLIC
Set whether to expand all nested structures.
-
orionis.console.output.var_dumper.VarDumper.__max_depth
orionis.console.output.var_dumper.VarDumper.html#__max_depth
Attribute
Instance Variable
PUBLIC
Set the maximum depth for nested structures; None means unlimited.
-
orionis.console.output.var_dumper.VarDumper.__module_path
orionis.console.output.var_dumper.VarDumper.html#__module_path
Attribute
Instance Variable
PUBLIC
Store the module path for display in the header.
-
orionis.console.output.var_dumper.VarDumper.__line_number
orionis.console.output.var_dumper.VarDumper.html#__line_number
Attribute
Instance Variable
PUBLIC
Store the line number for display in the header.
-
orionis.console.output.var_dumper.VarDumper.__html_module_path
orionis.console.output.var_dumper.VarDumper.html#__html_module_path
Attribute
Instance Variable
PUBLIC
HTML capture must not replace the terminal's module header.
-
orionis.console.output.var_dumper.VarDumper.__html_line_number
orionis.console.output.var_dumper.VarDumper.html#__html_line_number
Attribute
Instance Variable
PUBLIC
Current line number used when rendering inspected values as HTML.
-
orionis.console.output.var_dumper.VarDumper.__force_exit
orionis.console.output.var_dumper.VarDumper.html#__force_exit
Attribute
Instance Variable
PUBLIC
Set whether to force program exit after dumping.
-
orionis.console.output.var_dumper.VarDumper.__redirect_output
orionis.console.output.var_dumper.VarDumper.html#__redirect_output
Attribute
Instance Variable
PUBLIC
Set whether to redirect output streams during dumping.
-
orionis.console.output.var_dumper.VarDumper.__redirected_output
orionis.console.output.var_dumper.VarDumper.html#__redirected_output
Attribute
Instance Variable
PUBLIC
Redirected output flag used by VarDumper.
-
orionis.console.output.var_dumper.VarDumper.__original_stdout
orionis.console.output.var_dumper.VarDumper.html#__original_stdout
Attribute
Instance Variable
PUBLIC
Standard-output stream restored after temporary redirection.
-
orionis.console.output.var_dumper.VarDumper.__original_stderr
orionis.console.output.var_dumper.VarDumper.html#__original_stderr
Attribute
Instance Variable
PUBLIC
Standard-error stream restored after temporary redirection.
-
orionis.console.output.var_dumper.VarDumper.__args
orionis.console.output.var_dumper.VarDumper.html#__args
Attribute
Instance Variable
PUBLIC
Store the arguments to be dumped.
-
orionis.console.output.var_dumper.VarDumper.__console
orionis.console.output.var_dumper.VarDumper.html#__console
Attribute
Instance Variable
PUBLIC
Create a Console instance for output formatting.
-
orionis.console.output.var_dumper.VarDumper.__last_index
orionis.console.output.var_dumper.VarDumper.html#__last_index
Attribute
Instance Variable
PUBLIC
Initialize the last index for tracking.
-
orionis.console.output.var_dumper.VarDumper.__forceExit
orionis.console.output.var_dumper.VarDumper.html#__forceExit
Function
Method
PUBLIC
Terminate the program if the force exit flag is set.
-
orionis.console.output.var_dumper.VarDumper.__resolveCallerInfo
orionis.console.output.var_dumper.VarDumper.html#__resolveCallerInfo
Function
Method
PUBLIC
Resolve and set the caller's module path and line number.
-
orionis.console.output.var_dumper.VarDumper.__makeConsole
orionis.console.output.var_dumper.VarDumper.html#__makeConsole
Function
Method
PUBLIC
Create and return a configured Console instance for output formatting.
-
orionis.console.output.var_dumper.VarDumper.__storeClonedValue
orionis.console.output.var_dumper.VarDumper.html#__storeClonedValue
Function
Method
PUBLIC
Clone the given value using deep copy and store its type information.
-
orionis.console.output.var_dumper.VarDumper.__redirectOutput
orionis.console.output.var_dumper.VarDumper.html#__redirectOutput
Function
Method
PUBLIC
Redirect standard output and error streams temporarily.
-
orionis.console.output.var_dumper.VarDumper.__printLine
orionis.console.output.var_dumper.VarDumper.html#__printLine
Function
Method
PUBLIC
Print a blank line to the console if requested.
-
orionis.console.output.var_dumper.VarDumper.__makePretty
orionis.console.output.var_dumper.VarDumper.html#__makePretty
Function
Method
PUBLIC
Format a value consistently for terminal and HTML output.
-
orionis.console.output.var_dumper.VarDumper.__makePanel
orionis.console.output.var_dumper.VarDumper.html#__makePanel
Function
Method
PUBLIC
Create a Rich Panel with a pretty-printed representation of the value.
-
orionis.console.output.var_dumper.VarDumper.__render
orionis.console.output.var_dumper.VarDumper.html#__render
Function
Method
PUBLIC
Render the stored values to the selected console without exiting.
-
orionis.console.output.var_dumper.VarDumper.showTypes
orionis.console.output.var_dumper.VarDumper.html#showTypes
Function
Method
PUBLIC
Set whether to display the type of each argument in the panel title.
-
orionis.console.output.var_dumper.VarDumper.showIndex
orionis.console.output.var_dumper.VarDumper.html#showIndex
Function
Method
PUBLIC
Set whether to display an index number for each argument.
-
orionis.console.output.var_dumper.VarDumper.expandAll
orionis.console.output.var_dumper.VarDumper.html#expandAll
Function
Method
PUBLIC
Set whether to expand all nested data structures.
-
orionis.console.output.var_dumper.VarDumper.maxDepth
orionis.console.output.var_dumper.VarDumper.html#maxDepth
Function
Method
PUBLIC
Set the maximum depth for nested structures.
-
orionis.console.output.var_dumper.VarDumper.modulePath
orionis.console.output.var_dumper.VarDumper.html#modulePath
Function
Method
PUBLIC
Set the module path to display in the header.
-
orionis.console.output.var_dumper.VarDumper.lineNumber
orionis.console.output.var_dumper.VarDumper.html#lineNumber
Function
Method
PUBLIC
Set the line number for header display.
-
orionis.console.output.var_dumper.VarDumper.forceExit
orionis.console.output.var_dumper.VarDumper.html#forceExit
Function
Method
PUBLIC
Set whether to terminate the program after dumping.
-
orionis.console.output.var_dumper.VarDumper.redirectOutput
orionis.console.output.var_dumper.VarDumper.html#redirectOutput
Function
Method
PUBLIC
Set whether to temporarily restore stdout/stderr during output.
-
orionis.console.output.var_dumper.VarDumper.values
orionis.console.output.var_dumper.VarDumper.html#values
Function
Method
PUBLIC
Receive and store multiple values to be dumped.
-
orionis.console.output.var_dumper.VarDumper.value
orionis.console.output.var_dumper.VarDumper.html#value
Function
Method
PUBLIC
Add a value to be dumped.
-
orionis.console.output.var_dumper.VarDumper.print
orionis.console.output.var_dumper.VarDumper.html#print
Function
Method
PUBLIC
Print the stored values to the console in a formatted manner.
-
orionis.console.output.var_dumper.VarDumper.toHtml
orionis.console.output.var_dumper.VarDumper.html#toHtml
Function
Method
PUBLIC
Generate the HTML representation of the dumped output.
-
orionis.console.debug.dumper.HttpDump
orionis.console.debug.dumper.HttpDump.html
Class
Exception
PUBLIC
Carry a snapshot that only the debug HTTP error boundary may render.
-
orionis.console.debug.dumper.HttpDump.__slots__
orionis.console.debug.dumper.HttpDump.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.console.debug.dumper.HttpDump.__init__
orionis.console.debug.dumper.HttpDump.html#__init__
Function
Method
PUBLIC
Prepare a lazy dump that fails safely outside HTTP error handling.
-
orionis.console.debug.dumper.HttpDump.dumper
orionis.console.debug.dumper.HttpDump.html#dumper
Attribute
Instance Variable
PUBLIC
Configured dumper containing the cloned values.
-
orionis.console.debug.dumper.HttpDump.insert_line
orionis.console.debug.dumper.HttpDump.html#insert_line
Attribute
Instance Variable
PUBLIC
Whether the rendered fragment includes separating lines.
-
orionis.console.Dumper
orionis.console.Dumper.html
Class
Class
PUBLIC
Implement synchronous dumping independently of application boot.
-
orionis.console.Dumper.dd
orionis.console.Dumper.html#dd
Function
Static Method
PUBLIC
Dump variables and stop the current execution context.
-
orionis.console.Dumper.dump
orionis.console.Dumper.html#dump
Function
Static Method
PUBLIC
Dump variables to the console for debugging.
-
orionis.console.dynamic.contracts.progress_bar.IProgressBar
orionis.console.dynamic.contracts.progress_bar.IProgressBar.html
Class
Class
PUBLIC
Define the contract for progress bar implementations.
-
orionis.console.dynamic.contracts.progress_bar.IProgressBar.start
orionis.console.dynamic.contracts.progress_bar.IProgressBar.html#start
Function
Method
PUBLIC
Reset and display the progress bar at the starting state.
-
orionis.console.dynamic.contracts.progress_bar.IProgressBar.advance
orionis.console.dynamic.contracts.progress_bar.IProgressBar.html#advance
Function
Method
PUBLIC
Advance the progress bar by a specified increment.
-
orionis.console.dynamic.contracts.progress_bar.IProgressBar.finish
orionis.console.dynamic.contracts.progress_bar.IProgressBar.html#finish
Function
Method
PUBLIC
Complete the progress bar and move to a new line.
-
orionis.console.ProgressBar
orionis.console.ProgressBar.html
Class
Class
PUBLIC
Manage console progress tasks and their displayed state.
-
orionis.console.ProgressBar.__init__
orionis.console.ProgressBar.html#__init__
Function
Method
PUBLIC
Initialize a new progress bar instance.
-
orionis.console.ProgressBar.total
orionis.console.ProgressBar.html#total
Attribute
Instance Variable
PUBLIC
Maximum value representing 100% progress. Default is 100.
-
orionis.console.ProgressBar.bar_width
orionis.console.ProgressBar.html#bar_width
Attribute
Instance Variable
PUBLIC
Width of the progress bar in characters. Default is 50.
-
orionis.console.ProgressBar.progress
orionis.console.ProgressBar.html#progress
Attribute
Instance Variable
PUBLIC
Initialize progress to zero.
-
orionis.console.ProgressBar._write
orionis.console.ProgressBar.html#_write
Attribute
Instance Variable
PUBLIC
Callable used to append bytes to the current multipart part.
-
orionis.console.ProgressBar._flush
orionis.console.ProgressBar.html#_flush
Attribute
Instance Variable
PUBLIC
Flush obtained from _stdout.flush.
-
orionis.console.ProgressBar.__updateBar
orionis.console.ProgressBar.html#__updateBar
Function
Method
PUBLIC
Update the visual representation of the progress bar in the console.
-
orionis.console.ProgressBar.start
orionis.console.ProgressBar.html#start
Function
Method
PUBLIC
Reset and display the progress bar at the starting state.
-
orionis.console.ProgressBar.advance
orionis.console.ProgressBar.html#advance
Function
Method
PUBLIC
Advance the progress bar by a specified increment.
-
orionis.console.ProgressBar.finish
orionis.console.ProgressBar.html#finish
Function
Method
PUBLIC
Complete the progress bar and move to a new line.
-
orionis.console.output.contracts.console.IConsole
orionis.console.output.contracts.console.IConsole.html
Class
Class
PUBLIC
Define the contract for console implementations.
-
orionis.console.output.contracts.console.IConsole.progressBar
orionis.console.output.contracts.console.IConsole.html#progressBar
Attribute
Property
PUBLIC
Get a new instance of the ProgressBar class.
-
orionis.console.output.contracts.console.IConsole.success
orionis.console.output.contracts.console.IConsole.html#success
Function
Method
PUBLIC
Print a success message with a green background.
-
orionis.console.output.contracts.console.IConsole.textSuccess
orionis.console.output.contracts.console.IConsole.html#textSuccess
Function
Method
PUBLIC
Print a success message in green.
-
orionis.console.output.contracts.console.IConsole.textSuccessBold
orionis.console.output.contracts.console.IConsole.html#textSuccessBold
Function
Method
PUBLIC
Print a bold success message in green.
-
orionis.console.output.contracts.console.IConsole.info
orionis.console.output.contracts.console.IConsole.html#info
Function
Method
PUBLIC
Print an informational message with a blue background.
-
orionis.console.output.contracts.console.IConsole.textInfo
orionis.console.output.contracts.console.IConsole.html#textInfo
Function
Method
PUBLIC
Print an informational message in blue.
-
orionis.console.output.contracts.console.IConsole.textInfoBold
orionis.console.output.contracts.console.IConsole.html#textInfoBold
Function
Method
PUBLIC
Print a bold informational message in blue.
-
orionis.console.output.contracts.console.IConsole.warning
orionis.console.output.contracts.console.IConsole.html#warning
Function
Method
PUBLIC
Print a warning message with a yellow background.
-
orionis.console.output.contracts.console.IConsole.textWarning
orionis.console.output.contracts.console.IConsole.html#textWarning
Function
Method
PUBLIC
Print a warning message in yellow.
-
orionis.console.output.contracts.console.IConsole.textWarningBold
orionis.console.output.contracts.console.IConsole.html#textWarningBold
Function
Method
PUBLIC
Print a bold warning message in yellow.
-
orionis.console.output.contracts.console.IConsole.fail
orionis.console.output.contracts.console.IConsole.html#fail
Function
Method
PUBLIC
Print a failure message with a red background.
-
orionis.console.output.contracts.console.IConsole.error
orionis.console.output.contracts.console.IConsole.html#error
Function
Method
PUBLIC
Print an error message with a red background.
-
orionis.console.output.contracts.console.IConsole.textError
orionis.console.output.contracts.console.IConsole.html#textError
Function
Method
PUBLIC
Print an error message in red.
-
orionis.console.output.contracts.console.IConsole.textErrorBold
orionis.console.output.contracts.console.IConsole.html#textErrorBold
Function
Method
PUBLIC
Print a bold error message in red.
-
orionis.console.output.contracts.console.IConsole.textMuted
orionis.console.output.contracts.console.IConsole.html#textMuted
Function
Method
PUBLIC
Print a muted (gray) message.
-
orionis.console.output.contracts.console.IConsole.textMutedBold
orionis.console.output.contracts.console.IConsole.html#textMutedBold
Function
Method
PUBLIC
Print a bold muted (gray) message.
-
orionis.console.output.contracts.console.IConsole.textUnderline
orionis.console.output.contracts.console.IConsole.html#textUnderline
Function
Method
PUBLIC
Print an underlined message.
-
orionis.console.output.contracts.console.IConsole.clear
orionis.console.output.contracts.console.IConsole.html#clear
Function
Method
PUBLIC
Clear the console screen.
-
orionis.console.output.contracts.console.IConsole.clearLine
orionis.console.output.contracts.console.IConsole.html#clearLine
Function
Method
PUBLIC
Clear the current line in the console.
-
orionis.console.output.contracts.console.IConsole.line
orionis.console.output.contracts.console.IConsole.html#line
Function
Method
PUBLIC
Print a horizontal line in the console.
-
orionis.console.output.contracts.console.IConsole.newLine
orionis.console.output.contracts.console.IConsole.html#newLine
Function
Method
PUBLIC
Print multiple new lines.
-
orionis.console.output.contracts.console.IConsole.write
orionis.console.output.contracts.console.IConsole.html#write
Function
Method
PUBLIC
Write values to the output stream and move to the next line.
-
orionis.console.output.contracts.console.IConsole.writeLine
orionis.console.output.contracts.console.IConsole.html#writeLine
Function
Method
PUBLIC
Print a message and move to the next line.
-
orionis.console.output.contracts.console.IConsole.ask
orionis.console.output.contracts.console.IConsole.html#ask
Function
Method
PUBLIC
Prompt user for input and return the response.
-
orionis.console.output.contracts.console.IConsole.confirm
orionis.console.output.contracts.console.IConsole.html#confirm
Function
Method
PUBLIC
Ask for confirmation and return True or False.
-
orionis.console.output.contracts.console.IConsole.secret
orionis.console.output.contracts.console.IConsole.html#secret
Function
Method
PUBLIC
Prompt for hidden input using the provided question.
-
orionis.console.output.contracts.console.IConsole.table
orionis.console.output.contracts.console.IConsole.html#table
Function
Method
PUBLIC
Print a formatted table with bold headers and box-drawing borders.
-
orionis.console.output.contracts.console.IConsole.anticipate
orionis.console.output.contracts.console.IConsole.html#anticipate
Function
Method
PUBLIC
Provide autocomplete suggestions based on user input.
-
orionis.console.output.contracts.console.IConsole.choice
orionis.console.output.contracts.console.IConsole.html#choice
Function
Method
PUBLIC
Prompt user to select an option from a list.
-
orionis.console.output.contracts.console.IConsole.exception
orionis.console.output.contracts.console.IConsole.html#exception
Function
Method
PUBLIC
Print exception details and stack trace.
-
orionis.console.output.contracts.console.IConsole.exitSuccess
orionis.console.output.contracts.console.IConsole.html#exitSuccess
Function
Method
PUBLIC
Exit the program with a success message.
-
orionis.console.output.contracts.console.IConsole.exitError
orionis.console.output.contracts.console.IConsole.html#exitError
Function
Method
PUBLIC
Exit the program with an error message.
-
orionis.console.output.contracts.console.IConsole.dump
orionis.console.output.contracts.console.IConsole.html#dump
Function
Method
PUBLIC
Dump variable information to the console with formatting options.
-
orionis.console.output.contracts.console.IConsole.sleep
orionis.console.output.contracts.console.IConsole.html#sleep
Function
Method
PUBLIC
Asynchronously sleep for a specified number of seconds.
-
orionis.console.Console
orionis.console.Console.html
Class
Class
PUBLIC
Provide formatted console output, prompts and interactive utilities.
-
orionis.console.Console.progressBar
orionis.console.Console.html#progressBar
Attribute
Property
PUBLIC
Get a new instance of the ProgressBar class.
-
orionis.console.Console.__getNow
orionis.console.Console.html#__getNow
Function
Method
PUBLIC
Return the current date and time.
-
orionis.console.Console.__getTimestamp
orionis.console.Console.html#__getTimestamp
Function
Method
PUBLIC
Return current date and time formatted with muted color.
-
orionis.console.Console.__printWithBackground
orionis.console.Console.html#__printWithBackground
Function
Method
PUBLIC
Print a formatted message with a background color.
-
orionis.console.Console.__printColored
orionis.console.Console.html#__printColored
Function
Method
PUBLIC
Print a message with the specified text color.
-
orionis.console.Console.success
orionis.console.Console.html#success
Function
Method
PUBLIC
Print a success message with a green background.
-
orionis.console.Console.textSuccess
orionis.console.Console.html#textSuccess
Function
Method
PUBLIC
Print a success message in green.
-
orionis.console.Console.textSuccessBold
orionis.console.Console.html#textSuccessBold
Function
Method
PUBLIC
Print a bold success message in green.
-
orionis.console.Console.info
orionis.console.Console.html#info
Function
Method
PUBLIC
Print an informational message with a blue background.
-
orionis.console.Console.textInfo
orionis.console.Console.html#textInfo
Function
Method
PUBLIC
Print an informational message in blue.
-
orionis.console.Console.textInfoBold
orionis.console.Console.html#textInfoBold
Function
Method
PUBLIC
Print a bold informational message in blue.
-
orionis.console.Console.warning
orionis.console.Console.html#warning
Function
Method
PUBLIC
Print a warning message with a yellow background.
-
orionis.console.Console.textWarning
orionis.console.Console.html#textWarning
Function
Method
PUBLIC
Print a warning message in yellow.
-
orionis.console.Console.textWarningBold
orionis.console.Console.html#textWarningBold
Function
Method
PUBLIC
Print a bold warning message in yellow.
-
orionis.console.Console.fail
orionis.console.Console.html#fail
Function
Method
PUBLIC
Print a failure message with a red background.
-
orionis.console.Console.error
orionis.console.Console.html#error
Function
Method
PUBLIC
Print an error message with a red background.
-
orionis.console.Console.textError
orionis.console.Console.html#textError
Function
Method
PUBLIC
Print an error message in red.
-
orionis.console.Console.textErrorBold
orionis.console.Console.html#textErrorBold
Function
Method
PUBLIC
Print a bold error message in red.
-
orionis.console.Console.textMuted
orionis.console.Console.html#textMuted
Function
Method
PUBLIC
Print a muted (gray) message.
-
orionis.console.Console.textMutedBold
orionis.console.Console.html#textMutedBold
Function
Method
PUBLIC
Print a bold muted (gray) message.
-
orionis.console.Console.textUnderline
orionis.console.Console.html#textUnderline
Function
Method
PUBLIC
Print an underlined message.
-
orionis.console.Console.clear
orionis.console.Console.html#clear
Function
Method
PUBLIC
Clear the console screen.
-
orionis.console.Console.clearLine
orionis.console.Console.html#clearLine
Function
Method
PUBLIC
Clear the current line in the console.
-
orionis.console.Console.line
orionis.console.Console.html#line
Function
Method
PUBLIC
Print a horizontal line in the console.
-
orionis.console.Console.newLine
orionis.console.Console.html#newLine
Function
Method
PUBLIC
Print multiple new lines.
-
orionis.console.Console.write
orionis.console.Console.html#write
Function
Method
PUBLIC
Write values to the output stream and move to the next line.
-
orionis.console.Console.writeLine
orionis.console.Console.html#writeLine
Function
Method
PUBLIC
Print a message and move to the next line.
-
orionis.console.Console.ask
orionis.console.Console.html#ask
Function
Method
PUBLIC
Prompt user for input and return the response.
-
orionis.console.Console.confirm
orionis.console.Console.html#confirm
Function
Method
PUBLIC
Ask for confirmation and return True or False.
-
orionis.console.Console.secret
orionis.console.Console.html#secret
Function
Method
PUBLIC
Prompt for hidden input using the provided question.
-
orionis.console.Console.table
orionis.console.Console.html#table
Function
Method
PUBLIC
Print a formatted table with bold headers and box-drawing borders.
-
orionis.console.Console.anticipate
orionis.console.Console.html#anticipate
Function
Method
PUBLIC
Provide autocomplete suggestions based on user input.
-
orionis.console.Console.choice
orionis.console.Console.html#choice
Function
Method
PUBLIC
Prompt user to select an option from a list.
-
orionis.console.Console.exception
orionis.console.Console.html#exception
Function
Method
PUBLIC
Print exception details and stack trace.
-
orionis.console.Console.exitSuccess
orionis.console.Console.html#exitSuccess
Function
Method
PUBLIC
Exit the program with a success message.
-
orionis.console.Console.exitError
orionis.console.Console.html#exitError
Function
Method
PUBLIC
Exit the program with an error message.
-
orionis.console.Console.dump
orionis.console.Console.html#dump
Function
Method
PUBLIC
Dump variable information to the console with formatting options.
-
orionis.console.Console.sleep
orionis.console.Console.html#sleep
Function
Method
PUBLIC
Asynchronously sleep for a specified number of seconds.
-
orionis.console._EXPORTS
orionis.console.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.console.__getattr__
orionis.console.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.console.__dir__
orionis.console.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.console.base.contracts.command.IBaseCommand
orionis.console.base.contracts.command.IBaseCommand.html
Class
Class
PUBLIC
Define the contract for base command implementations.
-
orionis.console.base.contracts.command.IBaseCommand.timestamps
orionis.console.base.contracts.command.IBaseCommand.html#timestamps
Attribute
Class Variable
PUBLIC
Enable timestamps in console output by default.
-
orionis.console.base.contracts.command.IBaseCommand.signature
orionis.console.base.contracts.command.IBaseCommand.html#signature
Attribute
Class Variable
PUBLIC
Command signature string for registration and help text generation.
-
orionis.console.base.contracts.command.IBaseCommand.description
orionis.console.base.contracts.command.IBaseCommand.html#description
Attribute
Class Variable
PUBLIC
Human-readable description for documentation and help display.
-
orionis.console.base.contracts.command.IBaseCommand.arguments
orionis.console.base.contracts.command.IBaseCommand.html#arguments
Attribute
Class Variable
PUBLIC
List of Argument instances defining command-line options and arguments.
-
orionis.console.base.contracts.command.IBaseCommand.handle
orionis.console.base.contracts.command.IBaseCommand.html#handle
Function
Method
PUBLIC
Run the main logic for the command.
-
orionis.console.base.contracts.command.IBaseCommand.getArgument
orionis.console.base.contracts.command.IBaseCommand.html#getArgument
Function
Method
PUBLIC
Retrieve the value of a command-line argument by key, with optional default.
-
orionis.console.base.contracts.command.IBaseCommand.getArguments
orionis.console.base.contracts.command.IBaseCommand.html#getArguments
Function
Method
PUBLIC
Return all parsed command-line arguments and options.
-
orionis.console.base.contracts.command.IBaseCommand.setArguments
orionis.console.base.contracts.command.IBaseCommand.html#setArguments
Function
Method
PUBLIC
Set the internal arguments dictionary with parsed command-line arguments.
-
orionis.console.base.command._MISSING
orionis.console.base.command.html#_MISSING
Attribute
Constant
PUBLIC
Sentinel object to distinguish between missing keys and keys with None values.
-
orionis.console.base.BaseCommand
orionis.console.base.BaseCommand.html
Class
Class
PUBLIC
Define the metadata and execution hooks shared by console commands.
-
orionis.console.base.BaseCommand.timestamps
orionis.console.base.BaseCommand.html#timestamps
Attribute
Class Variable
PUBLIC
Enable timestamps in console output by default.
-
orionis.console.base.BaseCommand.signature
orionis.console.base.BaseCommand.html#signature
Attribute
Class Variable
PUBLIC
Command signature string for registration and help text generation.
-
orionis.console.base.BaseCommand.description
orionis.console.base.BaseCommand.html#description
Attribute
Class Variable
PUBLIC
Human-readable description for documentation and help display.
-
orionis.console.base.BaseCommand.arguments
orionis.console.base.BaseCommand.html#arguments
Attribute
Class Variable
PUBLIC
List of Argument instances defining command-line options and arguments.
-
orionis.console.base.BaseCommand.__init__
orionis.console.base.BaseCommand.html#__init__
Function
Method
PUBLIC
Initialize the BaseCommand instance.
-
orionis.console.base.BaseCommand.__arguments__
orionis.console.base.BaseCommand.html#__arguments__
Attribute
Instance Variable
PUBLIC
Initialize internal argument storage for parsed CLI arguments.
-
orionis.console.base.BaseCommand.handle
orionis.console.base.BaseCommand.html#handle
Function
Method
PUBLIC
Run the main logic for the command.
-
orionis.console.base.BaseCommand.getArgument
orionis.console.base.BaseCommand.html#getArgument
Function
Method
PUBLIC
Retrieve the value of a command-line argument.
-
orionis.console.base.BaseCommand.getArguments
orionis.console.base.BaseCommand.html#getArguments
Function
Method
PUBLIC
Retrieve all parsed command-line arguments.
-
orionis.console.base.BaseCommand.setArguments
orionis.console.base.BaseCommand.html#setArguments
Function
Method
PUBLIC
Set the internal arguments dictionary with the provided arguments.
-
orionis.console.base.BaseTaskListener
orionis.console.base.BaseTaskListener.html
Class
Class
PUBLIC
Provide lifecycle hooks for scheduled task events.
-
orionis.console.base.BaseTaskListener.onTaskAdded
orionis.console.base.BaseTaskListener.html#onTaskAdded
Function
Method
PUBLIC
Handle the event when a task is added.
-
orionis.console.base.BaseTaskListener.onTaskRemoved
orionis.console.base.BaseTaskListener.html#onTaskRemoved
Function
Method
PUBLIC
Handle the event when a task is removed.
-
orionis.console.base.BaseTaskListener.onTaskExecuted
orionis.console.base.BaseTaskListener.html#onTaskExecuted
Function
Method
PUBLIC
Handle the event when a task is executed.
-
orionis.console.base.BaseTaskListener.onTaskError
orionis.console.base.BaseTaskListener.html#onTaskError
Function
Method
PUBLIC
Handle the event when a task encounters an error.
-
orionis.console.base.BaseTaskListener.onTaskMissed
orionis.console.base.BaseTaskListener.html#onTaskMissed
Function
Method
PUBLIC
Handle the event when a task is missed.
-
orionis.console.base.BaseTaskListener.onTaskSubmitted
orionis.console.base.BaseTaskListener.html#onTaskSubmitted
Function
Method
PUBLIC
Handle the event when a task is submitted.
-
orionis.console.base.BaseTaskListener.onTaskMaxInstances
orionis.console.base.BaseTaskListener.html#onTaskMaxInstances
Function
Method
PUBLIC
Handle the event when a task reaches its maximum allowed instances.
-
orionis.console.base.BaseScheduler
orionis.console.base.BaseScheduler.html
Class
Class
PUBLIC
Provide the base declaration interface for application schedules.
-
orionis.console.base.BaseScheduler.tasks
orionis.console.base.BaseScheduler.html#tasks
Function
Method
PUBLIC
Register scheduled tasks for the application.
-
orionis.console.base.BaseScheduler.onStarted
orionis.console.base.BaseScheduler.html#onStarted
Function
Method
PUBLIC
Handle the scheduler start event.
-
orionis.console.base.BaseScheduler.onPaused
orionis.console.base.BaseScheduler.html#onPaused
Function
Method
PUBLIC
Handle the scheduler pause event.
-
orionis.console.base.BaseScheduler.onResumed
orionis.console.base.BaseScheduler.html#onResumed
Function
Method
PUBLIC
Handle the scheduler resumption event.
-
orionis.console.base.BaseScheduler.onShutdown
orionis.console.base.BaseScheduler.html#onShutdown
Function
Method
PUBLIC
Handle the scheduler finalization event.
-
orionis.console.base._EXPORTS
orionis.console.base.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.console.base.__getattr__
orionis.console.base.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.console.base.__dir__
orionis.console.base.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.console.bootstrap._CONTEXTS
orionis.console.bootstrap.html#_CONTEXTS
Attribute
Constant
PUBLIC
Contexts used by bootstrap.
-
orionis.console.bootstrap._COMMANDS
orionis.console.bootstrap.html#_COMMANDS
Attribute
Constant
PUBLIC
Commands used by bootstrap.
-
orionis.console.bootstrap._RECOVERING
orionis.console.bootstrap.html#_RECOVERING
Attribute
Constant
PUBLIC
Context-local recovering isolated between asynchronous tasks.
-
orionis.console.bootstrap.bootstrap_recovery
orionis.console.bootstrap.html#bootstrap_recovery
Function
Function
PUBLIC
Enable missing route recovery only for an exact bootstrap invocation.
-
orionis.console.bootstrap.recovering_route
orionis.console.bootstrap.html#recovering_route
Function
Function
PUBLIC
Return whether this particular context is being explicitly repaired.
-
orionis.console.bootstrap.bootstrap_recovery_active
orionis.console.bootstrap.html#bootstrap_recovery_active
Function
Function
PUBLIC
Return whether transient recovery configuration must bypass caches.
-
orionis.console.startup._FRAME
orionis.console.startup.html#_FRAME
Attribute
Constant
PUBLIC
⠋ Inicializando Orionis....
-
orionis.console.startup._ASCII_FRAME
orionis.console.startup.html#_ASCII_FRAME
Attribute
Constant
PUBLIC
- Inicializando Orionis....
-
orionis.console.startup._OutputProxy
orionis.console.startup._OutputProxy.html
Class
Class
PUBLIC
Delegate output while retiring a startup message before its first write.
-
orionis.console.startup._OutputProxy.__init__
orionis.console.startup._OutputProxy.html#__init__
Function
Method
PUBLIC
Initialize a stream proxy with shared startup feedback.
-
orionis.console.startup._OutputProxy._stream
orionis.console.startup._OutputProxy.html#_stream
Attribute
Instance Variable
PUBLIC
Wrapped stream that receives delegated operations.
-
orionis.console.startup._OutputProxy.feedback
orionis.console.startup._OutputProxy.html#feedback
Attribute
Instance Variable
PUBLIC
Controller that clears the startup message before output.
-
orionis.console.startup._OutputProxy._buffer_proxy
orionis.console.startup._OutputProxy.html#_buffer_proxy
Attribute
Instance Variable
PUBLIC
Binary-stream proxy corresponding to the text output wrapper.
-
orionis.console.startup._OutputProxy.__getattr__
orionis.console.startup._OutputProxy.html#__getattr__
Function
Method
PUBLIC
Delegate an unresolved attribute to the wrapped stream.
-
orionis.console.startup._OutputProxy.buffer
orionis.console.startup._OutputProxy.html#buffer
Attribute
Property
PUBLIC
Return a cached proxy for the wrapped stream's binary buffer.
-
orionis.console.startup._OutputProxy.write
orionis.console.startup._OutputProxy.html#write
Function
Method
PUBLIC
Write data and retire feedback before nonempty output.
-
orionis.console.startup._OutputProxy.writelines
orionis.console.startup._OutputProxy.html#writelines
Function
Method
PUBLIC
Write each line through the proxy without adding separators.
-
orionis.console.startup._OutputProxy.__enter__
orionis.console.startup._OutputProxy.html#__enter__
Function
Method
PUBLIC
Enter the wrapped stream's context and return this proxy.
-
orionis.console.startup._OutputProxy.__exit__
orionis.console.startup._OutputProxy.html#__exit__
Function
Method
PUBLIC
Exit the wrapped stream's context with its exception details.
-
orionis.console.startup._StartupFeedback
orionis.console.startup._StartupFeedback.html
Class
Class
PUBLIC
Own the temporary streams and clear the message once, without a thread.
-
orionis.console.startup._StartupFeedback.__init__
orionis.console.startup._StartupFeedback.html#__init__
Function
Method
PUBLIC
Initialize inactive startup feedback and its stream proxies.
-
orionis.console.startup._StartupFeedback.stdout
orionis.console.startup._StartupFeedback.html#stdout
Attribute
Instance Variable
PUBLIC
Original standard output stream to restore after feedback.
-
orionis.console.startup._StartupFeedback.stderr
orionis.console.startup._StartupFeedback.html#stderr
Attribute
Instance Variable
PUBLIC
Original error stream used to display and clear the message.
-
orionis.console.startup._StartupFeedback.frame
orionis.console.startup._StartupFeedback.html#frame
Attribute
Instance Variable
PUBLIC
Single-line startup message to display on stderr.
-
orionis.console.startup._StartupFeedback.active
orionis.console.startup._StartupFeedback.html#active
Attribute
Instance Variable
PUBLIC
Active flag used by _StartupFeedback.
-
orionis.console.startup._StartupFeedback.lock
orionis.console.startup._StartupFeedback.html#lock
Attribute
Instance Variable
PUBLIC
Lock produced by allocate_lock.
-
orionis.console.startup._StartupFeedback.stdout_proxy
orionis.console.startup._StartupFeedback.html#stdout_proxy
Attribute
Instance Variable
PUBLIC
Stdout proxy produced by _OutputProxy.
-
orionis.console.startup._StartupFeedback.stderr_proxy
orionis.console.startup._StartupFeedback.html#stderr_proxy
Attribute
Instance Variable
PUBLIC
Stderr proxy produced by _OutputProxy.
-
orionis.console.startup._StartupFeedback.start
orionis.console.startup._StartupFeedback.html#start
Function
Method
PUBLIC
Display the startup message and install temporary stream proxies.
-
orionis.console.startup._StartupFeedback.clear
orionis.console.startup._StartupFeedback.html#clear
Function
Method
PUBLIC
Clear active feedback and restore the original standard streams.
-
orionis.console.startup._StartupFeedback.finish
orionis.console.startup._StartupFeedback.html#finish
Function
Method
PUBLIC
Retire startup feedback while holding its lock.
-
orionis.console.startup._interactive_frame
orionis.console.startup.html#_interactive_frame
Function
Function
PUBLIC
Select a startup message for an eligible interactive console.
-
orionis.console.startup.stop_startup_feedback
orionis.console.startup.html#stop_startup_feedback
Function
Function
PUBLIC
Retire active feedback before executing a resolved command.
-
orionis.console.startup.startup_feedback
orionis.console.startup.html#startup_feedback
Function
Function
PUBLIC
Show transient feedback during interactive CLI startup.
-
orionis.console.cli.main
orionis.console.cli.html#main
Function
Function
PUBLIC
Boot the local application and run CLI commands in the current process.
-
orionis.console.commands.auth.migrate.AuthMigrateCommand
orionis.console.commands.auth.migrate.AuthMigrateCommand.html
Class
Class
PUBLIC
Create the framework authentication tables without removing data.
-
orionis.console.commands.auth.migrate.AuthMigrateCommand.__slots__
orionis.console.commands.auth.migrate.AuthMigrateCommand.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.console.commands.auth.migrate.AuthMigrateCommand.timestamps
orionis.console.commands.auth.migrate.AuthMigrateCommand.html#timestamps
Attribute
Class Variable
PUBLIC
Timestamps flag used by AuthMigrateCommand.
-
orionis.console.commands.auth.migrate.AuthMigrateCommand.signature
orionis.console.commands.auth.migrate.AuthMigrateCommand.html#signature
Attribute
Class Variable
PUBLIC
auth:migrate.
-
orionis.console.commands.auth.migrate.AuthMigrateCommand.description
orionis.console.commands.auth.migrate.AuthMigrateCommand.html#description
Attribute
Class Variable
PUBLIC
Description of the authentication storage preparation command.
-
orionis.console.commands.auth.migrate.AuthMigrateCommand.handle
orionis.console.commands.auth.migrate.AuthMigrateCommand.html#handle
Function
Method
PUBLIC
Create authorization and credentials on the default SQL connection.
-
orionis.console.commands.bootstrap._editor._REPLACE_ATTEMPTS
orionis.console.commands.bootstrap._editor.html#_REPLACE_ATTEMPTS
Attribute
Constant
PUBLIC
Replace attempts value used by _editor.
-
orionis.console.commands.bootstrap._editor._REPLACE_BACKOFF_SECONDS
orionis.console.commands.bootstrap._editor.html#_REPLACE_BACKOFF_SECONDS
Attribute
Constant
PUBLIC
Replace backoff seconds value used by _editor.
-
orionis.console.commands.bootstrap._editor._WINDOWS_REPLACE_ERRORS
orionis.console.commands.bootstrap._editor.html#_WINDOWS_REPLACE_ERRORS
Attribute
Constant
PUBLIC
Access denied, sharing violation, and lock violation.
-
orionis.console.commands.bootstrap._editor.BootstrapEditError
orionis.console.commands.bootstrap._editor.BootstrapEditError.html
Class
Exception
PUBLIC
A bootstrap cannot be updated without guessing about application flow.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor
orionis.console.commands.bootstrap._editor.BootstrapEditor.html
Class
Class
PUBLIC
Plan surgical Python edits and publish them without clobbering changes.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor.__init__
orionis.console.commands.bootstrap._editor.BootstrapEditor.html#__init__
Function
Method
PUBLIC
Initialize a source-preserving application bootstrap edit session.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor.path
orionis.console.commands.bootstrap._editor.BootstrapEditor.html#path
Attribute
Instance Variable
PUBLIC
Bootstrap Python module to inspect.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor.base_path
orionis.console.commands.bootstrap._editor.BootstrapEditor.html#base_path
Attribute
Instance Variable
PUBLIC
Application root used for relative route and import paths.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor._original
orionis.console.commands.bootstrap._editor.BootstrapEditor.html#_original
Attribute
Instance Variable
PUBLIC
Original produced by self.path.read_bytes.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor.encoding
orionis.console.commands.bootstrap._editor.BootstrapEditor.html#encoding
Attribute
Instance Variable
PUBLIC
Encoding produced by tokenize.detect_encoding.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor.source
orionis.console.commands.bootstrap._editor.BootstrapEditor.html#source
Attribute
Instance Variable
PUBLIC
Source produced by self._original.decode.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor.newline
orionis.console.commands.bootstrap._editor.BootstrapEditor.html#newline
Attribute
Instance Variable
PUBLIC
Newline sequence preserved when rewriting the source file.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor.tree
orionis.console.commands.bootstrap._editor.BootstrapEditor.html#tree
Attribute
Instance Variable
PUBLIC
Tree produced by ast.parse.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor._lines
orionis.console.commands.bootstrap._editor.BootstrapEditor.html#_lines
Attribute
Instance Variable
PUBLIC
Lines produced by self.source.splitlines.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor._offsets
orionis.console.commands.bootstrap._editor.BootstrapEditor.html#_offsets
Attribute
Instance Variable
PUBLIC
Character offsets used to translate source positions into edit ranges.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor._parents
orionis.console.commands.bootstrap._editor.BootstrapEditor.html#_parents
Attribute
Instance Variable
PUBLIC
Parent node associated with each node in the parsed syntax tree.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor.assignment
orionis.console.commands.bootstrap._editor.BootstrapEditor.html#assignment
Attribute
Instance Variable
PUBLIC
Assignment produced by self._findApplication.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor.app_name
orionis.console.commands.bootstrap._editor.BootstrapEditor.html#app_name
Attribute
Instance Variable
PUBLIC
Assignment produced by self._findApplication.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor.scope
orionis.console.commands.bootstrap._editor.BootstrapEditor.html#scope
Attribute
Instance Variable
PUBLIC
Dependency-injection scope associated with the current operation.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor.body
orionis.console.commands.bootstrap._editor.BootstrapEditor.html#body
Attribute
Instance Variable
PUBLIC
HTTP response body or encoded payload returned to the client.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor._nodes
orionis.console.commands.bootstrap._editor.BootstrapEditor.html#_nodes
Attribute
Instance Variable
PUBLIC
Nodes produced by list.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor._applicationNames
orionis.console.commands.bootstrap._editor.BootstrapEditor.html#_applicationNames
Function
Method
PUBLIC
Collect supported application constructor and module aliases.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor._isConstructor
orionis.console.commands.bootstrap._editor.BootstrapEditor.html#_isConstructor
Function
Static Method
PUBLIC
Identify an application constructor beneath chained builder calls.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor._findApplication
orionis.console.commands.bootstrap._editor.BootstrapEditor.html#_findApplication
Function
Method
PUBLIC
Locate the unique named application construction assignment.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor._checkAssignments
orionis.console.commands.bootstrap._editor.BootstrapEditor.html#_checkAssignments
Function
Method
PUBLIC
Reject application reassignments that obscure the selected receiver.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor._scopeNodes
orionis.console.commands.bootstrap._editor.BootstrapEditor.html#_scopeNodes
Function
Static Method
PUBLIC
Walk a lexical scope without entering unrelated nested definitions.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor._rootName
orionis.console.commands.bootstrap._editor.BootstrapEditor.html#_rootName
Function
Static Method
PUBLIC
Resolve the named receiver beneath a fluent method-call chain.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor._position
orionis.console.commands.bootstrap._editor.BootstrapEditor.html#_position
Function
Method
PUBLIC
Translate an AST byte position into a source character offset.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor._start
orionis.console.commands.bootstrap._editor.BootstrapEditor.html#_start
Function
Method
PUBLIC
Locate the first source character belonging to a syntax node.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor._end
orionis.console.commands.bootstrap._editor.BootstrapEditor.html#_end
Function
Method
PUBLIC
Locate the source character immediately after a syntax node.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor._statement
orionis.console.commands.bootstrap._editor.BootstrapEditor.html#_statement
Function
Method
PUBLIC
Find the enclosing statement in the application construction scope.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor._calls
orionis.console.commands.bootstrap._editor.BootstrapEditor.html#_calls
Function
Method
PUBLIC
Collect editable calls to an application builder method.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor._initializerCalls
orionis.console.commands.bootstrap._editor.BootstrapEditor.html#_initializerCalls
Function
Method
PUBLIC
Collect fluent calls that construct the named application.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor._routingCall
orionis.console.commands.bootstrap._editor.BootstrapEditor.html#_routingCall
Function
Method
PUBLIC
Find the final directly editable application routing call.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor.hasRouting
orionis.console.commands.bootstrap._editor.BootstrapEditor.html#hasRouting
Attribute
Property
PUBLIC
Report whether the application exposes a directly editable routing call.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor._routingValue
orionis.console.commands.bootstrap._editor.BootstrapEditor.html#_routingValue
Function
Static Method
PUBLIC
Find a context argument in a supported routing call.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor.routePaths
orionis.console.commands.bootstrap._editor.BootstrapEditor.html#routePaths
Function
Method
PUBLIC
Read literal route paths from the effective routing configuration.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor._pathLiteral
orionis.console.commands.bootstrap._editor.BootstrapEditor.html#_pathLiteral
Function
Method
PUBLIC
Encode a route path as a project-relative Python string literal.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor._edited
orionis.console.commands.bootstrap._editor.BootstrapEditor.html#_edited
Function
Method
PUBLIC
Apply planned source edits and validate the resulting Python module.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor._before
orionis.console.commands.bootstrap._editor.BootstrapEditor.html#_before
Function
Method
PUBLIC
Plan an insertion before a statement and its leading comments.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor._after
orionis.console.commands.bootstrap._editor.BootstrapEditor.html#_after
Function
Method
PUBLIC
Plan an insertion after a standalone statement.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor._callbackImport
orionis.console.commands.bootstrap._editor.BootstrapEditor.html#_callbackImport
Function
Method
PUBLIC
Extend the visible import block without adding an empty import group.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor._registration
orionis.console.commands.bootstrap._editor.BootstrapEditor.html#_registration
Function
Method
PUBLIC
Plan registration before application initialization or factory return.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor.routing
orionis.console.commands.bootstrap._editor.BootstrapEditor.html#routing
Function
Method
PUBLIC
Register a missing route context while preserving other arguments.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor._checkIndirectRouting
orionis.console.commands.bootstrap._editor.BootstrapEditor.html#_checkIndirectRouting
Function
Method
PUBLIC
Reject later helpers that can replace the selected routing setup.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor._helperApplicationParameters
orionis.console.commands.bootstrap._editor.BootstrapEditor.html#_helperApplicationParameters
Function
Method
PUBLIC
Identify helper names that can reference the selected application.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor._helperReplacesRouting
orionis.console.commands.bootstrap._editor.BootstrapEditor.html#_helperReplacesRouting
Function
Method
PUBLIC
Detect routing mutations through helper parameters or closures.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor._appendKeyword
orionis.console.commands.bootstrap._editor.BootstrapEditor.html#_appendKeyword
Function
Method
PUBLIC
Extend a routing argument list while retaining its source layout.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor._argumentTail
orionis.console.commands.bootstrap._editor.BootstrapEditor.html#_argumentTail
Function
Method
PUBLIC
Find grouping parentheses beyond a positional argument AST node.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor._checkRoutingOrder
orionis.console.commands.bootstrap._editor.BootstrapEditor.html#_checkRoutingOrder
Function
Method
PUBLIC
Reject routing configuration placed after application initialization.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor.lifespan
orionis.console.commands.bootstrap._editor.BootstrapEditor.html#lifespan
Function
Method
PUBLIC
Import and register application callbacks before initialization.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor._lifespanBindings
orionis.console.commands.bootstrap._editor.BootstrapEditor.html#_lifespanBindings
Function
Method
PUBLIC
Recognize visible direct and module imports for lifespan callbacks.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor._hasLifespanRegistration
orionis.console.commands.bootstrap._editor.BootstrapEditor.html#_hasLifespanRegistration
Function
Method
PUBLIC
Detect existing callback registration for the selected application.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor._freshCallbackName
orionis.console.commands.bootstrap._editor.BootstrapEditor.html#_freshCallbackName
Function
Method
PUBLIC
Choose an unused callback import name in the application scope.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor._importModule
orionis.console.commands.bootstrap._editor.BootstrapEditor.html#_importModule
Function
Method
PUBLIC
Resolve an import node to its absolute application module path.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor.encode
orionis.console.commands.bootstrap._editor.BootstrapEditor.html#encode
Function
Method
PUBLIC
Encode planned source using the original coding cookie and BOM.
-
orionis.console.commands.bootstrap._editor.BootstrapEditor.commit
orionis.console.commands.bootstrap._editor.BootstrapEditor.html#commit
Function
Method
PUBLIC
Publish validated source atomically while preserving concurrent edits.
-
orionis.console.commands.bootstrap._paths.application_path
orionis.console.commands.bootstrap._paths.html#application_path
Function
Function
PUBLIC
Resolve an effective application path with the framework default.
-
orionis.console.commands.bootstrap._paths.display_path
orionis.console.commands.bootstrap._paths.html#display_path
Function
Function
PUBLIC
Format a path relative to the application when possible.
-
orionis.console.templates.stub._NAME_RE
orionis.console.templates.stub.html#_NAME_RE
Attribute
Constant
PUBLIC
Validate names containing lowercase letters, digits, and underscores.
-
orionis.console.templates.stub._EXTENSION_RE
orionis.console.templates.stub.html#_EXTENSION_RE
Attribute
Constant
PUBLIC
Compiled pattern used to recognize extension re.
-
orionis.console.templates.stub._TEMPLATE_DIR
orionis.console.templates.stub.html#_TEMPLATE_DIR
Attribute
Constant
PUBLIC
Template dir used by stub.
-
orionis.console.templates.stub._CLASS_NAME_PLACEHOLDERS
orionis.console.templates.stub.html#_CLASS_NAME_PLACEHOLDERS
Attribute
Constant
PUBLIC
Class name placeholders definitions used by stub.
-
orionis.console.templates.stub.Stub
orionis.console.templates.stub.Stub.html
Class
Class
PUBLIC
Load and render source templates used by code-generation commands.
-
orionis.console.templates.stub.Stub.__slots__
orionis.console.templates.stub.Stub.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.console.templates.stub.Stub.__init__
orionis.console.templates.stub.Stub.html#__init__
Function
Method
PUBLIC
Initialize a stub generator.
-
orionis.console.templates.stub.Stub._template_name
orionis.console.templates.stub.Stub.html#_template_name
Attribute
Instance Variable
PUBLIC
Name of the template file without its .stub suffix.
-
orionis.console.templates.stub.Stub._class_name
orionis.console.templates.stub.Stub.html#_class_name
Attribute
Instance Variable
PUBLIC
Name used to derive the generated filename and class name.
-
orionis.console.templates.stub.Stub._prefix
orionis.console.templates.stub.Stub.html#_prefix
Attribute
Instance Variable
PUBLIC
Prefix prepended to the derived filename and class name.
-
orionis.console.templates.stub.Stub._postfix
orionis.console.templates.stub.Stub.html#_postfix
Attribute
Instance Variable
PUBLIC
Suffix appended to the derived filename and class name.
-
orionis.console.templates.stub.Stub._replacements
orionis.console.templates.stub.Stub.html#_replacements
Attribute
Instance Variable
PUBLIC
Placeholder values to apply to the loaded template.
-
orionis.console.templates.stub.Stub._filename
orionis.console.templates.stub.Stub.html#_filename
Attribute
Instance Variable
PUBLIC
Filename used when rendering or storing the resource.
-
orionis.console.templates.stub.Stub._classname
orionis.console.templates.stub.Stub.html#_classname
Attribute
Instance Variable
PUBLIC
Python class name substituted into the generated source.
-
orionis.console.templates.stub.Stub._directory_parts
orionis.console.templates.stub.Stub.html#_directory_parts
Attribute
Instance Variable
PUBLIC
Path components locating the generated resource directory.
-
orionis.console.templates.stub.Stub.__parseName
orionis.console.templates.stub.Stub.html#__parseName
Function
Method
PUBLIC
Normalize a generated name and reject unsafe path components.
-
orionis.console.templates.stub.Stub.__compileFilenameAndClassname
orionis.console.templates.stub.Stub.html#__compileFilenameAndClassname
Function
Method
PUBLIC
Compile the generated filename and class name.
-
orionis.console.templates.stub.Stub.__loadTemplate
orionis.console.templates.stub.Stub.html#__loadTemplate
Function
Method
PUBLIC
Load the requested stub template.
-
orionis.console.templates.stub.Stub.__replaceTemplateContent
orionis.console.templates.stub.Stub.html#__replaceTemplateContent
Function
Method
PUBLIC
Replace placeholders in the loaded template.
-
orionis.console.templates.stub.Stub.render
orionis.console.templates.stub.Stub.html#render
Function
Method
PUBLIC
Render a packaged template without choosing a destination.
-
orionis.console.templates.stub.Stub.create
orionis.console.templates.stub.Stub.html#create
Function
Method
PUBLIC
Create the generated source file.
-
orionis.console.commands.bootstrap._service._HTTP_PATHS
orionis.console.commands.bootstrap._service.html#_HTTP_PATHS
Attribute
Constant
PUBLIC
Http paths definitions used by _service.
-
orionis.console.commands.bootstrap._service._CONTEXT_PATHS
orionis.console.commands.bootstrap._service.html#_CONTEXT_PATHS
Attribute
Constant
PUBLIC
Context paths definitions used by _service.
-
orionis.console.commands.bootstrap._service.Bootstrapper
orionis.console.commands.bootstrap._service.Bootstrapper.html
Class
Class
PUBLIC
Plan bootstrap integration before creating optional project resources.
-
orionis.console.commands.bootstrap._service.Bootstrapper.__init__
orionis.console.commands.bootstrap._service.Bootstrapper.html#__init__
Function
Method
PUBLIC
Store the configured application.
-
orionis.console.commands.bootstrap._service.Bootstrapper.app
orionis.console.commands.bootstrap._service.Bootstrapper.html#app
Attribute
Instance Variable
PUBLIC
Application providing effective routes and component paths.
-
orionis.console.commands.bootstrap._service.Bootstrapper._editor
orionis.console.commands.bootstrap._service.Bootstrapper.html#_editor
Function
Method
PUBLIC
Find the source recorded by Application.create.
-
orionis.console.commands.bootstrap._service.Bootstrapper._directory
orionis.console.commands.bootstrap._service.Bootstrapper.html#_directory
Function
Method
PUBLIC
Create a directory without changing existing resources.
-
orionis.console.commands.bootstrap._service.Bootstrapper._file
orionis.console.commands.bootstrap._service.Bootstrapper.html#_file
Function
Method
PUBLIC
Create a template exclusively, preserving existing file bytes.
-
orionis.console.commands.bootstrap._service.Bootstrapper._routingPaths
orionis.console.commands.bootstrap._service.Bootstrapper.html#_routingPaths
Function
Method
PUBLIC
Reconcile declared routes with the loaded application registry.
-
orionis.console.commands.bootstrap._service.Bootstrapper._validateRoute
orionis.console.commands.bootstrap._service.Bootstrapper.html#_validateRoute
Function
Static Method
PUBLIC
Check existing routes with the same import rules as Application.
-
orionis.console.commands.bootstrap._service.Bootstrapper.routing
orionis.console.commands.bootstrap._service.Bootstrapper.html#routing
Function
Method
PUBLIC
Enable one routing context using the application's effective paths.
-
orionis.console.commands.bootstrap._service.Bootstrapper.lifespan
orionis.console.commands.bootstrap._service.Bootstrapper.html#lifespan
Function
Method
PUBLIC
Create and register native lifecycle callbacks before application boot.
-
orionis.console.commands.bootstrap._base.BootstrapCommand
orionis.console.commands.bootstrap._base.BootstrapCommand.html
Class
Class
PUBLIC
Run component bootstrapping through native Reactor output and injection.
-
orionis.console.commands.bootstrap._base.BootstrapCommand.timestamps
orionis.console.commands.bootstrap._base.BootstrapCommand.html#timestamps
Attribute
Class Variable
PUBLIC
Timestamps flag used by BootstrapCommand.
-
orionis.console.commands.bootstrap._base.BootstrapCommand.context
orionis.console.commands.bootstrap._base.BootstrapCommand.html#context
Attribute
Class Variable
PUBLIC
Runtime context made available to the operation and its callbacks.
-
orionis.console.commands.bootstrap._base.BootstrapCommand._action_styles
orionis.console.commands.bootstrap._base.BootstrapCommand.html#_action_styles
Attribute
Class Variable
PUBLIC
Console styles assigned to bootstrap resource actions.
-
orionis.console.commands.bootstrap._base.BootstrapCommand.bootstrap
orionis.console.commands.bootstrap._base.BootstrapCommand.html#bootstrap
Function
Method
PUBLIC
Enable this command's routing context.
-
orionis.console.commands.bootstrap._base.BootstrapCommand._execute
orionis.console.commands.bootstrap._base.BootstrapCommand.html#_execute
Function
Method
PUBLIC
Generate resources and invalidate existing compiled state if changed.
-
orionis.console.commands.bootstrap._base.BootstrapCommand._writeAction
orionis.console.commands.bootstrap._base.BootstrapCommand.html#_writeAction
Function
Method
PUBLIC
Write one aligned resource action with a single colored status.
-
orionis.console.commands.bootstrap._base.BootstrapCommand.handle
orionis.console.commands.bootstrap._base.BootstrapCommand.html#handle
Function
Method
PUBLIC
Generate resources off the event loop and report the actual result.
-
orionis.console.commands.bootstrap._config._TREE_URL
orionis.console.commands.bootstrap._config.html#_TREE_URL
Attribute
Constant
PUBLIC
Tree url identifier: https://api.github.com/repos/orionis-framework/skeleton/git/trees/master?recursive=1.
-
orionis.console.commands.bootstrap._config._RAW_ROOT
orionis.console.commands.bootstrap._config.html#_RAW_ROOT
Attribute
Constant
PUBLIC
Raw root identifier: https://raw.githubusercontent.com/orionis-framework/skeleton/master/.
-
orionis.console.commands.bootstrap._config._TIMEOUT
orionis.console.commands.bootstrap._config.html#_TIMEOUT
Attribute
Constant
PUBLIC
Timeout value used by _config.
-
orionis.console.commands.bootstrap._config._SHA_LENGTH
orionis.console.commands.bootstrap._config.html#_SHA_LENGTH
Attribute
Constant
PUBLIC
Sha length value used by _config.
-
orionis.console.commands.bootstrap._config.ConfigBootstrapper
orionis.console.commands.bootstrap._config.ConfigBootstrapper.html
Class
Class
PUBLIC
Download and validate missing configuration before creating local files.
-
orionis.console.commands.bootstrap._config.ConfigBootstrapper.__init__
orionis.console.commands.bootstrap._config.ConfigBootstrapper.html#__init__
Function
Method
PUBLIC
Retain the application supplying the effective configuration path.
-
orionis.console.commands.bootstrap._config.ConfigBootstrapper.app
orionis.console.commands.bootstrap._config.ConfigBootstrapper.html#app
Attribute
Instance Variable
PUBLIC
Application supplying effective configuration paths.
-
orionis.console.commands.bootstrap._config.ConfigBootstrapper.bootstrap
orionis.console.commands.bootstrap._config.ConfigBootstrapper.html#bootstrap
Function
Method
PUBLIC
Restore selected configuration without replacing existing files.
-
orionis.console.commands.bootstrap._config.ConfigBootstrapper._selectFile
orionis.console.commands.bootstrap._config.ConfigBootstrapper.html#_selectFile
Function
Static Method
PUBLIC
Select one configuration module using the validated remote tree.
-
orionis.console.commands.bootstrap._config.ConfigBootstrapper._validateLocalResource
orionis.console.commands.bootstrap._config.ConfigBootstrapper.html#_validateLocalResource
Function
Static Method
PUBLIC
Reject a local resource whose type conflicts with the official tree.
-
orionis.console.commands.bootstrap._config.ConfigBootstrapper._createResource
orionis.console.commands.bootstrap._config.ConfigBootstrapper.html#_createResource
Function
Class Method
PUBLIC
Create one validated resource and report whether it existed.
-
orionis.console.commands.bootstrap._config.ConfigBootstrapper._blob
orionis.console.commands.bootstrap._config.ConfigBootstrapper.html#_blob
Function
Class Method
PUBLIC
Download raw bytes and verify GitHub's size and Git object hash.
-
orionis.console.commands.bootstrap._config.ConfigBootstrapper._download
orionis.console.commands.bootstrap._config.ConfigBootstrapper.html#_download
Function
Static Method
PUBLIC
Read one successful GitHub response or identify the failed resource.
-
orionis.console.commands.bootstrap._config.ConfigBootstrapper._entries
orionis.console.commands.bootstrap._config.ConfigBootstrapper.html#_entries
Function
Class Method
PUBLIC
Validate the master tree and retain regular configuration entries.
-
orionis.console.commands.bootstrap._config.ConfigBootstrapper._entryOrder
orionis.console.commands.bootstrap._config.ConfigBootstrapper.html#_entryOrder
Function
Static Method
PUBLIC
Order configuration entries by depth and then by path.
-
orionis.console.commands.bootstrap._config.ConfigBootstrapper._safeDestination
orionis.console.commands.bootstrap._config.ConfigBootstrapper.html#_safeDestination
Function
Static Method
PUBLIC
Reject links and traversal before writing any configuration resource.
-
orionis.console.commands.bootstrap.config.BootstrapConfigCommand
orionis.console.commands.bootstrap.config.BootstrapConfigCommand.html
Class
Class
PUBLIC
Recover missing official configuration files from the master branch.
-
orionis.console.commands.bootstrap.config.BootstrapConfigCommand.signature
orionis.console.commands.bootstrap.config.BootstrapConfigCommand.html#signature
Attribute
Class Variable
PUBLIC
bootstrap:config.
-
orionis.console.commands.bootstrap.config.BootstrapConfigCommand.description
orionis.console.commands.bootstrap.config.BootstrapConfigCommand.html#description
Attribute
Class Variable
PUBLIC
Restore missing configuration files from the official
master branch..
-
orionis.console.commands.bootstrap.config.BootstrapConfigCommand.arguments
orionis.console.commands.bootstrap.config.BootstrapConfigCommand.html#arguments
Attribute
Class Variable
PUBLIC
Command-line argument declarations accepted by this command.
-
orionis.console.commands.bootstrap.config.BootstrapConfigCommand.bootstrap
orionis.console.commands.bootstrap.config.BootstrapConfigCommand.html#bootstrap
Function
Method
PUBLIC
Recover missing configuration without replacing existing files.
-
orionis.console.commands.bootstrap.lifespan.BootstrapLifespanCommand
orionis.console.commands.bootstrap.lifespan.BootstrapLifespanCommand.html
Class
Class
PUBLIC
Enable native application lifespan callbacks.
-
orionis.console.commands.bootstrap.lifespan.BootstrapLifespanCommand.signature
orionis.console.commands.bootstrap.lifespan.BootstrapLifespanCommand.html#signature
Attribute
Class Variable
PUBLIC
bootstrap:lifespan.
-
orionis.console.commands.bootstrap.lifespan.BootstrapLifespanCommand.description
orionis.console.commands.bootstrap.lifespan.BootstrapLifespanCommand.html#description
Attribute
Class Variable
PUBLIC
Create and register application lifespan callbacks..
-
orionis.console.commands.bootstrap.lifespan.BootstrapLifespanCommand.bootstrap
orionis.console.commands.bootstrap.lifespan.BootstrapLifespanCommand.html#bootstrap
Function
Method
PUBLIC
Enable lifecycle callbacks.
-
orionis.console.commands.bootstrap.routes.BootstrapApiCommand
orionis.console.commands.bootstrap.routes.BootstrapApiCommand.html
Class
Class
PUBLIC
Enable API routes and their HTTP component directories.
-
orionis.console.commands.bootstrap.routes.BootstrapApiCommand.signature
orionis.console.commands.bootstrap.routes.BootstrapApiCommand.html#signature
Attribute
Class Variable
PUBLIC
Bind the native Reactor signature to the API routing context.
-
orionis.console.commands.bootstrap.routes.BootstrapApiCommand.description
orionis.console.commands.bootstrap.routes.BootstrapApiCommand.html#description
Attribute
Class Variable
PUBLIC
Create and register API routing and HTTP component
paths..
-
orionis.console.commands.bootstrap.routes.BootstrapApiCommand.context
orionis.console.commands.bootstrap.routes.BootstrapApiCommand.html#context
Attribute
Class Variable
PUBLIC
api.
-
orionis.console.commands.bootstrap.routes.BootstrapAiCommand
orionis.console.commands.bootstrap.routes.BootstrapAiCommand.html
Class
Class
PUBLIC
Enable AI routes and their MCP component directories.
-
orionis.console.commands.bootstrap.routes.BootstrapAiCommand.signature
orionis.console.commands.bootstrap.routes.BootstrapAiCommand.html#signature
Attribute
Class Variable
PUBLIC
Bind the native Reactor signature to the AI routing context.
-
orionis.console.commands.bootstrap.routes.BootstrapAiCommand.description
orionis.console.commands.bootstrap.routes.BootstrapAiCommand.html#description
Attribute
Class Variable
PUBLIC
Create and register AI routing and MCP component
paths..
-
orionis.console.commands.bootstrap.routes.BootstrapAiCommand.context
orionis.console.commands.bootstrap.routes.BootstrapAiCommand.html#context
Attribute
Class Variable
PUBLIC
ai.
-
orionis.console.commands.bootstrap.routes.BootstrapConsoleCommand
orionis.console.commands.bootstrap.routes.BootstrapConsoleCommand.html
Class
Class
PUBLIC
Enable console routes and their command component directories.
-
orionis.console.commands.bootstrap.routes.BootstrapConsoleCommand.signature
orionis.console.commands.bootstrap.routes.BootstrapConsoleCommand.html#signature
Attribute
Class Variable
PUBLIC
Bind the native Reactor signature to the console routing context.
-
orionis.console.commands.bootstrap.routes.BootstrapConsoleCommand.description
orionis.console.commands.bootstrap.routes.BootstrapConsoleCommand.html#description
Attribute
Class Variable
PUBLIC
Create and register console routing and command
paths..
-
orionis.console.commands.bootstrap.routes.BootstrapConsoleCommand.context
orionis.console.commands.bootstrap.routes.BootstrapConsoleCommand.html#context
Attribute
Class Variable
PUBLIC
console.
-
orionis.console.commands.bootstrap.routes.BootstrapWebCommand
orionis.console.commands.bootstrap.routes.BootstrapWebCommand.html
Class
Class
PUBLIC
Enable web routes and their HTTP component directories.
-
orionis.console.commands.bootstrap.routes.BootstrapWebCommand.signature
orionis.console.commands.bootstrap.routes.BootstrapWebCommand.html#signature
Attribute
Class Variable
PUBLIC
Bind the native Reactor signature to the web routing context.
-
orionis.console.commands.bootstrap.routes.BootstrapWebCommand.description
orionis.console.commands.bootstrap.routes.BootstrapWebCommand.html#description
Attribute
Class Variable
PUBLIC
Create and register web routing and HTTP component
paths..
-
orionis.console.commands.bootstrap.routes.BootstrapWebCommand.context
orionis.console.commands.bootstrap.routes.BootstrapWebCommand.html#context
Attribute
Class Variable
PUBLIC
web.
-
orionis.console.commands.bootstrap.routes.BootstrapWebsocketCommand
orionis.console.commands.bootstrap.routes.BootstrapWebsocketCommand.html
Class
Class
PUBLIC
Enable WebSocket routes and their HTTP component directories.
-
orionis.console.commands.bootstrap.routes.BootstrapWebsocketCommand.signature
orionis.console.commands.bootstrap.routes.BootstrapWebsocketCommand.html#signature
Attribute
Class Variable
PUBLIC
Bind the native Reactor signature to the WebSocket routing context.
-
orionis.console.commands.bootstrap.routes.BootstrapWebsocketCommand.description
orionis.console.commands.bootstrap.routes.BootstrapWebsocketCommand.html#description
Attribute
Class Variable
PUBLIC
Create and register WebSocket routing and HTTP
component paths..
-
orionis.console.commands.bootstrap.routes.BootstrapWebsocketCommand.context
orionis.console.commands.bootstrap.routes.BootstrapWebsocketCommand.html#context
Attribute
Class Variable
PUBLIC
websocket.
-
orionis.console.commands.cache.migrate.CacheMigrateCommand
orionis.console.commands.cache.migrate.CacheMigrateCommand.html
Class
Class
PUBLIC
Create the configured framework cache tables without removing data.
-
orionis.console.commands.cache.migrate.CacheMigrateCommand.__slots__
orionis.console.commands.cache.migrate.CacheMigrateCommand.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.console.commands.cache.migrate.CacheMigrateCommand.timestamps
orionis.console.commands.cache.migrate.CacheMigrateCommand.html#timestamps
Attribute
Class Variable
PUBLIC
Timestamps flag used by CacheMigrateCommand.
-
orionis.console.commands.cache.migrate.CacheMigrateCommand.signature
orionis.console.commands.cache.migrate.CacheMigrateCommand.html#signature
Attribute
Class Variable
PUBLIC
cache:migrate.
-
orionis.console.commands.cache.migrate.CacheMigrateCommand.description
orionis.console.commands.cache.migrate.CacheMigrateCommand.html#description
Attribute
Class Variable
PUBLIC
Create the configured database cache and lock
tables..
-
orionis.console.commands.cache.migrate.CacheMigrateCommand.handle
orionis.console.commands.cache.migrate.CacheMigrateCommand.html#handle
Function
Method
PUBLIC
Create database cache storage independently of the active cache driver.
-
orionis.console.commands.db._inspection.DatabaseInspector
orionis.console.commands.db._inspection.DatabaseInspector.html
Class
Class
PUBLIC
Inspect user objects without opening a separate database engine.
-
orionis.console.commands.db._inspection.DatabaseInspector.__slots__
orionis.console.commands.db._inspection.DatabaseInspector.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.console.commands.db._inspection.DatabaseInspector.__init__
orionis.console.commands.db._inspection.DatabaseInspector.html#__init__
Function
Method
PUBLIC
Bind inspection to a named connection.
-
orionis.console.commands.db._inspection.DatabaseInspector.name
orionis.console.commands.db._inspection.DatabaseInspector.html#name
Attribute
Instance Variable
PUBLIC
Named connection, or the configured default.
-
orionis.console.commands.db._inspection.DatabaseInspector.config
orionis.console.commands.db._inspection.DatabaseInspector.html#config
Attribute
Instance Variable
PUBLIC
Validated configuration used to construct and operate the service.
-
orionis.console.commands.db._inspection.DatabaseInspector.driver
orionis.console.commands.db._inspection.DatabaseInspector.html#driver
Attribute
Instance Variable
PUBLIC
Driver produced by resolve_driver.
-
orionis.console.commands.db._inspection.DatabaseInspector.connection
orionis.console.commands.db._inspection.DatabaseInspector.html#connection
Attribute
Instance Variable
PUBLIC
Configured connection used to store or dispatch the operation.
-
orionis.console.commands.db._inspection.DatabaseInspector.quoteIdentifier
orionis.console.commands.db._inspection.DatabaseInspector.html#quoteIdentifier
Function
Method
PUBLIC
Quote a catalog identifier using the selected SQL dialect.
-
orionis.console.commands.db._inspection.DatabaseInspector.listTables
orionis.console.commands.db._inspection.DatabaseInspector.html#listTables
Function
Method
PUBLIC
List non-system tables visible on the selected database.
-
orionis.console.commands.db._inspection.DatabaseInspector.listViews
orionis.console.commands.db._inspection.DatabaseInspector.html#listViews
Function
Method
PUBLIC
List user views visible on the selected database.
-
orionis.console.commands.db._inspection.DatabaseInspector.listMaterializedViews
orionis.console.commands.db._inspection.DatabaseInspector.html#listMaterializedViews
Function
Method
PUBLIC
List materialized views outside system schemas.
-
orionis.console.commands.db._inspection.DatabaseInspector.viewCounts
orionis.console.commands.db._inspection.DatabaseInspector.html#viewCounts
Function
Method
PUBLIC
Count ordinary and materialized views from native catalogs.
-
orionis.console.commands.db._inspection.DatabaseInspector.listTypes
orionis.console.commands.db._inspection.DatabaseInspector.html#listTypes
Function
Method
PUBLIC
List user-defined types that may be removed by db:wipe.
-
orionis.console.commands.db._inspection.DatabaseInspector.listDomains
orionis.console.commands.db._inspection.DatabaseInspector.html#listDomains
Function
Method
PUBLIC
List PostgreSQL domains, which require DROP DOMAIN.
-
orionis.console.commands.db._inspection.DatabaseInspector.databaseSize
orionis.console.commands.db._inspection.DatabaseInspector.html#databaseSize
Function
Method
PUBLIC
Return database size in bytes when available.
-
orionis.console.commands.db._inspection.DatabaseInspector.connectionCount
orionis.console.commands.db._inspection.DatabaseInspector.html#connectionCount
Function
Method
PUBLIC
Return server session count if the driver exposes it.
-
orionis.console.commands.db._inspection.DatabaseInspector.rowCount
orionis.console.commands.db._inspection.DatabaseInspector.html#rowCount
Function
Method
PUBLIC
Count rows in a table returned by the catalog.
-
orionis.console.commands.db._inspection.DatabaseInspector.tableSize
orionis.console.commands.db._inspection.DatabaseInspector.html#tableSize
Function
Method
PUBLIC
Return physical table size in bytes when exposed by the driver.
-
orionis.console.commands.db._inspection.DatabaseInspector.tableSizes
orionis.console.commands.db._inspection.DatabaseInspector.html#tableSizes
Function
Method
PUBLIC
Read physical sizes for all catalog tables in one query.
-
orionis.console.commands.db._inspection.DatabaseInspector.tableDetails
orionis.console.commands.db._inspection.DatabaseInspector.html#tableDetails
Function
Method
PUBLIC
Describe a physical table, including columns, indexes and keys.
-
orionis.console.commands.db._inspection.DatabaseInspector._findTableName
orionis.console.commands.db._inspection.DatabaseInspector.html#_findTableName
Function
Method
PUBLIC
Find a requested table with a filtered catalog query.
-
orionis.console.commands.db._inspection.DatabaseInspector._resolveTableName
orionis.console.commands.db._inspection.DatabaseInspector.html#_resolveTableName
Function
Method
PUBLIC
Match catalog names according to the driver's identifier rules.
-
orionis.console.commands.db._inspection.DatabaseInspector._sqliteDetails
orionis.console.commands.db._inspection.DatabaseInspector.html#_sqliteDetails
Function
Method
PUBLIC
Read SQLite column, index and foreign-key metadata.
-
orionis.console.commands.db._inspection.DatabaseInspector._serverDetails
orionis.console.commands.db._inspection.DatabaseInspector.html#_serverDetails
Function
Method
PUBLIC
Read server column, index and foreign-key metadata.
-
orionis.console.commands.db._inspection.DatabaseInspector._redshiftObjects
orionis.console.commands.db._inspection.DatabaseInspector.html#_redshiftObjects
Function
Method
PUBLIC
Read visible local objects without treating materialized views as tables.
-
orionis.console.commands.db._inspection.DatabaseInspector._redshiftSizeRows
orionis.console.commands.db._inspection.DatabaseInspector.html#_redshiftSizeRows
Function
Method
PUBLIC
Read native block sizes when the caller can access SVV_TABLE_INFO.
-
orionis.console.commands.db._inspection.DatabaseInspector._redshiftDetails
orionis.console.commands.db._inspection.DatabaseInspector.html#_redshiftDetails
Function
Method
PUBLIC
Read Redshift columns and informational keys without querying indexes.
-
orionis.console.output.contracts.executor.IExecutor
orionis.console.output.contracts.executor.IExecutor.html
Class
Class
PUBLIC
Define the contract for executor implementations.
-
orionis.console.output.contracts.executor.IExecutor.running
orionis.console.output.contracts.executor.IExecutor.html#running
Function
Method
PUBLIC
Log the execution of a program in the "RUNNING" state.
-
orionis.console.output.contracts.executor.IExecutor.done
orionis.console.output.contracts.executor.IExecutor.html#done
Function
Method
PUBLIC
Log the completion of a program in the "DONE" state.
-
orionis.console.output.contracts.executor.IExecutor.fail
orionis.console.output.contracts.executor.IExecutor.html#fail
Function
Method
PUBLIC
Log program execution in the "FAIL" state.
-
orionis.console.output.executor.Executor
orionis.console.output.executor.Executor.html
Class
Class
PUBLIC
Execute external commands and expose their console results.
-
orionis.console.output.executor.Executor.__getNow
orionis.console.output.executor.Executor.html#__getNow
Function
Method
PUBLIC
Return the current date and time.
-
orionis.console.output.executor.Executor.__ansiOutput
orionis.console.output.executor.Executor.html#__ansiOutput
Function
Method
PUBLIC
Output a formatted console message with timestamp, program name, and state.
-
orionis.console.output.executor.Executor.running
orionis.console.output.executor.Executor.html#running
Function
Method
PUBLIC
Log the execution of a program in the "RUNNING" state.
-
orionis.console.output.executor.Executor.done
orionis.console.output.executor.Executor.html#done
Function
Method
PUBLIC
Log the completion of a program in the "DONE" state.
-
orionis.console.output.executor.Executor.fail
orionis.console.output.executor.Executor.html#fail
Function
Method
PUBLIC
Log program execution in the "FAIL" state.
-
orionis.database.migrations.events._report_failure
orionis.database.migrations.events.html#_report_failure
Function
Function
PUBLIC
Deliver failure progress while preserving an existing execution error.
-
orionis.console.commands.migrate.base.MigrationCommand
orionis.console.commands.migrate.base.MigrationCommand.html
Class
Class
PUBLIC
Base class shared by every migration console command.
-
orionis.console.commands.migrate.base.MigrationCommand.timestamps
orionis.console.commands.migrate.base.MigrationCommand.html#timestamps
Attribute
Class Variable
PUBLIC
Indicates whether timestamps will be shown in the command output.
-
orionis.console.commands.migrate.base.MigrationCommand.arguments
orionis.console.commands.migrate.base.MigrationCommand.html#arguments
Attribute
Class Variable
PUBLIC
Every migration command targets an optional named connection.
-
orionis.console.commands.migrate.base.MigrationCommand.targetConnection
orionis.console.commands.migrate.base.MigrationCommand.html#targetConnection
Function
Method
PUBLIC
Return the connection the command was asked to run against.
-
orionis.console.commands.migrate.base.MigrationCommand.progressEvents
orionis.console.commands.migrate.base.MigrationCommand.html#progressEvents
Function
Method
PUBLIC
Build the progress callbacks rendering one line per migration.
-
orionis.console.commands.migrate.base.MigrationCommand.reportEmpty
orionis.console.commands.migrate.base.MigrationCommand.html#reportEmpty
Function
Method
PUBLIC
Report that the command had nothing to do.
-
orionis.database.migrations.discovery._discover_steps
orionis.database.migrations.discovery.html#_discover_steps
Function
Function
PUBLIC
Collect distinct step classes while rejecting ambiguous persisted names.
-
orionis.database.seeders.events.SeederEvents
orionis.database.seeders.events.SeederEvents.html
Class
Class
PUBLIC
Progress callbacks reported while migrations run.
-
orionis.database.seeders.events.SeederEvents.on_start
orionis.database.seeders.events.SeederEvents.html#on_start
Attribute
Instance Variable
PUBLIC
Invoked with the migration name right before it runs.
-
orionis.database.seeders.events.SeederEvents.on_success
orionis.database.seeders.events.SeederEvents.html#on_success
Attribute
Instance Variable
PUBLIC
Invoked with the migration name and elapsed seconds once it completes successfully.
-
orionis.database.seeders.events.SeederEvents.on_error
orionis.database.seeders.events.SeederEvents.html#on_error
Attribute
Instance Variable
PUBLIC
Invoked with the migration name and elapsed seconds when it fails, right before the exception propagates.
-
orionis.database.seeders.events.SeederEvents.started
orionis.database.seeders.events.SeederEvents.html#started
Function
Method
PUBLIC
Report that a migration is about to run.
-
orionis.database.seeders.events.SeederEvents.succeeded
orionis.database.seeders.events.SeederEvents.html#succeeded
Function
Method
PUBLIC
Report that a migration completed successfully.
-
orionis.database.seeders.events.SeederEvents.failed
orionis.database.seeders.events.SeederEvents.html#failed
Function
Method
PUBLIC
Report that a migration failed.
-
orionis.database.seeders.events.NO_EVENTS
orionis.database.seeders.events.html#NO_EVENTS
Attribute
Constant
PUBLIC
Shared instance used when the caller reports no progress at all.
-
orionis.database.seeders.runner._ClaimFailed
orionis.database.seeders.runner._ClaimFailed.html
Class
Exception
PUBLIC
Signal that inserting a seeder claim failed inside a transaction.
-
orionis.database.seeders.runner._ClaimFailed.__slots__
orionis.database.seeders.runner._ClaimFailed.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.database.seeders.runner._ClaimFailed.__init__
orionis.database.seeders.runner._ClaimFailed.html#__init__
Function
Method
PUBLIC
Retain the query error that prevented a seeder claim.
-
orionis.database.seeders.runner._ClaimFailed.error
orionis.database.seeders.runner._ClaimFailed.html#error
Attribute
Instance Variable
PUBLIC
Query failure that prevented the claim.
-
orionis.database.seeders.runner._build_seeders_table
orionis.database.seeders.runner.html#_build_seeders_table
Function
Function
PUBLIC
Build the persistent seeder tracking table definition.
-
orionis.database.seeders.runner._SEEDERS_TABLE
orionis.database.seeders.runner.html#_SEEDERS_TABLE
Attribute
Constant
PUBLIC
Seeders table used by runner.
-
orionis.console.commands.seed.seed.SeedCommand
orionis.console.commands.seed.seed.SeedCommand.html
Class
Class
PUBLIC
Apply every database seeder that has not been run yet.
-
orionis.console.commands.seed.seed.SeedCommand.signature
orionis.console.commands.seed.seed.SeedCommand.html#signature
Attribute
Class Variable
PUBLIC
seed.
-
orionis.console.commands.seed.seed.SeedCommand.description
orionis.console.commands.seed.seed.SeedCommand.html#description
Attribute
Class Variable
PUBLIC
Runs all pending database seeders..
-
orionis.console.commands.seed.seed.SeedCommand.handle
orionis.console.commands.seed.seed.SeedCommand.html#handle
Function
Method
PUBLIC
Apply pending seeders on the selected database connection.
-
orionis.console.commands.db.seed.DbSeedCommand
orionis.console.commands.db.seed.DbSeedCommand.html
Class
Class
PUBLIC
Run pending seeders through the db:seed command.
-
orionis.console.commands.db.seed.DbSeedCommand.signature
orionis.console.commands.db.seed.DbSeedCommand.html#signature
Attribute
Class Variable
PUBLIC
db:seed.
-
orionis.console.commands.db.seed.DbSeedCommand.description
orionis.console.commands.db.seed.DbSeedCommand.html#description
Attribute
Class Variable
PUBLIC
Runs all pending database seeders..
-
orionis.console.commands.db.show._KIB
orionis.console.commands.db.show.html#_KIB
Attribute
Constant
PUBLIC
Kib value used by show.
-
orionis.console.commands.db.show.format_bytes
orionis.console.commands.db.show.html#format_bytes
Function
Function
PUBLIC
Format a byte count for display.
-
orionis.console.commands.db.show.DbShowCommand
orionis.console.commands.db.show.DbShowCommand.html
Class
Class
PUBLIC
Render connection details and a table summary.
-
orionis.console.commands.db.show.DbShowCommand.timestamps
orionis.console.commands.db.show.DbShowCommand.html#timestamps
Attribute
Class Variable
PUBLIC
Timestamps flag used by DbShowCommand.
-
orionis.console.commands.db.show.DbShowCommand.signature
orionis.console.commands.db.show.DbShowCommand.html#signature
Attribute
Class Variable
PUBLIC
db:show.
-
orionis.console.commands.db.show.DbShowCommand.description
orionis.console.commands.db.show.DbShowCommand.html#description
Attribute
Class Variable
PUBLIC
Shows database information and table summaries..
-
orionis.console.commands.db.show.DbShowCommand.arguments
orionis.console.commands.db.show.DbShowCommand.html#arguments
Attribute
Class Variable
PUBLIC
Command-line argument declarations accepted by this command.
-
orionis.console.commands.db.show.DbShowCommand.handle
orionis.console.commands.db.show.DbShowCommand.html#handle
Function
Method
PUBLIC
Fetch metadata and render the database summary.
-
orionis.console.commands.db.table.DbTableCommand
orionis.console.commands.db.table.DbTableCommand.html
Class
Class
PUBLIC
Render a table schema summary.
-
orionis.console.commands.db.table.DbTableCommand.timestamps
orionis.console.commands.db.table.DbTableCommand.html#timestamps
Attribute
Class Variable
PUBLIC
Timestamps flag used by DbTableCommand.
-
orionis.console.commands.db.table.DbTableCommand.signature
orionis.console.commands.db.table.DbTableCommand.html#signature
Attribute
Class Variable
PUBLIC
db:table.
-
orionis.console.commands.db.table.DbTableCommand.description
orionis.console.commands.db.table.DbTableCommand.html#description
Attribute
Class Variable
PUBLIC
Shows columns, indexes and keys for a database
table..
-
orionis.console.commands.db.table.DbTableCommand.arguments
orionis.console.commands.db.table.DbTableCommand.html#arguments
Attribute
Class Variable
PUBLIC
Command-line argument declarations accepted by this command.
-
orionis.console.commands.db.table.DbTableCommand.handle
orionis.console.commands.db.table.DbTableCommand.html#handle
Function
Method
PUBLIC
Inspect the requested table and render its schema details.
-
orionis.console.commands.db.wipe.WipeResult
orionis.console.commands.db.wipe.WipeResult.html
Class
Class
PUBLIC
Store counts for objects removed by a database wipe.
-
orionis.console.commands.db.wipe.WipeResult.tables
orionis.console.commands.db.wipe.WipeResult.html#tables
Attribute
Class Variable
PUBLIC
Number of database tables removed by the wipe operation.
-
orionis.console.commands.db.wipe.WipeResult.views
orionis.console.commands.db.wipe.WipeResult.html#views
Attribute
Class Variable
PUBLIC
Number of database views removed by the wipe operation.
-
orionis.console.commands.db.wipe.WipeResult.types
orionis.console.commands.db.wipe.WipeResult.html#types
Attribute
Class Variable
PUBLIC
Number of user-defined database types removed by the wipe operation.
-
orionis.console.commands.db.wipe.DatabaseWiper
orionis.console.commands.db.wipe.DatabaseWiper.html
Class
Class
PUBLIC
Remove user-defined objects from a selected connection.
-
orionis.console.commands.db.wipe.DatabaseWiper.__slots__
orionis.console.commands.db.wipe.DatabaseWiper.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.console.commands.db.wipe.DatabaseWiper.__init__
orionis.console.commands.db.wipe.DatabaseWiper.html#__init__
Function
Method
PUBLIC
Keep the inspector used for the wipe.
-
orionis.console.commands.db.wipe.DatabaseWiper._inspector
orionis.console.commands.db.wipe.DatabaseWiper.html#_inspector
Attribute
Instance Variable
PUBLIC
Inspector for the target database connection.
-
orionis.console.commands.db.wipe.DatabaseWiper.wipe
orionis.console.commands.db.wipe.DatabaseWiper.html#wipe
Function
Method
PUBLIC
Remove all discoverable user objects from the selected database.
-
orionis.console.commands.db.wipe.DatabaseWiper._wipeMysql
orionis.console.commands.db.wipe.DatabaseWiper.html#_wipeMysql
Function
Method
PUBLIC
Temporarily disable foreign-key checks while removing MySQL objects.
-
orionis.console.commands.db.wipe.DatabaseWiper._dropMaterializedViews
orionis.console.commands.db.wipe.DatabaseWiper.html#_dropMaterializedViews
Function
Method
PUBLIC
Drop materialized views before regular views and tables.
-
orionis.console.commands.db.wipe.DatabaseWiper._dropDomains
orionis.console.commands.db.wipe.DatabaseWiper.html#_dropDomains
Function
Method
PUBLIC
Drop PostgreSQL domains.
-
orionis.console.commands.db.wipe.DatabaseWiper._dropViews
orionis.console.commands.db.wipe.DatabaseWiper.html#_dropViews
Function
Method
PUBLIC
Drop listed views.
-
orionis.console.commands.db.wipe.DatabaseWiper._dropTables
orionis.console.commands.db.wipe.DatabaseWiper.html#_dropTables
Function
Method
PUBLIC
Drop listed tables.
-
orionis.console.commands.db.wipe.DatabaseWiper._dropTypes
orionis.console.commands.db.wipe.DatabaseWiper.html#_dropTypes
Function
Method
PUBLIC
Drop listed schema types.
-
orionis.console.commands.db.wipe.DatabaseWiper._orderSqlserverTypes
orionis.console.commands.db.wipe.DatabaseWiper.html#_orderSqlserverTypes
Function
Method
PUBLIC
Order SQL Server user-defined types before their dependencies.
-
orionis.console.commands.db.wipe.DatabaseWiper._prepareOracleTypes
orionis.console.commands.db.wipe.DatabaseWiper.html#_prepareOracleTypes
Function
Method
PUBLIC
Validate and order Oracle types for safe deletion.
-
orionis.console.commands.db.wipe.DatabaseWiper._dependencyOrder
orionis.console.commands.db.wipe.DatabaseWiper.html#_dependencyOrder
Function
Static Method
PUBLIC
Order objects so dependencies are removed after their dependents.
-
orionis.console.commands.db.wipe.DatabaseWiper._dropSqlserverViews
orionis.console.commands.db.wipe.DatabaseWiper.html#_dropSqlserverViews
Function
Method
PUBLIC
Drop SQL Server views in dependency-safe order.
-
orionis.console.commands.db.wipe.DatabaseWiper._disableSqlserverTemporalTables
orionis.console.commands.db.wipe.DatabaseWiper.html#_disableSqlserverTemporalTables
Function
Method
PUBLIC
Disable system versioning for temporal tables before dropping them.
-
orionis.console.commands.db.wipe.DatabaseWiper._dropSqlserverForeignKeys
orionis.console.commands.db.wipe.DatabaseWiper.html#_dropSqlserverForeignKeys
Function
Method
PUBLIC
Remove foreign keys before dropping SQL Server tables.
-
orionis.console.commands.db.wipe.DbWipeCommand
orionis.console.commands.db.wipe.DbWipeCommand.html
Class
Class
PUBLIC
Wipe a database connection after confirmation.
-
orionis.console.commands.db.wipe.DbWipeCommand.signature
orionis.console.commands.db.wipe.DbWipeCommand.html#signature
Attribute
Class Variable
PUBLIC
db:wipe.
-
orionis.console.commands.db.wipe.DbWipeCommand.description
orionis.console.commands.db.wipe.DbWipeCommand.html#description
Attribute
Class Variable
PUBLIC
Drop all user tables, views, and types in a
database..
-
orionis.console.commands.db.wipe.DbWipeCommand.arguments
orionis.console.commands.db.wipe.DbWipeCommand.html#arguments
Attribute
Class Variable
PUBLIC
Command-line argument declarations accepted by this command.
-
orionis.console.commands.db.wipe.DbWipeCommand.handle
orionis.console.commands.db.wipe.DbWipeCommand.html#handle
Function
Method
PUBLIC
Confirm and wipe the selected database connection.
-
orionis.console.commands.make._base.MakeStubCommand
orionis.console.commands.make._base.MakeStubCommand.html
Class
Class
PUBLIC
Create application files from packaged stubs.
-
orionis.console.commands.make._base.MakeStubCommand.template_name
orionis.console.commands.make._base.MakeStubCommand.html#template_name
Attribute
Class Variable
PUBLIC
Name of the source template rendered by the generator.
-
orionis.console.commands.make._base.MakeStubCommand.path_key
orionis.console.commands.make._base.MakeStubCommand.html#path_key
Attribute
Class Variable
PUBLIC
Application path key selecting the destination directory.
-
orionis.console.commands.make._base.MakeStubCommand.success_label
orionis.console.commands.make._base.MakeStubCommand.html#success_label
Attribute
Class Variable
PUBLIC
Resource label displayed after successful generation.
-
orionis.console.commands.make._base.MakeStubCommand.prefix
orionis.console.commands.make._base.MakeStubCommand.html#prefix
Attribute
Class Variable
PUBLIC
Prefix applied when constructing names or storage keys.
-
orionis.console.commands.make._base.MakeStubCommand.postfix
orionis.console.commands.make._base.MakeStubCommand.html#postfix
Attribute
Class Variable
PUBLIC
Suffix appended to the generated resource name.
-
orionis.console.commands.make._base.MakeStubCommand.replacement_arguments
orionis.console.commands.make._base.MakeStubCommand.html#replacement_arguments
Attribute
Class Variable
PUBLIC
Command arguments forwarded to template placeholder replacement.
-
orionis.console.commands.make._base.MakeStubCommand.arguments
orionis.console.commands.make._base.MakeStubCommand.html#arguments
Attribute
Class Variable
PUBLIC
Command-line argument declarations accepted by this command.
-
orionis.console.commands.make._base.MakeStubCommand.getTemplateName
orionis.console.commands.make._base.MakeStubCommand.html#getTemplateName
Function
Method
PUBLIC
Return the selected template name.
-
orionis.console.commands.make._base.MakeStubCommand.getReplacements
orionis.console.commands.make._base.MakeStubCommand.html#getReplacements
Function
Method
PUBLIC
Read string replacements from the parsed command arguments.
-
orionis.console.commands.make._base.MakeStubCommand.createFile
orionis.console.commands.make._base.MakeStubCommand.html#createFile
Function
Method
PUBLIC
Render one stub into its configured application directory.
-
orionis.console.commands.make._base.MakeStubCommand.createFiles
orionis.console.commands.make._base.MakeStubCommand.html#createFiles
Function
Method
PUBLIC
Create the files produced by this command.
-
orionis.console.commands.make._base.MakeStubCommand.handle
orionis.console.commands.make._base.MakeStubCommand.html#handle
Function
Method
PUBLIC
Create configured files without blocking the running event loop.
-
orionis.console.fluent.contracts.command.ICommand
orionis.console.fluent.contracts.command.ICommand.html
Class
Class
PUBLIC
Define the contract for command implementations.
-
orionis.console.fluent.contracts.command.ICommand.timestamp
orionis.console.fluent.contracts.command.ICommand.html#timestamp
Function
Method
PUBLIC
Configure timestamp display for command output.
-
orionis.console.fluent.contracts.command.ICommand.description
orionis.console.fluent.contracts.command.ICommand.html#description
Function
Method
PUBLIC
Set description for the command.
-
orionis.console.fluent.contracts.command.ICommand.arguments
orionis.console.fluent.contracts.command.ICommand.html#arguments
Function
Method
PUBLIC
Set CLI arguments for the command.
-
orionis.console.fluent.contracts.command.ICommand.get
orionis.console.fluent.contracts.command.ICommand.html#get
Function
Method
PUBLIC
Retrieve configured Command entity.
-
orionis.console.core.contracts.reactor.IReactor
orionis.console.core.contracts.reactor.IReactor.html
Class
Class
PUBLIC
Define the contract for reactor implementations.
-
orionis.console.core.contracts.reactor.IReactor.command
orionis.console.core.contracts.reactor.IReactor.html#command
Function
Method
PUBLIC
Register a fluent command with the given signature and handler.
-
orionis.console.core.contracts.reactor.IReactor.hasCommand
orionis.console.core.contracts.reactor.IReactor.html#hasCommand
Function
Method
PUBLIC
Check whether a command signature is registered.
-
orionis.console.core.contracts.reactor.IReactor.info
orionis.console.core.contracts.reactor.IReactor.html#info
Function
Method
PUBLIC
Return registered commands metadata.
-
orionis.console.core.contracts.reactor.IReactor.call
orionis.console.core.contracts.reactor.IReactor.html#call
Function
Method
PUBLIC
Execute a registered command by its signature.
-
orionis.console.commands.make.console._SIGNATURE_RE
orionis.console.commands.make.console.html#_SIGNATURE_RE
Attribute
Constant
PUBLIC
Compiled pattern used to recognize signature re.
-
orionis.console.commands.make.console.MakeConsoleCommand
orionis.console.commands.make.console.MakeConsoleCommand.html
Class
Class
PUBLIC
Generate a custom command for the Orionis CLI.
-
orionis.console.commands.make.console.MakeConsoleCommand.timestamps
orionis.console.commands.make.console.MakeConsoleCommand.html#timestamps
Attribute
Class Variable
PUBLIC
Timestamps flag used by MakeConsoleCommand.
-
orionis.console.commands.make.console.MakeConsoleCommand.signature
orionis.console.commands.make.console.MakeConsoleCommand.html#signature
Attribute
Class Variable
PUBLIC
make:console-command.
-
orionis.console.commands.make.console.MakeConsoleCommand.description
orionis.console.commands.make.console.MakeConsoleCommand.html#description
Attribute
Class Variable
PUBLIC
Creates a new custom console command..
-
orionis.console.commands.make.console.MakeConsoleCommand.template_name
orionis.console.commands.make.console.MakeConsoleCommand.html#template_name
Attribute
Class Variable
PUBLIC
console_command.
-
orionis.console.commands.make.console.MakeConsoleCommand.path_key
orionis.console.commands.make.console.MakeConsoleCommand.html#path_key
Attribute
Class Variable
PUBLIC
app_console_commands.
-
orionis.console.commands.make.console.MakeConsoleCommand.success_label
orionis.console.commands.make.console.MakeConsoleCommand.html#success_label
Attribute
Class Variable
PUBLIC
Console command.
-
orionis.console.commands.make.console.MakeConsoleCommand.postfix
orionis.console.commands.make.console.MakeConsoleCommand.html#postfix
Attribute
Class Variable
PUBLIC
Command.
-
orionis.console.commands.make.console.MakeConsoleCommand.replacement_arguments
orionis.console.commands.make.console.MakeConsoleCommand.html#replacement_arguments
Attribute
Class Variable
PUBLIC
Command arguments forwarded to template placeholder replacement.
-
orionis.console.commands.make.console.MakeConsoleCommand.arguments
orionis.console.commands.make.console.MakeConsoleCommand.html#arguments
Attribute
Class Variable
PUBLIC
Command-line argument declarations accepted by this command.
-
orionis.console.commands.make.console.MakeConsoleCommand.getReplacements
orionis.console.commands.make.console.MakeConsoleCommand.html#getReplacements
Function
Method
PUBLIC
Return the signature and description placeholders.
-
orionis.console.commands.make.console.MakeConsoleCommand.handle
orionis.console.commands.make.console.MakeConsoleCommand.html#handle
Function
Method
PUBLIC
Validate a command signature and create its file on a worker thread.
-
orionis.console.commands.make.console_listener.MakeConsoleListener
orionis.console.commands.make.console_listener.MakeConsoleListener.html
Class
Class
PUBLIC
Generate a console task listener class.
-
orionis.console.commands.make.console_listener.MakeConsoleListener.timestamps
orionis.console.commands.make.console_listener.MakeConsoleListener.html#timestamps
Attribute
Class Variable
PUBLIC
Timestamps flag used by MakeConsoleListener.
-
orionis.console.commands.make.console_listener.MakeConsoleListener.signature
orionis.console.commands.make.console_listener.MakeConsoleListener.html#signature
Attribute
Class Variable
PUBLIC
make:console-listener.
-
orionis.console.commands.make.console_listener.MakeConsoleListener.description
orionis.console.commands.make.console_listener.MakeConsoleListener.html#description
Attribute
Class Variable
PUBLIC
Creates a new console task listener class..
-
orionis.console.commands.make.console_listener.MakeConsoleListener.template_name
orionis.console.commands.make.console_listener.MakeConsoleListener.html#template_name
Attribute
Class Variable
PUBLIC
console_listener.
-
orionis.console.commands.make.console_listener.MakeConsoleListener.path_key
orionis.console.commands.make.console_listener.MakeConsoleListener.html#path_key
Attribute
Class Variable
PUBLIC
app_console_listeners.
-
orionis.console.commands.make.console_listener.MakeConsoleListener.success_label
orionis.console.commands.make.console_listener.MakeConsoleListener.html#success_label
Attribute
Class Variable
PUBLIC
Console task listener.
-
orionis.console.commands.make.console_listener.MakeConsoleListener.postfix
orionis.console.commands.make.console_listener.MakeConsoleListener.html#postfix
Attribute
Class Variable
PUBLIC
Listener.
-
orionis.console.commands.make.contract.MakeContract
orionis.console.commands.make.contract.MakeContract.html
Class
Class
PUBLIC
Generate an application contract class.
-
orionis.console.commands.make.contract.MakeContract.timestamps
orionis.console.commands.make.contract.MakeContract.html#timestamps
Attribute
Class Variable
PUBLIC
Timestamps flag used by MakeContract.
-
orionis.console.commands.make.contract.MakeContract.signature
orionis.console.commands.make.contract.MakeContract.html#signature
Attribute
Class Variable
PUBLIC
make:contract.
-
orionis.console.commands.make.contract.MakeContract.description
orionis.console.commands.make.contract.MakeContract.html#description
Attribute
Class Variable
PUBLIC
Creates a new contract class..
-
orionis.console.commands.make.contract.MakeContract.template_name
orionis.console.commands.make.contract.MakeContract.html#template_name
Attribute
Class Variable
PUBLIC
contract.
-
orionis.console.commands.make.contract.MakeContract.path_key
orionis.console.commands.make.contract.MakeContract.html#path_key
Attribute
Class Variable
PUBLIC
app_contracts.
-
orionis.console.commands.make.contract.MakeContract.success_label
orionis.console.commands.make.contract.MakeContract.html#success_label
Attribute
Class Variable
PUBLIC
Contract.
-
orionis.console.commands.make.contract.MakeContract.prefix
orionis.console.commands.make.contract.MakeContract.html#prefix
Attribute
Class Variable
PUBLIC
I.
-
orionis.console.commands.make.database_migration.MakeDatabaseMigration
orionis.console.commands.make.database_migration.MakeDatabaseMigration.html
Class
Class
PUBLIC
Generate a migration named for its creation date and time.
-
orionis.console.commands.make.database_migration.MakeDatabaseMigration.timestamps
orionis.console.commands.make.database_migration.MakeDatabaseMigration.html#timestamps
Attribute
Class Variable
PUBLIC
Timestamps flag used by MakeDatabaseMigration.
-
orionis.console.commands.make.database_migration.MakeDatabaseMigration.signature
orionis.console.commands.make.database_migration.MakeDatabaseMigration.html#signature
Attribute
Class Variable
PUBLIC
make:database-migration.
-
orionis.console.commands.make.database_migration.MakeDatabaseMigration.description
orionis.console.commands.make.database_migration.MakeDatabaseMigration.html#description
Attribute
Class Variable
PUBLIC
Creates a timestamped database migration..
-
orionis.console.commands.make.database_migration.MakeDatabaseMigration.template_name
orionis.console.commands.make.database_migration.MakeDatabaseMigration.html#template_name
Attribute
Class Variable
PUBLIC
database_migration.
-
orionis.console.commands.make.database_migration.MakeDatabaseMigration.path_key
orionis.console.commands.make.database_migration.MakeDatabaseMigration.html#path_key
Attribute
Class Variable
PUBLIC
database_migrations.
-
orionis.console.commands.make.database_migration.MakeDatabaseMigration.success_label
orionis.console.commands.make.database_migration.MakeDatabaseMigration.html#success_label
Attribute
Class Variable
PUBLIC
Database migration.
-
orionis.console.commands.make.database_migration.MakeDatabaseMigration.createFiles
orionis.console.commands.make.database_migration.MakeDatabaseMigration.html#createFiles
Function
Method
PUBLIC
Create a migration with a timestamp from the application timezone.
-
orionis.console.commands.make.database_schema.MakeDatabaseSchema
orionis.console.commands.make.database_schema.MakeDatabaseSchema.html
Class
Class
PUBLIC
Generate a reusable database table definition module.
-
orionis.console.commands.make.database_schema.MakeDatabaseSchema.timestamps
orionis.console.commands.make.database_schema.MakeDatabaseSchema.html#timestamps
Attribute
Class Variable
PUBLIC
Timestamps flag used by MakeDatabaseSchema.
-
orionis.console.commands.make.database_schema.MakeDatabaseSchema.signature
orionis.console.commands.make.database_schema.MakeDatabaseSchema.html#signature
Attribute
Class Variable
PUBLIC
make:database-schema.
-
orionis.console.commands.make.database_schema.MakeDatabaseSchema.description
orionis.console.commands.make.database_schema.MakeDatabaseSchema.html#description
Attribute
Class Variable
PUBLIC
Creates a reusable database table schema..
-
orionis.console.commands.make.database_schema.MakeDatabaseSchema.template_name
orionis.console.commands.make.database_schema.MakeDatabaseSchema.html#template_name
Attribute
Class Variable
PUBLIC
database_schema.
-
orionis.console.commands.make.database_schema.MakeDatabaseSchema.path_key
orionis.console.commands.make.database_schema.MakeDatabaseSchema.html#path_key
Attribute
Class Variable
PUBLIC
database_schemas.
-
orionis.console.commands.make.database_schema.MakeDatabaseSchema.success_label
orionis.console.commands.make.database_schema.MakeDatabaseSchema.html#success_label
Attribute
Class Variable
PUBLIC
Database schema.
-
orionis.console.commands.make.database_schema.MakeDatabaseSchema.postfix
orionis.console.commands.make.database_schema.MakeDatabaseSchema.html#postfix
Attribute
Class Variable
PUBLIC
Schema.
-
orionis.console.commands.make.database_seeder.MakeDatabaseSeeder
orionis.console.commands.make.database_seeder.MakeDatabaseSeeder.html
Class
Class
PUBLIC
Generate an application database seeder.
-
orionis.console.commands.make.database_seeder.MakeDatabaseSeeder.timestamps
orionis.console.commands.make.database_seeder.MakeDatabaseSeeder.html#timestamps
Attribute
Class Variable
PUBLIC
Timestamps flag used by MakeDatabaseSeeder.
-
orionis.console.commands.make.database_seeder.MakeDatabaseSeeder.signature
orionis.console.commands.make.database_seeder.MakeDatabaseSeeder.html#signature
Attribute
Class Variable
PUBLIC
make:database-seeder.
-
orionis.console.commands.make.database_seeder.MakeDatabaseSeeder.description
orionis.console.commands.make.database_seeder.MakeDatabaseSeeder.html#description
Attribute
Class Variable
PUBLIC
Creates a database seeder..
-
orionis.console.commands.make.database_seeder.MakeDatabaseSeeder.template_name
orionis.console.commands.make.database_seeder.MakeDatabaseSeeder.html#template_name
Attribute
Class Variable
PUBLIC
database_seeder.
-
orionis.console.commands.make.database_seeder.MakeDatabaseSeeder.path_key
orionis.console.commands.make.database_seeder.MakeDatabaseSeeder.html#path_key
Attribute
Class Variable
PUBLIC
database_seeders.
-
orionis.console.commands.make.database_seeder.MakeDatabaseSeeder.success_label
orionis.console.commands.make.database_seeder.MakeDatabaseSeeder.html#success_label
Attribute
Class Variable
PUBLIC
Database seeder.
-
orionis.console.commands.make.database_seeder.MakeDatabaseSeeder.postfix
orionis.console.commands.make.database_seeder.MakeDatabaseSeeder.html#postfix
Attribute
Class Variable
PUBLIC
Seeder.
-
orionis.console.commands.make.facade.MakeFacade
orionis.console.commands.make.facade.MakeFacade.html
Class
Class
PUBLIC
Generate a facade and its typing interface.
-
orionis.console.commands.make.facade.MakeFacade.timestamps
orionis.console.commands.make.facade.MakeFacade.html#timestamps
Attribute
Class Variable
PUBLIC
Timestamps flag used by MakeFacade.
-
orionis.console.commands.make.facade.MakeFacade.signature
orionis.console.commands.make.facade.MakeFacade.html#signature
Attribute
Class Variable
PUBLIC
make:facade.
-
orionis.console.commands.make.facade.MakeFacade.description
orionis.console.commands.make.facade.MakeFacade.html#description
Attribute
Class Variable
PUBLIC
Creates a new facade class and interface..
-
orionis.console.commands.make.facade.MakeFacade.template_name
orionis.console.commands.make.facade.MakeFacade.html#template_name
Attribute
Class Variable
PUBLIC
facade.
-
orionis.console.commands.make.facade.MakeFacade.path_key
orionis.console.commands.make.facade.MakeFacade.html#path_key
Attribute
Class Variable
PUBLIC
app_facades.
-
orionis.console.commands.make.facade.MakeFacade.success_label
orionis.console.commands.make.facade.MakeFacade.html#success_label
Attribute
Class Variable
PUBLIC
Facade.
-
orionis.console.commands.make.facade.MakeFacade.arguments
orionis.console.commands.make.facade.MakeFacade.html#arguments
Attribute
Class Variable
PUBLIC
Command-line argument declarations accepted by this command.
-
orionis.console.commands.make.facade.MakeFacade.getReplacements
orionis.console.commands.make.facade.MakeFacade.html#getReplacements
Function
Method
PUBLIC
Return a Python string literal for the configured accessor.
-
orionis.console.commands.make.facade.MakeFacade.createFiles
orionis.console.commands.make.facade.MakeFacade.html#createFiles
Function
Method
PUBLIC
Create a facade implementation and its .pyi interface.
-
orionis.console.commands.make.factory._NAME_RE
orionis.console.commands.make.factory.html#_NAME_RE
Attribute
Constant
PUBLIC
Compiled pattern used to recognize name re.
-
orionis.console.commands.make.factory._ACRONYM_RE
orionis.console.commands.make.factory.html#_ACRONYM_RE
Attribute
Constant
PUBLIC
Compiled pattern used to recognize acronym re.
-
orionis.console.commands.make.factory._CAMEL_RE
orionis.console.commands.make.factory.html#_CAMEL_RE
Attribute
Constant
PUBLIC
Compiled pattern used to recognize camel re.
-
orionis.console.commands.make.factory._parse_name
orionis.console.commands.make.factory.html#_parse_name
Function
Function
PUBLIC
Parse a relative Python name into module components and a class name.
-
orionis.console.commands.make.factory.MakeFactory
orionis.console.commands.make.factory.MakeFactory.html
Class
Class
PUBLIC
Generate an explicitly imported factory for an application model.
-
orionis.console.commands.make.factory.MakeFactory.__slots__
orionis.console.commands.make.factory.MakeFactory.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.console.commands.make.factory.MakeFactory.timestamps
orionis.console.commands.make.factory.MakeFactory.html#timestamps
Attribute
Class Variable
PUBLIC
Timestamps flag used by MakeFactory.
-
orionis.console.commands.make.factory.MakeFactory.signature
orionis.console.commands.make.factory.MakeFactory.html#signature
Attribute
Class Variable
PUBLIC
make:factory.
-
orionis.console.commands.make.factory.MakeFactory.description
orionis.console.commands.make.factory.MakeFactory.html#description
Attribute
Class Variable
PUBLIC
Creates a model factory in the database directory..
-
orionis.console.commands.make.factory.MakeFactory.template_name
orionis.console.commands.make.factory.MakeFactory.html#template_name
Attribute
Class Variable
PUBLIC
factory.
-
orionis.console.commands.make.factory.MakeFactory.path_key
orionis.console.commands.make.factory.MakeFactory.html#path_key
Attribute
Class Variable
PUBLIC
database_factories.
-
orionis.console.commands.make.factory.MakeFactory.success_label
orionis.console.commands.make.factory.MakeFactory.html#success_label
Attribute
Class Variable
PUBLIC
Model factory.
-
orionis.console.commands.make.factory.MakeFactory.postfix
orionis.console.commands.make.factory.MakeFactory.html#postfix
Attribute
Class Variable
PUBLIC
Factory.
-
orionis.console.commands.make.factory.MakeFactory.arguments
orionis.console.commands.make.factory.MakeFactory.html#arguments
Attribute
Class Variable
PUBLIC
Command-line argument declarations accepted by this command.
-
orionis.console.commands.make.factory.MakeFactory.createFiles
orionis.console.commands.make.factory.MakeFactory.html#createFiles
Function
Method
PUBLIC
Create a factory using the configured model and factory directories.
-
orionis.console.commands.make.http_controller._RESOURCE_ACTIONS
orionis.console.commands.make.http_controller.html#_RESOURCE_ACTIONS
Attribute
Constant
PUBLIC
Resource actions definitions used by http_controller.
-
orionis.console.commands.make.http_controller.MakeHttpController
orionis.console.commands.make.http_controller.MakeHttpController.html
Class
Class
PUBLIC
Generate an invokable or resource HTTP controller.
-
orionis.console.commands.make.http_controller.MakeHttpController.timestamps
orionis.console.commands.make.http_controller.MakeHttpController.html#timestamps
Attribute
Class Variable
PUBLIC
Timestamps flag used by MakeHttpController.
-
orionis.console.commands.make.http_controller.MakeHttpController.signature
orionis.console.commands.make.http_controller.MakeHttpController.html#signature
Attribute
Class Variable
PUBLIC
make:http-controller.
-
orionis.console.commands.make.http_controller.MakeHttpController.description
orionis.console.commands.make.http_controller.MakeHttpController.html#description
Attribute
Class Variable
PUBLIC
Creates an invokable or resource HTTP controller..
-
orionis.console.commands.make.http_controller.MakeHttpController.template_name
orionis.console.commands.make.http_controller.MakeHttpController.html#template_name
Attribute
Class Variable
PUBLIC
http_controller.
-
orionis.console.commands.make.http_controller.MakeHttpController.path_key
orionis.console.commands.make.http_controller.MakeHttpController.html#path_key
Attribute
Class Variable
PUBLIC
app_http_controllers.
-
orionis.console.commands.make.http_controller.MakeHttpController.success_label
orionis.console.commands.make.http_controller.MakeHttpController.html#success_label
Attribute
Class Variable
PUBLIC
HTTP controller.
-
orionis.console.commands.make.http_controller.MakeHttpController.postfix
orionis.console.commands.make.http_controller.MakeHttpController.html#postfix
Attribute
Class Variable
PUBLIC
Controller.
-
orionis.console.commands.make.http_controller.MakeHttpController.arguments
orionis.console.commands.make.http_controller.MakeHttpController.html#arguments
Attribute
Class Variable
PUBLIC
Command-line argument declarations accepted by this command.
-
orionis.console.commands.make.http_controller.MakeHttpController.getControllerMethods
orionis.console.commands.make.http_controller.MakeHttpController.html#getControllerMethods
Function
Method
PUBLIC
Build documented asynchronous controller action declarations.
-
orionis.console.commands.make.http_controller.MakeHttpController.getReplacements
orionis.console.commands.make.http_controller.MakeHttpController.html#getReplacements
Function
Method
PUBLIC
Return the imports and action declarations for the controller.
-
orionis.console.commands.make.http_middleware.MakeHttpMiddleware
orionis.console.commands.make.http_middleware.MakeHttpMiddleware.html
Class
Class
PUBLIC
Generate an HTTP middleware class.
-
orionis.console.commands.make.http_middleware.MakeHttpMiddleware.timestamps
orionis.console.commands.make.http_middleware.MakeHttpMiddleware.html#timestamps
Attribute
Class Variable
PUBLIC
Timestamps flag used by MakeHttpMiddleware.
-
orionis.console.commands.make.http_middleware.MakeHttpMiddleware.signature
orionis.console.commands.make.http_middleware.MakeHttpMiddleware.html#signature
Attribute
Class Variable
PUBLIC
make:http-middleware.
-
orionis.console.commands.make.http_middleware.MakeHttpMiddleware.description
orionis.console.commands.make.http_middleware.MakeHttpMiddleware.html#description
Attribute
Class Variable
PUBLIC
Creates a new HTTP middleware class..
-
orionis.console.commands.make.http_middleware.MakeHttpMiddleware.template_name
orionis.console.commands.make.http_middleware.MakeHttpMiddleware.html#template_name
Attribute
Class Variable
PUBLIC
http_middleware.
-
orionis.console.commands.make.http_middleware.MakeHttpMiddleware.path_key
orionis.console.commands.make.http_middleware.MakeHttpMiddleware.html#path_key
Attribute
Class Variable
PUBLIC
app_http_middleware.
-
orionis.console.commands.make.http_middleware.MakeHttpMiddleware.success_label
orionis.console.commands.make.http_middleware.MakeHttpMiddleware.html#success_label
Attribute
Class Variable
PUBLIC
HTTP middleware.
-
orionis.console.commands.make.http_middleware.MakeHttpMiddleware.postfix
orionis.console.commands.make.http_middleware.MakeHttpMiddleware.html#postfix
Attribute
Class Variable
PUBLIC
Middleware.
-
orionis.console.commands.make.http_schema.MakeHttpSchema
orionis.console.commands.make.http_schema.MakeHttpSchema.html
Class
Class
PUBLIC
Generate an HTTP validation schema class.
-
orionis.console.commands.make.http_schema.MakeHttpSchema.timestamps
orionis.console.commands.make.http_schema.MakeHttpSchema.html#timestamps
Attribute
Class Variable
PUBLIC
Timestamps flag used by MakeHttpSchema.
-
orionis.console.commands.make.http_schema.MakeHttpSchema.signature
orionis.console.commands.make.http_schema.MakeHttpSchema.html#signature
Attribute
Class Variable
PUBLIC
make:http-schema.
-
orionis.console.commands.make.http_schema.MakeHttpSchema.description
orionis.console.commands.make.http_schema.MakeHttpSchema.html#description
Attribute
Class Variable
PUBLIC
Creates a custom HTTP validation schema..
-
orionis.console.commands.make.http_schema.MakeHttpSchema.template_name
orionis.console.commands.make.http_schema.MakeHttpSchema.html#template_name
Attribute
Class Variable
PUBLIC
http_schema.
-
orionis.console.commands.make.http_schema.MakeHttpSchema.path_key
orionis.console.commands.make.http_schema.MakeHttpSchema.html#path_key
Attribute
Class Variable
PUBLIC
app_http_schemas.
-
orionis.console.commands.make.http_schema.MakeHttpSchema.success_label
orionis.console.commands.make.http_schema.MakeHttpSchema.html#success_label
Attribute
Class Variable
PUBLIC
HTTP schema.
-
orionis.console.commands.make.http_schema.MakeHttpSchema.postfix
orionis.console.commands.make.http_schema.MakeHttpSchema.html#postfix
Attribute
Class Variable
PUBLIC
Schema.
-
orionis.console.commands.make.http_schema_rule.MakeHttpSchemaRule
orionis.console.commands.make.http_schema_rule.MakeHttpSchemaRule.html
Class
Class
PUBLIC
Generate a custom HTTP validation rule class.
-
orionis.console.commands.make.http_schema_rule.MakeHttpSchemaRule.timestamps
orionis.console.commands.make.http_schema_rule.MakeHttpSchemaRule.html#timestamps
Attribute
Class Variable
PUBLIC
Timestamps flag used by MakeHttpSchemaRule.
-
orionis.console.commands.make.http_schema_rule.MakeHttpSchemaRule.signature
orionis.console.commands.make.http_schema_rule.MakeHttpSchemaRule.html#signature
Attribute
Class Variable
PUBLIC
make:http-schema-rule.
-
orionis.console.commands.make.http_schema_rule.MakeHttpSchemaRule.description
orionis.console.commands.make.http_schema_rule.MakeHttpSchemaRule.html#description
Attribute
Class Variable
PUBLIC
Creates a custom validation rule..
-
orionis.console.commands.make.http_schema_rule.MakeHttpSchemaRule.template_name
orionis.console.commands.make.http_schema_rule.MakeHttpSchemaRule.html#template_name
Attribute
Class Variable
PUBLIC
http_schema_rule.
-
orionis.console.commands.make.http_schema_rule.MakeHttpSchemaRule.path_key
orionis.console.commands.make.http_schema_rule.MakeHttpSchemaRule.html#path_key
Attribute
Class Variable
PUBLIC
app_http_schemas_rules.
-
orionis.console.commands.make.http_schema_rule.MakeHttpSchemaRule.success_label
orionis.console.commands.make.http_schema_rule.MakeHttpSchemaRule.html#success_label
Attribute
Class Variable
PUBLIC
HTTP schema rule.
-
orionis.console.commands.make.http_schema_rule.MakeHttpSchemaRule.postfix
orionis.console.commands.make.http_schema_rule.MakeHttpSchemaRule.html#postfix
Attribute
Class Variable
PUBLIC
Rule.
-
orionis.console.commands.make.job.MakeJob
orionis.console.commands.make.job.MakeJob.html
Class
Class
PUBLIC
Generate a serializable application job.
-
orionis.console.commands.make.job.MakeJob.__slots__
orionis.console.commands.make.job.MakeJob.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.console.commands.make.job.MakeJob.timestamps
orionis.console.commands.make.job.MakeJob.html#timestamps
Attribute
Class Variable
PUBLIC
Timestamps flag used by MakeJob.
-
orionis.console.commands.make.job.MakeJob.signature
orionis.console.commands.make.job.MakeJob.html#signature
Attribute
Class Variable
PUBLIC
make:job.
-
orionis.console.commands.make.job.MakeJob.description
orionis.console.commands.make.job.MakeJob.html#description
Attribute
Class Variable
PUBLIC
Create an asynchronous queue job..
-
orionis.console.commands.make.job.MakeJob.template_name
orionis.console.commands.make.job.MakeJob.html#template_name
Attribute
Class Variable
PUBLIC
job.
-
orionis.console.commands.make.job.MakeJob.path_key
orionis.console.commands.make.job.MakeJob.html#path_key
Attribute
Class Variable
PUBLIC
app_jobs.
-
orionis.console.commands.make.job.MakeJob.success_label
orionis.console.commands.make.job.MakeJob.html#success_label
Attribute
Class Variable
PUBLIC
Job.
-
orionis.console.commands.make.job.MakeJob.postfix
orionis.console.commands.make.job.MakeJob.html#postfix
Attribute
Class Variable
PUBLIC
Job.
-
orionis.console.commands.make.mail.MakeMail
orionis.console.commands.make.mail.MakeMail.html
Class
Class
PUBLIC
Generate a reusable Mailable class.
-
orionis.console.commands.make.mail.MakeMail.timestamps
orionis.console.commands.make.mail.MakeMail.html#timestamps
Attribute
Class Variable
PUBLIC
Timestamps flag used by MakeMail.
-
orionis.console.commands.make.mail.MakeMail.signature
orionis.console.commands.make.mail.MakeMail.html#signature
Attribute
Class Variable
PUBLIC
make:mail.
-
orionis.console.commands.make.mail.MakeMail.description
orionis.console.commands.make.mail.MakeMail.html#description
Attribute
Class Variable
PUBLIC
Creates a reusable mail notification class..
-
orionis.console.commands.make.mail.MakeMail.template_name
orionis.console.commands.make.mail.MakeMail.html#template_name
Attribute
Class Variable
PUBLIC
mail.
-
orionis.console.commands.make.mail.MakeMail.path_key
orionis.console.commands.make.mail.MakeMail.html#path_key
Attribute
Class Variable
PUBLIC
app_notifications.
-
orionis.console.commands.make.mail.MakeMail.success_label
orionis.console.commands.make.mail.MakeMail.html#success_label
Attribute
Class Variable
PUBLIC
Mail.
-
orionis.console.commands.make.mail.MakeMail.postfix
orionis.console.commands.make.mail.MakeMail.html#postfix
Attribute
Class Variable
PUBLIC
Mail.
-
orionis.console.commands.make.mcp.MakeMcpServer
orionis.console.commands.make.mcp.MakeMcpServer.html
Class
Class
PUBLIC
Generate a transport-independent MCP server declaration.
-
orionis.console.commands.make.mcp.MakeMcpServer.timestamps
orionis.console.commands.make.mcp.MakeMcpServer.html#timestamps
Attribute
Class Variable
PUBLIC
Timestamps flag used by MakeMcpServer.
-
orionis.console.commands.make.mcp.MakeMcpServer.signature
orionis.console.commands.make.mcp.MakeMcpServer.html#signature
Attribute
Class Variable
PUBLIC
make:mcp-server.
-
orionis.console.commands.make.mcp.MakeMcpServer.description
orionis.console.commands.make.mcp.MakeMcpServer.html#description
Attribute
Class Variable
PUBLIC
Create a new MCP server..
-
orionis.console.commands.make.mcp.MakeMcpServer.template_name
orionis.console.commands.make.mcp.MakeMcpServer.html#template_name
Attribute
Class Variable
PUBLIC
mcp_server.
-
orionis.console.commands.make.mcp.MakeMcpServer.path_key
orionis.console.commands.make.mcp.MakeMcpServer.html#path_key
Attribute
Class Variable
PUBLIC
app_mcp_servers.
-
orionis.console.commands.make.mcp.MakeMcpServer.success_label
orionis.console.commands.make.mcp.MakeMcpServer.html#success_label
Attribute
Class Variable
PUBLIC
MCP server.
-
orionis.console.commands.make.mcp.MakeMcpServer.postfix
orionis.console.commands.make.mcp.MakeMcpServer.html#postfix
Attribute
Class Variable
PUBLIC
Server.
-
orionis.console.commands.make.mcp.MakeMcpTool
orionis.console.commands.make.mcp.MakeMcpTool.html
Class
Class
PUBLIC
Generate a typed MCP tool with a native Orionis input schema.
-
orionis.console.commands.make.mcp.MakeMcpTool.timestamps
orionis.console.commands.make.mcp.MakeMcpTool.html#timestamps
Attribute
Class Variable
PUBLIC
Timestamps flag used by MakeMcpTool.
-
orionis.console.commands.make.mcp.MakeMcpTool.signature
orionis.console.commands.make.mcp.MakeMcpTool.html#signature
Attribute
Class Variable
PUBLIC
make:mcp-tool.
-
orionis.console.commands.make.mcp.MakeMcpTool.description
orionis.console.commands.make.mcp.MakeMcpTool.html#description
Attribute
Class Variable
PUBLIC
Create a new MCP tool..
-
orionis.console.commands.make.mcp.MakeMcpTool.template_name
orionis.console.commands.make.mcp.MakeMcpTool.html#template_name
Attribute
Class Variable
PUBLIC
mcp_tool.
-
orionis.console.commands.make.mcp.MakeMcpTool.path_key
orionis.console.commands.make.mcp.MakeMcpTool.html#path_key
Attribute
Class Variable
PUBLIC
app_mcp_tools.
-
orionis.console.commands.make.mcp.MakeMcpTool.success_label
orionis.console.commands.make.mcp.MakeMcpTool.html#success_label
Attribute
Class Variable
PUBLIC
MCP tool.
-
orionis.console.commands.make.mcp.MakeMcpTool.postfix
orionis.console.commands.make.mcp.MakeMcpTool.html#postfix
Attribute
Class Variable
PUBLIC
Tool.
-
orionis.console.commands.make.mcp.MakeMcpResource
orionis.console.commands.make.mcp.MakeMcpResource.html
Class
Class
PUBLIC
Generate an explicitly addressed MCP resource.
-
orionis.console.commands.make.mcp.MakeMcpResource.timestamps
orionis.console.commands.make.mcp.MakeMcpResource.html#timestamps
Attribute
Class Variable
PUBLIC
Timestamps flag used by MakeMcpResource.
-
orionis.console.commands.make.mcp.MakeMcpResource.signature
orionis.console.commands.make.mcp.MakeMcpResource.html#signature
Attribute
Class Variable
PUBLIC
make:mcp-resource.
-
orionis.console.commands.make.mcp.MakeMcpResource.description
orionis.console.commands.make.mcp.MakeMcpResource.html#description
Attribute
Class Variable
PUBLIC
Create a new MCP resource..
-
orionis.console.commands.make.mcp.MakeMcpResource.template_name
orionis.console.commands.make.mcp.MakeMcpResource.html#template_name
Attribute
Class Variable
PUBLIC
mcp_resource.
-
orionis.console.commands.make.mcp.MakeMcpResource.path_key
orionis.console.commands.make.mcp.MakeMcpResource.html#path_key
Attribute
Class Variable
PUBLIC
app_mcp_resources.
-
orionis.console.commands.make.mcp.MakeMcpResource.success_label
orionis.console.commands.make.mcp.MakeMcpResource.html#success_label
Attribute
Class Variable
PUBLIC
MCP resource.
-
orionis.console.commands.make.mcp.MakeMcpResource.postfix
orionis.console.commands.make.mcp.MakeMcpResource.html#postfix
Attribute
Class Variable
PUBLIC
Resource.
-
orionis.console.commands.make.mcp.MakeMcpPrompt
orionis.console.commands.make.mcp.MakeMcpPrompt.html
Class
Class
PUBLIC
Generate an MCP prompt declaration and asynchronous handler.
-
orionis.console.commands.make.mcp.MakeMcpPrompt.timestamps
orionis.console.commands.make.mcp.MakeMcpPrompt.html#timestamps
Attribute
Class Variable
PUBLIC
Timestamps flag used by MakeMcpPrompt.
-
orionis.console.commands.make.mcp.MakeMcpPrompt.signature
orionis.console.commands.make.mcp.MakeMcpPrompt.html#signature
Attribute
Class Variable
PUBLIC
make:mcp-prompt.
-
orionis.console.commands.make.mcp.MakeMcpPrompt.description
orionis.console.commands.make.mcp.MakeMcpPrompt.html#description
Attribute
Class Variable
PUBLIC
Create a new MCP prompt..
-
orionis.console.commands.make.mcp.MakeMcpPrompt.template_name
orionis.console.commands.make.mcp.MakeMcpPrompt.html#template_name
Attribute
Class Variable
PUBLIC
mcp_prompt.
-
orionis.console.commands.make.mcp.MakeMcpPrompt.path_key
orionis.console.commands.make.mcp.MakeMcpPrompt.html#path_key
Attribute
Class Variable
PUBLIC
app_mcp_prompts.
-
orionis.console.commands.make.mcp.MakeMcpPrompt.success_label
orionis.console.commands.make.mcp.MakeMcpPrompt.html#success_label
Attribute
Class Variable
PUBLIC
MCP prompt.
-
orionis.console.commands.make.mcp.MakeMcpPrompt.postfix
orionis.console.commands.make.mcp.MakeMcpPrompt.html#postfix
Attribute
Class Variable
PUBLIC
Prompt.
-
orionis.console.commands.make.model.MakeModel
orionis.console.commands.make.model.MakeModel.html
Class
Class
PUBLIC
Generate an ORM model class.
-
orionis.console.commands.make.model.MakeModel.timestamps
orionis.console.commands.make.model.MakeModel.html#timestamps
Attribute
Class Variable
PUBLIC
Timestamps flag used by MakeModel.
-
orionis.console.commands.make.model.MakeModel.signature
orionis.console.commands.make.model.MakeModel.html#signature
Attribute
Class Variable
PUBLIC
make:model.
-
orionis.console.commands.make.model.MakeModel.description
orionis.console.commands.make.model.MakeModel.html#description
Attribute
Class Variable
PUBLIC
Creates a new ORM model class..
-
orionis.console.commands.make.model.MakeModel.template_name
orionis.console.commands.make.model.MakeModel.html#template_name
Attribute
Class Variable
PUBLIC
model.
-
orionis.console.commands.make.model.MakeModel.path_key
orionis.console.commands.make.model.MakeModel.html#path_key
Attribute
Class Variable
PUBLIC
app_models.
-
orionis.console.commands.make.model.MakeModel.success_label
orionis.console.commands.make.model.MakeModel.html#success_label
Attribute
Class Variable
PUBLIC
Model.
-
orionis.console.commands.make.provider.MakeProvider
orionis.console.commands.make.provider.MakeProvider.html
Class
Class
PUBLIC
Generate an eager or deferred application provider.
-
orionis.console.commands.make.provider.MakeProvider.timestamps
orionis.console.commands.make.provider.MakeProvider.html#timestamps
Attribute
Class Variable
PUBLIC
Timestamps flag used by MakeProvider.
-
orionis.console.commands.make.provider.MakeProvider.signature
orionis.console.commands.make.provider.MakeProvider.html#signature
Attribute
Class Variable
PUBLIC
make:provider.
-
orionis.console.commands.make.provider.MakeProvider.description
orionis.console.commands.make.provider.MakeProvider.html#description
Attribute
Class Variable
PUBLIC
Creates a new provider class file..
-
orionis.console.commands.make.provider.MakeProvider.template_name
orionis.console.commands.make.provider.MakeProvider.html#template_name
Attribute
Class Variable
PUBLIC
provider_eager.
-
orionis.console.commands.make.provider.MakeProvider.path_key
orionis.console.commands.make.provider.MakeProvider.html#path_key
Attribute
Class Variable
PUBLIC
app_providers.
-
orionis.console.commands.make.provider.MakeProvider.success_label
orionis.console.commands.make.provider.MakeProvider.html#success_label
Attribute
Class Variable
PUBLIC
Provider.
-
orionis.console.commands.make.provider.MakeProvider.postfix
orionis.console.commands.make.provider.MakeProvider.html#postfix
Attribute
Class Variable
PUBLIC
Provider.
-
orionis.console.commands.make.provider.MakeProvider.arguments
orionis.console.commands.make.provider.MakeProvider.html#arguments
Attribute
Class Variable
PUBLIC
Command-line argument declarations accepted by this command.
-
orionis.console.commands.make.provider.MakeProvider.getTemplateName
orionis.console.commands.make.provider.MakeProvider.html#getTemplateName
Function
Method
PUBLIC
Select the provider template from the deferred option.
-
orionis.console.commands.make.realtime.MakeRealtimeSocket
orionis.console.commands.make.realtime.MakeRealtimeSocket.html
Class
Class
PUBLIC
Generate an invokable realtime WebSocket handler.
-
orionis.console.commands.make.realtime.MakeRealtimeSocket.timestamps
orionis.console.commands.make.realtime.MakeRealtimeSocket.html#timestamps
Attribute
Class Variable
PUBLIC
Timestamps flag used by MakeRealtimeSocket.
-
orionis.console.commands.make.realtime.MakeRealtimeSocket.signature
orionis.console.commands.make.realtime.MakeRealtimeSocket.html#signature
Attribute
Class Variable
PUBLIC
make:realtime-socket.
-
orionis.console.commands.make.realtime.MakeRealtimeSocket.description
orionis.console.commands.make.realtime.MakeRealtimeSocket.html#description
Attribute
Class Variable
PUBLIC
Creates a new realtime WebSocket handler..
-
orionis.console.commands.make.realtime.MakeRealtimeSocket.template_name
orionis.console.commands.make.realtime.MakeRealtimeSocket.html#template_name
Attribute
Class Variable
PUBLIC
realtime_socket.
-
orionis.console.commands.make.realtime.MakeRealtimeSocket.path_key
orionis.console.commands.make.realtime.MakeRealtimeSocket.html#path_key
Attribute
Class Variable
PUBLIC
app_realtime_sockets.
-
orionis.console.commands.make.realtime.MakeRealtimeSocket.success_label
orionis.console.commands.make.realtime.MakeRealtimeSocket.html#success_label
Attribute
Class Variable
PUBLIC
Realtime socket.
-
orionis.console.commands.make.realtime.MakeRealtimeSocket.postfix
orionis.console.commands.make.realtime.MakeRealtimeSocket.html#postfix
Attribute
Class Variable
PUBLIC
Socket.
-
orionis.console.commands.make.realtime.MakeRealtimeHub
orionis.console.commands.make.realtime.MakeRealtimeHub.html
Class
Class
PUBLIC
Generate a realtime hub with a typed remote operation.
-
orionis.console.commands.make.realtime.MakeRealtimeHub.timestamps
orionis.console.commands.make.realtime.MakeRealtimeHub.html#timestamps
Attribute
Class Variable
PUBLIC
Timestamps flag used by MakeRealtimeHub.
-
orionis.console.commands.make.realtime.MakeRealtimeHub.signature
orionis.console.commands.make.realtime.MakeRealtimeHub.html#signature
Attribute
Class Variable
PUBLIC
make:realtime-hub.
-
orionis.console.commands.make.realtime.MakeRealtimeHub.description
orionis.console.commands.make.realtime.MakeRealtimeHub.html#description
Attribute
Class Variable
PUBLIC
Creates a new realtime hub..
-
orionis.console.commands.make.realtime.MakeRealtimeHub.template_name
orionis.console.commands.make.realtime.MakeRealtimeHub.html#template_name
Attribute
Class Variable
PUBLIC
realtime_hub.
-
orionis.console.commands.make.realtime.MakeRealtimeHub.path_key
orionis.console.commands.make.realtime.MakeRealtimeHub.html#path_key
Attribute
Class Variable
PUBLIC
app_realtime_hubs.
-
orionis.console.commands.make.realtime.MakeRealtimeHub.success_label
orionis.console.commands.make.realtime.MakeRealtimeHub.html#success_label
Attribute
Class Variable
PUBLIC
Realtime hub.
-
orionis.console.commands.make.realtime.MakeRealtimeHub.postfix
orionis.console.commands.make.realtime.MakeRealtimeHub.html#postfix
Attribute
Class Variable
PUBLIC
Hub.
-
orionis.console.commands.make.service.MakeService
orionis.console.commands.make.service.MakeService.html
Class
Class
PUBLIC
Generate an application service class.
-
orionis.console.commands.make.service.MakeService.timestamps
orionis.console.commands.make.service.MakeService.html#timestamps
Attribute
Class Variable
PUBLIC
Timestamps flag used by MakeService.
-
orionis.console.commands.make.service.MakeService.signature
orionis.console.commands.make.service.MakeService.html#signature
Attribute
Class Variable
PUBLIC
make:service.
-
orionis.console.commands.make.service.MakeService.description
orionis.console.commands.make.service.MakeService.html#description
Attribute
Class Variable
PUBLIC
Creates a new service class..
-
orionis.console.commands.make.service.MakeService.template_name
orionis.console.commands.make.service.MakeService.html#template_name
Attribute
Class Variable
PUBLIC
service.
-
orionis.console.commands.make.service.MakeService.path_key
orionis.console.commands.make.service.MakeService.html#path_key
Attribute
Class Variable
PUBLIC
app_services.
-
orionis.console.commands.make.service.MakeService.success_label
orionis.console.commands.make.service.MakeService.html#success_label
Attribute
Class Variable
PUBLIC
Service.
-
orionis.console.commands.make.test.MakeTest
orionis.console.commands.make.test.MakeTest.html
Class
Class
PUBLIC
Generate an application test case.
-
orionis.console.commands.make.test.MakeTest.timestamps
orionis.console.commands.make.test.MakeTest.html#timestamps
Attribute
Class Variable
PUBLIC
Timestamps flag used by MakeTest.
-
orionis.console.commands.make.test.MakeTest.signature
orionis.console.commands.make.test.MakeTest.html#signature
Attribute
Class Variable
PUBLIC
make:test.
-
orionis.console.commands.make.test.MakeTest.description
orionis.console.commands.make.test.MakeTest.html#description
Attribute
Class Variable
PUBLIC
Creates a new application test case..
-
orionis.console.commands.make.test.MakeTest.template_name
orionis.console.commands.make.test.MakeTest.html#template_name
Attribute
Class Variable
PUBLIC
test.
-
orionis.console.commands.make.test.MakeTest.path_key
orionis.console.commands.make.test.MakeTest.html#path_key
Attribute
Class Variable
PUBLIC
tests.
-
orionis.console.commands.make.test.MakeTest.success_label
orionis.console.commands.make.test.MakeTest.html#success_label
Attribute
Class Variable
PUBLIC
Test.
-
orionis.console.commands.make.test.MakeTest.createFiles
orionis.console.commands.make.test.MakeTest.html#createFiles
Function
Method
PUBLIC
Create a test module with a discoverable filename.
-
orionis.http.routes.contracts.fluent.IFluentRoute
orionis.http.routes.contracts.fluent.IFluentRoute.html
Class
Class
PUBLIC
Define the contract for fluent route implementations.
-
orionis.http.routes.contracts.fluent.IFluentRoute.id
orionis.http.routes.contracts.fluent.IFluentRoute.html#id
Attribute
Property
PUBLIC
Return the unique identifier of the route.
-
orionis.http.routes.contracts.fluent.IFluentRoute.action
orionis.http.routes.contracts.fluent.IFluentRoute.html#action
Function
Method
PUBLIC
Set the controller class and handler for the route.
-
orionis.http.routes.contracts.fluent.IFluentRoute.name
orionis.http.routes.contracts.fluent.IFluentRoute.html#name
Function
Method
PUBLIC
Set the name for the route.
-
orionis.http.routes.contracts.fluent.IFluentRoute.public
orionis.http.routes.contracts.fluent.IFluentRoute.html#public
Function
Method
PUBLIC
Select a stateless route without automatic session or identity setup.
-
orionis.http.routes.contracts.fluent.IFluentRoute.middleware
orionis.http.routes.contracts.fluent.IFluentRoute.html#middleware
Function
Method
PUBLIC
Add middleware to the route.
-
orionis.http.routes.contracts.fluent.IFluentRoute.withOutMiddleware
orionis.http.routes.contracts.fluent.IFluentRoute.html#withOutMiddleware
Function
Method
PUBLIC
Exclude one or more middleware classes from the route.
-
orionis.http.routes.contracts.fluent.IFluentRoute.prefix
orionis.http.routes.contracts.fluent.IFluentRoute.html#prefix
Function
Method
PUBLIC
Prepend a path segment to the route's current path.
-
orionis.http.routes.contracts.fluent.IFluentRoute.export
orionis.http.routes.contracts.fluent.IFluentRoute.html#export
Function
Method
PUBLIC
Export a complete route configuration as a plain dictionary.
-
orionis.http.routes.enums.protocols.RouteProtocol
orionis.http.routes.enums.protocols.RouteProtocol.html
Class
Class
PUBLIC
Identify a route's transport independently of its handler action type.
-
orionis.http.routes.enums.protocols.RouteProtocol.HTTP
orionis.http.routes.enums.protocols.RouteProtocol.html#HTTP
Attribute
Constant
PUBLIC
http.
-
orionis.http.routes.enums.protocols.RouteProtocol.WEBSOCKET
orionis.http.routes.enums.protocols.RouteProtocol.html#WEBSOCKET
Attribute
Constant
PUBLIC
websocket.
-
orionis.http.routes.route_id._next_id
orionis.http.routes.route_id.html#_next_id
Attribute
Variable
PUBLIC
Advance the process-local route sequence.
-
orionis.http.routes.route_id._pid
orionis.http.routes.route_id.html#_pid
Attribute
Variable
PUBLIC
Include the process identifier in generated route identifiers.
-
orionis.http.routes.route_id.RouteID
orionis.http.routes.route_id.RouteID.html
Class
Class
PUBLIC
Generate process-qualified identifiers for registered routes.
-
orionis.http.routes.route_id.RouteID.__slots__
orionis.http.routes.route_id.RouteID.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.http.routes.route_id.RouteID.next
orionis.http.routes.route_id.RouteID.html#next
Function
Static Method
PUBLIC
Generate a unique route identifier.
-
orionis.http.routes.fluent.FluentRoute
orionis.http.routes.fluent.FluentRoute.html
Class
Class
PUBLIC
Build route definitions through chainable routing options.
-
orionis.http.routes.fluent.FluentRoute.__method
orionis.http.routes.fluent.FluentRoute.html#__method
Attribute
Instance Variable
PUBLIC
HTTP method (e.g., 'GET', 'POST').
-
orionis.http.routes.fluent.FluentRoute.__path
orionis.http.routes.fluent.FluentRoute.html#__path
Attribute
Instance Variable
PUBLIC
Route path.
-
orionis.http.routes.fluent.FluentRoute.__id
orionis.http.routes.fluent.FluentRoute.html#__id
Attribute
Instance Variable
PUBLIC
Identifier used to correlate or locate this protocol or storage record.
-
orionis.http.routes.fluent.FluentRoute.__class
orionis.http.routes.fluent.FluentRoute.html#__class
Attribute
Instance Variable
PUBLIC
Controller class selected to handle the route.
-
orionis.http.routes.fluent.FluentRoute.__handler
orionis.http.routes.fluent.FluentRoute.html#__handler
Attribute
Instance Variable
PUBLIC
Callable or method selected to handle the registered operation.
-
orionis.http.routes.fluent.FluentRoute.__callable_handler
orionis.http.routes.fluent.FluentRoute.html#__callable_handler
Attribute
Instance Variable
PUBLIC
Direct callable selected as the route action.
-
orionis.http.routes.fluent.FluentRoute.__name
orionis.http.routes.fluent.FluentRoute.html#__name
Attribute
Instance Variable
PUBLIC
Name identifying this declaration within its containing registry.
-
orionis.http.routes.fluent.FluentRoute.__middleware
orionis.http.routes.fluent.FluentRoute.html#__middleware
Attribute
Instance Variable
PUBLIC
Middleware applied around the route handler.
-
orionis.http.routes.fluent.FluentRoute.__without_middleware
orionis.http.routes.fluent.FluentRoute.html#__without_middleware
Attribute
Instance Variable
PUBLIC
Without middleware produced by set.
-
orionis.http.routes.fluent.FluentRoute.__kind
orionis.http.routes.fluent.FluentRoute.html#__kind
Attribute
Instance Variable
PUBLIC
Kind identifier: web.
-
orionis.http.routes.fluent.FluentRoute.__public
orionis.http.routes.fluent.FluentRoute.html#__public
Attribute
Instance Variable
PUBLIC
Whether the route is marked for public access.
-
orionis.http.routes.fluent.FluentRoute.__view
orionis.http.routes.fluent.FluentRoute.html#__view
Attribute
Instance Variable
PUBLIC
Template name rendered directly by the kernel. When given, the route carries no Python handler and action is not parsed.
-
orionis.http.routes.fluent.FluentRoute.__hub
orionis.http.routes.fluent.FluentRoute.html#__hub
Attribute
Instance Variable
PUBLIC
Realtime hub class attached to the route.
-
orionis.http.routes.fluent.FluentRoute.__hub_protocol
orionis.http.routes.fluent.FluentRoute.html#__hub_protocol
Attribute
Instance Variable
PUBLIC
Wire protocol selected for the realtime hub route.
-
orionis.http.routes.fluent.FluentRoute._ALLOWED_METHODS
orionis.http.routes.fluent.FluentRoute.html#_ALLOWED_METHODS
Attribute
Constant
PUBLIC
Allowed methods used by FluentRoute.
-
orionis.http.routes.fluent.FluentRoute.__init__
orionis.http.routes.fluent.FluentRoute.html#__init__
Function
Method
PUBLIC
Initialize a FluentRoute instance.
-
orionis.http.routes.fluent.FluentRoute.path
orionis.http.routes.fluent.FluentRoute.html#path
Attribute
Property
PUBLIC
Return the current canonical path, including inherited prefixes.
-
orionis.http.routes.fluent.FluentRoute.id
orionis.http.routes.fluent.FluentRoute.html#id
Attribute
Property
PUBLIC
Return the unique identifier of the route.
-
orionis.http.routes.fluent.FluentRoute.action
orionis.http.routes.fluent.FluentRoute.html#action
Function
Method
PUBLIC
Set the controller class and handler for the route.
-
orionis.http.routes.fluent.FluentRoute._hub
orionis.http.routes.fluent.FluentRoute.html#_hub
Function
Method
PUBLIC
Set the Hub class and its fixed connection codec.
-
orionis.http.routes.fluent.FluentRoute.name
orionis.http.routes.fluent.FluentRoute.html#name
Function
Method
PUBLIC
Set the name for the route.
-
orionis.http.routes.fluent.FluentRoute.public
orionis.http.routes.fluent.FluentRoute.html#public
Function
Method
PUBLIC
Select a stateless route without automatic session or identity setup.
-
orionis.http.routes.fluent.FluentRoute.middleware
orionis.http.routes.fluent.FluentRoute.html#middleware
Function
Method
PUBLIC
Add middleware to the route.
-
orionis.http.routes.fluent.FluentRoute.withOutMiddleware
orionis.http.routes.fluent.FluentRoute.html#withOutMiddleware
Function
Method
PUBLIC
Exclude one or more middleware classes from the route.
-
orionis.http.routes.fluent.FluentRoute.prefix
orionis.http.routes.fluent.FluentRoute.html#prefix
Function
Method
PUBLIC
Prepend a path segment to the route's current path.
-
orionis.http.routes.fluent.FluentRoute.inheritGroup
orionis.http.routes.fluent.FluentRoute.html#inheritGroup
Function
Method
PUBLIC
Apply validated group context during registration.
-
orionis.http.routes.fluent.FluentRoute._kind
orionis.http.routes.fluent.FluentRoute.html#_kind
Function
Method
PUBLIC
Set the kind of the route (e.g., 'web', 'api').
-
orionis.http.routes.fluent.FluentRoute.export
orionis.http.routes.fluent.FluentRoute.html#export
Function
Method
PUBLIC
Export a complete route configuration as a plain dictionary.
-
orionis.mcp.context.freeze_json
orionis.mcp.context.html#freeze_json
Function
Function
PUBLIC
Copy JSON containers into recursively immutable request snapshots.
-
orionis.mcp.context.mutable_json
orionis.mcp.context.html#mutable_json
Function
Function
PUBLIC
Copy a request snapshot into standard containers for msgspec validation.
-
orionis.mcp.exceptions.McpProtocolException
orionis.mcp.exceptions.McpProtocolException.html
Class
Exception
PUBLIC
Carry an explicitly safe JSON-RPC error and HTTP status.
-
orionis.mcp.exceptions.McpProtocolException.__slots__
orionis.mcp.exceptions.McpProtocolException.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.mcp.exceptions.McpProtocolException.__init__
orionis.mcp.exceptions.McpProtocolException.html#__init__
Function
Method
PUBLIC
Store safe public error details without exposing a cause.
-
orionis.mcp.exceptions.McpProtocolException.code
orionis.mcp.exceptions.McpProtocolException.html#code
Attribute
Instance Variable
PUBLIC
Value supplied for code.
-
orionis.mcp.exceptions.McpProtocolException.message
orionis.mcp.exceptions.McpProtocolException.html#message
Attribute
Instance Variable
PUBLIC
Value supplied for message.
-
orionis.mcp.exceptions.McpProtocolException.status
orionis.mcp.exceptions.McpProtocolException.html#status
Attribute
Instance Variable
PUBLIC
Value supplied for status.
-
orionis.mcp.exceptions.McpProtocolException.data
orionis.mcp.exceptions.McpProtocolException.html#data
Attribute
Instance Variable
PUBLIC
Value supplied for data.
-
orionis.mcp.exceptions.McpInvalidParams
orionis.mcp.exceptions.McpInvalidParams.html
Class
Exception
PUBLIC
Reject malformed method parameters.
-
orionis.mcp.exceptions.McpInvalidParams.__slots__
orionis.mcp.exceptions.McpInvalidParams.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.mcp.exceptions.McpInvalidParams.__init__
orionis.mcp.exceptions.McpInvalidParams.html#__init__
Function
Method
PUBLIC
Use the standard JSON-RPC invalid-params code.
-
orionis.mcp.exceptions.McpAuthorizationException
orionis.mcp.exceptions.McpAuthorizationException.html
Class
Exception
PUBLIC
Deny a primitive through its explicit authorization hook.
-
orionis.mcp.exceptions.McpAuthorizationException.__slots__
orionis.mcp.exceptions.McpAuthorizationException.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.mcp.exceptions.McpAuthorizationException.__init__
orionis.mcp.exceptions.McpAuthorizationException.html#__init__
Function
Method
PUBLIC
Avoid revealing policy or identity details.
-
orionis.mcp.invoker._Parameter
orionis.mcp.invoker._Parameter.html
Class
Class
PUBLIC
One compile-time classified argument, with no request references.
-
orionis.mcp.invoker._Parameter.name
orionis.mcp.invoker._Parameter.html#name
Attribute
Class Variable
PUBLIC
Name identifying this declaration within its containing registry.
-
orionis.mcp.invoker._Parameter.source
orionis.mcp.invoker._Parameter.html#source
Attribute
Class Variable
PUBLIC
Trusted source from which this argument is resolved.
-
orionis.mcp.invoker._Parameter.value
orionis.mcp.invoker._Parameter.html#value
Attribute
Class Variable
PUBLIC
Type, default or lookup metadata used to resolve this argument.
-
orionis.mcp.invoker._Parameter.positional
orionis.mcp.invoker._Parameter.html#positional
Attribute
Class Variable
PUBLIC
Whether this argument must be passed positionally.
-
orionis.mcp.invoker._classify
orionis.mcp.invoker.html#_classify
Function
Function
PUBLIC
Assign one trusted source to an argument before accepting requests.
-
orionis.mcp.invoker.McpInvoker
orionis.mcp.invoker.McpInvoker.html
Class
Class
PUBLIC
A reusable unbound handler plan; payloads never become keyword mappings.
-
orionis.mcp.invoker.McpInvoker.function
orionis.mcp.invoker.McpInvoker.html#function
Attribute
Class Variable
PUBLIC
Unbound handler function executed by the invocation plan.
-
orionis.mcp.invoker.McpInvoker.parameters
orionis.mcp.invoker.McpInvoker.html#parameters
Attribute
Class Variable
PUBLIC
Binding plans for all handler parameters, including injected dependencies.
-
orionis.mcp.invoker.McpInvoker.receiver
orionis.mcp.invoker.McpInvoker.html#receiver
Attribute
Class Variable
PUBLIC
Whether the handler receives an instance, a class or no receiver.
-
orionis.mcp.invoker.McpInvoker.compile
orionis.mcp.invoker.McpInvoker.html#compile
Function
Class Method
PUBLIC
Resolve annotations and classify all parameters once during boot.
-
orionis.mcp.invoker.McpInvoker.invoke
orionis.mcp.invoker.McpInvoker.html#invoke
Function
Method
PUBLIC
Inject trusted context/services while preserving generator results.
-
orionis.mcp.invoker.McpInvoker._value
orionis.mcp.invoker.McpInvoker.html#_value
Function
Static Method
PUBLIC
Resolve the trusted source chosen at compile time.
-
orionis.mcp.invoker.McpInvoker._clientValue
orionis.mcp.invoker.McpInvoker.html#_clientValue
Function
Static Method
PUBLIC
Read only parameters explicitly declared as client-controlled input.
-
orionis.mcp.protocol.metadata.ServerInfo
orionis.mcp.protocol.metadata.ServerInfo.html
Class
Class
PUBLIC
Describe one compiled server implementation.
-
orionis.mcp.protocol.metadata.ServerInfo.name
orionis.mcp.protocol.metadata.ServerInfo.html#name
Attribute
Class Variable
PUBLIC
Name identifying this declaration within its containing registry.
-
orionis.mcp.protocol.metadata.ServerInfo.version
orionis.mcp.protocol.metadata.ServerInfo.html#version
Attribute
Class Variable
PUBLIC
Version string advertised by the implementation.
-
orionis.mcp.protocol.metadata.ServerInfo.website_url
orionis.mcp.protocol.metadata.ServerInfo.html#website_url
Attribute
Class Variable
PUBLIC
Website url produced by msgspec.field.
-
orionis.mcp.protocol.metadata.PrimitiveMetadata
orionis.mcp.protocol.metadata.PrimitiveMetadata.html
Class
Class
PUBLIC
Common typed fields used to validate static registry metadata at boot.
-
orionis.mcp.protocol.metadata.PrimitiveMetadata.name
orionis.mcp.protocol.metadata.PrimitiveMetadata.html#name
Attribute
Class Variable
PUBLIC
Name identifying this declaration within its containing registry.
-
orionis.mcp.protocol.metadata.PrimitiveMetadata.meta
orionis.mcp.protocol.metadata.PrimitiveMetadata.html#meta
Attribute
Class Variable
PUBLIC
Meta produced by msgspec.field.
-
orionis.mcp.protocol.metadata.ToolMetadata
orionis.mcp.protocol.metadata.ToolMetadata.html
Class
Class
PUBLIC
A native tool schema with optional behavioral hints.
-
orionis.mcp.protocol.metadata.ToolMetadata.input_schema
orionis.mcp.protocol.metadata.ToolMetadata.html#input_schema
Attribute
Class Variable
PUBLIC
JSON Schema describing the accepted input.
-
orionis.mcp.protocol.metadata.ToolMetadata.output_schema
orionis.mcp.protocol.metadata.ToolMetadata.html#output_schema
Attribute
Class Variable
PUBLIC
JSON Schema describing the declared structured output.
-
orionis.mcp.protocol.metadata.ResourceMetadata
orionis.mcp.protocol.metadata.ResourceMetadata.html
Class
Class
PUBLIC
A resource or template already validated by the URI compiler.
-
orionis.mcp.protocol.metadata.ResourceMetadata.uri_template
orionis.mcp.protocol.metadata.ResourceMetadata.html#uri_template
Attribute
Class Variable
PUBLIC
Uri template produced by msgspec.field.
-
orionis.mcp.protocol.metadata.ResourceMetadata.mime_type
orionis.mcp.protocol.metadata.ResourceMetadata.html#mime_type
Attribute
Class Variable
PUBLIC
Media type describing the resource content.
-
orionis.mcp.protocol.metadata.PromptMetadata
orionis.mcp.protocol.metadata.PromptMetadata.html
Class
Class
PUBLIC
Prompt descriptors and their string-valued argument declarations.
-
orionis.mcp.protocol.metavalidation._LABEL
orionis.mcp.protocol.metavalidation.html#_LABEL
Attribute
Constant
PUBLIC
[A-Za-z](?:[A-Za-z0-9-]*[A-Za-z0-9])?.
-
orionis.mcp.protocol.metavalidation._NAME
orionis.mcp.protocol.metavalidation.html#_NAME
Attribute
Constant
PUBLIC
(?:[A-Za-z0-9](?:[A-Za-z0-9_.-]*[A-Za-z0-9])?)?.
-
orionis.mcp.protocol.metavalidation._META_KEY
orionis.mcp.protocol.metavalidation.html#_META_KEY
Attribute
Constant
PUBLIC
Compiled pattern used to recognize meta key.
-
orionis.mcp.protocol.metavalidation._TRACE_PARENT
orionis.mcp.protocol.metavalidation.html#_TRACE_PARENT
Attribute
Constant
PUBLIC
Compiled pattern used to recognize trace parent.
-
orionis.mcp.protocol.metavalidation._STATE_KEY
orionis.mcp.protocol.metavalidation.html#_STATE_KEY
Attribute
Constant
PUBLIC
Compiled pattern used to recognize state key.
-
orionis.mcp.protocol.metavalidation._TOKEN
orionis.mcp.protocol.metavalidation.html#_TOKEN
Attribute
Constant
PUBLIC
Compiled pattern used to recognize token.
-
orionis.mcp.protocol.metavalidation._MAX_TRACE_MEMBERS
orionis.mcp.protocol.metavalidation.html#_MAX_TRACE_MEMBERS
Attribute
Constant
PUBLIC
Max trace members value used by metavalidation.
-
orionis.mcp.protocol.metavalidation._MAX_TRACE_VALUE
orionis.mcp.protocol.metavalidation.html#_MAX_TRACE_VALUE
Attribute
Constant
PUBLIC
Max trace value value used by metavalidation.
-
orionis.mcp.protocol.metavalidation.validate_meta_key
orionis.mcp.protocol.metavalidation.html#validate_meta_key
Function
Function
PUBLIC
Check the specification's prefix and name grammar.
-
orionis.mcp.protocol.metavalidation.validate_metadata
orionis.mcp.protocol.metavalidation.html#validate_metadata
Function
Function
PUBLIC
Preserve unknown metadata while validating its names and trace formats.
-
orionis.mcp.protocol.metavalidation.validate_client_capabilities
orionis.mcp.protocol.metavalidation.html#validate_client_capabilities
Function
Function
PUBLIC
Validate known capabilities without closing the protocol's open set.
-
orionis.mcp.protocol.metavalidation._capability_settings
orionis.mcp.protocol.metavalidation.html#_capability_settings
Function
Function
PUBLIC
Validate the nested settings of a known client capability.
-
orionis.mcp.protocol.metavalidation.validate_implementation
orionis.mcp.protocol.metavalidation.html#validate_implementation
Function
Function
PUBLIC
Check the standard client/server implementation record.
-
orionis.mcp.protocol.metavalidation._trace_parent
orionis.mcp.protocol.metavalidation.html#_trace_parent
Function
Function
PUBLIC
Accept W3C version zero and forward-compatible future versions.
-
orionis.mcp.protocol.metavalidation._trace_state
orionis.mcp.protocol.metavalidation.html#_trace_state
Function
Function
PUBLIC
Check ordered tracestate members, including unique vendor keys.
-
orionis.mcp.protocol.metavalidation._baggage
orionis.mcp.protocol.metavalidation.html#_baggage
Function
Function
PUBLIC
Check W3C baggage grammar without interpreting application values.
-
orionis.mcp.protocol.content.Annotations
orionis.mcp.protocol.content.Annotations.html
Class
Class
PUBLIC
Optional audience, priority and modification hints.
-
orionis.mcp.protocol.content.Content
orionis.mcp.protocol.content.Content.html
Class
Class
PUBLIC
Common content metadata.
-
orionis.mcp.protocol.content.Content.meta
orionis.mcp.protocol.content.Content.html#meta
Attribute
Class Variable
PUBLIC
Meta produced by msgspec.field.
-
orionis.mcp.protocol.content.TextContent
orionis.mcp.protocol.content.TextContent.html
Class
Class
PUBLIC
UTF-8 text content.
-
orionis.mcp.protocol.content.TextContent.text
orionis.mcp.protocol.content.TextContent.html#text
Attribute
Class Variable
PUBLIC
Text content carried by this protocol value.
-
orionis.mcp.protocol.content.ImageContent
orionis.mcp.protocol.content.ImageContent.html
Class
Class
PUBLIC
Base64-encoded image content.
-
orionis.mcp.protocol.content.ImageContent.data
orionis.mcp.protocol.content.ImageContent.html#data
Attribute
Class Variable
PUBLIC
Decoded content carried by this message or request.
-
orionis.mcp.protocol.content.ImageContent.mimeType
orionis.mcp.protocol.content.ImageContent.html#mimeType
Attribute
Class Variable
PUBLIC
Media type of the encoded image content.
-
orionis.mcp.protocol.content.AudioContent
orionis.mcp.protocol.content.AudioContent.html
Class
Class
PUBLIC
Base64-encoded audio content.
-
orionis.mcp.protocol.content.AudioContent.data
orionis.mcp.protocol.content.AudioContent.html#data
Attribute
Class Variable
PUBLIC
Decoded content carried by this message or request.
-
orionis.mcp.protocol.content.AudioContent.mimeType
orionis.mcp.protocol.content.AudioContent.html#mimeType
Attribute
Class Variable
PUBLIC
Media type of the encoded audio content.
-
orionis.mcp.protocol.content.TextResourceContents
orionis.mcp.protocol.content.TextResourceContents.html
Class
Class
PUBLIC
Text at an explicit resource URI.
-
orionis.mcp.protocol.content.TextResourceContents.uri
orionis.mcp.protocol.content.TextResourceContents.html#uri
Attribute
Class Variable
PUBLIC
Resource URI identifying the requested or returned content.
-
orionis.mcp.protocol.content.TextResourceContents.text
orionis.mcp.protocol.content.TextResourceContents.html#text
Attribute
Class Variable
PUBLIC
Text content carried by this protocol value.
-
orionis.mcp.protocol.content.TextResourceContents.meta
orionis.mcp.protocol.content.TextResourceContents.html#meta
Attribute
Class Variable
PUBLIC
Meta produced by msgspec.field.
-
orionis.mcp.protocol.content.BlobResourceContents
orionis.mcp.protocol.content.BlobResourceContents.html
Class
Class
PUBLIC
Binary resource encoded once as base64.
-
orionis.mcp.protocol.content.BlobResourceContents.uri
orionis.mcp.protocol.content.BlobResourceContents.html#uri
Attribute
Class Variable
PUBLIC
Resource URI identifying the requested or returned content.
-
orionis.mcp.protocol.content.BlobResourceContents.blob
orionis.mcp.protocol.content.BlobResourceContents.html#blob
Attribute
Class Variable
PUBLIC
Base64-encoded binary resource content.
-
orionis.mcp.protocol.content.BlobResourceContents.meta
orionis.mcp.protocol.content.BlobResourceContents.html#meta
Attribute
Class Variable
PUBLIC
Meta produced by msgspec.field.
-
orionis.mcp.protocol.content.EmbeddedResource
orionis.mcp.protocol.content.EmbeddedResource.html
Class
Class
PUBLIC
A resource embedded in tool or prompt content.
-
orionis.mcp.protocol.content.EmbeddedResource.resource
orionis.mcp.protocol.content.EmbeddedResource.html#resource
Attribute
Class Variable
PUBLIC
Embedded resource contents included in the response.
-
orionis.mcp.protocol.content.ResourceLink
orionis.mcp.protocol.content.ResourceLink.html
Class
Class
PUBLIC
A discoverable resource reference, without reading its bytes.
-
orionis.mcp.protocol.content.ResourceLink.name
orionis.mcp.protocol.content.ResourceLink.html#name
Attribute
Class Variable
PUBLIC
Name identifying this declaration within its containing registry.
-
orionis.mcp.protocol.content.ResourceLink.uri
orionis.mcp.protocol.content.ResourceLink.html#uri
Attribute
Class Variable
PUBLIC
Resource URI identifying the requested or returned content.
-
orionis.mcp.protocol.content.ContentBlock
orionis.mcp.protocol.content.html#ContentBlock
Attribute
Type Alias
PUBLIC
Type alias for TextContent | ImageContent | AudioContent | EmbeddedResource |
ResourceLink.
-
orionis.mcp.protocol.content.PromptMessage
orionis.mcp.protocol.content.PromptMessage.html
Class
Class
PUBLIC
One prompt message with a protocol-defined role.
-
orionis.mcp.protocol.content.PromptMessage.role
orionis.mcp.protocol.content.PromptMessage.html#role
Attribute
Class Variable
PUBLIC
Role assigned to this message in the conversation.
-
orionis.mcp.protocol.content.PromptMessage.content
orionis.mcp.protocol.content.PromptMessage.html#content
Attribute
Class Variable
PUBLIC
Content blocks carried by this protocol value.
-
orionis.mcp.protocol.results.Error
orionis.mcp.protocol.results.Error.html
Class
Class
PUBLIC
A safe protocol error.
-
orionis.mcp.protocol.results.Error.code
orionis.mcp.protocol.results.Error.html#code
Attribute
Class Variable
PUBLIC
Machine-readable status or error code.
-
orionis.mcp.protocol.results.Error.message
orionis.mcp.protocol.results.Error.html#message
Attribute
Class Variable
PUBLIC
Human-readable message associated with this operation or result.
-
orionis.mcp.protocol.results.ErrorResponse
orionis.mcp.protocol.results.ErrorResponse.html
Class
Class
PUBLIC
An unidentifiable malformed request has an omitted ID.
-
orionis.mcp.protocol.results.ErrorResponse.error
orionis.mcp.protocol.results.ErrorResponse.html#error
Attribute
Class Variable
PUBLIC
First error retained while background work continues to drain.
-
orionis.mcp.protocol.results.ErrorResponse.jsonrpc
orionis.mcp.protocol.results.ErrorResponse.html#jsonrpc
Attribute
Class Variable
PUBLIC
2.0.
-
orionis.mcp.protocol.results.ResultResponse
orionis.mcp.protocol.results.ResultResponse.html
Class
Class
PUBLIC
A response correlated with one client request.
-
orionis.mcp.protocol.results.ResultResponse.id
orionis.mcp.protocol.results.ResultResponse.html#id
Attribute
Class Variable
PUBLIC
Identifier used to correlate or locate this protocol or storage record.
-
orionis.mcp.protocol.results.ResultResponse.result
orionis.mcp.protocol.results.ResultResponse.html#result
Attribute
Class Variable
PUBLIC
Successful result payload returned for the request.
-
orionis.mcp.protocol.results.ResultResponse.jsonrpc
orionis.mcp.protocol.results.ResultResponse.html#jsonrpc
Attribute
Class Variable
PUBLIC
2.0.
-
orionis.mcp.protocol.results.Notification
orionis.mcp.protocol.results.Notification.html
Class
Class
PUBLIC
A server notification with no request ID.
-
orionis.mcp.protocol.results.Notification.method
orionis.mcp.protocol.results.Notification.html#method
Attribute
Class Variable
PUBLIC
JSON-RPC notification method sent to the client.
-
orionis.mcp.protocol.results.Notification.params
orionis.mcp.protocol.results.Notification.html#params
Attribute
Class Variable
PUBLIC
Parameters carried by the JSON-RPC message.
-
orionis.mcp.protocol.results.Notification.jsonrpc
orionis.mcp.protocol.results.Notification.html#jsonrpc
Attribute
Class Variable
PUBLIC
2.0.
-
orionis.mcp.protocol.results.CompleteResult
orionis.mcp.protocol.results.CompleteResult.html
Class
Class
PUBLIC
Common fields of completed server results.
-
orionis.mcp.protocol.results.CompleteResult.meta
orionis.mcp.protocol.results.CompleteResult.html#meta
Attribute
Class Variable
PUBLIC
Meta produced by msgspec.field.
-
orionis.mcp.protocol.results.CompleteResult.resultType
orionis.mcp.protocol.results.CompleteResult.html#resultType
Attribute
Class Variable
PUBLIC
complete.
-
orionis.mcp.protocol.results.CacheableResult
orionis.mcp.protocol.results.CacheableResult.html
Class
Class
PUBLIC
Required, conservative client cache hints.
-
orionis.mcp.protocol.results.CacheableResult.ttlMs
orionis.mcp.protocol.results.CacheableResult.html#ttlMs
Attribute
Class Variable
PUBLIC
Ttl ms value used by CacheableResult.
-
orionis.mcp.protocol.results.CacheableResult.cacheScope
orionis.mcp.protocol.results.CacheableResult.html#cacheScope
Attribute
Class Variable
PUBLIC
private.
-
orionis.mcp.protocol.results.DiscoverResult
orionis.mcp.protocol.results.DiscoverResult.html
Class
Class
PUBLIC
Self-contained server discovery.
-
orionis.mcp.protocol.results.DiscoverResult.supportedVersions
orionis.mcp.protocol.results.DiscoverResult.html#supportedVersions
Attribute
Class Variable
PUBLIC
Protocol versions accepted by the server.
-
orionis.mcp.protocol.results.DiscoverResult.capabilities
orionis.mcp.protocol.results.DiscoverResult.html#capabilities
Attribute
Class Variable
PUBLIC
Capabilities advertised by the compiled server.
-
orionis.mcp.protocol.results.ListToolsResult
orionis.mcp.protocol.results.ListToolsResult.html
Class
Class
PUBLIC
One deterministic tool catalog page.
-
orionis.mcp.protocol.results.ListToolsResult.tools
orionis.mcp.protocol.results.ListToolsResult.html#tools
Attribute
Class Variable
PUBLIC
Tool declarations available through this server or catalog.
-
orionis.mcp.protocol.results.ListResourcesResult
orionis.mcp.protocol.results.ListResourcesResult.html
Class
Class
PUBLIC
One deterministic resource page.
-
orionis.mcp.protocol.results.ListResourcesResult.resources
orionis.mcp.protocol.results.ListResourcesResult.html#resources
Attribute
Class Variable
PUBLIC
Resource declarations available through this server.
-
orionis.mcp.protocol.results.ListResourceTemplatesResult
orionis.mcp.protocol.results.ListResourceTemplatesResult.html
Class
Class
PUBLIC
One deterministic template page.
-
orionis.mcp.protocol.results.ListResourceTemplatesResult.resourceTemplates
orionis.mcp.protocol.results.ListResourceTemplatesResult.html#resourceTemplates
Attribute
Class Variable
PUBLIC
Parameterized resource templates advertised by the server.
-
orionis.mcp.protocol.results.ListPromptsResult
orionis.mcp.protocol.results.ListPromptsResult.html
Class
Class
PUBLIC
One deterministic prompt page.
-
orionis.mcp.protocol.results.ListPromptsResult.prompts
orionis.mcp.protocol.results.ListPromptsResult.html#prompts
Attribute
Class Variable
PUBLIC
Prompt declarations available through this server.
-
orionis.mcp.protocol.results.CallToolResult
orionis.mcp.protocol.results.CallToolResult.html
Class
Class
PUBLIC
Content with optional structured output of any JSON type.
-
orionis.mcp.protocol.results.CallToolResult.content
orionis.mcp.protocol.results.CallToolResult.html#content
Attribute
Class Variable
PUBLIC
Content blocks carried by this protocol value.
-
orionis.mcp.protocol.results.ReadResourceResult
orionis.mcp.protocol.results.ReadResourceResult.html
Class
Class
PUBLIC
Text or blob resource contents.
-
orionis.mcp.protocol.results.ReadResourceResult.contents
orionis.mcp.protocol.results.ReadResourceResult.html#contents
Attribute
Class Variable
PUBLIC
Resource content items returned by the read operation.
-
orionis.mcp.protocol.results.GetPromptResult
orionis.mcp.protocol.results.GetPromptResult.html
Class
Class
PUBLIC
User and assistant prompt messages.
-
orionis.mcp.protocol.results.GetPromptResult.messages
orionis.mcp.protocol.results.GetPromptResult.html#messages
Attribute
Class Variable
PUBLIC
Ordered messages supplied to or returned by the operation.
-
orionis.mcp.protocol.results.CompleteCompletionResult
orionis.mcp.protocol.results.CompleteCompletionResult.html
Class
Class
PUBLIC
A completion response.
-
orionis.mcp.protocol.results.CompleteCompletionResult.completion
orionis.mcp.protocol.results.CompleteCompletionResult.html#completion
Attribute
Class Variable
PUBLIC
Completion provider or result associated with the primitive.
-
orionis.mcp.server.primitives.Primitive
orionis.mcp.server.primitives.Primitive.html
Class
Class
PUBLIC
Static metadata shared by tools, resources and prompts.
-
orionis.mcp.server.primitives.Primitive.__slots__
orionis.mcp.server.primitives.Primitive.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.mcp.server.primitives.Primitive.name
orionis.mcp.server.primitives.Primitive.html#name
Attribute
Class Variable
PUBLIC
''.
-
orionis.mcp.server.primitives.Primitive.title
orionis.mcp.server.primitives.Primitive.html#title
Attribute
Class Variable
PUBLIC
''.
-
orionis.mcp.server.primitives.Primitive.description
orionis.mcp.server.primitives.Primitive.html#description
Attribute
Class Variable
PUBLIC
''.
-
orionis.mcp.server.primitives.Primitive.icons
orionis.mcp.server.primitives.Primitive.html#icons
Attribute
Class Variable
PUBLIC
Icon metadata advertised for the primitive or server.
-
orionis.mcp.server.primitives.Primitive.meta
orionis.mcp.server.primitives.Primitive.html#meta
Attribute
Class Variable
PUBLIC
Meta produced by MappingProxyType.
-
orionis.mcp.server.primitives.Primitive.cache
orionis.mcp.server.primitives.Primitive.html#cache
Attribute
Class Variable
PUBLIC
Cache policy or cached state used by this component.
-
orionis.mcp.server.templates._VARNAME
orionis.mcp.server.templates.html#_VARNAME
Attribute
Constant
PUBLIC
(?:\w|%[0-9A-Fa-f]{2})++(?:\.(?:\w|%[0-9A-Fa-f]{2})++)*+.
-
orionis.mcp.server.templates._MODIFIER
orionis.mcp.server.templates.html#_MODIFIER
Attribute
Constant
PUBLIC
(?::[1-9]\d{0,3}|\*)?.
-
orionis.mcp.server.templates._EXPRESSION
orionis.mcp.server.templates.html#_EXPRESSION
Attribute
Constant
PUBLIC
Compiled pattern used to recognize expression.
-
orionis.mcp.server.templates._SIMPLE
orionis.mcp.server.templates.html#_SIMPLE
Attribute
Constant
PUBLIC
Compiled pattern used to recognize simple.
-
orionis.mcp.server.templates._PART
orionis.mcp.server.templates.html#_PART
Attribute
Constant
PUBLIC
Compiled pattern used to recognize part.
-
orionis.mcp.server.templates._INVALID_LITERAL
orionis.mcp.server.templates.html#_INVALID_LITERAL
Attribute
Constant
PUBLIC
Compiled pattern used to recognize invalid literal.
-
orionis.mcp.server.templates._SCHEME
orionis.mcp.server.templates.html#_SCHEME
Attribute
Constant
PUBLIC
Compiled pattern used to recognize scheme.
-
orionis.mcp.server.templates._ESCAPE
orionis.mcp.server.templates.html#_ESCAPE
Attribute
Constant
PUBLIC
Compiled pattern used to recognize escape.
-
orionis.mcp.server.templates._uppercase_escape
orionis.mcp.server.templates.html#_uppercase_escape
Function
Function
PUBLIC
Normalize the hexadecimal digits of one percent escape.
-
orionis.mcp.server.templates._decode_captures
orionis.mcp.server.templates.html#_decode_captures
Function
Function
PUBLIC
Decode URI variables while checking repeated variable consistency.
-
orionis.mcp.server.templates.validate_uri
orionis.mcp.server.templates.html#validate_uri
Function
Function
PUBLIC
Require an absolute URI without malformed escapes or literal controls.
-
orionis.mcp.server.templates._validate_template
orionis.mcp.server.templates.html#_validate_template
Function
Function
PUBLIC
Require RFC 6570 syntax before compiling a resource template.
-
orionis.mcp.server.templates._simple_pattern
orionis.mcp.server.templates.html#_simple_pattern
Function
Function
PUBLIC
Compile safe simple-string inverses; other expressions need a match hook.
-
orionis.mcp.server.templates._expansion_value
orionis.mcp.server.templates.html#_expansion_value
Function
Function
PUBLIC
Preserve Orionis scalar formatting and mapping order during RFC expansion.
-
orionis.mcp.server.templates.UriMatcher
orionis.mcp.server.templates.UriMatcher.html
Class
Class
PUBLIC
Compile expansion once and verify every inverse result by expansion.
-
orionis.mcp.server.templates.UriMatcher.template
orionis.mcp.server.templates.UriMatcher.html#template
Attribute
Class Variable
PUBLIC
URI template from which the matcher was compiled.
-
orionis.mcp.server.templates.UriMatcher.variable_names
orionis.mcp.server.templates.UriMatcher.html#variable_names
Attribute
Class Variable
PUBLIC
Names of variables referenced by the URI template.
-
orionis.mcp.server.templates.UriMatcher.expander
orionis.mcp.server.templates.UriMatcher.html#expander
Attribute
Class Variable
PUBLIC
Callable used to expand a URI template with variable values.
-
orionis.mcp.server.templates.UriMatcher.pattern
orionis.mcp.server.templates.UriMatcher.html#pattern
Attribute
Class Variable
PUBLIC
Compiled pattern used to match the declared URI template.
-
orionis.mcp.server.templates.UriMatcher.captures
orionis.mcp.server.templates.UriMatcher.html#captures
Attribute
Class Variable
PUBLIC
Capture metadata used to extract template variable values.
-
orionis.mcp.server.templates.UriMatcher.custom
orionis.mcp.server.templates.UriMatcher.html#custom
Attribute
Class Variable
PUBLIC
Custom implementations registered by the application.
-
orionis.mcp.server.templates.UriMatcher.compile
orionis.mcp.server.templates.UriMatcher.html#compile
Function
Class Method
PUBLIC
Require an explicit inverse for RFC operators with ambiguous matching.
-
orionis.mcp.server.templates.UriMatcher._customVariables
orionis.mcp.server.templates.UriMatcher.html#_customVariables
Function
Method
PUBLIC
Validate the result of a configured custom inverse matcher.
-
orionis.mcp.server.templates.UriMatcher.match
orionis.mcp.server.templates.UriMatcher.html#match
Function
Method
PUBLIC
Return validated URI variables without loading any resource or file.
-
orionis.mcp.protocol.validation._RESULT_TYPES
orionis.mcp.protocol.validation.html#_RESULT_TYPES
Attribute
Constant
PUBLIC
Result types definitions used by validation.
-
orionis.mcp.protocol.validation._CONTENT_TYPES
orionis.mcp.protocol.validation.html#_CONTENT_TYPES
Attribute
Constant
PUBLIC
Content types definitions used by validation.
-
orionis.mcp.protocol.validation._MAX_COMPLETIONS
orionis.mcp.protocol.validation.html#_MAX_COMPLETIONS
Attribute
Constant
PUBLIC
Max completions value used by validation.
-
orionis.mcp.protocol.validation.validate_json
orionis.mcp.protocol.validation.html#validate_json
Function
Function
PUBLIC
Reject non-JSON values and nonfinite numbers rather than changing data.
-
orionis.mcp.protocol.validation.validate_result
orionis.mcp.protocol.validation.html#validate_result
Function
Function
PUBLIC
Reject invalid direct Struct construction and method/result mismatches.
-
orionis.mcp.protocol.validation._result_payload
orionis.mcp.protocol.validation.html#_result_payload
Function
Function
PUBLIC
Check only dynamic application payloads; registry metadata is precompiled.
-
orionis.mcp.protocol.validation._validate_completion
orionis.mcp.protocol.validation.html#_validate_completion
Function
Function
PUBLIC
Check completion count and total bounds before serialization.
-
orionis.mcp.protocol.validation._object
orionis.mcp.protocol.validation.html#_object
Function
Function
PUBLIC
Convert a public wire struct without a second JSON serialization.
-
orionis.mcp.protocol.validation._common
orionis.mcp.protocol.validation.html#_common
Function
Function
PUBLIC
Validate annotations and metadata shared by content variants.
-
orionis.mcp.protocol.validation.validate_content
orionis.mcp.protocol.validation.html#validate_content
Function
Function
PUBLIC
Validate all five standard MCP content variants.
-
orionis.mcp.protocol.validation.validate_resource
orionis.mcp.protocol.validation.html#validate_resource
Function
Function
PUBLIC
Check text/blob resource contents and their explicit URI.
-
orionis.mcp.protocol.validation._message
orionis.mcp.protocol.validation.html#_message
Function
Function
PUBLIC
Validate a prompt role and its single content block.
-
orionis.schemas.constraint_plan._KEYS
orionis.schemas.constraint_plan.html#_KEYS
Attribute
Constant
PUBLIC
Keys definitions used by constraint_plan.
-
orionis.schemas.constraint_plan._CACHE_MAX
orionis.schemas.constraint_plan.html#_CACHE_MAX
Attribute
Constant
PUBLIC
Maximum number of retained constraint plans, including unhashable annotations.
-
orionis.schemas.constraint_plan._CACHE
orionis.schemas.constraint_plan.html#_CACHE
Attribute
Constant
PUBLIC
Bounded identity cache retaining each annotation alongside its immutable plan.
-
orionis.schemas.constraint_plan._CACHE_LOCK
orionis.schemas.constraint_plan.html#_CACHE_LOCK
Attribute
Constant
PUBLIC
Serialize cache promotion and eviction across concurrent schema consumers.
-
orionis.schemas.constraint_plan._ConstraintMessages
orionis.schemas.constraint_plan._ConstraintMessages.html
Class
Class
PUBLIC
Keep annotations with distinct messages from sharing a typing cache key.
-
orionis.schemas.constraint_plan._ConstraintMessages.__slots__
orionis.schemas.constraint_plan._ConstraintMessages.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.schemas.constraint_plan._ConstraintMessages.__init__
orionis.schemas.constraint_plan._ConstraintMessages.html#__init__
Function
Method
PUBLIC
Retain local messages in metadata ignored by native validation.
-
orionis.schemas.constraint_plan._ConstraintMessages.messages
orionis.schemas.constraint_plan._ConstraintMessages.html#messages
Attribute
Instance Variable
PUBLIC
Custom messages indexed by validation code.
-
orionis.schemas.constraint_plan.register_messages
orionis.schemas.constraint_plan.html#register_messages
Function
Function
PUBLIC
Attach and index local messages during annotation compilation.
-
orionis.schemas.constraint_plan.annotation_messages
orionis.schemas.constraint_plan.html#annotation_messages
Function
Function
PUBLIC
Retrieve the most recently attached local message marker.
-
orionis.schemas.constraint_plan._cache_plan
orionis.schemas.constraint_plan.html#_cache_plan
Function
Function
PUBLIC
Publish a completed plan while evicting the least recently used annotations.
-
orionis.schemas.constraint_plan._constraint_probes
orionis.schemas.constraint_plan.html#_constraint_probes
Function
Function
PUBLIC
Build independent checks for the constraints in one metadata entry.
-
orionis.schemas.constraint_plan.constraint_plan
orionis.schemas.constraint_plan.html#constraint_plan
Function
Function
PUBLIC
Build and cache independent native checks for local constraints.
-
orionis.schemas.instance_payload._PLANS
orionis.schemas.instance_payload.html#_PLANS
Attribute
Constant
PUBLIC
Wire names and primitive configuration cached without retaining struct types.
-
orionis.schemas.instance_payload.matching_type
orionis.schemas.instance_payload.html#matching_type
Function
Function
PUBLIC
Select a schema or collection annotation matching an input representation.
-
orionis.schemas.instance_payload.matching_schema
orionis.schemas.instance_payload.html#matching_schema
Function
Function
PUBLIC
Match an existing schema instance or its wire representation and tag.
-
orionis.schemas.instance_payload.instance_payload
orionis.schemas.instance_payload.html#instance_payload
Function
Function
PUBLIC
Expand structs using their wire names, tags and container shape.
-
orionis.schemas.meta.validation.ValidationMetadata
orionis.schemas.meta.validation.ValidationMetadata.html
Class
Class
PUBLIC
Root marker for all Orionis field-level annotations.
-
orionis.schemas.meta.validation.ValidationMetadata.__slots__
orionis.schemas.meta.validation.ValidationMetadata.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.schemas.meta.document.DocumentMetadata
orionis.schemas.meta.document.DocumentMetadata.html
Class
Class
PUBLIC
Intermediate marker for documentation / JSON Schema metadata.
-
orionis.schemas.meta.document.DocumentMetadata.__slots__
orionis.schemas.meta.document.DocumentMetadata.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.schemas.metadata.Coerce
orionis.schemas.metadata.Coerce.html
Class
Class
PUBLIC
Convert a field to its declared type before validating its constraints.
-
orionis.schemas.metadata.Title
orionis.schemas.metadata.Title.html
Class
Class
PUBLIC
Provide a human-readable title for the field in JSON Schema / OpenAPI.
-
orionis.schemas.metadata.Title.value
orionis.schemas.metadata.Title.html#value
Attribute
Instance Variable
PUBLIC
The field title shown in generated schema output.
-
orionis.schemas.metadata.Description
orionis.schemas.metadata.Description.html
Class
Class
PUBLIC
Provide a human-readable description for the field in JSON Schema / OpenAPI.
-
orionis.schemas.metadata.Description.value
orionis.schemas.metadata.Description.html#value
Attribute
Instance Variable
PUBLIC
The field description shown in generated schema output.
-
orionis.schemas.metadata.Examples
orionis.schemas.metadata.Examples.html
Class
Class
PUBLIC
Provide example values for the field in JSON Schema / OpenAPI.
-
orionis.schemas.metadata.Examples.values
orionis.schemas.metadata.Examples.html#values
Attribute
Instance Variable
PUBLIC
A list of example values; each must be JSON-serialisable.
-
orionis.schemas.metadata.Message
orionis.schemas.metadata.Message.html
Class
Class
PUBLIC
Attach a custom type-mismatch error message to a field.
-
orionis.schemas.metadata.Message.text
orionis.schemas.metadata.Message.html#text
Attribute
Instance Variable
PUBLIC
The custom error message shown when type validation fails.
-
orionis.schemas.entities.failure.ValidationFailure
orionis.schemas.entities.failure.ValidationFailure.html
Class
Class
PUBLIC
Represent a validation failure.
-
orionis.schemas.entities.failure.ValidationFailure.field
orionis.schemas.entities.failure.ValidationFailure.html#field
Attribute
Instance Variable
PUBLIC
Identify the field that failed validation.
-
orionis.schemas.entities.failure.ValidationFailure.rule
orionis.schemas.entities.failure.ValidationFailure.html#rule
Attribute
Instance Variable
PUBLIC
Identify the validation rule that failed.
-
orionis.schemas.entities.failure.ValidationFailure.message
orionis.schemas.entities.failure.ValidationFailure.html#message
Attribute
Instance Variable
PUBLIC
Describe the validation failure.
-
orionis.schemas.entities.failure.ValidationFailure.toDict
orionis.schemas.entities.failure.ValidationFailure.html#toDict
Function
Method
PUBLIC
Return the failure as a plain dictionary.
-
orionis.schemas.contracts.constraint.IRule
orionis.schemas.contracts.constraint.IRule.html
Class
Class
PUBLIC
Define the contract for rule implementations.
-
orionis.schemas.contracts.constraint.IRule.__slots__
orionis.schemas.contracts.constraint.IRule.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.schemas.contracts.constraint.IRule.__init__
orionis.schemas.contracts.constraint.IRule.html#__init__
Function
Method
PUBLIC
Initialize the rule with an optional custom failure message.
-
orionis.schemas.contracts.constraint.IRule.enforce
orionis.schemas.contracts.constraint.IRule.html#enforce
Function
Method
PUBLIC
Evaluate asynchronously whether the current value satisfies this rule.
-
orionis.schemas.contracts.constraint.IRule.validate
orionis.schemas.contracts.constraint.IRule.html#validate
Function
Method
PUBLIC
Await validation and return a failure or None.
-
orionis.schemas.rule.Rule
orionis.schemas.rule.Rule.html
Class
Class
PUBLIC
Define a reusable validation rule and its failure message.
-
orionis.schemas.rule.Rule.__slots__
orionis.schemas.rule.Rule.html#__slots__
Attribute
Class Variable
PUBLIC
Restrict rule instances to their declared attributes.
-
orionis.schemas.rule.Rule.__init_subclass__
orionis.schemas.rule.Rule.html#__init_subclass__
Function
Method
PUBLIC
Require asynchronous enforcement on every rule subclass.
-
orionis.schemas.rule.Rule.__init__
orionis.schemas.rule.Rule.html#__init__
Function
Method
PUBLIC
Initialize the rule with an optional custom failure message.
-
orionis.schemas.rule.Rule._code
orionis.schemas.rule.Rule.html#_code
Attribute
Instance Variable
PUBLIC
Machine-readable status or error code.
-
orionis.schemas.rule.Rule._message
orionis.schemas.rule.Rule.html#_message
Attribute
Instance Variable
PUBLIC
Override message used when validation fails.
-
orionis.schemas.rule.Rule.enforce
orionis.schemas.rule.Rule.html#enforce
Function
Method
PUBLIC
Asynchronously evaluate whether the current value satisfies this rule.
-
orionis.schemas.rule.Rule.validate
orionis.schemas.rule.Rule.html#validate
Function
Method
PUBLIC
Validate the field by awaiting its asynchronous enforcement.
-
orionis.schemas.exceptions.validation._DEFAULT_MESSAGE
orionis.schemas.exceptions.validation.html#_DEFAULT_MESSAGE
Attribute
Constant
PUBLIC
Fallback used when the exception is built without any failure.
-
orionis.schemas.rules_executor._PLAN_CACHE_MAX
orionis.schemas.rules_executor.html#_PLAN_CACHE_MAX
Attribute
Constant
PUBLIC
Cache of validation plans for schema types. Keys are schema classes; values are tuples of field validation plans as returned by _build_plan(). Populated on demand by _build_plan and warmed at class creation time.
-
orionis.schemas.rules_executor._PLAN_CACHE
orionis.schemas.rules_executor.html#_PLAN_CACHE
Attribute
Constant
PUBLIC
Plan cache used by rules_executor.
-
orionis.schemas.rules_executor._PLAN_LOCK
orionis.schemas.rules_executor.html#_PLAN_LOCK
Attribute
Constant
PUBLIC
Synchronization primitive controlling access to plan lock.
-
orionis.schemas.rules_executor._BUILDING
orionis.schemas.rules_executor.html#_BUILDING
Attribute
Constant
PUBLIC
Building used by rules_executor.
-
orionis.schemas.rules_executor._cache_get
orionis.schemas.rules_executor.html#_cache_get
Function
Function
PUBLIC
Read and promote a bounded validation plan.
-
orionis.schemas.rules_executor._EMPTY_META
orionis.schemas.rules_executor.html#_EMPTY_META
Attribute
Constant
PUBLIC
Shared empty mapping returned for schemas without Orionis metadata. Reused instead of allocating a fresh dict on every plan build.
-
orionis.schemas.rules_executor._type_contains_nested
orionis.schemas.rules_executor.html#_type_contains_nested
Function
Function
PUBLIC
Check an annotation for nested schemas requiring traversal.
-
orionis.schemas.rules_executor._warm_child_plan
orionis.schemas.rules_executor.html#_warm_child_plan
Function
Function
PUBLIC
Eagerly populate _PLAN_CACHE for any nested Orionis schema type.
-
orionis.schemas.rules_executor._collection_item_type
orionis.schemas.rules_executor.html#_collection_item_type
Function
Function
PUBLIC
Resolve the element annotation selected from a concrete collection type.
-
orionis.schemas.rules_executor._field_rules
orionis.schemas.rules_executor.html#_field_rules
Function
Function
PUBLIC
Select executable rules from a field's validated metadata.
-
orionis.schemas.rules_executor._build_plan
orionis.schemas.rules_executor.html#_build_plan
Function
Function
PUBLIC
Compile under a reentrant lock, including recursive schema graphs.
-
orionis.schemas.rules_executor._compile_plan
orionis.schemas.rules_executor.html#_compile_plan
Function
Function
PUBLIC
Build and cache the custom-rule execution plan for a schema.
-
orionis.schemas.rules_executor._collect_nested
orionis.schemas.rules_executor.html#_collect_nested
Function
Function
PUBLIC
Validate nested schemas, including schemas held inside collections.
-
orionis.schemas.rules_executor._collect_with_plan
orionis.schemas.rules_executor.html#_collect_with_plan
Function
Function
PUBLIC
Execute a pre-resolved validation plan against a schema instance.
-
orionis.schemas.rules_executor._SchemaPlan
orionis.schemas.rules_executor._SchemaPlan.html
Class
Class
PUBLIC
Retain trusted field names and local rules for one native Struct.
-
orionis.schemas.rules_executor._SchemaPlan.fields
orionis.schemas.rules_executor._SchemaPlan.html#fields
Attribute
Class Variable
PUBLIC
Fields traversed after the local rules have completed.
-
orionis.schemas.rules_executor._SchemaPlan.rules
orionis.schemas.rules_executor._SchemaPlan.html#rules
Attribute
Class Variable
PUBLIC
Local validation rules, without duplicate nested traversal.
-
orionis.schemas.rules_executor._visit_schema_plan
orionis.schemas.rules_executor.html#_visit_schema_plan
Function
Function
PUBLIC
Visit each declared Struct once, including recursive references.
-
orionis.schemas.rules_executor._schema_plans
orionis.schemas.rules_executor.html#_schema_plans
Function
Function
PUBLIC
Compile immutable rule traversal for declared transport data.
-
orionis.schemas.rules_executor._validate_schemas
orionis.schemas.rules_executor.html#_validate_schemas
Function
Function
PUBLIC
Apply local schema rules once across converted transport data.
-
orionis.schemas.coercion._requires_preparation
orionis.schemas.coercion.html#_requires_preparation
Function
Function
PUBLIC
Find coercion markers or struct types requiring instance revalidation.
-
orionis.schemas.coercion._field_plan
orionis.schemas.coercion.html#_field_plan
Function
Function
PUBLIC
Cache fields requiring coercion or struct expansion and their wire positions.
-
orionis.schemas.coercion.coerce_payload
orionis.schemas.coercion.html#coerce_payload
Function
Function
PUBLIC
Prepare marked values and existing structs using copy-on-write containers.
-
orionis.schemas.coercion._coerce_mapping
orionis.schemas.coercion.html#_coerce_mapping
Function
Function
PUBLIC
Normalize selected mapping entries without changing their source.
-
orionis.schemas.coercion._coerce_array
orionis.schemas.coercion.html#_coerce_array
Function
Function
PUBLIC
Normalize declared array fields without consuming the discriminator tag.
-
orionis.schemas.coercion._coerce_collection
orionis.schemas.coercion.html#_coerce_collection
Function
Function
PUBLIC
Prepare collection values while preserving keys and fixed tuple positions.
-
orionis.schemas.coercion._plain_struct_item
orionis.schemas.coercion.html#_plain_struct_item
Function
Function
PUBLIC
Select uniform struct items whose fields need no further preparation.
-
orionis.schemas.coercion._expand_struct_sequence
orionis.schemas.coercion.html#_expand_struct_sequence
Function
Function
PUBLIC
Expand existing struct items and leave native input representations intact.
-
orionis.schemas.coercion._coerce_union
orionis.schemas.coercion.html#_coerce_union
Function
Function
PUBLIC
Preserve compatible union branches and normalize only matching structures.
-
orionis.schemas.coercion._coerce_value
orionis.schemas.coercion.html#_coerce_value
Function
Function
PUBLIC
Normalize a selected annotation before applying any value constraints.
-
orionis.mcp.server.schemas._ConversionPlan
orionis.mcp.server.schemas.html#_ConversionPlan
Attribute
Type Alias
PUBLIC
Preparation requirement and schema rules retained by a compiled primitive.
-
orionis.mcp.server.schemas.compile_conversion
orionis.mcp.server.schemas.html#compile_conversion
Function
Function
PUBLIC
Prepare conversion metadata once for a compiled tool declaration.
-
orionis.mcp.server.schemas._META_FIELDS
orionis.mcp.server.schemas.html#_META_FIELDS
Attribute
Constant
PUBLIC
Meta fields definitions used by schemas.
-
orionis.mcp.server.schemas._ANNOTATION_KEYS
orionis.mcp.server.schemas.html#_ANNOTATION_KEYS
Attribute
Constant
PUBLIC
Annotation keys used by schemas.
-
orionis.mcp.server.schemas._DIALECT
orionis.mcp.server.schemas.html#_DIALECT
Attribute
Constant
PUBLIC
https://json-schema.org/draft/2020-12/schema.
-
orionis.mcp.server.schemas._DEFINITIONS
orionis.mcp.server.schemas.html#_DEFINITIONS
Attribute
Constant
PUBLIC
$defs.
-
orionis.mcp.server.schemas._schema_hook
orionis.mcp.server.schemas.html#_schema_hook
Function
Function
PUBLIC
Represent an unconstrained JSON value without inventing custom type schemas.
-
orionis.mcp.server.schemas._check_metadata
orionis.mcp.server.schemas.html#_check_metadata
Function
Function
PUBLIC
Reject extra schema validation rules the native validator cannot enforce.
-
orionis.mcp.server.schemas._validate_schema_additions
orionis.mcp.server.schemas.html#_validate_schema_additions
Function
Function
PUBLIC
Require additional schema keywords to match native validation behavior.
-
orionis.mcp.server.schemas._check_type
orionis.mcp.server.schemas.html#_check_type
Function
Function
PUBLIC
Inspect metadata across nested fields and recursive type declarations.
-
orionis.mcp.server.schemas.compile_schema
orionis.mcp.server.schemas.html#compile_schema
Function
Function
PUBLIC
Produce the native JSON Schema, preserving local references and constraints.
-
orionis.mcp.server.schemas._inline
orionis.mcp.server.schemas.html#_inline
Function
Function
PUBLIC
Inline acyclic local references while preserving recursive definitions.
-
orionis.mcp.server.schemas.convert_payload
orionis.mcp.server.schemas.html#convert_payload
Function
Function
PUBLIC
Validate and convert a payload to its declared native type.
-
orionis.mcp.protocol.constants.SUPPORTED_VERSIONS
orionis.mcp.protocol.constants.html#SUPPORTED_VERSIONS
Attribute
Constant
PUBLIC
Supported versions definitions used by constants.
-
orionis.mcp.protocol.constants.PROTOCOL_VERSION
orionis.mcp.protocol.constants.html#PROTOCOL_VERSION
Attribute
Constant
PUBLIC
io.modelcontextprotocol/protocolVersion.
-
orionis.mcp.protocol.constants.CLIENT_CAPABILITIES
orionis.mcp.protocol.constants.html#CLIENT_CAPABILITIES
Attribute
Constant
PUBLIC
io.modelcontextprotocol/clientCapabilities.
-
orionis.mcp.protocol.constants.CLIENT_INFO
orionis.mcp.protocol.constants.html#CLIENT_INFO
Attribute
Constant
PUBLIC
io.modelcontextprotocol/clientInfo.
-
orionis.mcp.protocol.constants.SERVER_INFO
orionis.mcp.protocol.constants.html#SERVER_INFO
Attribute
Constant
PUBLIC
io.modelcontextprotocol/serverInfo.
-
orionis.mcp.protocol.constants.SUBSCRIPTION_ID
orionis.mcp.protocol.constants.html#SUBSCRIPTION_ID
Attribute
Constant
PUBLIC
io.modelcontextprotocol/subscriptionId.
-
orionis.mcp.protocol.constants.LOG_LEVEL
orionis.mcp.protocol.constants.html#LOG_LEVEL
Attribute
Constant
PUBLIC
io.modelcontextprotocol/logLevel.
-
orionis.mcp.protocol.requests.RequestId
orionis.mcp.protocol.requests.html#RequestId
Attribute
Type Alias
PUBLIC
Type alias for str | int.
-
orionis.mcp.protocol.requests.Metadata
orionis.mcp.protocol.requests.html#Metadata
Attribute
Type Alias
PUBLIC
Type alias for dict[str, object].
-
orionis.mcp.protocol.requests.LoggingLevel
orionis.mcp.protocol.requests.html#LoggingLevel
Attribute
Type Alias
PUBLIC
Type alias for Literal['debug', 'info', 'notice', 'warning', 'error', 'critical',
'alert', 'emergency'].
-
orionis.mcp.protocol.requests.JsonRpcRequest
orionis.mcp.protocol.requests.JsonRpcRequest.html
Class
Class
PUBLIC
A request or notification, with lazily decoded parameters.
-
orionis.mcp.protocol.requests.JsonRpcRequest.jsonrpc
orionis.mcp.protocol.requests.JsonRpcRequest.html#jsonrpc
Attribute
Class Variable
PUBLIC
JSON-RPC version marker, which must be 2.0.
-
orionis.mcp.protocol.requests.JsonRpcRequest.method
orionis.mcp.protocol.requests.JsonRpcRequest.html#method
Attribute
Class Variable
PUBLIC
JSON-RPC method requested by the client.
-
orionis.mcp.protocol.requests.JsonRpcRequest.params
orionis.mcp.protocol.requests.JsonRpcRequest.html#params
Attribute
Class Variable
PUBLIC
Parameters carried by the JSON-RPC message.
-
orionis.mcp.protocol.requests.RequestParams
orionis.mcp.protocol.requests.RequestParams.html
Class
Class
PUBLIC
Common metadata, retained verbatim including extension keys.
-
orionis.mcp.protocol.requests.RequestParams.meta
orionis.mcp.protocol.requests.RequestParams.html#meta
Attribute
Class Variable
PUBLIC
Meta produced by msgspec.field.
-
orionis.mcp.protocol.requests.PaginatedParams
orionis.mcp.protocol.requests.PaginatedParams.html
Class
Class
PUBLIC
An opaque stateless cursor.
-
orionis.mcp.protocol.requests.InputResponseParams
orionis.mcp.protocol.requests.InputResponseParams.html
Class
Class
PUBLIC
Explicit state and client inputs for an MRTR retry.
-
orionis.mcp.protocol.requests.CallToolParams
orionis.mcp.protocol.requests.CallToolParams.html
Class
Class
PUBLIC
Client-controlled tool payload, separate from DI.
-
orionis.mcp.protocol.requests.CallToolParams.name
orionis.mcp.protocol.requests.CallToolParams.html#name
Attribute
Class Variable
PUBLIC
Name identifying this declaration within its containing registry.
-
orionis.mcp.protocol.requests.CallToolParams.arguments
orionis.mcp.protocol.requests.CallToolParams.html#arguments
Attribute
Class Variable
PUBLIC
Command-line argument declarations accepted by this command.
-
orionis.mcp.protocol.requests.ReadResourceParams
orionis.mcp.protocol.requests.ReadResourceParams.html
Class
Class
PUBLIC
The requested resource URI.
-
orionis.mcp.protocol.requests.ReadResourceParams.uri
orionis.mcp.protocol.requests.ReadResourceParams.html#uri
Attribute
Class Variable
PUBLIC
Resource URI identifying the requested or returned content.
-
orionis.mcp.protocol.requests.GetPromptParams
orionis.mcp.protocol.requests.GetPromptParams.html
Class
Class
PUBLIC
String-valued prompt arguments.
-
orionis.mcp.protocol.requests.GetPromptParams.name
orionis.mcp.protocol.requests.GetPromptParams.html#name
Attribute
Class Variable
PUBLIC
Name identifying this declaration within its containing registry.
-
orionis.mcp.protocol.requests.GetPromptParams.arguments
orionis.mcp.protocol.requests.GetPromptParams.html#arguments
Attribute
Class Variable
PUBLIC
Command-line argument declarations accepted by this command.
-
orionis.mcp.protocol.requests.PromptReference
orionis.mcp.protocol.requests.PromptReference.html
Class
Class
PUBLIC
Reference a prompt for completion.
-
orionis.mcp.protocol.requests.PromptReference.name
orionis.mcp.protocol.requests.PromptReference.html#name
Attribute
Class Variable
PUBLIC
Name identifying this declaration within its containing registry.
-
orionis.mcp.protocol.requests.ResourceTemplateReference
orionis.mcp.protocol.requests.ResourceTemplateReference.html
Class
Class
PUBLIC
Reference an RFC 6570 resource template for completion.
-
orionis.mcp.protocol.requests.ResourceTemplateReference.uri
orionis.mcp.protocol.requests.ResourceTemplateReference.html#uri
Attribute
Class Variable
PUBLIC
Resource URI identifying the requested or returned content.
-
orionis.mcp.protocol.requests.CompletionArgument
orionis.mcp.protocol.requests.CompletionArgument.html
Class
Class
PUBLIC
One incomplete argument.
-
orionis.mcp.protocol.requests.CompletionArgument.name
orionis.mcp.protocol.requests.CompletionArgument.html#name
Attribute
Class Variable
PUBLIC
Name identifying this declaration within its containing registry.
-
orionis.mcp.protocol.requests.CompletionArgument.value
orionis.mcp.protocol.requests.CompletionArgument.html#value
Attribute
Class Variable
PUBLIC
Payload retained for subsequent resolution or restoration.
-
orionis.mcp.protocol.requests.CompletionContext
orionis.mcp.protocol.requests.CompletionContext.html
Class
Class
PUBLIC
Previously completed arguments.
-
orionis.mcp.protocol.requests.CompletionContext.arguments
orionis.mcp.protocol.requests.CompletionContext.html#arguments
Attribute
Class Variable
PUBLIC
Command-line argument declarations accepted by this command.
-
orionis.mcp.protocol.requests.CompleteParams
orionis.mcp.protocol.requests.CompleteParams.html
Class
Class
PUBLIC
Typed completion reference and context.
-
orionis.mcp.protocol.requests.CompleteParams.ref
orionis.mcp.protocol.requests.CompleteParams.html#ref
Attribute
Class Variable
PUBLIC
Reference identifying the primitive for completion.
-
orionis.mcp.protocol.requests.CompleteParams.argument
orionis.mcp.protocol.requests.CompleteParams.html#argument
Attribute
Class Variable
PUBLIC
Argument whose value requires completion.
-
orionis.mcp.protocol.requests.SubscriptionFilter
orionis.mcp.protocol.requests.SubscriptionFilter.html
Class
Class
PUBLIC
Explicit opt-in to server change notifications.
-
orionis.mcp.protocol.requests.SubscriptionFilter.toolsListChanged
orionis.mcp.protocol.requests.SubscriptionFilter.html#toolsListChanged
Attribute
Class Variable
PUBLIC
Tools list changed flag used by SubscriptionFilter.
-
orionis.mcp.protocol.requests.SubscriptionFilter.promptsListChanged
orionis.mcp.protocol.requests.SubscriptionFilter.html#promptsListChanged
Attribute
Class Variable
PUBLIC
Prompts list changed flag used by SubscriptionFilter.
-
orionis.mcp.protocol.requests.SubscriptionFilter.resourcesListChanged
orionis.mcp.protocol.requests.SubscriptionFilter.html#resourcesListChanged
Attribute
Class Variable
PUBLIC
Resources list changed flag used by SubscriptionFilter.
-
orionis.mcp.protocol.requests.SubscriptionFilter.resourceSubscriptions
orionis.mcp.protocol.requests.SubscriptionFilter.html#resourceSubscriptions
Attribute
Class Variable
PUBLIC
Resource URIs for which change notifications are requested.
-
orionis.mcp.protocol.requests.ListenParams
orionis.mcp.protocol.requests.ListenParams.html
Class
Class
PUBLIC
A filter belonging to one long-lived request.
-
orionis.mcp.protocol.requests.ListenParams.notifications
orionis.mcp.protocol.requests.ListenParams.html#notifications
Attribute
Class Variable
PUBLIC
Notification categories selected by the subscriber.
-
orionis.mcp.protocol.requests.CancelledParams
orionis.mcp.protocol.requests.CancelledParams.html
Class
Class
PUBLIC
STDIO cancellation notification parameters.
-
orionis.mcp.protocol.requests.CancelledParams.requestId
orionis.mcp.protocol.requests.CancelledParams.html#requestId
Attribute
Class Variable
PUBLIC
Identifier of the request being cancelled.
-
orionis.mcp.protocol.requests.RequestMetadata
orionis.mcp.protocol.requests.RequestMetadata.html
Class
Class
PUBLIC
Validate reserved metadata while preserving the original mapping.
-
orionis.mcp.protocol.requests.RequestMetadata.protocol_version
orionis.mcp.protocol.requests.RequestMetadata.html#protocol_version
Attribute
Class Variable
PUBLIC
Protocol version produced by msgspec.field.
-
orionis.mcp.protocol.requests.RequestMetadata.capabilities
orionis.mcp.protocol.requests.RequestMetadata.html#capabilities
Attribute
Class Variable
PUBLIC
Capabilities advertised by the compiled server.
-
orionis.mcp.protocol.requests.RequestMetadata.client_info
orionis.mcp.protocol.requests.RequestMetadata.html#client_info
Attribute
Class Variable
PUBLIC
Client info produced by msgspec.field.
-
orionis.mcp.protocol.requests.RequestMetadata.log_level
orionis.mcp.protocol.requests.RequestMetadata.html#log_level
Attribute
Class Variable
PUBLIC
Log level produced by msgspec.field.
-
orionis.mcp.transport.headers._validate_standard
orionis.mcp.transport.headers.html#_validate_standard
Function
Function
PUBLIC
Compare one required standard header with its corresponding body field.
-
orionis.mcp.server.compiler._JsonObject
orionis.mcp.server.compiler.html#_JsonObject
Attribute
Type Alias
PUBLIC
Type alias for dict[str, object].
-
orionis.mcp.server.compiler._NAME
orionis.mcp.server.compiler.html#_NAME
Attribute
Constant
PUBLIC
Compiled pattern used to recognize name.
-
orionis.mcp.server.compiler._CORE_METHODS
orionis.mcp.server.compiler.html#_CORE_METHODS
Attribute
Constant
PUBLIC
Core methods used by compiler.
-
orionis.mcp.server.compiler._SearchPayload
orionis.mcp.server.compiler._SearchPayload.html
Class
Class
PUBLIC
Bounded searchable catalog arguments.
-
orionis.mcp.server.compiler._SearchPayload.query
orionis.mcp.server.compiler._SearchPayload.html#query
Attribute
Class Variable
PUBLIC
''.
-
orionis.mcp.server.compiler._SearchPayload.limit
orionis.mcp.server.compiler._SearchPayload.html#limit
Attribute
Class Variable
PUBLIC
Limit value used by _SearchPayload.
-
orionis.mcp.server.compiler._CatalogCall
orionis.mcp.server.compiler._CatalogCall.html
Class
Class
PUBLIC
An independent catalog invocation, with no Python call kwargs.
-
orionis.mcp.server.compiler._CatalogCall.name
orionis.mcp.server.compiler._CatalogCall.html#name
Attribute
Class Variable
PUBLIC
Name identifying this declaration within its containing registry.
-
orionis.mcp.server.compiler._CatalogCall.arguments
orionis.mcp.server.compiler._CatalogCall.html#arguments
Attribute
Class Variable
PUBLIC
Command-line argument declarations accepted by this command.
-
orionis.mcp.server.compiler._ExecutePayload
orionis.mcp.server.compiler._ExecutePayload.html
Class
Class
PUBLIC
Request limits are additionally enforced by the dispatcher configuration.
-
orionis.mcp.server.compiler._ExecutePayload.calls
orionis.mcp.server.compiler._ExecutePayload.html#calls
Attribute
Class Variable
PUBLIC
Tool invocations included in the catalog execution request.
-
orionis.mcp.server.compiler.CompiledPrimitive
orionis.mcp.server.compiler.CompiledPrimitive.html
Class
Class
PUBLIC
Unbound declaration metadata, with no identity or per-call service instance.
-
orionis.mcp.server.compiler.CompiledPrimitive.definition
orionis.mcp.server.compiler.CompiledPrimitive.html#definition
Attribute
Class Variable
PUBLIC
Original declaration from which runtime metadata was compiled.
-
orionis.mcp.server.compiler.CompiledPrimitive.name
orionis.mcp.server.compiler.CompiledPrimitive.html#name
Attribute
Class Variable
PUBLIC
Name identifying this declaration within its containing registry.
-
orionis.mcp.server.compiler.CompiledPrimitive.metadata
orionis.mcp.server.compiler.CompiledPrimitive.html#metadata
Attribute
Class Variable
PUBLIC
Compiled metadata used to describe and invoke the registered operation.
-
orionis.mcp.server.compiler.CompiledPrimitive.handler
orionis.mcp.server.compiler.CompiledPrimitive.html#handler
Attribute
Class Variable
PUBLIC
Callable or method selected to handle the registered operation.
-
orionis.mcp.server.compiler.CompiledPrimitive.description
orionis.mcp.server.compiler.CompiledPrimitive.html#description
Attribute
Class Variable
PUBLIC
''.
-
orionis.mcp.server.compiler.CompiledPrimitive.availability
orionis.mcp.server.compiler.CompiledPrimitive.html#availability
Attribute
Class Variable
PUBLIC
Hook determining whether the primitive is visible for this request.
-
orionis.mcp.server.compiler.CompiledPrimitive.authorization
orionis.mcp.server.compiler.CompiledPrimitive.html#authorization
Attribute
Class Variable
PUBLIC
Hook deciding whether the current caller may invoke the primitive.
-
orionis.mcp.server.compiler.CompiledPrimitive.completion
orionis.mcp.server.compiler.CompiledPrimitive.html#completion
Attribute
Class Variable
PUBLIC
Completion provider or result associated with the primitive.
-
orionis.mcp.server.compiler.CompiledPrimitive.input_type
orionis.mcp.server.compiler.CompiledPrimitive.html#input_type
Attribute
Class Variable
PUBLIC
Python schema type used to decode and validate handler input.
-
orionis.mcp.server.compiler.CompiledPrimitive.input_schema
orionis.mcp.server.compiler.CompiledPrimitive.html#input_schema
Attribute
Class Variable
PUBLIC
JSON Schema describing the accepted input.
-
orionis.mcp.server.compiler.CompiledPrimitive.output_schema
orionis.mcp.server.compiler.CompiledPrimitive.html#output_schema
Attribute
Class Variable
PUBLIC
JSON Schema describing the declared structured output.
-
orionis.mcp.server.compiler.CompiledPrimitive.input_plan
orionis.mcp.server.compiler.CompiledPrimitive.html#input_plan
Attribute
Class Variable
PUBLIC
Prepared input conversion and nested rule metadata.
-
orionis.mcp.server.compiler.CompiledPrimitive.output_plan
orionis.mcp.server.compiler.CompiledPrimitive.html#output_plan
Attribute
Class Variable
PUBLIC
Prepared output conversion and nested rule metadata.
-
orionis.mcp.server.compiler.CompiledPrimitive.cache
orionis.mcp.server.compiler.CompiledPrimitive.html#cache
Attribute
Class Variable
PUBLIC
Cache policy or cached state used by this component.
-
orionis.mcp.server.compiler.CompiledPrimitive.uri
orionis.mcp.server.compiler.CompiledPrimitive.html#uri
Attribute
Class Variable
PUBLIC
Resource URI identifying the requested or returned content.
-
orionis.mcp.server.compiler.CompiledPrimitive.mime_type
orionis.mcp.server.compiler.CompiledPrimitive.html#mime_type
Attribute
Class Variable
PUBLIC
Media type describing the resource content.
-
orionis.mcp.server.compiler.CompiledPrimitive.prompt_arguments
orionis.mcp.server.compiler.CompiledPrimitive.html#prompt_arguments
Attribute
Class Variable
PUBLIC
Argument declarations accepted by the prompt.
-
orionis.mcp.server.compiler.CompiledPrimitive.matcher
orionis.mcp.server.compiler.CompiledPrimitive.html#matcher
Attribute
Class Variable
PUBLIC
Compiled matcher resolving parameters from a resource URI.
-
orionis.mcp.server.compiler.CompiledPrimitive.synthetic
orionis.mcp.server.compiler.CompiledPrimitive.html#synthetic
Attribute
Class Variable
PUBLIC
Whether this primitive was generated for catalog dispatch.
-
orionis.mcp.server.compiler.CompiledPrimitive.catalog
orionis.mcp.server.compiler.CompiledPrimitive.html#catalog
Attribute
Class Variable
PUBLIC
Catalog metadata associated with this primitive.
-
orionis.mcp.server.compiler.CompiledPrimitive.search_text
orionis.mcp.server.compiler.CompiledPrimitive.html#search_text
Attribute
Class Variable
PUBLIC
''.
-
orionis.mcp.server.compiler.CompiledCatalog
orionis.mcp.server.compiler.CompiledCatalog.html
Class
Class
PUBLIC
One hidden catalog and its deterministic boot-time lexical index.
-
orionis.mcp.server.compiler.CompiledCatalog.tools
orionis.mcp.server.compiler.CompiledCatalog.html#tools
Attribute
Class Variable
PUBLIC
Tool declarations available through this server or catalog.
-
orionis.mcp.server.compiler.CompiledCatalog.search_name
orionis.mcp.server.compiler.CompiledCatalog.html#search_name
Attribute
Class Variable
PUBLIC
Public tool name used to search the catalog.
-
orionis.mcp.server.compiler.CompiledCatalog.execute_name
orionis.mcp.server.compiler.CompiledCatalog.html#execute_name
Attribute
Class Variable
PUBLIC
Public tool name used to execute catalog calls.
-
orionis.mcp.server.compiler.CompiledCatalog.index
orionis.mcp.server.compiler.CompiledCatalog.html#index
Attribute
Class Variable
PUBLIC
Lookup index used to resolve registered entries.
-
orionis.mcp.server.compiler.CompiledMcpServer
orionis.mcp.server.compiler.CompiledMcpServer.html
Class
Class
PUBLIC
A definition reusable by every request, worker and supported transport.
-
orionis.mcp.server.compiler.CompiledMcpServer.definition
orionis.mcp.server.compiler.CompiledMcpServer.html#definition
Attribute
Class Variable
PUBLIC
Original declaration from which runtime metadata was compiled.
-
orionis.mcp.server.compiler.CompiledMcpServer.tools
orionis.mcp.server.compiler.CompiledMcpServer.html#tools
Attribute
Class Variable
PUBLIC
Tool declarations available through this server or catalog.
-
orionis.mcp.server.compiler.CompiledMcpServer.resources
orionis.mcp.server.compiler.CompiledMcpServer.html#resources
Attribute
Class Variable
PUBLIC
Resource declarations available through this server.
-
orionis.mcp.server.compiler.CompiledMcpServer.prompts
orionis.mcp.server.compiler.CompiledMcpServer.html#prompts
Attribute
Class Variable
PUBLIC
Prompt declarations available through this server.
-
orionis.mcp.server.compiler.CompiledMcpServer.templates
orionis.mcp.server.compiler.CompiledMcpServer.html#templates
Attribute
Class Variable
PUBLIC
Compiled resource templates indexed by their identifiers.
-
orionis.mcp.server.compiler.CompiledMcpServer.info
orionis.mcp.server.compiler.CompiledMcpServer.html#info
Attribute
Class Variable
PUBLIC
Server identity metadata exposed during discovery.
-
orionis.mcp.server.compiler.CompiledMcpServer.capabilities
orionis.mcp.server.compiler.CompiledMcpServer.html#capabilities
Attribute
Class Variable
PUBLIC
Capabilities advertised by the compiled server.
-
orionis.mcp.server.compiler.CompiledMcpServer.capabilities_wire
orionis.mcp.server.compiler.CompiledMcpServer.html#capabilities_wire
Attribute
Class Variable
PUBLIC
Preencoded capabilities retained for protocol responses.
-
orionis.mcp.server.compiler.CompiledMcpServer.instructions
orionis.mcp.server.compiler.CompiledMcpServer.html#instructions
Attribute
Class Variable
PUBLIC
Instructions exposed by the server to protocol clients.
-
orionis.mcp.server.compiler.CompiledMcpServer.cache
orionis.mcp.server.compiler.CompiledMcpServer.html#cache
Attribute
Class Variable
PUBLIC
Cache policy or cached state used by this component.
-
orionis.mcp.server.compiler.CompiledMcpServer.extensions
orionis.mcp.server.compiler.CompiledMcpServer.html#extensions
Attribute
Class Variable
PUBLIC
Extensions registered for this server or transport.
-
orionis.mcp.server.compiler.CompiledMcpServer.catalog_tools
orionis.mcp.server.compiler.CompiledMcpServer.html#catalog_tools
Attribute
Class Variable
PUBLIC
Tools belonging to compiled catalogs.
-
orionis.mcp.server.compiler.CompiledMcpServer.catalogs
orionis.mcp.server.compiler.CompiledMcpServer.html#catalogs
Attribute
Class Variable
PUBLIC
Catalogs compiled for this server.
-
orionis.mcp.server.compiler._wire
orionis.mcp.server.compiler.html#_wire
Function
Function
PUBLIC
Freeze wire metadata into immutable JSON without retaining mutable maps.
-
orionis.mcp.server.compiler._validate_static_metadata
orionis.mcp.server.compiler.html#_validate_static_metadata
Function
Function
PUBLIC
Check declaration constructors once, keeping validation off list hot paths.
-
orionis.mcp.server.compiler._extend_metadata
orionis.mcp.server.compiler.html#_extend_metadata
Function
Function
PUBLIC
Let extensions attach data without changing compiled native contracts.
-
orionis.mcp.server.compiler._name
orionis.mcp.server.compiler.html#_name
Function
Function
PUBLIC
Derive readable kebab names while honoring explicit protocol identifiers.
-
orionis.mcp.server.compiler._metadata
orionis.mcp.server.compiler.html#_metadata
Function
Function
PUBLIC
Snapshot common metadata before adding primitive-specific wire fields.
-
orionis.mcp.server.compiler._hook
orionis.mcp.server.compiler.html#_hook
Function
Function
PUBLIC
Compile optional per-request checks without resolving a handler instance.
-
orionis.mcp.server.compiler._tool_arguments
orionis.mcp.server.compiler.html#_tool_arguments
Function
Function
PUBLIC
Enumerate generic Tool arguments in method resolution order.
-
orionis.mcp.server.compiler._tool_types
orionis.mcp.server.compiler.html#_tool_types
Function
Function
PUBLIC
Resolve explicit or generic input and output declarations.
-
orionis.mcp.server.compiler._Compiler
orionis.mcp.server.compiler._Compiler.html
Class
Class
PUBLIC
Own only boot-time schema caches; discard them after the registry is built.
-
orionis.mcp.server.compiler._Compiler.__slots__
orionis.mcp.server.compiler._Compiler.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.mcp.server.compiler._Compiler.__init__
orionis.mcp.server.compiler._Compiler.html#__init__
Function
Method
PUBLIC
Use a per-compilation cache rather than growing a process-global cache.
-
orionis.mcp.server.compiler._Compiler.schemas
orionis.mcp.server.compiler._Compiler.html#schemas
Attribute
Instance Variable
PUBLIC
Schema definitions collected during compilation.
-
orionis.mcp.server.compiler._Compiler.extensions
orionis.mcp.server.compiler._Compiler.html#extensions
Attribute
Instance Variable
PUBLIC
Value supplied for extensions.
-
orionis.mcp.server.compiler._Compiler.cache
orionis.mcp.server.compiler._Compiler.html#cache
Attribute
Instance Variable
PUBLIC
Value supplied for cache.
-
orionis.mcp.server.compiler._Compiler.schema
orionis.mcp.server.compiler._Compiler.html#schema
Function
Method
PUBLIC
Share one schema snapshot per type and direction inside this compilation.
-
orionis.mcp.server.compiler._Compiler.primitive
orionis.mcp.server.compiler._Compiler.html#primitive
Function
Method
PUBLIC
Compile one ordinary primitive and all of its immutable handler plans.
-
orionis.mcp.server.compiler._Compiler._tool
orionis.mcp.server.compiler._Compiler.html#_tool
Function
Method
PUBLIC
Compile typed tool schemas and statically reachable header bindings.
-
orionis.mcp.server.compiler._Compiler._resource
orionis.mcp.server.compiler._Compiler.html#_resource
Function
Static Method
PUBLIC
Compile exact resources and RFC templates with safe inverse matching.
-
orionis.mcp.server.compiler._Compiler._prompt
orionis.mcp.server.compiler._Compiler.html#_prompt
Function
Static Method
PUBLIC
Compile only explicitly named prompt arguments.
-
orionis.mcp.server.compiler._Compiler.synthetic
orionis.mcp.server.compiler._Compiler.html#synthetic
Function
Method
PUBLIC
Describe runtime-owned catalog operations using native typed schemas.
-
orionis.mcp.server.compiler._insert
orionis.mcp.server.compiler.html#_insert
Function
Function
PUBLIC
Reject collisions at boot instead of changing lookup semantics silently.
-
orionis.mcp.server.compiler._extensions
orionis.mcp.server.compiler.html#_extensions
Function
Function
PUBLIC
Reject extension collisions with built-in methods and other extensions.
-
orionis.mcp.server.compiler._ordered
orionis.mcp.server.compiler.html#_ordered
Function
Function
PUBLIC
Keep deterministic name order in the compiled mapping, including URI keys.
-
orionis.mcp.server.compiler._tool_registry
orionis.mcp.server.compiler.html#_tool_registry
Function
Function
PUBLIC
Compile visible and hidden tool namespaces with collision checks.
-
orionis.mcp.server.compiler._resource_registry
orionis.mcp.server.compiler.html#_resource_registry
Function
Function
PUBLIC
Reject identical URI/template names and automatically detectable ambiguity.
-
orionis.mcp.server.compiler._capabilities
orionis.mcp.server.compiler.html#_capabilities
Function
Function
PUBLIC
Advertise only the methods and notifications backed by this registry.
-
orionis.mcp.server.compiler.compile_server
orionis.mcp.server.compiler.html#compile_server
Function
Function
PUBLIC
Compile one definition without resolving services or retaining runtime state.
-
orionis.mcp.server.compiler.validate_payload
orionis.mcp.server.compiler.html#validate_payload
Function
Function
PUBLIC
Validate only the tool's argument object, never the HTTP JSON-RPC envelope.
-
orionis.mcp.server.compiler.validate_output
orionis.mcp.server.compiler.html#validate_output
Function
Function
PUBLIC
Enforce the advertised native output type before encoding structured data.
-
orionis.mcp.server.compiler.validate_prompt_arguments
orionis.mcp.server.compiler.html#validate_prompt_arguments
Function
Function
PUBLIC
Check required/unknown argument names and the protocol's string values.
-
orionis.mcp.contracts.manager.IMcpManager
orionis.mcp.contracts.manager.IMcpManager.html
Class
Class
PUBLIC
Share compiled servers, native routes, local transports, and change events.
-
orionis.mcp.contracts.manager.IMcpManager.__slots__
orionis.mcp.contracts.manager.IMcpManager.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.mcp.contracts.manager.IMcpManager.web
orionis.mcp.contracts.manager.IMcpManager.html#web
Function
Method
PUBLIC
Register a server on one native HTTP POST route.
-
orionis.mcp.contracts.manager.IMcpManager.local
orionis.mcp.contracts.manager.IMcpManager.html#local
Function
Method
PUBLIC
Register a server for an explicit local CLI handle.
-
orionis.mcp.contracts.manager.IMcpManager.finalizeRoutes
orionis.mcp.contracts.manager.IMcpManager.html#finalizeRoutes
Function
Method
PUBLIC
Index final native route paths after fluent prefixes and groups.
-
orionis.mcp.contracts.manager.IMcpManager.getWebServer
orionis.mcp.contracts.manager.IMcpManager.html#getWebServer
Function
Method
PUBLIC
Find the compiled server assigned to an HTTP path.
-
orionis.mcp.contracts.manager.IMcpManager.getLocalServer
orionis.mcp.contracts.manager.IMcpManager.html#getLocalServer
Function
Method
PUBLIC
Find the compiled server assigned to a local handle.
-
orionis.mcp.contracts.manager.IMcpManager.servers
orionis.mcp.contracts.manager.IMcpManager.html#servers
Function
Method
PUBLIC
Describe registered transports without exposing mutable registries.
-
orionis.mcp.contracts.manager.IMcpManager.dispatchHttp
orionis.mcp.contracts.manager.IMcpManager.html#dispatchHttp
Function
Method
PUBLIC
Handle a request through the shared compiled server's HTTP transport.
-
orionis.mcp.contracts.manager.IMcpManager.startLocal
orionis.mcp.contracts.manager.IMcpManager.html#startLocal
Function
Method
PUBLIC
Serve one registered local server until EOF or cancellation.
-
orionis.mcp.contracts.manager.IMcpManager.toolsChanged
orionis.mcp.contracts.manager.IMcpManager.html#toolsChanged
Function
Method
PUBLIC
Publish that an authorized tool catalog may have changed.
-
orionis.mcp.contracts.manager.IMcpManager.promptsChanged
orionis.mcp.contracts.manager.IMcpManager.html#promptsChanged
Function
Method
PUBLIC
Publish that an authorized prompt catalog may have changed.
-
orionis.mcp.contracts.manager.IMcpManager.resourcesChanged
orionis.mcp.contracts.manager.IMcpManager.html#resourcesChanged
Function
Method
PUBLIC
Publish that an authorized resource catalog may have changed.
-
orionis.mcp.contracts.manager.IMcpManager.resourceUpdated
orionis.mcp.contracts.manager.IMcpManager.html#resourceUpdated
Function
Method
PUBLIC
Publish a resource change to listeners that requested that URI.
-
orionis.mcp.contracts.manager.IMcpManager.shutdown
orionis.mcp.contracts.manager.IMcpManager.html#shutdown
Function
Method
PUBLIC
Wake active subscription streams for graceful completion.
-
orionis.console.commands.mcp.list.McpListCommand
orionis.console.commands.mcp.list.McpListCommand.html
Class
Class
PUBLIC
Describe registered servers without opening their transports.
-
orionis.console.commands.mcp.list.McpListCommand.timestamps
orionis.console.commands.mcp.list.McpListCommand.html#timestamps
Attribute
Class Variable
PUBLIC
Timestamps flag used by McpListCommand.
-
orionis.console.commands.mcp.list.McpListCommand.signature
orionis.console.commands.mcp.list.McpListCommand.html#signature
Attribute
Class Variable
PUBLIC
mcp:list.
-
orionis.console.commands.mcp.list.McpListCommand.description
orionis.console.commands.mcp.list.McpListCommand.html#description
Attribute
Class Variable
PUBLIC
List registered HTTP and local MCP servers..
-
orionis.console.commands.mcp.list.McpListCommand.handle
orionis.console.commands.mcp.list.McpListCommand.html#handle
Function
Method
PUBLIC
Show each transport, address and server declaration.
-
orionis.console.commands.mcp.start.McpStartCommand
orionis.console.commands.mcp.start.McpStartCommand.html
Class
Class
PUBLIC
Run one explicitly registered local MCP server.
-
orionis.console.commands.mcp.start.McpStartCommand.timestamps
orionis.console.commands.mcp.start.McpStartCommand.html#timestamps
Attribute
Class Variable
PUBLIC
Timestamps flag used by McpStartCommand.
-
orionis.console.commands.mcp.start.McpStartCommand.signature
orionis.console.commands.mcp.start.McpStartCommand.html#signature
Attribute
Class Variable
PUBLIC
mcp:start.
-
orionis.console.commands.mcp.start.McpStartCommand.description
orionis.console.commands.mcp.start.McpStartCommand.html#description
Attribute
Class Variable
PUBLIC
Start a registered MCP 2026-07-28 server over
STDIO..
-
orionis.console.commands.mcp.start.McpStartCommand.arguments
orionis.console.commands.mcp.start.McpStartCommand.html#arguments
Attribute
Class Variable
PUBLIC
Command-line argument declarations accepted by this command.
-
orionis.console.commands.mcp.start.McpStartCommand.handle
orionis.console.commands.mcp.start.McpStartCommand.html#handle
Function
Method
PUBLIC
Preserve protocol-only STDOUT and fail unknown handles without imports.
-
orionis.database.contracts.migrator.IMigrator
orionis.database.contracts.migrator.IMigrator.html
Class
Class
PUBLIC
Contract for the database migration runner.
-
orionis.database.contracts.migrator.IMigrator.__slots__
orionis.database.contracts.migrator.IMigrator.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.database.contracts.migrator.IMigrator.migrate
orionis.database.contracts.migrator.IMigrator.html#migrate
Function
Method
PUBLIC
Apply every migration that has not been run yet.
-
orionis.database.contracts.migrator.IMigrator.rollback
orionis.database.contracts.migrator.IMigrator.html#rollback
Function
Method
PUBLIC
Revert the most recently applied migration batches.
-
orionis.database.contracts.migrator.IMigrator.reset
orionis.database.contracts.migrator.IMigrator.html#reset
Function
Method
PUBLIC
Revert every migration recorded on the connection.
-
orionis.database.contracts.migrator.IMigrator.refresh
orionis.database.contracts.migrator.IMigrator.html#refresh
Function
Method
PUBLIC
Roll back migrations and immediately apply them again.
-
orionis.database.contracts.migrator.IMigrator.fresh
orionis.database.contracts.migrator.IMigrator.html#fresh
Function
Method
PUBLIC
Drop the tracking table and apply every migration from scratch.
-
orionis.database.contracts.migrator.IMigrator.status
orionis.database.contracts.migrator.IMigrator.html#status
Function
Method
PUBLIC
Report which migrations are applied and which are pending.
-
orionis.database.migrations.migrator._MIGRATIONS_TABLE
orionis.database.migrations.migrator.module.html#_MIGRATIONS_TABLE
Attribute
Constant
PUBLIC
Name of the table used to track already-applied migrations.
-
orionis.database.migrations.migrator._SEEDERS_TABLE
orionis.database.migrations.migrator.module.html#_SEEDERS_TABLE
Attribute
Constant
PUBLIC
Seeder history belongs to a schema built by the recorded migrations.
-
orionis.database.migrations.migrator._build_migrations_table
orionis.database.migrations.migrator.module.html#_build_migrations_table
Function
Function
PUBLIC
Build the table definition for the migrations tracking table.
-
orionis.database.migrations.migrator._MIGRATIONS_TABLE_DEFINITION
orionis.database.migrations.migrator.module.html#_MIGRATIONS_TABLE_DEFINITION
Attribute
Constant
PUBLIC
Define the columns used to track applied migrations.
-
orionis.console.commands.migrate.fresh.MigrateFreshCommand
orionis.console.commands.migrate.fresh.MigrateFreshCommand.html
Class
Class
PUBLIC
Clear migration and seeder history, then rebuild the schema.
-
orionis.console.commands.migrate.fresh.MigrateFreshCommand.signature
orionis.console.commands.migrate.fresh.MigrateFreshCommand.html#signature
Attribute
Class Variable
PUBLIC
migrate:fresh.
-
orionis.console.commands.migrate.fresh.MigrateFreshCommand.description
orionis.console.commands.migrate.fresh.MigrateFreshCommand.html#description
Attribute
Class Variable
PUBLIC
Clears migration and seeder history, then migrates..
-
orionis.console.commands.migrate.fresh.MigrateFreshCommand.handle
orionis.console.commands.migrate.fresh.MigrateFreshCommand.html#handle
Function
Method
PUBLIC
Clear migration and seeder history, then apply every migration.
-
orionis.console.commands.migrate.migrate.MigrateCommand
orionis.console.commands.migrate.migrate.MigrateCommand.html
Class
Class
PUBLIC
Apply every migration that has not been run yet.
-
orionis.console.commands.migrate.migrate.MigrateCommand.signature
orionis.console.commands.migrate.migrate.MigrateCommand.html#signature
Attribute
Class Variable
PUBLIC
migrate.
-
orionis.console.commands.migrate.migrate.MigrateCommand.description
orionis.console.commands.migrate.migrate.MigrateCommand.html#description
Attribute
Class Variable
PUBLIC
Runs all pending database migrations..
-
orionis.console.commands.migrate.migrate.MigrateCommand.arguments
orionis.console.commands.migrate.migrate.MigrateCommand.html#arguments
Attribute
Class Variable
PUBLIC
Command-line argument declarations accepted by this command.
-
orionis.console.commands.migrate.migrate.MigrateCommand.handle
orionis.console.commands.migrate.migrate.MigrateCommand.html#handle
Function
Method
PUBLIC
Apply every migration that has not been run yet.
-
orionis.console.commands.migrate.refresh.MigrateRefreshCommand
orionis.console.commands.migrate.refresh.MigrateRefreshCommand.html
Class
Class
PUBLIC
Roll back migrations and immediately apply them again.
-
orionis.console.commands.migrate.refresh.MigrateRefreshCommand.signature
orionis.console.commands.migrate.refresh.MigrateRefreshCommand.html#signature
Attribute
Class Variable
PUBLIC
migrate:refresh.
-
orionis.console.commands.migrate.refresh.MigrateRefreshCommand.description
orionis.console.commands.migrate.refresh.MigrateRefreshCommand.html#description
Attribute
Class Variable
PUBLIC
Rolls back and re-applies database migrations..
-
orionis.console.commands.migrate.refresh.MigrateRefreshCommand.arguments
orionis.console.commands.migrate.refresh.MigrateRefreshCommand.html#arguments
Attribute
Class Variable
PUBLIC
Command-line argument declarations accepted by this command.
-
orionis.console.commands.migrate.refresh.MigrateRefreshCommand.handle
orionis.console.commands.migrate.refresh.MigrateRefreshCommand.html#handle
Function
Method
PUBLIC
Roll back migrations and immediately apply them again.
-
orionis.console.commands.migrate.reset.MigrateResetCommand
orionis.console.commands.migrate.reset.MigrateResetCommand.html
Class
Class
PUBLIC
Revert every migration recorded on the connection.
-
orionis.console.commands.migrate.reset.MigrateResetCommand.signature
orionis.console.commands.migrate.reset.MigrateResetCommand.html#signature
Attribute
Class Variable
PUBLIC
migrate:reset.
-
orionis.console.commands.migrate.reset.MigrateResetCommand.description
orionis.console.commands.migrate.reset.MigrateResetCommand.html#description
Attribute
Class Variable
PUBLIC
Reverts every applied database migration..
-
orionis.console.commands.migrate.reset.MigrateResetCommand.handle
orionis.console.commands.migrate.reset.MigrateResetCommand.html#handle
Function
Method
PUBLIC
Revert every migration recorded on the connection.
-
orionis.console.commands.migrate.rollback.MigrateRollbackCommand
orionis.console.commands.migrate.rollback.MigrateRollbackCommand.html
Class
Class
PUBLIC
Revert the most recently applied migration batches.
-
orionis.console.commands.migrate.rollback.MigrateRollbackCommand.signature
orionis.console.commands.migrate.rollback.MigrateRollbackCommand.html#signature
Attribute
Class Variable
PUBLIC
migrate:rollback.
-
orionis.console.commands.migrate.rollback.MigrateRollbackCommand.description
orionis.console.commands.migrate.rollback.MigrateRollbackCommand.html#description
Attribute
Class Variable
PUBLIC
Reverts the last batch(es) of database migrations..
-
orionis.console.commands.migrate.rollback.MigrateRollbackCommand.arguments
orionis.console.commands.migrate.rollback.MigrateRollbackCommand.html#arguments
Attribute
Class Variable
PUBLIC
Command-line argument declarations accepted by this command.
-
orionis.console.commands.migrate.rollback.MigrateRollbackCommand.handle
orionis.console.commands.migrate.rollback.MigrateRollbackCommand.html#handle
Function
Method
PUBLIC
Revert the most recently applied migration batches.
-
orionis.console.commands.migrate.status.MigrateStatusCommand
orionis.console.commands.migrate.status.MigrateStatusCommand.html
Class
Class
PUBLIC
Report which migrations are applied and which are pending.
-
orionis.console.commands.migrate.status.MigrateStatusCommand.signature
orionis.console.commands.migrate.status.MigrateStatusCommand.html#signature
Attribute
Class Variable
PUBLIC
migrate:status.
-
orionis.console.commands.migrate.status.MigrateStatusCommand.description
orionis.console.commands.migrate.status.MigrateStatusCommand.html#description
Attribute
Class Variable
PUBLIC
Shows the status of every discovered migration..
-
orionis.console.commands.migrate.status.MigrateStatusCommand.handle
orionis.console.commands.migrate.status.MigrateStatusCommand.html#handle
Function
Method
PUBLIC
Print the applied/pending status of every migration.
-
orionis.queues.entities.reserved_job.ReservedJob
orionis.queues.entities.reserved_job.ReservedJob.html
Class
Class
PUBLIC
Describe a backend claim and its opaque fencing token.
-
orionis.queues.entities.reserved_job.ReservedJob.id
orionis.queues.entities.reserved_job.ReservedJob.html#id
Attribute
Class Variable
PUBLIC
Identifier used to correlate or locate this protocol or storage record.
-
orionis.queues.entities.reserved_job.ReservedJob.payload
orionis.queues.entities.reserved_job.ReservedJob.html#payload
Attribute
Class Variable
PUBLIC
Serialized data required to execute or restore the job.
-
orionis.queues.entities.reserved_job.ReservedJob.queue
orionis.queues.entities.reserved_job.ReservedJob.html#queue
Attribute
Class Variable
PUBLIC
Name of the queue receiving or storing the job.
-
orionis.queues.entities.reserved_job.ReservedJob.attempts
orionis.queues.entities.reserved_job.ReservedJob.html#attempts
Attribute
Class Variable
PUBLIC
Number of execution attempts already made for the job.
-
orionis.queues.entities.reserved_job.ReservedJob.token
orionis.queues.entities.reserved_job.ReservedJob.html#token
Attribute
Class Variable
PUBLIC
Token identifying the current reservation or protected operation.
-
orionis.queues.entities.reserved_job.ReservedJob.reserved_until
orionis.queues.entities.reserved_job.ReservedJob.html#reserved_until
Attribute
Class Variable
PUBLIC
Deadline at which the job reservation expires.
-
orionis.queues.contracts.worker.IWorker
orionis.queues.contracts.worker.IWorker.html
Class
Class
PUBLIC
Declare asynchronous consumption and graceful stopping.
-
orionis.queues.contracts.worker.IWorker.__slots__
orionis.queues.contracts.worker.IWorker.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.queues.contracts.worker.IWorker.run
orionis.queues.contracts.worker.IWorker.html#run
Function
Method
PUBLIC
Consume jobs until stopped or the requested limit is reached.
-
orionis.queues.contracts.worker.IWorker.stop
orionis.queues.contracts.worker.IWorker.html#stop
Function
Method
PUBLIC
Stop reserving jobs and drain in-flight executions.
-
orionis.queues.contracts.worker.IWorker.execute
orionis.queues.contracts.worker.IWorker.html#execute
Function
Method
PUBLIC
Execute one claim through scoped DI and fenced transitions.
-
orionis.console.commands.queue._signals._stop_worker
orionis.console.commands.queue._signals.html#_stop_worker
Function
Function
PUBLIC
Request graceful draining after a process termination signal.
-
orionis.console.commands.queue._signals.WorkerSignals
orionis.console.commands.queue._signals.WorkerSignals.html
Class
Class
PUBLIC
Install temporary worker shutdown handlers on the main thread.
-
orionis.console.commands.queue._signals.WorkerSignals.__slots__
orionis.console.commands.queue._signals.WorkerSignals.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.console.commands.queue._signals.WorkerSignals.__init__
orionis.console.commands.queue._signals.WorkerSignals.html#__init__
Function
Method
PUBLIC
Store the worker and currently running event loop.
-
orionis.console.commands.queue._signals.WorkerSignals._worker
orionis.console.commands.queue._signals.WorkerSignals.html#_worker
Attribute
Instance Variable
PUBLIC
Worker receiving graceful shutdown requests.
-
orionis.console.commands.queue._signals.WorkerSignals._loop
orionis.console.commands.queue._signals.WorkerSignals.html#_loop
Attribute
Instance Variable
PUBLIC
Loop produced by asyncio.get_running_loop.
-
orionis.console.commands.queue._signals.WorkerSignals._handlers
orionis.console.commands.queue._signals.WorkerSignals.html#_handlers
Attribute
Instance Variable
PUBLIC
Handlers retained for dispatch or restoration during cleanup.
-
orionis.console.commands.queue._signals.WorkerSignals.__enter__
orionis.console.commands.queue._signals.WorkerSignals.html#__enter__
Function
Method
PUBLIC
Install portable signal callbacks without replacing thread handlers.
-
orionis.console.commands.queue._signals.WorkerSignals.__exit__
orionis.console.commands.queue._signals.WorkerSignals.html#__exit__
Function
Method
PUBLIC
Restore the application's previous signal handlers.
-
orionis.queues.exceptions.QueueError
orionis.queues.exceptions.QueueError.html
Class
Exception
PUBLIC
Represent a failure in the queue runtime.
-
orionis.queues.exceptions.QueueError.__slots__
orionis.queues.exceptions.QueueError.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.queues.exceptions.QueueConfigurationError
orionis.queues.exceptions.QueueConfigurationError.html
Class
Exception
PUBLIC
Represent invalid connection, worker, or job settings.
-
orionis.queues.exceptions.QueueConfigurationError.__slots__
orionis.queues.exceptions.QueueConfigurationError.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.queues.exceptions.QueuePayloadError
orionis.queues.exceptions.QueuePayloadError.html
Class
Exception
PUBLIC
Represent malformed or unsupported persistent job data.
-
orionis.queues.exceptions.QueuePayloadError.__slots__
orionis.queues.exceptions.QueuePayloadError.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.queues.exceptions.UnknownJobError
orionis.queues.exceptions.UnknownJobError.html
Class
Exception
PUBLIC
Reject a job identity absent from the trusted registry.
-
orionis.queues.exceptions.UnknownJobError.__slots__
orionis.queues.exceptions.UnknownJobError.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.queues.exceptions.QueueStorageError
orionis.queues.exceptions.QueueStorageError.html
Class
Exception
PUBLIC
Represent an invalid response or transition from queue storage.
-
orionis.queues.exceptions.QueueStorageError.__slots__
orionis.queues.exceptions.QueueStorageError.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.queues.exceptions.QueueLeaseError
orionis.queues.exceptions.QueueLeaseError.html
Class
Exception
PUBLIC
Represent an expired or superseded job reservation.
-
orionis.queues.exceptions.QueueLeaseError.__slots__
orionis.queues.exceptions.QueueLeaseError.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.queues.exceptions.QueueDispatchError
orionis.queues.exceptions.QueueDispatchError.html
Class
Exception
PUBLIC
Represent an invalid pending dispatch operation.
-
orionis.queues.exceptions.QueueDispatchError.__slots__
orionis.queues.exceptions.QueueDispatchError.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.queues.exceptions.QueueRetryError
orionis.queues.exceptions.QueueRetryError.html
Class
Exception
PUBLIC
Represent exhausted attempts or an expired retry deadline.
-
orionis.queues.exceptions.QueueRetryError.__slots__
orionis.queues.exceptions.QueueRetryError.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.queues.functions._NAME_PATTERN
orionis.queues.functions.html#_NAME_PATTERN
Attribute
Constant
PUBLIC
Compiled pattern used to recognize name pattern.
-
orionis.queues.functions._is_finite_number
orionis.queues.functions.html#_is_finite_number
Function
Function
PUBLIC
Recognize finite primitive numbers without overflowing during conversion.
-
orionis.queues.functions.validate_name
orionis.queues.functions.html#validate_name
Function
Function
PUBLIC
Validate a logical queue or connection name.
-
orionis.queues.functions.validate_seconds
orionis.queues.functions.html#validate_seconds
Function
Function
PUBLIC
Validate a finite duration in seconds.
-
orionis.queues.functions.current_time
orionis.queues.functions.html#current_time
Function
Function
PUBLIC
Return wall-clock epoch seconds with sub-second precision.
-
orionis.queues.contracts.driver.IQueueDriver
orionis.queues.contracts.driver.IQueueDriver.html
Class
Class
PUBLIC
Declare persistence and fenced transitions for a queue connection.
-
orionis.queues.contracts.driver.IQueueDriver.__slots__
orionis.queues.contracts.driver.IQueueDriver.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.queues.contracts.driver.IQueueDriver.push
orionis.queues.contracts.driver.IQueueDriver.html#push
Function
Method
PUBLIC
Persist an envelope until its scheduled availability.
-
orionis.queues.contracts.driver.IQueueDriver.reserve
orionis.queues.contracts.driver.IQueueDriver.html#reserve
Function
Method
PUBLIC
Acquire one eligible job in queue priority order.
-
orionis.queues.contracts.driver.IQueueDriver.release
orionis.queues.contracts.driver.IQueueDriver.html#release
Function
Method
PUBLIC
Release the current claim for a later attempt.
-
orionis.queues.contracts.driver.IQueueDriver.delete
orionis.queues.contracts.driver.IQueueDriver.html#delete
Function
Method
PUBLIC
Acknowledge a job only while its claim owns the lease.
-
orionis.queues.contracts.driver.IQueueDriver.size
orionis.queues.contracts.driver.IQueueDriver.html#size
Function
Method
PUBLIC
Count ready, delayed, and reserved jobs in a logical queue.
-
orionis.queues.contracts.driver.IQueueDriver.clear
orionis.queues.contracts.driver.IQueueDriver.html#clear
Function
Method
PUBLIC
Remove all stored jobs from a logical queue.
-
orionis.queues.contracts.driver.IQueueDriver.close
orionis.queues.contracts.driver.IQueueDriver.html#close
Function
Method
PUBLIC
Close resources owned by this driver.
-
orionis.queues.entities.failed_job.FailedJob
orionis.queues.entities.failed_job.FailedJob.html
Class
Class
PUBLIC
Preserve the payload and exception associated with terminal failure.
-
orionis.queues.entities.failed_job.FailedJob.id
orionis.queues.entities.failed_job.FailedJob.html#id
Attribute
Class Variable
PUBLIC
Identifier used to correlate or locate this protocol or storage record.
-
orionis.queues.entities.failed_job.FailedJob.job_id
orionis.queues.entities.failed_job.FailedJob.html#job_id
Attribute
Class Variable
PUBLIC
Identifier of the original queued job.
-
orionis.queues.entities.failed_job.FailedJob.connection
orionis.queues.entities.failed_job.FailedJob.html#connection
Attribute
Class Variable
PUBLIC
Configured connection used to store or dispatch the operation.
-
orionis.queues.entities.failed_job.FailedJob.queue
orionis.queues.entities.failed_job.FailedJob.html#queue
Attribute
Class Variable
PUBLIC
Name of the queue receiving or storing the job.
-
orionis.queues.entities.failed_job.FailedJob.payload
orionis.queues.entities.failed_job.FailedJob.html#payload
Attribute
Class Variable
PUBLIC
Serialized data required to execute or restore the job.
-
orionis.queues.entities.failed_job.FailedJob.exception_type
orionis.queues.entities.failed_job.FailedJob.html#exception_type
Attribute
Class Variable
PUBLIC
Type name of the exception that caused the job failure.
-
orionis.queues.entities.failed_job.FailedJob.exception_message
orionis.queues.entities.failed_job.FailedJob.html#exception_message
Attribute
Class Variable
PUBLIC
Message describing the exception that caused the job failure.
-
orionis.queues.entities.failed_job.FailedJob.traceback
orionis.queues.entities.failed_job.FailedJob.html#traceback
Attribute
Class Variable
PUBLIC
Formatted traceback retained for failure diagnostics.
-
orionis.queues.entities.failed_job.FailedJob.failed_at
orionis.queues.entities.failed_job.FailedJob.html#failed_at
Attribute
Class Variable
PUBLIC
Timestamp at which the job was recorded as failed.
-
orionis.queues.entities.failed_job.FailedJob.attempts
orionis.queues.entities.failed_job.FailedJob.html#attempts
Attribute
Class Variable
PUBLIC
Number of execution attempts already made for the job.
-
orionis.queues.contracts.failed_repository.IFailedJobRepository
orionis.queues.contracts.failed_repository.IFailedJobRepository.html
Class
Class
PUBLIC
Declare durable terminal failure inspection and removal.
-
orionis.queues.contracts.failed_repository.IFailedJobRepository.__slots__
orionis.queues.contracts.failed_repository.IFailedJobRepository.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.queues.contracts.failed_repository.IFailedJobRepository.record
orionis.queues.contracts.failed_repository.IFailedJobRepository.html#record
Function
Method
PUBLIC
Persist the original payload and exception before acknowledgement.
-
orionis.queues.contracts.failed_repository.IFailedJobRepository.all
orionis.queues.contracts.failed_repository.IFailedJobRepository.html#all
Function
Method
PUBLIC
List persisted failures in creation order.
-
orionis.queues.contracts.failed_repository.IFailedJobRepository.find
orionis.queues.contracts.failed_repository.IFailedJobRepository.html#find
Function
Method
PUBLIC
Find a persisted failure by its identifier.
-
orionis.queues.contracts.failed_repository.IFailedJobRepository.forget
orionis.queues.contracts.failed_repository.IFailedJobRepository.html#forget
Function
Method
PUBLIC
Delete a persisted failure by its identifier.
-
orionis.queues.contracts.failed_repository.IFailedJobRepository.close
orionis.queues.contracts.failed_repository.IFailedJobRepository.html#close
Function
Method
PUBLIC
Close resources owned by the repository.
-
orionis.queues.contracts.job.IJob
orionis.queues.contracts.job.IJob.html
Class
Class
PUBLIC
Declare the asynchronous entry point of a persistent job.
-
orionis.queues.contracts.job.IJob.__slots__
orionis.queues.contracts.job.IJob.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.queues.contracts.job.IJob.handle
orionis.queues.contracts.job.IJob.html#handle
Function
Method
PUBLIC
Execute the job with services resolved by the application.
-
orionis.queues.types.DispatchCallback
orionis.queues.types.html#DispatchCallback
Attribute
Type Alias
PUBLIC
Type alias for Callable[[BaseJob, str | None, str | None, float],
Awaitable[str]].
-
orionis.queues.contracts.manager.IQueueManager
orionis.queues.contracts.manager.IQueueManager.html
Class
Class
PUBLIC
Declare the canonical dispatch and queue administration API.
-
orionis.queues.contracts.manager.IQueueManager.__slots__
orionis.queues.contracts.manager.IQueueManager.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.queues.contracts.manager.IQueueManager.dispatch
orionis.queues.contracts.manager.IQueueManager.html#dispatch
Function
Method
PUBLIC
Create an awaitable operation without performing I/O.
-
orionis.queues.contracts.manager.IQueueManager.connection
orionis.queues.contracts.manager.IQueueManager.html#connection
Function
Method
PUBLIC
Resolve a configured connection lazily.
-
orionis.queues.contracts.manager.IQueueManager.worker
orionis.queues.contracts.manager.IQueueManager.html#worker
Function
Method
PUBLIC
Create a worker using validated central settings.
-
orionis.queues.contracts.manager.IQueueManager.failed
orionis.queues.contracts.manager.IQueueManager.html#failed
Function
Method
PUBLIC
Resolve the durable failure repository lazily.
-
orionis.queues.contracts.manager.IQueueManager.migrate
orionis.queues.contracts.manager.IQueueManager.html#migrate
Function
Method
PUBLIC
Create missing database queue tables and central failed-job storage.
-
orionis.queues.contracts.manager.IQueueManager.retryFailed
orionis.queues.contracts.manager.IQueueManager.html#retryFailed
Function
Method
PUBLIC
Requeue a failed job with a fresh attempt budget.
-
orionis.queues.contracts.manager.IQueueManager.close
orionis.queues.contracts.manager.IQueueManager.html#close
Function
Method
PUBLIC
Close queue-owned clients without disposing shared database services.
-
orionis.console.commands.queue.clear.QueueClearCommand
orionis.console.commands.queue.clear.QueueClearCommand.html
Class
Class
PUBLIC
Clear every pending state from one logical queue.
-
orionis.console.commands.queue.clear.QueueClearCommand.__slots__
orionis.console.commands.queue.clear.QueueClearCommand.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.console.commands.queue.clear.QueueClearCommand.timestamps
orionis.console.commands.queue.clear.QueueClearCommand.html#timestamps
Attribute
Class Variable
PUBLIC
Timestamps flag used by QueueClearCommand.
-
orionis.console.commands.queue.clear.QueueClearCommand.signature
orionis.console.commands.queue.clear.QueueClearCommand.html#signature
Attribute
Class Variable
PUBLIC
queue:clear.
-
orionis.console.commands.queue.clear.QueueClearCommand.description
orionis.console.commands.queue.clear.QueueClearCommand.html#description
Attribute
Class Variable
PUBLIC
Delete ready, delayed, and reserved jobs from a
queue..
-
orionis.console.commands.queue.clear.QueueClearCommand.arguments
orionis.console.commands.queue.clear.QueueClearCommand.html#arguments
Attribute
Class Variable
PUBLIC
Command-line argument declarations accepted by this command.
-
orionis.console.commands.queue.clear.QueueClearCommand.handle
orionis.console.commands.queue.clear.QueueClearCommand.html#handle
Function
Method
PUBLIC
Remove the selected queue's jobs and report the count.
-
orionis.console.commands.queue.failed.QueueFailedCommand
orionis.console.commands.queue.failed.QueueFailedCommand.html
Class
Class
PUBLIC
List persistent failed jobs and their original exceptions.
-
orionis.console.commands.queue.failed.QueueFailedCommand.__slots__
orionis.console.commands.queue.failed.QueueFailedCommand.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.console.commands.queue.failed.QueueFailedCommand.timestamps
orionis.console.commands.queue.failed.QueueFailedCommand.html#timestamps
Attribute
Class Variable
PUBLIC
Timestamps flag used by QueueFailedCommand.
-
orionis.console.commands.queue.failed.QueueFailedCommand.signature
orionis.console.commands.queue.failed.QueueFailedCommand.html#signature
Attribute
Class Variable
PUBLIC
queue:failed.
-
orionis.console.commands.queue.failed.QueueFailedCommand.description
orionis.console.commands.queue.failed.QueueFailedCommand.html#description
Attribute
Class Variable
PUBLIC
List failed queue jobs..
-
orionis.console.commands.queue.failed.QueueFailedCommand.handle
orionis.console.commands.queue.failed.QueueFailedCommand.html#handle
Function
Method
PUBLIC
Display job identifiers, routing, attempts, and exceptions.
-
orionis.console.commands.queue.forget.QueueForgetCommand
orionis.console.commands.queue.forget.QueueForgetCommand.html
Class
Class
PUBLIC
Remove one failed job record.
-
orionis.console.commands.queue.forget.QueueForgetCommand.__slots__
orionis.console.commands.queue.forget.QueueForgetCommand.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.console.commands.queue.forget.QueueForgetCommand.timestamps
orionis.console.commands.queue.forget.QueueForgetCommand.html#timestamps
Attribute
Class Variable
PUBLIC
Timestamps flag used by QueueForgetCommand.
-
orionis.console.commands.queue.forget.QueueForgetCommand.signature
orionis.console.commands.queue.forget.QueueForgetCommand.html#signature
Attribute
Class Variable
PUBLIC
queue:forget.
-
orionis.console.commands.queue.forget.QueueForgetCommand.description
orionis.console.commands.queue.forget.QueueForgetCommand.html#description
Attribute
Class Variable
PUBLIC
Delete a failed job by its identifier..
-
orionis.console.commands.queue.forget.QueueForgetCommand.arguments
orionis.console.commands.queue.forget.QueueForgetCommand.html#arguments
Attribute
Class Variable
PUBLIC
Command-line argument declarations accepted by this command.
-
orionis.console.commands.queue.forget.QueueForgetCommand.handle
orionis.console.commands.queue.forget.QueueForgetCommand.html#handle
Function
Method
PUBLIC
Delete the selected failure record and report missing identifiers.
-
orionis.console.commands.queue.migrate.QueueMigrateCommand
orionis.console.commands.queue.migrate.QueueMigrateCommand.html
Class
Class
PUBLIC
Create all configured queue tables without removing existing data.
-
orionis.console.commands.queue.migrate.QueueMigrateCommand.__slots__
orionis.console.commands.queue.migrate.QueueMigrateCommand.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.console.commands.queue.migrate.QueueMigrateCommand.timestamps
orionis.console.commands.queue.migrate.QueueMigrateCommand.html#timestamps
Attribute
Class Variable
PUBLIC
Timestamps flag used by QueueMigrateCommand.
-
orionis.console.commands.queue.migrate.QueueMigrateCommand.signature
orionis.console.commands.queue.migrate.QueueMigrateCommand.html#signature
Attribute
Class Variable
PUBLIC
queue:migrate.
-
orionis.console.commands.queue.migrate.QueueMigrateCommand.description
orionis.console.commands.queue.migrate.QueueMigrateCommand.html#description
Attribute
Class Variable
PUBLIC
Create database queue tables and failed-job
storage..
-
orionis.console.commands.queue.migrate.QueueMigrateCommand.handle
orionis.console.commands.queue.migrate.QueueMigrateCommand.html#handle
Function
Method
PUBLIC
Prepare every database queue connection and central failure storage.
-
orionis.console.commands.queue.retry.QueueRetryCommand
orionis.console.commands.queue.retry.QueueRetryCommand.html
Class
Class
PUBLIC
Redispatch one failed job through its original connection.
-
orionis.console.commands.queue.retry.QueueRetryCommand.__slots__
orionis.console.commands.queue.retry.QueueRetryCommand.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.console.commands.queue.retry.QueueRetryCommand.timestamps
orionis.console.commands.queue.retry.QueueRetryCommand.html#timestamps
Attribute
Class Variable
PUBLIC
Timestamps flag used by QueueRetryCommand.
-
orionis.console.commands.queue.retry.QueueRetryCommand.signature
orionis.console.commands.queue.retry.QueueRetryCommand.html#signature
Attribute
Class Variable
PUBLIC
queue:retry.
-
orionis.console.commands.queue.retry.QueueRetryCommand.description
orionis.console.commands.queue.retry.QueueRetryCommand.html#description
Attribute
Class Variable
PUBLIC
Retry a failed job by its identifier..
-
orionis.console.commands.queue.retry.QueueRetryCommand.arguments
orionis.console.commands.queue.retry.QueueRetryCommand.html#arguments
Attribute
Class Variable
PUBLIC
Command-line argument declarations accepted by this command.
-
orionis.console.commands.queue.retry.QueueRetryCommand.handle
orionis.console.commands.queue.retry.QueueRetryCommand.html#handle
Function
Method
PUBLIC
Restore one failed payload with its preserved job identifier.
-
orionis.console.commands.queue.work.QueueWorkCommand
orionis.console.commands.queue.work.QueueWorkCommand.html
Class
Class
PUBLIC
Run an asynchronous worker over prioritized logical queues.
-
orionis.console.commands.queue.work.QueueWorkCommand.__slots__
orionis.console.commands.queue.work.QueueWorkCommand.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.console.commands.queue.work.QueueWorkCommand.timestamps
orionis.console.commands.queue.work.QueueWorkCommand.html#timestamps
Attribute
Class Variable
PUBLIC
Timestamps flag used by QueueWorkCommand.
-
orionis.console.commands.queue.work.QueueWorkCommand.signature
orionis.console.commands.queue.work.QueueWorkCommand.html#signature
Attribute
Class Variable
PUBLIC
queue:work.
-
orionis.console.commands.queue.work.QueueWorkCommand.description
orionis.console.commands.queue.work.QueueWorkCommand.html#description
Attribute
Class Variable
PUBLIC
Consume queued jobs with retries and graceful
shutdown..
-
orionis.console.commands.queue.work.QueueWorkCommand.arguments
orionis.console.commands.queue.work.QueueWorkCommand.html#arguments
Attribute
Class Variable
PUBLIC
Command-line argument declarations accepted by this command.
-
orionis.console.commands.queue.work.QueueWorkCommand.handle
orionis.console.commands.queue.work.QueueWorkCommand.html#handle
Function
Method
PUBLIC
Consume jobs until shutdown or a requested stopping condition.
-
orionis.http.routes.enums.route_types.RouteType
orionis.http.routes.enums.route_types.RouteType.html
Class
Class
PUBLIC
Define enumeration of route types for the framework.
-
orionis.http.routes.enums.route_types.RouteType.CONTROLLER
orionis.http.routes.enums.route_types.RouteType.html#CONTROLLER
Attribute
Constant
PUBLIC
controller.
-
orionis.http.routes.enums.route_types.RouteType.FUNCTION
orionis.http.routes.enums.route_types.RouteType.html#FUNCTION
Attribute
Constant
PUBLIC
function.
-
orionis.http.routes.enums.route_types.RouteType.INVOKABLE
orionis.http.routes.enums.route_types.RouteType.html#INVOKABLE
Attribute
Constant
PUBLIC
invokable.
-
orionis.http.routes.enums.route_types.RouteType.VIEW
orionis.http.routes.enums.route_types.RouteType.html#VIEW
Attribute
Constant
PUBLIC
view.
-
orionis.http.routes.enums.route_types.RouteType.HUB
orionis.http.routes.enums.route_types.RouteType.html#HUB
Attribute
Constant
PUBLIC
hub.
-
orionis.http.routes.entities.compiled_route.CompiledRoute
orionis.http.routes.entities.compiled_route.CompiledRoute.html
Class
Class
PUBLIC
Represent a runtime-ready compiled HTTP or WebSocket route.
-
orionis.http.routes.entities.compiled_route.CompiledRoute.path
orionis.http.routes.entities.compiled_route.CompiledRoute.html#path
Attribute
Instance Variable
PUBLIC
The original route path, e.g. '/users/{id:int}'.
-
orionis.http.routes.entities.compiled_route.CompiledRoute.method
orionis.http.routes.entities.compiled_route.CompiledRoute.html#method
Attribute
Instance Variable
PUBLIC
HTTP method in uppercase, or the reserved 'WEBSOCKET' table key.
-
orionis.http.routes.entities.compiled_route.CompiledRoute.type
orionis.http.routes.entities.compiled_route.CompiledRoute.html#type
Attribute
Instance Variable
PUBLIC
How the handler will be resolved at dispatch time.
-
orionis.http.routes.entities.compiled_route.CompiledRoute.protocol
orionis.http.routes.entities.compiled_route.CompiledRoute.html#protocol
Attribute
Instance Variable
PUBLIC
Transport used for this route, independently of the action type.
-
orionis.http.routes.entities.compiled_route.CompiledRoute.hub_protocol
orionis.http.routes.entities.compiled_route.CompiledRoute.html#hub_protocol
Attribute
Instance Variable
PUBLIC
Realtime codec name for Hub actions; None for ordinary routes.
-
orionis.http.routes.entities.compiled_route.CompiledRoute.action
orionis.http.routes.entities.compiled_route.CompiledRoute.html#action
Attribute
Instance Variable
PUBLIC
Resolved handler descriptor containing module and either function (for functions) or class + method (for controllers and invokable classes).
-
orionis.http.routes.entities.compiled_route.CompiledRoute.name
orionis.http.routes.entities.compiled_route.CompiledRoute.html#name
Attribute
Instance Variable
PUBLIC
Optional route name used for URL generation.
-
orionis.http.routes.entities.compiled_route.CompiledRoute.regex
orionis.http.routes.entities.compiled_route.CompiledRoute.html#regex
Attribute
Instance Variable
PUBLIC
Compiled regex for dynamic routes; None for static routes.
-
orionis.http.routes.entities.compiled_route.CompiledRoute.segment_count
orionis.http.routes.entities.compiled_route.CompiledRoute.html#segment_count
Attribute
Instance Variable
PUBLIC
Number of non-empty path segments, e.g. 2 for '/users/{id}'. Used to narrow dynamic route matching to candidates of the same depth.
-
orionis.http.routes.entities.compiled_route.CompiledRoute.priority_score
orionis.http.routes.entities.compiled_route.CompiledRoute.html#priority_score
Attribute
Instance Variable
PUBLIC
Specificity score used to order dynamic routes during dispatch. Higher scores are matched first. Computed as static_segments * 10 - dynamic_segments.
-
orionis.http.routes.entities.compiled_route.CompiledRoute.kind
orionis.http.routes.entities.compiled_route.CompiledRoute.html#kind
Attribute
Instance Variable
PUBLIC
Route group kind; either 'web' or 'api'. Set by the loader when importing route files.
-
orionis.http.routes.entities.compiled_route.CompiledRoute.public
orionis.http.routes.entities.compiled_route.CompiledRoute.html#public
Attribute
Instance Variable
PUBLIC
Whether automatic session, CSRF, and identity context are omitted.
-
orionis.http.routes.entities.compiled_route.CompiledRoute.converters
orionis.http.routes.entities.compiled_route.CompiledRoute.html#converters
Attribute
Instance Variable
PUBLIC
Maps each path parameter name to its converter function. Empty for static routes.
-
orionis.http.routes.entities.compiled_route.CompiledRoute.middleware
orionis.http.routes.entities.compiled_route.CompiledRoute.html#middleware
Attribute
Instance Variable
PUBLIC
Middleware classes attached to this route.
-
orionis.http.routes.entities.compiled_route.CompiledRoute.without_middleware
orionis.http.routes.entities.compiled_route.CompiledRoute.html#without_middleware
Attribute
Instance Variable
PUBLIC
Middleware classes explicitly excluded from this route.
-
orionis.http.routes.entities.compiled_route.CompiledRoute.compiled_middlewares
orionis.http.routes.entities.compiled_route.CompiledRoute.html#compiled_middlewares
Attribute
Instance Variable
PUBLIC
Tuple of resolved middleware classes for efficient dispatch.
-
orionis.http.routes.contracts.loader.IRouteLoader
orionis.http.routes.contracts.loader.IRouteLoader.html
Class
Class
PUBLIC
Define the contract for route loader implementations.
-
orionis.http.routes.contracts.loader.IRouteLoader.load
orionis.http.routes.contracts.loader.IRouteLoader.html#load
Function
Method
PUBLIC
Return all compiled routes, loading them first if necessary.
-
orionis.http.routes.contracts.loader.IRouteLoader.fallback
orionis.http.routes.contracts.loader.IRouteLoader.html#fallback
Attribute
Property
PUBLIC
Return the registered fallback handler, if any.
-
orionis.http.routes.group.RouteGroup
orionis.http.routes.group.RouteGroup.html
Class
Class
PUBLIC
Hold already registered routes so a parent can compose their context.
-
orionis.http.routes.group.RouteGroup.routes
orionis.http.routes.group.RouteGroup.html#routes
Attribute
Class Variable
PUBLIC
Route definitions registered in this routing context.
-
orionis.http.routes.contracts.router.IRouter
orionis.http.routes.contracts.router.IRouter.html
Class
Class
PUBLIC
Define the contract for router implementations.
-
orionis.http.routes.contracts.router.IRouter.__slots__
orionis.http.routes.contracts.router.IRouter.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.http.routes.contracts.router.IRouter.hub
orionis.http.routes.contracts.router.IRouter.html#hub
Function
Method
PUBLIC
Register a Hub connection endpoint with a fixed wire codec.
-
orionis.http.routes.contracts.router.IRouter.websocket
orionis.http.routes.contracts.router.IRouter.html#websocket
Function
Method
PUBLIC
Register a WebSocket connection handler independently of HTTP routes.
-
orionis.http.routes.contracts.router.IRouter.auth
orionis.http.routes.contracts.router.IRouter.html#auth
Function
Method
PUBLIC
Register the built-in web authentication routes.
-
orionis.http.routes.contracts.router.IRouter.view
orionis.http.routes.contracts.router.IRouter.html#view
Function
Method
PUBLIC
Register a GET route that renders a template with no controller.
-
orionis.http.routes.contracts.router.IRouter.post
orionis.http.routes.contracts.router.IRouter.html#post
Function
Method
PUBLIC
Register a POST route.
-
orionis.http.routes.contracts.router.IRouter.query
orionis.http.routes.contracts.router.IRouter.html#query
Function
Method
PUBLIC
Register a QUERY route.
-
orionis.http.routes.contracts.router.IRouter.get
orionis.http.routes.contracts.router.IRouter.html#get
Function
Method
PUBLIC
Register a GET route.
-
orionis.http.routes.contracts.router.IRouter.put
orionis.http.routes.contracts.router.IRouter.html#put
Function
Method
PUBLIC
Register a PUT route.
-
orionis.http.routes.contracts.router.IRouter.delete
orionis.http.routes.contracts.router.IRouter.html#delete
Function
Method
PUBLIC
Register a DELETE route.
-
orionis.http.routes.contracts.router.IRouter.patch
orionis.http.routes.contracts.router.IRouter.html#patch
Function
Method
PUBLIC
Register a PATCH route.
-
orionis.http.routes.contracts.router.IRouter.fallback
orionis.http.routes.contracts.router.IRouter.html#fallback
Function
Method
PUBLIC
Register the fallback handler for unmatched routes (HTTP 404).
-
orionis.http.routes.contracts.router.IRouter.group
orionis.http.routes.contracts.router.IRouter.html#group
Function
Method
PUBLIC
Register a group of routes with a shared prefix and middleware.
-
orionis.http.routes.contracts.router.IRouter.export
orionis.http.routes.contracts.router.IRouter.html#export
Function
Method
PUBLIC
Export all registered routes and the fallback handler.
-
orionis.http.routes.contracts.route_cache.IRouteCache
orionis.http.routes.contracts.route_cache.IRouteCache.html
Class
Class
PUBLIC
Define the contract for route cache implementations.
-
orionis.http.routes.contracts.route_cache.IRouteCache.toCache
orionis.http.routes.contracts.route_cache.IRouteCache.html#toCache
Function
Method
PUBLIC
Serialise compiled routes and the fallback handler to a cache dict.
-
orionis.http.routes.contracts.route_cache.IRouteCache.fromCache
orionis.http.routes.contracts.route_cache.IRouteCache.html#fromCache
Function
Method
PUBLIC
Rebuild compiled routes and the fallback handler from a cache dict.
-
orionis.http.routes.contracts.route_compiler.IRouteCompiler
orionis.http.routes.contracts.route_compiler.IRouteCompiler.html
Class
Class
PUBLIC
Define the contract for route compiler implementations.
-
orionis.http.routes.contracts.route_compiler.IRouteCompiler.compile
orionis.http.routes.contracts.route_compiler.IRouteCompiler.html#compile
Function
Method
PUBLIC
Compile a list of raw route dicts into a ready-to-dispatch structure.
-
orionis.http.routes.contracts.route_compiler.IRouteCompiler.compilePath
orionis.http.routes.contracts.route_compiler.IRouteCompiler.html#compilePath
Function
Static Method
PUBLIC
Determine whether a path is static or dynamic and compile its regex.
-
orionis.http.routes.params_types.PARAM_TYPES
orionis.http.routes.params_types.html#PARAM_TYPES
Attribute
Constant
PUBLIC
Param types definitions used by params_types.
-
orionis.http.routes.route_compiler._PARAM_RE
orionis.http.routes.route_compiler.html#_PARAM_RE
Attribute
Constant
PUBLIC
Match path parameter placeholders, including optional converter names.
-
orionis.http.routes.route_compiler._NAMED_GROUP_RE
orionis.http.routes.route_compiler.html#_NAMED_GROUP_RE
Attribute
Constant
PUBLIC
Precompiled pattern to normalise named capture groups for collision detection.
-
orionis.http.routes.route_compiler._validate_literal
orionis.http.routes.route_compiler.html#_validate_literal
Function
Function
PUBLIC
Reject unmatched braces and malformed parameter declarations.
-
orionis.http.routes.route_compiler._action_name
orionis.http.routes.route_compiler.html#_action_name
Function
Function
PUBLIC
Return an importable handler name for boot-time dispatch and caching.
-
orionis.http.routes.route_compiler._register_name
orionis.http.routes.route_compiler.html#_register_name
Function
Function
PUBLIC
Require one unambiguous URL template per route name.
-
orionis.http.routes.route_compiler.RouteCompiler
orionis.http.routes.route_compiler.RouteCompiler.html
Class
Class
PUBLIC
Compile declared routes into runtime dispatch metadata.
-
orionis.http.routes.route_compiler.RouteCompiler.compile
orionis.http.routes.route_compiler.RouteCompiler.html#compile
Function
Method
PUBLIC
Compile a list of raw route dicts into a ready-to-dispatch structure.
-
orionis.http.routes.route_compiler.RouteCompiler.compilePath
orionis.http.routes.route_compiler.RouteCompiler.html#compilePath
Function
Static Method
PUBLIC
Determine whether a path is static or dynamic and compile its regex.
-
orionis.http.routes.route_compiler.RouteCompiler.__compileRoute
orionis.http.routes.route_compiler.RouteCompiler.html#__compileRoute
Function
Method
PUBLIC
Compile a single raw route dict into a CompiledRoute.
-
orionis.http.routes.route_compiler.RouteCompiler.__buildAction
orionis.http.routes.route_compiler.RouteCompiler.html#__buildAction
Function
Static Method
PUBLIC
Resolve the handler type and build the action descriptor for a route.
-
orionis.http.routes.route_compiler.RouteCompiler.__buildPathRegex
orionis.http.routes.route_compiler.RouteCompiler.html#__buildPathRegex
Function
Static Method
PUBLIC
Compile a route path with placeholders into a regex and converters.
-
orionis.http.routes.route_compiler.RouteCompiler.__routeSignature
orionis.http.routes.route_compiler.RouteCompiler.html#__routeSignature
Function
Static Method
PUBLIC
Build a collision-detection key for a dynamic route.
-
orionis.http.routes.route_compiler.RouteCompiler.__routeMetrics
orionis.http.routes.route_compiler.RouteCompiler.html#__routeMetrics
Function
Static Method
PUBLIC
Compute the segment count and specificity score for a route path.
-
orionis.http.routes.route_cache.RouteCache
orionis.http.routes.route_cache.RouteCache.html
Class
Class
PUBLIC
Read and write compiled routing metadata for application startup.
-
orionis.http.routes.route_cache.RouteCache.VERSION
orionis.http.routes.route_cache.RouteCache.html#VERSION
Attribute
Constant
PUBLIC
Version value used by RouteCache.
-
orionis.http.routes.route_cache.RouteCache.toCache
orionis.http.routes.route_cache.RouteCache.html#toCache
Function
Method
PUBLIC
Serialise compiled routes and the fallback handler to a cache dict.
-
orionis.http.routes.route_cache.RouteCache.fromCache
orionis.http.routes.route_cache.RouteCache.html#fromCache
Function
Method
PUBLIC
Rebuild compiled routes and the fallback handler from a cache dict.
-
orionis.http.routes.route_cache.RouteCache.__serializeCompiledRoute
orionis.http.routes.route_cache.RouteCache.html#__serializeCompiledRoute
Function
Static Method
PUBLIC
Convert a CompiledRoute to a JSON-safe dict.
-
orionis.http.routes.route_cache.RouteCache.__deserializeCompiledRoute
orionis.http.routes.route_cache.RouteCache.html#__deserializeCompiledRoute
Function
Static Method
PUBLIC
Rebuild a CompiledRoute from a cache dict.
-
orionis.http.routes.route_cache.RouteCache.__serializeFallback
orionis.http.routes.route_cache.RouteCache.html#__serializeFallback
Function
Static Method
PUBLIC
Serialise the fallback tuple to a JSON-safe descriptor dict.
-
orionis.http.routes.route_cache.RouteCache.__deserializeFallback
orionis.http.routes.route_cache.RouteCache.html#__deserializeFallback
Function
Static Method
PUBLIC
Rebuild the fallback tuple from a cache descriptor dict.
-
orionis.http.routes.route_cache.RouteCache.__resolveClass
orionis.http.routes.route_cache.RouteCache.html#__resolveClass
Function
Static Method
PUBLIC
Import and return a class given its fully-qualified dotted path.
-
orionis.http.routes.route_cache.RouteCache.__resolveQualname
orionis.http.routes.route_cache.RouteCache.html#__resolveQualname
Function
Static Method
PUBLIC
Resolve a module-level qualname into its target object.
-
orionis.http.routes.loader.RouteLoader
orionis.http.routes.loader.RouteLoader.html
Class
Class
PUBLIC
Load route declarations from configured application modules.
-
orionis.http.routes.loader.RouteLoader._KINDS
orionis.http.routes.loader.RouteLoader.html#_KINDS
Attribute
Constant
PUBLIC
Keep a deterministic import order so route registration is stable.
-
orionis.http.routes.loader.RouteLoader.__init__
orionis.http.routes.loader.RouteLoader.html#__init__
Function
Method
PUBLIC
Initialise the RouteLoader with its required collaborators.
-
orionis.http.routes.loader.RouteLoader.__router
orionis.http.routes.loader.RouteLoader.html#__router
Attribute
Instance Variable
PUBLIC
Router that holds the raw registered routes.
-
orionis.http.routes.loader.RouteLoader.__app
orionis.http.routes.loader.RouteLoader.html#__app
Attribute
Instance Variable
PUBLIC
Application instance used to resolve paths and settings.
-
orionis.http.routes.loader.RouteLoader.__app_middleware
orionis.http.routes.loader.RouteLoader.html#__app_middleware
Attribute
Instance Variable
PUBLIC
App middleware produced by app.getMiddleware.
-
orionis.http.routes.loader.RouteLoader.__routes
orionis.http.routes.loader.RouteLoader.html#__routes
Attribute
Instance Variable
PUBLIC
Route definitions registered in this routing context.
-
orionis.http.routes.loader.RouteLoader.__loaded
orionis.http.routes.loader.RouteLoader.html#__loaded
Attribute
Instance Variable
PUBLIC
Loaded flag used by RouteLoader.
-
orionis.http.routes.loader.RouteLoader.__fallback
orionis.http.routes.loader.RouteLoader.html#__fallback
Attribute
Instance Variable
PUBLIC
Handler or route selected when no ordinary route matches.
-
orionis.http.routes.loader.RouteLoader.__use_cache
orionis.http.routes.loader.RouteLoader.html#__use_cache
Attribute
Instance Variable
PUBLIC
Use cache flag used by RouteLoader.
-
orionis.http.routes.loader.RouteLoader.__persistence
orionis.http.routes.loader.RouteLoader.html#__persistence
Attribute
Instance Variable
PUBLIC
Persistence produced by self.__getCachePersistence.
-
orionis.http.routes.loader.RouteLoader.__compiler
orionis.http.routes.loader.RouteLoader.html#__compiler
Attribute
Instance Variable
PUBLIC
Compiler that converts raw routes to CompiledRoute objects.
-
orionis.http.routes.loader.RouteLoader.__cache
orionis.http.routes.loader.RouteLoader.html#__cache
Attribute
Instance Variable
PUBLIC
Serialiser/deserialiser for the compiled route cache.
-
orionis.http.routes.loader.RouteLoader.load
orionis.http.routes.loader.RouteLoader.html#load
Function
Method
PUBLIC
Return all compiled routes, loading them first if necessary.
-
orionis.http.routes.loader.RouteLoader.fallback
orionis.http.routes.loader.RouteLoader.html#fallback
Attribute
Property
PUBLIC
Return the registered fallback handler, if any.
-
orionis.http.routes.loader.RouteLoader.__getCachePersistence
orionis.http.routes.loader.RouteLoader.html#__getCachePersistence
Function
Method
PUBLIC
Build the cache persistence handle for compiled routes.
-
orionis.http.routes.loader.RouteLoader.__importFluentRoutes
orionis.http.routes.loader.RouteLoader.html#__importFluentRoutes
Function
Method
PUBLIC
Import a route file by kind so its fluent registrations run.
-
orionis.http.routes.loader.RouteLoader.__loadRoutes
orionis.http.routes.loader.RouteLoader.html#__loadRoutes
Function
Method
PUBLIC
Load compiled routes, using the persistent cache when available.
-
orionis.console.commands.route.list.RouteListCommand
orionis.console.commands.route.list.RouteListCommand.html
Class
Class
PUBLIC
Display registered HTTP routes in URI order.
-
orionis.console.commands.route.list.RouteListCommand.timestamps
orionis.console.commands.route.list.RouteListCommand.html#timestamps
Attribute
Class Variable
PUBLIC
Timestamps flag used by RouteListCommand.
-
orionis.console.commands.route.list.RouteListCommand.signature
orionis.console.commands.route.list.RouteListCommand.html#signature
Attribute
Class Variable
PUBLIC
route:list.
-
orionis.console.commands.route.list.RouteListCommand.description
orionis.console.commands.route.list.RouteListCommand.html#description
Attribute
Class Variable
PUBLIC
List the application's registered HTTP routes..
-
orionis.console.commands.route.list.RouteListCommand.__getAction
orionis.console.commands.route.list.RouteListCommand.html#__getAction
Function
Method
PUBLIC
Format the route handler as an importable Python name.
-
orionis.console.commands.route.list.RouteListCommand.__getMiddleware
orionis.console.commands.route.list.RouteListCommand.html#__getMiddleware
Function
Method
PUBLIC
Format the middleware stack attached to a route.
-
orionis.console.commands.route.list.RouteListCommand.__collectRoutes
orionis.console.commands.route.list.RouteListCommand.html#__collectRoutes
Function
Method
PUBLIC
Flatten compiled method buckets and sort routes by their URI.
-
orionis.console.commands.route.list.RouteListCommand.handle
orionis.console.commands.route.list.RouteListCommand.html#handle
Function
Method
PUBLIC
Print all application routes as a sorted Rich table.
-
orionis.console.commands.schedule.list.ScheduleListCommand
orionis.console.commands.schedule.list.ScheduleListCommand.html
Class
Class
PUBLIC
Display the application's registered scheduled tasks.
-
orionis.console.commands.schedule.list.ScheduleListCommand.timestamps
orionis.console.commands.schedule.list.ScheduleListCommand.html#timestamps
Attribute
Class Variable
PUBLIC
Indicates whether timestamps will be shown in the command output.
-
orionis.console.commands.schedule.list.ScheduleListCommand.signature
orionis.console.commands.schedule.list.ScheduleListCommand.html#signature
Attribute
Class Variable
PUBLIC
Command signature and description.
-
orionis.console.commands.schedule.list.ScheduleListCommand.description
orionis.console.commands.schedule.list.ScheduleListCommand.html#description
Attribute
Class Variable
PUBLIC
Command description.
-
orionis.console.commands.schedule.list.ScheduleListCommand.__formatValue
orionis.console.commands.schedule.list.ScheduleListCommand.html#__formatValue
Function
Method
PUBLIC
Format one schedule value for display in the task table.
-
orionis.console.commands.schedule.list.ScheduleListCommand.handle
orionis.console.commands.schedule.list.ScheduleListCommand.html#handle
Function
Method
PUBLIC
Display a formatted table of scheduled jobs.
-
orionis.foundation.config.scheduler.entities.scheduler._DRIVER_NAMES
orionis.foundation.config.scheduler.entities.scheduler.html#_DRIVER_NAMES
Attribute
Constant
PUBLIC
Define the supported scheduler driver names.
-
orionis.console.contracts.store.IScheduleStore
orionis.console.contracts.store.IScheduleStore.html
Class
Class
PUBLIC
Define the contract for schedule store implementations.
-
orionis.console.contracts.store.IScheduleStore.store
orionis.console.contracts.store.IScheduleStore.html#store
Attribute
Property
PUBLIC
Get the configured job store type.
-
orionis.console.contracts.store.IScheduleStore.config
orionis.console.contracts.store.IScheduleStore.html#config
Attribute
Property
PUBLIC
Get the full scheduler configuration entity.
-
orionis.console.contracts.store.IScheduleStore.redis
orionis.console.contracts.store.IScheduleStore.html#redis
Function
Method
PUBLIC
Create a Redis job store for the scheduler.
-
orionis.console.contracts.store.IScheduleStore.database
orionis.console.contracts.store.IScheduleStore.html#database
Function
Method
PUBLIC
Create a database job store for the scheduler.
-
orionis.console.contracts.store.IScheduleStore.migrate
orionis.console.contracts.store.IScheduleStore.html#migrate
Function
Method
PUBLIC
Create the configured database job table without starting the scheduler.
-
orionis.console.commands.schedule.migrate.ScheduleMigrateCommand
orionis.console.commands.schedule.migrate.ScheduleMigrateCommand.html
Class
Class
PUBLIC
Create the native scheduler task table without starting scheduled tasks.
-
orionis.console.commands.schedule.migrate.ScheduleMigrateCommand.__slots__
orionis.console.commands.schedule.migrate.ScheduleMigrateCommand.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.console.commands.schedule.migrate.ScheduleMigrateCommand.timestamps
orionis.console.commands.schedule.migrate.ScheduleMigrateCommand.html#timestamps
Attribute
Class Variable
PUBLIC
Timestamps flag used by ScheduleMigrateCommand.
-
orionis.console.commands.schedule.migrate.ScheduleMigrateCommand.signature
orionis.console.commands.schedule.migrate.ScheduleMigrateCommand.html#signature
Attribute
Class Variable
PUBLIC
schedule:migrate.
-
orionis.console.commands.schedule.migrate.ScheduleMigrateCommand.description
orionis.console.commands.schedule.migrate.ScheduleMigrateCommand.html#description
Attribute
Class Variable
PUBLIC
Create the configured database scheduler task
table..
-
orionis.console.commands.schedule.migrate.ScheduleMigrateCommand.handle
orionis.console.commands.schedule.migrate.ScheduleMigrateCommand.html#handle
Function
Method
PUBLIC
Create the native job store schema using the scheduler configuration.
-
orionis.console.commands.schedule.work._LISTENER_MAP
orionis.console.commands.schedule.work.html#_LISTENER_MAP
Attribute
Constant
PUBLIC
Ordered pairs of scheduler method names and their corresponding events, used to register optional event listeners defined on the Scheduler class.
-
orionis.console.commands.schedule.work.ScheduleWorkCommand
orionis.console.commands.schedule.work.ScheduleWorkCommand.html
Class
Class
PUBLIC
Register and run the application's scheduled tasks.
-
orionis.console.commands.schedule.work.ScheduleWorkCommand.timestamps
orionis.console.commands.schedule.work.ScheduleWorkCommand.html#timestamps
Attribute
Class Variable
PUBLIC
Indicates whether timestamps will be shown in the command output.
-
orionis.console.commands.schedule.work.ScheduleWorkCommand.signature
orionis.console.commands.schedule.work.ScheduleWorkCommand.html#signature
Attribute
Class Variable
PUBLIC
Command signature and description.
-
orionis.console.commands.schedule.work.ScheduleWorkCommand.description
orionis.console.commands.schedule.work.ScheduleWorkCommand.html#description
Attribute
Class Variable
PUBLIC
Command description.
-
orionis.console.commands.schedule.work.ScheduleWorkCommand.__startPanel
orionis.console.commands.schedule.work.ScheduleWorkCommand.html#__startPanel
Function
Method
PUBLIC
Display a formatted scheduler start message on the console.
-
orionis.console.commands.schedule.work.ScheduleWorkCommand.__shutdownSchedule
orionis.console.commands.schedule.work.ScheduleWorkCommand.html#__shutdownSchedule
Function
Method
PUBLIC
Request graceful shutdown and wait until it completes.
-
orionis.console.commands.schedule.work.ScheduleWorkCommand.__registerListeners
orionis.console.commands.schedule.work.ScheduleWorkCommand.html#__registerListeners
Function
Method
PUBLIC
Register the application's available scheduler event callbacks.
-
orionis.console.commands.schedule.work.ScheduleWorkCommand.handle
orionis.console.commands.schedule.work.ScheduleWorkCommand.html#handle
Function
Method
PUBLIC
Run the application's scheduled tasks worker.
-
orionis.console.commands.serve.serve._EXTRA_ALLOWED
orionis.console.commands.serve.serve.html#_EXTRA_ALLOWED
Attribute
Constant
PUBLIC
Characters additionally allowed in the sanitized process name, besides alphanumeric.
-
orionis.console.commands.serve.serve._CPU_COUNT
orionis.console.commands.serve.serve.html#_CPU_COUNT
Attribute
Constant
PUBLIC
Number of logical CPUs available; resolved once at import time.
-
orionis.console.commands.serve.serve.ServerCommand
orionis.console.commands.serve.serve.ServerCommand.html
Class
Class
PUBLIC
Start the application server using the selected runtime options.
-
orionis.console.commands.serve.serve.ServerCommand.timestamps
orionis.console.commands.serve.serve.ServerCommand.html#timestamps
Attribute
Class Variable
PUBLIC
Timestamps flag used by ServerCommand.
-
orionis.console.commands.serve.serve.ServerCommand.signature
orionis.console.commands.serve.serve.ServerCommand.html#signature
Attribute
Class Variable
PUBLIC
Command signature and description.
-
orionis.console.commands.serve.serve.ServerCommand.description
orionis.console.commands.serve.serve.ServerCommand.html#description
Attribute
Class Variable
PUBLIC
Initializes the Orionis server with Granian (The Rust
HTTP server for Python)..
-
orionis.console.commands.serve.serve.ServerCommand.arguments
orionis.console.commands.serve.serve.ServerCommand.html#arguments
Attribute
Class Variable
PUBLIC
Command-line argument declarations accepted by this command.
-
orionis.console.commands.serve.serve.ServerCommand.__init__
orionis.console.commands.serve.serve.ServerCommand.html#__init__
Function
Method
PUBLIC
Initialize command arguments and server launch state.
-
orionis.console.commands.serve.serve.ServerCommand.__lock
orionis.console.commands.serve.serve.ServerCommand.html#__lock
Attribute
Instance Variable
PUBLIC
Lock protecting concurrent access to shared state.
-
orionis.console.commands.serve.serve.ServerCommand.__env
orionis.console.commands.serve.serve.ServerCommand.html#__env
Attribute
Instance Variable
PUBLIC
Environment overrides passed to the application server process.
-
orionis.console.commands.serve.serve.ServerCommand.__cmd
orionis.console.commands.serve.serve.ServerCommand.html#__cmd
Attribute
Instance Variable
PUBLIC
Argument vector used to launch the application server.
-
orionis.console.commands.serve.serve.ServerCommand.__call_in_shutdown
orionis.console.commands.serve.serve.ServerCommand.html#__call_in_shutdown
Attribute
Instance Variable
PUBLIC
Callbacks invoked when the server shuts down.
-
orionis.console.commands.serve.serve.ServerCommand.__initNewEnvironment
orionis.console.commands.serve.serve.ServerCommand.html#__initNewEnvironment
Function
Method
PUBLIC
Build a fresh environment dictionary with Orionis metadata.
-
orionis.console.commands.serve.serve.ServerCommand.__configureBytecodeWriting
orionis.console.commands.serve.serve.ServerCommand.html#__configureBytecodeWriting
Function
Method
PUBLIC
Disable bytecode writes in this interpreter and all server processes.
-
orionis.console.commands.serve.serve.ServerCommand.__appendHostAndPortToCommand
orionis.console.commands.serve.serve.ServerCommand.html#__appendHostAndPortToCommand
Function
Method
PUBLIC
Resolve and append host and port arguments to the command.
-
orionis.console.commands.serve.serve.ServerCommand.__appendInterfaceToCommand
orionis.console.commands.serve.serve.ServerCommand.html#__appendInterfaceToCommand
Function
Method
PUBLIC
Append the selected interface type to the command.
-
orionis.console.commands.serve.serve.ServerCommand.__appendWorkersToCommand
orionis.console.commands.serve.serve.ServerCommand.html#__appendWorkersToCommand
Function
Method
PUBLIC
Append the worker-process count to the command.
-
orionis.console.commands.serve.serve.ServerCommand.__appendLoopToCommand
orionis.console.commands.serve.serve.ServerCommand.html#__appendLoopToCommand
Function
Method
PUBLIC
Append the event-loop backend to the command.
-
orionis.console.commands.serve.serve.ServerCommand.__appendLoggingConfigurationToCommand
orionis.console.commands.serve.serve.ServerCommand.html#__appendLoggingConfigurationToCommand
Function
Method
PUBLIC
Append the logging-level flags to the command.
-
orionis.console.commands.serve.serve.ServerCommand.__appendReloadOptionsToCommand
orionis.console.commands.serve.serve.ServerCommand.html#__appendReloadOptionsToCommand
Function
Method
PUBLIC
Append hot-reload flags and watched directories to the command.
-
orionis.console.commands.serve.serve.ServerCommand.__appendStaticMountAndRouteToCommand
orionis.console.commands.serve.serve.ServerCommand.html#__appendStaticMountAndRouteToCommand
Function
Method
PUBLIC
Append the static-file mount path and URL route to the command.
-
orionis.console.commands.serve.serve.ServerCommand.__appendProcessNameToCommand
orionis.console.commands.serve.serve.ServerCommand.html#__appendProcessNameToCommand
Function
Method
PUBLIC
Append the process name to the command.
-
orionis.console.commands.serve.serve.ServerCommand.__unixServe
orionis.console.commands.serve.serve.ServerCommand.html#__unixServe
Function
Method
PUBLIC
Replace the current process with the Granian server via execvpe.
-
orionis.console.commands.serve.serve.ServerCommand.__isDebugMode
orionis.console.commands.serve.serve.ServerCommand.html#__isDebugMode
Function
Static Method
PUBLIC
Detect whether a Python debugger is currently attached.
-
orionis.console.commands.serve.serve.ServerCommand.__embeddedServe
orionis.console.commands.serve.serve.ServerCommand.html#__embeddedServe
Function
Method
PUBLIC
Start the server in-process using Granian's embedded backend.
-
orionis.console.commands.serve.serve.ServerCommand.__windowsServe
orionis.console.commands.serve.serve.ServerCommand.html#__windowsServe
Function
Method
PUBLIC
Launch Granian as a managed subprocess on Windows.
-
orionis.console.commands.serve.serve.ServerCommand.__setShutdownHandler
orionis.console.commands.serve.serve.ServerCommand.html#__setShutdownHandler
Function
Method
PUBLIC
Assign the application shutdown coroutine for later invocation.
-
orionis.console.commands.serve.serve.ServerCommand.handle
orionis.console.commands.serve.serve.ServerCommand.html#handle
Function
Method
PUBLIC
Build the Granian command and start the HTTP server.
-
orionis.session.entities.record.SessionRecord
orionis.session.entities.record.SessionRecord.html
Class
Class
PUBLIC
Persistent representation of a single session.
-
orionis.session.entities.record.SessionRecord.id
orionis.session.entities.record.SessionRecord.html#id
Attribute
Instance Variable
PUBLIC
Unique session identifier (URL-safe random token).
-
orionis.session.entities.record.SessionRecord.data
orionis.session.entities.record.SessionRecord.html#data
Attribute
Instance Variable
PUBLIC
Serialisable payload stored alongside the session.
-
orionis.session.entities.record.SessionRecord.expires_at
orionis.session.entities.record.SessionRecord.html#expires_at
Attribute
Instance Variable
PUBLIC
UTC datetime at which the record must be considered expired.
-
orionis.session.stores.database._DEFAULT_TABLE
orionis.session.stores.database.html#_DEFAULT_TABLE
Attribute
Constant
PUBLIC
Default table name used when the session config does not override it.
-
orionis.session.stores.database._ENCODER
orionis.session.stores.database.html#_ENCODER
Attribute
Constant
PUBLIC
msgspec resolves its internal state at construction time instead of on every encode/decode call.
-
orionis.session.stores.database._DECODER
orionis.session.stores.database.html#_DECODER
Attribute
Constant
PUBLIC
Decoder used by database.
-
orionis.session.stores.database._build_sessions_table
orionis.session.stores.database.html#_build_sessions_table
Function
Function
PUBLIC
Build the table definition for the sessions table.
-
orionis.session.stores.database.DatabaseSessionStore
orionis.session.stores.database.DatabaseSessionStore.html
Class
Class
PUBLIC
Session store that persists each session as a row in a database table.
-
orionis.session.stores.database.DatabaseSessionStore.__slots__
orionis.session.stores.database.DatabaseSessionStore.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.session.stores.database.DatabaseSessionStore.__init__
orionis.session.stores.database.DatabaseSessionStore.html#__init__
Function
Method
PUBLIC
Bind the store to connection and the target table.
-
orionis.session.stores.database.DatabaseSessionStore._connection
orionis.session.stores.database.DatabaseSessionStore.html#_connection
Attribute
Instance Variable
PUBLIC
Database connection used to persist session records.
-
orionis.session.stores.database.DatabaseSessionStore._table
orionis.session.stores.database.DatabaseSessionStore.html#_table
Attribute
Instance Variable
PUBLIC
Table name used to store session records.
-
orionis.session.stores.database.DatabaseSessionStore._ready
orionis.session.stores.database.DatabaseSessionStore.html#_ready
Attribute
Instance Variable
PUBLIC
Ready flag used by DatabaseSessionStore.
-
orionis.session.stores.database.DatabaseSessionStore._ready_lock
orionis.session.stores.database.DatabaseSessionStore.html#_ready_lock
Attribute
Instance Variable
PUBLIC
Synchronization primitive controlling access to ready lock.
-
orionis.session.stores.database.DatabaseSessionStore._definition
orionis.session.stores.database.DatabaseSessionStore.html#_definition
Attribute
Instance Variable
PUBLIC
Original declaration from which runtime metadata was compiled.
-
orionis.session.stores.database.DatabaseSessionStore.migrate
orionis.session.stores.database.DatabaseSessionStore.html#migrate
Function
Method
PUBLIC
Create the framework session table without removing existing data.
-
orionis.session.stores.database.DatabaseSessionStore._ensureSchema
orionis.session.stores.database.DatabaseSessionStore.html#_ensureSchema
Function
Method
PUBLIC
Create the sessions table on first use, if missing.
-
orionis.session.stores.database.DatabaseSessionStore.read
orionis.session.stores.database.DatabaseSessionStore.html#read
Function
Method
PUBLIC
Return the stored record for session_id, or None.
-
orionis.session.stores.database.DatabaseSessionStore.write
orionis.session.stores.database.DatabaseSessionStore.html#write
Function
Method
PUBLIC
Insert or replace the record keyed by its identifier.
-
orionis.session.stores.database.DatabaseSessionStore.__insertOrRetryUpdate
orionis.session.stores.database.DatabaseSessionStore.html#__insertOrRetryUpdate
Function
Method
PUBLIC
Insert a new session row, falling back to an update on conflict.
-
orionis.session.stores.database.DatabaseSessionStore.update
orionis.session.stores.database.DatabaseSessionStore.html#update
Function
Method
PUBLIC
Update only a live session row with a single SQL statement.
-
orionis.session.stores.database.DatabaseSessionStore.delete
orionis.session.stores.database.DatabaseSessionStore.html#delete
Function
Method
PUBLIC
Remove the record for session_id (no-op when absent).
-
orionis.session.stores.database.DatabaseSessionStore.gc
orionis.session.stores.database.DatabaseSessionStore.html#gc
Function
Method
PUBLIC
Remove all rows whose expires_at is in the past.
-
orionis.session.stores.database.DatabaseSessionStore.__encode
orionis.session.stores.database.DatabaseSessionStore.html#__encode
Function
Method
PUBLIC
Serialize data to a JSON string suitable for storage.
-
orionis.session.stores.database.DatabaseSessionStore.__decode
orionis.session.stores.database.DatabaseSessionStore.html#__decode
Function
Method
PUBLIC
Deserialize a stored JSON payload back into a Python dict.
-
orionis.console.commands.session.migrate.SessionMigrateCommand
orionis.console.commands.session.migrate.SessionMigrateCommand.html
Class
Class
PUBLIC
Create the configured framework session table without removing data.
-
orionis.console.commands.session.migrate.SessionMigrateCommand.__slots__
orionis.console.commands.session.migrate.SessionMigrateCommand.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.console.commands.session.migrate.SessionMigrateCommand.timestamps
orionis.console.commands.session.migrate.SessionMigrateCommand.html#timestamps
Attribute
Class Variable
PUBLIC
Timestamps flag used by SessionMigrateCommand.
-
orionis.console.commands.session.migrate.SessionMigrateCommand.signature
orionis.console.commands.session.migrate.SessionMigrateCommand.html#signature
Attribute
Class Variable
PUBLIC
session:migrate.
-
orionis.console.commands.session.migrate.SessionMigrateCommand.description
orionis.console.commands.session.migrate.SessionMigrateCommand.html#description
Attribute
Class Variable
PUBLIC
Create the configured database session table..
-
orionis.console.commands.session.migrate.SessionMigrateCommand.handle
orionis.console.commands.session.migrate.SessionMigrateCommand.html#handle
Function
Method
PUBLIC
Create session storage from the framework's internal definition.
-
orionis.console.commands.support._clear.clear_files
orionis.console.commands.support._clear.html#clear_files
Function
Function
PUBLIC
Remove files with the given suffixes from a dedicated directory.
-
orionis.metadata.API
orionis.metadata.html#API
Attribute
Constant
PUBLIC
API URL to the project's JSON data.
-
orionis.metadata.AUTHOR
orionis.metadata.html#AUTHOR
Attribute
Constant
PUBLIC
Full name of the author or maintainer of the project.
-
orionis.metadata.AUTHOR_EMAIL
orionis.metadata.html#AUTHOR_EMAIL
Attribute
Constant
PUBLIC
Email address of the author or maintainer for contact purposes.
-
orionis.metadata.DESCRIPTION
orionis.metadata.html#DESCRIPTION
Attribute
Constant
PUBLIC
Short description of the project or framework.
-
orionis.metadata.DOCS
orionis.metadata.html#DOCS
Attribute
Constant
PUBLIC
URL to the project's documentation.
-
orionis.metadata.FRAMEWORK
orionis.metadata.html#FRAMEWORK
Attribute
Constant
PUBLIC
URL to the project's main framework repository.
-
orionis.metadata.NAME
orionis.metadata.html#NAME
Attribute
Constant
PUBLIC
Metadata for the Orionis Framework project.
-
orionis.metadata.PYTHON_REQUIRES
orionis.metadata.html#PYTHON_REQUIRES
Attribute
Constant
PUBLIC
Minimum Python version required to run the project.
-
orionis.metadata.SKELETON
orionis.metadata.html#SKELETON
Attribute
Constant
PUBLIC
URL to the project's skeleton or template repository (for initial setup).
-
orionis.metadata.VERSION
orionis.metadata.html#VERSION
Attribute
Constant
PUBLIC
Current version of the framework.
-
orionis.console.commands.support.about._PANEL_TITLE
orionis.console.commands.support.about.html#_PANEL_TITLE
Attribute
Constant
PUBLIC
Show the framework name and version in the panel title.
-
orionis.console.commands.support.about._PANEL_BODY
orionis.console.commands.support.about.html#_PANEL_BODY
Attribute
Constant
PUBLIC
Show framework details, author contact information, and project links.
-
orionis.console.commands.support.about.VersionCommand
orionis.console.commands.support.about.VersionCommand.html
Class
Class
PUBLIC
Display the installed framework and runtime version information.
-
orionis.console.commands.support.about.VersionCommand.timestamps
orionis.console.commands.support.about.VersionCommand.html#timestamps
Attribute
Class Variable
PUBLIC
Control whether this command includes timestamps in its output.
-
orionis.console.commands.support.about.VersionCommand.signature
orionis.console.commands.support.about.VersionCommand.html#signature
Attribute
Class Variable
PUBLIC
Identify the command in the CLI registry.
-
orionis.console.commands.support.about.VersionCommand.description
orionis.console.commands.support.about.VersionCommand.html#description
Attribute
Class Variable
PUBLIC
Describe the information displayed by this command.
-
orionis.console.commands.support.about.VersionCommand.handle
orionis.console.commands.support.about.VersionCommand.html#handle
Function
Method
PUBLIC
Display Orionis framework version and metadata.
-
orionis.console.commands.support.clear_cache.ClearCacheCommand
orionis.console.commands.support.clear_cache.ClearCacheCommand.html
Class
Class
PUBLIC
Clear entries from the application's configured default cache store.
-
orionis.console.commands.support.clear_cache.ClearCacheCommand.timestamps
orionis.console.commands.support.clear_cache.ClearCacheCommand.html#timestamps
Attribute
Class Variable
PUBLIC
Timestamps flag used by ClearCacheCommand.
-
orionis.console.commands.support.clear_cache.ClearCacheCommand.signature
orionis.console.commands.support.clear_cache.ClearCacheCommand.html#signature
Attribute
Class Variable
PUBLIC
clear:cache.
-
orionis.console.commands.support.clear_cache.ClearCacheCommand.description
orionis.console.commands.support.clear_cache.ClearCacheCommand.html#description
Attribute
Class Variable
PUBLIC
Clear entries from the default application cache
store..
-
orionis.console.commands.support.clear_cache.ClearCacheCommand.handle
orionis.console.commands.support.clear_cache.ClearCacheCommand.html#handle
Function
Method
PUBLIC
Clear the configured default cache store.
-
orionis.console.commands.support.clear_logs._clear_configured_log
orionis.console.commands.support.clear_logs.html#_clear_configured_log
Function
Function
PUBLIC
Remove files matching one configured log path template.
-
orionis.console.commands.support.clear_logs.ClearLogsCommand
orionis.console.commands.support.clear_logs.ClearLogsCommand.html
Class
Class
PUBLIC
Remove files generated by the application's logging channels.
-
orionis.console.commands.support.clear_logs.ClearLogsCommand.timestamps
orionis.console.commands.support.clear_logs.ClearLogsCommand.html#timestamps
Attribute
Class Variable
PUBLIC
Timestamps flag used by ClearLogsCommand.
-
orionis.console.commands.support.clear_logs.ClearLogsCommand.signature
orionis.console.commands.support.clear_logs.ClearLogsCommand.html#signature
Attribute
Class Variable
PUBLIC
clear:logs.
-
orionis.console.commands.support.clear_logs.ClearLogsCommand.description
orionis.console.commands.support.clear_logs.ClearLogsCommand.html#description
Attribute
Class Variable
PUBLIC
Clear framework log files..
-
orionis.console.commands.support.clear_logs.ClearLogsCommand.handle
orionis.console.commands.support.clear_logs.ClearLogsCommand.html#handle
Function
Method
PUBLIC
Remove framework log files and compressed rotated logs.
-
orionis.console.commands.support.clear_testing.ClearTestingCommand
orionis.console.commands.support.clear_testing.ClearTestingCommand.html
Class
Class
PUBLIC
Remove saved test-run result files.
-
orionis.console.commands.support.clear_testing.ClearTestingCommand.timestamps
orionis.console.commands.support.clear_testing.ClearTestingCommand.html#timestamps
Attribute
Class Variable
PUBLIC
Timestamps flag used by ClearTestingCommand.
-
orionis.console.commands.support.clear_testing.ClearTestingCommand.signature
orionis.console.commands.support.clear_testing.ClearTestingCommand.html#signature
Attribute
Class Variable
PUBLIC
clear:testing.
-
orionis.console.commands.support.clear_testing.ClearTestingCommand.description
orionis.console.commands.support.clear_testing.ClearTestingCommand.html#description
Attribute
Class Variable
PUBLIC
Clear cached test-run results..
-
orionis.console.commands.support.clear_testing.ClearTestingCommand.handle
orionis.console.commands.support.clear_testing.ClearTestingCommand.html#handle
Function
Method
PUBLIC
Remove JSON test results from the framework test cache.
-
orionis.console.commands.support.clear_views.ClearViewsCommand
orionis.console.commands.support.clear_views.ClearViewsCommand.html
Class
Class
PUBLIC
Remove compiled template bytecode from the configured view cache.
-
orionis.console.commands.support.clear_views.ClearViewsCommand.timestamps
orionis.console.commands.support.clear_views.ClearViewsCommand.html#timestamps
Attribute
Class Variable
PUBLIC
Timestamps flag used by ClearViewsCommand.
-
orionis.console.commands.support.clear_views.ClearViewsCommand.signature
orionis.console.commands.support.clear_views.ClearViewsCommand.html#signature
Attribute
Class Variable
PUBLIC
clear:views.
-
orionis.console.commands.support.clear_views.ClearViewsCommand.description
orionis.console.commands.support.clear_views.ClearViewsCommand.html#description
Attribute
Class Variable
PUBLIC
Clear compiled view templates..
-
orionis.console.commands.support.clear_views.ClearViewsCommand.handle
orionis.console.commands.support.clear_views.ClearViewsCommand.html#handle
Function
Method
PUBLIC
Remove Jinja bytecode cache files while preserving the cache directory.
-
orionis.console.commands.support.maintenance._REPLACE_ATTEMPTS
orionis.console.commands.support.maintenance.html#_REPLACE_ATTEMPTS
Attribute
Constant
PUBLIC
Replace attempts value used by maintenance.
-
orionis.console.commands.support.maintenance.MaintenanceModeCommand
orionis.console.commands.support.maintenance.MaintenanceModeCommand.html
Class
Class
PUBLIC
Write a runtime-visible maintenance state for HTTP workers.
-
orionis.console.commands.support.maintenance.MaintenanceModeCommand.timestamps
orionis.console.commands.support.maintenance.MaintenanceModeCommand.html#timestamps
Attribute
Class Variable
PUBLIC
Timestamps flag used by MaintenanceModeCommand.
-
orionis.console.commands.support.maintenance.MaintenanceModeCommand.state
orionis.console.commands.support.maintenance.MaintenanceModeCommand.html#state
Attribute
Class Variable
PUBLIC
State selected by the maintenance-mode command.
-
orionis.console.commands.support.maintenance.MaintenanceModeCommand.status_message
orionis.console.commands.support.maintenance.MaintenanceModeCommand.html#status_message
Attribute
Class Variable
PUBLIC
Console message describing the resulting maintenance status.
-
orionis.console.commands.support.maintenance.MaintenanceModeCommand.handle
orionis.console.commands.support.maintenance.MaintenanceModeCommand.html#handle
Function
Method
PUBLIC
Atomically update the state periodically read by HTTP workers.
-
orionis.console.commands.support.down.DownCommand
orionis.console.commands.support.down.DownCommand.html
Class
Class
PUBLIC
Place the application in runtime maintenance mode.
-
orionis.console.commands.support.down.DownCommand.signature
orionis.console.commands.support.down.DownCommand.html#signature
Attribute
Class Variable
PUBLIC
down.
-
orionis.console.commands.support.down.DownCommand.description
orionis.console.commands.support.down.DownCommand.html#description
Attribute
Class Variable
PUBLIC
Put the application into maintenance mode..
-
orionis.console.commands.support.down.DownCommand.state
orionis.console.commands.support.down.DownCommand.html#state
Attribute
Class Variable
PUBLIC
down.
-
orionis.console.commands.support.down.DownCommand.status_message
orionis.console.commands.support.down.DownCommand.html#status_message
Attribute
Class Variable
PUBLIC
Confirmation displayed when the application enters maintenance mode.
-
orionis.console.commands.support.environment.EnvironmentCommand
orionis.console.commands.support.environment.EnvironmentCommand.html
Class
Class
PUBLIC
Display the active application environment.
-
orionis.console.commands.support.environment.EnvironmentCommand.timestamps
orionis.console.commands.support.environment.EnvironmentCommand.html#timestamps
Attribute
Class Variable
PUBLIC
Timestamps flag used by EnvironmentCommand.
-
orionis.console.commands.support.environment.EnvironmentCommand.signature
orionis.console.commands.support.environment.EnvironmentCommand.html#signature
Attribute
Class Variable
PUBLIC
env.
-
orionis.console.commands.support.environment.EnvironmentCommand.description
orionis.console.commands.support.environment.EnvironmentCommand.html#description
Attribute
Class Variable
PUBLIC
Display the current application environment..
-
orionis.console.commands.support.environment.EnvironmentCommand.handle
orionis.console.commands.support.environment.EnvironmentCommand.html#handle
Function
Method
PUBLIC
Print the environment configured for the running application.
-
orionis.console.commands.support.install._ACCENT_STYLE
orionis.console.commands.support.install.html#_ACCENT_STYLE
Attribute
Constant
PUBLIC
bold cyan.
-
orionis.console.commands.support.install._ERROR_STYLE
orionis.console.commands.support.install.html#_ERROR_STYLE
Attribute
Constant
PUBLIC
Console style used to display installation errors.
-
orionis.console.commands.support.install._WARNING_STYLE
orionis.console.commands.support.install.html#_WARNING_STYLE
Attribute
Constant
PUBLIC
yellow.
-
orionis.console.commands.support.install._MANIFEST_NAME
orionis.console.commands.support.install.html#_MANIFEST_NAME
Attribute
Constant
PUBLIC
pyproject.toml.
-
orionis.console.commands.support.install._PACKAGE_MANIFEST
orionis.console.commands.support.install.html#_PACKAGE_MANIFEST
Attribute
Constant
PUBLIC
Package manifest used by install.
-
orionis.console.commands.support.install._SOURCE_MANIFEST
orionis.console.commands.support.install.html#_SOURCE_MANIFEST
Attribute
Constant
PUBLIC
Source manifest used by install.
-
orionis.console.commands.support.install.InstallCommand
orionis.console.commands.support.install.InstallCommand.html
Class
Class
PUBLIC
Install optional features declared by the resolved project manifest.
-
orionis.console.commands.support.install.InstallCommand.__slots__
orionis.console.commands.support.install.InstallCommand.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.console.commands.support.install.InstallCommand.timestamps
orionis.console.commands.support.install.InstallCommand.html#timestamps
Attribute
Class Variable
PUBLIC
Timestamps flag used by InstallCommand.
-
orionis.console.commands.support.install.InstallCommand.signature
orionis.console.commands.support.install.InstallCommand.html#signature
Attribute
Class Variable
PUBLIC
packages.
-
orionis.console.commands.support.install.InstallCommand.description
orionis.console.commands.support.install.InstallCommand.html#description
Attribute
Class Variable
PUBLIC
Install optional Orionis features and development
tools..
-
orionis.console.commands.support.install.InstallCommand.arguments
orionis.console.commands.support.install.InstallCommand.html#arguments
Attribute
Class Variable
PUBLIC
Command-line argument declarations accepted by this command.
-
orionis.console.commands.support.install.InstallCommand.__init__
orionis.console.commands.support.install.InstallCommand.html#__init__
Function
Method
PUBLIC
Initialize the command arguments and Rich output.
-
orionis.console.commands.support.install.InstallCommand._console
orionis.console.commands.support.install.InstallCommand.html#_console
Attribute
Instance Variable
PUBLIC
Console produced by RichConsole.
-
orionis.console.commands.support.install.InstallCommand._purposes
orionis.console.commands.support.install.InstallCommand.html#_purposes
Attribute
Instance Variable
PUBLIC
Human-readable descriptions of installable extras and dependency groups.
-
orionis.console.commands.support.install.InstallCommand.handle
orionis.console.commands.support.install.InstallCommand.html#handle
Function
Method
PUBLIC
List and install optional features in the interpreter running Reactor.
-
orionis.console.commands.support.install.InstallCommand.__projectPath
orionis.console.commands.support.install.InstallCommand.html#__projectPath
Function
Static Method
PUBLIC
Prefer the framework manifest over the application's fallback manifest.
-
orionis.console.commands.support.install.InstallCommand.__loadOptions
orionis.console.commands.support.install.InstallCommand.html#__loadOptions
Function
Method
PUBLIC
Read extras and expand dependency groups from a TOML manifest.
-
orionis.console.commands.support.install.InstallCommand.__loadPurposes
orionis.console.commands.support.install.InstallCommand.html#__loadPurposes
Function
Method
PUBLIC
Read human-readable purposes for the installation options.
-
orionis.console.commands.support.install.InstallCommand.__dependencyTable
orionis.console.commands.support.install.InstallCommand.html#__dependencyTable
Function
Static Method
PUBLIC
Validate a manifest table containing dependency declarations.
-
orionis.console.commands.support.install.InstallCommand.__requirements
orionis.console.commands.support.install.InstallCommand.html#__requirements
Function
Static Method
PUBLIC
Validate and deduplicate a list of package requirements.
-
orionis.console.commands.support.install.InstallCommand.__resolveGroup
orionis.console.commands.support.install.InstallCommand.html#__resolveGroup
Function
Method
PUBLIC
Expand included dependency groups and reject recursive references.
-
orionis.console.commands.support.install.InstallCommand.__renderOptions
orionis.console.commands.support.install.InstallCommand.html#__renderOptions
Function
Method
PUBLIC
Render a compact catalog with one row per installation option.
-
orionis.console.commands.support.install.InstallCommand.__optionPurpose
orionis.console.commands.support.install.InstallCommand.html#__optionPurpose
Function
Method
PUBLIC
Describe an option without exposing its package requirements.
-
orionis.console.commands.support.install.InstallCommand.__selectOptions
orionis.console.commands.support.install.InstallCommand.html#__selectOptions
Function
Method
PUBLIC
Read explicit options or ask for an interactive selection.
-
orionis.console.commands.support.install.InstallCommand.__resolveOption
orionis.console.commands.support.install.InstallCommand.html#__resolveOption
Function
Static Method
PUBLIC
Resolve a catalog number, namespaced key or unambiguous name.
-
orionis.console.commands.support.install.InstallCommand.__installSelection
orionis.console.commands.support.install.InstallCommand.html#__installSelection
Function
Method
PUBLIC
Confirm and install all requirements from the selected options.
-
orionis.console.commands.support.install.InstallCommand.__runInstaller
orionis.console.commands.support.install.InstallCommand.html#__runInstaller
Function
Method
PUBLIC
Run uv against the current Python environment without a shell.
-
orionis.foundation.config.app.enums.ciphers._AUTHENTICATED_CIPHERS
orionis.foundation.config.app.enums.ciphers.html#_AUTHENTICATED_CIPHERS
Attribute
Constant
PUBLIC
Canonical cipher names accepted for authenticated application encryption.
-
orionis.environment.key.key_generator.SecureKeyGenerator
orionis.environment.key.key_generator.SecureKeyGenerator.html
Class
Class
PUBLIC
Generate cryptographically secure application secret keys.
-
orionis.environment.key.key_generator.SecureKeyGenerator.__slots__
orionis.environment.key.key_generator.SecureKeyGenerator.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.environment.key.key_generator.SecureKeyGenerator.KEY_SIZES
orionis.environment.key.key_generator.SecureKeyGenerator.html#KEY_SIZES
Attribute
Constant
PUBLIC
Mapping of cipher modes to their respective key sizes in bytes.
-
orionis.environment.key.key_generator.SecureKeyGenerator.generate
orionis.environment.key.key_generator.SecureKeyGenerator.html#generate
Function
Static Method
PUBLIC
Generate a Laravel-compatible APP_KEY.
-
orionis.console.commands.support.key_generate.KeyGenerateCommand
orionis.console.commands.support.key_generate.KeyGenerateCommand.html
Class
Class
PUBLIC
Generate and persist an application encryption key.
-
orionis.console.commands.support.key_generate.KeyGenerateCommand.timestamps
orionis.console.commands.support.key_generate.KeyGenerateCommand.html#timestamps
Attribute
Class Variable
PUBLIC
Timestamps flag used by KeyGenerateCommand.
-
orionis.console.commands.support.key_generate.KeyGenerateCommand.signature
orionis.console.commands.support.key_generate.KeyGenerateCommand.html#signature
Attribute
Class Variable
PUBLIC
key:generate.
-
orionis.console.commands.support.key_generate.KeyGenerateCommand.description
orionis.console.commands.support.key_generate.KeyGenerateCommand.html#description
Attribute
Class Variable
PUBLIC
Generate the application encryption key..
-
orionis.console.commands.support.key_generate.KeyGenerateCommand.arguments
orionis.console.commands.support.key_generate.KeyGenerateCommand.html#arguments
Attribute
Class Variable
PUBLIC
Command-line argument declarations accepted by this command.
-
orionis.console.commands.support.key_generate.KeyGenerateCommand.handle
orionis.console.commands.support.key_generate.KeyGenerateCommand.html#handle
Function
Method
PUBLIC
Create a key and store it in the application's environment file.
-
orionis.console.commands.support.list._USAGE_HEADER
orionis.console.commands.support.list.html#_USAGE_HEADER
Attribute
Constant
PUBLIC
Show usage, an example, and the available command list heading.
-
orionis.console.commands.support.list._USAGE_FOOTER
orionis.console.commands.support.list.html#_USAGE_FOOTER
Attribute
Constant
PUBLIC
Show the help option after the registered commands.
-
orionis.console.commands.support.list.HelpCommand
orionis.console.commands.support.list.HelpCommand.html
Class
Class
PUBLIC
Display available commands and their usage information.
-
orionis.console.commands.support.list.HelpCommand.timestamps
orionis.console.commands.support.list.HelpCommand.html#timestamps
Attribute
Class Variable
PUBLIC
Control whether this command includes timestamps in its output.
-
orionis.console.commands.support.list.HelpCommand.signature
orionis.console.commands.support.list.HelpCommand.html#signature
Attribute
Class Variable
PUBLIC
Identify the command in the CLI registry.
-
orionis.console.commands.support.list.HelpCommand.description
orionis.console.commands.support.list.HelpCommand.html#description
Attribute
Class Variable
PUBLIC
Describe the information displayed by this command.
-
orionis.console.commands.support.list.HelpCommand.handle
orionis.console.commands.support.list.HelpCommand.html#handle
Function
Method
PUBLIC
Display usage information and available commands for the Orionis CLI.
-
orionis.console.commands.support.optimize._VENV_DIR_NAMES
orionis.console.commands.support.optimize.html#_VENV_DIR_NAMES
Attribute
Constant
PUBLIC
Venv dir names used by optimize.
-
orionis.console.commands.support.optimize._ACTIVE_VENV_BASENAME
orionis.console.commands.support.optimize.html#_ACTIVE_VENV_BASENAME
Attribute
Constant
PUBLIC
Active venv basename used by optimize.
-
orionis.console.commands.support.optimize._SKIP_DIRS
orionis.console.commands.support.optimize.html#_SKIP_DIRS
Attribute
Variable
PUBLIC
Skip dirs used by optimize.
-
orionis.console.commands.support.optimize.OptimizeCommand
orionis.console.commands.support.optimize.OptimizeCommand.html
Class
Class
PUBLIC
Validate application Python sources without writing bytecode.
-
orionis.console.commands.support.optimize.OptimizeCommand.timestamps
orionis.console.commands.support.optimize.OptimizeCommand.html#timestamps
Attribute
Class Variable
PUBLIC
Timestamps flag used by OptimizeCommand.
-
orionis.console.commands.support.optimize.OptimizeCommand.signature
orionis.console.commands.support.optimize.OptimizeCommand.html#signature
Attribute
Class Variable
PUBLIC
optimize.
-
orionis.console.commands.support.optimize.OptimizeCommand.description
orionis.console.commands.support.optimize.OptimizeCommand.html#description
Attribute
Class Variable
PUBLIC
Validate application Python files without writing
bytecode..
-
orionis.console.commands.support.optimize.OptimizeCommand.handle
orionis.console.commands.support.optimize.OptimizeCommand.html#handle
Function
Method
PUBLIC
Validate Python modules below the application root in memory.
-
orionis.console.commands.support.optimize_clear._VENV_DIR_NAMES
orionis.console.commands.support.optimize_clear.html#_VENV_DIR_NAMES
Attribute
Constant
PUBLIC
Venv dir names used by optimize_clear.
-
orionis.console.commands.support.optimize_clear._ACTIVE_VENV_BASENAME
orionis.console.commands.support.optimize_clear.html#_ACTIVE_VENV_BASENAME
Attribute
Constant
PUBLIC
Active venv basename used by optimize_clear.
-
orionis.console.commands.support.optimize_clear._SKIP_DIRS
orionis.console.commands.support.optimize_clear.html#_SKIP_DIRS
Attribute
Variable
PUBLIC
Skip dirs used by optimize_clear.
-
orionis.console.commands.support.optimize_clear._BUILD_DIR_NAMES
orionis.console.commands.support.optimize_clear.html#_BUILD_DIR_NAMES
Attribute
Constant
PUBLIC
Build dir names definitions used by optimize_clear.
-
orionis.console.commands.support.optimize_clear._COMPILED_CACHE_FILES
orionis.console.commands.support.optimize_clear.html#_COMPILED_CACHE_FILES
Attribute
Constant
PUBLIC
Compiled cache files definitions used by optimize_clear.
-
orionis.console.commands.support.optimize_clear._BYTECODE_SUFFIXES
orionis.console.commands.support.optimize_clear.html#_BYTECODE_SUFFIXES
Attribute
Constant
PUBLIC
Bytecode suffixes used by optimize_clear.
-
orionis.console.commands.support.optimize_clear.OptimizeClearCommand
orionis.console.commands.support.optimize_clear.OptimizeClearCommand.html
Class
Class
PUBLIC
Remove generated optimization artifacts from the application.
-
orionis.console.commands.support.optimize_clear.OptimizeClearCommand.timestamps
orionis.console.commands.support.optimize_clear.OptimizeClearCommand.html#timestamps
Attribute
Class Variable
PUBLIC
Timestamps flag used by OptimizeClearCommand.
-
orionis.console.commands.support.optimize_clear.OptimizeClearCommand.signature
orionis.console.commands.support.optimize_clear.OptimizeClearCommand.html#signature
Attribute
Class Variable
PUBLIC
optimize:clear.
-
orionis.console.commands.support.optimize_clear.OptimizeClearCommand.description
orionis.console.commands.support.optimize_clear.OptimizeClearCommand.html#description
Attribute
Class Variable
PUBLIC
Removes compiled configuration, route, and command
caches, Python bytecode, and build artifacts..
-
orionis.console.commands.support.optimize_clear.OptimizeClearCommand.handle
orionis.console.commands.support.optimize_clear.OptimizeClearCommand.html#handle
Function
Method
PUBLIC
Clear generated bytecode, build artifacts, and compiled caches.
-
orionis.console.commands.support.optimize_clear.OptimizeClearCommand.__clearBytecode
orionis.console.commands.support.optimize_clear.OptimizeClearCommand.html#__clearBytecode
Function
Method
PUBLIC
Remove bytecode directories and standalone bytecode files.
-
orionis.console.commands.support.optimize_clear.OptimizeClearCommand.__clearBuildArtifacts
orionis.console.commands.support.optimize_clear.OptimizeClearCommand.html#__clearBuildArtifacts
Function
Method
PUBLIC
Remove top-level build output and package metadata directories.
-
orionis.console.commands.support.optimize_clear.OptimizeClearCommand.__clearCompiledCaches
orionis.console.commands.support.optimize_clear.OptimizeClearCommand.html#__clearCompiledCaches
Function
Method
PUBLIC
Remove framework-owned compiled state cache files.
-
orionis.console.commands.support.optimize_clear.OptimizeClearCommand.__removePath
orionis.console.commands.support.optimize_clear.OptimizeClearCommand.html#__removePath
Function
Method
PUBLIC
Remove one file, directory, or symbolic link and record failures.
-
orionis.console.commands.support.optimize_clear.OptimizeClearCommand.__reportCleanup
orionis.console.commands.support.optimize_clear.OptimizeClearCommand.html#__reportCleanup
Function
Method
PUBLIC
Write a cleanup summary and any filesystem errors to the console.
-
orionis.console.commands.support.up.UpCommand
orionis.console.commands.support.up.UpCommand.html
Class
Class
PUBLIC
Restore normal application traffic after maintenance.
-
orionis.console.commands.support.up.UpCommand.signature
orionis.console.commands.support.up.UpCommand.html#signature
Attribute
Class Variable
PUBLIC
up.
-
orionis.console.commands.support.up.UpCommand.description
orionis.console.commands.support.up.UpCommand.html#description
Attribute
Class Variable
PUBLIC
Bring the application out of maintenance mode..
-
orionis.console.commands.support.up.UpCommand.state
orionis.console.commands.support.up.UpCommand.html#state
Attribute
Class Variable
PUBLIC
up.
-
orionis.console.commands.support.up.UpCommand.status_message
orionis.console.commands.support.up.UpCommand.html#status_message
Attribute
Class Variable
PUBLIC
Confirmation displayed when the application leaves maintenance mode.
-
orionis.test.enums.status.TestStatus
orionis.test.enums.status.TestStatus.html
Class
Class
PUBLIC
Represent possible statuses for a test during execution.
-
orionis.test.enums.status.TestStatus.PASSED
orionis.test.enums.status.TestStatus.html#PASSED
Attribute
Constant
PUBLIC
Indicates the test completed successfully without errors or failures.
-
orionis.test.enums.status.TestStatus.FAILED
orionis.test.enums.status.TestStatus.html#FAILED
Attribute
Constant
PUBLIC
Indicates the test completed but did not produce the expected results.
-
orionis.test.enums.status.TestStatus.ERRORED
orionis.test.enums.status.TestStatus.html#ERRORED
Attribute
Constant
PUBLIC
Indicates an unexpected error occurred during test execution.
-
orionis.test.enums.status.TestStatus.SKIPPED
orionis.test.enums.status.TestStatus.html#SKIPPED
Attribute
Constant
PUBLIC
Indicate an omitted test or a declared expected failure.
-
orionis.test.entities.result.TestResult
orionis.test.entities.result.TestResult.html
Class
Class
PUBLIC
Represent the outcome of a test execution.
-
orionis.test.entities.result.TestResult.id
orionis.test.entities.result.TestResult.html#id
Attribute
Instance Variable
PUBLIC
Unique identifier for the test result.
-
orionis.test.entities.result.TestResult.name
orionis.test.entities.result.TestResult.html#name
Attribute
Instance Variable
PUBLIC
Name of the test.
-
orionis.test.entities.result.TestResult.status
orionis.test.entities.result.TestResult.html#status
Attribute
Instance Variable
PUBLIC
Status of the test execution (e.g., passed, failed).
-
orionis.test.entities.result.TestResult.execution_time
orionis.test.entities.result.TestResult.html#execution_time
Attribute
Instance Variable
PUBLIC
Time taken to execute the test, in seconds.
-
orionis.test.entities.result.TestResult.error_message
orionis.test.entities.result.TestResult.html#error_message
Attribute
Instance Variable
PUBLIC
Error message if the test failed, otherwise None.
-
orionis.test.entities.result.TestResult.traceback
orionis.test.entities.result.TestResult.html#traceback
Attribute
Instance Variable
PUBLIC
Formatted traceback lines if an error occurred, otherwise None.
-
orionis.test.entities.result.TestResult.class_name
orionis.test.entities.result.TestResult.html#class_name
Attribute
Instance Variable
PUBLIC
Name of the class containing the test, if applicable.
-
orionis.test.entities.result.TestResult.method
orionis.test.entities.result.TestResult.html#method
Attribute
Instance Variable
PUBLIC
Name of the method representing the test, if applicable.
-
orionis.test.entities.result.TestResult.module
orionis.test.entities.result.TestResult.html#module
Attribute
Instance Variable
PUBLIC
Name of the module containing the test, if applicable.
-
orionis.test.entities.result.TestResult.file_path
orionis.test.entities.result.TestResult.html#file_path
Attribute
Instance Variable
PUBLIC
Path to the file containing the test, if applicable.
-
orionis.test.entities.result.TestResult.doc_string
orionis.test.entities.result.TestResult.html#doc_string
Attribute
Instance Variable
PUBLIC
Docstring of the test, if applicable.
-
orionis.test.entities.result.TestResult.exception
orionis.test.entities.result.TestResult.html#exception
Attribute
Instance Variable
PUBLIC
Name of the raised exception class if an error occurred, otherwise None.
-
orionis.test.entities.result.TestResult.line_no
orionis.test.entities.result.TestResult.html#line_no
Attribute
Instance Variable
PUBLIC
Source line associated with the failure, if available.
-
orionis.test.entities.result.TestResult.source_code
orionis.test.entities.result.TestResult.html#source_code
Attribute
Instance Variable
PUBLIC
Source line numbers and text surrounding the failure.
-
orionis.test.contracts.engine.ITestingEngine
orionis.test.contracts.engine.ITestingEngine.html
Class
Class
PUBLIC
Define the contract for testing engine implementations.
-
orionis.test.contracts.engine.ITestingEngine.setVerbosity
orionis.test.contracts.engine.ITestingEngine.html#setVerbosity
Function
Method
PUBLIC
Set the verbosity level for the testing engine.
-
orionis.test.contracts.engine.ITestingEngine.setFailFast
orionis.test.contracts.engine.ITestingEngine.html#setFailFast
Function
Method
PUBLIC
Set the fail-fast behavior for the testing engine.
-
orionis.test.contracts.engine.ITestingEngine.setStartDir
orionis.test.contracts.engine.ITestingEngine.html#setStartDir
Function
Method
PUBLIC
Set the directory or Python file used for test discovery.
-
orionis.test.contracts.engine.ITestingEngine.setFilePattern
orionis.test.contracts.engine.ITestingEngine.html#setFilePattern
Function
Method
PUBLIC
Set the file pattern for test file discovery.
-
orionis.test.contracts.engine.ITestingEngine.setMethodPattern
orionis.test.contracts.engine.ITestingEngine.html#setMethodPattern
Function
Method
PUBLIC
Set the method pattern for test method discovery.
-
orionis.test.contracts.engine.ITestingEngine.withoutPanel
orionis.test.contracts.engine.ITestingEngine.html#withoutPanel
Function
Method
PUBLIC
Disable the start panel display for the testing engine.
-
orionis.test.contracts.engine.ITestingEngine.discover
orionis.test.contracts.engine.ITestingEngine.html#discover
Function
Method
PUBLIC
Discover and filter tests using configuration parameters.
-
orionis.test.contracts.engine.ITestingEngine.run
orionis.test.contracts.engine.ITestingEngine.html#run
Function
Method
PUBLIC
Run the discovered test suite asynchronously.
-
orionis.console.commands.test.test._TRUTHY_VALUES
orionis.console.commands.test.test.html#_TRUTHY_VALUES
Attribute
Constant
PUBLIC
Values considered truthy for boolean CLI/config arguments.
-
orionis.console.commands.test.test._VALID_VERBOSITY
orionis.console.commands.test.test.html#_VALID_VERBOSITY
Attribute
Constant
PUBLIC
Valid verbosity levels accepted by the test runner.
-
orionis.console.commands.test.test._FAILURE_STATUSES
orionis.console.commands.test.test.html#_FAILURE_STATUSES
Attribute
Constant
PUBLIC
Test result statuses that indicate a non-passing outcome.
-
orionis.console.commands.test.test.TestCommand
orionis.console.commands.test.test.TestCommand.html
Class
Class
PUBLIC
Run the configured application test suite from the console.
-
orionis.console.commands.test.test.TestCommand.timestamps
orionis.console.commands.test.test.TestCommand.html#timestamps
Attribute
Class Variable
PUBLIC
Indicates whether timestamps will be shown in the command output.
-
orionis.console.commands.test.test.TestCommand.signature
orionis.console.commands.test.test.TestCommand.html#signature
Attribute
Class Variable
PUBLIC
Command signature and description.
-
orionis.console.commands.test.test.TestCommand.description
orionis.console.commands.test.test.TestCommand.html#description
Attribute
Class Variable
PUBLIC
Command description.
-
orionis.console.commands.test.test.TestCommand.arguments
orionis.console.commands.test.test.TestCommand.html#arguments
Attribute
Class Variable
PUBLIC
List of Argument instances defining command-line options and arguments.
-
orionis.console.commands.test.test.TestCommand.__resolveVerbosity
orionis.console.commands.test.test.TestCommand.html#__resolveVerbosity
Function
Method
PUBLIC
Resolve the verbosity level requested for this run.
-
orionis.console.commands.test.test.TestCommand.handle
orionis.console.commands.test.test.TestCommand.html#handle
Function
Method
PUBLIC
Execute the test command with configured parameters.
-
orionis.console.contracts.ISchedule
orionis.console.contracts.ISchedule.html
Class
Class
PUBLIC
Define the contract for schedule implementations.
-
orionis.console.contracts.ISchedule.info
orionis.console.contracts.ISchedule.html#info
Function
Method
PUBLIC
Retrieve information about all loaded fluent tasks.
-
orionis.console.contracts.ISchedule.boot
orionis.console.contracts.ISchedule.html#boot
Function
Method
PUBLIC
Boot the scheduler and register all configured tasks.
-
orionis.console.contracts.ISchedule.on
orionis.console.contracts.ISchedule.html#on
Function
Method
PUBLIC
Register a listener for a scheduler event.
-
orionis.console.contracts.ISchedule.state
orionis.console.contracts.ISchedule.html#state
Function
Method
PUBLIC
Return the current scheduler state as a string.
-
orionis.console.contracts.ISchedule.isRunning
orionis.console.contracts.ISchedule.html#isRunning
Function
Method
PUBLIC
Determine if the scheduler is currently running.
-
orionis.console.contracts.ISchedule.isPaused
orionis.console.contracts.ISchedule.html#isPaused
Function
Method
PUBLIC
Determine if the scheduler is currently paused.
-
orionis.console.contracts.ISchedule.isStopped
orionis.console.contracts.ISchedule.html#isStopped
Function
Method
PUBLIC
Determine if the scheduler is currently stopped.
-
orionis.console.contracts.ISchedule.command
orionis.console.contracts.ISchedule.html#command
Function
Method
PUBLIC
Add a command for fluent configuration.
-
orionis.console.contracts.ISchedule.pauseTask
orionis.console.contracts.ISchedule.html#pauseTask
Function
Method
PUBLIC
Pause a running task by its signature.
-
orionis.console.contracts.ISchedule.resumeTask
orionis.console.contracts.ISchedule.html#resumeTask
Function
Method
PUBLIC
Resume a paused task by its signature.
-
orionis.console.contracts.ISchedule.removeTask
orionis.console.contracts.ISchedule.html#removeTask
Function
Method
PUBLIC
Remove a task from the scheduler by its signature.
-
orionis.console.contracts.ISchedule.removeAllTasks
orionis.console.contracts.ISchedule.html#removeAllTasks
Function
Method
PUBLIC
Remove all tasks from the scheduler.
-
orionis.console.contracts.ISchedule.pause
orionis.console.contracts.ISchedule.html#pause
Function
Method
PUBLIC
Pause the scheduler if it is running.
-
orionis.console.contracts.ISchedule.resume
orionis.console.contracts.ISchedule.html#resume
Function
Method
PUBLIC
Resume the scheduler if it is paused.
-
orionis.console.contracts.ISchedule.shutdown
orionis.console.contracts.ISchedule.html#shutdown
Function
Method
PUBLIC
Shut down the task scheduler safely without waiting for running tasks.
-
orionis.console.contracts.ISchedule.wait
orionis.console.contracts.ISchedule.html#wait
Function
Method
PUBLIC
Wait for the scheduler shutdown to complete.
-
orionis.console.contracts._EXPORTS
orionis.console.contracts.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.console.contracts.__getattr__
orionis.console.contracts.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.console.contracts.__dir__
orionis.console.contracts.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.console.core.commands.get_core_commands_mapping
orionis.console.core.commands.html#get_core_commands_mapping
Function
Function
PUBLIC
Return the immutable collection of core command classes.
-
orionis.console.core.commands.CORE_COMMANDS
orionis.console.core.commands.html#CORE_COMMANDS
Attribute
Constant
PUBLIC
Core commands used by commands.
-
orionis.console.core.contracts.loader.ILoader
orionis.console.core.contracts.loader.ILoader.html
Class
Class
PUBLIC
Define the contract for loader implementations.
-
orionis.console.core.contracts.loader.ILoader.get
orionis.console.core.contracts.loader.ILoader.html#get
Function
Method
PUBLIC
Retrieve a command instance by its signature.
-
orionis.console.core.contracts.loader.ILoader.all
orionis.console.core.contracts.loader.ILoader.html#all
Function
Method
PUBLIC
Return all loaded commands.
-
orionis.console.core.contracts.loader.ILoader.addFluentCommand
orionis.console.core.contracts.loader.ILoader.html#addFluentCommand
Function
Method
PUBLIC
Define a new command using the fluent interface.
-
orionis.console.core.contracts.loader.ILoader.load
orionis.console.core.contracts.loader.ILoader.html#load
Function
Method
PUBLIC
Load all command classes and their metadata.
-
orionis.console.core.loader._MISSING_TYPE
orionis.console.core.loader.html#_MISSING_TYPE
Attribute
Constant
PUBLIC
Define the sentinel type and command signature pattern.
-
orionis.console.core.loader._CORE_COMMANDS_PATH
orionis.console.core.loader.html#_CORE_COMMANDS_PATH
Attribute
Constant
PUBLIC
Core commands path used by loader.
-
orionis.console.core.loader._SIGNATURE_RE
orionis.console.core.loader.html#_SIGNATURE_RE
Attribute
Constant
PUBLIC
Compiled pattern used to recognize signature re.
-
orionis.console.core.loader._restore_argument_type
orionis.console.core.loader.html#_restore_argument_type
Function
Function
PUBLIC
Resolve a cached parser callable without hiding its import failures.
-
orionis.console.core.loader.Loader
orionis.console.core.loader.Loader.html
Class
Class
PUBLIC
Discover command classes and prepare their runtime registrations.
-
orionis.console.core.loader.Loader.__init__
orionis.console.core.loader.Loader.html#__init__
Function
Method
PUBLIC
Initialize the Loader instance.
-
orionis.console.core.loader.Loader.__fluent_commands
orionis.console.core.loader.Loader.html#__fluent_commands
Attribute
Instance Variable
PUBLIC
Initialize internal lists and dictionaries for commands and metadata.
-
orionis.console.core.loader.Loader.__commands
orionis.console.core.loader.Loader.html#__commands
Attribute
Instance Variable
PUBLIC
Discovered console commands indexed by their command signature.
-
orionis.console.core.loader.Loader.__metadata
orionis.console.core.loader.Loader.html#__metadata
Attribute
Instance Variable
PUBLIC
Compiled metadata used to describe and invoke the registered operation.
-
orionis.console.core.loader.Loader.__imported_modules
orionis.console.core.loader.Loader.html#__imported_modules
Attribute
Instance Variable
PUBLIC
Modules already imported during command discovery.
-
orionis.console.core.loader.Loader.__app
orionis.console.core.loader.Loader.html#__app
Attribute
Instance Variable
PUBLIC
The application instance providing configuration and paths.
-
orionis.console.core.loader.Loader.__all_loaded
orionis.console.core.loader.Loader.html#__all_loaded
Attribute
Instance Variable
PUBLIC
All loaded flag used by Loader.
-
orionis.console.core.loader.Loader.__metadata_loaded
orionis.console.core.loader.Loader.html#__metadata_loaded
Attribute
Instance Variable
PUBLIC
Metadata loaded flag used by Loader.
-
orionis.console.core.loader.Loader.__use_cache
orionis.console.core.loader.Loader.html#__use_cache
Attribute
Instance Variable
PUBLIC
Set up persistence for command caching.
-
orionis.console.core.loader.Loader.__persistence
orionis.console.core.loader.Loader.html#__persistence
Attribute
Instance Variable
PUBLIC
Persistence produced by self.__getCachePersistence.
-
orionis.console.core.loader.Loader.__getCachePersistence
orionis.console.core.loader.Loader.html#__getCachePersistence
Function
Method
PUBLIC
Get the persistence mechanism for command caching.
-
orionis.console.core.loader.Loader.get
orionis.console.core.loader.Loader.html#get
Function
Method
PUBLIC
Retrieve a command instance by its signature.
-
orionis.console.core.loader.Loader.all
orionis.console.core.loader.Loader.html#all
Function
Method
PUBLIC
Return all loaded commands.
-
orionis.console.core.loader.Loader.load
orionis.console.core.loader.Loader.html#load
Function
Method
PUBLIC
Load all command classes and their metadata.
-
orionis.console.core.loader.Loader.addFluentCommand
orionis.console.core.loader.Loader.html#addFluentCommand
Function
Method
PUBLIC
Define a new command using the fluent interface.
-
orionis.console.core.loader.Loader.__loadCoreCommands
orionis.console.core.loader.Loader.html#__loadCoreCommands
Function
Method
PUBLIC
Load and register core command classes provided by the Orionis framework.
-
orionis.console.core.loader.Loader.__loadCustomCommands
orionis.console.core.loader.Loader.html#__loadCustomCommands
Function
Method
PUBLIC
Load custom command classes from the commands directory.
-
orionis.console.core.loader.Loader.__importFluentCommandRoutes
orionis.console.core.loader.Loader.html#__importFluentCommandRoutes
Function
Method
PUBLIC
Import fluent command route modules from application routing paths.
-
orionis.console.core.loader.Loader.__loadFluentCommands
orionis.console.core.loader.Loader.html#__loadFluentCommands
Function
Method
PUBLIC
Register commands defined via the fluent interface.
-
orionis.console.core.loader.Loader.__getSignature
orionis.console.core.loader.Loader.html#__getSignature
Function
Method
PUBLIC
Validate and return the 'signature' attribute of a command class.
-
orionis.console.core.loader.Loader.__getTimestamps
orionis.console.core.loader.Loader.html#__getTimestamps
Function
Method
PUBLIC
Retrieve the 'timestamps' attribute from a command class.
-
orionis.console.core.loader.Loader.__getDescription
orionis.console.core.loader.Loader.html#__getDescription
Function
Method
PUBLIC
Retrieve and validate the 'description' attribute of a command class.
-
orionis.console.core.loader.Loader.__getArguments
orionis.console.core.loader.Loader.html#__getArguments
Function
Method
PUBLIC
Retrieve and validate Argument inputs for a command class.
-
orionis.console.core.loader.Loader.__argToDict
orionis.console.core.loader.Loader.html#__argToDict
Function
Method
PUBLIC
Convert an Argument instance to a JSON-compatible dictionary.
-
orionis.console.core.loader.Loader.__argFromDict
orionis.console.core.loader.Loader.html#__argFromDict
Function
Method
PUBLIC
Reconstruct an Argument instance from a serialized dictionary.
-
orionis.console.core.loader.Loader.__buildArgumentParser
orionis.console.core.loader.Loader.html#__buildArgumentParser
Function
Method
PUBLIC
Construct and configure an ArgumentParser for a command class.
-
orionis.console.core.loader.Loader.__buildCommand
orionis.console.core.loader.Loader.html#__buildCommand
Function
Method
PUBLIC
Build a Command instance from metadata.
-
orionis.console.core.loader.Loader.__loadMetadata
orionis.console.core.loader.Loader.html#__loadMetadata
Function
Method
PUBLIC
Load command metadata from cache or discover commands.
-
orionis.console.core.loader.Loader.__load
orionis.console.core.loader.Loader.html#__load
Function
Method
PUBLIC
Load command classes from metadata and populate the commands dictionary.
-
orionis.console.output.contracts.help_command.IHelpCommand
orionis.console.output.contracts.help_command.IHelpCommand.html
Class
Class
PUBLIC
Define the contract for help command implementations.
-
orionis.console.output.contracts.help_command.IHelpCommand.parseActions
orionis.console.output.contracts.help_command.IHelpCommand.html#parseActions
Function
Static Method
PUBLIC
Parse argparse actions and categorize them.
-
orionis.console.output.contracts.help_command.IHelpCommand.printActions
orionis.console.output.contracts.help_command.IHelpCommand.html#printActions
Function
Static Method
PUBLIC
Render CLI help information for a command or show error if parsing failed.
-
orionis.console.output.help_command.HelpCommand
orionis.console.output.help_command.HelpCommand.html
Class
Class
PUBLIC
Display available commands and their usage information.
-
orionis.console.output.help_command.HelpCommand.parseActions
orionis.console.output.help_command.HelpCommand.html#parseActions
Function
Static Method
PUBLIC
Parse argparse actions and categorize them.
-
orionis.console.output.help_command.HelpCommand.printActions
orionis.console.output.help_command.HelpCommand.html#printActions
Function
Static Method
PUBLIC
Render CLI help information for a command or show error if parsing failed.
-
orionis.support.performance.contracts.counter.IPerformanceCounter
orionis.support.performance.contracts.counter.IPerformanceCounter.html
Class
Class
PUBLIC
Define the contract for performance counter implementations.
-
orionis.support.performance.contracts.counter.IPerformanceCounter.__slots__
orionis.support.performance.contracts.counter.IPerformanceCounter.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.support.performance.contracts.counter.IPerformanceCounter.start
orionis.support.performance.contracts.counter.IPerformanceCounter.html#start
Function
Method
PUBLIC
Start the performance counter.
-
orionis.support.performance.contracts.counter.IPerformanceCounter.astart
orionis.support.performance.contracts.counter.IPerformanceCounter.html#astart
Function
Method
PUBLIC
Start the performance counter asynchronously.
-
orionis.support.performance.contracts.counter.IPerformanceCounter.stop
orionis.support.performance.contracts.counter.IPerformanceCounter.html#stop
Function
Method
PUBLIC
Stop the performance counter and compute elapsed time.
-
orionis.support.performance.contracts.counter.IPerformanceCounter.astop
orionis.support.performance.contracts.counter.IPerformanceCounter.html#astop
Function
Method
PUBLIC
Stop the performance counter asynchronously.
-
orionis.support.performance.contracts.counter.IPerformanceCounter.elapsedTime
orionis.support.performance.contracts.counter.IPerformanceCounter.html#elapsedTime
Function
Method
PUBLIC
Return the elapsed time in seconds between the last start and stop calls.
-
orionis.support.performance.contracts.counter.IPerformanceCounter.aelapsedTime
orionis.support.performance.contracts.counter.IPerformanceCounter.html#aelapsedTime
Function
Method
PUBLIC
Return the elapsed time in seconds asynchronously.
-
orionis.support.performance.contracts.counter.IPerformanceCounter.getMicroseconds
orionis.support.performance.contracts.counter.IPerformanceCounter.html#getMicroseconds
Function
Method
PUBLIC
Return the elapsed time in microseconds.
-
orionis.support.performance.contracts.counter.IPerformanceCounter.agetMicroseconds
orionis.support.performance.contracts.counter.IPerformanceCounter.html#agetMicroseconds
Function
Method
PUBLIC
Return the elapsed time in microseconds asynchronously.
-
orionis.support.performance.contracts.counter.IPerformanceCounter.getMilliseconds
orionis.support.performance.contracts.counter.IPerformanceCounter.html#getMilliseconds
Function
Method
PUBLIC
Return the elapsed time in milliseconds.
-
orionis.support.performance.contracts.counter.IPerformanceCounter.agetMilliseconds
orionis.support.performance.contracts.counter.IPerformanceCounter.html#agetMilliseconds
Function
Method
PUBLIC
Return the elapsed time in milliseconds asynchronously.
-
orionis.support.performance.contracts.counter.IPerformanceCounter.getSeconds
orionis.support.performance.contracts.counter.IPerformanceCounter.html#getSeconds
Function
Method
PUBLIC
Return the elapsed time in seconds.
-
orionis.support.performance.contracts.counter.IPerformanceCounter.agetSeconds
orionis.support.performance.contracts.counter.IPerformanceCounter.html#agetSeconds
Function
Method
PUBLIC
Return the elapsed time in seconds asynchronously.
-
orionis.support.performance.contracts.counter.IPerformanceCounter.getMinutes
orionis.support.performance.contracts.counter.IPerformanceCounter.html#getMinutes
Function
Method
PUBLIC
Return the elapsed time in minutes.
-
orionis.support.performance.contracts.counter.IPerformanceCounter.agetMinutes
orionis.support.performance.contracts.counter.IPerformanceCounter.html#agetMinutes
Function
Method
PUBLIC
Return the elapsed time in minutes asynchronously.
-
orionis.support.performance.contracts.counter.IPerformanceCounter.restart
orionis.support.performance.contracts.counter.IPerformanceCounter.html#restart
Function
Method
PUBLIC
Restart the performance counter.
-
orionis.support.performance.contracts.counter.IPerformanceCounter.arestart
orionis.support.performance.contracts.counter.IPerformanceCounter.html#arestart
Function
Method
PUBLIC
Restart the performance counter asynchronously.
-
orionis.support.performance.counter._ERR_NOT_MEASURED
orionis.support.performance.counter.html#_ERR_NOT_MEASURED
Attribute
Constant
PUBLIC
Counter has not been started and stopped properly..
-
orionis.support.performance.counter._ERR_NOT_STARTED
orionis.support.performance.counter.html#_ERR_NOT_STARTED
Attribute
Constant
PUBLIC
Counter has not been started..
-
orionis.support.performance.counter._ERR_USE_ASTOP
orionis.support.performance.counter.html#_ERR_USE_ASTOP
Attribute
Constant
PUBLIC
Cannot use stop() after astart(). Use astop()
instead..
-
orionis.support.performance.counter._ERR_USE_STOP
orionis.support.performance.counter.html#_ERR_USE_STOP
Attribute
Constant
PUBLIC
Cannot use astop() after start(). Use stop() instead..
-
orionis.console.core.reactor.Reactor
orionis.console.core.reactor.Reactor.html
Class
Class
PUBLIC
Resolve and execute registered console commands.
-
orionis.console.core.reactor.Reactor.__init__
orionis.console.core.reactor.Reactor.html#__init__
Function
Method
PUBLIC
Initialize the command dispatcher and its services.
-
orionis.console.core.reactor.Reactor.__app
orionis.console.core.reactor.Reactor.html#__app
Attribute
Instance Variable
PUBLIC
Application instance for command processing.
-
orionis.console.core.reactor.Reactor.__loader
orionis.console.core.reactor.Reactor.html#__loader
Attribute
Instance Variable
PUBLIC
Loader instance for managing command loading.
-
orionis.console.core.reactor.Reactor.__executer
orionis.console.core.reactor.Reactor.html#__executer
Attribute
Instance Variable
PUBLIC
Executor instance for managing command output.
-
orionis.console.core.reactor.Reactor.__logger
orionis.console.core.reactor.Reactor.html#__logger
Attribute
Instance Variable
PUBLIC
Logger instance for logging command execution details.
-
orionis.console.core.reactor.Reactor.__performance_counter
orionis.console.core.reactor.Reactor.html#__performance_counter
Attribute
Instance Variable
PUBLIC
PerformanceCounter instance for measuring command execution time.
-
orionis.console.core.reactor.Reactor.__catch
orionis.console.core.reactor.Reactor.html#__catch
Attribute
Instance Variable
PUBLIC
Catch instance for handling exceptions.
-
orionis.console.core.reactor.Reactor.__cache_info
orionis.console.core.reactor.Reactor.html#__cache_info
Attribute
Instance Variable
PUBLIC
Initialize cache for command information.
-
orionis.console.core.reactor.Reactor.__parseCommandArgs
orionis.console.core.reactor.Reactor.html#__parseCommandArgs
Function
Method
PUBLIC
Parse command arguments and omit values marked as missing.
-
orionis.console.core.reactor.Reactor.command
orionis.console.core.reactor.Reactor.html#command
Function
Method
PUBLIC
Register a command and return its fluent configuration.
-
orionis.console.core.reactor.Reactor.hasCommand
orionis.console.core.reactor.Reactor.html#hasCommand
Function
Method
PUBLIC
Check whether a command signature is registered.
-
orionis.console.core.reactor.Reactor.info
orionis.console.core.reactor.Reactor.html#info
Function
Method
PUBLIC
Return cached metadata for non-internal commands.
-
orionis.console.core.reactor.Reactor.call
orionis.console.core.reactor.Reactor.html#call
Function
Method
PUBLIC
Execute a command in an isolated failure-reporting context.
-
orionis.console.core.reactor.Reactor.__call
orionis.console.core.reactor.Reactor.html#__call
Function
Method
PUBLIC
Execute a command within a scoped application context.
-
orionis.console.debug.provider.DumperProvider
orionis.console.debug.provider.DumperProvider.html
Class
Class
PUBLIC
Register dumper services in the application container.
-
orionis.console.debug.provider.DumperProvider.register
orionis.console.debug.provider.DumperProvider.html#register
Function
Method
PUBLIC
Register the dumper contract as a singleton.
-
orionis.console.debug.provider.DumperProvider.boot
orionis.console.debug.provider.DumperProvider.html#boot
Function
Method
PUBLIC
Pin the Debug facade for direct synchronous calls.
-
orionis.console.entities.Command
orionis.console.entities.Command.html
Class
Class
PUBLIC
Represent a console command and its metadata.
-
orionis.console.entities.Command.obj
orionis.console.entities.Command.html#obj
Attribute
Instance Variable
PUBLIC
Type or class associated with the command.
-
orionis.console.entities.Command.method
orionis.console.entities.Command.html#method
Attribute
Instance Variable
PUBLIC
Method name to invoke on the object. Defaults to 'handle'.
-
orionis.console.entities.Command.timestamps
orionis.console.entities.Command.html#timestamps
Attribute
Instance Variable
PUBLIC
Enable timestamps for this command. Defaults to True.
-
orionis.console.entities.Command.signature
orionis.console.entities.Command.html#signature
Attribute
Instance Variable
PUBLIC
Command usage signature.
-
orionis.console.entities.Command.description
orionis.console.entities.Command.html#description
Attribute
Instance Variable
PUBLIC
Brief description of the command.
-
orionis.console.entities.Command.args
orionis.console.entities.Command.html#args
Attribute
Instance Variable
PUBLIC
Declarative argument list while the command is being defined, and the parser built from it once the loader materializes the command. Defaults to None.
-
orionis.console.entities.SchedulerEvent
orionis.console.entities.SchedulerEvent.html
Class
Class
PUBLIC
Represent a scheduler event entity.
-
orionis.console.entities.SchedulerEvent.code
orionis.console.entities.SchedulerEvent.html#code
Attribute
Instance Variable
PUBLIC
Unique identifier code for the scheduler event.
-
orionis.console.entities.SchedulerEvent.description
orionis.console.entities.SchedulerEvent.html#description
Attribute
Instance Variable
PUBLIC
Description of the scheduler event. Defaults to an empty string.
-
orionis.console.entities.SchedulerEvent.jobstore
orionis.console.entities.SchedulerEvent.html#jobstore
Attribute
Instance Variable
PUBLIC
Storage backend for the scheduler job. Defaults to "memory".
-
orionis.console.entities.SchedulerEvent.__post_init__
orionis.console.entities.SchedulerEvent.html#__post_init__
Function
Method
PUBLIC
Initialize the SchedulerEvent instance after dataclass construction.
-
orionis.console.entities.Task
orionis.console.entities.Task.html
Class
Class
PUBLIC
Represent a scheduled event and configure its execution and timing.
-
orionis.console.entities.Task.signature
orionis.console.entities.Task.html#signature
Attribute
Instance Variable
PUBLIC
Unique identifier for the event.
-
orionis.console.entities.Task.args
orionis.console.entities.Task.html#args
Attribute
Instance Variable
PUBLIC
Arguments to be passed to the event. Defaults to empty list.
-
orionis.console.entities.Task.kwargs
orionis.console.entities.Task.html#kwargs
Attribute
Instance Variable
PUBLIC
Keyword arguments to be passed to the event. Defaults to empty dict.
-
orionis.console.entities.Task.purpose
orionis.console.entities.Task.html#purpose
Attribute
Instance Variable
PUBLIC
Description of the event's purpose.
-
orionis.console.entities.Task.random_delay
orionis.console.entities.Task.html#random_delay
Attribute
Instance Variable
PUBLIC
Random delay in seconds before triggering.
-
orionis.console.entities.Task.start_date
orionis.console.entities.Task.html#start_date
Attribute
Instance Variable
PUBLIC
Date and time when the event becomes active.
-
orionis.console.entities.Task.end_date
orionis.console.entities.Task.html#end_date
Attribute
Instance Variable
PUBLIC
Date and time when the event becomes inactive.
-
orionis.console.entities.Task.trigger
orionis.console.entities.Task.html#trigger
Attribute
Instance Variable
PUBLIC
Trigger mechanism for event execution.
-
orionis.console.entities.Task.details
orionis.console.entities.Task.html#details
Attribute
Instance Variable
PUBLIC
Additional metadata about the event.
-
orionis.console.entities.Task.max_instances
orionis.console.entities.Task.html#max_instances
Attribute
Instance Variable
PUBLIC
Maximum concurrent instances allowed. Defaults to 1.
-
orionis.console.entities.Task.misfire_grace_time
orionis.console.entities.Task.html#misfire_grace_time
Attribute
Instance Variable
PUBLIC
Grace period in seconds for misfired events.
-
orionis.console.entities.Task.coalesce
orionis.console.entities.Task.html#coalesce
Attribute
Instance Variable
PUBLIC
Whether to coalesce missed runs into a single run. Defaults to True.
-
orionis.console.entities.Task.listeners
orionis.console.entities.Task.html#listeners
Attribute
Instance Variable
PUBLIC
Listeners for event-specific logic. Defaults to empty list.
-
orionis.console.entities.TaskEvent
orionis.console.entities.TaskEvent.html
Class
Class
PUBLIC
Represent a task execution event with scheduling and result information.
-
orionis.console.entities.TaskEvent.code
orionis.console.entities.TaskEvent.html#code
Attribute
Instance Variable
PUBLIC
Event status or result code.
-
orionis.console.entities.TaskEvent.signature
orionis.console.entities.TaskEvent.html#signature
Attribute
Instance Variable
PUBLIC
Task signature identifier.
-
orionis.console.entities.TaskEvent.jobstore
orionis.console.entities.TaskEvent.html#jobstore
Attribute
Instance Variable
PUBLIC
Storage backend for the job.
-
orionis.console.entities.TaskEvent.scheduled_run_times
orionis.console.entities.TaskEvent.html#scheduled_run_times
Attribute
Instance Variable
PUBLIC
Collection of scheduled execution times.
-
orionis.console.entities.TaskEvent.scheduled_run_time
orionis.console.entities.TaskEvent.html#scheduled_run_time
Attribute
Instance Variable
PUBLIC
Specific scheduled execution time.
-
orionis.console.entities.TaskEvent.retval
orionis.console.entities.TaskEvent.html#retval
Attribute
Instance Variable
PUBLIC
Return value from task execution.
-
orionis.console.entities.TaskEvent.exception
orionis.console.entities.TaskEvent.html#exception
Attribute
Instance Variable
PUBLIC
Exception raised during task execution.
-
orionis.console.entities.TaskEvent.traceback
orionis.console.entities.TaskEvent.html#traceback
Attribute
Instance Variable
PUBLIC
Exception traceback information.
-
orionis.console.entities.TaskEvent.description
orionis.console.entities.TaskEvent.html#description
Attribute
Class Variable
PUBLIC
Description produced by field.
-
orionis.console.entities.TaskEvent.__post_init__
orionis.console.entities.TaskEvent.html#__post_init__
Function
Method
PUBLIC
Initialize the TaskEvent instance after dataclass creation.
-
orionis.console.enums.ArgumentAction
orionis.console.enums.ArgumentAction.html
Class
Class
PUBLIC
Define valid action types for use with Python's argparse module.
-
orionis.console.enums.ArgumentAction.STORE
orionis.console.enums.ArgumentAction.html#STORE
Attribute
Constant
PUBLIC
Store the argument value directly.
-
orionis.console.enums.ArgumentAction.STORE_CONST
orionis.console.enums.ArgumentAction.html#STORE_CONST
Attribute
Constant
PUBLIC
Store a constant value when the argument is specified.
-
orionis.console.enums.ArgumentAction.STORE_TRUE
orionis.console.enums.ArgumentAction.html#STORE_TRUE
Attribute
Constant
PUBLIC
Store True when the argument is specified.
-
orionis.console.enums.ArgumentAction.STORE_FALSE
orionis.console.enums.ArgumentAction.html#STORE_FALSE
Attribute
Constant
PUBLIC
Store False when the argument is specified.
-
orionis.console.enums.ArgumentAction.APPEND
orionis.console.enums.ArgumentAction.html#APPEND
Attribute
Constant
PUBLIC
Append each argument value to a list.
-
orionis.console.enums.ArgumentAction.APPEND_CONST
orionis.console.enums.ArgumentAction.html#APPEND_CONST
Attribute
Constant
PUBLIC
Append a constant value to a list when the argument is specified.
-
orionis.console.enums.ArgumentAction.COUNT
orionis.console.enums.ArgumentAction.html#COUNT
Attribute
Constant
PUBLIC
Count the number of times the argument is specified.
-
orionis.console.enums.ArgumentAction.HELP
orionis.console.enums.ArgumentAction.html#HELP
Attribute
Constant
PUBLIC
Display the help message and exit.
-
orionis.console.enums.ArgumentAction.VERSION
orionis.console.enums.ArgumentAction.html#VERSION
Attribute
Constant
PUBLIC
Display version information and exit.
-
orionis.console.enums.SchedulerEvent
orionis.console.enums.SchedulerEvent.html
Class
Class
PUBLIC
Define scheduler-related event types.
-
orionis.console.enums.SchedulerEvent.STARTED
orionis.console.enums.SchedulerEvent.html#STARTED
Attribute
Constant
PUBLIC
Event type for when the scheduler starts.
-
orionis.console.enums.SchedulerEvent.SHUTDOWN
orionis.console.enums.SchedulerEvent.html#SHUTDOWN
Attribute
Constant
PUBLIC
Event type for when the scheduler shuts down.
-
orionis.console.enums.SchedulerEvent.PAUSED
orionis.console.enums.SchedulerEvent.html#PAUSED
Attribute
Constant
PUBLIC
Event type for when the scheduler is paused.
-
orionis.console.enums.SchedulerEvent.RESUMED
orionis.console.enums.SchedulerEvent.html#RESUMED
Attribute
Constant
PUBLIC
Event type for when the scheduler resumes.
-
orionis.console.enums.TaskEvent
orionis.console.enums.TaskEvent.html
Class
Class
PUBLIC
Define task-related event types for the scheduler.
-
orionis.console.enums.TaskEvent.ADDED
orionis.console.enums.TaskEvent.html#ADDED
Attribute
Constant
PUBLIC
Event type for when a task is added.
-
orionis.console.enums.TaskEvent.REMOVED
orionis.console.enums.TaskEvent.html#REMOVED
Attribute
Constant
PUBLIC
Event type for when a task is removed.
-
orionis.console.enums.TaskEvent.MODIFIED
orionis.console.enums.TaskEvent.html#MODIFIED
Attribute
Constant
PUBLIC
Event type for when a task is modified.
-
orionis.console.enums.TaskEvent.EXECUTED
orionis.console.enums.TaskEvent.html#EXECUTED
Attribute
Constant
PUBLIC
Event type for when a task is executed.
-
orionis.console.enums.TaskEvent.ERROR
orionis.console.enums.TaskEvent.html#ERROR
Attribute
Constant
PUBLIC
Event type for when a task encounters an error.
-
orionis.console.enums.TaskEvent.MISSED
orionis.console.enums.TaskEvent.html#MISSED
Attribute
Constant
PUBLIC
Event type for when a task is missed.
-
orionis.console.enums.TaskEvent.SUBMITTED
orionis.console.enums.TaskEvent.html#SUBMITTED
Attribute
Constant
PUBLIC
Event type for when a task is submitted.
-
orionis.console.enums.TaskEvent.MAX_INSTANCES
orionis.console.enums.TaskEvent.html#MAX_INSTANCES
Attribute
Constant
PUBLIC
Event type for when a task reaches max instances.
-
orionis.console.enums.ScheduleStates
orionis.console.enums.ScheduleStates.html
Class
Class
PUBLIC
Represent the possible states of a schedule.
-
orionis.console.enums.ScheduleStates.STOPPED
orionis.console.enums.ScheduleStates.html#STOPPED
Attribute
Constant
PUBLIC
Indicates the schedule is stopped.
-
orionis.console.enums.ScheduleStates.RUNNING
orionis.console.enums.ScheduleStates.html#RUNNING
Attribute
Constant
PUBLIC
Indicates the schedule is running.
-
orionis.console.enums.ScheduleStates.PAUSED
orionis.console.enums.ScheduleStates.html#PAUSED
Attribute
Constant
PUBLIC
Indicates the schedule is paused.
-
orionis.console.enums.ANSIColors
orionis.console.enums.ANSIColors.html
Class
Class
PUBLIC
Define ANSI escape codes for styling terminal text and backgrounds.
-
orionis.console.enums.ANSIColors.DEFAULT
orionis.console.enums.ANSIColors.html#DEFAULT
Attribute
Constant
PUBLIC
Reset all colors and styles to default.
-
orionis.console.enums.ANSIColors.BG_INFO
orionis.console.enums.ANSIColors.html#BG_INFO
Attribute
Constant
PUBLIC
Background color for informational messages.
-
orionis.console.enums.ANSIColors.BG_ERROR
orionis.console.enums.ANSIColors.html#BG_ERROR
Attribute
Constant
PUBLIC
Background color for error messages.
-
orionis.console.enums.ANSIColors.BG_FAIL
orionis.console.enums.ANSIColors.html#BG_FAIL
Attribute
Constant
PUBLIC
Background color for failure messages.
-
orionis.console.enums.ANSIColors.BG_WARNING
orionis.console.enums.ANSIColors.html#BG_WARNING
Attribute
Constant
PUBLIC
Background color for warning messages.
-
orionis.console.enums.ANSIColors.BG_SUCCESS
orionis.console.enums.ANSIColors.html#BG_SUCCESS
Attribute
Constant
PUBLIC
Background color for success messages.
-
orionis.console.enums.ANSIColors.TEXT_INFO
orionis.console.enums.ANSIColors.html#TEXT_INFO
Attribute
Constant
PUBLIC
Foreground color for informational messages.
-
orionis.console.enums.ANSIColors.TEXT_ERROR
orionis.console.enums.ANSIColors.html#TEXT_ERROR
Attribute
Constant
PUBLIC
Foreground color for error messages.
-
orionis.console.enums.ANSIColors.TEXT_WARNING
orionis.console.enums.ANSIColors.html#TEXT_WARNING
Attribute
Constant
PUBLIC
Foreground color for warning messages.
-
orionis.console.enums.ANSIColors.TEXT_SUCCESS
orionis.console.enums.ANSIColors.html#TEXT_SUCCESS
Attribute
Constant
PUBLIC
Foreground color for success messages.
-
orionis.console.enums.ANSIColors.TEXT_WHITE
orionis.console.enums.ANSIColors.html#TEXT_WHITE
Attribute
Constant
PUBLIC
Foreground color for white text.
-
orionis.console.enums.ANSIColors.TEXT_MUTED
orionis.console.enums.ANSIColors.html#TEXT_MUTED
Attribute
Constant
PUBLIC
Foreground color for muted (gray) text.
-
orionis.console.enums.ANSIColors.TEXT_BOLD_INFO
orionis.console.enums.ANSIColors.html#TEXT_BOLD_INFO
Attribute
Constant
PUBLIC
Bold foreground color for informational messages.
-
orionis.console.enums.ANSIColors.TEXT_BOLD_ERROR
orionis.console.enums.ANSIColors.html#TEXT_BOLD_ERROR
Attribute
Constant
PUBLIC
Bold foreground color for error messages.
-
orionis.console.enums.ANSIColors.TEXT_BOLD_WARNING
orionis.console.enums.ANSIColors.html#TEXT_BOLD_WARNING
Attribute
Constant
PUBLIC
Bold foreground color for warning messages.
-
orionis.console.enums.ANSIColors.TEXT_BOLD_SUCCESS
orionis.console.enums.ANSIColors.html#TEXT_BOLD_SUCCESS
Attribute
Constant
PUBLIC
Bold foreground color for success messages.
-
orionis.console.enums.ANSIColors.TEXT_BOLD_WHITE
orionis.console.enums.ANSIColors.html#TEXT_BOLD_WHITE
Attribute
Constant
PUBLIC
Bold foreground color for white text.
-
orionis.console.enums.ANSIColors.TEXT_BOLD_MUTED
orionis.console.enums.ANSIColors.html#TEXT_BOLD_MUTED
Attribute
Constant
PUBLIC
Bold foreground color for muted (gray) text.
-
orionis.console.enums.ANSIColors.TEXT_BOLD
orionis.console.enums.ANSIColors.html#TEXT_BOLD
Attribute
Constant
PUBLIC
Bold text style.
-
orionis.console.enums.ANSIColors.TEXT_STYLE_UNDERLINE
orionis.console.enums.ANSIColors.html#TEXT_STYLE_UNDERLINE
Attribute
Constant
PUBLIC
Underlined text style.
-
orionis.console.enums.ANSIColors.CYAN
orionis.console.enums.ANSIColors.html#CYAN
Attribute
Constant
PUBLIC
Foreground color for cyan text.
-
orionis.console.enums.ANSIColors.DIM
orionis.console.enums.ANSIColors.html#DIM
Attribute
Constant
PUBLIC
Dimmed foreground text style.
-
orionis.console.enums.ANSIColors.MAGENTA
orionis.console.enums.ANSIColors.html#MAGENTA
Attribute
Constant
PUBLIC
Foreground color for magenta text.
-
orionis.console.enums.ANSIColors.ITALIC
orionis.console.enums.ANSIColors.html#ITALIC
Attribute
Constant
PUBLIC
Italicized foreground text style.
-
orionis.console.fluent.Command
orionis.console.fluent.Command.html
Class
Class
PUBLIC
Build console command registrations through a fluent interface.
-
orionis.console.fluent.Command.__init__
orionis.console.fluent.Command.html#__init__
Function
Method
PUBLIC
Initialize Command instance with signature, concrete class, and method.
-
orionis.console.fluent.Command.__signature
orionis.console.fluent.Command.html#__signature
Attribute
Instance Variable
PUBLIC
Command signature for CLI invocation.
-
orionis.console.fluent.Command.__concrete
orionis.console.fluent.Command.html#__concrete
Attribute
Instance Variable
PUBLIC
Class implementing command logic.
-
orionis.console.fluent.Command.__method
orionis.console.fluent.Command.html#__method
Attribute
Instance Variable
PUBLIC
Method name to execute in concrete class.
-
orionis.console.fluent.Command.__timestamp
orionis.console.fluent.Command.html#__timestamp
Attribute
Instance Variable
PUBLIC
Enable timestamp display by default.
-
orionis.console.fluent.Command.__description
orionis.console.fluent.Command.html#__description
Attribute
Instance Variable
PUBLIC
Set default description.
-
orionis.console.fluent.Command.__arguments
orionis.console.fluent.Command.html#__arguments
Attribute
Instance Variable
PUBLIC
Initialize empty arguments list.
-
orionis.console.fluent.Command.timestamp
orionis.console.fluent.Command.html#timestamp
Function
Method
PUBLIC
Configure timestamp display for command output.
-
orionis.console.fluent.Command.description
orionis.console.fluent.Command.html#description
Function
Method
PUBLIC
Set description for the command.
-
orionis.console.fluent.Command.arguments
orionis.console.fluent.Command.html#arguments
Function
Method
PUBLIC
Set CLI arguments for the command.
-
orionis.console.fluent.Command.get
orionis.console.fluent.Command.html#get
Function
Method
PUBLIC
Retrieve configured Command entity.
-
orionis.console.fluent.Task
orionis.console.fluent.Task.html
Class
Class
PUBLIC
Configure scheduled command execution with fluent scheduling options.
-
orionis.console.fluent.Task._ERROR_MSG_INVALID_INTERVAL
orionis.console.fluent.Task.html#_ERROR_MSG_INVALID_INTERVAL
Attribute
Constant
PUBLIC
Interval value must be a positive
integer..
-
orionis.console.fluent.Task._ERROR_MSG_INVALID_MINUTE
orionis.console.fluent.Task.html#_ERROR_MSG_INVALID_MINUTE
Attribute
Constant
PUBLIC
Minute must be between 0 and 59..
-
orionis.console.fluent.Task._ERROR_MSG_INVALID_SECOND
orionis.console.fluent.Task.html#_ERROR_MSG_INVALID_SECOND
Attribute
Constant
PUBLIC
Second must be between 0 and 59..
-
orionis.console.fluent.Task._ERROR_MSG_INVALID_HOUR
orionis.console.fluent.Task.html#_ERROR_MSG_INVALID_HOUR
Attribute
Constant
PUBLIC
Hour must be between 0 and 23..
-
orionis.console.fluent.Task._LISTENER_METHODS_MAP
orionis.console.fluent.Task.html#_LISTENER_METHODS_MAP
Attribute
Constant
PUBLIC
Map event labels to their listener methods.
-
orionis.console.fluent.Task.__init__
orionis.console.fluent.Task.html#__init__
Function
Method
PUBLIC
Initialize the Task instance.
-
orionis.console.fluent.Task.__default_tz
orionis.console.fluent.Task.html#__default_tz
Attribute
Instance Variable
PUBLIC
Initialize the default timezone for the event using DateTime utility.
-
orionis.console.fluent.Task.__signature
orionis.console.fluent.Task.html#__signature
Attribute
Instance Variable
PUBLIC
Unique identifier for the task. Must be a non-empty string.
-
orionis.console.fluent.Task.__args
orionis.console.fluent.Task.html#__args
Attribute
Instance Variable
PUBLIC
List of arguments for the task. Defaults to an empty list if None.
-
orionis.console.fluent.Task.__kwargs
orionis.console.fluent.Task.html#__kwargs
Attribute
Instance Variable
PUBLIC
Value supplied for kwargs.
-
orionis.console.fluent.Task.__purpose
orionis.console.fluent.Task.html#__purpose
Attribute
Instance Variable
PUBLIC
Human-readable description or purpose of the task.
-
orionis.console.fluent.Task.__random_delay
orionis.console.fluent.Task.html#__random_delay
Attribute
Instance Variable
PUBLIC
Initialize the random delay attribute (in seconds) as None.
-
orionis.console.fluent.Task.__start_date
orionis.console.fluent.Task.html#__start_date
Attribute
Instance Variable
PUBLIC
Initialize the start date for the task as None.
-
orionis.console.fluent.Task.__end_date
orionis.console.fluent.Task.html#__end_date
Attribute
Instance Variable
PUBLIC
Initialize the end date for the task as None.
-
orionis.console.fluent.Task.__trigger
orionis.console.fluent.Task.html#__trigger
Attribute
Instance Variable
PUBLIC
Initialize the trigger for the task as None.
-
orionis.console.fluent.Task.__allows_jitter
orionis.console.fluent.Task.html#__allows_jitter
Attribute
Instance Variable
PUBLIC
Whether the selected schedule permits randomized delays.
-
orionis.console.fluent.Task.__details
orionis.console.fluent.Task.html#__details
Attribute
Instance Variable
PUBLIC
Initialize the details for the task as None.
-
orionis.console.fluent.Task.__listeners
orionis.console.fluent.Task.html#__listeners
Attribute
Instance Variable
PUBLIC
Initialize list to hold task event listeners.
-
orionis.console.fluent.Task.__max_instances
orionis.console.fluent.Task.html#__max_instances
Attribute
Instance Variable
PUBLIC
Initialize the maximum instances attribute as 1.
-
orionis.console.fluent.Task.__misfire_grace_time
orionis.console.fluent.Task.html#__misfire_grace_time
Attribute
Instance Variable
PUBLIC
Initialize the misfire grace time attribute as None.
-
orionis.console.fluent.Task.__coalesce
orionis.console.fluent.Task.html#__coalesce
Attribute
Instance Variable
PUBLIC
Initialize the coalesce attribute as None.
-
orionis.console.fluent.Task.__datetime
orionis.console.fluent.Task.html#__datetime
Function
Method
PUBLIC
Create a datetime instance from individual date and time components.
-
orionis.console.fluent.Task.__setTrigger
orionis.console.fluent.Task.html#__setTrigger
Function
Method
PUBLIC
Select a trigger and retain its delay policy.
-
orionis.console.fluent.Task.entity
orionis.console.fluent.Task.html#entity
Function
Method
PUBLIC
Create and return a TaskEntity instance from the current Task.
-
orionis.console.fluent.Task.coalesce
orionis.console.fluent.Task.html#coalesce
Function
Method
PUBLIC
Set the coalesce behavior for missed task executions.
-
orionis.console.fluent.Task.misfireGraceTime
orionis.console.fluent.Task.html#misfireGraceTime
Function
Method
PUBLIC
Set the misfire grace time in seconds.
-
orionis.console.fluent.Task.purpose
orionis.console.fluent.Task.html#purpose
Function
Method
PUBLIC
Set the purpose or description for the scheduled command.
-
orionis.console.fluent.Task.startDate
orionis.console.fluent.Task.html#startDate
Function
Method
PUBLIC
Set the start date for task execution.
-
orionis.console.fluent.Task.endDate
orionis.console.fluent.Task.html#endDate
Function
Method
PUBLIC
Set the end date for task execution.
-
orionis.console.fluent.Task.randomDelay
orionis.console.fluent.Task.html#randomDelay
Function
Method
PUBLIC
Configure a random delay before task execution.
-
orionis.console.fluent.Task.maxInstances
orionis.console.fluent.Task.html#maxInstances
Function
Method
PUBLIC
Set the maximum number of concurrent task instances.
-
orionis.console.fluent.Task.on
orionis.console.fluent.Task.html#on
Function
Method
PUBLIC
Register a callback for a specific task event.
-
orionis.console.fluent.Task.registerListener
orionis.console.fluent.Task.html#registerListener
Function
Method
PUBLIC
Register a task listener for task events.
-
orionis.console.fluent.Task.onceAt
orionis.console.fluent.Task.html#onceAt
Function
Method
PUBLIC
Schedule the task to execute once at a specific date and time.
-
orionis.console.fluent.Task.everySeconds
orionis.console.fluent.Task.html#everySeconds
Function
Method
PUBLIC
Schedule the task to run at fixed intervals in seconds.
-
orionis.console.fluent.Task.everyFiveSeconds
orionis.console.fluent.Task.html#everyFiveSeconds
Function
Method
PUBLIC
Schedule the task to run every five seconds.
-
orionis.console.fluent.Task.everyTenSeconds
orionis.console.fluent.Task.html#everyTenSeconds
Function
Method
PUBLIC
Schedule the task to run every ten seconds.
-
orionis.console.fluent.Task.everyFifteenSeconds
orionis.console.fluent.Task.html#everyFifteenSeconds
Function
Method
PUBLIC
Schedule the task to run every fifteen seconds.
-
orionis.console.fluent.Task.everyTwentySeconds
orionis.console.fluent.Task.html#everyTwentySeconds
Function
Method
PUBLIC
Schedule the task to run every twenty seconds.
-
orionis.console.fluent.Task.everyTwentyFiveSeconds
orionis.console.fluent.Task.html#everyTwentyFiveSeconds
Function
Method
PUBLIC
Schedule the task to run every twenty-five seconds.
-
orionis.console.fluent.Task.everyThirtySeconds
orionis.console.fluent.Task.html#everyThirtySeconds
Function
Method
PUBLIC
Schedule the task to run every thirty seconds.
-
orionis.console.fluent.Task.everyThirtyFiveSeconds
orionis.console.fluent.Task.html#everyThirtyFiveSeconds
Function
Method
PUBLIC
Schedule the task to run every thirty-five seconds.
-
orionis.console.fluent.Task.everyFortySeconds
orionis.console.fluent.Task.html#everyFortySeconds
Function
Method
PUBLIC
Schedule the task to run every forty seconds.
-
orionis.console.fluent.Task.everyFortyFiveSeconds
orionis.console.fluent.Task.html#everyFortyFiveSeconds
Function
Method
PUBLIC
Schedule the task to run every forty-five seconds.
-
orionis.console.fluent.Task.everyFiftySeconds
orionis.console.fluent.Task.html#everyFiftySeconds
Function
Method
PUBLIC
Schedule the task to run every fifty seconds.
-
orionis.console.fluent.Task.everyFiftyFiveSeconds
orionis.console.fluent.Task.html#everyFiftyFiveSeconds
Function
Method
PUBLIC
Schedule the task to run every fifty-five seconds.
-
orionis.console.fluent.Task.everyMinutes
orionis.console.fluent.Task.html#everyMinutes
Function
Method
PUBLIC
Schedule the task to run at fixed intervals in minutes.
-
orionis.console.fluent.Task.everyMinuteAt
orionis.console.fluent.Task.html#everyMinuteAt
Function
Method
PUBLIC
Schedule the task to run every minute at a specific second.
-
orionis.console.fluent.Task.everyMinutesAt
orionis.console.fluent.Task.html#everyMinutesAt
Function
Method
PUBLIC
Schedule to run at a specific second of every N-minute interval.
-
orionis.console.fluent.Task.everyFiveMinutes
orionis.console.fluent.Task.html#everyFiveMinutes
Function
Method
PUBLIC
Schedule the task to run every five minutes.
-
orionis.console.fluent.Task.everyFiveMinutesAt
orionis.console.fluent.Task.html#everyFiveMinutesAt
Function
Method
PUBLIC
Schedule the task to run every five minutes at a specific second.
-
orionis.console.fluent.Task.everyTenMinutes
orionis.console.fluent.Task.html#everyTenMinutes
Function
Method
PUBLIC
Schedule to run every ten minutes.
-
orionis.console.fluent.Task.everyTenMinutesAt
orionis.console.fluent.Task.html#everyTenMinutesAt
Function
Method
PUBLIC
Schedule to run every ten minutes at a specific second.
-
orionis.console.fluent.Task.everyFifteenMinutes
orionis.console.fluent.Task.html#everyFifteenMinutes
Function
Method
PUBLIC
Schedule the task to run every fifteen minutes.
-
orionis.console.fluent.Task.everyFifteenMinutesAt
orionis.console.fluent.Task.html#everyFifteenMinutesAt
Function
Method
PUBLIC
Schedule to run every fifteen minutes at a specific second.
-
orionis.console.fluent.Task.everyTwentyMinutes
orionis.console.fluent.Task.html#everyTwentyMinutes
Function
Method
PUBLIC
Schedule to run every twenty minutes.
-
orionis.console.fluent.Task.everyTwentyMinutesAt
orionis.console.fluent.Task.html#everyTwentyMinutesAt
Function
Method
PUBLIC
Schedule to run every twenty minutes at a specific second.
-
orionis.console.fluent.Task.everyTwentyFiveMinutes
orionis.console.fluent.Task.html#everyTwentyFiveMinutes
Function
Method
PUBLIC
Schedule the task to run every twenty-five minutes.
-
orionis.console.fluent.Task.everyTwentyFiveMinutesAt
orionis.console.fluent.Task.html#everyTwentyFiveMinutesAt
Function
Method
PUBLIC
Schedule to run every twenty-five minutes at a specific second.
-
orionis.console.fluent.Task.everyThirtyMinutes
orionis.console.fluent.Task.html#everyThirtyMinutes
Function
Method
PUBLIC
Schedule the task to run every thirty minutes.
-
orionis.console.fluent.Task.everyThirtyMinutesAt
orionis.console.fluent.Task.html#everyThirtyMinutesAt
Function
Method
PUBLIC
Schedule to run every thirty minutes at a specific second.
-
orionis.console.fluent.Task.everyThirtyFiveMinutes
orionis.console.fluent.Task.html#everyThirtyFiveMinutes
Function
Method
PUBLIC
Schedule to run every thirty-five minutes.
-
orionis.console.fluent.Task.everyThirtyFiveMinutesAt
orionis.console.fluent.Task.html#everyThirtyFiveMinutesAt
Function
Method
PUBLIC
Schedule to run every 35 minutes at a specific second.
-
orionis.console.fluent.Task.everyFortyMinutes
orionis.console.fluent.Task.html#everyFortyMinutes
Function
Method
PUBLIC
Schedule the task to run every forty minutes.
-
orionis.console.fluent.Task.everyFortyMinutesAt
orionis.console.fluent.Task.html#everyFortyMinutesAt
Function
Method
PUBLIC
Schedule to run every forty minutes at a specific second.
-
orionis.console.fluent.Task.everyFortyFiveMinutes
orionis.console.fluent.Task.html#everyFortyFiveMinutes
Function
Method
PUBLIC
Schedule the task to run every forty-five minutes.
-
orionis.console.fluent.Task.everyFortyFiveMinutesAt
orionis.console.fluent.Task.html#everyFortyFiveMinutesAt
Function
Method
PUBLIC
Schedule the task to run every forty-five minutes at a specific second.
-
orionis.console.fluent.Task.everyFiftyMinutes
orionis.console.fluent.Task.html#everyFiftyMinutes
Function
Method
PUBLIC
Schedule to run every fifty minutes.
-
orionis.console.fluent.Task.everyFiftyMinutesAt
orionis.console.fluent.Task.html#everyFiftyMinutesAt
Function
Method
PUBLIC
Schedule to run every fifty minutes at a specific second.
-
orionis.console.fluent.Task.everyFiftyFiveMinutes
orionis.console.fluent.Task.html#everyFiftyFiveMinutes
Function
Method
PUBLIC
Schedule the task to run every fifty-five minutes.
-
orionis.console.fluent.Task.everyFiftyFiveMinutesAt
orionis.console.fluent.Task.html#everyFiftyFiveMinutesAt
Function
Method
PUBLIC
Schedule the task to run every fifty-five minutes at a specific second.
-
orionis.console.fluent.Task.hourly
orionis.console.fluent.Task.html#hourly
Function
Method
PUBLIC
Schedule the task to run every hour.
-
orionis.console.fluent.Task.hourlyAt
orionis.console.fluent.Task.html#hourlyAt
Function
Method
PUBLIC
Schedule the task to run every hour at a specific minute and second.
-
orionis.console.fluent.Task.everyOddHours
orionis.console.fluent.Task.html#everyOddHours
Function
Method
PUBLIC
Schedule the task to run at every odd hour of the day.
-
orionis.console.fluent.Task.everyEvenHours
orionis.console.fluent.Task.html#everyEvenHours
Function
Method
PUBLIC
Schedule the task to run at every even hour of the day.
-
orionis.console.fluent.Task.everyHours
orionis.console.fluent.Task.html#everyHours
Function
Method
PUBLIC
Schedule the task to run at fixed intervals in hours.
-
orionis.console.fluent.Task.everyHoursAt
orionis.console.fluent.Task.html#everyHoursAt
Function
Method
PUBLIC
Schedule the task to run every N hours at a specific minute and second.
-
orionis.console.fluent.Task.everyTwoHours
orionis.console.fluent.Task.html#everyTwoHours
Function
Method
PUBLIC
Schedule the task to run every two hours.
-
orionis.console.fluent.Task.everyTwoHoursAt
orionis.console.fluent.Task.html#everyTwoHoursAt
Function
Method
PUBLIC
Schedule to run every two hours at a specific minute and second.
-
orionis.console.fluent.Task.everyThreeHours
orionis.console.fluent.Task.html#everyThreeHours
Function
Method
PUBLIC
Schedule the task to run every three hours.
-
orionis.console.fluent.Task.everyThreeHoursAt
orionis.console.fluent.Task.html#everyThreeHoursAt
Function
Method
PUBLIC
Schedule to run every three hours at a specific minute and second.
-
orionis.console.fluent.Task.everyFourHours
orionis.console.fluent.Task.html#everyFourHours
Function
Method
PUBLIC
Schedule the task to run every four hours.
-
orionis.console.fluent.Task.everyFourHoursAt
orionis.console.fluent.Task.html#everyFourHoursAt
Function
Method
PUBLIC
Schedule to run every four hours at a specific minute and second.
-
orionis.console.fluent.Task.everyFiveHours
orionis.console.fluent.Task.html#everyFiveHours
Function
Method
PUBLIC
Schedule the task to run every five hours.
-
orionis.console.fluent.Task.everyFiveHoursAt
orionis.console.fluent.Task.html#everyFiveHoursAt
Function
Method
PUBLIC
Schedule to run every five hours at a specific minute and second.
-
orionis.console.fluent.Task.everySixHours
orionis.console.fluent.Task.html#everySixHours
Function
Method
PUBLIC
Schedule to run every six hours.
-
orionis.console.fluent.Task.everySixHoursAt
orionis.console.fluent.Task.html#everySixHoursAt
Function
Method
PUBLIC
Schedule to run every six hours at a specific minute and second.
-
orionis.console.fluent.Task.everySevenHours
orionis.console.fluent.Task.html#everySevenHours
Function
Method
PUBLIC
Schedule to run every seven hours.
-
orionis.console.fluent.Task.everySevenHoursAt
orionis.console.fluent.Task.html#everySevenHoursAt
Function
Method
PUBLIC
Schedule to run every seven hours at a specific minute and second.
-
orionis.console.fluent.Task.everyEightHours
orionis.console.fluent.Task.html#everyEightHours
Function
Method
PUBLIC
Schedule to run every eight hours.
-
orionis.console.fluent.Task.everyEightHoursAt
orionis.console.fluent.Task.html#everyEightHoursAt
Function
Method
PUBLIC
Schedule to run every eight hours at a specific minute and second.
-
orionis.console.fluent.Task.everyNineHours
orionis.console.fluent.Task.html#everyNineHours
Function
Method
PUBLIC
Schedule to run every nine hours.
-
orionis.console.fluent.Task.everyNineHoursAt
orionis.console.fluent.Task.html#everyNineHoursAt
Function
Method
PUBLIC
Schedule to run every nine hours at a specific minute and second.
-
orionis.console.fluent.Task.everyTenHours
orionis.console.fluent.Task.html#everyTenHours
Function
Method
PUBLIC
Schedule to run every ten hours.
-
orionis.console.fluent.Task.everyTenHoursAt
orionis.console.fluent.Task.html#everyTenHoursAt
Function
Method
PUBLIC
Schedule to run every ten hours at a specific minute and second.
-
orionis.console.fluent.Task.everyElevenHours
orionis.console.fluent.Task.html#everyElevenHours
Function
Method
PUBLIC
Schedule to run every eleven hours.
-
orionis.console.fluent.Task.everyElevenHoursAt
orionis.console.fluent.Task.html#everyElevenHoursAt
Function
Method
PUBLIC
Schedule to run every eleven hours at a specific minute and second.
-
orionis.console.fluent.Task.everyTwelveHours
orionis.console.fluent.Task.html#everyTwelveHours
Function
Method
PUBLIC
Schedule to run every twelve hours.
-
orionis.console.fluent.Task.everyTwelveHoursAt
orionis.console.fluent.Task.html#everyTwelveHoursAt
Function
Method
PUBLIC
Schedule to run every twelve hours at a specific minute and second.
-
orionis.console.fluent.Task.daily
orionis.console.fluent.Task.html#daily
Function
Method
PUBLIC
Schedule the task to run once per day.
-
orionis.console.fluent.Task.dailyAt
orionis.console.fluent.Task.html#dailyAt
Function
Method
PUBLIC
Schedule the task to run daily at a specific hour, minute, and second.
-
orionis.console.fluent.Task.everyDays
orionis.console.fluent.Task.html#everyDays
Function
Method
PUBLIC
Schedule to run at fixed intervals measured in days.
-
orionis.console.fluent.Task.everyDaysAt
orionis.console.fluent.Task.html#everyDaysAt
Function
Method
PUBLIC
Schedule to run every N days at a specific hour, minute, and second.
-
orionis.console.fluent.Task.everyTwoDays
orionis.console.fluent.Task.html#everyTwoDays
Function
Method
PUBLIC
Schedule to run every two days.
-
orionis.console.fluent.Task.everyTwoDaysAt
orionis.console.fluent.Task.html#everyTwoDaysAt
Function
Method
PUBLIC
Schedule to run every two days at a specific hour, minute, and second.
-
orionis.console.fluent.Task.everyThreeDays
orionis.console.fluent.Task.html#everyThreeDays
Function
Method
PUBLIC
Schedule to run every three days.
-
orionis.console.fluent.Task.everyThreeDaysAt
orionis.console.fluent.Task.html#everyThreeDaysAt
Function
Method
PUBLIC
Schedule to run every three days at a specific hour, minute, and second.
-
orionis.console.fluent.Task.everyFourDays
orionis.console.fluent.Task.html#everyFourDays
Function
Method
PUBLIC
Schedule to run every four days.
-
orionis.console.fluent.Task.everyFourDaysAt
orionis.console.fluent.Task.html#everyFourDaysAt
Function
Method
PUBLIC
Schedule to run every four days at a specific hour, minute, and second.
-
orionis.console.fluent.Task.everyFiveDays
orionis.console.fluent.Task.html#everyFiveDays
Function
Method
PUBLIC
Schedule to run every five days.
-
orionis.console.fluent.Task.everyFiveDaysAt
orionis.console.fluent.Task.html#everyFiveDaysAt
Function
Method
PUBLIC
Schedule event to run every five days at a specific hour, minute, and second.
-
orionis.console.fluent.Task.everySixDays
orionis.console.fluent.Task.html#everySixDays
Function
Method
PUBLIC
Schedule the task to run every six days.
-
orionis.console.fluent.Task.everySixDaysAt
orionis.console.fluent.Task.html#everySixDaysAt
Function
Method
PUBLIC
Schedule event to run every six days at a specific hour, minute, and second.
-
orionis.console.fluent.Task.everySevenDays
orionis.console.fluent.Task.html#everySevenDays
Function
Method
PUBLIC
Schedule the task to run every seven days.
-
orionis.console.fluent.Task.everySevenDaysAt
orionis.console.fluent.Task.html#everySevenDaysAt
Function
Method
PUBLIC
Schedule event to run every seven days at a specific hour, minute, and second.
-
orionis.console.fluent.Task.everyMondayAt
orionis.console.fluent.Task.html#everyMondayAt
Function
Method
PUBLIC
Schedule event to run every Monday at a specific hour, minute, and second.
-
orionis.console.fluent.Task.everyTuesdayAt
orionis.console.fluent.Task.html#everyTuesdayAt
Function
Method
PUBLIC
Schedule event to run every Tuesday at a specific hour, minute, and second.
-
orionis.console.fluent.Task.everyWednesdayAt
orionis.console.fluent.Task.html#everyWednesdayAt
Function
Method
PUBLIC
Schedule event to run every Wednesday at a specific hour, minute, and second.
-
orionis.console.fluent.Task.everyThursdayAt
orionis.console.fluent.Task.html#everyThursdayAt
Function
Method
PUBLIC
Schedule event to run every Thursday at a specific hour, minute, and second.
-
orionis.console.fluent.Task.everyFridayAt
orionis.console.fluent.Task.html#everyFridayAt
Function
Method
PUBLIC
Schedule the task to run every Friday at a specific hour, minute, and second.
-
orionis.console.fluent.Task.everySaturdayAt
orionis.console.fluent.Task.html#everySaturdayAt
Function
Method
PUBLIC
Schedule the task to run every Saturday at a specific hour, minute, and second.
-
orionis.console.fluent.Task.everySundayAt
orionis.console.fluent.Task.html#everySundayAt
Function
Method
PUBLIC
Schedule the task to run every Sunday at a specific hour, minute, and second.
-
orionis.console.fluent.Task.weekly
orionis.console.fluent.Task.html#weekly
Function
Method
PUBLIC
Schedule the task to run every week.
-
orionis.console.fluent.Task.everyWeeks
orionis.console.fluent.Task.html#everyWeeks
Function
Method
PUBLIC
Configure the task to run at fixed intervals measured in weeks.
-
orionis.console.fluent.Task.every
orionis.console.fluent.Task.html#every
Function
Method
PUBLIC
Configure the task to run at a custom interval.
-
orionis.console.fluent.Task.cron
orionis.console.fluent.Task.html#cron
Function
Method
PUBLIC
Configure the task using a CRON-like expression.
-
orionis.console.fluent._EXPORTS
orionis.console.fluent.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.console.fluent.__getattr__
orionis.console.fluent.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.console.fluent.__dir__
orionis.console.fluent.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.console.kernel.KernelCLI
orionis.console.kernel.KernelCLI.html
Class
Class
PUBLIC
Bootstrap the console runtime and dispatch command invocations.
-
orionis.console.kernel.KernelCLI.__slots__
orionis.console.kernel.KernelCLI.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.console.kernel.KernelCLI.IGNORE_FLAGS
orionis.console.kernel.KernelCLI.html#IGNORE_FLAGS
Attribute
Constant
PUBLIC
Ignore flags used by KernelCLI.
-
orionis.console.kernel.KernelCLI._HELP_FLAGS
orionis.console.kernel.KernelCLI.html#_HELP_FLAGS
Attribute
Constant
PUBLIC
Help flags used by KernelCLI.
-
orionis.console.kernel.KernelCLI.boot
orionis.console.kernel.KernelCLI.html#boot
Function
Method
PUBLIC
Initialize the kernel CLI and register commands with the reactor.
-
orionis.console.kernel.KernelCLI.__reactor
orionis.console.kernel.KernelCLI.html#__reactor
Attribute
Instance Variable
PUBLIC
Create and assign the reactor instance using the application factory.
-
orionis.console.kernel.KernelCLI.handle
orionis.console.kernel.KernelCLI.html#handle
Function
Method
PUBLIC
Process and dispatch command line arguments to the appropriate handler.
-
orionis.console.output.contracts.http_request.IHTTPRequestPrinter
orionis.console.output.contracts.http_request.IHTTPRequestPrinter.html
Class
Class
PUBLIC
Define the contract for http request printer implementations.
-
orionis.console.output.contracts.http_request.IHTTPRequestPrinter.setEnabled
orionis.console.output.contracts.http_request.IHTTPRequestPrinter.html#setEnabled
Function
Method
PUBLIC
Set whether to enable or disable console output for HTTP requests.
-
orionis.console.output.contracts.http_request.IHTTPRequestPrinter.start
orionis.console.output.contracts.http_request.IHTTPRequestPrinter.html#start
Function
Method
PUBLIC
Start the background print worker.
-
orionis.console.output.contracts.http_request.IHTTPRequestPrinter.stop
orionis.console.output.contracts.http_request.IHTTPRequestPrinter.html#stop
Function
Method
PUBLIC
Drain remaining output and stop the background worker.
-
orionis.console.output.contracts.http_request.IHTTPRequestPrinter.startTimer
orionis.console.output.contracts.http_request.IHTTPRequestPrinter.html#startTimer
Function
Method
PUBLIC
Capture the current high-resolution timestamp for request timing.
-
orionis.console.output.contracts.http_request.IHTTPRequestPrinter.printRequest
orionis.console.output.contracts.http_request.IHTTPRequestPrinter.html#printRequest
Function
Method
PUBLIC
Print a formatted HTTP request line to stdout or queue.
-
orionis.console.output.http_request._RESET
orionis.console.output.http_request.html#_RESET
Attribute
Constant
PUBLIC
ANSI escape codes.
-
orionis.console.output.http_request._BOLD
orionis.console.output.http_request.html#_BOLD
Attribute
Constant
PUBLIC
\x1b[1m.
-
orionis.console.output.http_request._FG_BLACK
orionis.console.output.http_request.html#_FG_BLACK
Attribute
Constant
PUBLIC
Foreground.
-
orionis.console.output.http_request._FG_WHITE
orionis.console.output.http_request.html#_FG_WHITE
Attribute
Constant
PUBLIC
\x1b[37m.
-
orionis.console.output.http_request._FG_CYAN
orionis.console.output.http_request.html#_FG_CYAN
Attribute
Constant
PUBLIC
\x1b[36m.
-
orionis.console.output.http_request._FG_GREY
orionis.console.output.http_request.html#_FG_GREY
Attribute
Constant
PUBLIC
\x1b[90m.
-
orionis.console.output.http_request._BG_RED
orionis.console.output.http_request.html#_BG_RED
Attribute
Constant
PUBLIC
Background (standard).
-
orionis.console.output.http_request._BG_GREEN
orionis.console.output.http_request.html#_BG_GREEN
Attribute
Constant
PUBLIC
\x1b[42m.
-
orionis.console.output.http_request._BG_YELLOW
orionis.console.output.http_request.html#_BG_YELLOW
Attribute
Constant
PUBLIC
\x1b[43m.
-
orionis.console.output.http_request._BG_BLUE
orionis.console.output.http_request.html#_BG_BLUE
Attribute
Constant
PUBLIC
\x1b[44m.
-
orionis.console.output.http_request._BG_MAGENTA
orionis.console.output.http_request.html#_BG_MAGENTA
Attribute
Constant
PUBLIC
\x1b[45m.
-
orionis.console.output.http_request._BG_CYAN
orionis.console.output.http_request.html#_BG_CYAN
Attribute
Constant
PUBLIC
\x1b[46m.
-
orionis.console.output.http_request._BG_WHITE
orionis.console.output.http_request.html#_BG_WHITE
Attribute
Constant
PUBLIC
\x1b[47m.
-
orionis.console.output.http_request._BG_BRIGHT
orionis.console.output.http_request.html#_BG_BRIGHT
Attribute
Constant
PUBLIC
\x1b[100m.
-
orionis.console.output.http_request._BG_GREY37
orionis.console.output.http_request.html#_BG_GREY37
Attribute
Constant
PUBLIC
Background (256-colour approximations).
-
orionis.console.output.http_request._BG_GREY50
orionis.console.output.http_request.html#_BG_GREY50
Attribute
Constant
PUBLIC
\x1b[48;5;244m.
-
orionis.console.output.http_request._BG_GREY70
orionis.console.output.http_request.html#_BG_GREY70
Attribute
Constant
PUBLIC
\x1b[48;5;250m.
-
orionis.console.output.http_request.HTTPRequestPrinter
orionis.console.output.http_request.HTTPRequestPrinter.html
Class
Class
PUBLIC
Queue and display formatted HTTP request timing information.
-
orionis.console.output.http_request.HTTPRequestPrinter.HTTP_MIN_STATUS_CODE
orionis.console.output.http_request.HTTPRequestPrinter.html#HTTP_MIN_STATUS_CODE
Attribute
Constant
PUBLIC
Minimum valid HTTP status code.
-
orionis.console.output.http_request.HTTPRequestPrinter.HTTP_COLORS
orionis.console.output.http_request.HTTPRequestPrinter.html#HTTP_COLORS
Attribute
Constant
PUBLIC
(bg_ansi, fg_ansi) tuples for HTTP methods.
-
orionis.console.output.http_request.HTTPRequestPrinter.STATUS_COLORS
orionis.console.output.http_request.HTTPRequestPrinter.html#STATUS_COLORS
Attribute
Constant
PUBLIC
(bg_ansi, fg_ansi) tuples for HTTP status categories.
-
orionis.console.output.http_request.HTTPRequestPrinter.__init__
orionis.console.output.http_request.HTTPRequestPrinter.html#__init__
Function
Method
PUBLIC
Initialize the HTTPRequestPrinter instance.
-
orionis.console.output.http_request.HTTPRequestPrinter._total_width
orionis.console.output.http_request.HTTPRequestPrinter.html#_total_width
Attribute
Instance Variable
PUBLIC
Total width produced by max.
-
orionis.console.output.http_request.HTTPRequestPrinter.__status_icons
orionis.console.output.http_request.HTTPRequestPrinter.html#__status_icons
Attribute
Instance Variable
PUBLIC
Precompute status icons by HTTP code category.
-
orionis.console.output.http_request.HTTPRequestPrinter.__enabled
orionis.console.output.http_request.HTTPRequestPrinter.html#__enabled
Attribute
Instance Variable
PUBLIC
Enable HTTP request printing to console by default.
-
orionis.console.output.http_request.HTTPRequestPrinter.__queue
orionis.console.output.http_request.HTTPRequestPrinter.html#__queue
Attribute
Instance Variable
PUBLIC
Async queue and worker task (initialized by start()).
-
orionis.console.output.http_request.HTTPRequestPrinter.__worker_task
orionis.console.output.http_request.HTTPRequestPrinter.html#__worker_task
Attribute
Instance Variable
PUBLIC
Background task responsible for draining queued output.
-
orionis.console.output.http_request.HTTPRequestPrinter.__lifecycle_lock
orionis.console.output.http_request.HTTPRequestPrinter.html#__lifecycle_lock
Attribute
Instance Variable
PUBLIC
Serialize worker startup and shutdown.
-
orionis.console.output.http_request.HTTPRequestPrinter.__start_timer
orionis.console.output.http_request.HTTPRequestPrinter.html#__start_timer
Attribute
Instance Variable
PUBLIC
Context-local timestamp set by startTimer for each request.
-
orionis.console.output.http_request.HTTPRequestPrinter._write
orionis.console.output.http_request.HTTPRequestPrinter.html#_write
Attribute
Instance Variable
PUBLIC
LOAD_FAST vs sys.stdout LOAD_GLOBAL+LOAD_ATTR.
-
orionis.console.output.http_request.HTTPRequestPrinter._flush
orionis.console.output.http_request.HTTPRequestPrinter.html#_flush
Attribute
Instance Variable
PUBLIC
Flush obtained from sys.stdout.flush.
-
orionis.console.output.http_request.HTTPRequestPrinter.setEnabled
orionis.console.output.http_request.HTTPRequestPrinter.html#setEnabled
Function
Method
PUBLIC
Set whether to enable or disable console output for HTTP requests.
-
orionis.console.output.http_request.HTTPRequestPrinter.start
orionis.console.output.http_request.HTTPRequestPrinter.html#start
Function
Method
PUBLIC
Start the background print worker.
-
orionis.console.output.http_request.HTTPRequestPrinter.stop
orionis.console.output.http_request.HTTPRequestPrinter.html#stop
Function
Method
PUBLIC
Drain remaining output and stop the background worker.
-
orionis.console.output.http_request.HTTPRequestPrinter.__worker
orionis.console.output.http_request.HTTPRequestPrinter.html#__worker
Function
Method
PUBLIC
Write queued lines to stdout in the background.
-
orionis.console.output.http_request.HTTPRequestPrinter.startTimer
orionis.console.output.http_request.HTTPRequestPrinter.html#startTimer
Function
Method
PUBLIC
Capture the current high-resolution timestamp for request timing.
-
orionis.console.output.http_request.HTTPRequestPrinter.printRequest
orionis.console.output.http_request.HTTPRequestPrinter.html#printRequest
Function
Method
PUBLIC
Print a formatted HTTP request line to stdout or queue.
-
orionis.console.reactor_provider.ReactorProvider
orionis.console.reactor_provider.ReactorProvider.html
Class
Class
PUBLIC
Register reactor services in the application container.
-
orionis.console.reactor_provider.ReactorProvider.register
orionis.console.reactor_provider.ReactorProvider.html#register
Function
Method
PUBLIC
Register the reactor management service in the application container.
-
orionis.console.reactor_provider.ReactorProvider.boot
orionis.console.reactor_provider.ReactorProvider.html#boot
Function
Method
PUBLIC
Perform post-registration bootstrapping for the reactor provider.
-
orionis.console.tasks._backend._Executor
orionis.console.tasks._backend._Executor.html
Class
Class
PUBLIC
Expose the futures owned by the native asyncio executor.
-
orionis.console.tasks._backend._Executor.__init__
orionis.console.tasks._backend._Executor.html#__init__
Function
Method
PUBLIC
Initialize future tracking before native startup can fail.
-
orionis.console.tasks._backend._Executor._pending_futures
orionis.console.tasks._backend._Executor.html#_pending_futures
Attribute
Instance Variable
PUBLIC
Native job futures retained even if executor startup fails.
-
orionis.console.tasks._backend._Executor.pendingTasks
orionis.console.tasks._backend._Executor.html#pendingTasks
Function
Method
PUBLIC
Snapshot submitted futures before native shutdown clears its registry.
-
orionis.console.tasks._backend.SchedulerBackend
orionis.console.tasks._backend.SchedulerBackend.html
Class
Class
PUBLIC
Bridge native loop callbacks to the framework's awaited shutdown.
-
orionis.console.tasks._backend.SchedulerBackend.__init__
orionis.console.tasks._backend.SchedulerBackend.html#__init__
Function
Method
PUBLIC
Retain the native executor and its shutdown snapshot.
-
orionis.console.tasks._backend.SchedulerBackend.__executor
orionis.console.tasks._backend.SchedulerBackend.html#__executor
Attribute
Instance Variable
PUBLIC
Native executor whose futures must outlive cancellation requests.
-
orionis.console.tasks._backend.SchedulerBackend.__pending
orionis.console.tasks._backend.SchedulerBackend.html#__pending
Attribute
Instance Variable
PUBLIC
Job futures awaiting transfer to the framework's shutdown owner.
-
orionis.console.tasks._backend.SchedulerBackend._createDefaultExecutor
orionis.console.tasks._backend.SchedulerBackend.html#_createDefaultExecutor
Function
Method
PUBLIC
Create the executor through APScheduler's required extension hook.
-
orionis.console.tasks._backend.SchedulerBackend.takePending
orionis.console.tasks._backend.SchedulerBackend.html#takePending
Function
Method
PUBLIC
Transfer pending job cleanup to the framework shutdown owner.
-
orionis.console.tasks._backend.SchedulerBackend.shutdown
orionis.console.tasks._backend.SchedulerBackend.html#shutdown
Function
Method
PUBLIC
Finish native shutdown before returning to a waiting worker thread.
-
orionis.console.tasks._backend.SchedulerBackend.__shutdownOnLoop
orionis.console.tasks._backend.SchedulerBackend.html#__shutdownOnLoop
Function
Method
PUBLIC
Run shutdown on the owning loop and always retire its timer.
-
orionis.console.tasks._backend.SchedulerBackend._eventloop
orionis.console.tasks._backend.SchedulerBackend.html#_eventloop
Attribute
Instance Variable
PUBLIC
Retired owner loop after native shutdown, including failures.
-
orionis.console.tasks._backend.SchedulerBackend.abortStart
orionis.console.tasks._backend.SchedulerBackend.html#abortStart
Function
Method
PUBLIC
Release owned stores and executors after partial startup.
-
orionis.console.tasks.schedule._execute_scheduled_command
orionis.console.tasks.schedule.html#_execute_scheduled_command
Function
Function
PUBLIC
Execute a scheduled command through the Reactor facade.
-
orionis.console.tasks.schedule.Schedule
orionis.console.tasks.schedule.Schedule.html
Class
Class
PUBLIC
Register scheduled tasks and coordinate their scheduler integration.
-
orionis.console.tasks.schedule.Schedule._SCHEDULER_NOT_STARTED_ERROR
orionis.console.tasks.schedule.Schedule.html#_SCHEDULER_NOT_STARTED_ERROR
Attribute
Constant
PUBLIC
The Orionis task scheduler has not
been started..
-
orionis.console.tasks.schedule.Schedule.__init__
orionis.console.tasks.schedule.Schedule.html#__init__
Function
Method
PUBLIC
Initialize scheduler dependencies, task registries, and shutdown state.
-
orionis.console.tasks.schedule.Schedule.__reactor
orionis.console.tasks.schedule.Schedule.html#__reactor
Attribute
Instance Variable
PUBLIC
Reactor instance for command execution.
-
orionis.console.tasks.schedule.Schedule.__exception_handler
orionis.console.tasks.schedule.Schedule.html#__exception_handler
Attribute
Instance Variable
PUBLIC
Exception handler for managing errors.
-
orionis.console.tasks.schedule.Schedule.__stores
orionis.console.tasks.schedule.Schedule.html#__stores
Attribute
Instance Variable
PUBLIC
Schedule store for managing job stores.
-
orionis.console.tasks.schedule.Schedule.__config
orionis.console.tasks.schedule.Schedule.html#__config
Attribute
Instance Variable
PUBLIC
Validated configuration used to construct and operate the service.
-
orionis.console.tasks.schedule.Schedule.__available_command_signatures
orionis.console.tasks.schedule.Schedule.html#__available_command_signatures
Attribute
Instance Variable
PUBLIC
Available command signatures produced by set.
-
orionis.console.tasks.schedule.Schedule.__job_store
orionis.console.tasks.schedule.Schedule.html#__job_store
Attribute
Instance Variable
PUBLIC
Job store obtained from self.__config.store.
-
orionis.console.tasks.schedule.Schedule.__scheduler
orionis.console.tasks.schedule.Schedule.html#__scheduler
Attribute
Instance Variable
PUBLIC
Scheduler instance responsible for registering and running tasks.
-
orionis.console.tasks.schedule.Schedule.__scheduler_listeners
orionis.console.tasks.schedule.Schedule.html#__scheduler_listeners
Attribute
Instance Variable
PUBLIC
Callbacks subscribed to scheduler lifecycle events.
-
orionis.console.tasks.schedule.Schedule.__tasks_listeners
orionis.console.tasks.schedule.Schedule.html#__tasks_listeners
Attribute
Instance Variable
PUBLIC
Callbacks subscribed to scheduled-task events.
-
orionis.console.tasks.schedule.Schedule.__fluent_tasks
orionis.console.tasks.schedule.Schedule.html#__fluent_tasks
Attribute
Instance Variable
PUBLIC
Task declarations awaiting conversion to scheduler jobs.
-
orionis.console.tasks.schedule.Schedule.__tasks
orionis.console.tasks.schedule.Schedule.html#__tasks
Attribute
Instance Variable
PUBLIC
Tasks registered for scheduling or lifecycle management.
-
orionis.console.tasks.schedule.Schedule.__state
orionis.console.tasks.schedule.Schedule.html#__state
Attribute
Instance Variable
PUBLIC
State selected by the maintenance-mode command.
-
orionis.console.tasks.schedule.Schedule.__running_tasks
orionis.console.tasks.schedule.Schedule.html#__running_tasks
Attribute
Instance Variable
PUBLIC
Running tasks produced by set.
-
orionis.console.tasks.schedule.Schedule.__paused_tasks
orionis.console.tasks.schedule.Schedule.html#__paused_tasks
Attribute
Instance Variable
PUBLIC
Paused tasks produced by set.
-
orionis.console.tasks.schedule.Schedule.__removed_tasks
orionis.console.tasks.schedule.Schedule.html#__removed_tasks
Attribute
Instance Variable
PUBLIC
Removed tasks produced by set.
-
orionis.console.tasks.schedule.Schedule.__pending_listener_tasks
orionis.console.tasks.schedule.Schedule.html#__pending_listener_tasks
Attribute
Instance Variable
PUBLIC
Pending listener tasks produced by set.
-
orionis.console.tasks.schedule.Schedule.__shutdown_event
orionis.console.tasks.schedule.Schedule.html#__shutdown_event
Attribute
Instance Variable
PUBLIC
Notify callers when scheduler shutdown settles.
-
orionis.console.tasks.schedule.Schedule.__shutdown_error
orionis.console.tasks.schedule.Schedule.html#__shutdown_error
Attribute
Instance Variable
PUBLIC
Failure retained for the caller awaiting shutdown completion.
-
orionis.console.tasks.schedule.Schedule.__shutdown_task
orionis.console.tasks.schedule.Schedule.html#__shutdown_task
Attribute
Instance Variable
PUBLIC
Single shutdown operation owned by the current scheduler cycle.
-
orionis.console.tasks.schedule.Schedule.__boot_lock
orionis.console.tasks.schedule.Schedule.html#__boot_lock
Attribute
Instance Variable
PUBLIC
Serialize native scheduler creation and closure.
-
orionis.console.tasks.schedule.Schedule.__failure_runtime
orionis.console.tasks.schedule.Schedule.html#__failure_runtime
Attribute
Instance Variable
PUBLIC
Application runtime retained for callbacks outside the starting context.
-
orionis.console.tasks.schedule.Schedule.__wait_to_shutdown
orionis.console.tasks.schedule.Schedule.html#__wait_to_shutdown
Attribute
Instance Variable
PUBLIC
Wait to shutdown value used by Schedule.
-
orionis.console.tasks.schedule.Schedule.__loadAvailableCommands
orionis.console.tasks.schedule.Schedule.html#__loadAvailableCommands
Function
Method
PUBLIC
Cache command signatures exposed by the reactor.
-
orionis.console.tasks.schedule.Schedule.__suppressApschedulerLogging
orionis.console.tasks.schedule.Schedule.html#__suppressApschedulerLogging
Function
Method
PUBLIC
Disable APScheduler loggers and their message propagation.
-
orionis.console.tasks.schedule.Schedule.__validateAndLoadFluentTasks
orionis.console.tasks.schedule.Schedule.html#__validateAndLoadFluentTasks
Function
Method
PUBLIC
Validate fluent task signatures and build their task entities.
-
orionis.console.tasks.schedule.Schedule.info
orionis.console.tasks.schedule.Schedule.html#info
Function
Method
PUBLIC
Return scheduling metadata for all validated tasks.
-
orionis.console.tasks.schedule.Schedule._dispatchSchedulerEventListener
orionis.console.tasks.schedule.Schedule.html#_dispatchSchedulerEventListener
Function
Method
PUBLIC
Dispatch a scheduler event to its registered listener.
-
orionis.console.tasks.schedule.Schedule._dispatchTaskEventListener
orionis.console.tasks.schedule.Schedule.html#_dispatchTaskEventListener
Function
Method
PUBLIC
Observe task failures and dispatch the matching event listener.
-
orionis.console.tasks.schedule.Schedule.__createManagedTask
orionis.console.tasks.schedule.Schedule.html#__createManagedTask
Function
Method
PUBLIC
Create a supervised asyncio task and retain it until completion.
-
orionis.console.tasks.schedule.Schedule.__handleTaskException
orionis.console.tasks.schedule.Schedule.html#__handleTaskException
Function
Method
PUBLIC
Report a task execution failure independently of event listeners.
-
orionis.console.tasks.schedule.Schedule.__handleListenerException
orionis.console.tasks.schedule.Schedule.html#__handleListenerException
Function
Method
PUBLIC
Report a scheduler failure through runtime or legacy handling.
-
orionis.console.tasks.schedule.Schedule.__controlFailure
orionis.console.tasks.schedule.Schedule.html#__controlFailure
Function
Method
PUBLIC
Report a scheduler control failure and return its error.
-
orionis.console.tasks.schedule.Schedule.__addConfiguredJobStore
orionis.console.tasks.schedule.Schedule.html#__addConfiguredJobStore
Function
Method
PUBLIC
Register the configured database or Redis job store.
-
orionis.console.tasks.schedule.Schedule.boot
orionis.console.tasks.schedule.Schedule.html#boot
Function
Method
PUBLIC
Initialize and start the scheduler with configured tasks and listeners.
-
orionis.console.tasks.schedule.Schedule.__startScheduler
orionis.console.tasks.schedule.Schedule.html#__startScheduler
Function
Method
PUBLIC
Build and start one native backend under the lifecycle lock.
-
orionis.console.tasks.schedule.Schedule.on
orionis.console.tasks.schedule.Schedule.html#on
Function
Method
PUBLIC
Register or replace a listener for a scheduler lifecycle event.
-
orionis.console.tasks.schedule.Schedule.state
orionis.console.tasks.schedule.Schedule.html#state
Function
Method
PUBLIC
Return the current scheduler state value.
-
orionis.console.tasks.schedule.Schedule.isRunning
orionis.console.tasks.schedule.Schedule.html#isRunning
Function
Method
PUBLIC
Check whether the scheduler is running.
-
orionis.console.tasks.schedule.Schedule.isPaused
orionis.console.tasks.schedule.Schedule.html#isPaused
Function
Method
PUBLIC
Check whether the scheduler is paused.
-
orionis.console.tasks.schedule.Schedule.isStopped
orionis.console.tasks.schedule.Schedule.html#isStopped
Function
Method
PUBLIC
Check whether the scheduler is stopped.
-
orionis.console.tasks.schedule.Schedule.command
orionis.console.tasks.schedule.Schedule.html#command
Function
Method
PUBLIC
Declare a command for fluent scheduling configuration.
-
orionis.console.tasks.schedule.Schedule.pauseTask
orionis.console.tasks.schedule.Schedule.html#pauseTask
Function
Method
PUBLIC
Pause a running task by its signature.
-
orionis.console.tasks.schedule.Schedule.resumeTask
orionis.console.tasks.schedule.Schedule.html#resumeTask
Function
Method
PUBLIC
Resume a paused task by its signature.
-
orionis.console.tasks.schedule.Schedule.removeTask
orionis.console.tasks.schedule.Schedule.html#removeTask
Function
Method
PUBLIC
Remove a tracked task from the scheduler.
-
orionis.console.tasks.schedule.Schedule.removeAllTasks
orionis.console.tasks.schedule.Schedule.html#removeAllTasks
Function
Method
PUBLIC
Remove all tasks from the scheduler.
-
orionis.console.tasks.schedule.Schedule.pause
orionis.console.tasks.schedule.Schedule.html#pause
Function
Method
PUBLIC
Pause scheduling when the scheduler is running.
-
orionis.console.tasks.schedule.Schedule.resume
orionis.console.tasks.schedule.Schedule.html#resume
Function
Method
PUBLIC
Resume scheduling when the scheduler is paused.
-
orionis.console.tasks.schedule.Schedule.shutdown
orionis.console.tasks.schedule.Schedule.html#shutdown
Function
Method
PUBLIC
Schedule graceful shutdown without blocking the caller.
-
orionis.console.tasks.schedule.Schedule.__shutdownCompleted
orionis.console.tasks.schedule.Schedule.html#__shutdownCompleted
Function
Method
PUBLIC
Notify shutdown waiters if the managed shutdown task was cancelled.
-
orionis.console.tasks.schedule.Schedule.__gracefulShutdown
orionis.console.tasks.schedule.Schedule.html#__gracefulShutdown
Function
Method
PUBLIC
Finalize shutdown and preserve failures for waiting callers.
-
orionis.console.tasks.schedule.Schedule.__finishShutdown
orionis.console.tasks.schedule.Schedule.html#__finishShutdown
Function
Method
PUBLIC
Await native shutdown, job cleanup and late lifecycle listeners.
-
orionis.console.tasks.schedule.Schedule.__drainListeners
orionis.console.tasks.schedule.Schedule.html#__drainListeners
Function
Method
PUBLIC
Await the current listener snapshot without awaiting its shutdown owner.
-
orionis.console.tasks.schedule.Schedule.__drainTasks
orionis.console.tasks.schedule.Schedule.html#__drainTasks
Function
Method
PUBLIC
Collect owned futures and observe failures without abandoning cleanup.
-
orionis.console.tasks.schedule.Schedule.wait
orionis.console.tasks.schedule.Schedule.html#wait
Function
Method
PUBLIC
Wait for shutdown completion and re-raise any retained failure.
-
orionis.console.tasks.store.ScheduleStore
orionis.console.tasks.store.ScheduleStore.html
Class
Class
PUBLIC
Construct scheduler job stores from application configuration.
-
orionis.console.tasks.store.ScheduleStore.__init__
orionis.console.tasks.store.ScheduleStore.html#__init__
Function
Method
PUBLIC
Initialize the schedule store.
-
orionis.console.tasks.store.ScheduleStore.__application
orionis.console.tasks.store.ScheduleStore.html#__application
Attribute
Instance Variable
PUBLIC
The application instance.
-
orionis.console.tasks.store.ScheduleStore.__scheduler_conf
orionis.console.tasks.store.ScheduleStore.html#__scheduler_conf
Attribute
Instance Variable
PUBLIC
Scheduler conf produced by ConfigScheduler.
-
orionis.console.tasks.store.ScheduleStore._db_manager
orionis.console.tasks.store.ScheduleStore.html#_db_manager
Attribute
Instance Variable
PUBLIC
The database connection manager.
-
orionis.console.tasks.store.ScheduleStore.store
orionis.console.tasks.store.ScheduleStore.html#store
Attribute
Property
PUBLIC
Get the configured job store type.
-
orionis.console.tasks.store.ScheduleStore.config
orionis.console.tasks.store.ScheduleStore.html#config
Attribute
Property
PUBLIC
Get the full scheduler configuration entity.
-
orionis.console.tasks.store.ScheduleStore.redis
orionis.console.tasks.store.ScheduleStore.html#redis
Function
Method
PUBLIC
Create a Redis job store for the scheduler.
-
orionis.console.tasks.store.ScheduleStore.database
orionis.console.tasks.store.ScheduleStore.html#database
Function
Method
PUBLIC
Create a database job store for the scheduler.
-
orionis.console.tasks.store.ScheduleStore.migrate
orionis.console.tasks.store.ScheduleStore.html#migrate
Function
Method
PUBLIC
Create the native database job table without starting the scheduler.
-
orionis.console.tasks.store.ScheduleStore._migrateDatabase
orionis.console.tasks.store.ScheduleStore.html#_migrateDatabase
Function
Method
PUBLIC
Create the configured job store table and release its temporary engine.
-
orionis.console.scheduler_provider.ScheduleProvider
orionis.console.scheduler_provider.ScheduleProvider.html
Class
Class
PUBLIC
Register schedule services in the application container.
-
orionis.console.scheduler_provider.ScheduleProvider.register
orionis.console.scheduler_provider.ScheduleProvider.html#register
Function
Method
PUBLIC
Register the Scheduler as a singleton service in the application container.
-
orionis.console.scheduler_provider.ScheduleProvider.boot
orionis.console.scheduler_provider.ScheduleProvider.html#boot
Function
Method
PUBLIC
Initialize the Schedule facade asynchronously during the boot process.
-
orionis.container.contracts.IFacade
orionis.container.contracts.IFacade.html
Class
Class
PUBLIC
Define the contract for facade implementations.
-
orionis.container.contracts.IFacade.getFacadeAccessor
orionis.container.contracts.IFacade.html#getFacadeAccessor
Function
Class Method
PUBLIC
Return the container accessor key for this facade.
-
orionis.container.contracts.IFacade.resolve
orionis.container.contracts.IFacade.html#resolve
Function
Class Method
PUBLIC
Resolve the service instance bound to this facade.
-
orionis.container.contracts.IFacade.pin
orionis.container.contracts.IFacade.html#pin
Function
Class Method
PUBLIC
Pin the resolved instance on this facade class.
-
orionis.container.contracts.IFacade.unpin
orionis.container.contracts.IFacade.html#unpin
Function
Class Method
PUBLIC
Clear the pinned instance from this facade class.
-
orionis.container.entities.Binding
orionis.container.entities.Binding.html
Class
Class
PUBLIC
Represent a binding between a contract and its implementation.
-
orionis.container.entities.Binding.contract
orionis.container.entities.Binding.html#contract
Attribute
Instance Variable
PUBLIC
Contract of the concrete class to inject.
-
orionis.container.entities.Binding.concrete
orionis.container.entities.Binding.html#concrete
Attribute
Instance Variable
PUBLIC
Concrete class implementing the contract.
-
orionis.container.entities.Binding.instance
orionis.container.entities.Binding.html#instance
Attribute
Instance Variable
PUBLIC
Concrete instance of the class, if provided.
-
orionis.container.entities.Binding.lifetime
orionis.container.entities.Binding.html#lifetime
Attribute
Instance Variable
PUBLIC
Lifetime of the instance.
-
orionis.container.entities.Binding.alias
orionis.container.entities.Binding.html#alias
Attribute
Instance Variable
PUBLIC
Alias for resolving the dependency from the container.
-
orionis.container.entities.Binding.__post_init__
orionis.container.entities.Binding.html#__post_init__
Function
Method
PUBLIC
Validate the type of the 'lifetime' attribute after initialization.
-
orionis.container.enums.Lifetime
orionis.container.enums.Lifetime.html
Class
Class
PUBLIC
Define lifecycle types for dependency injection.
-
orionis.container.enums.Lifetime.TRANSIENT
orionis.container.enums.Lifetime.html#TRANSIENT
Attribute
Constant
PUBLIC
Create a new instance every time the dependency is requested.
-
orionis.container.enums.Lifetime.SINGLETON
orionis.container.enums.Lifetime.html#SINGLETON
Attribute
Constant
PUBLIC
Create a single shared instance for the application's lifetime.
-
orionis.container.enums.Lifetime.SCOPED
orionis.container.enums.Lifetime.html#SCOPED
Attribute
Constant
PUBLIC
Create and share an instance within a defined scope.
-
orionis.container.facades.Facade
orionis.container.facades.Facade.html
Class
Class
PUBLIC
Resolve container services through a shared class-level interface.
-
orionis.container.facades.Facade._application
orionis.container.facades.Facade.html#_application
Attribute
Class Variable
PUBLIC
Cached application instance shared across all facade subclasses.
-
orionis.container.facades.Facade._pinned_instance
orionis.container.facades.Facade.html#_pinned_instance
Attribute
Class Variable
PUBLIC
Resolved service retained while the facade is pinned.
-
orionis.container.facades.Facade.getFacadeAccessor
orionis.container.facades.Facade.html#getFacadeAccessor
Function
Class Method
PUBLIC
Return the container accessor key for this facade.
-
orionis.container.facades.Facade.resolve
orionis.container.facades.Facade.html#resolve
Function
Class Method
PUBLIC
Resolve the service instance bound to this facade.
-
orionis.container.facades.Facade.pin
orionis.container.facades.Facade.html#pin
Function
Class Method
PUBLIC
Pin the resolved instance on this facade class.
-
orionis.container.facades.Facade.unpin
orionis.container.facades.Facade.html#unpin
Function
Class Method
PUBLIC
Clear the pinned instance from this facade class.
-
orionis.container.providers.DeferrableProvider
orionis.container.providers.DeferrableProvider.html
Class
Class
PUBLIC
Mark service providers that support deferred loading.
-
orionis.container.providers.DeferrableProvider.provides
orionis.container.providers.DeferrableProvider.html#provides
Function
Class Method
PUBLIC
Return the services provided by this provider.
-
orionis.container.providers.ServiceProvider
orionis.container.providers.ServiceProvider.html
Class
Class
PUBLIC
Define optional registration and startup hooks for service providers.
-
orionis.container.providers.ServiceProvider.__init__
orionis.container.providers.ServiceProvider.html#__init__
Function
Method
PUBLIC
Initialize a new ServiceProvider instance with the given application container.
-
orionis.container.providers.ServiceProvider.app
orionis.container.providers.ServiceProvider.html#app
Attribute
Instance Variable
PUBLIC
The application container instance to which this service provider will be attached.
-
orionis.container.providers.ServiceProvider.register
orionis.container.providers.ServiceProvider.html#register
Function
Method
PUBLIC
Register services and components into the application container.
-
orionis.container.providers.ServiceProvider.boot
orionis.container.providers.ServiceProvider.html#boot
Function
Method
PUBLIC
Perform post-registration initialization tasks.
-
orionis.database.SQLCompiler
orionis.database.SQLCompiler.html
Class
Class
PUBLIC
Translate Orionis query plans into engine-executable statements.
-
orionis.database.SQLCompiler._TYPE_BUILDERS
orionis.database.SQLCompiler.html#_TYPE_BUILDERS
Attribute
Constant
PUBLIC
Factories translating logical column definitions into SQLAlchemy types.
-
orionis.database.SQLCompiler.__slots__
orionis.database.SQLCompiler.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.database.SQLCompiler.__init__
orionis.database.SQLCompiler.html#__init__
Function
Method
PUBLIC
Initialize backend settings and compiler-owned table metadata.
-
orionis.database.SQLCompiler._prefix
orionis.database.SQLCompiler.html#_prefix
Attribute
Instance Variable
PUBLIC
Text prepended to logical table names; empty by default.
-
orionis.database.SQLCompiler._driver
orionis.database.SQLCompiler.html#_driver
Attribute
Instance Variable
PUBLIC
Orionis backend name for native type, identity, and locking options.
-
orionis.database.SQLCompiler._metadata
orionis.database.SQLCompiler.html#_metadata
Attribute
Instance Variable
PUBLIC
Compiled metadata used to describe and invoke the registered operation.
-
orionis.database.SQLCompiler._tables
orionis.database.SQLCompiler.html#_tables
Attribute
Instance Variable
PUBLIC
Table metadata indexed for query compilation or route lookup.
-
orionis.database.SQLCompiler._definitions
orionis.database.SQLCompiler.html#_definitions
Attribute
Instance Variable
PUBLIC
Schema definitions cached for statement compilation.
-
orionis.database.SQLCompiler.compileSelect
orionis.database.SQLCompiler.html#compileSelect
Function
Method
PUBLIC
Compile a SELECT plan, including aggregates and union branches.
-
orionis.database.SQLCompiler._compileSelect
orionis.database.SQLCompiler.html#_compileSelect
Function
Method
PUBLIC
Compile every branch while retaining enclosing correlation sources.
-
orionis.database.SQLCompiler._aggregateDerived
orionis.database.SQLCompiler.html#_aggregateDerived
Function
Method
PUBLIC
Aggregate the complete compound or grouped query through a derived table.
-
orionis.database.SQLCompiler._applyUnions
orionis.database.SQLCompiler.html#_applyUnions
Function
Method
PUBLIC
Combine union branches and apply global ordering and pagination.
-
orionis.database.SQLCompiler._buildSelect
orionis.database.SQLCompiler.html#_buildSelect
Function
Method
PUBLIC
Build a SELECT and resolve references to enclosing query sources.
-
orionis.database.SQLCompiler._applySelectLock
orionis.database.SQLCompiler.html#_applySelectLock
Function
Method
PUBLIC
Apply the backend's supported row-lock syntax to a SELECT.
-
orionis.database.SQLCompiler._validateSelectLock
orionis.database.SQLCompiler.html#_validateSelectLock
Function
Method
PUBLIC
Reject a SELECT row lock when the backend is Redshift.
-
orionis.database.SQLCompiler._bareNameForIdentifier
orionis.database.SQLCompiler.html#_bareNameForIdentifier
Function
Method
PUBLIC
Extract a bare column name for a matching source identifier.
-
orionis.database.SQLCompiler._collectClauseColumnNames
orionis.database.SQLCompiler.html#_collectClauseColumnNames
Function
Method
PUBLIC
Collect explicit column references from conditions and nested groups.
-
orionis.database.SQLCompiler._collectPlanColumnNames
orionis.database.SQLCompiler.html#_collectPlanColumnNames
Function
Method
PUBLIC
Collect explicit column references from the current SELECT plan.
-
orionis.database.SQLCompiler._ensureRawColumns
orionis.database.SQLCompiler.html#_ensureRawColumns
Function
Method
PUBLIC
Declare missing referenced columns on a schemaless table.
-
orionis.database.SQLCompiler._ensureSelectRawColumns
orionis.database.SQLCompiler.html#_ensureSelectRawColumns
Function
Method
PUBLIC
Declare referenced columns for schemaless SELECT and JOIN sources.
-
orionis.database.SQLCompiler._resolveSources
orionis.database.SQLCompiler.html#_resolveSources
Function
Method
PUBLIC
Build SELECT sources and assemble the FROM clause.
-
orionis.database.SQLCompiler._joinSource
orionis.database.SQLCompiler.html#_joinSource
Function
Method
PUBLIC
Build a joined table or an aliased subquery source.
-
orionis.database.SQLCompiler._applyJoin
orionis.database.SQLCompiler.html#_applyJoin
Function
Method
PUBLIC
Extend a FROM clause with the requested join type.
-
orionis.database.SQLCompiler._joinCondition
orionis.database.SQLCompiler.html#_joinCondition
Function
Method
PUBLIC
Combine a join's ON conditions into one boolean expression.
-
orionis.database.SQLCompiler._joinConditionExpression
orionis.database.SQLCompiler.html#_joinConditionExpression
Function
Method
PUBLIC
Compile an ON condition as a comparison between two columns.
-
orionis.database.SQLCompiler._selectProjection
orionis.database.SQLCompiler.html#_selectProjection
Function
Method
PUBLIC
Build a SELECT projection from an aggregate or projected entries.
-
orionis.database.SQLCompiler._rawElement
orionis.database.SQLCompiler.html#_rawElement
Function
Static Method
PUBLIC
Compile trusted SQL text with named bindings and an optional alias.
-
orionis.database.SQLCompiler._projectionElement
orionis.database.SQLCompiler.html#_projectionElement
Function
Method
PUBLIC
Compile one projection entry into a SQL expression.
-
orionis.database.SQLCompiler._applyOrderingAndPaging
orionis.database.SQLCompiler.html#_applyOrderingAndPaging
Function
Method
PUBLIC
Apply a plan's ordering, limit, and offset to a SELECT.
-
orionis.database.SQLCompiler.supportsBatchInsert
orionis.database.SQLCompiler.html#supportsBatchInsert
Function
Static Method
PUBLIC
Check whether multiple rows share a parameter-only batch shape.
-
orionis.database.SQLCompiler.compileInsert
orionis.database.SQLCompiler.html#compileInsert
Function
Method
PUBLIC
Compile row mappings into an executable INSERT statement.
-
orionis.database.SQLCompiler.compileUpdate
orionis.database.SQLCompiler.html#compileUpdate
Function
Method
PUBLIC
Compile replacement values and filters into an UPDATE statement.
-
orionis.database.SQLCompiler.compileDelete
orionis.database.SQLCompiler.html#compileDelete
Function
Method
PUBLIC
Compile filtering conditions into a DELETE statement.
-
orionis.database.SQLCompiler.compileCreateTable
orionis.database.SQLCompiler.html#compileCreateTable
Function
Method
PUBLIC
Compile table metadata into a CREATE TABLE DDL object.
-
orionis.database.SQLCompiler.compileDropTable
orionis.database.SQLCompiler.html#compileDropTable
Function
Method
PUBLIC
Compile a DROP TABLE DDL object for a logical table name.
-
orionis.database.SQLCompiler._physicalName
orionis.database.SQLCompiler.html#_physicalName
Function
Method
PUBLIC
Build a physical table name by prepending the configured prefix.
-
orionis.database.SQLCompiler._cacheKey
orionis.database.SQLCompiler.html#_cacheKey
Function
Method
PUBLIC
Build a table cache key from its physical name and optional schema.
-
orionis.database.SQLCompiler._sqlTable
orionis.database.SQLCompiler.html#_sqlTable
Function
Method
PUBLIC
Resolve cached table metadata or rebuild it for a new definition.
-
orionis.database.SQLCompiler._tableConstraints
orionis.database.SQLCompiler.html#_tableConstraints
Function
Method
PUBLIC
Build table-level keys, foreign keys, and indexes.
-
orionis.database.SQLCompiler._ensureReferencedTable
orionis.database.SQLCompiler.html#_ensureReferencedTable
Function
Method
PUBLIC
Register missing metadata for a single-column foreign-key target.
-
orionis.database.SQLCompiler._ensureReferencedColumns
orionis.database.SQLCompiler.html#_ensureReferencedColumns
Function
Method
PUBLIC
Extend undeclared target metadata with missing foreign-key columns.
-
orionis.database.SQLCompiler._sqlColumn
orionis.database.SQLCompiler.html#_sqlColumn
Function
Method
PUBLIC
Translate a column definition into SQLAlchemy column metadata.
-
orionis.database.SQLCompiler._columnOptions
orionis.database.SQLCompiler.html#_columnOptions
Function
Method
PUBLIC
Build column constraints, identity options and static defaults.
-
orionis.database.SQLCompiler._sqlType
orionis.database.SQLCompiler.html#_sqlType
Function
Method
PUBLIC
Build a SQLAlchemy type with any required backend variants.
-
orionis.database.SQLCompiler._splitQualifiedColumn
orionis.database.SQLCompiler.html#_splitQualifiedColumn
Function
Method
PUBLIC
Split a column reference at its last qualifier separator.
-
orionis.database.SQLCompiler._resolveColumn
orionis.database.SQLCompiler.html#_resolveColumn
Function
Method
PUBLIC
Resolve a column by source qualifier or default table.
-
orionis.database.SQLCompiler._whereExpression
orionis.database.SQLCompiler.html#_whereExpression
Function
Method
PUBLIC
Compile ordered WHERE or HAVING clauses into one predicate.
-
orionis.database.SQLCompiler._combineExpressions
orionis.database.SQLCompiler.html#_combineExpressions
Function
Static Method
PUBLIC
Combine compiled clauses while preserving left-to-right grouping.
-
orionis.database.SQLCompiler._columnlessExpression
orionis.database.SQLCompiler.html#_columnlessExpression
Function
Method
PUBLIC
Compile nested groups, raw predicates, and EXISTS subqueries.
-
orionis.database.SQLCompiler._clauseExpression
orionis.database.SQLCompiler.html#_clauseExpression
Function
Method
PUBLIC
Dispatch a WHERE condition to its matching SQL predicate builder.
-
orionis.database.SQLCompiler._predicateValue
orionis.database.SQLCompiler.html#_predicateValue
Function
Static Method
PUBLIC
Match UUID predicates to textual storage without changing UUID columns.
-
orionis.database.SQLCompiler._clauseValue
orionis.database.SQLCompiler.html#_clauseValue
Function
Method
PUBLIC
Compile a SELECT value or return a non-query value unchanged.
-
orionis.database.SQLCompiler._betweenExpression
orionis.database.SQLCompiler.html#_betweenExpression
Function
Method
PUBLIC
Compile BETWEEN or NOT BETWEEN with exactly two bounds.
-
orionis.database.SQLCompiler._columnComparison
orionis.database.SQLCompiler.html#_columnComparison
Function
Method
PUBLIC
Compare two resolved columns using the clause's operator.
-
orionis.database.SQLCompiler._basicExpression
orionis.database.SQLCompiler.html#_basicExpression
Function
Method
PUBLIC
Compile a column-to-value comparison with backend-specific handling.
-
orionis.database.SQLCompiler._aggregateExpression
orionis.database.SQLCompiler.html#_aggregateExpression
Function
Method
PUBLIC
Compile an aggregate function over a column or all rows.
-
orionis.database.Connection
orionis.database.Connection.html
Class
Class
PUBLIC
Named database connection encapsulating the SQL engine.
-
orionis.database.Connection.__slots__
orionis.database.Connection.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.database.Connection.__init__
orionis.database.Connection.html#__init__
Function
Method
PUBLIC
Validate the driver and initialize a lazy named connection.
-
orionis.database.Connection._name
orionis.database.Connection.html#_name
Attribute
Instance Variable
PUBLIC
Name identifying this connection in the manager.
-
orionis.database.Connection._config
orionis.database.Connection.html#_config
Attribute
Instance Variable
PUBLIC
Driver, connection settings, and optional table prefix.
-
orionis.database.Connection._engine
orionis.database.Connection.html#_engine
Attribute
Instance Variable
PUBLIC
Database engine, created lazily when the connection is first used.
-
orionis.database.Connection._compiler
orionis.database.Connection.html#_compiler
Attribute
Instance Variable
PUBLIC
Compiler produced by SQLCompiler.
-
orionis.database.Connection._tx_state
orionis.database.Connection.html#_tx_state
Attribute
Instance Variable
PUBLIC
Task-local transaction state keeps concurrent tasks isolated.
-
orionis.database.Connection.getName
orionis.database.Connection.html#getName
Function
Method
PUBLIC
Return this connection's registered name.
-
orionis.database.Connection.supportsUniqueConstraints
orionis.database.Connection.html#supportsUniqueConstraints
Function
Method
PUBLIC
Report whether the configured backend enforces key uniqueness.
-
orionis.database.Connection.toSql
orionis.database.Connection.html#toSql
Function
Method
PUBLIC
Render a SELECT plan without creating an engine or executing SQL.
-
orionis.database.Connection.select
orionis.database.Connection.html#select
Function
Method
PUBLIC
Execute a SELECT plan or raw SQL and materialize its rows.
-
orionis.database.Connection.insert
orionis.database.Connection.html#insert
Function
Method
PUBLIC
Execute an INSERT plan and report its key and row count.
-
orionis.database.Connection.update
orionis.database.Connection.html#update
Function
Method
PUBLIC
Execute an UPDATE plan and return the driver's affected row count.
-
orionis.database.Connection.delete
orionis.database.Connection.html#delete
Function
Method
PUBLIC
Execute a DELETE plan and return the driver's affected row count.
-
orionis.database.Connection.scalar
orionis.database.Connection.html#scalar
Function
Method
PUBLIC
Execute a SELECT plan and return its first scalar value.
-
orionis.database.Connection.execute
orionis.database.Connection.html#execute
Function
Method
PUBLIC
Execute raw SQL and return the driver's affected row count.
-
orionis.database.Connection.statement
orionis.database.Connection.html#statement
Function
Method
PUBLIC
Execute raw SQL and discard its result.
-
orionis.database.Connection.createTable
orionis.database.Connection.html#createTable
Function
Method
PUBLIC
Create a table from its schema definition.
-
orionis.database.Connection.dropTable
orionis.database.Connection.html#dropTable
Function
Method
PUBLIC
Drop a table using its logical name and optional schema.
-
orionis.database.Connection.begin
orionis.database.Connection.html#begin
Function
Method
PUBLIC
Begin a task-local transaction or create a nested savepoint.
-
orionis.database.Connection.commit
orionis.database.Connection.html#commit
Function
Method
PUBLIC
Commit the current task's innermost transaction or savepoint.
-
orionis.database.Connection.rollback
orionis.database.Connection.html#rollback
Function
Method
PUBLIC
Roll back the current task's innermost transaction or savepoint.
-
orionis.database.Connection.transaction
orionis.database.Connection.html#transaction
Function
Method
PUBLIC
Return a context manager for a task-local transaction.
-
orionis.database.Connection.inTransaction
orionis.database.Connection.html#inTransaction
Function
Method
PUBLIC
Report whether the current task owns an active transaction.
-
orionis.database.Connection.disconnect
orionis.database.Connection.html#disconnect
Function
Method
PUBLIC
Dispose the cached engine and release its idle pooled connections.
-
orionis.database.Connection._getEngine
orionis.database.Connection.html#_getEngine
Function
Method
PUBLIC
Return the cached engine, creating and configuring it on first use.
-
orionis.database.Connection._transactionState
orionis.database.Connection.html#_transactionState
Function
Method
PUBLIC
Return transaction state owned by the current task.
-
orionis.database.Connection._acquire
orionis.database.Connection.html#_acquire
Function
Method
PUBLIC
Return a context manager for reusing or acquiring a connection.
-
orionis.database.Connection._run
orionis.database.Connection.html#_run
Function
Method
PUBLIC
Execute a SQLAlchemy statement and sanitize database errors.
-
orionis.database.Connection._queryException
orionis.database.Connection.html#_queryException
Function
Method
PUBLIC
Build a query error containing only the connection name and error type.
-
orionis.database.Connection._releaseIfSettled
orionis.database.Connection.html#_releaseIfSettled
Function
Method
PUBLIC
Release the raw connection when its transaction stack becomes empty.
-
orionis.foundation.config.database.enums._EXPORTS
orionis.foundation.config.database.enums.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.foundation.config.database.enums.__getattr__
orionis.foundation.config.database.enums.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public database enum.
-
orionis.foundation.config.database.enums.__dir__
orionis.foundation.config.database.enums.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared enum exports.
-
orionis.foundation.config.database.entities.sqlserver._MAX_PORT
orionis.foundation.config.database.entities.sqlserver.html#_MAX_PORT
Attribute
Constant
PUBLIC
Valid TCP port boundary for the SQL Server listener.
-
orionis.foundation.config.database.entities.connections._CONNECTION_ENTITIES
orionis.foundation.config.database.entities.connections.html#_CONNECTION_ENTITIES
Attribute
Constant
PUBLIC
Table-driven mapping between connection field names and their entities.
-
orionis.foundation.config.database.entities.database._CONNECTION_NAMES
orionis.foundation.config.database.entities.database.html#_CONNECTION_NAMES
Attribute
Constant
PUBLIC
Define the supported database connection names.
-
orionis.database.ConnectionManager
orionis.database.ConnectionManager.html
Class
Class
PUBLIC
Resolve named database connections and manage their lifecycle.
-
orionis.database.ConnectionManager.__slots__
orionis.database.ConnectionManager.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.database.ConnectionManager.__init__
orionis.database.ConnectionManager.html#__init__
Function
Method
PUBLIC
Initialize the manager from the application configuration.
-
orionis.database.ConnectionManager._connections
orionis.database.ConnectionManager.html#_connections
Attribute
Instance Variable
PUBLIC
Database configurations indexed by their case-sensitive registered name.
-
orionis.database.ConnectionManager._default
orionis.database.ConnectionManager.html#_default
Attribute
Instance Variable
PUBLIC
Exact registered default name, with the legacy lowercase fallback.
-
orionis.database.ConnectionManager._cached_connections
orionis.database.ConnectionManager.html#_cached_connections
Attribute
Instance Variable
PUBLIC
Cached connections value, computed on first access.
-
orionis.database.ConnectionManager._lock
orionis.database.ConnectionManager.html#_lock
Attribute
Instance Variable
PUBLIC
Serialize publication and registry mutation without holding async cleanup.
-
orionis.database.ConnectionManager.connection
orionis.database.ConnectionManager.html#connection
Function
Method
PUBLIC
Resolve the connection registered under the given name.
-
orionis.database.ConnectionManager.addConnection
orionis.database.ConnectionManager.html#addConnection
Function
Method
PUBLIC
Register or replace a named connection configuration at runtime.
-
orionis.database.ConnectionManager.hasConnection
orionis.database.ConnectionManager.html#hasConnection
Function
Method
PUBLIC
Report whether a connection configuration exists.
-
orionis.database.ConnectionManager.getDefaultName
orionis.database.ConnectionManager.html#getDefaultName
Function
Method
PUBLIC
Return the name of the default connection.
-
orionis.database.ConnectionManager.setDefaultName
orionis.database.ConnectionManager.html#setDefaultName
Function
Method
PUBLIC
Change the default connection name.
-
orionis.database.ConnectionManager.disconnect
orionis.database.ConnectionManager.html#disconnect
Function
Method
PUBLIC
Dispose one or all cached connections.
-
orionis.database.ConnectionManager.configFor
orionis.database.ConnectionManager.html#configFor
Function
Method
PUBLIC
Retrieve the configuration for a named connection.
-
orionis.database.ConnectionManager.__unknownConnectionMessage
orionis.database.ConnectionManager.html#__unknownConnectionMessage
Function
Method
PUBLIC
Build the descriptive message for an unresolved connection name.
-
orionis.database.Migration
orionis.database.Migration.html
Class
Class
PUBLIC
Abstract base class for all database migrations.
-
orionis.database.Migration.__slots__
orionis.database.Migration.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.database.Migration.up
orionis.database.Migration.html#up
Function
Method
PUBLIC
Apply the migration.
-
orionis.database.Migration.down
orionis.database.Migration.html#down
Function
Method
PUBLIC
Revert the migration.
-
orionis.database.ConnectionNotFoundException
orionis.database.ConnectionNotFoundException.html
Class
Exception
PUBLIC
Raised when a connection name is not present in the configuration.
-
orionis.database.DatabaseException
orionis.database.DatabaseException.html
Class
Exception
PUBLIC
Base exception for all database-related errors.
-
orionis.database.MigrationNotFoundException
orionis.database.MigrationNotFoundException.html
Class
Exception
PUBLIC
Raised when a recorded migration has no matching migration file.
-
orionis.database.MissingDatabaseDependencyException
orionis.database.MissingDatabaseDependencyException.html
Class
Exception
PUBLIC
Raised when a driver requires an optional package that is not installed.
-
orionis.database.QueryException
orionis.database.QueryException.html
Class
Exception
PUBLIC
Raised when a statement fails to compile or execute.
-
orionis.database.TransactionException
orionis.database.TransactionException.html
Class
Exception
PUBLIC
Raised when transaction control methods are used incorrectly.
-
orionis.database.UnsupportedDriverException
orionis.database.UnsupportedDriverException.html
Class
Exception
PUBLIC
Raised when a connection references a driver with no implementation.
-
orionis.database.Transaction
orionis.database.Transaction.html
Class
Class
PUBLIC
Async context manager driving a connection-level transaction.
-
orionis.database.Transaction.__slots__
orionis.database.Transaction.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.database.Transaction.__init__
orionis.database.Transaction.html#__init__
Function
Method
PUBLIC
Initialize the transaction around a connection.
-
orionis.database.Transaction._connection
orionis.database.Transaction.html#_connection
Attribute
Instance Variable
PUBLIC
Connection whose transaction lifecycle is managed.
-
orionis.database.Transaction.__aenter__
orionis.database.Transaction.html#__aenter__
Function
Method
PUBLIC
Begin the transaction and enter the context.
-
orionis.database.Transaction.__aexit__
orionis.database.Transaction.html#__aexit__
Function
Method
PUBLIC
Commit or roll back the transaction when leaving the context.
-
orionis.database._EXCEPTIONS_MODULE
orionis.database.html#_EXCEPTIONS_MODULE
Attribute
Constant
PUBLIC
Module defining the exported database exception types.
-
orionis.database._EXPORTS
orionis.database.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.database.__getattr__
orionis.database.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.database.__dir__
orionis.database.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.database.contracts.IConnection
orionis.database.contracts.IConnection.html
Class
Class
PUBLIC
Contract for a single named database connection.
-
orionis.database.contracts.IConnection.__slots__
orionis.database.contracts.IConnection.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.database.contracts.IConnection.getName
orionis.database.contracts.IConnection.html#getName
Function
Method
PUBLIC
Return the configured name of this connection.
-
orionis.database.contracts.IConnection.supportsUniqueConstraints
orionis.database.contracts.IConnection.html#supportsUniqueConstraints
Function
Method
PUBLIC
Report whether primary and unique keys reject duplicate values.
-
orionis.database.contracts.IConnection.toSql
orionis.database.contracts.IConnection.html#toSql
Function
Method
PUBLIC
Render a SELECT plan without executing it or opening a connection.
-
orionis.database.contracts.IConnection.select
orionis.database.contracts.IConnection.html#select
Function
Method
PUBLIC
Run a SELECT query and return its rows as dictionaries.
-
orionis.database.contracts.IConnection.insert
orionis.database.contracts.IConnection.html#insert
Function
Method
PUBLIC
Run an INSERT statement described by the given plan.
-
orionis.database.contracts.IConnection.update
orionis.database.contracts.IConnection.html#update
Function
Method
PUBLIC
Run an UPDATE statement described by the given plan.
-
orionis.database.contracts.IConnection.delete
orionis.database.contracts.IConnection.html#delete
Function
Method
PUBLIC
Run a DELETE statement described by the given plan.
-
orionis.database.contracts.IConnection.scalar
orionis.database.contracts.IConnection.html#scalar
Function
Method
PUBLIC
Run a SELECT plan and return the first column of the first row.
-
orionis.database.contracts.IConnection.execute
orionis.database.contracts.IConnection.html#execute
Function
Method
PUBLIC
Run a raw data-modifying SQL statement.
-
orionis.database.contracts.IConnection.statement
orionis.database.contracts.IConnection.html#statement
Function
Method
PUBLIC
Run a raw SQL statement without inspecting its result.
-
orionis.database.contracts.IConnection.createTable
orionis.database.contracts.IConnection.html#createTable
Function
Method
PUBLIC
Create the physical table described by the given definition.
-
orionis.database.contracts.IConnection.dropTable
orionis.database.contracts.IConnection.html#dropTable
Function
Method
PUBLIC
Drop the physical table with the given logical name.
-
orionis.database.contracts.IConnection.begin
orionis.database.contracts.IConnection.html#begin
Function
Method
PUBLIC
Begin a transaction, or a savepoint when one is already active.
-
orionis.database.contracts.IConnection.commit
orionis.database.contracts.IConnection.html#commit
Function
Method
PUBLIC
Commit the innermost active transaction or savepoint.
-
orionis.database.contracts.IConnection.rollback
orionis.database.contracts.IConnection.html#rollback
Function
Method
PUBLIC
Roll back the innermost active transaction or savepoint.
-
orionis.database.contracts.IConnection.transaction
orionis.database.contracts.IConnection.html#transaction
Function
Method
PUBLIC
Return a transaction usable as an async context manager.
-
orionis.database.contracts.IConnection.inTransaction
orionis.database.contracts.IConnection.html#inTransaction
Function
Method
PUBLIC
Report whether a transaction is active in the current task.
-
orionis.database.contracts.IConnection.disconnect
orionis.database.contracts.IConnection.html#disconnect
Function
Method
PUBLIC
Dispose the underlying engine and release its pooled resources.
-
orionis.database.contracts.IConnectionManager
orionis.database.contracts.IConnectionManager.html
Class
Class
PUBLIC
Define the contract for connection manager implementations.
-
orionis.database.contracts.IConnectionManager.__slots__
orionis.database.contracts.IConnectionManager.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.database.contracts.IConnectionManager.connection
orionis.database.contracts.IConnectionManager.html#connection
Function
Method
PUBLIC
Resolve the connection registered under the given name.
-
orionis.database.contracts.IConnectionManager.addConnection
orionis.database.contracts.IConnectionManager.html#addConnection
Function
Method
PUBLIC
Register or replace a named connection configuration at runtime.
-
orionis.database.contracts.IConnectionManager.hasConnection
orionis.database.contracts.IConnectionManager.html#hasConnection
Function
Method
PUBLIC
Report whether a connection configuration exists.
-
orionis.database.contracts.IConnectionManager.getDefaultName
orionis.database.contracts.IConnectionManager.html#getDefaultName
Function
Method
PUBLIC
Return the name of the default connection.
-
orionis.database.contracts.IConnectionManager.setDefaultName
orionis.database.contracts.IConnectionManager.html#setDefaultName
Function
Method
PUBLIC
Change the default connection name.
-
orionis.database.contracts.IConnectionManager.disconnect
orionis.database.contracts.IConnectionManager.html#disconnect
Function
Method
PUBLIC
Dispose one or all cached connections.
-
orionis.database.contracts.IConnectionManager.configFor
orionis.database.contracts.IConnectionManager.html#configFor
Function
Method
PUBLIC
Retrieve the configuration for a named connection.
-
orionis.database.contracts.ITransaction
orionis.database.contracts.ITransaction.html
Class
Class
PUBLIC
Contract for a database transaction usable as an async context manager.
-
orionis.database.contracts.ITransaction.__slots__
orionis.database.contracts.ITransaction.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.database.contracts.ITransaction.__aenter__
orionis.database.contracts.ITransaction.html#__aenter__
Function
Method
PUBLIC
Begin the transaction and enter the context.
-
orionis.database.contracts.ITransaction.__aexit__
orionis.database.contracts.ITransaction.html#__aexit__
Function
Method
PUBLIC
Finalize the transaction when leaving the context.
-
orionis.database.contracts.schema.ISchema
orionis.database.contracts.schema.ISchema.html
Class
Class
PUBLIC
Define the contract for schema implementations.
-
orionis.database.contracts.schema.ISchema.__slots__
orionis.database.contracts.schema.ISchema.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.database.contracts.schema.ISchema.connection
orionis.database.contracts.schema.ISchema.html#connection
Function
Method
PUBLIC
Set the connection name for schema operations.
-
orionis.database.contracts.schema.ISchema.create
orionis.database.contracts.schema.ISchema.html#create
Function
Method
PUBLIC
Start a fluent table declaration block with async with.
-
orionis.database.contracts.schema.ISchema.createFromDefinition
orionis.database.contracts.schema.ISchema.html#createFromDefinition
Function
Method
PUBLIC
Create a table from a reusable, versioned schema definition.
-
orionis.database.contracts.schema.ISchema.createFromModel
orionis.database.contracts.schema.ISchema.html#createFromModel
Function
Method
PUBLIC
Create the current table declared by a concrete model.
-
orionis.database.contracts.schema.ISchema.drop
orionis.database.contracts.schema.ISchema.html#drop
Function
Method
PUBLIC
Drop an existing table.
-
orionis.database.schema.table_creation.TableCreation
orionis.database.schema.table_creation.TableCreation.html
Class
Class
PUBLIC
Async context manager returned by Schema.create.
-
orionis.database.schema.table_creation.TableCreation.__slots__
orionis.database.schema.table_creation.TableCreation.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.database.schema.table_creation.TableCreation.__init__
orionis.database.schema.table_creation.TableCreation.html#__init__
Function
Method
PUBLIC
Store the pending table declaration request.
-
orionis.database.schema.table_creation.TableCreation.__schema
orionis.database.schema.table_creation.TableCreation.html#__schema
Attribute
Instance Variable
PUBLIC
The schema instance that will perform the creation.
-
orionis.database.schema.table_creation.TableCreation.__name
orionis.database.schema.table_creation.TableCreation.html#__name
Attribute
Instance Variable
PUBLIC
The name of the table to create.
-
orionis.database.schema.table_creation.TableCreation.__blueprint
orionis.database.schema.table_creation.TableCreation.html#__blueprint
Attribute
Instance Variable
PUBLIC
Table blueprint being converted into a schema operation.
-
orionis.database.schema.table_creation.TableCreation.__aenter__
orionis.database.schema.table_creation.TableCreation.html#__aenter__
Function
Method
PUBLIC
Start a fluent, per-table column declaration block.
-
orionis.database.schema.table_creation.TableCreation.__aexit__
orionis.database.schema.table_creation.TableCreation.html#__aexit__
Function
Method
PUBLIC
Create the table with the collected columns, unless it raised.
-
orionis.database.entities.InsertResult
orionis.database.entities.InsertResult.html
Class
Class
PUBLIC
Outcome of an INSERT statement executed through a connection.
-
orionis.database.entities.InsertResult.last_insert_id
orionis.database.entities.InsertResult.html#last_insert_id
Attribute
Instance Variable
PUBLIC
Primary key generated for the inserted row, or None when the driver cannot report it (for example on multi-row inserts).
-
orionis.database.entities.InsertResult.row_count
orionis.database.entities.InsertResult.html#row_count
Attribute
Instance Variable
PUBLIC
Number of rows affected by the statement.
-
orionis.database.migrations.Migrator
orionis.database.migrations.Migrator.html
Class
Class
PUBLIC
Runner applying and reverting the application migrations.
-
orionis.database.migrations.Migrator.__slots__
orionis.database.migrations.Migrator.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.database.migrations.Migrator.__init__
orionis.database.migrations.Migrator.html#__init__
Function
Method
PUBLIC
Initialize the migrator.
-
orionis.database.migrations.Migrator.__app
orionis.database.migrations.Migrator.html#__app
Attribute
Instance Variable
PUBLIC
Application instance used to resolve the migrations directory.
-
orionis.database.migrations.Migrator.__conn_manager
orionis.database.migrations.Migrator.html#__conn_manager
Attribute
Instance Variable
PUBLIC
Connection manager used to resolve the database connection.
-
orionis.database.migrations.Migrator.__discovered_cache
orionis.database.migrations.Migrator.html#__discovered_cache
Attribute
Instance Variable
PUBLIC
Cached results of filesystem discovery.
-
orionis.database.migrations.Migrator.migrate
orionis.database.migrations.Migrator.html#migrate
Function
Method
PUBLIC
Apply every migration that has not been run yet.
-
orionis.database.migrations.Migrator.rollback
orionis.database.migrations.Migrator.html#rollback
Function
Method
PUBLIC
Revert the most recently applied migration batches.
-
orionis.database.migrations.Migrator.reset
orionis.database.migrations.Migrator.html#reset
Function
Method
PUBLIC
Revert every migration recorded on the connection.
-
orionis.database.migrations.Migrator.refresh
orionis.database.migrations.Migrator.html#refresh
Function
Method
PUBLIC
Roll back migrations and immediately apply them again.
-
orionis.database.migrations.Migrator.fresh
orionis.database.migrations.Migrator.html#fresh
Function
Method
PUBLIC
Drop migration and seeder history, then apply every migration.
-
orionis.database.migrations.Migrator.status
orionis.database.migrations.Migrator.html#status
Function
Method
PUBLIC
Report which migrations are applied and which are pending.
-
orionis.database.migrations.Migrator.__revert
orionis.database.migrations.Migrator.html#__revert
Function
Method
PUBLIC
Roll back the recorded migrations of the selected batches.
-
orionis.database.migrations.Migrator.__selectBatches
orionis.database.migrations.Migrator.html#__selectBatches
Function
Static Method
PUBLIC
Pick the recorded rows belonging to the batches being reverted.
-
orionis.database.migrations.Migrator.__runStep
orionis.database.migrations.Migrator.html#__runStep
Function
Method
PUBLIC
Run one migration and its tracking write atomically.
-
orionis.database.migrations.Migrator.__connection
orionis.database.migrations.Migrator.html#__connection
Function
Method
PUBLIC
Resolve the connection migrations run against.
-
orionis.database.migrations.Migrator.__migrationsPath
orionis.database.migrations.Migrator.html#__migrationsPath
Function
Method
PUBLIC
Return the directory holding migration files.
-
orionis.database.migrations.Migrator.__discover
orionis.database.migrations.Migrator.html#__discover
Function
Method
PUBLIC
Discover migration classes defined under the migrations directory.
-
orionis.database.migrations.Migrator.__ensureMigrationsTable
orionis.database.migrations.Migrator.html#__ensureMigrationsTable
Function
Method
PUBLIC
Create the migrations tracking table if it does not already exist.
-
orionis.database.migrations.Migrator.__getRan
orionis.database.migrations.Migrator.html#__getRan
Function
Method
PUBLIC
Return every recorded migration, ordered by application order.
-
orionis.database.migrations.Migrator.__nextBatch
orionis.database.migrations.Migrator.html#__nextBatch
Function
Static Method
PUBLIC
Compute the batch number to assign to a new migration run.
-
orionis.database.migrations.Migrator.__insertRecord
orionis.database.migrations.Migrator.html#__insertRecord
Function
Method
PUBLIC
Record a migration as applied.
-
orionis.database.migrations.Migrator.__deleteRecord
orionis.database.migrations.Migrator.html#__deleteRecord
Function
Method
PUBLIC
Remove a migration's tracking record.
-
orionis.database.migrations._EXPORTS
orionis.database.migrations.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.database.migrations.__getattr__
orionis.database.migrations.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.database.migrations.__dir__
orionis.database.migrations.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.database.provider.ConnectionManagerProvider
orionis.database.provider.ConnectionManagerProvider.html
Class
Class
PUBLIC
Register connection manager services in the application container.
-
orionis.database.provider.ConnectionManagerProvider.register
orionis.database.provider.ConnectionManagerProvider.html#register
Function
Method
PUBLIC
Register the connection manager as a singleton in the container.
-
orionis.database.provider.ConnectionManagerProvider.boot
orionis.database.provider.ConnectionManagerProvider.html#boot
Function
Method
PUBLIC
Wire the ORM resolver.
-
orionis.database.redshift.RedshiftConnectorDialect
orionis.database.redshift.html#RedshiftConnectorDialect
Attribute
Variable
PUBLIC
Redshift connector dialect obtained from import_module('sqlalchemy_redshift.dialect').RedshiftDialect_redshift_connector.
-
orionis.database.redshift.RedshiftDialect
orionis.database.redshift.RedshiftDialect.html
Class
Class
PUBLIC
Retain the connector dialect without PostgreSQL-only capabilities.
-
orionis.database.redshift.RedshiftDialect.__slots__
orionis.database.redshift.RedshiftDialect.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.database.redshift.RedshiftDialect.insert_returning
orionis.database.redshift.RedshiftDialect.html#insert_returning
Attribute
Class Variable
PUBLIC
Insert returning flag used by RedshiftDialect.
-
orionis.database.redshift.RedshiftDialect.update_returning
orionis.database.redshift.RedshiftDialect.html#update_returning
Attribute
Class Variable
PUBLIC
Update returning flag used by RedshiftDialect.
-
orionis.database.redshift.RedshiftDialect.delete_returning
orionis.database.redshift.RedshiftDialect.html#delete_returning
Attribute
Class Variable
PUBLIC
Delete returning flag used by RedshiftDialect.
-
orionis.database.redshift.RedshiftDialect.preexecute_autoincrement_sequences
orionis.database.redshift.RedshiftDialect.html#preexecute_autoincrement_sequences
Attribute
Class Variable
PUBLIC
Preexecute autoincrement sequences flag used by RedshiftDialect.
-
orionis.database.redshift.RedshiftDialect.postfetch_lastrowid
orionis.database.redshift.RedshiftDialect.html#postfetch_lastrowid
Attribute
Class Variable
PUBLIC
Postfetch lastrowid flag used by RedshiftDialect.
-
orionis.database.redshift.RedshiftDialect.supports_statement_cache
orionis.database.redshift.RedshiftDialect.html#supports_statement_cache
Attribute
Class Variable
PUBLIC
Supports statement cache flag used by RedshiftDialect.
-
orionis.database.redshift.RedshiftDialect.use_insertmanyvalues_wo_returning
orionis.database.redshift.RedshiftDialect.html#use_insertmanyvalues_wo_returning
Attribute
Class Variable
PUBLIC
The official connector's executemany loops over individual network calls. Core can page supported multi-value INSERTs without RETURNING.
-
orionis.database.redshift.RedshiftDialect.hasTable
orionis.database.redshift.RedshiftDialect.html#hasTable
Function
Method
PUBLIC
Check catalog membership with bound schema and table names.
-
orionis.database.schema.Blueprint
orionis.database.schema.Blueprint.html
Class
Class
PUBLIC
Fluent collector of column definitions for a single table.
-
orionis.database.schema.Blueprint.__slots__
orionis.database.schema.Blueprint.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.database.schema.Blueprint.__init__
orionis.database.schema.Blueprint.html#__init__
Function
Method
PUBLIC
Initialize the blueprint with no columns declared yet.
-
orionis.database.schema.Blueprint.__columns
orionis.database.schema.Blueprint.html#__columns
Attribute
Instance Variable
PUBLIC
Column definitions included in the table schema.
-
orionis.database.schema.Blueprint.__constraints
orionis.database.schema.Blueprint.html#__constraints
Attribute
Instance Variable
PUBLIC
Constraints declared for the table schema.
-
orionis.database.schema.Blueprint.__factory_cache
orionis.database.schema.Blueprint.html#__factory_cache
Attribute
Instance Variable
PUBLIC
Cached factories for constructing schema definitions.
-
orionis.database.schema.Blueprint.__getattr__
orionis.database.schema.Blueprint.html#__getattr__
Function
Method
PUBLIC
Proxy and record a schema column-factory call.
-
orionis.database.schema.Blueprint.timestamps
orionis.database.schema.Blueprint.html#timestamps
Function
Method
PUBLIC
Add nullable created_at and updated_at columns.
-
orionis.database.schema.Blueprint.foreignKey
orionis.database.schema.Blueprint.html#foreignKey
Function
Method
PUBLIC
Declare a foreign key constraint on this table.
-
orionis.database.schema.Blueprint.index
orionis.database.schema.Blueprint.html#index
Function
Method
PUBLIC
Declare an index over one or more columns.
-
orionis.database.schema.Blueprint.primaryKey
orionis.database.schema.Blueprint.html#primaryKey
Function
Method
PUBLIC
Declare a (composite) primary key over one or more columns.
-
orionis.database.schema.Blueprint.unique
orionis.database.schema.Blueprint.html#unique
Function
Method
PUBLIC
Declare a unique constraint over one or more columns.
-
orionis.database.schema.Blueprint.columns
orionis.database.schema.Blueprint.html#columns
Function
Method
PUBLIC
Return the columns declared so far, in declaration order.
-
orionis.database.schema.Blueprint.definitions
orionis.database.schema.Blueprint.html#definitions
Function
Method
PUBLIC
Return every column and table-level constraint declared so far.
-
orionis.database.schema.Column
orionis.database.schema.Column.html
Class
Class
PUBLIC
Create column definitions for database schema declarations.
-
orionis.database.schema.Column.id
orionis.database.schema.Column.html#id
Function
Static Method
PUBLIC
Build a BIGINT primary key column definition.
-
orionis.database.schema.Column.bigInteger
orionis.database.schema.Column.html#bigInteger
Function
Static Method
PUBLIC
Build a BIGINT column definition.
-
orionis.database.schema.Column.boolean
orionis.database.schema.Column.html#boolean
Function
Static Method
PUBLIC
Build a boolean column definition.
-
orionis.database.schema.Column.date
orionis.database.schema.Column.html#date
Function
Static Method
PUBLIC
Build a DATE column definition.
-
orionis.database.schema.Column.dateTime
orionis.database.schema.Column.html#dateTime
Function
Static Method
PUBLIC
Build a DATETIME column definition.
-
orionis.database.schema.Column.double
orionis.database.schema.Column.html#double
Function
Static Method
PUBLIC
Build a DOUBLE column definition.
-
orionis.database.schema.Column.enum
orionis.database.schema.Column.html#enum
Function
Static Method
PUBLIC
Build a string-backed enumeration column definition.
-
orionis.database.schema.Column.float
orionis.database.schema.Column.html#float
Function
Static Method
PUBLIC
Build a FLOAT column definition.
-
orionis.database.schema.Column.integer
orionis.database.schema.Column.html#integer
Function
Static Method
PUBLIC
Build an INTEGER column definition.
-
orionis.database.schema.Column.interval
orionis.database.schema.Column.html#interval
Function
Static Method
PUBLIC
Build an INTERVAL column definition.
-
orionis.database.schema.Column.largeBinary
orionis.database.schema.Column.html#largeBinary
Function
Static Method
PUBLIC
Build a large binary column definition.
-
orionis.database.schema.Column.matchType
orionis.database.schema.Column.html#matchType
Function
Static Method
PUBLIC
Build a MATCH-operator return-type column definition.
-
orionis.database.schema.Column.numeric
orionis.database.schema.Column.html#numeric
Function
Static Method
PUBLIC
Build a NUMERIC column definition.
-
orionis.database.schema.Column.numericCommon
orionis.database.schema.Column.html#numericCommon
Function
Static Method
PUBLIC
Build a numeric-common placeholder column definition.
-
orionis.database.schema.Column.pickleType
orionis.database.schema.Column.html#pickleType
Function
Static Method
PUBLIC
Build a pickle-backed column definition.
-
orionis.database.schema.Column.schemaType
orionis.database.schema.Column.html#schemaType
Function
Static Method
PUBLIC
Build a schema-level placeholder column definition.
-
orionis.database.schema.Column.smallInteger
orionis.database.schema.Column.html#smallInteger
Function
Static Method
PUBLIC
Build a SMALLINT column definition.
-
orionis.database.schema.Column.string
orionis.database.schema.Column.html#string
Function
Static Method
PUBLIC
Build a VARCHAR column definition.
-
orionis.database.schema.Column.text
orionis.database.schema.Column.html#text
Function
Static Method
PUBLIC
Build a TEXT/CLOB column definition.
-
orionis.database.schema.Column.time
orionis.database.schema.Column.html#time
Function
Static Method
PUBLIC
Build a TIME column definition.
-
orionis.database.schema.Column.unicode
orionis.database.schema.Column.html#unicode
Function
Static Method
PUBLIC
Build an NVARCHAR column definition.
-
orionis.database.schema.Column.unicodeText
orionis.database.schema.Column.html#unicodeText
Function
Static Method
PUBLIC
Build an NCLOB/NTEXT column definition.
-
orionis.database.schema.Column.uuid
orionis.database.schema.Column.html#uuid
Function
Static Method
PUBLIC
Build a UUID column definition.
-
orionis.database.schema.Column.strictArray
orionis.database.schema.Column.html#strictArray
Function
Static Method
PUBLIC
Build a SQL ARRAY column definition.
-
orionis.database.schema.Column.strictBigInt
orionis.database.schema.Column.html#strictBigInt
Function
Static Method
PUBLIC
Build a SQL BIGINT column definition.
-
orionis.database.schema.Column.strictBinary
orionis.database.schema.Column.html#strictBinary
Function
Static Method
PUBLIC
Build a SQL BINARY column definition.
-
orionis.database.schema.Column.strictBlob
orionis.database.schema.Column.html#strictBlob
Function
Static Method
PUBLIC
Build a SQL BLOB column definition.
-
orionis.database.schema.Column.strictChar
orionis.database.schema.Column.html#strictChar
Function
Static Method
PUBLIC
Build a SQL CHAR column definition.
-
orionis.database.schema.Column.strictClob
orionis.database.schema.Column.html#strictClob
Function
Static Method
PUBLIC
Build an Oracle/Informix CLOB column definition.
-
orionis.database.schema.Column.strictDecimal
orionis.database.schema.Column.html#strictDecimal
Function
Static Method
PUBLIC
Build a SQL DECIMAL column definition.
-
orionis.database.schema.Column.strictDoublePrecision
orionis.database.schema.Column.html#strictDoublePrecision
Function
Static Method
PUBLIC
Build a SQL DOUBLE PRECISION column definition.
-
orionis.database.schema.Column.strictInt
orionis.database.schema.Column.html#strictInt
Function
Static Method
PUBLIC
Build a SQL INT column definition, alias of INTEGER.
-
orionis.database.schema.Column.strictJson
orionis.database.schema.Column.html#strictJson
Function
Static Method
PUBLIC
Build a SQL JSON column definition.
-
orionis.database.schema.Column.strictNChar
orionis.database.schema.Column.html#strictNChar
Function
Static Method
PUBLIC
Build a SQL NCHAR column definition.
-
orionis.database.schema.Column.strictNVarChar
orionis.database.schema.Column.html#strictNVarChar
Function
Static Method
PUBLIC
Build a SQL NVARCHAR column definition.
-
orionis.database.schema.Column.strictReal
orionis.database.schema.Column.html#strictReal
Function
Static Method
PUBLIC
Build a SQL REAL column definition.
-
orionis.database.schema.Column.strictSmallInt
orionis.database.schema.Column.html#strictSmallInt
Function
Static Method
PUBLIC
Build a SQL SMALLINT column definition.
-
orionis.database.schema.Column.strictTimestamp
orionis.database.schema.Column.html#strictTimestamp
Function
Static Method
PUBLIC
Build a SQL TIMESTAMP column definition.
-
orionis.database.schema.Column.strictVarBinary
orionis.database.schema.Column.html#strictVarBinary
Function
Static Method
PUBLIC
Build a SQL VARBINARY column definition.
-
orionis.database.schema.Column.strictVarChar
orionis.database.schema.Column.html#strictVarChar
Function
Static Method
PUBLIC
Build a SQL VARCHAR column definition.
-
orionis.database.schema.ForeignKey
orionis.database.schema.ForeignKey.html
Class
Class
PUBLIC
Describe a foreign-key constraint and its referential actions.
-
orionis.database.schema.ForeignKey.__init__
orionis.database.schema.ForeignKey.html#__init__
Function
Method
PUBLIC
Initialize a foreign key constraint.
-
orionis.database.schema.ForeignKey.foreign
orionis.database.schema.ForeignKey.html#foreign
Attribute
Instance Variable
PUBLIC
Create a composite foreign key wrapper for single column.
-
orionis.database.schema.Index
orionis.database.schema.Index.html
Class
Class
PUBLIC
Describe a database index and its indexed columns.
-
orionis.database.schema.Index.__init__
orionis.database.schema.Index.html#__init__
Function
Method
PUBLIC
Create an index for database columns.
-
orionis.database.schema.Index.constraint
orionis.database.schema.Index.html#constraint
Attribute
Instance Variable
PUBLIC
Initialize index with provided columns and configuration.
-
orionis.database.schema.PrimaryKey
orionis.database.schema.PrimaryKey.html
Class
Class
PUBLIC
Describe a primary-key constraint on a table.
-
orionis.database.schema.PrimaryKey.__init__
orionis.database.schema.PrimaryKey.html#__init__
Function
Method
PUBLIC
Define a primary key constraint with one or more columns.
-
orionis.database.schema.PrimaryKey.columns
orionis.database.schema.PrimaryKey.html#columns
Attribute
Instance Variable
PUBLIC
The column names for the primary key.
-
orionis.database.schema.Unique
orionis.database.schema.Unique.html
Class
Class
PUBLIC
Describe a uniqueness constraint on table columns.
-
orionis.database.schema.Unique.__init__
orionis.database.schema.Unique.html#__init__
Function
Method
PUBLIC
Define a unique constraint for database columns.
-
orionis.database.schema.Unique.constraint
orionis.database.schema.Unique.html#constraint
Attribute
Instance Variable
PUBLIC
Constraint produced by UniqueConstraint.
-
orionis.database.schema.Timestamps
orionis.database.schema.Timestamps.html
Class
Class
PUBLIC
Describe the standard creation and update timestamp columns.
-
orionis.database.schema.Timestamps.__init__
orionis.database.schema.Timestamps.html#__init__
Function
Method
PUBLIC
Initialize a timestamp column definition.
-
orionis.database.schema.Timestamps.timezone
orionis.database.schema.Timestamps.html#timezone
Attribute
Instance Variable
PUBLIC
Whether the timestamp should include timezone information.
-
orionis.database.schema._EXPORTS
orionis.database.schema.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.database.schema.__getattr__
orionis.database.schema.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.database.schema.__dir__
orionis.database.schema.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.database.schema.definition_bucket.DefinitionBucket
orionis.database.schema.definition_bucket.DefinitionBucket.html
Class
Class
PUBLIC
Mutable accumulator used while classifying schema definitions.
-
orionis.database.schema.definition_bucket.DefinitionBucket.__slots__
orionis.database.schema.definition_bucket.DefinitionBucket.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.database.schema.definition_bucket.DefinitionBucket.__init__
orionis.database.schema.definition_bucket.DefinitionBucket.html#__init__
Function
Method
PUBLIC
Initialize empty containers for each definition kind.
-
orionis.database.schema.definition_bucket.DefinitionBucket.columns
orionis.database.schema.definition_bucket.DefinitionBucket.html#columns
Attribute
Instance Variable
PUBLIC
Column definitions included in the table schema.
-
orionis.database.schema.definition_bucket.DefinitionBucket.primary_columns
orionis.database.schema.definition_bucket.DefinitionBucket.html#primary_columns
Attribute
Instance Variable
PUBLIC
Columns included in the primary-key constraint.
-
orionis.database.schema.definition_bucket.DefinitionBucket.unique_constraints
orionis.database.schema.definition_bucket.DefinitionBucket.html#unique_constraints
Attribute
Instance Variable
PUBLIC
Uniqueness constraints declared for the table.
-
orionis.database.schema.definition_bucket.DefinitionBucket.foreign_keys
orionis.database.schema.definition_bucket.DefinitionBucket.html#foreign_keys
Attribute
Instance Variable
PUBLIC
Foreign-key constraints declared for the table.
-
orionis.database.schema.definition_bucket.DefinitionBucket.indexes
orionis.database.schema.definition_bucket.DefinitionBucket.html#indexes
Attribute
Instance Variable
PUBLIC
Indexes declared for the table.
-
orionis.database.schema.definition_bucket.DefinitionBucket.kwargs
orionis.database.schema.definition_bucket.DefinitionBucket.html#kwargs
Attribute
Instance Variable
PUBLIC
Keyword options forwarded to construction of the underlying object.
-
orionis.database.schema.definitions.SchemaDefinition
orionis.database.schema.definitions.html#SchemaDefinition
Attribute
Type Alias
PUBLIC
A schema definition collected by Blueprint and compiled by Schema.
-
orionis.database.schema.schema.Schema
orionis.database.schema.schema.Schema.html
Class
Class
PUBLIC
Apply database schema operations to the selected connection.
-
orionis.database.schema.schema.Schema.__slots__
orionis.database.schema.schema.Schema.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.database.schema.schema.Schema.__init__
orionis.database.schema.schema.Schema.html#__init__
Function
Method
PUBLIC
Initialize the Schema instance.
-
orionis.database.schema.schema.Schema.__conn_manager
orionis.database.schema.schema.Schema.html#__conn_manager
Attribute
Instance Variable
PUBLIC
The connection manager for database operations.
-
orionis.database.schema.schema.Schema.__connection_name
orionis.database.schema.schema.Schema.html#__connection_name
Attribute
Instance Variable
PUBLIC
Name of the configured database connection to use.
-
orionis.database.schema.schema.Schema.__connection_selected
orionis.database.schema.schema.Schema.html#__connection_selected
Attribute
Instance Variable
PUBLIC
Connection selected flag used by Schema.
-
orionis.database.schema.schema.Schema.connection
orionis.database.schema.schema.Schema.html#connection
Function
Method
PUBLIC
Set the connection name for schema operations.
-
orionis.database.schema.schema.Schema.create
orionis.database.schema.schema.Schema.html#create
Function
Method
PUBLIC
Start a fluent table declaration block.
-
orionis.database.schema.schema.Schema.createFromDefinition
orionis.database.schema.schema.Schema.html#createFromDefinition
Function
Method
PUBLIC
Create a table from its reusable, versioned definition.
-
orionis.database.schema.schema.Schema.createFromModel
orionis.database.schema.schema.Schema.html#createFromModel
Function
Method
PUBLIC
Create the current schema declared by a concrete model.
-
orionis.database.schema.schema.Schema.drop
orionis.database.schema.schema.Schema.html#drop
Function
Method
PUBLIC
Drop an existing table.
-
orionis.database.schema.schema.Schema._createTable
orionis.database.schema.schema.Schema.html#_createTable
Function
Method
PUBLIC
Compile and execute the CREATE TABLE for name.
-
orionis.database.schema.schema.Schema.__resolveConnection
orionis.database.schema.schema.Schema.html#__resolveConnection
Function
Method
PUBLIC
Resolve the connection bound to the configured connection name.
-
orionis.database.schema.schema.Schema.__buildTable
orionis.database.schema.schema.Schema.html#__buildTable
Function
Method
PUBLIC
Build the table definition from a name and its definitions.
-
orionis.database.schema.schema.Schema.__collectDefinitions
orionis.database.schema.schema.Schema.html#__collectDefinitions
Function
Method
PUBLIC
Group heterogeneous schema definitions into constructor kwargs.
-
orionis.database.schema.schema.Schema.__classifyDefinition
orionis.database.schema.schema.Schema.html#__classifyDefinition
Function
Method
PUBLIC
Route a single schema definition into the shared bucket.
-
orionis.database.schema.schema.Schema.__addTimestampColumns
orionis.database.schema.schema.Schema.html#__addTimestampColumns
Function
Method
PUBLIC
Expand a Timestamps marker into its two nullable columns.
-
orionis.database.schema.schema.Schema.__setPrimaryKey
orionis.database.schema.schema.Schema.html#__setPrimaryKey
Function
Method
PUBLIC
Assign the primary key columns, rejecting duplicate definitions.
-
orionis.database.schema.schema.Schema.__parseTableName
orionis.database.schema.schema.Schema.html#__parseTableName
Function
Method
PUBLIC
Parse the table name to extract schema and table components.
-
orionis.database.schema_provider.SchemaProvider
orionis.database.schema_provider.SchemaProvider.html
Class
Class
PUBLIC
Register schema services in the application container.
-
orionis.database.schema_provider.SchemaProvider.register
orionis.database.schema_provider.SchemaProvider.html#register
Function
Method
PUBLIC
Bind the ISchema contract to the Schema implementation.
-
orionis.database.seeders.SeederRunner
orionis.database.seeders.SeederRunner.html
Class
Class
PUBLIC
Apply new seeders exactly once on the selected database connection.
-
orionis.database.seeders.SeederRunner.__slots__
orionis.database.seeders.SeederRunner.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.database.seeders.SeederRunner.__init__
orionis.database.seeders.SeederRunner.html#__init__
Function
Method
PUBLIC
Initialize the runner with the application and connection manager.
-
orionis.database.seeders.SeederRunner.__app
orionis.database.seeders.SeederRunner.html#__app
Attribute
Instance Variable
PUBLIC
Application providing the seeder directory.
-
orionis.database.seeders.SeederRunner.__conn_manager
orionis.database.seeders.SeederRunner.html#__conn_manager
Attribute
Instance Variable
PUBLIC
Manager resolving configured database connections.
-
orionis.database.seeders.SeederRunner.__discovered_cache
orionis.database.seeders.SeederRunner.html#__discovered_cache
Attribute
Instance Variable
PUBLIC
Cached results of filesystem discovery.
-
orionis.database.seeders.SeederRunner.seed
orionis.database.seeders.SeederRunner.html#seed
Function
Method
PUBLIC
Run every discovered seeder that has no committed tracking row.
-
orionis.database.seeders.SeederRunner.__ensureTrackingTable
orionis.database.seeders.SeederRunner.html#__ensureTrackingTable
Function
Method
PUBLIC
Create the tracking table, tolerating a concurrent creator.
-
orionis.database.seeders.SeederRunner.__seedersPath
orionis.database.seeders.SeederRunner.html#__seedersPath
Function
Method
PUBLIC
Return the application's configured seeder directory.
-
orionis.database.seeders.SeederRunner.__discover
orionis.database.seeders.SeederRunner.html#__discover
Function
Method
PUBLIC
Find local Seeder subclasses in deterministic filename order.
-
orionis.database.seeders.SeederRunner.__getRan
orionis.database.seeders.SeederRunner.html#__getRan
Function
Method
PUBLIC
Read committed tracking rows in insertion order.
-
orionis.database.seeders.SeederRunner.__isRecorded
orionis.database.seeders.SeederRunner.html#__isRecorded
Function
Method
PUBLIC
Check whether another transaction committed this seeder.
-
orionis.database.seeders.SeederRunner.__runStep
orionis.database.seeders.SeederRunner.html#__runStep
Function
Method
PUBLIC
Claim, run and commit one seeder and its tracking row.
-
orionis.database.seeders.Seeder
orionis.database.seeders.Seeder.html
Class
Class
PUBLIC
Base class for asynchronous application database seeders.
-
orionis.database.seeders.Seeder.__slots__
orionis.database.seeders.Seeder.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.database.seeders.Seeder.run
orionis.database.seeders.Seeder.html#run
Function
Method
PUBLIC
Insert the application data described by this seeder.
-
orionis.database.seeders._EXPORTS
orionis.database.seeders.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.database.seeders.__getattr__
orionis.database.seeders.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.database.seeders.__dir__
orionis.database.seeders.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.encrypter.encrypter._Payload
orionis.encrypter.encrypter._Payload.html
Class
Class
PUBLIC
Represent serialized encryption payload components.
-
orionis.encrypter.encrypter._Payload.iv
orionis.encrypter.encrypter._Payload.html#iv
Attribute
Instance Variable
PUBLIC
Base64-encoded initialization vector.
-
orionis.encrypter.encrypter._Payload.value
orionis.encrypter.encrypter._Payload.html#value
Attribute
Instance Variable
PUBLIC
Base64-encoded encrypted value.
-
orionis.encrypter.encrypter._Payload.tag
orionis.encrypter.encrypter._Payload.html#tag
Attribute
Instance Variable
PUBLIC
Base64-encoded authentication tag; a missing tag is always rejected.
-
orionis.encrypter.encrypter._Payload.cipher
orionis.encrypter.encrypter._Payload.html#cipher
Attribute
Instance Variable
PUBLIC
Cipher identifier used for encryption.
-
orionis.encrypter.encrypter._PAYLOAD_DECODER
orionis.encrypter.encrypter.module.html#_PAYLOAD_DECODER
Attribute
Constant
PUBLIC
Payload decoder used by encrypter.
-
orionis.encrypter.Encrypter
orionis.encrypter.Encrypter.html
Class
Class
PUBLIC
Encrypt and decrypt application payloads using configured cipher keys.
-
orionis.encrypter.Encrypter.__slots__
orionis.encrypter.Encrypter.html#__slots__
Attribute
Class Variable
PUBLIC
Use __slots__ to prevent dynamic attribute creation and reduce memory usage.
-
orionis.encrypter.Encrypter.AES_128_KEY_SIZE
orionis.encrypter.Encrypter.html#AES_128_KEY_SIZE
Attribute
Constant
PUBLIC
Required key length in bytes for the AES-128 cipher variants.
-
orionis.encrypter.Encrypter.AES_256_KEY_SIZE
orionis.encrypter.Encrypter.html#AES_256_KEY_SIZE
Attribute
Constant
PUBLIC
Required key length in bytes for the AES-256 cipher variants.
-
orionis.encrypter.Encrypter.CBC_IV_SIZE
orionis.encrypter.Encrypter.html#CBC_IV_SIZE
Attribute
Constant
PUBLIC
Retain the legacy CBC IV size; unauthenticated CBC is not accepted.
-
orionis.encrypter.Encrypter.GCM_IV_SIZE
orionis.encrypter.Encrypter.html#GCM_IV_SIZE
Attribute
Constant
PUBLIC
Nonce length in bytes for GCM mode.
-
orionis.encrypter.Encrypter.GCM_TAG_SIZE
orionis.encrypter.Encrypter.html#GCM_TAG_SIZE
Attribute
Constant
PUBLIC
Authentication-tag length in bytes for GCM mode.
-
orionis.encrypter.Encrypter.PKCS7_BLOCK_SIZE
orionis.encrypter.Encrypter.html#PKCS7_BLOCK_SIZE
Attribute
Constant
PUBLIC
Retain the legacy padding size for callers describing old payloads.
-
orionis.encrypter.Encrypter.__init__
orionis.encrypter.Encrypter.html#__init__
Function
Method
PUBLIC
Initialize the encrypter with application configuration.
-
orionis.encrypter.Encrypter.key
orionis.encrypter.Encrypter.html#key
Attribute
Instance Variable
PUBLIC
Normalized immutable application key used by the configured cipher.
-
orionis.encrypter.Encrypter.cipher
orionis.encrypter.Encrypter.html#cipher
Attribute
Instance Variable
PUBLIC
Configured cipher identifier from the supported catalogue.
-
orionis.encrypter.Encrypter._aesgcm
orionis.encrypter.Encrypter.html#_aesgcm
Attribute
Instance Variable
PUBLIC
Reusable authenticated cipher with no mutable per-operation state.
-
orionis.encrypter.Encrypter.encrypt
orionis.encrypter.Encrypter.html#encrypt
Function
Method
PUBLIC
Encrypt plaintext using the configured cipher algorithm.
-
orionis.encrypter.Encrypter.decrypt
orionis.encrypter.Encrypter.html#decrypt
Function
Method
PUBLIC
Decrypt an encrypted payload using the configured cipher algorithm.
-
orionis.encrypter.Encrypter.__decodePayload
orionis.encrypter.Encrypter.html#__decodePayload
Function
Method
PUBLIC
Decode base64 payload and parse as typed _Payload struct.
-
orionis.encrypter.Encrypter.__validateCipherMatch
orionis.encrypter.Encrypter.html#__validateCipherMatch
Function
Method
PUBLIC
Validate that payload cipher matches the configured cipher.
-
orionis.encrypter.Encrypter.__validateIvSize
orionis.encrypter.Encrypter.html#__validateIvSize
Function
Method
PUBLIC
Validate that the IV size matches the configured cipher requirements.
-
orionis.encrypter.Encrypter.__performDecryption
orionis.encrypter.Encrypter.html#__performDecryption
Function
Method
PUBLIC
Perform decryption based on the configured cipher mode.
-
orionis.encrypter.Encrypter.__encryptGCM
orionis.encrypter.Encrypter.html#__encryptGCM
Function
Method
PUBLIC
Encrypt data using AES-GCM mode with authentication.
-
orionis.encrypter.Encrypter.__decryptGCM
orionis.encrypter.Encrypter.html#__decryptGCM
Function
Method
PUBLIC
Decrypt GCM-encrypted data using AESGCM with authentication tag.
-
orionis.encrypter._EXPORTS
orionis.encrypter.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.encrypter.__getattr__
orionis.encrypter.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.encrypter.__dir__
orionis.encrypter.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.encrypter.contracts.IEncrypter
orionis.encrypter.contracts.IEncrypter.html
Class
Class
PUBLIC
Define the contract for encrypter implementations.
-
orionis.encrypter.contracts.IEncrypter.__slots__
orionis.encrypter.contracts.IEncrypter.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.encrypter.contracts.IEncrypter.encrypt
orionis.encrypter.contracts.IEncrypter.html#encrypt
Function
Method
PUBLIC
Encrypt plaintext using the configured cipher algorithm.
-
orionis.encrypter.contracts.IEncrypter.decrypt
orionis.encrypter.contracts.IEncrypter.html#decrypt
Function
Method
PUBLIC
Decrypt an encrypted payload using the configured cipher algorithm.
-
orionis.encrypter.provider.EncrypterProvider
orionis.encrypter.provider.EncrypterProvider.html
Class
Class
PUBLIC
Service provider for the Orionis encryption system.
-
orionis.encrypter.provider.EncrypterProvider.register
orionis.encrypter.provider.EncrypterProvider.html#register
Function
Method
PUBLIC
Bind the encrypter contract to its singleton implementation.
-
orionis.encrypter.provider.EncrypterProvider.boot
orionis.encrypter.provider.EncrypterProvider.html#boot
Function
Method
PUBLIC
Pin the Crypt facade after all services are registered.
-
orionis.failure.Catch
orionis.failure.Catch.html
Class
Class
PUBLIC
Resolve the unified handling plan and request native presentation.
-
orionis.failure.Catch.__init__
orionis.failure.Catch.html#__init__
Function
Method
PUBLIC
Initialize exception handling for the application.
-
orionis.failure.Catch.__app
orionis.failure.Catch.html#__app
Attribute
Instance Variable
PUBLIC
The application instance used to resolve required services.
-
orionis.failure.Catch.__standalone_runtime
orionis.failure.Catch.html#__standalone_runtime
Attribute
Instance Variable
PUBLIC
Inactive coordinator for explicitly invoked standalone handling.
-
orionis.failure.Catch.capture
orionis.failure.Catch.html#capture
Function
Method
PUBLIC
Observe an exception through the application's active failure runtime.
-
orionis.failure.Catch.exception
orionis.failure.Catch.html#exception
Function
Method
PUBLIC
Handle an exception in the current kernel context.
-
orionis.failure._EXPORTS
orionis.failure.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.failure.__getattr__
orionis.failure.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.failure.__dir__
orionis.failure.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.foundation.contracts.directory.IDirectory
orionis.foundation.contracts.directory.IDirectory.html
Class
Class
PUBLIC
Define access to the application directory paths.
-
orionis.foundation.contracts.directory.IDirectory.__slots__
orionis.foundation.contracts.directory.IDirectory.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.foundation.contracts.directory.IDirectory.root
orionis.foundation.contracts.directory.IDirectory.html#root
Function
Method
PUBLIC
Return the application root directory.
-
orionis.foundation.contracts.directory.IDirectory.app
orionis.foundation.contracts.directory.IDirectory.html#app
Function
Method
PUBLIC
Return the application directory.
-
orionis.foundation.contracts.directory.IDirectory.appConsole
orionis.foundation.contracts.directory.IDirectory.html#appConsole
Function
Method
PUBLIC
Return the application console directory.
-
orionis.foundation.contracts.directory.IDirectory.appConsoleCommands
orionis.foundation.contracts.directory.IDirectory.html#appConsoleCommands
Function
Method
PUBLIC
Return the application console commands directory.
-
orionis.foundation.contracts.directory.IDirectory.appConsoleListeners
orionis.foundation.contracts.directory.IDirectory.html#appConsoleListeners
Function
Method
PUBLIC
Return the application console listeners directory.
-
orionis.foundation.contracts.directory.IDirectory.appExceptions
orionis.foundation.contracts.directory.IDirectory.html#appExceptions
Function
Method
PUBLIC
Return the application exceptions directory.
-
orionis.foundation.contracts.directory.IDirectory.appHttp
orionis.foundation.contracts.directory.IDirectory.html#appHttp
Function
Method
PUBLIC
Return the application HTTP directory.
-
orionis.foundation.contracts.directory.IDirectory.appHttpControllers
orionis.foundation.contracts.directory.IDirectory.html#appHttpControllers
Function
Method
PUBLIC
Return the application controllers directory.
-
orionis.foundation.contracts.directory.IDirectory.appHttpMiddleware
orionis.foundation.contracts.directory.IDirectory.html#appHttpMiddleware
Function
Method
PUBLIC
Return the application HTTP middleware directory.
-
orionis.foundation.contracts.directory.IDirectory.appHttpSchemas
orionis.foundation.contracts.directory.IDirectory.html#appHttpSchemas
Function
Method
PUBLIC
Return the application HTTP schemas directory.
-
orionis.foundation.contracts.directory.IDirectory.appHttpSchemasRules
orionis.foundation.contracts.directory.IDirectory.html#appHttpSchemasRules
Function
Method
PUBLIC
Return the application HTTP schema rules directory.
-
orionis.foundation.contracts.directory.IDirectory.appModels
orionis.foundation.contracts.directory.IDirectory.html#appModels
Function
Method
PUBLIC
Return the application models directory.
-
orionis.foundation.contracts.directory.IDirectory.appProviders
orionis.foundation.contracts.directory.IDirectory.html#appProviders
Function
Method
PUBLIC
Return the application providers directory.
-
orionis.foundation.contracts.directory.IDirectory.appNotifications
orionis.foundation.contracts.directory.IDirectory.html#appNotifications
Function
Method
PUBLIC
Return the application notifications directory.
-
orionis.foundation.contracts.directory.IDirectory.appServices
orionis.foundation.contracts.directory.IDirectory.html#appServices
Function
Method
PUBLIC
Return the application services directory.
-
orionis.foundation.contracts.directory.IDirectory.appFacades
orionis.foundation.contracts.directory.IDirectory.html#appFacades
Function
Method
PUBLIC
Return the application facades directory.
-
orionis.foundation.contracts.directory.IDirectory.appJobs
orionis.foundation.contracts.directory.IDirectory.html#appJobs
Function
Method
PUBLIC
Return the application jobs directory.
-
orionis.foundation.contracts.directory.IDirectory.appContracts
orionis.foundation.contracts.directory.IDirectory.html#appContracts
Function
Method
PUBLIC
Return the application contracts directory.
-
orionis.foundation.contracts.directory.IDirectory.bootstrap
orionis.foundation.contracts.directory.IDirectory.html#bootstrap
Function
Method
PUBLIC
Return the bootstrap directory.
-
orionis.foundation.contracts.directory.IDirectory.config
orionis.foundation.contracts.directory.IDirectory.html#config
Function
Method
PUBLIC
Return the configuration directory.
-
orionis.foundation.contracts.directory.IDirectory.database
orionis.foundation.contracts.directory.IDirectory.html#database
Function
Method
PUBLIC
Return the database directory.
-
orionis.foundation.contracts.directory.IDirectory.databaseFactories
orionis.foundation.contracts.directory.IDirectory.html#databaseFactories
Function
Method
PUBLIC
Return the database factories directory.
-
orionis.foundation.contracts.directory.IDirectory.databaseMigrations
orionis.foundation.contracts.directory.IDirectory.html#databaseMigrations
Function
Method
PUBLIC
Return the database migrations directory.
-
orionis.foundation.contracts.directory.IDirectory.databaseSchemas
orionis.foundation.contracts.directory.IDirectory.html#databaseSchemas
Function
Method
PUBLIC
Return the database schemas directory.
-
orionis.foundation.contracts.directory.IDirectory.databaseSeeders
orionis.foundation.contracts.directory.IDirectory.html#databaseSeeders
Function
Method
PUBLIC
Return the database seeders directory.
-
orionis.foundation.contracts.directory.IDirectory.resources
orionis.foundation.contracts.directory.IDirectory.html#resources
Function
Method
PUBLIC
Return the resources directory.
-
orionis.foundation.contracts.directory.IDirectory.resourcesCss
orionis.foundation.contracts.directory.IDirectory.html#resourcesCss
Function
Method
PUBLIC
Return the resources CSS directory.
-
orionis.foundation.contracts.directory.IDirectory.resourcesJs
orionis.foundation.contracts.directory.IDirectory.html#resourcesJs
Function
Method
PUBLIC
Return the resources JavaScript directory.
-
orionis.foundation.contracts.directory.IDirectory.resourcesLang
orionis.foundation.contracts.directory.IDirectory.html#resourcesLang
Function
Method
PUBLIC
Return the resources language directory.
-
orionis.foundation.contracts.directory.IDirectory.resourcesViews
orionis.foundation.contracts.directory.IDirectory.html#resourcesViews
Function
Method
PUBLIC
Return the resources views directory.
-
orionis.foundation.contracts.directory.IDirectory.routes
orionis.foundation.contracts.directory.IDirectory.html#routes
Function
Method
PUBLIC
Return the routes directory.
-
orionis.foundation.contracts.directory.IDirectory.storage
orionis.foundation.contracts.directory.IDirectory.html#storage
Function
Method
PUBLIC
Return the storage directory.
-
orionis.foundation.contracts.directory.IDirectory.storageApp
orionis.foundation.contracts.directory.IDirectory.html#storageApp
Function
Method
PUBLIC
Return the storage application directory.
-
orionis.foundation.contracts.directory.IDirectory.storageAppPrivate
orionis.foundation.contracts.directory.IDirectory.html#storageAppPrivate
Function
Method
PUBLIC
Return the private storage application directory.
-
orionis.foundation.contracts.directory.IDirectory.storageAppPublic
orionis.foundation.contracts.directory.IDirectory.html#storageAppPublic
Function
Method
PUBLIC
Return the public storage application directory.
-
orionis.foundation.contracts.directory.IDirectory.storageFramework
orionis.foundation.contracts.directory.IDirectory.html#storageFramework
Function
Method
PUBLIC
Return the framework storage directory.
-
orionis.foundation.contracts.directory.IDirectory.storageLogs
orionis.foundation.contracts.directory.IDirectory.html#storageLogs
Function
Method
PUBLIC
Return the storage logs directory.
-
orionis.foundation.contracts.directory.IDirectory.tests
orionis.foundation.contracts.directory.IDirectory.html#tests
Function
Method
PUBLIC
Return the tests directory.
-
orionis.foundation.contracts.directory.IDirectory.appMcp
orionis.foundation.contracts.directory.IDirectory.html#appMcp
Function
Method
PUBLIC
Return the MCP application directory.
-
orionis.foundation.contracts.directory.IDirectory.appMcpServers
orionis.foundation.contracts.directory.IDirectory.html#appMcpServers
Function
Method
PUBLIC
Return the MCP server declarations directory.
-
orionis.foundation.contracts.directory.IDirectory.appMcpTools
orionis.foundation.contracts.directory.IDirectory.html#appMcpTools
Function
Method
PUBLIC
Return the MCP tool declarations directory.
-
orionis.foundation.contracts.directory.IDirectory.appMcpResources
orionis.foundation.contracts.directory.IDirectory.html#appMcpResources
Function
Method
PUBLIC
Return the MCP resource declarations directory.
-
orionis.foundation.contracts.directory.IDirectory.appMcpPrompts
orionis.foundation.contracts.directory.IDirectory.html#appMcpPrompts
Function
Method
PUBLIC
Return the MCP prompt declarations directory.
-
orionis.foundation.contracts.directory.IDirectory.appRealtime
orionis.foundation.contracts.directory.IDirectory.html#appRealtime
Function
Method
PUBLIC
Return the realtime application directory.
-
orionis.foundation.contracts.directory.IDirectory.appRealtimeSockets
orionis.foundation.contracts.directory.IDirectory.html#appRealtimeSockets
Function
Method
PUBLIC
Return the realtime WebSocket handlers directory.
-
orionis.foundation.contracts.directory.IDirectory.appRealtimeHubs
orionis.foundation.contracts.directory.IDirectory.html#appRealtimeHubs
Function
Method
PUBLIC
Return the realtime hubs directory.
-
orionis.foundation.directory.Directory
orionis.foundation.directory.Directory.html
Class
Class
PUBLIC
Expose the configured application directories.
-
orionis.foundation.directory.Directory.__slots__
orionis.foundation.directory.Directory.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.foundation.directory.Directory.__init__
orionis.foundation.directory.Directory.html#__init__
Function
Method
PUBLIC
Snapshot all resolved application paths from their shared mapping.
-
orionis.foundation.directory.Directory._all_paths
orionis.foundation.directory.Directory.html#_all_paths
Attribute
Instance Variable
PUBLIC
All paths produced by dict.
-
orionis.foundation.directory.Directory._path
orionis.foundation.directory.Directory.html#_path
Function
Method
PUBLIC
Return a cached path for a configured key.
-
orionis.foundation.directory.Directory.root
orionis.foundation.directory.Directory.html#root
Function
Method
PUBLIC
Return the application root directory.
-
orionis.foundation.directory.Directory.app
orionis.foundation.directory.Directory.html#app
Function
Method
PUBLIC
Return the application directory.
-
orionis.foundation.directory.Directory.appConsole
orionis.foundation.directory.Directory.html#appConsole
Function
Method
PUBLIC
Return the application console directory.
-
orionis.foundation.directory.Directory.appConsoleCommands
orionis.foundation.directory.Directory.html#appConsoleCommands
Function
Method
PUBLIC
Return the application console commands directory.
-
orionis.foundation.directory.Directory.appConsoleListeners
orionis.foundation.directory.Directory.html#appConsoleListeners
Function
Method
PUBLIC
Return the application console listeners directory.
-
orionis.foundation.directory.Directory.appExceptions
orionis.foundation.directory.Directory.html#appExceptions
Function
Method
PUBLIC
Return the application exceptions directory.
-
orionis.foundation.directory.Directory.appHttp
orionis.foundation.directory.Directory.html#appHttp
Function
Method
PUBLIC
Return the application HTTP directory.
-
orionis.foundation.directory.Directory.appHttpControllers
orionis.foundation.directory.Directory.html#appHttpControllers
Function
Method
PUBLIC
Return the application controllers directory.
-
orionis.foundation.directory.Directory.appHttpMiddleware
orionis.foundation.directory.Directory.html#appHttpMiddleware
Function
Method
PUBLIC
Return the application HTTP middleware directory.
-
orionis.foundation.directory.Directory.appHttpSchemas
orionis.foundation.directory.Directory.html#appHttpSchemas
Function
Method
PUBLIC
Return the application HTTP schemas directory.
-
orionis.foundation.directory.Directory.appHttpSchemasRules
orionis.foundation.directory.Directory.html#appHttpSchemasRules
Function
Method
PUBLIC
Return the application HTTP schema rules directory.
-
orionis.foundation.directory.Directory.appModels
orionis.foundation.directory.Directory.html#appModels
Function
Method
PUBLIC
Return the application models directory.
-
orionis.foundation.directory.Directory.appMcp
orionis.foundation.directory.Directory.html#appMcp
Function
Method
PUBLIC
Return the MCP application directory.
-
orionis.foundation.directory.Directory.appMcpServers
orionis.foundation.directory.Directory.html#appMcpServers
Function
Method
PUBLIC
Return the MCP server declaration directory.
-
orionis.foundation.directory.Directory.appMcpTools
orionis.foundation.directory.Directory.html#appMcpTools
Function
Method
PUBLIC
Return the MCP tool declaration directory.
-
orionis.foundation.directory.Directory.appMcpResources
orionis.foundation.directory.Directory.html#appMcpResources
Function
Method
PUBLIC
Return the MCP resource declaration directory.
-
orionis.foundation.directory.Directory.appMcpPrompts
orionis.foundation.directory.Directory.html#appMcpPrompts
Function
Method
PUBLIC
Return the MCP prompt declaration directory.
-
orionis.foundation.directory.Directory.appRealtime
orionis.foundation.directory.Directory.html#appRealtime
Function
Method
PUBLIC
Return the realtime application directory.
-
orionis.foundation.directory.Directory.appRealtimeSockets
orionis.foundation.directory.Directory.html#appRealtimeSockets
Function
Method
PUBLIC
Return the realtime WebSocket handlers directory.
-
orionis.foundation.directory.Directory.appRealtimeHubs
orionis.foundation.directory.Directory.html#appRealtimeHubs
Function
Method
PUBLIC
Return the realtime hubs directory.
-
orionis.foundation.directory.Directory.appProviders
orionis.foundation.directory.Directory.html#appProviders
Function
Method
PUBLIC
Return the application providers directory.
-
orionis.foundation.directory.Directory.appNotifications
orionis.foundation.directory.Directory.html#appNotifications
Function
Method
PUBLIC
Return the application notifications directory.
-
orionis.foundation.directory.Directory.appServices
orionis.foundation.directory.Directory.html#appServices
Function
Method
PUBLIC
Return the application services directory.
-
orionis.foundation.directory.Directory.appFacades
orionis.foundation.directory.Directory.html#appFacades
Function
Method
PUBLIC
Return the application facades directory.
-
orionis.foundation.directory.Directory.appJobs
orionis.foundation.directory.Directory.html#appJobs
Function
Method
PUBLIC
Return the application jobs directory.
-
orionis.foundation.directory.Directory.appContracts
orionis.foundation.directory.Directory.html#appContracts
Function
Method
PUBLIC
Return the application contracts directory.
-
orionis.foundation.directory.Directory.bootstrap
orionis.foundation.directory.Directory.html#bootstrap
Function
Method
PUBLIC
Return the bootstrap directory.
-
orionis.foundation.directory.Directory.config
orionis.foundation.directory.Directory.html#config
Function
Method
PUBLIC
Return the configuration directory.
-
orionis.foundation.directory.Directory.database
orionis.foundation.directory.Directory.html#database
Function
Method
PUBLIC
Return the database directory.
-
orionis.foundation.directory.Directory.databaseFactories
orionis.foundation.directory.Directory.html#databaseFactories
Function
Method
PUBLIC
Return the database factories directory.
-
orionis.foundation.directory.Directory.databaseMigrations
orionis.foundation.directory.Directory.html#databaseMigrations
Function
Method
PUBLIC
Return the database migrations directory.
-
orionis.foundation.directory.Directory.databaseSchemas
orionis.foundation.directory.Directory.html#databaseSchemas
Function
Method
PUBLIC
Return the database schemas directory.
-
orionis.foundation.directory.Directory.databaseSeeders
orionis.foundation.directory.Directory.html#databaseSeeders
Function
Method
PUBLIC
Return the database seeders directory.
-
orionis.foundation.directory.Directory.resources
orionis.foundation.directory.Directory.html#resources
Function
Method
PUBLIC
Return the resources directory.
-
orionis.foundation.directory.Directory.resourcesCss
orionis.foundation.directory.Directory.html#resourcesCss
Function
Method
PUBLIC
Return the resources CSS directory.
-
orionis.foundation.directory.Directory.resourcesJs
orionis.foundation.directory.Directory.html#resourcesJs
Function
Method
PUBLIC
Return the resources JavaScript directory.
-
orionis.foundation.directory.Directory.resourcesLang
orionis.foundation.directory.Directory.html#resourcesLang
Function
Method
PUBLIC
Return the resources language directory.
-
orionis.foundation.directory.Directory.resourcesViews
orionis.foundation.directory.Directory.html#resourcesViews
Function
Method
PUBLIC
Return the resources views directory.
-
orionis.foundation.directory.Directory.routes
orionis.foundation.directory.Directory.html#routes
Function
Method
PUBLIC
Return the routes directory.
-
orionis.foundation.directory.Directory.storage
orionis.foundation.directory.Directory.html#storage
Function
Method
PUBLIC
Return the storage directory.
-
orionis.foundation.directory.Directory.storageApp
orionis.foundation.directory.Directory.html#storageApp
Function
Method
PUBLIC
Return the storage application directory.
-
orionis.foundation.directory.Directory.storageAppPrivate
orionis.foundation.directory.Directory.html#storageAppPrivate
Function
Method
PUBLIC
Return the private storage application directory.
-
orionis.foundation.directory.Directory.storageAppPublic
orionis.foundation.directory.Directory.html#storageAppPublic
Function
Method
PUBLIC
Return the public storage application directory.
-
orionis.foundation.directory.Directory.storageFramework
orionis.foundation.directory.Directory.html#storageFramework
Function
Method
PUBLIC
Return the framework storage directory.
-
orionis.foundation.directory.Directory.storageLogs
orionis.foundation.directory.Directory.html#storageLogs
Function
Method
PUBLIC
Return the storage logs directory.
-
orionis.foundation.directory.Directory.tests
orionis.foundation.directory.Directory.html#tests
Function
Method
PUBLIC
Return the tests directory.
-
orionis.http.default.assistance.CHATGPT_URL_MAX_LENGTH
orionis.http.default.assistance.html#CHATGPT_URL_MAX_LENGTH
Attribute
Constant
PUBLIC
Apply a conservative application limit to the complete outgoing URL.
-
orionis.http.default.assistance._CHATGPT_URL_PREFIX
orionis.http.default.assistance.html#_CHATGPT_URL_PREFIX
Attribute
Constant
PUBLIC
https://chatgpt.com/?prompt=.
-
orionis.http.default.assistance._PROMPT_BUDGET
orionis.http.default.assistance.html#_PROMPT_BUDGET
Attribute
Constant
PUBLIC
Prompt budget used by assistance.
-
orionis.http.default.assistance._PROMPT_START
orionis.http.default.assistance.html#_PROMPT_START
Attribute
Constant
PUBLIC
Opening instruction included in the bounded error-assistance prompt.
-
orionis.http.default.assistance._FRAME_HEADING
orionis.http.default.assistance.html#_FRAME_HEADING
Attribute
Constant
PUBLIC
Section heading introducing the error traceback frames.
-
orionis.http.default.assistance._SOURCE_NOTICE
orionis.http.default.assistance.html#_SOURCE_NOTICE
Attribute
Constant
PUBLIC
`` [Source snippets omitted to fit the URL limit.]``.
-
orionis.http.default.assistance._TRUNCATION_NOTICE
orionis.http.default.assistance.html#_TRUNCATION_NOTICE
Attribute
Constant
PUBLIC
`` [Truncated to fit URL: source snippets omitted; {omitted} older frames omitted.]``.
-
orionis.http.default.assistance._MIN_FRAME_BUDGET
orionis.http.default.assistance.html#_MIN_FRAME_BUDGET
Attribute
Constant
PUBLIC
Min frame budget value used by assistance.
-
orionis.http.default.assistance._ESCAPE_WIDTH
orionis.http.default.assistance.html#_ESCAPE_WIDTH
Attribute
Constant
PUBLIC
Escape width value used by assistance.
-
orionis.http.default.assistance._encode_bounded
orionis.http.default.assistance.html#_encode_bounded
Function
Function
PUBLIC
Encode a bounded UTF-8 prefix or suffix.
-
orionis.http.default.assistance._encode_field
orionis.http.default.assistance.html#_encode_field
Function
Function
PUBLIC
Encode a field and mark any truncation.
-
orionis.http.default.assistance._prompt_parts
orionis.http.default.assistance.html#_prompt_parts
Function
Function
PUBLIC
Yield the diagnostic header and captured frames.
-
orionis.http.default.assistance._frame_parts
orionis.http.default.assistance.html#_frame_parts
Function
Function
PUBLIC
Yield frame locations and optional source lines.
-
orionis.http.default.assistance._try_prompt
orionis.http.default.assistance.html#_try_prompt
Function
Function
PUBLIC
Encode a prompt only when all fields fit within the limit.
-
orionis.http.default.assistance._compact_frame
orionis.http.default.assistance.html#_compact_frame
Function
Function
PUBLIC
Build a compact representation of one traceback frame.
-
orionis.http.default.assistance._compact_prompt
orionis.http.default.assistance.html#_compact_prompt
Function
Function
PUBLIC
Build a compact prompt when the full traceback does not fit.
-
orionis.http.default.assistance.build_chatgpt_url
orionis.http.default.assistance.html#build_chatgpt_url
Function
Function
PUBLIC
Build a compact, encoded diagnostic link within a local URL budget.
-
orionis.http.default.contracts.responses.IDefaultResponses
orionis.http.default.contracts.responses.IDefaultResponses.html
Class
Class
PUBLIC
Define the contract for default responses implementations.
-
orionis.http.default.contracts.responses.IDefaultResponses.__slots__
orionis.http.default.contracts.responses.IDefaultResponses.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.http.default.contracts.responses.IDefaultResponses.favicon
orionis.http.default.contracts.responses.IDefaultResponses.html#favicon
Function
Method
PUBLIC
Return the favicon file response or a 404 response if not found.
-
orionis.http.default.contracts.responses.IDefaultResponses.robotsTxt
orionis.http.default.contracts.responses.IDefaultResponses.html#robotsTxt
Function
Method
PUBLIC
Return the robots.txt file or a 404 response if not found.
-
orionis.http.default.contracts.responses.IDefaultResponses.sitemapXml
orionis.http.default.contracts.responses.IDefaultResponses.html#sitemapXml
Function
Method
PUBLIC
Return the public sitemap.xml file, or a 404 response when absent.
-
orionis.http.default.contracts.responses.IDefaultResponses.health
orionis.http.default.contracts.responses.IDefaultResponses.html#health
Function
Method
PUBLIC
Render the application health state as an HTML or JSON response.
-
orionis.http.default.contracts.responses.IDefaultResponses.error
orionis.http.default.contracts.responses.IDefaultResponses.html#error
Function
Method
PUBLIC
Return an error page or JSON response for the specified status code.
-
orionis.http.default.contracts.responses.IDefaultResponses.exception
orionis.http.default.contracts.responses.IDefaultResponses.html#exception
Function
Method
PUBLIC
Render an exception page with request and traceback details.
-
orionis.http.default.contracts.responses.IDefaultResponses.dump
orionis.http.default.contracts.responses.IDefaultResponses.html#dump
Function
Method
PUBLIC
Wrap an escaped variable dump in the framework's diagnostic layout.
-
orionis.http.default.contracts.responses.IDefaultResponses.asset
orionis.http.default.contracts.responses.IDefaultResponses.html#asset
Function
Method
PUBLIC
Return an allowlisted framework asset, or a 404 response.
-
orionis.view.contracts.engine.IViewEngine
orionis.view.contracts.engine.IViewEngine.html
Class
Class
PUBLIC
Define the operations provided by a view engine.
-
orionis.view.contracts.engine.IViewEngine.__slots__
orionis.view.contracts.engine.IViewEngine.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.view.contracts.engine.IViewEngine.warmup
orionis.view.contracts.engine.IViewEngine.html#warmup
Function
Method
PUBLIC
Prepare known templates without evaluating render context when supported.
-
orionis.view.contracts.engine.IViewEngine.render
orionis.view.contracts.engine.IViewEngine.html#render
Function
Method
PUBLIC
Render a template with the supplied context and return HTML.
-
orionis.support.formatter.exceptions.contracts.parser.IExceptionParser
orionis.support.formatter.exceptions.contracts.parser.IExceptionParser.html
Class
Class
PUBLIC
Define the contract for exception parser implementations.
-
orionis.support.formatter.exceptions.contracts.parser.IExceptionParser.toDict
orionis.support.formatter.exceptions.contracts.parser.IExceptionParser.html#toDict
Function
Method
PUBLIC
Serialize exception details into a dictionary.
-
orionis.support.formatter.exceptions.parser.ExceptionParser
orionis.support.formatter.exceptions.parser.ExceptionParser.html
Class
Class
PUBLIC
Extract structured details from exceptions and tracebacks.
-
orionis.support.formatter.exceptions.parser.ExceptionParser.__slots__
orionis.support.formatter.exceptions.parser.ExceptionParser.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.support.formatter.exceptions.parser.ExceptionParser.__init__
orionis.support.formatter.exceptions.parser.ExceptionParser.html#__init__
Function
Method
PUBLIC
Initialize ExceptionParser with an exception instance.
-
orionis.support.formatter.exceptions.parser.ExceptionParser._tb
orionis.support.formatter.exceptions.parser.ExceptionParser.html#_tb
Attribute
Instance Variable
PUBLIC
Tb supplied through tb.
-
orionis.support.formatter.exceptions.parser.ExceptionParser._exc_type
orionis.support.formatter.exceptions.parser.ExceptionParser.html#_exc_type
Attribute
Instance Variable
PUBLIC
Type of the exception being formatted.
-
orionis.support.formatter.exceptions.parser.ExceptionParser._error_code
orionis.support.formatter.exceptions.parser.ExceptionParser.html#_error_code
Attribute
Instance Variable
PUBLIC
Error code produced by getattr.
-
orionis.support.formatter.exceptions.parser.ExceptionParser._cache
orionis.support.formatter.exceptions.parser.ExceptionParser.html#_cache
Attribute
Instance Variable
PUBLIC
Cache policy or cached state used by this component.
-
orionis.support.formatter.exceptions.parser.ExceptionParser.toDict
orionis.support.formatter.exceptions.parser.ExceptionParser.html#toDict
Function
Method
PUBLIC
Serialize exception details into a dictionary.
-
orionis.support.formatter.exceptions.parser.ExceptionParser._getSourceCode
orionis.support.formatter.exceptions.parser.ExceptionParser.html#_getSourceCode
Function
Method
PUBLIC
Extract source code lines around a specific line number from a file.
-
orionis.support.formatter.exceptions.parser.ExceptionParser._parseStack
orionis.support.formatter.exceptions.parser.ExceptionParser.html#_parseStack
Function
Method
PUBLIC
Parse stack trace summary into frame dictionaries.
-
orionis.http.default.responses._STATUS_MESSAGES
orionis.http.default.responses.html#_STATUS_MESSAGES
Attribute
Constant
PUBLIC
Human-readable labels for validated HTTP status codes.
-
orionis.http.default.responses._MIN_STATUS_CODE
orionis.http.default.responses.html#_MIN_STATUS_CODE
Attribute
Constant
PUBLIC
Min status code value used by responses.
-
orionis.http.default.responses._MAX_STATUS_CODE
orionis.http.default.responses.html#_MAX_STATUS_CODE
Attribute
Constant
PUBLIC
Max status code value used by responses.
-
orionis.http.default.responses._FRAMEWORK_VERSION
orionis.http.default.responses.html#_FRAMEWORK_VERSION
Attribute
Constant
PUBLIC
Framework version used by responses.
-
orionis.http.default.responses._PYTHON_VERSION
orionis.http.default.responses.html#_PYTHON_VERSION
Attribute
Constant
PUBLIC
Python version used by responses.
-
orionis.http.default.responses._LOCALE_CONFIG_KEY
orionis.http.default.responses.html#_LOCALE_CONFIG_KEY
Attribute
Constant
PUBLIC
app.locale.
-
orionis.http.default.responses._validate_status_code
orionis.http.default.responses.html#_validate_status_code
Function
Function
PUBLIC
Validate an HTTP status before either response format is rendered.
-
orionis.http.default.responses._status_message
orionis.http.default.responses.html#_status_message
Function
Function
PUBLIC
Return the display label for a validated HTTP status.
-
orionis.http.default.responses.DefaultResponses
orionis.http.default.responses.DefaultResponses.html
Class
Class
PUBLIC
Render the framework default HTTP error and status responses.
-
orionis.http.default.responses.DefaultResponses.__slots__
orionis.http.default.responses.DefaultResponses.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.http.default.responses.DefaultResponses._FAVICON_CACHE_CONTROL_AGE
orionis.http.default.responses.DefaultResponses.html#_FAVICON_CACHE_CONTROL_AGE
Attribute
Constant
PUBLIC
public, max-age=31536000, immutable.
-
orionis.http.default.responses.DefaultResponses._FAVICON_NAME
orionis.http.default.responses.DefaultResponses.html#_FAVICON_NAME
Attribute
Constant
PUBLIC
favicon.ico.
-
orionis.http.default.responses.DefaultResponses._FONT_CONTENT_TYPE
orionis.http.default.responses.DefaultResponses.html#_FONT_CONTENT_TYPE
Attribute
Constant
PUBLIC
font/ttf.
-
orionis.http.default.responses.DefaultResponses._WEB_FONT_CONTENT_TYPE
orionis.http.default.responses.DefaultResponses.html#_WEB_FONT_CONTENT_TYPE
Attribute
Constant
PUBLIC
font/woff2.
-
orionis.http.default.responses.DefaultResponses._GENERAL_CACHE_CONTROL
orionis.http.default.responses.DefaultResponses.html#_GENERAL_CACHE_CONTROL
Attribute
Constant
PUBLIC
no-cache, no-store, must-revalidate.
-
orionis.http.default.responses.DefaultResponses.ASSET_PREFIX
orionis.http.default.responses.DefaultResponses.html#ASSET_PREFIX
Attribute
Constant
PUBLIC
Only these package-owned files can be served through the reserved URL.
-
orionis.http.default.responses.DefaultResponses._ASSET_BASE
orionis.http.default.responses.DefaultResponses.html#_ASSET_BASE
Attribute
Constant
PUBLIC
Asset base used by DefaultResponses.
-
orionis.http.default.responses.DefaultResponses._ASSETS_DIR
orionis.http.default.responses.DefaultResponses.html#_ASSETS_DIR
Attribute
Constant
PUBLIC
Assets dir used by DefaultResponses.
-
orionis.http.default.responses.DefaultResponses._FAVICON_CANDIDATES
orionis.http.default.responses.DefaultResponses.html#_FAVICON_CANDIDATES
Attribute
Constant
PUBLIC
Favicon candidates in order of preference.
-
orionis.http.default.responses.DefaultResponses._ROBOTS_CANDIDATES
orionis.http.default.responses.DefaultResponses.html#_ROBOTS_CANDIDATES
Attribute
Constant
PUBLIC
Robots candidates definitions used by DefaultResponses.
-
orionis.http.default.responses.DefaultResponses._SITEMAP_CANDIDATES
orionis.http.default.responses.DefaultResponses.html#_SITEMAP_CANDIDATES
Attribute
Constant
PUBLIC
Sitemap candidates definitions used by DefaultResponses.
-
orionis.http.default.responses.DefaultResponses._TEMPLATES
orionis.http.default.responses.DefaultResponses.html#_TEMPLATES
Attribute
Constant
PUBLIC
Templates definitions used by DefaultResponses.
-
orionis.http.default.responses.DefaultResponses._HEALTH_STATES
orionis.http.default.responses.DefaultResponses.html#_HEALTH_STATES
Attribute
Constant
PUBLIC
Map the maintenance flag to the health response metadata.
-
orionis.http.default.responses.DefaultResponses.__init__
orionis.http.default.responses.DefaultResponses.html#__init__
Function
Method
PUBLIC
Initialize instance with application and directory dependencies.
-
orionis.http.default.responses.DefaultResponses.__app
orionis.http.default.responses.DefaultResponses.html#__app
Attribute
Instance Variable
PUBLIC
The application instance providing configuration and services.
-
orionis.http.default.responses.DefaultResponses.__directory
orionis.http.default.responses.DefaultResponses.html#__directory
Attribute
Instance Variable
PUBLIC
The directory service for accessing storage paths.
-
orionis.http.default.responses.DefaultResponses.__engine
orionis.http.default.responses.DefaultResponses.html#__engine
Attribute
Instance Variable
PUBLIC
Official asynchronous template rendering engine.
-
orionis.http.default.responses.DefaultResponses.__app_name
orionis.http.default.responses.DefaultResponses.html#__app_name
Attribute
Instance Variable
PUBLIC
Store the application name and locale.
-
orionis.http.default.responses.DefaultResponses.__app_locale
orionis.http.default.responses.DefaultResponses.html#__app_locale
Attribute
Instance Variable
PUBLIC
App locale produced by self.__app.config.
-
orionis.http.default.responses.DefaultResponses.__memory_cache
orionis.http.default.responses.DefaultResponses.html#__memory_cache
Attribute
Instance Variable
PUBLIC
Initialize storage for asset paths and rendered page bodies.
-
orionis.http.default.responses.DefaultResponses.__asset_paths
orionis.http.default.responses.DefaultResponses.html#__asset_paths
Attribute
Instance Variable
PUBLIC
Resolved paths of assets used by the default response templates.
-
orionis.http.default.responses.DefaultResponses.__getitem__
orionis.http.default.responses.DefaultResponses.html#__getitem__
Function
Method
PUBLIC
Retrieve a cached value by key.
-
orionis.http.default.responses.DefaultResponses.__setitem__
orionis.http.default.responses.DefaultResponses.html#__setitem__
Function
Method
PUBLIC
Store a value in the cache with the specified key.
-
orionis.http.default.responses.DefaultResponses.__contains__
orionis.http.default.responses.DefaultResponses.html#__contains__
Function
Method
PUBLIC
Check if the cache contains the specified key.
-
orionis.http.default.responses.DefaultResponses.__delitem__
orionis.http.default.responses.DefaultResponses.html#__delitem__
Function
Method
PUBLIC
Remove an item from the memory cache by key.
-
orionis.http.default.responses.DefaultResponses.favicon
orionis.http.default.responses.DefaultResponses.html#favicon
Function
Method
PUBLIC
Return the favicon file response or a 404 response if not found.
-
orionis.http.default.responses.DefaultResponses.robotsTxt
orionis.http.default.responses.DefaultResponses.html#robotsTxt
Function
Method
PUBLIC
Return the robots.txt file or a 404 response if not found.
-
orionis.http.default.responses.DefaultResponses.sitemapXml
orionis.http.default.responses.DefaultResponses.html#sitemapXml
Function
Method
PUBLIC
Return the public sitemap.xml file, or a 404 response when absent.
-
orionis.http.default.responses.DefaultResponses.__publicFile
orionis.http.default.responses.DefaultResponses.html#__publicFile
Function
Method
PUBLIC
Select a public file and recover when a previously selected file vanishes.
-
orionis.http.default.responses.DefaultResponses.__fileResponse
orionis.http.default.responses.DefaultResponses.html#__fileResponse
Function
Static Method
PUBLIC
Build an independent response for an available regular file.
-
orionis.http.default.responses.DefaultResponses.health
orionis.http.default.responses.DefaultResponses.html#health
Function
Method
PUBLIC
Render the application health state as an HTML or JSON response.
-
orionis.http.default.responses.DefaultResponses.error
orionis.http.default.responses.DefaultResponses.html#error
Function
Method
PUBLIC
Return an error page or JSON response for the specified status code.
-
orionis.http.default.responses.DefaultResponses.exception
orionis.http.default.responses.DefaultResponses.html#exception
Function
Method
PUBLIC
Render an exception page with request and traceback details.
-
orionis.http.default.responses.DefaultResponses.dump
orionis.http.default.responses.DefaultResponses.html#dump
Function
Method
PUBLIC
Wrap an escaped variable dump in the framework's diagnostic layout.
-
orionis.http.default.responses.DefaultResponses.__refreshContext
orionis.http.default.responses.DefaultResponses.html#__refreshContext
Function
Method
PUBLIC
Refresh application labels and expire health bodies when they change.
-
orionis.http.default.responses.DefaultResponses.__render
orionis.http.default.responses.DefaultResponses.html#__render
Function
Method
PUBLIC
Render a built-in template through the application's official engine.
-
orionis.http.default.responses.DefaultResponses.asset
orionis.http.default.responses.DefaultResponses.html#asset
Function
Method
PUBLIC
Serve a whitelisted package asset without exposing arbitrary files.
-
orionis.http.layer.web.exceptions.CSRFTokenMismatchException
orionis.http.layer.web.exceptions.CSRFTokenMismatchException.html
Class
Exception
PUBLIC
Raised when the CSRF token does not match the session token.
-
orionis.http.routes.exceptions.method_not_allowed.MethodNotAllowed
orionis.http.routes.exceptions.method_not_allowed.MethodNotAllowed.html
Class
Exception
PUBLIC
Signal that the requested path exists under a different HTTP method.
-
orionis.http.routes.exceptions.route_not_found.RouteNotFound
orionis.http.routes.exceptions.route_not_found.RouteNotFound.html
Class
Exception
PUBLIC
Signal that no route matches the requested path under any HTTP method.
-
orionis.failure.base.handler._HTTP_STATUS_MAP
orionis.failure.base.handler.html#_HTTP_STATUS_MAP
Attribute
Constant
PUBLIC
Map handled exception types to their public HTTP status and message.
-
orionis.failure.base.BaseExceptionHandler
orionis.failure.base.BaseExceptionHandler.html
Class
Class
PUBLIC
Select logging and protocol presentation through one failure hook.
-
orionis.failure.base.BaseExceptionHandler.dont_catch
orionis.failure.base.BaseExceptionHandler.html#dont_catch
Attribute
Class Variable
PUBLIC
Exceptions that should not be caught by the handler.
-
orionis.failure.base.BaseExceptionHandler.__init__
orionis.failure.base.BaseExceptionHandler.html#__init__
Function
Method
PUBLIC
Initialize the BaseExceptionHandler instance.
-
orionis.failure.base.BaseExceptionHandler.__default_responses
orionis.failure.base.BaseExceptionHandler.html#__default_responses
Attribute
Instance Variable
PUBLIC
Default responses for HTTP error handling.
-
orionis.failure.base.BaseExceptionHandler.__application
orionis.failure.base.BaseExceptionHandler.html#__application
Attribute
Instance Variable
PUBLIC
The application instance containing configuration and context.
-
orionis.failure.base.BaseExceptionHandler.handleFailure
orionis.failure.base.BaseExceptionHandler.html#handleFailure
Function
Method
PUBLIC
Select default effects without logging or rendering during observation.
-
orionis.failure.base.BaseExceptionHandler.handleResult
orionis.failure.base.BaseExceptionHandler.html#handleResult
Function
Method
PUBLIC
Observe a declared failed result without creating an exception.
-
orionis.failure.base.BaseExceptionHandler.toThrowable
orionis.failure.base.BaseExceptionHandler.html#toThrowable
Function
Method
PUBLIC
Convert an exception to a structured Throwable object.
-
orionis.failure.base.BaseExceptionHandler.isExceptionIgnored
orionis.failure.base.BaseExceptionHandler.html#isExceptionIgnored
Function
Method
PUBLIC
Determine whether the given exception should be ignored.
-
orionis.failure.base.BaseExceptionHandler.__log
orionis.failure.base.BaseExceptionHandler.html#__log
Function
Method
PUBLIC
Log an exception and its traceback as a single error record.
-
orionis.failure.base.BaseExceptionHandler.__present
orionis.failure.base.BaseExceptionHandler.html#__present
Function
Method
PUBLIC
Present the exception only when its HTTP or CLI owner requests it.
-
orionis.failure.base.BaseExceptionHandler.report
orionis.failure.base.BaseExceptionHandler.html#report
Function
Method
PUBLIC
Log an exception immediately using the supplied logger.
-
orionis.failure.base.BaseExceptionHandler.handleCLI
orionis.failure.base.BaseExceptionHandler.html#handleCLI
Function
Method
PUBLIC
Render an exception immediately using the supplied console.
-
orionis.failure.base.BaseExceptionHandler.handleHTTP
orionis.failure.base.BaseExceptionHandler.html#handleHTTP
Function
Method
PUBLIC
Render an exception immediately as an HTTP response.
-
orionis.failure.base._EXPORTS
orionis.failure.base.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.failure.base.__getattr__
orionis.failure.base.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.failure.base.__dir__
orionis.failure.base.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.failure.contracts.ICatch
orionis.failure.contracts.ICatch.html
Class
Class
PUBLIC
Define the contract for catch implementations.
-
orionis.failure.contracts.ICatch.capture
orionis.failure.contracts.ICatch.html#capture
Function
Method
PUBLIC
Observe an exception through the active failure runtime.
-
orionis.failure.contracts.ICatch.exception
orionis.failure.contracts.ICatch.html#exception
Function
Method
PUBLIC
Handle an exception in the current kernel context.
-
orionis.failure.entities.Throwable
orionis.failure.entities.Throwable.html
Class
Class
PUBLIC
Represent a throwable entity within the framework.
-
orionis.failure.entities.Throwable.classtype
orionis.failure.entities.Throwable.html#classtype
Attribute
Instance Variable
PUBLIC
The class type of the throwable, typically an exception class.
-
orionis.failure.entities.Throwable.message
orionis.failure.entities.Throwable.html#message
Attribute
Instance Variable
PUBLIC
The error message describing the throwable.
-
orionis.failure.entities.Throwable.args
orionis.failure.entities.Throwable.html#args
Attribute
Instance Variable
PUBLIC
Arguments passed to the throwable, usually corresponding to the exception arguments.
-
orionis.failure.entities.Throwable.traceback
orionis.failure.entities.Throwable.html#traceback
Attribute
Instance Variable
PUBLIC
The native traceback object, if available. Defaults to None.
-
orionis.failure.entities.FailureContext
orionis.failure.entities.FailureContext.html
Class
Class
PUBLIC
Immutable, bounded context delivered to the application failure hook.
-
orionis.failure.entities.FailureContext.flow
orionis.failure.entities.FailureContext.html#flow
Attribute
Class Variable
PUBLIC
Execution flow owning the failure, such as HTTP, CLI, or worker.
-
orionis.failure.entities.FailureContext.phase
orionis.failure.entities.FailureContext.html#phase
Attribute
Class Variable
PUBLIC
Stage within the owning flow at which the failure was observed.
-
orionis.failure.entities.FailureContext.operation
orionis.failure.entities.FailureContext.html#operation
Attribute
Class Variable
PUBLIC
Optional logical operation name supplied by the execution owner.
-
orionis.failure.entities.FailureContext.correlation_id
orionis.failure.entities.FailureContext.html#correlation_id
Attribute
Class Variable
PUBLIC
Identifier shared by incidents within the same operation.
-
orionis.failure.entities.FailureContext.event_id
orionis.failure.entities.FailureContext.html#event_id
Attribute
Class Variable
PUBLIC
Identifier assigned to this incident when observation begins.
-
orionis.failure.entities.FailureContext.parent_event_id
orionis.failure.entities.FailureContext.html#parent_event_id
Attribute
Class Variable
PUBLIC
Previously observed cause associated with this secondary incident.
-
orionis.failure.entities.FailureContext.expected
orionis.failure.entities.FailureContext.html#expected
Attribute
Class Variable
PUBLIC
Whether default policy should omit ordinary error logging.
-
orionis.failure.entities.FailureContext.reporting_allowed
orionis.failure.entities.FailureContext.html#reporting_allowed
Attribute
Class Variable
PUBLIC
Whether logging resources remain available for deferred reporting.
-
orionis.failure.entities.FailureContext.metadata
orionis.failure.entities.FailureContext.html#metadata
Attribute
Class Variable
PUBLIC
Read-only, bounded scalar metadata with credential-like values redacted.
-
orionis.failure.entities.FailureContext.__post_init__
orionis.failure.entities.FailureContext.html#__post_init__
Function
Method
PUBLIC
Copy bounded metadata and redact values under credential-like keys.
-
orionis.failure.entities.FailureReceipt
orionis.failure.entities.FailureReceipt.html
Class
Class
PUBLIC
Record delivery status without retaining the exception or its traceback.
-
orionis.failure.entities.FailureReceipt.event_id
orionis.failure.entities.FailureReceipt.html#event_id
Attribute
Class Variable
PUBLIC
Stable incident identifier without retaining the exception itself.
-
orionis.failure.entities.FailureReceipt.delivered
orionis.failure.entities.FailureReceipt.html#delivered
Attribute
Class Variable
PUBLIC
Whether the configured application hook returned successfully.
-
orionis.failure.entities.FailureReceipt.reported
orionis.failure.entities.FailureReceipt.html#reported
Attribute
Class Variable
PUBLIC
Whether the selected logging effect completed successfully.
-
orionis.failure.entities.FailureReceipt.duplicate
orionis.failure.entities.FailureReceipt.html#duplicate
Attribute
Class Variable
PUBLIC
Whether this capture reused an existing incident in its operation.
-
orionis.failure.entities.FailureReceipt.degraded
orionis.failure.entities.FailureReceipt.html#degraded
Attribute
Class Variable
PUBLIC
Whether reporting required fallback or could not complete normally.
-
orionis.failure.entities.FailureHandling
orionis.failure.entities.FailureHandling.html
Class
Class
PUBLIC
Own logging and optional presentation for one observed incident.
-
orionis.failure.entities.FailureHandling.logging
orionis.failure.entities.FailureHandling.html#logging
Attribute
Class Variable
PUBLIC
Deferred asynchronous logging action owned by the coordinator.
-
orionis.failure.entities.FailureHandling.presentation
orionis.failure.entities.FailureHandling.html#presentation
Attribute
Class Variable
PUBLIC
Deferred presentation accepting the owner's flow and live request.
-
orionis.failure.entities.FailureHandling.reported
orionis.failure.entities.FailureHandling.html#reported
Attribute
Instance Variable
PUBLIC
Whether the logging action completed successfully.
-
orionis.failure.entities.FailureHandling.degraded
orionis.failure.entities.FailureHandling.html#degraded
Attribute
Class Variable
PUBLIC
Whether an effect required fallback or failed during handling.
-
orionis.failure.entities.FailureHandling._completion_lock
orionis.failure.entities.FailureHandling.html#_completion_lock
Attribute
Class Variable
PUBLIC
Coordinate consumers of the single logging effect.
-
orionis.failure.entities.FailureHandling._presentation_lock
orionis.failure.entities.FailureHandling.html#_presentation_lock
Attribute
Class Variable
PUBLIC
Coordinate consumers of the single presentation effect.
-
orionis.failure.entities.FailureHandling._completion_owner
orionis.failure.entities.FailureHandling.html#_completion_owner
Attribute
Instance Variable
PUBLIC
Task executing logging, cleared when the action finishes or fails.
-
orionis.failure.entities.FailureHandling._presentation_owner
orionis.failure.entities.FailureHandling.html#_presentation_owner
Attribute
Instance Variable
PUBLIC
Task executing presentation, cleared when the action finishes or fails.
-
orionis.failure.entities.FailureHandling._completed
orionis.failure.entities.FailureHandling.html#_completed
Attribute
Instance Variable
PUBLIC
Whether logging execution has already been claimed.
-
orionis.failure.entities.FailureHandling._presented
orionis.failure.entities.FailureHandling.html#_presented
Attribute
Instance Variable
PUBLIC
Whether presentation execution has already been claimed.
-
orionis.failure.entities.FailureHandling._completion_error
orionis.failure.entities.FailureHandling.html#_completion_error
Attribute
Class Variable
PUBLIC
Retained logging failure preventing automatic effect retries.
-
orionis.failure.entities.FailureHandling._completion_traceback
orionis.failure.entities.FailureHandling.html#_completion_traceback
Attribute
Class Variable
PUBLIC
Original logging traceback, without frames added by subsequent callers.
-
orionis.failure.entities.FailureHandling._presentation_error
orionis.failure.entities.FailureHandling.html#_presentation_error
Attribute
Class Variable
PUBLIC
Retained presentation failure preventing automatic effect retries.
-
orionis.failure.entities.FailureHandling._presentation_traceback
orionis.failure.entities.FailureHandling.html#_presentation_traceback
Attribute
Class Variable
PUBLIC
Original presentation traceback, restored for repeated failed requests.
-
orionis.failure.entities.FailureHandling._presentation_diagnosed
orionis.failure.entities.FailureHandling.html#_presentation_diagnosed
Attribute
Class Variable
PUBLIC
Whether the coordinator already emitted the presentation diagnostic.
-
orionis.failure.entities.FailureHandling._result
orionis.failure.entities.FailureHandling.html#_result
Attribute
Instance Variable
PUBLIC
Cached presentation outcome shared with concurrent consumers.
-
orionis.failure.entities.FailureHandling.complete
orionis.failure.entities.FailureHandling.html#complete
Function
Method
PUBLIC
Execute the deferred logging action at most once.
-
orionis.failure.entities.FailureHandling.present
orionis.failure.entities.FailureHandling.html#present
Function
Method
PUBLIC
Execute deferred presentation at most once and cache its result.
-
orionis.failure.enums.KernelContext
orionis.failure.enums.KernelContext.html
Class
Class
PUBLIC
Define available kernel types in the system.
-
orionis.failure.enums.KernelContext.CONSOLE
orionis.failure.enums.KernelContext.html#CONSOLE
Attribute
Constant
PUBLIC
Kernel for command-line or console execution.
-
orionis.failure.enums.KernelContext.HTTP
orionis.failure.enums.KernelContext.html#HTTP
Attribute
Constant
PUBLIC
Kernel for HTTP environments, such as web servers.
-
orionis.failure.provider.CatchProvider
orionis.failure.provider.CatchProvider.html
Class
Class
PUBLIC
Register catch services in the application container.
-
orionis.failure.provider.CatchProvider.register
orionis.failure.provider.CatchProvider.html#register
Function
Method
PUBLIC
Register the Catch service as a singleton in the application container.
-
orionis.failure.provider.CatchProvider.boot
orionis.failure.provider.CatchProvider.html#boot
Function
Method
PUBLIC
Resolve and pin the Catch facade after service registration.
-
orionis.foundation.config.app.App
orionis.foundation.config.app.App.html
Class
Class
PUBLIC
Represent application configuration settings.
-
orionis.foundation.config.app.App.name
orionis.foundation.config.app.App.html#name
Attribute
Instance Variable
PUBLIC
The name of the application. Default is 'Orionis Application'.
-
orionis.foundation.config.app.App.env
orionis.foundation.config.app.App.html#env
Attribute
Instance Variable
PUBLIC
The environment in which the application is running. Default is 'DEVELOPMENT'.
-
orionis.foundation.config.app.App.debug
orionis.foundation.config.app.App.html#debug
Attribute
Instance Variable
PUBLIC
Whether debug mode is enabled. Default is True.
-
orionis.foundation.config.app.App.timezone
orionis.foundation.config.app.App.html#timezone
Attribute
Instance Variable
PUBLIC
The timezone of the application. Default is 'UTC'.
-
orionis.foundation.config.app.App.locale
orionis.foundation.config.app.App.html#locale
Attribute
Instance Variable
PUBLIC
The locale for the application. Default is 'en'.
-
orionis.foundation.config.app.App.fallback_locale
orionis.foundation.config.app.App.html#fallback_locale
Attribute
Instance Variable
PUBLIC
The locale used when a translation is missing. Default is 'en'.
-
orionis.foundation.config.app.App.language_path
orionis.foundation.config.app.App.html#language_path
Attribute
Instance Variable
PUBLIC
Relative path to the JSON translation files. Default is 'resources/lang/'.
-
orionis.foundation.config.app.App.cipher
orionis.foundation.config.app.App.html#cipher
Attribute
Instance Variable
PUBLIC
The authenticated cipher used for encryption. Default is 'AES-256-GCM'.
-
orionis.foundation.config.app.App.key
orionis.foundation.config.app.App.html#key
Attribute
Instance Variable
PUBLIC
The encryption key, normalized to bytes. None generates a persistent key.
-
orionis.foundation.config.app.App.maintenance
orionis.foundation.config.app.App.html#maintenance
Attribute
Instance Variable
PUBLIC
Whether maintenance mode is enabled. Default is False.
-
orionis.foundation.config.app.App.__post_init__
orionis.foundation.config.app.App.html#__post_init__
Function
Method
PUBLIC
Validate application options and normalize their values.
-
orionis.foundation.config.app.App.__validateKey
orionis.foundation.config.app.App.html#__validateKey
Function
Method
PUBLIC
Validate and normalize the encryption key for cipher consumers.
-
orionis.foundation.config.app.Cipher
orionis.foundation.config.app.Cipher.html
Class
Class
PUBLIC
Enumerate authenticated AES modes and retained legacy identifiers.
-
orionis.foundation.config.app.Cipher.AES_128_CBC
orionis.foundation.config.app.Cipher.html#AES_128_CBC
Attribute
Constant
PUBLIC
Legacy AES-128-CBC identifier; rejected by application encryption.
-
orionis.foundation.config.app.Cipher.AES_256_CBC
orionis.foundation.config.app.Cipher.html#AES_256_CBC
Attribute
Constant
PUBLIC
Legacy AES-256-CBC identifier; rejected by application encryption.
-
orionis.foundation.config.app.Cipher.AES_128_GCM
orionis.foundation.config.app.Cipher.html#AES_128_GCM
Attribute
Constant
PUBLIC
AES with a 128-bit key in Galois/Counter Mode (GCM).
-
orionis.foundation.config.app.Cipher.AES_256_GCM
orionis.foundation.config.app.Cipher.html#AES_256_GCM
Attribute
Constant
PUBLIC
AES with a 256-bit key in Galois/Counter Mode (GCM).
-
orionis.foundation.config.app.Environments
orionis.foundation.config.app.Environments.html
Class
Class
PUBLIC
Enumerate possible application environments.
-
orionis.foundation.config.app.Environments.DEVELOPMENT
orionis.foundation.config.app.Environments.html#DEVELOPMENT
Attribute
Constant
PUBLIC
Represents the development environment.
-
orionis.foundation.config.app.Environments.TESTING
orionis.foundation.config.app.Environments.html#TESTING
Attribute
Constant
PUBLIC
Represents the testing environment.
-
orionis.foundation.config.app.Environments.PRODUCTION
orionis.foundation.config.app.Environments.html#PRODUCTION
Attribute
Constant
PUBLIC
Represents the production environment.
-
orionis.foundation.config.app._EXPORTS
orionis.foundation.config.app.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.foundation.config.app.__getattr__
orionis.foundation.config.app.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.foundation.config.app.__dir__
orionis.foundation.config.app.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.foundation.config.auth.entities.tokens._MIN_SECRET_BYTES
orionis.foundation.config.auth.entities.tokens.html#_MIN_SECRET_BYTES
Attribute
Constant
PUBLIC
Number of random bytes used to build the secret half of a token.
-
orionis.foundation.config.auth.entities.tokens._MAX_SECRET_BYTES
orionis.foundation.config.auth.entities.tokens.html#_MAX_SECRET_BYTES
Attribute
Constant
PUBLIC
Max secret bytes value used by tokens.
-
orionis.foundation.config.auth.entities.auth._GUARD_NAMES
orionis.foundation.config.auth.entities.auth.html#_GUARD_NAMES
Attribute
Constant
PUBLIC
Define the supported authentication guard names.
-
orionis.foundation.config.auth.Auth
orionis.foundation.config.auth.Auth.html
Class
Class
PUBLIC
Represent the authentication and authorization configuration.
-
orionis.foundation.config.auth.Auth.default
orionis.foundation.config.auth.Auth.html#default
Attribute
Instance Variable
PUBLIC
Guard used when a middleware or a facade call does not name one. Accepts a Guards member or a plain string.
-
orionis.foundation.config.auth.Auth.identity
orionis.foundation.config.auth.Auth.html#identity
Attribute
Instance Variable
PUBLIC
Where the application identity lives and how it is verified.
-
orionis.foundation.config.auth.Auth.session
orionis.foundation.config.auth.Auth.html#session
Attribute
Instance Variable
PUBLIC
Options of the session guard used by web routes.
-
orionis.foundation.config.auth.Auth.tokens
orionis.foundation.config.auth.Auth.html#tokens
Attribute
Instance Variable
PUBLIC
Options of the personal access token guard used by API routes.
-
orionis.foundation.config.auth.Auth.passwords
orionis.foundation.config.auth.Auth.html#passwords
Attribute
Instance Variable
PUBLIC
Trusted reset URL, token table, lifetime and resend delay.
-
orionis.foundation.config.auth.Auth.remember
orionis.foundation.config.auth.Auth.html#remember
Attribute
Instance Variable
PUBLIC
Optional persistent login cookie name, lifetime and HTTPS requirement.
-
orionis.foundation.config.auth.Auth.__post_init__
orionis.foundation.config.auth.Auth.html#__post_init__
Function
Method
PUBLIC
Validate and normalize the authentication configuration.
-
orionis.foundation.config.auth.Auth.__normalizeSection
orionis.foundation.config.auth.Auth.html#__normalizeSection
Function
Method
PUBLIC
Coerce a configuration section into its typed entity.
-
orionis.foundation.config.auth.Identity
orionis.foundation.config.auth.Identity.html
Class
Class
PUBLIC
Represent how the application identity is located and verified.
-
orionis.foundation.config.auth.Identity.model
orionis.foundation.config.auth.Identity.html#model
Attribute
Instance Variable
PUBLIC
Dotted path of the model backing the authenticated identity.
-
orionis.foundation.config.auth.Identity.username
orionis.foundation.config.auth.Identity.html#username
Attribute
Instance Variable
PUBLIC
Attribute holding the public credential used to look an identity up, such as the email address.
-
orionis.foundation.config.auth.Identity.__post_init__
orionis.foundation.config.auth.Identity.html#__post_init__
Function
Method
PUBLIC
Validate the identity configuration after initialization.
-
orionis.foundation.config.auth.PasswordReset
orionis.foundation.config.auth.PasswordReset.html
Class
Class
PUBLIC
Represent the configuration of password reset functionality.
-
orionis.foundation.config.auth.PasswordReset.expiration
orionis.foundation.config.auth.PasswordReset.html#expiration
Attribute
Instance Variable
PUBLIC
Lifetime of the password reset link, in minutes.
-
orionis.foundation.config.auth.PasswordReset.throttle
orionis.foundation.config.auth.PasswordReset.html#throttle
Attribute
Instance Variable
PUBLIC
Throttle delay between password reset requests for the same account, in seconds.
-
orionis.foundation.config.auth.PasswordReset.table
orionis.foundation.config.auth.PasswordReset.html#table
Attribute
Instance Variable
PUBLIC
Table storing the password reset tokens.
-
orionis.foundation.config.auth.PasswordReset.__post_init__
orionis.foundation.config.auth.PasswordReset.html#__post_init__
Function
Method
PUBLIC
Validate password reset limits and the token table name.
-
orionis.foundation.config.auth.RememberAuth
orionis.foundation.config.auth.RememberAuth.html
Class
Class
PUBLIC
Configure the optional persistent login cookie separately from sessions.
-
orionis.foundation.config.auth.RememberAuth.cookie
orionis.foundation.config.auth.RememberAuth.html#cookie
Attribute
Instance Variable
PUBLIC
Name of the persistent login cookie.
-
orionis.foundation.config.auth.RememberAuth.lifetime
orionis.foundation.config.auth.RememberAuth.html#lifetime
Attribute
Instance Variable
PUBLIC
Lifetime of the persistent login cookie, in minutes.
-
orionis.foundation.config.auth.RememberAuth.secure
orionis.foundation.config.auth.RememberAuth.html#secure
Attribute
Instance Variable
PUBLIC
Whether the persistent login cookie requires a secure connection.
-
orionis.foundation.config.auth.RememberAuth.__post_init__
orionis.foundation.config.auth.RememberAuth.html#__post_init__
Function
Method
PUBLIC
Validate persistent login cookie settings.
-
orionis.foundation.config.auth.SessionAuth
orionis.foundation.config.auth.SessionAuth.html
Class
Class
PUBLIC
Represent the configuration of session based authentication.
-
orionis.foundation.config.auth.SessionAuth.key
orionis.foundation.config.auth.SessionAuth.html#key
Attribute
Instance Variable
PUBLIC
Session key holding the identifier of the authenticated identity.
-
orionis.foundation.config.auth.SessionAuth.redirect_to
orionis.foundation.config.auth.SessionAuth.html#redirect_to
Attribute
Instance Variable
PUBLIC
Path browsers are redirected to when authentication is required. None renders the standard 401 error response instead.
-
orionis.foundation.config.auth.SessionAuth.home
orionis.foundation.config.auth.SessionAuth.html#home
Attribute
Instance Variable
PUBLIC
Path browsers are redirected to once the login succeeds, and the target guest-only pages send already authenticated visitors to.
-
orionis.foundation.config.auth.SessionAuth.__post_init__
orionis.foundation.config.auth.SessionAuth.html#__post_init__
Function
Method
PUBLIC
Validate the session authentication options after initialization.
-
orionis.foundation.config.auth.Tokens
orionis.foundation.config.auth.Tokens.html
Class
Class
PUBLIC
Represent the configuration of personal access token authentication.
-
orionis.foundation.config.auth.Tokens.table
orionis.foundation.config.auth.Tokens.html#table
Attribute
Instance Variable
PUBLIC
Table storing the issued personal access tokens.
-
orionis.foundation.config.auth.Tokens.expiration
orionis.foundation.config.auth.Tokens.html#expiration
Attribute
Instance Variable
PUBLIC
Lifetime of a freshly issued token, in minutes. None issues tokens that never expire on their own.
-
orionis.foundation.config.auth.Tokens.secret_bytes
orionis.foundation.config.auth.Tokens.html#secret_bytes
Attribute
Instance Variable
PUBLIC
Number of random bytes used to build the secret of a token.
-
orionis.foundation.config.auth.Tokens.__post_init__
orionis.foundation.config.auth.Tokens.html#__post_init__
Function
Method
PUBLIC
Validate the token configuration after initialization.
-
orionis.foundation.config.auth._EXPORTS
orionis.foundation.config.auth.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.foundation.config.auth.__getattr__
orionis.foundation.config.auth.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.foundation.config.auth.__dir__
orionis.foundation.config.auth.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.foundation.config.auth.enums.Guards
orionis.foundation.config.auth.enums.Guards.html
Class
Class
PUBLIC
Enumerate the authentication guards shipped with the framework.
-
orionis.foundation.config.auth.enums.Guards.SESSION
orionis.foundation.config.auth.enums.Guards.html#SESSION
Attribute
Constant
PUBLIC
Guard resolving the identity from the HTTP session.
-
orionis.foundation.config.auth.enums.Guards.TOKEN
orionis.foundation.config.auth.enums.Guards.html#TOKEN
Attribute
Constant
PUBLIC
Guard resolving the identity from a personal access token.
-
orionis.foundation.config.cache.Cache
orionis.foundation.config.cache.Cache.html
Class
Class
PUBLIC
Represent the cache configuration for the application.
-
orionis.foundation.config.cache.Cache.default
orionis.foundation.config.cache.Cache.html#default
Attribute
Instance Variable
PUBLIC
The default cache storage type. Accepts a Drivers enum member or a plain string (e.g. 'memory', 'file'). Resolved from the CACHE_STORE environment variable or Drivers.FILE.value.
-
orionis.foundation.config.cache.Cache.prefix
orionis.foundation.config.cache.Cache.html#prefix
Attribute
Instance Variable
PUBLIC
Global key prefix applied to all cache entries. Resolved from the CACHE_PREFIX environment variable or 'orionis'.
-
orionis.foundation.config.cache.Cache.stores
orionis.foundation.config.cache.Cache.html#stores
Attribute
Instance Variable
PUBLIC
Configuration for the available cache stores. Defaults to a Stores instance backed by a file store.
-
orionis.foundation.config.cache.Cache.__post_init__
orionis.foundation.config.cache.Cache.html#__post_init__
Function
Method
PUBLIC
Validate and normalize the cache configuration after initialization.
-
orionis.foundation.config.cache.Database
orionis.foundation.config.cache.Database.html
Class
Class
PUBLIC
Represent the configuration entity for a database-backed cache store.
-
orionis.foundation.config.cache.Database.driver
orionis.foundation.config.cache.Database.html#driver
Attribute
Instance Variable
PUBLIC
The driver type. Defaults to 'database'.
-
orionis.foundation.config.cache.Database.connection
orionis.foundation.config.cache.Database.html#connection
Attribute
Instance Variable
PUBLIC
The database connection name used to store cache entries. Resolved from the DB_CACHE_CONNECTION environment variable or None to use the application's default connection.
-
orionis.foundation.config.cache.Database.table
orionis.foundation.config.cache.Database.html#table
Attribute
Instance Variable
PUBLIC
The database table name used to store cache entries. Must match the pattern [a-z_]+. Resolved from the DB_CACHE_TABLE environment variable or defaults to 'cache'.
-
orionis.foundation.config.cache.Database.lock_table
orionis.foundation.config.cache.Database.html#lock_table
Attribute
Instance Variable
PUBLIC
The database table name used to store cache locks. Must match the pattern [a-z_]+ when provided. Resolved from the DB_CACHE_LOCK_TABLE environment variable or None to let the driver fall back to its own default.
-
orionis.foundation.config.cache.Database.__validateDriver
orionis.foundation.config.cache.Database.html#__validateDriver
Function
Method
PUBLIC
Validate the driver property.
-
orionis.foundation.config.cache.Database.__validateConnection
orionis.foundation.config.cache.Database.html#__validateConnection
Function
Method
PUBLIC
Validate the connection property.
-
orionis.foundation.config.cache.Database.__post_init__
orionis.foundation.config.cache.Database.html#__post_init__
Function
Method
PUBLIC
Validate the Database cache configuration after initialization.
-
orionis.foundation.config.cache.File
orionis.foundation.config.cache.File.html
Class
Class
PUBLIC
Represent the configuration entity for a file-based cache store.
-
orionis.foundation.config.cache.File.driver
orionis.foundation.config.cache.File.html#driver
Attribute
Instance Variable
PUBLIC
The driver type for the cache store. Defaults to 'file'.
-
orionis.foundation.config.cache.File.path
orionis.foundation.config.cache.File.html#path
Attribute
Instance Variable
PUBLIC
The filesystem path where cache data will be stored. Defaults to 'storage/framework/cache/data'.
-
orionis.foundation.config.cache.File.__post_init__
orionis.foundation.config.cache.File.html#__post_init__
Function
Method
PUBLIC
Validate and initialise the path attribute after dataclass init.
-
orionis.foundation.config.cache.Memcached
orionis.foundation.config.cache.Memcached.html
Class
Class
PUBLIC
Represent the configuration entity for a Memcached cache store.
-
orionis.foundation.config.cache.Memcached.driver
orionis.foundation.config.cache.Memcached.html#driver
Attribute
Instance Variable
PUBLIC
The driver type. Defaults to 'memcached'.
-
orionis.foundation.config.cache.Memcached.endpoint
orionis.foundation.config.cache.Memcached.html#endpoint
Attribute
Instance Variable
PUBLIC
Memcached host address. Resolved from the MEMCACHED_HOST environment variable or defaults to '127.0.0.1'.
-
orionis.foundation.config.cache.Memcached.port
orionis.foundation.config.cache.Memcached.html#port
Attribute
Instance Variable
PUBLIC
Memcached port number. Resolved from the MEMCACHED_PORT environment variable or defaults to 11211.
-
orionis.foundation.config.cache.Memcached.__validateDriver
orionis.foundation.config.cache.Memcached.html#__validateDriver
Function
Method
PUBLIC
Validate the driver property.
-
orionis.foundation.config.cache.Memcached.__validateEndpoint
orionis.foundation.config.cache.Memcached.html#__validateEndpoint
Function
Method
PUBLIC
Validate the endpoint property.
-
orionis.foundation.config.cache.Memcached.__post_init__
orionis.foundation.config.cache.Memcached.html#__post_init__
Function
Method
PUBLIC
Validate the Memcached configuration after initialization.
-
orionis.foundation.config.cache.Memory
orionis.foundation.config.cache.Memory.html
Class
Class
PUBLIC
Represent the configuration entity for an in-memory cache store.
-
orionis.foundation.config.cache.Memory.driver
orionis.foundation.config.cache.Memory.html#driver
Attribute
Instance Variable
PUBLIC
The driver type for the cache store. Defaults to 'memory'.
-
orionis.foundation.config.cache.Memory.__post_init__
orionis.foundation.config.cache.Memory.html#__post_init__
Function
Method
PUBLIC
Validate the Memory configuration after initialization.
-
orionis.foundation.config.cache.Redis
orionis.foundation.config.cache.Redis.html
Class
Class
PUBLIC
Represent the configuration entity for a Redis cache store.
-
orionis.foundation.config.cache.Redis.driver
orionis.foundation.config.cache.Redis.html#driver
Attribute
Instance Variable
PUBLIC
The driver type. Defaults to 'redis'.
-
orionis.foundation.config.cache.Redis.endpoint
orionis.foundation.config.cache.Redis.html#endpoint
Attribute
Instance Variable
PUBLIC
Redis host address. Resolved from the REDIS_HOST environment variable or defaults to '127.0.0.1'.
-
orionis.foundation.config.cache.Redis.port
orionis.foundation.config.cache.Redis.html#port
Attribute
Instance Variable
PUBLIC
Redis port number. Resolved from the REDIS_PORT environment variable or defaults to 6379.
-
orionis.foundation.config.cache.Redis.db
orionis.foundation.config.cache.Redis.html#db
Attribute
Instance Variable
PUBLIC
Redis database index. Resolved from the REDIS_DB environment variable or defaults to 0.
-
orionis.foundation.config.cache.Redis.password
orionis.foundation.config.cache.Redis.html#password
Attribute
Instance Variable
PUBLIC
Redis password. Resolved from the REDIS_PASSWORD environment variable or defaults to None.
-
orionis.foundation.config.cache.Redis.__validateDriver
orionis.foundation.config.cache.Redis.html#__validateDriver
Function
Method
PUBLIC
Validate the driver property.
-
orionis.foundation.config.cache.Redis.__validateEndpoint
orionis.foundation.config.cache.Redis.html#__validateEndpoint
Function
Method
PUBLIC
Validate the endpoint property.
-
orionis.foundation.config.cache.Redis.__validatePassword
orionis.foundation.config.cache.Redis.html#__validatePassword
Function
Method
PUBLIC
Validate the password property.
-
orionis.foundation.config.cache.Redis.__post_init__
orionis.foundation.config.cache.Redis.html#__post_init__
Function
Method
PUBLIC
Validate the Redis configuration after initialization.
-
orionis.foundation.config.cache.Stores
orionis.foundation.config.cache.Stores.html
Class
Class
PUBLIC
Represent a collection of cache storage backends for the application.
-
orionis.foundation.config.cache.Stores.file
orionis.foundation.config.cache.Stores.html#file
Attribute
Instance Variable
PUBLIC
File-based cache storage configuration.
-
orionis.foundation.config.cache.Stores.memory
orionis.foundation.config.cache.Stores.html#memory
Attribute
Instance Variable
PUBLIC
In-memory cache storage configuration. Defaults to None.
-
orionis.foundation.config.cache.Stores.redis
orionis.foundation.config.cache.Stores.html#redis
Attribute
Instance Variable
PUBLIC
Redis cache storage configuration. Defaults to None.
-
orionis.foundation.config.cache.Stores.memcached
orionis.foundation.config.cache.Stores.html#memcached
Attribute
Instance Variable
PUBLIC
Memcached cache storage configuration. Defaults to None.
-
orionis.foundation.config.cache.Stores.database
orionis.foundation.config.cache.Stores.html#database
Attribute
Instance Variable
PUBLIC
Database-backed cache storage configuration. Defaults to None.
-
orionis.foundation.config.cache.Stores.__post_init__
orionis.foundation.config.cache.Stores.html#__post_init__
Function
Method
PUBLIC
Validate and convert store configuration attributes after init.
-
orionis.foundation.config.cache.Stores.__validateFile
orionis.foundation.config.cache.Stores.html#__validateFile
Function
Method
PUBLIC
Validate and convert the file store attribute.
-
orionis.foundation.config.cache.Drivers
orionis.foundation.config.cache.Drivers.html
Class
Class
PUBLIC
Enumerate supported cache drivers.
-
orionis.foundation.config.cache.Drivers.FILE
orionis.foundation.config.cache.Drivers.html#FILE
Attribute
Constant
PUBLIC
Represents a file-based cache driver.
-
orionis.foundation.config.cache.Drivers.MEMCACHED
orionis.foundation.config.cache.Drivers.html#MEMCACHED
Attribute
Constant
PUBLIC
Represents a Memcached cache driver.
-
orionis.foundation.config.cache.Drivers.REDIS
orionis.foundation.config.cache.Drivers.html#REDIS
Attribute
Constant
PUBLIC
Represents a Redis cache driver.
-
orionis.foundation.config.cache.Drivers.MEMORY
orionis.foundation.config.cache.Drivers.html#MEMORY
Attribute
Constant
PUBLIC
memory.
-
orionis.foundation.config.cache.Drivers.DATABASE
orionis.foundation.config.cache.Drivers.html#DATABASE
Attribute
Constant
PUBLIC
database.
-
orionis.foundation.config.cache._EXPORTS
orionis.foundation.config.cache.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.foundation.config.cache.__getattr__
orionis.foundation.config.cache.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.foundation.config.cache.__dir__
orionis.foundation.config.cache.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.foundation.config.database.Connections
orionis.foundation.config.database.Connections.html
Class
Class
PUBLIC
Represent all database connections used by the application.
-
orionis.foundation.config.database.Connections.sqlite
orionis.foundation.config.database.Connections.html#sqlite
Attribute
Instance Variable
PUBLIC
Configuration for the SQLite database connection.
-
orionis.foundation.config.database.Connections.mysql
orionis.foundation.config.database.Connections.html#mysql
Attribute
Instance Variable
PUBLIC
Configuration for the MySQL database connection.
-
orionis.foundation.config.database.Connections.pgsql
orionis.foundation.config.database.Connections.html#pgsql
Attribute
Instance Variable
PUBLIC
Configuration for the PostgreSQL database connection.
-
orionis.foundation.config.database.Connections.oracle
orionis.foundation.config.database.Connections.html#oracle
Attribute
Instance Variable
PUBLIC
Configuration for the Oracle database connection.
-
orionis.foundation.config.database.Connections.sqlserver
orionis.foundation.config.database.Connections.html#sqlserver
Attribute
Instance Variable
PUBLIC
Configuration for the Microsoft SQL Server database connection.
-
orionis.foundation.config.database.Connections.redshift
orionis.foundation.config.database.Connections.html#redshift
Attribute
Instance Variable
PUBLIC
Configuration for the Amazon Redshift database connection.
-
orionis.foundation.config.database.Connections.__post_init__
orionis.foundation.config.database.Connections.html#__post_init__
Function
Method
PUBLIC
Validate and convert database connection attributes after initialization.
-
orionis.foundation.config.database.Database
orionis.foundation.config.database.Database.html
Class
Class
PUBLIC
Represent the general database configuration.
-
orionis.foundation.config.database.Database.default
orionis.foundation.config.database.Database.html#default
Attribute
Instance Variable
PUBLIC
The name of the default database connection to use. Accepts a ConnectionName enum member or a plain string (e.g. 'sqlite').
-
orionis.foundation.config.database.Database.connections
orionis.foundation.config.database.Database.html#connections
Attribute
Instance Variable
PUBLIC
The different database connections available to the application.
-
orionis.foundation.config.database.Database.__post_init__
orionis.foundation.config.database.Database.html#__post_init__
Function
Method
PUBLIC
Validate and normalize the 'default' and 'connections' attributes.
-
orionis.foundation.config.database.MySQL
orionis.foundation.config.database.MySQL.html
Class
Class
PUBLIC
Data class to represent the MySQL database configuration.
-
orionis.foundation.config.database.MySQL.driver
orionis.foundation.config.database.MySQL.html#driver
Attribute
Instance Variable
PUBLIC
The database driver being used, e.g., 'mysql'.
-
orionis.foundation.config.database.MySQL.host
orionis.foundation.config.database.MySQL.html#host
Attribute
Instance Variable
PUBLIC
The host address for the MySQL server.
-
orionis.foundation.config.database.MySQL.port
orionis.foundation.config.database.MySQL.html#port
Attribute
Instance Variable
PUBLIC
The port for connecting to the MySQL server.
-
orionis.foundation.config.database.MySQL.database
orionis.foundation.config.database.MySQL.html#database
Attribute
Instance Variable
PUBLIC
The name of the MySQL database.
-
orionis.foundation.config.database.MySQL.username
orionis.foundation.config.database.MySQL.html#username
Attribute
Instance Variable
PUBLIC
The username for connecting to the MySQL database.
-
orionis.foundation.config.database.MySQL.password
orionis.foundation.config.database.MySQL.html#password
Attribute
Instance Variable
PUBLIC
The password for the MySQL database.
-
orionis.foundation.config.database.MySQL.unix_socket
orionis.foundation.config.database.MySQL.html#unix_socket
Attribute
Instance Variable
PUBLIC
The path to the Unix socket for MySQL connections (optional).
-
orionis.foundation.config.database.MySQL.charset
orionis.foundation.config.database.MySQL.html#charset
Attribute
Instance Variable
PUBLIC
The charset used for the connection.
-
orionis.foundation.config.database.MySQL.collation
orionis.foundation.config.database.MySQL.html#collation
Attribute
Instance Variable
PUBLIC
The collation for the database.
-
orionis.foundation.config.database.MySQL.prefix
orionis.foundation.config.database.MySQL.html#prefix
Attribute
Instance Variable
PUBLIC
Prefix for table names.
-
orionis.foundation.config.database.MySQL.prefix_indexes
orionis.foundation.config.database.MySQL.html#prefix_indexes
Attribute
Instance Variable
PUBLIC
Whether to prefix index names.
-
orionis.foundation.config.database.MySQL.strict
orionis.foundation.config.database.MySQL.html#strict
Attribute
Instance Variable
PUBLIC
Whether to enforce strict SQL mode.
-
orionis.foundation.config.database.MySQL.engine
orionis.foundation.config.database.MySQL.html#engine
Attribute
Instance Variable
PUBLIC
The storage engine for the MySQL database (optional).
-
orionis.foundation.config.database.MySQL.__post_init__
orionis.foundation.config.database.MySQL.html#__post_init__
Function
Method
PUBLIC
Validate connection settings and normalize MySQL options.
-
orionis.foundation.config.database.MySQL.__validateCharset
orionis.foundation.config.database.MySQL.html#__validateCharset
Function
Method
PUBLIC
Validate and normalize the MySQL charset.
-
orionis.foundation.config.database.MySQL.__validateCollation
orionis.foundation.config.database.MySQL.html#__validateCollation
Function
Method
PUBLIC
Validate and normalize the MySQL collation.
-
orionis.foundation.config.database.MySQL.__validateEngine
orionis.foundation.config.database.MySQL.html#__validateEngine
Function
Method
PUBLIC
Validate and normalize the MySQL storage engine.
-
orionis.foundation.config.database.Oracle
orionis.foundation.config.database.Oracle.html
Class
Class
PUBLIC
Represent Oracle database configuration for oracledb.
-
orionis.foundation.config.database.Oracle.driver
orionis.foundation.config.database.Oracle.html#driver
Attribute
Instance Variable
PUBLIC
The database driver being used, typically 'oracle'.
-
orionis.foundation.config.database.Oracle.username
orionis.foundation.config.database.Oracle.html#username
Attribute
Instance Variable
PUBLIC
Username for the database connection.
-
orionis.foundation.config.database.Oracle.password
orionis.foundation.config.database.Oracle.html#password
Attribute
Instance Variable
PUBLIC
Password for the database connection.
-
orionis.foundation.config.database.Oracle.host
orionis.foundation.config.database.Oracle.html#host
Attribute
Instance Variable
PUBLIC
Hostname or IP address of the Oracle server.
-
orionis.foundation.config.database.Oracle.port
orionis.foundation.config.database.Oracle.html#port
Attribute
Instance Variable
PUBLIC
Port number for the Oracle listener (default 1521).
-
orionis.foundation.config.database.Oracle.service_name
orionis.foundation.config.database.Oracle.html#service_name
Attribute
Instance Variable
PUBLIC
Service name for connection using the SERVICE_NAME method.
-
orionis.foundation.config.database.Oracle.sid
orionis.foundation.config.database.Oracle.html#sid
Attribute
Instance Variable
PUBLIC
SID for connection using the SID method.
-
orionis.foundation.config.database.Oracle.dsn
orionis.foundation.config.database.Oracle.html#dsn
Attribute
Instance Variable
PUBLIC
Full DSN string, used if service_name/sid are not specified.
-
orionis.foundation.config.database.Oracle.tns_name
orionis.foundation.config.database.Oracle.html#tns_name
Attribute
Instance Variable
PUBLIC
TNS alias name defined in tnsnames.ora.
-
orionis.foundation.config.database.Oracle.encoding
orionis.foundation.config.database.Oracle.html#encoding
Attribute
Instance Variable
PUBLIC
Character encoding for the connection.
-
orionis.foundation.config.database.Oracle.nencoding
orionis.foundation.config.database.Oracle.html#nencoding
Attribute
Instance Variable
PUBLIC
National character encoding for the connection.
-
orionis.foundation.config.database.Oracle.__validateConnectionParameters
orionis.foundation.config.database.Oracle.html#__validateConnectionParameters
Function
Method
PUBLIC
Validate Oracle connection parameters.
-
orionis.foundation.config.database.Oracle.__validateEncoding
orionis.foundation.config.database.Oracle.html#__validateEncoding
Function
Method
PUBLIC
Validate Oracle encoding parameters.
-
orionis.foundation.config.database.Oracle.__validateNencoding
orionis.foundation.config.database.Oracle.html#__validateNencoding
Function
Method
PUBLIC
Validate the Oracle national encoding parameter.
-
orionis.foundation.config.database.Oracle.__post_init__
orionis.foundation.config.database.Oracle.html#__post_init__
Function
Method
PUBLIC
Validate Oracle database connection configuration after initialization.
-
orionis.foundation.config.database.PGSQL
orionis.foundation.config.database.PGSQL.html
Class
Class
PUBLIC
Represent a PostgreSQL database configuration entity.
-
orionis.foundation.config.database.PGSQL.driver
orionis.foundation.config.database.PGSQL.html#driver
Attribute
Instance Variable
PUBLIC
Database driver type.
-
orionis.foundation.config.database.PGSQL.host
orionis.foundation.config.database.PGSQL.html#host
Attribute
Instance Variable
PUBLIC
Database host.
-
orionis.foundation.config.database.PGSQL.port
orionis.foundation.config.database.PGSQL.html#port
Attribute
Instance Variable
PUBLIC
Database port.
-
orionis.foundation.config.database.PGSQL.database
orionis.foundation.config.database.PGSQL.html#database
Attribute
Instance Variable
PUBLIC
Database name.
-
orionis.foundation.config.database.PGSQL.username
orionis.foundation.config.database.PGSQL.html#username
Attribute
Instance Variable
PUBLIC
Database user.
-
orionis.foundation.config.database.PGSQL.password
orionis.foundation.config.database.PGSQL.html#password
Attribute
Instance Variable
PUBLIC
Database password.
-
orionis.foundation.config.database.PGSQL.charset
orionis.foundation.config.database.PGSQL.html#charset
Attribute
Instance Variable
PUBLIC
Database charset.
-
orionis.foundation.config.database.PGSQL.prefix
orionis.foundation.config.database.PGSQL.html#prefix
Attribute
Instance Variable
PUBLIC
Table prefix.
-
orionis.foundation.config.database.PGSQL.prefix_indexes
orionis.foundation.config.database.PGSQL.html#prefix_indexes
Attribute
Instance Variable
PUBLIC
Whether to prefix indexes.
-
orionis.foundation.config.database.PGSQL.search_path
orionis.foundation.config.database.PGSQL.html#search_path
Attribute
Instance Variable
PUBLIC
PostgreSQL schema search_path.
-
orionis.foundation.config.database.PGSQL.sslmode
orionis.foundation.config.database.PGSQL.html#sslmode
Attribute
Instance Variable
PUBLIC
Connection SSL mode.
-
orionis.foundation.config.database.PGSQL.__validateCharset
orionis.foundation.config.database.PGSQL.html#__validateCharset
Function
Method
PUBLIC
Normalize the PostgreSQL charset option.
-
orionis.foundation.config.database.PGSQL.__validateSSLMode
orionis.foundation.config.database.PGSQL.html#__validateSSLMode
Function
Method
PUBLIC
Normalize the PostgreSQL SSL mode option.
-
orionis.foundation.config.database.PGSQL.__post_init__
orionis.foundation.config.database.PGSQL.html#__post_init__
Function
Method
PUBLIC
Validate and initialize the PostgreSQL configuration attributes.
-
orionis.foundation.config.database.Redshift
orionis.foundation.config.database.Redshift.html
Class
Class
PUBLIC
Configure Amazon Redshift with the official AWS Python connector.
-
orionis.foundation.config.database.Redshift.driver
orionis.foundation.config.database.Redshift.html#driver
Attribute
Instance Variable
PUBLIC
Fixed Redshift driver identifier.
-
orionis.foundation.config.database.Redshift.host
orionis.foundation.config.database.Redshift.html#host
Attribute
Instance Variable
PUBLIC
Cluster endpoint, or None when IAM resolves the endpoint.
-
orionis.foundation.config.database.Redshift.port
orionis.foundation.config.database.Redshift.html#port
Attribute
Instance Variable
PUBLIC
Database port, defaulting to 5439.
-
orionis.foundation.config.database.Redshift.database
orionis.foundation.config.database.Redshift.html#database
Attribute
Instance Variable
PUBLIC
Database name.
-
orionis.foundation.config.database.Redshift.username
orionis.foundation.config.database.Redshift.html#username
Attribute
Instance Variable
PUBLIC
Database authentication user.
-
orionis.foundation.config.database.Redshift.password
orionis.foundation.config.database.Redshift.html#password
Attribute
Instance Variable
PUBLIC
Database authentication password, unused with IAM credentials.
-
orionis.foundation.config.database.Redshift.prefix
orionis.foundation.config.database.Redshift.html#prefix
Attribute
Instance Variable
PUBLIC
Table name prefix.
-
orionis.foundation.config.database.Redshift.ssl
orionis.foundation.config.database.Redshift.html#ssl
Attribute
Instance Variable
PUBLIC
Enable TLS for database connections.
-
orionis.foundation.config.database.Redshift.sslmode
orionis.foundation.config.database.Redshift.html#sslmode
Attribute
Instance Variable
PUBLIC
Certificate verification policy, defaulting to verify-full.
-
orionis.foundation.config.database.Redshift.timeout
orionis.foundation.config.database.Redshift.html#timeout
Attribute
Instance Variable
PUBLIC
Connection socket timeout in seconds, or None for no timeout.
-
orionis.foundation.config.database.Redshift.iam
orionis.foundation.config.database.Redshift.html#iam
Attribute
Instance Variable
PUBLIC
Enable the connector's IAM authentication.
-
orionis.foundation.config.database.Redshift.region
orionis.foundation.config.database.Redshift.html#region
Attribute
Instance Variable
PUBLIC
AWS region used for IAM endpoint and credential resolution.
-
orionis.foundation.config.database.Redshift.cluster_identifier
orionis.foundation.config.database.Redshift.html#cluster_identifier
Attribute
Instance Variable
PUBLIC
Provisioned cluster identifier for IAM authentication.
-
orionis.foundation.config.database.Redshift.db_user
orionis.foundation.config.database.Redshift.html#db_user
Attribute
Instance Variable
PUBLIC
Database user requested through IAM.
-
orionis.foundation.config.database.Redshift.profile
orionis.foundation.config.database.Redshift.html#profile
Attribute
Instance Variable
PUBLIC
AWS credentials profile; None uses the SDK credential chain.
-
orionis.foundation.config.database.Redshift.is_serverless
orionis.foundation.config.database.Redshift.html#is_serverless
Attribute
Instance Variable
PUBLIC
Select Redshift Serverless instead of a provisioned cluster.
-
orionis.foundation.config.database.Redshift.serverless_work_group
orionis.foundation.config.database.Redshift.html#serverless_work_group
Attribute
Instance Variable
PUBLIC
Serverless workgroup used for endpoint resolution.
-
orionis.foundation.config.database.Redshift.serverless_acct_id
orionis.foundation.config.database.Redshift.html#serverless_acct_id
Attribute
Instance Variable
PUBLIC
AWS account owning the Serverless workgroup.
-
orionis.foundation.config.database.Redshift.__post_init__
orionis.foundation.config.database.Redshift.html#__post_init__
Function
Method
PUBLIC
Validate connector settings without contacting AWS or opening a socket.
-
orionis.foundation.config.database.SQLite
orionis.foundation.config.database.SQLite.html
Class
Class
PUBLIC
Represent the SQLite database configuration.
-
orionis.foundation.config.database.SQLite.driver
orionis.foundation.config.database.SQLite.html#driver
Attribute
Instance Variable
PUBLIC
The database driver being used, e.g., 'sqlite'.
-
orionis.foundation.config.database.SQLite.url
orionis.foundation.config.database.SQLite.html#url
Attribute
Instance Variable
PUBLIC
Informational URL, derived from database when omitted.
-
orionis.foundation.config.database.SQLite.database
orionis.foundation.config.database.SQLite.html#database
Attribute
Instance Variable
PUBLIC
The path to the SQLite database file.
-
orionis.foundation.config.database.SQLite.prefix
orionis.foundation.config.database.SQLite.html#prefix
Attribute
Instance Variable
PUBLIC
Prefix for table names.
-
orionis.foundation.config.database.SQLite.foreign_key_constraints
orionis.foundation.config.database.SQLite.html#foreign_key_constraints
Attribute
Instance Variable
PUBLIC
Whether foreign key constraints are enabled.
-
orionis.foundation.config.database.SQLite.busy_timeout
orionis.foundation.config.database.SQLite.html#busy_timeout
Attribute
Instance Variable
PUBLIC
The timeout period (in milliseconds) before retrying a locked database.
-
orionis.foundation.config.database.SQLite.journal_mode
orionis.foundation.config.database.SQLite.html#journal_mode
Attribute
Instance Variable
PUBLIC
The journal mode used for transactions.
-
orionis.foundation.config.database.SQLite.synchronous
orionis.foundation.config.database.SQLite.html#synchronous
Attribute
Instance Variable
PUBLIC
The synchronization level for the database.
-
orionis.foundation.config.database.SQLite.__normalizeForeignKeyConstraints
orionis.foundation.config.database.SQLite.html#__normalizeForeignKeyConstraints
Function
Method
PUBLIC
Normalize foreign-key settings to SQLite enum values.
-
orionis.foundation.config.database.SQLite.__normalizeJournalMode
orionis.foundation.config.database.SQLite.html#__normalizeJournalMode
Function
Method
PUBLIC
Normalize the SQLite journal mode option.
-
orionis.foundation.config.database.SQLite.__normalizeSynchronous
orionis.foundation.config.database.SQLite.html#__normalizeSynchronous
Function
Method
PUBLIC
Normalize the SQLite synchronous option.
-
orionis.foundation.config.database.SQLite.__post_init__
orionis.foundation.config.database.SQLite.html#__post_init__
Function
Method
PUBLIC
Validate SQLite options and derive the informational URL when absent.
-
orionis.foundation.config.database.SQLServer
orionis.foundation.config.database.SQLServer.html
Class
Class
PUBLIC
Represent the Microsoft SQL Server database configuration.
-
orionis.foundation.config.database.SQLServer.driver
orionis.foundation.config.database.SQLServer.html#driver
Attribute
Instance Variable
PUBLIC
The database driver being used, e.g., 'sqlserver'.
-
orionis.foundation.config.database.SQLServer.host
orionis.foundation.config.database.SQLServer.html#host
Attribute
Instance Variable
PUBLIC
The host address for the SQL Server instance.
-
orionis.foundation.config.database.SQLServer.port
orionis.foundation.config.database.SQLServer.html#port
Attribute
Instance Variable
PUBLIC
The port for connecting to SQL Server (default 1433).
-
orionis.foundation.config.database.SQLServer.database
orionis.foundation.config.database.SQLServer.html#database
Attribute
Instance Variable
PUBLIC
The name of the SQL Server database.
-
orionis.foundation.config.database.SQLServer.username
orionis.foundation.config.database.SQLServer.html#username
Attribute
Instance Variable
PUBLIC
The username for connecting to the database.
-
orionis.foundation.config.database.SQLServer.password
orionis.foundation.config.database.SQLServer.html#password
Attribute
Instance Variable
PUBLIC
The password for the database.
-
orionis.foundation.config.database.SQLServer.charset
orionis.foundation.config.database.SQLServer.html#charset
Attribute
Instance Variable
PUBLIC
The charset used for the connection.
-
orionis.foundation.config.database.SQLServer.prefix
orionis.foundation.config.database.SQLServer.html#prefix
Attribute
Instance Variable
PUBLIC
Prefix for table names.
-
orionis.foundation.config.database.SQLServer.prefix_indexes
orionis.foundation.config.database.SQLServer.html#prefix_indexes
Attribute
Instance Variable
PUBLIC
Whether to prefix index names.
-
orionis.foundation.config.database.SQLServer.encrypt
orionis.foundation.config.database.SQLServer.html#encrypt
Attribute
Instance Variable
PUBLIC
Whether the connection must be encrypted ('yes'/'no' or bool).
-
orionis.foundation.config.database.SQLServer.trust_server_certificate
orionis.foundation.config.database.SQLServer.html#trust_server_certificate
Attribute
Instance Variable
PUBLIC
Whether to trust the server certificate without validation.
-
orionis.foundation.config.database.SQLServer.odbc_driver
orionis.foundation.config.database.SQLServer.html#odbc_driver
Attribute
Instance Variable
PUBLIC
Name of the ODBC driver used by the connection.
-
orionis.foundation.config.database.SQLServer.__post_init__
orionis.foundation.config.database.SQLServer.html#__post_init__
Function
Method
PUBLIC
Validate the SQL Server configuration after initialization.
-
orionis.foundation.config.database.SQLServer.__validateDriver
orionis.foundation.config.database.SQLServer.html#__validateDriver
Function
Method
PUBLIC
Require the SQL Server driver discriminator.
-
orionis.foundation.config.database.SQLServer.__validateEndpoint
orionis.foundation.config.database.SQLServer.html#__validateEndpoint
Function
Method
PUBLIC
Validate the host, port, and database fields.
-
orionis.foundation.config.database.SQLServer.__validateCredentials
orionis.foundation.config.database.SQLServer.html#__validateCredentials
Function
Method
PUBLIC
Validate the username and password fields.
-
orionis.foundation.config.database.SQLServer.__validateOptions
orionis.foundation.config.database.SQLServer.html#__validateOptions
Function
Method
PUBLIC
Validate the prefix, charset, and ODBC connection options.
-
orionis.foundation.config.database.ConnectionName
orionis.foundation.config.database.ConnectionName.html
Class
Class
PUBLIC
Enumerate the built-in database connection names supported by Orionis.
-
orionis.foundation.config.database.ConnectionName.SQLITE
orionis.foundation.config.database.ConnectionName.html#SQLITE
Attribute
Constant
PUBLIC
Represents the SQLite database connection.
-
orionis.foundation.config.database.ConnectionName.MYSQL
orionis.foundation.config.database.ConnectionName.html#MYSQL
Attribute
Constant
PUBLIC
Represents the MySQL database connection.
-
orionis.foundation.config.database.ConnectionName.PGSQL
orionis.foundation.config.database.ConnectionName.html#PGSQL
Attribute
Constant
PUBLIC
Represents the PostgreSQL database connection.
-
orionis.foundation.config.database.ConnectionName.ORACLE
orionis.foundation.config.database.ConnectionName.html#ORACLE
Attribute
Constant
PUBLIC
Represents the Oracle database connection.
-
orionis.foundation.config.database.ConnectionName.SQLSERVER
orionis.foundation.config.database.ConnectionName.html#SQLSERVER
Attribute
Constant
PUBLIC
Represents the Microsoft SQL Server database connection.
-
orionis.foundation.config.database.ConnectionName.REDSHIFT
orionis.foundation.config.database.ConnectionName.html#REDSHIFT
Attribute
Constant
PUBLIC
Represents the Amazon Redshift database connection.
-
orionis.foundation.config.database.MySQLCharset
orionis.foundation.config.database.MySQLCharset.html
Class
Class
PUBLIC
Enumerate MySQL character sets usable by the configured connection drivers.
-
orionis.foundation.config.database.MySQLCharset.ASCII
orionis.foundation.config.database.MySQLCharset.html#ASCII
Attribute
Constant
PUBLIC
US ASCII.
-
orionis.foundation.config.database.MySQLCharset.BIG5
orionis.foundation.config.database.MySQLCharset.html#BIG5
Attribute
Constant
PUBLIC
Big5 Traditional Chinese.
-
orionis.foundation.config.database.MySQLCharset.CP1250
orionis.foundation.config.database.MySQLCharset.html#CP1250
Attribute
Constant
PUBLIC
Windows Central European.
-
orionis.foundation.config.database.MySQLCharset.CP1251
orionis.foundation.config.database.MySQLCharset.html#CP1251
Attribute
Constant
PUBLIC
Windows Cyrillic.
-
orionis.foundation.config.database.MySQLCharset.CP1256
orionis.foundation.config.database.MySQLCharset.html#CP1256
Attribute
Constant
PUBLIC
Windows Arabic.
-
orionis.foundation.config.database.MySQLCharset.CP1257
orionis.foundation.config.database.MySQLCharset.html#CP1257
Attribute
Constant
PUBLIC
Windows Baltic.
-
orionis.foundation.config.database.MySQLCharset.CP850
orionis.foundation.config.database.MySQLCharset.html#CP850
Attribute
Constant
PUBLIC
DOS West European.
-
orionis.foundation.config.database.MySQLCharset.CP852
orionis.foundation.config.database.MySQLCharset.html#CP852
Attribute
Constant
PUBLIC
DOS Central European.
-
orionis.foundation.config.database.MySQLCharset.CP866
orionis.foundation.config.database.MySQLCharset.html#CP866
Attribute
Constant
PUBLIC
DOS Russian.
-
orionis.foundation.config.database.MySQLCharset.CP932
orionis.foundation.config.database.MySQLCharset.html#CP932
Attribute
Constant
PUBLIC
SJIS for Windows Japanese.
-
orionis.foundation.config.database.MySQLCharset.EUCKR
orionis.foundation.config.database.MySQLCharset.html#EUCKR
Attribute
Constant
PUBLIC
EUC-KR Korean.
-
orionis.foundation.config.database.MySQLCharset.GB18030
orionis.foundation.config.database.MySQLCharset.html#GB18030
Attribute
Constant
PUBLIC
GB18030 Chinese national standard.
-
orionis.foundation.config.database.MySQLCharset.GB2312
orionis.foundation.config.database.MySQLCharset.html#GB2312
Attribute
Constant
PUBLIC
GB2312 Simplified Chinese.
-
orionis.foundation.config.database.MySQLCharset.GBK
orionis.foundation.config.database.MySQLCharset.html#GBK
Attribute
Constant
PUBLIC
GBK Simplified Chinese.
-
orionis.foundation.config.database.MySQLCharset.GREEK
orionis.foundation.config.database.MySQLCharset.html#GREEK
Attribute
Constant
PUBLIC
ISO 8859-7 Greek.
-
orionis.foundation.config.database.MySQLCharset.HEBREW
orionis.foundation.config.database.MySQLCharset.html#HEBREW
Attribute
Constant
PUBLIC
ISO 8859-8 Hebrew.
-
orionis.foundation.config.database.MySQLCharset.KOI8R
orionis.foundation.config.database.MySQLCharset.html#KOI8R
Attribute
Constant
PUBLIC
KOI8-R Relcom Russian.
-
orionis.foundation.config.database.MySQLCharset.KOI8U
orionis.foundation.config.database.MySQLCharset.html#KOI8U
Attribute
Constant
PUBLIC
KOI8-U Ukrainian.
-
orionis.foundation.config.database.MySQLCharset.LATIN1
orionis.foundation.config.database.MySQLCharset.html#LATIN1
Attribute
Constant
PUBLIC
cp1252 West European.
-
orionis.foundation.config.database.MySQLCharset.LATIN2
orionis.foundation.config.database.MySQLCharset.html#LATIN2
Attribute
Constant
PUBLIC
ISO 8859-2 Central European.
-
orionis.foundation.config.database.MySQLCharset.LATIN5
orionis.foundation.config.database.MySQLCharset.html#LATIN5
Attribute
Constant
PUBLIC
ISO 8859-9 Turkish.
-
orionis.foundation.config.database.MySQLCharset.LATIN7
orionis.foundation.config.database.MySQLCharset.html#LATIN7
Attribute
Constant
PUBLIC
ISO 8859-13 Baltic.
-
orionis.foundation.config.database.MySQLCharset.MACROMAN
orionis.foundation.config.database.MySQLCharset.html#MACROMAN
Attribute
Constant
PUBLIC
Mac West European.
-
orionis.foundation.config.database.MySQLCharset.SJIS
orionis.foundation.config.database.MySQLCharset.html#SJIS
Attribute
Constant
PUBLIC
Shift-JIS Japanese.
-
orionis.foundation.config.database.MySQLCharset.TIS620
orionis.foundation.config.database.MySQLCharset.html#TIS620
Attribute
Constant
PUBLIC
TIS620 Thai.
-
orionis.foundation.config.database.MySQLCharset.UJIS
orionis.foundation.config.database.MySQLCharset.html#UJIS
Attribute
Constant
PUBLIC
EUC-JP Japanese.
-
orionis.foundation.config.database.MySQLCharset.UTF8
orionis.foundation.config.database.MySQLCharset.html#UTF8
Attribute
Constant
PUBLIC
Deprecated MySQL alias for UTF8MB3; use UTF8MB4 for new connections.
-
orionis.foundation.config.database.MySQLCharset.UTF8MB3
orionis.foundation.config.database.MySQLCharset.html#UTF8MB3
Attribute
Constant
PUBLIC
Deprecated UTF-8 Unicode limited to three bytes per character.
-
orionis.foundation.config.database.MySQLCharset.UTF8MB4
orionis.foundation.config.database.MySQLCharset.html#UTF8MB4
Attribute
Constant
PUBLIC
UTF-8 Unicode with up to four bytes per character.
-
orionis.foundation.config.database.MySQLCollation
orionis.foundation.config.database.MySQLCollation.html
Class
Class
PUBLIC
Enumerate common MySQL collations.
-
orionis.foundation.config.database.MySQLCollation.UTF8_GENERAL_CI
orionis.foundation.config.database.MySQLCollation.html#UTF8_GENERAL_CI
Attribute
Constant
PUBLIC
UTF-8, case-insensitive, general collation.
-
orionis.foundation.config.database.MySQLCollation.UTF8_UNICODE_CI
orionis.foundation.config.database.MySQLCollation.html#UTF8_UNICODE_CI
Attribute
Constant
PUBLIC
UTF-8, case-insensitive, Unicode collation.
-
orionis.foundation.config.database.MySQLCollation.UTF8_BIN
orionis.foundation.config.database.MySQLCollation.html#UTF8_BIN
Attribute
Constant
PUBLIC
UTF-8, binary collation.
-
orionis.foundation.config.database.MySQLCollation.UTF8MB4_GENERAL_CI
orionis.foundation.config.database.MySQLCollation.html#UTF8MB4_GENERAL_CI
Attribute
Constant
PUBLIC
UTF-8MB4, case-insensitive, general collation.
-
orionis.foundation.config.database.MySQLCollation.UTF8MB4_UNICODE_CI
orionis.foundation.config.database.MySQLCollation.html#UTF8MB4_UNICODE_CI
Attribute
Constant
PUBLIC
UTF-8MB4, case-insensitive, Unicode collation.
-
orionis.foundation.config.database.MySQLCollation.UTF8MB4_BIN
orionis.foundation.config.database.MySQLCollation.html#UTF8MB4_BIN
Attribute
Constant
PUBLIC
UTF-8MB4, binary collation.
-
orionis.foundation.config.database.MySQLCollation.LATIN1_SWEDISH_CI
orionis.foundation.config.database.MySQLCollation.html#LATIN1_SWEDISH_CI
Attribute
Constant
PUBLIC
Latin1, case-insensitive, Swedish collation.
-
orionis.foundation.config.database.MySQLCollation.LATIN1_GENERAL_CI
orionis.foundation.config.database.MySQLCollation.html#LATIN1_GENERAL_CI
Attribute
Constant
PUBLIC
Latin1, case-insensitive, general collation.
-
orionis.foundation.config.database.MySQLCollation.LATIN1_BIN
orionis.foundation.config.database.MySQLCollation.html#LATIN1_BIN
Attribute
Constant
PUBLIC
Latin1, binary collation.
-
orionis.foundation.config.database.MySQLCollation.ASCII_GENERAL_CI
orionis.foundation.config.database.MySQLCollation.html#ASCII_GENERAL_CI
Attribute
Constant
PUBLIC
ASCII, case-insensitive, general collation.
-
orionis.foundation.config.database.MySQLCollation.ASCII_BIN
orionis.foundation.config.database.MySQLCollation.html#ASCII_BIN
Attribute
Constant
PUBLIC
ASCII, binary collation.
-
orionis.foundation.config.database.MySQLCollation.GB18030_CHINESE_CI
orionis.foundation.config.database.MySQLCollation.html#GB18030_CHINESE_CI
Attribute
Constant
PUBLIC
GB18030 default Chinese collation.
-
orionis.foundation.config.database.MySQLCollation.GB18030_BIN
orionis.foundation.config.database.MySQLCollation.html#GB18030_BIN
Attribute
Constant
PUBLIC
GB18030 binary collation.
-
orionis.foundation.config.database.MySQLCollation.GB18030_UNICODE_520_CI
orionis.foundation.config.database.MySQLCollation.html#GB18030_UNICODE_520_CI
Attribute
Constant
PUBLIC
GB18030 Unicode 5.2 collation.
-
orionis.foundation.config.database.MySQLEngine
orionis.foundation.config.database.MySQLEngine.html
Class
Class
PUBLIC
Enumerate supported MySQL storage engines.
-
orionis.foundation.config.database.MySQLEngine.INNODB
orionis.foundation.config.database.MySQLEngine.html#INNODB
Attribute
Constant
PUBLIC
Default transactional storage engine, supports ACID compliance and foreign keys.
-
orionis.foundation.config.database.OracleEncoding
orionis.foundation.config.database.OracleEncoding.html
Class
Class
PUBLIC
Enumerate Oracle database character encodings.
-
orionis.foundation.config.database.OracleEncoding.AL32UTF8
orionis.foundation.config.database.OracleEncoding.html#AL32UTF8
Attribute
Constant
PUBLIC
AL32UTF8.
-
orionis.foundation.config.database.OracleNencoding
orionis.foundation.config.database.OracleNencoding.html
Class
Class
PUBLIC
Represent Oracle national character sets supported by Oracle Database.
-
orionis.foundation.config.database.OracleNencoding.AL16UTF16
orionis.foundation.config.database.OracleNencoding.html#AL16UTF16
Attribute
Constant
PUBLIC
UTF-16 big-endian national character set.
-
orionis.foundation.config.database.OracleNencoding.UTF8
orionis.foundation.config.database.OracleNencoding.html#UTF8
Attribute
Constant
PUBLIC
CESU-8 national character set.
-
orionis.foundation.config.database.PGSQLCharset
orionis.foundation.config.database.PGSQLCharset.html
Class
Class
PUBLIC
Enumerate PostgreSQL encodings supported for database storage.
-
orionis.foundation.config.database.PGSQLCharset.EUC_CN
orionis.foundation.config.database.PGSQLCharset.html#EUC_CN
Attribute
Constant
PUBLIC
Extended Unix Code for Simplified Chinese.
-
orionis.foundation.config.database.PGSQLCharset.EUC_JP
orionis.foundation.config.database.PGSQLCharset.html#EUC_JP
Attribute
Constant
PUBLIC
Extended Unix Code for Japanese.
-
orionis.foundation.config.database.PGSQLCharset.EUC_JIS_2004
orionis.foundation.config.database.PGSQLCharset.html#EUC_JIS_2004
Attribute
Constant
PUBLIC
Japanese EUC encoding for JIS X 0213.
-
orionis.foundation.config.database.PGSQLCharset.EUC_KR
orionis.foundation.config.database.PGSQLCharset.html#EUC_KR
Attribute
Constant
PUBLIC
Extended Unix Code for Korean.
-
orionis.foundation.config.database.PGSQLCharset.EUC_TW
orionis.foundation.config.database.PGSQLCharset.html#EUC_TW
Attribute
Constant
PUBLIC
Extended Unix Code for Traditional Chinese.
-
orionis.foundation.config.database.PGSQLCharset.ISO_8859_5
orionis.foundation.config.database.PGSQLCharset.html#ISO_8859_5
Attribute
Constant
PUBLIC
ISO 8859-5 Cyrillic encoding.
-
orionis.foundation.config.database.PGSQLCharset.ISO_8859_6
orionis.foundation.config.database.PGSQLCharset.html#ISO_8859_6
Attribute
Constant
PUBLIC
ISO 8859-6 Arabic encoding.
-
orionis.foundation.config.database.PGSQLCharset.ISO_8859_7
orionis.foundation.config.database.PGSQLCharset.html#ISO_8859_7
Attribute
Constant
PUBLIC
ISO 8859-7 Greek encoding.
-
orionis.foundation.config.database.PGSQLCharset.ISO_8859_8
orionis.foundation.config.database.PGSQLCharset.html#ISO_8859_8
Attribute
Constant
PUBLIC
ISO 8859-8 Hebrew encoding.
-
orionis.foundation.config.database.PGSQLCharset.KOI8R
orionis.foundation.config.database.PGSQLCharset.html#KOI8R
Attribute
Constant
PUBLIC
KOI8-R Russian encoding.
-
orionis.foundation.config.database.PGSQLCharset.KOI8U
orionis.foundation.config.database.PGSQLCharset.html#KOI8U
Attribute
Constant
PUBLIC
KOI8-U Ukrainian encoding.
-
orionis.foundation.config.database.PGSQLCharset.LATIN1
orionis.foundation.config.database.PGSQLCharset.html#LATIN1
Attribute
Constant
PUBLIC
ISO 8859-1 Western European encoding.
-
orionis.foundation.config.database.PGSQLCharset.LATIN2
orionis.foundation.config.database.PGSQLCharset.html#LATIN2
Attribute
Constant
PUBLIC
ISO 8859-2 Central European encoding.
-
orionis.foundation.config.database.PGSQLCharset.LATIN3
orionis.foundation.config.database.PGSQLCharset.html#LATIN3
Attribute
Constant
PUBLIC
ISO 8859-3 South European encoding.
-
orionis.foundation.config.database.PGSQLCharset.LATIN4
orionis.foundation.config.database.PGSQLCharset.html#LATIN4
Attribute
Constant
PUBLIC
ISO 8859-4 North European encoding.
-
orionis.foundation.config.database.PGSQLCharset.LATIN5
orionis.foundation.config.database.PGSQLCharset.html#LATIN5
Attribute
Constant
PUBLIC
ISO 8859-9 Turkish encoding.
-
orionis.foundation.config.database.PGSQLCharset.LATIN6
orionis.foundation.config.database.PGSQLCharset.html#LATIN6
Attribute
Constant
PUBLIC
ISO 8859-10 Nordic encoding.
-
orionis.foundation.config.database.PGSQLCharset.LATIN7
orionis.foundation.config.database.PGSQLCharset.html#LATIN7
Attribute
Constant
PUBLIC
ISO 8859-13 Baltic Rim encoding.
-
orionis.foundation.config.database.PGSQLCharset.LATIN8
orionis.foundation.config.database.PGSQLCharset.html#LATIN8
Attribute
Constant
PUBLIC
ISO 8859-14 Celtic encoding.
-
orionis.foundation.config.database.PGSQLCharset.LATIN9
orionis.foundation.config.database.PGSQLCharset.html#LATIN9
Attribute
Constant
PUBLIC
ISO 8859-15 Western European encoding with Euro.
-
orionis.foundation.config.database.PGSQLCharset.LATIN10
orionis.foundation.config.database.PGSQLCharset.html#LATIN10
Attribute
Constant
PUBLIC
ISO 8859-16 South-Eastern European encoding.
-
orionis.foundation.config.database.PGSQLCharset.UTF8
orionis.foundation.config.database.PGSQLCharset.html#UTF8
Attribute
Constant
PUBLIC
Unicode UTF-8 encoding.
-
orionis.foundation.config.database.PGSQLCharset.WIN866
orionis.foundation.config.database.PGSQLCharset.html#WIN866
Attribute
Constant
PUBLIC
Windows code page 866 (Cyrillic).
-
orionis.foundation.config.database.PGSQLCharset.WIN874
orionis.foundation.config.database.PGSQLCharset.html#WIN874
Attribute
Constant
PUBLIC
Windows code page 874 (Thai).
-
orionis.foundation.config.database.PGSQLCharset.WIN1250
orionis.foundation.config.database.PGSQLCharset.html#WIN1250
Attribute
Constant
PUBLIC
Windows code page 1250 (Central European).
-
orionis.foundation.config.database.PGSQLCharset.WIN1251
orionis.foundation.config.database.PGSQLCharset.html#WIN1251
Attribute
Constant
PUBLIC
Windows code page 1251 (Cyrillic).
-
orionis.foundation.config.database.PGSQLCharset.WIN1252
orionis.foundation.config.database.PGSQLCharset.html#WIN1252
Attribute
Constant
PUBLIC
Windows code page 1252 (Western European).
-
orionis.foundation.config.database.PGSQLCharset.WIN1253
orionis.foundation.config.database.PGSQLCharset.html#WIN1253
Attribute
Constant
PUBLIC
Windows code page 1253 (Greek).
-
orionis.foundation.config.database.PGSQLCharset.WIN1254
orionis.foundation.config.database.PGSQLCharset.html#WIN1254
Attribute
Constant
PUBLIC
Windows code page 1254 (Turkish).
-
orionis.foundation.config.database.PGSQLCharset.WIN1255
orionis.foundation.config.database.PGSQLCharset.html#WIN1255
Attribute
Constant
PUBLIC
Windows code page 1255 (Hebrew).
-
orionis.foundation.config.database.PGSQLCharset.WIN1256
orionis.foundation.config.database.PGSQLCharset.html#WIN1256
Attribute
Constant
PUBLIC
Windows code page 1256 (Arabic).
-
orionis.foundation.config.database.PGSQLCharset.WIN1257
orionis.foundation.config.database.PGSQLCharset.html#WIN1257
Attribute
Constant
PUBLIC
Windows code page 1257 (Baltic).
-
orionis.foundation.config.database.PGSQLCharset.WIN1258
orionis.foundation.config.database.PGSQLCharset.html#WIN1258
Attribute
Constant
PUBLIC
Windows code page 1258 (Vietnamese).
-
orionis.foundation.config.database.PGSQLCollation
orionis.foundation.config.database.PGSQLCollation.html
Class
Class
PUBLIC
Enumerate common PostgreSQL collations.
-
orionis.foundation.config.database.PGSQLCollation.C
orionis.foundation.config.database.PGSQLCollation.html#C
Attribute
Constant
PUBLIC
Binary collation, fast, based on byte order.
-
orionis.foundation.config.database.PGSQLCollation.POSIX
orionis.foundation.config.database.PGSQLCollation.html#POSIX
Attribute
Constant
PUBLIC
Similar to 'C', binary order.
-
orionis.foundation.config.database.PGSQLSSLMode
orionis.foundation.config.database.PGSQLSSLMode.html
Class
Class
PUBLIC
Define SSL modes for PostgreSQL connections.
-
orionis.foundation.config.database.PGSQLSSLMode.DISABLE
orionis.foundation.config.database.PGSQLSSLMode.html#DISABLE
Attribute
Constant
PUBLIC
No SSL (not secure).
-
orionis.foundation.config.database.PGSQLSSLMode.ALLOW
orionis.foundation.config.database.PGSQLSSLMode.html#ALLOW
Attribute
Constant
PUBLIC
Attempt SSL, silently fall back if unavailable.
-
orionis.foundation.config.database.PGSQLSSLMode.PREFER
orionis.foundation.config.database.PGSQLSSLMode.html#PREFER
Attribute
Constant
PUBLIC
Use SSL if available (common default).
-
orionis.foundation.config.database.PGSQLSSLMode.REQUIRE
orionis.foundation.config.database.PGSQLSSLMode.html#REQUIRE
Attribute
Constant
PUBLIC
Require SSL (no certificate validation).
-
orionis.foundation.config.database.PGSQLSSLMode.VERIFY_CA
orionis.foundation.config.database.PGSQLSSLMode.html#VERIFY_CA
Attribute
Constant
PUBLIC
Validate the server certificate against the CA.
-
orionis.foundation.config.database.PGSQLSSLMode.VERIFY_FULL
orionis.foundation.config.database.PGSQLSSLMode.html#VERIFY_FULL
Attribute
Constant
PUBLIC
Validate both the certificate and the host name (most secure).
-
orionis.foundation.config.database.RedshiftSSLMode
orionis.foundation.config.database.RedshiftSSLMode.html
Class
Class
PUBLIC
Enumerate certificate verification modes supported by the AWS connector.
-
orionis.foundation.config.database.RedshiftSSLMode.VERIFY_CA
orionis.foundation.config.database.RedshiftSSLMode.html#VERIFY_CA
Attribute
Constant
PUBLIC
verify-ca.
-
orionis.foundation.config.database.RedshiftSSLMode.VERIFY_FULL
orionis.foundation.config.database.RedshiftSSLMode.html#VERIFY_FULL
Attribute
Constant
PUBLIC
verify-full.
-
orionis.foundation.config.database.SQLiteForeignKey
orionis.foundation.config.database.SQLiteForeignKey.html
Class
Class
PUBLIC
Represent the state of foreign key constraints in SQLite.
-
orionis.foundation.config.database.SQLiteForeignKey.ON
orionis.foundation.config.database.SQLiteForeignKey.html#ON
Attribute
Constant
PUBLIC
Enables foreign key constraint enforcement.
-
orionis.foundation.config.database.SQLiteForeignKey.OFF
orionis.foundation.config.database.SQLiteForeignKey.html#OFF
Attribute
Constant
PUBLIC
Disables foreign key constraint enforcement.
-
orionis.foundation.config.database.SQLiteJournalMode
orionis.foundation.config.database.SQLiteJournalMode.html
Class
Class
PUBLIC
Enumerate SQLite journal modes.
-
orionis.foundation.config.database.SQLiteJournalMode.DELETE
orionis.foundation.config.database.SQLiteJournalMode.html#DELETE
Attribute
Constant
PUBLIC
The journal file is deleted at the end of each transaction.
-
orionis.foundation.config.database.SQLiteJournalMode.TRUNCATE
orionis.foundation.config.database.SQLiteJournalMode.html#TRUNCATE
Attribute
Constant
PUBLIC
The journal file is truncated to zero bytes instead of being deleted.
-
orionis.foundation.config.database.SQLiteJournalMode.PERSIST
orionis.foundation.config.database.SQLiteJournalMode.html#PERSIST
Attribute
Constant
PUBLIC
The journal file is retained but marked as inactive after a transaction.
-
orionis.foundation.config.database.SQLiteJournalMode.MEMORY
orionis.foundation.config.database.SQLiteJournalMode.html#MEMORY
Attribute
Constant
PUBLIC
The journal is kept in volatile memory, offering faster performance but less safety.
-
orionis.foundation.config.database.SQLiteJournalMode.WAL
orionis.foundation.config.database.SQLiteJournalMode.html#WAL
Attribute
Constant
PUBLIC
Write-Ahead Logging mode, which can improve concurrency and performance.
-
orionis.foundation.config.database.SQLiteJournalMode.OFF
orionis.foundation.config.database.SQLiteJournalMode.html#OFF
Attribute
Constant
PUBLIC
Disables journaling entirely, providing no protection against failures.
-
orionis.foundation.config.database.SQLiteSynchronous
orionis.foundation.config.database.SQLiteSynchronous.html
Class
Class
PUBLIC
Represent SQLite synchronous settings for transaction durability.
-
orionis.foundation.config.database.SQLiteSynchronous.FULL
orionis.foundation.config.database.SQLiteSynchronous.html#FULL
Attribute
Constant
PUBLIC
Provides maximum data integrity and durability, but is the slowest option.
-
orionis.foundation.config.database.SQLiteSynchronous.NORMAL
orionis.foundation.config.database.SQLiteSynchronous.html#NORMAL
Attribute
Constant
PUBLIC
Offers a balance between data safety and performance.
-
orionis.foundation.config.database.SQLiteSynchronous.OFF
orionis.foundation.config.database.SQLiteSynchronous.html#OFF
Attribute
Constant
PUBLIC
Maximizes speed, but data may be lost in the event of a crash.
-
orionis.foundation.config.database.SQLServerCharset
orionis.foundation.config.database.SQLServerCharset.html
Class
Class
PUBLIC
Enumerate SQLCHAR encodings documented for SQL Server ODBC on Linux and macOS.
-
orionis.foundation.config.database.SQLServerCharset.UTF8
orionis.foundation.config.database.SQLServerCharset.html#UTF8
Attribute
Constant
PUBLIC
UTF-8.
-
orionis.foundation.config.database.SQLServerCharset.CP437
orionis.foundation.config.database.SQLServerCharset.html#CP437
Attribute
Constant
PUBLIC
CP437.
-
orionis.foundation.config.database.SQLServerCharset.CP850
orionis.foundation.config.database.SQLServerCharset.html#CP850
Attribute
Constant
PUBLIC
CP850.
-
orionis.foundation.config.database.SQLServerCharset.CP874
orionis.foundation.config.database.SQLServerCharset.html#CP874
Attribute
Constant
PUBLIC
CP874.
-
orionis.foundation.config.database.SQLServerCharset.CP932
orionis.foundation.config.database.SQLServerCharset.html#CP932
Attribute
Constant
PUBLIC
CP932.
-
orionis.foundation.config.database.SQLServerCharset.CP936
orionis.foundation.config.database.SQLServerCharset.html#CP936
Attribute
Constant
PUBLIC
CP936.
-
orionis.foundation.config.database.SQLServerCharset.CP949
orionis.foundation.config.database.SQLServerCharset.html#CP949
Attribute
Constant
PUBLIC
CP949.
-
orionis.foundation.config.database.SQLServerCharset.CP950
orionis.foundation.config.database.SQLServerCharset.html#CP950
Attribute
Constant
PUBLIC
CP950.
-
orionis.foundation.config.database.SQLServerCharset.CP1250
orionis.foundation.config.database.SQLServerCharset.html#CP1250
Attribute
Constant
PUBLIC
CP1250.
-
orionis.foundation.config.database.SQLServerCharset.CP1251
orionis.foundation.config.database.SQLServerCharset.html#CP1251
Attribute
Constant
PUBLIC
CP1251.
-
orionis.foundation.config.database.SQLServerCharset.CP1252
orionis.foundation.config.database.SQLServerCharset.html#CP1252
Attribute
Constant
PUBLIC
CP1252.
-
orionis.foundation.config.database.SQLServerCharset.CP1253
orionis.foundation.config.database.SQLServerCharset.html#CP1253
Attribute
Constant
PUBLIC
CP1253.
-
orionis.foundation.config.database.SQLServerCharset.CP1254
orionis.foundation.config.database.SQLServerCharset.html#CP1254
Attribute
Constant
PUBLIC
CP1254.
-
orionis.foundation.config.database.SQLServerCharset.CP1255
orionis.foundation.config.database.SQLServerCharset.html#CP1255
Attribute
Constant
PUBLIC
CP1255.
-
orionis.foundation.config.database.SQLServerCharset.CP1256
orionis.foundation.config.database.SQLServerCharset.html#CP1256
Attribute
Constant
PUBLIC
CP1256.
-
orionis.foundation.config.database.SQLServerCharset.CP1257
orionis.foundation.config.database.SQLServerCharset.html#CP1257
Attribute
Constant
PUBLIC
CP1257.
-
orionis.foundation.config.database.SQLServerCharset.CP1258
orionis.foundation.config.database.SQLServerCharset.html#CP1258
Attribute
Constant
PUBLIC
CP1258.
-
orionis.foundation.config.database.SQLServerCharset.ISO_8859_1
orionis.foundation.config.database.SQLServerCharset.html#ISO_8859_1
Attribute
Constant
PUBLIC
ISO-8859-1.
-
orionis.foundation.config.database.SQLServerCharset.ISO_8859_2
orionis.foundation.config.database.SQLServerCharset.html#ISO_8859_2
Attribute
Constant
PUBLIC
ISO-8859-2.
-
orionis.foundation.config.database.SQLServerCharset.ISO_8859_3
orionis.foundation.config.database.SQLServerCharset.html#ISO_8859_3
Attribute
Constant
PUBLIC
ISO-8859-3.
-
orionis.foundation.config.database.SQLServerCharset.ISO_8859_4
orionis.foundation.config.database.SQLServerCharset.html#ISO_8859_4
Attribute
Constant
PUBLIC
ISO-8859-4.
-
orionis.foundation.config.database.SQLServerCharset.ISO_8859_5
orionis.foundation.config.database.SQLServerCharset.html#ISO_8859_5
Attribute
Constant
PUBLIC
ISO-8859-5.
-
orionis.foundation.config.database.SQLServerCharset.ISO_8859_6
orionis.foundation.config.database.SQLServerCharset.html#ISO_8859_6
Attribute
Constant
PUBLIC
ISO-8859-6.
-
orionis.foundation.config.database.SQLServerCharset.ISO_8859_7
orionis.foundation.config.database.SQLServerCharset.html#ISO_8859_7
Attribute
Constant
PUBLIC
ISO-8859-7.
-
orionis.foundation.config.database.SQLServerCharset.ISO_8859_8
orionis.foundation.config.database.SQLServerCharset.html#ISO_8859_8
Attribute
Constant
PUBLIC
ISO-8859-8.
-
orionis.foundation.config.database.SQLServerCharset.ISO_8859_9
orionis.foundation.config.database.SQLServerCharset.html#ISO_8859_9
Attribute
Constant
PUBLIC
ISO-8859-9.
-
orionis.foundation.config.database.SQLServerCharset.ISO_8859_13
orionis.foundation.config.database.SQLServerCharset.html#ISO_8859_13
Attribute
Constant
PUBLIC
ISO-8859-13.
-
orionis.foundation.config.database.SQLServerCharset.ISO_8859_15
orionis.foundation.config.database.SQLServerCharset.html#ISO_8859_15
Attribute
Constant
PUBLIC
ISO-8859-15.
-
orionis.foundation.config.database._EXPORTS
orionis.foundation.config.database.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.foundation.config.database.__getattr__
orionis.foundation.config.database.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public database configuration export.
-
orionis.foundation.config.database.__dir__
orionis.foundation.config.database.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared database configuration exports.
-
orionis.foundation.config.filesystems.S3
orionis.foundation.config.filesystems.S3.html
Class
Class
PUBLIC
Represent an AWS S3 storage configuration.
-
orionis.foundation.config.filesystems.S3.driver
orionis.foundation.config.filesystems.S3.html#driver
Attribute
Instance Variable
PUBLIC
The filesystem driver name. Built-in names are "aws" and "s3".
-
orionis.foundation.config.filesystems.S3.key
orionis.foundation.config.filesystems.S3.html#key
Attribute
Instance Variable
PUBLIC
AWS access key ID.
-
orionis.foundation.config.filesystems.S3.secret
orionis.foundation.config.filesystems.S3.html#secret
Attribute
Instance Variable
PUBLIC
AWS secret access key.
-
orionis.foundation.config.filesystems.S3.region
orionis.foundation.config.filesystems.S3.html#region
Attribute
Instance Variable
PUBLIC
AWS region where the bucket is located.
-
orionis.foundation.config.filesystems.S3.bucket
orionis.foundation.config.filesystems.S3.html#bucket
Attribute
Instance Variable
PUBLIC
The S3 bucket name.
-
orionis.foundation.config.filesystems.S3.url
orionis.foundation.config.filesystems.S3.html#url
Attribute
Instance Variable
PUBLIC
The URL endpoint for accessing the S3 bucket.
-
orionis.foundation.config.filesystems.S3.endpoint
orionis.foundation.config.filesystems.S3.html#endpoint
Attribute
Instance Variable
PUBLIC
The AWS S3 endpoint URL.
-
orionis.foundation.config.filesystems.S3.use_path_style_endpoint
orionis.foundation.config.filesystems.S3.html#use_path_style_endpoint
Attribute
Instance Variable
PUBLIC
Whether to use a path-style endpoint.
-
orionis.foundation.config.filesystems.S3.__post_init__
orionis.foundation.config.filesystems.S3.html#__post_init__
Function
Method
PUBLIC
Validate initialization of AWS filesystem entity attributes.
-
orionis.foundation.config.filesystems.Azure
orionis.foundation.config.filesystems.Azure.html
Class
Class
PUBLIC
Represent an Azure Blob Storage configuration.
-
orionis.foundation.config.filesystems.Azure.driver
orionis.foundation.config.filesystems.Azure.html#driver
Attribute
Instance Variable
PUBLIC
The filesystem driver name resolved by StorageManager.
-
orionis.foundation.config.filesystems.Azure.connection_string
orionis.foundation.config.filesystems.Azure.html#connection_string
Attribute
Instance Variable
PUBLIC
Azure storage connection string. When provided, it takes precedence over the account name and key.
-
orionis.foundation.config.filesystems.Azure.account_name
orionis.foundation.config.filesystems.Azure.html#account_name
Attribute
Instance Variable
PUBLIC
Azure storage account name.
-
orionis.foundation.config.filesystems.Azure.account_key
orionis.foundation.config.filesystems.Azure.html#account_key
Attribute
Instance Variable
PUBLIC
Azure storage account key.
-
orionis.foundation.config.filesystems.Azure.container
orionis.foundation.config.filesystems.Azure.html#container
Attribute
Instance Variable
PUBLIC
The blob container name.
-
orionis.foundation.config.filesystems.Azure.url
orionis.foundation.config.filesystems.Azure.html#url
Attribute
Instance Variable
PUBLIC
Public base URL used to build file URLs.
-
orionis.foundation.config.filesystems.Azure.__post_init__
orionis.foundation.config.filesystems.Azure.html#__post_init__
Function
Method
PUBLIC
Validate the types of the Azure entity attributes.
-
orionis.foundation.config.filesystems.entitites.disks._DISK_ENTITIES
orionis.foundation.config.filesystems.entitites.disks.html#_DISK_ENTITIES
Attribute
Constant
PUBLIC
Disk entities definitions used by disks.
-
orionis.foundation.config.filesystems.Disks
orionis.foundation.config.filesystems.Disks.html
Class
Class
PUBLIC
Represent the configuration for different filesystem disks.
-
orionis.foundation.config.filesystems.Disks.local
orionis.foundation.config.filesystems.Disks.html#local
Attribute
Instance Variable
PUBLIC
The disk configuration for local file storage.
-
orionis.foundation.config.filesystems.Disks.public
orionis.foundation.config.filesystems.Disks.html#public
Attribute
Instance Variable
PUBLIC
The disk configuration for public file storage.
-
orionis.foundation.config.filesystems.Disks.s3
orionis.foundation.config.filesystems.Disks.html#s3
Attribute
Instance Variable
PUBLIC
The configuration for AWS S3 storage.
-
orionis.foundation.config.filesystems.Disks.azure
orionis.foundation.config.filesystems.Disks.html#azure
Attribute
Instance Variable
PUBLIC
The configuration for Azure Blob Storage.
-
orionis.foundation.config.filesystems.Disks.gcs
orionis.foundation.config.filesystems.Disks.html#gcs
Attribute
Instance Variable
PUBLIC
The configuration for Google Cloud Storage.
-
orionis.foundation.config.filesystems.Disks.__post_init__
orionis.foundation.config.filesystems.Disks.html#__post_init__
Function
Method
PUBLIC
Validate and convert disk attributes after initialization.
-
orionis.foundation.config.filesystems.entitites.filesystems._DISK_NAMES
orionis.foundation.config.filesystems.entitites.filesystems.html#_DISK_NAMES
Attribute
Constant
PUBLIC
Define the supported filesystem disk names.
-
orionis.foundation.config.filesystems.Filesystems
orionis.foundation.config.filesystems.Filesystems.html
Class
Class
PUBLIC
Represent the filesystems configuration.
-
orionis.foundation.config.filesystems.Filesystems.default
orionis.foundation.config.filesystems.Filesystems.html#default
Attribute
Instance Variable
PUBLIC
The name of the default filesystem disk to use. Accepts a DiskName enum member or a plain string (e.g. 'local').
-
orionis.foundation.config.filesystems.Filesystems.disks
orionis.foundation.config.filesystems.Filesystems.html#disks
Attribute
Instance Variable
PUBLIC
A collection of available filesystem disks.
-
orionis.foundation.config.filesystems.Filesystems.__post_init__
orionis.foundation.config.filesystems.Filesystems.html#__post_init__
Function
Method
PUBLIC
Validate the types of attributes after initialization.
-
orionis.foundation.config.filesystems.GCS
orionis.foundation.config.filesystems.GCS.html
Class
Class
PUBLIC
Represent a Google Cloud Storage configuration.
-
orionis.foundation.config.filesystems.GCS.driver
orionis.foundation.config.filesystems.GCS.html#driver
Attribute
Instance Variable
PUBLIC
The filesystem driver name. Built-in names are "gcs" and "google".
-
orionis.foundation.config.filesystems.GCS.project_id
orionis.foundation.config.filesystems.GCS.html#project_id
Attribute
Instance Variable
PUBLIC
Google Cloud project identifier.
-
orionis.foundation.config.filesystems.GCS.key_file
orionis.foundation.config.filesystems.GCS.html#key_file
Attribute
Instance Variable
PUBLIC
Path to the service-account JSON key file. When omitted, Application Default Credentials are used.
-
orionis.foundation.config.filesystems.GCS.bucket
orionis.foundation.config.filesystems.GCS.html#bucket
Attribute
Instance Variable
PUBLIC
The GCS bucket name.
-
orionis.foundation.config.filesystems.GCS.url
orionis.foundation.config.filesystems.GCS.html#url
Attribute
Instance Variable
PUBLIC
Public base URL used to build file URLs.
-
orionis.foundation.config.filesystems.GCS.__post_init__
orionis.foundation.config.filesystems.GCS.html#__post_init__
Function
Method
PUBLIC
Validate the types of the GCS entity attributes.
-
orionis.foundation.config.filesystems.Local
orionis.foundation.config.filesystems.Local.html
Class
Class
PUBLIC
Represent a local filesystem configuration.
-
orionis.foundation.config.filesystems.Local.local
orionis.foundation.config.filesystems.Local.html#local
Attribute
Instance Variable
PUBLIC
The local filesystem configuration entity.
-
orionis.foundation.config.filesystems.Local.path
orionis.foundation.config.filesystems.Local.html#path
Attribute
Instance Variable
PUBLIC
The absolute or relative path where local files are stored.
-
orionis.foundation.config.filesystems.Local.driver
orionis.foundation.config.filesystems.Local.html#driver
Attribute
Class Variable
PUBLIC
Driver produced by field.
-
orionis.foundation.config.filesystems.Local.__post_init__
orionis.foundation.config.filesystems.Local.html#__post_init__
Function
Method
PUBLIC
Validate and initialize the 'path' attribute after object creation.
-
orionis.foundation.config.filesystems.Public
orionis.foundation.config.filesystems.Public.html
Class
Class
PUBLIC
Represent a local filesystem configuration.
-
orionis.foundation.config.filesystems.Public.driver
orionis.foundation.config.filesystems.Public.html#driver
Attribute
Instance Variable
PUBLIC
The filesystem driver name resolved by StorageManager.
-
orionis.foundation.config.filesystems.Public.path
orionis.foundation.config.filesystems.Public.html#path
Attribute
Instance Variable
PUBLIC
The absolute or relative path where public files are stored.
-
orionis.foundation.config.filesystems.Public.url
orionis.foundation.config.filesystems.Public.html#url
Attribute
Instance Variable
PUBLIC
The URL where the public files can be accessed.
-
orionis.foundation.config.filesystems.Public.__post_init__
orionis.foundation.config.filesystems.Public.html#__post_init__
Function
Method
PUBLIC
Validate and initialize the Public entity.
-
orionis.foundation.config.filesystems._EXPORTS
orionis.foundation.config.filesystems.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.foundation.config.filesystems.__getattr__
orionis.foundation.config.filesystems.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.foundation.config.filesystems.__dir__
orionis.foundation.config.filesystems.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.foundation.config.filesystems.enums.DiskName
orionis.foundation.config.filesystems.enums.DiskName.html
Class
Class
PUBLIC
Enumerate the built-in filesystem disk names supported by Orionis.
-
orionis.foundation.config.filesystems.enums.DiskName.LOCAL
orionis.foundation.config.filesystems.enums.DiskName.html#LOCAL
Attribute
Constant
PUBLIC
Represents the local private disk.
-
orionis.foundation.config.filesystems.enums.DiskName.PUBLIC
orionis.foundation.config.filesystems.enums.DiskName.html#PUBLIC
Attribute
Constant
PUBLIC
Represents the local public disk.
-
orionis.foundation.config.filesystems.enums.DiskName.S3
orionis.foundation.config.filesystems.enums.DiskName.html#S3
Attribute
Constant
PUBLIC
Represents the AWS S3 disk.
-
orionis.foundation.config.filesystems.enums.DiskName.AZURE
orionis.foundation.config.filesystems.enums.DiskName.html#AZURE
Attribute
Constant
PUBLIC
Represents the Azure Blob Storage disk.
-
orionis.foundation.config.filesystems.enums.DiskName.GCS
orionis.foundation.config.filesystems.enums.DiskName.html#GCS
Attribute
Constant
PUBLIC
Represents the Google Cloud Storage disk.
-
orionis.hashing.exceptions.HashException
orionis.hashing.exceptions.HashException.html
Class
Exception
PUBLIC
Base exception for every failure raised by the hashing module.
-
orionis.hashing.exceptions.HashConfigurationException
orionis.hashing.exceptions.HashConfigurationException.html
Class
Exception
PUBLIC
Raised when a hashing driver receives invalid cost parameters.
-
orionis.hashing.exceptions.HashDriverNotSupportedException
orionis.hashing.exceptions.HashDriverNotSupportedException.html
Class
Exception
PUBLIC
Raised when the configured hashing driver has no implementation.
-
orionis.hashing.exceptions.MissingHashDependencyException
orionis.hashing.exceptions.MissingHashDependencyException.html
Class
Exception
PUBLIC
Raised when the backend package of a hashing driver is missing.
-
orionis.hashing.hashers.functions.ARGON2_MAX_COST
orionis.hashing.hashers.functions.html#ARGON2_MAX_COST
Attribute
Constant
PUBLIC
Largest memory or time cost representable by the native Argon2 interface.
-
orionis.hashing.hashers.functions.ARGON2_MAX_THREADS
orionis.hashing.hashers.functions.html#ARGON2_MAX_THREADS
Attribute
Constant
PUBLIC
Largest number of parallel lanes supported by Argon2.
-
orionis.hashing.hashers.functions.ARGON2_MEMORY_PER_THREAD
orionis.hashing.hashers.functions.html#ARGON2_MEMORY_PER_THREAD
Attribute
Constant
PUBLIC
Minimum memory in kibibytes required for each Argon2 lane.
-
orionis.hashing.hashers.functions.import_hasher_backend
orionis.hashing.hashers.functions.html#import_hasher_backend
Function
Function
PUBLIC
Import the backend class of a hashing driver on demand.
-
orionis.foundation.config.hashing.Argon2
orionis.foundation.config.hashing.Argon2.html
Class
Class
PUBLIC
Represent the configuration entity for the Argon2id hashing driver.
-
orionis.foundation.config.hashing.Argon2.memory
orionis.foundation.config.hashing.Argon2.html#memory
Attribute
Instance Variable
PUBLIC
Amount of memory, in kibibytes, used by the algorithm.
-
orionis.foundation.config.hashing.Argon2.threads
orionis.foundation.config.hashing.Argon2.html#threads
Attribute
Instance Variable
PUBLIC
Degree of parallelism used by the algorithm.
-
orionis.foundation.config.hashing.Argon2.time
orionis.foundation.config.hashing.Argon2.html#time
Attribute
Instance Variable
PUBLIC
Number of iterations performed by the algorithm.
-
orionis.foundation.config.hashing.Argon2.__post_init__
orionis.foundation.config.hashing.Argon2.html#__post_init__
Function
Method
PUBLIC
Validate the Argon2id cost parameters after initialization.
-
orionis.foundation.config.hashing.entities.bcrypt._MIN_ROUNDS
orionis.foundation.config.hashing.entities.bcrypt.html#_MIN_ROUNDS
Attribute
Constant
PUBLIC
Bounds imposed by the bcrypt algorithm itself.
-
orionis.foundation.config.hashing.entities.bcrypt._MAX_ROUNDS
orionis.foundation.config.hashing.entities.bcrypt.html#_MAX_ROUNDS
Attribute
Constant
PUBLIC
Max rounds value used by bcrypt.
-
orionis.foundation.config.hashing.Bcrypt
orionis.foundation.config.hashing.Bcrypt.html
Class
Class
PUBLIC
Represent the configuration entity for the bcrypt hashing driver.
-
orionis.foundation.config.hashing.Bcrypt.rounds
orionis.foundation.config.hashing.Bcrypt.html#rounds
Attribute
Instance Variable
PUBLIC
Cost factor (base-2 logarithm of the iteration count).
-
orionis.foundation.config.hashing.Bcrypt.__post_init__
orionis.foundation.config.hashing.Bcrypt.html#__post_init__
Function
Method
PUBLIC
Validate the bcrypt cost factor after initialization.
-
orionis.foundation.config.hashing.entities.hashing._DRIVER_NAMES
orionis.foundation.config.hashing.entities.hashing.html#_DRIVER_NAMES
Attribute
Constant
PUBLIC
Define the supported hashing driver names.
-
orionis.foundation.config.hashing.Hashing
orionis.foundation.config.hashing.Hashing.html
Class
Class
PUBLIC
Represent the password hashing configuration for the application.
-
orionis.foundation.config.hashing.Hashing.driver
orionis.foundation.config.hashing.Hashing.html#driver
Attribute
Instance Variable
PUBLIC
Default hashing driver. Accepts a Drivers enum member or a plain string ('argon2' or 'bcrypt'). Resolved from the HASH_DRIVER environment variable or Drivers.ARGON2.value.
-
orionis.foundation.config.hashing.Hashing.argon2
orionis.foundation.config.hashing.Hashing.html#argon2
Attribute
Instance Variable
PUBLIC
Cost parameters applied by the Argon2id driver.
-
orionis.foundation.config.hashing.Hashing.bcrypt
orionis.foundation.config.hashing.Hashing.html#bcrypt
Attribute
Instance Variable
PUBLIC
Cost parameters applied by the bcrypt driver.
-
orionis.foundation.config.hashing.Hashing.__post_init__
orionis.foundation.config.hashing.Hashing.html#__post_init__
Function
Method
PUBLIC
Validate and normalize the hashing configuration after initialization.
-
orionis.foundation.config.hashing.Drivers
orionis.foundation.config.hashing.Drivers.html
Class
Class
PUBLIC
Enumerate supported password hashing drivers.
-
orionis.foundation.config.hashing.Drivers.ARGON2
orionis.foundation.config.hashing.Drivers.html#ARGON2
Attribute
Constant
PUBLIC
Represents the Argon2id password hashing driver.
-
orionis.foundation.config.hashing.Drivers.BCRYPT
orionis.foundation.config.hashing.Drivers.html#BCRYPT
Attribute
Constant
PUBLIC
Represents the bcrypt password hashing driver.
-
orionis.foundation.config.hashing._EXPORTS
orionis.foundation.config.hashing.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.foundation.config.hashing.__getattr__
orionis.foundation.config.hashing.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.foundation.config.hashing.__dir__
orionis.foundation.config.hashing.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.foundation.config.http.HTTPBodyLimits
orionis.foundation.config.http.HTTPBodyLimits.html
Class
Class
PUBLIC
Configure finite request, buffering, multipart and concurrency budgets.
-
orionis.foundation.config.http.HTTPBodyLimits.max_body_size
orionis.foundation.config.http.HTTPBodyLimits.html#max_body_size
Attribute
Instance Variable
PUBLIC
Maximum transport bytes consumed for one request, including framing. Defaults to 16 MiB from HTTP_MAX_BODY_SIZE.
-
orionis.foundation.config.http.HTTPBodyLimits.max_buffer_size
orionis.foundation.config.http.HTTPBodyLimits.html#max_buffer_size
Attribute
Instance Variable
PUBLIC
Maximum bytes materialized by body(), JSON and other buffered parsers. Defaults to 2 MiB from HTTP_MAX_BUFFER_SIZE.
-
orionis.foundation.config.http.HTTPBodyLimits.max_concurrent_requests
orionis.foundation.config.http.HTTPBodyLimits.html#max_concurrent_requests
Attribute
Instance Variable
PUBLIC
Maximum active HTTP requests per kernel, including response delivery. Defaults to 128 from HTTP_MAX_CONCURRENT_REQUESTS.
-
orionis.foundation.config.http.HTTPBodyLimits.max_files
orionis.foundation.config.http.HTTPBodyLimits.html#max_files
Attribute
Instance Variable
PUBLIC
Maximum multipart file count; zero rejects all files. Defaults to 32 from HTTP_MAX_FILES.
-
orionis.foundation.config.http.HTTPBodyLimits.max_fields
orionis.foundation.config.http.HTTPBodyLimits.html#max_fields
Attribute
Instance Variable
PUBLIC
Maximum multipart text field count; zero rejects all text fields. Defaults to 128 from HTTP_MAX_FIELDS.
-
orionis.foundation.config.http.HTTPBodyLimits.max_part_size
orionis.foundation.config.http.HTTPBodyLimits.html#max_part_size
Attribute
Instance Variable
PUBLIC
Maximum bytes of one multipart file or field. Defaults to 10 MiB from HTTP_MAX_PART_SIZE.
-
orionis.foundation.config.http.HTTPBodyLimits.max_field_size
orionis.foundation.config.http.HTTPBodyLimits.html#max_field_size
Attribute
Instance Variable
PUBLIC
Maximum bytes of one multipart text field before decoding. Defaults to 1 MiB from HTTP_MAX_FIELD_SIZE.
-
orionis.foundation.config.http.HTTPBodyLimits.max_header_size
orionis.foundation.config.http.HTTPBodyLimits.html#max_header_size
Attribute
Instance Variable
PUBLIC
Maximum MIME header bytes per multipart part. Defaults to 16 KiB from HTTP_MAX_PART_HEADER_SIZE.
-
orionis.foundation.config.http.HTTPBodyLimits.memory_threshold
orionis.foundation.config.http.HTTPBodyLimits.html#memory_threshold
Attribute
Instance Variable
PUBLIC
Maximum file payload bytes retained before spooling to disk. Defaults to 256 KiB from HTTP_UPLOAD_MEMORY_THRESHOLD.
-
orionis.foundation.config.http.HTTPBodyLimits.max_memory_size
orionis.foundation.config.http.HTTPBodyLimits.html#max_memory_size
Attribute
Instance Variable
PUBLIC
Budget for retained multipart field strings and in-memory file payloads. Transport buffers, object metadata and temporary copies are additional. Defaults to 8 MiB from HTTP_MAX_MULTIPART_MEMORY_SIZE.
-
orionis.foundation.config.http.HTTPBodyLimits.__post_init__
orionis.foundation.config.http.HTTPBodyLimits.html#__post_init__
Function
Method
PUBLIC
Validate finite byte budgets and nonnegative multipart counts.
-
orionis.foundation.config.http.entitites.cors._ALLOWED_HTTP_METHODS
orionis.foundation.config.http.entitites.cors.html#_ALLOWED_HTTP_METHODS
Attribute
Constant
PUBLIC
avoids recreating the set per __validateAllowMethods call.
-
orionis.foundation.config.http.Cors
orionis.foundation.config.http.Cors.html
Class
Class
PUBLIC
Represent a CORS configuration compatible with Starlette CORSMiddleware.
-
orionis.foundation.config.http.Cors.allow_origins
orionis.foundation.config.http.Cors.html#allow_origins
Attribute
Instance Variable
PUBLIC
List of allowed origins. Defaults to ["*"] to allow all origins.
-
orionis.foundation.config.http.Cors.allow_origin_regex
orionis.foundation.config.http.Cors.html#allow_origin_regex
Attribute
Instance Variable
PUBLIC
Regular expression to match allowed origins. Defaults to None.
-
orionis.foundation.config.http.Cors.allow_methods
orionis.foundation.config.http.Cors.html#allow_methods
Attribute
Instance Variable
PUBLIC
List of allowed HTTP methods. Defaults to ["*"] to allow all methods.
-
orionis.foundation.config.http.Cors.allow_credentials
orionis.foundation.config.http.Cors.html#allow_credentials
Attribute
Instance Variable
PUBLIC
Whether to allow credentials (cookies, authorization headers, etc.). Defaults to False.
-
orionis.foundation.config.http.Cors.max_age
orionis.foundation.config.http.Cors.html#max_age
Attribute
Instance Variable
PUBLIC
Maximum time (in seconds) for the preflight request to be cached. Defaults to 600.
-
orionis.foundation.config.http.Cors.__validateAllowMethods
orionis.foundation.config.http.Cors.html#__validateAllowMethods
Function
Method
PUBLIC
Validate that all items in 'allow_methods' are valid HTTP methods or a wildcard.
-
orionis.foundation.config.http.Cors.__post_init__
orionis.foundation.config.http.Cors.html#__post_init__
Function
Method
PUBLIC
Normalize allowlists, validate CORS options and own supplied mutable lists.
-
orionis.foundation.config.http.entitites.csrf._MIN_TOKEN_LENGTH
orionis.foundation.config.http.entitites.csrf.html#_MIN_TOKEN_LENGTH
Attribute
Constant
PUBLIC
Min token length value used by csrf.
-
orionis.foundation.config.http.HTTPCsrf
orionis.foundation.config.http.HTTPCsrf.html
Class
Class
PUBLIC
CSRF protection configuration for web routes.
-
orionis.foundation.config.http.HTTPCsrf.enabled
orionis.foundation.config.http.HTTPCsrf.html#enabled
Attribute
Instance Variable
PUBLIC
Enable or disable CSRF validation globally. Defaults to True.
-
orionis.foundation.config.http.HTTPCsrf.token_length
orionis.foundation.config.http.HTTPCsrf.html#token_length
Attribute
Instance Variable
PUBLIC
Number of random bytes used to generate the token via secrets.token_urlsafe. 32 bytes yields 256 bits of entropy (43 URL-safe characters). Defaults to 32.
-
orionis.foundation.config.http.HTTPCsrf.session_key
orionis.foundation.config.http.HTTPCsrf.html#session_key
Attribute
Instance Variable
PUBLIC
Session key under which the token is stored. Defaults to "_csrf_token".
-
orionis.foundation.config.http.HTTPCsrf.xsrf_cookie
orionis.foundation.config.http.HTTPCsrf.html#xsrf_cookie
Attribute
Instance Variable
PUBLIC
When True, set a readable XSRF-TOKEN cookie on every response so that JavaScript clients (Angular, Axios) can forward it as X-XSRF-Token. Defaults to False.
-
orionis.foundation.config.http.HTTPCsrf.cookie_name
orionis.foundation.config.http.HTTPCsrf.html#cookie_name
Attribute
Instance Variable
PUBLIC
Name of the XSRF cookie. Defaults to "XSRF-TOKEN".
-
orionis.foundation.config.http.HTTPCsrf.cookie_secure
orionis.foundation.config.http.HTTPCsrf.html#cookie_secure
Attribute
Instance Variable
PUBLIC
Set the Secure attribute on the XSRF cookie. When False, the middleware automatically promotes the flag to True on HTTPS requests. Defaults to False.
-
orionis.foundation.config.http.HTTPCsrf.cookie_same_site
orionis.foundation.config.http.HTTPCsrf.html#cookie_same_site
Attribute
Instance Variable
PUBLIC
SameSite attribute for the XSRF cookie. Defaults to "lax".
-
orionis.foundation.config.http.HTTPCsrf.cookie_path
orionis.foundation.config.http.HTTPCsrf.html#cookie_path
Attribute
Instance Variable
PUBLIC
Path attribute for the XSRF cookie. Defaults to "/".
-
orionis.foundation.config.http.HTTPCsrf.cookie_domain
orionis.foundation.config.http.HTTPCsrf.html#cookie_domain
Attribute
Instance Variable
PUBLIC
Domain attribute for the XSRF cookie. None omits it. Defaults to None.
-
orionis.foundation.config.http.HTTPCsrf.__post_init__
orionis.foundation.config.http.HTTPCsrf.html#__post_init__
Function
Method
PUBLIC
Validate all CSRF configuration fields after dataclass construction.
-
orionis.foundation.config.http.HTTPCsrf.__validateEnabled
orionis.foundation.config.http.HTTPCsrf.html#__validateEnabled
Function
Method
PUBLIC
Validate that enabled is a boolean.
-
orionis.foundation.config.http.HTTPCsrf.__validateTokenLength
orionis.foundation.config.http.HTTPCsrf.html#__validateTokenLength
Function
Method
PUBLIC
Validate that token_length is a plain integer >= 32.
-
orionis.foundation.config.http.HTTPCsrf.__validateSessionKey
orionis.foundation.config.http.HTTPCsrf.html#__validateSessionKey
Function
Method
PUBLIC
Validate that session_key is a non-empty string.
-
orionis.foundation.config.http.HTTPCsrf.__validateXsrfCookie
orionis.foundation.config.http.HTTPCsrf.html#__validateXsrfCookie
Function
Method
PUBLIC
Validate that xsrf_cookie is a boolean.
-
orionis.foundation.config.http.HTTPCsrf.__validateCookieName
orionis.foundation.config.http.HTTPCsrf.html#__validateCookieName
Function
Method
PUBLIC
Validate that cookie_name is acceptable by the response cookie serializer.
-
orionis.foundation.config.http.HTTPCsrf.__validateCookieSameSite
orionis.foundation.config.http.HTTPCsrf.html#__validateCookieSameSite
Function
Method
PUBLIC
Validate that cookie_same_site is a recognised SameSite value.
-
orionis.foundation.config.http.HTTPCsrf.__validateCookiePath
orionis.foundation.config.http.HTTPCsrf.html#__validateCookiePath
Function
Method
PUBLIC
Validate that cookie_path is a string.
-
orionis.foundation.config.http.HTTPCsrf.__validateCookieDomain
orionis.foundation.config.http.HTTPCsrf.html#__validateCookieDomain
Function
Method
PUBLIC
Validate that cookie_domain is a string or None.
-
orionis.foundation.config.http.HTTP
orionis.foundation.config.http.HTTP.html
Class
Class
PUBLIC
Configure HTTP request handling and security.
-
orionis.foundation.config.http.HTTP.monitor_disconnects
orionis.foundation.config.http.HTTP.html#monitor_disconnects
Attribute
Instance Variable
PUBLIC
Cancel handlers proactively when a client disconnects. Defaults to False, executing handlers in the server task with direct body reads. External server cancellation still propagates in both modes. The application snapshots this setting during create().
-
orionis.foundation.config.http.HTTP.body_limits
orionis.foundation.config.http.HTTP.html#body_limits
Attribute
Class Variable
PUBLIC
Body limits produced by field.
-
orionis.foundation.config.http.HTTP.websocket
orionis.foundation.config.http.HTTP.html#websocket
Attribute
Class Variable
PUBLIC
Websocket produced by field.
-
orionis.foundation.config.http.HTTP.proxies
orionis.foundation.config.http.HTTP.html#proxies
Attribute
Class Variable
PUBLIC
Proxies produced by field.
-
orionis.foundation.config.http.HTTP.security
orionis.foundation.config.http.HTTP.html#security
Attribute
Class Variable
PUBLIC
Security produced by field.
-
orionis.foundation.config.http.HTTP.rate_limit
orionis.foundation.config.http.HTTP.html#rate_limit
Attribute
Class Variable
PUBLIC
Rate limit produced by field.
-
orionis.foundation.config.http.HTTP.cors
orionis.foundation.config.http.HTTP.html#cors
Attribute
Class Variable
PUBLIC
Cors produced by field.
-
orionis.foundation.config.http.HTTP.csrf
orionis.foundation.config.http.HTTP.html#csrf
Attribute
Class Variable
PUBLIC
Csrf produced by field.
-
orionis.foundation.config.http.HTTP.__post_init__
orionis.foundation.config.http.HTTP.html#__post_init__
Function
Method
PUBLIC
Validate and coerce all composite fields.
-
orionis.foundation.config.http.HTTP.__validateProxies
orionis.foundation.config.http.HTTP.html#__validateProxies
Function
Method
PUBLIC
Validate the proxies field.
-
orionis.foundation.config.http.HTTP.__validateSecurity
orionis.foundation.config.http.HTTP.html#__validateSecurity
Function
Method
PUBLIC
Validate the security field.
-
orionis.foundation.config.http.HTTP.__validateRateLimit
orionis.foundation.config.http.HTTP.html#__validateRateLimit
Function
Method
PUBLIC
Validate the rate_limit field.
-
orionis.foundation.config.http.HTTP.__validateCors
orionis.foundation.config.http.HTTP.html#__validateCors
Function
Method
PUBLIC
Validate the cors field.
-
orionis.foundation.config.http.HTTP.__validateCsrf
orionis.foundation.config.http.HTTP.html#__validateCsrf
Function
Method
PUBLIC
Validate the csrf field.
-
orionis.foundation.config.http.HTTPProxies
orionis.foundation.config.http.HTTPProxies.html
Class
Class
PUBLIC
Represent the configuration for trusted HTTP proxies.
-
orionis.foundation.config.http.HTTPProxies.trusted_proxies
orionis.foundation.config.http.HTTPProxies.html#trusted_proxies
Attribute
Instance Variable
PUBLIC
List of trusted proxy IP addresses or CIDR ranges.
-
orionis.foundation.config.http.HTTPProxies.__post_init__
orionis.foundation.config.http.HTTPProxies.html#__post_init__
Function
Method
PUBLIC
Validate proxy fields.
-
orionis.foundation.config.http.HTTPProxies.__validateTrustedProxies
orionis.foundation.config.http.HTTPProxies.html#__validateTrustedProxies
Function
Method
PUBLIC
Validate the trusted_proxies field.
-
orionis.foundation.config.http.HTTPRateLimit
orionis.foundation.config.http.HTTPRateLimit.html
Class
Class
PUBLIC
Represent the rate-limiting configuration for HTTP.
-
orionis.foundation.config.http.HTTPRateLimit.rate_limit_enabled
orionis.foundation.config.http.HTTPRateLimit.html#rate_limit_enabled
Attribute
Instance Variable
PUBLIC
Whether global rate limiting is enabled.
-
orionis.foundation.config.http.HTTPRateLimit.rate_limit_requests
orionis.foundation.config.http.HTTPRateLimit.html#rate_limit_requests
Attribute
Instance Variable
PUBLIC
Maximum number of requests allowed per window.
-
orionis.foundation.config.http.HTTPRateLimit.rate_limit_window_seconds
orionis.foundation.config.http.HTTPRateLimit.html#rate_limit_window_seconds
Attribute
Instance Variable
PUBLIC
Time window in seconds for rate limit counting.
-
orionis.foundation.config.http.HTTPRateLimit.rate_limit_store
orionis.foundation.config.http.HTTPRateLimit.html#rate_limit_store
Attribute
Instance Variable
PUBLIC
memory for one process or redis for shared worker quotas.
-
orionis.foundation.config.http.HTTPRateLimit.rate_limit_max_keys
orionis.foundation.config.http.HTTPRateLimit.html#rate_limit_max_keys
Attribute
Instance Variable
PUBLIC
Maximum retained clients in the memory store.
-
orionis.foundation.config.http.HTTPRateLimit.rate_limit_max_events
orionis.foundation.config.http.HTTPRateLimit.html#rate_limit_max_events
Attribute
Instance Variable
PUBLIC
Maximum retained accepted timestamps in the memory store.
-
orionis.foundation.config.http.HTTPRateLimit.rate_limit_redis
orionis.foundation.config.http.HTTPRateLimit.html#rate_limit_redis
Attribute
Instance Variable
PUBLIC
Redis connection settings, used only by the Redis store.
-
orionis.foundation.config.http.HTTPRateLimit.rate_limit_redis_prefix
orionis.foundation.config.http.HTTPRateLimit.html#rate_limit_redis_prefix
Attribute
Instance Variable
PUBLIC
Application namespace for Redis quota keys.
-
orionis.foundation.config.http.HTTPRateLimit.rate_limit_redis_timeout_seconds
orionis.foundation.config.http.HTTPRateLimit.html#rate_limit_redis_timeout_seconds
Attribute
Instance Variable
PUBLIC
Bound Redis connect and socket operations in seconds.
-
orionis.foundation.config.http.HTTPRateLimit.__post_init__
orionis.foundation.config.http.HTTPRateLimit.html#__post_init__
Function
Method
PUBLIC
Validate rate-limiting fields.
-
orionis.foundation.config.http.HTTPRateLimit.__validateStore
orionis.foundation.config.http.HTTPRateLimit.html#__validateStore
Function
Method
PUBLIC
Validate backend selection, bounded capacity and Redis transport.
-
orionis.foundation.config.http.HTTPRateLimit.__validateRateLimiting
orionis.foundation.config.http.HTTPRateLimit.html#__validateRateLimiting
Function
Method
PUBLIC
Validate rate-limiting constraints.
-
orionis.foundation.config.http.Redis
orionis.foundation.config.http.Redis.html
Class
Class
PUBLIC
Configure the Redis connection used by HTTP rate limiting.
-
orionis.foundation.config.http.Redis.endpoint
orionis.foundation.config.http.Redis.html#endpoint
Attribute
Instance Variable
PUBLIC
Redis host address, read from REDIS_HOST.
-
orionis.foundation.config.http.Redis.port
orionis.foundation.config.http.Redis.html#port
Attribute
Instance Variable
PUBLIC
Redis TCP port, read from REDIS_PORT.
-
orionis.foundation.config.http.Redis.db
orionis.foundation.config.http.Redis.html#db
Attribute
Instance Variable
PUBLIC
Redis database index, read from REDIS_DB.
-
orionis.foundation.config.http.Redis.password
orionis.foundation.config.http.Redis.html#password
Attribute
Instance Variable
PUBLIC
Optional Redis password, read from REDIS_PASSWORD.
-
orionis.foundation.config.http.Redis.__post_init__
orionis.foundation.config.http.Redis.html#__post_init__
Function
Method
PUBLIC
Validate connection fields without creating a Redis client.
-
orionis.foundation.config.http.HTTPSecurity
orionis.foundation.config.http.HTTPSecurity.html
Class
Class
PUBLIC
Represent the security-related configuration for HTTP.
-
orionis.foundation.config.http.HTTPSecurity.allowed_hosts
orionis.foundation.config.http.HTTPSecurity.html#allowed_hosts
Attribute
Instance Variable
PUBLIC
List of allowed host names or '*' to allow all hosts.
-
orionis.foundation.config.http.HTTPSecurity.__post_init__
orionis.foundation.config.http.HTTPSecurity.html#__post_init__
Function
Method
PUBLIC
Validate security-related fields.
-
orionis.foundation.config.http.HTTPSecurity.__validateAllowedHosts
orionis.foundation.config.http.HTTPSecurity.html#__validateAllowedHosts
Function
Method
PUBLIC
Validate the allowed_hosts field.
-
orionis.foundation.config.http.HTTPSecurity.__isLocalHost
orionis.foundation.config.http.HTTPSecurity.html#__isLocalHost
Function
Method
PUBLIC
Return whether the host is local-only.
-
orionis.foundation.config.http.HTTPSecurity.__addHostToAllowedHosts
orionis.foundation.config.http.HTTPSecurity.html#__addHostToAllowedHosts
Function
Method
PUBLIC
Add a host to the list if it is missing.
-
orionis.foundation.config.http.HTTPWebSocket
orionis.foundation.config.http.HTTPWebSocket.html
Class
Class
PUBLIC
Configure connection admission, inbound messages and browser origins.
-
orionis.foundation.config.http.HTTPWebSocket.max_connections
orionis.foundation.config.http.HTTPWebSocket.html#max_connections
Attribute
Instance Variable
PUBLIC
Maximum active connections per kernel. Defaults to 128 from WEBSOCKET_MAX_CONNECTIONS.
-
orionis.foundation.config.http.HTTPWebSocket.max_message_size
orionis.foundation.config.http.HTTPWebSocket.html#max_message_size
Attribute
Instance Variable
PUBLIC
Maximum complete inbound message bytes. Defaults to 1 MiB from WEBSOCKET_MAX_MESSAGE_SIZE.
-
orionis.foundation.config.http.HTTPWebSocket.allow_origins
orionis.foundation.config.http.HTTPWebSocket.html#allow_origins
Attribute
Instance Variable
PUBLIC
Additional allowed browser origins. Empty allows the same origin only. The wildcard "*" explicitly allows every origin. Defaults to an empty tuple from the shared CORS_ALLOW_ORIGINS environment variable.
-
orionis.foundation.config.http.HTTPWebSocket.__post_init__
orionis.foundation.config.http.HTTPWebSocket.html#__post_init__
Function
Method
PUBLIC
Validate limits and copy the configured origin collection.
-
orionis.foundation.config.http._EXPORTS
orionis.foundation.config.http.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.foundation.config.http.__getattr__
orionis.foundation.config.http.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.foundation.config.http.__dir__
orionis.foundation.config.http.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.foundation.config.logging.validators.level._IsValidLevel
orionis.foundation.config.logging.validators.level._IsValidLevel.html
Class
Class
PUBLIC
Validate if a value is a valid logging level.
-
orionis.foundation.config.logging.validators.level._IsValidLevel._level_names
orionis.foundation.config.logging.validators.level._IsValidLevel.html#_level_names
Attribute
Instance Variable
PUBLIC
Valid logging level names.
-
orionis.foundation.config.logging.validators.level._IsValidLevel._level_values
orionis.foundation.config.logging.validators.level._IsValidLevel.html#_level_values
Attribute
Instance Variable
PUBLIC
Valid logging level integer values.
-
orionis.foundation.config.logging.validators.level._IsValidLevel.__slots__
orionis.foundation.config.logging.validators.level._IsValidLevel.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.foundation.config.logging.validators.level._IsValidLevel.normalize
orionis.foundation.config.logging.validators.level._IsValidLevel.html#normalize
Function
Method
PUBLIC
Normalize a logging level to its integer representation.
-
orionis.foundation.config.logging.validators.level._IsValidLevel.__call__
orionis.foundation.config.logging.validators.level._IsValidLevel.html#__call__
Function
Method
PUBLIC
Validate a logging level without returning its normalized value.
-
orionis.foundation.config.logging.validators.IsValidLevel
orionis.foundation.config.logging.validators.html#IsValidLevel
Attribute
Variable
PUBLIC
Exported singleton instance.
-
orionis.foundation.config.logging.validators.path.__IsValidPath
orionis.foundation.config.logging.validators.path.__IsValidPath.html
Class
Class
PUBLIC
Validate logging paths without storing per-call state.
-
orionis.foundation.config.logging.validators.path.__IsValidPath.__slots__
orionis.foundation.config.logging.validators.path.__IsValidPath.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.foundation.config.logging.validators.path.__IsValidPath.__call__
orionis.foundation.config.logging.validators.path.__IsValidPath.html#__call__
Function
Method
PUBLIC
Validate that the value is a non-empty string representing a file path.
-
orionis.foundation.config.logging.validators.IsValidPath
orionis.foundation.config.logging.validators.html#IsValidPath
Attribute
Variable
PUBLIC
Exported singleton instance.
-
orionis.foundation.config.logging.entities.chunked._DEFAULT_PATH
orionis.foundation.config.logging.entities.chunked.html#_DEFAULT_PATH
Attribute
Constant
PUBLIC
storage/logs/chunked_{suffix}.log.
-
orionis.foundation.config.logging.entities.daily._DEFAULT_PATH
orionis.foundation.config.logging.entities.daily.html#_DEFAULT_PATH
Attribute
Constant
PUBLIC
storage/logs/daily_{suffix}.log.
-
orionis.foundation.config.logging.entities.hourly._DEFAULT_PATH
orionis.foundation.config.logging.entities.hourly.html#_DEFAULT_PATH
Attribute
Constant
PUBLIC
storage/logs/hourly_{suffix}.log.
-
orionis.foundation.config.logging.entities.monthly._DEFAULT_PATH
orionis.foundation.config.logging.entities.monthly.html#_DEFAULT_PATH
Attribute
Constant
PUBLIC
storage/logs/monthly_{suffix}.log.
-
orionis.foundation.config.logging.entities.stack._DEFAULT_PATH
orionis.foundation.config.logging.entities.stack.html#_DEFAULT_PATH
Attribute
Constant
PUBLIC
storage/logs/stack.log.
-
orionis.foundation.config.logging.entities.weekly._DEFAULT_PATH
orionis.foundation.config.logging.entities.weekly.html#_DEFAULT_PATH
Attribute
Constant
PUBLIC
storage/logs/weekly_{suffix}.log.
-
orionis.foundation.config.logging.entities.channels._CHANNEL_ENTITIES
orionis.foundation.config.logging.entities.channels.html#_CHANNEL_ENTITIES
Attribute
Constant
PUBLIC
Channel entities definitions used by channels.
-
orionis.foundation.config.logging.Channels
orionis.foundation.config.logging.Channels.html
Class
Class
PUBLIC
Represent the available logging channels and their configurations.
-
orionis.foundation.config.logging.Channels.stack
orionis.foundation.config.logging.Channels.html#stack
Attribute
Instance Variable
PUBLIC
Configuration for stack log channel.
-
orionis.foundation.config.logging.Channels.hourly
orionis.foundation.config.logging.Channels.html#hourly
Attribute
Instance Variable
PUBLIC
Configuration for hourly log rotation.
-
orionis.foundation.config.logging.Channels.daily
orionis.foundation.config.logging.Channels.html#daily
Attribute
Instance Variable
PUBLIC
Configuration for daily log rotation.
-
orionis.foundation.config.logging.Channels.weekly
orionis.foundation.config.logging.Channels.html#weekly
Attribute
Instance Variable
PUBLIC
Configuration for weekly log rotation.
-
orionis.foundation.config.logging.Channels.monthly
orionis.foundation.config.logging.Channels.html#monthly
Attribute
Instance Variable
PUBLIC
Configuration for monthly log rotation.
-
orionis.foundation.config.logging.Channels.chunked
orionis.foundation.config.logging.Channels.html#chunked
Attribute
Instance Variable
PUBLIC
Configuration for chunked log file storage.
-
orionis.foundation.config.logging.Channels.__post_init__
orionis.foundation.config.logging.Channels.html#__post_init__
Function
Method
PUBLIC
Validate and construct every configured logging channel.
-
orionis.foundation.config.logging.Chunked
orionis.foundation.config.logging.Chunked.html
Class
Class
PUBLIC
Configure chunked log file rotation.
-
orionis.foundation.config.logging.Chunked.path
orionis.foundation.config.logging.Chunked.html#path
Attribute
Instance Variable
PUBLIC
Filesystem path where chunked log files are stored.
-
orionis.foundation.config.logging.Chunked.level
orionis.foundation.config.logging.Chunked.html#level
Attribute
Instance Variable
PUBLIC
Logging level for the log file. Accepts an integer, string, or Level enum.
-
orionis.foundation.config.logging.Chunked.mb_size
orionis.foundation.config.logging.Chunked.html#mb_size
Attribute
Instance Variable
PUBLIC
Maximum size (in megabytes) of a single log file before a new chunk is created.
-
orionis.foundation.config.logging.Chunked.files
orionis.foundation.config.logging.Chunked.html#files
Attribute
Instance Variable
PUBLIC
Maximum number of log files to retain. Older files are deleted when this limit is exceeded.
-
orionis.foundation.config.logging.Chunked.__post_init__
orionis.foundation.config.logging.Chunked.html#__post_init__
Function
Method
PUBLIC
Validate and normalize configuration fields after initialization.
-
orionis.foundation.config.logging.Daily
orionis.foundation.config.logging.Daily.html
Class
Class
PUBLIC
Represent the configuration for daily log file rotation.
-
orionis.foundation.config.logging.Daily.path
orionis.foundation.config.logging.Daily.html#path
Attribute
Instance Variable
PUBLIC
The file path where the log is stored.
-
orionis.foundation.config.logging.Daily.level
orionis.foundation.config.logging.Daily.html#level
Attribute
Instance Variable
PUBLIC
The logging level (e.g., 'info', 'error', 'debug').
-
orionis.foundation.config.logging.Daily.retention_days
orionis.foundation.config.logging.Daily.html#retention_days
Attribute
Instance Variable
PUBLIC
The number of days to retain log files before deletion.
-
orionis.foundation.config.logging.Daily.at
orionis.foundation.config.logging.Daily.html#at
Attribute
Instance Variable
PUBLIC
The time of day when the log rotation should occur.
-
orionis.foundation.config.logging.Daily.__post_init__
orionis.foundation.config.logging.Daily.html#__post_init__
Function
Method
PUBLIC
Validate and normalize attributes after dataclass initialization.
-
orionis.foundation.config.logging.Hourly
orionis.foundation.config.logging.Hourly.html
Class
Class
PUBLIC
Represent the configuration for hourly log file management.
-
orionis.foundation.config.logging.Hourly.path
orionis.foundation.config.logging.Hourly.html#path
Attribute
Instance Variable
PUBLIC
The file path where the log is stored.
-
orionis.foundation.config.logging.Hourly.level
orionis.foundation.config.logging.Hourly.html#level
Attribute
Instance Variable
PUBLIC
The logging level (e.g., 'info', 'error', 'debug').
-
orionis.foundation.config.logging.Hourly.retention_hours
orionis.foundation.config.logging.Hourly.html#retention_hours
Attribute
Instance Variable
PUBLIC
The number of hours to retain log files before deletion.
-
orionis.foundation.config.logging.Hourly.__post_init__
orionis.foundation.config.logging.Hourly.html#__post_init__
Function
Method
PUBLIC
Validate attributes after dataclass initialization.
-
orionis.foundation.config.logging.entities.logging._CHANNEL_OPTIONS
orionis.foundation.config.logging.entities.logging.html#_CHANNEL_OPTIONS
Attribute
Constant
PUBLIC
Pre-computed channel option names.
-
orionis.foundation.config.logging.Logging
orionis.foundation.config.logging.Logging.html
Class
Class
PUBLIC
Represent the logging system configuration.
-
orionis.foundation.config.logging.Logging.default
orionis.foundation.config.logging.Logging.html#default
Attribute
Instance Variable
PUBLIC
The default logging channel to use.
-
orionis.foundation.config.logging.Logging.channels
orionis.foundation.config.logging.Logging.html#channels
Attribute
Instance Variable
PUBLIC
A collection of available logging channels.
-
orionis.foundation.config.logging.Logging.queue_capacity
orionis.foundation.config.logging.Logging.html#queue_capacity
Attribute
Instance Variable
PUBLIC
Pending records per handler; zero retains synchronous emission.
-
orionis.foundation.config.logging.Logging.__post_init__
orionis.foundation.config.logging.Logging.html#__post_init__
Function
Method
PUBLIC
Validate the logging configuration after dataclass initialization.
-
orionis.foundation.config.logging.Monthly
orionis.foundation.config.logging.Monthly.html
Class
Class
PUBLIC
Represent the configuration for monthly log file management.
-
orionis.foundation.config.logging.Monthly.path
orionis.foundation.config.logging.Monthly.html#path
Attribute
Instance Variable
PUBLIC
The file path where the log is stored.
-
orionis.foundation.config.logging.Monthly.level
orionis.foundation.config.logging.Monthly.html#level
Attribute
Instance Variable
PUBLIC
The logging level (e.g., 'info', 'error', 'debug').
-
orionis.foundation.config.logging.Monthly.retention_months
orionis.foundation.config.logging.Monthly.html#retention_months
Attribute
Instance Variable
PUBLIC
The number of months to retain log files before deletion.
-
orionis.foundation.config.logging.Monthly.__post_init__
orionis.foundation.config.logging.Monthly.html#__post_init__
Function
Method
PUBLIC
Validate and normalize attributes after dataclass initialization.
-
orionis.foundation.config.logging.Stack
orionis.foundation.config.logging.Stack.html
Class
Class
PUBLIC
Represent the configuration for a logging stack.
-
orionis.foundation.config.logging.Stack.path
orionis.foundation.config.logging.Stack.html#path
Attribute
Instance Variable
PUBLIC
The file path where the log is stored.
-
orionis.foundation.config.logging.Stack.level
orionis.foundation.config.logging.Stack.html#level
Attribute
Instance Variable
PUBLIC
The logging level.
-
orionis.foundation.config.logging.Stack.__post_init__
orionis.foundation.config.logging.Stack.html#__post_init__
Function
Method
PUBLIC
Validate the log path and normalize the configured level.
-
orionis.foundation.config.logging.Weekly
orionis.foundation.config.logging.Weekly.html
Class
Class
PUBLIC
Represent the configuration for weekly log file management.
-
orionis.foundation.config.logging.Weekly.path
orionis.foundation.config.logging.Weekly.html#path
Attribute
Instance Variable
PUBLIC
The file path where the log is stored.
-
orionis.foundation.config.logging.Weekly.level
orionis.foundation.config.logging.Weekly.html#level
Attribute
Instance Variable
PUBLIC
The logging level (e.g., 'info', 'error', 'debug').
-
orionis.foundation.config.logging.Weekly.retention_weeks
orionis.foundation.config.logging.Weekly.html#retention_weeks
Attribute
Instance Variable
PUBLIC
The number of weeks to retain log files before deletion.
-
orionis.foundation.config.logging.Weekly.__post_init__
orionis.foundation.config.logging.Weekly.html#__post_init__
Function
Method
PUBLIC
Validate and normalize the Weekly configuration after initialization.
-
orionis.foundation.config.logging.Level
orionis.foundation.config.logging.Level.html
Class
Class
PUBLIC
Enumerate standard logging levels.
-
orionis.foundation.config.logging.Level.DEBUG
orionis.foundation.config.logging.Level.html#DEBUG
Attribute
Constant
PUBLIC
Detailed information, typically of interest only when diagnosing problems. Value is 10.
-
orionis.foundation.config.logging.Level.INFO
orionis.foundation.config.logging.Level.html#INFO
Attribute
Constant
PUBLIC
Confirmation that things are working as expected. Value is 20.
-
orionis.foundation.config.logging.Level.WARNING
orionis.foundation.config.logging.Level.html#WARNING
Attribute
Constant
PUBLIC
An indication that something unexpected happened, or indicative of some problem in the near future. Value is 30.
-
orionis.foundation.config.logging.Level.ERROR
orionis.foundation.config.logging.Level.html#ERROR
Attribute
Constant
PUBLIC
Due to a more serious problem, the software has not been able to perform some function. Value is 40.
-
orionis.foundation.config.logging.Level.CRITICAL
orionis.foundation.config.logging.Level.html#CRITICAL
Attribute
Constant
PUBLIC
A very serious error, indicating that the program itself may be unable to continue running. Value is 50.
-
orionis.foundation.config.logging._EXPORTS
orionis.foundation.config.logging.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.foundation.config.logging.__getattr__
orionis.foundation.config.logging.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.foundation.config.logging.__dir__
orionis.foundation.config.logging.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.foundation.config.mail.File
orionis.foundation.config.mail.File.html
Class
Class
PUBLIC
Represent a file configuration entity for storing outgoing emails.
-
orionis.foundation.config.mail.File.path
orionis.foundation.config.mail.File.html#path
Attribute
Instance Variable
PUBLIC
The file path where outgoing emails are stored.
-
orionis.foundation.config.mail.File.__post_init__
orionis.foundation.config.mail.File.html#__post_init__
Function
Method
PUBLIC
Validate the 'path' attribute after initialization.
-
orionis.foundation.config.mail.FromAddress
orionis.foundation.config.mail.FromAddress.html
Class
Class
PUBLIC
Represent the global sender applied to messages that declare no From.
-
orionis.foundation.config.mail.FromAddress.address
orionis.foundation.config.mail.FromAddress.html#address
Attribute
Instance Variable
PUBLIC
Default sender mailbox, or an empty string to require an explicit one.
-
orionis.foundation.config.mail.FromAddress.name
orionis.foundation.config.mail.FromAddress.html#name
Attribute
Instance Variable
PUBLIC
Optional display name attached to the default mailbox.
-
orionis.foundation.config.mail.FromAddress.__post_init__
orionis.foundation.config.mail.FromAddress.html#__post_init__
Function
Method
PUBLIC
Validate the structural types without parsing the mailbox.
-
orionis.foundation.config.mail.Mail
orionis.foundation.config.mail.Mail.html
Class
Class
PUBLIC
Represent the mail configuration entity.
-
orionis.foundation.config.mail.Mail.default
orionis.foundation.config.mail.Mail.html#default
Attribute
Instance Variable
PUBLIC
The default configured mailer name or its transport driver.
-
orionis.foundation.config.mail.Mail.from_address
orionis.foundation.config.mail.Mail.html#from_address
Attribute
Instance Variable
PUBLIC
Global sender applied to every message that declares no From header.
-
orionis.foundation.config.mail.Mail.mailers
orionis.foundation.config.mail.Mail.html#mailers
Attribute
Instance Variable
PUBLIC
Conventional entities or arbitrary mailer names mapped to their settings.
-
orionis.foundation.config.mail.Mail.__post_init__
orionis.foundation.config.mail.Mail.html#__post_init__
Function
Method
PUBLIC
Validate the default mailer and isolate nested configuration mappings.
-
orionis.foundation.config.mail.Mail.__validateMailers
orionis.foundation.config.mail.Mail.html#__validateMailers
Function
Method
PUBLIC
Validate and copy named mailer settings without converting their shape.
-
orionis.foundation.config.mail.Mailers
orionis.foundation.config.mail.Mailers.html
Class
Class
PUBLIC
Represent mail transport configurations for the application.
-
orionis.foundation.config.mail.Mailers.smtp
orionis.foundation.config.mail.Mailers.html#smtp
Attribute
Instance Variable
PUBLIC
The SMTP configuration used for sending emails.
-
orionis.foundation.config.mail.Mailers.file
orionis.foundation.config.mail.Mailers.html#file
Attribute
Instance Variable
PUBLIC
The file-based mail transport configuration.
-
orionis.foundation.config.mail.Mailers.__post_init__
orionis.foundation.config.mail.Mailers.html#__post_init__
Function
Method
PUBLIC
Validate attribute types after initialization.
-
orionis.foundation.config.mail.Smtp
orionis.foundation.config.mail.Smtp.html
Class
Class
PUBLIC
Represent SMTP configuration settings.
-
orionis.foundation.config.mail.Smtp.driver
orionis.foundation.config.mail.Smtp.html#driver
Attribute
Instance Variable
PUBLIC
The driver type for the mail transport. Default is "smtp".
-
orionis.foundation.config.mail.Smtp.url
orionis.foundation.config.mail.Smtp.html#url
Attribute
Instance Variable
PUBLIC
Full URL for the SMTP service. Default is from 'MAIL_URL'.
-
orionis.foundation.config.mail.Smtp.host
orionis.foundation.config.mail.Smtp.html#host
Attribute
Instance Variable
PUBLIC
Hostname of the SMTP server. Default is from 'MAIL_HOST'.
-
orionis.foundation.config.mail.Smtp.port
orionis.foundation.config.mail.Smtp.html#port
Attribute
Instance Variable
PUBLIC
Port number for SMTP communication. Default is from 'MAIL_PORT' or 587.
-
orionis.foundation.config.mail.Smtp.encryption
orionis.foundation.config.mail.Smtp.html#encryption
Attribute
Instance Variable
PUBLIC
Encryption type for secure communication. Default is from 'MAIL_ENCRYPTION' or 'TLS'.
-
orionis.foundation.config.mail.Smtp.username
orionis.foundation.config.mail.Smtp.html#username
Attribute
Instance Variable
PUBLIC
Username for SMTP authentication. Default is from 'MAIL_USERNAME'.
-
orionis.foundation.config.mail.Smtp.password
orionis.foundation.config.mail.Smtp.html#password
Attribute
Instance Variable
PUBLIC
Password for SMTP authentication. Default is from 'MAIL_PASSWORD'.
-
orionis.foundation.config.mail.Smtp.timeout
orionis.foundation.config.mail.Smtp.html#timeout
Attribute
Instance Variable
PUBLIC
Connection timeout in seconds. Default is None.
-
orionis.foundation.config.mail.Smtp.__post_init__
orionis.foundation.config.mail.Smtp.html#__post_init__
Function
Method
PUBLIC
Validate the structural types of the SMTP settings.
-
orionis.foundation.config.mail.MailDriver
orionis.foundation.config.mail.MailDriver.html
Class
Class
PUBLIC
Enumeration of supported mail drivers.
-
orionis.foundation.config.mail.MailDriver.SMTP
orionis.foundation.config.mail.MailDriver.html#SMTP
Attribute
Constant
PUBLIC
Simple Mail Transfer Protocol driver.
-
orionis.foundation.config.mail.MailDriver.FILE
orionis.foundation.config.mail.MailDriver.html#FILE
Attribute
Constant
PUBLIC
File-based driver.
-
orionis.foundation.config.mail._EXPORTS
orionis.foundation.config.mail.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.foundation.config.mail.__getattr__
orionis.foundation.config.mail.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.foundation.config.mail.__dir__
orionis.foundation.config.mail.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.foundation.config.queue.entities.redis._MAX_PORT
orionis.foundation.config.queue.entities.redis.html#_MAX_PORT
Attribute
Constant
PUBLIC
Max port value used by redis.
-
orionis.foundation.config.queue.entities.connections._CONNECTION_ENTITIES
orionis.foundation.config.queue.entities.connections.html#_CONNECTION_ENTITIES
Attribute
Constant
PUBLIC
Connection entities definitions used by connections.
-
orionis.foundation.config.queue.Connections
orionis.foundation.config.queue.Connections.html
Class
Class
PUBLIC
Group the conventional validated queue connections.
-
orionis.foundation.config.queue.Connections.sync
orionis.foundation.config.queue.Connections.html#sync
Attribute
Instance Variable
PUBLIC
Synchronous connection settings.
-
orionis.foundation.config.queue.Connections.database
orionis.foundation.config.queue.Connections.html#database
Attribute
Instance Variable
PUBLIC
Durable database connection settings.
-
orionis.foundation.config.queue.Connections.redis
orionis.foundation.config.queue.Connections.html#redis
Attribute
Instance Variable
PUBLIC
Durable Redis connection settings.
-
orionis.foundation.config.queue.Connections.__post_init__
orionis.foundation.config.queue.Connections.html#__post_init__
Function
Method
PUBLIC
Convert connection mappings into strictly validated entities.
-
orionis.foundation.config.queue.Database
orionis.foundation.config.queue.Database.html
Class
Class
PUBLIC
Configure a durable database queue connection.
-
orionis.foundation.config.queue.Database.driver
orionis.foundation.config.queue.Database.html#driver
Attribute
Instance Variable
PUBLIC
Database driver identifier.
-
orionis.foundation.config.queue.Database.connection
orionis.foundation.config.queue.Database.html#connection
Attribute
Instance Variable
PUBLIC
Framework database connection, or its default when omitted.
-
orionis.foundation.config.queue.Database.table
orionis.foundation.config.queue.Database.html#table
Attribute
Instance Variable
PUBLIC
Unqualified SQL table used to persist jobs.
-
orionis.foundation.config.queue.Database.queue
orionis.foundation.config.queue.Database.html#queue
Attribute
Instance Variable
PUBLIC
Default logical queue name read from QUEUE_DB_QUEUE.
-
orionis.foundation.config.queue.Database.retry_after
orionis.foundation.config.queue.Database.html#retry_after
Attribute
Instance Variable
PUBLIC
Reservation duration read from QUEUE_DB_RETRY_AFTER in seconds.
-
orionis.foundation.config.queue.Database.__post_init__
orionis.foundation.config.queue.Database.html#__post_init__
Function
Method
PUBLIC
Validate the driver, database identifiers, and reservation duration.
-
orionis.foundation.config.queue.Failed
orionis.foundation.config.queue.Failed.html
Class
Class
PUBLIC
Configure database storage for failed jobs.
-
orionis.foundation.config.queue.Failed.connection
orionis.foundation.config.queue.Failed.html#connection
Attribute
Instance Variable
PUBLIC
Framework database connection, or its default when omitted.
-
orionis.foundation.config.queue.Failed.table
orionis.foundation.config.queue.Failed.html#table
Attribute
Instance Variable
PUBLIC
Unqualified SQL table used to preserve failed jobs.
-
orionis.foundation.config.queue.Failed.__post_init__
orionis.foundation.config.queue.Failed.html#__post_init__
Function
Method
PUBLIC
Validate the failed-job database connection and table.
-
orionis.foundation.config.queue.entities.queue._CONNECTION_ENTITIES
orionis.foundation.config.queue.entities.queue.html#_CONNECTION_ENTITIES
Attribute
Constant
PUBLIC
Connection entities definitions used by queue.
-
orionis.foundation.config.queue.Queue
orionis.foundation.config.queue.Queue.html
Class
Class
PUBLIC
Configure named queue connections, failure storage, and workers.
-
orionis.foundation.config.queue.Queue.default
orionis.foundation.config.queue.Queue.html#default
Attribute
Instance Variable
PUBLIC
Default connection name, read from QUEUE_CONNECTION.
-
orionis.foundation.config.queue.Queue.connections
orionis.foundation.config.queue.Queue.html#connections
Attribute
Instance Variable
PUBLIC
Conventional connections or named backends converted to typed entities.
-
orionis.foundation.config.queue.Queue.failed
orionis.foundation.config.queue.Queue.html#failed
Attribute
Instance Variable
PUBLIC
Database connection and table used to preserve failed jobs.
-
orionis.foundation.config.queue.Queue.worker
orionis.foundation.config.queue.Queue.html#worker
Attribute
Instance Variable
PUBLIC
Default concurrency, polling interval, timeout, tries, and backoff.
-
orionis.foundation.config.queue.Queue.__post_init__
orionis.foundation.config.queue.Queue.html#__post_init__
Function
Method
PUBLIC
Normalize nested entities and reject invalid worker leases.
-
orionis.foundation.config.queue.Queue.__normalizeWorker
orionis.foundation.config.queue.Queue.html#__normalizeWorker
Function
Method
PUBLIC
Convert worker mappings to a validated immutable entity.
-
orionis.foundation.config.queue.Queue.__normalizeFailed
orionis.foundation.config.queue.Queue.html#__normalizeFailed
Function
Method
PUBLIC
Convert failure storage mappings to a validated immutable entity.
-
orionis.foundation.config.queue.Queue.__normalizeConnections
orionis.foundation.config.queue.Queue.html#__normalizeConnections
Function
Method
PUBLIC
Validate conventional or named connections as typed entities.
-
orionis.foundation.config.queue.Queue.__validateConnections
orionis.foundation.config.queue.Queue.html#__validateConnections
Function
Static Method
PUBLIC
Validate reservation leases and isolate failure storage.
-
orionis.foundation.config.queue.Queue.__validateStorageNamespaces
orionis.foundation.config.queue.Queue.html#__validateStorageNamespaces
Function
Static Method
PUBLIC
Require distinct persistent storage for named durable connections.
-
orionis.foundation.config.queue.Redis
orionis.foundation.config.queue.Redis.html
Class
Class
PUBLIC
Configure a durable Redis queue connection.
-
orionis.foundation.config.queue.Redis.driver
orionis.foundation.config.queue.Redis.html#driver
Attribute
Instance Variable
PUBLIC
Redis driver identifier.
-
orionis.foundation.config.queue.Redis.endpoint
orionis.foundation.config.queue.Redis.html#endpoint
Attribute
Instance Variable
PUBLIC
Redis host read from REDIS_HOST.
-
orionis.foundation.config.queue.Redis.port
orionis.foundation.config.queue.Redis.html#port
Attribute
Instance Variable
PUBLIC
TCP port read from REDIS_PORT, between 1 and 65535.
-
orionis.foundation.config.queue.Redis.db
orionis.foundation.config.queue.Redis.html#db
Attribute
Instance Variable
PUBLIC
Nonnegative database index read from REDIS_DB.
-
orionis.foundation.config.queue.Redis.password
orionis.foundation.config.queue.Redis.html#password
Attribute
Instance Variable
PUBLIC
Optional authentication password read from REDIS_PASSWORD.
-
orionis.foundation.config.queue.Redis.prefix
orionis.foundation.config.queue.Redis.html#prefix
Attribute
Instance Variable
PUBLIC
Namespace read from QUEUE_REDIS_PREFIX to isolate persisted jobs.
-
orionis.foundation.config.queue.Redis.queue
orionis.foundation.config.queue.Redis.html#queue
Attribute
Instance Variable
PUBLIC
Default logical queue name read from QUEUE_REDIS_QUEUE.
-
orionis.foundation.config.queue.Redis.retry_after
orionis.foundation.config.queue.Redis.html#retry_after
Attribute
Instance Variable
PUBLIC
Reservation duration read from QUEUE_REDIS_RETRY_AFTER in seconds.
-
orionis.foundation.config.queue.Redis.__post_init__
orionis.foundation.config.queue.Redis.html#__post_init__
Function
Method
PUBLIC
Validate Redis connection fields, namespace, and reservation duration.
-
orionis.foundation.config.queue.Sync
orionis.foundation.config.queue.Sync.html
Class
Class
PUBLIC
Configure the synchronous queue connection.
-
orionis.foundation.config.queue.Sync.driver
orionis.foundation.config.queue.Sync.html#driver
Attribute
Instance Variable
PUBLIC
Synchronous driver identifier.
-
orionis.foundation.config.queue.Sync.queue
orionis.foundation.config.queue.Sync.html#queue
Attribute
Instance Variable
PUBLIC
Default logical queue name read from QUEUE_SYNC_QUEUE.
-
orionis.foundation.config.queue.Sync.retry_after
orionis.foundation.config.queue.Sync.html#retry_after
Attribute
Instance Variable
PUBLIC
Reservation duration read from QUEUE_SYNC_RETRY_AFTER in seconds.
-
orionis.foundation.config.queue.Sync.__post_init__
orionis.foundation.config.queue.Sync.html#__post_init__
Function
Method
PUBLIC
Validate the driver, queue name, and reservation duration.
-
orionis.foundation.config.queue.Worker
orionis.foundation.config.queue.Worker.html
Class
Class
PUBLIC
Configure strictly validated queue worker defaults.
-
orionis.foundation.config.queue.Worker.concurrency
orionis.foundation.config.queue.Worker.html#concurrency
Attribute
Instance Variable
PUBLIC
Maximum concurrent jobs read from QUEUE_WORKER_CONCURRENCY.
-
orionis.foundation.config.queue.Worker.sleep
orionis.foundation.config.queue.Worker.html#sleep
Attribute
Instance Variable
PUBLIC
Positive polling seconds read from QUEUE_WORKER_SLEEP.
-
orionis.foundation.config.queue.Worker.timeout
orionis.foundation.config.queue.Worker.html#timeout
Attribute
Instance Variable
PUBLIC
Positive execution seconds read from QUEUE_WORKER_TIMEOUT.
-
orionis.foundation.config.queue.Worker.tries
orionis.foundation.config.queue.Worker.html#tries
Attribute
Instance Variable
PUBLIC
Maximum attempts read from QUEUE_WORKER_TRIES.
-
orionis.foundation.config.queue.Worker.backoff
orionis.foundation.config.queue.Worker.html#backoff
Attribute
Instance Variable
PUBLIC
Nonnegative retry delays read from QUEUE_WORKER_BACKOFF.
-
orionis.foundation.config.queue.Worker.__post_init__
orionis.foundation.config.queue.Worker.html#__post_init__
Function
Method
PUBLIC
Validate worker limits and own the immutable retry schedule.
-
orionis.foundation.config.queue._EXPORTS
orionis.foundation.config.queue.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.foundation.config.queue.__getattr__
orionis.foundation.config.queue.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.foundation.config.queue.__dir__
orionis.foundation.config.queue.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.foundation.config.queue.enums.Drivers
orionis.foundation.config.queue.enums.Drivers.html
Class
Class
PUBLIC
Enumerate supported queue connection drivers.
-
orionis.foundation.config.queue.enums.Drivers.SYNC
orionis.foundation.config.queue.enums.Drivers.html#SYNC
Attribute
Constant
PUBLIC
sync.
-
orionis.foundation.config.queue.enums.Drivers.DATABASE
orionis.foundation.config.queue.enums.Drivers.html#DATABASE
Attribute
Constant
PUBLIC
database.
-
orionis.foundation.config.queue.enums.Drivers.REDIS
orionis.foundation.config.queue.enums.Drivers.html#REDIS
Attribute
Constant
PUBLIC
redis.
-
orionis.foundation.config.realtime._EXPORTS
orionis.foundation.config.realtime.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.foundation.config.realtime.__getattr__
orionis.foundation.config.realtime.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.foundation.config.realtime.__dir__
orionis.foundation.config.realtime.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.foundation.config.scheduler.Database
orionis.foundation.config.scheduler.Database.html
Class
Class
PUBLIC
Represent the configuration entity for a database-backed job store.
-
orionis.foundation.config.scheduler.Database.driver
orionis.foundation.config.scheduler.Database.html#driver
Attribute
Instance Variable
PUBLIC
The driver type. Defaults to 'database'.
-
orionis.foundation.config.scheduler.Database.connection
orionis.foundation.config.scheduler.Database.html#connection
Attribute
Instance Variable
PUBLIC
The database connection name used to store scheduled tasks. Resolved from the DB_TASK_CONNECTION environment variable or None to use the application's default connection.
-
orionis.foundation.config.scheduler.Database.table
orionis.foundation.config.scheduler.Database.html#table
Attribute
Instance Variable
PUBLIC
The database table name used to store scheduled tasks. Must match the pattern [a-z_]+. Resolved from the DB_TASK_TABLE environment variable or defaults to 'scheduler_tasks'.
-
orionis.foundation.config.scheduler.Database.__validateDriver
orionis.foundation.config.scheduler.Database.html#__validateDriver
Function
Method
PUBLIC
Validate the driver property.
-
orionis.foundation.config.scheduler.Database.__validateConnection
orionis.foundation.config.scheduler.Database.html#__validateConnection
Function
Method
PUBLIC
Validate the connection property.
-
orionis.foundation.config.scheduler.Database.__post_init__
orionis.foundation.config.scheduler.Database.html#__post_init__
Function
Method
PUBLIC
Validate the Database job store configuration after initialization.
-
orionis.foundation.config.scheduler.Memory
orionis.foundation.config.scheduler.Memory.html
Class
Class
PUBLIC
Represent the configuration entity for an in-memory job store.
-
orionis.foundation.config.scheduler.Memory.driver
orionis.foundation.config.scheduler.Memory.html#driver
Attribute
Instance Variable
PUBLIC
The driver type for the job store. Defaults to 'memory'.
-
orionis.foundation.config.scheduler.Memory.__post_init__
orionis.foundation.config.scheduler.Memory.html#__post_init__
Function
Method
PUBLIC
Validate the Memory configuration after initialization.
-
orionis.foundation.config.scheduler.Redis
orionis.foundation.config.scheduler.Redis.html
Class
Class
PUBLIC
Represent the configuration entity for a Redis job store.
-
orionis.foundation.config.scheduler.Redis.driver
orionis.foundation.config.scheduler.Redis.html#driver
Attribute
Instance Variable
PUBLIC
The driver type. Defaults to 'redis'.
-
orionis.foundation.config.scheduler.Redis.host
orionis.foundation.config.scheduler.Redis.html#host
Attribute
Instance Variable
PUBLIC
Redis host address. Defaults to '127.0.0.1'.
-
orionis.foundation.config.scheduler.Redis.port
orionis.foundation.config.scheduler.Redis.html#port
Attribute
Instance Variable
PUBLIC
Redis port number. Defaults to 6379.
-
orionis.foundation.config.scheduler.Redis.db
orionis.foundation.config.scheduler.Redis.html#db
Attribute
Instance Variable
PUBLIC
Redis database index. Defaults to 0.
-
orionis.foundation.config.scheduler.Redis.key
orionis.foundation.config.scheduler.Redis.html#key
Attribute
Instance Variable
PUBLIC
Redis key used to store the serialized job definitions. Defaults to 'scheduler:tasks'.
-
orionis.foundation.config.scheduler.Redis.run_times_key
orionis.foundation.config.scheduler.Redis.html#run_times_key
Attribute
Instance Variable
PUBLIC
Redis key used to store the next-run-time index for scheduled jobs. Defaults to 'scheduler:run_times'.
-
orionis.foundation.config.scheduler.Redis.password
orionis.foundation.config.scheduler.Redis.html#password
Attribute
Class Variable
PUBLIC
Account password subject to the declared validation constraints.
-
orionis.foundation.config.scheduler.Redis.__validateDriver
orionis.foundation.config.scheduler.Redis.html#__validateDriver
Function
Method
PUBLIC
Validate the driver property.
-
orionis.foundation.config.scheduler.Redis.__validateHost
orionis.foundation.config.scheduler.Redis.html#__validateHost
Function
Method
PUBLIC
Validate the host property.
-
orionis.foundation.config.scheduler.Redis.__validateKey
orionis.foundation.config.scheduler.Redis.html#__validateKey
Function
Method
PUBLIC
Validate the key property.
-
orionis.foundation.config.scheduler.Redis.__validateRunTimesKey
orionis.foundation.config.scheduler.Redis.html#__validateRunTimesKey
Function
Method
PUBLIC
Validate the run_times_key property.
-
orionis.foundation.config.scheduler.Redis.__post_init__
orionis.foundation.config.scheduler.Redis.html#__post_init__
Function
Method
PUBLIC
Validate the Redis job store configuration after initialization.
-
orionis.foundation.config.scheduler.Scheduler
orionis.foundation.config.scheduler.Scheduler.html
Class
Class
PUBLIC
Represent the task scheduler configuration for the application.
-
orionis.foundation.config.scheduler.Scheduler.store
orionis.foundation.config.scheduler.Scheduler.html#store
Attribute
Instance Variable
PUBLIC
The default job store used by the task scheduler. Accepts a Drivers enum member or a plain string (e.g. 'memory', 'redis'). Resolved from the TASKS_STORE environment variable or Drivers.MEMORY.value.
-
orionis.foundation.config.scheduler.Scheduler.stores
orionis.foundation.config.scheduler.Scheduler.html#stores
Attribute
Instance Variable
PUBLIC
Configuration for the available scheduler job stores. Defaults to a Stores instance backed by the in-memory job store.
-
orionis.foundation.config.scheduler.Scheduler.max_instances
orionis.foundation.config.scheduler.Scheduler.html#max_instances
Attribute
Instance Variable
PUBLIC
Maximum number of concurrently running instances allowed for a single scheduled job. Defaults to 1.
-
orionis.foundation.config.scheduler.Scheduler.coalesce
orionis.foundation.config.scheduler.Scheduler.html#coalesce
Attribute
Instance Variable
PUBLIC
Whether missed runs of a job are collapsed into a single run. Defaults to True.
-
orionis.foundation.config.scheduler.Scheduler.misfire_grace_time
orionis.foundation.config.scheduler.Scheduler.html#misfire_grace_time
Attribute
Instance Variable
PUBLIC
Number of seconds a job is allowed to run late before it is considered misfired. Defaults to 30.
-
orionis.foundation.config.scheduler.Scheduler.replace_existing
orionis.foundation.config.scheduler.Scheduler.html#replace_existing
Attribute
Instance Variable
PUBLIC
Whether adding a job with an already registered id replaces the previous definition. Defaults to True so the declarative task list is always reconciled against a persistent job store (e.g. database/redis...
-
orionis.foundation.config.scheduler.Scheduler.jitter
orionis.foundation.config.scheduler.Scheduler.html#jitter
Attribute
Instance Variable
PUBLIC
Maximum number of seconds of random delay applied to job execution to avoid thundering-herd effects. Defaults to 0.
-
orionis.foundation.config.scheduler.Scheduler.__validateStore
orionis.foundation.config.scheduler.Scheduler.html#__validateStore
Function
Method
PUBLIC
Validate and normalize the store property.
-
orionis.foundation.config.scheduler.Scheduler.__validateStores
orionis.foundation.config.scheduler.Scheduler.html#__validateStores
Function
Method
PUBLIC
Validate and convert the stores property.
-
orionis.foundation.config.scheduler.Scheduler.__validateMaxInstances
orionis.foundation.config.scheduler.Scheduler.html#__validateMaxInstances
Function
Method
PUBLIC
Validate the max_instances property.
-
orionis.foundation.config.scheduler.Scheduler.__validateCoalesce
orionis.foundation.config.scheduler.Scheduler.html#__validateCoalesce
Function
Method
PUBLIC
Validate the coalesce property.
-
orionis.foundation.config.scheduler.Scheduler.__validateMisfireGraceTime
orionis.foundation.config.scheduler.Scheduler.html#__validateMisfireGraceTime
Function
Method
PUBLIC
Validate the misfire_grace_time property.
-
orionis.foundation.config.scheduler.Scheduler.__validateReplaceExisting
orionis.foundation.config.scheduler.Scheduler.html#__validateReplaceExisting
Function
Method
PUBLIC
Validate the replace_existing property.
-
orionis.foundation.config.scheduler.Scheduler.__validateJitter
orionis.foundation.config.scheduler.Scheduler.html#__validateJitter
Function
Method
PUBLIC
Validate the jitter property.
-
orionis.foundation.config.scheduler.Scheduler.__post_init__
orionis.foundation.config.scheduler.Scheduler.html#__post_init__
Function
Method
PUBLIC
Validate and normalize the scheduler configuration after init.
-
orionis.foundation.config.scheduler.Stores
orionis.foundation.config.scheduler.Stores.html
Class
Class
PUBLIC
Represent a collection of scheduler job store backends.
-
orionis.foundation.config.scheduler.Stores.memory
orionis.foundation.config.scheduler.Stores.html#memory
Attribute
Instance Variable
PUBLIC
In-memory job store configuration. Defaults to None.
-
orionis.foundation.config.scheduler.Stores.redis
orionis.foundation.config.scheduler.Stores.html#redis
Attribute
Instance Variable
PUBLIC
Redis job store configuration. Defaults to None.
-
orionis.foundation.config.scheduler.Stores.database
orionis.foundation.config.scheduler.Stores.html#database
Attribute
Instance Variable
PUBLIC
Database-backed job store configuration. Defaults to None.
-
orionis.foundation.config.scheduler.Stores.__post_init__
orionis.foundation.config.scheduler.Stores.html#__post_init__
Function
Method
PUBLIC
Validate and convert store configuration attributes after init.
-
orionis.foundation.config.scheduler._EXPORTS
orionis.foundation.config.scheduler.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.foundation.config.scheduler.__getattr__
orionis.foundation.config.scheduler.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.foundation.config.scheduler.__dir__
orionis.foundation.config.scheduler.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.foundation.config.scheduler.enums.Drivers
orionis.foundation.config.scheduler.enums.Drivers.html
Class
Class
PUBLIC
Enumerate supported scheduler job store drivers.
-
orionis.foundation.config.scheduler.enums.Drivers.MEMORY
orionis.foundation.config.scheduler.enums.Drivers.html#MEMORY
Attribute
Constant
PUBLIC
Represents an in-memory job store driver.
-
orionis.foundation.config.scheduler.enums.Drivers.REDIS
orionis.foundation.config.scheduler.enums.Drivers.html#REDIS
Attribute
Constant
PUBLIC
Represents a Redis job store driver.
-
orionis.foundation.config.scheduler.enums.Drivers.DATABASE
orionis.foundation.config.scheduler.enums.Drivers.html#DATABASE
Attribute
Constant
PUBLIC
Represents a database job store driver.
-
orionis.foundation.config.session.enums.SameSitePolicy
orionis.foundation.config.session.enums.SameSitePolicy.html
Class
Class
PUBLIC
Represent possible values for the SameSite attribute of cookies.
-
orionis.foundation.config.session.enums.SameSitePolicy.LAX
orionis.foundation.config.session.enums.SameSitePolicy.html#LAX
Attribute
Constant
PUBLIC
Cookies are withheld on cross-site subrequests, but sent when a user navigates to the URL from an external site (e.g., following a link).
-
orionis.foundation.config.session.enums.SameSitePolicy.STRICT
orionis.foundation.config.session.enums.SameSitePolicy.html#STRICT
Attribute
Constant
PUBLIC
Cookies are only sent in a first-party context and not with requests initiated by third party websites.
-
orionis.foundation.config.session.enums.SameSitePolicy.NONE
orionis.foundation.config.session.enums.SameSitePolicy.html#NONE
Attribute
Constant
PUBLIC
Cookies are sent in all contexts, i.e., in responses to both first-party and cross-origin requests.
-
orionis.foundation.config.session.entities.session._SAME_SITE_VALUES
orionis.foundation.config.session.entities.session.html#_SAME_SITE_VALUES
Attribute
Constant
PUBLIC
Enumerate accepted session drivers and cookie policies.
-
orionis.foundation.config.session.entities.session._DRIVER_VALUES
orionis.foundation.config.session.entities.session.html#_DRIVER_VALUES
Attribute
Constant
PUBLIC
Driver values used by session.
-
orionis.foundation.config.session.Session
orionis.foundation.config.session.Session.html
Class
Class
PUBLIC
Configure the session middleware.
-
orionis.foundation.config.session.Session.driver
orionis.foundation.config.session.Session.html#driver
Attribute
Instance Variable
PUBLIC
Session driver. Defaults to SessionDriver.MEMORY.
-
orionis.foundation.config.session.Session.lifetime
orionis.foundation.config.session.Session.html#lifetime
Attribute
Instance Variable
PUBLIC
Session lifetime in minutes. Defaults to 120.
-
orionis.foundation.config.session.Session.expire_on_close
orionis.foundation.config.session.Session.html#expire_on_close
Attribute
Instance Variable
PUBLIC
Expire session on browser close (omits Max-Age). Defaults to False.
-
orionis.foundation.config.session.Session.track_previous_url
orionis.foundation.config.session.Session.html#track_previous_url
Attribute
Instance Variable
PUBLIC
Remember successful navigation URLs in the session. Defaults to True.
-
orionis.foundation.config.session.Session.renewal_interval
orionis.foundation.config.session.Session.html#renewal_interval
Attribute
Instance Variable
PUBLIC
Minimum seconds between renewal writes for unchanged scalar payloads. Zero renews every request. Must be strictly below the lifetime in seconds so renewal can occur while the session is still valid. Mutable payloads and dirty sessions are always persisted.
-
orionis.foundation.config.session.Session.files
orionis.foundation.config.session.Session.html#files
Attribute
Instance Variable
PUBLIC
Path to session files (file driver). Defaults to 'storage/framework/sessions'.
-
orionis.foundation.config.session.Session.connection
orionis.foundation.config.session.Session.html#connection
Attribute
Instance Variable
PUBLIC
Database connection for session storage (database driver). Defaults to None.
-
orionis.foundation.config.session.Session.table
orionis.foundation.config.session.Session.html#table
Attribute
Instance Variable
PUBLIC
Database table for session storage (database driver). Defaults to 'sessions'.
-
orionis.foundation.config.session.Session.cache
orionis.foundation.config.session.Session.html#cache
Attribute
Instance Variable
PUBLIC
Cache store for session storage (cache driver). Defaults to None.
-
orionis.foundation.config.session.Session.cookie
orionis.foundation.config.session.Session.html#cookie
Attribute
Instance Variable
PUBLIC
Name of the session cookie. Defaults to 'sessionid'.
-
orionis.foundation.config.session.Session.path
orionis.foundation.config.session.Session.html#path
Attribute
Instance Variable
PUBLIC
Cookie path. Defaults to '/'.
-
orionis.foundation.config.session.Session.domain
orionis.foundation.config.session.Session.html#domain
Attribute
Instance Variable
PUBLIC
Cookie domain for cross-subdomain usage.
-
orionis.foundation.config.session.Session.secure
orionis.foundation.config.session.Session.html#secure
Attribute
Instance Variable
PUBLIC
Restrict cookies to HTTPS. Defaults to False.
-
orionis.foundation.config.session.Session.http_only
orionis.foundation.config.session.Session.html#http_only
Attribute
Instance Variable
PUBLIC
Prevent JavaScript from accessing the cookie. Defaults to True.
-
orionis.foundation.config.session.Session.same_site
orionis.foundation.config.session.Session.html#same_site
Attribute
Instance Variable
PUBLIC
SameSite cookie policy. Defaults to SameSitePolicy.LAX.
-
orionis.foundation.config.session.Session.partitioned
orionis.foundation.config.session.Session.html#partitioned
Attribute
Instance Variable
PUBLIC
Enable CHIPS (partitioned) cookies. Defaults to False.
-
orionis.foundation.config.session.Session.__validateDriver
orionis.foundation.config.session.Session.html#__validateDriver
Function
Method
PUBLIC
Normalise and validate the driver field.
-
orionis.foundation.config.session.Session.__validateCookie
orionis.foundation.config.session.Session.html#__validateCookie
Function
Method
PUBLIC
Validate the cookie field.
-
orionis.foundation.config.session.Session.__validateLifetime
orionis.foundation.config.session.Session.html#__validateLifetime
Function
Method
PUBLIC
Validate the lifetime field.
-
orionis.foundation.config.session.Session.__validateBooleans
orionis.foundation.config.session.Session.html#__validateBooleans
Function
Method
PUBLIC
Validate all boolean fields in a single pass.
-
orionis.foundation.config.session.Session.__validateSameSite
orionis.foundation.config.session.Session.html#__validateSameSite
Function
Method
PUBLIC
Normalise and validate the same_site field.
-
orionis.foundation.config.session.Session.__validatePath
orionis.foundation.config.session.Session.html#__validatePath
Function
Method
PUBLIC
Validate the path field.
-
orionis.foundation.config.session.Session.__validateDomain
orionis.foundation.config.session.Session.html#__validateDomain
Function
Method
PUBLIC
Validate the domain field.
-
orionis.foundation.config.session.Session.__validateFiles
orionis.foundation.config.session.Session.html#__validateFiles
Function
Method
PUBLIC
Validate the files path field.
-
orionis.foundation.config.session.Session.__validateConnection
orionis.foundation.config.session.Session.html#__validateConnection
Function
Method
PUBLIC
Validate the connection field.
-
orionis.foundation.config.session.Session.__validateTable
orionis.foundation.config.session.Session.html#__validateTable
Function
Method
PUBLIC
Validate the table field.
-
orionis.foundation.config.session.Session.__validateCache
orionis.foundation.config.session.Session.html#__validateCache
Function
Method
PUBLIC
Validate the cache field.
-
orionis.foundation.config.session.Session.__post_init__
orionis.foundation.config.session.Session.html#__post_init__
Function
Method
PUBLIC
Validate all fields after dataclass initialisation.
-
orionis.foundation.config.session.SessionDriver
orionis.foundation.config.session.SessionDriver.html
Class
Class
PUBLIC
Enumeration of supported session storage drivers.
-
orionis.foundation.config.session.SessionDriver.MEMORY
orionis.foundation.config.session.SessionDriver.html#MEMORY
Attribute
Constant
PUBLIC
In-memory session storage.
-
orionis.foundation.config.session.SessionDriver.FILE
orionis.foundation.config.session.SessionDriver.html#FILE
Attribute
Constant
PUBLIC
File-based session storage.
-
orionis.foundation.config.session.SessionDriver.DATABASE
orionis.foundation.config.session.SessionDriver.html#DATABASE
Attribute
Constant
PUBLIC
Database-backed session storage.
-
orionis.foundation.config.session.SessionDriver.CACHE
orionis.foundation.config.session.SessionDriver.html#CACHE
Attribute
Constant
PUBLIC
Cache-based session storage.
-
orionis.foundation.config.session._EXPORTS
orionis.foundation.config.session.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.foundation.config.session.__getattr__
orionis.foundation.config.session.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.foundation.config.session.__dir__
orionis.foundation.config.session.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.foundation.config.session.helpers.secret_key.SecretKey
orionis.foundation.config.session.helpers.secret_key.SecretKey.html
Class
Class
PUBLIC
Resolve and validate the key used to protect session data.
-
orionis.foundation.config.session.helpers.secret_key.SecretKey.random
orionis.foundation.config.session.helpers.secret_key.SecretKey.html#random
Function
Static Method
PUBLIC
Generate a cryptographically secure random key as a hexadecimal string.
-
orionis.foundation.config.testing.enums.VerbosityMode
orionis.foundation.config.testing.enums.VerbosityMode.html
Class
Class
PUBLIC
Enumerate verbosity levels for test output.
-
orionis.foundation.config.testing.enums.VerbosityMode.SILENT
orionis.foundation.config.testing.enums.VerbosityMode.html#SILENT
Attribute
Constant
PUBLIC
No output will be shown.
-
orionis.foundation.config.testing.enums.VerbosityMode.MINIMAL
orionis.foundation.config.testing.enums.VerbosityMode.html#MINIMAL
Attribute
Constant
PUBLIC
Minimal output will be displayed.
-
orionis.foundation.config.testing.enums.VerbosityMode.DETAILED
orionis.foundation.config.testing.enums.VerbosityMode.html#DETAILED
Attribute
Constant
PUBLIC
Detailed output will be provided (default).
-
orionis.foundation.config.testing.entities.testing._VERBOSITY_VALUES
orionis.foundation.config.testing.entities.testing.html#_VERBOSITY_VALUES
Attribute
Constant
PUBLIC
avoids building a list on every Testing() init.
-
orionis.foundation.config.startup._SECTION_MAP
orionis.foundation.config.startup.html#_SECTION_MAP
Attribute
Constant
PUBLIC
maps each field name to its expected concrete type.
-
orionis.foundation.config.startup.Configuration
orionis.foundation.config.startup.Configuration.html
Class
Class
PUBLIC
Represent the main configuration for Orionis Framework startup.
-
orionis.foundation.config.startup.Configuration.app
orionis.foundation.config.startup.Configuration.html#app
Attribute
Instance Variable
PUBLIC
Application configuration settings.
-
orionis.foundation.config.startup.Configuration.auth
orionis.foundation.config.startup.Configuration.html#auth
Attribute
Instance Variable
PUBLIC
Authentication configuration settings.
-
orionis.foundation.config.startup.Configuration.cache
orionis.foundation.config.startup.Configuration.html#cache
Attribute
Instance Variable
PUBLIC
Cache configuration settings.
-
orionis.foundation.config.startup.Configuration.database
orionis.foundation.config.startup.Configuration.html#database
Attribute
Instance Variable
PUBLIC
Database configuration settings.
-
orionis.foundation.config.startup.Configuration.filesystems
orionis.foundation.config.startup.Configuration.html#filesystems
Attribute
Instance Variable
PUBLIC
Filesystem configuration settings.
-
orionis.foundation.config.startup.Configuration.logging
orionis.foundation.config.startup.Configuration.html#logging
Attribute
Instance Variable
PUBLIC
Logging configuration settings.
-
orionis.foundation.config.startup.Configuration.mail
orionis.foundation.config.startup.Configuration.html#mail
Attribute
Instance Variable
PUBLIC
Mail configuration settings.
-
orionis.foundation.config.startup.Configuration.hashing
orionis.foundation.config.startup.Configuration.html#hashing
Attribute
Instance Variable
PUBLIC
Password hashing configuration settings.
-
orionis.foundation.config.startup.Configuration.scheduler
orionis.foundation.config.startup.Configuration.html#scheduler
Attribute
Instance Variable
PUBLIC
Scheduled task configuration settings.
-
orionis.foundation.config.startup.Configuration.view
orionis.foundation.config.startup.Configuration.html#view
Attribute
Instance Variable
PUBLIC
Template rendering configuration settings.
-
orionis.foundation.config.startup.Configuration.http
orionis.foundation.config.startup.Configuration.html#http
Attribute
Instance Variable
PUBLIC
HTTP configuration settings.
-
orionis.foundation.config.startup.Configuration.queue
orionis.foundation.config.startup.Configuration.html#queue
Attribute
Instance Variable
PUBLIC
Queue configuration settings.
-
orionis.foundation.config.startup.Configuration.realtime
orionis.foundation.config.startup.Configuration.html#realtime
Attribute
Instance Variable
PUBLIC
Realtime invocation, message and broadcast limits.
-
orionis.foundation.config.startup.Configuration.session
orionis.foundation.config.startup.Configuration.html#session
Attribute
Instance Variable
PUBLIC
Session configuration settings.
-
orionis.foundation.config.startup.Configuration.testing
orionis.foundation.config.startup.Configuration.html#testing
Attribute
Instance Variable
PUBLIC
Testing configuration settings.
-
orionis.foundation.config.startup.Configuration.mcp
orionis.foundation.config.startup.Configuration.html#mcp
Attribute
Instance Variable
PUBLIC
MCP protocol limits and trusted browser origins.
-
orionis.foundation.config.startup.Configuration.__post_init__
orionis.foundation.config.startup.Configuration.html#__post_init__
Function
Method
PUBLIC
Validate and convert configuration attributes to their entity types.
-
orionis.foundation.config.testing.Testing
orionis.foundation.config.testing.Testing.html
Class
Class
PUBLIC
Configure testing settings.
-
orionis.foundation.config.testing.Testing.verbosity
orionis.foundation.config.testing.Testing.html#verbosity
Attribute
Instance Variable
PUBLIC
Level of detail in test output. 0: silent, 1: standard, 2: detailed. Defaults to 2 (detailed).
-
orionis.foundation.config.testing.Testing.fail_fast
orionis.foundation.config.testing.Testing.html#fail_fast
Attribute
Instance Variable
PUBLIC
If True, stops execution at the first failure. Defaults to False.
-
orionis.foundation.config.testing.Testing.start_dir
orionis.foundation.config.testing.Testing.html#start_dir
Attribute
Instance Variable
PUBLIC
Directory to search for tests. Defaults to 'tests'.
-
orionis.foundation.config.testing.Testing.file_pattern
orionis.foundation.config.testing.Testing.html#file_pattern
Attribute
Instance Variable
PUBLIC
Filename pattern to identify test files. Defaults to 'test_*.py'.
-
orionis.foundation.config.testing.Testing.method_pattern
orionis.foundation.config.testing.Testing.html#method_pattern
Attribute
Instance Variable
PUBLIC
Pattern to filter specific test methods. Defaults to 'test*'.
-
orionis.foundation.config.testing.Testing.cache_results
orionis.foundation.config.testing.Testing.html#cache_results
Attribute
Class Variable
PUBLIC
Cache results produced by field.
-
orionis.foundation.config.testing.Testing.__post_init__
orionis.foundation.config.testing.Testing.html#__post_init__
Function
Method
PUBLIC
Validate runner options and normalize verbosity after construction.
-
orionis.foundation.config.testing._EXPORTS
orionis.foundation.config.testing.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.foundation.config.testing.__getattr__
orionis.foundation.config.testing.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.foundation.config.testing.__dir__
orionis.foundation.config.testing.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.foundation.config.view.View
orionis.foundation.config.view.View.html
Class
Class
PUBLIC
Represent view engine configuration for the application.
-
orionis.foundation.config.view.View.paths
orionis.foundation.config.view.View.html#paths
Attribute
Instance Variable
PUBLIC
Ordered list of directory paths searched for templates.
-
orionis.foundation.config.view.View.cache_size
orionis.foundation.config.view.View.html#cache_size
Attribute
Instance Variable
PUBLIC
Maximum number of compiled templates kept in the LRU memory cache. A value of 0 disables the cache; -1 keeps templates without a limit.
-
orionis.foundation.config.view.View.cache_path
orionis.foundation.config.view.View.html#cache_path
Attribute
Instance Variable
PUBLIC
Optional filesystem path used for Jinja2 bytecode caching. None disables disk-based caching.
-
orionis.foundation.config.view.View.auto_reload
orionis.foundation.config.view.View.html#auto_reload
Attribute
Instance Variable
PUBLIC
Reload templates from disk whenever the source file changes. Typically True in development and False in production.
-
orionis.foundation.config.view.View.autoescape
orionis.foundation.config.view.View.html#autoescape
Attribute
Instance Variable
PUBLIC
Enable automatic HTML escaping of all template variables.
-
orionis.foundation.config.view.View.__post_init__
orionis.foundation.config.view.View.html#__post_init__
Function
Method
PUBLIC
Validate template paths and cache settings without coercing values.
-
orionis.foundation.config.view._EXPORTS
orionis.foundation.config.view.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.foundation.config.view.__getattr__
orionis.foundation.config.view.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.foundation.config.view.__dir__
orionis.foundation.config.view.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.foundation.enums.Lifespan
orionis.foundation.enums.Lifespan.html
Class
Class
PUBLIC
Define the possible lifespan events for the application.
-
orionis.foundation.enums.Lifespan.STARTUP
orionis.foundation.enums.Lifespan.html#STARTUP
Attribute
Constant
PUBLIC
Indicates the startup event of the application.
-
orionis.foundation.enums.Lifespan.SHUTDOWN
orionis.foundation.enums.Lifespan.html#SHUTDOWN
Attribute
Constant
PUBLIC
Indicates the shutdown event of the application.
-
orionis.foundation.enums.Runtime
orionis.foundation.enums.Runtime.html
Class
Class
PUBLIC
Define runtime environments for the framework.
-
orionis.foundation.enums.Runtime.HTTP
orionis.foundation.enums.Runtime.html#HTTP
Attribute
Constant
PUBLIC
Represents the HTTP runtime environment.
-
orionis.foundation.enums.Runtime.CLI
orionis.foundation.enums.Runtime.html#CLI
Attribute
Constant
PUBLIC
Represents the CLI runtime environment.
-
orionis.foundation.lifespan.shutdown._console
orionis.foundation.lifespan.shutdown.html#_console
Attribute
Variable
PUBLIC
Shared terminal output interface reused across all shutdown display functions.
-
orionis.foundation.lifespan.shutdown._BEFORE_SHUTDOWN_PANEL
orionis.foundation.lifespan.shutdown.html#_BEFORE_SHUTDOWN_PANEL
Attribute
Constant
PUBLIC
Pre-built static panel displayed while the server is stopping.
-
orionis.foundation.lifespan.shutdown.before_shutdown_orionis_generator
orionis.foundation.lifespan.shutdown.html#before_shutdown_orionis_generator
Function
Function
PUBLIC
Render a brief shutdown panel before the server stops accepting requests.
-
orionis.foundation.lifespan.shutdown.after_shutdown_orionis_generator
orionis.foundation.lifespan.shutdown.html#after_shutdown_orionis_generator
Function
Function
PUBLIC
Render the server uptime summary panel after a successful shutdown.
-
orionis.foundation.lifespan.shutdown.shutdown_orionis_generator
orionis.foundation.lifespan.shutdown.html#shutdown_orionis_generator
Function
Function
PUBLIC
Yield control between the pre- and post-shutdown display steps.
-
orionis.foundation.lifespan.startup._console
orionis.foundation.lifespan.startup.html#_console
Attribute
Variable
PUBLIC
Shared terminal output interface reused across all startup display functions.
-
orionis.foundation.lifespan.startup._BEFORE_STARTUP_PANEL
orionis.foundation.lifespan.startup.html#_BEFORE_STARTUP_PANEL
Attribute
Constant
PUBLIC
Pre-built static splash panel displayed before server initialization begins.
-
orionis.foundation.lifespan.startup._INTERFACE_LABELS
orionis.foundation.lifespan.startup.html#_INTERFACE_LABELS
Attribute
Constant
PUBLIC
Mapping of GRANIAN_INTERFACE values to their human-readable display labels.
-
orionis.foundation.lifespan.startup.before_startup_orionis_generator
orionis.foundation.lifespan.startup.html#before_startup_orionis_generator
Function
Function
PUBLIC
Render a brief startup panel before the server begins accepting requests.
-
orionis.foundation.lifespan.startup.after_startup_orionis_generator
orionis.foundation.lifespan.startup.html#after_startup_orionis_generator
Function
Function
PUBLIC
Render the server status panel after a successful startup.
-
orionis.foundation.lifespan.startup.startup_orionis_generator
orionis.foundation.lifespan.startup.html#startup_orionis_generator
Function
Function
PUBLIC
Yield control between the pre- and post-startup display steps.
-
orionis.hashing.HashManager
orionis.hashing.HashManager.html
Class
Class
PUBLIC
Expose an algorithm-agnostic hashing API.
-
orionis.hashing.HashManager.__slots__
orionis.hashing.HashManager.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.hashing.HashManager.__init__
orionis.hashing.HashManager.html#__init__
Function
Method
PUBLIC
Initialize the manager from the application hashing configuration.
-
orionis.hashing.HashManager._config
orionis.hashing.HashManager.html#_config
Attribute
Instance Variable
PUBLIC
Validated configuration used to construct and operate the service.
-
orionis.hashing.HashManager._default
orionis.hashing.HashManager.html#_default
Attribute
Instance Variable
PUBLIC
Configured driver name used when a caller does not select one.
-
orionis.hashing.HashManager._drivers
orionis.hashing.HashManager.html#_drivers
Attribute
Instance Variable
PUBLIC
Configured backend drivers cached by their registered names.
-
orionis.hashing.HashManager.driver
orionis.hashing.HashManager.html#driver
Function
Method
PUBLIC
Return the hasher bound to the named (or default) driver.
-
orionis.hashing.HashManager.getDefaultDriver
orionis.hashing.HashManager.html#getDefaultDriver
Function
Method
PUBLIC
Return the name of the configured default driver.
-
orionis.hashing.HashManager._build
orionis.hashing.HashManager.html#_build
Function
Method
PUBLIC
Instantiate the driver identified by name.
-
orionis.hashing.HashManager.make
orionis.hashing.HashManager.html#make
Function
Method
PUBLIC
Hash a plain text value with the default driver.
-
orionis.hashing.HashManager.check
orionis.hashing.HashManager.html#check
Function
Method
PUBLIC
Verify a plain text value against an encoded hash.
-
orionis.hashing.HashManager.needsRehash
orionis.hashing.HashManager.html#needsRehash
Function
Method
PUBLIC
Determine whether a hash was produced with outdated parameters.
-
orionis.hashing.HashManager.getAlgorithm
orionis.hashing.HashManager.html#getAlgorithm
Function
Method
PUBLIC
Return the algorithm identifier of the default driver.
-
orionis.hashing.HashManager.setRounds
orionis.hashing.HashManager.html#setRounds
Function
Method
PUBLIC
Set the default cost factor used by the default driver.
-
orionis.hashing.execution.HASH_WORKERS
orionis.hashing.execution.html#HASH_WORKERS
Attribute
Constant
PUBLIC
Shared across Argon2 and bcrypt instances. Running work retains its permit until the native function finishes, including when its caller is cancelled.
-
orionis.hashing.hashers.argon2_hasher._BACKEND_MODULE
orionis.hashing.hashers.argon2_hasher.html#_BACKEND_MODULE
Attribute
Constant
PUBLIC
Backend location and distribution name reported when it is missing.
-
orionis.hashing.hashers.argon2_hasher._BACKEND_CLASS
orionis.hashing.hashers.argon2_hasher.html#_BACKEND_CLASS
Attribute
Constant
PUBLIC
Argon2Hasher.
-
orionis.hashing.hashers.argon2_hasher._BACKEND_PACKAGE
orionis.hashing.hashers.argon2_hasher.html#_BACKEND_PACKAGE
Attribute
Constant
PUBLIC
pwdlib[argon2].
-
orionis.hashing.hashers.argon2_hasher.DEFAULT_MEMORY
orionis.hashing.hashers.argon2_hasher.html#DEFAULT_MEMORY
Attribute
Constant
PUBLIC
Default per-operation memory cost in kibibytes.
-
orionis.hashing.hashers.argon2_hasher.DEFAULT_THREADS
orionis.hashing.hashers.argon2_hasher.html#DEFAULT_THREADS
Attribute
Constant
PUBLIC
Default number of parallel Argon2 lanes.
-
orionis.hashing.hashers.argon2_hasher.DEFAULT_TIME
orionis.hashing.hashers.argon2_hasher.html#DEFAULT_TIME
Attribute
Constant
PUBLIC
Default number of passes over the allocated memory.
-
orionis.hashing.hashers.bcrypt_hasher._BACKEND_MODULE
orionis.hashing.hashers.bcrypt_hasher.html#_BACKEND_MODULE
Attribute
Constant
PUBLIC
Backend location and distribution name reported when it is missing.
-
orionis.hashing.hashers.bcrypt_hasher._BACKEND_CLASS
orionis.hashing.hashers.bcrypt_hasher.html#_BACKEND_CLASS
Attribute
Constant
PUBLIC
BcryptHasher.
-
orionis.hashing.hashers.bcrypt_hasher._BACKEND_PACKAGE
orionis.hashing.hashers.bcrypt_hasher.html#_BACKEND_PACKAGE
Attribute
Constant
PUBLIC
pwdlib[bcrypt].
-
orionis.hashing.hashers.bcrypt_hasher.MIN_ROUNDS
orionis.hashing.hashers.bcrypt_hasher.html#MIN_ROUNDS
Attribute
Constant
PUBLIC
Minimum accepted base-two logarithm of the bcrypt iteration count.
-
orionis.hashing.hashers.bcrypt_hasher.MAX_ROUNDS
orionis.hashing.hashers.bcrypt_hasher.html#MAX_ROUNDS
Attribute
Constant
PUBLIC
Maximum accepted base-two logarithm of the bcrypt iteration count.
-
orionis.hashing.hashers.bcrypt_hasher.DEFAULT_ROUNDS
orionis.hashing.hashers.bcrypt_hasher.html#DEFAULT_ROUNDS
Attribute
Constant
PUBLIC
Default base-two logarithm of the bcrypt iteration count.
-
orionis.hashing.hashers.bcrypt_hasher._HASH_PATTERN
orionis.hashing.hashers.bcrypt_hasher.html#_HASH_PATTERN
Attribute
Constant
PUBLIC
Canonical bcrypt cost, salt, and digest encoding without unused trailing bits.
-
orionis.hashing._EXPORTS
orionis.hashing.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.hashing.__getattr__
orionis.hashing.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.hashing.__dir__
orionis.hashing.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.hashing.contracts.IHashManager
orionis.hashing.contracts.IHashManager.html
Class
Class
PUBLIC
Define the contract for the hashing manager.
-
orionis.hashing.contracts.IHashManager.__slots__
orionis.hashing.contracts.IHashManager.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.hashing.contracts.IHashManager.driver
orionis.hashing.contracts.IHashManager.html#driver
Function
Method
PUBLIC
Return the hasher bound to the named (or default) driver.
-
orionis.hashing.contracts.IHashManager.getDefaultDriver
orionis.hashing.contracts.IHashManager.html#getDefaultDriver
Function
Method
PUBLIC
Return the name of the configured default driver.
-
orionis.hashing.contracts.IHasher
orionis.hashing.contracts.IHasher.html
Class
Class
PUBLIC
Define the contract implemented by every password hashing driver.
-
orionis.hashing.contracts.IHasher.__slots__
orionis.hashing.contracts.IHasher.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.hashing.contracts.IHasher.make
orionis.hashing.contracts.IHasher.html#make
Function
Method
PUBLIC
Hash a plain text value off the event loop.
-
orionis.hashing.contracts.IHasher.check
orionis.hashing.contracts.IHasher.html#check
Function
Method
PUBLIC
Verify a plain text value against an encoded hash.
-
orionis.hashing.contracts.IHasher.needsRehash
orionis.hashing.contracts.IHasher.html#needsRehash
Function
Method
PUBLIC
Determine whether a hash was produced with outdated parameters.
-
orionis.hashing.contracts.IHasher.getAlgorithm
orionis.hashing.contracts.IHasher.html#getAlgorithm
Function
Method
PUBLIC
Return the identifier of the algorithm used by the driver.
-
orionis.hashing.contracts.IHasher.setRounds
orionis.hashing.contracts.IHasher.html#setRounds
Function
Method
PUBLIC
Set the default cost factor used by the driver.
-
orionis.hashing.hashers.Argon2Hasher
orionis.hashing.hashers.Argon2Hasher.html
Class
Class
PUBLIC
Hash passwords with Argon2id.
-
orionis.hashing.hashers.Argon2Hasher.__slots__
orionis.hashing.hashers.Argon2Hasher.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.hashing.hashers.Argon2Hasher.__init__
orionis.hashing.hashers.Argon2Hasher.html#__init__
Function
Method
PUBLIC
Initialize the driver with its default cost parameters.
-
orionis.hashing.hashers.Argon2Hasher._memory
orionis.hashing.hashers.Argon2Hasher.html#_memory
Attribute
Instance Variable
PUBLIC
Memory cost in kibibytes.
-
orionis.hashing.hashers.Argon2Hasher._state_lock
orionis.hashing.hashers.Argon2Hasher.html#_state_lock
Attribute
Instance Variable
PUBLIC
Lock protecting cost snapshots and backend cache publication.
-
orionis.hashing.hashers.Argon2Hasher._executor
orionis.hashing.hashers.Argon2Hasher.html#_executor
Attribute
Instance Variable
PUBLIC
Caller-owned dedicated executor, or the shared bounded hashing pool.
-
orionis.hashing.hashers.Argon2Hasher._threads
orionis.hashing.hashers.Argon2Hasher.html#_threads
Attribute
Instance Variable
PUBLIC
Degree of parallelism.
-
orionis.hashing.hashers.Argon2Hasher._time
orionis.hashing.hashers.Argon2Hasher.html#_time
Attribute
Instance Variable
PUBLIC
Number of iterations.
-
orionis.hashing.hashers.Argon2Hasher._backend_class
orionis.hashing.hashers.Argon2Hasher.html#_backend_class
Attribute
Instance Variable
PUBLIC
The backend is imported and built on first use to keep the driver constructible even when the dependency is absent.
-
orionis.hashing.hashers.Argon2Hasher._backend
orionis.hashing.hashers.Argon2Hasher.html#_backend
Attribute
Instance Variable
PUBLIC
Backend implementation used to perform the configured operation.
-
orionis.hashing.hashers.Argon2Hasher._validate
orionis.hashing.hashers.Argon2Hasher.html#_validate
Function
Static Method
PUBLIC
Ensure a cost parameter fits the native algorithm's integer range.
-
orionis.hashing.hashers.Argon2Hasher._validateMemory
orionis.hashing.hashers.Argon2Hasher.html#_validateMemory
Function
Static Method
PUBLIC
Require enough configured memory for every Argon2 lane.
-
orionis.hashing.hashers.Argon2Hasher._backendClass
orionis.hashing.hashers.Argon2Hasher.html#_backendClass
Function
Method
PUBLIC
Return the backend class, importing it on first use.
-
orionis.hashing.hashers.Argon2Hasher._build
orionis.hashing.hashers.Argon2Hasher.html#_build
Function
Method
PUBLIC
Build a backend instance for the given cost parameters.
-
orionis.hashing.hashers.Argon2Hasher._default
orionis.hashing.hashers.Argon2Hasher.html#_default
Function
Method
PUBLIC
Return the cached backend built from the configured parameters.
-
orionis.hashing.hashers.Argon2Hasher._make
orionis.hashing.hashers.Argon2Hasher.html#_make
Function
Method
PUBLIC
Hash a plain text value with Argon2id.
-
orionis.hashing.hashers.Argon2Hasher.make
orionis.hashing.hashers.Argon2Hasher.html#make
Function
Method
PUBLIC
Hash a plain text value off the event loop.
-
orionis.hashing.hashers.Argon2Hasher._check
orionis.hashing.hashers.Argon2Hasher.html#_check
Function
Method
PUBLIC
Verify a plain text value against an Argon2id hash.
-
orionis.hashing.hashers.Argon2Hasher.check
orionis.hashing.hashers.Argon2Hasher.html#check
Function
Method
PUBLIC
Verify a plain text value off the event loop.
-
orionis.hashing.hashers.Argon2Hasher.needsRehash
orionis.hashing.hashers.Argon2Hasher.html#needsRehash
Function
Method
PUBLIC
Determine whether the hash uses outdated Argon2id parameters.
-
orionis.hashing.hashers.Argon2Hasher._identify
orionis.hashing.hashers.Argon2Hasher.html#_identify
Function
Method
PUBLIC
Check whether the hash was produced by the Argon2 family.
-
orionis.hashing.hashers.Argon2Hasher.getAlgorithm
orionis.hashing.hashers.Argon2Hasher.html#getAlgorithm
Function
Method
PUBLIC
Return the algorithm identifier of this driver.
-
orionis.hashing.hashers.Argon2Hasher.setRounds
orionis.hashing.hashers.Argon2Hasher.html#setRounds
Function
Method
PUBLIC
Set the default time cost used by the driver.
-
orionis.hashing.hashers.Argon2Hasher.setMemory
orionis.hashing.hashers.Argon2Hasher.html#setMemory
Function
Method
PUBLIC
Set the default memory cost used by the driver.
-
orionis.hashing.hashers.Argon2Hasher.setThreads
orionis.hashing.hashers.Argon2Hasher.html#setThreads
Function
Method
PUBLIC
Set the default parallelism used by the driver.
-
orionis.hashing.hashers.BcryptHasher
orionis.hashing.hashers.BcryptHasher.html
Class
Class
PUBLIC
Hash passwords with bcrypt.
-
orionis.hashing.hashers.BcryptHasher.__slots__
orionis.hashing.hashers.BcryptHasher.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.hashing.hashers.BcryptHasher.__init__
orionis.hashing.hashers.BcryptHasher.html#__init__
Function
Method
PUBLIC
Initialize the driver with its default cost factor.
-
orionis.hashing.hashers.BcryptHasher._rounds
orionis.hashing.hashers.BcryptHasher.html#_rounds
Attribute
Instance Variable
PUBLIC
Cost factor, expressed as the base-2 logarithm of the iteration count.
-
orionis.hashing.hashers.BcryptHasher._state_lock
orionis.hashing.hashers.BcryptHasher.html#_state_lock
Attribute
Instance Variable
PUBLIC
Lock protecting cost snapshots and backend cache publication.
-
orionis.hashing.hashers.BcryptHasher._executor
orionis.hashing.hashers.BcryptHasher.html#_executor
Attribute
Instance Variable
PUBLIC
Caller-owned dedicated executor, or the shared bounded hashing pool.
-
orionis.hashing.hashers.BcryptHasher._backend_class
orionis.hashing.hashers.BcryptHasher.html#_backend_class
Attribute
Instance Variable
PUBLIC
The backend is imported and built on first use to keep the driver constructible even when the dependency is absent.
-
orionis.hashing.hashers.BcryptHasher._backend
orionis.hashing.hashers.BcryptHasher.html#_backend
Attribute
Instance Variable
PUBLIC
Backend implementation used to perform the configured operation.
-
orionis.hashing.hashers.BcryptHasher._validate
orionis.hashing.hashers.BcryptHasher.html#_validate
Function
Static Method
PUBLIC
Ensure the cost factor is supported by bcrypt.
-
orionis.hashing.hashers.BcryptHasher._backendClass
orionis.hashing.hashers.BcryptHasher.html#_backendClass
Function
Method
PUBLIC
Return the backend class, importing it on first use.
-
orionis.hashing.hashers.BcryptHasher._build
orionis.hashing.hashers.BcryptHasher.html#_build
Function
Method
PUBLIC
Build a backend instance for the given cost factor.
-
orionis.hashing.hashers.BcryptHasher._default
orionis.hashing.hashers.BcryptHasher.html#_default
Function
Method
PUBLIC
Return the cached backend built from the configured cost factor.
-
orionis.hashing.hashers.BcryptHasher._make
orionis.hashing.hashers.BcryptHasher.html#_make
Function
Method
PUBLIC
Hash a plain text value with bcrypt.
-
orionis.hashing.hashers.BcryptHasher.make
orionis.hashing.hashers.BcryptHasher.html#make
Function
Method
PUBLIC
Hash a plain text value off the event loop.
-
orionis.hashing.hashers.BcryptHasher._check
orionis.hashing.hashers.BcryptHasher.html#_check
Function
Method
PUBLIC
Verify a plain text value against a bcrypt hash.
-
orionis.hashing.hashers.BcryptHasher.check
orionis.hashing.hashers.BcryptHasher.html#check
Function
Method
PUBLIC
Verify a plain text value off the event loop.
-
orionis.hashing.hashers.BcryptHasher.needsRehash
orionis.hashing.hashers.BcryptHasher.html#needsRehash
Function
Method
PUBLIC
Determine whether the hash uses an outdated cost factor.
-
orionis.hashing.hashers.BcryptHasher._identify
orionis.hashing.hashers.BcryptHasher.html#_identify
Function
Method
PUBLIC
Check whether the hash was produced by bcrypt.
-
orionis.hashing.hashers.BcryptHasher.getAlgorithm
orionis.hashing.hashers.BcryptHasher.html#getAlgorithm
Function
Method
PUBLIC
Return the algorithm identifier of this driver.
-
orionis.hashing.hashers.BcryptHasher.setRounds
orionis.hashing.hashers.BcryptHasher.html#setRounds
Function
Method
PUBLIC
Set the default cost factor used by the driver.
-
orionis.hashing.hashers._EXPORTS
orionis.hashing.hashers.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.hashing.hashers.__getattr__
orionis.hashing.hashers.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.hashing.hashers.__dir__
orionis.hashing.hashers.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.hashing.provider.HashProvider
orionis.hashing.provider.HashProvider.html
Class
Class
PUBLIC
Service provider for the Orionis hashing system.
-
orionis.hashing.provider.HashProvider.register
orionis.hashing.provider.HashProvider.html#register
Function
Method
PUBLIC
Bind IHashManager to HashManager as a singleton.
-
orionis.hashing.provider.HashProvider.boot
orionis.hashing.provider.HashProvider.html#boot
Function
Method
PUBLIC
Pin the Hash facade after all services are registered.
-
orionis.view.exceptions.ViewException
orionis.view.exceptions.ViewException.html
Class
Exception
PUBLIC
Base exception for all view-system errors.
-
orionis.view.exceptions.ViewRenderException
orionis.view.exceptions.ViewRenderException.html
Class
Exception
PUBLIC
Raised when a template fails to render.
-
orionis.view.exceptions.ViewTemplateNotFoundException
orionis.view.exceptions.ViewTemplateNotFoundException.html
Class
Exception
PUBLIC
Raised when the requested template file cannot be located.
-
orionis.view.exceptions.ViewRouteException
orionis.view.exceptions.ViewRouteException.html
Class
Exception
PUBLIC
Raised when the route() template global cannot build a URL.
-
orionis.view.pending._LOCALS_QUALNAME
orionis.view.pending.html#_LOCALS_QUALNAME
Attribute
Constant
PUBLIC
Closure qualname noise (e.g. _global_csrf_field.<locals>.) leaked by errors raised inside template globals; irrelevant for the developer.
-
orionis.view.pending.PendingView
orionis.view.pending.PendingView.html
Class
Class
PUBLIC
Represent an awaitable, chainable template rendering result.
-
orionis.view.pending.PendingView.__slots__
orionis.view.pending.PendingView.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.view.pending.PendingView.__init__
orionis.view.pending.PendingView.html#__init__
Function
Method
PUBLIC
Store the rendering intent without performing any work.
-
orionis.view.pending.PendingView._engine
orionis.view.pending.PendingView.html#_engine
Attribute
Instance Variable
PUBLIC
Engine used to render the template once awaited.
-
orionis.view.pending.PendingView._template
orionis.view.pending.PendingView.html#_template
Attribute
Instance Variable
PUBLIC
Template name using dot notation or a relative path.
-
orionis.view.pending.PendingView._context
orionis.view.pending.PendingView.html#_context
Attribute
Instance Variable
PUBLIC
Template variables forwarded to the engine.
-
orionis.view.pending.PendingView._status_code
orionis.view.pending.PendingView.html#_status_code
Attribute
Instance Variable
PUBLIC
Initial HTTP status code, validated when the view is rendered.
-
orionis.view.pending.PendingView._background
orionis.view.pending.PendingView.html#_background
Attribute
Instance Variable
PUBLIC
Initial background task, executed only after response delivery.
-
orionis.view.pending.PendingView._mutations
orionis.view.pending.PendingView.html#_mutations
Attribute
Instance Variable
PUBLIC
Response changes queued while configuring the pending view.
-
orionis.view.pending.PendingView._flash
orionis.view.pending.PendingView.html#_flash
Attribute
Instance Variable
PUBLIC
Session values scheduled for availability during the next request.
-
orionis.view.pending.PendingView.withStatusCode
orionis.view.pending.PendingView.html#withStatusCode
Function
Method
PUBLIC
Queue an HTTP status change and return the pending view.
-
orionis.view.pending.PendingView.withBackground
orionis.view.pending.PendingView.html#withBackground
Function
Method
PUBLIC
Queue a background task change and return the pending view.
-
orionis.view.pending.PendingView.__queueMutation
orionis.view.pending.PendingView.html#__queueMutation
Function
Method
PUBLIC
Retain a response mutation in call order without rendering.
-
orionis.view.pending.PendingView.__getattr__
orionis.view.pending.PendingView.html#__getattr__
Function
Method
PUBLIC
-
orionis.view.pending.PendingView.__await__
orionis.view.pending.PendingView.html#__await__
Function
Method
PUBLIC
Render the template and apply every queued mutation.
-
orionis.view.pending.PendingView.render
orionis.view.pending.PendingView.html#render
Function
Method
PUBLIC
-
orionis.view.pending.PendingView.__flashToSession
orionis.view.pending.PendingView.html#__flashToSession
Function
Method
PUBLIC
Write the queued flash data into the active session.
-
orionis.view.contracts.factory.IViewFactory
orionis.view.contracts.factory.IViewFactory.html
Class
Class
PUBLIC
Contract for the view factory.
-
orionis.view.contracts.factory.IViewFactory.__slots__
orionis.view.contracts.factory.IViewFactory.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.view.contracts.factory.IViewFactory.make
orionis.view.contracts.factory.IViewFactory.html#make
Function
Method
PUBLIC
Prepare a template render as an awaitable, chainable response.
-
orionis.http.ResponseFactory
orionis.http.ResponseFactory.html
Class
Class
PUBLIC
Build every kind of HTTP response from a single entry-point.
-
orionis.http.ResponseFactory.__slots__
orionis.http.ResponseFactory.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.http.ResponseFactory.view
orionis.http.ResponseFactory.html#view
Function
Method
PUBLIC
Render a template as an awaitable, chainable HTML response.
-
orionis.http.ResponseFactory.html
orionis.http.ResponseFactory.html#html
Function
Method
PUBLIC
Build a response carrying raw HTML content.
-
orionis.http.ResponseFactory.json
orionis.http.ResponseFactory.html#json
Function
Method
PUBLIC
Build a response serialising the content as JSON.
-
orionis.http.ResponseFactory.text
orionis.http.ResponseFactory.html#text
Function
Method
PUBLIC
Build a response carrying plain text content.
-
orionis.http.ResponseFactory.redirect
orionis.http.ResponseFactory.html#redirect
Function
Method
PUBLIC
Build a response redirecting the client to another URL.
-
orionis.http.ResponseFactory.stream
orionis.http.ResponseFactory.html#stream
Function
Method
PUBLIC
Build a response streaming byte chunks to the client.
-
orionis.http.ResponseFactory.eventStream
orionis.http.ResponseFactory.html#eventStream
Function
Method
PUBLIC
Build a streaming response carrying UTF-8 server-sent events.
-
orionis.http.ResponseFactory.file
orionis.http.ResponseFactory.html#file
Function
Method
PUBLIC
Build a response streaming a file from disk.
-
orionis.http.ResponseFactory.download
orionis.http.ResponseFactory.html#download
Function
Method
PUBLIC
Build a file response forced to be downloaded as an attachment.
-
orionis.http.ResponseFactory.noContent
orionis.http.ResponseFactory.html#noContent
Function
Method
PUBLIC
Build an empty response, typically for 204 No Content.
-
orionis.http.ResponseFactory.make
orionis.http.ResponseFactory.html#make
Function
Method
PUBLIC
Build a bare response with full control over its content.
-
orionis.http.response
orionis.http.html#response
Attribute
Variable
PUBLIC
Stateless factory shared by every controller; safe to import directly.
-
orionis.http.BaseMiddleware
orionis.http.BaseMiddleware.html
Class
Class
PUBLIC
Base class for HTTP middleware implementations.
-
orionis.http.BaseMiddleware.__slots__
orionis.http.BaseMiddleware.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.http.BaseMiddleware.handle
orionis.http.BaseMiddleware.html#handle
Function
Method
PUBLIC
Process an incoming HTTP request and delegate to next handler.
-
orionis.http.NextCallable
orionis.http.html#NextCallable
Attribute
Type Alias
PUBLIC
No-arg async callable that advances to the next middleware layer.
-
orionis.http.Request
orionis.http.Request.html
Class
Class
PUBLIC
Expose HTTP request metadata, input, authentication and session state.
-
orionis.http.Request.__scope
orionis.http.Request.html#__scope
Attribute
Instance Variable
PUBLIC
Dependency-injection scope associated with the current operation.
-
orionis.http.Request.__adapter
orionis.http.Request.html#__adapter
Attribute
Instance Variable
PUBLIC
Provides the parsed scope dict and header accessor.
-
orionis.http.Request.__interface
orionis.http.Request.html#__interface
Attribute
Instance Variable
PUBLIC
Transport protocol type (ASGI or RSGI).
-
orionis.http.Request.__body_stream
orionis.http.Request.html#__body_stream
Attribute
Instance Variable
PUBLIC
Pre-constructed stream, or None to create it on first body access.
-
orionis.http.Request.__body_limits
orionis.http.Request.html#__body_limits
Attribute
Instance Variable
PUBLIC
Finite request and multipart limits. Defaults to HTTPBodyLimits().
-
orionis.http.Request.__receive_or_protocol
orionis.http.Request.html#__receive_or_protocol
Attribute
Instance Variable
PUBLIC
ASGI receive callable or RSGI protocol used for lazy body creation.
-
orionis.http.Request.__registry
orionis.http.Request.html#__registry
Attribute
Instance Variable
PUBLIC
Content-type parser registry. Defaults to DEFAULT_MEDIA_TYPES.
-
orionis.http.Request.__cached_url
orionis.http.Request.html#__cached_url
Attribute
Instance Variable
PUBLIC
Cached url value, computed on first access.
-
orionis.http.Request.__cached_base_url
orionis.http.Request.html#__cached_base_url
Attribute
Instance Variable
PUBLIC
Cached base url value, computed on first access.
-
orionis.http.Request.__cached_query_params
orionis.http.Request.html#__cached_query_params
Attribute
Instance Variable
PUBLIC
Cached query params value, computed on first access.
-
orionis.http.Request.__cached_cookies
orionis.http.Request.html#__cached_cookies
Attribute
Instance Variable
PUBLIC
Cached cookies value, computed on first access.
-
orionis.http.Request.__cached_ip
orionis.http.Request.html#__cached_ip
Attribute
Instance Variable
PUBLIC
Cached ip value, computed on first access.
-
orionis.http.Request.__cached_port
orionis.http.Request.html#__cached_port
Attribute
Instance Variable
PUBLIC
Cached port value, computed on first access.
-
orionis.http.Request.__cached_method
orionis.http.Request.html#__cached_method
Attribute
Instance Variable
PUBLIC
Cached method value, computed on first access.
-
orionis.http.Request.__cached_scheme
orionis.http.Request.html#__cached_scheme
Attribute
Instance Variable
PUBLIC
Cached scheme value, computed on first access.
-
orionis.http.Request.__cached_http_version
orionis.http.Request.html#__cached_http_version
Attribute
Instance Variable
PUBLIC
Cached http version value, computed on first access.
-
orionis.http.Request.__cached_data
orionis.http.Request.html#__cached_data
Attribute
Instance Variable
PUBLIC
Cached data value, computed on first access.
-
orionis.http.Request.__cached_json
orionis.http.Request.html#__cached_json
Attribute
Instance Variable
PUBLIC
Cached json value, computed on first access.
-
orionis.http.Request.__json_parsed
orionis.http.Request.html#__json_parsed
Attribute
Instance Variable
PUBLIC
Json parsed flag used by Request.
-
orionis.http.Request.__cached_form
orionis.http.Request.html#__cached_form
Attribute
Instance Variable
PUBLIC
Cached form value, computed on first access.
-
orionis.http.Request.__cached_multipart
orionis.http.Request.html#__cached_multipart
Attribute
Instance Variable
PUBLIC
Cached multipart value, computed on first access.
-
orionis.http.Request.__cached_forwarded
orionis.http.Request.html#__cached_forwarded
Attribute
Instance Variable
PUBLIC
Cached forwarded value, computed on first access.
-
orionis.http.Request.__cached_content_type
orionis.http.Request.html#__cached_content_type
Attribute
Instance Variable
PUBLIC
Cached content type value, computed on first access.
-
orionis.http.Request.__cached_path
orionis.http.Request.html#__cached_path
Attribute
Instance Variable
PUBLIC
Cached path value, computed on first access.
-
orionis.http.Request.__cached_accept_lower
orionis.http.Request.html#__cached_accept_lower
Attribute
Instance Variable
PUBLIC
Cached accept lower value, computed on first access.
-
orionis.http.Request.__path_params
orionis.http.Request.html#__path_params
Attribute
Instance Variable
PUBLIC
Values extracted from the matched route path.
-
orionis.http.Request.__state
orionis.http.Request.html#__state
Attribute
Instance Variable
PUBLIC
State selected by the maintenance-mode command.
-
orionis.http.Request.__slots__
orionis.http.Request.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.http.Request.__init__
orionis.http.Request.html#__init__
Function
Method
PUBLIC
Initialize an HTTP request from an interface, adapter, and body stream.
-
orionis.http.Request.__getScope
orionis.http.Request.html#__getScope
Function
Method
PUBLIC
Materialize the transport scope on its first access.
-
orionis.http.Request.__getBodyStream
orionis.http.Request.html#__getBodyStream
Function
Method
PUBLIC
Create the body reader when the request consumes its body.
-
orionis.http.Request.__buildUrlRSGI
orionis.http.Request.html#__buildUrlRSGI
Function
Method
PUBLIC
Build the full URL from an RSGI scope.
-
orionis.http.Request.__buildUrlASGI
orionis.http.Request.html#__buildUrlASGI
Function
Method
PUBLIC
Build the full URL from an ASGI scope.
-
orionis.http.Request.__buildBaseUrlRSGI
orionis.http.Request.html#__buildBaseUrlRSGI
Function
Method
PUBLIC
Build the base URL from an RSGI scope.
-
orionis.http.Request.__buildBaseUrlASGI
orionis.http.Request.html#__buildBaseUrlASGI
Function
Method
PUBLIC
Build the base URL from an ASGI scope.
-
orionis.http.Request.__contentType
orionis.http.Request.html#__contentType
Function
Method
PUBLIC
Parse and cache the request Content-Type header.
-
orionis.http.Request.__getAcceptLower
orionis.http.Request.html#__getAcceptLower
Function
Method
PUBLIC
Cache and return the lowercased request Accept header.
-
orionis.http.Request.__parseDataJson
orionis.http.Request.html#__parseDataJson
Function
Method
PUBLIC
Parse JSON body for data() and populate the JSON cache.
-
orionis.http.Request.__parseDataUrlencoded
orionis.http.Request.html#__parseDataUrlencoded
Function
Method
PUBLIC
Parse URL-encoded body for data() with multi-value support.
-
orionis.http.Request.__parseDataMultipart
orionis.http.Request.html#__parseDataMultipart
Function
Method
PUBLIC
Parse multipart body for data() in a single pass.
-
orionis.http.Request.__parseDataMsgpack
orionis.http.Request.html#__parseDataMsgpack
Function
Method
PUBLIC
Parse MessagePack body for data().
-
orionis.http.Request.method
orionis.http.Request.html#method
Attribute
Property
PUBLIC
Return the HTTP request method.
-
orionis.http.Request.scheme
orionis.http.Request.html#scheme
Attribute
Property
PUBLIC
Return the URL scheme (e.g., 'http' or 'https') of the request.
-
orionis.http.Request.path
orionis.http.Request.html#path
Attribute
Property
PUBLIC
Return the request path.
-
orionis.http.Request.httpVersion
orionis.http.Request.html#httpVersion
Attribute
Property
PUBLIC
Return the HTTP version of the request.
-
orionis.http.Request.interface
orionis.http.Request.html#interface
Attribute
Property
PUBLIC
Return the interface type of the request (ASGI or RSGI).
-
orionis.http.Request.url
orionis.http.Request.html#url
Attribute
Property
PUBLIC
Return the full request URL.
-
orionis.http.Request.baseUrl
orionis.http.Request.html#baseUrl
Attribute
Property
PUBLIC
Return the base URL (scheme and host) for the request.
-
orionis.http.Request.queryParams
orionis.http.Request.html#queryParams
Attribute
Property
PUBLIC
Return parsed query parameters from the request URL.
-
orionis.http.Request.cookies
orionis.http.Request.html#cookies
Attribute
Property
PUBLIC
Return parsed cookies from the request.
-
orionis.http.Request.ip
orionis.http.Request.html#ip
Attribute
Property
PUBLIC
Return the client's IP address from the request scope.
-
orionis.http.Request.port
orionis.http.Request.html#port
Attribute
Property
PUBLIC
Return the client's port number from the request scope.
-
orionis.http.Request.forwarded
orionis.http.Request.html#forwarded
Attribute
Property
PUBLIC
Return the forwarded information from the request scope.
-
orionis.http.Request.userAgent
orionis.http.Request.html#userAgent
Attribute
Property
PUBLIC
Return the User-Agent string from the request headers.
-
orionis.http.Request.authorization
orionis.http.Request.html#authorization
Attribute
Property
PUBLIC
Return the Authorization header value if present.
-
orionis.http.Request.bearerToken
orionis.http.Request.html#bearerToken
Attribute
Property
PUBLIC
Extract a bearer credential from one unambiguous Authorization header.
-
orionis.http.Request.apiKey
orionis.http.Request.html#apiKey
Attribute
Property
PUBLIC
Return the API key from the request headers if present.
-
orionis.http.Request.accept
orionis.http.Request.html#accept
Attribute
Property
PUBLIC
Return the value of the Accept header.
-
orionis.http.Request.state
orionis.http.Request.html#state
Attribute
Property
PUBLIC
Return the mutable request state namespace.
-
orionis.http.Request.scope
orionis.http.Request.html#scope
Attribute
Property
PUBLIC
Return the raw ASGI / RSGI connection scope.
-
orionis.http.Request.stream
orionis.http.Request.html#stream
Function
Method
PUBLIC
Yield chunks of the request body as they arrive.
-
orionis.http.Request.body
orionis.http.Request.html#body
Function
Method
PUBLIC
Return the full request body as bytes.
-
orionis.http.Request.raw
orionis.http.Request.html#raw
Function
Method
PUBLIC
Return the request body as raw bytes.
-
orionis.http.Request.text
orionis.http.Request.html#text
Function
Method
PUBLIC
Decode the request body as UTF-8 text.
-
orionis.http.Request.json
orionis.http.Request.html#json
Function
Method
PUBLIC
Parse the request body as JSON.
-
orionis.http.Request.xml
orionis.http.Request.html#xml
Function
Method
PUBLIC
Parse the request body as XML.
-
orionis.http.Request.msgpack
orionis.http.Request.html#msgpack
Function
Method
PUBLIC
Decode the request body as MessagePack.
-
orionis.http.Request.formUrlEncoded
orionis.http.Request.html#formUrlEncoded
Function
Method
PUBLIC
Parse application/x-www-form-urlencoded body.
-
orionis.http.Request.form
orionis.http.Request.html#form
Function
Method
PUBLIC
Parse multipart/form-data using a streaming parser.
-
orionis.http.Request.close
orionis.http.Request.html#close
Function
Method
PUBLIC
Close uploaded files retained by the parsed multipart request.
-
orionis.http.Request.payload
orionis.http.Request.html#payload
Function
Method
PUBLIC
Parse and return structured data according to Content-Type.
-
orionis.http.Request.data
orionis.http.Request.html#data
Function
Method
PUBLIC
Return a flat dictionary parsed from the request body.
-
orionis.http.Request.wantsJson
orionis.http.Request.html#wantsJson
Function
Method
PUBLIC
Determine if the client prefers a JSON response based on the Accept header.
-
orionis.http.Request.wantsHtml
orionis.http.Request.html#wantsHtml
Function
Method
PUBLIC
Determine if the client expects an HTML response based on the Accept header.
-
orionis.http.Request.wantsXml
orionis.http.Request.html#wantsXml
Function
Method
PUBLIC
Determine if the client prefers an XML response based on the Accept header.
-
orionis.http.Request.accepts
orionis.http.Request.html#accepts
Function
Method
PUBLIC
Check if the client accepts a specific MIME type.
-
orionis.http.Request.isAjax
orionis.http.Request.html#isAjax
Function
Method
PUBLIC
Determine if the request was made via AJAX.
-
orionis.http.Request.routeParam
orionis.http.Request.html#routeParam
Function
Method
PUBLIC
Return a specific path parameter by key.
-
orionis.http.Request.routeParams
orionis.http.Request.html#routeParams
Function
Method
PUBLIC
Return all path parameters as a dictionary.
-
orionis.http.Request.csrfToken
orionis.http.Request.html#csrfToken
Function
Method
PUBLIC
Return the CSRF token for the current request.
-
orionis.http.Request.csrf_token
orionis.http.Request.html#csrf_token
Attribute
Class Variable
PUBLIC
Template-facing attribute shares the camelCase implementation.
-
orionis.http.EventStreamResponse
orionis.http.EventStreamResponse.html
Class
Class
PUBLIC
Stream typed server-sent events through the existing response transport.
-
orionis.http.EventStreamResponse.__slots__
orionis.http.EventStreamResponse.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.http.EventStreamResponse.__init__
orionis.http.EventStreamResponse.html#__init__
Function
Method
PUBLIC
Initialize a lazy UTF-8 event stream with SSE response headers.
-
orionis.http.EventStreamResponse.getStream
orionis.http.EventStreamResponse.html#getStream
Function
Method
PUBLIC
Return the owned byte iterator without starting its event source.
-
orionis.http.FileResponse
orionis.http.FileResponse.html
Class
Class
PUBLIC
Serve a filesystem resource through an HTTP response.
-
orionis.http.FileResponse.__slots__
orionis.http.FileResponse.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.http.FileResponse.__init__
orionis.http.FileResponse.html#__init__
Function
Method
PUBLIC
Initialize a file streaming response.
-
orionis.http.FileResponse._path
orionis.http.FileResponse.html#_path
Attribute
Instance Variable
PUBLIC
Path to the file to serve.
-
orionis.http.FileResponse._chunk_size
orionis.http.FileResponse.html#_chunk_size
Attribute
Instance Variable
PUBLIC
Size of file chunks to read and send.
-
orionis.http.FileResponse._file_size
orionis.http.FileResponse.html#_file_size
Attribute
Instance Variable
PUBLIC
Advertise the file size recorded during validation.
-
orionis.http.FileResponse.getPath
orionis.http.FileResponse.html#getPath
Function
Method
PUBLIC
Return the file path.
-
orionis.http.FileResponse.getFileSize
orionis.http.FileResponse.html#getFileSize
Function
Method
PUBLIC
Return the file size in bytes.
-
orionis.http.FileResponse._fileIterator
orionis.http.FileResponse.html#_fileIterator
Function
Method
PUBLIC
Yield file content in chunks asynchronously.
-
orionis.http.HTMLResponse
orionis.http.HTMLResponse.html
Class
Class
PUBLIC
Render an HTML response with the corresponding content type.
-
orionis.http.HTMLResponse.__slots__
orionis.http.HTMLResponse.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.http.HTMLResponse._CONTENT_TYPE
orionis.http.HTMLResponse.html#_CONTENT_TYPE
Attribute
Constant
PUBLIC
Content type advertised by this response.
-
orionis.http.HTMLResponse.__init__
orionis.http.HTMLResponse.html#__init__
Function
Method
PUBLIC
Initialize an HTMLResponse with HTML content.
-
orionis.http.JSONResponse
orionis.http.JSONResponse.html
Class
Class
PUBLIC
Encode a JSON response while preserving response metadata.
-
orionis.http.JSONResponse.__slots__
orionis.http.JSONResponse.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.http.JSONResponse._CONTENT_TYPE
orionis.http.JSONResponse.html#_CONTENT_TYPE
Attribute
Constant
PUBLIC
Content type advertised by this response.
-
orionis.http.JSONResponse.__init__
orionis.http.JSONResponse.html#__init__
Function
Method
PUBLIC
Initialize a JSONResponse with serialized JSON content.
-
orionis.http.JSONResponse._json_indent
orionis.http.JSONResponse.html#_json_indent
Attribute
Instance Variable
PUBLIC
Indentation level for pretty-printing JSON.
-
orionis.http.JSONResponse._json_ensure_ascii
orionis.http.JSONResponse.html#_json_ensure_ascii
Attribute
Instance Variable
PUBLIC
Whether to escape non-ASCII characters.
-
orionis.http.JSONResponse._json_separators
orionis.http.JSONResponse.html#_json_separators
Attribute
Instance Variable
PUBLIC
Item and key separators for JSON output.
-
orionis.http.JSONResponse._json_default
orionis.http.JSONResponse.html#_json_default
Attribute
Instance Variable
PUBLIC
Select the custom encoder or the default type handler.
-
orionis.http.JSONResponse.render
orionis.http.JSONResponse.html#render
Function
Method
PUBLIC
Serialize content to JSON bytes.
-
orionis.http.JSONResponse._defaultEncoder
orionis.http.JSONResponse.html#_defaultEncoder
Function
Static Method
PUBLIC
Encode unsupported types for JSON serialization.
-
orionis.http.PlainTextResponse
orionis.http.PlainTextResponse.html
Class
Class
PUBLIC
Return a plain-text HTTP response.
-
orionis.http.PlainTextResponse.__slots__
orionis.http.PlainTextResponse.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.http.PlainTextResponse._CONTENT_TYPE
orionis.http.PlainTextResponse.html#_CONTENT_TYPE
Attribute
Constant
PUBLIC
Content type advertised by this response.
-
orionis.http.PlainTextResponse.__init__
orionis.http.PlainTextResponse.html#__init__
Function
Method
PUBLIC
Initialize a plain text response.
-
orionis.http.RedirectResponse
orionis.http.RedirectResponse.html
Class
Class
PUBLIC
Return an HTTP redirect to the configured location.
-
orionis.http.RedirectResponse.__slots__
orionis.http.RedirectResponse.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.http.RedirectResponse._CONTENT_TYPE
orionis.http.RedirectResponse.html#_CONTENT_TYPE
Attribute
Constant
PUBLIC
Content type advertised by this response.
-
orionis.http.RedirectResponse.__init__
orionis.http.RedirectResponse.html#__init__
Function
Method
PUBLIC
Initialize a redirect response.
-
orionis.http.RedirectResponse.withStatusCode
orionis.http.RedirectResponse.html#withStatusCode
Function
Method
PUBLIC
Set a redirect status code and return the response.
-
orionis.http.Response
orionis.http.Response.html
Class
Class
PUBLIC
Represent an HTTP response with status, headers, cookies and body.
-
orionis.http.Response.__slots__
orionis.http.Response.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.http.Response.charset
orionis.http.Response.html#charset
Attribute
Class Variable
PUBLIC
Encode text responses using UTF-8.
-
orionis.http.Response.__init__
orionis.http.Response.html#__init__
Function
Method
PUBLIC
Initialize the BaseResponse object.
-
orionis.http.Response.status_code
orionis.http.Response.html#status_code
Attribute
Instance Variable
PUBLIC
The HTTP status code for the response.
-
orionis.http.Response.media_type
orionis.http.Response.html#media_type
Attribute
Instance Variable
PUBLIC
The media type of the response.
-
orionis.http.Response._body
orionis.http.Response.html#_body
Attribute
Instance Variable
PUBLIC
HTTP response body or encoded payload returned to the client.
-
orionis.http.Response._stream
orionis.http.Response.html#_stream
Attribute
Instance Variable
PUBLIC
Iterator supplying response body chunks.
-
orionis.http.Response._flash
orionis.http.Response.html#_flash
Attribute
Instance Variable
PUBLIC
Initialize flash data when it is first queued.
-
orionis.http.Response.background
orionis.http.Response.html#background
Attribute
Instance Variable
PUBLIC
The background task to run after response.
-
orionis.http.Response.withStatusCode
orionis.http.Response.html#withStatusCode
Function
Method
PUBLIC
Set the HTTP status code and return the response.
-
orionis.http.Response.withBackground
orionis.http.Response.html#withBackground
Function
Method
PUBLIC
Set the background task and return the response.
-
orionis.http.Response.render
orionis.http.Response.html#render
Function
Method
PUBLIC
Render the content to bytes.
-
orionis.http.Response.setCookie
orionis.http.Response.html#setCookie
Function
Method
PUBLIC
Set a cookie header in the response.
-
orionis.http.Response.deleteCookie
orionis.http.Response.html#deleteCookie
Function
Method
PUBLIC
Delete a cookie by setting its expiration to the past.
-
orionis.http.Response.withCookie
orionis.http.Response.html#withCookie
Function
Method
PUBLIC
Attach a cookie and return the response for chaining.
-
orionis.http.Response.withCookies
orionis.http.Response.html#withCookies
Function
Method
PUBLIC
Attach several cookies at once and return the response.
-
orionis.http.Response.withoutCookie
orionis.http.Response.html#withoutCookie
Function
Method
PUBLIC
Expire a cookie and return the response for chaining.
-
orionis.http.Response.getFlashData
orionis.http.Response.html#getFlashData
Function
Method
PUBLIC
Return the data queued by withFlash() for the session flash bag.
-
orionis.http.Response.getBody
orionis.http.Response.html#getBody
Function
Method
PUBLIC
Return the response body as bytes.
-
orionis.http.Response.getStream
orionis.http.Response.html#getStream
Function
Method
PUBLIC
Return the response stream if present.
-
orionis.http.Response.hasStream
orionis.http.Response.html#hasStream
Function
Method
PUBLIC
Check if the response has a stream.
-
orionis.http.Response.runBackground
orionis.http.Response.html#runBackground
Function
Method
PUBLIC
Run the background task if it exists.
-
orionis.http.Response.getStatusCode
orionis.http.Response.html#getStatusCode
Function
Method
PUBLIC
Return the HTTP status code of the response.
-
orionis.http.Response.getMediaType
orionis.http.Response.html#getMediaType
Function
Method
PUBLIC
Return the media type of the response.
-
orionis.http.ResponseTemplate
orionis.http.ResponseTemplate.html
Class
Class
PUBLIC
Store validated immutable content for independent response instances.
-
orionis.http.ResponseTemplate.status_code
orionis.http.ResponseTemplate.html#status_code
Attribute
Class Variable
PUBLIC
Valid HTTP response status.
-
orionis.http.ResponseTemplate.media_type
orionis.http.ResponseTemplate.html#media_type
Attribute
Class Variable
PUBLIC
Media type metadata copied to each response.
-
orionis.http.ResponseTemplate.body
orionis.http.ResponseTemplate.html#body
Attribute
Class Variable
PUBLIC
HTTP response body or encoded payload returned to the client.
-
orionis.http.ResponseTemplate.__init__
orionis.http.ResponseTemplate.html#__init__
Function
Method
PUBLIC
Validate and snapshot constant response content and headers.
-
orionis.http.ResponseTemplate.make
orionis.http.ResponseTemplate.html#make
Function
Method
PUBLIC
Create a response with independent headers, cookies, and background.
-
orionis.http.StreamingResponse
orionis.http.StreamingResponse.html
Class
Class
PUBLIC
Stream response chunks without buffering the complete body.
-
orionis.http.StreamingResponse.__slots__
orionis.http.StreamingResponse.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.http.StreamingResponse.__init__
orionis.http.StreamingResponse.html#__init__
Function
Method
PUBLIC
Initialize a streaming response.
-
orionis.http.StreamingResponse._body
orionis.http.StreamingResponse.html#_body
Attribute
Instance Variable
PUBLIC
HTTP response body or encoded payload returned to the client.
-
orionis.http.StreamingResponse._wrapSyncIterable
orionis.http.StreamingResponse.html#_wrapSyncIterable
Function
Method
PUBLIC
Adapt a synchronous iterable of bytes to an asynchronous iterable.
-
orionis.http.ServerSentEvent
orionis.http.ServerSentEvent.html
Class
Class
PUBLIC
Represent one immutable UTF-8 server-sent event.
-
orionis.http.ServerSentEvent.data
orionis.http.ServerSentEvent.html#data
Attribute
Instance Variable
PUBLIC
Text payload; serialize structured values explicitly before passing them.
-
orionis.http.ServerSentEvent.event
orionis.http.ServerSentEvent.html#event
Attribute
Instance Variable
PUBLIC
Single-line event name.
-
orionis.http.ServerSentEvent.id
orionis.http.ServerSentEvent.html#id
Attribute
Instance Variable
PUBLIC
Single-line cursor without NUL characters.
-
orionis.http.ServerSentEvent.retry
orionis.http.ServerSentEvent.html#retry
Attribute
Instance Variable
PUBLIC
Non-negative reconnection delay in milliseconds; booleans are rejected.
-
orionis.http.ServerSentEvent.__post_init__
orionis.http.ServerSentEvent.html#__post_init__
Function
Method
PUBLIC
Validate field types and prevent single-line field injection.
-
orionis.http.ServerSentEvent._validateRetry
orionis.http.ServerSentEvent.html#_validateRetry
Function
Method
PUBLIC
Require a nonnegative integer for an explicitly supplied retry delay.
-
orionis.http.ServerSentEvent.encode
orionis.http.ServerSentEvent.html#encode
Function
Method
PUBLIC
Encode the event as UTF-8 fields followed by one empty line.
-
orionis.http.HttpResponse
orionis.http.html#HttpResponse
Attribute
Type Alias
PUBLIC
Every object built by the response factory derives from Response, so this single alias annotates any handler regardless of its content type.
-
orionis.http.WebSocket
orionis.http.WebSocket.html
Class
Class
PUBLIC
Own one server-independent connection with direct awaited messaging.
-
orionis.http.WebSocket.__slots__
orionis.http.WebSocket.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.http.WebSocket.__init__
orionis.http.WebSocket.html#__init__
Function
Method
PUBLIC
Bind a normalized transport and connection metadata.
-
orionis.http.WebSocket._transport
orionis.http.WebSocket.html#_transport
Attribute
Instance Variable
PUBLIC
Server adapter implementing awaited network operations.
-
orionis.http.WebSocket._adapter
orionis.http.WebSocket.html#_adapter
Attribute
Instance Variable
PUBLIC
Handshake metadata, including normalized proxy information.
-
orionis.http.WebSocket._params
orionis.http.WebSocket.html#_params
Attribute
Instance Variable
PUBLIC
Converted route parameters owned by this connection.
-
orionis.http.WebSocket._max_message_size
orionis.http.WebSocket.html#_max_message_size
Attribute
Instance Variable
PUBLIC
Positive maximum incoming message size in bytes.
-
orionis.http.WebSocket._connection_state
orionis.http.WebSocket.html#_connection_state
Attribute
Instance Variable
PUBLIC
Connection state obtained from WebSocketState.CONNECTING.
-
orionis.http.WebSocket._accepted
orionis.http.WebSocket.html#_accepted
Attribute
Instance Variable
PUBLIC
Accepted flag used by WebSocket.
-
orionis.http.WebSocket._close_code
orionis.http.WebSocket.html#_close_code
Attribute
Instance Variable
PUBLIC
Close code produced by int.
-
orionis.http.WebSocket._close_reason
orionis.http.WebSocket.html#_close_reason
Attribute
Instance Variable
PUBLIC
''.
-
orionis.http.WebSocket._send_lock
orionis.http.WebSocket.html#_send_lock
Attribute
Instance Variable
PUBLIC
Synchronization primitive controlling access to send lock.
-
orionis.http.WebSocket._receive_lock
orionis.http.WebSocket.html#_receive_lock
Attribute
Instance Variable
PUBLIC
Synchronization primitive controlling access to receive lock.
-
orionis.http.WebSocket._state
orionis.http.WebSocket.html#_state
Attribute
Instance Variable
PUBLIC
State selected by the maintenance-mode command.
-
orionis.http.WebSocket.path
orionis.http.WebSocket.html#path
Attribute
Property
PUBLIC
Return the handshake path.
-
orionis.http.WebSocket.state
orionis.http.WebSocket.html#state
Attribute
Property
PUBLIC
Return connection-local application state.
-
orionis.http.WebSocket.connectionState
orionis.http.WebSocket.html#connectionState
Attribute
Property
PUBLIC
Return the explicit lifecycle state.
-
orionis.http.WebSocket.accepted
orionis.http.WebSocket.html#accepted
Attribute
Property
PUBLIC
Report completed or interrupted acceptance.
-
orionis.http.WebSocket.closed
orionis.http.WebSocket.html#closed
Attribute
Property
PUBLIC
Report terminal connection closure.
-
orionis.http.WebSocket.supportsCloseDetails
orionis.http.WebSocket.html#supportsCloseDetails
Attribute
Property
PUBLIC
Report support for custom wire close details.
-
orionis.http.WebSocket.routeParams
orionis.http.WebSocket.html#routeParams
Function
Method
PUBLIC
Return mutable connection-local route parameters.
-
orionis.http.WebSocket.accept
orionis.http.WebSocket.html#accept
Function
Method
PUBLIC
Accept the pending handshake exactly once.
-
orionis.http.WebSocket._disconnected
orionis.http.WebSocket.html#_disconnected
Function
Method
PUBLIC
Retain terminal metadata for later operation failures.
-
orionis.http.WebSocket._requireOpen
orionis.http.WebSocket.html#_requireOpen
Function
Method
PUBLIC
Reject messaging outside the connected lifecycle state.
-
orionis.http.WebSocket.receive
orionis.http.WebSocket.html#receive
Function
Method
PUBLIC
Receive one immutable data or disconnect message.
-
orionis.http.WebSocket._receiveData
orionis.http.WebSocket.html#_receiveData
Function
Method
PUBLIC
Receive data while translating disconnects to exceptions.
-
orionis.http.WebSocket.receiveText
orionis.http.WebSocket.html#receiveText
Function
Method
PUBLIC
Receive one text payload.
-
orionis.http.WebSocket.receiveBytes
orionis.http.WebSocket.html#receiveBytes
Function
Method
PUBLIC
Receive one binary payload.
-
orionis.http.WebSocket.receiveJson
orionis.http.WebSocket.html#receiveJson
Function
Method
PUBLIC
Decode the next text or binary JSON message with msgspec.
-
orionis.http.WebSocket.send
orionis.http.WebSocket.html#send
Function
Method
PUBLIC
Send text or bytes through a serialized, awaited transport write.
-
orionis.http.WebSocket.sendText
orionis.http.WebSocket.html#sendText
Function
Method
PUBLIC
Send one text message with natural backpressure.
-
orionis.http.WebSocket.sendBytes
orionis.http.WebSocket.html#sendBytes
Function
Method
PUBLIC
Send one binary message without copying the payload.
-
orionis.http.WebSocket.sendJson
orionis.http.WebSocket.html#sendJson
Function
Method
PUBLIC
Encode a JSON value and send one UTF-8 text message.
-
orionis.http.WebSocket.reject
orionis.http.WebSocket.html#reject
Function
Method
PUBLIC
Reject the pending handshake once.
-
orionis.http.WebSocket.close
orionis.http.WebSocket.html#close
Function
Method
PUBLIC
Close an accepted connection or reject a pending handshake once.
-
orionis.http.WebSocket.__aiter__
orionis.http.WebSocket.html#__aiter__
Function
Method
PUBLIC
Iterate data messages until the peer disconnects.
-
orionis.http.WebSocket.__anext__
orionis.http.WebSocket.html#__anext__
Function
Method
PUBLIC
Receive the next application message for asynchronous iteration.
-
orionis.http.WebSocketDisconnected
orionis.http.WebSocketDisconnected.html
Class
Exception
PUBLIC
Report a terminal connection failure with available close details.
-
orionis.http.WebSocketDisconnected.__init__
orionis.http.WebSocketDisconnected.html#__init__
Function
Method
PUBLIC
Store the observed close details.
-
orionis.http.WebSocketDisconnected.code
orionis.http.WebSocketDisconnected.html#code
Attribute
Instance Variable
PUBLIC
Close code, or abnormal closure when unavailable.
-
orionis.http.WebSocketDisconnected.reason
orionis.http.WebSocketDisconnected.html#reason
Attribute
Instance Variable
PUBLIC
Peer or locally generated close reason.
-
orionis.http.WebSocketMessage
orionis.http.WebSocketMessage.html
Class
Class
PUBLIC
Retain an immutable message without copying its payload.
-
orionis.http.WebSocketMessage.type
orionis.http.WebSocketMessage.html#type
Attribute
Class Variable
PUBLIC
Discriminator identifying the message or schema variant.
-
orionis.http.WebSocketMessage.data
orionis.http.WebSocketMessage.html#data
Attribute
Class Variable
PUBLIC
Decoded content carried by this message or request.
-
orionis.http.WebSocketMessage.code
orionis.http.WebSocketMessage.html#code
Attribute
Class Variable
PUBLIC
Machine-readable status or error code.
-
orionis.http.WebSocketMessage.reason
orionis.http.WebSocketMessage.html#reason
Attribute
Class Variable
PUBLIC
Human-readable reason associated with connection closure.
-
orionis.http.WebSocketMessage.isText
orionis.http.WebSocketMessage.html#isText
Function
Method
PUBLIC
Identify text data.
-
orionis.http.WebSocketMessage.isBytes
orionis.http.WebSocketMessage.html#isBytes
Function
Method
PUBLIC
Identify binary data.
-
orionis.http.WebSocketMessage.isDisconnect
orionis.http.WebSocketMessage.html#isDisconnect
Function
Method
PUBLIC
Identify the terminal peer event.
-
orionis.http.WebSocketMessage.text
orionis.http.WebSocketMessage.html#text
Attribute
Property
PUBLIC
Return the original text payload.
-
orionis.http.WebSocketMessage.bytes
orionis.http.WebSocketMessage.html#bytes
Attribute
Property
PUBLIC
Return the original binary payload.
-
orionis.http.WebSocketMessageType
orionis.http.WebSocketMessageType.html
Class
Class
PUBLIC
Identify a normalized complete WebSocket message.
-
orionis.http.WebSocketMessageType.TEXT
orionis.http.WebSocketMessageType.html#TEXT
Attribute
Constant
PUBLIC
text.
-
orionis.http.WebSocketMessageType.BYTES
orionis.http.WebSocketMessageType.html#BYTES
Attribute
Constant
PUBLIC
bytes.
-
orionis.http.WebSocketMessageType.DISCONNECT
orionis.http.WebSocketMessageType.html#DISCONNECT
Attribute
Constant
PUBLIC
disconnect.
-
orionis.http.WebSocketState
orionis.http.WebSocketState.html
Class
Class
PUBLIC
Describe the connection lifecycle independently of its server.
-
orionis.http.WebSocketState.CONNECTING
orionis.http.WebSocketState.html#CONNECTING
Attribute
Constant
PUBLIC
connecting.
-
orionis.http.WebSocketState.CONNECTED
orionis.http.WebSocketState.html#CONNECTED
Attribute
Constant
PUBLIC
connected.
-
orionis.http.WebSocketState.CLOSING
orionis.http.WebSocketState.html#CLOSING
Attribute
Constant
PUBLIC
closing.
-
orionis.http.WebSocketState.CLOSED
orionis.http.WebSocketState.html#CLOSED
Attribute
Constant
PUBLIC
closed.
-
orionis.http.WebSocketMiddleware
orionis.http.WebSocketMiddleware.html
Class
Class
PUBLIC
Define a connection middleware resolved inside each WebSocket scope.
-
orionis.http.WebSocketMiddleware.__slots__
orionis.http.WebSocketMiddleware.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.http.WebSocketMiddleware.handle
orionis.http.WebSocketMiddleware.html#handle
Function
Method
PUBLIC
Inspect the handshake or wrap the connection handler.
-
orionis.http.WebSocketNext
orionis.http.html#WebSocketNext
Attribute
Type Alias
PUBLIC
Type alias for Callable[[], Awaitable[None]].
-
orionis.http._WEBSOCKET_MESSAGE_MODULE
orionis.http.html#_WEBSOCKET_MESSAGE_MODULE
Attribute
Constant
PUBLIC
Module path used to resolve the public WebSocket message exports.
-
orionis.http._EXPORTS
orionis.http.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.http.__getattr__
orionis.http.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.http.__dir__
orionis.http.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.http.adapters.request.asgi._MISSING
orionis.http.adapters.request.asgi.html#_MISSING
Attribute
Constant
PUBLIC
Sentinel that marks per-request lazy fields as "not yet resolved".
-
orionis.http.adapters.request.asgi.ASGITransportAdapter
orionis.http.adapters.request.asgi.ASGITransportAdapter.html
Class
Class
PUBLIC
Adapt an ASGI scope dictionary to the transport adapter contract.
-
orionis.http.adapters.request.asgi.ASGITransportAdapter.__slots__
orionis.http.adapters.request.asgi.ASGITransportAdapter.html#__slots__
Attribute
Class Variable
PUBLIC
Store scope data, request state, and resolved fields.
-
orionis.http.adapters.request.asgi.ASGITransportAdapter.__init__
orionis.http.adapters.request.asgi.ASGITransportAdapter.html#__init__
Function
Method
PUBLIC
Initialize the adapter with an ASGI scope dictionary.
-
orionis.http.adapters.request.asgi.ASGITransportAdapter.__scope
orionis.http.adapters.request.asgi.ASGITransportAdapter.html#__scope
Attribute
Instance Variable
PUBLIC
Provide the ASGI scope mapping.
-
orionis.http.adapters.request.asgi.ASGITransportAdapter.__overrides
orionis.http.adapters.request.asgi.ASGITransportAdapter.html#__overrides
Attribute
Instance Variable
PUBLIC
Keep all overrides and computed fields in one dictionary.
-
orionis.http.adapters.request.asgi.ASGITransportAdapter.__client
orionis.http.adapters.request.asgi.ASGITransportAdapter.html#__client
Attribute
Instance Variable
PUBLIC
Mark fields to be resolved on their first access.
-
orionis.http.adapters.request.asgi.ASGITransportAdapter.__wants_json
orionis.http.adapters.request.asgi.ASGITransportAdapter.html#__wants_json
Attribute
Instance Variable
PUBLIC
Wants json supplied through _MISSING.
-
orionis.http.adapters.request.asgi.ASGITransportAdapter.__getitem__
orionis.http.adapters.request.asgi.ASGITransportAdapter.html#__getitem__
Function
Method
PUBLIC
Get a cached override value by key.
-
orionis.http.adapters.request.asgi.ASGITransportAdapter.__setitem__
orionis.http.adapters.request.asgi.ASGITransportAdapter.html#__setitem__
Function
Method
PUBLIC
Set a cached override value by key.
-
orionis.http.adapters.request.asgi.ASGITransportAdapter.__contains__
orionis.http.adapters.request.asgi.ASGITransportAdapter.html#__contains__
Function
Method
PUBLIC
Check whether an override key exists.
-
orionis.http.adapters.request.asgi.ASGITransportAdapter.__delitem__
orionis.http.adapters.request.asgi.ASGITransportAdapter.html#__delitem__
Function
Method
PUBLIC
Delete an override value by key.
-
orionis.http.adapters.request.asgi.ASGITransportAdapter.client
orionis.http.adapters.request.asgi.ASGITransportAdapter.html#client
Function
Method
PUBLIC
Get the remote client IP from the ASGI scope.
-
orionis.http.adapters.request.asgi.ASGITransportAdapter.setClient
orionis.http.adapters.request.asgi.ASGITransportAdapter.html#setClient
Function
Method
PUBLIC
Set the remote client address.
-
orionis.http.adapters.request.asgi.ASGITransportAdapter.scheme
orionis.http.adapters.request.asgi.ASGITransportAdapter.html#scheme
Function
Method
PUBLIC
Get the URL scheme.
-
orionis.http.adapters.request.asgi.ASGITransportAdapter.setScheme
orionis.http.adapters.request.asgi.ASGITransportAdapter.html#setScheme
Function
Method
PUBLIC
Set the URL scheme.
-
orionis.http.adapters.request.asgi.ASGITransportAdapter.method
orionis.http.adapters.request.asgi.ASGITransportAdapter.html#method
Function
Method
PUBLIC
Get the HTTP method.
-
orionis.http.adapters.request.asgi.ASGITransportAdapter.path
orionis.http.adapters.request.asgi.ASGITransportAdapter.html#path
Function
Method
PUBLIC
Get the request path.
-
orionis.http.adapters.request.asgi.ASGITransportAdapter.setState
orionis.http.adapters.request.asgi.ASGITransportAdapter.html#setState
Function
Method
PUBLIC
Set an arbitrary override state value.
-
orionis.http.adapters.request.asgi.ASGITransportAdapter.wantsJson
orionis.http.adapters.request.asgi.ASGITransportAdapter.html#wantsJson
Function
Method
PUBLIC
Determine whether the client prefers JSON.
-
orionis.http.adapters.request.asgi.ASGITransportAdapter.getScope
orionis.http.adapters.request.asgi.ASGITransportAdapter.html#getScope
Function
Method
PUBLIC
Get the adjusted ASGI scope dictionary.
-
orionis.http.adapters.request.rsgi._MISSING
orionis.http.adapters.request.rsgi.html#_MISSING
Attribute
Constant
PUBLIC
Sentinel that marks per-request lazy fields as "not yet resolved".
-
orionis.http.adapters.request.rsgi.RSGITransportAdapter
orionis.http.adapters.request.rsgi.RSGITransportAdapter.html
Class
Class
PUBLIC
Adapt a Granian RSGI scope to the transport adapter contract.
-
orionis.http.adapters.request.rsgi.RSGITransportAdapter.__slots__
orionis.http.adapters.request.rsgi.RSGITransportAdapter.html#__slots__
Attribute
Class Variable
PUBLIC
Store scope data, request state, and resolved fields.
-
orionis.http.adapters.request.rsgi.RSGITransportAdapter.__init__
orionis.http.adapters.request.rsgi.RSGITransportAdapter.html#__init__
Function
Method
PUBLIC
Initialize the adapter with a Granian RSGI scope.
-
orionis.http.adapters.request.rsgi.RSGITransportAdapter.__scope
orionis.http.adapters.request.rsgi.RSGITransportAdapter.html#__scope
Attribute
Instance Variable
PUBLIC
The Granian RSGI scope object.
-
orionis.http.adapters.request.rsgi.RSGITransportAdapter.__overrides
orionis.http.adapters.request.rsgi.RSGITransportAdapter.html#__overrides
Attribute
Instance Variable
PUBLIC
Keep overrides and computed values in a single state dictionary.
-
orionis.http.adapters.request.rsgi.RSGITransportAdapter.__client
orionis.http.adapters.request.rsgi.RSGITransportAdapter.html#__client
Attribute
Instance Variable
PUBLIC
Resolve lazy fields on first access using the _MISSING sentinel.
-
orionis.http.adapters.request.rsgi.RSGITransportAdapter.__wants_json
orionis.http.adapters.request.rsgi.RSGITransportAdapter.html#__wants_json
Attribute
Instance Variable
PUBLIC
Wants json supplied through _MISSING.
-
orionis.http.adapters.request.rsgi.RSGITransportAdapter.__getitem__
orionis.http.adapters.request.rsgi.RSGITransportAdapter.html#__getitem__
Function
Method
PUBLIC
Return a cached state value by key.
-
orionis.http.adapters.request.rsgi.RSGITransportAdapter.__setitem__
orionis.http.adapters.request.rsgi.RSGITransportAdapter.html#__setitem__
Function
Method
PUBLIC
Store a state value under a key.
-
orionis.http.adapters.request.rsgi.RSGITransportAdapter.__contains__
orionis.http.adapters.request.rsgi.RSGITransportAdapter.html#__contains__
Function
Method
PUBLIC
Check whether a state key exists.
-
orionis.http.adapters.request.rsgi.RSGITransportAdapter.__delitem__
orionis.http.adapters.request.rsgi.RSGITransportAdapter.html#__delitem__
Function
Method
PUBLIC
Remove a state value by key.
-
orionis.http.adapters.request.rsgi.RSGITransportAdapter.client
orionis.http.adapters.request.rsgi.RSGITransportAdapter.html#client
Function
Method
PUBLIC
Return the remote client IP parsed from the scope.
-
orionis.http.adapters.request.rsgi.RSGITransportAdapter.setClient
orionis.http.adapters.request.rsgi.RSGITransportAdapter.html#setClient
Function
Method
PUBLIC
Set the remote client IP in the override state.
-
orionis.http.adapters.request.rsgi.RSGITransportAdapter.scheme
orionis.http.adapters.request.rsgi.RSGITransportAdapter.html#scheme
Function
Method
PUBLIC
Return the request scheme.
-
orionis.http.adapters.request.rsgi.RSGITransportAdapter.setScheme
orionis.http.adapters.request.rsgi.RSGITransportAdapter.html#setScheme
Function
Method
PUBLIC
Set the request scheme in the override state.
-
orionis.http.adapters.request.rsgi.RSGITransportAdapter.method
orionis.http.adapters.request.rsgi.RSGITransportAdapter.html#method
Function
Method
PUBLIC
Return the HTTP method.
-
orionis.http.adapters.request.rsgi.RSGITransportAdapter.path
orionis.http.adapters.request.rsgi.RSGITransportAdapter.html#path
Function
Method
PUBLIC
Return the request path.
-
orionis.http.adapters.request.rsgi.RSGITransportAdapter.setState
orionis.http.adapters.request.rsgi.RSGITransportAdapter.html#setState
Function
Method
PUBLIC
Store a custom value in the override state.
-
orionis.http.adapters.request.rsgi.RSGITransportAdapter.wantsJson
orionis.http.adapters.request.rsgi.RSGITransportAdapter.html#wantsJson
Function
Method
PUBLIC
Determine whether the request prefers a JSON response.
-
orionis.http.adapters.request.rsgi.RSGITransportAdapter.getScope
orionis.http.adapters.request.rsgi.RSGITransportAdapter.html#getScope
Function
Method
PUBLIC
Build and return a dictionary view of the request scope.
-
orionis.http.adapters.response.contracts.response.ResponseAdapter
orionis.http.adapters.response.contracts.response.ResponseAdapter.html
Class
Class
PUBLIC
Write abstraction for sending an HTTP response over a protocol transport.
-
orionis.http.adapters.response.contracts.response.ResponseAdapter.__slots__
orionis.http.adapters.response.contracts.response.ResponseAdapter.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.http.adapters.response.contracts.response.ResponseAdapter.send
orionis.http.adapters.response.contracts.response.ResponseAdapter.html#send
Function
Method
PUBLIC
Send the HTTP response using the underlying protocol transport.
-
orionis.http.adapters.response.ranges.parse_range
orionis.http.adapters.response.ranges.html#parse_range
Function
Function
PUBLIC
Parse a byte range into an interval with an exclusive end offset.
-
orionis.http.adapters.response.asgi.ASGIResponseAdapter
orionis.http.adapters.response.asgi.ASGIResponseAdapter.html
Class
Class
PUBLIC
Translate HTTP responses into ASGI protocol messages.
-
orionis.http.adapters.response.asgi.ASGIResponseAdapter.RESPONSE_START
orionis.http.adapters.response.asgi.ASGIResponseAdapter.html#RESPONSE_START
Attribute
Constant
PUBLIC
http.response.start.
-
orionis.http.adapters.response.asgi.ASGIResponseAdapter.RESPONSE_BODY
orionis.http.adapters.response.asgi.ASGIResponseAdapter.html#RESPONSE_BODY
Attribute
Constant
PUBLIC
http.response.body.
-
orionis.http.adapters.response.asgi.ASGIResponseAdapter.__slots__
orionis.http.adapters.response.asgi.ASGIResponseAdapter.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.http.adapters.response.asgi.ASGIResponseAdapter.send
orionis.http.adapters.response.asgi.ASGIResponseAdapter.html#send
Function
Method
PUBLIC
Send the HTTP response using the ASGI protocol.
-
orionis.http.adapters.response.asgi.ASGIResponseAdapter.__sendHead
orionis.http.adapters.response.asgi.ASGIResponseAdapter.html#__sendHead
Function
Method
PUBLIC
Send HEAD framing without starting an event producer.
-
orionis.http.adapters.response.asgi.ASGIResponseAdapter.__waitDisconnect
orionis.http.adapters.response.asgi.ASGIResponseAdapter.html#__waitDisconnect
Function
Method
PUBLIC
Wait for disconnect, draining unconsumed request messages.
-
orionis.http.adapters.response.asgi.ASGIResponseAdapter.__sendStream
orionis.http.adapters.response.asgi.ASGIResponseAdapter.html#__sendStream
Function
Method
PUBLIC
Send and close a stream with transport backpressure.
-
orionis.http.adapters.response.asgi.ASGIResponseAdapter.__ensureContentLength
orionis.http.adapters.response.asgi.ASGIResponseAdapter.html#__ensureContentLength
Function
Method
PUBLIC
Add content-length to headers if absent, reflecting the body size.
-
orionis.http.adapters.response.asgi.ASGIResponseAdapter.__fileRangeIterator
orionis.http.adapters.response.asgi.ASGIResponseAdapter.html#__fileRangeIterator
Function
Method
PUBLIC
Yield file bytes within [start, end) range asynchronously.
-
orionis.http.adapters.response.rsgi.RSGIResponseAdapter
orionis.http.adapters.response.rsgi.RSGIResponseAdapter.html
Class
Class
PUBLIC
Translate HTTP responses into Granian RSGI operations.
-
orionis.http.adapters.response.rsgi.RSGIResponseAdapter.__slots__
orionis.http.adapters.response.rsgi.RSGIResponseAdapter.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.http.adapters.response.rsgi.RSGIResponseAdapter.send
orionis.http.adapters.response.rsgi.RSGIResponseAdapter.html#send
Function
Method
PUBLIC
Send the HTTP response using the appropriate protocol adapter.
-
orionis.http.adapters.response.rsgi.RSGIResponseAdapter.__sendResponseStream
orionis.http.adapters.response.rsgi.RSGIResponseAdapter.html#__sendResponseStream
Function
Method
PUBLIC
Deliver an ordinary stream or observe disconnects for an event stream.
-
orionis.http.adapters.response.rsgi.RSGIResponseAdapter.__sendHead
orionis.http.adapters.response.rsgi.RSGIResponseAdapter.html#__sendHead
Function
Method
PUBLIC
Send HEAD metadata without starting an event producer.
-
orionis.http.adapters.response.rsgi.RSGIResponseAdapter.__waitDisconnect
orionis.http.adapters.response.rsgi.RSGIResponseAdapter.html#__waitDisconnect
Function
Method
PUBLIC
Await Granian's supported HTTP client disconnect notification.
-
orionis.http.adapters.response.rsgi.RSGIResponseAdapter.__sendStream
orionis.http.adapters.response.rsgi.RSGIResponseAdapter.html#__sendStream
Function
Method
PUBLIC
Send and close a stream through the existing RSGI transport.
-
orionis.http.adapters.response.rsgi.RSGIResponseAdapter.__sendFile
orionis.http.adapters.response.rsgi.RSGIResponseAdapter.html#__sendFile
Function
Method
PUBLIC
Send a file or the byte interval selected by the request.
-
orionis.http.adapters.response.rsgi.RSGIResponseAdapter.__ensureContentLength
orionis.http.adapters.response.rsgi.RSGIResponseAdapter.html#__ensureContentLength
Function
Method
PUBLIC
Add content-length to headers if absent, reflecting the body size.
-
orionis.http.adapters.websocket.failure.disconnected
orionis.http.adapters.websocket.failure.html#disconnected
Function
Function
PUBLIC
Observe a transport error and associate its public disconnect wrapper.
-
orionis.http.adapters.websocket.asgi._REASON_VERSION
orionis.http.adapters.websocket.asgi.html#_REASON_VERSION
Attribute
Constant
PUBLIC
Reason version definitions used by asgi.
-
orionis.http.adapters.websocket.asgi.ASGIWebSocketTransport
orionis.http.adapters.websocket.asgi.ASGIWebSocketTransport.html
Class
Class
PUBLIC
Translate the ASGI WebSocket protocol into normalized operations.
-
orionis.http.adapters.websocket.asgi.ASGIWebSocketTransport.__slots__
orionis.http.adapters.websocket.asgi.ASGIWebSocketTransport.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.http.adapters.websocket.asgi.ASGIWebSocketTransport.__init__
orionis.http.adapters.websocket.asgi.ASGIWebSocketTransport.html#__init__
Function
Method
PUBLIC
Retain callbacks and advertised WebSocket specification version.
-
orionis.http.adapters.websocket.asgi.ASGIWebSocketTransport._scope
orionis.http.adapters.websocket.asgi.ASGIWebSocketTransport.html#_scope
Attribute
Instance Variable
PUBLIC
Original ASGI connection scope.
-
orionis.http.adapters.websocket.asgi.ASGIWebSocketTransport._receive
orionis.http.adapters.websocket.asgi.ASGIWebSocketTransport.html#_receive
Attribute
Instance Variable
PUBLIC
Server event reader.
-
orionis.http.adapters.websocket.asgi.ASGIWebSocketTransport._send
orionis.http.adapters.websocket.asgi.ASGIWebSocketTransport.html#_send
Attribute
Instance Variable
PUBLIC
Server event writer.
-
orionis.http.adapters.websocket.asgi.ASGIWebSocketTransport._handshake_received
orionis.http.adapters.websocket.asgi.ASGIWebSocketTransport.html#_handshake_received
Attribute
Instance Variable
PUBLIC
Handshake received flag used by ASGIWebSocketTransport.
-
orionis.http.adapters.websocket.asgi.ASGIWebSocketTransport._version
orionis.http.adapters.websocket.asgi.ASGIWebSocketTransport.html#_version
Attribute
Instance Variable
PUBLIC
Version string advertised by the implementation.
-
orionis.http.adapters.websocket.asgi.ASGIWebSocketTransport._connectEvent
orionis.http.adapters.websocket.asgi.ASGIWebSocketTransport.html#_connectEvent
Function
Method
PUBLIC
Consume the server's initial handshake event once.
-
orionis.http.adapters.websocket.asgi.ASGIWebSocketTransport.accept
orionis.http.adapters.websocket.asgi.ASGIWebSocketTransport.html#accept
Function
Method
PUBLIC
Accept using the server's supported handshake fields.
-
orionis.http.adapters.websocket.asgi.ASGIWebSocketTransport.receive
orionis.http.adapters.websocket.asgi.ASGIWebSocketTransport.html#receive
Function
Method
PUBLIC
Normalize one complete ASGI data or disconnect event.
-
orionis.http.adapters.websocket.asgi.ASGIWebSocketTransport.sendText
orionis.http.adapters.websocket.asgi.ASGIWebSocketTransport.html#sendText
Function
Method
PUBLIC
Send one text message and await server backpressure.
-
orionis.http.adapters.websocket.asgi.ASGIWebSocketTransport.sendBytes
orionis.http.adapters.websocket.asgi.ASGIWebSocketTransport.html#sendBytes
Function
Method
PUBLIC
Send one binary message and await server backpressure.
-
orionis.http.adapters.websocket.asgi.ASGIWebSocketTransport.reject
orionis.http.adapters.websocket.asgi.ASGIWebSocketTransport.html#reject
Function
Method
PUBLIC
Deny the handshake with an HTTP status when the extension exists.
-
orionis.http.adapters.websocket.asgi.ASGIWebSocketTransport.close
orionis.http.adapters.websocket.asgi.ASGIWebSocketTransport.html#close
Function
Method
PUBLIC
Send a close event using fields supported by the advertised version.
-
orionis.http.adapters.websocket.rsgi._NORMAL_CLOSE
orionis.http.adapters.websocket.rsgi.html#_NORMAL_CLOSE
Attribute
Constant
PUBLIC
Normal close value used by rsgi.
-
orionis.http.adapters.websocket.rsgi.RSGIWebSocketTransport
orionis.http.adapters.websocket.rsgi.RSGIWebSocketTransport.html
Class
Class
PUBLIC
Adapt Granian's actual RSGI WebsocketProtocol and accepted transport.
-
orionis.http.adapters.websocket.rsgi.RSGIWebSocketTransport.__slots__
orionis.http.adapters.websocket.rsgi.RSGIWebSocketTransport.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.http.adapters.websocket.rsgi.RSGIWebSocketTransport.__init__
orionis.http.adapters.websocket.rsgi.RSGIWebSocketTransport.html#__init__
Function
Method
PUBLIC
Retain the pending server protocol.
-
orionis.http.adapters.websocket.rsgi.RSGIWebSocketTransport._protocol
orionis.http.adapters.websocket.rsgi.RSGIWebSocketTransport.html#_protocol
Attribute
Instance Variable
PUBLIC
Granian's handshake and close interface.
-
orionis.http.adapters.websocket.rsgi.RSGIWebSocketTransport._transport
orionis.http.adapters.websocket.rsgi.RSGIWebSocketTransport.html#_transport
Attribute
Instance Variable
PUBLIC
Native protocol transport backing the framework adapter.
-
orionis.http.adapters.websocket.rsgi.RSGIWebSocketTransport.supportsCloseDetails
orionis.http.adapters.websocket.rsgi.RSGIWebSocketTransport.html#supportsCloseDetails
Attribute
Property
PUBLIC
Report the documented RSGI close-frame limitation.
-
orionis.http.adapters.websocket.rsgi.RSGIWebSocketTransport.accept
orionis.http.adapters.websocket.rsgi.RSGIWebSocketTransport.html#accept
Function
Method
PUBLIC
Accept through Granian's argument-free handshake method.
-
orionis.http.adapters.websocket.rsgi.RSGIWebSocketTransport._acceptedTransport
orionis.http.adapters.websocket.rsgi.RSGIWebSocketTransport.html#_acceptedTransport
Function
Method
PUBLIC
Require the transport returned by a completed handshake.
-
orionis.http.adapters.websocket.rsgi.RSGIWebSocketTransport.receive
orionis.http.adapters.websocket.rsgi.RSGIWebSocketTransport.html#receive
Function
Method
PUBLIC
Normalize Granian's close, bytes and string message kinds.
-
orionis.http.adapters.websocket.rsgi.RSGIWebSocketTransport.sendText
orionis.http.adapters.websocket.rsgi.RSGIWebSocketTransport.html#sendText
Function
Method
PUBLIC
Await Granian's text write without buffering.
-
orionis.http.adapters.websocket.rsgi.RSGIWebSocketTransport.sendBytes
orionis.http.adapters.websocket.rsgi.RSGIWebSocketTransport.html#sendBytes
Function
Method
PUBLIC
Await Granian's binary write without buffering.
-
orionis.http.adapters.websocket.rsgi.RSGIWebSocketTransport.reject
orionis.http.adapters.websocket.rsgi.RSGIWebSocketTransport.html#reject
Function
Method
PUBLIC
Reject the handshake using the actual HTTP status argument.
-
orionis.http.adapters.websocket.rsgi.RSGIWebSocketTransport.close
orionis.http.adapters.websocket.rsgi.RSGIWebSocketTransport.html#close
Function
Method
PUBLIC
Close through Granian's default connection closure API.
-
orionis.http.base.BaseController
orionis.http.base.BaseController.html
Class
Class
PUBLIC
Provide a base class for HTTP controllers.
-
orionis.http.contracts.endpoint_policy.IHttpEndpointPolicy
orionis.http.contracts.endpoint_policy.IHttpEndpointPolicy.html
Class
Class
PUBLIC
Customize endpoint framing without replacing routing or middleware.
-
orionis.http.contracts.endpoint_policy.IHttpEndpointPolicy.__slots__
orionis.http.contracts.endpoint_policy.IHttpEndpointPolicy.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.http.contracts.endpoint_policy.IHttpEndpointPolicy.monitor_disconnects
orionis.http.contracts.endpoint_policy.IHttpEndpointPolicy.html#monitor_disconnects
Attribute
Class Variable
PUBLIC
Monitor disconnects flag used by IHttpEndpointPolicy.
-
orionis.http.contracts.endpoint_policy.IHttpEndpointPolicy.isExpectedFailure
orionis.http.contracts.endpoint_policy.IHttpEndpointPolicy.html#isExpectedFailure
Function
Method
PUBLIC
Classify a protocol rejection before global failure observation.
-
orionis.http.contracts.endpoint_policy.IHttpEndpointPolicy.before
orionis.http.contracts.endpoint_policy.IHttpEndpointPolicy.html#before
Function
Method
PUBLIC
Validate protocol connection metadata before admission and middleware.
-
orionis.http.contracts.endpoint_policy.IHttpEndpointPolicy.response
orionis.http.contracts.endpoint_policy.IHttpEndpointPolicy.html#response
Function
Method
PUBLIC
Adapt middleware and handler responses to the endpoint's wire format.
-
orionis.http.contracts.endpoint_policy.IHttpEndpointPolicy.exception
orionis.http.contracts.endpoint_policy.IHttpEndpointPolicy.html#exception
Function
Method
PUBLIC
Report a failure and provide the endpoint's sanitized response.
-
orionis.schemas.meta.constraint.ConstraintMetadata
orionis.schemas.meta.constraint.ConstraintMetadata.html
Class
Class
PUBLIC
Intermediate marker for validation constraints.
-
orionis.schemas.meta.constraint.ConstraintMetadata.__slots__
orionis.schemas.meta.constraint.ConstraintMetadata.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.schemas.rules.accepted._ACCEPTED_TEXT
orionis.schemas.rules.accepted.module.html#_ACCEPTED_TEXT
Attribute
Constant
PUBLIC
Textual representations treated as an explicit acceptance.
-
orionis.schemas.rules.temporal.to_datetime
orionis.schemas.rules.temporal.html#to_datetime
Function
Function
PUBLIC
Coerce a value into a timezone-aware datetime.
-
orionis.schemas.rules.temporal.parse_moment
orionis.schemas.rules.temporal.html#parse_moment
Function
Function
PUBLIC
Parse a textual moment, honouring the relative keywords.
-
orionis.schemas.rules.temporal.resolve_moment
orionis.schemas.rules.temporal.html#resolve_moment
Function
Function
PUBLIC
Resolve a rule reference into the datetime it points at.
-
orionis.schemas.rules.alpha._LETTER_CATEGORIES
orionis.schemas.rules.alpha.module.html#_LETTER_CATEGORIES
Attribute
Constant
PUBLIC
Unicode general category prefixes accepted as alphabetic content.
-
orionis.schemas.rules.measure.KILOBYTE
orionis.schemas.rules.measure.html#KILOBYTE
Attribute
Constant
PUBLIC
Bytes per kilobyte, the unit size rules use to express file sizes.
-
orionis.schemas.rules.measure._FILE_ATTRIBUTES
orionis.schemas.rules.measure.html#_FILE_ATTRIBUTES
Attribute
Constant
PUBLIC
Attributes an uploaded file exposes, used for structural detection so the schema layer stays decoupled from the HTTP payload package.
-
orionis.schemas.rules.measure.is_file
orionis.schemas.rules.measure.html#is_file
Function
Function
PUBLIC
Report whether a value behaves like an uploaded file.
-
orionis.schemas.rules.measure.is_empty
orionis.schemas.rules.measure.html#is_empty
Function
Function
PUBLIC
Recognize empty text, containers, numbers and uploaded files.
-
orionis.schemas.rules.measure.read_content
orionis.schemas.rules.measure.html#read_content
Function
Function
PUBLIC
Read uploaded-file content without blocking the event loop.
-
orionis.schemas.rules.measure.measure
orionis.schemas.rules.measure.html#measure
Function
Function
PUBLIC
Compute the comparable size of a value.
-
orionis.schemas.rules.confirm_password._MISSING
orionis.schemas.rules.confirm_password.html#_MISSING
Attribute
Constant
PUBLIC
Sentinel telling apart "field absent" from "field present but None".
-
orionis.schemas.rules.image_probe._PNG_SIGNATURE
orionis.schemas.rules.image_probe.html#_PNG_SIGNATURE
Attribute
Constant
PUBLIC
Magic numbers identifying every supported raster format.
-
orionis.schemas.rules.image_probe._JPEG_SIGNATURE
orionis.schemas.rules.image_probe.html#_JPEG_SIGNATURE
Attribute
Constant
PUBLIC
Jpeg signature value used by image_probe.
-
orionis.schemas.rules.image_probe._BMP_SIGNATURE
orionis.schemas.rules.image_probe.html#_BMP_SIGNATURE
Attribute
Constant
PUBLIC
Bmp signature value used by image_probe.
-
orionis.schemas.rules.image_probe._GIF_SIGNATURES
orionis.schemas.rules.image_probe.html#_GIF_SIGNATURES
Attribute
Constant
PUBLIC
Gif signatures definitions used by image_probe.
-
orionis.schemas.rules.image_probe._SOF_MARKERS
orionis.schemas.rules.image_probe.html#_SOF_MARKERS
Attribute
Constant
PUBLIC
JPEG start-of-frame markers; their payload carries the image dimensions.
-
orionis.schemas.rules.image_probe._JPEG_FILL
orionis.schemas.rules.image_probe.html#_JPEG_FILL
Attribute
Constant
PUBLIC
Byte introducing every JPEG marker.
-
orionis.schemas.rules.image_probe._STANDALONE_MARKERS
orionis.schemas.rules.image_probe.html#_STANDALONE_MARKERS
Attribute
Constant
PUBLIC
JPEG markers that carry no payload and are skipped two bytes at a time.
-
orionis.schemas.rules.image_probe._BMP_CORE_SIZE
orionis.schemas.rules.image_probe.html#_BMP_CORE_SIZE
Attribute
Constant
PUBLIC
DIB header size identifying unsigned sixteen-bit CORE dimensions.
-
orionis.schemas.rules.image_probe._BMP_INFO_PREFIX
orionis.schemas.rules.image_probe.html#_BMP_INFO_PREFIX
Attribute
Constant
PUBLIC
Minimum DIB header size carrying thirty-two-bit dimensions.
-
orionis.schemas.rules.image_probe._WEBP_FRAME_SIZE
orionis.schemas.rules.image_probe.html#_WEBP_FRAME_SIZE
Attribute
Constant
PUBLIC
Bytes required in the VP8 or VP8X dimension prefix.
-
orionis.schemas.rules.image_probe._WEBP_LOSSLESS_SIZE
orionis.schemas.rules.image_probe.html#_WEBP_LOSSLESS_SIZE
Attribute
Constant
PUBLIC
Bytes required in the VP8L signature and dimension prefix.
-
orionis.schemas.rules.image_probe._WEBP_LOSSLESS_SIGNATURE
orionis.schemas.rules.image_probe.html#_WEBP_LOSSLESS_SIGNATURE
Attribute
Constant
PUBLIC
Signature byte that must begin a lossless WebP bitstream.
-
orionis.schemas.rules.image_probe._JPEG_LENGTH_SIZE
orionis.schemas.rules.image_probe.html#_JPEG_LENGTH_SIZE
Attribute
Constant
PUBLIC
Length-field bytes included in every variable-length JPEG segment.
-
orionis.schemas.rules.image_probe._JPEG_SOF_BASE
orionis.schemas.rules.image_probe.html#_JPEG_SOF_BASE
Attribute
Constant
PUBLIC
SOF segment bytes preceding the three-byte component entries.
-
orionis.schemas.rules.image_probe._WEBP_MASK
orionis.schemas.rules.image_probe.html#_WEBP_MASK
Attribute
Constant
PUBLIC
Mask isolating the 14-bit dimensions stored in WebP bitstreams.
-
orionis.schemas.rules.image_probe._probe_png
orionis.schemas.rules.image_probe.html#_probe_png
Function
Function
PUBLIC
Read the dimensions stored in a PNG IHDR chunk.
-
orionis.schemas.rules.image_probe._probe_gif
orionis.schemas.rules.image_probe.html#_probe_gif
Function
Function
PUBLIC
Read the dimensions stored in a GIF logical screen descriptor.
-
orionis.schemas.rules.image_probe._probe_bmp
orionis.schemas.rules.image_probe.html#_probe_bmp
Function
Function
PUBLIC
Read the dimensions stored in a BMP information header.
-
orionis.schemas.rules.image_probe._probe_webp
orionis.schemas.rules.image_probe.html#_probe_webp
Function
Function
PUBLIC
Read the dimensions of the lossy, lossless or extended WebP bitstream.
-
orionis.schemas.rules.image_probe._jpeg_frame
orionis.schemas.rules.image_probe.html#_jpeg_frame
Function
Function
PUBLIC
Read dimensions from a structurally complete JPEG frame segment.
-
orionis.schemas.rules.image_probe._probe_jpeg
orionis.schemas.rules.image_probe.html#_probe_jpeg
Function
Function
PUBLIC
Walk the JPEG segments until a start-of-frame marker is found.
-
orionis.schemas.rules.image_probe._PROBES
orionis.schemas.rules.image_probe.html#_PROBES
Attribute
Constant
PUBLIC
Probes are ordered by signature cost; each one rejects foreign formats first.
-
orionis.schemas.rules.image_probe.probe_image
orionis.schemas.rules.image_probe.html#probe_image
Function
Function
PUBLIC
Identify a raster image and read its dimensions from the header.
-
orionis.schemas.rules.dimensions._parse_ratio
orionis.schemas.rules.dimensions.module.html#_parse_ratio
Function
Function
PUBLIC
Normalize a ratio constraint into a floating point value.
-
orionis.schemas.rules.email._MAX_LENGTH
orionis.schemas.rules.email.module.html#_MAX_LENGTH
Attribute
Constant
PUBLIC
Constants for email validation.
-
orionis.schemas.rules.email._MAX_LOCAL_LENGTH
orionis.schemas.rules.email.module.html#_MAX_LOCAL_LENGTH
Attribute
Constant
PUBLIC
Max local length value used by email.
-
orionis.schemas.rules.email._LOCAL_ATOM
orionis.schemas.rules.email.module.html#_LOCAL_ATOM
Attribute
Constant
PUBLIC
dot-separated atoms of RFC 5322 allowed characters.
-
orionis.schemas.rules.email._DOMAIN_LABEL
orionis.schemas.rules.email.module.html#_DOMAIN_LABEL
Attribute
Constant
PUBLIC
alphanumeric edges with optional inner hyphens.
-
orionis.schemas.rules.email._EMAIL_PATTERN
orionis.schemas.rules.email.module.html#_EMAIL_PATTERN
Attribute
Constant
PUBLIC
Compiled pattern used to recognize email pattern.
-
orionis.schemas.rules.encoding._DEFAULT_ENCODING
orionis.schemas.rules.encoding.module.html#_DEFAULT_ENCODING
Attribute
Constant
PUBLIC
Codec aliases that are always available through the standard library.
-
orionis.schemas.rules.integer._INTEGER_PATTERN
orionis.schemas.rules.integer.module.html#_INTEGER_PATTERN
Attribute
Constant
PUBLIC
Optionally signed sequence of digits, matching a whole number in text form.
-
orionis.schemas.rules.ip_address._VERSIONS
orionis.schemas.rules.ip_address.html#_VERSIONS
Attribute
Constant
PUBLIC
IP versions the rule is able to enforce.
-
orionis.schemas.rules.mac_address._MAC_PATTERN
orionis.schemas.rules.mac_address.html#_MAC_PATTERN
Attribute
Constant
PUBLIC
Colon, hyphen and Cisco dotted notations for a 48-bit hardware address.
-
orionis.schemas.rules.strong_password._MIN_LENGTH
orionis.schemas.rules.strong_password.html#_MIN_LENGTH
Attribute
Constant
PUBLIC
Constants for password validation.
-
orionis.schemas.rules.strong_password._UPPER
orionis.schemas.rules.strong_password.html#_UPPER
Attribute
Constant
PUBLIC
Upper used by strong_password.
-
orionis.schemas.rules.strong_password._LOWER
orionis.schemas.rules.strong_password.html#_LOWER
Attribute
Constant
PUBLIC
Lower used by strong_password.
-
orionis.schemas.rules.strong_password._DIGIT
orionis.schemas.rules.strong_password.html#_DIGIT
Attribute
Constant
PUBLIC
Digit used by strong_password.
-
orionis.schemas.rules.ulid._ALPHABET
orionis.schemas.rules.ulid.module.html#_ALPHABET
Attribute
Constant
PUBLIC
Crockford base32 alphabet, excluding I, L, O and U.
-
orionis.schemas.rules.ulid._LENGTH
orionis.schemas.rules.ulid.module.html#_LENGTH
Attribute
Constant
PUBLIC
Canonical length of the textual representation.
-
orionis.schemas.rules.ulid._MAX_LEADING
orionis.schemas.rules.ulid.module.html#_MAX_LEADING
Attribute
Constant
PUBLIC
Highest first character keeping the 48-bit timestamp within range.
-
orionis.schemas.rules.uuid_string._UUID_PATTERN
orionis.schemas.rules.uuid_string.html#_UUID_PATTERN
Attribute
Constant
PUBLIC
Compiled pattern used to recognize uuid pattern.
-
orionis.schemas.rules.uuid_string._VERSIONS
orionis.schemas.rules.uuid_string.html#_VERSIONS
Attribute
Constant
PUBLIC
Versions defined by RFC 9562.
-
orionis.schemas.rules.uuid_string._VARIANT_NIBBLES
orionis.schemas.rules.uuid_string.html#_VARIANT_NIBBLES
Attribute
Constant
PUBLIC
Nibbles marking the RFC 9562 variant in the third group of the identifier.
-
orionis.schemas.rules.uuid_string._VERSION_INDEX
orionis.schemas.rules.uuid_string.html#_VERSION_INDEX
Attribute
Constant
PUBLIC
Offsets of the version and variant nibbles in the canonical representation.
-
orionis.schemas.rules.uuid_string._VARIANT_INDEX
orionis.schemas.rules.uuid_string.html#_VARIANT_INDEX
Attribute
Constant
PUBLIC
Variant index value used by uuid_string.
-
orionis.schemas.constraints.GreaterThan
orionis.schemas.constraints.GreaterThan.html
Class
Class
PUBLIC
Assert that a numeric value is strictly greater than value.
-
orionis.schemas.constraints.GreaterThan.value
orionis.schemas.constraints.GreaterThan.html#value
Attribute
Instance Variable
PUBLIC
The exclusive lower bound.
-
orionis.schemas.constraints.GreaterThan.message
orionis.schemas.constraints.GreaterThan.html#message
Attribute
Instance Variable
PUBLIC
Custom error message reported when this constraint fails.
-
orionis.schemas.constraints.GreaterThanOrEqual
orionis.schemas.constraints.GreaterThanOrEqual.html
Class
Class
PUBLIC
Assert that a numeric value is greater than or equal to value.
-
orionis.schemas.constraints.GreaterThanOrEqual.value
orionis.schemas.constraints.GreaterThanOrEqual.html#value
Attribute
Instance Variable
PUBLIC
The inclusive lower bound.
-
orionis.schemas.constraints.GreaterThanOrEqual.message
orionis.schemas.constraints.GreaterThanOrEqual.html#message
Attribute
Instance Variable
PUBLIC
Custom error message reported when this constraint fails.
-
orionis.schemas.constraints.LessThan
orionis.schemas.constraints.LessThan.html
Class
Class
PUBLIC
Assert that a numeric value is strictly less than value.
-
orionis.schemas.constraints.LessThan.value
orionis.schemas.constraints.LessThan.html#value
Attribute
Instance Variable
PUBLIC
The exclusive upper bound.
-
orionis.schemas.constraints.LessThan.message
orionis.schemas.constraints.LessThan.html#message
Attribute
Instance Variable
PUBLIC
Custom error message reported when this constraint fails.
-
orionis.schemas.constraints.LessThanOrEqual
orionis.schemas.constraints.LessThanOrEqual.html
Class
Class
PUBLIC
Assert that a numeric value is less than or equal to value.
-
orionis.schemas.constraints.LessThanOrEqual.value
orionis.schemas.constraints.LessThanOrEqual.html#value
Attribute
Instance Variable
PUBLIC
The inclusive upper bound.
-
orionis.schemas.constraints.LessThanOrEqual.message
orionis.schemas.constraints.LessThanOrEqual.html#message
Attribute
Instance Variable
PUBLIC
Custom error message reported when this constraint fails.
-
orionis.schemas.constraints.MultipleOf
orionis.schemas.constraints.MultipleOf.html
Class
Class
PUBLIC
Assert that a numeric value is a multiple of value.
-
orionis.schemas.constraints.MultipleOf.value
orionis.schemas.constraints.MultipleOf.html#value
Attribute
Instance Variable
PUBLIC
The divisor; the field value must be evenly divisible by this.
-
orionis.schemas.constraints.MultipleOf.message
orionis.schemas.constraints.MultipleOf.html#message
Attribute
Instance Variable
PUBLIC
Custom error message reported when this constraint fails.
-
orionis.schemas.constraints.Pattern
orionis.schemas.constraints.Pattern.html
Class
Class
PUBLIC
Assert that a string value matches the given regex pattern.
-
orionis.schemas.constraints.Pattern.regex
orionis.schemas.constraints.Pattern.html#regex
Attribute
Instance Variable
PUBLIC
An unanchored regular expression searched within the field value.
-
orionis.schemas.constraints.Pattern.message
orionis.schemas.constraints.Pattern.html#message
Attribute
Instance Variable
PUBLIC
Custom error message reported when this constraint fails.
-
orionis.schemas.constraints.MinLength
orionis.schemas.constraints.MinLength.html
Class
Class
PUBLIC
Assert that a string or collection has at least value characters/items.
-
orionis.schemas.constraints.MinLength.value
orionis.schemas.constraints.MinLength.html#value
Attribute
Instance Variable
PUBLIC
The minimum allowed length (inclusive).
-
orionis.schemas.constraints.MinLength.message
orionis.schemas.constraints.MinLength.html#message
Attribute
Instance Variable
PUBLIC
Custom error message reported when this constraint fails.
-
orionis.schemas.constraints.MaxLength
orionis.schemas.constraints.MaxLength.html
Class
Class
PUBLIC
Assert that a string or collection has at most value characters/items.
-
orionis.schemas.constraints.MaxLength.value
orionis.schemas.constraints.MaxLength.html#value
Attribute
Instance Variable
PUBLIC
The maximum allowed length (inclusive).
-
orionis.schemas.constraints.MaxLength.message
orionis.schemas.constraints.MaxLength.html#message
Attribute
Instance Variable
PUBLIC
Custom error message reported when this constraint fails.
-
orionis.schemas.constraints.TimezoneAware
orionis.schemas.constraints.TimezoneAware.html
Class
Class
PUBLIC
Assert timezone-awareness on a datetime.datetime or datetime.time.
-
orionis.schemas.constraints.TimezoneAware.message
orionis.schemas.constraints.TimezoneAware.html#message
Attribute
Instance Variable
PUBLIC
Custom error message reported when this constraint fails.
-
orionis.schemas.constraints.TimezoneNaive
orionis.schemas.constraints.TimezoneNaive.html
Class
Class
PUBLIC
Assert timezone-naivety on a datetime.datetime or datetime.time.
-
orionis.schemas.constraints.TimezoneNaive.message
orionis.schemas.constraints.TimezoneNaive.html#message
Attribute
Instance Variable
PUBLIC
Custom error message reported when this constraint fails.
-
orionis.schemas.compiler.MetadataConflictError
orionis.schemas.compiler.MetadataConflictError.html
Class
Exception
PUBLIC
Signal incompatible or invalid metadata annotations detected by MetaCompiler.
-
orionis.schemas.compiler.MetaCompiler
orionis.schemas.compiler.MetaCompiler.html
Class
Class
PUBLIC
Compile Orionis metadata annotations into a field constraint descriptor.
-
orionis.schemas.compiler.MetaCompiler.__slots__
orionis.schemas.compiler.MetaCompiler.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.schemas.compiler.MetaCompiler.compile
orionis.schemas.compiler.MetaCompiler.html#compile
Function
Static Method
PUBLIC
Compile metadata annotations into a field constraint descriptor.
-
orionis.schemas.compiler.MetaCompiler._index
orionis.schemas.compiler.MetaCompiler.html#_index
Function
Static Method
PUBLIC
Build a type → instance mapping and reject duplicate types.
-
orionis.schemas.compiler.MetaCompiler._validateConflicts
orionis.schemas.compiler.MetaCompiler.html#_validateConflicts
Function
Static Method
PUBLIC
Validate numeric bounds, length ranges and individual metadata values.
-
orionis.schemas.compiler.MetaCompiler._validateNumericBounds
orionis.schemas.compiler.MetaCompiler.html#_validateNumericBounds
Function
Static Method
PUBLIC
Reject ambiguous or impossible combinations of numeric bounds.
-
orionis.schemas.compiler.MetaCompiler._validateLengthRange
orionis.schemas.compiler.MetaCompiler.html#_validateLengthRange
Function
Static Method
PUBLIC
Reject a minimum length greater than the declared maximum.
-
orionis.schemas.compiler.MetaCompiler._validateValues
orionis.schemas.compiler.MetaCompiler.html#_validateValues
Function
Static Method
PUBLIC
Reject conflicting timezones, nonpositive divisors and negative lengths.
-
orionis.schemas.compiler.MetaCompiler._build
orionis.schemas.compiler.MetaCompiler.html#_build
Function
Static Method
PUBLIC
Construct the field constraint descriptor from the validated metadata index.
-
orionis.schemas.schema._CONSTRAINT_MSGSPEC_KEYS
orionis.schemas.schema.module.html#_CONSTRAINT_MSGSPEC_KEYS
Attribute
Constant
PUBLIC
ValidationMetadata subclass -> msgspec.Meta keyword argument name.
-
orionis.schemas.schema._compile_annotation
orionis.schemas.schema.module.html#_compile_annotation
Function
Function
PUBLIC
Compile constraints throughout an annotation and its nested types.
-
orionis.schemas.schema._compile_annotated
orionis.schemas.schema.module.html#_compile_annotated
Function
Function
PUBLIC
Compile an Annotated layer and preserve its local error messages.
-
orionis.schemas.schema._StructMeta
orionis.schemas.schema.module.html#_StructMeta
Attribute
Variable
PUBLIC
The metaclass for all Schema subclasses. Intercept class creation to compile ValidationMetadata into msgspec.Meta and collect custom metadata for later use.
-
orionis.schemas.schema.SchemaMeta
orionis.schemas.schema.SchemaMeta.html
Class
Class
PUBLIC
Collect schema declarations and prepare their validation metadata.
-
orionis.schemas.schema.SchemaMeta.__new__
orionis.schemas.schema.SchemaMeta.html#__new__
Function
Method
PUBLIC
Build a Schema subclass with compiled metadata and rule plans.
-
orionis.schemas.schema.SchemaMeta._compileExplicit
orionis.schemas.schema.SchemaMeta.html#_compileExplicit
Function
Static Method
PUBLIC
Compile eager or string annotations before native conversion is cached.
-
orionis.schemas.schema.SchemaMeta._wrap
orionis.schemas.schema.SchemaMeta.html#_wrap
Function
Static Method
PUBLIC
Wrap lazy annotation resolution with recursive metadata compilation.
-
orionis.schemas.schema.SchemaMeta._collect
orionis.schemas.schema.SchemaMeta.html#_collect
Function
Static Method
PUBLIC
Collect application metadata from a newly created schema class.
-
orionis.schemas.Schema
orionis.schemas.Schema.html
Class
Class
PUBLIC
Define the base class for Orionis schema declarations.
-
orionis.schemas.Schema.toDict
orionis.schemas.Schema.html#toDict
Function
Method
PUBLIC
Recursively convert the schema instance into a dictionary.
-
orionis.schemas._EXPORTS
orionis.schemas.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.schemas.__getattr__
orionis.schemas.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.schemas.__dir__
orionis.schemas.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.http.default.schemas.forgot_password.ForgotPasswordSchema
orionis.http.default.schemas.forgot_password.ForgotPasswordSchema.html
Class
Class
PUBLIC
Validate the email address used to request a password reset.
-
orionis.http.default.schemas.forgot_password.ForgotPasswordSchema.email
orionis.http.default.schemas.forgot_password.ForgotPasswordSchema.html#email
Attribute
Class Variable
PUBLIC
Email address subject to the declared length and address constraints.
-
orionis.http.default.schemas.reset_password.ResetPasswordSchema
orionis.http.default.schemas.reset_password.ResetPasswordSchema.html
Class
Class
PUBLIC
Validate password-reset credentials and the replacement password.
-
orionis.http.default.schemas.reset_password.ResetPasswordSchema.token
orionis.http.default.schemas.reset_password.ResetPasswordSchema.html#token
Attribute
Class Variable
PUBLIC
Token identifying the current reservation or protected operation.
-
orionis.http.default.schemas.reset_password.ResetPasswordSchema.password
orionis.http.default.schemas.reset_password.ResetPasswordSchema.html#password
Attribute
Class Variable
PUBLIC
Account password subject to the declared validation constraints.
-
orionis.http.default.schemas.reset_password.ResetPasswordSchema.password_confirmation
orionis.http.default.schemas.reset_password.ResetPasswordSchema.html#password_confirmation
Attribute
Class Variable
PUBLIC
Repeated password value that must match the password field.
-
orionis.mail.exceptions.MailException
orionis.mail.exceptions.MailException.html
Class
Exception
PUBLIC
Represent a failure in the mail subsystem.
-
orionis.mail.exceptions.MailException.__slots__
orionis.mail.exceptions.MailException.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.mail.exceptions.MailConfigurationException
orionis.mail.exceptions.MailConfigurationException.html
Class
Exception
PUBLIC
Report invalid mailer settings or driver registrations.
-
orionis.mail.exceptions.MailConfigurationException.__slots__
orionis.mail.exceptions.MailConfigurationException.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.mail.exceptions.MailCompositionException
orionis.mail.exceptions.MailCompositionException.html
Class
Exception
PUBLIC
Report invalid declarations, callbacks, views, or MIME content.
-
orionis.mail.exceptions.MailCompositionException.__slots__
orionis.mail.exceptions.MailCompositionException.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.mail.exceptions.MailAttachmentException
orionis.mail.exceptions.MailAttachmentException.html
Class
Exception
PUBLIC
Report unsafe metadata or an unreadable storage attachment.
-
orionis.mail.exceptions.MailAttachmentException.__slots__
orionis.mail.exceptions.MailAttachmentException.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.mail.exceptions.MailTransportException
orionis.mail.exceptions.MailTransportException.html
Class
Exception
PUBLIC
Report a failed transaction without implying non-delivery.
-
orionis.mail.exceptions.MailTransportException.__slots__
orionis.mail.exceptions.MailTransportException.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.mail.exceptions.MailBatchException
orionis.mail.exceptions.MailBatchException.html
Class
Exception
PUBLIC
Expose accepted batch results and the first uncertain transaction index.
-
orionis.mail.exceptions.MailBatchException.__init__
orionis.mail.exceptions.MailBatchException.html#__init__
Function
Method
PUBLIC
Retain partial outcomes without retrying ambiguous SMTP deliveries.
-
orionis.mail.exceptions.MailBatchException.completed
orionis.mail.exceptions.MailBatchException.html#completed
Attribute
Instance Variable
PUBLIC
Successful results recorded before the batch failed.
-
orionis.mail.exceptions.MailBatchException.failed_index
orionis.mail.exceptions.MailBatchException.html#failed_index
Attribute
Instance Variable
PUBLIC
Zero-based index of the first unsuccessful delivery.
-
orionis.mail.functions._TOKEN_CHARS
orionis.mail.functions.html#_TOKEN_CHARS
Attribute
Constant
PUBLIC
Characters allowed by RFC 2045 in a MIME type or subtype token.
-
orionis.mail.functions._MEDIA_TYPE_PARTS
orionis.mail.functions.html#_MEDIA_TYPE_PARTS
Attribute
Constant
PUBLIC
Media type parts value used by functions.
-
orionis.mail.functions._MAX_REASON_LENGTH
orionis.mail.functions.html#_MAX_REASON_LENGTH
Attribute
Constant
PUBLIC
Max reason length value used by functions.
-
orionis.mail.functions.attachment_name
orionis.mail.functions.html#attachment_name
Function
Function
PUBLIC
Validate the visible basename of an attachment.
-
orionis.mail.functions.media_type
orionis.mail.functions.html#media_type
Function
Function
PUBLIC
Validate a bare MIME type without header parameters.
-
orionis.mail.functions.freeze_owned
orionis.mail.functions.html#freeze_owned
Function
Function
PUBLIC
Snapshot containers without copying arbitrary user objects.
-
orionis.mail.functions.sanitize_reason
orionis.mail.functions.html#sanitize_reason
Function
Function
PUBLIC
Remove controls and configured secrets from a transport diagnostic.
-
orionis.schemas.exception_parser.MISSING_FIELD_RE
orionis.schemas.exception_parser.html#MISSING_FIELD_RE
Attribute
Constant
PUBLIC
Regular expressions for parsing msgspec error messages.
-
orionis.schemas.exception_parser._PATH_PART_RE
orionis.schemas.exception_parser.html#_PATH_PART_RE
Attribute
Constant
PUBLIC
Keep quoted dictionary keys intact even when they contain dots or brackets.
-
orionis.schemas.exception_parser._PATH_MARKER
orionis.schemas.exception_parser.html#_PATH_MARKER
Attribute
Constant
PUBLIC
Suffix msgspec appends to report the location of the offending value.
-
orionis.schemas.exception_parser._PATH_MARKER_LEN
orionis.schemas.exception_parser.html#_PATH_MARKER_LEN
Attribute
Constant
PUBLIC
Path marker len used by exception_parser.
-
orionis.schemas.exception_parser._CONSTRAINT_PATTERNS
orionis.schemas.exception_parser.html#_CONSTRAINT_PATTERNS
Attribute
Constant
PUBLIC
Ordered patterns for identifying constraint types from msgspec error messages.
-
orionis.schemas.exception_parser._MISSING
orionis.schemas.exception_parser.html#_MISSING
Attribute
Constant
PUBLIC
Sentinel for distinguishing "not in cache" from "cached result is None".
-
orionis.schemas.exception_parser._get_fields_map
orionis.schemas.exception_parser.html#_get_fields_map
Function
Function
PUBLIC
Return a class-owned mapping from encoded field names to declared types.
-
orionis.schemas.exception_parser.ValidationErrorParser
orionis.schemas.exception_parser.ValidationErrorParser.html
Class
Class
PUBLIC
Translate validation exceptions into structured field errors.
-
orionis.schemas.exception_parser.ValidationErrorParser.__slots__
orionis.schemas.exception_parser.ValidationErrorParser.html#__slots__
Attribute
Class Variable
PUBLIC
Prevent per-instance dictionaries; the class is used statically.
-
orionis.schemas.exception_parser.ValidationErrorParser.parse
orionis.schemas.exception_parser.ValidationErrorParser.html#parse
Function
Class Method
PUBLIC
Parse a msgspec validation error into framework failures.
-
orionis.schemas.exception_parser.ValidationErrorParser.parseAt
orionis.schemas.exception_parser.ValidationErrorParser.html#parseAt
Function
Class Method
PUBLIC
Parse a msgspec validation error raised while converting a sub-value.
-
orionis.schemas.exception_parser.ValidationErrorParser._joinPath
orionis.schemas.exception_parser.ValidationErrorParser.html#_joinPath
Function
Static Method
PUBLIC
Concatenate a base field path with a relative msgspec path.
-
orionis.schemas.exception_parser.ValidationErrorParser._customMessage
orionis.schemas.exception_parser.ValidationErrorParser.html#_customMessage
Function
Class Method
PUBLIC
Return a custom error message for a failed constraint, if one is set.
-
orionis.schemas.exception_parser.ValidationErrorParser._resolveSchema
orionis.schemas.exception_parser.ValidationErrorParser.html#_resolveSchema
Function
Static Method
PUBLIC
Traverse the schema hierarchy and return (leaf_schema, leaf_field).
-
orionis.schemas.exception_parser.ValidationErrorParser._resolveNestedType
orionis.schemas.exception_parser.ValidationErrorParser.html#_resolveNestedType
Function
Static Method
PUBLIC
Return the nested schema type for field_name within schema.
-
orionis.schemas.exception_parser.ValidationErrorParser._nestedType
orionis.schemas.exception_parser.ValidationErrorParser.html#_nestedType
Function
Static Method
PUBLIC
Follow collection selectors to the schema owning a nested field.
-
orionis.schemas.exception_parser.ValidationErrorParser._matchConstraintKey
orionis.schemas.exception_parser.ValidationErrorParser.html#_matchConstraintKey
Function
Static Method
PUBLIC
Identify the constraint type from a raw msgspec error message.
-
orionis.schemas.failure_collector._INVALID
orionis.schemas.failure_collector.html#_INVALID
Attribute
Constant
PUBLIC
Sentinel distinguishing invalid from ordinary values.
-
orionis.schemas.failure_collector._nested_schema
orionis.schemas.failure_collector.html#_nested_schema
Function
Function
PUBLIC
Return the Orionis schema wrapped by a field annotation, if any.
-
orionis.schemas.failure_collector._field_plan
orionis.schemas.failure_collector.html#_field_plan
Function
Function
PUBLIC
Return a class-owned plan for collecting field validation failures.
-
orionis.schemas.failure_collector._payload_fields
orionis.schemas.failure_collector.html#_payload_fields
Function
Function
PUBLIC
Map array-like schema positions to encoded field names.
-
orionis.schemas.failure_collector.FailureCollector
orionis.schemas.failure_collector.FailureCollector.html
Class
Class
PUBLIC
Collect and organize validation failures by field path.
-
orionis.schemas.failure_collector.FailureCollector.__slots__
orionis.schemas.failure_collector.FailureCollector.html#__slots__
Attribute
Class Variable
PUBLIC
Prevent per-instance dictionaries; the class is used statically.
-
orionis.schemas.failure_collector.FailureCollector.collect
orionis.schemas.failure_collector.FailureCollector.html#collect
Function
Class Method
PUBLIC
Collect conversion, constraint and rule failures from a rejected payload.
-
orionis.schemas.failure_collector.FailureCollector._collect
orionis.schemas.failure_collector.FailureCollector.html#_collect
Function
Class Method
PUBLIC
Convert declared fields and accumulate their validation failures.
-
orionis.schemas.failure_collector.FailureCollector._recover
orionis.schemas.failure_collector.FailureCollector.html#_recover
Function
Class Method
PUBLIC
Recover a type-compatible value and collect its validation failures.
-
orionis.schemas.failure_collector.FailureCollector._constraints
orionis.schemas.failure_collector.FailureCollector.html#_constraints
Function
Static Method
PUBLIC
Collect independent constraint failures with their declared codes.
-
orionis.schemas.failure_collector.FailureCollector._enforce
orionis.schemas.failure_collector.FailureCollector.html#_enforce
Function
Class Method
PUBLIC
Run nested and field rules over type-compatible values.
-
orionis.schemas.failure_collector.FailureCollector._blame
orionis.schemas.failure_collector.FailureCollector.html#_blame
Function
Class Method
PUBLIC
Collect local and nested failures for a rejected field value.
-
orionis.schemas.failure_collector.FailureCollector._matchingType
orionis.schemas.failure_collector.FailureCollector.html#_matchingType
Function
Class Method
PUBLIC
Select a nested annotation matching the value's shape and schema tag.
-
orionis.schemas.failure_collector.FailureCollector._matchingSchema
orionis.schemas.failure_collector.FailureCollector.html#_matchingSchema
Function
Static Method
PUBLIC
Match a schema's object or array representation and optional tag.
-
orionis.schemas.failure_collector.FailureCollector._blameCollection
orionis.schemas.failure_collector.FailureCollector.html#_blameCollection
Function
Class Method
PUBLIC
Collect conversion and rule failures independently for each child.
-
orionis.schemas.validator.Schema
orionis.schemas.validator.Schema.html
Class
Class
PUBLIC
Validate structured input against declared fields and validation rules.
-
orionis.schemas.validator.Schema.__slots__
orionis.schemas.validator.Schema.html#__slots__
Attribute
Class Variable
PUBLIC
Prevent per-instance dictionaries; the class is used statically.
-
orionis.schemas.validator.Schema.validate
orionis.schemas.validator.Schema.html#validate
Function
Static Method
PUBLIC
Validate a payload or existing struct and await its schema rules.
-
orionis.support.facades.Application
orionis.support.facades.Application.html
Class
Class
PUBLIC
Resolve the application service through the application facade.
-
orionis.support.facades.Application.getFacadeAccessor
orionis.support.facades.Application.html#getFacadeAccessor
Function
Class Method
PUBLIC
Return the container alias for the application.
-
orionis.support.facades.Auth
orionis.support.facades.Auth.html
Class
Class
PUBLIC
Resolve the auth service through the application facade.
-
orionis.support.facades.Auth.getFacadeAccessor
orionis.support.facades.Auth.html#getFacadeAccessor
Function
Class Method
PUBLIC
Return the container accessor for the authentication manager.
-
orionis.support.facades.Cache
orionis.support.facades.Cache.html
Class
Class
PUBLIC
Facade for the cache system.
-
orionis.support.facades.Cache.getFacadeAccessor
orionis.support.facades.Cache.html#getFacadeAccessor
Function
Class Method
PUBLIC
Return the container accessor for the cache manager.
-
orionis.support.facades.Catch
orionis.support.facades.Catch.html
Class
Class
PUBLIC
Resolve the catch service through the application facade.
-
orionis.support.facades.Catch.getFacadeAccessor
orionis.support.facades.Catch.html#getFacadeAccessor
Function
Class Method
PUBLIC
Return the container alias for the exception handler.
-
orionis.support.facades.DateTime
orionis.support.facades.DateTime.html
Class
Class
PUBLIC
Provide a high-level interface for date and time operations.
-
orionis.support.facades.DateTime.__slots__
orionis.support.facades.DateTime.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.support.facades.DateTime._timezone
orionis.support.facades.DateTime.html#_timezone
Attribute
Class Variable
PUBLIC
Default timezone and locale.
-
orionis.support.facades.DateTime._locale
orionis.support.facades.DateTime.html#_locale
Attribute
Class Variable
PUBLIC
en.
-
orionis.support.facades.DateTime._zoneinfo_cache
orionis.support.facades.DateTime.html#_zoneinfo_cache
Attribute
Class Variable
PUBLIC
Previously resolved time-zone objects indexed by zone name.
-
orionis.support.facades.DateTime._loadConfig
orionis.support.facades.DateTime.html#_loadConfig
Function
Class Method
PUBLIC
Load configuration for timezone and locale.
-
orionis.support.facades.DateTime._setTimezone
orionis.support.facades.DateTime.html#_setTimezone
Function
Class Method
PUBLIC
Set the default timezone for the application.
-
orionis.support.facades.DateTime._setLocale
orionis.support.facades.DateTime.html#_setLocale
Function
Class Method
PUBLIC
Set the default locale for date and time formatting.
-
orionis.support.facades.DateTime.getTimezone
orionis.support.facades.DateTime.html#getTimezone
Function
Class Method
PUBLIC
Return the configured timezone.
-
orionis.support.facades.DateTime.getLocale
orionis.support.facades.DateTime.html#getLocale
Function
Class Method
PUBLIC
Return the configured locale.
-
orionis.support.facades.DateTime.getZoneInfo
orionis.support.facades.DateTime.html#getZoneInfo
Function
Class Method
PUBLIC
Return the ZoneInfo object for the configured timezone.
-
orionis.support.facades.DateTime.now
orionis.support.facades.DateTime.html#now
Function
Class Method
PUBLIC
Get the current date and time.
-
orionis.support.facades.DateTime.today
orionis.support.facades.DateTime.html#today
Function
Class Method
PUBLIC
Return the current date at midnight in the selected timezone.
-
orionis.support.facades.DateTime.tomorrow
orionis.support.facades.DateTime.html#tomorrow
Function
Class Method
PUBLIC
Return tomorrow's date in the specified or default timezone.
-
orionis.support.facades.DateTime.yesterday
orionis.support.facades.DateTime.html#yesterday
Function
Class Method
PUBLIC
Return the date for yesterday in the specified or default timezone.
-
orionis.support.facades.DateTime.parse
orionis.support.facades.DateTime.html#parse
Function
Class Method
PUBLIC
Parse a date string and convert it to the configured timezone.
-
orionis.support.facades.DateTime.fromFormat
orionis.support.facades.DateTime.html#fromFormat
Function
Class Method
PUBLIC
Parse a date string using explicit format tokens.
-
orionis.support.facades.DateTime.local
orionis.support.facades.DateTime.html#local
Function
Class Method
PUBLIC
Create a datetime object in the local system timezone.
-
orionis.support.facades.DateTime.naive
orionis.support.facades.DateTime.html#naive
Function
Class Method
PUBLIC
Create a timezone-naive datetime object.
-
orionis.support.facades.DateTime.fromTimestamp
orionis.support.facades.DateTime.html#fromTimestamp
Function
Class Method
PUBLIC
Convert a Unix timestamp to a datetime in the configured timezone.
-
orionis.support.facades.DateTime.fromDatetime
orionis.support.facades.DateTime.html#fromDatetime
Function
Class Method
PUBLIC
Convert a standard datetime object to the configured timezone.
-
orionis.support.facades.DateTime.datetime
orionis.support.facades.DateTime.html#datetime
Function
Class Method
PUBLIC
Create a datetime object in the configured timezone.
-
orionis.support.facades.DateTime.duration
orionis.support.facades.DateTime.html#duration
Function
Class Method
PUBLIC
Create a Duration instance representing a span of time.
-
orionis.support.facades.DateTime.interval
orionis.support.facades.DateTime.html#interval
Function
Class Method
PUBLIC
Create an Interval instance between two datetimes.
-
orionis.support.facades.DateTime.startOf
orionis.support.facades.DateTime.html#startOf
Function
Class Method
PUBLIC
Return the start of the given unit of time (e.g. 'hour', 'decade').
-
orionis.support.facades.DateTime.endOf
orionis.support.facades.DateTime.html#endOf
Function
Class Method
PUBLIC
Return the end of the given unit of time (e.g. 'hour', 'decade').
-
orionis.support.facades.DateTime.startOfDay
orionis.support.facades.DateTime.html#startOfDay
Function
Class Method
PUBLIC
Return the start of the day (00:00:00).
-
orionis.support.facades.DateTime.endOfDay
orionis.support.facades.DateTime.html#endOfDay
Function
Class Method
PUBLIC
Return the end of the day (23:59:59).
-
orionis.support.facades.DateTime.convertToLocal
orionis.support.facades.DateTime.html#convertToLocal
Function
Class Method
PUBLIC
Convert a date to the configured local timezone.
-
orionis.support.facades.DateTime.formatLocal
orionis.support.facades.DateTime.html#formatLocal
Function
Class Method
PUBLIC
Format a date in the configured timezone and locale.
-
orionis.support.facades.DateTime.startOfWeek
orionis.support.facades.DateTime.html#startOfWeek
Function
Class Method
PUBLIC
Return the start of the week (Monday 00:00:00).
-
orionis.support.facades.DateTime.endOfWeek
orionis.support.facades.DateTime.html#endOfWeek
Function
Class Method
PUBLIC
Return the end of the week (Sunday 23:59:59).
-
orionis.support.facades.DateTime.startOfMonth
orionis.support.facades.DateTime.html#startOfMonth
Function
Class Method
PUBLIC
Return the start of the month (first day at 00:00:00).
-
orionis.support.facades.DateTime.endOfMonth
orionis.support.facades.DateTime.html#endOfMonth
Function
Class Method
PUBLIC
Return the end of the month (last day at 23:59:59).
-
orionis.support.facades.DateTime.startOfYear
orionis.support.facades.DateTime.html#startOfYear
Function
Class Method
PUBLIC
Return the start of the year (January 1st at 00:00:00).
-
orionis.support.facades.DateTime.endOfYear
orionis.support.facades.DateTime.html#endOfYear
Function
Class Method
PUBLIC
Return the end of the year (December 31st at 23:59:59).
-
orionis.support.facades.DateTime.addDays
orionis.support.facades.DateTime.html#addDays
Function
Class Method
PUBLIC
Add days to a given date.
-
orionis.support.facades.DateTime.addHours
orionis.support.facades.DateTime.html#addHours
Function
Class Method
PUBLIC
Add hours to a given datetime.
-
orionis.support.facades.DateTime.addMinutes
orionis.support.facades.DateTime.html#addMinutes
Function
Class Method
PUBLIC
Add minutes to a given datetime.
-
orionis.support.facades.DateTime.diffInDays
orionis.support.facades.DateTime.html#diffInDays
Function
Class Method
PUBLIC
Calculate the difference in days between two dates.
-
orionis.support.facades.DateTime.diffInHours
orionis.support.facades.DateTime.html#diffInHours
Function
Class Method
PUBLIC
Compute the difference in hours between two dates.
-
orionis.support.facades.DateTime.isWeekend
orionis.support.facades.DateTime.html#isWeekend
Function
Class Method
PUBLIC
Determine if the given date falls on a weekend.
-
orionis.support.facades.DateTime.isToday
orionis.support.facades.DateTime.html#isToday
Function
Class Method
PUBLIC
Check whether the date is today in the configured timezone.
-
orionis.support.facades.DateTime.isFuture
orionis.support.facades.DateTime.html#isFuture
Function
Class Method
PUBLIC
Determine if the given date is in the future.
-
orionis.support.facades.DateTime.isPast
orionis.support.facades.DateTime.html#isPast
Function
Class Method
PUBLIC
Determine if the given date is in the past.
-
orionis.support.facades.DateTime.isLeapYear
orionis.support.facades.DateTime.html#isLeapYear
Function
Class Method
PUBLIC
Determine if the year of the given date is a leap year.
-
orionis.support.facades.DateTime.isBirthday
orionis.support.facades.DateTime.html#isBirthday
Function
Class Method
PUBLIC
Determine if the given date shares month and day with another date.
-
orionis.support.facades.DateTime.closest
orionis.support.facades.DateTime.html#closest
Function
Class Method
PUBLIC
Return the datetime closest to the given one among the candidates.
-
orionis.support.facades.DateTime.farthest
orionis.support.facades.DateTime.html#farthest
Function
Class Method
PUBLIC
Return the datetime farthest from the given one among the candidates.
-
orionis.support.facades.DateTime.add
orionis.support.facades.DateTime.html#add
Function
Class Method
PUBLIC
Add a combination of time units to a given date.
-
orionis.support.facades.DateTime.subtract
orionis.support.facades.DateTime.html#subtract
Function
Class Method
PUBLIC
Subtract a combination of time units from a given date.
-
orionis.support.facades.DateTime.diff
orionis.support.facades.DateTime.html#diff
Function
Class Method
PUBLIC
Return the full Interval between two dates.
-
orionis.support.facades.DateTime.diffForHumans
orionis.support.facades.DateTime.html#diffForHumans
Function
Class Method
PUBLIC
Return a human-readable difference between two dates.
-
orionis.support.facades.DateTime.next
orionis.support.facades.DateTime.html#next
Function
Class Method
PUBLIC
Move to the next occurrence of the given day of the week.
-
orionis.support.facades.DateTime.previous
orionis.support.facades.DateTime.html#previous
Function
Class Method
PUBLIC
Move to the previous occurrence of the given day of the week.
-
orionis.support.facades.DateTime.average
orionis.support.facades.DateTime.html#average
Function
Class Method
PUBLIC
Return the middle datetime between two dates.
-
orionis.support.facades.DateTime.firstOf
orionis.support.facades.DateTime.html#firstOf
Function
Class Method
PUBLIC
Return the first day of the given unit, optionally on a weekday.
-
orionis.support.facades.DateTime.lastOf
orionis.support.facades.DateTime.html#lastOf
Function
Class Method
PUBLIC
Return the last day of the given unit, optionally on a weekday.
-
orionis.support.facades.DateTime.nthOf
orionis.support.facades.DateTime.html#nthOf
Function
Class Method
PUBLIC
Return the n-th occurrence of a weekday within the given unit.
-
orionis.support.facades.DB
orionis.support.facades.DB.html
Class
Class
PUBLIC
Resolve the db service through the application facade.
-
orionis.support.facades.DB.getFacadeAccessor
orionis.support.facades.DB.html#getFacadeAccessor
Function
Class Method
PUBLIC
Return the container accessor for the database gateway.
-
orionis.support.facades.Debug
orionis.support.facades.Debug.html
Class
Class
PUBLIC
Resolve the debug service through the application facade.
-
orionis.support.facades.Debug.getFacadeAccessor
orionis.support.facades.Debug.html#getFacadeAccessor
Function
Class Method
PUBLIC
Return the container alias for the dumper contract.
-
orionis.support.facades.Crypt
orionis.support.facades.Crypt.html
Class
Class
PUBLIC
Resolve the crypt service through the application facade.
-
orionis.support.facades.Crypt.getFacadeAccessor
orionis.support.facades.Crypt.html#getFacadeAccessor
Function
Class Method
PUBLIC
Return the contract used to resolve the encrypter.
-
orionis.support.facades.Hash
orionis.support.facades.Hash.html
Class
Class
PUBLIC
Resolve the hash service through the application facade.
-
orionis.support.facades.Hash.getFacadeAccessor
orionis.support.facades.Hash.html#getFacadeAccessor
Function
Class Method
PUBLIC
Return the container accessor for the hashing manager.
-
orionis.localization.types.TranslationMap
orionis.localization.types.html#TranslationMap
Attribute
Type Alias
PUBLIC
Flat mapping of translation key to translated text for a single locale.
-
orionis.localization.types.LocaleCache
orionis.localization.types.html#LocaleCache
Attribute
Type Alias
PUBLIC
In-memory cache mapping each locale code to its translation map.
-
orionis.localization.types.MissingKeyHandler
orionis.localization.types.html#MissingKeyHandler
Attribute
Type Alias
PUBLIC
Handler invoked when a translation key is missing; receives the key and the locale, and may return a replacement line or None.
-
orionis.support.facades.Lang
orionis.support.facades.Lang.html
Class
Class
PUBLIC
Resolve the lang service through the application facade.
-
orionis.support.facades.Lang.getFacadeAccessor
orionis.support.facades.Lang.html#getFacadeAccessor
Function
Class Method
PUBLIC
Return the container accessor for the translator.
-
orionis.support.facades.Log
orionis.support.facades.Log.html
Class
Class
PUBLIC
Resolve the log service through the application facade.
-
orionis.support.facades.Log.getFacadeAccessor
orionis.support.facades.Log.html#getFacadeAccessor
Function
Class Method
PUBLIC
Return the container alias for the logger.
-
orionis.mail.entities.address.Recipients
orionis.mail.entities.address.module.html#Recipients
Attribute
Type Alias
PUBLIC
Accepted recipient declaration, re-exported by orionis.mail.types.
-
orionis.mail.entities.address.one_address
orionis.mail.entities.address.module.html#one_address
Function
Function
PUBLIC
Normalize exactly one mailbox and reject ambiguous names.
-
orionis.mail.entities.address.addresses
orionis.mail.entities.address.module.html#addresses
Function
Function
PUBLIC
Normalize and stably deduplicate a recipient declaration.
-
orionis.storage.exceptions.StorageException
orionis.storage.exceptions.StorageException.html
Class
Exception
PUBLIC
Base exception for all storage-related errors.
-
orionis.storage.exceptions.DiskNotFoundException
orionis.storage.exceptions.DiskNotFoundException.html
Class
Exception
PUBLIC
Raised when a disk is not defined in the filesystems configuration.
-
orionis.storage.exceptions.DriverNotSupportedException
orionis.storage.exceptions.DriverNotSupportedException.html
Class
Exception
PUBLIC
Raised when a disk references a driver without an implementation.
-
orionis.storage.exceptions.MissingStorageDependencyException
orionis.storage.exceptions.MissingStorageDependencyException.html
Class
Exception
PUBLIC
Raised when a driver requires an optional package that is not installed.
-
orionis.storage.exceptions.StoragePathException
orionis.storage.exceptions.StoragePathException.html
Class
Exception
PUBLIC
Raised when a storage path is malformed or escapes the disk root.
-
orionis.storage.exceptions.StorageFileNotFoundException
orionis.storage.exceptions.StorageFileNotFoundException.html
Class
Exception
PUBLIC
Raised when a file does not exist on the target disk.
-
orionis.storage.exceptions.UnsupportedStorageOperationException
orionis.storage.exceptions.UnsupportedStorageOperationException.html
Class
Exception
PUBLIC
Raised when a driver cannot perform the requested operation.
-
orionis.storage.paths.normalize_path
orionis.storage.paths.html#normalize_path
Function
Function
PUBLIC
Normalize a storage path into a canonical root-relative form.
-
orionis.storage.paths.normalize_file_path
orionis.storage.paths.html#normalize_file_path
Function
Function
PUBLIC
Normalize a storage path and require it to reference a file.
-
orionis.storage.paths._LEGACY_EXPORTS
orionis.storage.paths.html#_LEGACY_EXPORTS
Attribute
Constant
PUBLIC
Legacy exports definitions used by paths.
-
orionis.storage.paths.__getattr__
orionis.storage.paths.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a legacy path function name.
-
orionis.mail.types.MessageCallback
orionis.mail.types.html#MessageCallback
Attribute
Type Alias
PUBLIC
Operation-local configurator invoked once for a direct send.
-
orionis.mail.types.Delivery
orionis.mail.types.html#Delivery
Attribute
Type Alias
PUBLIC
Shared preparation and transport entry point owned by the manager.
-
orionis.mail.types.TransportFactory
orionis.mail.types.html#TransportFactory
Attribute
Type Alias
PUBLIC
Driver factory registered through the manager extension point.
-
orionis.mail.pending._run_callback
orionis.mail.pending.html#_run_callback
Function
Function
PUBLIC
Run one configurator exactly once and await an asynchronous result.
-
orionis.mail.pending._assert_declaration
orionis.mail.pending.html#_assert_declaration
Function
Function
PUBLIC
Reject invalid synchronous declarations without leaking coroutines.
-
orionis.mail.pending._is_mailable_class
orionis.mail.pending.html#_is_mailable_class
Function
Function
PUBLIC
Check whether a value is a Mailable subclass.
-
orionis.support.facades.Mail
orionis.support.facades.Mail.html
Class
Class
PUBLIC
Resolve the mail service through the application facade.
-
orionis.support.facades.Mail.__slots__
orionis.support.facades.Mail.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.support.facades.Mail.getFacadeAccessor
orionis.support.facades.Mail.html#getFacadeAccessor
Function
Class Method
PUBLIC
Return the contract shared by the facade and dependency injection.
-
orionis.support.facades.Mcp
orionis.support.facades.Mcp.html
Class
Class
PUBLIC
Expose the same MCP manager that application services receive through DI.
-
orionis.support.facades.Mcp.__slots__
orionis.support.facades.Mcp.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.support.facades.Mcp.getFacadeAccessor
orionis.support.facades.Mcp.html#getFacadeAccessor
Function
Class Method
PUBLIC
Return the contract used to resolve the MCP manager.
-
orionis.support.facades.Queue
orionis.support.facades.Queue.html
Class
Class
PUBLIC
Resolve the queue service through the application facade.
-
orionis.support.facades.Queue.__slots__
orionis.support.facades.Queue.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.support.facades.Queue.getFacadeAccessor
orionis.support.facades.Queue.html#getFacadeAccessor
Function
Class Method
PUBLIC
Return the queue manager contract used by the application.
-
orionis.support.facades.Reactor
orionis.support.facades.Reactor.html
Class
Class
PUBLIC
Resolve the reactor service through the application facade.
-
orionis.support.facades.Reactor.getFacadeAccessor
orionis.support.facades.Reactor.html#getFacadeAccessor
Function
Class Method
PUBLIC
Return the container alias for the command reactor.
-
orionis.support.facades.Realtime
orionis.support.facades.Realtime.html
Class
Class
PUBLIC
Expose worker-local Hub targeting from ordinary application services.
-
orionis.support.facades.Realtime.__slots__
orionis.support.facades.Realtime.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.support.facades.Realtime.getFacadeAccessor
orionis.support.facades.Realtime.html#getFacadeAccessor
Function
Class Method
PUBLIC
Return the registry contract owned by the application container.
-
orionis.support.facades.Route
orionis.support.facades.Route.html
Class
Class
PUBLIC
Resolve the route service through the application facade.
-
orionis.support.facades.Route.getFacadeAccessor
orionis.support.facades.Route.html#getFacadeAccessor
Function
Class Method
PUBLIC
Return the facade accessor string for the router contract.
-
orionis.support.facades.Schedule
orionis.support.facades.Schedule.html
Class
Class
PUBLIC
Resolve the schedule service through the application facade.
-
orionis.support.facades.Schedule.getFacadeAccessor
orionis.support.facades.Schedule.html#getFacadeAccessor
Function
Class Method
PUBLIC
Return the contract used to resolve the scheduler.
-
orionis.support.facades.Schema
orionis.support.facades.Schema.html
Class
Class
PUBLIC
Resolve the schema service through the application facade.
-
orionis.support.facades.Schema.getFacadeAccessor
orionis.support.facades.Schema.html#getFacadeAccessor
Function
Class Method
PUBLIC
Return the contract used to resolve schema operations.
-
orionis.support.facades.Session
orionis.support.facades.Session.html
Class
Class
PUBLIC
Resolve the session service through the application facade.
-
orionis.support.facades.Session.getFacadeAccessor
orionis.support.facades.Session.html#getFacadeAccessor
Function
Class Method
PUBLIC
Return the contract of the request-local session.
-
orionis.support.facades.Storage
orionis.support.facades.Storage.html
Class
Class
PUBLIC
Resolve the storage service through the application facade.
-
orionis.support.facades.Storage.getFacadeAccessor
orionis.support.facades.Storage.html#getFacadeAccessor
Function
Class Method
PUBLIC
Return the container accessor for the storage manager.
-
orionis.support.facades.Test
orionis.support.facades.Test.html
Class
Class
PUBLIC
Resolve the test service through the application facade.
-
orionis.support.facades.Test.getFacadeAccessor
orionis.support.facades.Test.html#getFacadeAccessor
Function
Class Method
PUBLIC
Return the contract used to resolve the test engine.
-
orionis.support.facades.View
orionis.support.facades.View.html
Class
Class
PUBLIC
Resolve the view service through the application facade.
-
orionis.support.facades.View.getFacadeAccessor
orionis.support.facades.View.html#getFacadeAccessor
Function
Class Method
PUBLIC
Return the container accessor for the view factory.
-
orionis.support.facades._EXPORTS
orionis.support.facades.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.support.facades.__getattr__
orionis.support.facades.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.support.facades.__dir__
orionis.support.facades.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.http.default.controllers.forgot_password_controller._MAX_EMAIL_LENGTH
orionis.http.default.controllers.forgot_password_controller.html#_MAX_EMAIL_LENGTH
Attribute
Constant
PUBLIC
Max email length value used by forgot_password_controller.
-
orionis.http.default.controllers.forgot_password_controller._TOKEN_LENGTH
orionis.http.default.controllers.forgot_password_controller.html#_TOKEN_LENGTH
Attribute
Constant
PUBLIC
Token length value used by forgot_password_controller.
-
orionis.http.default.controllers.forgot_password_controller.ForgotPasswordController
orionis.http.default.controllers.forgot_password_controller.ForgotPasswordController.html
Class
Class
PUBLIC
Handle the built-in password-reset request endpoints.
-
orionis.http.default.controllers.forgot_password_controller.ForgotPasswordController.SENT_MESSAGE
orionis.http.default.controllers.forgot_password_controller.ForgotPasswordController.html#SENT_MESSAGE
Attribute
Constant
PUBLIC
Confirmation shown after a password-reset request, regardless of whether the account exists.
-
orionis.http.default.controllers.forgot_password_controller.ForgotPasswordController.index
orionis.http.default.controllers.forgot_password_controller.ForgotPasswordController.html#index
Function
Method
PUBLIC
Render the forgot-password page.
-
orionis.http.default.controllers.forgot_password_controller.ForgotPasswordController.sendResetLinkEmail
orionis.http.default.controllers.forgot_password_controller.ForgotPasswordController.html#sendResetLinkEmail
Function
Method
PUBLIC
Queue a password-reset message without revealing account existence.
-
orionis.http.default.controllers.forgot_password_controller.ForgotPasswordController._sendLink
orionis.http.default.controllers.forgot_password_controller.ForgotPasswordController.html#_sendLink
Function
Method
PUBLIC
Issue and deliver a reset link after the response.
-
orionis.http.default.controllers.forgot_password_controller.ForgotPasswordController.showResetForm
orionis.http.default.controllers.forgot_password_controller.ForgotPasswordController.html#showResetForm
Function
Method
PUBLIC
Display a reset form for an unconsumed link.
-
orionis.http.default.controllers.forgot_password_controller.ForgotPasswordController.resetPassword
orionis.http.default.controllers.forgot_password_controller.ForgotPasswordController.html#resetPassword
Function
Method
PUBLIC
Reset the password without flashing credentials or tokens.
-
orionis.http.default.controllers.forgot_password_controller.ForgotPasswordController._sendConfirmation
orionis.http.default.controllers.forgot_password_controller.ForgotPasswordController.html#_sendConfirmation
Function
Method
PUBLIC
Notify the account owner after the password reset commits.
-
orionis.http.default.controllers.forgot_password_controller.ForgotPasswordController._form
orionis.http.default.controllers.forgot_password_controller.ForgotPasswordController.html#_form
Function
Method
PUBLIC
Render the reset form without exposing password values.
-
orionis.http.default.controllers.forgot_password_controller.ForgotPasswordController._private
orionis.http.default.controllers.forgot_password_controller.ForgotPasswordController.html#_private
Function
Static Method
PUBLIC
Mark a response as private and prevent reset URL referrers.
-
orionis.http.default.schemas.login.LoginSchema
orionis.http.default.schemas.login.LoginSchema.html
Class
Class
PUBLIC
Validate sign-in credentials and the remember-session option.
-
orionis.http.default.schemas.login.LoginSchema.email
orionis.http.default.schemas.login.LoginSchema.html#email
Attribute
Class Variable
PUBLIC
Email address subject to the declared length and address constraints.
-
orionis.http.default.schemas.login.LoginSchema.password
orionis.http.default.schemas.login.LoginSchema.html#password
Attribute
Class Variable
PUBLIC
Account password subject to the declared validation constraints.
-
orionis.http.default.schemas.login.LoginSchema.remember
orionis.http.default.schemas.login.LoginSchema.html#remember
Attribute
Class Variable
PUBLIC
Optional request value enabling persistent authentication.
-
orionis.http.default.controllers.login_controller.LoginController
orionis.http.default.controllers.login_controller.LoginController.html
Class
Class
PUBLIC
Handle the built-in sign-in and sign-out endpoints.
-
orionis.http.default.controllers.login_controller.LoginController.HOME_REDIRECT_PATH
orionis.http.default.controllers.login_controller.LoginController.html#HOME_REDIRECT_PATH
Attribute
Constant
PUBLIC
/home.
-
orionis.http.default.controllers.login_controller.LoginController.DEFAULT_LOGIN_PATH
orionis.http.default.controllers.login_controller.LoginController.html#DEFAULT_LOGIN_PATH
Attribute
Constant
PUBLIC
/login.
-
orionis.http.default.controllers.login_controller.LoginController.LOGOUT_REDIRECT_PATH
orionis.http.default.controllers.login_controller.LoginController.html#LOGOUT_REDIRECT_PATH
Attribute
Constant
PUBLIC
/.
-
orionis.http.default.controllers.login_controller.LoginController.LOGIN_VIEW_NAME
orionis.http.default.controllers.login_controller.LoginController.html#LOGIN_VIEW_NAME
Attribute
Constant
PUBLIC
auth.login.
-
orionis.http.default.controllers.login_controller.LoginController.__init__
orionis.http.default.controllers.login_controller.LoginController.html#__init__
Function
Method
PUBLIC
Configure the controller from the session authentication settings.
-
orionis.http.default.controllers.login_controller.LoginController.redirect_to
orionis.http.default.controllers.login_controller.LoginController.html#redirect_to
Attribute
Instance Variable
PUBLIC
Cache the destination used after a valid session login.
-
orionis.http.default.controllers.login_controller.LoginController.index
orionis.http.default.controllers.login_controller.LoginController.html#index
Function
Method
PUBLIC
Return the login page response.
-
orionis.http.default.controllers.login_controller.LoginController.login
orionis.http.default.controllers.login_controller.LoginController.html#login
Function
Method
PUBLIC
Handle the login form submission.
-
orionis.http.default.controllers.login_controller.LoginController.logout
orionis.http.default.controllers.login_controller.LoginController.html#logout
Function
Method
PUBLIC
Invalidate the current session and return to the public welcome page.
-
orionis.http.default.schemas.change_password.ChangePasswordSchema
orionis.http.default.schemas.change_password.ChangePasswordSchema.html
Class
Class
PUBLIC
Validate the current password and its proposed replacement.
-
orionis.http.default.schemas.change_password.ChangePasswordSchema.current_password
orionis.http.default.schemas.change_password.ChangePasswordSchema.html#current_password
Attribute
Class Variable
PUBLIC
Current account password supplied for verification.
-
orionis.http.default.schemas.change_password.ChangePasswordSchema.password
orionis.http.default.schemas.change_password.ChangePasswordSchema.html#password
Attribute
Class Variable
PUBLIC
Account password subject to the declared validation constraints.
-
orionis.http.default.schemas.change_password.ChangePasswordSchema.password_confirmation
orionis.http.default.schemas.change_password.ChangePasswordSchema.html#password_confirmation
Attribute
Class Variable
PUBLIC
Repeated password value that must match the password field.
-
orionis.http.default.controllers.profile_controller.ProfileController
orionis.http.default.controllers.profile_controller.ProfileController.html
Class
Class
PUBLIC
Handle built-in profile and password-management endpoints.
-
orionis.http.default.controllers.profile_controller.ProfileController.index
orionis.http.default.controllers.profile_controller.ProfileController.html#index
Function
Method
PUBLIC
Render the profile page with the authenticated account data.
-
orionis.http.default.controllers.profile_controller.ProfileController.changePassword
orionis.http.default.controllers.profile_controller.ProfileController.html#changePassword
Function
Method
PUBLIC
Verify the current secret, save a hash and rotate the active session.
-
orionis.http.default.schemas.register.RegisterSchema
orionis.http.default.schemas.register.RegisterSchema.html
Class
Class
PUBLIC
Validate the account details required for user registration.
-
orionis.http.default.schemas.register.RegisterSchema.name
orionis.http.default.schemas.register.RegisterSchema.html#name
Attribute
Class Variable
PUBLIC
Account display name subject to the declared validation constraints.
-
orionis.http.default.schemas.register.RegisterSchema.email
orionis.http.default.schemas.register.RegisterSchema.html#email
Attribute
Class Variable
PUBLIC
Email address subject to the declared length and address constraints.
-
orionis.http.default.schemas.register.RegisterSchema.password
orionis.http.default.schemas.register.RegisterSchema.html#password
Attribute
Class Variable
PUBLIC
Account password subject to the declared validation constraints.
-
orionis.http.default.schemas.register.RegisterSchema.password_confirmation
orionis.http.default.schemas.register.RegisterSchema.html#password_confirmation
Attribute
Class Variable
PUBLIC
Repeated password value that must match the password field.
-
orionis.http.default.controllers.register_controller.RegisterController
orionis.http.default.controllers.register_controller.RegisterController.html
Class
Class
PUBLIC
Handle the built-in account-registration endpoints.
-
orionis.http.default.controllers.register_controller.RegisterController.REGISTER_VIEW_NAME
orionis.http.default.controllers.register_controller.RegisterController.html#REGISTER_VIEW_NAME
Attribute
Constant
PUBLIC
auth.register.
-
orionis.http.default.controllers.register_controller.RegisterController.REGISTER_REDIRECT_PATH
orionis.http.default.controllers.register_controller.RegisterController.html#REGISTER_REDIRECT_PATH
Attribute
Constant
PUBLIC
/login.
-
orionis.http.default.controllers.register_controller.RegisterController.VERIFY_VIEW_NAME
orionis.http.default.controllers.register_controller.RegisterController.html#VERIFY_VIEW_NAME
Attribute
Constant
PUBLIC
auth.verify-email.
-
orionis.http.default.controllers.register_controller.RegisterController.VERIFY_PARAM_NAME
orionis.http.default.controllers.register_controller.RegisterController.html#VERIFY_PARAM_NAME
Attribute
Constant
PUBLIC
id.
-
orionis.http.default.controllers.register_controller.RegisterController.index
orionis.http.default.controllers.register_controller.RegisterController.html#index
Function
Method
PUBLIC
Return the registration page response.
-
orionis.http.default.controllers.register_controller.RegisterController.register
orionis.http.default.controllers.register_controller.RegisterController.html#register
Function
Method
PUBLIC
Handle the registration form submission.
-
orionis.http.default.controllers.register_controller.RegisterController.sendVerificationEmail
orionis.http.default.controllers.register_controller.RegisterController.html#sendVerificationEmail
Function
Method
PUBLIC
Send a verification email to the newly registered user.
-
orionis.http.default.controllers.register_controller.RegisterController.verifyEmail
orionis.http.default.controllers.register_controller.RegisterController.html#verifyEmail
Function
Method
PUBLIC
Activate the account addressed by a verification link.
-
orionis.http.default.controllers.register_controller.RegisterController.__resolveUser
orionis.http.default.controllers.register_controller.RegisterController.html#__resolveUser
Function
Method
PUBLIC
Resolve the account referenced by an encrypted verification link.
-
orionis.http.enums.Interface
orionis.http.enums.Interface.html
Class
Class
PUBLIC
Represent the supported HTTP interface types.
-
orionis.http.enums.Interface.ASGI
orionis.http.enums.Interface.html#ASGI
Attribute
Constant
PUBLIC
Represents the ASGI interface.
-
orionis.http.enums.Interface.RSGI
orionis.http.enums.Interface.html#RSGI
Attribute
Constant
PUBLIC
Represents the RSGI interface.
-
orionis.http.enums.HTTPStatus
orionis.http.enums.HTTPStatus.html
Class
Class
PUBLIC
Enumerate HTTP response status codes supported by the framework.
-
orionis.http.enums.HTTPStatus.CONTINUE
orionis.http.enums.HTTPStatus.html#CONTINUE
Attribute
Constant
PUBLIC
Continue value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.SWITCHING_PROTOCOLS
orionis.http.enums.HTTPStatus.html#SWITCHING_PROTOCOLS
Attribute
Constant
PUBLIC
Switching protocols value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.PROCESSING
orionis.http.enums.HTTPStatus.html#PROCESSING
Attribute
Constant
PUBLIC
Processing value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.EARLY_HINTS
orionis.http.enums.HTTPStatus.html#EARLY_HINTS
Attribute
Constant
PUBLIC
Early hints value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.OK
orionis.http.enums.HTTPStatus.html#OK
Attribute
Constant
PUBLIC
Ok value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.CREATED
orionis.http.enums.HTTPStatus.html#CREATED
Attribute
Constant
PUBLIC
Created value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.ACCEPTED
orionis.http.enums.HTTPStatus.html#ACCEPTED
Attribute
Constant
PUBLIC
Accepted value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.NON_AUTHORITATIVE_INFORMATION
orionis.http.enums.HTTPStatus.html#NON_AUTHORITATIVE_INFORMATION
Attribute
Constant
PUBLIC
Non authoritative information value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.NO_CONTENT
orionis.http.enums.HTTPStatus.html#NO_CONTENT
Attribute
Constant
PUBLIC
No content value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.RESET_CONTENT
orionis.http.enums.HTTPStatus.html#RESET_CONTENT
Attribute
Constant
PUBLIC
Reset content value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.PARTIAL_CONTENT
orionis.http.enums.HTTPStatus.html#PARTIAL_CONTENT
Attribute
Constant
PUBLIC
Partial content value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.MULTI_STATUS
orionis.http.enums.HTTPStatus.html#MULTI_STATUS
Attribute
Constant
PUBLIC
Multi status value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.ALREADY_REPORTED
orionis.http.enums.HTTPStatus.html#ALREADY_REPORTED
Attribute
Constant
PUBLIC
Already reported value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.IM_USED
orionis.http.enums.HTTPStatus.html#IM_USED
Attribute
Constant
PUBLIC
Im used value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.MULTIPLE_CHOICES
orionis.http.enums.HTTPStatus.html#MULTIPLE_CHOICES
Attribute
Constant
PUBLIC
Multiple choices value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.MOVED_PERMANENTLY
orionis.http.enums.HTTPStatus.html#MOVED_PERMANENTLY
Attribute
Constant
PUBLIC
Moved permanently value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.FOUND
orionis.http.enums.HTTPStatus.html#FOUND
Attribute
Constant
PUBLIC
Found value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.SEE_OTHER
orionis.http.enums.HTTPStatus.html#SEE_OTHER
Attribute
Constant
PUBLIC
See other value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.NOT_MODIFIED
orionis.http.enums.HTTPStatus.html#NOT_MODIFIED
Attribute
Constant
PUBLIC
Not modified value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.USE_PROXY
orionis.http.enums.HTTPStatus.html#USE_PROXY
Attribute
Constant
PUBLIC
Use proxy value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.UNUSED
orionis.http.enums.HTTPStatus.html#UNUSED
Attribute
Constant
PUBLIC
Unused value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.TEMPORARY_REDIRECT
orionis.http.enums.HTTPStatus.html#TEMPORARY_REDIRECT
Attribute
Constant
PUBLIC
Temporary redirect value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.PERMANENT_REDIRECT
orionis.http.enums.HTTPStatus.html#PERMANENT_REDIRECT
Attribute
Constant
PUBLIC
Permanent redirect value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.BAD_REQUEST
orionis.http.enums.HTTPStatus.html#BAD_REQUEST
Attribute
Constant
PUBLIC
Bad request value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.UNAUTHORIZED
orionis.http.enums.HTTPStatus.html#UNAUTHORIZED
Attribute
Constant
PUBLIC
Unauthorized value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.PAYMENT_REQUIRED
orionis.http.enums.HTTPStatus.html#PAYMENT_REQUIRED
Attribute
Constant
PUBLIC
Payment required value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.FORBIDDEN
orionis.http.enums.HTTPStatus.html#FORBIDDEN
Attribute
Constant
PUBLIC
Forbidden value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.NOT_FOUND
orionis.http.enums.HTTPStatus.html#NOT_FOUND
Attribute
Constant
PUBLIC
Not found value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.METHOD_NOT_ALLOWED
orionis.http.enums.HTTPStatus.html#METHOD_NOT_ALLOWED
Attribute
Constant
PUBLIC
Method not allowed value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.NOT_ACCEPTABLE
orionis.http.enums.HTTPStatus.html#NOT_ACCEPTABLE
Attribute
Constant
PUBLIC
Not acceptable value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.PROXY_AUTHENTICATION_REQUIRED
orionis.http.enums.HTTPStatus.html#PROXY_AUTHENTICATION_REQUIRED
Attribute
Constant
PUBLIC
Proxy authentication required value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.REQUEST_TIMEOUT
orionis.http.enums.HTTPStatus.html#REQUEST_TIMEOUT
Attribute
Constant
PUBLIC
Request timeout value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.CONFLICT
orionis.http.enums.HTTPStatus.html#CONFLICT
Attribute
Constant
PUBLIC
Conflict value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.GONE
orionis.http.enums.HTTPStatus.html#GONE
Attribute
Constant
PUBLIC
Gone value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.LENGTH_REQUIRED
orionis.http.enums.HTTPStatus.html#LENGTH_REQUIRED
Attribute
Constant
PUBLIC
Length required value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.PRECONDITION_FAILED
orionis.http.enums.HTTPStatus.html#PRECONDITION_FAILED
Attribute
Constant
PUBLIC
Precondition failed value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.CONTENT_TOO_LARGE
orionis.http.enums.HTTPStatus.html#CONTENT_TOO_LARGE
Attribute
Constant
PUBLIC
Content too large value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.URI_TOO_LONG
orionis.http.enums.HTTPStatus.html#URI_TOO_LONG
Attribute
Constant
PUBLIC
Uri too long value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.UNSUPPORTED_MEDIA_TYPE
orionis.http.enums.HTTPStatus.html#UNSUPPORTED_MEDIA_TYPE
Attribute
Constant
PUBLIC
Unsupported media type value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.RANGE_NOT_SATISFIABLE
orionis.http.enums.HTTPStatus.html#RANGE_NOT_SATISFIABLE
Attribute
Constant
PUBLIC
Range not satisfiable value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.EXPECTATION_FAILED
orionis.http.enums.HTTPStatus.html#EXPECTATION_FAILED
Attribute
Constant
PUBLIC
Expectation failed value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.IM_A_TEAPOT
orionis.http.enums.HTTPStatus.html#IM_A_TEAPOT
Attribute
Constant
PUBLIC
Im a teapot value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.PAGE_EXPIRED
orionis.http.enums.HTTPStatus.html#PAGE_EXPIRED
Attribute
Constant
PUBLIC
Page expired value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.MISDIRECTED_REQUEST
orionis.http.enums.HTTPStatus.html#MISDIRECTED_REQUEST
Attribute
Constant
PUBLIC
Misdirected request value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.UNPROCESSABLE_CONTENT
orionis.http.enums.HTTPStatus.html#UNPROCESSABLE_CONTENT
Attribute
Constant
PUBLIC
Unprocessable content value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.LOCKED
orionis.http.enums.HTTPStatus.html#LOCKED
Attribute
Constant
PUBLIC
Locked value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.FAILED_DEPENDENCY
orionis.http.enums.HTTPStatus.html#FAILED_DEPENDENCY
Attribute
Constant
PUBLIC
Failed dependency value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.TOO_EARLY
orionis.http.enums.HTTPStatus.html#TOO_EARLY
Attribute
Constant
PUBLIC
Too early value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.UPGRADE_REQUIRED
orionis.http.enums.HTTPStatus.html#UPGRADE_REQUIRED
Attribute
Constant
PUBLIC
Upgrade required value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.PRECONDITION_REQUIRED
orionis.http.enums.HTTPStatus.html#PRECONDITION_REQUIRED
Attribute
Constant
PUBLIC
Precondition required value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.TOO_MANY_REQUESTS
orionis.http.enums.HTTPStatus.html#TOO_MANY_REQUESTS
Attribute
Constant
PUBLIC
Too many requests value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.UNAVAILABLE_FOR_LEGAL_REASONS
orionis.http.enums.HTTPStatus.html#UNAVAILABLE_FOR_LEGAL_REASONS
Attribute
Constant
PUBLIC
Unavailable for legal reasons value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.INTERNAL_SERVER_ERROR
orionis.http.enums.HTTPStatus.html#INTERNAL_SERVER_ERROR
Attribute
Constant
PUBLIC
Internal server error value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.NOT_IMPLEMENTED
orionis.http.enums.HTTPStatus.html#NOT_IMPLEMENTED
Attribute
Constant
PUBLIC
Not implemented value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.BAD_GATEWAY
orionis.http.enums.HTTPStatus.html#BAD_GATEWAY
Attribute
Constant
PUBLIC
Bad gateway value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.SERVICE_UNAVAILABLE
orionis.http.enums.HTTPStatus.html#SERVICE_UNAVAILABLE
Attribute
Constant
PUBLIC
Service unavailable value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.GATEWAY_TIMEOUT
orionis.http.enums.HTTPStatus.html#GATEWAY_TIMEOUT
Attribute
Constant
PUBLIC
Gateway timeout value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.HTTP_VERSION_NOT_SUPPORTED
orionis.http.enums.HTTPStatus.html#HTTP_VERSION_NOT_SUPPORTED
Attribute
Constant
PUBLIC
Http version not supported value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.VARIANT_ALSO_NEGOTIATES
orionis.http.enums.HTTPStatus.html#VARIANT_ALSO_NEGOTIATES
Attribute
Constant
PUBLIC
Variant also negotiates value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.INSUFFICIENT_STORAGE
orionis.http.enums.HTTPStatus.html#INSUFFICIENT_STORAGE
Attribute
Constant
PUBLIC
Insufficient storage value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.LOOP_DETECTED
orionis.http.enums.HTTPStatus.html#LOOP_DETECTED
Attribute
Constant
PUBLIC
Loop detected value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.NOT_EXTENDED
orionis.http.enums.HTTPStatus.html#NOT_EXTENDED
Attribute
Constant
PUBLIC
Not extended value used by HTTPStatus.
-
orionis.http.enums.HTTPStatus.NETWORK_AUTHENTICATION_REQUIRED
orionis.http.enums.HTTPStatus.html#NETWORK_AUTHENTICATION_REQUIRED
Attribute
Constant
PUBLIC
Network authentication required value used by HTTPStatus.
-
orionis.http.enums.WebSocketStatus
orionis.http.enums.WebSocketStatus.html
Class
Class
PUBLIC
Enumerate WebSocket close status codes.
-
orionis.http.enums.WebSocketStatus.NORMAL_CLOSURE
orionis.http.enums.WebSocketStatus.html#NORMAL_CLOSURE
Attribute
Constant
PUBLIC
Normal closure value used by WebSocketStatus.
-
orionis.http.enums.WebSocketStatus.GOING_AWAY
orionis.http.enums.WebSocketStatus.html#GOING_AWAY
Attribute
Constant
PUBLIC
Going away value used by WebSocketStatus.
-
orionis.http.enums.WebSocketStatus.PROTOCOL_ERROR
orionis.http.enums.WebSocketStatus.html#PROTOCOL_ERROR
Attribute
Constant
PUBLIC
Protocol error value used by WebSocketStatus.
-
orionis.http.enums.WebSocketStatus.UNSUPPORTED_DATA
orionis.http.enums.WebSocketStatus.html#UNSUPPORTED_DATA
Attribute
Constant
PUBLIC
Unsupported data value used by WebSocketStatus.
-
orionis.http.enums.WebSocketStatus.RESERVED
orionis.http.enums.WebSocketStatus.html#RESERVED
Attribute
Constant
PUBLIC
Reserved value used by WebSocketStatus.
-
orionis.http.enums.WebSocketStatus.NO_STATUS_RCVD
orionis.http.enums.WebSocketStatus.html#NO_STATUS_RCVD
Attribute
Constant
PUBLIC
No status rcvd value used by WebSocketStatus.
-
orionis.http.enums.WebSocketStatus.ABNORMAL_CLOSURE
orionis.http.enums.WebSocketStatus.html#ABNORMAL_CLOSURE
Attribute
Constant
PUBLIC
Abnormal closure value used by WebSocketStatus.
-
orionis.http.enums.WebSocketStatus.INVALID_FRAME_PAYLOAD_DATA
orionis.http.enums.WebSocketStatus.html#INVALID_FRAME_PAYLOAD_DATA
Attribute
Constant
PUBLIC
Invalid frame payload data value used by WebSocketStatus.
-
orionis.http.enums.WebSocketStatus.POLICY_VIOLATION
orionis.http.enums.WebSocketStatus.html#POLICY_VIOLATION
Attribute
Constant
PUBLIC
Policy violation value used by WebSocketStatus.
-
orionis.http.enums.WebSocketStatus.MESSAGE_TOO_BIG
orionis.http.enums.WebSocketStatus.html#MESSAGE_TOO_BIG
Attribute
Constant
PUBLIC
Message too big value used by WebSocketStatus.
-
orionis.http.enums.WebSocketStatus.MANDATORY_EXT
orionis.http.enums.WebSocketStatus.html#MANDATORY_EXT
Attribute
Constant
PUBLIC
Mandatory ext value used by WebSocketStatus.
-
orionis.http.enums.WebSocketStatus.INTERNAL_ERROR
orionis.http.enums.WebSocketStatus.html#INTERNAL_ERROR
Attribute
Constant
PUBLIC
Internal error value used by WebSocketStatus.
-
orionis.http.enums.WebSocketStatus.SERVICE_RESTART
orionis.http.enums.WebSocketStatus.html#SERVICE_RESTART
Attribute
Constant
PUBLIC
Service restart value used by WebSocketStatus.
-
orionis.http.enums.WebSocketStatus.TRY_AGAIN_LATER
orionis.http.enums.WebSocketStatus.html#TRY_AGAIN_LATER
Attribute
Constant
PUBLIC
Try again later value used by WebSocketStatus.
-
orionis.http.enums.WebSocketStatus.BAD_GATEWAY
orionis.http.enums.WebSocketStatus.html#BAD_GATEWAY
Attribute
Constant
PUBLIC
Bad gateway value used by WebSocketStatus.
-
orionis.http.enums.WebSocketStatus.TLS_HANDSHAKE
orionis.http.enums.WebSocketStatus.html#TLS_HANDSHAKE
Attribute
Constant
PUBLIC
Tls handshake value used by WebSocketStatus.
-
orionis.http.enums.WebSocketStatus.UNAUTHORIZED
orionis.http.enums.WebSocketStatus.html#UNAUTHORIZED
Attribute
Constant
PUBLIC
Unauthorized value used by WebSocketStatus.
-
orionis.http.enums.WebSocketStatus.FORBIDDEN
orionis.http.enums.WebSocketStatus.html#FORBIDDEN
Attribute
Constant
PUBLIC
Forbidden value used by WebSocketStatus.
-
orionis.http.enums.WebSocketStatus.TIMEOUT
orionis.http.enums.WebSocketStatus.html#TIMEOUT
Attribute
Constant
PUBLIC
Timeout value used by WebSocketStatus.
-
orionis.http.exceptions.response_validation.ResponseValidationException
orionis.http.exceptions.response_validation.ResponseValidationException.html
Class
Exception
PUBLIC
Report an invalid schema returned by an HTTP handler.
-
orionis.http.layer.shared.cors.CORSException
orionis.http.layer.shared.cors.CORSException.html
Class
Exception
PUBLIC
Report a request rejected by cross-origin access policy.
-
orionis.http.layer.shared.cors.CORSMiddleware
orionis.http.layer.shared.cors.CORSMiddleware.html
Class
Class
PUBLIC
Validate cross-origin requests and attach the required CORS headers.
-
orionis.http.layer.shared.cors.CORSMiddleware.__slots__
orionis.http.layer.shared.cors.CORSMiddleware.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.http.layer.shared.cors.CORSMiddleware.ALL_METHODS
orionis.http.layer.shared.cors.CORSMiddleware.html#ALL_METHODS
Attribute
Constant
PUBLIC
Methods allowed in CORS preflight responses when the wildcard is used.
-
orionis.http.layer.shared.cors.CORSMiddleware.__init__
orionis.http.layer.shared.cors.CORSMiddleware.html#__init__
Function
Method
PUBLIC
Initialize the middleware with the given CORS configuration.
-
orionis.http.layer.shared.cors.CORSMiddleware.__allow_all_origins
orionis.http.layer.shared.cors.CORSMiddleware.html#__allow_all_origins
Attribute
Instance Variable
PUBLIC
Origins.
-
orionis.http.layer.shared.cors.CORSMiddleware.__allow_origins
orionis.http.layer.shared.cors.CORSMiddleware.html#__allow_origins
Attribute
Instance Variable
PUBLIC
Origins permitted by the cross-origin request policy.
-
orionis.http.layer.shared.cors.CORSMiddleware.__origin_regex
orionis.http.layer.shared.cors.CORSMiddleware.html#__origin_regex
Attribute
Instance Variable
PUBLIC
Compiled regular expression matching permitted request origins.
-
orionis.http.layer.shared.cors.CORSMiddleware.__allow_all_methods
orionis.http.layer.shared.cors.CORSMiddleware.html#__allow_all_methods
Attribute
Instance Variable
PUBLIC
Methods.
-
orionis.http.layer.shared.cors.CORSMiddleware.__allow_methods_value
orionis.http.layer.shared.cors.CORSMiddleware.html#__allow_methods_value
Attribute
Instance Variable
PUBLIC
Serialized value of the Access-Control-Allow-Methods header.
-
orionis.http.layer.shared.cors.CORSMiddleware.__allow_credentials
orionis.http.layer.shared.cors.CORSMiddleware.html#__allow_credentials
Attribute
Instance Variable
PUBLIC
Credentials / Cache.
-
orionis.http.layer.shared.cors.CORSMiddleware.__max_age_value
orionis.http.layer.shared.cors.CORSMiddleware.html#__max_age_value
Attribute
Instance Variable
PUBLIC
Pre-render the max-age header value; None disables the header.
-
orionis.http.layer.shared.cors.CORSMiddleware.__isAllowedOrigin
orionis.http.layer.shared.cors.CORSMiddleware.html#__isAllowedOrigin
Function
Method
PUBLIC
Validate whether an origin is allowed.
-
orionis.http.layer.shared.cors.CORSMiddleware.__isPreflight
orionis.http.layer.shared.cors.CORSMiddleware.html#__isPreflight
Function
Method
PUBLIC
Determine whether the request is a CORS preflight.
-
orionis.http.layer.shared.cors.CORSMiddleware.__mergeVary
orionis.http.layer.shared.cors.CORSMiddleware.html#__mergeVary
Function
Method
PUBLIC
Append a directive to the Vary header without overwriting it.
-
orionis.http.layer.shared.cors.CORSMiddleware.__applyOrigin
orionis.http.layer.shared.cors.CORSMiddleware.html#__applyOrigin
Function
Method
PUBLIC
Write the Access-Control-Allow-Origin (and Vary) headers.
-
orionis.http.layer.shared.cors.CORSMiddleware.__applyCredentials
orionis.http.layer.shared.cors.CORSMiddleware.html#__applyCredentials
Function
Method
PUBLIC
Write the Access-Control-Allow-Credentials header if needed.
-
orionis.http.layer.shared.cors.CORSMiddleware.before
orionis.http.layer.shared.cors.CORSMiddleware.html#before
Function
Method
PUBLIC
Intercept preflight requests and return an early response.
-
orionis.http.layer.shared.cors.CORSMiddleware.after
orionis.http.layer.shared.cors.CORSMiddleware.html#after
Function
Method
PUBLIC
Apply CORS headers to actual (non-preflight) responses.
-
orionis.http.layer.shared.maintenance.UnderMaintenanceMiddleware
orionis.http.layer.shared.maintenance.UnderMaintenanceMiddleware.html
Class
Class
PUBLIC
Reject every incoming request with 503 while in maintenance mode.
-
orionis.http.layer.shared.maintenance.UnderMaintenanceMiddleware.__slots__
orionis.http.layer.shared.maintenance.UnderMaintenanceMiddleware.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.http.layer.shared.maintenance.UnderMaintenanceMiddleware.__init__
orionis.http.layer.shared.maintenance.UnderMaintenanceMiddleware.html#__init__
Function
Method
PUBLIC
Initialize with the maintenance flag and default response handler.
-
orionis.http.layer.shared.maintenance.UnderMaintenanceMiddleware.__under_maintenance
orionis.http.layer.shared.maintenance.UnderMaintenanceMiddleware.html#__under_maintenance
Attribute
Instance Variable
PUBLIC
True when the application is in maintenance mode.
-
orionis.http.layer.shared.maintenance.UnderMaintenanceMiddleware.__default_responses
orionis.http.layer.shared.maintenance.UnderMaintenanceMiddleware.html#__default_responses
Attribute
Instance Variable
PUBLIC
Handler used to build the 503 response.
-
orionis.http.layer.shared.maintenance.UnderMaintenanceMiddleware.handle
orionis.http.layer.shared.maintenance.UnderMaintenanceMiddleware.html#handle
Function
Method
PUBLIC
Return a 503 response if the application is under maintenance.
-
orionis.http.layer.shared.proxies._PRIVATE_NETWORKS
orionis.http.layer.shared.proxies.html#_PRIVATE_NETWORKS
Attribute
Constant
PUBLIC
Loopback and RFC-1918 networks used to expand the 'private' shorthand.
-
orionis.http.layer.shared.proxies.ProxiesMiddleware
orionis.http.layer.shared.proxies.ProxiesMiddleware.html
Class
Class
PUBLIC
Normalize client IP and scheme using trusted proxy headers.
-
orionis.http.layer.shared.proxies.ProxiesMiddleware.__slots__
orionis.http.layer.shared.proxies.ProxiesMiddleware.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.http.layer.shared.proxies.ProxiesMiddleware.__init__
orionis.http.layer.shared.proxies.ProxiesMiddleware.html#__init__
Function
Method
PUBLIC
Initialize the middleware with the given proxy configuration.
-
orionis.http.layer.shared.proxies.ProxiesMiddleware.__trusted_networks
orionis.http.layer.shared.proxies.ProxiesMiddleware.html#__trusted_networks
Attribute
Instance Variable
PUBLIC
Pre-compile networks and index single-host peers for exact matches.
-
orionis.http.layer.shared.proxies.ProxiesMiddleware.__trusted_peers
orionis.http.layer.shared.proxies.ProxiesMiddleware.html#__trusted_peers
Attribute
Instance Variable
PUBLIC
Trusted peers produced by frozenset.
-
orionis.http.layer.shared.proxies.ProxiesMiddleware.__enabled
orionis.http.layer.shared.proxies.ProxiesMiddleware.html#__enabled
Attribute
Instance Variable
PUBLIC
Requests are only rewritten when at least one proxy is trusted.
-
orionis.http.layer.shared.proxies.ProxiesMiddleware.handle
orionis.http.layer.shared.proxies.ProxiesMiddleware.html#handle
Function
Method
PUBLIC
Process an ASGI/RSGI scope and normalize its client IP and scheme.
-
orionis.http.layer.shared.proxies.ProxiesMiddleware.__process
orionis.http.layer.shared.proxies.ProxiesMiddleware.html#__process
Function
Method
PUBLIC
Apply trusted-proxy normalization to the transport adapter.
-
orionis.http.layer.shared.proxies.ProxiesMiddleware.__resolveForwardedChain
orionis.http.layer.shared.proxies.ProxiesMiddleware.html#__resolveForwardedChain
Function
Method
PUBLIC
Resolve the real client IP from the forwarded header chain.
-
orionis.http.layer.shared.proxies.ProxiesMiddleware.__resolveScheme
orionis.http.layer.shared.proxies.ProxiesMiddleware.html#__resolveScheme
Function
Method
PUBLIC
Determine the original request scheme from forwarded headers.
-
orionis.http.layer.shared.proxies.ProxiesMiddleware.__isTrustedAddress
orionis.http.layer.shared.proxies.ProxiesMiddleware.html#__isTrustedAddress
Function
Method
PUBLIC
Determine whether a parsed address belongs to a trusted network.
-
orionis.http.layer.shared.proxies.ProxiesMiddleware.__parseIp
orionis.http.layer.shared.proxies.ProxiesMiddleware.html#__parseIp
Function
Static Method
PUBLIC
Parse a string into an IP address object.
-
orionis.http.layer.shared.proxies.ProxiesMiddleware.__compile
orionis.http.layer.shared.proxies.ProxiesMiddleware.html#__compile
Function
Static Method
PUBLIC
Compile proxy identifiers into network objects.
-
orionis.http.layer.store.memory_rate_limit._RateLimitBucket
orionis.http.layer.store.memory_rate_limit._RateLimitBucket.html
Class
Class
PUBLIC
Track accepted timestamps and the time the last one expires.
-
orionis.http.layer.store.memory_rate_limit._RateLimitBucket.expires_at
orionis.http.layer.store.memory_rate_limit._RateLimitBucket.html#expires_at
Attribute
Class Variable
PUBLIC
Timestamp after which the stored value is no longer valid.
-
orionis.http.layer.store.memory_rate_limit._RateLimitBucket.timestamps
orionis.http.layer.store.memory_rate_limit._RateLimitBucket.html#timestamps
Attribute
Class Variable
PUBLIC
Timestamps produced by field.
-
orionis.http.layer.store.memory_rate_limit.MemoryRateLimitStore
orionis.http.layer.store.memory_rate_limit.MemoryRateLimitStore.html
Class
Class
PUBLIC
Track rate-limit counters in process-local memory.
-
orionis.http.layer.store.memory_rate_limit.MemoryRateLimitStore.__slots__
orionis.http.layer.store.memory_rate_limit.MemoryRateLimitStore.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.http.layer.store.memory_rate_limit.MemoryRateLimitStore._GC_INTERVAL
orionis.http.layer.store.memory_rate_limit.MemoryRateLimitStore.html#_GC_INTERVAL
Attribute
Constant
PUBLIC
Inspect a bounded group of keys after each group of request attempts.
-
orionis.http.layer.store.memory_rate_limit.MemoryRateLimitStore._GC_BATCH_SIZE
orionis.http.layer.store.memory_rate_limit.MemoryRateLimitStore.html#_GC_BATCH_SIZE
Attribute
Constant
PUBLIC
Gc batch size value used by MemoryRateLimitStore.
-
orionis.http.layer.store.memory_rate_limit.MemoryRateLimitStore.__init__
orionis.http.layer.store.memory_rate_limit.MemoryRateLimitStore.html#__init__
Function
Method
PUBLIC
Initialize an empty rate-limit store.
-
orionis.http.layer.store.memory_rate_limit.MemoryRateLimitStore.__max_keys
orionis.http.layer.store.memory_rate_limit.MemoryRateLimitStore.html#__max_keys
Attribute
Instance Variable
PUBLIC
Maximum number of retained client buckets.
-
orionis.http.layer.store.memory_rate_limit.MemoryRateLimitStore.__max_events
orionis.http.layer.store.memory_rate_limit.MemoryRateLimitStore.html#__max_events
Attribute
Instance Variable
PUBLIC
Maximum number of accepted timestamps retained across all clients.
-
orionis.http.layer.store.memory_rate_limit.MemoryRateLimitStore.__lock
orionis.http.layer.store.memory_rate_limit.MemoryRateLimitStore.html#__lock
Attribute
Instance Variable
PUBLIC
Lock protecting concurrent access to shared state.
-
orionis.http.layer.store.memory_rate_limit.MemoryRateLimitStore.__total_events
orionis.http.layer.store.memory_rate_limit.MemoryRateLimitStore.html#__total_events
Attribute
Instance Variable
PUBLIC
Total events value used by MemoryRateLimitStore.
-
orionis.http.layer.store.memory_rate_limit.MemoryRateLimitStore.__storage
orionis.http.layer.store.memory_rate_limit.MemoryRateLimitStore.html#__storage
Attribute
Instance Variable
PUBLIC
Entries retained by the in-memory storage backend.
-
orionis.http.layer.store.memory_rate_limit.MemoryRateLimitStore.__keys
orionis.http.layer.store.memory_rate_limit.MemoryRateLimitStore.html#__keys
Attribute
Instance Variable
PUBLIC
Keys produced by deque.
-
orionis.http.layer.store.memory_rate_limit.MemoryRateLimitStore.__ticks
orionis.http.layer.store.memory_rate_limit.MemoryRateLimitStore.html#__ticks
Attribute
Instance Variable
PUBLIC
Ticks value used by MemoryRateLimitStore.
-
orionis.http.layer.store.memory_rate_limit.MemoryRateLimitStore.hit
orionis.http.layer.store.memory_rate_limit.MemoryRateLimitStore.html#hit
Function
Method
PUBLIC
Record a request attempt and decide whether it is allowed.
-
orionis.http.layer.store.memory_rate_limit.MemoryRateLimitStore.__hit
orionis.http.layer.store.memory_rate_limit.MemoryRateLimitStore.html#__hit
Function
Method
PUBLIC
Update quota and capacity counters while holding the store lock.
-
orionis.http.layer.store.memory_rate_limit.MemoryRateLimitStore.__newBucket
orionis.http.layer.store.memory_rate_limit.MemoryRateLimitStore.html#__newBucket
Function
Method
PUBLIC
Create a bucket only when bounded reclamation makes room for it.
-
orionis.http.layer.store.memory_rate_limit.MemoryRateLimitStore.__atCapacity
orionis.http.layer.store.memory_rate_limit.MemoryRateLimitStore.html#__atCapacity
Function
Method
PUBLIC
Report whether admitting a new client would exceed either bound.
-
orionis.http.layer.store.memory_rate_limit.MemoryRateLimitStore.__gc
orionis.http.layer.store.memory_rate_limit.MemoryRateLimitStore.html#__gc
Function
Method
PUBLIC
Inspect the next group of keys and remove expired buckets.
-
orionis.http.layer.shared.rate_limit.RateLimitMiddleware
orionis.http.layer.shared.rate_limit.RateLimitMiddleware.html
Class
Class
PUBLIC
Apply configured request-rate limits before dispatch.
-
orionis.http.layer.shared.rate_limit.RateLimitMiddleware.__slots__
orionis.http.layer.shared.rate_limit.RateLimitMiddleware.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.http.layer.shared.rate_limit.RateLimitMiddleware.__init__
orionis.http.layer.shared.rate_limit.RateLimitMiddleware.html#__init__
Function
Method
PUBLIC
Initialize the middleware with the given rate-limit configuration.
-
orionis.http.layer.shared.rate_limit.RateLimitMiddleware.__rate_limit_enabled
orionis.http.layer.shared.rate_limit.RateLimitMiddleware.html#__rate_limit_enabled
Attribute
Instance Variable
PUBLIC
Rate limit enabled obtained from cfg.rate_limit_enabled.
-
orionis.http.layer.shared.rate_limit.RateLimitMiddleware.__rate_limit_requests
orionis.http.layer.shared.rate_limit.RateLimitMiddleware.html#__rate_limit_requests
Attribute
Instance Variable
PUBLIC
Rate limit requests obtained from cfg.rate_limit_requests.
-
orionis.http.layer.shared.rate_limit.RateLimitMiddleware.__rate_limit_window_seconds
orionis.http.layer.shared.rate_limit.RateLimitMiddleware.html#__rate_limit_window_seconds
Attribute
Instance Variable
PUBLIC
Rate limit window seconds obtained from cfg.rate_limit_window_seconds.
-
orionis.http.layer.shared.rate_limit.RateLimitMiddleware.__retry_after_value
orionis.http.layer.shared.rate_limit.RateLimitMiddleware.html#__retry_after_value
Attribute
Instance Variable
PUBLIC
Pre-render the Retry-After header value for rejection responses.
-
orionis.http.layer.shared.rate_limit.RateLimitMiddleware.__store
orionis.http.layer.shared.rate_limit.RateLimitMiddleware.html#__store
Attribute
Instance Variable
PUBLIC
Backend storing the state needed by this service.
-
orionis.http.layer.shared.rate_limit.RateLimitMiddleware.__default_responses
orionis.http.layer.shared.rate_limit.RateLimitMiddleware.html#__default_responses
Attribute
Instance Variable
PUBLIC
Predefined default responses for common HTTP errors.
-
orionis.http.layer.shared.rate_limit.RateLimitMiddleware.close
orionis.http.layer.shared.rate_limit.RateLimitMiddleware.html#close
Function
Method
PUBLIC
Release an owned Redis connection pool during application shutdown.
-
orionis.http.layer.shared.rate_limit.RateLimitMiddleware.isEnabled
orionis.http.layer.shared.rate_limit.RateLimitMiddleware.html#isEnabled
Function
Method
PUBLIC
Report whether rate limiting is active for this application.
-
orionis.http.layer.shared.rate_limit.RateLimitMiddleware.handle
orionis.http.layer.shared.rate_limit.RateLimitMiddleware.html#handle
Function
Method
PUBLIC
Enforce the sliding-window rate limit for the incoming request.
-
orionis.http.layer.shared.security.SecurityMiddleware
orionis.http.layer.shared.security.SecurityMiddleware.html
Class
Class
PUBLIC
Enforce baseline HTTP security policies on every request.
-
orionis.http.layer.shared.security.SecurityMiddleware.__slots__
orionis.http.layer.shared.security.SecurityMiddleware.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.http.layer.shared.security.SecurityMiddleware.__init__
orionis.http.layer.shared.security.SecurityMiddleware.html#__init__
Function
Method
PUBLIC
Initialize the middleware with the given security configuration.
-
orionis.http.layer.shared.security.SecurityMiddleware.__allowed_hosts
orionis.http.layer.shared.security.SecurityMiddleware.html#__allowed_hosts
Attribute
Instance Variable
PUBLIC
Allowed hosts produced by frozenset.
-
orionis.http.layer.shared.security.SecurityMiddleware.__allowed_host_suffixes
orionis.http.layer.shared.security.SecurityMiddleware.html#__allowed_host_suffixes
Attribute
Instance Variable
PUBLIC
Allowed host suffixes produced by tuple.
-
orionis.http.layer.shared.security.SecurityMiddleware.__enforce_hosts
orionis.http.layer.shared.security.SecurityMiddleware.html#__enforce_hosts
Attribute
Instance Variable
PUBLIC
Host validation is skipped entirely when no allowlist is set.
-
orionis.http.layer.shared.security.SecurityMiddleware.__default_responses
orionis.http.layer.shared.security.SecurityMiddleware.html#__default_responses
Attribute
Instance Variable
PUBLIC
Predefined default responses for common HTTP errors.
-
orionis.http.layer.shared.security.SecurityMiddleware.__isAllowedHost
orionis.http.layer.shared.security.SecurityMiddleware.html#__isAllowedHost
Function
Method
PUBLIC
Check a hostname against the configured allowlist.
-
orionis.http.layer.shared.security.SecurityMiddleware.handle
orionis.http.layer.shared.security.SecurityMiddleware.html#handle
Function
Method
PUBLIC
Inspect the incoming request and enforce all security policies.
-
orionis.http.layer.web.csrf_token._SAFE_METHODS
orionis.http.layer.web.csrf_token.html#_SAFE_METHODS
Attribute
Constant
PUBLIC
CSRF check is skipped entirely.
-
orionis.http.layer.web.csrf_token._FORM_MIME_URLENCODED
orionis.http.layer.web.csrf_token.html#_FORM_MIME_URLENCODED
Attribute
Constant
PUBLIC
Content-Types that may carry the CSRF value inside the request body.
-
orionis.http.layer.web.csrf_token._FORM_MIME_MULTIPART
orionis.http.layer.web.csrf_token.html#_FORM_MIME_MULTIPART
Attribute
Constant
PUBLIC
multipart/form-data.
-
orionis.http.layer.web.csrf_token._HDR_CSRF
orionis.http.layer.web.csrf_token.html#_HDR_CSRF
Attribute
Constant
PUBLIC
Request header names inspected for the submitted value (lowercase).
-
orionis.http.layer.web.csrf_token._HDR_XSRF
orionis.http.layer.web.csrf_token.html#_HDR_XSRF
Attribute
Constant
PUBLIC
x-xsrf-token.
-
orionis.http.layer.web.csrf_token._FIELD_CSRF
orionis.http.layer.web.csrf_token.html#_FIELD_CSRF
Attribute
Constant
PUBLIC
Form field names inspected for the submitted value, in priority order.
-
orionis.http.layer.web.csrf_token._FIELD_CSRF_ALT
orionis.http.layer.web.csrf_token.html#_FIELD_CSRF_ALT
Attribute
Constant
PUBLIC
csrf_token.
-
orionis.http.layer.web.csrf_token.CSRFTokenMiddleware
orionis.http.layer.web.csrf_token.CSRFTokenMiddleware.html
Class
Class
PUBLIC
Web-layer middleware that enforces Cross-Site Request Forgery protection.
-
orionis.http.layer.web.csrf_token.CSRFTokenMiddleware.__slots__
orionis.http.layer.web.csrf_token.CSRFTokenMiddleware.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.http.layer.web.csrf_token.CSRFTokenMiddleware.__init__
orionis.http.layer.web.csrf_token.CSRFTokenMiddleware.html#__init__
Function
Method
PUBLIC
Initialise the middleware from a raw configuration dictionary.
-
orionis.http.layer.web.csrf_token.CSRFTokenMiddleware._cfg
orionis.http.layer.web.csrf_token.CSRFTokenMiddleware.html#_cfg
Attribute
Instance Variable
PUBLIC
Cfg supplied through cfg.
-
orionis.http.layer.web.csrf_token.CSRFTokenMiddleware._enabled
orionis.http.layer.web.csrf_token.CSRFTokenMiddleware.html#_enabled
Attribute
Instance Variable
PUBLIC
Store the settings used by the token lifecycle.
-
orionis.http.layer.web.csrf_token.CSRFTokenMiddleware._session_key
orionis.http.layer.web.csrf_token.CSRFTokenMiddleware.html#_session_key
Attribute
Instance Variable
PUBLIC
Session key under which the authenticated identity is stored.
-
orionis.http.layer.web.csrf_token.CSRFTokenMiddleware._token_length
orionis.http.layer.web.csrf_token.CSRFTokenMiddleware.html#_token_length
Attribute
Instance Variable
PUBLIC
Token length obtained from cfg.token_length.
-
orionis.http.layer.web.csrf_token.CSRFTokenMiddleware._xsrf_cookie
orionis.http.layer.web.csrf_token.CSRFTokenMiddleware.html#_xsrf_cookie
Attribute
Instance Variable
PUBLIC
Xsrf cookie obtained from cfg.xsrf_cookie.
-
orionis.http.layer.web.csrf_token.CSRFTokenMiddleware.handle
orionis.http.layer.web.csrf_token.CSRFTokenMiddleware.html#handle
Function
Method
PUBLIC
Execute the CSRF lifecycle for one HTTP request.
-
orionis.http.layer.web.csrf_token.CSRFTokenMiddleware.__resolveToken
orionis.http.layer.web.csrf_token.CSRFTokenMiddleware.html#__resolveToken
Function
Method
PUBLIC
Return the CSRF token for this session, creating it if absent.
-
orionis.http.layer.web.csrf_token.CSRFTokenMiddleware.__extractFromBody
orionis.http.layer.web.csrf_token.CSRFTokenMiddleware.html#__extractFromBody
Function
Static Method
PUBLIC
Return the CSRF token from the parsed form body, or None.
-
orionis.http.layer.web.csrf_token.CSRFTokenMiddleware.__attachXsrfCookie
orionis.http.layer.web.csrf_token.CSRFTokenMiddleware.html#__attachXsrfCookie
Function
Method
PUBLIC
Set the XSRF-TOKEN cookie on the outgoing response.
-
orionis.session.session._FLASH_NEW
orionis.session.session.html#_FLASH_NEW
Attribute
Constant
PUBLIC
Identify flash values written during the current request.
-
orionis.session.session._FLASH_OLD
orionis.session.session.html#_FLASH_OLD
Attribute
Constant
PUBLIC
_flash_old.
-
orionis.session.session._MISSING
orionis.session.session.html#_MISSING
Attribute
Constant
PUBLIC
Sentinel distinguishing missing from ordinary values.
-
orionis.session.session._IMMUTABLE_VALUE_TYPES
orionis.session.session.html#_IMMUTABLE_VALUE_TYPES
Attribute
Constant
PUBLIC
Immutable value types used by session.
-
orionis.session.session.Session
orionis.session.session.Session.html
Class
Class
PUBLIC
Runtime representation of a single HTTP session.
-
orionis.session.session.Session._id
orionis.session.session.Session.html#_id
Attribute
Instance Variable
PUBLIC
Unique session identifier; None until first activation.
-
orionis.session.session.Session._data
orionis.session.session.Session.html#_data
Attribute
Instance Variable
PUBLIC
In-memory key-value payload.
-
orionis.session.session.Session._started
orionis.session.session.Session.html#_started
Attribute
Instance Variable
PUBLIC
True once the session has been activated by any write.
-
orionis.session.session.Session._dirty
orionis.session.session.Session.html#_dirty
Attribute
Instance Variable
PUBLIC
True when the in-memory session state must be persisted before the response is sent.
-
orionis.session.session.Session._invalidated
orionis.session.session.Session.html#_invalidated
Attribute
Instance Variable
PUBLIC
True when the session should be fully deleted.
-
orionis.session.session.Session._is_new
orionis.session.session.Session.html#_is_new
Attribute
Instance Variable
PUBLIC
True for sessions that were not restored from a store.
-
orionis.session.session.Session._regenerate
orionis.session.session.Session.html#_regenerate
Attribute
Instance Variable
PUBLIC
True when the ID must be rotated before the next save.
-
orionis.session.session.Session._renew_at
orionis.session.session.Session.html#_renew_at
Attribute
Instance Variable
PUBLIC
Deadline for renewing an unchanged scalar payload. None requires persistence because no deadline is known or mutable data is present.
-
orionis.session.session.Session.__slots__
orionis.session.session.Session.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.session.session.Session.__init__
orionis.session.session.Session.html#__init__
Function
Method
PUBLIC
Initialise a session instance.
-
orionis.session.session.Session.__activate
orionis.session.session.Session.html#__activate
Function
Method
PUBLIC
Ensure the session has an identifier and is marked active.
-
orionis.session.session.Session.id
orionis.session.session.Session.html#id
Attribute
Property
PUBLIC
Return the current session identifier.
-
orionis.session.session.Session.started
orionis.session.session.Session.html#started
Attribute
Property
PUBLIC
Report whether the session has been activated.
-
orionis.session.session.Session.dirty
orionis.session.session.Session.html#dirty
Attribute
Property
PUBLIC
Report whether changes require persistence.
-
orionis.session.session.Session.invalidated
orionis.session.session.Session.html#invalidated
Attribute
Property
PUBLIC
Report whether the session has been invalidated.
-
orionis.session.session.Session.isNew
orionis.session.session.Session.html#isNew
Attribute
Property
PUBLIC
Report whether the session has a new storage identity.
-
orionis.session.session.Session.wantsRegenerate
orionis.session.session.Session.html#wantsRegenerate
Attribute
Property
PUBLIC
Report whether the session requests identifier rotation.
-
orionis.session.session.Session.get
orionis.session.session.Session.html#get
Function
Method
PUBLIC
Return the value for key, or default when absent.
-
orionis.session.session.Session.put
orionis.session.session.Session.html#put
Function
Method
PUBLIC
Store value under key, activating the session on the first call.
-
orionis.session.session.Session.has
orionis.session.session.Session.html#has
Function
Method
PUBLIC
Return True when key exists in the session data.
-
orionis.session.session.Session.forget
orionis.session.session.Session.html#forget
Function
Method
PUBLIC
Remove key from session data (no-op when absent).
-
orionis.session.session.Session.clear
orionis.session.session.Session.html#clear
Function
Method
PUBLIC
Remove all data from this session.
-
orionis.session.session.Session.flash
orionis.session.session.Session.html#flash
Function
Method
PUBLIC
Store value under key for exactly one subsequent request.
-
orionis.session.session.Session.getFlash
orionis.session.session.Session.html#getFlash
Function
Method
PUBLIC
Return the flash value for key.
-
orionis.session.session.Session.__mergeReservedBag
orionis.session.session.Session.html#__mergeReservedBag
Function
Method
PUBLIC
Merge values with the reserved bag already flashed in this request.
-
orionis.session.session.Session.flashInput
orionis.session.session.Session.html#flashInput
Function
Method
PUBLIC
Flash a submitted form payload so the next request can repopulate it.
-
orionis.session.session.Session.getOldInput
orionis.session.session.Session.html#getOldInput
Function
Method
PUBLIC
Return the value submitted for key in the previous request.
-
orionis.session.session.Session.flashErrors
orionis.session.session.Session.html#flashErrors
Function
Method
PUBLIC
Flash validation errors for the next request.
-
orionis.session.session.Session.getErrors
orionis.session.session.Session.html#getErrors
Function
Method
PUBLIC
Return the validation errors flashed for this request.
-
orionis.session.session.Session.setPreviousUrl
orionis.session.session.Session.html#setPreviousUrl
Function
Method
PUBLIC
Remember the page the user is currently viewing.
-
orionis.session.session.Session.getPreviousUrl
orionis.session.session.Session.html#getPreviousUrl
Function
Method
PUBLIC
Return the last page the user navigated to.
-
orionis.session.session.Session.regenerate
orionis.session.session.Session.html#regenerate
Function
Method
PUBLIC
Request a session ID rotation (e.g. immediately after login).
-
orionis.session.session.Session.invalidate
orionis.session.session.Session.html#invalidate
Function
Method
PUBLIC
Mark the session for full deletion and clear in-memory data.
-
orionis.session.session.Session.all
orionis.session.session.Session.html#all
Function
Method
PUBLIC
Return a shallow copy of the current session data.
-
orionis.session.session.Session._setRenewalDeadline
orionis.session.session.Session.html#_setRenewalDeadline
Function
Method
PUBLIC
Set a renewal deadline for payloads containing immutable scalars.
-
orionis.session.session.Session._needsPersistence
orionis.session.session.Session.html#_needsPersistence
Function
Method
PUBLIC
Check whether payload changes or the renewal deadline require a save.
-
orionis.session.session.Session._ageFlashData
orionis.session.session.Session.html#_ageFlashData
Function
Method
PUBLIC
Advance the flash lifecycle: new → old; discard previous old.
-
orionis.session.session.Session._rotateId
orionis.session.session.Session.html#_rotateId
Function
Method
PUBLIC
Assign a fresh identifier and return the previous one.
-
orionis.session.session.Session._markClean
orionis.session.session.Session.html#_markClean
Function
Method
PUBLIC
Reset the dirty flag after a successful persistence operation.
-
orionis.session.manager._VALID_SESSION_ID
orionis.session.manager.html#_VALID_SESSION_ID
Attribute
Constant
PUBLIC
Compiled pattern used to recognize valid session id.
-
orionis.session.manager.SessionManager
orionis.session.manager.SessionManager.html
Class
Class
PUBLIC
Coordinate the session lifecycle for every HTTP request.
-
orionis.session.manager.SessionManager.__slots__
orionis.session.manager.SessionManager.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.session.manager.SessionManager.__init__
orionis.session.manager.SessionManager.html#__init__
Function
Method
PUBLIC
Initialise the manager, pre-computing all request-invariant values.
-
orionis.session.manager.SessionManager._app
orionis.session.manager.SessionManager.html#_app
Attribute
Instance Variable
PUBLIC
The application instance.
-
orionis.session.manager.SessionManager._store
orionis.session.manager.SessionManager.html#_store
Attribute
Instance Variable
PUBLIC
Pre-built backing-store instance.
-
orionis.session.manager.SessionManager._lifetime_delta
orionis.session.manager.SessionManager.html#_lifetime_delta
Attribute
Instance Variable
PUBLIC
Lifetime delta produced by timedelta.
-
orionis.session.manager.SessionManager._renewal_delta
orionis.session.manager.SessionManager.html#_renewal_delta
Attribute
Instance Variable
PUBLIC
Interval used to calculate the next session renewal deadline.
-
orionis.session.manager.SessionManager._renewal_window
orionis.session.manager.SessionManager.html#_renewal_window
Attribute
Instance Variable
PUBLIC
Window during which a session becomes eligible for renewal.
-
orionis.session.manager.SessionManager._track_previous_url
orionis.session.manager.SessionManager.html#_track_previous_url
Attribute
Instance Variable
PUBLIC
Track previous url obtained from config.track_previous_url.
-
orionis.session.manager.SessionManager._cookie_name
orionis.session.manager.SessionManager.html#_cookie_name
Attribute
Instance Variable
PUBLIC
Cookie name obtained from config.cookie.
-
orionis.session.manager.SessionManager._cookie_path
orionis.session.manager.SessionManager.html#_cookie_path
Attribute
Instance Variable
PUBLIC
Cookie path obtained from config.path.
-
orionis.session.manager.SessionManager._cookie_domain
orionis.session.manager.SessionManager.html#_cookie_domain
Attribute
Instance Variable
PUBLIC
Cookie domain obtained from config.domain.
-
orionis.session.manager.SessionManager._cookie_max_age
orionis.session.manager.SessionManager.html#_cookie_max_age
Attribute
Instance Variable
PUBLIC
Lifetime applied to the session cookie.
-
orionis.session.manager.SessionManager._cookie_secure
orionis.session.manager.SessionManager.html#_cookie_secure
Attribute
Instance Variable
PUBLIC
Cookie secure obtained from config.secure.
-
orionis.session.manager.SessionManager._cookie_http_only
orionis.session.manager.SessionManager.html#_cookie_http_only
Attribute
Instance Variable
PUBLIC
Cookie http only obtained from config.http_only.
-
orionis.session.manager.SessionManager._cookie_same_site
orionis.session.manager.SessionManager.html#_cookie_same_site
Attribute
Instance Variable
PUBLIC
Cookie same site produced by getattr.
-
orionis.session.manager.SessionManager._cookie_partitioned
orionis.session.manager.SessionManager.html#_cookie_partitioned
Attribute
Instance Variable
PUBLIC
Cookie partitioned obtained from config.partitioned.
-
orionis.session.manager.SessionManager.tracksPreviousUrl
orionis.session.manager.SessionManager.html#tracksPreviousUrl
Attribute
Property
PUBLIC
Return whether session middleware remembers successful navigation URLs.
-
orionis.session.manager.SessionManager.start
orionis.session.manager.SessionManager.html#start
Function
Method
PUBLIC
Restore or create a session for the incoming request.
-
orionis.session.manager.SessionManager.save
orionis.session.manager.SessionManager.html#save
Function
Method
PUBLIC
Persist the session and set the cookie on response.
-
orionis.session.manager.SessionManager.abort
orionis.session.manager.SessionManager.html#abort
Function
Method
PUBLIC
Persist pending revocation when a request cannot produce a response.
-
orionis.session.manager.SessionManager.__register
orionis.session.manager.SessionManager.html#__register
Function
Method
PUBLIC
Register the session in the application container.
-
orionis.session.manager.SessionManager.__resolveStore
orionis.session.manager.SessionManager.html#__resolveStore
Function
Method
PUBLIC
Resolve and return the configured session store implementation.
-
orionis.session.manager.SessionManager.__restore
orionis.session.manager.SessionManager.html#__restore
Function
Method
PUBLIC
Load a session from the store, or return a blank lazy session.
-
orionis.session.manager.SessionManager.__persist
orionis.session.manager.SessionManager.html#__persist
Function
Method
PUBLIC
Write the current session state to the backing store.
-
orionis.session.manager.SessionManager.__rotateId
orionis.session.manager.SessionManager.html#__rotateId
Function
Method
PUBLIC
Replace the session ID, deleting the old record from the store.
-
orionis.session.manager.SessionManager.__invalidateSession
orionis.session.manager.SessionManager.html#__invalidateSession
Function
Method
PUBLIC
Remove the session record and expire the cookie on response.
-
orionis.session.manager.SessionManager.__setCookie
orionis.session.manager.SessionManager.html#__setCookie
Function
Method
PUBLIC
Attach the session identifier cookie to response.
-
orionis.session.manager.SessionManager.__deleteCookie
orionis.session.manager.SessionManager.html#__deleteCookie
Function
Method
PUBLIC
Set an expired cookie to instruct the browser to clear it.
-
orionis.http.layer.web.start_session._NAVIGATION_METHODS
orionis.http.layer.web.start_session.html#_NAVIGATION_METHODS
Attribute
Constant
PUBLIC
Only plain navigations are worth remembering as the "previous page".
-
orionis.http.layer.web.start_session._SUCCESS_MIN
orionis.http.layer.web.start_session.html#_SUCCESS_MIN
Attribute
Constant
PUBLIC
Successful responses eligible to become the previous page.
-
orionis.http.layer.web.start_session._SUCCESS_MAX
orionis.http.layer.web.start_session.html#_SUCCESS_MAX
Attribute
Constant
PUBLIC
Success max value used by start_session.
-
orionis.http.layer.web.start_session.StartSessionMiddleware
orionis.http.layer.web.start_session.StartSessionMiddleware.html
Class
Class
PUBLIC
Open request sessions and persist their response-side changes.
-
orionis.http.layer.web.start_session.StartSessionMiddleware.__slots__
orionis.http.layer.web.start_session.StartSessionMiddleware.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.http.layer.web.start_session.StartSessionMiddleware.__init__
orionis.http.layer.web.start_session.StartSessionMiddleware.html#__init__
Function
Method
PUBLIC
Initialise the middleware with the given session manager.
-
orionis.http.layer.web.start_session.StartSessionMiddleware._manager
orionis.http.layer.web.start_session.StartSessionMiddleware.html#_manager
Attribute
Instance Variable
PUBLIC
Session manager used for the start / save cycle.
-
orionis.http.layer.web.start_session.StartSessionMiddleware._catch
orionis.http.layer.web.start_session.StartSessionMiddleware.html#_catch
Attribute
Instance Variable
PUBLIC
Framework exception handler producing responses before persistence.
-
orionis.http.layer.web.start_session.StartSessionMiddleware._track_previous_url
orionis.http.layer.web.start_session.StartSessionMiddleware.html#_track_previous_url
Attribute
Instance Variable
PUBLIC
Track previous url obtained from manager.tracksPreviousUrl.
-
orionis.http.layer.web.start_session.StartSessionMiddleware.handle
orionis.http.layer.web.start_session.StartSessionMiddleware.html#handle
Function
Method
PUBLIC
Process the request through the session lifecycle.
-
orionis.http.layer.web.start_session.StartSessionMiddleware.__response
orionis.http.layer.web.start_session.StartSessionMiddleware.html#__response
Function
Method
PUBLIC
Render failures while the session is still available for persistence.
-
orionis.http.layer.web.start_session.StartSessionMiddleware.__storeCurrentUrl
orionis.http.layer.web.start_session.StartSessionMiddleware.html#__storeCurrentUrl
Function
Static Method
PUBLIC
Record the current URL as the page to redirect back to.
-
orionis.http.routes.entities.resolved_route._EMPTY_PARAMS
orionis.http.routes.entities.resolved_route.html#_EMPTY_PARAMS
Attribute
Constant
PUBLIC
Empty params used by resolved_route.
-
orionis.http.routes.entities.resolved_route.ResolvedRoute
orionis.http.routes.entities.resolved_route.ResolvedRoute.html
Class
Class
PUBLIC
Represent the immutable result of a successful route resolution.
-
orionis.http.routes.entities.resolved_route.ResolvedRoute.route
orionis.http.routes.entities.resolved_route.ResolvedRoute.html#route
Attribute
Instance Variable
PUBLIC
The matched compiled route descriptor.
-
orionis.http.routes.entities.resolved_route.ResolvedRoute.params
orionis.http.routes.entities.resolved_route.ResolvedRoute.html#params
Attribute
Instance Variable
PUBLIC
Path parameters extracted and type-converted from the URL. Empty for static routes.
-
orionis.http.routes.entities.resolved_route.ResolvedRoute.__post_init__
orionis.http.routes.entities.resolved_route.ResolvedRoute.html#__post_init__
Function
Method
PUBLIC
Freeze parameters so cached results can be shared across requests.
-
orionis.http.routes.entities.resolved_route.ResolvedRoute._fromOwnedParams
orionis.http.routes.entities.resolved_route.ResolvedRoute.html#_fromOwnedParams
Function
Class Method
PUBLIC
Freeze a parameter dict exclusively owned by the route resolver.
-
orionis.http.routes.entities.resolved_route.ResolvedRoute.kind
orionis.http.routes.entities.resolved_route.ResolvedRoute.html#kind
Attribute
Property
PUBLIC
Return the route group kind ('web' or 'api').
-
orionis.http.routes.contracts.route_resolver.IRouteResolver
orionis.http.routes.contracts.route_resolver.IRouteResolver.html
Class
Class
PUBLIC
Define the contract for route resolver implementations.
-
orionis.http.routes.contracts.route_resolver.IRouteResolver.resolve
orionis.http.routes.contracts.route_resolver.IRouteResolver.html#resolve
Function
Method
PUBLIC
Resolve a method and path into a compiled route.
-
orionis.http.routes.contracts.route_resolver.IRouteResolver.options
orionis.http.routes.contracts.route_resolver.IRouteResolver.html#options
Function
Method
PUBLIC
Resolve all allowed methods for a path.
-
orionis.http.routes.contracts.route_resolver.IRouteResolver.fallback
orionis.http.routes.contracts.route_resolver.IRouteResolver.html#fallback
Function
Method
PUBLIC
Return the registered fallback handler.
-
orionis.http.routes.contracts.route_resolver.IRouteResolver.allRoutes
orionis.http.routes.contracts.route_resolver.IRouteResolver.html#allRoutes
Function
Method
PUBLIC
Return all compiled routes across all HTTP methods.
-
orionis.http.routes.contracts.route_resolver.IRouteResolver.invalidateCache
orionis.http.routes.contracts.route_resolver.IRouteResolver.html#invalidateCache
Function
Method
PUBLIC
Clear the hot-path cache.
-
orionis.http.routes.route_resolver._GROUP_NAME_RE
orionis.http.routes.route_resolver.html#_GROUP_NAME_RE
Attribute
Constant
PUBLIC
Compiled pattern used to recognize group name re.
-
orionis.http.routes.route_resolver._METHOD_MAP
orionis.http.routes.route_resolver.html#_METHOD_MAP
Attribute
Constant
PUBLIC
Canonical dispatch method per incoming method string; HEAD is served by the GET table.
-
orionis.http.routes.route_resolver.ParamConverter
orionis.http.routes.route_resolver.html#ParamConverter
Attribute
Type Alias
PUBLIC
Type alias for Callable[[str], object].
-
orionis.http.routes.route_resolver.BucketEntry
orionis.http.routes.route_resolver.html#BucketEntry
Attribute
Type Alias
PUBLIC
Type alias for tuple[list[Extractor], 'CompiledRoute'].
-
orionis.http.routes.route_resolver._DepthBucket
orionis.http.routes.route_resolver._DepthBucket.html
Class
Class
PUBLIC
Group compiled route candidates by their path segment structure.
-
orionis.http.routes.route_resolver._DepthBucket.__slots__
orionis.http.routes.route_resolver._DepthBucket.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.http.routes.route_resolver._DepthBucket.__init__
orionis.http.routes.route_resolver._DepthBucket.html#__init__
Function
Method
PUBLIC
Store matching and parameter extraction metadata for dynamic routes.
-
orionis.http.routes.route_resolver._DepthBucket.pattern
orionis.http.routes.route_resolver._DepthBucket.html#pattern
Attribute
Instance Variable
PUBLIC
Compiled regex for the bucket's dynamic route candidates.
-
orionis.http.routes.route_resolver._DepthBucket.entries
orionis.http.routes.route_resolver._DepthBucket.html#entries
Attribute
Instance Variable
PUBLIC
Extraction metadata and route pairs aligned with regex alternatives.
-
orionis.http.routes.route_resolver._DepthBucket.marker_to_entry
orionis.http.routes.route_resolver._DepthBucket.html#marker_to_entry
Attribute
Instance Variable
PUBLIC
Map of terminal capture group IDs to entry indices, or None for a single-route bucket. Defaults to None.
-
orionis.http.routes.route_resolver._PrefixIndex
orionis.http.routes.route_resolver._PrefixIndex.html
Class
Class
PUBLIC
Select the first distinct segment after a shared static path prefix.
-
orionis.http.routes.route_resolver._PrefixIndex.start
orionis.http.routes.route_resolver._PrefixIndex.html#start
Attribute
Class Variable
PUBLIC
Starting position used to search the route-prefix index.
-
orionis.http.routes.route_resolver._PrefixIndex.branches
orionis.http.routes.route_resolver._PrefixIndex.html#branches
Attribute
Class Variable
PUBLIC
Child branches of the compiled route-prefix index.
-
orionis.http.routes.route_resolver._PrefixIndex.fallback
orionis.http.routes.route_resolver._PrefixIndex.html#fallback
Attribute
Class Variable
PUBLIC
Handler or route selected when no ordinary route matches.
-
orionis.http.routes.route_resolver.DepthTable
orionis.http.routes.route_resolver.html#DepthTable
Attribute
Type Alias
PUBLIC
Type alias for dict[int, _DepthBucket | _PrefixIndex].
-
orionis.http.routes.route_resolver._select_bucket
orionis.http.routes.route_resolver.html#_select_bucket
Function
Function
PUBLIC
Select a dynamic route bucket by path depth and literal segments.
-
orionis.http.routes.route_resolver._path_allowed_for_method
orionis.http.routes.route_resolver.html#_path_allowed_for_method
Function
Function
PUBLIC
Check whether a method has a static or regex match for a path.
-
orionis.http.routes.route_resolver._build_matching_bucket
orionis.http.routes.route_resolver.html#_build_matching_bucket
Function
Function
PUBLIC
Build an ordered matcher and extractors for dynamic routes.
-
orionis.http.routes.route_resolver._partition_route_segments
orionis.http.routes.route_resolver.html#_partition_route_segments
Function
Function
PUBLIC
Partition literal and wildcard path segments in candidate order.
-
orionis.http.routes.route_resolver._build_depth_bucket
orionis.http.routes.route_resolver.html#_build_depth_bucket
Function
Function
PUBLIC
Build a depth matcher, splitting literal prefixes when useful.
-
orionis.http.routes.route_resolver._build_overlapping_index
orionis.http.routes.route_resolver.html#_build_overlapping_index
Function
Function
PUBLIC
Merge wildcard candidates into literal branches in route order.
-
orionis.http.routes.route_resolver.RouteResolver
orionis.http.routes.route_resolver.RouteResolver.html
Class
Class
PUBLIC
Resolve compiled routes using static maps and ordered dynamic buckets.
-
orionis.http.routes.route_resolver.RouteResolver.__slots__
orionis.http.routes.route_resolver.RouteResolver.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.http.routes.route_resolver.RouteResolver.__init__
orionis.http.routes.route_resolver.RouteResolver.html#__init__
Function
Method
PUBLIC
Build lookup tables and the bounded FIFO result cache.
-
orionis.http.routes.route_resolver.RouteResolver._tables
orionis.http.routes.route_resolver.RouteResolver.html#_tables
Attribute
Instance Variable
PUBLIC
Table metadata indexed for query compilation or route lookup.
-
orionis.http.routes.route_resolver.RouteResolver._routes
orionis.http.routes.route_resolver.RouteResolver.html#_routes
Attribute
Instance Variable
PUBLIC
Compiler output grouped by method and static/dynamic paths.
-
orionis.http.routes.route_resolver.RouteResolver._global_static
orionis.http.routes.route_resolver.RouteResolver.html#_global_static
Attribute
Instance Variable
PUBLIC
Global static produced by frozenset.
-
orionis.http.routes.route_resolver.RouteResolver._cache_order
orionis.http.routes.route_resolver.RouteResolver.html#_cache_order
Attribute
Instance Variable
PUBLIC
Cache order produced by deque.
-
orionis.http.routes.route_resolver.RouteResolver._cache_max
orionis.http.routes.route_resolver.RouteResolver.html#_cache_max
Attribute
Instance Variable
PUBLIC
Maximum dynamic results cached across all methods; zero disables caching. Defaults to 512.
-
orionis.http.routes.route_resolver.RouteResolver._fallback
orionis.http.routes.route_resolver.RouteResolver.html#_fallback
Attribute
Instance Variable
PUBLIC
Fallback handler metadata. None or (None, None) disables the fallback. Defaults to None.
-
orionis.http.routes.route_resolver.RouteResolver.resolve
orionis.http.routes.route_resolver.RouteResolver.html#resolve
Function
Method
PUBLIC
Resolve a request method and path using prebuilt dispatch metadata.
-
orionis.http.routes.route_resolver.RouteResolver.__raiseForUnmatchedPath
orionis.http.routes.route_resolver.RouteResolver.html#__raiseForUnmatchedPath
Function
Method
PUBLIC
Distinguish an unknown path from a path registered for another method.
-
orionis.http.routes.route_resolver.RouteResolver.__resolveDynamic
orionis.http.routes.route_resolver.RouteResolver.html#__resolveDynamic
Function
Method
PUBLIC
Resolve dynamic candidates and cache a successful conversion.
-
orionis.http.routes.route_resolver.RouteResolver.options
orionis.http.routes.route_resolver.RouteResolver.html#options
Function
Method
PUBLIC
Return the sorted HTTP methods whose routes match a path.
-
orionis.http.routes.route_resolver.RouteResolver.fallback
orionis.http.routes.route_resolver.RouteResolver.html#fallback
Function
Method
PUBLIC
Return the configured fallback handler metadata.
-
orionis.http.routes.route_resolver.RouteResolver.allRoutes
orionis.http.routes.route_resolver.RouteResolver.html#allRoutes
Function
Method
PUBLIC
Return a fresh list of all unique compiled routes.
-
orionis.http.routes.route_resolver.RouteResolver.invalidateCache
orionis.http.routes.route_resolver.RouteResolver.html#invalidateCache
Function
Method
PUBLIC
Clear all dynamic route results and their FIFO eviction order.
-
orionis.http.routes.route_resolver.RouteResolver.__storeCache
orionis.http.routes.route_resolver.RouteResolver.html#__storeCache
Function
Method
PUBLIC
Cache a dynamic result, evicting the oldest entry at capacity.
-
orionis.http.validation._DEFAULT_PORTS
orionis.http.validation.html#_DEFAULT_PORTS
Attribute
Constant
PUBLIC
Default ports definitions used by validation.
-
orionis.http.validation._FIRST_PRINTABLE_CODE
orionis.http.validation.html#_FIRST_PRINTABLE_CODE
Attribute
Constant
PUBLIC
First printable code value used by validation.
-
orionis.http.validation._DELETE_CODE
orionis.http.validation.html#_DELETE_CODE
Attribute
Constant
PUBLIC
Delete code value used by validation.
-
orionis.http.validation._url_origin
orionis.http.validation.html#_url_origin
Function
Function
PUBLIC
Extract the normalized scheme, hostname, and effective port of a URL.
-
orionis.http.validation._is_local_reference
orionis.http.validation.html#_is_local_reference
Function
Function
PUBLIC
Accept a local path or an absolute reference with the application origin.
-
orionis.http.validation.validation_response
orionis.http.validation.html#validation_response
Function
Function
PUBLIC
Translate a schema validation failure into an HTTP response.
-
orionis.http.validation.previous_url
orionis.http.validation.html#previous_url
Function
Function
PUBLIC
Resolve the page a failed submission should be redirected back to.
-
orionis.realtime.decorators.MAX_TARGET_LENGTH
orionis.realtime.decorators.html#MAX_TARGET_LENGTH
Attribute
Constant
PUBLIC
Max target length value used by decorators.
-
orionis.realtime.decorators.REMOTE_ATTRIBUTE
orionis.realtime.decorators.html#REMOTE_ATTRIBUTE
Attribute
Constant
PUBLIC
__orionis_remote_name__.
-
orionis.realtime.decorators.validate_remote_name
orionis.realtime.decorators.html#validate_remote_name
Function
Function
PUBLIC
Validate a public method name or alias without evaluating it.
-
orionis.realtime.clients._MAX_IDENTIFIER
orionis.realtime.clients.html#_MAX_IDENTIFIER
Attribute
Constant
PUBLIC
Max identifier value used by clients.
-
orionis.realtime.clients._MAX_GROUP
orionis.realtime.clients.html#_MAX_GROUP
Attribute
Constant
PUBLIC
Max group value used by clients.
-
orionis.realtime.clients._MAX_ARGUMENTS
orionis.realtime.clients.html#_MAX_ARGUMENTS
Attribute
Constant
PUBLIC
Max arguments value used by clients.
-
orionis.realtime.clients.validate_identifier
orionis.realtime.clients.html#validate_identifier
Function
Function
PUBLIC
Validate a bounded, nonempty connection or public method identifier.
-
orionis.realtime.clients.validate_group
orionis.realtime.clients.html#validate_group
Function
Function
PUBLIC
Validate a bounded, nonempty group name.
-
orionis.realtime.clients._validate_call
orionis.realtime.clients.html#_validate_call
Function
Function
PUBLIC
Validate a public client target and its argument count.
-
orionis.realtime.clients.ClientTarget
orionis.realtime.clients.ClientTarget.html
Class
Class
PUBLIC
Send to a Hub-local selection or invoke one explicitly selected client.
-
orionis.realtime.clients.ClientTarget.__slots__
orionis.realtime.clients.ClientTarget.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.realtime.clients.ClientTarget.__init__
orionis.realtime.clients.ClientTarget.html#__init__
Function
Method
PUBLIC
Store a connection selection without retaining connection objects.
-
orionis.realtime.clients.ClientTarget._manager
orionis.realtime.clients.ClientTarget.html#_manager
Attribute
Instance Variable
PUBLIC
Registry owning local connections.
-
orionis.realtime.clients.ClientTarget._hub
orionis.realtime.clients.ClientTarget.html#_hub
Attribute
Instance Variable
PUBLIC
Namespace limiting every selected recipient.
-
orionis.realtime.clients.ClientTarget._single
orionis.realtime.clients.ClientTarget.html#_single
Attribute
Instance Variable
PUBLIC
Single produced by isinstance.
-
orionis.realtime.clients.ClientTarget._ids
orionis.realtime.clients.ClientTarget.html#_ids
Attribute
Instance Variable
PUBLIC
Connection identifiers selected as the client invocation targets.
-
orionis.realtime.clients.ClientTarget._group
orionis.realtime.clients.ClientTarget.html#_group
Attribute
Instance Variable
PUBLIC
Hub-local group to select when no identifiers are supplied.
-
orionis.realtime.clients.ClientTarget._excluded
orionis.realtime.clients.ClientTarget.html#_excluded
Attribute
Instance Variable
PUBLIC
Connection to omit from an all-connections or group selection.
-
orionis.realtime.clients.ClientTarget._recipients
orionis.realtime.clients.ClientTarget.html#_recipients
Function
Method
PUBLIC
Snapshot the identifiers selected for Hub-local delivery.
-
orionis.realtime.clients.ClientTarget.send
orionis.realtime.clients.ClientTarget.html#send
Function
Method
PUBLIC
Deliver a client event and report per-recipient delivery outcomes.
-
orionis.realtime.clients.ClientTarget.invoke
orionis.realtime.clients.ClientTarget.html#invoke
Function
Method
PUBLIC
Invoke one selected client and await its correlated completion.
-
orionis.realtime.errors.RPCError
orionis.realtime.errors.RPCError.html
Class
Exception
PUBLIC
Report a deliberate, client-safe remote invocation failure.
-
orionis.realtime.errors.RPCError.__slots__
orionis.realtime.errors.RPCError.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.realtime.errors.RPCError.__init__
orionis.realtime.errors.RPCError.html#__init__
Function
Method
PUBLIC
Retain the explicit public error code and message.
-
orionis.realtime.errors.RPCError.code
orionis.realtime.errors.RPCError.html#code
Attribute
Instance Variable
PUBLIC
Stable application or framework error identifier.
-
orionis.realtime.errors.RPCError.message
orionis.realtime.errors.RPCError.html#message
Attribute
Instance Variable
PUBLIC
Public explanation that must not contain secrets.
-
orionis.realtime.errors.ProtocolError
orionis.realtime.errors.ProtocolError.html
Class
Exception
PUBLIC
Report an invalid envelope or incompatible WebSocket frame.
-
orionis.realtime.errors.ProtocolError.__slots__
orionis.realtime.errors.ProtocolError.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.realtime.errors.ProtocolError.__init__
orionis.realtime.errors.ProtocolError.html#__init__
Function
Method
PUBLIC
Retain a sanitized explanation and the appropriate close code.
-
orionis.realtime.errors.ProtocolError.close_code
orionis.realtime.errors.ProtocolError.html#close_code
Attribute
Instance Variable
PUBLIC
WebSocket close code; defaults to protocol violation.
-
orionis.realtime.errors.ClientInvocationError
orionis.realtime.errors.ClientInvocationError.html
Class
Exception
PUBLIC
Report a client completion failure to the invoking application service.
-
orionis.realtime.errors.ClientInvocationError.__slots__
orionis.realtime.errors.ClientInvocationError.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.realtime.protocol.MAX_ID_LENGTH
orionis.realtime.protocol.html#MAX_ID_LENGTH
Attribute
Constant
PUBLIC
Max id length value used by protocol.
-
orionis.realtime.protocol.MAX_ARGUMENTS
orionis.realtime.protocol.html#MAX_ARGUMENTS
Attribute
Constant
PUBLIC
Max arguments value used by protocol.
-
orionis.realtime.protocol.MAX_ERROR_MESSAGE_LENGTH
orionis.realtime.protocol.html#MAX_ERROR_MESSAGE_LENGTH
Attribute
Constant
PUBLIC
Max error message length value used by protocol.
-
orionis.realtime.protocol.MAX_ERROR_CODE_LENGTH
orionis.realtime.protocol.html#MAX_ERROR_CODE_LENGTH
Attribute
Constant
PUBLIC
Max error code length value used by protocol.
-
orionis.realtime.protocol._DEFAULT_MESSAGE_LIMIT
orionis.realtime.protocol.html#_DEFAULT_MESSAGE_LIMIT
Attribute
Constant
PUBLIC
Default message limit used by protocol.
-
orionis.realtime.protocol.RPCErrorPayload
orionis.realtime.protocol.RPCErrorPayload.html
Class
Class
PUBLIC
Carry the public error returned by one completed invocation.
-
orionis.realtime.protocol.RPCErrorPayload.code
orionis.realtime.protocol.RPCErrorPayload.html#code
Attribute
Class Variable
PUBLIC
Machine-readable status or error code.
-
orionis.realtime.protocol.RPCErrorPayload.message
orionis.realtime.protocol.RPCErrorPayload.html#message
Attribute
Class Variable
PUBLIC
Human-readable message associated with this operation or result.
-
orionis.realtime.protocol.Invoke
orionis.realtime.protocol.Invoke.html
Class
Class
PUBLIC
Request one named server operation within a bounded invocation lifetime.
-
orionis.realtime.protocol.Invoke.id
orionis.realtime.protocol.Invoke.html#id
Attribute
Class Variable
PUBLIC
Identifier used to correlate or locate this protocol or storage record.
-
orionis.realtime.protocol.Invoke.target
orionis.realtime.protocol.Invoke.html#target
Attribute
Class Variable
PUBLIC
Public remote method name selected for invocation.
-
orionis.realtime.protocol.Invoke.args
orionis.realtime.protocol.Invoke.html#args
Attribute
Class Variable
PUBLIC
Args produced by msgspec.field.
-
orionis.realtime.protocol.Invoke.kwargs
orionis.realtime.protocol.Invoke.html#kwargs
Attribute
Class Variable
PUBLIC
Keyword options forwarded to construction of the underlying object.
-
orionis.realtime.protocol.Invoke.timeout
orionis.realtime.protocol.Invoke.html#timeout
Attribute
Class Variable
PUBLIC
Maximum duration allowed for an execution attempt.
-
orionis.realtime.protocol.Completion
orionis.realtime.protocol.Completion.html
Class
Class
PUBLIC
Finish a pending server-to-client call with exactly one result or error.
-
orionis.realtime.protocol.Completion.id
orionis.realtime.protocol.Completion.html#id
Attribute
Class Variable
PUBLIC
Identifier used to correlate or locate this protocol or storage record.
-
orionis.realtime.protocol.Cancel
orionis.realtime.protocol.Cancel.html
Class
Class
PUBLIC
Cancel one active client-to-server invocation.
-
orionis.realtime.protocol.Cancel.id
orionis.realtime.protocol.Cancel.html#id
Attribute
Class Variable
PUBLIC
Identifier used to correlate or locate this protocol or storage record.
-
orionis.realtime.protocol.Ping
orionis.realtime.protocol.Ping.html
Class
Class
PUBLIC
Request an application-level pong without creating a heartbeat task.
-
orionis.realtime.protocol.Pong
orionis.realtime.protocol.Pong.html
Class
Class
PUBLIC
Acknowledge an application-level ping.
-
orionis.realtime.protocol.ClientMessage
orionis.realtime.protocol.html#ClientMessage
Attribute
Type Alias
PUBLIC
Type alias for Invoke | Completion | Cancel | Ping | Pong.
-
orionis.realtime.protocol.validate_invocation_id
orionis.realtime.protocol.html#validate_invocation_id
Function
Function
PUBLIC
Require a bounded printable identifier without interpreting its content.
-
orionis.realtime.protocol._validate_invoke
orionis.realtime.protocol.html#_validate_invoke
Function
Function
PUBLIC
Validate structural request limits beyond the decoded envelope types.
-
orionis.realtime.protocol._validate_completion
orionis.realtime.protocol.html#_validate_completion
Function
Function
PUBLIC
Require exactly one completion outcome and bounded public error text.
-
orionis.realtime.connection._TARGET_LIMIT
orionis.realtime.connection.html#_TARGET_LIMIT
Attribute
Constant
PUBLIC
Target limit value used by connection.
-
orionis.realtime.connection._ARGUMENT_LIMIT
orionis.realtime.connection.html#_ARGUMENT_LIMIT
Attribute
Constant
PUBLIC
Argument limit value used by connection.
-
orionis.realtime.connection.RealtimeConnection
orionis.realtime.connection.RealtimeConnection.html
Class
Class
PUBLIC
Own tasks and pending client results for exactly one connection.
-
orionis.realtime.connection.RealtimeConnection.__slots__
orionis.realtime.connection.RealtimeConnection.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.realtime.connection.RealtimeConnection.__init__
orionis.realtime.connection.RealtimeConnection.html#__init__
Function
Method
PUBLIC
Bind connection state and initialize task, result, and write ownership.
-
orionis.realtime.connection.RealtimeConnection.context
orionis.realtime.connection.RealtimeConnection.html#context
Attribute
Instance Variable
PUBLIC
Connection identity and public socket.
-
orionis.realtime.connection.RealtimeConnection.socket
orionis.realtime.connection.RealtimeConnection.html#socket
Attribute
Instance Variable
PUBLIC
WebSocket associated with the current realtime invocation.
-
orionis.realtime.connection.RealtimeConnection.hub
orionis.realtime.connection.RealtimeConnection.html#hub
Attribute
Instance Variable
PUBLIC
Application-owned Hub type.
-
orionis.realtime.connection.RealtimeConnection.protocol
orionis.realtime.connection.RealtimeConnection.html#protocol
Attribute
Instance Variable
PUBLIC
Route-selected codec.
-
orionis.realtime.connection.RealtimeConnection.config
orionis.realtime.connection.RealtimeConnection.html#config
Attribute
Instance Variable
PUBLIC
Invocation and broadcast limits.
-
orionis.realtime.connection.RealtimeConnection.active
orionis.realtime.connection.RealtimeConnection.html#active
Attribute
Instance Variable
PUBLIC
Operations currently running for this connection or transport.
-
orionis.realtime.connection.RealtimeConnection.finishing
orionis.realtime.connection.RealtimeConnection.html#finishing
Attribute
Instance Variable
PUBLIC
Finishing produced by set.
-
orionis.realtime.connection.RealtimeConnection._cancel_requested
orionis.realtime.connection.RealtimeConnection.html#_cancel_requested
Attribute
Instance Variable
PUBLIC
Cancel requested produced by set.
-
orionis.realtime.connection.RealtimeConnection.pending
orionis.realtime.connection.RealtimeConnection.html#pending
Attribute
Instance Variable
PUBLIC
Work that has been admitted and is awaiting completion.
-
orionis.realtime.connection.RealtimeConnection.owner
orionis.realtime.connection.RealtimeConnection.html#owner
Attribute
Instance Variable
PUBLIC
Owner produced by asyncio.current_task.
-
orionis.realtime.connection.RealtimeConnection.ready
orionis.realtime.connection.RealtimeConnection.html#ready
Attribute
Instance Variable
PUBLIC
Ready flag used by RealtimeConnection.
-
orionis.realtime.connection.RealtimeConnection.closing
orionis.realtime.connection.RealtimeConnection.html#closing
Attribute
Instance Variable
PUBLIC
Closing flag used by RealtimeConnection.
-
orionis.realtime.connection.RealtimeConnection.failure
orionis.realtime.connection.RealtimeConnection.html#failure
Attribute
Instance Variable
PUBLIC
Failure retained for propagation or reporting.
-
orionis.realtime.connection.RealtimeConnection._counter
orionis.realtime.connection.RealtimeConnection.html#_counter
Attribute
Instance Variable
PUBLIC
Counter value used by RealtimeConnection.
-
orionis.realtime.connection.RealtimeConnection._write_lock
orionis.realtime.connection.RealtimeConnection.html#_write_lock
Attribute
Instance Variable
PUBLIC
Synchronization primitive controlling access to write lock.
-
orionis.realtime.connection.RealtimeConnection._write_task
orionis.realtime.connection.RealtimeConnection.html#_write_task
Attribute
Instance Variable
PUBLIC
Background task sending queued messages to the connection.
-
orionis.realtime.connection.RealtimeConnection._failure_runtime
orionis.realtime.connection.RealtimeConnection.html#_failure_runtime
Attribute
Instance Variable
PUBLIC
Application runtime retained through connection cleanup.
-
orionis.realtime.connection.RealtimeConnection._failure_operation
orionis.realtime.connection.RealtimeConnection.html#_failure_operation
Attribute
Instance Variable
PUBLIC
Connection boundary receiving fatal child-task incident identity.
-
orionis.realtime.connection.RealtimeConnection._reports
orionis.realtime.connection.RealtimeConnection.html#_reports
Attribute
Instance Variable
PUBLIC
Failure delivery tasks owned by this connection.
-
orionis.realtime.connection.RealtimeConnection._observe
orionis.realtime.connection.RealtimeConnection.html#_observe
Function
Method
PUBLIC
Observe a connection failure and retain ownership of pending reports.
-
orionis.realtime.connection.RealtimeConnection.failureRuntime
orionis.realtime.connection.RealtimeConnection.html#failureRuntime
Attribute
Property
PUBLIC
Return the retained runtime used for connection failure delivery.
-
orionis.realtime.connection.RealtimeConnection.bindFailureOperation
orionis.realtime.connection.RealtimeConnection.html#bindFailureOperation
Function
Method
PUBLIC
Bind the current failure operation as the connection's incident boundary.
-
orionis.realtime.connection.RealtimeConnection._writeDone
orionis.realtime.connection.RealtimeConnection.html#_writeDone
Function
Method
PUBLIC
Retire a completed write and notify its waiter without losing failures.
-
orionis.realtime.connection.RealtimeConnection.invocationDone
orionis.realtime.connection.RealtimeConnection.html#invocationDone
Function
Method
PUBLIC
Retire a completed invocation and observe unhandled task failures.
-
orionis.realtime.connection.RealtimeConnection.cancel
orionis.realtime.connection.RealtimeConnection.html#cancel
Function
Method
PUBLIC
Schedule cancellation once for an active invocation identifier.
-
orionis.realtime.connection.RealtimeConnection._cancelTask
orionis.realtime.connection.RealtimeConnection.html#_cancelTask
Function
Method
PUBLIC
Cancel unfinished invocation work without interrupting cleanup twice.
-
orionis.realtime.connection.RealtimeConnection.finish
orionis.realtime.connection.RealtimeConnection.html#finish
Function
Method
PUBLIC
Release an invocation ID while retaining ownership of terminal delivery.
-
orionis.realtime.connection.RealtimeConnection.sendEncoded
orionis.realtime.connection.RealtimeConnection.html#sendEncoded
Function
Method
PUBLIC
Serialize an encoded message while retaining ownership of its write task.
-
orionis.realtime.connection.RealtimeConnection._sendOwned
orionis.realtime.connection.RealtimeConnection.html#_sendOwned
Function
Method
PUBLIC
Send within an owned incident context that survives caller cancellation.
-
orionis.realtime.connection.RealtimeConnection.send
orionis.realtime.connection.RealtimeConnection.html#send
Function
Method
PUBLIC
Encode a protocol envelope and await its serialized transport write.
-
orionis.realtime.connection.RealtimeConnection.invoke
orionis.realtime.connection.RealtimeConnection.html#invoke
Function
Method
PUBLIC
Invoke a client method and release its pending result on every exit.
-
orionis.realtime.connection.RealtimeConnection.complete
orionis.realtime.connection.RealtimeConnection.html#complete
Function
Method
PUBLIC
Settle a pending client invocation and ignore late or duplicate completions.
-
orionis.realtime.connection.RealtimeConnection.cleanup
orionis.realtime.connection.RealtimeConnection.html#cleanup
Function
Method
PUBLIC
Cancel owned work, join cleanup, and release connection task registries.
-
orionis.realtime.connection.RealtimeConnection._cancelWork
orionis.realtime.connection.RealtimeConnection.html#_cancelWork
Function
Method
PUBLIC
Reject pending client results and request cancellation of owned tasks.
-
orionis.realtime.metadata._INVALID_ARGUMENTS
orionis.realtime.metadata.html#_INVALID_ARGUMENTS
Attribute
Constant
PUBLIC
invalid_arguments.
-
orionis.realtime.metadata._VALIDATION_ERROR
orionis.realtime.metadata.html#_VALIDATION_ERROR
Attribute
Constant
PUBLIC
Protocol error code returned when invocation arguments fail validation.
-
orionis.realtime.metadata._ARGUMENTS_MESSAGE
orionis.realtime.metadata.html#_ARGUMENTS_MESSAGE
Attribute
Constant
PUBLIC
Invalid arguments.
-
orionis.realtime.metadata._SCALARS
orionis.realtime.metadata.html#_SCALARS
Attribute
Constant
PUBLIC
Scalars used by metadata.
-
orionis.realtime.metadata._COLLECTIONS
orionis.realtime.metadata.html#_COLLECTIONS
Attribute
Constant
PUBLIC
Collections used by metadata.
-
orionis.realtime.metadata._base_annotation
orionis.realtime.metadata.html#_base_annotation
Function
Function
PUBLIC
Remove metadata wrappers when classifying trusted annotations.
-
orionis.realtime.metadata._is_data
orionis.realtime.metadata.html#_is_data
Function
Function
PUBLIC
Identify types whose values may safely originate in decoded client data.
-
orionis.realtime.metadata._dependency_type
orionis.realtime.metadata.html#_dependency_type
Function
Function
PUBLIC
Extract a container-owned service type, including nullable dependencies.
-
orionis.realtime.metadata._ClientParameter
orionis.realtime.metadata._ClientParameter.html
Class
Class
PUBLIC
Retain the immutable conversion plan for one client-owned parameter.
-
orionis.realtime.metadata._ClientParameter.name
orionis.realtime.metadata._ClientParameter.html#name
Attribute
Class Variable
PUBLIC
Name identifying this declaration within its containing registry.
-
orionis.realtime.metadata._ClientParameter.annotation
orionis.realtime.metadata._ClientParameter.html#annotation
Attribute
Class Variable
PUBLIC
Declared Python type used to validate the client argument.
-
orionis.realtime.metadata._ClientParameter.default
orionis.realtime.metadata._ClientParameter.html#default
Attribute
Class Variable
PUBLIC
Value used when the client omits this argument.
-
orionis.realtime.metadata._ClientParameter.keyword_only
orionis.realtime.metadata._ClientParameter.html#keyword_only
Attribute
Class Variable
PUBLIC
Whether the client argument must be passed by keyword.
-
orionis.realtime.metadata._ClientParameter.schema_plans
orionis.realtime.metadata._ClientParameter.html#schema_plans
Attribute
Class Variable
PUBLIC
Compiled schema-validation plans for the argument.
-
orionis.realtime.metadata._ClientParameter.requires_preparation
orionis.realtime.metadata._ClientParameter.html#requires_preparation
Attribute
Class Variable
PUBLIC
Whether marked coercion or existing-Struct expansion is required.
-
orionis.realtime.metadata._ClientParameter.convert
orionis.realtime.metadata._ClientParameter.html#convert
Function
Method
PUBLIC
Convert and validate one RPC value without accessing an HTTP request body.
-
orionis.realtime.metadata.RemoteMethod
orionis.realtime.metadata.RemoteMethod.html
Class
Class
PUBLIC
Describe one pre-authorized method without retaining a Hub instance.
-
orionis.realtime.metadata.RemoteMethod.method_name
orionis.realtime.metadata.RemoteMethod.html#method_name
Attribute
Class Variable
PUBLIC
Python method name implementing the remote target.
-
orionis.realtime.metadata.RemoteMethod.is_stream
orionis.realtime.metadata.RemoteMethod.html#is_stream
Attribute
Class Variable
PUBLIC
Whether the remote method produces streamed results.
-
orionis.realtime.metadata.RemoteMethod.dependencies
orionis.realtime.metadata.RemoteMethod.html#dependencies
Attribute
Class Variable
PUBLIC
Service dependencies resolved for the remote invocation.
-
orionis.realtime.metadata.RemoteMethod.parameters
orionis.realtime.metadata.RemoteMethod.html#parameters
Attribute
Class Variable
PUBLIC
Client-supplied parameters accepted by the remote method.
-
orionis.realtime.metadata.RemoteMethod.positional
orionis.realtime.metadata.RemoteMethod.html#positional
Attribute
Class Variable
PUBLIC
Parameter metadata used to bind positional client arguments.
-
orionis.realtime.metadata.RemoteMethod.client_names
orionis.realtime.metadata.RemoteMethod.html#client_names
Attribute
Class Variable
PUBLIC
Names of arguments the client is permitted to supply.
-
orionis.realtime.metadata.RemoteMethod.bind
orionis.realtime.metadata.RemoteMethod.html#bind
Function
Method
PUBLIC
Bind and validate client-owned parameters, providing declared defaults.
-
orionis.realtime.metadata._method_plan
orionis.realtime.metadata.html#_method_plan
Function
Function
PUBLIC
Compile trusted reflection metadata once, rejecting ambiguous signatures.
-
orionis.realtime.metadata.compile_hub
orionis.realtime.metadata.html#compile_hub
Function
Function
PUBLIC
Build the immutable remote dispatch map exclusively from class metadata.
-
orionis.realtime.runtime._LOGGER
orionis.realtime.runtime.html#_LOGGER
Attribute
Constant
PUBLIC
Logger used by runtime.
-
orionis.realtime.runtime.HubRuntime
orionis.realtime.runtime.HubRuntime.html
Class
Class
PUBLIC
Execute a precompiled Hub using the existing application and scopes.
-
orionis.realtime.runtime.HubRuntime.__slots__
orionis.realtime.runtime.HubRuntime.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.realtime.runtime.HubRuntime.__init__
orionis.realtime.runtime.HubRuntime.html#__init__
Function
Method
PUBLIC
Bind application services and compile a Hub's remote dispatch metadata.
-
orionis.realtime.runtime.HubRuntime._app
orionis.realtime.runtime.HubRuntime.html#_app
Attribute
Instance Variable
PUBLIC
Existing application and dependency container.
-
orionis.realtime.runtime.HubRuntime._manager
orionis.realtime.runtime.HubRuntime.html#_manager
Attribute
Instance Variable
PUBLIC
Shared worker-local registry and targeting service.
-
orionis.realtime.runtime.HubRuntime._hub
orionis.realtime.runtime.HubRuntime.html#_hub
Attribute
Instance Variable
PUBLIC
Application-declared Hub class.
-
orionis.realtime.runtime.HubRuntime._dispatch
orionis.realtime.runtime.HubRuntime.html#_dispatch
Attribute
Instance Variable
PUBLIC
Dispatch produced by compile_hub.
-
orionis.realtime.runtime.HubRuntime._protocol
orionis.realtime.runtime.HubRuntime.html#_protocol
Attribute
Instance Variable
PUBLIC
JSON or MessagePack selected by the route.
-
orionis.realtime.runtime.HubRuntime._bindContext
orionis.realtime.runtime.HubRuntime.html#_bindContext
Function
Method
PUBLIC
Bind connection state and targeting helpers into the supplied scope.
-
orionis.realtime.runtime.HubRuntime._buildHub
orionis.realtime.runtime.HubRuntime.html#_buildHub
Function
Method
PUBLIC
Build a Hub instance and attach connection-scoped client/group helpers.
-
orionis.realtime.runtime.HubRuntime.serve
orionis.realtime.runtime.HubRuntime.html#serve
Function
Method
PUBLIC
Serve one scoped Hub connection and finalize its owned work.
-
orionis.realtime.runtime.HubRuntime._finishConnection
orionis.realtime.runtime.HubRuntime.html#_finishConnection
Function
Method
PUBLIC
Finalize connection work while preserving an escaping primary failure.
-
orionis.realtime.runtime.HubRuntime._disconnect
orionis.realtime.runtime.HubRuntime.html#_disconnect
Function
Method
PUBLIC
Run the disconnect hook with a deadline, then close any open socket.
-
orionis.realtime.runtime.HubRuntime._receive
orionis.realtime.runtime.HubRuntime.html#_receive
Function
Method
PUBLIC
Read Hub messages while admitted invocations execute concurrently.
-
orionis.realtime.runtime.HubRuntime._startInvocation
orionis.realtime.runtime.HubRuntime.html#_startInvocation
Function
Method
PUBLIC
Admit a validated client invocation or send a controlled rejection.
-
orionis.realtime.runtime.HubRuntime._invoke
orionis.realtime.runtime.HubRuntime.html#_invoke
Function
Method
PUBLIC
Execute one remote method with isolated dependencies and authentication.
-
orionis.realtime.runtime.HubRuntime._stream
orionis.realtime.runtime.HubRuntime.html#_stream
Function
Method
PUBLIC
Deliver stream items with send backpressure and close the source iterator.
-
orionis.realtime.runtime.HubRuntime._error
orionis.realtime.runtime.HubRuntime.html#_error
Function
Static Method
PUBLIC
Send a sanitized terminal error with optional admission observation.
-
orionis.http.kernel._LOGGER
orionis.http.kernel.html#_LOGGER
Attribute
Constant
PUBLIC
Logger used by kernel.
-
orionis.http.kernel._SHUTDOWN_TIMEOUT
orionis.http.kernel.html#_SHUTDOWN_TIMEOUT
Attribute
Constant
PUBLIC
Shutdown timeout value used by kernel.
-
orionis.http.kernel._MiddlewareNext
orionis.http.kernel._MiddlewareNext.html
Class
Class
PUBLIC
Hold one request-local continuation that can be consumed only once.
-
orionis.http.kernel._MiddlewareNext.__slots__
orionis.http.kernel._MiddlewareNext.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.http.kernel._MiddlewareNext.__init__
orionis.http.kernel._MiddlewareNext.html#__init__
Function
Method
PUBLIC
Bind a continuation to its fixed arguments.
-
orionis.http.kernel._MiddlewareNext._terminal
orionis.http.kernel._MiddlewareNext.html#_terminal
Attribute
Instance Variable
PUBLIC
Asynchronous next middleware or handler.
-
orionis.http.kernel._MiddlewareNext._args
orionis.http.kernel._MiddlewareNext.html#_args
Attribute
Instance Variable
PUBLIC
Arguments supplied when advancing the pipeline.
-
orionis.http.kernel._MiddlewareNext._called
orionis.http.kernel._MiddlewareNext.html#_called
Attribute
Instance Variable
PUBLIC
Called flag used by _MiddlewareNext.
-
orionis.http.kernel._MiddlewareNext.__call__
orionis.http.kernel._MiddlewareNext.html#__call__
Function
Method
PUBLIC
Advance once, including when concurrent tasks call the continuation.
-
orionis.http.kernel._MiddlewarePipeline
orionis.http.kernel._MiddlewarePipeline.html
Class
Class
PUBLIC
Middleware pipeline with request-local execution state.
-
orionis.http.kernel._MiddlewarePipeline.__slots__
orionis.http.kernel._MiddlewarePipeline.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.http.kernel._MiddlewarePipeline.__init__
orionis.http.kernel._MiddlewarePipeline.html#__init__
Function
Method
PUBLIC
Store the middleware stack and terminal callable for one request.
-
orionis.http.kernel._MiddlewarePipeline._instances
orionis.http.kernel._MiddlewarePipeline.html#_instances
Attribute
Instance Variable
PUBLIC
Ordered tuple of pre-built middleware instances.
-
orionis.http.kernel._MiddlewarePipeline._request
orionis.http.kernel._MiddlewarePipeline.html#_request
Attribute
Instance Variable
PUBLIC
Incoming HTTP request forwarded to each layer.
-
orionis.http.kernel._MiddlewarePipeline._terminal
orionis.http.kernel._MiddlewarePipeline.html#_terminal
Attribute
Instance Variable
PUBLIC
Async callable invoked after all middleware layers have run.
-
orionis.http.kernel._MiddlewarePipeline._terminal_args
orionis.http.kernel._MiddlewarePipeline.html#_terminal_args
Attribute
Instance Variable
PUBLIC
Positional arguments forwarded to the terminal callable.
-
orionis.http.kernel._MiddlewarePipeline._n
orionis.http.kernel._MiddlewarePipeline.html#_n
Attribute
Instance Variable
PUBLIC
N produced by len.
-
orionis.http.kernel._MiddlewarePipeline._called
orionis.http.kernel._MiddlewarePipeline.html#_called
Attribute
Instance Variable
PUBLIC
Called flag used by _MiddlewarePipeline.
-
orionis.http.kernel._MiddlewarePipeline.__call__
orionis.http.kernel._MiddlewarePipeline.html#__call__
Function
Method
PUBLIC
Start the middleware stack once for this request.
-
orionis.http.kernel._MiddlewarePipeline.__advance
orionis.http.kernel._MiddlewarePipeline.html#__advance
Function
Method
PUBLIC
Invoke the layer at a fixed depth with its own continuation.
-
orionis.http.kernel.KernelHTTP
orionis.http.kernel.KernelHTTP.html
Class
Class
PUBLIC
Serve concurrent requests within one worker event loop.
-
orionis.http.kernel.KernelHTTP.__slots__
orionis.http.kernel.KernelHTTP.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.http.kernel.KernelHTTP.__init__
orionis.http.kernel.KernelHTTP.html#__init__
Function
Method
PUBLIC
Initialize the HTTP kernel with application and failure handler.
-
orionis.http.kernel.KernelHTTP.__app
orionis.http.kernel.KernelHTTP.html#__app
Attribute
Instance Variable
PUBLIC
Application instance providing configuration and DI container.
-
orionis.http.kernel.KernelHTTP.__boot
orionis.http.kernel.KernelHTTP.html#__boot
Attribute
Instance Variable
PUBLIC
Boot flag used by KernelHTTP.
-
orionis.http.kernel.KernelHTTP.__catch
orionis.http.kernel.KernelHTTP.html#__catch
Attribute
Instance Variable
PUBLIC
Failure handler used to format unhandled exceptions.
-
orionis.http.kernel.KernelHTTP.__body_limits
orionis.http.kernel.KernelHTTP.html#__body_limits
Attribute
Instance Variable
PUBLIC
Body limits produced by HTTPBodyLimits.
-
orionis.http.kernel.KernelHTTP.__request_slots
orionis.http.kernel.KernelHTTP.html#__request_slots
Attribute
Instance Variable
PUBLIC
Request slots obtained from self.__body_limits.max_concurrent_requests.
-
orionis.http.kernel.KernelHTTP.__websocket_config
orionis.http.kernel.KernelHTTP.html#__websocket_config
Attribute
Instance Variable
PUBLIC
Websocket config produced by HTTPWebSocket.
-
orionis.http.kernel.KernelHTTP.__websocket_slots
orionis.http.kernel.KernelHTTP.html#__websocket_slots
Attribute
Instance Variable
PUBLIC
Synchronization primitive controlling access to websocket slots.
-
orionis.http.kernel.KernelHTTP.__websocket_tasks
orionis.http.kernel.KernelHTTP.html#__websocket_tasks
Attribute
Instance Variable
PUBLIC
Websocket tasks produced by set.
-
orionis.http.kernel.KernelHTTP.__middleware_cache
orionis.http.kernel.KernelHTTP.html#__middleware_cache
Attribute
Instance Variable
PUBLIC
Associate each route middleware stack with its instances.
-
orionis.http.kernel.KernelHTTP.__endpoint_policies
orionis.http.kernel.KernelHTTP.html#__endpoint_policies
Attribute
Instance Variable
PUBLIC
Compiled policies associated with each dispatched endpoint.
-
orionis.http.kernel.KernelHTTP.disconnectPaths
orionis.http.kernel.KernelHTTP.html#disconnectPaths
Function
Method
PUBLIC
Expose compiled endpoint opt-ins to the application transport wrapper.
-
orionis.http.kernel.KernelHTTP.boot
orionis.http.kernel.KernelHTTP.html#boot
Function
Method
PUBLIC
Boot the HTTP kernel by initializing all core components.
-
orionis.http.kernel.KernelHTTP.__default_responses
orionis.http.kernel.KernelHTTP.html#__default_responses
Attribute
Instance Variable
PUBLIC
Build the default response factory for common HTTP error responses.
-
orionis.http.kernel.KernelHTTP.__health_path
orionis.http.kernel.KernelHTTP.html#__health_path
Attribute
Instance Variable
PUBLIC
Health path produced by self.__app.routeHealthCheck.rstrip.
-
orionis.http.kernel.KernelHTTP.__web_middleware
orionis.http.kernel.KernelHTTP.html#__web_middleware
Attribute
Instance Variable
PUBLIC
Resolve web identities only after session restoration and CSRF checks.
-
orionis.http.kernel.KernelHTTP.__api_middleware
orionis.http.kernel.KernelHTTP.html#__api_middleware
Attribute
Instance Variable
PUBLIC
API identity resolution uses Bearer credentials without starting a session.
-
orionis.http.kernel.KernelHTTP.__rsgi_adapter
orionis.http.kernel.KernelHTTP.html#__rsgi_adapter
Attribute
Instance Variable
PUBLIC
Protocol-level response adapters for RSGI and ASGI transports.
-
orionis.http.kernel.KernelHTTP.__asgi_adapter
orionis.http.kernel.KernelHTTP.html#__asgi_adapter
Attribute
Instance Variable
PUBLIC
Adapter translating ASGI request events into framework operations.
-
orionis.http.kernel.KernelHTTP.__request_printer
orionis.http.kernel.KernelHTTP.html#__request_printer
Attribute
Instance Variable
PUBLIC
Request logger; only active when the application runs in debug mode.
-
orionis.http.kernel.KernelHTTP.__printer_enabled
orionis.http.kernel.KernelHTTP.html#__printer_enabled
Attribute
Instance Variable
PUBLIC
Record whether requests should be timed and logged.
-
orionis.http.kernel.KernelHTTP.__fallback
orionis.http.kernel.KernelHTTP.html#__fallback
Attribute
Instance Variable
PUBLIC
Handler or route selected when no ordinary route matches.
-
orionis.http.kernel.KernelHTTP.__routeResolve
orionis.http.kernel.KernelHTTP.html#__routeResolve
Function
Method
PUBLIC
Initialize route resolver with loaded routes.
-
orionis.http.kernel.KernelHTTP.__routes
orionis.http.kernel.KernelHTTP.html#__routes
Attribute
Instance Variable
PUBLIC
Build the resolver with compiled routes and a fixed hot-cache budget.
-
orionis.http.kernel.KernelHTTP.__preloadHandlers
orionis.http.kernel.KernelHTTP.html#__preloadHandlers
Function
Method
PUBLIC
Import route handlers and prepare their dependency metadata at boot time.
-
orionis.http.kernel.KernelHTTP.__fn_dispatch
orionis.http.kernel.KernelHTTP.html#__fn_dispatch
Attribute
Instance Variable
PUBLIC
Fn dispatch supplied through fn_dispatch.
-
orionis.http.kernel.KernelHTTP.__cls_dispatch
orionis.http.kernel.KernelHTTP.html#__cls_dispatch
Attribute
Instance Variable
PUBLIC
Cls dispatch supplied through cls_dispatch.
-
orionis.http.kernel.KernelHTTP.__view_dispatch
orionis.http.kernel.KernelHTTP.html#__view_dispatch
Attribute
Instance Variable
PUBLIC
View dispatch supplied through view_dispatch.
-
orionis.http.kernel.KernelHTTP.__hub_dispatch
orionis.http.kernel.KernelHTTP.html#__hub_dispatch
Attribute
Instance Variable
PUBLIC
Hub dispatch supplied through hub_dispatch.
-
orionis.http.kernel.KernelHTTP.__preloadEndpointPolicy
orionis.http.kernel.KernelHTTP.html#__preloadEndpointPolicy
Function
Method
PUBLIC
Bind one validated policy instance to a static HTTP endpoint.
-
orionis.http.kernel.KernelHTTP.__defaultMiddleware
orionis.http.kernel.KernelHTTP.html#__defaultMiddleware
Function
Method
PUBLIC
Initialize default HTTP middleware stack.
-
orionis.http.kernel.KernelHTTP.__proxies
orionis.http.kernel.KernelHTTP.html#__proxies
Attribute
Instance Variable
PUBLIC
Proxies produced by ProxiesMiddleware.
-
orionis.http.kernel.KernelHTTP.__security
orionis.http.kernel.KernelHTTP.html#__security
Attribute
Instance Variable
PUBLIC
Security produced by SecurityMiddleware.
-
orionis.http.kernel.KernelHTTP.__cors
orionis.http.kernel.KernelHTTP.html#__cors
Attribute
Instance Variable
PUBLIC
Cors produced by CORSMiddleware.
-
orionis.http.kernel.KernelHTTP.__rate_limit
orionis.http.kernel.KernelHTTP.html#__rate_limit
Attribute
Instance Variable
PUBLIC
Rate limit produced by RateLimitMiddleware.
-
orionis.http.kernel.KernelHTTP.__under_maintenance
orionis.http.kernel.KernelHTTP.html#__under_maintenance
Attribute
Instance Variable
PUBLIC
Value supplied for under_maintenance.
-
orionis.http.kernel.KernelHTTP.__rate_limit_enabled
orionis.http.kernel.KernelHTTP.html#__rate_limit_enabled
Attribute
Instance Variable
PUBLIC
Record whether rate limiting is active.
-
orionis.http.kernel.KernelHTTP.__rsgiResponse
orionis.http.kernel.KernelHTTP.html#__rsgiResponse
Function
Method
PUBLIC
Send an RSGI HTTP response through the transport adapter.
-
orionis.http.kernel.KernelHTTP.__asgiResponse
orionis.http.kernel.KernelHTTP.html#__asgiResponse
Function
Method
PUBLIC
Send ASGI HTTP response through transport adapter.
-
orionis.http.kernel.KernelHTTP.__globalMiddleware
orionis.http.kernel.KernelHTTP.html#__globalMiddleware
Function
Method
PUBLIC
Execute global middleware and serve packaged default-page assets.
-
orionis.http.kernel.KernelHTTP.__preloadMiddleware
orionis.http.kernel.KernelHTTP.html#__preloadMiddleware
Function
Method
PUBLIC
Pre-build middleware instances for all routes at boot time.
-
orionis.http.kernel.KernelHTTP.__routeLayer
orionis.http.kernel.KernelHTTP.html#__routeLayer
Function
Method
PUBLIC
Establish the web or API context before running route middleware.
-
orionis.http.kernel.KernelHTTP.__webTerminal
orionis.http.kernel.KernelHTTP.html#__webTerminal
Function
Method
PUBLIC
Run the route pipeline and translate validation failures for the web.
-
orionis.http.kernel.KernelHTTP.__requestLayer
orionis.http.kernel.KernelHTTP.html#__requestLayer
Function
Method
PUBLIC
Execute route-level middleware for the resolved route.
-
orionis.http.kernel.KernelHTTP.__callHandler
orionis.http.kernel.KernelHTTP.html#__callHandler
Function
Method
PUBLIC
Dispatch the route handler and validate direct schema results.
-
orionis.http.kernel.KernelHTTP.__callFallback
orionis.http.kernel.KernelHTTP.html#__callFallback
Function
Method
PUBLIC
Invoke the registered fallback handler and return its response.
-
orionis.http.kernel.KernelHTTP.__handleException
orionis.http.kernel.KernelHTTP.html#__handleException
Function
Method
PUBLIC
Translate a caught exception into an HTTP response.
-
orionis.http.kernel.KernelHTTP.__isExpectedFailure
orionis.http.kernel.KernelHTTP.html#__isExpectedFailure
Function
Method
PUBLIC
Classify an error while observing failures of a custom classifier.
-
orionis.http.kernel.KernelHTTP.__exceptionResponse
orionis.http.kernel.KernelHTTP.html#__exceptionResponse
Function
Method
PUBLIC
Apply endpoint policies and application handling to an ordinary error.
-
orionis.http.kernel.KernelHTTP.__bodyLengthResponse
orionis.http.kernel.KernelHTTP.html#__bodyLengthResponse
Function
Method
PUBLIC
Reject invalid framing and declared oversized bodies before reading.
-
orionis.http.kernel.KernelHTTP.__processRequest
orionis.http.kernel.KernelHTTP.html#__processRequest
Function
Method
PUBLIC
Build the HTTP response for this request.
-
orionis.http.kernel.KernelHTTP.handleRSGI
orionis.http.kernel.KernelHTTP.html#handleRSGI
Function
Method
PUBLIC
Handle an incoming RSGI HTTP request end-to-end.
-
orionis.http.kernel.KernelHTTP.handleASGI
orionis.http.kernel.KernelHTTP.html#handleASGI
Function
Method
PUBLIC
Handle an incoming ASGI HTTP request end-to-end.
-
orionis.http.kernel.KernelHTTP.__websocketOriginAllowed
orionis.http.kernel.KernelHTTP.html#__websocketOriginAllowed
Function
Method
PUBLIC
Check browser origins before allowing an application handshake.
-
orionis.http.kernel.KernelHTTP.__callWebSocketHandler
orionis.http.kernel.KernelHTTP.html#__callWebSocketHandler
Function
Method
PUBLIC
Invoke a preloaded connection handler through the scoped container.
-
orionis.http.kernel.KernelHTTP.__handleWebSocket
orionis.http.kernel.KernelHTTP.html#__handleWebSocket
Function
Method
PUBLIC
Dispatch a bounded connection inside a dedicated lifetime scope.
-
orionis.http.kernel.KernelHTTP.__runWebSocket
orionis.http.kernel.KernelHTTP.html#__runWebSocket
Function
Method
PUBLIC
Run an admitted connection and observe errors before transport cleanup.
-
orionis.http.kernel.KernelHTTP.__closeWebSocket
orionis.http.kernel.KernelHTTP.html#__closeWebSocket
Function
Method
PUBLIC
Close a connection while retaining the failure already escaping its owner.
-
orionis.http.kernel.KernelHTTP.__shutdownWebSockets
orionis.http.kernel.KernelHTTP.html#__shutdownWebSockets
Function
Method
PUBLIC
Cancel connection lifetimes within the existing shutdown lifecycle.
-
orionis.http.kernel.KernelHTTP.__processWebSocket
orionis.http.kernel.KernelHTTP.html#__processWebSocket
Function
Method
PUBLIC
Validate a handshake and run its connection middleware and handler.
-
orionis.http.layer.store.redis_rate_limit._HIT
orionis.http.layer.store.redis_rate_limit.html#_HIT
Attribute
Constant
PUBLIC
Redis owns the clock and makes expiration, quota checking and insertion atomic.
-
orionis.http.layer.store.redis_rate_limit.RedisRateLimitStore
orionis.http.layer.store.redis_rate_limit.RedisRateLimitStore.html
Class
Class
PUBLIC
Share sliding-window quotas using a single-key atomic Redis script.
-
orionis.http.layer.store.redis_rate_limit.RedisRateLimitStore.__slots__
orionis.http.layer.store.redis_rate_limit.RedisRateLimitStore.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.http.layer.store.redis_rate_limit.RedisRateLimitStore.__init__
orionis.http.layer.store.redis_rate_limit.RedisRateLimitStore.html#__init__
Function
Method
PUBLIC
Build a lazy Redis connection, optionally using an external client.
-
orionis.http.layer.store.redis_rate_limit.RedisRateLimitStore.__prefix
orionis.http.layer.store.redis_rate_limit.RedisRateLimitStore.html#__prefix
Attribute
Instance Variable
PUBLIC
Prefix applied when constructing names or storage keys.
-
orionis.http.layer.store.redis_rate_limit.RedisRateLimitStore.__timeout
orionis.http.layer.store.redis_rate_limit.RedisRateLimitStore.html#__timeout
Attribute
Instance Variable
PUBLIC
Maximum duration allowed for an execution attempt.
-
orionis.http.layer.store.redis_rate_limit.RedisRateLimitStore.__owns_client
orionis.http.layer.store.redis_rate_limit.RedisRateLimitStore.html#__owns_client
Attribute
Instance Variable
PUBLIC
Whether this object must close the client during its own cleanup.
-
orionis.http.layer.store.redis_rate_limit.RedisRateLimitStore.__client
orionis.http.layer.store.redis_rate_limit.RedisRateLimitStore.html#__client
Attribute
Instance Variable
PUBLIC
Externally owned transport. The caller remains responsible for it.
-
orionis.http.layer.store.redis_rate_limit.RedisRateLimitStore.hit
orionis.http.layer.store.redis_rate_limit.RedisRateLimitStore.html#hit
Function
Method
PUBLIC
Accept an attempt only when its distributed sliding quota permits.
-
orionis.http.layer.store.redis_rate_limit.RedisRateLimitStore.close
orionis.http.layer.store.redis_rate_limit.RedisRateLimitStore.html#close
Function
Method
PUBLIC
Close connections created by this store without deleting quotas.
-
orionis.http.routes.auth.build_auth_routes
orionis.http.routes.auth.html#build_auth_routes
Function
Function
PUBLIC
Register the authentication routes on the given router.
-
orionis.http.routes.exceptions.fallback_route_already_registered.FallbackRouteAlreadyRegisteredException
orionis.http.routes.exceptions.fallback_route_already_registered.FallbackRouteAlreadyRegisteredException.html
Class
Exception
PUBLIC
Raised when a second fallback route is registered.
-
orionis.http.routes.router.Router
orionis.http.routes.router.Router.html
Class
Class
PUBLIC
Register application routes and configure their shared dispatch options.
-
orionis.http.routes.router.Router._DEFAULT_PATHS
orionis.http.routes.router.Router.html#_DEFAULT_PATHS
Attribute
Constant
PUBLIC
Default paths used by Router.
-
orionis.http.routes.router.Router.__init__
orionis.http.routes.router.Router.html#__init__
Function
Method
PUBLIC
Initialise the Router and register default system routes.
-
orionis.http.routes.router.Router.__app
orionis.http.routes.router.Router.html#__app
Attribute
Instance Variable
PUBLIC
The application instance.
-
orionis.http.routes.router.Router.__fallback
orionis.http.routes.router.Router.html#__fallback
Attribute
Instance Variable
PUBLIC
Handler or route selected when no ordinary route matches.
-
orionis.http.routes.router.Router.__routes
orionis.http.routes.router.Router.html#__routes
Attribute
Instance Variable
PUBLIC
Route definitions registered in this routing context.
-
orionis.http.routes.router.Router.__replaceable_routes
orionis.http.routes.router.Router.html#__replaceable_routes
Attribute
Instance Variable
PUBLIC
Previously registered routes eligible for replacement.
-
orionis.http.routes.router.Router.__current_kind
orionis.http.routes.router.Router.html#__current_kind
Attribute
Instance Variable
PUBLIC
web.
-
orionis.http.routes.router.Router.__defaultRoutes
orionis.http.routes.router.Router.html#__defaultRoutes
Function
Method
PUBLIC
Register default routes for common static paths.
-
orionis.http.routes.router.Router.__addSingleRoute
orionis.http.routes.router.Router.html#__addSingleRoute
Function
Method
PUBLIC
Create and register a single HTTP route.
-
orionis.http.routes.router.Router._setKind
orionis.http.routes.router.Router.html#_setKind
Function
Method
PUBLIC
Set the route group kind context for subsequent registrations.
-
orionis.http.routes.router.Router.websocket
orionis.http.routes.router.Router.html#websocket
Function
Method
PUBLIC
Register a WebSocket connection handler independently of HTTP routes.
-
orionis.http.routes.router.Router.hub
orionis.http.routes.router.Router.html#hub
Function
Method
PUBLIC
Register a Hub endpoint using a fixed JSON or MessagePack codec.
-
orionis.http.routes.router.Router.auth
orionis.http.routes.router.Router.html#auth
Function
Method
PUBLIC
Register the built-in web authentication routes.
-
orionis.http.routes.router.Router.view
orionis.http.routes.router.Router.html#view
Function
Method
PUBLIC
Register a GET route that renders a template with no controller.
-
orionis.http.routes.router.Router.post
orionis.http.routes.router.Router.html#post
Function
Method
PUBLIC
Register a POST route.
-
orionis.http.routes.router.Router.query
orionis.http.routes.router.Router.html#query
Function
Method
PUBLIC
Register a QUERY route.
-
orionis.http.routes.router.Router.get
orionis.http.routes.router.Router.html#get
Function
Method
PUBLIC
Register a GET route.
-
orionis.http.routes.router.Router.put
orionis.http.routes.router.Router.html#put
Function
Method
PUBLIC
Register a PUT route.
-
orionis.http.routes.router.Router.delete
orionis.http.routes.router.Router.html#delete
Function
Method
PUBLIC
Register a DELETE route.
-
orionis.http.routes.router.Router.patch
orionis.http.routes.router.Router.html#patch
Function
Method
PUBLIC
Register a PATCH route.
-
orionis.http.routes.router.Router.fallback
orionis.http.routes.router.Router.html#fallback
Function
Method
PUBLIC
Register the fallback handler for unmatched routes (HTTP 404).
-
orionis.http.routes.router.Router.group
orionis.http.routes.router.Router.html#group
Function
Method
PUBLIC
Compose a group and return its flattened membership for nesting.
-
orionis.http.routes.router.Router.__groupMembers
orionis.http.routes.router.Router.html#__groupMembers
Function
Static Method
PUBLIC
Validate and flatten membership without mutating any routes.
-
orionis.http.routes.router.Router.export
orionis.http.routes.router.Router.html#export
Function
Method
PUBLIC
Export all registered routes and the fallback handler.
-
orionis.http.routes.provider.RouterProvider
orionis.http.routes.provider.RouterProvider.html
Class
Class
PUBLIC
Register router services in the application container.
-
orionis.http.routes.provider.RouterProvider.register
orionis.http.routes.provider.RouterProvider.html#register
Function
Method
PUBLIC
Register the IRouter contract as a singleton in the application container.
-
orionis.http.routes.provider.RouterProvider.boot
orionis.http.routes.provider.RouterProvider.html#boot
Function
Method
PUBLIC
Initialize the Route facade asynchronously during the boot process.
-
orionis.introspection.abstract.reflection._EXCLUDED_DUNDER_ATTRS
orionis.introspection.abstract.reflection.html#_EXCLUDED_DUNDER_ATTRS
Attribute
Constant
PUBLIC
Dunder attributes built into the language, excluded from user-defined detection.
-
orionis.introspection.abstract.reflection._Flags
orionis.introspection.abstract.reflection._Flags.html
Class
Class
PUBLIC
Represent visibility classification flags for a class member.
-
orionis.introspection.abstract.reflection._Flags.is_dunder
orionis.introspection.abstract.reflection._Flags.html#is_dunder
Attribute
Instance Variable
PUBLIC
Indicate whether the member name is a double-underscore name.
-
orionis.introspection.abstract.reflection._Flags.is_private
orionis.introspection.abstract.reflection._Flags.html#is_private
Attribute
Instance Variable
PUBLIC
Indicate whether the member name is private.
-
orionis.introspection.abstract.reflection._Flags.is_prot
orionis.introspection.abstract.reflection._Flags.html#is_prot
Attribute
Instance Variable
PUBLIC
Indicate whether the member name is protected.
-
orionis.introspection.abstract.reflection._Flags.is_pub
orionis.introspection.abstract.reflection._Flags.html#is_pub
Attribute
Instance Variable
PUBLIC
Indicate whether the member name is public.
-
orionis.introspection.ReflectionAbstract
orionis.introspection.ReflectionAbstract.html
Class
Class
PUBLIC
Inspect abstract class declarations and their members.
-
orionis.introspection.ReflectionAbstract.__slots__
orionis.introspection.ReflectionAbstract.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.introspection.ReflectionAbstract.__init__
orionis.introspection.ReflectionAbstract.html#__init__
Function
Method
PUBLIC
Initialize the reflector for an abstract base class.
-
orionis.introspection.ReflectionAbstract._abstract
orionis.introspection.ReflectionAbstract.html#_abstract
Attribute
Instance Variable
PUBLIC
Provide the abstract base class to inspect.
-
orionis.introspection.ReflectionAbstract._abstract_name
orionis.introspection.ReflectionAbstract.html#_abstract_name
Attribute
Instance Variable
PUBLIC
Abstract name supplied through abstract_name.
-
orionis.introspection.ReflectionAbstract._abstract_module
orionis.introspection.ReflectionAbstract.html#_abstract_module
Attribute
Instance Variable
PUBLIC
Abstract module obtained from abstract.__module__.
-
orionis.introspection.ReflectionAbstract._private_prefix
orionis.introspection.ReflectionAbstract.html#_private_prefix
Attribute
Instance Variable
PUBLIC
Python strips the leading underscores of the class name when it mangles private members, so the prefix must be built the same way.
-
orionis.introspection.ReflectionAbstract._cache
orionis.introspection.ReflectionAbstract.html#_cache
Attribute
Instance Variable
PUBLIC
Cache policy or cached state used by this component.
-
orionis.introspection.ReflectionAbstract._scanned
orionis.introspection.ReflectionAbstract.html#_scanned
Attribute
Instance Variable
PUBLIC
Scanned flag used by ReflectionAbstract.
-
orionis.introspection.ReflectionAbstract.__getitem__
orionis.introspection.ReflectionAbstract.html#__getitem__
Function
Method
PUBLIC
Return the cached value for a key.
-
orionis.introspection.ReflectionAbstract.__setitem__
orionis.introspection.ReflectionAbstract.html#__setitem__
Function
Method
PUBLIC
Store a value in the cache.
-
orionis.introspection.ReflectionAbstract.__contains__
orionis.introspection.ReflectionAbstract.html#__contains__
Function
Method
PUBLIC
Return whether a cache key exists.
-
orionis.introspection.ReflectionAbstract.__delitem__
orionis.introspection.ReflectionAbstract.html#__delitem__
Function
Method
PUBLIC
Remove a key from the cache.
-
orionis.introspection.ReflectionAbstract._ensureScanned
orionis.introspection.ReflectionAbstract.html#_ensureScanned
Function
Method
PUBLIC
Ensure class members are scanned once before member access.
-
orionis.introspection.ReflectionAbstract._invalidateMembers
orionis.introspection.ReflectionAbstract.html#_invalidateMembers
Function
Method
PUBLIC
Invalidate cached member classifications.
-
orionis.introspection.ReflectionAbstract._makeBuckets
orionis.introspection.ReflectionAbstract.html#_makeBuckets
Function
Method
PUBLIC
Create mutable classification containers for a scan pass.
-
orionis.introspection.ReflectionAbstract._classifyProperty
orionis.introspection.ReflectionAbstract.html#_classifyProperty
Function
Method
PUBLIC
Classify a property name into visibility-specific buckets.
-
orionis.introspection.ReflectionAbstract._classifyStatic
orionis.introspection.ReflectionAbstract.html#_classifyStatic
Function
Method
PUBLIC
Classify a static method by visibility and coroutine status.
-
orionis.introspection.ReflectionAbstract._classifyClassMethod
orionis.introspection.ReflectionAbstract.html#_classifyClassMethod
Function
Method
PUBLIC
Classify a class method into reflection buckets.
-
orionis.introspection.ReflectionAbstract._classifyCallable
orionis.introspection.ReflectionAbstract.html#_classifyCallable
Function
Method
PUBLIC
Classify a regular callable by visibility and coroutine type.
-
orionis.introspection.ReflectionAbstract._classifyDataAttr
orionis.introspection.ReflectionAbstract.html#_classifyDataAttr
Function
Method
PUBLIC
Classify a non-callable attribute into visibility buckets.
-
orionis.introspection.ReflectionAbstract._commitAttrBuckets
orionis.introspection.ReflectionAbstract.html#_commitAttrBuckets
Function
Method
PUBLIC
Persist classified attribute buckets into the instance cache.
-
orionis.introspection.ReflectionAbstract._commitMethodBuckets
orionis.introspection.ReflectionAbstract.html#_commitMethodBuckets
Function
Method
PUBLIC
Persist classified method and property buckets into the instance cache.
-
orionis.introspection.ReflectionAbstract._scanClass
orionis.introspection.ReflectionAbstract.html#_scanClass
Function
Method
PUBLIC
Classify class members and commit cached reflection buckets.
-
orionis.introspection.ReflectionAbstract.getClass
orionis.introspection.ReflectionAbstract.html#getClass
Function
Method
PUBLIC
Return the class type associated with this reflection instance.
-
orionis.introspection.ReflectionAbstract.getClassName
orionis.introspection.ReflectionAbstract.html#getClassName
Function
Method
PUBLIC
Return the name of the reflected abstract class.
-
orionis.introspection.ReflectionAbstract.getModuleName
orionis.introspection.ReflectionAbstract.html#getModuleName
Function
Method
PUBLIC
Return the module name of the reflected abstract class.
-
orionis.introspection.ReflectionAbstract.getModuleWithClassName
orionis.introspection.ReflectionAbstract.html#getModuleWithClassName
Function
Method
PUBLIC
Return the fully qualified name of the abstract class.
-
orionis.introspection.ReflectionAbstract.getDocstring
orionis.introspection.ReflectionAbstract.html#getDocstring
Function
Method
PUBLIC
Retrieve the docstring for the reflected abstract class.
-
orionis.introspection.ReflectionAbstract.getBaseClasses
orionis.introspection.ReflectionAbstract.html#getBaseClasses
Function
Method
PUBLIC
Return the direct base classes of the reflected abstract class.
-
orionis.introspection.ReflectionAbstract.getSourceCode
orionis.introspection.ReflectionAbstract.html#getSourceCode
Function
Method
PUBLIC
Retrieve the source code of the reflected abstract class.
-
orionis.introspection.ReflectionAbstract.getFile
orionis.introspection.ReflectionAbstract.html#getFile
Function
Method
PUBLIC
Retrieve the absolute file path of the reflected abstract class.
-
orionis.introspection.ReflectionAbstract.getAnnotations
orionis.introspection.ReflectionAbstract.html#getAnnotations
Function
Method
PUBLIC
Retrieve type annotations for class attributes.
-
orionis.introspection.ReflectionAbstract.hasAttribute
orionis.introspection.ReflectionAbstract.html#hasAttribute
Function
Method
PUBLIC
Check if the class has a specific attribute.
-
orionis.introspection.ReflectionAbstract.getAttribute
orionis.introspection.ReflectionAbstract.html#getAttribute
Function
Method
PUBLIC
Retrieve the value of a class attribute.
-
orionis.introspection.ReflectionAbstract.setAttribute
orionis.introspection.ReflectionAbstract.html#setAttribute
Function
Method
PUBLIC
Set the value of a class attribute.
-
orionis.introspection.ReflectionAbstract.removeAttribute
orionis.introspection.ReflectionAbstract.html#removeAttribute
Function
Method
PUBLIC
Remove an attribute from the reflected abstract class.
-
orionis.introspection.ReflectionAbstract.getAttributes
orionis.introspection.ReflectionAbstract.html#getAttributes
Function
Method
PUBLIC
Aggregate all class-level attributes.
-
orionis.introspection.ReflectionAbstract.getPublicAttributes
orionis.introspection.ReflectionAbstract.html#getPublicAttributes
Function
Method
PUBLIC
Retrieve all public class-level attributes.
-
orionis.introspection.ReflectionAbstract.getProtectedAttributes
orionis.introspection.ReflectionAbstract.html#getProtectedAttributes
Function
Method
PUBLIC
Retrieve all protected class-level attributes.
-
orionis.introspection.ReflectionAbstract.getPrivateAttributes
orionis.introspection.ReflectionAbstract.html#getPrivateAttributes
Function
Method
PUBLIC
Retrieve all private class-level attributes.
-
orionis.introspection.ReflectionAbstract.getDunderAttributes
orionis.introspection.ReflectionAbstract.html#getDunderAttributes
Function
Method
PUBLIC
Retrieve dunder (double underscore) class-level attributes.
-
orionis.introspection.ReflectionAbstract.getMagicAttributes
orionis.introspection.ReflectionAbstract.html#getMagicAttributes
Function
Method
PUBLIC
Return a dictionary of magic (dunder) class attributes.
-
orionis.introspection.ReflectionAbstract.hasMethod
orionis.introspection.ReflectionAbstract.html#hasMethod
Function
Method
PUBLIC
Determine if the abstract class contains a method with the given name.
-
orionis.introspection.ReflectionAbstract.removeMethod
orionis.introspection.ReflectionAbstract.html#removeMethod
Function
Method
PUBLIC
Remove a method from the abstract class.
-
orionis.introspection.ReflectionAbstract.getMethodSignature
orionis.introspection.ReflectionAbstract.html#getMethodSignature
Function
Method
PUBLIC
Retrieve the signature of a method in the abstract class.
-
orionis.introspection.ReflectionAbstract.getMethods
orionis.introspection.ReflectionAbstract.html#getMethods
Function
Method
PUBLIC
Return all method names defined in the abstract class.
-
orionis.introspection.ReflectionAbstract.getPublicMethods
orionis.introspection.ReflectionAbstract.html#getPublicMethods
Function
Method
PUBLIC
Return all public instance method names.
-
orionis.introspection.ReflectionAbstract.getPublicSyncMethods
orionis.introspection.ReflectionAbstract.html#getPublicSyncMethods
Function
Method
PUBLIC
Return all public synchronous method names from the abstract class.
-
orionis.introspection.ReflectionAbstract.getPublicAsyncMethods
orionis.introspection.ReflectionAbstract.html#getPublicAsyncMethods
Function
Method
PUBLIC
Return all public asynchronous method names.
-
orionis.introspection.ReflectionAbstract.getProtectedMethods
orionis.introspection.ReflectionAbstract.html#getProtectedMethods
Function
Method
PUBLIC
Return all protected instance method names.
-
orionis.introspection.ReflectionAbstract.getProtectedSyncMethods
orionis.introspection.ReflectionAbstract.html#getProtectedSyncMethods
Function
Method
PUBLIC
Return all protected synchronous method names.
-
orionis.introspection.ReflectionAbstract.getProtectedAsyncMethods
orionis.introspection.ReflectionAbstract.html#getProtectedAsyncMethods
Function
Method
PUBLIC
Return all protected asynchronous method names.
-
orionis.introspection.ReflectionAbstract.getPrivateMethods
orionis.introspection.ReflectionAbstract.html#getPrivateMethods
Function
Method
PUBLIC
Return all private instance method names.
-
orionis.introspection.ReflectionAbstract.getPrivateSyncMethods
orionis.introspection.ReflectionAbstract.html#getPrivateSyncMethods
Function
Method
PUBLIC
Return all private synchronous method names.
-
orionis.introspection.ReflectionAbstract.getPrivateAsyncMethods
orionis.introspection.ReflectionAbstract.html#getPrivateAsyncMethods
Function
Method
PUBLIC
Retrieve private asynchronous method names.
-
orionis.introspection.ReflectionAbstract.getPublicClassMethods
orionis.introspection.ReflectionAbstract.html#getPublicClassMethods
Function
Method
PUBLIC
Return all public class method names.
-
orionis.introspection.ReflectionAbstract.getPublicClassSyncMethods
orionis.introspection.ReflectionAbstract.html#getPublicClassSyncMethods
Function
Method
PUBLIC
Return all public synchronous class method names.
-
orionis.introspection.ReflectionAbstract.getPublicClassAsyncMethods
orionis.introspection.ReflectionAbstract.html#getPublicClassAsyncMethods
Function
Method
PUBLIC
Return all public asynchronous class method names.
-
orionis.introspection.ReflectionAbstract.getProtectedClassMethods
orionis.introspection.ReflectionAbstract.html#getProtectedClassMethods
Function
Method
PUBLIC
Return a list of protected class methods.
-
orionis.introspection.ReflectionAbstract.getProtectedClassSyncMethods
orionis.introspection.ReflectionAbstract.html#getProtectedClassSyncMethods
Function
Method
PUBLIC
Return all protected synchronous class method names.
-
orionis.introspection.ReflectionAbstract.getProtectedClassAsyncMethods
orionis.introspection.ReflectionAbstract.html#getProtectedClassAsyncMethods
Function
Method
PUBLIC
Return all protected asynchronous class method names.
-
orionis.introspection.ReflectionAbstract.getPrivateClassMethods
orionis.introspection.ReflectionAbstract.html#getPrivateClassMethods
Function
Method
PUBLIC
Return a list of private class methods.
-
orionis.introspection.ReflectionAbstract.getPrivateClassSyncMethods
orionis.introspection.ReflectionAbstract.html#getPrivateClassSyncMethods
Function
Method
PUBLIC
Return all private synchronous class method names.
-
orionis.introspection.ReflectionAbstract.getPrivateClassAsyncMethods
orionis.introspection.ReflectionAbstract.html#getPrivateClassAsyncMethods
Function
Method
PUBLIC
Return all private asynchronous class method names.
-
orionis.introspection.ReflectionAbstract.getPublicStaticMethods
orionis.introspection.ReflectionAbstract.html#getPublicStaticMethods
Function
Method
PUBLIC
Return all public static method names.
-
orionis.introspection.ReflectionAbstract.getPublicStaticSyncMethods
orionis.introspection.ReflectionAbstract.html#getPublicStaticSyncMethods
Function
Method
PUBLIC
Return all public synchronous static method names.
-
orionis.introspection.ReflectionAbstract.getPublicStaticAsyncMethods
orionis.introspection.ReflectionAbstract.html#getPublicStaticAsyncMethods
Function
Method
PUBLIC
Return all public asynchronous static method names.
-
orionis.introspection.ReflectionAbstract.getProtectedStaticMethods
orionis.introspection.ReflectionAbstract.html#getProtectedStaticMethods
Function
Method
PUBLIC
Return a list of protected static method names.
-
orionis.introspection.ReflectionAbstract.getProtectedStaticSyncMethods
orionis.introspection.ReflectionAbstract.html#getProtectedStaticSyncMethods
Function
Method
PUBLIC
Return all protected synchronous static method names.
-
orionis.introspection.ReflectionAbstract.getProtectedStaticAsyncMethods
orionis.introspection.ReflectionAbstract.html#getProtectedStaticAsyncMethods
Function
Method
PUBLIC
Return all protected asynchronous static method names.
-
orionis.introspection.ReflectionAbstract.getPrivateStaticMethods
orionis.introspection.ReflectionAbstract.html#getPrivateStaticMethods
Function
Method
PUBLIC
Return a list of private static method names.
-
orionis.introspection.ReflectionAbstract.getPrivateStaticSyncMethods
orionis.introspection.ReflectionAbstract.html#getPrivateStaticSyncMethods
Function
Method
PUBLIC
Return all private synchronous static method names.
-
orionis.introspection.ReflectionAbstract.getPrivateStaticAsyncMethods
orionis.introspection.ReflectionAbstract.html#getPrivateStaticAsyncMethods
Function
Method
PUBLIC
Return all private asynchronous static method names.
-
orionis.introspection.ReflectionAbstract.getDunderMethods
orionis.introspection.ReflectionAbstract.html#getDunderMethods
Function
Method
PUBLIC
Return all dunder (double underscore) method names in the abstract class.
-
orionis.introspection.ReflectionAbstract.getMagicMethods
orionis.introspection.ReflectionAbstract.html#getMagicMethods
Function
Method
PUBLIC
Return all magic (dunder) methods from the abstract class.
-
orionis.introspection.ReflectionAbstract.getProperties
orionis.introspection.ReflectionAbstract.html#getProperties
Function
Method
PUBLIC
Retrieve all property names from the abstract class.
-
orionis.introspection.ReflectionAbstract.getPublicProperties
orionis.introspection.ReflectionAbstract.html#getPublicProperties
Function
Method
PUBLIC
Return all public property names from the abstract class.
-
orionis.introspection.ReflectionAbstract.getProtectedProperties
orionis.introspection.ReflectionAbstract.html#getProtectedProperties
Function
Method
PUBLIC
Retrieve all protected properties from the abstract class.
-
orionis.introspection.ReflectionAbstract.getPrivateProperties
orionis.introspection.ReflectionAbstract.html#getPrivateProperties
Function
Method
PUBLIC
Retrieve all private properties from the abstract class.
-
orionis.introspection.ReflectionAbstract.getPropertySignature
orionis.introspection.ReflectionAbstract.html#getPropertySignature
Function
Method
PUBLIC
Retrieve the signature of a property's getter method.
-
orionis.introspection.ReflectionAbstract.getPropertyDocstring
orionis.introspection.ReflectionAbstract.html#getPropertyDocstring
Function
Method
PUBLIC
Retrieve the docstring of a property's getter method.
-
orionis.introspection.ReflectionAbstract.constructorSignature
orionis.introspection.ReflectionAbstract.html#constructorSignature
Function
Method
PUBLIC
Retrieve constructor dependencies for the reflected class.
-
orionis.introspection.ReflectionAbstract.methodSignature
orionis.introspection.ReflectionAbstract.html#methodSignature
Function
Method
PUBLIC
Retrieve resolved and unresolved dependencies for a method.
-
orionis.introspection.ReflectionAbstract.clearCache
orionis.introspection.ReflectionAbstract.html#clearCache
Function
Method
PUBLIC
Clear all cached reflection data.
-
orionis.introspection.ReflectionCallable
orionis.introspection.ReflectionCallable.html
Class
Class
PUBLIC
Inspect callable signatures, parameters and invocation metadata.
-
orionis.introspection.ReflectionCallable.__slots__
orionis.introspection.ReflectionCallable.html#__slots__
Attribute
Class Variable
PUBLIC
Store the callable, cached results, and descriptive metadata snapshots.
-
orionis.introspection.ReflectionCallable.__init__
orionis.introspection.ReflectionCallable.html#__init__
Function
Method
PUBLIC
Initialize the reflection wrapper with a callable object.
-
orionis.introspection.ReflectionCallable._function
orionis.introspection.ReflectionCallable.html#_function
Attribute
Instance Variable
PUBLIC
The function, method, or lambda to be wrapped.
-
orionis.introspection.ReflectionCallable._name
orionis.introspection.ReflectionCallable.html#_name
Attribute
Instance Variable
PUBLIC
Name identifying this declaration within its containing registry.
-
orionis.introspection.ReflectionCallable._module
orionis.introspection.ReflectionCallable.html#_module
Attribute
Instance Variable
PUBLIC
Module obtained from fn.__module__.
-
orionis.introspection.ReflectionCallable._docstring
orionis.introspection.ReflectionCallable.html#_docstring
Attribute
Instance Variable
PUBLIC
Documentation text extracted from the inspected callable.
-
orionis.introspection.ReflectionCallable._cache
orionis.introspection.ReflectionCallable.html#_cache
Attribute
Instance Variable
PUBLIC
Shared dict for deferred computation results and the external cache protocol.
-
orionis.introspection.ReflectionCallable.__getitem__
orionis.introspection.ReflectionCallable.html#__getitem__
Function
Method
PUBLIC
Retrieve a cached value by key.
-
orionis.introspection.ReflectionCallable.__setitem__
orionis.introspection.ReflectionCallable.html#__setitem__
Function
Method
PUBLIC
Store a value in the cache with the specified key.
-
orionis.introspection.ReflectionCallable.__contains__
orionis.introspection.ReflectionCallable.html#__contains__
Function
Method
PUBLIC
Check if the cache contains the specified key.
-
orionis.introspection.ReflectionCallable.__delitem__
orionis.introspection.ReflectionCallable.html#__delitem__
Function
Method
PUBLIC
Remove an item from the memory cache by key.
-
orionis.introspection.ReflectionCallable.getCallable
orionis.introspection.ReflectionCallable.html#getCallable
Function
Method
PUBLIC
Return the callable function associated with this instance.
-
orionis.introspection.ReflectionCallable.getName
orionis.introspection.ReflectionCallable.html#getName
Function
Method
PUBLIC
Return the name of the callable.
-
orionis.introspection.ReflectionCallable.getModuleName
orionis.introspection.ReflectionCallable.html#getModuleName
Function
Method
PUBLIC
Return the module name where the callable is defined.
-
orionis.introspection.ReflectionCallable.getModuleWithCallableName
orionis.introspection.ReflectionCallable.html#getModuleWithCallableName
Function
Method
PUBLIC
Return the fully qualified name of the callable.
-
orionis.introspection.ReflectionCallable.getDocstring
orionis.introspection.ReflectionCallable.html#getDocstring
Function
Method
PUBLIC
Return the docstring of the callable.
-
orionis.introspection.ReflectionCallable.getSourceCode
orionis.introspection.ReflectionCallable.html#getSourceCode
Function
Method
PUBLIC
Retrieve the source code of the wrapped callable.
-
orionis.introspection.ReflectionCallable.getFile
orionis.introspection.ReflectionCallable.html#getFile
Function
Method
PUBLIC
Retrieve the absolute path to the source file of the callable.
-
orionis.introspection.ReflectionCallable.getSignature
orionis.introspection.ReflectionCallable.html#getSignature
Function
Method
PUBLIC
Return the signature of the callable.
-
orionis.introspection.ReflectionCallable.getDependencies
orionis.introspection.ReflectionCallable.html#getDependencies
Function
Method
PUBLIC
Analyze and return the dependency signature of the wrapped callable.
-
orionis.introspection.ReflectionCallable.clearCache
orionis.introspection.ReflectionCallable.html#clearCache
Function
Method
PUBLIC
Clear all cached reflection data.
-
orionis.introspection.ReflectionConcrete
orionis.introspection.ReflectionConcrete.html
Class
Class
PUBLIC
Inspect concrete classes and their construction requirements.
-
orionis.introspection.ReflectionConcrete.__init__
orionis.introspection.ReflectionConcrete.html#__init__
Function
Method
PUBLIC
Initialize the reflection concrete with a validated class type.
-
orionis.introspection.ReflectionConcrete._concrete
orionis.introspection.ReflectionConcrete.html#_concrete
Attribute
Instance Variable
PUBLIC
The class type to reflect.
-
orionis.introspection.ReflectionConcrete._class_name
orionis.introspection.ReflectionConcrete.html#_class_name
Attribute
Instance Variable
PUBLIC
Class name obtained from concrete.__name__.
-
orionis.introspection.ReflectionConcrete._private_prefix
orionis.introspection.ReflectionConcrete.html#_private_prefix
Attribute
Instance Variable
PUBLIC
Python strips the leading underscores of the class name when it mangles private members, so the prefix must be built the same way.
-
orionis.introspection.ReflectionConcrete._private_prefix_len
orionis.introspection.ReflectionConcrete.html#_private_prefix_len
Attribute
Instance Variable
PUBLIC
Private prefix len produced by len.
-
orionis.introspection.ReflectionConcrete._cache
orionis.introspection.ReflectionConcrete.html#_cache
Attribute
Instance Variable
PUBLIC
Cache policy or cached state used by this component.
-
orionis.introspection.ReflectionConcrete.__getitem__
orionis.introspection.ReflectionConcrete.html#__getitem__
Function
Method
PUBLIC
Retrieve a cached value by key.
-
orionis.introspection.ReflectionConcrete.__setitem__
orionis.introspection.ReflectionConcrete.html#__setitem__
Function
Method
PUBLIC
Store a value in the cache with the specified key.
-
orionis.introspection.ReflectionConcrete.__contains__
orionis.introspection.ReflectionConcrete.html#__contains__
Function
Method
PUBLIC
Check if the cache contains the specified key.
-
orionis.introspection.ReflectionConcrete.__delitem__
orionis.introspection.ReflectionConcrete.html#__delitem__
Function
Method
PUBLIC
Remove an item from the cache by key.
-
orionis.introspection.ReflectionConcrete._routeStaticMethod
orionis.introspection.ReflectionConcrete.html#_routeStaticMethod
Function
Static Method
PUBLIC
Route a static method into the correct visibility and async bucket.
-
orionis.introspection.ReflectionConcrete._routeClassMethod
orionis.introspection.ReflectionConcrete.html#_routeClassMethod
Function
Static Method
PUBLIC
Route a class method into the correct visibility and async bucket.
-
orionis.introspection.ReflectionConcrete._routeProperty
orionis.introspection.ReflectionConcrete.html#_routeProperty
Function
Static Method
PUBLIC
Route a property descriptor into the correct visibility bucket.
-
orionis.introspection.ReflectionConcrete._routeMethod
orionis.introspection.ReflectionConcrete.html#_routeMethod
Function
Static Method
PUBLIC
Route a plain callable into the correct instance method buckets.
-
orionis.introspection.ReflectionConcrete._routeAttribute
orionis.introspection.ReflectionConcrete.html#_routeAttribute
Function
Static Method
PUBLIC
Route a non-callable member into the correct attribute bucket.
-
orionis.introspection.ReflectionConcrete._scanClass
orionis.introspection.ReflectionConcrete.html#_scanClass
Function
Method
PUBLIC
Perform a single-pass classification of all members in the class __dict__.
-
orionis.introspection.ReflectionConcrete.getClass
orionis.introspection.ReflectionConcrete.html#getClass
Function
Method
PUBLIC
Return the class type being reflected.
-
orionis.introspection.ReflectionConcrete.getClassName
orionis.introspection.ReflectionConcrete.html#getClassName
Function
Method
PUBLIC
Return the name of the reflected class.
-
orionis.introspection.ReflectionConcrete.getModuleName
orionis.introspection.ReflectionConcrete.html#getModuleName
Function
Method
PUBLIC
Return the module name where the reflected class is defined.
-
orionis.introspection.ReflectionConcrete.getModuleWithClassName
orionis.introspection.ReflectionConcrete.html#getModuleWithClassName
Function
Method
PUBLIC
Return the fully qualified class name with module path.
-
orionis.introspection.ReflectionConcrete.getDocstring
orionis.introspection.ReflectionConcrete.html#getDocstring
Function
Method
PUBLIC
Return the docstring of the reflected class.
-
orionis.introspection.ReflectionConcrete.getBaseClasses
orionis.introspection.ReflectionConcrete.html#getBaseClasses
Function
Method
PUBLIC
Return all base classes of the reflected class.
-
orionis.introspection.ReflectionConcrete.getSourceCode
orionis.introspection.ReflectionConcrete.html#getSourceCode
Function
Method
PUBLIC
Retrieve the source code for the class or a specific method.
-
orionis.introspection.ReflectionConcrete.getFile
orionis.introspection.ReflectionConcrete.html#getFile
Function
Method
PUBLIC
Return the absolute file path of the reflected class.
-
orionis.introspection.ReflectionConcrete.getAnnotations
orionis.introspection.ReflectionConcrete.html#getAnnotations
Function
Method
PUBLIC
Retrieve type annotations defined on the reflected class.
-
orionis.introspection.ReflectionConcrete.hasAttribute
orionis.introspection.ReflectionConcrete.html#hasAttribute
Function
Method
PUBLIC
Determine if the reflected class has a specific attribute.
-
orionis.introspection.ReflectionConcrete.getAttribute
orionis.introspection.ReflectionConcrete.html#getAttribute
Function
Method
PUBLIC
Retrieve the value of a class attribute.
-
orionis.introspection.ReflectionConcrete.setAttribute
orionis.introspection.ReflectionConcrete.html#setAttribute
Function
Method
PUBLIC
Set a class attribute to the specified value.
-
orionis.introspection.ReflectionConcrete.removeAttribute
orionis.introspection.ReflectionConcrete.html#removeAttribute
Function
Method
PUBLIC
Remove an attribute from the reflected class.
-
orionis.introspection.ReflectionConcrete.getAttributes
orionis.introspection.ReflectionConcrete.html#getAttributes
Function
Method
PUBLIC
Aggregate all class attributes of all visibility levels.
-
orionis.introspection.ReflectionConcrete.getPublicAttributes
orionis.introspection.ReflectionConcrete.html#getPublicAttributes
Function
Method
PUBLIC
Retrieve all public class attributes.
-
orionis.introspection.ReflectionConcrete.getProtectedAttributes
orionis.introspection.ReflectionConcrete.html#getProtectedAttributes
Function
Method
PUBLIC
Retrieve all protected class attributes.
-
orionis.introspection.ReflectionConcrete.getPrivateAttributes
orionis.introspection.ReflectionConcrete.html#getPrivateAttributes
Function
Method
PUBLIC
Retrieve all private class attributes.
-
orionis.introspection.ReflectionConcrete.getDunderAttributes
orionis.introspection.ReflectionConcrete.html#getDunderAttributes
Function
Method
PUBLIC
Retrieve all dunder (magic) class attributes.
-
orionis.introspection.ReflectionConcrete.getMagicAttributes
orionis.introspection.ReflectionConcrete.html#getMagicAttributes
Function
Method
PUBLIC
Return all magic (dunder) class attributes.
-
orionis.introspection.ReflectionConcrete.hasMethod
orionis.introspection.ReflectionConcrete.html#hasMethod
Function
Method
PUBLIC
Determine if the class defines a method with the given name.
-
orionis.introspection.ReflectionConcrete.setMethod
orionis.introspection.ReflectionConcrete.html#setMethod
Function
Method
PUBLIC
Add a method to the reflected class.
-
orionis.introspection.ReflectionConcrete.removeMethod
orionis.introspection.ReflectionConcrete.html#removeMethod
Function
Method
PUBLIC
Remove a method from the reflected class.
-
orionis.introspection.ReflectionConcrete.getMethodSignature
orionis.introspection.ReflectionConcrete.html#getMethodSignature
Function
Method
PUBLIC
Retrieve the signature of a specific method.
-
orionis.introspection.ReflectionConcrete.getMethods
orionis.introspection.ReflectionConcrete.html#getMethods
Function
Method
PUBLIC
Retrieve all method names defined in the reflected class.
-
orionis.introspection.ReflectionConcrete.getPublicMethods
orionis.introspection.ReflectionConcrete.html#getPublicMethods
Function
Method
PUBLIC
Return all public instance method names of the reflected class.
-
orionis.introspection.ReflectionConcrete.getPublicSyncMethods
orionis.introspection.ReflectionConcrete.html#getPublicSyncMethods
Function
Method
PUBLIC
Return all public synchronous method names of the reflected class.
-
orionis.introspection.ReflectionConcrete.getPublicAsyncMethods
orionis.introspection.ReflectionConcrete.html#getPublicAsyncMethods
Function
Method
PUBLIC
Return all public asynchronous method names of the reflected class.
-
orionis.introspection.ReflectionConcrete.getProtectedMethods
orionis.introspection.ReflectionConcrete.html#getProtectedMethods
Function
Method
PUBLIC
Return all protected instance method names.
-
orionis.introspection.ReflectionConcrete.getProtectedSyncMethods
orionis.introspection.ReflectionConcrete.html#getProtectedSyncMethods
Function
Method
PUBLIC
Return all protected synchronous method names.
-
orionis.introspection.ReflectionConcrete.getProtectedAsyncMethods
orionis.introspection.ReflectionConcrete.html#getProtectedAsyncMethods
Function
Method
PUBLIC
Retrieve all protected asynchronous method names.
-
orionis.introspection.ReflectionConcrete.getPrivateMethods
orionis.introspection.ReflectionConcrete.html#getPrivateMethods
Function
Method
PUBLIC
Retrieve all private instance method names.
-
orionis.introspection.ReflectionConcrete.getPrivateSyncMethods
orionis.introspection.ReflectionConcrete.html#getPrivateSyncMethods
Function
Method
PUBLIC
Return all private synchronous method names of the class.
-
orionis.introspection.ReflectionConcrete.getPrivateAsyncMethods
orionis.introspection.ReflectionConcrete.html#getPrivateAsyncMethods
Function
Method
PUBLIC
Return all private asynchronous method names of the class.
-
orionis.introspection.ReflectionConcrete.getPublicClassMethods
orionis.introspection.ReflectionConcrete.html#getPublicClassMethods
Function
Method
PUBLIC
Return a list of public class method names.
-
orionis.introspection.ReflectionConcrete.getPublicClassSyncMethods
orionis.introspection.ReflectionConcrete.html#getPublicClassSyncMethods
Function
Method
PUBLIC
Return all public synchronous class method names.
-
orionis.introspection.ReflectionConcrete.getPublicClassAsyncMethods
orionis.introspection.ReflectionConcrete.html#getPublicClassAsyncMethods
Function
Method
PUBLIC
Return all public asynchronous class method names.
-
orionis.introspection.ReflectionConcrete.getProtectedClassMethods
orionis.introspection.ReflectionConcrete.html#getProtectedClassMethods
Function
Method
PUBLIC
Return a list of protected class method names.
-
orionis.introspection.ReflectionConcrete.getProtectedClassSyncMethods
orionis.introspection.ReflectionConcrete.html#getProtectedClassSyncMethods
Function
Method
PUBLIC
Return all protected synchronous class method names.
-
orionis.introspection.ReflectionConcrete.getProtectedClassAsyncMethods
orionis.introspection.ReflectionConcrete.html#getProtectedClassAsyncMethods
Function
Method
PUBLIC
Return all protected asynchronous class method names.
-
orionis.introspection.ReflectionConcrete.getPrivateClassMethods
orionis.introspection.ReflectionConcrete.html#getPrivateClassMethods
Function
Method
PUBLIC
Return a list of private class method names.
-
orionis.introspection.ReflectionConcrete.getPrivateClassSyncMethods
orionis.introspection.ReflectionConcrete.html#getPrivateClassSyncMethods
Function
Method
PUBLIC
Return all private synchronous class method names.
-
orionis.introspection.ReflectionConcrete.getPrivateClassAsyncMethods
orionis.introspection.ReflectionConcrete.html#getPrivateClassAsyncMethods
Function
Method
PUBLIC
Return all private asynchronous class method names.
-
orionis.introspection.ReflectionConcrete.getPublicStaticMethods
orionis.introspection.ReflectionConcrete.html#getPublicStaticMethods
Function
Method
PUBLIC
Return a list of public static method names.
-
orionis.introspection.ReflectionConcrete.getPublicStaticSyncMethods
orionis.introspection.ReflectionConcrete.html#getPublicStaticSyncMethods
Function
Method
PUBLIC
Return all public synchronous static method names of the class.
-
orionis.introspection.ReflectionConcrete.getPublicStaticAsyncMethods
orionis.introspection.ReflectionConcrete.html#getPublicStaticAsyncMethods
Function
Method
PUBLIC
Return all public asynchronous static method names of the class.
-
orionis.introspection.ReflectionConcrete.getProtectedStaticMethods
orionis.introspection.ReflectionConcrete.html#getProtectedStaticMethods
Function
Method
PUBLIC
Return a list of protected static method names.
-
orionis.introspection.ReflectionConcrete.getProtectedStaticSyncMethods
orionis.introspection.ReflectionConcrete.html#getProtectedStaticSyncMethods
Function
Method
PUBLIC
Return all protected synchronous static method names of the class.
-
orionis.introspection.ReflectionConcrete.getProtectedStaticAsyncMethods
orionis.introspection.ReflectionConcrete.html#getProtectedStaticAsyncMethods
Function
Method
PUBLIC
Retrieve all protected asynchronous static method names.
-
orionis.introspection.ReflectionConcrete.getPrivateStaticMethods
orionis.introspection.ReflectionConcrete.html#getPrivateStaticMethods
Function
Method
PUBLIC
Return the names of all private static methods of the class.
-
orionis.introspection.ReflectionConcrete.getPrivateStaticSyncMethods
orionis.introspection.ReflectionConcrete.html#getPrivateStaticSyncMethods
Function
Method
PUBLIC
Return all private synchronous static method names of the class.
-
orionis.introspection.ReflectionConcrete.getPrivateStaticAsyncMethods
orionis.introspection.ReflectionConcrete.html#getPrivateStaticAsyncMethods
Function
Method
PUBLIC
Retrieve all private asynchronous static method names of the class.
-
orionis.introspection.ReflectionConcrete.getDunderMethods
orionis.introspection.ReflectionConcrete.html#getDunderMethods
Function
Method
PUBLIC
Retrieve all dunder (magic) method names from the reflected class.
-
orionis.introspection.ReflectionConcrete.getMagicMethods
orionis.introspection.ReflectionConcrete.html#getMagicMethods
Function
Method
PUBLIC
Return all magic (dunder) method names from the reflected class.
-
orionis.introspection.ReflectionConcrete.getProperties
orionis.introspection.ReflectionConcrete.html#getProperties
Function
Method
PUBLIC
Return all property names defined in the reflected class.
-
orionis.introspection.ReflectionConcrete.getPublicProperties
orionis.introspection.ReflectionConcrete.html#getPublicProperties
Function
Method
PUBLIC
Return all public property names of the reflected class.
-
orionis.introspection.ReflectionConcrete.getProtectedProperties
orionis.introspection.ReflectionConcrete.html#getProtectedProperties
Function
Method
PUBLIC
Retrieve all protected property names from the reflected class.
-
orionis.introspection.ReflectionConcrete.getPrivateProperties
orionis.introspection.ReflectionConcrete.html#getPrivateProperties
Function
Method
PUBLIC
Return all private property names of the reflected class.
-
orionis.introspection.ReflectionConcrete.getProperty
orionis.introspection.ReflectionConcrete.html#getProperty
Function
Method
PUBLIC
Retrieve the value of a property from the reflected class.
-
orionis.introspection.ReflectionConcrete.getPropertySignature
orionis.introspection.ReflectionConcrete.html#getPropertySignature
Function
Method
PUBLIC
Return the signature of a property's getter method.
-
orionis.introspection.ReflectionConcrete.getPropertyDocstring
orionis.introspection.ReflectionConcrete.html#getPropertyDocstring
Function
Method
PUBLIC
Retrieve the docstring of a property's getter method.
-
orionis.introspection.ReflectionConcrete.getConstructorSignature
orionis.introspection.ReflectionConcrete.html#getConstructorSignature
Function
Method
PUBLIC
Return the signature of the class constructor.
-
orionis.introspection.ReflectionConcrete.constructorSignature
orionis.introspection.ReflectionConcrete.html#constructorSignature
Function
Method
PUBLIC
Analyze the constructor's dependencies.
-
orionis.introspection.ReflectionConcrete.methodSignature
orionis.introspection.ReflectionConcrete.html#methodSignature
Function
Method
PUBLIC
Analyze the dependencies of a specific method.
-
orionis.introspection.ReflectionConcrete.clearCache
orionis.introspection.ReflectionConcrete.html#clearCache
Function
Method
PUBLIC
Clear the internal memory cache.
-
orionis.introspection.ReflectDependencies
orionis.introspection.ReflectDependencies.html
Class
Class
PUBLIC
Reflect dependency metadata from callables, constructors, and methods.
-
orionis.introspection.ReflectDependencies.__slots__
orionis.introspection.ReflectDependencies.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.introspection.ReflectDependencies.__init__
orionis.introspection.ReflectDependencies.html#__init__
Function
Method
PUBLIC
Initialize the ReflectDependencies instance.
-
orionis.introspection.ReflectDependencies._target
orionis.introspection.ReflectDependencies.html#_target
Attribute
Instance Variable
PUBLIC
The object whose dependencies are to be reflected.
-
orionis.introspection.ReflectDependencies.constructorSignature
orionis.introspection.ReflectDependencies.html#constructorSignature
Function
Method
PUBLIC
Inspect the constructor (__init__) and categorize parameter dependencies.
-
orionis.introspection.ReflectDependencies.methodSignature
orionis.introspection.ReflectDependencies.html#methodSignature
Function
Method
PUBLIC
Inspect a named method and categorize its parameter dependencies.
-
orionis.introspection.ReflectDependencies.callableSignature
orionis.introspection.ReflectDependencies.html#callableSignature
Function
Method
PUBLIC
Inspect the callable target and categorize its parameter dependencies.
-
orionis.introspection.ReflectionInstance
orionis.introspection.ReflectionInstance.html
Class
Class
PUBLIC
Inspect the class and members of an existing object.
-
orionis.introspection.ReflectionInstance.__init__
orionis.introspection.ReflectionInstance.html#__init__
Function
Method
PUBLIC
Initialize the ReflectionInstance with the given object instance.
-
orionis.introspection.ReflectionInstance._instance
orionis.introspection.ReflectionInstance.html#_instance
Attribute
Instance Variable
PUBLIC
The object instance to reflect.
-
orionis.introspection.ReflectionInstance._cls
orionis.introspection.ReflectionInstance.html#_cls
Attribute
Instance Variable
PUBLIC
Cls supplied through cls.
-
orionis.introspection.ReflectionInstance._class_name
orionis.introspection.ReflectionInstance.html#_class_name
Attribute
Instance Variable
PUBLIC
Class name obtained from cls.__name__.
-
orionis.introspection.ReflectionInstance._module_name
orionis.introspection.ReflectionInstance.html#_module_name
Attribute
Instance Variable
PUBLIC
Module name supplied through module.
-
orionis.introspection.ReflectionInstance._private_prefix
orionis.introspection.ReflectionInstance.html#_private_prefix
Attribute
Instance Variable
PUBLIC
Python strips the leading underscores of the class name when it mangles private members, so the prefix must be built the same way.
-
orionis.introspection.ReflectionInstance._memory_cache
orionis.introspection.ReflectionInstance.html#_memory_cache
Attribute
Instance Variable
PUBLIC
Process-local cache of previously computed reflection results.
-
orionis.introspection.ReflectionInstance.__getitem__
orionis.introspection.ReflectionInstance.html#__getitem__
Function
Method
PUBLIC
Retrieve a cached value by key.
-
orionis.introspection.ReflectionInstance.__setitem__
orionis.introspection.ReflectionInstance.html#__setitem__
Function
Method
PUBLIC
Store a value in the cache with the specified key.
-
orionis.introspection.ReflectionInstance.__contains__
orionis.introspection.ReflectionInstance.html#__contains__
Function
Method
PUBLIC
Check if the cache contains the specified key.
-
orionis.introspection.ReflectionInstance.__delitem__
orionis.introspection.ReflectionInstance.html#__delitem__
Function
Method
PUBLIC
Remove an item from the memory cache by key.
-
orionis.introspection.ReflectionInstance._storedAttributes
orionis.introspection.ReflectionInstance.html#_storedAttributes
Function
Method
PUBLIC
Read populated dictionary and slot fields without evaluating properties.
-
orionis.introspection.ReflectionInstance._scanInstanceVars
orionis.introspection.ReflectionInstance.html#_scanInstanceVars
Function
Method
PUBLIC
Categorize instance variables into visibility groups in a single traversal.
-
orionis.introspection.ReflectionInstance._scanPropertyEntries
orionis.introspection.ReflectionInstance.html#_scanPropertyEntries
Function
Method
PUBLIC
Scan the class dict for property descriptors and sort by visibility.
-
orionis.introspection.ReflectionInstance._classifyStaticEntry
orionis.introspection.ReflectionInstance.html#_classifyStaticEntry
Function
Method
PUBLIC
Categorize a static method by visibility and append to the accumulator.
-
orionis.introspection.ReflectionInstance._classifyClassEntry
orionis.introspection.ReflectionInstance.html#_classifyClassEntry
Function
Method
PUBLIC
Categorize a class method by visibility and append to the accumulator.
-
orionis.introspection.ReflectionInstance._classifyFunctionEntry
orionis.introspection.ReflectionInstance.html#_classifyFunctionEntry
Function
Method
PUBLIC
Categorize an instance method by visibility and append to the accumulator.
-
orionis.introspection.ReflectionInstance._classifyCallableMember
orionis.introspection.ReflectionInstance.html#_classifyCallableMember
Function
Method
PUBLIC
Route a non-special member according to its actual binding owner.
-
orionis.introspection.ReflectionInstance._scanClassMembers
orionis.introspection.ReflectionInstance.html#_scanClassMembers
Function
Method
PUBLIC
Discover and categorize all class members in a single traversal.
-
orionis.introspection.ReflectionInstance.getInstance
orionis.introspection.ReflectionInstance.html#getInstance
Function
Method
PUBLIC
Return the reflected object instance.
-
orionis.introspection.ReflectionInstance.getClass
orionis.introspection.ReflectionInstance.html#getClass
Function
Method
PUBLIC
Return the class of the instance.
-
orionis.introspection.ReflectionInstance.getClassName
orionis.introspection.ReflectionInstance.html#getClassName
Function
Method
PUBLIC
Return the name of the instance's class.
-
orionis.introspection.ReflectionInstance.getModuleName
orionis.introspection.ReflectionInstance.html#getModuleName
Function
Method
PUBLIC
Return the name of the module where the class is defined.
-
orionis.introspection.ReflectionInstance.getModuleWithClassName
orionis.introspection.ReflectionInstance.html#getModuleWithClassName
Function
Method
PUBLIC
Return the module and class name as a single string.
-
orionis.introspection.ReflectionInstance.getDocstring
orionis.introspection.ReflectionInstance.html#getDocstring
Function
Method
PUBLIC
Return the docstring of the instance's class.
-
orionis.introspection.ReflectionInstance.getBaseClasses
orionis.introspection.ReflectionInstance.html#getBaseClasses
Function
Method
PUBLIC
Return the base classes of the instance's class.
-
orionis.introspection.ReflectionInstance.getSourceCode
orionis.introspection.ReflectionInstance.html#getSourceCode
Function
Method
PUBLIC
Retrieve the source code for the class or a specific method.
-
orionis.introspection.ReflectionInstance.getFile
orionis.introspection.ReflectionInstance.html#getFile
Function
Method
PUBLIC
Return the file path where the class is defined.
-
orionis.introspection.ReflectionInstance.getAnnotations
orionis.introspection.ReflectionInstance.html#getAnnotations
Function
Method
PUBLIC
Retrieve type annotations of the class.
-
orionis.introspection.ReflectionInstance.hasAttribute
orionis.introspection.ReflectionInstance.html#hasAttribute
Function
Method
PUBLIC
Check if the instance has a specific attribute.
-
orionis.introspection.ReflectionInstance.getAttribute
orionis.introspection.ReflectionInstance.html#getAttribute
Function
Method
PUBLIC
Retrieve the value of an attribute by name from the instance.
-
orionis.introspection.ReflectionInstance.setAttribute
orionis.introspection.ReflectionInstance.html#setAttribute
Function
Method
PUBLIC
Set the value of an attribute on the instance.
-
orionis.introspection.ReflectionInstance.removeAttribute
orionis.introspection.ReflectionInstance.html#removeAttribute
Function
Method
PUBLIC
Remove an attribute from the instance.
-
orionis.introspection.ReflectionInstance.getAttributeDocstring
orionis.introspection.ReflectionInstance.html#getAttributeDocstring
Function
Method
PUBLIC
Retrieve the docstring of a specific attribute.
-
orionis.introspection.ReflectionInstance.getAttributes
orionis.introspection.ReflectionInstance.html#getAttributes
Function
Method
PUBLIC
Aggregate all attributes of the instance.
-
orionis.introspection.ReflectionInstance.getPublicAttributes
orionis.introspection.ReflectionInstance.html#getPublicAttributes
Function
Method
PUBLIC
Return all public attributes of the instance.
-
orionis.introspection.ReflectionInstance.getProtectedAttributes
orionis.introspection.ReflectionInstance.html#getProtectedAttributes
Function
Method
PUBLIC
Return all protected attributes of the instance.
-
orionis.introspection.ReflectionInstance.getPrivateAttributes
orionis.introspection.ReflectionInstance.html#getPrivateAttributes
Function
Method
PUBLIC
Retrieve all private attributes of the instance.
-
orionis.introspection.ReflectionInstance.getDunderAttributes
orionis.introspection.ReflectionInstance.html#getDunderAttributes
Function
Method
PUBLIC
Retrieve all dunder (double underscore) attributes of the instance.
-
orionis.introspection.ReflectionInstance.getMagicAttributes
orionis.introspection.ReflectionInstance.html#getMagicAttributes
Function
Method
PUBLIC
Return all magic attributes of the instance.
-
orionis.introspection.ReflectionInstance.hasMethod
orionis.introspection.ReflectionInstance.html#hasMethod
Function
Method
PUBLIC
Determine if the instance has a specific method.
-
orionis.introspection.ReflectionInstance.setMethod
orionis.introspection.ReflectionInstance.html#setMethod
Function
Method
PUBLIC
Set a callable attribute as a method.
-
orionis.introspection.ReflectionInstance.removeMethod
orionis.introspection.ReflectionInstance.html#removeMethod
Function
Method
PUBLIC
Remove an instance override or a method declared on its class.
-
orionis.introspection.ReflectionInstance._methodTarget
orionis.introspection.ReflectionInstance.html#_methodTarget
Function
Method
PUBLIC
Select an instance override before the unbound class declaration.
-
orionis.introspection.ReflectionInstance.getMethodSignature
orionis.introspection.ReflectionInstance.html#getMethodSignature
Function
Method
PUBLIC
Retrieve the signature of a method.
-
orionis.introspection.ReflectionInstance.getMethodDocstring
orionis.introspection.ReflectionInstance.html#getMethodDocstring
Function
Method
PUBLIC
Retrieve the docstring of a method.
-
orionis.introspection.ReflectionInstance.getMethods
orionis.introspection.ReflectionInstance.html#getMethods
Function
Method
PUBLIC
Retrieve all method names associated with the instance.
-
orionis.introspection.ReflectionInstance.getPublicMethods
orionis.introspection.ReflectionInstance.html#getPublicMethods
Function
Method
PUBLIC
Return all public method names of the instance.
-
orionis.introspection.ReflectionInstance.getPublicSyncMethods
orionis.introspection.ReflectionInstance.html#getPublicSyncMethods
Function
Method
PUBLIC
Return all public synchronous method names of the instance.
-
orionis.introspection.ReflectionInstance.getPublicAsyncMethods
orionis.introspection.ReflectionInstance.html#getPublicAsyncMethods
Function
Method
PUBLIC
Return all public asynchronous method names of the instance.
-
orionis.introspection.ReflectionInstance.getProtectedMethods
orionis.introspection.ReflectionInstance.html#getProtectedMethods
Function
Method
PUBLIC
Return all protected method names of the instance.
-
orionis.introspection.ReflectionInstance.getProtectedSyncMethods
orionis.introspection.ReflectionInstance.html#getProtectedSyncMethods
Function
Method
PUBLIC
Return all protected synchronous method names of the instance.
-
orionis.introspection.ReflectionInstance.getProtectedAsyncMethods
orionis.introspection.ReflectionInstance.html#getProtectedAsyncMethods
Function
Method
PUBLIC
Retrieve all protected asynchronous method names of the instance.
-
orionis.introspection.ReflectionInstance.getPrivateMethods
orionis.introspection.ReflectionInstance.html#getPrivateMethods
Function
Method
PUBLIC
Return all private method names of the instance.
-
orionis.introspection.ReflectionInstance.getPrivateSyncMethods
orionis.introspection.ReflectionInstance.html#getPrivateSyncMethods
Function
Method
PUBLIC
Retrieve all private synchronous method names of the instance.
-
orionis.introspection.ReflectionInstance.getPrivateAsyncMethods
orionis.introspection.ReflectionInstance.html#getPrivateAsyncMethods
Function
Method
PUBLIC
Retrieve all private asynchronous method names of the instance.
-
orionis.introspection.ReflectionInstance.getPublicClassMethods
orionis.introspection.ReflectionInstance.html#getPublicClassMethods
Function
Method
PUBLIC
Return all public class method names of the instance.
-
orionis.introspection.ReflectionInstance.getPublicClassSyncMethods
orionis.introspection.ReflectionInstance.html#getPublicClassSyncMethods
Function
Method
PUBLIC
Return all public synchronous class method names of the instance.
-
orionis.introspection.ReflectionInstance.getPublicClassAsyncMethods
orionis.introspection.ReflectionInstance.html#getPublicClassAsyncMethods
Function
Method
PUBLIC
Return all public asynchronous class method names of the instance.
-
orionis.introspection.ReflectionInstance.getProtectedClassMethods
orionis.introspection.ReflectionInstance.html#getProtectedClassMethods
Function
Method
PUBLIC
Return all protected class method names of the instance.
-
orionis.introspection.ReflectionInstance.getProtectedClassSyncMethods
orionis.introspection.ReflectionInstance.html#getProtectedClassSyncMethods
Function
Method
PUBLIC
Return all protected synchronous class method names of the instance.
-
orionis.introspection.ReflectionInstance.getProtectedClassAsyncMethods
orionis.introspection.ReflectionInstance.html#getProtectedClassAsyncMethods
Function
Method
PUBLIC
Retrieve all protected asynchronous class method names of the instance.
-
orionis.introspection.ReflectionInstance.getPrivateClassMethods
orionis.introspection.ReflectionInstance.html#getPrivateClassMethods
Function
Method
PUBLIC
Return all private class method names of the instance.
-
orionis.introspection.ReflectionInstance.getPrivateClassSyncMethods
orionis.introspection.ReflectionInstance.html#getPrivateClassSyncMethods
Function
Method
PUBLIC
Retrieve all private synchronous class method names of the instance.
-
orionis.introspection.ReflectionInstance.getPrivateClassAsyncMethods
orionis.introspection.ReflectionInstance.html#getPrivateClassAsyncMethods
Function
Method
PUBLIC
Retrieve all private asynchronous class method names of the instance.
-
orionis.introspection.ReflectionInstance.getPublicStaticMethods
orionis.introspection.ReflectionInstance.html#getPublicStaticMethods
Function
Method
PUBLIC
Return the names of all public static methods of the instance's class.
-
orionis.introspection.ReflectionInstance.getPublicStaticSyncMethods
orionis.introspection.ReflectionInstance.html#getPublicStaticSyncMethods
Function
Method
PUBLIC
Return all public synchronous static method names of the instance.
-
orionis.introspection.ReflectionInstance.getPublicStaticAsyncMethods
orionis.introspection.ReflectionInstance.html#getPublicStaticAsyncMethods
Function
Method
PUBLIC
Retrieve all public asynchronous static method names of the instance.
-
orionis.introspection.ReflectionInstance.getProtectedStaticMethods
orionis.introspection.ReflectionInstance.html#getProtectedStaticMethods
Function
Method
PUBLIC
Return all protected static method names of the instance.
-
orionis.introspection.ReflectionInstance.getProtectedStaticSyncMethods
orionis.introspection.ReflectionInstance.html#getProtectedStaticSyncMethods
Function
Method
PUBLIC
Retrieve all protected synchronous static method names.
-
orionis.introspection.ReflectionInstance.getProtectedStaticAsyncMethods
orionis.introspection.ReflectionInstance.html#getProtectedStaticAsyncMethods
Function
Method
PUBLIC
Retrieve all protected asynchronous static method names.
-
orionis.introspection.ReflectionInstance.getPrivateStaticMethods
orionis.introspection.ReflectionInstance.html#getPrivateStaticMethods
Function
Method
PUBLIC
Return all private static method names of the instance.
-
orionis.introspection.ReflectionInstance.getPrivateStaticSyncMethods
orionis.introspection.ReflectionInstance.html#getPrivateStaticSyncMethods
Function
Method
PUBLIC
Retrieve all private synchronous static method names of the instance.
-
orionis.introspection.ReflectionInstance.getPrivateStaticAsyncMethods
orionis.introspection.ReflectionInstance.html#getPrivateStaticAsyncMethods
Function
Method
PUBLIC
Retrieve all private asynchronous static method names of the instance.
-
orionis.introspection.ReflectionInstance.getDunderMethods
orionis.introspection.ReflectionInstance.html#getDunderMethods
Function
Method
PUBLIC
Return all dunder (double underscore) method names of the instance.
-
orionis.introspection.ReflectionInstance.getMagicMethods
orionis.introspection.ReflectionInstance.html#getMagicMethods
Function
Method
PUBLIC
Return all magic method names of the instance.
-
orionis.introspection.ReflectionInstance.getProperties
orionis.introspection.ReflectionInstance.html#getProperties
Function
Method
PUBLIC
Return all property names of the instance.
-
orionis.introspection.ReflectionInstance.getPublicProperties
orionis.introspection.ReflectionInstance.html#getPublicProperties
Function
Method
PUBLIC
Return all public properties of the instance.
-
orionis.introspection.ReflectionInstance.getProtectedProperties
orionis.introspection.ReflectionInstance.html#getProtectedProperties
Function
Method
PUBLIC
Retrieve all protected properties of the instance.
-
orionis.introspection.ReflectionInstance.getPrivateProperties
orionis.introspection.ReflectionInstance.html#getPrivateProperties
Function
Method
PUBLIC
Retrieve all private properties of the instance.
-
orionis.introspection.ReflectionInstance.getProperty
orionis.introspection.ReflectionInstance.html#getProperty
Function
Method
PUBLIC
Retrieve the value of a property from the instance.
-
orionis.introspection.ReflectionInstance.getPropertySignature
orionis.introspection.ReflectionInstance.html#getPropertySignature
Function
Method
PUBLIC
Return the signature of a property getter.
-
orionis.introspection.ReflectionInstance.getPropertyDocstring
orionis.introspection.ReflectionInstance.html#getPropertyDocstring
Function
Method
PUBLIC
Retrieve the docstring for a property.
-
orionis.introspection.ReflectionInstance.constructorSignature
orionis.introspection.ReflectionInstance.html#constructorSignature
Function
Method
PUBLIC
Analyze and return constructor dependencies of the instance's class.
-
orionis.introspection.ReflectionInstance.methodSignature
orionis.introspection.ReflectionInstance.html#methodSignature
Function
Method
PUBLIC
Analyze and return dependencies for a method of the instance's class.
-
orionis.introspection.ReflectionInstance.clearCache
orionis.introspection.ReflectionInstance.html#clearCache
Function
Method
PUBLIC
Clear the internal memory cache.
-
orionis.introspection.ModuleInspector
orionis.introspection.ModuleInspector.html
Class
Class
PUBLIC
Load modules and inspect their exported definitions.
-
orionis.introspection.ModuleInspector.discoverModules
orionis.introspection.ModuleInspector.html#discoverModules
Function
Static Method
PUBLIC
Discover Python modules in a directory tree.
-
orionis.introspection.ModuleInspector._collectDirectoryModules
orionis.introspection.ModuleInspector.html#_collectDirectoryModules
Function
Static Method
PUBLIC
Add Python module names from one discovered directory.
-
orionis.introspection.ModuleInspector.loadClass
orionis.introspection.ModuleInspector.html#loadClass
Function
Class Method
PUBLIC
Load and return a class object from a specified module.
-
orionis.introspection.ModuleInspector.fileImportsAny
orionis.introspection.ModuleInspector.html#fileImportsAny
Function
Static Method
PUBLIC
Determine if a file imports any target modules using AST analysis.
-
orionis.introspection.ModuleInspector.discoverFrozenDataclasses
orionis.introspection.ModuleInspector.html#discoverFrozenDataclasses
Function
Static Method
PUBLIC
Discover frozen dataclasses in specified modules.
-
orionis.introspection.ReflectionModule
orionis.introspection.ReflectionModule.html
Class
Class
PUBLIC
Inspect Python modules and the definitions they contain.
-
orionis.introspection.ReflectionModule.__init__
orionis.introspection.ReflectionModule.html#__init__
Function
Method
PUBLIC
Initialize the ReflectionModule by importing the specified module.
-
orionis.introspection.ReflectionModule.__module
orionis.introspection.ReflectionModule.html#__module
Attribute
Instance Variable
PUBLIC
Name of the module to import and reflect upon.
-
orionis.introspection.ReflectionModule.__memory_cache
orionis.introspection.ReflectionModule.html#__memory_cache
Attribute
Instance Variable
PUBLIC
Initialize memory cache for storing values.
-
orionis.introspection.ReflectionModule.__getitem__
orionis.introspection.ReflectionModule.html#__getitem__
Function
Method
PUBLIC
Retrieve a cached value by key.
-
orionis.introspection.ReflectionModule.__setitem__
orionis.introspection.ReflectionModule.html#__setitem__
Function
Method
PUBLIC
Store a value in the cache with the specified key.
-
orionis.introspection.ReflectionModule.__contains__
orionis.introspection.ReflectionModule.html#__contains__
Function
Method
PUBLIC
Check if the cache contains the specified key.
-
orionis.introspection.ReflectionModule.__delitem__
orionis.introspection.ReflectionModule.html#__delitem__
Function
Method
PUBLIC
Remove an item from the memory cache by key.
-
orionis.introspection.ReflectionModule.getModule
orionis.introspection.ReflectionModule.html#getModule
Function
Method
PUBLIC
Return the imported module object.
-
orionis.introspection.ReflectionModule.hasClass
orionis.introspection.ReflectionModule.html#hasClass
Function
Method
PUBLIC
Check if a class with the specified name exists in the module.
-
orionis.introspection.ReflectionModule.getClass
orionis.introspection.ReflectionModule.html#getClass
Function
Method
PUBLIC
Retrieve a class object by its name from the module.
-
orionis.introspection.ReflectionModule.setClass
orionis.introspection.ReflectionModule.html#setClass
Function
Method
PUBLIC
Set a class in the module.
-
orionis.introspection.ReflectionModule.removeClass
orionis.introspection.ReflectionModule.html#removeClass
Function
Method
PUBLIC
Remove a class from the module.
-
orionis.introspection.ReflectionModule.getClasses
orionis.introspection.ReflectionModule.html#getClasses
Function
Method
PUBLIC
Return a dictionary of classes defined in the module.
-
orionis.introspection.ReflectionModule.getPublicClasses
orionis.introspection.ReflectionModule.html#getPublicClasses
Function
Method
PUBLIC
Return a dictionary of public classes defined in the module.
-
orionis.introspection.ReflectionModule.getProtectedClasses
orionis.introspection.ReflectionModule.html#getProtectedClasses
Function
Method
PUBLIC
Return a dictionary of protected classes defined in the module.
-
orionis.introspection.ReflectionModule.getPrivateClasses
orionis.introspection.ReflectionModule.html#getPrivateClasses
Function
Method
PUBLIC
Return a dictionary of private classes defined in the module.
-
orionis.introspection.ReflectionModule.getConstant
orionis.introspection.ReflectionModule.html#getConstant
Function
Method
PUBLIC
Retrieve a constant value by name from the module.
-
orionis.introspection.ReflectionModule.getConstants
orionis.introspection.ReflectionModule.html#getConstants
Function
Method
PUBLIC
Retrieve constants defined in the module.
-
orionis.introspection.ReflectionModule.getPublicConstants
orionis.introspection.ReflectionModule.html#getPublicConstants
Function
Method
PUBLIC
Retrieve public constants defined in the module.
-
orionis.introspection.ReflectionModule.getProtectedConstants
orionis.introspection.ReflectionModule.html#getProtectedConstants
Function
Method
PUBLIC
Return protected constants defined in the module.
-
orionis.introspection.ReflectionModule.getPrivateConstants
orionis.introspection.ReflectionModule.html#getPrivateConstants
Function
Method
PUBLIC
Retrieve private constants defined in the module.
-
orionis.introspection.ReflectionModule.getFunctions
orionis.introspection.ReflectionModule.html#getFunctions
Function
Method
PUBLIC
Return a dictionary of functions defined in the module.
-
orionis.introspection.ReflectionModule.getPublicFunctions
orionis.introspection.ReflectionModule.html#getPublicFunctions
Function
Method
PUBLIC
Return a dictionary of public functions defined in the module.
-
orionis.introspection.ReflectionModule.getPublicSyncFunctions
orionis.introspection.ReflectionModule.html#getPublicSyncFunctions
Function
Method
PUBLIC
Return a dictionary of public synchronous functions in the module.
-
orionis.introspection.ReflectionModule.getPublicAsyncFunctions
orionis.introspection.ReflectionModule.html#getPublicAsyncFunctions
Function
Method
PUBLIC
Return a dictionary of public asynchronous functions in the module.
-
orionis.introspection.ReflectionModule.getProtectedFunctions
orionis.introspection.ReflectionModule.html#getProtectedFunctions
Function
Method
PUBLIC
Return a dictionary of protected functions defined in the module.
-
orionis.introspection.ReflectionModule.getProtectedSyncFunctions
orionis.introspection.ReflectionModule.html#getProtectedSyncFunctions
Function
Method
PUBLIC
Return protected synchronous functions defined in the module.
-
orionis.introspection.ReflectionModule.getProtectedAsyncFunctions
orionis.introspection.ReflectionModule.html#getProtectedAsyncFunctions
Function
Method
PUBLIC
Return protected asynchronous functions defined in the module.
-
orionis.introspection.ReflectionModule.getPrivateFunctions
orionis.introspection.ReflectionModule.html#getPrivateFunctions
Function
Method
PUBLIC
Return private functions defined in the module.
-
orionis.introspection.ReflectionModule.getPrivateSyncFunctions
orionis.introspection.ReflectionModule.html#getPrivateSyncFunctions
Function
Method
PUBLIC
Return private synchronous functions defined in the module.
-
orionis.introspection.ReflectionModule.getPrivateAsyncFunctions
orionis.introspection.ReflectionModule.html#getPrivateAsyncFunctions
Function
Method
PUBLIC
Return private asynchronous functions defined in the module.
-
orionis.introspection.ReflectionModule.getImports
orionis.introspection.ReflectionModule.html#getImports
Function
Method
PUBLIC
Retrieve imported modules from the module.
-
orionis.introspection.ReflectionModule.getFile
orionis.introspection.ReflectionModule.html#getFile
Function
Method
PUBLIC
Return the file path of the module.
-
orionis.introspection.ReflectionModule.getSourceCode
orionis.introspection.ReflectionModule.html#getSourceCode
Function
Method
PUBLIC
Retrieve the source code of the module.
-
orionis.introspection.ReflectionModule.clearCache
orionis.introspection.ReflectionModule.html#clearCache
Function
Method
PUBLIC
Clear all cached reflection data.
-
orionis.introspection.Reflection
orionis.introspection.Reflection.html
Class
Class
PUBLIC
Select reflection helpers for classes, instances, functions and modules.
-
orionis.introspection.Reflection.instance
orionis.introspection.Reflection.html#instance
Function
Static Method
PUBLIC
Create a ReflectionInstance for an object instance.
-
orionis.introspection.Reflection.abstract
orionis.introspection.Reflection.html#abstract
Function
Static Method
PUBLIC
Create a ReflectionAbstract for an abstract class.
-
orionis.introspection.Reflection.concrete
orionis.introspection.Reflection.html#concrete
Function
Static Method
PUBLIC
Create a ReflectionConcrete for a concrete class.
-
orionis.introspection.Reflection.module
orionis.introspection.Reflection.html#module
Function
Static Method
PUBLIC
Create a reflection object for a module.
-
orionis.introspection.Reflection.callable
orionis.introspection.Reflection.html#callable
Function
Static Method
PUBLIC
Create a ReflectionCallable for a callable object.
-
orionis.introspection.Reflection.isAbstract
orionis.introspection.Reflection.html#isAbstract
Function
Static Method
PUBLIC
Determine if the object is an abstract base class.
-
orionis.introspection.Reflection.isConcreteClass
orionis.introspection.Reflection.html#isConcreteClass
Function
Static Method
PUBLIC
Determine if the object is a concrete user-defined class.
-
orionis.introspection.Reflection.isAsyncGen
orionis.introspection.Reflection.html#isAsyncGen
Function
Static Method
PUBLIC
Determine if the object is an asynchronous generator.
-
orionis.introspection.Reflection.isAsyncGenFunction
orionis.introspection.Reflection.html#isAsyncGenFunction
Function
Static Method
PUBLIC
Determine if the object is an asynchronous generator function.
-
orionis.introspection.Reflection.isAwaitable
orionis.introspection.Reflection.html#isAwaitable
Function
Static Method
PUBLIC
Determine if the object can be awaited.
-
orionis.introspection.Reflection.isBuiltIn
orionis.introspection.Reflection.html#isBuiltIn
Function
Static Method
PUBLIC
Determine if the object is a built-in function or method.
-
orionis.introspection.Reflection.isClass
orionis.introspection.Reflection.html#isClass
Function
Static Method
PUBLIC
Determine if the object is a class.
-
orionis.introspection.Reflection.isCode
orionis.introspection.Reflection.html#isCode
Function
Static Method
PUBLIC
Determine if the object is a code object.
-
orionis.introspection.Reflection.isCoroutine
orionis.introspection.Reflection.html#isCoroutine
Function
Static Method
PUBLIC
Determine if the object is a coroutine.
-
orionis.introspection.Reflection.isCoroutineFunction
orionis.introspection.Reflection.html#isCoroutineFunction
Function
Static Method
PUBLIC
Determine if the object is a coroutine function.
-
orionis.introspection.Reflection.isDataDescriptor
orionis.introspection.Reflection.html#isDataDescriptor
Function
Static Method
PUBLIC
Determine if the object is a data descriptor.
-
orionis.introspection.Reflection.isFrame
orionis.introspection.Reflection.html#isFrame
Function
Static Method
PUBLIC
Determine if the object is a frame object.
-
orionis.introspection.Reflection.isFunction
orionis.introspection.Reflection.html#isFunction
Function
Static Method
PUBLIC
Determine if the object is a Python function.
-
orionis.introspection.Reflection.isGenerator
orionis.introspection.Reflection.html#isGenerator
Function
Static Method
PUBLIC
Determine if the object is a generator.
-
orionis.introspection.Reflection.isGeneratorFunction
orionis.introspection.Reflection.html#isGeneratorFunction
Function
Static Method
PUBLIC
Determine if the object is a generator function.
-
orionis.introspection.Reflection.isGetSetDescriptor
orionis.introspection.Reflection.html#isGetSetDescriptor
Function
Static Method
PUBLIC
Determine if the object is a getset descriptor.
-
orionis.introspection.Reflection.isMemberDescriptor
orionis.introspection.Reflection.html#isMemberDescriptor
Function
Static Method
PUBLIC
Determine if the object is a member descriptor.
-
orionis.introspection.Reflection.isMethod
orionis.introspection.Reflection.html#isMethod
Function
Static Method
PUBLIC
Determine if the object is a method.
-
orionis.introspection.Reflection.isMethodDescriptor
orionis.introspection.Reflection.html#isMethodDescriptor
Function
Static Method
PUBLIC
Determine if the object is a method descriptor.
-
orionis.introspection.Reflection.isModule
orionis.introspection.Reflection.html#isModule
Function
Static Method
PUBLIC
Determine if the object is a module.
-
orionis.introspection.Reflection.isRoutine
orionis.introspection.Reflection.html#isRoutine
Function
Static Method
PUBLIC
Determine if the object is a user-defined or built-in function or method.
-
orionis.introspection.Reflection.isTraceback
orionis.introspection.Reflection.html#isTraceback
Function
Static Method
PUBLIC
Determine if the object is a traceback object.
-
orionis.introspection.Reflection.isGeneric
orionis.introspection.Reflection.html#isGeneric
Function
Static Method
PUBLIC
Determine if the provided type is a generic type.
-
orionis.introspection.Reflection.isProtocol
orionis.introspection.Reflection.html#isProtocol
Function
Static Method
PUBLIC
Determine if the object is a subclass of typing.Protocol.
-
orionis.introspection.Reflection.isInstance
orionis.introspection.Reflection.html#isInstance
Function
Static Method
PUBLIC
Determine if the object is an instance of a user-defined class.
-
orionis.introspection.Reflection.isTypingConstruct
orionis.introspection.Reflection.html#isTypingConstruct
Function
Static Method
PUBLIC
Determine if the object is a construct from the typing module.
-
orionis.introspection._EXPORTS
orionis.introspection.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.introspection.__getattr__
orionis.introspection.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.introspection.__dir__
orionis.introspection.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.localization.InvalidLocaleException
orionis.localization.InvalidLocaleException.html
Class
Exception
PUBLIC
Raised when a locale code is empty, malformed, or unsafe.
-
orionis.localization.TranslationException
orionis.localization.TranslationException.html
Class
Exception
PUBLIC
Base exception for all localization-related errors.
-
orionis.localization.TranslationFileNotFoundException
orionis.localization.TranslationFileNotFoundException.html
Class
Exception
PUBLIC
Raised when a translation file cannot be found on disk.
-
orionis.localization.TranslationSyntaxException
orionis.localization.TranslationSyntaxException.html
Class
Exception
PUBLIC
Raised when a translation file contains invalid JSON or structure.
-
orionis.localization.validators._LOCALE_PATTERN
orionis.localization.validators.html#_LOCALE_PATTERN
Attribute
Constant
PUBLIC
Accept alphanumeric locale segments separated by hyphens or underscores.
-
orionis.localization.validators.validate_locale
orionis.localization.validators.html#validate_locale
Function
Function
PUBLIC
Validate a locale code and return its original spelling.
-
orionis.localization.TranslationLoader
orionis.localization.TranslationLoader.html
Class
Class
PUBLIC
Load translation sources from the configured language path.
-
orionis.localization.TranslationLoader.__slots__
orionis.localization.TranslationLoader.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.localization.TranslationLoader.__init__
orionis.localization.TranslationLoader.html#__init__
Function
Method
PUBLIC
Initialize the loader with the language directory.
-
orionis.localization.TranslationLoader._path
orionis.localization.TranslationLoader.html#_path
Attribute
Instance Variable
PUBLIC
Absolute directory containing the translation sources.
-
orionis.localization.TranslationLoader.load
orionis.localization.TranslationLoader.html#load
Function
Method
PUBLIC
Load every translation available for locale.
-
orionis.localization.TranslationLoader.availableLocales
orionis.localization.TranslationLoader.html#availableLocales
Function
Method
PUBLIC
Discover every locale with at least one translation source.
-
orionis.localization.TranslationLoader.__readFile
orionis.localization.TranslationLoader.html#__readFile
Function
Method
PUBLIC
Decode a single translation file with msgspec.
-
orionis.localization.TranslationLoader.__resolveSource
orionis.localization.TranslationLoader.html#__resolveSource
Function
Method
PUBLIC
Resolve a source inside the configured language directory.
-
orionis.localization.TranslationLoader.__flatten
orionis.localization.TranslationLoader.html#__flatten
Function
Method
PUBLIC
Flatten a nested translation object into dot-notated keys.
-
orionis.localization.translator._EXACT_PATTERN
orionis.localization.translator.module.html#_EXACT_PATTERN
Attribute
Constant
PUBLIC
Explicit exact condition on a plural segment, e.g. "{0} none".
-
orionis.localization.translator._RANGE_PATTERN
orionis.localization.translator.module.html#_RANGE_PATTERN
Attribute
Constant
PUBLIC
Explicit range condition on a plural segment, e.g. "[2,*] many".
-
orionis.localization.LocalizationManager
orionis.localization.LocalizationManager.html
Class
Class
PUBLIC
Wire the localization component from the application configuration.
-
orionis.localization.LocalizationManager.__slots__
orionis.localization.LocalizationManager.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.localization.LocalizationManager.__init__
orionis.localization.LocalizationManager.html#__init__
Function
Method
PUBLIC
Initialize the manager with the application container.
-
orionis.localization.LocalizationManager._app
orionis.localization.LocalizationManager.html#_app
Attribute
Instance Variable
PUBLIC
Application container providing configuration and paths.
-
orionis.localization.LocalizationManager._lock
orionis.localization.LocalizationManager.html#_lock
Attribute
Instance Variable
PUBLIC
Lock serializing construction and publication of the translator.
-
orionis.localization.LocalizationManager._translator
orionis.localization.LocalizationManager.html#_translator
Attribute
Instance Variable
PUBLIC
Translator used to resolve localized messages.
-
orionis.localization.LocalizationManager.translator
orionis.localization.LocalizationManager.html#translator
Function
Method
PUBLIC
Return the shared translator instance, building it on demand.
-
orionis.localization.LocalizationManager.__buildTranslator
orionis.localization.LocalizationManager.html#__buildTranslator
Function
Method
PUBLIC
Build the translator from the application configuration.
-
orionis.localization.TranslationRepository
orionis.localization.TranslationRepository.html
Class
Class
PUBLIC
In-memory cache of translation maps keyed by locale.
-
orionis.localization.TranslationRepository.__slots__
orionis.localization.TranslationRepository.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.localization.TranslationRepository.__init__
orionis.localization.TranslationRepository.html#__init__
Function
Method
PUBLIC
Initialize the repository with its translation loader.
-
orionis.localization.TranslationRepository._loader
orionis.localization.TranslationRepository.html#_loader
Attribute
Instance Variable
PUBLIC
Loader used to read translation sources on cache misses.
-
orionis.localization.TranslationRepository._cache
orionis.localization.TranslationRepository.html#_cache
Attribute
Instance Variable
PUBLIC
Cache policy or cached state used by this component.
-
orionis.localization.TranslationRepository._expires
orionis.localization.TranslationRepository.html#_expires
Attribute
Instance Variable
PUBLIC
Expiration deadline for the cached or protected value.
-
orionis.localization.TranslationRepository._limit
orionis.localization.TranslationRepository.html#_limit
Attribute
Instance Variable
PUBLIC
Maximum retained locales, including empty results.
-
orionis.localization.TranslationRepository._negative_ttl
orionis.localization.TranslationRepository.html#_negative_ttl
Attribute
Instance Variable
PUBLIC
Seconds to retain an empty result before retrying the loader.
-
orionis.localization.TranslationRepository._lock
orionis.localization.TranslationRepository.html#_lock
Attribute
Instance Variable
PUBLIC
Lock protecting concurrent access to shared state.
-
orionis.localization.TranslationRepository.get
orionis.localization.TranslationRepository.html#get
Function
Method
PUBLIC
Return the translation map for locale, loading it on demand.
-
orionis.localization.TranslationRepository.has
orionis.localization.TranslationRepository.html#has
Function
Method
PUBLIC
Determine whether locale is already cached in memory.
-
orionis.localization.TranslationRepository.forget
orionis.localization.TranslationRepository.html#forget
Function
Method
PUBLIC
Discard the cached translations for locale.
-
orionis.localization.TranslationRepository.flush
orionis.localization.TranslationRepository.html#flush
Function
Method
PUBLIC
Discard every cached translation map.
-
orionis.localization.TranslationRepository.loadedLocales
orionis.localization.TranslationRepository.html#loadedLocales
Function
Method
PUBLIC
Return the locales currently held in the cache.
-
orionis.localization.Translator
orionis.localization.Translator.html
Class
Class
PUBLIC
Resolve translation lines for the active locale.
-
orionis.localization.Translator.__slots__
orionis.localization.Translator.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.localization.Translator.__init__
orionis.localization.Translator.html#__init__
Function
Method
PUBLIC
Initialize the translator with its locales and collaborators.
-
orionis.localization.Translator._loader
orionis.localization.Translator.html#_loader
Attribute
Instance Variable
PUBLIC
Loader used to discover the available locales.
-
orionis.localization.Translator._repository
orionis.localization.Translator.html#_repository
Attribute
Instance Variable
PUBLIC
In-memory cache resolving translation maps per locale.
-
orionis.localization.Translator._locale
orionis.localization.Translator.html#_locale
Attribute
Instance Variable
PUBLIC
Active locale code.
-
orionis.localization.Translator._fallback
orionis.localization.Translator.html#_fallback
Attribute
Instance Variable
PUBLIC
Locale used when a translation is missing.
-
orionis.localization.Translator._missing
orionis.localization.Translator.html#_missing
Attribute
Instance Variable
PUBLIC
Callback used when a translation key cannot be resolved.
-
orionis.localization.Translator.get
orionis.localization.Translator.html#get
Function
Method
PUBLIC
Retrieve the translation line registered under key.
-
orionis.localization.Translator.has
orionis.localization.Translator.html#has
Function
Method
PUBLIC
Determine whether a translation exists for key.
-
orionis.localization.Translator.choice
orionis.localization.Translator.html#choice
Function
Method
PUBLIC
Retrieve a pluralized translation line based on count.
-
orionis.localization.Translator.setLocale
orionis.localization.Translator.html#setLocale
Function
Method
PUBLIC
Change the active locale at runtime.
-
orionis.localization.Translator.getLocale
orionis.localization.Translator.html#getLocale
Function
Method
PUBLIC
Return the active locale.
-
orionis.localization.Translator.availableLocales
orionis.localization.Translator.html#availableLocales
Function
Method
PUBLIC
Return every locale with at least one translation source.
-
orionis.localization.Translator.reload
orionis.localization.Translator.html#reload
Function
Method
PUBLIC
Discard cached translations so they are re-read from disk.
-
orionis.localization.Translator.forget
orionis.localization.Translator.html#forget
Function
Method
PUBLIC
Discard the cached translations for a single locale.
-
orionis.localization.Translator.flush
orionis.localization.Translator.html#flush
Function
Method
PUBLIC
Discard every cached translation map.
-
orionis.localization.Translator.missing
orionis.localization.Translator.html#missing
Function
Method
PUBLIC
Register a handler invoked when a translation key is missing.
-
orionis.localization.Translator.__assertLocale
orionis.localization.Translator.html#__assertLocale
Function
Method
PUBLIC
Validate a locale code and return it unchanged.
-
orionis.localization.Translator.__resolveMissing
orionis.localization.Translator.html#__resolveMissing
Function
Method
PUBLIC
Resolve the line for a missing translation key.
-
orionis.localization.Translator.__applyReplacements
orionis.localization.Translator.html#__applyReplacements
Function
Method
PUBLIC
Substitute placeholders into a translation line.
-
orionis.localization.Translator.__matchExplicitSegment
orionis.localization.Translator.html#__matchExplicitSegment
Function
Method
PUBLIC
Select the plural segment whose explicit condition matches.
-
orionis.localization.Translator.__matchPluralSegment
orionis.localization.Translator.html#__matchPluralSegment
Function
Method
PUBLIC
Select the plural segment through positional rules.
-
orionis.localization.Translator.__stripCondition
orionis.localization.Translator.html#__stripCondition
Function
Method
PUBLIC
Remove a leading explicit condition from a plural segment.
-
orionis.localization.Translator.__asNumber
orionis.localization.Translator.html#__asNumber
Function
Method
PUBLIC
Parse a plural condition token into a number.
-
orionis.localization.Translator.__matchesBound
orionis.localization.Translator.html#__matchesBound
Function
Method
PUBLIC
Evaluate one bound of an explicit range condition.
-
orionis.localization._EXCEPTION_MODULE
orionis.localization.html#_EXCEPTION_MODULE
Attribute
Constant
PUBLIC
Module defining the public localization exception types.
-
orionis.localization._EXPORTS
orionis.localization.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.localization.__getattr__
orionis.localization.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.localization.__dir__
orionis.localization.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.localization.contracts.ITranslationLoader
orionis.localization.contracts.ITranslationLoader.html
Class
Class
PUBLIC
Define the contract for translation file loaders.
-
orionis.localization.contracts.ITranslationLoader.__slots__
orionis.localization.contracts.ITranslationLoader.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.localization.contracts.ITranslationLoader.load
orionis.localization.contracts.ITranslationLoader.html#load
Function
Method
PUBLIC
Load every translation available for locale.
-
orionis.localization.contracts.ITranslationLoader.availableLocales
orionis.localization.contracts.ITranslationLoader.html#availableLocales
Function
Method
PUBLIC
Discover every locale with at least one translation source.
-
orionis.localization.contracts.ILocalizationManager
orionis.localization.contracts.ILocalizationManager.html
Class
Class
PUBLIC
Define the contract for the localization manager.
-
orionis.localization.contracts.ILocalizationManager.__slots__
orionis.localization.contracts.ILocalizationManager.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.localization.contracts.ILocalizationManager.translator
orionis.localization.contracts.ILocalizationManager.html#translator
Function
Method
PUBLIC
Return the shared translator instance, building it on demand.
-
orionis.localization.contracts.ITranslationRepository
orionis.localization.contracts.ITranslationRepository.html
Class
Class
PUBLIC
Define the contract for the in-memory translation cache.
-
orionis.localization.contracts.ITranslationRepository.__slots__
orionis.localization.contracts.ITranslationRepository.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.localization.contracts.ITranslationRepository.get
orionis.localization.contracts.ITranslationRepository.html#get
Function
Method
PUBLIC
Return the translation map for locale, loading it on demand.
-
orionis.localization.contracts.ITranslationRepository.has
orionis.localization.contracts.ITranslationRepository.html#has
Function
Method
PUBLIC
Determine whether locale is already cached in memory.
-
orionis.localization.contracts.ITranslationRepository.forget
orionis.localization.contracts.ITranslationRepository.html#forget
Function
Method
PUBLIC
Discard the cached translations for locale.
-
orionis.localization.contracts.ITranslationRepository.flush
orionis.localization.contracts.ITranslationRepository.html#flush
Function
Method
PUBLIC
Discard every cached translation map.
-
orionis.localization.contracts.ITranslationRepository.loadedLocales
orionis.localization.contracts.ITranslationRepository.html#loadedLocales
Function
Method
PUBLIC
Return the locales currently held in the cache.
-
orionis.localization.contracts.ITranslator
orionis.localization.contracts.ITranslator.html
Class
Class
PUBLIC
Define the contract for the translation service.
-
orionis.localization.contracts.ITranslator.__slots__
orionis.localization.contracts.ITranslator.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.localization.contracts.ITranslator.get
orionis.localization.contracts.ITranslator.html#get
Function
Method
PUBLIC
Retrieve the translation line registered under key.
-
orionis.localization.contracts.ITranslator.has
orionis.localization.contracts.ITranslator.html#has
Function
Method
PUBLIC
Determine whether a translation exists for key.
-
orionis.localization.contracts.ITranslator.choice
orionis.localization.contracts.ITranslator.html#choice
Function
Method
PUBLIC
Retrieve a pluralized translation line based on count.
-
orionis.localization.contracts.ITranslator.setLocale
orionis.localization.contracts.ITranslator.html#setLocale
Function
Method
PUBLIC
Change the active locale at runtime.
-
orionis.localization.contracts.ITranslator.getLocale
orionis.localization.contracts.ITranslator.html#getLocale
Function
Method
PUBLIC
Return the active locale.
-
orionis.localization.contracts.ITranslator.availableLocales
orionis.localization.contracts.ITranslator.html#availableLocales
Function
Method
PUBLIC
Return every locale with at least one translation source.
-
orionis.localization.contracts.ITranslator.reload
orionis.localization.contracts.ITranslator.html#reload
Function
Method
PUBLIC
Discard cached translations so they are re-read from disk.
-
orionis.localization.contracts.ITranslator.forget
orionis.localization.contracts.ITranslator.html#forget
Function
Method
PUBLIC
Discard the cached translations for a single locale.
-
orionis.localization.contracts.ITranslator.flush
orionis.localization.contracts.ITranslator.html#flush
Function
Method
PUBLIC
Discard every cached translation map.
-
orionis.localization.contracts.ITranslator.missing
orionis.localization.contracts.ITranslator.html#missing
Function
Method
PUBLIC
Register a handler invoked when a translation key is missing.
-
orionis.localization.provider.LocalizationProvider
orionis.localization.provider.LocalizationProvider.html
Class
Class
PUBLIC
Service provider for the Orionis localization system.
-
orionis.localization.provider.LocalizationProvider.register
orionis.localization.provider.LocalizationProvider.html#register
Function
Method
PUBLIC
Bind ILocalizationManager to LocalizationManager as a singleton.
-
orionis.localization.provider.LocalizationProvider.boot
orionis.localization.provider.LocalizationProvider.html#boot
Function
Method
PUBLIC
Bind the shared translator and pin the Lang facade.
-
orionis.logging.handlers.queued.LoggingDeliveryError
orionis.logging.handlers.queued.LoggingDeliveryError.html
Class
Exception
PUBLIC
Signal a synchronous or background log-delivery failure.
-
orionis.logging.handlers.queued.observe_sink_error
orionis.logging.handlers.queued.html#observe_sink_error
Function
Function
PUBLIC
Observe an active sink exception before invoking its original callback.
-
orionis.logging.handlers.queued._raise_sink_error
orionis.logging.handlers.queued.html#_raise_sink_error
Function
Function
PUBLIC
Raise a delivery error for the active sink exception.
-
orionis.logging.handlers.queued._Listener
orionis.logging.handlers.queued._Listener.html
Class
Class
PUBLIC
Drain queued records while retaining and observing delivery failures.
-
orionis.logging.handlers.queued._Listener.error
orionis.logging.handlers.queued._Listener.html#error
Attribute
Class Variable
PUBLIC
First error retained while background work continues to drain.
-
orionis.logging.handlers.queued._Listener.app
orionis.logging.handlers.queued._Listener.html#app
Attribute
Class Variable
PUBLIC
Application owning the sink and its failure policy.
-
orionis.logging.handlers.queued._Listener.runtime
orionis.logging.handlers.queued._Listener.html#runtime
Attribute
Class Variable
PUBLIC
Prepared coordinator retained for deliveries outside a request context.
-
orionis.logging.handlers.queued._Listener.handle
orionis.logging.handlers.queued._Listener.html#handle
Function
Method
PUBLIC
Deliver a record under its originating failure-reporting context.
-
orionis.logging.handlers.queued._Listener._deliver
orionis.logging.handlers.queued._Listener.html#_deliver
Function
Method
PUBLIC
Deliver a queued record and retain the listener's first sink failure.
-
orionis.logging.handlers.queued._Listener.enqueueSentinel
orionis.logging.handlers.queued._Listener.html#enqueueSentinel
Function
Method
PUBLIC
Enqueue the shutdown sentinel, waiting for queue capacity.
-
orionis.logging.handlers.queued.BoundedQueueHandler
orionis.logging.handlers.queued.BoundedQueueHandler.html
Class
Class
PUBLIC
Deliver records to an owned sink through a bounded background queue.
-
orionis.logging.handlers.queued.BoundedQueueHandler.__init__
orionis.logging.handlers.queued.BoundedQueueHandler.html#__init__
Function
Method
PUBLIC
Start a bounded background listener for an owned logging sink.
-
orionis.logging.handlers.queued.BoundedQueueHandler._target
orionis.logging.handlers.queued.BoundedQueueHandler.html#_target
Attribute
Instance Variable
PUBLIC
Owned sink, closed after the queue drains.
-
orionis.logging.handlers.queued.BoundedQueueHandler._queue
orionis.logging.handlers.queued.BoundedQueueHandler.html#_queue
Attribute
Instance Variable
PUBLIC
Name of the queue receiving or storing the job.
-
orionis.logging.handlers.queued.BoundedQueueHandler._listener
orionis.logging.handlers.queued.BoundedQueueHandler.html#_listener
Attribute
Instance Variable
PUBLIC
Listener produced by _Listener.
-
orionis.logging.handlers.queued.BoundedQueueHandler._stopped
orionis.logging.handlers.queued.BoundedQueueHandler.html#_stopped
Attribute
Instance Variable
PUBLIC
Stopped flag used by BoundedQueueHandler.
-
orionis.logging.handlers.queued.BoundedQueueHandler.emit
orionis.logging.handlers.queued.BoundedQueueHandler.html#emit
Function
Method
PUBLIC
Enqueue a record snapshot without waiting for queue capacity.
-
orionis.logging.handlers.queued.BoundedQueueHandler.flush
orionis.logging.handlers.queued.BoundedQueueHandler.html#flush
Function
Method
PUBLIC
Wait for queued work, then flush the owned sink and surface failures.
-
orionis.logging.handlers.queued.BoundedQueueHandler.close
orionis.logging.handlers.queued.BoundedQueueHandler.html#close
Function
Method
PUBLIC
Stop admission, drain queued records, and close the owned sink.
-
orionis.logging.handlers.queued.BoundedQueueHandler._observeFailure
orionis.logging.handlers.queued.BoundedQueueHandler.html#_observeFailure
Function
Method
PUBLIC
Observe a sink failure without replacing the retained shutdown error.
-
orionis.logging.contracts.suffix_resolver.SuffixResolver
orionis.logging.contracts.suffix_resolver.SuffixResolver.html
Class
Class
PUBLIC
Define how rotating log files derive their time-based suffixes.
-
orionis.logging.contracts.suffix_resolver.SuffixResolver.__slots__
orionis.logging.contracts.suffix_resolver.SuffixResolver.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.logging.contracts.suffix_resolver.SuffixResolver.getSuffix
orionis.logging.contracts.suffix_resolver.SuffixResolver.html#getSuffix
Function
Method
PUBLIC
Return the suffix based on the rotation type.
-
orionis.logging.contracts.suffix_resolver.SuffixResolver.getNextRotationTime
orionis.logging.contracts.suffix_resolver.SuffixResolver.html#getNextRotationTime
Function
Method
PUBLIC
Compute the next rotation time.
-
orionis.logging.handlers.advanced_rotating_file_handler._PATH_CACHE_LIMIT
orionis.logging.handlers.advanced_rotating_file_handler.html#_PATH_CACHE_LIMIT
Attribute
Constant
PUBLIC
Threshold for clearing previously resolved suffix paths.
-
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler.html
Class
Class
PUBLIC
Rotate log files using size limits and resolved time suffixes.
-
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler.__init__
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler.html#__init__
Function
Method
PUBLIC
Initialize the advanced rotating file handler.
-
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler.path_template
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler.html#path_template
Attribute
Instance Variable
PUBLIC
Path template containing the {suffix} placeholder.
-
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler.suffix_resolver
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler.html#suffix_resolver
Attribute
Instance Variable
PUBLIC
Resolver for determining the suffix for rotation.
-
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler.max_bytes
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler.html#max_bytes
Attribute
Instance Variable
PUBLIC
Maximum file size in bytes before rotation (for chunked rotation).
-
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler.backup_count
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler.html#backup_count
Attribute
Instance Variable
PUBLIC
Maximum number of backup files to retain.
-
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler.encoding
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler.html#encoding
Attribute
Instance Variable
PUBLIC
File encoding.
-
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler._utf8_encoding
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler.html#_utf8_encoding
Attribute
Instance Variable
PUBLIC
Whether independent UTF-8 encoding gives the exact appended byte count.
-
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler.delay
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler.html#delay
Attribute
Instance Variable
PUBLIC
If True, delay file opening until the first log record.
-
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler.compress_rotated
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler.html#compress_rotated
Attribute
Instance Variable
PUBLIC
If True, compress rotated files using gzip.
-
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler.app_root
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler.html#app_root
Attribute
Instance Variable
PUBLIC
Application root directory.
-
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler.stream
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler.html#stream
Attribute
Instance Variable
PUBLIC
Text stream receiving records for the active log file.
-
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler.current_path
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler.html#current_path
Attribute
Instance Variable
PUBLIC
Filesystem path of the active log file.
-
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler.current_suffix
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler.html#current_suffix
Attribute
Instance Variable
PUBLIC
Suffix identifying the active log-rotation window.
-
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler.file_size
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler.html#file_size
Attribute
Instance Variable
PUBLIC
File size value used by AdvancedRotatingFileHandler.
-
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler._lock
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler.html#_lock
Attribute
Instance Variable
PUBLIC
Ensure thread safety for file operations.
-
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler._path_cache
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler.html#_path_cache
Attribute
Instance Variable
PUBLIC
Store resolved paths for recent suffixes.
-
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler._cache_monotonic_expiry
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler.html#_cache_monotonic_expiry
Attribute
Instance Variable
PUBLIC
Cache monotonic expiry value used by AdvancedRotatingFileHandler.
-
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler._cleanup_pattern
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler.html#_cleanup_pattern
Attribute
Instance Variable
PUBLIC
Compiled pattern used to recognize cleanup pattern.
-
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler._resolvePath
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler.html#_resolvePath
Function
Method
PUBLIC
Resolve the full path by replacing the {suffix} placeholder.
-
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler._shouldRotate
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler.html#_shouldRotate
Function
Method
PUBLIC
Determine whether the log file should be rotated.
-
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler._rotateFile
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler.html#_rotateFile
Function
Method
PUBLIC
Rotate the current log file if needed.
-
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler._compressFile
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler.html#_compressFile
Function
Method
PUBLIC
Compress the specified file using gzip.
-
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler._cleanupOldFiles
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler.html#_cleanupOldFiles
Function
Method
PUBLIC
Remove old log files exceeding the backup count.
-
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler._observeFailure
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler.html#_observeFailure
Function
Method
PUBLIC
Observe a recovered sink error without changing rotation behavior.
-
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler._ensureStream
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler.html#_ensureStream
Function
Method
PUBLIC
Ensure the stream is available and up to date.
-
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler.emit
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler.html#emit
Function
Method
PUBLIC
Emit a log record.
-
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler.close
orionis.logging.handlers.advanced_rotating_file_handler.AdvancedRotatingFileHandler.html#close
Function
Method
PUBLIC
Close the handler and release resources.
-
orionis.logging.handlers.chunked_suffix_resolver.ChunkedSuffixResolver
orionis.logging.handlers.chunked_suffix_resolver.ChunkedSuffixResolver.html
Class
Class
PUBLIC
Resolve log suffixes for configured time chunks.
-
orionis.logging.handlers.chunked_suffix_resolver.ChunkedSuffixResolver.__slots__
orionis.logging.handlers.chunked_suffix_resolver.ChunkedSuffixResolver.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.logging.handlers.chunked_suffix_resolver.ChunkedSuffixResolver.__init__
orionis.logging.handlers.chunked_suffix_resolver.ChunkedSuffixResolver.html#__init__
Function
Method
PUBLIC
Initialize the ChunkedSuffixResolver.
-
orionis.logging.handlers.chunked_suffix_resolver.ChunkedSuffixResolver._counter
orionis.logging.handlers.chunked_suffix_resolver.ChunkedSuffixResolver.html#_counter
Attribute
Instance Variable
PUBLIC
Counter value used by ChunkedSuffixResolver.
-
orionis.logging.handlers.chunked_suffix_resolver.ChunkedSuffixResolver._lock
orionis.logging.handlers.chunked_suffix_resolver.ChunkedSuffixResolver.html#_lock
Attribute
Instance Variable
PUBLIC
Lock protecting concurrent access to shared state.
-
orionis.logging.handlers.chunked_suffix_resolver.ChunkedSuffixResolver.tz
orionis.logging.handlers.chunked_suffix_resolver.ChunkedSuffixResolver.html#tz
Attribute
Instance Variable
PUBLIC
Tz produced by DateTime.getZoneInfo.
-
orionis.logging.handlers.chunked_suffix_resolver.ChunkedSuffixResolver.getSuffix
orionis.logging.handlers.chunked_suffix_resolver.ChunkedSuffixResolver.html#getSuffix
Function
Method
PUBLIC
Generate a unique suffix for the log file.
-
orionis.logging.handlers.chunked_suffix_resolver.ChunkedSuffixResolver.getNextRotationTime
orionis.logging.handlers.chunked_suffix_resolver.ChunkedSuffixResolver.html#getNextRotationTime
Function
Method
PUBLIC
Compute the next rotation time for the log file.
-
orionis.logging.handlers.daily_suffix_resolver.DailySuffixResolver
orionis.logging.handlers.daily_suffix_resolver.DailySuffixResolver.html
Class
Class
PUBLIC
Resolve log suffixes for daily rotation windows.
-
orionis.logging.handlers.daily_suffix_resolver.DailySuffixResolver.__slots__
orionis.logging.handlers.daily_suffix_resolver.DailySuffixResolver.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.logging.handlers.daily_suffix_resolver.DailySuffixResolver.__init__
orionis.logging.handlers.daily_suffix_resolver.DailySuffixResolver.html#__init__
Function
Method
PUBLIC
Initialize the DailySuffixResolver with an optional rotation time.
-
orionis.logging.handlers.daily_suffix_resolver.DailySuffixResolver.at_time
orionis.logging.handlers.daily_suffix_resolver.DailySuffixResolver.html#at_time
Attribute
Instance Variable
PUBLIC
The time of day when log rotation should occur. Defaults to midnight.
-
orionis.logging.handlers.daily_suffix_resolver.DailySuffixResolver.tz
orionis.logging.handlers.daily_suffix_resolver.DailySuffixResolver.html#tz
Attribute
Instance Variable
PUBLIC
Tz produced by DateTime.getZoneInfo.
-
orionis.logging.handlers.daily_suffix_resolver.DailySuffixResolver.getSuffix
orionis.logging.handlers.daily_suffix_resolver.DailySuffixResolver.html#getSuffix
Function
Method
PUBLIC
Generate a date-based suffix for log files.
-
orionis.logging.handlers.daily_suffix_resolver.DailySuffixResolver.getNextRotationTime
orionis.logging.handlers.daily_suffix_resolver.DailySuffixResolver.html#getNextRotationTime
Function
Method
PUBLIC
Calculate the next log rotation datetime.
-
orionis.logging.handlers.hourly_suffix_resolver.HourlySuffixResolver
orionis.logging.handlers.hourly_suffix_resolver.HourlySuffixResolver.html
Class
Class
PUBLIC
Resolve log suffixes for hourly rotation windows.
-
orionis.logging.handlers.hourly_suffix_resolver.HourlySuffixResolver.__slots__
orionis.logging.handlers.hourly_suffix_resolver.HourlySuffixResolver.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.logging.handlers.hourly_suffix_resolver.HourlySuffixResolver.__init__
orionis.logging.handlers.hourly_suffix_resolver.HourlySuffixResolver.html#__init__
Function
Method
PUBLIC
Initialize the HourlySuffixResolver.
-
orionis.logging.handlers.hourly_suffix_resolver.HourlySuffixResolver.tz
orionis.logging.handlers.hourly_suffix_resolver.HourlySuffixResolver.html#tz
Attribute
Instance Variable
PUBLIC
Tz produced by DateTime.getZoneInfo.
-
orionis.logging.handlers.hourly_suffix_resolver.HourlySuffixResolver.getSuffix
orionis.logging.handlers.hourly_suffix_resolver.HourlySuffixResolver.html#getSuffix
Function
Method
PUBLIC
Generate a suffix string for the given datetime in hourly format.
-
orionis.logging.handlers.hourly_suffix_resolver.HourlySuffixResolver.getNextRotationTime
orionis.logging.handlers.hourly_suffix_resolver.HourlySuffixResolver.html#getNextRotationTime
Function
Method
PUBLIC
Calculate the next rotation time rounded to the next hour.
-
orionis.logging.handlers.monthly_suffix_resolver._DECEMBER
orionis.logging.handlers.monthly_suffix_resolver.html#_DECEMBER
Attribute
Constant
PUBLIC
Identify the final month before the calendar year advances.
-
orionis.logging.handlers.monthly_suffix_resolver.MonthlySuffixResolver
orionis.logging.handlers.monthly_suffix_resolver.MonthlySuffixResolver.html
Class
Class
PUBLIC
Resolve log suffixes for monthly rotation windows.
-
orionis.logging.handlers.monthly_suffix_resolver.MonthlySuffixResolver.__slots__
orionis.logging.handlers.monthly_suffix_resolver.MonthlySuffixResolver.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.logging.handlers.monthly_suffix_resolver.MonthlySuffixResolver.__init__
orionis.logging.handlers.monthly_suffix_resolver.MonthlySuffixResolver.html#__init__
Function
Method
PUBLIC
Initialize the resolver with an optional rotation time.
-
orionis.logging.handlers.monthly_suffix_resolver.MonthlySuffixResolver.at_time
orionis.logging.handlers.monthly_suffix_resolver.MonthlySuffixResolver.html#at_time
Attribute
Instance Variable
PUBLIC
The time of day when rotation should occur. Defaults to midnight.
-
orionis.logging.handlers.monthly_suffix_resolver.MonthlySuffixResolver.tz
orionis.logging.handlers.monthly_suffix_resolver.MonthlySuffixResolver.html#tz
Attribute
Instance Variable
PUBLIC
Tz produced by DateTime.getZoneInfo.
-
orionis.logging.handlers.monthly_suffix_resolver.MonthlySuffixResolver.getSuffix
orionis.logging.handlers.monthly_suffix_resolver.MonthlySuffixResolver.html#getSuffix
Function
Method
PUBLIC
Return the suffix string for the given datetime.
-
orionis.logging.handlers.monthly_suffix_resolver.MonthlySuffixResolver.getNextRotationTime
orionis.logging.handlers.monthly_suffix_resolver.MonthlySuffixResolver.html#getNextRotationTime
Function
Method
PUBLIC
Compute the next rotation datetime after the current time.
-
orionis.logging.handlers.weekly_suffix_resolver.WeeklySuffixResolver
orionis.logging.handlers.weekly_suffix_resolver.WeeklySuffixResolver.html
Class
Class
PUBLIC
Resolve log suffixes for weekly rotation windows.
-
orionis.logging.handlers.weekly_suffix_resolver.WeeklySuffixResolver.__slots__
orionis.logging.handlers.weekly_suffix_resolver.WeeklySuffixResolver.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.logging.handlers.weekly_suffix_resolver.WeeklySuffixResolver.__init__
orionis.logging.handlers.weekly_suffix_resolver.WeeklySuffixResolver.html#__init__
Function
Method
PUBLIC
Initialize WeeklySuffixResolver.
-
orionis.logging.handlers.weekly_suffix_resolver.WeeklySuffixResolver.at_time
orionis.logging.handlers.weekly_suffix_resolver.WeeklySuffixResolver.html#at_time
Attribute
Instance Variable
PUBLIC
The time of day when rotation should occur. Defaults to midnight.
-
orionis.logging.handlers.weekly_suffix_resolver.WeeklySuffixResolver.tz
orionis.logging.handlers.weekly_suffix_resolver.WeeklySuffixResolver.html#tz
Attribute
Instance Variable
PUBLIC
Tz produced by DateTime.getZoneInfo.
-
orionis.logging.handlers.weekly_suffix_resolver.WeeklySuffixResolver.getSuffix
orionis.logging.handlers.weekly_suffix_resolver.WeeklySuffixResolver.html#getSuffix
Function
Method
PUBLIC
Generate a weekly suffix based on the provided datetime.
-
orionis.logging.handlers.weekly_suffix_resolver.WeeklySuffixResolver.getNextRotationTime
orionis.logging.handlers.weekly_suffix_resolver.WeeklySuffixResolver.html#getNextRotationTime
Function
Method
PUBLIC
Calculate the next rotation datetime based on the current time.
-
orionis.logging.handlers.rotating_handler_factory._create_stack
orionis.logging.handlers.rotating_handler_factory.html#_create_stack
Function
Function
PUBLIC
Create a non-rotating file handler for the stack channel.
-
orionis.logging.handlers.rotating_handler_factory._create_hourly
orionis.logging.handlers.rotating_handler_factory.html#_create_hourly
Function
Function
PUBLIC
Create an hourly rotating file handler.
-
orionis.logging.handlers.rotating_handler_factory._create_daily
orionis.logging.handlers.rotating_handler_factory.html#_create_daily
Function
Function
PUBLIC
Create a daily rotating file handler.
-
orionis.logging.handlers.rotating_handler_factory._create_weekly
orionis.logging.handlers.rotating_handler_factory.html#_create_weekly
Function
Function
PUBLIC
Create a weekly rotating file handler.
-
orionis.logging.handlers.rotating_handler_factory._create_monthly
orionis.logging.handlers.rotating_handler_factory.html#_create_monthly
Function
Function
PUBLIC
Create a monthly rotating file handler.
-
orionis.logging.handlers.rotating_handler_factory._create_chunked
orionis.logging.handlers.rotating_handler_factory.html#_create_chunked
Function
Function
PUBLIC
Create a size-based rotating file handler.
-
orionis.logging.handlers.rotating_handler_factory._CHANNEL_CREATORS
orionis.logging.handlers.rotating_handler_factory.html#_CHANNEL_CREATORS
Attribute
Constant
PUBLIC
Mapping of channel types to their respective handler creation functions.
-
orionis.logging.handlers.rotating_handler_factory.RotatingHandlerFactory
orionis.logging.handlers.rotating_handler_factory.RotatingHandlerFactory.html
Class
Class
PUBLIC
Construct rotating log handlers from channel configuration.
-
orionis.logging.handlers.rotating_handler_factory.RotatingHandlerFactory.createHandler
orionis.logging.handlers.rotating_handler_factory.RotatingHandlerFactory.html#createHandler
Function
Static Method
PUBLIC
Create and return a log handler based on the channel configuration.
-
orionis.logging.Logger
orionis.logging.Logger.html
Class
Class
PUBLIC
Resolve logging channels and dispatch structured log records.
-
orionis.logging.Logger.name
orionis.logging.Logger.html#name
Attribute
Class Variable
PUBLIC
Return the name of the logger service.
-
orionis.logging.Logger._formatter_cache
orionis.logging.Logger.html#_formatter_cache
Attribute
Class Variable
PUBLIC
Share formatters configured with the same message and date formats.
-
orionis.logging.Logger.__init__
orionis.logging.Logger.html#__init__
Function
Method
PUBLIC
Retain logging configuration for lazy handler initialization.
-
orionis.logging.Logger.__app
orionis.logging.Logger.html#__app
Attribute
Instance Variable
PUBLIC
Application instance providing configuration.
-
orionis.logging.Logger.__config
orionis.logging.Logger.html#__config
Attribute
Instance Variable
PUBLIC
Validated configuration used to construct and operate the service.
-
orionis.logging.Logger.__logger
orionis.logging.Logger.html#__logger
Attribute
Instance Variable
PUBLIC
Logging implementation used to emit records.
-
orionis.logging.Logger.__handlers_cache
orionis.logging.Logger.html#__handlers_cache
Attribute
Instance Variable
PUBLIC
Previously constructed logging handlers indexed by channel.
-
orionis.logging.Logger.__init_lock
orionis.logging.Logger.html#__init_lock
Attribute
Instance Variable
PUBLIC
Synchronization primitive controlling access to init lock.
-
orionis.logging.Logger.__log_format
orionis.logging.Logger.html#__log_format
Attribute
Instance Variable
PUBLIC
Store the default formatter and logger settings.
-
orionis.logging.Logger.__date_format
orionis.logging.Logger.html#__date_format
Attribute
Instance Variable
PUBLIC
%Y-%m-%d %H:%M:%S.
-
orionis.logging.Logger.__logger_name
orionis.logging.Logger.html#__logger_name
Attribute
Instance Variable
PUBLIC
__orionis__.
-
orionis.logging.Logger.__default_level
orionis.logging.Logger.html#__default_level
Attribute
Instance Variable
PUBLIC
Default level obtained from logging.DEBUG.
-
orionis.logging.Logger.__initializeLogger
orionis.logging.Logger.html#__initializeLogger
Function
Method
PUBLIC
Build the standard library logger for the default channel.
-
orionis.logging.Logger.__discardUnpublishedHandler
orionis.logging.Logger.html#__discardUnpublishedHandler
Function
Method
PUBLIC
Close an unpublished sink without replacing the configuration failure.
-
orionis.logging.Logger.__closeConfigurationHandlers
orionis.logging.Logger.html#__closeConfigurationHandlers
Function
Method
PUBLIC
Detach and close previous sinks while holding the lifecycle lock.
-
orionis.logging.Logger.__queueHandler
orionis.logging.Logger.html#__queueHandler
Function
Method
PUBLIC
Enable bounded asynchronous emission only when explicitly configured.
-
orionis.logging.Logger.__createFormatter
orionis.logging.Logger.html#__createFormatter
Function
Method
PUBLIC
Return the formatter shared by matching message and date formats.
-
orionis.logging.Logger.__createChannelHandler
orionis.logging.Logger.html#__createChannelHandler
Function
Method
PUBLIC
Create a handler for a specific channel.
-
orionis.logging.Logger.__normalizeChannelConfig
orionis.logging.Logger.html#__normalizeChannelConfig
Function
Method
PUBLIC
Normalize the channel configuration for logging.
-
orionis.logging.Logger.__ensureLoggerReady
orionis.logging.Logger.html#__ensureLoggerReady
Function
Method
PUBLIC
Return the initialized logger while retaining a stable reference.
-
orionis.logging.Logger.info
orionis.logging.Logger.html#info
Function
Method
PUBLIC
Log an informational message.
-
orionis.logging.Logger.error
orionis.logging.Logger.html#error
Function
Method
PUBLIC
Log an error message.
-
orionis.logging.Logger.warning
orionis.logging.Logger.html#warning
Function
Method
PUBLIC
Log a warning message.
-
orionis.logging.Logger.debug
orionis.logging.Logger.html#debug
Function
Method
PUBLIC
Log a debug message.
-
orionis.logging.Logger.critical
orionis.logging.Logger.html#critical
Function
Method
PUBLIC
Log a critical message.
-
orionis.logging.Logger.getLogger
orionis.logging.Logger.html#getLogger
Function
Method
PUBLIC
Return the internal logger instance for advanced usage.
-
orionis.logging.Logger.reloadConfiguration
orionis.logging.Logger.html#reloadConfiguration
Function
Method
PUBLIC
Reload the logger configuration from the application.
-
orionis.logging.Logger.switchChannel
orionis.logging.Logger.html#switchChannel
Function
Method
PUBLIC
Switch to a different logging channel.
-
orionis.logging.Logger.__discardChannelHandler
orionis.logging.Logger.html#__discardChannelHandler
Function
Method
PUBLIC
Remove an unpublished channel sink without disturbing another switch.
-
orionis.logging.Logger.close
orionis.logging.Logger.html#close
Function
Method
PUBLIC
Close all handlers and release logger resources.
-
orionis.logging.Logger.aclose
orionis.logging.Logger.html#aclose
Function
Method
PUBLIC
Drain queued records and close handlers without blocking the event loop.
-
orionis.logging.Logger.getActiveChannels
orionis.logging.Logger.html#getActiveChannels
Function
Method
PUBLIC
Return the names of active logging channels.
-
orionis.logging.Logger.getActiveChannel
orionis.logging.Logger.html#getActiveChannel
Function
Method
PUBLIC
Return the name of the currently active logging channel.
-
orionis.logging.Logger.getAvailableChannels
orionis.logging.Logger.html#getAvailableChannels
Function
Method
PUBLIC
Return all available logging channels from configuration.
-
orionis.logging.Logger.__del__
orionis.logging.Logger.html#__del__
Function
Method
PUBLIC
Release resources when the logger is destroyed.
-
orionis.logging._EXPORTS
orionis.logging.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.logging.__getattr__
orionis.logging.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.logging.__dir__
orionis.logging.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.logging.contracts.ILogger
orionis.logging.contracts.ILogger.html
Class
Class
PUBLIC
Define the contract for logger implementations.
-
orionis.logging.contracts.ILogger.aclose
orionis.logging.contracts.ILogger.html#aclose
Function
Method
PUBLIC
Drain and close the logger without blocking the application event loop.
-
orionis.logging.contracts.ILogger.name
orionis.logging.contracts.ILogger.html#name
Attribute
Property
PUBLIC
Return the name of the logger service.
-
orionis.logging.contracts.ILogger.info
orionis.logging.contracts.ILogger.html#info
Function
Method
PUBLIC
Log an informational message.
-
orionis.logging.contracts.ILogger.error
orionis.logging.contracts.ILogger.html#error
Function
Method
PUBLIC
Log an error message.
-
orionis.logging.contracts.ILogger.warning
orionis.logging.contracts.ILogger.html#warning
Function
Method
PUBLIC
Log a warning message.
-
orionis.logging.contracts.ILogger.debug
orionis.logging.contracts.ILogger.html#debug
Function
Method
PUBLIC
Log a debug message.
-
orionis.logging.contracts.ILogger.critical
orionis.logging.contracts.ILogger.html#critical
Function
Method
PUBLIC
Log a critical message.
-
orionis.logging.contracts.ILogger.getLogger
orionis.logging.contracts.ILogger.html#getLogger
Function
Method
PUBLIC
Return the internal logger instance for advanced usage.
-
orionis.logging.contracts.ILogger.reloadConfiguration
orionis.logging.contracts.ILogger.html#reloadConfiguration
Function
Method
PUBLIC
Reload the logger configuration from the application.
-
orionis.logging.contracts.ILogger.switchChannel
orionis.logging.contracts.ILogger.html#switchChannel
Function
Method
PUBLIC
Switch to a different logging channel.
-
orionis.logging.contracts.ILogger.close
orionis.logging.contracts.ILogger.html#close
Function
Method
PUBLIC
Close all handlers and release logger resources.
-
orionis.logging.contracts.ILogger.getActiveChannels
orionis.logging.contracts.ILogger.html#getActiveChannels
Function
Method
PUBLIC
Return the names of active logging channels.
-
orionis.logging.contracts.ILogger.getActiveChannel
orionis.logging.contracts.ILogger.html#getActiveChannel
Function
Method
PUBLIC
Return the name of the currently active logging channel.
-
orionis.logging.contracts.ILogger.getAvailableChannels
orionis.logging.contracts.ILogger.html#getAvailableChannels
Function
Method
PUBLIC
Return all available logging channels from configuration.
-
orionis.logging.provider.LoggerProvider
orionis.logging.provider.LoggerProvider.html
Class
Class
PUBLIC
Register logger services in the application container.
-
orionis.logging.provider.LoggerProvider.register
orionis.logging.provider.LoggerProvider.html#register
Function
Method
PUBLIC
Register the Logger service implementation in the application container.
-
orionis.logging.provider.LoggerProvider.boot
orionis.logging.provider.LoggerProvider.html#boot
Function
Method
PUBLIC
Resolve the logger service and pin its application facade.
-
orionis.mail.Mailable
orionis.mail.Mailable.html
Class
Class
PUBLIC
Declare reusable mail without I/O or per-send mutation.
-
orionis.mail.Mailable.__slots__
orionis.mail.Mailable.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.mail.Mailable.envelope
orionis.mail.Mailable.html#envelope
Function
Method
PUBLIC
Declare headers and recipients synchronously.
-
orionis.mail.Mailable.content
orionis.mail.Mailable.html#content
Function
Method
PUBLIC
Declare literal bodies or views synchronously.
-
orionis.mail.Mailable.attachments
orionis.mail.Mailable.html#attachments
Function
Method
PUBLIC
Declare deferred storage attachments synchronously.
-
orionis.mail.Message
orionis.mail.Message.html
Class
Class
PUBLIC
Configure one direct send without exposing a mutable MIME message.
-
orionis.mail.Message.__slots__
orionis.mail.Message.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.mail.Message.__init__
orionis.mail.Message.html#__init__
Function
Method
PUBLIC
Initialize an operation-local mutable configurator.
-
orionis.mail.Message._options
orionis.mail.Message.html#_options
Attribute
Instance Variable
PUBLIC
Initial immutable snapshot supplied by PendingMail.
-
orionis.mail.Message.fromAddress
orionis.mail.Message.html#fromAddress
Function
Method
PUBLIC
Replace the From header and the transport sender.
-
orionis.mail.Message.to
orionis.mail.Message.html#to
Function
Method
PUBLIC
Append primary visible recipients.
-
orionis.mail.Message.cc
orionis.mail.Message.html#cc
Function
Method
PUBLIC
Append carbon-copy recipients.
-
orionis.mail.Message.bcc
orionis.mail.Message.html#bcc
Function
Method
PUBLIC
Append hidden transport recipients.
-
orionis.mail.Message.replyTo
orionis.mail.Message.html#replyTo
Function
Method
PUBLIC
Append Reply-To mailboxes without adding transport recipients.
-
orionis.mail.Message.subject
orionis.mail.Message.html#subject
Function
Method
PUBLIC
Replace the literal subject, including with an empty string.
-
orionis.mail.Message.attach
orionis.mail.Message.html#attach
Function
Method
PUBLIC
Append a deferred storage attachment.
-
orionis.mail.Message._appendRecipients
orionis.mail.Message.html#_appendRecipients
Function
Method
PUBLIC
Append normalized recipients to one internal address field.
-
orionis.mail.Message._snapshot
orionis.mail.Message.html#_snapshot
Function
Method
PUBLIC
Return the immutable current declaration for preparation.
-
orionis.mail.PendingMail
orionis.mail.PendingMail.html
Class
Class
PUBLIC
Build independent chains; every fluent call returns a new operation.
-
orionis.mail.PendingMail.__slots__
orionis.mail.PendingMail.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.mail.PendingMail.__init__
orionis.mail.PendingMail.html#__init__
Function
Method
PUBLIC
Bind an immutable declaration to the manager's delivery pipeline.
-
orionis.mail.PendingMail._delivery
orionis.mail.PendingMail.html#_delivery
Attribute
Instance Variable
PUBLIC
Shared preparation and transport entry point.
-
orionis.mail.PendingMail._mailable_builder
orionis.mail.PendingMail.html#_mailable_builder
Attribute
Instance Variable
PUBLIC
Optional application-container resolver for Mailable classes.
-
orionis.mail.PendingMail._options
orionis.mail.PendingMail.html#_options
Attribute
Instance Variable
PUBLIC
Immutable explicit options for this chain.
-
orionis.mail.PendingMail.mailer
orionis.mail.PendingMail.html#mailer
Function
Method
PUBLIC
Select a mailer on an independent derived chain.
-
orionis.mail.PendingMail.fromAddress
orionis.mail.PendingMail.html#fromAddress
Function
Method
PUBLIC
Replace the sender on a new independent chain.
-
orionis.mail.PendingMail.to
orionis.mail.PendingMail.html#to
Function
Method
PUBLIC
Append visible recipients on an independent chain.
-
orionis.mail.PendingMail.cc
orionis.mail.PendingMail.html#cc
Function
Method
PUBLIC
Append carbon-copy recipients on an independent chain.
-
orionis.mail.PendingMail.bcc
orionis.mail.PendingMail.html#bcc
Function
Method
PUBLIC
Append hidden recipients on an independent chain.
-
orionis.mail.PendingMail.replyTo
orionis.mail.PendingMail.html#replyTo
Function
Method
PUBLIC
Append Reply-To mailboxes on an independent chain.
-
orionis.mail.PendingMail.subject
orionis.mail.PendingMail.html#subject
Function
Method
PUBLIC
Replace the subject on an independent chain.
-
orionis.mail.PendingMail.attach
orionis.mail.PendingMail.html#attach
Function
Method
PUBLIC
Append a deferred storage attachment on an independent chain.
-
orionis.mail.PendingMail.send
orionis.mail.PendingMail.html#send
Function
Method
PUBLIC
Send a reusable Mailable, an HTML view, or explicit Content.
-
orionis.mail.PendingMail.raw
orionis.mail.PendingMail.html#raw
Function
Method
PUBLIC
Send literal plain text through the shared preparation pipeline.
-
orionis.mail.PendingMail.html
orionis.mail.PendingMail.html#html
Function
Method
PUBLIC
Send literal HTML through the shared preparation pipeline.
-
orionis.mail.PendingMail._derive
orionis.mail.PendingMail.html#_derive
Function
Method
PUBLIC
Detach a configurator's current snapshot into a new chain.
-
orionis.mail.PendingMail._sendDirect
orionis.mail.PendingMail.html#_sendDirect
Function
Method
PUBLIC
Invoke one callback, freeze its declaration, and deliver.
-
orionis.mail.PendingMail._sendMailable
orionis.mail.PendingMail.html#_sendMailable
Function
Method
PUBLIC
Merge reusable declarations with explicit fluent options.
-
orionis.mail._EXPORTS
orionis.mail.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.mail.__getattr__
orionis.mail.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.mail.__dir__
orionis.mail.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.mail.composer.LoadedAttachment
orionis.mail.composer.html#LoadedAttachment
Attribute
Type Alias
PUBLIC
Attachment declaration paired with its payload and storage MIME metadata.
-
orionis.mail.composer._DEFAULT_MEDIA_TYPE
orionis.mail.composer.html#_DEFAULT_MEDIA_TYPE
Attribute
Constant
PUBLIC
application/octet-stream.
-
orionis.mail.composer.MailComposer
orionis.mail.composer.MailComposer.html
Class
Class
PUBLIC
Prepare all bodies and attachments before any transport side effect.
-
orionis.mail.composer.MailComposer.__slots__
orionis.mail.composer.MailComposer.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.mail.composer.MailComposer.__init__
orionis.mail.composer.MailComposer.html#__init__
Function
Method
PUBLIC
Inject the configured framework engines without using facades.
-
orionis.mail.composer.MailComposer._view
orionis.mail.composer.MailComposer.html#_view
Attribute
Instance Variable
PUBLIC
Existing text-rendering view engine.
-
orionis.mail.composer.MailComposer._storage
orionis.mail.composer.MailComposer.html#_storage
Attribute
Instance Variable
PUBLIC
Existing default/named disk resolver.
-
orionis.mail.composer.MailComposer.prepare
orionis.mail.composer.MailComposer.html#prepare
Function
Method
PUBLIC
Validate, render, load attachments, and compose one immutable message.
-
orionis.mail.composer.MailComposer._render
orionis.mail.composer.MailComposer.html#_render
Function
Method
PUBLIC
Render a view to text without constructing an HTTP response.
-
orionis.mail.composer.MailComposer._resolveAttachment
orionis.mail.composer.MailComposer.html#_resolveAttachment
Function
Method
PUBLIC
Own an attachment task until its stream is closed, even on cancellation.
-
orionis.mail.composer.MailComposer._readAttachment
orionis.mail.composer.MailComposer.html#_readAttachment
Function
Method
PUBLIC
Read one backend-independent binary stream and close it reliably.
-
orionis.mail.composer.MailComposer._compose
orionis.mail.composer.MailComposer.html#_compose
Function
Static Method
PUBLIC
Build and serialize MIME on a worker using the standard email library.
-
orionis.mail.contracts.IMailManager
orionis.mail.contracts.IMailManager.html
Class
Class
PUBLIC
Expose independent composition and centrally configured mail delivery.
-
orionis.mail.contracts.IMailManager.__slots__
orionis.mail.contracts.IMailManager.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.mail.contracts.IMailManager.mailer
orionis.mail.contracts.IMailManager.html#mailer
Function
Method
PUBLIC
Start an independent chain selecting a named mailer.
-
orionis.mail.contracts.IMailManager.fromAddress
orionis.mail.contracts.IMailManager.html#fromAddress
Function
Method
PUBLIC
Start an independent chain with exactly one sender.
-
orionis.mail.contracts.IMailManager.to
orionis.mail.contracts.IMailManager.html#to
Function
Method
PUBLIC
Start an independent chain with primary recipients.
-
orionis.mail.contracts.IMailManager.cc
orionis.mail.contracts.IMailManager.html#cc
Function
Method
PUBLIC
Start an independent chain with carbon-copy recipients.
-
orionis.mail.contracts.IMailManager.bcc
orionis.mail.contracts.IMailManager.html#bcc
Function
Method
PUBLIC
Start an independent chain with hidden recipients.
-
orionis.mail.contracts.IMailManager.replyTo
orionis.mail.contracts.IMailManager.html#replyTo
Function
Method
PUBLIC
Start an independent chain with reply destinations.
-
orionis.mail.contracts.IMailManager.subject
orionis.mail.contracts.IMailManager.html#subject
Function
Method
PUBLIC
Start an independent chain with a literal subject.
-
orionis.mail.contracts.IMailManager.attach
orionis.mail.contracts.IMailManager.html#attach
Function
Method
PUBLIC
Start an independent chain with a deferred attachment.
-
orionis.mail.contracts.IMailManager.send
orionis.mail.contracts.IMailManager.html#send
Function
Method
PUBLIC
Send a Mailable, an HTML view, or Content through one pipeline.
-
orionis.mail.contracts.IMailManager.raw
orionis.mail.contracts.IMailManager.html#raw
Function
Method
PUBLIC
Send literal plain text without template interpretation.
-
orionis.mail.contracts.IMailManager.html
orionis.mail.contracts.IMailManager.html#html
Function
Method
PUBLIC
Send literal HTML without template interpretation.
-
orionis.mail.contracts.IMailManager.extend
orionis.mail.contracts.IMailManager.html#extend
Function
Method
PUBLIC
Register one sync or async factory for a new driver.
-
orionis.mail.contracts.IMailTransport
orionis.mail.contracts.IMailTransport.html
Class
Class
PUBLIC
Send already prepared mail without knowing views or storage declarations.
-
orionis.mail.contracts.IMailTransport.__slots__
orionis.mail.contracts.IMailTransport.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.mail.contracts.IMailTransport.send
orionis.mail.contracts.IMailTransport.html#send
Function
Method
PUBLIC
Transmit or store one complete message.
-
orionis.mail.contracts._EXPORTS
orionis.mail.contracts.html#_EXPORTS
Attribute
Constant
PUBLIC
Public contract names mapped to their defining modules and attributes.
-
orionis.mail.contracts.__getattr__
orionis.mail.contracts.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public contract without importing unrelated services.
-
orionis.mail.contracts.__dir__
orionis.mail.contracts.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public contracts.
-
orionis.mail.entities.Address
orionis.mail.entities.Address.html
Class
Class
PUBLIC
Represent one mailbox with an optional Unicode display name.
-
orionis.mail.entities.Address.address
orionis.mail.entities.Address.html#address
Attribute
Instance Variable
PUBLIC
Single addr-spec, never a comma-separated list or a display-name form.
-
orionis.mail.entities.Address.name
orionis.mail.entities.Address.html#name
Attribute
Instance Variable
PUBLIC
Optional visible name.
-
orionis.mail.entities.Address.__post_init__
orionis.mail.entities.Address.html#__post_init__
Function
Method
PUBLIC
Parse a mailbox using the standard email header parser.
-
orionis.mail.entities.Attachment
orionis.mail.entities.Attachment.html
Class
Class
PUBLIC
Describe a storage attachment without opening it or resolving a disk.
-
orionis.mail.entities.Attachment.path
orionis.mail.entities.Attachment.html#path
Attribute
Instance Variable
PUBLIC
Logical disk-relative path, normalized on declaration.
-
orionis.mail.entities.Attachment.disk
orionis.mail.entities.Attachment.html#disk
Attribute
Instance Variable
PUBLIC
Configured disk name, or None for the default disk.
-
orionis.mail.entities.Attachment.name
orionis.mail.entities.Attachment.html#name
Attribute
Instance Variable
PUBLIC
Visible basename overriding the logical path's basename.
-
orionis.mail.entities.Attachment.mime_type
orionis.mail.entities.Attachment.html#mime_type
Attribute
Instance Variable
PUBLIC
Explicit MIME type overriding storage metadata and inference.
-
orionis.mail.entities.Attachment.__post_init__
orionis.mail.entities.Attachment.html#__post_init__
Function
Method
PUBLIC
Validate logical paths and safe optional metadata without I/O.
-
orionis.mail.entities.Attachment.fromStorage
orionis.mail.entities.Attachment.html#fromStorage
Function
Class Method
PUBLIC
Declare a file to resolve through Orionis storage when sending.
-
orionis.mail.entities.Content
orionis.mail.entities.Content.html
Class
Class
PUBLIC
Declare literal bodies or views with one explicit isolated context.
-
orionis.mail.entities.Content.view
orionis.mail.entities.Content.html#view
Attribute
Instance Variable
PUBLIC
HTML template identifier, mutually exclusive with html.
-
orionis.mail.entities.Content.html
orionis.mail.entities.Content.html#html
Attribute
Instance Variable
PUBLIC
Literal HTML, never interpreted as a template.
-
orionis.mail.entities.Content.text
orionis.mail.entities.Content.html#text
Attribute
Instance Variable
PUBLIC
Literal plain text, mutually exclusive with text_view.
-
orionis.mail.entities.Content.text_view
orionis.mail.entities.Content.html#text_view
Attribute
Instance Variable
PUBLIC
Plain-text template identifier.
-
orionis.mail.entities.Content.data
orionis.mail.entities.Content.html#data
Attribute
Instance Variable
PUBLIC
Context shared by both views, with copied read-only containers.
-
orionis.mail.entities.Content.__post_init__
orionis.mail.entities.Content.html#__post_init__
Function
Method
PUBLIC
Validate body declarations and snapshot their context.
-
orionis.mail.entities.Envelope
orionis.mail.entities.Envelope.html
Class
Class
PUBLIC
Store normalized immutable headers and intended recipients.
-
orionis.mail.entities.Envelope.subject
orionis.mail.entities.Envelope.html#subject
Attribute
Class Variable
PUBLIC
Literal subject, including an empty subject.
-
orionis.mail.entities.Envelope.from_address
orionis.mail.entities.Envelope.html#from_address
Attribute
Class Variable
PUBLIC
From header and transport sender.
-
orionis.mail.entities.Envelope.to
orionis.mail.entities.Envelope.html#to
Attribute
Class Variable
PUBLIC
Primary visible recipients.
-
orionis.mail.entities.Envelope.cc
orionis.mail.entities.Envelope.html#cc
Attribute
Class Variable
PUBLIC
Additional visible recipients.
-
orionis.mail.entities.Envelope.bcc
orionis.mail.entities.Envelope.html#bcc
Attribute
Class Variable
PUBLIC
Hidden transport recipients.
-
orionis.mail.entities.Envelope.reply_to
orionis.mail.entities.Envelope.html#reply_to
Attribute
Class Variable
PUBLIC
Reply destinations, not transport recipients.
-
orionis.mail.entities.Envelope.__init__
orionis.mail.entities.Envelope.html#__init__
Function
Method
PUBLIC
Normalize a declarative envelope without performing I/O.
-
orionis.mail.entities.Envelope.recipients
orionis.mail.entities.Envelope.html#recipients
Function
Method
PUBLIC
Return the stable deduplicated transport recipient union.
-
orionis.mail.entities.MailOptions
orionis.mail.entities.MailOptions.html
Class
Class
PUBLIC
Snapshot the explicitly supplied options of one independent chain.
-
orionis.mail.entities.MailOptions.mailer
orionis.mail.entities.MailOptions.html#mailer
Attribute
Instance Variable
PUBLIC
Selected configuration name, or None for the central default.
-
orionis.mail.entities.MailOptions.from_address
orionis.mail.entities.MailOptions.html#from_address
Attribute
Instance Variable
PUBLIC
Explicit sender replacing any declared one.
-
orionis.mail.entities.MailOptions.subject
orionis.mail.entities.MailOptions.html#subject
Attribute
Instance Variable
PUBLIC
Explicit subject replacing any declared one.
-
orionis.mail.entities.MailOptions.to
orionis.mail.entities.MailOptions.html#to
Attribute
Instance Variable
PUBLIC
Visible recipients appended to a declaration.
-
orionis.mail.entities.MailOptions.cc
orionis.mail.entities.MailOptions.html#cc
Attribute
Instance Variable
PUBLIC
Carbon-copy recipients appended to a declaration.
-
orionis.mail.entities.MailOptions.bcc
orionis.mail.entities.MailOptions.html#bcc
Attribute
Instance Variable
PUBLIC
Hidden recipients appended to a declaration.
-
orionis.mail.entities.MailOptions.reply_to
orionis.mail.entities.MailOptions.html#reply_to
Attribute
Instance Variable
PUBLIC
Reply destinations appended to a declaration.
-
orionis.mail.entities.MailOptions.attachments
orionis.mail.entities.MailOptions.html#attachments
Attribute
Instance Variable
PUBLIC
Deferred attachments appended to a declaration.
-
orionis.mail.entities.MailOptions.envelope
orionis.mail.entities.MailOptions.html#envelope
Function
Method
PUBLIC
Overlay explicit scalars and append recipients to a declaration.
-
orionis.mail.entities.PreparedMail
orionis.mail.entities.PreparedMail.html
Class
Class
PUBLIC
Carry immutable MIME bytes and a separate validated transport envelope.
-
orionis.mail.entities.PreparedMail.message_id
orionis.mail.entities.PreparedMail.html#message_id
Attribute
Instance Variable
PUBLIC
Message-ID generated once for the operation.
-
orionis.mail.entities.PreparedMail.sender
orionis.mail.entities.PreparedMail.html#sender
Attribute
Instance Variable
PUBLIC
Envelope sender used by the transport.
-
orionis.mail.entities.PreparedMail.recipients
orionis.mail.entities.PreparedMail.html#recipients
Attribute
Instance Variable
PUBLIC
Deduplicated union of To, Cc, and Bcc addresses.
-
orionis.mail.entities.PreparedMail.mime
orionis.mail.entities.PreparedMail.html#mime
Attribute
Instance Variable
PUBLIC
Serialized message without any Bcc header.
-
orionis.mail.entities.PreparedMail.smtp_utf8
orionis.mail.entities.PreparedMail.html#smtp_utf8
Attribute
Instance Variable
PUBLIC
Whether an envelope mailbox or a visible addr-spec needs SMTPUTF8.
-
orionis.mail.entities.MailResult
orionis.mail.entities.MailResult.html
Class
Class
PUBLIC
Report SMTP acceptance or file storage, never final mailbox delivery.
-
orionis.mail.entities.MailResult.message_id
orionis.mail.entities.MailResult.html#message_id
Attribute
Instance Variable
PUBLIC
Message-ID of the transmitted or stored message.
-
orionis.mail.entities.MailResult.mailer
orionis.mail.entities.MailResult.html#mailer
Attribute
Instance Variable
PUBLIC
Selected configuration name.
-
orionis.mail.entities.MailResult.driver
orionis.mail.entities.MailResult.html#driver
Attribute
Instance Variable
PUBLIC
Registered transport implementation name.
-
orionis.mail.entities.MailResult.status
orionis.mail.entities.MailResult.html#status
Attribute
Instance Variable
PUBLIC
Confirmed outcome of the operation.
-
orionis.mail.entities.MailResult.recipients
orionis.mail.entities.MailResult.html#recipients
Attribute
Instance Variable
PUBLIC
Intended transport recipients.
-
orionis.mail.entities.MailResult.accepted_recipients
orionis.mail.entities.MailResult.html#accepted_recipients
Attribute
Instance Variable
PUBLIC
Recipients confirmed by an SMTP transaction.
-
orionis.mail.entities.MailResult.rejected_recipients
orionis.mail.entities.MailResult.html#rejected_recipients
Attribute
Instance Variable
PUBLIC
Rejected recipients mapped to their SMTP code and sanitized reason.
-
orionis.mail.entities.MailResult.file_path
orionis.mail.entities.MailResult.html#file_path
Attribute
Instance Variable
PUBLIC
Published file for stored messages, or None for SMTP.
-
orionis.mail.entities.MailResult.__post_init__
orionis.mail.entities.MailResult.html#__post_init__
Function
Method
PUBLIC
Detach recipient collections and sanitize SMTP rejection reasons.
-
orionis.mail.entities.smtp_settings._MAX_PORT
orionis.mail.entities.smtp_settings.html#_MAX_PORT
Attribute
Constant
PUBLIC
Max port value used by smtp_settings.
-
orionis.mail.entities.smtp_settings._DEFAULT_PORT
orionis.mail.entities.smtp_settings.html#_DEFAULT_PORT
Attribute
Constant
PUBLIC
Default port value used by smtp_settings.
-
orionis.mail.entities.smtp_settings._SMTPS_PORT
orionis.mail.entities.smtp_settings.html#_SMTPS_PORT
Attribute
Constant
PUBLIC
Smtps port value used by smtp_settings.
-
orionis.mail.entities.smtp_settings._ENCRYPTIONS
orionis.mail.entities.smtp_settings.html#_ENCRYPTIONS
Attribute
Constant
PUBLIC
Accepted encryption names, including the empty string that a configuration uses to request an explicit plaintext connection.
-
orionis.mail.entities.smtp_settings._text
orionis.mail.entities.smtp_settings.html#_text
Function
Function
PUBLIC
Read a string setting without including its value in errors.
-
orionis.mail.entities.smtp_settings._port
orionis.mail.entities.smtp_settings.html#_port
Function
Function
PUBLIC
Validate the effective SMTP TCP port.
-
orionis.mail.entities.smtp_settings._timeout
orionis.mail.entities.smtp_settings.html#_timeout
Function
Function
PUBLIC
Validate a blocking SMTP timeout without silently replacing None.
-
orionis.mail.entities.smtp_settings._url_overrides
orionis.mail.entities.smtp_settings.html#_url_overrides
Function
Function
PUBLIC
Parse the supported MAIL_URL components with explicit precedence.
-
orionis.mail.entities.smtp_settings._has_controls
orionis.mail.entities.smtp_settings.html#_has_controls
Function
Function
PUBLIC
Detect whitespace and non-printable characters in an endpoint.
-
orionis.mail.entities.SmtpSettings
orionis.mail.entities.SmtpSettings.html
Class
Class
PUBLIC
Store effective SMTP settings without exposing credentials in repr.
-
orionis.mail.entities.SmtpSettings.host
orionis.mail.entities.SmtpSettings.html#host
Attribute
Instance Variable
PUBLIC
Effective SMTP hostname.
-
orionis.mail.entities.SmtpSettings.port
orionis.mail.entities.SmtpSettings.html#port
Attribute
Instance Variable
PUBLIC
Effective TCP port between 1 and 65535.
-
orionis.mail.entities.SmtpSettings.encryption
orionis.mail.entities.SmtpSettings.html#encryption
Attribute
Instance Variable
PUBLIC
Negotiated transport security mode.
-
orionis.mail.entities.SmtpSettings.username
orionis.mail.entities.SmtpSettings.html#username
Attribute
Instance Variable
PUBLIC
Authentication user, empty when authentication is disabled.
-
orionis.mail.entities.SmtpSettings.password
orionis.mail.entities.SmtpSettings.html#password
Attribute
Instance Variable
PUBLIC
Authentication secret, empty when authentication is disabled.
-
orionis.mail.entities.SmtpSettings.timeout
orionis.mail.entities.SmtpSettings.html#timeout
Attribute
Instance Variable
PUBLIC
Positive socket timeout in seconds, or None for an unbounded wait.
-
orionis.mail.entities.SmtpSettings.sensitive
orionis.mail.entities.SmtpSettings.html#sensitive
Attribute
Instance Variable
PUBLIC
Values redacted from transport diagnostics.
-
orionis.mail.entities.SmtpSettings.fromConfig
orionis.mail.entities.SmtpSettings.html#fromConfig
Function
Class Method
PUBLIC
Resolve URL precedence and validate the effective SMTP settings.
-
orionis.mail.entities._EXPORTS
orionis.mail.entities.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.mail.entities.__getattr__
orionis.mail.entities.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.mail.entities.__dir__
orionis.mail.entities.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.mail.enums.MailEncryption
orionis.mail.enums.MailEncryption.html
Class
Class
PUBLIC
Enumerate the transport security modes accepted by the SMTP driver.
-
orionis.mail.enums.MailEncryption.TLS
orionis.mail.enums.MailEncryption.html#TLS
Attribute
Constant
PUBLIC
Mandatory STARTTLS upgrade over a plain connection.
-
orionis.mail.enums.MailEncryption.SSL
orionis.mail.enums.MailEncryption.html#SSL
Attribute
Constant
PUBLIC
Implicit TLS negotiated before the SMTP greeting.
-
orionis.mail.enums.MailEncryption.NONE
orionis.mail.enums.MailEncryption.html#NONE
Attribute
Constant
PUBLIC
Explicitly requested plaintext connection.
-
orionis.mail.enums.MailStatus
orionis.mail.enums.MailStatus.html
Class
Class
PUBLIC
Enumerate the outcomes a transport can confirm for one operation.
-
orionis.mail.enums.MailStatus.ACCEPTED
orionis.mail.enums.MailStatus.html#ACCEPTED
Attribute
Constant
PUBLIC
SMTP accepted the message for every intended recipient.
-
orionis.mail.enums.MailStatus.PARTIAL
orionis.mail.enums.MailStatus.html#PARTIAL
Attribute
Constant
PUBLIC
SMTP accepted the message for some recipients and rejected others.
-
orionis.mail.enums.MailStatus.STORED
orionis.mail.enums.MailStatus.html#STORED
Attribute
Constant
PUBLIC
The file transport published the complete message on disk.
-
orionis.mail.manager._CONVENTIONAL_DRIVERS
orionis.mail.manager.html#_CONVENTIONAL_DRIVERS
Attribute
Constant
PUBLIC
Mailer names whose driver may be omitted in the configuration.
-
orionis.mail.manager.MailManager
orionis.mail.manager.MailManager.html
Class
Class
PUBLIC
Resolve central mail configuration and delegate the shared fluent pipeline.
-
orionis.mail.manager.MailManager.__slots__
orionis.mail.manager.MailManager.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.mail.manager.MailManager.__init__
orionis.mail.manager.MailManager.html#__init__
Function
Method
PUBLIC
Retain shared dependencies without validating or opening transports.
-
orionis.mail.manager.MailManager._app
orionis.mail.manager.MailManager.html#_app
Attribute
Instance Variable
PUBLIC
Central configuration and dependency container.
-
orionis.mail.manager.MailManager._composer
orionis.mail.manager.MailManager.html#_composer
Attribute
Instance Variable
PUBLIC
Single pipeline for views, storage, validation, and MIME.
-
orionis.mail.manager.MailManager._factories
orionis.mail.manager.MailManager.html#_factories
Attribute
Instance Variable
PUBLIC
Factories registered to construct the available transport backends.
-
orionis.mail.manager.MailManager._buildMailable
orionis.mail.manager.MailManager.html#_buildMailable
Function
Method
PUBLIC
Build one reusable mail declaration with the application container.
-
orionis.mail.manager.MailManager.extend
orionis.mail.manager.MailManager.html#extend
Function
Method
PUBLIC
Register a new driver without silently replacing existing registrations.
-
orionis.mail.manager.MailManager._deliver
orionis.mail.manager.MailManager.html#_deliver
Function
Method
PUBLIC
Prepare a message completely before resolving and invoking its transport.
-
orionis.mail.manager.MailManager._applyGlobalSender
orionis.mail.manager.MailManager.html#_applyGlobalSender
Function
Method
PUBLIC
Overlay the configured global sender on an envelope that declares none.
-
orionis.mail.manager.MailManager._resolveMailer
orionis.mail.manager.MailManager.html#_resolveMailer
Function
Method
PUBLIC
Normalize only the selected central mailer without environment reads.
-
orionis.mail.manager._configuration_mapping
orionis.mail.manager.html#_configuration_mapping
Function
Function
PUBLIC
Copy one configuration layer while preserving arbitrary dependency values.
-
orionis.mail.provider.MailProvider
orionis.mail.provider.MailProvider.html
Class
Class
PUBLIC
Register mail eagerly so synchronous fluent facade entries work immediately.
-
orionis.mail.provider.MailProvider.__slots__
orionis.mail.provider.MailProvider.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.mail.provider.MailProvider.register
orionis.mail.provider.MailProvider.html#register
Function
Method
PUBLIC
Bind the shared composer and manager without resolving transports.
-
orionis.mail.provider.MailProvider.boot
orionis.mail.provider.MailProvider.html#boot
Function
Method
PUBLIC
Pin the facade without validating SMTP or opening a connection.
-
orionis.mail.transports.file._DEFAULT_OUTPUT_PATH
orionis.mail.transports.file.html#_DEFAULT_OUTPUT_PATH
Attribute
Constant
PUBLIC
storage/mail.
-
orionis.mail.transports.file._DIRECTORY_MODE
orionis.mail.transports.file.html#_DIRECTORY_MODE
Attribute
Constant
PUBLIC
Directory mode value used by file.
-
orionis.mail.transports.FileTransport
orionis.mail.transports.FileTransport.html
Class
Class
PUBLIC
Publish complete private .eml files atomically without overwriting.
-
orionis.mail.transports.FileTransport.__slots__
orionis.mail.transports.FileTransport.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.mail.transports.FileTransport.__init__
orionis.mail.transports.FileTransport.html#__init__
Function
Method
PUBLIC
Retain the application-rooted output directory without touching disk.
-
orionis.mail.transports.FileTransport._path
orionis.mail.transports.FileTransport.html#_path
Attribute
Instance Variable
PUBLIC
Absolute output directory, already anchored by the factory.
-
orionis.mail.transports.FileTransport.send
orionis.mail.transports.FileTransport.html#send
Function
Method
PUBLIC
Write and atomically publish one complete message on a worker.
-
orionis.mail.transports.FileTransport._store
orionis.mail.transports.FileTransport.html#_store
Function
Method
PUBLIC
Stage, sync, and link a message without exposing partial final files.
-
orionis.mail.transports.create_file_transport
orionis.mail.transports.html#create_file_transport
Function
Function
PUBLIC
Build a file transport anchored to the application, never the process cwd.
-
orionis.mail.transports.smtp._SMTP_READY
orionis.mail.transports.smtp.html#_SMTP_READY
Attribute
Constant
PUBLIC
Smtp ready value used by smtp.
-
orionis.mail.transports.smtp._MAX_BATCH
orionis.mail.transports.smtp.html#_MAX_BATCH
Attribute
Constant
PUBLIC
Max batch value used by smtp.
-
orionis.mail.transports.smtp._BATCH_WORKERS
orionis.mail.transports.smtp.html#_BATCH_WORKERS
Attribute
Constant
PUBLIC
Batch workers used by smtp.
-
orionis.mail.transports.smtp._mail_options
orionis.mail.transports.smtp.html#_mail_options
Function
Function
PUBLIC
Require advertised SMTPUTF8 support for international mailbox addresses.
-
orionis.mail.transports.smtp._tls_context
orionis.mail.transports.smtp.html#_tls_context
Function
Function
PUBLIC
Require trusted certificates, hostname verification, and TLS 1.2 or newer.
-
orionis.mail.transports.SmtpTransport
orionis.mail.transports.SmtpTransport.html
Class
Class
PUBLIC
Use one verified SMTP connection per message, entirely on a worker.
-
orionis.mail.transports.SmtpTransport.__slots__
orionis.mail.transports.SmtpTransport.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.mail.transports.SmtpTransport.__init__
orionis.mail.transports.SmtpTransport.html#__init__
Function
Method
PUBLIC
Retain validated settings without opening a connection.
-
orionis.mail.transports.SmtpTransport._settings
orionis.mail.transports.SmtpTransport.html#_settings
Attribute
Instance Variable
PUBLIC
Immutable effective connection options.
-
orionis.mail.transports.SmtpTransport.send
orionis.mail.transports.SmtpTransport.html#send
Function
Method
PUBLIC
Run the complete blocking SMTP cycle outside the event loop.
-
orionis.mail.transports.SmtpTransport.sendMany
orionis.mail.transports.SmtpTransport.html#sendMany
Function
Method
PUBLIC
Send a bounded batch using one authenticated connection and no retries.
-
orionis.mail.transports.SmtpTransport._sendSync
orionis.mail.transports.SmtpTransport.html#_sendSync
Function
Method
PUBLIC
Connect, negotiate, authenticate, transmit, and always close.
-
orionis.mail.transports.SmtpTransport._sendBatchSync
orionis.mail.transports.SmtpTransport.html#_sendBatchSync
Function
Method
PUBLIC
Own one SMTP session for the complete bounded batch.
-
orionis.mail.transports.SmtpTransport._result
orionis.mail.transports.SmtpTransport.html#_result
Function
Method
PUBLIC
Report exactly the recipients accepted by a completed transaction.
-
orionis.mail.transports.create_smtp_transport
orionis.mail.transports.html#create_smtp_transport
Function
Function
PUBLIC
Build SMTP from the central configuration without network activity.
-
orionis.mail.transports._EXPORTS
orionis.mail.transports.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.mail.transports.__getattr__
orionis.mail.transports.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.mail.transports.__dir__
orionis.mail.transports.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.mcp.config.McpConfig
orionis.mcp.config.McpConfig.html
Class
Class
PUBLIC
Bound MCP work and explicitly allow trusted HTTP browser origins.
-
orionis.mcp.config.McpConfig.max_request_size
orionis.mcp.config.McpConfig.html#max_request_size
Attribute
Instance Variable
PUBLIC
Maximum serialized request size in bytes. Read MCP_MAX_REQUEST_SIZE, then HTTP_MAX_BODY_SIZE, with a final default of 1 MiB.
-
orionis.mcp.config.McpConfig.default_page_size
orionis.mcp.config.McpConfig.html#default_page_size
Attribute
Instance Variable
PUBLIC
Default number of entries returned by paginated list operations. Read MCP_DEFAULT_PAGE_SIZE with a default of 50.
-
orionis.mcp.config.McpConfig.max_page_size
orionis.mcp.config.McpConfig.html#max_page_size
Attribute
Instance Variable
PUBLIC
Maximum entries per page; must be at least default_page_size. Read MCP_MAX_PAGE_SIZE with a default of 100.
-
orionis.mcp.config.McpConfig.max_concurrent_requests
orionis.mcp.config.McpConfig.html#max_concurrent_requests
Attribute
Instance Variable
PUBLIC
Maximum concurrent MCP requests. Read MCP_MAX_CONCURRENT_REQUESTS, then HTTP_MAX_CONCURRENT_REQUESTS, with a final default of 32.
-
orionis.mcp.config.McpConfig.subscription_buffer_size
orionis.mcp.config.McpConfig.html#subscription_buffer_size
Attribute
Instance Variable
PUBLIC
Maximum buffered events per subscription. Read MCP_SUBSCRIPTION_BUFFER_SIZE with a default of 64.
-
orionis.mcp.config.McpConfig.max_subscriptions
orionis.mcp.config.McpConfig.html#max_subscriptions
Attribute
Instance Variable
PUBLIC
Maximum total event-bus subscriptions. Read MCP_MAX_SUBSCRIPTIONS with a default of 1024.
-
orionis.mcp.config.McpConfig.max_resource_subscriptions
orionis.mcp.config.McpConfig.html#max_resource_subscriptions
Attribute
Instance Variable
PUBLIC
Maximum resource subscriptions per request or client context. Read MCP_MAX_RESOURCE_SUBSCRIPTIONS with a default of 64.
-
orionis.mcp.config.McpConfig.subscription_keepalive
orionis.mcp.config.McpConfig.html#subscription_keepalive
Attribute
Instance Variable
PUBLIC
Finite positive interval in seconds between subscription keepalive messages. Read MCP_SUBSCRIPTION_KEEPALIVE with a default of 15.0.
-
orionis.mcp.config.McpConfig.allowed_origins
orionis.mcp.config.McpConfig.html#allowed_origins
Attribute
Instance Variable
PUBLIC
Explicit trusted HTTP(S) browser origins without wildcards. Read CORS_ALLOW_ORIGINS with a default of an empty list.
-
orionis.mcp.config.McpConfig.tool_search_max_results
orionis.mcp.config.McpConfig.html#tool_search_max_results
Attribute
Instance Variable
PUBLIC
Maximum results returned by a tool catalog search. Read MCP_TOOL_SEARCH_MAX_RESULTS with a default of 20.
-
orionis.mcp.config.McpConfig.tool_search_max_calls
orionis.mcp.config.McpConfig.html#tool_search_max_calls
Attribute
Instance Variable
PUBLIC
Maximum tool calls allowed in one catalog execution. Read MCP_TOOL_SEARCH_MAX_CALLS with a default of 5.
-
orionis.mcp.config.McpConfig.tool_search_max_output_bytes
orionis.mcp.config.McpConfig.html#tool_search_max_output_bytes
Attribute
Instance Variable
PUBLIC
Maximum serialized tool catalog output size in bytes. Read MCP_TOOL_SEARCH_MAX_OUTPUT_BYTES with a default of 256 KiB.
-
orionis.mcp.config.McpConfig.max_response_size
orionis.mcp.config.McpConfig.html#max_response_size
Attribute
Instance Variable
PUBLIC
Maximum serialized response size in bytes. Read MCP_MAX_RESPONSE_SIZE with a default of 4 MiB.
-
orionis.mcp.config.McpConfig.max_metadata_size
orionis.mcp.config.McpConfig.html#max_metadata_size
Attribute
Instance Variable
PUBLIC
Maximum serialized request or response metadata size in bytes. Read MCP_MAX_METADATA_SIZE with a default of 64 KiB.
-
orionis.mcp.config.McpConfig.__post_init__
orionis.mcp.config.McpConfig.html#__post_init__
Function
Method
PUBLIC
Reject coercion, unbounded budgets, and ambiguous origin allowlists.
-
orionis.mcp.McpRequest
orionis.mcp.McpRequest.html
Class
Class
PUBLIC
Hold only explicit input and native context for one independent call.
-
orionis.mcp.McpRequest.id
orionis.mcp.McpRequest.html#id
Attribute
Class Variable
PUBLIC
Identifier used to correlate or locate this protocol or storage record.
-
orionis.mcp.McpRequest.method
orionis.mcp.McpRequest.html#method
Attribute
Class Variable
PUBLIC
JSON-RPC method requested by the client.
-
orionis.mcp.McpRequest.server_id
orionis.mcp.McpRequest.html#server_id
Attribute
Class Variable
PUBLIC
''.
-
orionis.mcp.McpRequest.meta
orionis.mcp.McpRequest.html#meta
Attribute
Class Variable
PUBLIC
Meta produced by field.
-
orionis.mcp.McpRequest.arguments
orionis.mcp.McpRequest.html#arguments
Attribute
Class Variable
PUBLIC
Command-line argument declarations accepted by this command.
-
orionis.mcp.McpRequest.params
orionis.mcp.McpRequest.html#params
Attribute
Class Variable
PUBLIC
Parameters carried by the JSON-RPC message.
-
orionis.mcp.McpRequest.uri_variables
orionis.mcp.McpRequest.html#uri_variables
Attribute
Class Variable
PUBLIC
Uri variables produced by field.
-
orionis.mcp.McpRequest.uri
orionis.mcp.McpRequest.html#uri
Attribute
Class Variable
PUBLIC
Resource URI identifying the requested or returned content.
-
orionis.mcp.McpRequest.input_responses
orionis.mcp.McpRequest.html#input_responses
Attribute
Class Variable
PUBLIC
Input responses produced by field.
-
orionis.mcp.McpRequest.transport
orionis.mcp.McpRequest.html#transport
Attribute
Class Variable
PUBLIC
test.
-
orionis.mcp.McpRequest.authentication
orionis.mcp.McpRequest.html#authentication
Attribute
Class Variable
PUBLIC
Authentication produced by field.
-
orionis.mcp.McpRequest.native_request
orionis.mcp.McpRequest.html#native_request
Attribute
Class Variable
PUBLIC
Underlying HTTP request when this call arrived over HTTP.
-
orionis.mcp.McpRequest.__post_init__
orionis.mcp.McpRequest.html#__post_init__
Function
Method
PUBLIC
Detach client mappings and make every nested container read-only.
-
orionis.mcp.McpRequest.identity
orionis.mcp.McpRequest.html#identity
Attribute
Property
PUBLIC
Read identity through Orionis' scoped authentication lifecycle.
-
orionis.mcp.McpRequest.clientCapabilities
orionis.mcp.McpRequest.html#clientCapabilities
Attribute
Property
PUBLIC
Read capabilities declared on this request, never a previous call.
-
orionis.mcp.MCP_PROTOCOL_VERSION
orionis.mcp.html#MCP_PROTOCOL_VERSION
Attribute
Constant
PUBLIC
2026-07-28.
-
orionis.mcp.CacheHint
orionis.mcp.CacheHint.html
Class
Class
PUBLIC
Describe client cache freshness without caching server-side results.
-
orionis.mcp.CacheHint.ttl_ms
orionis.mcp.CacheHint.html#ttl_ms
Attribute
Class Variable
PUBLIC
Ttl ms produced by msgspec.field.
-
orionis.mcp.CacheHint.scope
orionis.mcp.CacheHint.html#scope
Attribute
Class Variable
PUBLIC
Dependency-injection scope associated with the current operation.
-
orionis.mcp.CacheHint.__post_init__
orionis.mcp.CacheHint.html#__post_init__
Function
Method
PUBLIC
Reject cache hints with an invalid TTL or scope.
-
orionis.mcp.ContentAnnotations
orionis.mcp.ContentAnnotations.html
Class
Class
PUBLIC
Resource/content audience, relevance, and modification hints.
-
orionis.mcp.ContentAnnotations.last_modified
orionis.mcp.ContentAnnotations.html#last_modified
Attribute
Class Variable
PUBLIC
Last modified produced by msgspec.field.
-
orionis.mcp.ContentAnnotations.__post_init__
orionis.mcp.ContentAnnotations.html#__post_init__
Function
Method
PUBLIC
Keep content priority within the inclusive protocol interval.
-
orionis.mcp.Icon
orionis.mcp.Icon.html
Class
Class
PUBLIC
An icon reference; the server never fetches its source.
-
orionis.mcp.Icon.src
orionis.mcp.Icon.html#src
Attribute
Class Variable
PUBLIC
URI or data URL locating the icon image.
-
orionis.mcp.Icon.mime_type
orionis.mcp.Icon.html#mime_type
Attribute
Class Variable
PUBLIC
Media type describing the resource content.
-
orionis.mcp.Icon.__post_init__
orionis.mcp.Icon.html#__post_init__
Function
Method
PUBLIC
Reject icon sources that do not use HTTPS or a data URI.
-
orionis.mcp.PromptArgument
orionis.mcp.PromptArgument.html
Class
Class
PUBLIC
Declare one string-valued prompt argument.
-
orionis.mcp.PromptArgument.name
orionis.mcp.PromptArgument.html#name
Attribute
Class Variable
PUBLIC
Name identifying this declaration within its containing registry.
-
orionis.mcp.PromptArgument.required
orionis.mcp.PromptArgument.html#required
Attribute
Class Variable
PUBLIC
Required flag used by PromptArgument.
-
orionis.mcp.ToolAnnotations
orionis.mcp.ToolAnnotations.html
Class
Class
PUBLIC
Describe tool behavior as hints, never as authorization rules.
-
orionis.mcp.ToolAnnotations.read_only
orionis.mcp.ToolAnnotations.html#read_only
Attribute
Class Variable
PUBLIC
Read only produced by msgspec.field.
-
orionis.mcp.ToolAnnotations.destructive
orionis.mcp.ToolAnnotations.html#destructive
Attribute
Class Variable
PUBLIC
Destructive produced by msgspec.field.
-
orionis.mcp.ToolAnnotations.idempotent
orionis.mcp.ToolAnnotations.html#idempotent
Attribute
Class Variable
PUBLIC
Idempotent produced by msgspec.field.
-
orionis.mcp.ToolAnnotations.open_world
orionis.mcp.ToolAnnotations.html#open_world
Attribute
Class Variable
PUBLIC
Open world produced by msgspec.field.
-
orionis.mcp.Completion
orionis.mcp.Completion.html
Class
Class
PUBLIC
At most one hundred completion values.
-
orionis.mcp.Completion.values
orionis.mcp.Completion.html#values
Attribute
Class Variable
PUBLIC
Candidate values returned by the completion operation.
-
orionis.mcp.InputRequiredResult
orionis.mcp.InputRequiredResult.html
Class
Class
PUBLIC
An MRTR interim result, never a pushed JSON-RPC request.
-
orionis.mcp.InputRequiredResult.meta
orionis.mcp.InputRequiredResult.html#meta
Attribute
Class Variable
PUBLIC
Meta produced by msgspec.field.
-
orionis.mcp.InputRequiredResult.resultType
orionis.mcp.InputRequiredResult.html#resultType
Attribute
Class Variable
PUBLIC
input_required.
-
orionis.mcp.responses._JSON_MIME_TYPE
orionis.mcp.responses.html#_JSON_MIME_TYPE
Attribute
Constant
PUBLIC
application/json.
-
orionis.mcp.responses._MSGPACK_MIME_TYPES
orionis.mcp.responses.html#_MSGPACK_MIME_TYPES
Attribute
Constant
PUBLIC
Msgpack mime types used by responses.
-
orionis.mcp.responses.mime_format
orionis.mcp.responses.html#mime_format
Function
Function
PUBLIC
Select a structured content codec without changing the declared MIME type.
-
orionis.mcp.responses._encode_payload
orionis.mcp.responses.html#_encode_payload
Function
Function
PUBLIC
Serialize application data with the selected native msgspec codec.
-
orionis.mcp.responses.Progress
orionis.mcp.responses.Progress.html
Class
Class
PUBLIC
A request-scoped progress update awaiting a client-provided token.
-
orionis.mcp.responses.Progress.current
orionis.mcp.responses.Progress.html#current
Attribute
Class Variable
PUBLIC
Amount of work completed so far.
-
orionis.mcp.responses.Progress.total
orionis.mcp.responses.Progress.html#total
Attribute
Class Variable
PUBLIC
Total amount of work, when known.
-
orionis.mcp.responses.Progress.message
orionis.mcp.responses.Progress.html#message
Attribute
Class Variable
PUBLIC
Human-readable message associated with this operation or result.
-
orionis.mcp.McpResponse
orionis.mcp.McpResponse.html
Class
Class
PUBLIC
Compose protocol content without knowing the transport or DI container.
-
orionis.mcp.McpResponse.content
orionis.mcp.McpResponse.html#content
Attribute
Class Variable
PUBLIC
Content blocks carried by this protocol value.
-
orionis.mcp.McpResponse.is_error
orionis.mcp.McpResponse.html#is_error
Attribute
Class Variable
PUBLIC
Is error flag used by McpResponse.
-
orionis.mcp.McpResponse.role
orionis.mcp.McpResponse.html#role
Attribute
Class Variable
PUBLIC
user.
-
orionis.mcp.McpResponse.progress_update
orionis.mcp.McpResponse.html#progress_update
Attribute
Class Variable
PUBLIC
Progress notification emitted independently of response content.
-
orionis.mcp.McpResponse.meta
orionis.mcp.McpResponse.html#meta
Attribute
Class Variable
PUBLIC
Meta produced by field.
-
orionis.mcp.McpResponse._structured_text
orionis.mcp.McpResponse.html#_structured_text
Attribute
Class Variable
PUBLIC
Generated text block owned by structured content, excluding manual text.
-
orionis.mcp.McpResponse.text
orionis.mcp.McpResponse.html#text
Function
Class Method
PUBLIC
Return text content.
-
orionis.mcp.McpResponse.image
orionis.mcp.McpResponse.html#image
Function
Class Method
PUBLIC
Encode raw image bytes once.
-
orionis.mcp.McpResponse.audio
orionis.mcp.McpResponse.html#audio
Function
Class Method
PUBLIC
Encode raw audio bytes once.
-
orionis.mcp.McpResponse.resource
orionis.mcp.McpResponse.html#resource
Function
Class Method
PUBLIC
Serialize and embed resource content according to its MIME type.
-
orionis.mcp.McpResponse.resourceLink
orionis.mcp.McpResponse.html#resourceLink
Function
Class Method
PUBLIC
Link to a resource without loading it.
-
orionis.mcp.McpResponse.structured
orionis.mcp.McpResponse.html#structured
Function
Class Method
PUBLIC
Return any JSON value and the recommended serialized text content.
-
orionis.mcp.McpResponse.error
orionis.mcp.McpResponse.html#error
Function
Class Method
PUBLIC
Return an application-visible tool error, with an explicit safe message.
-
orionis.mcp.McpResponse.progress
orionis.mcp.McpResponse.html#progress
Function
Class Method
PUBLIC
Yield progress; the dispatcher suppresses it without client opt-in.
-
orionis.mcp.McpResponse.asAssistant
orionis.mcp.McpResponse.html#asAssistant
Function
Method
PUBLIC
Assign the assistant role for a prompt response.
-
orionis.mcp.McpResponse.asUser
orionis.mcp.McpResponse.html#asUser
Function
Method
PUBLIC
Assign the user role for a prompt response.
-
orionis.mcp.McpResponse.withMeta
orionis.mcp.McpResponse.html#withMeta
Function
Method
PUBLIC
Attach result metadata without allowing reserved protocol keys.
-
orionis.mcp.McpResponse.withContentMeta
orionis.mcp.McpResponse.html#withContentMeta
Function
Method
PUBLIC
Attach application metadata to each content block.
-
orionis.mcp.McpResponse.withAnnotations
orionis.mcp.McpResponse.html#withAnnotations
Function
Method
PUBLIC
Set audience, priority and modification hints on content blocks.
-
orionis.mcp.McpResponse._copyContent
orionis.mcp.McpResponse.html#_copyContent
Function
Method
PUBLIC
Retain generated-text ownership when cloning content metadata.
-
orionis.mcp.ToolCatalog
orionis.mcp.ToolCatalog.html
Class
Class
PUBLIC
Hide catalog tools behind bounded search_tools and execute_tools tools.
-
orionis.mcp.ToolCatalog.tools
orionis.mcp.ToolCatalog.html#tools
Attribute
Class Variable
PUBLIC
Value supplied for *tools.
-
orionis.mcp.ToolCatalog.search_name
orionis.mcp.ToolCatalog.html#search_name
Attribute
Class Variable
PUBLIC
Value supplied for search_name.
-
orionis.mcp.ToolCatalog.execute_name
orionis.mcp.ToolCatalog.html#execute_name
Attribute
Class Variable
PUBLIC
Value supplied for execute_name.
-
orionis.mcp.ToolCatalog.__init__
orionis.mcp.ToolCatalog.html#__init__
Function
Method
PUBLIC
Store definitions without resolving instances or inspecting handlers.
-
orionis.mcp.McpExtension
orionis.mcp.McpExtension.html
Class
Class
PUBLIC
Declare negotiated capabilities and extension-owned method/schema hooks.
-
orionis.mcp.McpExtension.identifier
orionis.mcp.McpExtension.html#identifier
Attribute
Class Variable
PUBLIC
Unique identifier used to negotiate the extension.
-
orionis.mcp.McpExtension.capabilities
orionis.mcp.McpExtension.html#capabilities
Attribute
Class Variable
PUBLIC
Capabilities advertised by the compiled server.
-
orionis.mcp.McpExtension.methods
orionis.mcp.McpExtension.html#methods
Attribute
Class Variable
PUBLIC
Methods produced by field.
-
orionis.mcp.McpExtension.decoders
orionis.mcp.McpExtension.html#decoders
Attribute
Class Variable
PUBLIC
Decoders produced by field.
-
orionis.mcp.McpExtension.schema_hook
orionis.mcp.McpExtension.html#schema_hook
Attribute
Class Variable
PUBLIC
Hook that contributes extension-specific schema definitions.
-
orionis.mcp.McpExtension.__post_init__
orionis.mcp.McpExtension.html#__post_init__
Function
Method
PUBLIC
Detach declarations so a compiled server cannot change accidentally.
-
orionis.mcp.Prompt
orionis.mcp.Prompt.html
Class
Class
PUBLIC
Declare string arguments and return user/assistant prompt messages.
-
orionis.mcp.Prompt.__slots__
orionis.mcp.Prompt.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.mcp.Prompt.arguments
orionis.mcp.Prompt.html#arguments
Attribute
Class Variable
PUBLIC
Command-line argument declarations accepted by this command.
-
orionis.mcp.Resource
orionis.mcp.Resource.html
Class
Class
PUBLIC
Read a declared URI or RFC 6570 template without implicit file access.
-
orionis.mcp.Resource.__slots__
orionis.mcp.Resource.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.mcp.Resource.uri
orionis.mcp.Resource.html#uri
Attribute
Class Variable
PUBLIC
''.
-
orionis.mcp.Resource.uri_template
orionis.mcp.Resource.html#uri_template
Attribute
Class Variable
PUBLIC
''.
-
orionis.mcp.Resource.mime_type
orionis.mcp.Resource.html#mime_type
Attribute
Class Variable
PUBLIC
text/plain.
-
orionis.mcp.Resource.size
orionis.mcp.Resource.html#size
Attribute
Class Variable
PUBLIC
Declared size of the resource content.
-
orionis.mcp.Resource.annotations
orionis.mcp.Resource.html#annotations
Attribute
Class Variable
PUBLIC
Declared metadata describing behavior or validation types.
-
orionis.mcp.Server
orionis.mcp.Server.html
Class
Class
PUBLIC
Define a server independently of any connection or transport.
-
orionis.mcp.Server.__slots__
orionis.mcp.Server.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.mcp.Server.name
orionis.mcp.Server.html#name
Attribute
Class Variable
PUBLIC
''.
-
orionis.mcp.Server.version
orionis.mcp.Server.html#version
Attribute
Class Variable
PUBLIC
1.0.0.
-
orionis.mcp.Server.title
orionis.mcp.Server.html#title
Attribute
Class Variable
PUBLIC
''.
-
orionis.mcp.Server.description
orionis.mcp.Server.html#description
Attribute
Class Variable
PUBLIC
''.
-
orionis.mcp.Server.website_url
orionis.mcp.Server.html#website_url
Attribute
Class Variable
PUBLIC
''.
-
orionis.mcp.Server.instructions
orionis.mcp.Server.html#instructions
Attribute
Class Variable
PUBLIC
''.
-
orionis.mcp.Server.icons
orionis.mcp.Server.html#icons
Attribute
Class Variable
PUBLIC
Icon metadata advertised for the primitive or server.
-
orionis.mcp.Server.tools
orionis.mcp.Server.html#tools
Attribute
Class Variable
PUBLIC
Tool declarations available through this server or catalog.
-
orionis.mcp.Server.resources
orionis.mcp.Server.html#resources
Attribute
Class Variable
PUBLIC
Resource declarations available through this server.
-
orionis.mcp.Server.prompts
orionis.mcp.Server.html#prompts
Attribute
Class Variable
PUBLIC
Prompt declarations available through this server.
-
orionis.mcp.Server.extensions
orionis.mcp.Server.html#extensions
Attribute
Class Variable
PUBLIC
Extensions registered for this server or transport.
-
orionis.mcp.Server.cache
orionis.mcp.Server.html#cache
Attribute
Class Variable
PUBLIC
Cache policy or cached state used by this component.
-
orionis.mcp.Server.list_changed
orionis.mcp.Server.html#list_changed
Attribute
Class Variable
PUBLIC
List changed flag used by Server.
-
orionis.mcp.Server.resource_subscriptions
orionis.mcp.Server.html#resource_subscriptions
Attribute
Class Variable
PUBLIC
Resource subscriptions flag used by Server.
-
orionis.mcp.Tool
orionis.mcp.Tool.html
Class
Class
PUBLIC
Declare a typed input, optional typed output, and an injectable handle method.
-
orionis.mcp.Tool.__slots__
orionis.mcp.Tool.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.mcp.Tool.input
orionis.mcp.Tool.html#input
Attribute
Class Variable
PUBLIC
Structured input supplied to the tool invocation.
-
orionis.mcp.Tool.output
orionis.mcp.Tool.html#output
Attribute
Class Variable
PUBLIC
Declared schema for structured tool output.
-
orionis.mcp.Tool.annotations
orionis.mcp.Tool.html#annotations
Attribute
Class Variable
PUBLIC
Declared metadata describing behavior or validation types.
-
orionis.mcp.state._State
orionis.mcp.state._State.html
Class
Class
PUBLIC
Authenticate the complete structured envelope before exposing state.
-
orionis.mcp.state._State.purpose
orionis.mcp.state._State.html#purpose
Attribute
Class Variable
PUBLIC
Purpose restricting where protected request state may be reused.
-
orionis.mcp.state._State.expires
orionis.mcp.state._State.html#expires
Attribute
Class Variable
PUBLIC
Expiration deadline for the cached or protected value.
-
orionis.mcp.state._State.principal
orionis.mcp.state._State.html#principal
Attribute
Class Variable
PUBLIC
Authenticated principal to which the state value is bound.
-
orionis.mcp.state._State.request
orionis.mcp.state._State.html#request
Attribute
Class Variable
PUBLIC
Request identity to which the state value is bound.
-
orionis.mcp.state._State.value
orionis.mcp.state._State.html#value
Attribute
Class Variable
PUBLIC
Payload retained for subsequent resolution or restoration.
-
orionis.mcp.state._STATE_DECODER
orionis.mcp.state.html#_STATE_DECODER
Attribute
Constant
PUBLIC
State decoder used by state.
-
orionis.mcp.state._INVALID_STATE
orionis.mcp.state.html#_INVALID_STATE
Attribute
Constant
PUBLIC
Invalid request state.
-
orionis.mcp.state._fingerprint
orionis.mcp.state.html#_fingerprint
Function
Function
PUBLIC
Bind state to stable request parameters, excluding retry and trace fields.
-
orionis.mcp.state._principal
orionis.mcp.state.html#_principal
Function
Function
PUBLIC
Bind native guard, identity type, identifier and credential without coercion.
-
orionis.mcp.McpState
orionis.mcp.McpState.html
Class
Class
PUBLIC
Seal state across workers sharing an application key and GCM cipher.
-
orionis.mcp.McpState.__slots__
orionis.mcp.McpState.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.mcp.McpState.__init__
orionis.mcp.McpState.html#__init__
Function
Method
PUBLIC
Require authenticated encryption rather than unauthenticated CBC.
-
orionis.mcp.McpState._encrypter
orionis.mcp.McpState.html#_encrypter
Attribute
Instance Variable
PUBLIC
Value supplied for encrypter.
-
orionis.mcp.McpState.seal
orionis.mcp.McpState.html#seal
Function
Method
PUBLIC
Encrypt data bound to its principal, arguments, method and expiry.
-
orionis.mcp.McpState.open
orionis.mcp.McpState.html#open
Function
Method
PUBLIC
Authenticate and validate client-carried state before using its data.
-
orionis.mcp._METADATA_MODULE
orionis.mcp.html#_METADATA_MODULE
Attribute
Constant
PUBLIC
Module defining metadata values exported by this package.
-
orionis.mcp._PRIMITIVES_MODULE
orionis.mcp.html#_PRIMITIVES_MODULE
Attribute
Constant
PUBLIC
Module defining the public tool, resource, prompt, and server primitives.
-
orionis.mcp._EXPORTS
orionis.mcp.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.mcp.__getattr__
orionis.mcp.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.mcp.__dir__
orionis.mcp.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.mcp.contracts.event_bus.IMcpEventBus
orionis.mcp.contracts.event_bus.IMcpEventBus.html
Class
Class
PUBLIC
Publish server changes without retaining identities or requests.
-
orionis.mcp.contracts.event_bus.IMcpEventBus.__slots__
orionis.mcp.contracts.event_bus.IMcpEventBus.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.mcp.contracts.event_bus.IMcpEventBus.listen
orionis.mcp.contracts.event_bus.IMcpEventBus.html#listen
Function
Method
PUBLIC
Open a bounded subscription, releasing it on iterator close.
-
orionis.mcp.contracts.event_bus.IMcpEventBus.publish
orionis.mcp.contracts.event_bus.IMcpEventBus.html#publish
Function
Method
PUBLIC
Publish a notification kind to the corresponding server.
-
orionis.mcp.contracts.event_bus.IMcpEventBus.shutdown
orionis.mcp.contracts.event_bus.IMcpEventBus.html#shutdown
Function
Method
PUBLIC
Wake subscribers for a graceful end.
-
orionis.mcp.protocol.codecs._ENVELOPE
orionis.mcp.protocol.codecs.html#_ENVELOPE
Attribute
Constant
PUBLIC
Envelope used by codecs.
-
orionis.mcp.protocol.codecs.METHOD_DECODERS
orionis.mcp.protocol.codecs.html#METHOD_DECODERS
Attribute
Constant
PUBLIC
Method decoders used by codecs.
-
orionis.mcp.protocol.codecs.decode_envelope
orionis.mcp.protocol.codecs.html#decode_envelope
Function
Function
PUBLIC
Parse a single UTF-8 JSON-RPC message without decoding its payload.
-
orionis.mcp.protocol.codecs.decode_params
orionis.mcp.protocol.codecs.html#decode_params
Function
Function
PUBLIC
Validate method-specific parameters and per-request metadata.
-
orionis.mcp.protocol.codecs.encode_error
orionis.mcp.protocol.codecs.html#encode_error
Function
Function
PUBLIC
Serialize only explicitly public exception fields.
-
orionis.mcp.protocol.input_shapes.OptionalString
orionis.mcp.protocol.input_shapes.html#OptionalString
Attribute
Type Alias
PUBLIC
Type alias for str | msgspec.UnsetType.
-
orionis.mcp.protocol.input_shapes.Nonnegative
orionis.mcp.protocol.input_shapes.html#Nonnegative
Attribute
Type Alias
PUBLIC
Type alias for Annotated[int, msgspec.Meta(ge=0)].
-
orionis.mcp.protocol.input_shapes.Priority
orionis.mcp.protocol.input_shapes.html#Priority
Attribute
Type Alias
PUBLIC
Type alias for Annotated[float, msgspec.Meta(ge=0, le=1)].
-
orionis.mcp.protocol.input_shapes.FormValue
orionis.mcp.protocol.input_shapes.html#FormValue
Attribute
Type Alias
PUBLIC
Type alias for str | float | bool | list[str].
-
orionis.mcp.protocol.input_shapes.FormResult
orionis.mcp.protocol.input_shapes.FormResult.html
Class
Class
PUBLIC
An elicitation response, with no JSON-RPC error envelope.
-
orionis.mcp.protocol.input_shapes.FormResult.action
orionis.mcp.protocol.input_shapes.FormResult.html#action
Attribute
Class Variable
PUBLIC
Client action completing or declining the form request.
-
orionis.mcp.protocol.input_shapes.EnumOption
orionis.mcp.protocol.input_shapes.EnumOption.html
Class
Class
PUBLIC
A titled single selection option.
-
orionis.mcp.protocol.input_shapes.EnumOption.const
orionis.mcp.protocol.input_shapes.EnumOption.html#const
Attribute
Class Variable
PUBLIC
Exact value represented by this enumeration option.
-
orionis.mcp.protocol.input_shapes.EnumOption.title
orionis.mcp.protocol.input_shapes.EnumOption.html#title
Attribute
Class Variable
PUBLIC
Human-readable title displayed for this protocol value.
-
orionis.mcp.protocol.input_shapes.FormField
orionis.mcp.protocol.input_shapes.FormField.html
Class
Class
PUBLIC
The non-nesting primitive schema supported by elicitation forms.
-
orionis.mcp.protocol.input_shapes.FormField.type
orionis.mcp.protocol.input_shapes.FormField.html#type
Attribute
Class Variable
PUBLIC
Discriminator identifying the message or schema variant.
-
orionis.mcp.protocol.input_shapes.FormField.min_length
orionis.mcp.protocol.input_shapes.FormField.html#min_length
Attribute
Class Variable
PUBLIC
Min length produced by msgspec.field.
-
orionis.mcp.protocol.input_shapes.FormField.max_length
orionis.mcp.protocol.input_shapes.FormField.html#max_length
Attribute
Class Variable
PUBLIC
Max length produced by msgspec.field.
-
orionis.mcp.protocol.input_shapes.FormField.min_items
orionis.mcp.protocol.input_shapes.FormField.html#min_items
Attribute
Class Variable
PUBLIC
Min items produced by msgspec.field.
-
orionis.mcp.protocol.input_shapes.FormField.max_items
orionis.mcp.protocol.input_shapes.FormField.html#max_items
Attribute
Class Variable
PUBLIC
Max items produced by msgspec.field.
-
orionis.mcp.protocol.input_shapes.FormField.enum_names
orionis.mcp.protocol.input_shapes.FormField.html#enum_names
Attribute
Class Variable
PUBLIC
Enum names produced by msgspec.field.
-
orionis.mcp.protocol.input_shapes.FormField.one_of
orionis.mcp.protocol.input_shapes.FormField.html#one_of
Attribute
Class Variable
PUBLIC
One of produced by msgspec.field.
-
orionis.mcp.protocol.input_shapes.EnumItems
orionis.mcp.protocol.input_shapes.EnumItems.html
Class
Class
PUBLIC
The two permitted string enumeration item schemas.
-
orionis.mcp.protocol.input_shapes.EnumItems.any_of
orionis.mcp.protocol.input_shapes.EnumItems.html#any_of
Attribute
Class Variable
PUBLIC
Any of produced by msgspec.field.
-
orionis.mcp.protocol.input_shapes.FormSchema
orionis.mcp.protocol.input_shapes.FormSchema.html
Class
Class
PUBLIC
A flat object containing elicitation form fields.
-
orionis.mcp.protocol.input_shapes.FormSchema.type
orionis.mcp.protocol.input_shapes.FormSchema.html#type
Attribute
Class Variable
PUBLIC
Discriminator identifying the message or schema variant.
-
orionis.mcp.protocol.input_shapes.FormSchema.properties
orionis.mcp.protocol.input_shapes.FormSchema.html#properties
Attribute
Class Variable
PUBLIC
Field schemas indexed by the corresponding property name.
-
orionis.mcp.protocol.input_shapes.FormSchema.required
orionis.mcp.protocol.input_shapes.FormSchema.html#required
Attribute
Class Variable
PUBLIC
Property names that must be present in the submitted object.
-
orionis.mcp.protocol.input_shapes.FormSchema.schema
orionis.mcp.protocol.input_shapes.FormSchema.html#schema
Attribute
Class Variable
PUBLIC
Schema produced by msgspec.field.
-
orionis.mcp.protocol.input_shapes.FormRequest
orionis.mcp.protocol.input_shapes.FormRequest.html
Class
Class
PUBLIC
Form elicitation parameters.
-
orionis.mcp.protocol.input_shapes.FormRequest.message
orionis.mcp.protocol.input_shapes.FormRequest.html#message
Attribute
Class Variable
PUBLIC
Human-readable message associated with this operation or result.
-
orionis.mcp.protocol.input_shapes.FormRequest.requested_schema
orionis.mcp.protocol.input_shapes.FormRequest.html#requested_schema
Attribute
Class Variable
PUBLIC
Requested schema produced by msgspec.field.
-
orionis.mcp.protocol.input_shapes.FormRequest.mode
orionis.mcp.protocol.input_shapes.FormRequest.html#mode
Attribute
Class Variable
PUBLIC
form.
-
orionis.mcp.protocol.input_shapes.UrlRequest
orionis.mcp.protocol.input_shapes.UrlRequest.html
Class
Class
PUBLIC
Out-of-band elicitation parameters.
-
orionis.mcp.protocol.input_shapes.UrlRequest.mode
orionis.mcp.protocol.input_shapes.UrlRequest.html#mode
Attribute
Class Variable
PUBLIC
Interaction mode requested from the client.
-
orionis.mcp.protocol.input_shapes.UrlRequest.message
orionis.mcp.protocol.input_shapes.UrlRequest.html#message
Attribute
Class Variable
PUBLIC
Human-readable message associated with this operation or result.
-
orionis.mcp.protocol.input_shapes.UrlRequest.url
orionis.mcp.protocol.input_shapes.UrlRequest.html#url
Attribute
Class Variable
PUBLIC
URL the client is asked to open or display.
-
orionis.mcp.protocol.input_shapes.Root
orionis.mcp.protocol.input_shapes.Root.html
Class
Class
PUBLIC
Wire-only deprecated root descriptor.
-
orionis.mcp.protocol.input_shapes.Root.uri
orionis.mcp.protocol.input_shapes.Root.html#uri
Attribute
Class Variable
PUBLIC
Resource URI identifying the requested or returned content.
-
orionis.mcp.protocol.input_shapes.Root.meta
orionis.mcp.protocol.input_shapes.Root.html#meta
Attribute
Class Variable
PUBLIC
Meta produced by msgspec.field.
-
orionis.mcp.protocol.input_shapes.RootsResult
orionis.mcp.protocol.input_shapes.RootsResult.html
Class
Class
PUBLIC
Wire-only deprecated roots result.
-
orionis.mcp.protocol.input_shapes.RootsResult.roots
orionis.mcp.protocol.input_shapes.RootsResult.html#roots
Attribute
Class Variable
PUBLIC
Root resources reported by the client.
-
orionis.mcp.protocol.input_shapes.SamplingMessage
orionis.mcp.protocol.input_shapes.SamplingMessage.html
Class
Class
PUBLIC
Wire-only deprecated sampling message.
-
orionis.mcp.protocol.input_shapes.SamplingMessage.role
orionis.mcp.protocol.input_shapes.SamplingMessage.html#role
Attribute
Class Variable
PUBLIC
Role assigned to this message in the conversation.
-
orionis.mcp.protocol.input_shapes.SamplingMessage.content
orionis.mcp.protocol.input_shapes.SamplingMessage.html#content
Attribute
Class Variable
PUBLIC
Content blocks carried by this protocol value.
-
orionis.mcp.protocol.input_shapes.SamplingMessage.meta
orionis.mcp.protocol.input_shapes.SamplingMessage.html#meta
Attribute
Class Variable
PUBLIC
Meta produced by msgspec.field.
-
orionis.mcp.protocol.input_shapes.SamplingResult
orionis.mcp.protocol.input_shapes.SamplingResult.html
Class
Class
PUBLIC
Wire-only deprecated sampling response.
-
orionis.mcp.protocol.input_shapes.SamplingResult.model
orionis.mcp.protocol.input_shapes.SamplingResult.html#model
Attribute
Class Variable
PUBLIC
Model selected for generation or persistence.
-
orionis.mcp.protocol.input_shapes.SamplingResult.stop_reason
orionis.mcp.protocol.input_shapes.SamplingResult.html#stop_reason
Attribute
Class Variable
PUBLIC
Stop reason produced by msgspec.field.
-
orionis.mcp.protocol.input_shapes.ModelHint
orionis.mcp.protocol.input_shapes.ModelHint.html
Class
Class
PUBLIC
A provider-agnostic model hint.
-
orionis.mcp.protocol.input_shapes.ModelPreferences
orionis.mcp.protocol.input_shapes.ModelPreferences.html
Class
Class
PUBLIC
Bounded priorities for a wire sampling request.
-
orionis.mcp.protocol.input_shapes.ModelPreferences.cost
orionis.mcp.protocol.input_shapes.ModelPreferences.html#cost
Attribute
Class Variable
PUBLIC
Cost produced by msgspec.field.
-
orionis.mcp.protocol.input_shapes.ModelPreferences.speed
orionis.mcp.protocol.input_shapes.ModelPreferences.html#speed
Attribute
Class Variable
PUBLIC
Speed produced by msgspec.field.
-
orionis.mcp.protocol.input_shapes.ModelPreferences.intelligence
orionis.mcp.protocol.input_shapes.ModelPreferences.html#intelligence
Attribute
Class Variable
PUBLIC
Intelligence produced by msgspec.field.
-
orionis.mcp.protocol.input_shapes.ToolChoice
orionis.mcp.protocol.input_shapes.ToolChoice.html
Class
Class
PUBLIC
The protocol's sampling tool policy.
-
orionis.mcp.protocol.input_shapes.ToolChoice.mode
orionis.mcp.protocol.input_shapes.ToolChoice.html#mode
Attribute
Class Variable
PUBLIC
auto.
-
orionis.mcp.protocol.input_shapes.SamplingRequest
orionis.mcp.protocol.input_shapes.SamplingRequest.html
Class
Class
PUBLIC
Wire-only deprecated sampling parameters.
-
orionis.mcp.protocol.input_shapes.SamplingRequest.messages
orionis.mcp.protocol.input_shapes.SamplingRequest.html#messages
Attribute
Class Variable
PUBLIC
Ordered messages supplied to or returned by the operation.
-
orionis.mcp.protocol.input_shapes.SamplingRequest.max_tokens
orionis.mcp.protocol.input_shapes.SamplingRequest.html#max_tokens
Attribute
Class Variable
PUBLIC
Max tokens produced by msgspec.field.
-
orionis.mcp.protocol.input_shapes.SamplingRequest.model_preferences
orionis.mcp.protocol.input_shapes.SamplingRequest.html#model_preferences
Attribute
Class Variable
PUBLIC
Model preferences produced by msgspec.field.
-
orionis.mcp.protocol.input_shapes.SamplingRequest.system_prompt
orionis.mcp.protocol.input_shapes.SamplingRequest.html#system_prompt
Attribute
Class Variable
PUBLIC
System prompt produced by msgspec.field.
-
orionis.mcp.protocol.input_shapes.SamplingRequest.include_context
orionis.mcp.protocol.input_shapes.SamplingRequest.html#include_context
Attribute
Class Variable
PUBLIC
Include context produced by msgspec.field.
-
orionis.mcp.protocol.input_shapes.SamplingRequest.stop_sequences
orionis.mcp.protocol.input_shapes.SamplingRequest.html#stop_sequences
Attribute
Class Variable
PUBLIC
Stop sequences produced by msgspec.field.
-
orionis.mcp.protocol.input_shapes.SamplingRequest.tool_choice
orionis.mcp.protocol.input_shapes.SamplingRequest.html#tool_choice
Attribute
Class Variable
PUBLIC
Tool choice produced by msgspec.field.
-
orionis.mcp.protocol.input_shapes.ToolUse
orionis.mcp.protocol.input_shapes.ToolUse.html
Class
Class
PUBLIC
Wire-only model invocation of a tool.
-
orionis.mcp.protocol.input_shapes.ToolUse.id
orionis.mcp.protocol.input_shapes.ToolUse.html#id
Attribute
Class Variable
PUBLIC
Identifier used to correlate or locate this protocol or storage record.
-
orionis.mcp.protocol.input_shapes.ToolUse.name
orionis.mcp.protocol.input_shapes.ToolUse.html#name
Attribute
Class Variable
PUBLIC
Name identifying this declaration within its containing registry.
-
orionis.mcp.protocol.input_shapes.ToolUse.input
orionis.mcp.protocol.input_shapes.ToolUse.html#input
Attribute
Class Variable
PUBLIC
Structured input supplied to the tool invocation.
-
orionis.mcp.protocol.input_shapes.ToolResult
orionis.mcp.protocol.input_shapes.ToolResult.html
Class
Class
PUBLIC
Wire-only response to a model's tool invocation.
-
orionis.mcp.protocol.input_shapes.ToolResult.tool_use_id
orionis.mcp.protocol.input_shapes.ToolResult.html#tool_use_id
Attribute
Class Variable
PUBLIC
Tool use id produced by msgspec.field.
-
orionis.mcp.protocol.input_shapes.ToolResult.content
orionis.mcp.protocol.input_shapes.ToolResult.html#content
Attribute
Class Variable
PUBLIC
Content blocks carried by this protocol value.
-
orionis.mcp.protocol.input_shapes.ToolResult.structured_content
orionis.mcp.protocol.input_shapes.ToolResult.html#structured_content
Attribute
Class Variable
PUBLIC
Structured content produced by msgspec.field.
-
orionis.mcp.protocol.input_shapes.ToolResult.is_error
orionis.mcp.protocol.input_shapes.ToolResult.html#is_error
Attribute
Class Variable
PUBLIC
Is error produced by msgspec.field.
-
orionis.mcp.protocol.mrtr.validate_input_required
orionis.mcp.protocol.mrtr.html#validate_input_required
Function
Function
PUBLIC
Never request client functionality absent from this request's capabilities.
-
orionis.mcp.protocol.mrtr._input_requests
orionis.mcp.protocol.mrtr.html#_input_requests
Function
Function
PUBLIC
Validate input request fields and the permitted enclosing method.
-
orionis.mcp.protocol.mrtr._input_request
orionis.mcp.protocol.mrtr.html#_input_request
Function
Function
PUBLIC
Validate and dispatch one embedded client input request.
-
orionis.mcp.protocol.mrtr._require
orionis.mcp.protocol.mrtr.html#_require
Function
Function
PUBLIC
Require a capability, including the historical implicit form flag.
-
orionis.mcp.protocol.mrtr._elicitation
orionis.mcp.protocol.mrtr.html#_elicitation
Function
Function
PUBLIC
Validate the modern form or URL elicitation wire shape.
-
orionis.mcp.protocol.mrtr._form_field
orionis.mcp.protocol.mrtr.html#_form_field
Function
Function
PUBLIC
Validate permitted enumeration and default shapes.
-
orionis.mcp.protocol.mrtr._sampling
orionis.mcp.protocol.mrtr.html#_sampling
Function
Function
PUBLIC
Retain deprecated sampling only as correctly validated MRTR wire support.
-
orionis.mcp.protocol.mrtr._sampling_message
orionis.mcp.protocol.mrtr.html#_sampling_message
Function
Function
PUBLIC
Check each sampling-specific or common content block.
-
orionis.mcp.protocol.mrtr.validate_input_responses
orionis.mcp.protocol.mrtr.html#validate_input_responses
Function
Function
PUBLIC
Validate exact result variants without fabricating request history.
-
orionis.mcp.protocol.mrtr._input_response
orionis.mcp.protocol.mrtr.html#_input_response
Function
Function
PUBLIC
Dispatch structural InputResponse variants, never a JSON-RPC error.
-
orionis.mcp.reporting.report
orionis.mcp.reporting.html#report
Function
Function
PUBLIC
Observe an MCP failure without constructing a protocol response.
-
orionis.mcp.normalization.CacheOptions
orionis.mcp.normalization.CacheOptions.html
Class
Class
PUBLIC
Describe MCP response cache lifetime and visibility options.
-
orionis.mcp.normalization.CacheOptions.ttlMs
orionis.mcp.normalization.CacheOptions.html#ttlMs
Attribute
Class Variable
PUBLIC
Cache lifetime in milliseconds.
-
orionis.mcp.normalization.CacheOptions.cacheScope
orionis.mcp.normalization.CacheOptions.html#cacheScope
Attribute
Class Variable
PUBLIC
private or public.
-
orionis.mcp.normalization.buffered_size
orionis.mcp.normalization.html#buffered_size
Function
Function
PUBLIC
Measure buffered JSON data without counting builder-only ownership state.
-
orionis.mcp.normalization.response_items
orionis.mcp.normalization.html#response_items
Function
Function
PUBLIC
Accept explicit content responses and reject accidental arbitrary objects.
-
orionis.mcp.normalization.tool_result
orionis.mcp.normalization.html#tool_result
Function
Function
PUBLIC
Validate structured output before publishing a successful result.
-
orionis.mcp.normalization.validated_output
orionis.mcp.normalization.html#validated_output
Function
Function
PUBLIC
Normalize declared structured output before publishing its wire value.
-
orionis.mcp.normalization.prompt_result
orionis.mcp.normalization.html#prompt_result
Function
Function
PUBLIC
Preserve role and individual content-block boundaries.
-
orionis.mcp.normalization.resource_result
orionis.mcp.normalization.html#resource_result
Function
Function
PUBLIC
Use only text/blob contents permitted by resources/read.
-
orionis.mcp.normalization._metadata
orionis.mcp.normalization.html#_metadata
Function
Function
PUBLIC
Merge response metadata while rejecting conflicting result values.
-
orionis.mcp.normalization.progress_params
orionis.mcp.normalization.html#progress_params
Function
Function
PUBLIC
Enforce monotonic progress and retain the caller's correlation token.
-
orionis.mcp.streams._create_task
orionis.mcp.streams.html#_create_task
Function
Function
PUBLIC
Close an owned coroutine when the loop refuses to schedule it.
-
orionis.mcp.streams._caller_cancelled
orionis.mcp.streams.html#_caller_cancelled
Function
Function
PUBLIC
Identify new caller cancellation while an owned cleanup was awaited.
-
orionis.mcp.streams.AsyncClosable
orionis.mcp.streams.AsyncClosable.html
Class
Class
PUBLIC
Describe the awaited close operation of an owned asynchronous source.
-
orionis.mcp.streams.AsyncClosable.__slots__
orionis.mcp.streams.AsyncClosable.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.mcp.streams.AsyncClosable.aclose
orionis.mcp.streams.AsyncClosable.html#aclose
Function
Method
PUBLIC
Release the resources owned by an asynchronous source.
-
orionis.mcp.streams.OwnedStream
orionis.mcp.streams.OwnedStream.html
Class
Class
PUBLIC
Join source cleanup before propagating delivery errors or cancellation.
-
orionis.mcp.streams.OwnedStream.__slots__
orionis.mcp.streams.OwnedStream.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.mcp.streams.OwnedStream.__init__
orionis.mcp.streams.OwnedStream.html#__init__
Function
Method
PUBLIC
Take lazy ownership of a synchronous or asynchronous iterator.
-
orionis.mcp.streams.OwnedStream._source
orionis.mcp.streams.OwnedStream.html#_source
Attribute
Instance Variable
PUBLIC
Source whose values or lifecycle are consumed by this operation.
-
orionis.mcp.streams.OwnedStream._owner
orionis.mcp.streams.OwnedStream.html#_owner
Attribute
Instance Variable
PUBLIC
Value supplied for owner.
-
orionis.mcp.streams.OwnedStream._closed
orionis.mcp.streams.OwnedStream.html#_closed
Attribute
Instance Variable
PUBLIC
Whether this resource has completed its close lifecycle.
-
orionis.mcp.streams.OwnedStream._cleanup
orionis.mcp.streams.OwnedStream.html#_cleanup
Attribute
Instance Variable
PUBLIC
Cleanup task shared by callers closing the owned stream.
-
orionis.mcp.streams.OwnedStream.__aiter__
orionis.mcp.streams.OwnedStream.html#__aiter__
Function
Method
PUBLIC
Return this stream as its single-consumer asynchronous iterator.
-
orionis.mcp.streams.OwnedStream.__anext__
orionis.mcp.streams.OwnedStream.html#__anext__
Function
Method
PUBLIC
Return the next source item and close on exhaustion or failure.
-
orionis.mcp.streams.OwnedStream.aclose
orionis.mcp.streams.OwnedStream.html#aclose
Function
Method
PUBLIC
Await one shared cleanup task across repeated close calls.
-
orionis.mcp.streams.OwnedStream._close
orionis.mcp.streams.OwnedStream.html#_close
Function
Method
PUBLIC
Share cleanup while transferring its primary incident to the owned task.
-
orionis.mcp.streams.OwnedStream._closeOwned
orionis.mcp.streams.OwnedStream.html#_closeOwned
Function
Method
PUBLIC
Close the source before releasing its nested owner.
-
orionis.mcp.dispatcher.TransportName
orionis.mcp.dispatcher.html#TransportName
Attribute
Type Alias
PUBLIC
Type alias for Literal['http', 'stdio', 'test'].
-
orionis.mcp.dispatcher._CURSOR_FIELDS
orionis.mcp.dispatcher.html#_CURSOR_FIELDS
Attribute
Constant
PUBLIC
Cursor fields value used by dispatcher.
-
orionis.mcp.dispatcher._MAX_COMPLETIONS
orionis.mcp.dispatcher.html#_MAX_COMPLETIONS
Attribute
Constant
PUBLIC
Max completions value used by dispatcher.
-
orionis.mcp.dispatcher._DISCOVER_METHOD
orionis.mcp.dispatcher.html#_DISCOVER_METHOD
Attribute
Constant
PUBLIC
server/discover.
-
orionis.mcp.dispatcher._TOOL_METHOD
orionis.mcp.dispatcher.html#_TOOL_METHOD
Attribute
Constant
PUBLIC
tools/call.
-
orionis.mcp.dispatcher._PROMPT_METHOD
orionis.mcp.dispatcher.html#_PROMPT_METHOD
Attribute
Constant
PUBLIC
prompts/get.
-
orionis.mcp.dispatcher._INTERNAL_ERROR
orionis.mcp.dispatcher.html#_INTERNAL_ERROR
Attribute
Constant
PUBLIC
Internal error.
-
orionis.mcp.dispatcher._INTERNAL_ERROR_CODE
orionis.mcp.dispatcher.html#_INTERNAL_ERROR_CODE
Attribute
Constant
PUBLIC
JSON-RPC code identifying an unexpected application failure.
-
orionis.mcp.dispatcher._UNAVAILABLE_STATUS
orionis.mcp.dispatcher.html#_UNAVAILABLE_STATUS
Attribute
Constant
PUBLIC
Expected admission rejection when bounded server capacity is unavailable.
-
orionis.mcp.dispatcher._RESULT_TYPES
orionis.mcp.dispatcher.html#_RESULT_TYPES
Attribute
Constant
PUBLIC
Result types definitions used by dispatcher.
-
orionis.mcp.dispatcher.DispatchResult
orionis.mcp.dispatcher.DispatchResult.html
Class
Class
PUBLIC
Encoded JSON or a lazy stream of encoded notifications and final result.
-
orionis.mcp.dispatcher.DispatchResult.body
orionis.mcp.dispatcher.DispatchResult.html#body
Attribute
Class Variable
PUBLIC
HTTP response body or encoded payload returned to the client.
-
orionis.mcp.dispatcher.DispatchResult.status
orionis.mcp.dispatcher.DispatchResult.html#status
Attribute
Class Variable
PUBLIC
Status value used by DispatchResult.
-
orionis.mcp.dispatcher.DispatchResult.streaming
orionis.mcp.dispatcher.DispatchResult.html#streaming
Attribute
Property
PUBLIC
Check whether the body requires streaming and request-scope retention.
-
orionis.mcp.dispatcher.McpDispatcher
orionis.mcp.dispatcher.McpDispatcher.html
Class
Class
PUBLIC
Perform no connection negotiation and retain no request or identity.
-
orionis.mcp.dispatcher.McpDispatcher.__slots__
orionis.mcp.dispatcher.McpDispatcher.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.mcp.dispatcher.McpDispatcher.__init__
orionis.mcp.dispatcher.McpDispatcher.html#__init__
Function
Method
PUBLIC
Bind compiled server metadata and shared services for stateless dispatch.
-
orionis.mcp.dispatcher.McpDispatcher.app
orionis.mcp.dispatcher.McpDispatcher.html#app
Attribute
Instance Variable
PUBLIC
Application container supplying configuration and dependencies.
-
orionis.mcp.dispatcher.McpDispatcher.server
orionis.mcp.dispatcher.McpDispatcher.html#server
Attribute
Instance Variable
PUBLIC
Precompiled metadata shared by request executions.
-
orionis.mcp.dispatcher.McpDispatcher.config
orionis.mcp.dispatcher.McpDispatcher.html#config
Attribute
Instance Variable
PUBLIC
Validated configuration controlling this component.
-
orionis.mcp.dispatcher.McpDispatcher.bus
orionis.mcp.dispatcher.McpDispatcher.html#bus
Attribute
Instance Variable
PUBLIC
Subscription service delivering server changes.
-
orionis.mcp.dispatcher.McpDispatcher._extensions
orionis.mcp.dispatcher.McpDispatcher.html#_extensions
Attribute
Instance Variable
PUBLIC
Extensions registered for this server or transport.
-
orionis.mcp.dispatcher.McpDispatcher._server_id
orionis.mcp.dispatcher.McpDispatcher.html#_server_id
Attribute
Instance Variable
PUBLIC
Stable server identifier used to bind protected request state.
-
orionis.mcp.dispatcher.McpDispatcher._list_sources
orionis.mcp.dispatcher.McpDispatcher.html#_list_sources
Attribute
Instance Variable
PUBLIC
Compiled primitive collections used by listing operations.
-
orionis.mcp.dispatcher.McpDispatcher.decode
orionis.mcp.dispatcher.McpDispatcher.html#decode
Function
Method
PUBLIC
Validate core request metadata and decode method-specific parameters.
-
orionis.mcp.dispatcher.McpDispatcher.handle
orionis.mcp.dispatcher.McpDispatcher.html#handle
Function
Method
PUBLIC
Decode and dispatch one envelope without adding transport framing.
-
orionis.mcp.dispatcher.McpDispatcher.dispatch
orionis.mcp.dispatcher.McpDispatcher.html#dispatch
Function
Method
PUBLIC
Execute a decoded request with shared policy checks and dependency bindings.
-
orionis.mcp.dispatcher.McpDispatcher._request
orionis.mcp.dispatcher.McpDispatcher.html#_request
Function
Method
PUBLIC
Build request context from the current envelope and typed parameters.
-
orionis.mcp.dispatcher.McpDispatcher._execute
orionis.mcp.dispatcher.McpDispatcher.html#_execute
Function
Method
PUBLIC
Route a decoded request to a core method, extension, or primitive.
-
orionis.mcp.dispatcher.McpDispatcher._extension
orionis.mcp.dispatcher.McpDispatcher.html#_extension
Function
Method
PUBLIC
Invoke an extension only when the client advertises its capability.
-
orionis.mcp.dispatcher.McpDispatcher._resource
orionis.mcp.dispatcher.McpDispatcher.html#_resource
Function
Method
PUBLIC
Resolve exact resource URIs before matching compiled URI templates.
-
orionis.mcp.dispatcher.McpDispatcher._access
orionis.mcp.dispatcher.McpDispatcher.html#_access
Function
Method
PUBLIC
Resolve a primitive handler and apply its request-specific access hooks.
-
orionis.mcp.dispatcher.McpDispatcher._invoke
orionis.mcp.dispatcher.McpDispatcher.html#_invoke
Function
Method
PUBLIC
Invoke a primitive through the shared policy and validation pipeline.
-
orionis.mcp.dispatcher.McpDispatcher._normalize
orionis.mcp.dispatcher.McpDispatcher.html#_normalize
Function
Method
PUBLIC
Normalize developer output into the requested method's validated result.
-
orionis.mcp.dispatcher.McpDispatcher._normalizeTyped
orionis.mcp.dispatcher.McpDispatcher.html#_normalizeTyped
Function
Method
PUBLIC
Validate an existing protocol result without changing observation order.
-
orionis.mcp.dispatcher.McpDispatcher._stream
orionis.mcp.dispatcher.McpDispatcher.html#_stream
Function
Method
PUBLIC
Yield progress notifications and a result with bounded response buffering.
-
orionis.mcp.dispatcher.McpDispatcher._streamError
orionis.mcp.dispatcher.McpDispatcher.html#_streamError
Function
Method
PUBLIC
Encode a sanitized result or protocol error for a failed primitive stream.
-
orionis.mcp.dispatcher.McpDispatcher._finishStream
orionis.mcp.dispatcher.McpDispatcher.html#_finishStream
Function
Method
PUBLIC
Close a primitive stream without replacing an escaping primary failure.
-
orionis.mcp.dispatcher.McpDispatcher._list
orionis.mcp.dispatcher.McpDispatcher.html#_list
Function
Method
PUBLIC
Build a bounded listing page after per-request access checks.
-
orionis.mcp.dispatcher.McpDispatcher._cursor
orionis.mcp.dispatcher.McpDispatcher.html#_cursor
Function
Static Method
PUBLIC
Decode and validate a stateless cursor for the requested listing method.
-
orionis.mcp.dispatcher.McpDispatcher._cache
orionis.mcp.dispatcher.McpDispatcher.html#_cache
Function
Method
PUBLIC
Select cache hints and disable caching for requests carrying retry state.
-
orionis.mcp.dispatcher.McpDispatcher._encode
orionis.mcp.dispatcher.McpDispatcher.html#_encode
Function
Method
PUBLIC
Validate a result, attach server metadata, and encode its response.
-
orionis.mcp.dispatcher.McpDispatcher._complete
orionis.mcp.dispatcher.McpDispatcher.html#_complete
Function
Method
PUBLIC
Resolve completion values through the referenced primitive's access hooks.
-
orionis.mcp.dispatcher.McpDispatcher._supports
orionis.mcp.dispatcher.McpDispatcher.html#_supports
Function
Method
PUBLIC
Check whether a compiled capability explicitly enables a feature.
-
orionis.mcp.dispatcher.McpDispatcher._listen
orionis.mcp.dispatcher.McpDispatcher.html#_listen
Function
Method
PUBLIC
Create a subscription stream from supported, currently authorized filters.
-
orionis.mcp.dispatcher.McpDispatcher._subscriptionResource
orionis.mcp.dispatcher.McpDispatcher.html#_subscriptionResource
Function
Method
PUBLIC
Check subscription access with a temporary resource-specific context.
-
orionis.mcp.dispatcher.McpDispatcher._subscriptionNotification
orionis.mcp.dispatcher.McpDispatcher.html#_subscriptionNotification
Function
Static Method
PUBLIC
Encode one change event while retaining subscription metadata ownership.
-
orionis.mcp.dispatcher.McpDispatcher._subscriptionStream
orionis.mcp.dispatcher.McpDispatcher.html#_subscriptionStream
Function
Method
PUBLIC
Yield an acknowledgement, subscription events, and transport keepalives.
-
orionis.mcp.dispatcher.McpDispatcher._finishSubscription
orionis.mcp.dispatcher.McpDispatcher.html#_finishSubscription
Function
Method
PUBLIC
Join pending subscription work and close the owned event source.
-
orionis.mcp.dispatcher.McpDispatcher._catalog
orionis.mcp.dispatcher.McpDispatcher.html#_catalog
Function
Method
PUBLIC
Run a synthetic catalog search or batch-execution operation.
-
orionis.mcp.dispatcher.McpDispatcher._searchCatalog
orionis.mcp.dispatcher.McpDispatcher.html#_searchCatalog
Function
Method
PUBLIC
Rank catalog text and return only request-accessible tool matches.
-
orionis.mcp.dispatcher.McpDispatcher._executeCatalog
orionis.mcp.dispatcher.McpDispatcher.html#_executeCatalog
Function
Method
PUBLIC
Execute catalog tool calls sequentially with shared validation and access.
-
orionis.mcp.dispatcher.McpDispatcher._catalogResult
orionis.mcp.dispatcher.McpDispatcher.html#_catalogResult
Function
Static Method
PUBLIC
Extract a catalog result while discarding intermediate stream notifications.
-
orionis.mcp.dispatcher.McpDispatcher._report
orionis.mcp.dispatcher.McpDispatcher.html#_report
Function
Method
PUBLIC
Observe a dispatch failure with normalized request and error context.
-
orionis.mcp.dispatcher._close
orionis.mcp.dispatcher.html#_close
Function
Function
PUBLIC
Await a source's asynchronous close hook when one is available.
-
orionis.mcp.transport.policy._REDIRECTION_START
orionis.mcp.transport.policy.html#_REDIRECTION_START
Attribute
Constant
PUBLIC
Redirection start value used by policy.
-
orionis.mcp.transport.policy._CLIENT_ERROR_START
orionis.mcp.transport.policy.html#_CLIENT_ERROR_START
Attribute
Constant
PUBLIC
Client error start value used by policy.
-
orionis.mcp.transport.policy._SERVER_ERROR_START
orionis.mcp.transport.policy.html#_SERVER_ERROR_START
Attribute
Constant
PUBLIC
Server error start value used by policy.
-
orionis.mcp.transport.policy._JSON_MEDIA_TYPE
orionis.mcp.transport.policy.html#_JSON_MEDIA_TYPE
Attribute
Constant
PUBLIC
application/json.
-
orionis.mcp.transport.policy._EXCEPTION_STATUS
orionis.mcp.transport.policy.html#_EXCEPTION_STATUS
Attribute
Constant
PUBLIC
Exception status definitions used by policy.
-
orionis.mcp.transport.policy.McpProtocolResponse
orionis.mcp.transport.policy.McpProtocolResponse.html
Class
Class
PUBLIC
Mark encoded protocol output to keep adaptation constant-time.
-
orionis.mcp.transport.policy.McpProtocolResponse.__slots__
orionis.mcp.transport.policy.McpProtocolResponse.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.mcp.transport.policy.McpProtocolResponse.__init__
orionis.mcp.transport.policy.McpProtocolResponse.html#__init__
Function
Method
PUBLIC
Keep preencoded bytes while emitting mandatory JSON response metadata.
-
orionis.mcp.transport.policy.origin_allowed
orionis.mcp.transport.policy.html#origin_allowed
Function
Function
PUBLIC
Accept absent origins and one explicitly configured serialized origin.
-
orionis.mcp.transport.policy._error
orionis.mcp.transport.policy.html#_error
Function
Function
PUBLIC
Use public status names rather than exception messages or middleware bodies.
-
orionis.mcp.transport.policy.McpHttpPolicy
orionis.mcp.transport.policy.McpHttpPolicy.html
Class
Class
PUBLIC
Enforce MCP origin and error rules around the existing HTTP pipeline.
-
orionis.mcp.transport.policy.McpHttpPolicy.__slots__
orionis.mcp.transport.policy.McpHttpPolicy.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.mcp.transport.policy.McpHttpPolicy.monitor_disconnects
orionis.mcp.transport.policy.McpHttpPolicy.html#monitor_disconnects
Attribute
Class Variable
PUBLIC
Monitor disconnects flag used by McpHttpPolicy.
-
orionis.mcp.transport.policy.McpHttpPolicy.__init__
orionis.mcp.transport.policy.McpHttpPolicy.html#__init__
Function
Method
PUBLIC
Compile an origin set without capturing any request or identity.
-
orionis.mcp.transport.policy.McpHttpPolicy._app
orionis.mcp.transport.policy.McpHttpPolicy.html#_app
Attribute
Instance Variable
PUBLIC
Application container supplying configuration and dependencies.
-
orionis.mcp.transport.policy.McpHttpPolicy._origins
orionis.mcp.transport.policy.McpHttpPolicy.html#_origins
Attribute
Instance Variable
PUBLIC
Origins produced by frozenset.
-
orionis.mcp.transport.policy.McpHttpPolicy.before
orionis.mcp.transport.policy.McpHttpPolicy.html#before
Function
Method
PUBLIC
Validate Origin for preflight and unsupported methods as well as POST.
-
orionis.mcp.transport.policy.McpHttpPolicy.response
orionis.mcp.transport.policy.McpHttpPolicy.html#response
Function
Method
PUBLIC
Preserve protocol output and replace browser bodies with safe errors.
-
orionis.mcp.transport.policy.McpHttpPolicy.isExpectedFailure
orionis.mcp.transport.policy.McpHttpPolicy.html#isExpectedFailure
Function
Method
PUBLIC
Identify expected MCP protocol and mapped HTTP policy failures.
-
orionis.mcp.transport.policy.McpHttpPolicy.exception
orionis.mcp.transport.policy.McpHttpPolicy.html#exception
Function
Method
PUBLIC
Report failures without calling the native HTML/debug presenter.
-
orionis.mcp.transport.http._JSON_MEDIA_TYPE
orionis.mcp.transport.http.html#_JSON_MEDIA_TYPE
Attribute
Constant
PUBLIC
application/json.
-
orionis.mcp.transport.http._ACCEPT_MEDIA_TYPES
orionis.mcp.transport.http.html#_ACCEPT_MEDIA_TYPES
Attribute
Constant
PUBLIC
Accept media types used by http.
-
orionis.mcp.transport.http._EventFrames
orionis.mcp.transport.http._EventFrames.html
Class
Class
PUBLIC
Own an MCP byte iterator even if the HTTP stream is never started.
-
orionis.mcp.transport.http._EventFrames.__slots__
orionis.mcp.transport.http._EventFrames.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.mcp.transport.http._EventFrames.__init__
orionis.mcp.transport.http._EventFrames.html#__init__
Function
Method
PUBLIC
Transfer iterator and admission-slot ownership to the response.
-
orionis.mcp.transport.http._EventFrames._source
orionis.mcp.transport.http._EventFrames.html#_source
Attribute
Instance Variable
PUBLIC
Source whose values or lifecycle are consumed by this operation.
-
orionis.mcp.transport.http._EventFrames._release
orionis.mcp.transport.http._EventFrames.html#_release
Attribute
Instance Variable
PUBLIC
Value supplied for release.
-
orionis.mcp.transport.http._EventFrames.__aiter__
orionis.mcp.transport.http._EventFrames.html#__aiter__
Function
Method
PUBLIC
Return this owned, single-use event source.
-
orionis.mcp.transport.http._EventFrames.__anext__
orionis.mcp.transport.http._EventFrames.html#__anext__
Function
Method
PUBLIC
Frame one message only when the native HTTP adapter is ready.
-
orionis.mcp.transport.http._EventFrames.aclose
orionis.mcp.transport.http._EventFrames.html#aclose
Function
Method
PUBLIC
Close the producer and release admission before scope disposal.
-
orionis.mcp.transport.http._accept_quality
orionis.mcp.transport.http.html#_accept_quality
Function
Function
PUBLIC
Read the final quality parameter of one Accept representation.
-
orionis.mcp.transport.http._accepts_both
orionis.mcp.transport.http.html#_accepts_both
Function
Function
PUBLIC
Require explicitly acceptable JSON and event-stream representations.
-
orionis.mcp.transport.http.McpHttpTransport
orionis.mcp.transport.http.McpHttpTransport.html
Class
Class
PUBLIC
Serve a registered endpoint without owning routes, sessions or identities.
-
orionis.mcp.transport.http.McpHttpTransport.__slots__
orionis.mcp.transport.http.McpHttpTransport.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.mcp.transport.http.McpHttpTransport.__init__
orionis.mcp.transport.http.McpHttpTransport.html#__init__
Function
Method
PUBLIC
Retain immutable server metadata and one shared protocol dispatcher.
-
orionis.mcp.transport.http.McpHttpTransport._app
orionis.mcp.transport.http.McpHttpTransport.html#_app
Attribute
Instance Variable
PUBLIC
Application owning runtime failure reporting.
-
orionis.mcp.transport.http.McpHttpTransport._compiled
orionis.mcp.transport.http.McpHttpTransport.html#_compiled
Attribute
Instance Variable
PUBLIC
Precompiled metadata shared by request executions.
-
orionis.mcp.transport.http.McpHttpTransport._config
orionis.mcp.transport.http.McpHttpTransport.html#_config
Attribute
Instance Variable
PUBLIC
Validated configuration controlling this component.
-
orionis.mcp.transport.http.McpHttpTransport._dispatcher
orionis.mcp.transport.http.McpHttpTransport.html#_dispatcher
Attribute
Instance Variable
PUBLIC
Dispatcher produced by McpDispatcher.
-
orionis.mcp.transport.http.McpHttpTransport._origins
orionis.mcp.transport.http.McpHttpTransport.html#_origins
Attribute
Instance Variable
PUBLIC
Origins produced by frozenset.
-
orionis.mcp.transport.http.McpHttpTransport._active
orionis.mcp.transport.http.McpHttpTransport.html#_active
Attribute
Instance Variable
PUBLIC
Active value used by McpHttpTransport.
-
orionis.mcp.transport.http.McpHttpTransport._release
orionis.mcp.transport.http.McpHttpTransport.html#_release
Function
Method
PUBLIC
Release a single request or response-stream admission slot.
-
orionis.mcp.transport.http.McpHttpTransport._validateHttp
orionis.mcp.transport.http.McpHttpTransport.html#_validateHttp
Function
Method
PUBLIC
Reject origins and unsupported media types before reading a body.
-
orionis.mcp.transport.http.McpHttpTransport._read
orionis.mcp.transport.http.McpHttpTransport.html#_read
Function
Method
PUBLIC
Bound the native body stream before allocating the complete message.
-
orionis.mcp.transport.http.McpHttpTransport._params
orionis.mcp.transport.http.McpHttpTransport.html#_params
Function
Method
PUBLIC
Decode method parameters and validate compiled tool parameter headers.
-
orionis.mcp.transport.http.McpHttpTransport.handle
orionis.mcp.transport.http.McpHttpTransport.html#handle
Function
Method
PUBLIC
Validate HTTP metadata, dispatch once, and return native response objects.
-
orionis.mcp.transport.http.McpHttpTransport._reportRequestFailure
orionis.mcp.transport.http.McpHttpTransport.html#_reportRequestFailure
Function
Method
PUBLIC
Report an HTTP request failure without passing an unset identifier.
-
orionis.mcp.transport.http.McpHttpTransport._streamResponse
orionis.mcp.transport.http.McpHttpTransport.html#_streamResponse
Function
Method
PUBLIC
Transfer event-source ownership to a response or clean up on failure.
-
orionis.mcp.transport.http.McpHttpTransport._closeFailedResponse
orionis.mcp.transport.http.McpHttpTransport.html#_closeFailedResponse
Function
Method
PUBLIC
Close failed-response events without suppressing cleanup interruptions.
-
orionis.mcp.transport.http.McpHttpTransport._error
orionis.mcp.transport.http.McpHttpTransport.html#_error
Function
Method
PUBLIC
Encode a sanitized protocol error with its required HTTP status.
-
orionis.mcp.manager._LOCAL_NAME
orionis.mcp.manager.html#_LOCAL_NAME
Attribute
Constant
PUBLIC
Compiled pattern used to recognize local name.
-
orionis.mcp.manager.McpManager
orionis.mcp.manager.McpManager.html
Class
Class
PUBLIC
Own one compiled registry shared by native HTTP, STDIO, DI and the facade.
-
orionis.mcp.manager.McpManager.__slots__
orionis.mcp.manager.McpManager.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.mcp.manager.McpManager.__init__
orionis.mcp.manager.McpManager.html#__init__
Function
Method
PUBLIC
Capture application services without opening transports or performing I/O.
-
orionis.mcp.manager.McpManager._app
orionis.mcp.manager.McpManager.html#_app
Attribute
Instance Variable
PUBLIC
Application container supplying configuration and dependencies.
-
orionis.mcp.manager.McpManager._router
orionis.mcp.manager.McpManager.html#_router
Attribute
Instance Variable
PUBLIC
Value supplied for router.
-
orionis.mcp.manager.McpManager._config
orionis.mcp.manager.McpManager.html#_config
Attribute
Instance Variable
PUBLIC
Validated configuration controlling this component.
-
orionis.mcp.manager.McpManager._bus
orionis.mcp.manager.McpManager.html#_bus
Attribute
Instance Variable
PUBLIC
Value supplied for bus.
-
orionis.mcp.manager.McpManager._compiled
orionis.mcp.manager.McpManager.html#_compiled
Attribute
Instance Variable
PUBLIC
Compiled server metadata indexed by the original server class.
-
orionis.mcp.manager.McpManager._web
orionis.mcp.manager.McpManager.html#_web
Attribute
Instance Variable
PUBLIC
HTTP routes, compiled servers and transports indexed by endpoint path.
-
orionis.mcp.manager.McpManager._local
orionis.mcp.manager.McpManager.html#_local
Attribute
Instance Variable
PUBLIC
Compiled servers indexed by their local STDIO registration names.
-
orionis.mcp.manager.McpManager._compile
orionis.mcp.manager.McpManager.html#_compile
Function
Method
PUBLIC
Validate and compile a server exactly once per application manager.
-
orionis.mcp.manager.McpManager.web
orionis.mcp.manager.McpManager.html#web
Function
Method
PUBLIC
Register one native POST endpoint with API authentication semantics.
-
orionis.mcp.manager.McpManager.local
orionis.mcp.manager.McpManager.html#local
Function
Method
PUBLIC
Register an explicit handle without accepting dynamic module imports.
-
orionis.mcp.manager.McpManager.getWebServer
orionis.mcp.manager.McpManager.html#getWebServer
Function
Method
PUBLIC
Return compiled HTTP metadata by normalized native route path.
-
orionis.mcp.manager.McpManager.finalizeRoutes
orionis.mcp.manager.McpManager.html#finalizeRoutes
Function
Method
PUBLIC
Index final fluent paths once at boot, preserving constant-time dispatch.
-
orionis.mcp.manager.McpManager.getLocalServer
orionis.mcp.manager.McpManager.html#getLocalServer
Function
Method
PUBLIC
Return compiled local metadata by its configured handle.
-
orionis.mcp.manager.McpManager.servers
orionis.mcp.manager.McpManager.html#servers
Function
Method
PUBLIC
Return an immutable transport/address/declaration inventory.
-
orionis.mcp.manager.McpManager.dispatchHttp
orionis.mcp.manager.McpManager.html#dispatchHttp
Function
Method
PUBLIC
Use the same server and invoker reached by its local registration.
-
orionis.mcp.manager.McpManager.startLocal
orionis.mcp.manager.McpManager.html#startLocal
Function
Method
PUBLIC
Serve only a configured local handle using native standard streams.
-
orionis.mcp.manager.McpManager.toolsChanged
orionis.mcp.manager.McpManager.html#toolsChanged
Function
Method
PUBLIC
Publish a catalog change without retaining the current identity.
-
orionis.mcp.manager.McpManager.promptsChanged
orionis.mcp.manager.McpManager.html#promptsChanged
Function
Method
PUBLIC
Publish a prompt catalog change to the matching server's listeners.
-
orionis.mcp.manager.McpManager.resourcesChanged
orionis.mcp.manager.McpManager.html#resourcesChanged
Function
Method
PUBLIC
Publish a resource catalog change to the matching server's listeners.
-
orionis.mcp.manager.McpManager.resourceUpdated
orionis.mcp.manager.McpManager.html#resourceUpdated
Function
Method
PUBLIC
Publish one changed URI without resolving its content or identity.
-
orionis.mcp.manager.McpManager._publish
orionis.mcp.manager.McpManager.html#_publish
Function
Method
PUBLIC
Scope events to a declaration already registered in this application.
-
orionis.mcp.manager.McpManager.shutdown
orionis.mcp.manager.McpManager.html#shutdown
Function
Method
PUBLIC
Wake subscriptions so their request owners can complete and clean up.
-
orionis.mcp.subscriptions.event_bus.Change
orionis.mcp.subscriptions.event_bus.html#Change
Attribute
Type Alias
PUBLIC
Type alias for tuple[str, str | None].
-
orionis.mcp.subscriptions.event_bus._Listener
orionis.mcp.subscriptions.event_bus._Listener.html
Class
Class
PUBLIC
Retain only a server key, accepted filter and bounded pending changes.
-
orionis.mcp.subscriptions.event_bus._Listener.__slots__
orionis.mcp.subscriptions.event_bus._Listener.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.mcp.subscriptions.event_bus._Listener.__init__
orionis.mcp.subscriptions.event_bus._Listener.html#__init__
Function
Method
PUBLIC
Create an empty process-local listener.
-
orionis.mcp.subscriptions.event_bus._Listener.server
orionis.mcp.subscriptions.event_bus._Listener.html#server
Attribute
Instance Variable
PUBLIC
Value supplied for server.
-
orionis.mcp.subscriptions.event_bus._Listener.filters
orionis.mcp.subscriptions.event_bus._Listener.html#filters
Attribute
Instance Variable
PUBLIC
Value supplied for filters.
-
orionis.mcp.subscriptions.event_bus._Listener.pending
orionis.mcp.subscriptions.event_bus._Listener.html#pending
Attribute
Instance Variable
PUBLIC
Work that has been admitted and is awaiting completion.
-
orionis.mcp.subscriptions.event_bus._Listener.ready
orionis.mcp.subscriptions.event_bus._Listener.html#ready
Attribute
Instance Variable
PUBLIC
Whether backend initialization has completed.
-
orionis.mcp.subscriptions.event_bus._Listener.closed
orionis.mcp.subscriptions.event_bus._Listener.html#closed
Attribute
Instance Variable
PUBLIC
Closed flag used by _Listener.
-
orionis.mcp.subscriptions.event_bus._Listener.accepts
orionis.mcp.subscriptions.event_bus._Listener.html#accepts
Function
Method
PUBLIC
Match only notification types explicitly requested by the client.
-
orionis.mcp.subscriptions.event_bus.InMemoryMcpEventBus
orionis.mcp.subscriptions.event_bus.InMemoryMcpEventBus.html
Class
Class
PUBLIC
Coalesce duplicate changes and close overloaded listeners gracefully.
-
orionis.mcp.subscriptions.event_bus.InMemoryMcpEventBus.__slots__
orionis.mcp.subscriptions.event_bus.InMemoryMcpEventBus.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.mcp.subscriptions.event_bus.InMemoryMcpEventBus.__init__
orionis.mcp.subscriptions.event_bus.InMemoryMcpEventBus.html#__init__
Function
Method
PUBLIC
Set finite listener and per-listener buffer budgets.
-
orionis.mcp.subscriptions.event_bus.InMemoryMcpEventBus._size
orionis.mcp.subscriptions.event_bus.InMemoryMcpEventBus.html#_size
Attribute
Instance Variable
PUBLIC
Value supplied for buffer_size.
-
orionis.mcp.subscriptions.event_bus.InMemoryMcpEventBus._max_listeners
orionis.mcp.subscriptions.event_bus.InMemoryMcpEventBus.html#_max_listeners
Attribute
Instance Variable
PUBLIC
Value supplied for max_listeners.
-
orionis.mcp.subscriptions.event_bus.InMemoryMcpEventBus._listeners
orionis.mcp.subscriptions.event_bus.InMemoryMcpEventBus.html#_listeners
Attribute
Instance Variable
PUBLIC
Listeners produced by set.
-
orionis.mcp.subscriptions.event_bus.InMemoryMcpEventBus._closed
orionis.mcp.subscriptions.event_bus.InMemoryMcpEventBus.html#_closed
Attribute
Instance Variable
PUBLIC
Whether this resource has completed its close lifecycle.
-
orionis.mcp.subscriptions.event_bus.InMemoryMcpEventBus.listenerCount
orionis.mcp.subscriptions.event_bus.InMemoryMcpEventBus.html#listenerCount
Attribute
Property
PUBLIC
Expose aggregate lifecycle diagnostics, without subscriber identity.
-
orionis.mcp.subscriptions.event_bus.InMemoryMcpEventBus.listen
orionis.mcp.subscriptions.event_bus.InMemoryMcpEventBus.html#listen
Function
Method
PUBLIC
Register synchronously so publication cannot race acknowledgment.
-
orionis.mcp.subscriptions.event_bus.InMemoryMcpEventBus.publish
orionis.mcp.subscriptions.event_bus.InMemoryMcpEventBus.html#publish
Function
Method
PUBLIC
Publish without awaiting a slow client or creating producer tasks.
-
orionis.mcp.subscriptions.event_bus.InMemoryMcpEventBus.remove
orionis.mcp.subscriptions.event_bus.InMemoryMcpEventBus.html#remove
Function
Method
PUBLIC
Release an iterator even if it was closed before its first read.
-
orionis.mcp.subscriptions.event_bus.InMemoryMcpEventBus.shutdown
orionis.mcp.subscriptions.event_bus.InMemoryMcpEventBus.html#shutdown
Function
Method
PUBLIC
Stop admission and wake all consumers to send graceful completion.
-
orionis.mcp.subscriptions.event_bus._Subscription
orionis.mcp.subscriptions.event_bus._Subscription.html
Class
Class
PUBLIC
An explicitly closable iterator, including before first iteration.
-
orionis.mcp.subscriptions.event_bus._Subscription.__slots__
orionis.mcp.subscriptions.event_bus._Subscription.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.mcp.subscriptions.event_bus._Subscription.__init__
orionis.mcp.subscriptions.event_bus._Subscription.html#__init__
Function
Method
PUBLIC
Own exactly one listener registration.
-
orionis.mcp.subscriptions.event_bus._Subscription._bus
orionis.mcp.subscriptions.event_bus._Subscription.html#_bus
Attribute
Instance Variable
PUBLIC
Value supplied for bus.
-
orionis.mcp.subscriptions.event_bus._Subscription._listener
orionis.mcp.subscriptions.event_bus._Subscription.html#_listener
Attribute
Instance Variable
PUBLIC
Value supplied for listener.
-
orionis.mcp.subscriptions.event_bus._Subscription.__aiter__
orionis.mcp.subscriptions.event_bus._Subscription.html#__aiter__
Function
Method
PUBLIC
Return the subscription iterator.
-
orionis.mcp.subscriptions.event_bus._Subscription.__anext__
orionis.mcp.subscriptions.event_bus._Subscription.html#__anext__
Function
Method
PUBLIC
Wait without losing wakeups; propagate cancellation after cleanup.
-
orionis.mcp.subscriptions.event_bus._Subscription.aclose
orionis.mcp.subscriptions.event_bus._Subscription.html#aclose
Function
Method
PUBLIC
Release request-owned resources immediately.
-
orionis.mcp.provider.McpProvider
orionis.mcp.provider.McpProvider.html
Class
Class
PUBLIC
Register one manager and load declarations before either runtime starts.
-
orionis.mcp.provider.McpProvider.__slots__
orionis.mcp.provider.McpProvider.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.mcp.provider.McpProvider.register
orionis.mcp.provider.McpProvider.html#register
Function
Method
PUBLIC
Bind validated configuration and bounded services without performing I/O.
-
orionis.mcp.provider.McpProvider._routes_loaded
orionis.mcp.provider.McpProvider.html#_routes_loaded
Attribute
Instance Variable
PUBLIC
Routes loaded flag used by McpProvider.
-
orionis.mcp.provider.McpProvider.boot
orionis.mcp.provider.McpProvider.html#boot
Function
Method
PUBLIC
Load AI registrations for HTTP and CLI, including warm HTTP route caches.
-
orionis.mcp.routing.McpController
orionis.mcp.routing.McpController.html
Class
Class
PUBLIC
An importable native HTTP handler, including after route-cache restore.
-
orionis.mcp.routing.McpController.__slots__
orionis.mcp.routing.McpController.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.mcp.routing.McpController.handle
orionis.mcp.routing.McpController.html#handle
Function
Method
PUBLIC
Delegate the complete MCP envelope to the registered transport.
-
orionis.mcp.transport.standard_io.StandardReader
orionis.mcp.transport.standard_io.StandardReader.html
Class
Class
PUBLIC
Read at most one queued frame using an interruptible async queue boundary.
-
orionis.mcp.transport.standard_io.StandardReader.__slots__
orionis.mcp.transport.standard_io.StandardReader.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.mcp.transport.standard_io.StandardReader.__init__
orionis.mcp.transport.standard_io.StandardReader.html#__init__
Function
Method
PUBLIC
Start a daemon reader with bounded delivery to the running event loop.
-
orionis.mcp.transport.standard_io.StandardReader._stream
orionis.mcp.transport.standard_io.StandardReader.html#_stream
Attribute
Instance Variable
PUBLIC
Value supplied for stream.
-
orionis.mcp.transport.standard_io.StandardReader._limit
orionis.mcp.transport.standard_io.StandardReader.html#_limit
Attribute
Instance Variable
PUBLIC
Value supplied for limit.
-
orionis.mcp.transport.standard_io.StandardReader._loop
orionis.mcp.transport.standard_io.StandardReader.html#_loop
Attribute
Instance Variable
PUBLIC
Loop produced by asyncio.get_running_loop.
-
orionis.mcp.transport.standard_io.StandardReader._runtime
orionis.mcp.transport.standard_io.StandardReader.html#_runtime
Attribute
Instance Variable
PUBLIC
Runtime retained for failures after reader cancellation.
-
orionis.mcp.transport.standard_io.StandardReader._failure
orionis.mcp.transport.standard_io.StandardReader.html#_failure
Attribute
Instance Variable
PUBLIC
Read failure awaiting either delivery or shutdown observation.
-
orionis.mcp.transport.standard_io.StandardReader._failure_lock
orionis.mcp.transport.standard_io.StandardReader.html#_failure_lock
Attribute
Instance Variable
PUBLIC
Transfer error ownership once between the daemon and event loop.
-
orionis.mcp.transport.standard_io.StandardReader._queue
orionis.mcp.transport.standard_io.StandardReader.html#_queue
Attribute
Instance Variable
PUBLIC
Name of the queue receiving or storing the job.
-
orionis.mcp.transport.standard_io.StandardReader._closed
orionis.mcp.transport.standard_io.StandardReader.html#_closed
Attribute
Instance Variable
PUBLIC
Whether this resource has completed its close lifecycle.
-
orionis.mcp.transport.standard_io.StandardReader._pending
orionis.mcp.transport.standard_io.StandardReader.html#_pending
Attribute
Instance Variable
PUBLIC
Work that has been admitted and is awaiting completion.
-
orionis.mcp.transport.standard_io.StandardReader._offer
orionis.mcp.transport.standard_io.StandardReader.html#_offer
Function
Method
PUBLIC
Offer one input item with backpressure on the reader's daemon thread.
-
orionis.mcp.transport.standard_io.StandardReader._read
orionis.mcp.transport.standard_io.StandardReader.html#_read
Function
Method
PUBLIC
Read bounded input chunks and discard oversized frame remainders.
-
orionis.mcp.transport.standard_io.StandardReader._drainOversizedFrame
orionis.mcp.transport.standard_io.StandardReader.html#_drainOversizedFrame
Function
Method
PUBLIC
Discard the unread remainder of an oversized input frame.
-
orionis.mcp.transport.standard_io.StandardReader._takeFailure
orionis.mcp.transport.standard_io.StandardReader.html#_takeFailure
Function
Method
PUBLIC
Claim and clear the pending read failure atomically.
-
orionis.mcp.transport.standard_io.StandardReader._reportFailure
orionis.mcp.transport.standard_io.StandardReader.html#_reportFailure
Function
Method
PUBLIC
Claim and observe any unread input failure once.
-
orionis.mcp.transport.standard_io.StandardReader.readline
orionis.mcp.transport.standard_io.StandardReader.html#readline
Function
Method
PUBLIC
Await the next bounded input chunk or propagate a queued read failure.
-
orionis.mcp.transport.standard_io.StandardReader.close
orionis.mcp.transport.standard_io.StandardReader.html#close
Function
Method
PUBLIC
Stop input delivery without waiting for a blocked operating-system read.
-
orionis.mcp.transport.standard_io._finish_write
orionis.mcp.transport.standard_io.html#_finish_write
Function
Function
PUBLIC
Settle a write future on its owning loop or observe a late write error.
-
orionis.mcp.transport.standard_io.StandardWriter
orionis.mcp.transport.standard_io.StandardWriter.html
Class
Class
PUBLIC
Serialize bounded queued output without blocking async cancellation.
-
orionis.mcp.transport.standard_io.StandardWriter.__slots__
orionis.mcp.transport.standard_io.StandardWriter.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.mcp.transport.standard_io.StandardWriter.__init__
orionis.mcp.transport.standard_io.StandardWriter.html#__init__
Function
Method
PUBLIC
Start a daemon writer with a single-slot queue on the running loop.
-
orionis.mcp.transport.standard_io.StandardWriter._stream
orionis.mcp.transport.standard_io.StandardWriter.html#_stream
Attribute
Instance Variable
PUBLIC
Value supplied for stream.
-
orionis.mcp.transport.standard_io.StandardWriter._loop
orionis.mcp.transport.standard_io.StandardWriter.html#_loop
Attribute
Instance Variable
PUBLIC
Loop produced by asyncio.get_running_loop.
-
orionis.mcp.transport.standard_io.StandardWriter._runtime
orionis.mcp.transport.standard_io.StandardWriter.html#_runtime
Attribute
Instance Variable
PUBLIC
Runtime retained for errors after output waiters are cancelled.
-
orionis.mcp.transport.standard_io.StandardWriter._queue
orionis.mcp.transport.standard_io.StandardWriter.html#_queue
Attribute
Instance Variable
PUBLIC
Name of the queue receiving or storing the job.
-
orionis.mcp.transport.standard_io.StandardWriter._closed
orionis.mcp.transport.standard_io.StandardWriter.html#_closed
Attribute
Instance Variable
PUBLIC
Whether this resource has completed its close lifecycle.
-
orionis.mcp.transport.standard_io.StandardWriter._pending
orionis.mcp.transport.standard_io.StandardWriter.html#_pending
Attribute
Instance Variable
PUBLIC
Work that has been admitted and is awaiting completion.
-
orionis.mcp.transport.standard_io.StandardWriter._write
orionis.mcp.transport.standard_io.StandardWriter.html#_write
Function
Method
PUBLIC
Write queued bytes and settle acknowledgements after flushing.
-
orionis.mcp.transport.standard_io.StandardWriter._writeFrame
orionis.mcp.transport.standard_io.StandardWriter.html#_writeFrame
Function
Method
PUBLIC
Complete partial raw-stream writes before flushing one frame.
-
orionis.mcp.transport.standard_io.StandardWriter.write
orionis.mcp.transport.standard_io.StandardWriter.html#write
Function
Method
PUBLIC
Queue unchanged bytes and wait for the output stream to flush them.
-
orionis.mcp.transport.standard_io.StandardWriter.close
orionis.mcp.transport.standard_io.StandardWriter.html#close
Function
Method
PUBLIC
Stop queued output without waiting for a blocked operating-system write.
-
orionis.mcp.transport.stdio.LineReader
orionis.mcp.transport.stdio.LineReader.html
Class
Class
PUBLIC
Provide one bounded input frame or empty bytes at EOF.
-
orionis.mcp.transport.stdio.LineReader.readline
orionis.mcp.transport.stdio.LineReader.html#readline
Function
Method
PUBLIC
Read one newline-delimited wire message.
-
orionis.mcp.transport.stdio.LineWriter
orionis.mcp.transport.stdio.LineWriter.html
Class
Class
PUBLIC
Write a complete message with backpressure.
-
orionis.mcp.transport.stdio.LineWriter.write
orionis.mcp.transport.stdio.LineWriter.html#write
Function
Method
PUBLIC
Deliver a complete frame, including its terminating newline.
-
orionis.mcp.transport.stdio.McpStdioTransport
orionis.mcp.transport.stdio.McpStdioTransport.html
Class
Class
PUBLIC
Keep the reader available while bounded request tasks execute independently.
-
orionis.mcp.transport.stdio.McpStdioTransport.__slots__
orionis.mcp.transport.stdio.McpStdioTransport.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.mcp.transport.stdio.McpStdioTransport.__init__
orionis.mcp.transport.stdio.McpStdioTransport.html#__init__
Function
Method
PUBLIC
Prepare request-local task ownership without touching process streams.
-
orionis.mcp.transport.stdio.McpStdioTransport._app
orionis.mcp.transport.stdio.McpStdioTransport.html#_app
Attribute
Instance Variable
PUBLIC
Application container supplying configuration and dependencies.
-
orionis.mcp.transport.stdio.McpStdioTransport._config
orionis.mcp.transport.stdio.McpStdioTransport.html#_config
Attribute
Instance Variable
PUBLIC
Validated configuration controlling this component.
-
orionis.mcp.transport.stdio.McpStdioTransport._dispatcher
orionis.mcp.transport.stdio.McpStdioTransport.html#_dispatcher
Attribute
Instance Variable
PUBLIC
Dispatcher produced by McpDispatcher.
-
orionis.mcp.transport.stdio.McpStdioTransport._active
orionis.mcp.transport.stdio.McpStdioTransport.html#_active
Attribute
Instance Variable
PUBLIC
Operations currently running for this connection or transport.
-
orionis.mcp.transport.stdio.McpStdioTransport._lock
orionis.mcp.transport.stdio.McpStdioTransport.html#_lock
Attribute
Instance Variable
PUBLIC
Lock protecting concurrent access to shared state.
-
orionis.mcp.transport.stdio.McpStdioTransport._failed
orionis.mcp.transport.stdio.McpStdioTransport.html#_failed
Attribute
Instance Variable
PUBLIC
Backend retaining failed-job records.
-
orionis.mcp.transport.stdio.McpStdioTransport._failure
orionis.mcp.transport.stdio.McpStdioTransport.html#_failure
Attribute
Instance Variable
PUBLIC
Failure retained for propagation or reporting.
-
orionis.mcp.transport.stdio.McpStdioTransport._reports
orionis.mcp.transport.stdio.McpStdioTransport.html#_reports
Attribute
Instance Variable
PUBLIC
Failure delivery tasks owned until transport shutdown.
-
orionis.mcp.transport.stdio.McpStdioTransport._closing
orionis.mcp.transport.stdio.McpStdioTransport.html#_closing
Attribute
Instance Variable
PUBLIC
Whether resource cleanup is currently in progress.
-
orionis.mcp.transport.stdio.McpStdioTransport._running
orionis.mcp.transport.stdio.McpStdioTransport.html#_running
Attribute
Instance Variable
PUBLIC
Running flag used by McpStdioTransport.
-
orionis.mcp.transport.stdio.McpStdioTransport._write
orionis.mcp.transport.stdio.McpStdioTransport.html#_write
Function
Method
PUBLIC
Serialize frames and suppress output after EOF or owner shutdown.
-
orionis.mcp.transport.stdio.McpStdioTransport._stream
orionis.mcp.transport.stdio.McpStdioTransport.html#_stream
Function
Method
PUBLIC
Preserve backpressure and close an owned producer on all exits.
-
orionis.mcp.transport.stdio.McpStdioTransport._invoke
orionis.mcp.transport.stdio.McpStdioTransport.html#_invoke
Function
Method
PUBLIC
Execute one call in its own DI scope, sanitizing only application errors.
-
orionis.mcp.transport.stdio.McpStdioTransport._done
orionis.mcp.transport.stdio.McpStdioTransport.html#_done
Function
Method
PUBLIC
Remove completed task ownership and notify the reader of I/O failures.
-
orionis.mcp.transport.stdio.McpStdioTransport._cancel
orionis.mcp.transport.stdio.McpStdioTransport.html#_cancel
Function
Method
PUBLIC
Ignore malformed, unknown and already completed cancellation messages.
-
orionis.mcp.transport.stdio.McpStdioTransport._accept
orionis.mcp.transport.stdio.McpStdioTransport.html#_accept
Function
Method
PUBLIC
Stop queued output without joining a potentially blocked OS writer.
-
orionis.mcp.transport.stdio.McpStdioTransport._readLoop
orionis.mcp.transport.stdio.McpStdioTransport.html#_readLoop
Function
Method
PUBLIC
Race each cancellable read against a failed request's transport I/O.
-
orionis.mcp.transport.stdio.McpStdioTransport.run
orionis.mcp.transport.stdio.McpStdioTransport.html#run
Function
Method
PUBLIC
Run until EOF, joining all owned request cleanup before returning.
-
orionis.mcp.transport.stdio.McpStdioTransport.runStandardStreams
orionis.mcp.transport.stdio.McpStdioTransport.html#runStandardStreams
Function
Method
PUBLIC
Bind portable daemon-backed streams and keep application prints on stderr.
-
orionis.orm.collections.Paginator
orionis.orm.collections.Paginator.html
Class
Class
PUBLIC
Length-aware page of query results.
-
orionis.orm.collections.Paginator.__slots__
orionis.orm.collections.Paginator.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.orm.collections.Paginator.__init__
orionis.orm.collections.Paginator.html#__init__
Function
Method
PUBLIC
Initialize the paginator with its items and metadata.
-
orionis.orm.collections.Paginator._items
orionis.orm.collections.Paginator.html#_items
Attribute
Instance Variable
PUBLIC
Items for the current page.
-
orionis.orm.collections.Paginator._total
orionis.orm.collections.Paginator.html#_total
Attribute
Instance Variable
PUBLIC
Total number of rows across all pages.
-
orionis.orm.collections.Paginator._page
orionis.orm.collections.Paginator.html#_page
Attribute
Instance Variable
PUBLIC
Current page number, starting at 1.
-
orionis.orm.collections.Paginator._per_page
orionis.orm.collections.Paginator.html#_per_page
Attribute
Instance Variable
PUBLIC
Number of items per page.
-
orionis.orm.collections.Paginator.items
orionis.orm.collections.Paginator.html#items
Attribute
Property
PUBLIC
Return the items for the current page.
-
orionis.orm.collections.Paginator.total
orionis.orm.collections.Paginator.html#total
Attribute
Property
PUBLIC
Return the total number of rows across all pages.
-
orionis.orm.collections.Paginator.page
orionis.orm.collections.Paginator.html#page
Attribute
Property
PUBLIC
Return the current page number.
-
orionis.orm.collections.Paginator.perPage
orionis.orm.collections.Paginator.html#perPage
Attribute
Property
PUBLIC
Return the configured page size.
-
orionis.orm.collections.Paginator.lastPage
orionis.orm.collections.Paginator.html#lastPage
Attribute
Property
PUBLIC
Return the number of the last available page.
-
orionis.orm.collections.Paginator.hasNext
orionis.orm.collections.Paginator.html#hasNext
Attribute
Property
PUBLIC
Report whether a page exists after the current one.
-
orionis.orm.collections.Paginator.hasPrevious
orionis.orm.collections.Paginator.html#hasPrevious
Attribute
Property
PUBLIC
Report whether a page exists before the current one.
-
orionis.orm.collections.Paginator.toDict
orionis.orm.collections.Paginator.html#toDict
Function
Method
PUBLIC
Serialize the page and its metadata into a dictionary.
-
orionis.orm.collections.Paginator.toJson
orionis.orm.collections.Paginator.html#toJson
Function
Method
PUBLIC
Serialize the page and its metadata into a JSON string.
-
orionis.orm.collections.Paginator.__len__
orionis.orm.collections.Paginator.html#__len__
Function
Method
PUBLIC
Return the number of items in the current page.
-
orionis.orm.collections.Paginator.__repr__
orionis.orm.collections.Paginator.html#__repr__
Function
Method
PUBLIC
Return a concise developer representation of the paginator.
-
orionis.orm.collections._EXPORTS
orionis.orm.collections.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.orm.collections.__getattr__
orionis.orm.collections.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.orm.collections.__dir__
orionis.orm.collections.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.orm.contracts.IModelQueryBuilder
orionis.orm.contracts.IModelQueryBuilder.html
Class
Class
PUBLIC
Contract for the query builder bound to a model class.
-
orionis.orm.contracts.IModelQueryBuilder.__slots__
orionis.orm.contracts.IModelQueryBuilder.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.contracts.IModelQueryBuilder.withRelations
orionis.orm.contracts.IModelQueryBuilder.html#withRelations
Function
Method
PUBLIC
Eager load the given relationships alongside the query.
-
orionis.orm.contracts.IModelQueryBuilder.load
orionis.orm.contracts.IModelQueryBuilder.html#load
Function
Method
PUBLIC
Eager load the given relationships; alias of withRelations.
-
orionis.orm.contracts.IModelQueryBuilder.get
orionis.orm.contracts.IModelQueryBuilder.html#get
Function
Method
PUBLIC
Execute the query and hydrate every matching row.
-
orionis.orm.contracts.IModelQueryBuilder.first
orionis.orm.contracts.IModelQueryBuilder.html#first
Function
Method
PUBLIC
Execute the query and hydrate only the first matching row.
-
orionis.orm.contracts.IModelQueryBuilder.firstOrFail
orionis.orm.contracts.IModelQueryBuilder.html#firstOrFail
Function
Method
PUBLIC
Return the first matching row or raise when none exists.
-
orionis.orm.contracts.IModelQueryBuilder.find
orionis.orm.contracts.IModelQueryBuilder.html#find
Function
Method
PUBLIC
Retrieve a model by its primary key.
-
orionis.orm.contracts.IModelQueryBuilder.findOrFail
orionis.orm.contracts.IModelQueryBuilder.html#findOrFail
Function
Method
PUBLIC
Retrieve a model by primary key or raise when absent.
-
orionis.orm.contracts.IModelQueryBuilder.value
orionis.orm.contracts.IModelQueryBuilder.html#value
Function
Method
PUBLIC
Return a single column value of the first matching row.
-
orionis.orm.contracts.IModelQueryBuilder.pluck
orionis.orm.contracts.IModelQueryBuilder.html#pluck
Function
Method
PUBLIC
Return one column of every matching row.
-
orionis.orm.contracts.IModelQueryBuilder.paginate
orionis.orm.contracts.IModelQueryBuilder.html#paginate
Function
Method
PUBLIC
Execute the query returning a length-aware page of results.
-
orionis.orm.factories.FactoryConcurrencyException
orionis.orm.factories.FactoryConcurrencyException.html
Class
Exception
PUBLIC
Report overlapping operations on the same factory instance.
-
orionis.orm.factories.FactoryConfigurationException
orionis.orm.factories.FactoryConfigurationException.html
Class
Exception
PUBLIC
Report invalid model, count, locale, seed, or sequence configuration.
-
orionis.orm.factories.FactoryDefinitionException
orionis.orm.factories.FactoryDefinitionException.html
Class
Exception
PUBLIC
Report an absent definition or invalid generated attributes.
-
orionis.orm.factories.FactoryDependencyException
orionis.orm.factories.FactoryDependencyException.html
Class
Exception
PUBLIC
Retain the legacy dependency exception for public API compatibility.
-
orionis.orm.factories.FactoryException
orionis.orm.factories.FactoryException.html
Class
Exception
PUBLIC
Base exception for model factory failures.
-
orionis.orm.factories.FactoryPersistenceException
orionis.orm.factories.FactoryPersistenceException.html
Class
Exception
PUBLIC
Report a model event vetoing persistence.
-
orionis.orm.factories._attributes._ATOMIC_TYPES
orionis.orm.factories._attributes.html#_ATOMIC_TYPES
Attribute
Constant
PUBLIC
Atomic types used by _attributes.
-
orionis.orm.factories._attributes.copy_attributes
orionis.orm.factories._attributes.html#copy_attributes
Function
Function
PUBLIC
Validate and detach attributes from caller-owned mutable data.
-
orionis.orm.factories.fake._camel_case
orionis.orm.factories.fake.module.html#_camel_case
Function
Function
PUBLIC
Normalize a provider method while retaining its original word casing.
-
orionis.orm.factories.fake._provider_aliases
orionis.orm.factories.fake.module.html#_provider_aliases
Function
Function
PUBLIC
Compile immutable aliases for one set of backend member names.
-
orionis.orm.factories.fake._ProviderState
orionis.orm.factories.fake._ProviderState.html
Class
Class
PUBLIC
Retain the random generator and locale state for fake-data providers.
-
orionis.orm.factories.fake._ProviderState.__slots__
orionis.orm.factories.fake._ProviderState.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.orm.factories.fake._ProviderState.__init__
orionis.orm.factories.fake._ProviderState.html#__init__
Function
Method
PUBLIC
Initialize provider names and cache revision for one instance.
-
orionis.orm.factories.fake._ProviderState.backend
orionis.orm.factories.fake._ProviderState.html#backend
Attribute
Instance Variable
PUBLIC
Instance-local data generator.
-
orionis.orm.factories.fake._ProviderState.revision
orionis.orm.factories.fake._ProviderState.html#revision
Attribute
Instance Variable
PUBLIC
Revision value used by _ProviderState.
-
orionis.orm.factories.fake._ProviderState.refresh
orionis.orm.factories.fake._ProviderState.html#refresh
Function
Method
PUBLIC
Publish aliases and invalidate views after backend registration.
-
orionis.orm.factories.fake._ProviderState.aliases
orionis.orm.factories.fake._ProviderState.html#aliases
Attribute
Instance Variable
PUBLIC
Aliases produced by _provider_aliases.
-
orionis.orm.factories.fake._ProviderView
orionis.orm.factories.fake._ProviderView.html
Class
Class
PUBLIC
Expose fake-data provider methods through a configured view.
-
orionis.orm.factories.fake._ProviderView.__slots__
orionis.orm.factories.fake._ProviderView.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.orm.factories.fake._ProviderView.__init__
orionis.orm.factories.fake._ProviderView.html#__init__
Function
Method
PUBLIC
Bind a normal, unique, or optional provider view.
-
orionis.orm.factories.fake._ProviderView._backend
orionis.orm.factories.fake._ProviderView.html#_backend
Attribute
Instance Variable
PUBLIC
Backend object dispatching this view's calls.
-
orionis.orm.factories.fake._ProviderView._state
orionis.orm.factories.fake._ProviderView.html#_state
Attribute
Instance Variable
PUBLIC
Names and revision shared by views of the same generator.
-
orionis.orm.factories.fake._ProviderView._revision
orionis.orm.factories.fake._ProviderView.html#_revision
Attribute
Instance Variable
PUBLIC
Revision obtained from state.revision.
-
orionis.orm.factories.fake._ProviderView._cache
orionis.orm.factories.fake._ProviderView.html#_cache
Attribute
Instance Variable
PUBLIC
Cache policy or cached state used by this component.
-
orionis.orm.factories.fake._ProviderView.__getattr__
orionis.orm.factories.fake._ProviderView.html#__getattr__
Function
Method
PUBLIC
Return a bound camelCase provider method.
-
orionis.orm.factories.fake._ProviderView.__dir__
orionis.orm.factories.fake._ProviderView.html#__dir__
Function
Method
PUBLIC
List camelCase provider methods available for the selected locale.
-
orionis.orm.factories._faker._application_locale
orionis.orm.factories._faker.html#_application_locale
Function
Function
PUBLIC
Read the configured locale without initializing an application.
-
orionis.orm.factories._faker.create_faker
orionis.orm.factories._faker.html#create_faker
Function
Function
PUBLIC
Create the data provider with an independent random generator.
-
orionis.orm.factories.sequence.SequenceEntry
orionis.orm.factories.sequence.module.html#SequenceEntry
Attribute
Type Alias
PUBLIC
Type alias for dict[str, Any] | Callable[[int], dict[str, Any]].
-
orionis.orm.factories.factory.State
orionis.orm.factories.factory.module.html#State
Attribute
Type Alias
PUBLIC
Type alias for dict[str, Any] | Callable[[dict[str, Any]], dict[str, Any]].
-
orionis.orm.factories.Factory
orionis.orm.factories.Factory.html
Class
Class
PUBLIC
Build and persist model instances from reusable attribute definitions.
-
orionis.orm.factories.Factory.__slots__
orionis.orm.factories.Factory.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.orm.factories.Factory.model
orionis.orm.factories.Factory.html#model
Attribute
Class Variable
PUBLIC
Model selected for generation or persistence.
-
orionis.orm.factories.Factory.__init__
orionis.orm.factories.Factory.html#__init__
Function
Method
PUBLIC
Validate the factory and initialize its independent data provider.
-
orionis.orm.factories.Factory._model
orionis.orm.factories.Factory.html#_model
Attribute
Instance Variable
PUBLIC
Model selected for generation or persistence.
-
orionis.orm.factories.Factory._count
orionis.orm.factories.Factory.html#_count
Attribute
Instance Variable
PUBLIC
Count value used by Factory.
-
orionis.orm.factories.Factory._states
orionis.orm.factories.Factory.html#_states
Attribute
Instance Variable
PUBLIC
Attribute transformations applied when building model instances.
-
orionis.orm.factories.Factory._sequence
orionis.orm.factories.Factory.html#_sequence
Attribute
Instance Variable
PUBLIC
Sequence state used to vary attributes between generated instances.
-
orionis.orm.factories.Factory._sequence_index
orionis.orm.factories.Factory.html#_sequence_index
Attribute
Instance Variable
PUBLIC
Sequence index value used by Factory.
-
orionis.orm.factories.Factory._busy
orionis.orm.factories.Factory.html#_busy
Attribute
Instance Variable
PUBLIC
Busy flag used by Factory.
-
orionis.orm.factories.Factory._fake
orionis.orm.factories.Factory.html#_fake
Attribute
Instance Variable
PUBLIC
Fake produced by create_faker.
-
orionis.orm.factories.Factory.fake
orionis.orm.factories.Factory.html#fake
Attribute
Property
PUBLIC
Expose the instance's typed camelCase data provider facade.
-
orionis.orm.factories.Factory.definition
orionis.orm.factories.Factory.html#definition
Function
Method
PUBLIC
Define the default attributes of one model.
-
orionis.orm.factories.Factory.count
orionis.orm.factories.Factory.html#count
Function
Method
PUBLIC
Set the number of models generated by subsequent operations.
-
orionis.orm.factories.Factory.state
orionis.orm.factories.Factory.html#state
Function
Method
PUBLIC
Append attributes or a synchronous transformation of defaults.
-
orionis.orm.factories.Factory.sequence
orionis.orm.factories.Factory.html#sequence
Function
Method
PUBLIC
Install a sequence and restart this factory's position at zero.
-
orionis.orm.factories.Factory.clearUnique
orionis.orm.factories.Factory.html#clearUnique
Function
Method
PUBLIC
Clear remembered unique values without reseeding or rewinding.
-
orionis.orm.factories.Factory.make
orionis.orm.factories.Factory.html#make
Function
Method
PUBLIC
Construct models without database access or persistence events.
-
orionis.orm.factories.Factory.create
orionis.orm.factories.Factory.html#create
Function
Method
PUBLIC
Construct and save each model through Orionis's event lifecycle.
-
orionis.orm.factories.Factory.iterMake
orionis.orm.factories.Factory.html#iterMake
Function
Method
PUBLIC
Yield unsaved models progressively, holding no result collection.
-
orionis.orm.factories.Factory.iterCreate
orionis.orm.factories.Factory.html#iterCreate
Function
Method
PUBLIC
Yield models immediately after each awaited save operation.
-
orionis.orm.factories.Factory._ensureIdle
orionis.orm.factories.Factory.html#_ensureIdle
Function
Method
PUBLIC
Reject reconfiguration or overlapping use of an active factory.
-
orionis.orm.factories.Factory._makeOne
orionis.orm.factories.Factory.html#_makeOne
Function
Method
PUBLIC
Merge one definition and construct a model through mass assignment.
-
orionis.orm.factories.Fake
orionis.orm.factories.Fake.html
Class
Class
PUBLIC
Generate fake values through the configured data providers.
-
orionis.orm.factories.Fake.__slots__
orionis.orm.factories.Fake.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.orm.factories.Fake.__init__
orionis.orm.factories.Fake.html#__init__
Function
Method
PUBLIC
Wrap an independently configured backend without changing its seed.
-
orionis.orm.factories.Fake._unique
orionis.orm.factories.Fake.html#_unique
Attribute
Instance Variable
PUBLIC
View tracking previously generated fake values.
-
orionis.orm.factories.Fake._optional
orionis.orm.factories.Fake.html#_optional
Attribute
Instance Variable
PUBLIC
View controlling whether fake-data generation returns a value.
-
orionis.orm.factories.Fake.unique
orionis.orm.factories.Fake.html#unique
Attribute
Property
PUBLIC
Return the typed camelCase uniqueness view.
-
orionis.orm.factories.Fake.optional
orionis.orm.factories.Fake.html#optional
Attribute
Property
PUBLIC
Return the typed camelCase optional-value view.
-
orionis.orm.factories.Fake.locales
orionis.orm.factories.Fake.html#locales
Attribute
Property
PUBLIC
Return the configured backend locales.
-
orionis.orm.factories.Fake.random
orionis.orm.factories.Fake.html#random
Attribute
Property
PUBLIC
Return the instance's independent standard-library random generator.
-
orionis.orm.factories.Fake.__getitem__
orionis.orm.factories.Fake.html#__getitem__
Function
Method
PUBLIC
Select a configured locale without exposing the native generator.
-
orionis.orm.factories.Fake.addProvider
orionis.orm.factories.Fake.html#addProvider
Function
Method
PUBLIC
Register a custom provider and invalidate cached bound methods.
-
orionis.orm.factories.Fake.seedInstance
orionis.orm.factories.Fake.html#seedInstance
Function
Method
PUBLIC
Reseed this generator without touching other factory instances.
-
orionis.orm.factories.Fake.seedLocale
orionis.orm.factories.Fake.html#seedLocale
Function
Method
PUBLIC
Reseed a configured locale's independent generator.
-
orionis.orm.factories.Fake.getFormatter
orionis.orm.factories.Fake.html#getFormatter
Function
Method
PUBLIC
Resolve a provider callable using its public camelCase name.
-
orionis.orm.factories.Fake.setFormatter
orionis.orm.factories.Fake.html#setFormatter
Function
Method
PUBLIC
Install a formatter under its public camelCase provider name.
-
orionis.orm.factories.Fake.format
orionis.orm.factories.Fake.html#format
Function
Method
PUBLIC
Generate a value from a named camelCase formatter.
-
orionis.orm.factories.OptionalFake
orionis.orm.factories.OptionalFake.html
Class
Class
PUBLIC
Generate optional fake values according to a configured probability.
-
orionis.orm.factories.OptionalFake.__slots__
orionis.orm.factories.OptionalFake.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.factories.UniqueFake
orionis.orm.factories.UniqueFake.html
Class
Class
PUBLIC
Generate fake values while tracking and rejecting duplicates.
-
orionis.orm.factories.UniqueFake.__slots__
orionis.orm.factories.UniqueFake.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.orm.factories.UniqueFake.clear
orionis.orm.factories.UniqueFake.html#clear
Function
Method
PUBLIC
Clear values tracked by this backend's unique view.
-
orionis.orm.factories.UniqueFake.excludeTypes
orionis.orm.factories.UniqueFake.html#excludeTypes
Function
Method
PUBLIC
Exclude selected result types from uniqueness checks.
-
orionis.orm.factories.UniqueFake.__getitem__
orionis.orm.factories.UniqueFake.html#__getitem__
Function
Method
PUBLIC
Select the configured locale without exposing a native proxy.
-
orionis.orm.factories.Sequence
orionis.orm.factories.Sequence.html
Class
Class
PUBLIC
Describe cycling attributes without owning a shared counter.
-
orionis.orm.factories.Sequence.__slots__
orionis.orm.factories.Sequence.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.orm.factories.Sequence.__init__
orionis.orm.factories.Sequence.html#__init__
Function
Method
PUBLIC
Capture one or more detached dictionaries or index callbacks.
-
orionis.orm.factories.Sequence._entries
orionis.orm.factories.Sequence.html#_entries
Attribute
Instance Variable
PUBLIC
Entries to cycle through in their supplied order.
-
orionis.orm.factories.Sequence.resolve
orionis.orm.factories.Sequence.html#resolve
Function
Method
PUBLIC
Resolve attributes for a factory-owned sequence position.
-
orionis.orm.factories._EXCEPTIONS_MODULE
orionis.orm.factories.html#_EXCEPTIONS_MODULE
Attribute
Constant
PUBLIC
Defining module shared by public factory exception exports.
-
orionis.orm.factories._FAKE_MODULE
orionis.orm.factories.html#_FAKE_MODULE
Attribute
Constant
PUBLIC
Defining module shared by public fake-data view exports.
-
orionis.orm.factories._EXPORTS
orionis.orm.factories.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.orm.factories.__getattr__
orionis.orm.factories.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.orm.factories.__dir__
orionis.orm.factories.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.orm.query_builder.QueryBuilder
orionis.orm.query_builder.QueryBuilder.html
Class
Class
PUBLIC
Entry point of the model-less query API, backing the DB facade.
-
orionis.orm.query_builder.QueryBuilder.__slots__
orionis.orm.query_builder.QueryBuilder.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.orm.query_builder.QueryBuilder.__init__
orionis.orm.query_builder.QueryBuilder.html#__init__
Function
Method
PUBLIC
Initialize the gateway with the connection manager to delegate to.
-
orionis.orm.query_builder.QueryBuilder._db_manager
orionis.orm.query_builder.QueryBuilder.html#_db_manager
Attribute
Instance Variable
PUBLIC
Manager resolving named database connections.
-
orionis.orm.query_builder.QueryBuilder._connection_name
orionis.orm.query_builder.QueryBuilder.html#_connection_name
Attribute
Instance Variable
PUBLIC
Connection every query defaults to, or None for the configured default connection.
-
orionis.orm.query_builder.QueryBuilder.connection
orionis.orm.query_builder.QueryBuilder.html#connection
Function
Method
PUBLIC
Return a gateway scoped to the connection with the given name.
-
orionis.orm.query_builder.QueryBuilder.table
orionis.orm.query_builder.QueryBuilder.html#table
Function
Method
PUBLIC
Build a fluent, model-less query over a plain table name.
-
orionis.orm.query_builder.QueryBuilder.getDefaultName
orionis.orm.query_builder.QueryBuilder.html#getDefaultName
Function
Method
PUBLIC
Return the name of the default connection.
-
orionis.orm.query_builder.QueryBuilder.setDefaultName
orionis.orm.query_builder.QueryBuilder.html#setDefaultName
Function
Method
PUBLIC
Change the connection used when none is specified.
-
orionis.orm.query_builder.QueryBuilder.select
orionis.orm.query_builder.QueryBuilder.html#select
Function
Method
PUBLIC
Run a raw SELECT statement and return its rows.
-
orionis.orm.query_builder.QueryBuilder.execute
orionis.orm.query_builder.QueryBuilder.html#execute
Function
Method
PUBLIC
Run a raw data-modifying statement and return the affected rows.
-
orionis.orm.query_builder.QueryBuilder.statement
orionis.orm.query_builder.QueryBuilder.html#statement
Function
Method
PUBLIC
Run a raw statement without inspecting its result.
-
orionis.orm.query_builder.QueryBuilder.beginTransaction
orionis.orm.query_builder.QueryBuilder.html#beginTransaction
Function
Method
PUBLIC
Begin a transaction, or a savepoint when one is already active.
-
orionis.orm.query_builder.QueryBuilder.commit
orionis.orm.query_builder.QueryBuilder.html#commit
Function
Method
PUBLIC
Commit the innermost active transaction or savepoint.
-
orionis.orm.query_builder.QueryBuilder.rollback
orionis.orm.query_builder.QueryBuilder.html#rollback
Function
Method
PUBLIC
Roll back the innermost active transaction or savepoint.
-
orionis.orm.query_builder.QueryBuilder.transaction
orionis.orm.query_builder.QueryBuilder.html#transaction
Function
Method
PUBLIC
Return a transaction usable as an async context manager.
-
orionis.orm.query_builder.QueryBuilder._resolve
orionis.orm.query_builder.QueryBuilder.html#_resolve
Function
Method
PUBLIC
Resolve the connection a call targets.
-
orionis.orm.provider.QueryBuilderProvider
orionis.orm.provider.QueryBuilderProvider.html
Class
Class
PUBLIC
Register query builder services in the application container.
-
orionis.orm.provider.QueryBuilderProvider.register
orionis.orm.provider.QueryBuilderProvider.html#register
Function
Method
PUBLIC
Register the query builder as a singleton in the container.
-
orionis.orm.provider.QueryBuilderProvider.boot
orionis.orm.provider.QueryBuilderProvider.html#boot
Function
Method
PUBLIC
Pin the query builder facade to the container.
-
orionis.orm.query.ModelQueryBuilder
orionis.orm.query.ModelQueryBuilder.html
Class
Class
PUBLIC
Fluent query builder bound to a model class.
-
orionis.orm.query.ModelQueryBuilder.__slots__
orionis.orm.query.ModelQueryBuilder.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.orm.query.ModelQueryBuilder.__init__
orionis.orm.query.ModelQueryBuilder.html#__init__
Function
Method
PUBLIC
Initialize the builder for a model class.
-
orionis.orm.query.ModelQueryBuilder._model
orionis.orm.query.ModelQueryBuilder.html#_model
Attribute
Instance Variable
PUBLIC
Model class the queries run against.
-
orionis.orm.query.ModelQueryBuilder._meta
orionis.orm.query.ModelQueryBuilder.html#_meta
Attribute
Instance Variable
PUBLIC
Meta supplied through meta.
-
orionis.orm.query.ModelQueryBuilder._connection_name
orionis.orm.query.ModelQueryBuilder.html#_connection_name
Attribute
Instance Variable
PUBLIC
Name of the configured database connection to use.
-
orionis.orm.query.ModelQueryBuilder._eager_loads
orionis.orm.query.ModelQueryBuilder.html#_eager_loads
Attribute
Instance Variable
PUBLIC
Relations scheduled for eager loading with the query result.
-
orionis.orm.query.ModelQueryBuilder._without_scopes
orionis.orm.query.ModelQueryBuilder.html#_without_scopes
Attribute
Instance Variable
PUBLIC
Without scopes produced by set.
-
orionis.orm.query.ModelQueryBuilder._trashed_mode
orionis.orm.query.ModelQueryBuilder.html#_trashed_mode
Attribute
Instance Variable
PUBLIC
Trashed mode supplied through _TRASHED_EXCLUDE.
-
orionis.orm.query.ModelQueryBuilder._scopes_applied
orionis.orm.query.ModelQueryBuilder.html#_scopes_applied
Attribute
Instance Variable
PUBLIC
Scopes applied flag used by ModelQueryBuilder.
-
orionis.orm.query.ModelQueryBuilder.__getattr__
orionis.orm.query.ModelQueryBuilder.html#__getattr__
Function
Method
PUBLIC
Expose the local scopes declared by the bound model.
-
orionis.orm.query.ModelQueryBuilder.withRelations
orionis.orm.query.ModelQueryBuilder.html#withRelations
Function
Method
PUBLIC
Eager load the given relationships alongside the query.
-
orionis.orm.query.ModelQueryBuilder.load
orionis.orm.query.ModelQueryBuilder.html#load
Function
Method
PUBLIC
Eager load the given relationships.
-
orionis.orm.query.ModelQueryBuilder.withoutGlobalScope
orionis.orm.query.ModelQueryBuilder.html#withoutGlobalScope
Function
Method
PUBLIC
Disable one global scope for this query.
-
orionis.orm.query.ModelQueryBuilder.withoutGlobalScopes
orionis.orm.query.ModelQueryBuilder.html#withoutGlobalScopes
Function
Method
PUBLIC
Disable several global scopes, or every one of them.
-
orionis.orm.query.ModelQueryBuilder.scope
orionis.orm.query.ModelQueryBuilder.html#scope
Function
Method
PUBLIC
Apply a local scope by name.
-
orionis.orm.query.ModelQueryBuilder.withTrashed
orionis.orm.query.ModelQueryBuilder.html#withTrashed
Function
Method
PUBLIC
Include soft deleted rows in the query results.
-
orionis.orm.query.ModelQueryBuilder.onlyTrashed
orionis.orm.query.ModelQueryBuilder.html#onlyTrashed
Function
Method
PUBLIC
Restrict the query to soft deleted rows.
-
orionis.orm.query.ModelQueryBuilder.withoutTrashed
orionis.orm.query.ModelQueryBuilder.html#withoutTrashed
Function
Method
PUBLIC
Exclude soft deleted rows; the default behavior.
-
orionis.orm.query.ModelQueryBuilder.restore
orionis.orm.query.ModelQueryBuilder.html#restore
Function
Method
PUBLIC
Restore every soft deleted row matched by the query.
-
orionis.orm.query.ModelQueryBuilder.forceDelete
orionis.orm.query.ModelQueryBuilder.html#forceDelete
Function
Method
PUBLIC
Delete the matched rows permanently, ignoring soft deletes.
-
orionis.orm.query.ModelQueryBuilder.delete
orionis.orm.query.ModelQueryBuilder.html#delete
Function
Method
PUBLIC
Delete the matched rows, honoring soft deletes when enabled.
-
orionis.orm.query.ModelQueryBuilder.get
orionis.orm.query.ModelQueryBuilder.html#get
Function
Method
PUBLIC
Execute the query and hydrate every matching row.
-
orionis.orm.query.ModelQueryBuilder.first
orionis.orm.query.ModelQueryBuilder.html#first
Function
Method
PUBLIC
Execute the query and hydrate only the first matching row.
-
orionis.orm.query.ModelQueryBuilder.firstOrFail
orionis.orm.query.ModelQueryBuilder.html#firstOrFail
Function
Method
PUBLIC
Return the first matching row or raise when none exists.
-
orionis.orm.query.ModelQueryBuilder.find
orionis.orm.query.ModelQueryBuilder.html#find
Function
Method
PUBLIC
Retrieve a model by its primary key.
-
orionis.orm.query.ModelQueryBuilder.findOrFail
orionis.orm.query.ModelQueryBuilder.html#findOrFail
Function
Method
PUBLIC
Retrieve a model by primary key or raise when absent.
-
orionis.orm.query.ModelQueryBuilder.value
orionis.orm.query.ModelQueryBuilder.html#value
Function
Method
PUBLIC
Return a single column value of the first matching row.
-
orionis.orm.query.ModelQueryBuilder.pluck
orionis.orm.query.ModelQueryBuilder.html#pluck
Function
Method
PUBLIC
Return one column of every matching row.
-
orionis.orm.query.ModelQueryBuilder.paginate
orionis.orm.query.ModelQueryBuilder.html#paginate
Function
Method
PUBLIC
Execute the query returning a length-aware page of results.
-
orionis.orm.query.ModelQueryBuilder.clone
orionis.orm.query.ModelQueryBuilder.html#clone
Function
Method
PUBLIC
Return an independent copy of this builder.
-
orionis.orm.query.ModelQueryBuilder._beforeExecute
orionis.orm.query.ModelQueryBuilder.html#_beforeExecute
Function
Method
PUBLIC
Apply the global scopes and the soft delete filter once.
-
orionis.orm.query.ModelQueryBuilder._plan
orionis.orm.query.ModelQueryBuilder.html#_plan
Attribute
Instance Variable
PUBLIC
Plan produced by SelectPlan.
-
orionis.orm.query.ModelQueryBuilder._applyModelFilters
orionis.orm.query.ModelQueryBuilder.html#_applyModelFilters
Function
Method
PUBLIC
Apply registered scopes and deletion visibility to the staged plan.
-
orionis.orm.query.ModelQueryBuilder._fireRetrieved
orionis.orm.query.ModelQueryBuilder.html#_fireRetrieved
Function
Method
PUBLIC
Dispatch the retrieved event for freshly hydrated models.
-
orionis.orm.query.ModelQueryBuilder._connection
orionis.orm.query.ModelQueryBuilder.html#_connection
Function
Method
PUBLIC
Resolve the database connection for the bound model.
-
orionis.orm.query.ModelQueryBuilder._serializeValues
orionis.orm.query.ModelQueryBuilder.html#_serializeValues
Function
Method
PUBLIC
Apply the model casts before values reach the database.
-
orionis.orm.query.ModelQueryBuilder._prepareUpdate
orionis.orm.query.ModelQueryBuilder.html#_prepareUpdate
Function
Method
PUBLIC
Refresh the update timestamp of a mass update payload.
-
orionis.orm.query.ModelQueryBuilder._existsColumns
orionis.orm.query.ModelQueryBuilder.html#_existsColumns
Function
Method
PUBLIC
Return the projection used by existence probes.
-
orionis.orm.query.ModelQueryBuilder._defaultTimestampColumn
orionis.orm.query.ModelQueryBuilder.html#_defaultTimestampColumn
Function
Method
PUBLIC
Return the column latest and oldest default to.
-
orionis.orm.query.ModelQueryBuilder._eagerLoad
orionis.orm.query.ModelQueryBuilder.html#_eagerLoad
Function
Method
PUBLIC
Resolve every pending eager-loaded relationship for a result set.
-
orionis.orm.query.ModelQueryBuilder._relationErrorMessage
orionis.orm.query.ModelQueryBuilder.html#_relationErrorMessage
Function
Method
PUBLIC
Build the error message for an unresolvable relationship name.
-
orionis.orm.query.AggregateClause
orionis.orm.query.AggregateClause.html
Class
Class
PUBLIC
Aggregate projection applied to a select plan.
-
orionis.orm.query.AggregateClause.function
orionis.orm.query.AggregateClause.html#function
Attribute
Instance Variable
PUBLIC
Aggregate function to apply.
-
orionis.orm.query.AggregateClause.column
orionis.orm.query.AggregateClause.html#column
Attribute
Instance Variable
PUBLIC
Target column, or "*" for COUNT.
-
orionis.orm.query.AggregateFunction
orionis.orm.query.AggregateFunction.html
Class
Class
PUBLIC
Aggregate functions supported by the query language.
-
orionis.orm.query.AggregateFunction.COUNT
orionis.orm.query.AggregateFunction.html#COUNT
Attribute
Constant
PUBLIC
count.
-
orionis.orm.query.AggregateFunction.MAX
orionis.orm.query.AggregateFunction.html#MAX
Attribute
Constant
PUBLIC
max.
-
orionis.orm.query.AggregateFunction.MIN
orionis.orm.query.AggregateFunction.html#MIN
Attribute
Constant
PUBLIC
min.
-
orionis.orm.query.AggregateFunction.AVG
orionis.orm.query.AggregateFunction.html#AVG
Attribute
Constant
PUBLIC
avg.
-
orionis.orm.query.AggregateFunction.SUM
orionis.orm.query.AggregateFunction.html#SUM
Attribute
Constant
PUBLIC
sum.
-
orionis.orm.query.DeletePlan
orionis.orm.query.DeletePlan.html
Class
Class
PUBLIC
Engine-agnostic description of a DELETE statement.
-
orionis.orm.query.DeletePlan.table
orionis.orm.query.DeletePlan.html#table
Attribute
Instance Variable
PUBLIC
Table to delete from.
-
orionis.orm.query.DeletePlan.wheres
orionis.orm.query.DeletePlan.html#wheres
Attribute
Instance Variable
PUBLIC
Conditions restricting the affected rows.
-
orionis.orm.query.InsertPlan
orionis.orm.query.InsertPlan.html
Class
Class
PUBLIC
Engine-agnostic description of an INSERT statement.
-
orionis.orm.query.InsertPlan.table
orionis.orm.query.InsertPlan.html#table
Attribute
Instance Variable
PUBLIC
Table receiving the rows.
-
orionis.orm.query.InsertPlan.values
orionis.orm.query.InsertPlan.html#values
Attribute
Instance Variable
PUBLIC
One dictionary of column values per row to insert.
-
orionis.orm.query.OrderClause
orionis.orm.query.OrderClause.html
Class
Class
PUBLIC
Single ordering rule inside a query plan.
-
orionis.orm.query.OrderClause.column
orionis.orm.query.OrderClause.html#column
Attribute
Instance Variable
PUBLIC
Column to sort by.
-
orionis.orm.query.OrderClause.direction
orionis.orm.query.OrderClause.html#direction
Attribute
Instance Variable
PUBLIC
Sort direction, ascending by default.
-
orionis.orm.query.SelectPlan
orionis.orm.query.SelectPlan.html
Class
Class
PUBLIC
Complete, engine-agnostic description of a SELECT query.
-
orionis.orm.query.SelectPlan.table
orionis.orm.query.SelectPlan.html#table
Attribute
Instance Variable
PUBLIC
Table the query runs against.
-
orionis.orm.query.SelectPlan.alias
orionis.orm.query.SelectPlan.html#alias
Attribute
Instance Variable
PUBLIC
Name the main table is referred to by inside the query, or None to use its logical table name. Required to self-join a table against itself once joins are composed on top of a plan.
-
orionis.orm.query.SelectPlan.joins
orionis.orm.query.SelectPlan.html#joins
Attribute
Instance Variable
PUBLIC
Additional table sources joined onto the main table.
-
orionis.orm.query.SelectPlan.columns
orionis.orm.query.SelectPlan.html#columns
Attribute
Instance Variable
PUBLIC
Projected columns; empty means all columns. Entries may be qualified as "table.column" once joins is non-empty.
-
orionis.orm.query.SelectPlan.wheres
orionis.orm.query.SelectPlan.html#wheres
Attribute
Instance Variable
PUBLIC
Filtering conditions combined left to right.
-
orionis.orm.query.SelectPlan.orders
orionis.orm.query.SelectPlan.html#orders
Attribute
Instance Variable
PUBLIC
Ordering rules.
-
orionis.orm.query.SelectPlan.groups
orionis.orm.query.SelectPlan.html#groups
Attribute
Instance Variable
PUBLIC
Grouping columns.
-
orionis.orm.query.SelectPlan.havings
orionis.orm.query.SelectPlan.html#havings
Attribute
Instance Variable
PUBLIC
Conditions applied after grouping.
-
orionis.orm.query.SelectPlan.limit_value
orionis.orm.query.SelectPlan.html#limit_value
Attribute
Instance Variable
PUBLIC
Maximum number of rows to return.
-
orionis.orm.query.SelectPlan.offset_value
orionis.orm.query.SelectPlan.html#offset_value
Attribute
Instance Variable
PUBLIC
Number of rows to skip.
-
orionis.orm.query.SelectPlan.aggregate
orionis.orm.query.SelectPlan.html#aggregate
Attribute
Instance Variable
PUBLIC
Aggregate projection replacing the column list when present.
-
orionis.orm.query.SelectPlan.distinct
orionis.orm.query.SelectPlan.html#distinct
Attribute
Instance Variable
PUBLIC
Whether duplicate rows are collapsed via SELECT DISTINCT.
-
orionis.orm.query.SelectPlan.lock
orionis.orm.query.SelectPlan.html#lock
Attribute
Instance Variable
PUBLIC
Row locking mode requested for the selected rows.
-
orionis.orm.query.SelectPlan.unions
orionis.orm.query.SelectPlan.html#unions
Attribute
Instance Variable
PUBLIC
Queries appended to this one through UNION.
-
orionis.orm.query.SelectPlan.clone
orionis.orm.query.SelectPlan.html#clone
Function
Method
PUBLIC
Return an independent copy of the plan.
-
orionis.orm.query.SortDirection
orionis.orm.query.SortDirection.html
Class
Class
PUBLIC
Sort directions supported by order clauses.
-
orionis.orm.query.SortDirection.ASC
orionis.orm.query.SortDirection.html#ASC
Attribute
Constant
PUBLIC
asc.
-
orionis.orm.query.SortDirection.DESC
orionis.orm.query.SortDirection.html#DESC
Attribute
Constant
PUBLIC
desc.
-
orionis.orm.query.UpdatePlan
orionis.orm.query.UpdatePlan.html
Class
Class
PUBLIC
Engine-agnostic description of an UPDATE statement.
-
orionis.orm.query.UpdatePlan.table
orionis.orm.query.UpdatePlan.html#table
Attribute
Instance Variable
PUBLIC
Table to update.
-
orionis.orm.query.UpdatePlan.values
orionis.orm.query.UpdatePlan.html#values
Attribute
Instance Variable
PUBLIC
Column values to assign.
-
orionis.orm.query.UpdatePlan.wheres
orionis.orm.query.UpdatePlan.html#wheres
Attribute
Instance Variable
PUBLIC
Conditions restricting the affected rows.
-
orionis.orm.query.WhereClause
orionis.orm.query.WhereClause.html
Class
Class
PUBLIC
Single filtering condition inside a query plan.
-
orionis.orm.query.WhereClause.column
orionis.orm.query.WhereClause.html#column
Attribute
Instance Variable
PUBLIC
-
orionis.orm.query.WhereClause.where_type
orionis.orm.query.WhereClause.html#where_type
Attribute
Instance Variable
PUBLIC
Kind of condition (basic comparison, in, null, between, like, nested group, column comparison, raw fragment, or exists).
-
orionis.orm.query.WhereClause.operator
orionis.orm.query.WhereClause.html#operator
Attribute
Instance Variable
PUBLIC
Comparison operator for basic and column conditions.
-
orionis.orm.query.WhereClause.value
orionis.orm.query.WhereClause.html#value
Attribute
Instance Variable
PUBLIC
-
orionis.orm.query.WhereClause.boolean
orionis.orm.query.WhereClause.html#boolean
Attribute
Instance Variable
PUBLIC
Logical connector with the previous clause: "and" or "or".
-
orionis.orm.query.WhereType
orionis.orm.query.WhereType.html
Class
Class
PUBLIC
Kinds of where clauses supported by the query language.
-
orionis.orm.query.WhereType.BASIC
orionis.orm.query.WhereType.html#BASIC
Attribute
Constant
PUBLIC
basic.
-
orionis.orm.query.WhereType.IN
orionis.orm.query.WhereType.html#IN
Attribute
Constant
PUBLIC
in.
-
orionis.orm.query.WhereType.NOT_IN
orionis.orm.query.WhereType.html#NOT_IN
Attribute
Constant
PUBLIC
not_in.
-
orionis.orm.query.WhereType.NULL
orionis.orm.query.WhereType.html#NULL
Attribute
Constant
PUBLIC
null.
-
orionis.orm.query.WhereType.NOT_NULL
orionis.orm.query.WhereType.html#NOT_NULL
Attribute
Constant
PUBLIC
not_null.
-
orionis.orm.query.WhereType.BETWEEN
orionis.orm.query.WhereType.html#BETWEEN
Attribute
Constant
PUBLIC
between.
-
orionis.orm.query.WhereType.NOT_BETWEEN
orionis.orm.query.WhereType.html#NOT_BETWEEN
Attribute
Constant
PUBLIC
not_between.
-
orionis.orm.query.WhereType.LIKE
orionis.orm.query.WhereType.html#LIKE
Attribute
Constant
PUBLIC
like.
-
orionis.orm.query.WhereType.NOT_LIKE
orionis.orm.query.WhereType.html#NOT_LIKE
Attribute
Constant
PUBLIC
not_like.
-
orionis.orm.query.WhereType.ILIKE
orionis.orm.query.WhereType.html#ILIKE
Attribute
Constant
PUBLIC
ilike.
-
orionis.orm.query.WhereType.NOT_ILIKE
orionis.orm.query.WhereType.html#NOT_ILIKE
Attribute
Constant
PUBLIC
not_ilike.
-
orionis.orm.query.WhereType.STARTS_WITH
orionis.orm.query.WhereType.html#STARTS_WITH
Attribute
Constant
PUBLIC
starts_with.
-
orionis.orm.query.WhereType.ENDS_WITH
orionis.orm.query.WhereType.html#ENDS_WITH
Attribute
Constant
PUBLIC
ends_with.
-
orionis.orm.query.WhereType.CONTAINS
orionis.orm.query.WhereType.html#CONTAINS
Attribute
Constant
PUBLIC
contains.
-
orionis.orm.query.WhereType.REGEXP
orionis.orm.query.WhereType.html#REGEXP
Attribute
Constant
PUBLIC
regexp.
-
orionis.orm.query.WhereType.NESTED
orionis.orm.query.WhereType.html#NESTED
Attribute
Constant
PUBLIC
nested.
-
orionis.orm.query.WhereType.COLUMN
orionis.orm.query.WhereType.html#COLUMN
Attribute
Constant
PUBLIC
column.
-
orionis.orm.query.WhereType.RAW
orionis.orm.query.WhereType.html#RAW
Attribute
Constant
PUBLIC
raw.
-
orionis.orm.query.WhereType.EXISTS
orionis.orm.query.WhereType.html#EXISTS
Attribute
Constant
PUBLIC
exists.
-
orionis.orm.query.WhereType.NOT_EXISTS
orionis.orm.query.WhereType.html#NOT_EXISTS
Attribute
Constant
PUBLIC
not_exists.
-
orionis.orm.query._EXPRESSIONS_MODULE
orionis.orm.query.html#_EXPRESSIONS_MODULE
Attribute
Constant
PUBLIC
Module defining the public query plan entities and enumerations.
-
orionis.orm.query._EXPORTS
orionis.orm.query.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.orm.query.__getattr__
orionis.orm.query.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.orm.query.__dir__
orionis.orm.query.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.queues.context.FailureCallback
orionis.queues.context.html#FailureCallback
Attribute
Type Alias
PUBLIC
Type alias for Callable[[ReservedJob, Exception], Awaitable[bool]].
-
orionis.queues.JobContext
orionis.queues.JobContext.html
Class
Class
PUBLIC
Expose the current reservation and explicit lifecycle operations.
-
orionis.queues.JobContext.__slots__
orionis.queues.JobContext.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.queues.JobContext.__init__
orionis.queues.JobContext.html#__init__
Function
Method
PUBLIC
Bind operational state to one job execution.
-
orionis.queues.JobContext._driver
orionis.queues.JobContext.html#_driver
Attribute
Instance Variable
PUBLIC
Driver owning the reservation.
-
orionis.queues.JobContext._reserved
orionis.queues.JobContext.html#_reserved
Attribute
Instance Variable
PUBLIC
Current fenced reservation.
-
orionis.queues.JobContext._connection
orionis.queues.JobContext.html#_connection
Attribute
Instance Variable
PUBLIC
Logical connection name.
-
orionis.queues.JobContext._fail
orionis.queues.JobContext.html#_fail
Attribute
Instance Variable
PUBLIC
Callback persisting a terminal failure.
-
orionis.queues.JobContext._finished
orionis.queues.JobContext.html#_finished
Attribute
Instance Variable
PUBLIC
Finished flag used by JobContext.
-
orionis.queues.JobContext._failure
orionis.queues.JobContext.html#_failure
Attribute
Instance Variable
PUBLIC
Failure retained for propagation or reporting.
-
orionis.queues.JobContext.id
orionis.queues.JobContext.html#id
Attribute
Property
PUBLIC
Return the immutable job identifier.
-
orionis.queues.JobContext.attempts
orionis.queues.JobContext.html#attempts
Attribute
Property
PUBLIC
Return the number of reservations including this execution.
-
orionis.queues.JobContext.queue
orionis.queues.JobContext.html#queue
Attribute
Property
PUBLIC
Return the logical queue name.
-
orionis.queues.JobContext.connection
orionis.queues.JobContext.html#connection
Attribute
Property
PUBLIC
Return the logical backend connection name.
-
orionis.queues.JobContext.finished
orionis.queues.JobContext.html#finished
Attribute
Property
PUBLIC
Report whether an explicit lifecycle operation completed.
-
orionis.queues.JobContext.failure
orionis.queues.JobContext.html#failure
Attribute
Property
PUBLIC
Return an explicitly reported terminal exception.
-
orionis.queues.JobContext._requireActive
orionis.queues.JobContext.html#_requireActive
Function
Method
PUBLIC
Reject repeated transitions on a completed context.
-
orionis.queues.JobContext.release
orionis.queues.JobContext.html#release
Function
Method
PUBLIC
Release the reservation for another attempt.
-
orionis.queues.JobContext.delete
orionis.queues.JobContext.html#delete
Function
Method
PUBLIC
Acknowledge the job and remove its reservation.
-
orionis.queues.JobContext.fail
orionis.queues.JobContext.html#fail
Function
Method
PUBLIC
Persist a terminal error and acknowledge the reservation.
-
orionis.queues.JobEnvelope
orionis.queues.JobEnvelope.html
Class
Class
PUBLIC
Carry immutable, versioned job data independently of backend state.
-
orionis.queues.JobEnvelope.id
orionis.queues.JobEnvelope.html#id
Attribute
Class Variable
PUBLIC
Identifier used to correlate or locate this protocol or storage record.
-
orionis.queues.JobEnvelope.job
orionis.queues.JobEnvelope.html#job
Attribute
Class Variable
PUBLIC
Registered job class or type identifier.
-
orionis.queues.JobEnvelope.payload
orionis.queues.JobEnvelope.html#payload
Attribute
Class Variable
PUBLIC
Serialized data required to execute or restore the job.
-
orionis.queues.JobEnvelope.connection
orionis.queues.JobEnvelope.html#connection
Attribute
Class Variable
PUBLIC
Configured connection used to store or dispatch the operation.
-
orionis.queues.JobEnvelope.queue
orionis.queues.JobEnvelope.html#queue
Attribute
Class Variable
PUBLIC
Name of the queue receiving or storing the job.
-
orionis.queues.JobEnvelope.max_tries
orionis.queues.JobEnvelope.html#max_tries
Attribute
Class Variable
PUBLIC
Maximum number of execution attempts allowed for the job.
-
orionis.queues.JobEnvelope.timeout
orionis.queues.JobEnvelope.html#timeout
Attribute
Class Variable
PUBLIC
Maximum duration allowed for an execution attempt.
-
orionis.queues.JobEnvelope.backoff
orionis.queues.JobEnvelope.html#backoff
Attribute
Class Variable
PUBLIC
Delay policy applied before retrying a failed attempt.
-
orionis.queues.JobEnvelope.retry_until
orionis.queues.JobEnvelope.html#retry_until
Attribute
Class Variable
PUBLIC
Deadline after which the job must no longer be retried.
-
orionis.queues.JobEnvelope.version
orionis.queues.JobEnvelope.html#version
Attribute
Class Variable
PUBLIC
Version value used by JobEnvelope.
-
orionis.queues.JobEnvelope.__post_init__
orionis.queues.JobEnvelope.html#__post_init__
Function
Method
PUBLIC
Reject invalid immutable execution options.
-
orionis.queues.BaseJob
orionis.queues.BaseJob.html
Class
Class
PUBLIC
Declare serializable job fields and asynchronous service dependencies.
-
orionis.queues.BaseJob.tries
orionis.queues.BaseJob.html#tries
Attribute
Instance Variable
PUBLIC
Maximum reservations, or the configured worker default.
-
orionis.queues.BaseJob.timeout
orionis.queues.BaseJob.html#timeout
Attribute
Instance Variable
PUBLIC
Cooperative execution timeout, or the configured worker default.
-
orionis.queues.BaseJob.backoff
orionis.queues.BaseJob.html#backoff
Attribute
Instance Variable
PUBLIC
Delay after each failed attempt, or the configured worker default.
-
orionis.queues.BaseJob.__slots__
orionis.queues.BaseJob.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.queues.BaseJob.retryUntil
orionis.queues.BaseJob.html#retryUntil
Function
Method
PUBLIC
Return an optional absolute retry deadline.
-
orionis.queues.PendingDispatch
orionis.queues.PendingDispatch.html
Class
Class
PUBLIC
Defer a single dispatch until awaited and allow options before submission.
-
orionis.queues.PendingDispatch.__slots__
orionis.queues.PendingDispatch.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.queues.PendingDispatch.__init__
orionis.queues.PendingDispatch.html#__init__
Function
Method
PUBLIC
Retain a job and its asynchronous submission callback.
-
orionis.queues.PendingDispatch._submit
orionis.queues.PendingDispatch.html#_submit
Attribute
Instance Variable
PUBLIC
Manager entry point invoked only when awaited.
-
orionis.queues.PendingDispatch._job
orionis.queues.PendingDispatch.html#_job
Attribute
Instance Variable
PUBLIC
Instance whose declared data will be serialized on submission.
-
orionis.queues.PendingDispatch._connection
orionis.queues.PendingDispatch.html#_connection
Attribute
Instance Variable
PUBLIC
Configured connection used to store or dispatch the operation.
-
orionis.queues.PendingDispatch._queue
orionis.queues.PendingDispatch.html#_queue
Attribute
Instance Variable
PUBLIC
Name of the queue receiving or storing the job.
-
orionis.queues.PendingDispatch._delay
orionis.queues.PendingDispatch.html#_delay
Attribute
Instance Variable
PUBLIC
Delay value used by PendingDispatch.
-
orionis.queues.PendingDispatch._completion
orionis.queues.PendingDispatch.html#_completion
Attribute
Instance Variable
PUBLIC
Completion provider or result associated with the primitive.
-
orionis.queues.PendingDispatch.onConnection
orionis.queues.PendingDispatch.html#onConnection
Function
Method
PUBLIC
Select the configured backend before submission.
-
orionis.queues.PendingDispatch.onQueue
orionis.queues.PendingDispatch.html#onQueue
Function
Method
PUBLIC
Select a logical channel before submission.
-
orionis.queues.PendingDispatch.delay
orionis.queues.PendingDispatch.html#delay
Function
Method
PUBLIC
Schedule availability relative to submission time.
-
orionis.queues.PendingDispatch._checkMutable
orionis.queues.PendingDispatch.html#_checkMutable
Function
Method
PUBLIC
Reject changes after the submission task has started.
-
orionis.queues.PendingDispatch._run
orionis.queues.PendingDispatch.html#_run
Function
Method
PUBLIC
Submit once and share the result with every awaiter.
-
orionis.queues.PendingDispatch.__await__
orionis.queues.PendingDispatch.html#__await__
Function
Method
PUBLIC
Start or join the deferred dispatch when awaited.
-
orionis.queues._EXPORTS
orionis.queues.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.queues.__getattr__
orionis.queues.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a declared public queue export.
-
orionis.queues.__dir__
orionis.queues.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public queue exports.
-
orionis.queues._database._DatabaseStorage
orionis.queues._database._DatabaseStorage.html
Class
Class
PUBLIC
Share concurrent schema bootstrap for queue and failed-job storage.
-
orionis.queues._database._DatabaseStorage.__slots__
orionis.queues._database._DatabaseStorage.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.queues._database._DatabaseStorage._connection
orionis.queues._database._DatabaseStorage.html#_connection
Attribute
Class Variable
PUBLIC
Configured connection used to store or dispatch the operation.
-
orionis.queues._database._DatabaseStorage._definition
orionis.queues._database._DatabaseStorage.html#_definition
Attribute
Class Variable
PUBLIC
Original declaration from which runtime metadata was compiled.
-
orionis.queues._database._DatabaseStorage._ready
orionis.queues._database._DatabaseStorage.html#_ready
Attribute
Instance Variable
PUBLIC
Whether backend initialization has completed.
-
orionis.queues._database._DatabaseStorage._ready_lock
orionis.queues._database._DatabaseStorage.html#_ready_lock
Attribute
Class Variable
PUBLIC
Lock coordinating one-time initialization of the backend.
-
orionis.queues._database._DatabaseStorage._ensureSchema
orionis.queues._database._DatabaseStorage.html#_ensureSchema
Function
Method
PUBLIC
Create the queue table on first use.
-
orionis.queues.contracts.serializer.IJobSerializer
orionis.queues.contracts.serializer.IJobSerializer.html
Class
Class
PUBLIC
Declare explicit state serialization and trusted job registration.
-
orionis.queues.contracts.serializer.IJobSerializer.__slots__
orionis.queues.contracts.serializer.IJobSerializer.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.queues.contracts.serializer.IJobSerializer.register
orionis.queues.contracts.serializer.IJobSerializer.html#register
Function
Method
PUBLIC
Register an application-trusted concrete job class.
-
orionis.queues.contracts.serializer.IJobSerializer.encode
orionis.queues.contracts.serializer.IJobSerializer.html#encode
Function
Method
PUBLIC
Serialize only the job's declared persistent fields.
-
orionis.queues.contracts.serializer.IJobSerializer.decode
orionis.queues.contracts.serializer.IJobSerializer.html#decode
Function
Method
PUBLIC
Restore a registered job without constructing dependencies.
-
orionis.queues.contracts.serializer.IJobSerializer.encodeEnvelope
orionis.queues.contracts.serializer.IJobSerializer.html#encodeEnvelope
Function
Method
PUBLIC
Encode a versioned immutable envelope.
-
orionis.queues.contracts.serializer.IJobSerializer.decodeEnvelope
orionis.queues.contracts.serializer.IJobSerializer.html#decodeEnvelope
Function
Method
PUBLIC
Validate a stored envelope before execution.
-
orionis.queues.schema._TABLE_NAME
orionis.queues.schema.html#_TABLE_NAME
Attribute
Constant
PUBLIC
Compiled pattern used to recognize table name.
-
orionis.queues.schema.validate_table_name
orionis.queues.schema.html#validate_table_name
Function
Function
PUBLIC
Validate a logical table identifier.
-
orionis.queues.schema.build_jobs_table
orionis.queues.schema.html#build_jobs_table
Function
Function
PUBLIC
Build the portable queue storage schema.
-
orionis.queues.schema.build_failed_jobs_table
orionis.queues.schema.html#build_failed_jobs_table
Function
Function
PUBLIC
Build the portable failed-job storage schema.
-
orionis.queues.drivers.database._ENCODER
orionis.queues.drivers.database.html#_ENCODER
Attribute
Constant
PUBLIC
Encoder used by database.
-
orionis.queues.drivers.database._CLAIM_ROUNDS
orionis.queues.drivers.database.html#_CLAIM_ROUNDS
Attribute
Constant
PUBLIC
Claim rounds value used by database.
-
orionis.queues.drivers.database.eligible_clauses
orionis.queues.drivers.database.html#eligible_clauses
Function
Function
PUBLIC
Build predicates for an available or expired queue row.
-
orionis.queues.drivers.database.DatabaseQueueDriver
orionis.queues.drivers.database.DatabaseQueueDriver.html
Class
Class
PUBLIC
Persist queued jobs using atomic conditional updates and expiring leases.
-
orionis.queues.drivers.database.DatabaseQueueDriver.__slots__
orionis.queues.drivers.database.DatabaseQueueDriver.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.queues.drivers.database.DatabaseQueueDriver.__init__
orionis.queues.drivers.database.DatabaseQueueDriver.html#__init__
Function
Method
PUBLIC
Bind the queue driver to a framework database connection.
-
orionis.queues.drivers.database.DatabaseQueueDriver._connection
orionis.queues.drivers.database.DatabaseQueueDriver.html#_connection
Attribute
Instance Variable
PUBLIC
Shared framework connection used for queue persistence.
-
orionis.queues.drivers.database.DatabaseQueueDriver._definition
orionis.queues.drivers.database.DatabaseQueueDriver.html#_definition
Attribute
Instance Variable
PUBLIC
Original declaration from which runtime metadata was compiled.
-
orionis.queues.drivers.database.DatabaseQueueDriver._ready
orionis.queues.drivers.database.DatabaseQueueDriver.html#_ready
Attribute
Instance Variable
PUBLIC
Ready flag used by DatabaseQueueDriver.
-
orionis.queues.drivers.database.DatabaseQueueDriver._ready_lock
orionis.queues.drivers.database.DatabaseQueueDriver.html#_ready_lock
Attribute
Instance Variable
PUBLIC
Synchronization primitive controlling access to ready lock.
-
orionis.queues.drivers.database.DatabaseQueueDriver.push
orionis.queues.drivers.database.DatabaseQueueDriver.html#push
Function
Method
PUBLIC
Store an envelope for immediate or delayed consumption.
-
orionis.queues.drivers.database.DatabaseQueueDriver.reserve
orionis.queues.drivers.database.DatabaseQueueDriver.html#reserve
Function
Method
PUBLIC
Claim one eligible job in queue priority order.
-
orionis.queues.drivers.database.DatabaseQueueDriver._ownershipClauses
orionis.queues.drivers.database.DatabaseQueueDriver.html#_ownershipClauses
Function
Method
PUBLIC
Require a current, unexpired reservation for a transition.
-
orionis.queues.drivers.database.DatabaseQueueDriver.release
orionis.queues.drivers.database.DatabaseQueueDriver.html#release
Function
Method
PUBLIC
Release an owned reservation for another attempt.
-
orionis.queues.drivers.database.DatabaseQueueDriver.delete
orionis.queues.drivers.database.DatabaseQueueDriver.html#delete
Function
Method
PUBLIC
Acknowledge an owned reservation by removing its row.
-
orionis.queues.drivers.database.DatabaseQueueDriver.size
orionis.queues.drivers.database.DatabaseQueueDriver.html#size
Function
Method
PUBLIC
Count ready, delayed, and reserved jobs in one queue.
-
orionis.queues.drivers.database.DatabaseQueueDriver.clear
orionis.queues.drivers.database.DatabaseQueueDriver.html#clear
Function
Method
PUBLIC
Remove every job in one logical queue.
-
orionis.queues.drivers.database.DatabaseQueueDriver.close
orionis.queues.drivers.database.DatabaseQueueDriver.html#close
Function
Method
PUBLIC
Leave the shared database connection under its manager's ownership.
-
orionis.queues.drivers.redis._ENCODER
orionis.queues.drivers.redis.html#_ENCODER
Attribute
Constant
PUBLIC
Encoder used by redis.
-
orionis.queues.drivers.redis._RESERVATION_FIELDS
orionis.queues.drivers.redis.html#_RESERVATION_FIELDS
Attribute
Constant
PUBLIC
Reservation fields value used by redis.
-
orionis.queues.drivers.redis._script_digest
orionis.queues.drivers.redis.html#_script_digest
Function
Function
PUBLIC
Return Redis's SHA-1 script identifier (not a security digest).
-
orionis.queues.drivers.redis._CHECK_TYPES
orionis.queues.drivers.redis.html#_CHECK_TYPES
Attribute
Constant
PUBLIC
Validate key types before any transition can remove persisted queue state.
-
orionis.queues.drivers.redis._PUSH
orionis.queues.drivers.redis.html#_PUSH
Attribute
Constant
PUBLIC
Store the envelope and availability together without exposing partial state.
-
orionis.queues.drivers.redis._RESERVE
orionis.queues.drivers.redis.html#_RESERVE
Attribute
Constant
PUBLIC
Reclaim expired leases and move one due job into an owned reservation.
-
orionis.queues.drivers.redis._RELEASE
orionis.queues.drivers.redis.html#_RELEASE
Attribute
Constant
PUBLIC
Release only a token that still owns an unexpired lease.
-
orionis.queues.drivers.redis._DELETE
orionis.queues.drivers.redis.html#_DELETE
Attribute
Constant
PUBLIC
Remove only a token that still owns an unexpired lease.
-
orionis.queues.drivers.redis._CLEAR
orionis.queues.drivers.redis.html#_CLEAR
Attribute
Constant
PUBLIC
Remove a queue's complete state and report its previous number of jobs.
-
orionis.queues.drivers.redis.RedisQueueDriver
orionis.queues.drivers.redis.RedisQueueDriver.html
Class
Class
PUBLIC
Persist delayed jobs and fenced reservations through atomic Lua scripts.
-
orionis.queues.drivers.redis.RedisQueueDriver.__slots__
orionis.queues.drivers.redis.RedisQueueDriver.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.queues.drivers.redis.RedisQueueDriver.__init__
orionis.queues.drivers.redis.RedisQueueDriver.html#__init__
Function
Method
PUBLIC
Configure a lazy Redis transport and queue key namespace.
-
orionis.queues.drivers.redis.RedisQueueDriver._prefix
orionis.queues.drivers.redis.RedisQueueDriver.html#_prefix
Attribute
Instance Variable
PUBLIC
Prefix applied when constructing names or storage keys.
-
orionis.queues.drivers.redis.RedisQueueDriver._owns_client
orionis.queues.drivers.redis.RedisQueueDriver.html#_owns_client
Attribute
Instance Variable
PUBLIC
Whether this object must close the client during its own cleanup.
-
orionis.queues.drivers.redis.RedisQueueDriver._client
orionis.queues.drivers.redis.RedisQueueDriver.html#_client
Attribute
Instance Variable
PUBLIC
Externally owned async client, primarily for explicit test fakes.
-
orionis.queues.drivers.redis.RedisQueueDriver._keys
orionis.queues.drivers.redis.RedisQueueDriver.html#_keys
Function
Method
PUBLIC
Return colocated keys for one logical queue.
-
orionis.queues.drivers.redis.RedisQueueDriver._executeScript
orionis.queues.drivers.redis.RedisQueueDriver.html#_executeScript
Function
Method
PUBLIC
Execute one atomic Redis transition and translate transport errors.
-
orionis.queues.drivers.redis.RedisQueueDriver.push
orionis.queues.drivers.redis.RedisQueueDriver.html#push
Function
Method
PUBLIC
Store an envelope and its availability atomically.
-
orionis.queues.drivers.redis.RedisQueueDriver.reserve
orionis.queues.drivers.redis.RedisQueueDriver.html#reserve
Function
Method
PUBLIC
Claim one due job in queue priority order.
-
orionis.queues.drivers.redis.RedisQueueDriver.release
orionis.queues.drivers.redis.RedisQueueDriver.html#release
Function
Method
PUBLIC
Release a currently owned reservation with optional delay.
-
orionis.queues.drivers.redis.RedisQueueDriver.delete
orionis.queues.drivers.redis.RedisQueueDriver.html#delete
Function
Method
PUBLIC
Acknowledge a currently owned reservation atomically.
-
orionis.queues.drivers.redis.RedisQueueDriver.size
orionis.queues.drivers.redis.RedisQueueDriver.html#size
Function
Method
PUBLIC
Count ready, delayed, and reserved jobs in one queue.
-
orionis.queues.drivers.redis.RedisQueueDriver.clear
orionis.queues.drivers.redis.RedisQueueDriver.html#clear
Function
Method
PUBLIC
Remove every job and reservation in one queue atomically.
-
orionis.queues.drivers.redis.RedisQueueDriver.close
orionis.queues.drivers.redis.RedisQueueDriver.html#close
Function
Method
PUBLIC
Close the transport only when this driver owns its Redis client.
-
orionis.queues.worker._LOGGER
orionis.queues.worker.html#_LOGGER
Attribute
Constant
PUBLIC
Logger used by worker.
-
orionis.queues.worker.FailedResolver
orionis.queues.worker.html#FailedResolver
Attribute
Type Alias
PUBLIC
Type alias for Callable[[], Awaitable[IFailedJobRepository]].
-
orionis.queues.worker.WorkerOptions
orionis.queues.worker.WorkerOptions.html
Class
Class
PUBLIC
Retain stable validated settings for an independent worker runtime.
-
orionis.queues.worker.WorkerOptions.connection
orionis.queues.worker.WorkerOptions.html#connection
Attribute
Class Variable
PUBLIC
Configured connection used to store or dispatch the operation.
-
orionis.queues.worker.WorkerOptions.queues
orionis.queues.worker.WorkerOptions.html#queues
Attribute
Class Variable
PUBLIC
Queue names selected for worker polling.
-
orionis.queues.worker.WorkerOptions.concurrency
orionis.queues.worker.WorkerOptions.html#concurrency
Attribute
Class Variable
PUBLIC
Concurrency value used by WorkerOptions.
-
orionis.queues.worker.WorkerOptions.retry_after
orionis.queues.worker.WorkerOptions.html#retry_after
Attribute
Class Variable
PUBLIC
Retry after value used by WorkerOptions.
-
orionis.queues.worker.WorkerOptions.sleep
orionis.queues.worker.WorkerOptions.html#sleep
Attribute
Class Variable
PUBLIC
Sleep value used by WorkerOptions.
-
orionis.queues.worker.WorkerOptions.__post_init__
orionis.queues.worker.WorkerOptions.html#__post_init__
Function
Method
PUBLIC
Validate concurrency, queue routing, and worker polling settings.
-
orionis.queues.worker.Worker
orionis.queues.worker.Worker.html
Class
Class
PUBLIC
Consume leased jobs through isolated Orionis dependency scopes.
-
orionis.queues.worker.Worker.__slots__
orionis.queues.worker.Worker.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.queues.worker.Worker.__init__
orionis.queues.worker.Worker.html#__init__
Function
Method
PUBLIC
Initialize a worker without opening queue-backend connections.
-
orionis.queues.worker.Worker._app
orionis.queues.worker.Worker.html#_app
Attribute
Instance Variable
PUBLIC
Application container used to create an isolated scope per job.
-
orionis.queues.worker.Worker._driver
orionis.queues.worker.Worker.html#_driver
Attribute
Instance Variable
PUBLIC
Backend used to reserve, release and acknowledge jobs.
-
orionis.queues.worker.Worker._serializer
orionis.queues.worker.Worker.html#_serializer
Attribute
Instance Variable
PUBLIC
Serializer used to restore envelopes and registered jobs.
-
orionis.queues.worker.Worker._connection
orionis.queues.worker.Worker.html#_connection
Attribute
Instance Variable
PUBLIC
Configured connection used to store or dispatch the operation.
-
orionis.queues.worker.Worker._queues
orionis.queues.worker.Worker.html#_queues
Attribute
Instance Variable
PUBLIC
Queue names selected for worker polling.
-
orionis.queues.worker.Worker._concurrency
orionis.queues.worker.Worker.html#_concurrency
Attribute
Instance Variable
PUBLIC
Concurrency obtained from options.concurrency.
-
orionis.queues.worker.Worker._retry_after
orionis.queues.worker.Worker.html#_retry_after
Attribute
Instance Variable
PUBLIC
Retry after obtained from options.retry_after.
-
orionis.queues.worker.Worker._sleep
orionis.queues.worker.Worker.html#_sleep
Attribute
Instance Variable
PUBLIC
Sleep obtained from options.sleep.
-
orionis.queues.worker.Worker._failed
orionis.queues.worker.Worker.html#_failed
Attribute
Instance Variable
PUBLIC
Failure repository or async resolver invoked on terminal failure. If None, terminal failures cannot be recorded.
-
orionis.queues.worker.Worker._failed_resolver
orionis.queues.worker.Worker.html#_failed_resolver
Attribute
Instance Variable
PUBLIC
Resolver supplying the configured failed-job storage backend.
-
orionis.queues.worker.Worker._stop
orionis.queues.worker.Worker.html#_stop
Attribute
Instance Variable
PUBLIC
Stop produced by asyncio.Event.
-
orionis.queues.worker.Worker._running
orionis.queues.worker.Worker.html#_running
Attribute
Instance Variable
PUBLIC
Running flag used by Worker.
-
orionis.queues.worker.Worker._started
orionis.queues.worker.Worker.html#_started
Attribute
Instance Variable
PUBLIC
Started value used by Worker.
-
orionis.queues.worker.Worker._processed
orionis.queues.worker.Worker.html#_processed
Attribute
Instance Variable
PUBLIC
Processed value used by Worker.
-
orionis.queues.worker.Worker.stop
orionis.queues.worker.Worker.html#stop
Function
Method
PUBLIC
Signal consumers to stop after their in-flight reservations finish.
-
orionis.queues.worker.Worker.run
orionis.queues.worker.Worker.html#run
Function
Method
PUBLIC
Run concurrent consumers under shared stop and reservation limits.
-
orionis.queues.worker.Worker._consume
orionis.queues.worker.Worker.html#_consume
Function
Method
PUBLIC
Run one consumer in an isolated queue-failure observation context.
-
orionis.queues.worker.Worker._consumeJobs
orionis.queues.worker.Worker.html#_consumeJobs
Function
Method
PUBLIC
Reserve and execute jobs within the worker's shared reservation budget.
-
orionis.queues.worker.Worker._validateReservation
orionis.queues.worker.Worker.html#_validateReservation
Function
Method
PUBLIC
Validate reservation routing, timeout compatibility, and retry eligibility.
-
orionis.queues.worker.Worker.execute
orionis.queues.worker.Worker.html#execute
Function
Method
PUBLIC
Execute one leased job in an isolated scope and apply its lifecycle outcome.
-
orionis.queues.worker.Worker._releaseCancelled
orionis.queues.worker.Worker.html#_releaseCancelled
Function
Method
PUBLIC
Attempt reservation release while preserving the original cancellation.
-
orionis.queues.worker.Worker._observe
orionis.queues.worker.Worker.html#_observe
Function
Method
PUBLIC
Observe a job failure without letting fallback logging replace it.
-
orionis.queues.worker.Worker._finish
orionis.queues.worker.Worker.html#_finish
Function
Method
PUBLIC
Acknowledge unfinished work or propagate an explicitly recorded job failure.
-
orionis.queues.worker.Worker._handleFailure
orionis.queues.worker.Worker.html#_handleFailure
Function
Method
PUBLIC
Select a delayed retry or terminal handling from the envelope's policy.
-
orionis.queues.worker.Worker._fail
orionis.queues.worker.Worker.html#_fail
Function
Method
PUBLIC
Record a terminal job failure before deleting its leased reservation.
-
orionis.queues.drivers.sync.SyncQueueDriver
orionis.queues.drivers.sync.SyncQueueDriver.html
Class
Class
PUBLIC
Execute one immediate attempt through the shared worker pipeline.
-
orionis.queues.drivers.sync.SyncQueueDriver.__slots__
orionis.queues.drivers.sync.SyncQueueDriver.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.queues.drivers.sync.SyncQueueDriver.__init__
orionis.queues.drivers.sync.SyncQueueDriver.html#__init__
Function
Method
PUBLIC
Prepare immediate execution without a durable backend.
-
orionis.queues.drivers.sync.SyncQueueDriver._serializer
orionis.queues.drivers.sync.SyncQueueDriver.html#_serializer
Attribute
Instance Variable
PUBLIC
Registered job serializer.
-
orionis.queues.drivers.sync.SyncQueueDriver._retry_after
orionis.queues.drivers.sync.SyncQueueDriver.html#_retry_after
Attribute
Instance Variable
PUBLIC
Execution lease used by the shared pipeline.
-
orionis.queues.drivers.sync.SyncQueueDriver._worker
orionis.queues.drivers.sync.SyncQueueDriver.html#_worker
Attribute
Instance Variable
PUBLIC
Worker produced by Worker.
-
orionis.queues.drivers.sync.SyncQueueDriver.push
orionis.queues.drivers.sync.SyncQueueDriver.html#push
Function
Method
PUBLIC
Execute the job immediately and propagate its original exception.
-
orionis.queues.drivers.sync.SyncQueueDriver.reserve
orionis.queues.drivers.sync.SyncQueueDriver.html#reserve
Function
Method
PUBLIC
Return no durable work for an immediate connection.
-
orionis.queues.drivers.sync.SyncQueueDriver.release
orionis.queues.drivers.sync.SyncQueueDriver.html#release
Function
Method
PUBLIC
Reject persistent retry on an immediate connection.
-
orionis.queues.drivers.sync.SyncQueueDriver.delete
orionis.queues.drivers.sync.SyncQueueDriver.html#delete
Function
Method
PUBLIC
Acknowledge completion of an immediate execution.
-
orionis.queues.drivers.sync.SyncQueueDriver.size
orionis.queues.drivers.sync.SyncQueueDriver.html#size
Function
Method
PUBLIC
Return the empty durable size of an immediate channel.
-
orionis.queues.drivers.sync.SyncQueueDriver.clear
orionis.queues.drivers.sync.SyncQueueDriver.html#clear
Function
Method
PUBLIC
Return zero removed jobs for an immediate channel.
-
orionis.queues.drivers.sync.SyncQueueDriver.close
orionis.queues.drivers.sync.SyncQueueDriver.html#close
Function
Method
PUBLIC
Signal the worker to stop without closing application services.
-
orionis.queues.failed.repository.DatabaseFailedJobRepository
orionis.queues.failed.repository.DatabaseFailedJobRepository.html
Class
Class
PUBLIC
Retain failed envelopes and diagnostics in framework-owned DB storage.
-
orionis.queues.failed.repository.DatabaseFailedJobRepository.__slots__
orionis.queues.failed.repository.DatabaseFailedJobRepository.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.queues.failed.repository.DatabaseFailedJobRepository.__init__
orionis.queues.failed.repository.DatabaseFailedJobRepository.html#__init__
Function
Method
PUBLIC
Bind failure storage to a framework database connection.
-
orionis.queues.failed.repository.DatabaseFailedJobRepository._connection
orionis.queues.failed.repository.DatabaseFailedJobRepository.html#_connection
Attribute
Instance Variable
PUBLIC
Shared framework connection used for failure persistence.
-
orionis.queues.failed.repository.DatabaseFailedJobRepository._definition
orionis.queues.failed.repository.DatabaseFailedJobRepository.html#_definition
Attribute
Instance Variable
PUBLIC
Original declaration from which runtime metadata was compiled.
-
orionis.queues.failed.repository.DatabaseFailedJobRepository._ready
orionis.queues.failed.repository.DatabaseFailedJobRepository.html#_ready
Attribute
Instance Variable
PUBLIC
Ready flag used by DatabaseFailedJobRepository.
-
orionis.queues.failed.repository.DatabaseFailedJobRepository._ready_lock
orionis.queues.failed.repository.DatabaseFailedJobRepository.html#_ready_lock
Attribute
Instance Variable
PUBLIC
Synchronization primitive controlling access to ready lock.
-
orionis.queues.failed.repository.DatabaseFailedJobRepository.record
orionis.queues.failed.repository.DatabaseFailedJobRepository.html#record
Function
Method
PUBLIC
Record a terminal failure once for this reservation token.
-
orionis.queues.failed.repository.DatabaseFailedJobRepository.all
orionis.queues.failed.repository.DatabaseFailedJobRepository.html#all
Function
Method
PUBLIC
Return recorded failures in chronological order.
-
orionis.queues.failed.repository.DatabaseFailedJobRepository.find
orionis.queues.failed.repository.DatabaseFailedJobRepository.html#find
Function
Method
PUBLIC
Find one persisted failure by identifier.
-
orionis.queues.failed.repository.DatabaseFailedJobRepository.forget
orionis.queues.failed.repository.DatabaseFailedJobRepository.html#forget
Function
Method
PUBLIC
Remove one recorded failure.
-
orionis.queues.failed.repository.DatabaseFailedJobRepository.close
orionis.queues.failed.repository.DatabaseFailedJobRepository.html#close
Function
Method
PUBLIC
Leave the shared database connection under its manager's ownership.
-
orionis.queues.manager._discover_jobs
orionis.queues.manager.html#_discover_jobs
Function
Function
PUBLIC
Import modules from the application jobs directory and collect jobs.
-
orionis.queues.manager.QueueManager
orionis.queues.manager.QueueManager.html
Class
Class
PUBLIC
Resolve lazy connections and expose the canonical deferred dispatch API.
-
orionis.queues.manager.QueueManager.__slots__
orionis.queues.manager.QueueManager.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.queues.manager.QueueManager.__init__
orionis.queues.manager.QueueManager.html#__init__
Function
Method
PUBLIC
Validate and serialize queue settings without opening backend clients.
-
orionis.queues.manager.QueueManager._app
orionis.queues.manager.QueueManager.html#_app
Attribute
Instance Variable
PUBLIC
Existing application container.
-
orionis.queues.manager.QueueManager._serializer
orionis.queues.manager.QueueManager.html#_serializer
Attribute
Instance Variable
PUBLIC
Singleton registered-job serializer.
-
orionis.queues.manager.QueueManager._config
orionis.queues.manager.QueueManager.html#_config
Attribute
Instance Variable
PUBLIC
Validated configuration used to construct and operate the service.
-
orionis.queues.manager.QueueManager._drivers
orionis.queues.manager.QueueManager.html#_drivers
Attribute
Instance Variable
PUBLIC
Configured backend drivers cached by their registered names.
-
orionis.queues.manager.QueueManager._driver_lock
orionis.queues.manager.QueueManager.html#_driver_lock
Attribute
Instance Variable
PUBLIC
Synchronization primitive controlling access to driver lock.
-
orionis.queues.manager.QueueManager._driver_owner
orionis.queues.manager.QueueManager.html#_driver_owner
Attribute
Instance Variable
PUBLIC
Task currently initializing a driver under its publication lock.
-
orionis.queues.manager.QueueManager._failed
orionis.queues.manager.QueueManager.html#_failed
Attribute
Instance Variable
PUBLIC
Backend retaining failed-job records.
-
orionis.queues.manager.QueueManager._failed_lock
orionis.queues.manager.QueueManager.html#_failed_lock
Attribute
Instance Variable
PUBLIC
Synchronization primitive controlling access to failed lock.
-
orionis.queues.manager.QueueManager._failed_owner
orionis.queues.manager.QueueManager.html#_failed_owner
Attribute
Instance Variable
PUBLIC
Task currently initializing the failed-job repository.
-
orionis.queues.manager.QueueManager.boot
orionis.queues.manager.QueueManager.html#boot
Function
Method
PUBLIC
Register jobs from the application's configured jobs path.
-
orionis.queues.manager.QueueManager.dispatch
orionis.queues.manager.QueueManager.html#dispatch
Function
Method
PUBLIC
Create one awaitable dispatch without serializing or persisting data.
-
orionis.queues.manager.QueueManager._connectionName
orionis.queues.manager.QueueManager.html#_connectionName
Function
Method
PUBLIC
Validate selection against the configured named backends.
-
orionis.queues.manager.QueueManager._submit
orionis.queues.manager.QueueManager.html#_submit
Function
Method
PUBLIC
Serialize validated job options and submit to the selected backend.
-
orionis.queues.manager.QueueManager.connection
orionis.queues.manager.QueueManager.html#connection
Function
Method
PUBLIC
Resolve one shared lazy driver for the selected named connection.
-
orionis.queues.manager.QueueManager._createDriver
orionis.queues.manager.QueueManager.html#_createDriver
Function
Method
PUBLIC
Construct a configured driver through framework database services.
-
orionis.queues.manager.QueueManager.worker
orionis.queues.manager.QueueManager.html#worker
Function
Method
PUBLIC
Create an independent persistent worker using validated defaults.
-
orionis.queues.manager.QueueManager.failed
orionis.queues.manager.QueueManager.html#failed
Function
Method
PUBLIC
Resolve durable failed-job storage only when first requested.
-
orionis.queues.manager.QueueManager.migrate
orionis.queues.manager.QueueManager.html#migrate
Function
Method
PUBLIC
Create every configured database queue table and failed-job storage.
-
orionis.queues.manager.QueueManager.retryFailed
orionis.queues.manager.QueueManager.html#retryFailed
Function
Method
PUBLIC
Requeue preserved job data with attempts reset by a fresh push.
-
orionis.queues.manager.QueueManager.close
orionis.queues.manager.QueueManager.html#close
Function
Method
PUBLIC
Release queue-owned resources without closing shared database services.
-
orionis.queues.manager.QueueManager._closeOwned
orionis.queues.manager.QueueManager.html#_closeOwned
Function
Method
PUBLIC
Detach initialized resources and attempt every owned cleanup.
-
orionis.queues.serializer._MAX_PAYLOAD_BYTES
orionis.queues.serializer.html#_MAX_PAYLOAD_BYTES
Attribute
Constant
PUBLIC
Max payload bytes used by serializer.
-
orionis.queues.serializer._MAX_STATE_DEPTH
orionis.queues.serializer.html#_MAX_STATE_DEPTH
Attribute
Constant
PUBLIC
Max state depth value used by serializer.
-
orionis.queues.serializer._TUPLE_EXTENSION
orionis.queues.serializer.html#_TUPLE_EXTENSION
Attribute
Constant
PUBLIC
Tuple extension value used by serializer.
-
orionis.queues.serializer._OPTIONS
orionis.queues.serializer.html#_OPTIONS
Attribute
Constant
PUBLIC
Options used by serializer.
-
orionis.queues.serializer._SCALAR_TYPES
orionis.queues.serializer.html#_SCALAR_TYPES
Attribute
Constant
PUBLIC
Scalar types used by serializer.
-
orionis.queues.serializer._JobMetadata
orionis.queues.serializer._JobMetadata.html
Class
Class
PUBLIC
Retain trusted class metadata independently of live job instances.
-
orionis.queues.serializer._JobMetadata.job_type
orionis.queues.serializer._JobMetadata.html#job_type
Attribute
Class Variable
PUBLIC
Job class associated with the compiled serialization metadata.
-
orionis.queues.serializer._JobMetadata.names
orionis.queues.serializer._JobMetadata.html#names
Attribute
Class Variable
PUBLIC
Field names accepted by the compiled serializer.
-
orionis.queues.serializer._JobMetadata.name_set
orionis.queues.serializer._JobMetadata.html#name_set
Attribute
Class Variable
PUBLIC
Field-name set used for fast validation of serialized input.
-
orionis.queues.serializer._JobMetadata.annotations
orionis.queues.serializer._JobMetadata.html#annotations
Attribute
Class Variable
PUBLIC
Declared metadata describing behavior or validation types.
-
orionis.queues.serializer._validate_annotation
orionis.queues.serializer.html#_validate_annotation
Function
Function
PUBLIC
Check whether a field annotation contains only supported state types.
-
orionis.queues.serializer._pack_value
orionis.queues.serializer.html#_pack_value
Function
Function
PUBLIC
Validate owned primitive data and tag tuples in MessagePack.
-
orionis.queues.serializer._validate_unpacked_value
orionis.queues.serializer.html#_validate_unpacked_value
Function
Function
PUBLIC
Validate decoded primitive state without rebuilding its containers.
-
orionis.queues.serializer._unpack_extension
orionis.queues.serializer.html#_unpack_extension
Function
Function
PUBLIC
Restore the tuple extension without importing or invoking payload types.
-
orionis.queues.serializer._collect_job_fields
orionis.queues.serializer.html#_collect_job_fields
Function
Function
PUBLIC
Collect one job class's declared slots and resolved persistent annotations.
-
orionis.queues.serializer._job_metadata
orionis.queues.serializer.html#_job_metadata
Function
Function
PUBLIC
Collect inherited persistent slots and annotations from a trusted class.
-
orionis.queues.serializer.JobSerializer
orionis.queues.serializer.JobSerializer.html
Class
Class
PUBLIC
Serialize explicit job state through a registry of application-trusted types.
-
orionis.queues.serializer.JobSerializer.__slots__
orionis.queues.serializer.JobSerializer.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.queues.serializer.JobSerializer.__init__
orionis.queues.serializer.JobSerializer.html#__init__
Function
Method
PUBLIC
Initialize reusable codecs and an empty trusted registry.
-
orionis.queues.serializer.JobSerializer._registry
orionis.queues.serializer.JobSerializer.html#_registry
Attribute
Instance Variable
PUBLIC
Registered implementations indexed by their public identifiers.
-
orionis.queues.serializer.JobSerializer._types
orionis.queues.serializer.JobSerializer.html#_types
Attribute
Instance Variable
PUBLIC
Types registered for validation, serialization or schema operations.
-
orionis.queues.serializer.JobSerializer._encoder
orionis.queues.serializer.JobSerializer.html#_encoder
Attribute
Instance Variable
PUBLIC
Encoder produced by msgspec.json.Encoder.
-
orionis.queues.serializer.JobSerializer._decoder
orionis.queues.serializer.JobSerializer.html#_decoder
Attribute
Instance Variable
PUBLIC
Decoder produced by msgspec.json.Decoder.
-
orionis.queues.serializer.JobSerializer._state_decoder
orionis.queues.serializer.JobSerializer.html#_state_decoder
Attribute
Instance Variable
PUBLIC
State decoder produced by msgspec.msgpack.Decoder.
-
orionis.queues.serializer.JobSerializer.register
orionis.queues.serializer.JobSerializer.html#register
Function
Method
PUBLIC
Register a concrete async job class supplied by trusted application code.
-
orionis.queues.serializer.JobSerializer.encode
orionis.queues.serializer.JobSerializer.html#encode
Function
Method
PUBLIC
Serialize declared fields while rejecting service and undeclared state.
-
orionis.queues.serializer.JobSerializer.decode
orionis.queues.serializer.JobSerializer.html#decode
Function
Method
PUBLIC
Restore primitive fields for a registered identity without running init.
-
orionis.queues.serializer.JobSerializer._validateFields
orionis.queues.serializer.JobSerializer.html#_validateFields
Function
Method
PUBLIC
Validate annotated fields without accepting arbitrary application types.
-
orionis.queues.serializer.JobSerializer._checkSize
orionis.queues.serializer.JobSerializer.html#_checkSize
Function
Method
PUBLIC
Reject oversized or nonbinary wire data before decoding.
-
orionis.queues.serializer.JobSerializer.encodeEnvelope
orionis.queues.serializer.JobSerializer.html#encodeEnvelope
Function
Method
PUBLIC
Encode the immutable envelope as explicit versioned JSON.
-
orionis.queues.serializer.JobSerializer.decodeEnvelope
orionis.queues.serializer.JobSerializer.html#decodeEnvelope
Function
Method
PUBLIC
Validate untrusted envelope JSON without resolving its job type.
-
orionis.queues.provider.QueueProvider
orionis.queues.provider.QueueProvider.html
Class
Class
PUBLIC
Register queue services eagerly while keeping backend I/O lazy.
-
orionis.queues.provider.QueueProvider.__slots__
orionis.queues.provider.QueueProvider.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.queues.provider.QueueProvider.register
orionis.queues.provider.QueueProvider.html#register
Function
Method
PUBLIC
Bind the job serializer and queue manager as application singletons.
-
orionis.queues.provider.QueueProvider.boot
orionis.queues.provider.QueueProvider.html#boot
Function
Method
PUBLIC
Discover application jobs and configure the queue service lifecycle.
-
orionis.realtime.HubClients
orionis.realtime.HubClients.html
Class
Class
PUBLIC
Select ready clients within one Hub in the current worker.
-
orionis.realtime.HubClients.__slots__
orionis.realtime.HubClients.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.realtime.HubClients.__init__
orionis.realtime.HubClients.html#__init__
Function
Method
PUBLIC
Bind Hub-local client selection to an optional caller.
-
orionis.realtime.HubClients._manager
orionis.realtime.HubClients.html#_manager
Attribute
Instance Variable
PUBLIC
Registry owning the connections.
-
orionis.realtime.HubClients._hub
orionis.realtime.HubClients.html#_hub
Attribute
Instance Variable
PUBLIC
Hub namespace selecting eligible clients.
-
orionis.realtime.HubClients._caller_id
orionis.realtime.HubClients.html#_caller_id
Attribute
Instance Variable
PUBLIC
Current connection identifier; absent for application services.
-
orionis.realtime.HubClients.all
orionis.realtime.HubClients.html#all
Attribute
Property
PUBLIC
Return a target for every ready connection to this Hub.
-
orionis.realtime.HubClients.caller
orionis.realtime.HubClients.html#caller
Attribute
Property
PUBLIC
Return a target for the calling connection.
-
orionis.realtime.HubClients.others
orionis.realtime.HubClients.html#others
Attribute
Property
PUBLIC
Return a target excluding the calling connection.
-
orionis.realtime.HubClients._caller
orionis.realtime.HubClients.html#_caller
Function
Method
PUBLIC
Require a connection-specific caller identifier.
-
orionis.realtime.HubClients.client
orionis.realtime.HubClients.html#client
Function
Method
PUBLIC
Select one connection for event delivery or bidirectional invocation.
-
orionis.realtime.HubClients.clients
orionis.realtime.HubClients.html#clients
Function
Method
PUBLIC
Select explicit recipients, preserving order and removing duplicates.
-
orionis.realtime.HubClients.group
orionis.realtime.HubClients.html#group
Function
Method
PUBLIC
Select a named group within this Hub namespace.
-
orionis.realtime.remote
orionis.realtime.html#remote
Function
Function
PUBLIC
Mark an instance method for remote dispatch without wrapping it.
-
orionis.realtime.BroadcastResult
orionis.realtime.BroadcastResult.html
Class
Class
PUBLIC
Count delivered and failed recipients without retaining connections.
-
orionis.realtime.BroadcastResult.sent
orionis.realtime.BroadcastResult.html#sent
Attribute
Class Variable
PUBLIC
Sent value used by BroadcastResult.
-
orionis.realtime.BroadcastResult.failed
orionis.realtime.BroadcastResult.html#failed
Attribute
Class Variable
PUBLIC
Failed value used by BroadcastResult.
-
orionis.realtime.HubGroups
orionis.realtime.HubGroups.html
Class
Class
PUBLIC
Manage group membership owned by the current Hub connection.
-
orionis.realtime.HubGroups.__slots__
orionis.realtime.HubGroups.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.realtime.HubGroups.__init__
orionis.realtime.HubGroups.html#__init__
Function
Method
PUBLIC
Bind membership operations to one owned connection.
-
orionis.realtime.HubGroups._manager
orionis.realtime.HubGroups.html#_manager
Attribute
Instance Variable
PUBLIC
Registry owning this connection and its Hub namespace.
-
orionis.realtime.HubGroups._connection_id
orionis.realtime.HubGroups.html#_connection_id
Attribute
Instance Variable
PUBLIC
Current connection identifier.
-
orionis.realtime.HubGroups.join
orionis.realtime.HubGroups.html#join
Function
Method
PUBLIC
Join a group without consuming another slot for existing membership.
-
orionis.realtime.HubGroups.leave
orionis.realtime.HubGroups.html#leave
Function
Method
PUBLIC
Remove the current connection from one group idempotently.
-
orionis.realtime.Hub
orionis.realtime.Hub.html
Class
Class
PUBLIC
Define an invocation-scoped realtime endpoint with explicit remote methods.
-
orionis.realtime.Hub.__slots__
orionis.realtime.Hub.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.realtime.Hub.context
orionis.realtime.Hub.html#context
Attribute
Class Variable
PUBLIC
Runtime context made available to the operation and its callbacks.
-
orionis.realtime.Hub.clients
orionis.realtime.Hub.html#clients
Attribute
Class Variable
PUBLIC
Client-target selector available to hub handlers.
-
orionis.realtime.Hub.groups
orionis.realtime.Hub.html#groups
Attribute
Class Variable
PUBLIC
Realtime group membership and targeting interface.
-
orionis.realtime.Hub.onConnect
orionis.realtime.Hub.html#onConnect
Function
Method
PUBLIC
Run connection initialization before the ready envelope is sent.
-
orionis.realtime.Hub.onDisconnect
orionis.realtime.Hub.html#onDisconnect
Function
Method
PUBLIC
Run after connection-owned calls and registrations are released.
-
orionis.realtime.HubContext
orionis.realtime.HubContext.html
Class
Class
PUBLIC
Expose connection identity without providing service location.
-
orionis.realtime.HubContext.connection_id
orionis.realtime.HubContext.html#connection_id
Attribute
Class Variable
PUBLIC
Identifier of the current realtime connection.
-
orionis.realtime.HubContext.socket
orionis.realtime.HubContext.html#socket
Attribute
Class Variable
PUBLIC
WebSocket associated with the current realtime invocation.
-
orionis.realtime.HubContext.user
orionis.realtime.HubContext.html#user
Attribute
Class Variable
PUBLIC
Authenticated identity associated with the current connection.
-
orionis.realtime.manager._Broadcast
orionis.realtime.manager._Broadcast.html
Class
Class
PUBLIC
Share one immutable encoded payload per codec among bounded workers.
-
orionis.realtime.manager._Broadcast.__slots__
orionis.realtime.manager._Broadcast.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.realtime.manager._Broadcast.__init__
orionis.realtime.manager._Broadcast.html#__init__
Function
Method
PUBLIC
Share recipient iteration, encoded frames, and counters across workers.
-
orionis.realtime.manager._Broadcast.manager
orionis.realtime.manager._Broadcast.html#manager
Attribute
Instance Variable
PUBLIC
Registry used to recheck availability immediately before sending.
-
orionis.realtime.manager._Broadcast.hub
orionis.realtime.manager._Broadcast.html#hub
Attribute
Instance Variable
PUBLIC
Hub namespace restricting all recipients.
-
orionis.realtime.manager._Broadcast.recipients
orionis.realtime.manager._Broadcast.html#recipients
Attribute
Instance Variable
PUBLIC
Snapshot of recipient identifiers; no connections are retained.
-
orionis.realtime.manager._Broadcast.encoded
orionis.realtime.manager._Broadcast.html#encoded
Attribute
Instance Variable
PUBLIC
Immutable frame payloads, encoded once per selected codec.
-
orionis.realtime.manager._Broadcast.sent
orionis.realtime.manager._Broadcast.html#sent
Attribute
Instance Variable
PUBLIC
Sent value used by _Broadcast.
-
orionis.realtime.manager._Broadcast.failed
orionis.realtime.manager._Broadcast.html#failed
Attribute
Instance Variable
PUBLIC
Failed value used by _Broadcast.
-
orionis.realtime.manager._Broadcast.run
orionis.realtime.manager._Broadcast.html#run
Function
Method
PUBLIC
Drain the shared recipient iterator and count per-connection outcomes.
-
orionis.realtime.ConnectionManager
orionis.realtime.ConnectionManager.html
Class
Class
PUBLIC
Own worker-local connections and isolate every group by Hub class.
-
orionis.realtime.ConnectionManager.__slots__
orionis.realtime.ConnectionManager.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.realtime.ConnectionManager.__init__
orionis.realtime.ConnectionManager.html#__init__
Function
Method
PUBLIC
Initialize connection and Hub-local group registries with validated limits.
-
orionis.realtime.ConnectionManager._config
orionis.realtime.ConnectionManager.html#_config
Attribute
Instance Variable
PUBLIC
Group and broadcast limits shared by this application.
-
orionis.realtime.ConnectionManager._connections
orionis.realtime.ConnectionManager.html#_connections
Attribute
Instance Variable
PUBLIC
Active realtime connections indexed by identifier.
-
orionis.realtime.ConnectionManager._hubs
orionis.realtime.ConnectionManager.html#_hubs
Attribute
Instance Variable
PUBLIC
Hub registrations associated with active connections.
-
orionis.realtime.ConnectionManager._groups
orionis.realtime.ConnectionManager.html#_groups
Attribute
Instance Variable
PUBLIC
Realtime group membership and targeting interface.
-
orionis.realtime.ConnectionManager._memberships
orionis.realtime.ConnectionManager.html#_memberships
Attribute
Instance Variable
PUBLIC
Group memberships indexed by connection identifier.
-
orionis.realtime.ConnectionManager.config
orionis.realtime.ConnectionManager.html#config
Attribute
Property
PUBLIC
Return the application-wide realtime configuration.
-
orionis.realtime.ConnectionManager.connectionCount
orionis.realtime.ConnectionManager.html#connectionCount
Attribute
Property
PUBLIC
Count registered connections regardless of readiness or closing state.
-
orionis.realtime.ConnectionManager.groupCount
orionis.realtime.ConnectionManager.html#groupCount
Attribute
Property
PUBLIC
Count nonempty groups across all Hub namespaces.
-
orionis.realtime.ConnectionManager.register
orionis.realtime.ConnectionManager.html#register
Function
Method
PUBLIC
Register a connection and its initial Hub-local membership state.
-
orionis.realtime.ConnectionManager.unregister
orionis.realtime.ConnectionManager.html#unregister
Function
Method
PUBLIC
Remove one owned connection and all of its group memberships.
-
orionis.realtime.ConnectionManager.get
orionis.realtime.ConnectionManager.html#get
Function
Method
PUBLIC
Return a ready, nonclosing connection within an optional Hub namespace.
-
orionis.realtime.ConnectionManager.snapshot
orionis.realtime.ConnectionManager.html#snapshot
Function
Method
PUBLIC
Return all currently owned connections for lifecycle coordination.
-
orionis.realtime.ConnectionManager.connectionIds
orionis.realtime.ConnectionManager.html#connectionIds
Function
Method
PUBLIC
Snapshot ready, nonclosing connection identifiers in one Hub namespace.
-
orionis.realtime.ConnectionManager.groupIds
orionis.realtime.ConnectionManager.html#groupIds
Function
Method
PUBLIC
Snapshot ready, nonclosing group members within one Hub namespace.
-
orionis.realtime.ConnectionManager.join
orionis.realtime.ConnectionManager.html#join
Function
Method
PUBLIC
Join a nonclosing owned connection to a Hub-local group.
-
orionis.realtime.ConnectionManager.leave
orionis.realtime.ConnectionManager.html#leave
Function
Method
PUBLIC
Remove an owned membership and discard empty Hub-local groups.
-
orionis.realtime.ConnectionManager.hub
orionis.realtime.ConnectionManager.html#hub
Function
Method
PUBLIC
Create application-service client selectors for one Hub class.
-
orionis.realtime.ConnectionManager.broadcast
orionis.realtime.ConnectionManager.html#broadcast
Function
Method
PUBLIC
Broadcast an envelope with per-codec encoding and bounded concurrency.
-
orionis.realtime.HubProtocol
orionis.realtime.HubProtocol.html
Class
Class
PUBLIC
Encode Orionis Realtime v1 using route-selected JSON or MessagePack.
-
orionis.realtime.HubProtocol.__slots__
orionis.realtime.HubProtocol.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.realtime.HubProtocol.__init__
orionis.realtime.HubProtocol.html#__init__
Function
Method
PUBLIC
Prepare reusable msgspec codecs without connection or task ownership.
-
orionis.realtime.HubProtocol.name
orionis.realtime.HubProtocol.html#name
Attribute
Instance Variable
PUBLIC
json for text frames or msgpack for binary frames.
-
orionis.realtime.HubProtocol._max_message_size
orionis.realtime.HubProtocol.html#_max_message_size
Attribute
Instance Variable
PUBLIC
Maximum incoming UTF-8 or binary byte length.
-
orionis.realtime.HubProtocol._decoder
orionis.realtime.HubProtocol.html#_decoder
Attribute
Instance Variable
PUBLIC
Decoder produced by codec.Decoder.
-
orionis.realtime.HubProtocol._encoder
orionis.realtime.HubProtocol.html#_encoder
Attribute
Instance Variable
PUBLIC
Encoder produced by codec.Encoder.
-
orionis.realtime.HubProtocol.decode
orionis.realtime.HubProtocol.html#decode
Function
Method
PUBLIC
Decode and validate one client envelope from a complete socket message.
-
orionis.realtime.HubProtocol.encode
orionis.realtime.HubProtocol.html#encode
Function
Method
PUBLIC
Encode an outgoing envelope once for direct send or broadcast reuse.
-
orionis.realtime._EXPORTS
orionis.realtime.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.realtime.__getattr__
orionis.realtime.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a declared realtime export.
-
orionis.realtime.__dir__
orionis.realtime.html#__dir__
Function
Function
PUBLIC
List declared exports and loaded package attributes.
-
orionis.realtime.config.RealtimeConfig
orionis.realtime.config.RealtimeConfig.html
Class
Class
PUBLIC
Configure finite per-connection RPC budgets and broadcast concurrency.
-
orionis.realtime.config.RealtimeConfig.max_message_size
orionis.realtime.config.RealtimeConfig.html#max_message_size
Attribute
Class Variable
PUBLIC
Max message size produced by field.
-
orionis.realtime.config.RealtimeConfig.max_concurrent_invocations
orionis.realtime.config.RealtimeConfig.html#max_concurrent_invocations
Attribute
Class Variable
PUBLIC
Max concurrent invocations produced by field.
-
orionis.realtime.config.RealtimeConfig.max_pending_client_invocations
orionis.realtime.config.RealtimeConfig.html#max_pending_client_invocations
Attribute
Class Variable
PUBLIC
Max pending client invocations produced by field.
-
orionis.realtime.config.RealtimeConfig.invocation_timeout
orionis.realtime.config.RealtimeConfig.html#invocation_timeout
Attribute
Class Variable
PUBLIC
Invocation timeout produced by field.
-
orionis.realtime.config.RealtimeConfig.client_result_timeout
orionis.realtime.config.RealtimeConfig.html#client_result_timeout
Attribute
Class Variable
PUBLIC
Client result timeout produced by field.
-
orionis.realtime.config.RealtimeConfig.broadcast_concurrency
orionis.realtime.config.RealtimeConfig.html#broadcast_concurrency
Attribute
Class Variable
PUBLIC
Broadcast concurrency produced by field.
-
orionis.realtime.config.RealtimeConfig.max_groups_per_connection
orionis.realtime.config.RealtimeConfig.html#max_groups_per_connection
Attribute
Class Variable
PUBLIC
Max groups per connection produced by field.
-
orionis.realtime.config.RealtimeConfig.__post_init__
orionis.realtime.config.RealtimeConfig.html#__post_init__
Function
Method
PUBLIC
Reject boolean counts, nonpositive budgets and nonfinite timeouts.
-
orionis.realtime.contracts.RealtimeConnectionLike
orionis.realtime.contracts.RealtimeConnectionLike.html
Class
Class
PUBLIC
Describe the connection surface required by the worker-local registry.
-
orionis.realtime.contracts.RealtimeConnectionLike.__slots__
orionis.realtime.contracts.RealtimeConnectionLike.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.realtime.contracts.RealtimeConnectionLike.context
orionis.realtime.contracts.RealtimeConnectionLike.html#context
Attribute
Property
PUBLIC
Return the immutable connection identity and handshake context.
-
orionis.realtime.contracts.RealtimeConnectionLike.hub
orionis.realtime.contracts.RealtimeConnectionLike.html#hub
Attribute
Property
PUBLIC
Return the Hub namespace owning this connection.
-
orionis.realtime.contracts.RealtimeConnectionLike.protocol
orionis.realtime.contracts.RealtimeConnectionLike.html#protocol
Attribute
Property
PUBLIC
Return the immutable codec selected for this connection.
-
orionis.realtime.contracts.RealtimeConnectionLike.ready
orionis.realtime.contracts.RealtimeConnectionLike.html#ready
Attribute
Property
PUBLIC
Report whether acceptance has admitted ordered realtime delivery.
-
orionis.realtime.contracts.RealtimeConnectionLike.closing
orionis.realtime.contracts.RealtimeConnectionLike.html#closing
Attribute
Property
PUBLIC
Report whether this connection is being released.
-
orionis.realtime.contracts.RealtimeConnectionLike.sendEncoded
orionis.realtime.contracts.RealtimeConnectionLike.html#sendEncoded
Function
Method
PUBLIC
Send an encoded frame while preserving transport backpressure.
-
orionis.realtime.contracts.RealtimeConnectionLike.invoke
orionis.realtime.contracts.RealtimeConnectionLike.html#invoke
Function
Method
PUBLIC
Invoke one client method and await its correlated completion.
-
orionis.realtime.contracts.IConnectionManager
orionis.realtime.contracts.IConnectionManager.html
Class
Class
PUBLIC
Define connection ownership and Hub delivery for registry providers.
-
orionis.realtime.contracts.IConnectionManager.__slots__
orionis.realtime.contracts.IConnectionManager.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.realtime.contracts.IConnectionManager.config
orionis.realtime.contracts.IConnectionManager.html#config
Attribute
Property
PUBLIC
Return immutable application limits used by Hub lifecycles.
-
orionis.realtime.contracts.IConnectionManager.register
orionis.realtime.contracts.IConnectionManager.html#register
Function
Method
PUBLIC
Register one provisional connection before its onConnect hook.
-
orionis.realtime.contracts.IConnectionManager.unregister
orionis.realtime.contracts.IConnectionManager.html#unregister
Function
Method
PUBLIC
Remove a connection and every group membership it owns.
-
orionis.realtime.contracts.IConnectionManager.get
orionis.realtime.contracts.IConnectionManager.html#get
Function
Method
PUBLIC
Return a ready connection in the requested Hub namespace.
-
orionis.realtime.contracts.IConnectionManager.snapshot
orionis.realtime.contracts.IConnectionManager.html#snapshot
Function
Method
PUBLIC
Return all owned connections, including provisional connections.
-
orionis.realtime.contracts.IConnectionManager.connectionIds
orionis.realtime.contracts.IConnectionManager.html#connectionIds
Function
Method
PUBLIC
Snapshot ready connection identifiers in one Hub namespace.
-
orionis.realtime.contracts.IConnectionManager.groupIds
orionis.realtime.contracts.IConnectionManager.html#groupIds
Function
Method
PUBLIC
Snapshot ready members of a group within one Hub namespace.
-
orionis.realtime.contracts.IConnectionManager.join
orionis.realtime.contracts.IConnectionManager.html#join
Function
Method
PUBLIC
Join an owned connection to a bounded, Hub-local group.
-
orionis.realtime.contracts.IConnectionManager.leave
orionis.realtime.contracts.IConnectionManager.html#leave
Function
Method
PUBLIC
Remove an owned connection from one group idempotently.
-
orionis.realtime.contracts.IConnectionManager.hub
orionis.realtime.contracts.IConnectionManager.html#hub
Function
Method
PUBLIC
Return client targets usable by application services.
-
orionis.realtime.contracts.IConnectionManager.broadcast
orionis.realtime.contracts.IConnectionManager.html#broadcast
Function
Method
PUBLIC
Deliver one envelope through a bounded set of concurrent workers.
-
orionis.realtime.provider.RealtimeProvider
orionis.realtime.provider.RealtimeProvider.html
Class
Class
PUBLIC
Register one worker-local registry and pin the synchronous target facade.
-
orionis.realtime.provider.RealtimeProvider.__slots__
orionis.realtime.provider.RealtimeProvider.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.realtime.provider.RealtimeProvider.register
orionis.realtime.provider.RealtimeProvider.html#register
Function
Method
PUBLIC
Bind validated configuration and the replaceable connection manager.
-
orionis.realtime.provider.RealtimeProvider.boot
orionis.realtime.provider.RealtimeProvider.html#boot
Function
Method
PUBLIC
Make Realtime.hub(...) available through the ordinary facade.
-
orionis.schemas.exceptions.ValidationException
orionis.schemas.exceptions.ValidationException.html
Class
Exception
PUBLIC
Carry structured schema-validation failures.
-
orionis.schemas.exceptions.ValidationException.__init__
orionis.schemas.exceptions.ValidationException.html#__init__
Function
Method
PUBLIC
Initialize field errors and a summary from validation failures.
-
orionis.schemas.exceptions.ValidationException.failures
orionis.schemas.exceptions.ValidationException.html#failures
Attribute
Instance Variable
PUBLIC
Single failure or collected payload failures in reporting order.
-
orionis.schemas.exceptions.ValidationException.failure
orionis.schemas.exceptions.ValidationException.html#failure
Attribute
Instance Variable
PUBLIC
Failure retained for propagation or reporting.
-
orionis.schemas.exceptions.ValidationException.errors
orionis.schemas.exceptions.ValidationException.html#errors
Attribute
Instance Variable
PUBLIC
Errors supplied through errors.
-
orionis.schemas.exceptions.ValidationException.message
orionis.schemas.exceptions.ValidationException.html#message
Attribute
Instance Variable
PUBLIC
Override the summary message reported to the client.
-
orionis.schemas.exceptions.ValidationException._summary
orionis.schemas.exceptions.ValidationException.html#_summary
Function
Static Method
PUBLIC
Build the summary message reported alongside the field errors.
-
orionis.schemas.exceptions.ValidationException.error
orionis.schemas.exceptions.ValidationException.html#error
Function
Method
PUBLIC
Return the summary and structured field errors as a dictionary.
-
orionis.schemas.rules.Accepted
orionis.schemas.rules.Accepted.html
Class
Class
PUBLIC
Ensure a value expresses an explicit acceptance.
-
orionis.schemas.rules.Accepted.__slots__
orionis.schemas.rules.Accepted.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.schemas.rules.Accepted.__message__
orionis.schemas.rules.Accepted.html#__message__
Attribute
Class Variable
PUBLIC
Value must be accepted..
-
orionis.schemas.rules.Accepted.__code__
orionis.schemas.rules.Accepted.html#__code__
Attribute
Class Variable
PUBLIC
accepted.
-
orionis.schemas.rules.Accepted.enforce
orionis.schemas.rules.Accepted.html#enforce
Function
Method
PUBLIC
Validate a field value as an acceptance flag.
-
orionis.schemas.rules.ActiveUrl
orionis.schemas.rules.ActiveUrl.html
Class
Class
PUBLIC
Ensure a URL points at a hostname that currently resolves.
-
orionis.schemas.rules.ActiveUrl.__slots__
orionis.schemas.rules.ActiveUrl.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.schemas.rules.ActiveUrl.__message__
orionis.schemas.rules.ActiveUrl.html#__message__
Attribute
Class Variable
PUBLIC
Value must be a URL with a resolvable hostname..
-
orionis.schemas.rules.ActiveUrl.__code__
orionis.schemas.rules.ActiveUrl.html#__code__
Attribute
Class Variable
PUBLIC
active_url.
-
orionis.schemas.rules.ActiveUrl.enforce
orionis.schemas.rules.ActiveUrl.html#enforce
Function
Method
PUBLIC
Resolve a URL hostname without blocking the current event loop.
-
orionis.schemas.rules.After
orionis.schemas.rules.After.html
Class
Class
PUBLIC
Ensure a date comes strictly after a reference moment.
-
orionis.schemas.rules.After.__slots__
orionis.schemas.rules.After.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.schemas.rules.After.__message__
orionis.schemas.rules.After.html#__message__
Attribute
Class Variable
PUBLIC
Value must be a date after the reference moment..
-
orionis.schemas.rules.After.__code__
orionis.schemas.rules.After.html#__code__
Attribute
Class Variable
PUBLIC
after.
-
orionis.schemas.rules.After.__init__
orionis.schemas.rules.After.html#__init__
Function
Method
PUBLIC
Initialize the rule with the reference moment.
-
orionis.schemas.rules.After._reference
orionis.schemas.rules.After.html#_reference
Attribute
Instance Variable
PUBLIC
Sibling field name, date string or datetime to compare against. Defaults to the current moment.
-
orionis.schemas.rules.After.enforce
orionis.schemas.rules.After.html#enforce
Function
Method
PUBLIC
Validate a field value against the reference moment.
-
orionis.schemas.rules.AfterOrEqual
orionis.schemas.rules.AfterOrEqual.html
Class
Class
PUBLIC
Ensure a date is equal to or comes after a reference moment.
-
orionis.schemas.rules.AfterOrEqual.__slots__
orionis.schemas.rules.AfterOrEqual.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.schemas.rules.AfterOrEqual.__message__
orionis.schemas.rules.AfterOrEqual.html#__message__
Attribute
Class Variable
PUBLIC
Value must be a date on or after the reference
moment..
-
orionis.schemas.rules.AfterOrEqual.__code__
orionis.schemas.rules.AfterOrEqual.html#__code__
Attribute
Class Variable
PUBLIC
after_or_equal.
-
orionis.schemas.rules.AfterOrEqual.__init__
orionis.schemas.rules.AfterOrEqual.html#__init__
Function
Method
PUBLIC
Initialize the rule with the reference moment.
-
orionis.schemas.rules.AfterOrEqual._reference
orionis.schemas.rules.AfterOrEqual.html#_reference
Attribute
Instance Variable
PUBLIC
Sibling field name, date string or datetime to compare against. Defaults to the current moment.
-
orionis.schemas.rules.AfterOrEqual.enforce
orionis.schemas.rules.AfterOrEqual.html#enforce
Function
Method
PUBLIC
Validate a field value against the reference moment.
-
orionis.schemas.rules.Alpha
orionis.schemas.rules.Alpha.html
Class
Class
PUBLIC
Ensure a string contains only alphabetic characters.
-
orionis.schemas.rules.Alpha.__slots__
orionis.schemas.rules.Alpha.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.schemas.rules.Alpha.__message__
orionis.schemas.rules.Alpha.html#__message__
Attribute
Class Variable
PUBLIC
Value must contain only alphabetic characters..
-
orionis.schemas.rules.Alpha.__code__
orionis.schemas.rules.Alpha.html#__code__
Attribute
Class Variable
PUBLIC
alpha.
-
orionis.schemas.rules.Alpha.__init__
orionis.schemas.rules.Alpha.html#__init__
Function
Method
PUBLIC
Initialize the rule with the accepted character range.
-
orionis.schemas.rules.Alpha._ascii_only
orionis.schemas.rules.Alpha.html#_ascii_only
Attribute
Instance Variable
PUBLIC
Whether to restrict the value to ASCII letters.
-
orionis.schemas.rules.Alpha.enforce
orionis.schemas.rules.Alpha.html#enforce
Function
Method
PUBLIC
Validate a field value as alphabetic content.
-
orionis.schemas.rules.Ascii
orionis.schemas.rules.Ascii.html
Class
Class
PUBLIC
Ensure a string contains only 7-bit ASCII characters.
-
orionis.schemas.rules.Ascii.__slots__
orionis.schemas.rules.Ascii.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.schemas.rules.Ascii.__message__
orionis.schemas.rules.Ascii.html#__message__
Attribute
Class Variable
PUBLIC
Value must contain only 7-bit ASCII characters..
-
orionis.schemas.rules.Ascii.__code__
orionis.schemas.rules.Ascii.html#__code__
Attribute
Class Variable
PUBLIC
ascii.
-
orionis.schemas.rules.Ascii.enforce
orionis.schemas.rules.Ascii.html#enforce
Function
Method
PUBLIC
Validate a field value as ASCII content.
-
orionis.schemas.rules.Before
orionis.schemas.rules.Before.html
Class
Class
PUBLIC
Ensure a date comes strictly before a reference moment.
-
orionis.schemas.rules.Before.__slots__
orionis.schemas.rules.Before.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.schemas.rules.Before.__message__
orionis.schemas.rules.Before.html#__message__
Attribute
Class Variable
PUBLIC
Value must be a date before the reference moment..
-
orionis.schemas.rules.Before.__code__
orionis.schemas.rules.Before.html#__code__
Attribute
Class Variable
PUBLIC
before.
-
orionis.schemas.rules.Before.__init__
orionis.schemas.rules.Before.html#__init__
Function
Method
PUBLIC
Initialize the rule with the reference moment.
-
orionis.schemas.rules.Before._reference
orionis.schemas.rules.Before.html#_reference
Attribute
Instance Variable
PUBLIC
Sibling field name, date string or datetime to compare against. Defaults to the current moment.
-
orionis.schemas.rules.Before.enforce
orionis.schemas.rules.Before.html#enforce
Function
Method
PUBLIC
Validate a field value against the reference moment.
-
orionis.schemas.rules.BeforeOrEqual
orionis.schemas.rules.BeforeOrEqual.html
Class
Class
PUBLIC
Ensure a date is equal to or comes before a reference moment.
-
orionis.schemas.rules.BeforeOrEqual.__slots__
orionis.schemas.rules.BeforeOrEqual.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.schemas.rules.BeforeOrEqual.__message__
orionis.schemas.rules.BeforeOrEqual.html#__message__
Attribute
Class Variable
PUBLIC
Value must be a date on or before the reference
moment..
-
orionis.schemas.rules.BeforeOrEqual.__code__
orionis.schemas.rules.BeforeOrEqual.html#__code__
Attribute
Class Variable
PUBLIC
before_or_equal.
-
orionis.schemas.rules.BeforeOrEqual.__init__
orionis.schemas.rules.BeforeOrEqual.html#__init__
Function
Method
PUBLIC
Initialize the rule with the reference moment.
-
orionis.schemas.rules.BeforeOrEqual._reference
orionis.schemas.rules.BeforeOrEqual.html#_reference
Attribute
Instance Variable
PUBLIC
Sibling field name, date string or datetime to compare against. Defaults to the current moment.
-
orionis.schemas.rules.BeforeOrEqual.enforce
orionis.schemas.rules.BeforeOrEqual.html#enforce
Function
Method
PUBLIC
Validate a field value against the reference moment.
-
orionis.schemas.rules.Between
orionis.schemas.rules.Between.html
Class
Class
PUBLIC
Ensure a value's size falls within an inclusive range.
-
orionis.schemas.rules.Between.__slots__
orionis.schemas.rules.Between.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.schemas.rules.Between.__message__
orionis.schemas.rules.Between.html#__message__
Attribute
Class Variable
PUBLIC
Value must be between the configured bounds..
-
orionis.schemas.rules.Between.__code__
orionis.schemas.rules.Between.html#__code__
Attribute
Class Variable
PUBLIC
between.
-
orionis.schemas.rules.Between.__init__
orionis.schemas.rules.Between.html#__init__
Function
Method
PUBLIC
Initialize the rule with the inclusive bounds.
-
orionis.schemas.rules.Between._minimum
orionis.schemas.rules.Between.html#_minimum
Attribute
Instance Variable
PUBLIC
Lowest accepted size.
-
orionis.schemas.rules.Between._maximum
orionis.schemas.rules.Between.html#_maximum
Attribute
Instance Variable
PUBLIC
Highest accepted size.
-
orionis.schemas.rules.Between.enforce
orionis.schemas.rules.Between.html#enforce
Function
Method
PUBLIC
Validate a field value against the configured range.
-
orionis.schemas.rules.ConfirmPassword
orionis.schemas.rules.ConfirmPassword.html
Class
Class
PUBLIC
Ensure a value matches the password supplied in a sibling field.
-
orionis.schemas.rules.ConfirmPassword.__slots__
orionis.schemas.rules.ConfirmPassword.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.schemas.rules.ConfirmPassword.__message__
orionis.schemas.rules.ConfirmPassword.html#__message__
Attribute
Class Variable
PUBLIC
Value must match the password field..
-
orionis.schemas.rules.ConfirmPassword.__code__
orionis.schemas.rules.ConfirmPassword.html#__code__
Attribute
Class Variable
PUBLIC
confirm_password.
-
orionis.schemas.rules.ConfirmPassword.__init__
orionis.schemas.rules.ConfirmPassword.html#__init__
Function
Method
PUBLIC
Initialize the rule with the field holding the original password.
-
orionis.schemas.rules.ConfirmPassword._other_field
orionis.schemas.rules.ConfirmPassword.html#_other_field
Attribute
Instance Variable
PUBLIC
Name of the sibling field holding the password to match.
-
orionis.schemas.rules.ConfirmPassword.enforce
orionis.schemas.rules.ConfirmPassword.html#enforce
Function
Method
PUBLIC
Validate a field value against the referenced password field.
-
orionis.schemas.rules.DateFormat
orionis.schemas.rules.DateFormat.html
Class
Class
PUBLIC
Ensure a date string matches one of the accepted formats.
-
orionis.schemas.rules.DateFormat.__slots__
orionis.schemas.rules.DateFormat.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.schemas.rules.DateFormat.__message__
orionis.schemas.rules.DateFormat.html#__message__
Attribute
Class Variable
PUBLIC
Value must match one of the accepted date formats..
-
orionis.schemas.rules.DateFormat.__code__
orionis.schemas.rules.DateFormat.html#__code__
Attribute
Class Variable
PUBLIC
date_format.
-
orionis.schemas.rules.DateFormat.__init__
orionis.schemas.rules.DateFormat.html#__init__
Function
Method
PUBLIC
Initialize the rule with the accepted date formats.
-
orionis.schemas.rules.DateFormat._formats
orionis.schemas.rules.DateFormat.html#_formats
Attribute
Instance Variable
PUBLIC
Format strings the value may match. At least one is required.
-
orionis.schemas.rules.DateFormat.enforce
orionis.schemas.rules.DateFormat.html#enforce
Function
Method
PUBLIC
Validate a field value against the accepted date formats.
-
orionis.schemas.rules.DecimalPlaces
orionis.schemas.rules.DecimalPlaces.html
Class
Class
PUBLIC
Ensure a numeric value carries a given number of decimal places.
-
orionis.schemas.rules.DecimalPlaces.__slots__
orionis.schemas.rules.DecimalPlaces.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.schemas.rules.DecimalPlaces.__message__
orionis.schemas.rules.DecimalPlaces.html#__message__
Attribute
Class Variable
PUBLIC
Value must have the required number of decimal
places..
-
orionis.schemas.rules.DecimalPlaces.__code__
orionis.schemas.rules.DecimalPlaces.html#__code__
Attribute
Class Variable
PUBLIC
decimal.
-
orionis.schemas.rules.DecimalPlaces.__init__
orionis.schemas.rules.DecimalPlaces.html#__init__
Function
Method
PUBLIC
Initialize the rule with the accepted number of decimal places.
-
orionis.schemas.rules.DecimalPlaces._minimum
orionis.schemas.rules.DecimalPlaces.html#_minimum
Attribute
Instance Variable
PUBLIC
Lowest accepted number of decimal places.
-
orionis.schemas.rules.DecimalPlaces._maximum
orionis.schemas.rules.DecimalPlaces.html#_maximum
Attribute
Instance Variable
PUBLIC
Highest accepted number of decimal places. Defaults to minimum, which requires an exact count.
-
orionis.schemas.rules.DecimalPlaces.enforce
orionis.schemas.rules.DecimalPlaces.html#enforce
Function
Method
PUBLIC
Validate a field value against the accepted decimal places.
-
orionis.schemas.rules.Different
orionis.schemas.rules.Different.html
Class
Class
PUBLIC
Ensure a value differs from every value supplied to the rule.
-
orionis.schemas.rules.Different.__slots__
orionis.schemas.rules.Different.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.schemas.rules.Different.__message__
orionis.schemas.rules.Different.html#__message__
Attribute
Class Variable
PUBLIC
Value must be different from the forbidden values..
-
orionis.schemas.rules.Different.__code__
orionis.schemas.rules.Different.html#__code__
Attribute
Class Variable
PUBLIC
different.
-
orionis.schemas.rules.Different.__init__
orionis.schemas.rules.Different.html#__init__
Function
Method
PUBLIC
Initialize the rule with the forbidden values.
-
orionis.schemas.rules.Different._forbidden
orionis.schemas.rules.Different.html#_forbidden
Attribute
Instance Variable
PUBLIC
Values the field must not be equal to. At least one is required.
-
orionis.schemas.rules.Different.enforce
orionis.schemas.rules.Different.html#enforce
Function
Method
PUBLIC
Validate a field value against the forbidden values.
-
orionis.schemas.rules.Dimensions
orionis.schemas.rules.Dimensions.html
Class
Class
PUBLIC
Ensure an uploaded image satisfies the given dimension constraints.
-
orionis.schemas.rules.Dimensions.__slots__
orionis.schemas.rules.Dimensions.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.schemas.rules.Dimensions.__message__
orionis.schemas.rules.Dimensions.html#__message__
Attribute
Class Variable
PUBLIC
Image must satisfy the required dimensions..
-
orionis.schemas.rules.Dimensions.__code__
orionis.schemas.rules.Dimensions.html#__code__
Attribute
Class Variable
PUBLIC
dimensions.
-
orionis.schemas.rules.Dimensions.__init__
orionis.schemas.rules.Dimensions.html#__init__
Function
Method
PUBLIC
Initialize the rule with the accepted dimension constraints.
-
orionis.schemas.rules.Dimensions._min_width
orionis.schemas.rules.Dimensions.html#_min_width
Attribute
Instance Variable
PUBLIC
Lowest accepted width in pixels.
-
orionis.schemas.rules.Dimensions._max_width
orionis.schemas.rules.Dimensions.html#_max_width
Attribute
Instance Variable
PUBLIC
Highest accepted width in pixels.
-
orionis.schemas.rules.Dimensions._min_height
orionis.schemas.rules.Dimensions.html#_min_height
Attribute
Instance Variable
PUBLIC
Lowest accepted height in pixels.
-
orionis.schemas.rules.Dimensions._max_height
orionis.schemas.rules.Dimensions.html#_max_height
Attribute
Instance Variable
PUBLIC
Highest accepted height in pixels.
-
orionis.schemas.rules.Dimensions._width
orionis.schemas.rules.Dimensions.html#_width
Attribute
Instance Variable
PUBLIC
Exact required width in pixels.
-
orionis.schemas.rules.Dimensions._height
orionis.schemas.rules.Dimensions.html#_height
Attribute
Instance Variable
PUBLIC
Exact required height in pixels.
-
orionis.schemas.rules.Dimensions._ratio
orionis.schemas.rules.Dimensions.html#_ratio
Attribute
Instance Variable
PUBLIC
Exact required aspect ratio.
-
orionis.schemas.rules.Dimensions._min_ratio
orionis.schemas.rules.Dimensions.html#_min_ratio
Attribute
Instance Variable
PUBLIC
Lowest accepted aspect ratio.
-
orionis.schemas.rules.Dimensions._max_ratio
orionis.schemas.rules.Dimensions.html#_max_ratio
Attribute
Instance Variable
PUBLIC
Highest accepted aspect ratio.
-
orionis.schemas.rules.Dimensions.enforce
orionis.schemas.rules.Dimensions.html#enforce
Function
Method
PUBLIC
Validate an uploaded image against the dimension constraints.
-
orionis.schemas.rules.Dimensions.__checkBounds
orionis.schemas.rules.Dimensions.html#__checkBounds
Function
Method
PUBLIC
Check the pixel dimensions against the configured bounds.
-
orionis.schemas.rules.Dimensions.__checkRatio
orionis.schemas.rules.Dimensions.html#__checkRatio
Function
Method
PUBLIC
Check the aspect ratio against the configured constraints.
-
orionis.schemas.rules.DoesntEndWith
orionis.schemas.rules.DoesntEndWith.html
Class
Class
PUBLIC
Ensure a string does not end with any of the given suffixes.
-
orionis.schemas.rules.DoesntEndWith.__slots__
orionis.schemas.rules.DoesntEndWith.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.schemas.rules.DoesntEndWith.__message__
orionis.schemas.rules.DoesntEndWith.html#__message__
Attribute
Class Variable
PUBLIC
Value must not end with any of the forbidden
suffixes..
-
orionis.schemas.rules.DoesntEndWith.__code__
orionis.schemas.rules.DoesntEndWith.html#__code__
Attribute
Class Variable
PUBLIC
doesnt_end_with.
-
orionis.schemas.rules.DoesntEndWith.__init__
orionis.schemas.rules.DoesntEndWith.html#__init__
Function
Method
PUBLIC
Initialize the rule with the forbidden suffixes.
-
orionis.schemas.rules.DoesntEndWith._suffixes
orionis.schemas.rules.DoesntEndWith.html#_suffixes
Attribute
Instance Variable
PUBLIC
Suffixes the value must not end with. At least one is required.
-
orionis.schemas.rules.DoesntEndWith.enforce
orionis.schemas.rules.DoesntEndWith.html#enforce
Function
Method
PUBLIC
Validate a field value against the forbidden suffixes.
-
orionis.schemas.rules.DoesntStartWith
orionis.schemas.rules.DoesntStartWith.html
Class
Class
PUBLIC
Ensure a string does not start with any of the given prefixes.
-
orionis.schemas.rules.DoesntStartWith.__slots__
orionis.schemas.rules.DoesntStartWith.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.schemas.rules.DoesntStartWith.__message__
orionis.schemas.rules.DoesntStartWith.html#__message__
Attribute
Class Variable
PUBLIC
Value must not start with any of the forbidden
prefixes..
-
orionis.schemas.rules.DoesntStartWith.__code__
orionis.schemas.rules.DoesntStartWith.html#__code__
Attribute
Class Variable
PUBLIC
doesnt_start_with.
-
orionis.schemas.rules.DoesntStartWith.__init__
orionis.schemas.rules.DoesntStartWith.html#__init__
Function
Method
PUBLIC
Initialize the rule with the forbidden prefixes.
-
orionis.schemas.rules.DoesntStartWith._prefixes
orionis.schemas.rules.DoesntStartWith.html#_prefixes
Attribute
Instance Variable
PUBLIC
Prefixes the value must not start with. At least one is required.
-
orionis.schemas.rules.DoesntStartWith.enforce
orionis.schemas.rules.DoesntStartWith.html#enforce
Function
Method
PUBLIC
Validate a field value against the forbidden prefixes.
-
orionis.schemas.rules.Email
orionis.schemas.rules.Email.html
Class
Class
PUBLIC
Ensure a string is a valid email address.
-
orionis.schemas.rules.Email.__slots__
orionis.schemas.rules.Email.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.schemas.rules.Email.__message__
orionis.schemas.rules.Email.html#__message__
Attribute
Class Variable
PUBLIC
Value must be a valid email address..
-
orionis.schemas.rules.Email.__code__
orionis.schemas.rules.Email.html#__code__
Attribute
Class Variable
PUBLIC
email.
-
orionis.schemas.rules.Email.enforce
orionis.schemas.rules.Email.html#enforce
Function
Method
PUBLIC
Validate a field value as an email address.
-
orionis.schemas.rules.Empty
orionis.schemas.rules.Empty.html
Class
Class
PUBLIC
Accept None, blank strings, zero, False and zero-length values.
-
orionis.schemas.rules.Empty.__slots__
orionis.schemas.rules.Empty.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.schemas.rules.Empty.__code__
orionis.schemas.rules.Empty.html#__code__
Attribute
Class Variable
PUBLIC
empty.
-
orionis.schemas.rules.Empty.__message__
orionis.schemas.rules.Empty.html#__message__
Attribute
Class Variable
PUBLIC
Default message reported for a non-empty value.
-
orionis.schemas.rules.Empty.enforce
orionis.schemas.rules.Empty.html#enforce
Function
Method
PUBLIC
Check that a field value is empty.
-
orionis.schemas.rules.Encoding
orionis.schemas.rules.Encoding.html
Class
Class
PUBLIC
Ensure a value can be represented in a given character encoding.
-
orionis.schemas.rules.Encoding.__slots__
orionis.schemas.rules.Encoding.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.schemas.rules.Encoding.__message__
orionis.schemas.rules.Encoding.html#__message__
Attribute
Class Variable
PUBLIC
Value must match the required character encoding..
-
orionis.schemas.rules.Encoding.__code__
orionis.schemas.rules.Encoding.html#__code__
Attribute
Class Variable
PUBLIC
encoding.
-
orionis.schemas.rules.Encoding.__init__
orionis.schemas.rules.Encoding.html#__init__
Function
Method
PUBLIC
Initialize the rule with the required character encoding.
-
orionis.schemas.rules.Encoding._encoding
orionis.schemas.rules.Encoding.html#_encoding
Attribute
Instance Variable
PUBLIC
Codec name the value must be representable in.
-
orionis.schemas.rules.Encoding.enforce
orionis.schemas.rules.Encoding.html#enforce
Function
Method
PUBLIC
Validate a field value against the required encoding.
-
orionis.schemas.rules.EndsWith
orionis.schemas.rules.EndsWith.html
Class
Class
PUBLIC
Ensure a string ends with one of the given suffixes.
-
orionis.schemas.rules.EndsWith.__slots__
orionis.schemas.rules.EndsWith.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.schemas.rules.EndsWith.__message__
orionis.schemas.rules.EndsWith.html#__message__
Attribute
Class Variable
PUBLIC
Value must end with one of the allowed suffixes..
-
orionis.schemas.rules.EndsWith.__code__
orionis.schemas.rules.EndsWith.html#__code__
Attribute
Class Variable
PUBLIC
ends_with.
-
orionis.schemas.rules.EndsWith.__init__
orionis.schemas.rules.EndsWith.html#__init__
Function
Method
PUBLIC
Initialize the rule with the accepted suffixes.
-
orionis.schemas.rules.EndsWith._suffixes
orionis.schemas.rules.EndsWith.html#_suffixes
Attribute
Instance Variable
PUBLIC
Suffixes the value may end with. At least one is required.
-
orionis.schemas.rules.EndsWith.enforce
orionis.schemas.rules.EndsWith.html#enforce
Function
Method
PUBLIC
Validate a field value against the accepted suffixes.
-
orionis.schemas.rules.File
orionis.schemas.rules.File.html
Class
Class
PUBLIC
Ensure a value is a successfully uploaded file.
-
orionis.schemas.rules.File.__slots__
orionis.schemas.rules.File.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.schemas.rules.File.__message__
orionis.schemas.rules.File.html#__message__
Attribute
Class Variable
PUBLIC
Value must be an uploaded file..
-
orionis.schemas.rules.File.__code__
orionis.schemas.rules.File.html#__code__
Attribute
Class Variable
PUBLIC
file.
-
orionis.schemas.rules.File.enforce
orionis.schemas.rules.File.html#enforce
Function
Method
PUBLIC
Validate a field value as an uploaded file.
-
orionis.schemas.rules.GreaterThanOrEqualField
orionis.schemas.rules.GreaterThanOrEqualField.html
Class
Class
PUBLIC
Ensure a value is greater than or equal to a sibling field.
-
orionis.schemas.rules.GreaterThanOrEqualField.__slots__
orionis.schemas.rules.GreaterThanOrEqualField.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.schemas.rules.GreaterThanOrEqualField.__message__
orionis.schemas.rules.GreaterThanOrEqualField.html#__message__
Attribute
Class Variable
PUBLIC
Value must be greater than or equal to the compared
field..
-
orionis.schemas.rules.GreaterThanOrEqualField.__code__
orionis.schemas.rules.GreaterThanOrEqualField.html#__code__
Attribute
Class Variable
PUBLIC
gte.
-
orionis.schemas.rules.GreaterThanOrEqualField.__init__
orionis.schemas.rules.GreaterThanOrEqualField.html#__init__
Function
Method
PUBLIC
Initialize the rule with the field to compare against.
-
orionis.schemas.rules.GreaterThanOrEqualField._other_field
orionis.schemas.rules.GreaterThanOrEqualField.html#_other_field
Attribute
Instance Variable
PUBLIC
Name of the sibling field holding the lower bound.
-
orionis.schemas.rules.GreaterThanOrEqualField.enforce
orionis.schemas.rules.GreaterThanOrEqualField.html#enforce
Function
Method
PUBLIC
Validate a field value against the compared field.
-
orionis.schemas.rules.Image
orionis.schemas.rules.Image.html
Class
Class
PUBLIC
Ensure an uploaded file has a supported raster image header.
-
orionis.schemas.rules.Image.__slots__
orionis.schemas.rules.Image.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.schemas.rules.Image.__message__
orionis.schemas.rules.Image.html#__message__
Attribute
Class Variable
PUBLIC
File must be a valid image..
-
orionis.schemas.rules.Image.__code__
orionis.schemas.rules.Image.html#__code__
Attribute
Class Variable
PUBLIC
image.
-
orionis.schemas.rules.Image.enforce
orionis.schemas.rules.Image.html#enforce
Function
Method
PUBLIC
Validate an uploaded file as an image.
-
orionis.schemas.rules.Integer
orionis.schemas.rules.Integer.html
Class
Class
PUBLIC
Ensure a value represents a whole number.
-
orionis.schemas.rules.Integer.__slots__
orionis.schemas.rules.Integer.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.schemas.rules.Integer.__message__
orionis.schemas.rules.Integer.html#__message__
Attribute
Class Variable
PUBLIC
Value must be an integer..
-
orionis.schemas.rules.Integer.__code__
orionis.schemas.rules.Integer.html#__code__
Attribute
Class Variable
PUBLIC
integer.
-
orionis.schemas.rules.Integer.enforce
orionis.schemas.rules.Integer.html#enforce
Function
Method
PUBLIC
Validate a field value as a whole number.
-
orionis.schemas.rules.IpAddress
orionis.schemas.rules.IpAddress.html
Class
Class
PUBLIC
Ensure a string is a valid IP address.
-
orionis.schemas.rules.IpAddress.__slots__
orionis.schemas.rules.IpAddress.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.schemas.rules.IpAddress.__message__
orionis.schemas.rules.IpAddress.html#__message__
Attribute
Class Variable
PUBLIC
Value must be a valid IP address..
-
orionis.schemas.rules.IpAddress.__code__
orionis.schemas.rules.IpAddress.html#__code__
Attribute
Class Variable
PUBLIC
ip.
-
orionis.schemas.rules.IpAddress.__init__
orionis.schemas.rules.IpAddress.html#__init__
Function
Method
PUBLIC
Initialize the rule with the required IP version.
-
orionis.schemas.rules.IpAddress._version
orionis.schemas.rules.IpAddress.html#_version
Attribute
Instance Variable
PUBLIC
Required IP version, either 4 or 6. Use None to accept both families.
-
orionis.schemas.rules.IpAddress.enforce
orionis.schemas.rules.IpAddress.html#enforce
Function
Method
PUBLIC
Validate a field value as an IP address.
-
orionis.schemas.rules.Json
orionis.schemas.rules.Json.html
Class
Class
PUBLIC
Ensure a string holds a syntactically valid JSON document.
-
orionis.schemas.rules.Json.__slots__
orionis.schemas.rules.Json.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.schemas.rules.Json.__message__
orionis.schemas.rules.Json.html#__message__
Attribute
Class Variable
PUBLIC
Value must be a valid JSON string..
-
orionis.schemas.rules.Json.__code__
orionis.schemas.rules.Json.html#__code__
Attribute
Class Variable
PUBLIC
json.
-
orionis.schemas.rules.Json.enforce
orionis.schemas.rules.Json.html#enforce
Function
Method
PUBLIC
Validate a field value as a JSON document.
-
orionis.schemas.rules.LessThanOrEqualField
orionis.schemas.rules.LessThanOrEqualField.html
Class
Class
PUBLIC
Ensure a value is less than or equal to a sibling field.
-
orionis.schemas.rules.LessThanOrEqualField.__slots__
orionis.schemas.rules.LessThanOrEqualField.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.schemas.rules.LessThanOrEqualField.__message__
orionis.schemas.rules.LessThanOrEqualField.html#__message__
Attribute
Class Variable
PUBLIC
Value must be less than or equal to the compared
field..
-
orionis.schemas.rules.LessThanOrEqualField.__code__
orionis.schemas.rules.LessThanOrEqualField.html#__code__
Attribute
Class Variable
PUBLIC
lte.
-
orionis.schemas.rules.LessThanOrEqualField.__init__
orionis.schemas.rules.LessThanOrEqualField.html#__init__
Function
Method
PUBLIC
Initialize the rule with the field to compare against.
-
orionis.schemas.rules.LessThanOrEqualField._other_field
orionis.schemas.rules.LessThanOrEqualField.html#_other_field
Attribute
Instance Variable
PUBLIC
Name of the sibling field holding the upper bound.
-
orionis.schemas.rules.LessThanOrEqualField.enforce
orionis.schemas.rules.LessThanOrEqualField.html#enforce
Function
Method
PUBLIC
Validate a field value against the compared field.
-
orionis.schemas.rules.Lowercase
orionis.schemas.rules.Lowercase.html
Class
Class
PUBLIC
Ensure a string contains no uppercase characters.
-
orionis.schemas.rules.Lowercase.__slots__
orionis.schemas.rules.Lowercase.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.schemas.rules.Lowercase.__message__
orionis.schemas.rules.Lowercase.html#__message__
Attribute
Class Variable
PUBLIC
Value must be lowercase..
-
orionis.schemas.rules.Lowercase.__code__
orionis.schemas.rules.Lowercase.html#__code__
Attribute
Class Variable
PUBLIC
lowercase.
-
orionis.schemas.rules.Lowercase.enforce
orionis.schemas.rules.Lowercase.html#enforce
Function
Method
PUBLIC
Validate a field value as lowercase content.
-
orionis.schemas.rules.MacAddress
orionis.schemas.rules.MacAddress.html
Class
Class
PUBLIC
Ensure a string is a valid MAC address.
-
orionis.schemas.rules.MacAddress.__slots__
orionis.schemas.rules.MacAddress.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.schemas.rules.MacAddress.__message__
orionis.schemas.rules.MacAddress.html#__message__
Attribute
Class Variable
PUBLIC
Value must be a valid MAC address..
-
orionis.schemas.rules.MacAddress.__code__
orionis.schemas.rules.MacAddress.html#__code__
Attribute
Class Variable
PUBLIC
mac_address.
-
orionis.schemas.rules.MacAddress.enforce
orionis.schemas.rules.MacAddress.html#enforce
Function
Method
PUBLIC
Validate a field value as a MAC address.
-
orionis.schemas.rules.MaxDigits
orionis.schemas.rules.MaxDigits.html
Class
Class
PUBLIC
Ensure an integer is written with at most a given number of digits.
-
orionis.schemas.rules.MaxDigits.__slots__
orionis.schemas.rules.MaxDigits.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.schemas.rules.MaxDigits.__message__
orionis.schemas.rules.MaxDigits.html#__message__
Attribute
Class Variable
PUBLIC
Value must not exceed the allowed number of digits..
-
orionis.schemas.rules.MaxDigits.__code__
orionis.schemas.rules.MaxDigits.html#__code__
Attribute
Class Variable
PUBLIC
max_digits.
-
orionis.schemas.rules.MaxDigits.__init__
orionis.schemas.rules.MaxDigits.html#__init__
Function
Method
PUBLIC
Initialize the rule with the maximum number of digits.
-
orionis.schemas.rules.MaxDigits._maximum
orionis.schemas.rules.MaxDigits.html#_maximum
Attribute
Instance Variable
PUBLIC
Highest accepted number of digits.
-
orionis.schemas.rules.MaxDigits.enforce
orionis.schemas.rules.MaxDigits.html#enforce
Function
Method
PUBLIC
Validate a field value against the allowed number of digits.
-
orionis.schemas.rules.MimeTypes
orionis.schemas.rules.MimeTypes.html
Class
Class
PUBLIC
Ensure an uploaded file declares one of the accepted MIME types.
-
orionis.schemas.rules.MimeTypes.__slots__
orionis.schemas.rules.MimeTypes.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.schemas.rules.MimeTypes.__message__
orionis.schemas.rules.MimeTypes.html#__message__
Attribute
Class Variable
PUBLIC
File must match one of the accepted MIME types..
-
orionis.schemas.rules.MimeTypes.__code__
orionis.schemas.rules.MimeTypes.html#__code__
Attribute
Class Variable
PUBLIC
mimetypes.
-
orionis.schemas.rules.MimeTypes.__init__
orionis.schemas.rules.MimeTypes.html#__init__
Function
Method
PUBLIC
Initialize the rule with the accepted MIME types.
-
orionis.schemas.rules.MimeTypes._exact
orionis.schemas.rules.MimeTypes.html#_exact
Attribute
Instance Variable
PUBLIC
Exact produced by frozenset.
-
orionis.schemas.rules.MimeTypes._prefixes
orionis.schemas.rules.MimeTypes.html#_prefixes
Attribute
Instance Variable
PUBLIC
Prefixes produced by tuple.
-
orionis.schemas.rules.MimeTypes.enforce
orionis.schemas.rules.MimeTypes.html#enforce
Function
Method
PUBLIC
Validate an uploaded file against the accepted MIME types.
-
orionis.schemas.rules.NoEmpty
orionis.schemas.rules.NoEmpty.html
Class
Class
PUBLIC
Reject exactly the values accepted by Empty.
-
orionis.schemas.rules.NoEmpty.__slots__
orionis.schemas.rules.NoEmpty.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.schemas.rules.NoEmpty.__code__
orionis.schemas.rules.NoEmpty.html#__code__
Attribute
Class Variable
PUBLIC
no_empty.
-
orionis.schemas.rules.NoEmpty.__message__
orionis.schemas.rules.NoEmpty.html#__message__
Attribute
Class Variable
PUBLIC
Default message reported for an empty value.
-
orionis.schemas.rules.NoEmpty.enforce
orionis.schemas.rules.NoEmpty.html#enforce
Function
Method
PUBLIC
Check that a field value is not empty.
-
orionis.schemas.rules.Size
orionis.schemas.rules.Size.html
Class
Class
PUBLIC
Ensure a value has an exact size.
-
orionis.schemas.rules.Size.__slots__
orionis.schemas.rules.Size.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.schemas.rules.Size.__message__
orionis.schemas.rules.Size.html#__message__
Attribute
Class Variable
PUBLIC
Value must have the required size..
-
orionis.schemas.rules.Size.__code__
orionis.schemas.rules.Size.html#__code__
Attribute
Class Variable
PUBLIC
size.
-
orionis.schemas.rules.Size.__init__
orionis.schemas.rules.Size.html#__init__
Function
Method
PUBLIC
Initialize the rule with the required size.
-
orionis.schemas.rules.Size._size
orionis.schemas.rules.Size.html#_size
Attribute
Instance Variable
PUBLIC
Exact size the value must have.
-
orionis.schemas.rules.Size.enforce
orionis.schemas.rules.Size.html#enforce
Function
Method
PUBLIC
Validate a field value against the required size.
-
orionis.schemas.rules.StartsWith
orionis.schemas.rules.StartsWith.html
Class
Class
PUBLIC
Ensure a string starts with one of the given prefixes.
-
orionis.schemas.rules.StartsWith.__slots__
orionis.schemas.rules.StartsWith.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.schemas.rules.StartsWith.__message__
orionis.schemas.rules.StartsWith.html#__message__
Attribute
Class Variable
PUBLIC
Value must start with one of the allowed prefixes..
-
orionis.schemas.rules.StartsWith.__code__
orionis.schemas.rules.StartsWith.html#__code__
Attribute
Class Variable
PUBLIC
starts_with.
-
orionis.schemas.rules.StartsWith.__init__
orionis.schemas.rules.StartsWith.html#__init__
Function
Method
PUBLIC
Initialize the rule with the accepted prefixes.
-
orionis.schemas.rules.StartsWith._prefixes
orionis.schemas.rules.StartsWith.html#_prefixes
Attribute
Instance Variable
PUBLIC
Prefixes the value may start with. At least one is required.
-
orionis.schemas.rules.StartsWith.enforce
orionis.schemas.rules.StartsWith.html#enforce
Function
Method
PUBLIC
Validate a field value against the accepted prefixes.
-
orionis.schemas.rules.StrongPassword
orionis.schemas.rules.StrongPassword.html
Class
Class
PUBLIC
Ensure a string is strong enough to be used as a password.
-
orionis.schemas.rules.StrongPassword.__slots__
orionis.schemas.rules.StrongPassword.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.schemas.rules.StrongPassword.__message__
orionis.schemas.rules.StrongPassword.html#__message__
Attribute
Class Variable
PUBLIC
Human-readable message associated with this operation or result.
-
orionis.schemas.rules.StrongPassword.__code__
orionis.schemas.rules.StrongPassword.html#__code__
Attribute
Class Variable
PUBLIC
strong_password.
-
orionis.schemas.rules.StrongPassword.enforce
orionis.schemas.rules.StrongPassword.html#enforce
Function
Method
PUBLIC
Validate a field value as a strong password.
-
orionis.schemas.rules.Ulid
orionis.schemas.rules.Ulid.html
Class
Class
PUBLIC
Ensure a string is a valid lexicographically sortable identifier.
-
orionis.schemas.rules.Ulid.__slots__
orionis.schemas.rules.Ulid.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.schemas.rules.Ulid.__message__
orionis.schemas.rules.Ulid.html#__message__
Attribute
Class Variable
PUBLIC
Value must be a valid ULID..
-
orionis.schemas.rules.Ulid.__code__
orionis.schemas.rules.Ulid.html#__code__
Attribute
Class Variable
PUBLIC
ulid.
-
orionis.schemas.rules.Ulid.enforce
orionis.schemas.rules.Ulid.html#enforce
Function
Method
PUBLIC
Validate a field value as a ULID.
-
orionis.schemas.rules.Unique
orionis.schemas.rules.Unique.html
Class
Class
PUBLIC
Ensure a value is not already stored in a database column.
-
orionis.schemas.rules.Unique.__message__
orionis.schemas.rules.Unique.html#__message__
Attribute
Class Variable
PUBLIC
Value must be unique..
-
orionis.schemas.rules.Unique.__code__
orionis.schemas.rules.Unique.html#__code__
Attribute
Class Variable
PUBLIC
unique.
-
orionis.schemas.rules.Unique.__slots__
orionis.schemas.rules.Unique.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.schemas.rules.Unique.__init__
orionis.schemas.rules.Unique.html#__init__
Function
Method
PUBLIC
Initialize the rule with the database table and column to check.
-
orionis.schemas.rules.Unique._table
orionis.schemas.rules.Unique.html#_table
Attribute
Instance Variable
PUBLIC
Logical table name, without the connection prefix.
-
orionis.schemas.rules.Unique._column
orionis.schemas.rules.Unique.html#_column
Attribute
Instance Variable
PUBLIC
Column name within the table.
-
orionis.schemas.rules.Unique._ignore
orionis.schemas.rules.Unique.html#_ignore
Attribute
Instance Variable
PUBLIC
Row identifier excluded from the lookup, so updating a record does not clash with itself.
-
orionis.schemas.rules.Unique._ignore_column
orionis.schemas.rules.Unique.html#_ignore_column
Attribute
Instance Variable
PUBLIC
Column ignore is matched against.
-
orionis.schemas.rules.Unique._connection
orionis.schemas.rules.Unique.html#_connection
Attribute
Instance Variable
PUBLIC
Named connection to query, or None for the default one.
-
orionis.schemas.rules.Unique.enforce
orionis.schemas.rules.Unique.html#enforce
Function
Method
PUBLIC
Check uniqueness on the current loop and its active transaction.
-
orionis.schemas.rules.Unique.__plan
orionis.schemas.rules.Unique.html#__plan
Function
Method
PUBLIC
Build the query plan probing for a conflicting row.
-
orionis.schemas.rules.Uppercase
orionis.schemas.rules.Uppercase.html
Class
Class
PUBLIC
Ensure a string contains no lowercase characters.
-
orionis.schemas.rules.Uppercase.__slots__
orionis.schemas.rules.Uppercase.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.schemas.rules.Uppercase.__message__
orionis.schemas.rules.Uppercase.html#__message__
Attribute
Class Variable
PUBLIC
Value must be uppercase..
-
orionis.schemas.rules.Uppercase.__code__
orionis.schemas.rules.Uppercase.html#__code__
Attribute
Class Variable
PUBLIC
uppercase.
-
orionis.schemas.rules.Uppercase.enforce
orionis.schemas.rules.Uppercase.html#enforce
Function
Method
PUBLIC
Validate a field value as uppercase content.
-
orionis.schemas.rules.Uuid
orionis.schemas.rules.Uuid.html
Class
Class
PUBLIC
Ensure a string is a valid RFC 9562 universally unique identifier.
-
orionis.schemas.rules.Uuid.__slots__
orionis.schemas.rules.Uuid.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.schemas.rules.Uuid.__message__
orionis.schemas.rules.Uuid.html#__message__
Attribute
Class Variable
PUBLIC
Value must be a valid UUID..
-
orionis.schemas.rules.Uuid.__code__
orionis.schemas.rules.Uuid.html#__code__
Attribute
Class Variable
PUBLIC
uuid.
-
orionis.schemas.rules.Uuid.__init__
orionis.schemas.rules.Uuid.html#__init__
Function
Method
PUBLIC
Initialize the rule with the required UUID version.
-
orionis.schemas.rules.Uuid._version
orionis.schemas.rules.Uuid.html#_version
Attribute
Instance Variable
PUBLIC
Required version among 1, 3, 4, 5, 6, 7 and 8. Use None to accept any version.
-
orionis.schemas.rules.Uuid.enforce
orionis.schemas.rules.Uuid.html#enforce
Function
Method
PUBLIC
Validate a field value as a UUID.
-
orionis.schemas.rules._EXPORTS
orionis.schemas.rules.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.schemas.rules.__getattr__
orionis.schemas.rules.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public schema rule.
-
orionis.schemas.rules.__dir__
orionis.schemas.rules.html#__dir__
Function
Function
PUBLIC
List loaded attributes and public schema rules.
-
orionis.session.contracts.ISession
orionis.session.contracts.ISession.html
Class
Class
PUBLIC
Contract for a single HTTP session runtime object.
-
orionis.session.contracts.ISession.__slots__
orionis.session.contracts.ISession.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.session.contracts.ISession.id
orionis.session.contracts.ISession.html#id
Attribute
Property
PUBLIC
Return the current session identifier.
-
orionis.session.contracts.ISession.started
orionis.session.contracts.ISession.html#started
Attribute
Property
PUBLIC
Report whether the session has been activated.
-
orionis.session.contracts.ISession.dirty
orionis.session.contracts.ISession.html#dirty
Attribute
Property
PUBLIC
Report whether changes require persistence.
-
orionis.session.contracts.ISession.invalidated
orionis.session.contracts.ISession.html#invalidated
Attribute
Property
PUBLIC
Report whether the session has been invalidated.
-
orionis.session.contracts.ISession.isNew
orionis.session.contracts.ISession.html#isNew
Attribute
Property
PUBLIC
Report whether the session has a new storage identity.
-
orionis.session.contracts.ISession.wantsRegenerate
orionis.session.contracts.ISession.html#wantsRegenerate
Attribute
Property
PUBLIC
Report whether the session requests identifier rotation.
-
orionis.session.contracts.ISession.get
orionis.session.contracts.ISession.html#get
Function
Method
PUBLIC
Return the value for key, or default when absent.
-
orionis.session.contracts.ISession.put
orionis.session.contracts.ISession.html#put
Function
Method
PUBLIC
Store value under key, activating the session on the first call.
-
orionis.session.contracts.ISession.has
orionis.session.contracts.ISession.html#has
Function
Method
PUBLIC
Return True when key exists in the session data.
-
orionis.session.contracts.ISession.forget
orionis.session.contracts.ISession.html#forget
Function
Method
PUBLIC
Remove key from session data (no-op when absent).
-
orionis.session.contracts.ISession.clear
orionis.session.contracts.ISession.html#clear
Function
Method
PUBLIC
Remove all data from this session.
-
orionis.session.contracts.ISession.flash
orionis.session.contracts.ISession.html#flash
Function
Method
PUBLIC
Store value under key for exactly one subsequent request.
-
orionis.session.contracts.ISession.getFlash
orionis.session.contracts.ISession.html#getFlash
Function
Method
PUBLIC
Return the flash value for key.
-
orionis.session.contracts.ISession.flashInput
orionis.session.contracts.ISession.html#flashInput
Function
Method
PUBLIC
Flash a submitted form payload so the next request can repopulate it.
-
orionis.session.contracts.ISession.getOldInput
orionis.session.contracts.ISession.html#getOldInput
Function
Method
PUBLIC
Return the value submitted for key in the previous request.
-
orionis.session.contracts.ISession.flashErrors
orionis.session.contracts.ISession.html#flashErrors
Function
Method
PUBLIC
Flash validation errors for the next request.
-
orionis.session.contracts.ISession.getErrors
orionis.session.contracts.ISession.html#getErrors
Function
Method
PUBLIC
Return the validation errors flashed for this request.
-
orionis.session.contracts.ISession.setPreviousUrl
orionis.session.contracts.ISession.html#setPreviousUrl
Function
Method
PUBLIC
Remember the page the user is currently viewing.
-
orionis.session.contracts.ISession.getPreviousUrl
orionis.session.contracts.ISession.html#getPreviousUrl
Function
Method
PUBLIC
Return the last page the user navigated to.
-
orionis.session.contracts.ISession.regenerate
orionis.session.contracts.ISession.html#regenerate
Function
Method
PUBLIC
Request a session ID rotation (e.g. immediately after login).
-
orionis.session.contracts.ISession.invalidate
orionis.session.contracts.ISession.html#invalidate
Function
Method
PUBLIC
Mark the session for full deletion and clear in-memory data.
-
orionis.session.contracts.ISession.all
orionis.session.contracts.ISession.html#all
Function
Method
PUBLIC
Return a shallow copy of the current session data.
-
orionis.session.contracts.ISessionStore
orionis.session.contracts.ISessionStore.html
Class
Class
PUBLIC
Contract every session backing-store must satisfy.
-
orionis.session.contracts.ISessionStore.__slots__
orionis.session.contracts.ISessionStore.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.session.contracts.ISessionStore.read
orionis.session.contracts.ISessionStore.html#read
Function
Method
PUBLIC
Return the stored record for session_id, or None.
-
orionis.session.contracts.ISessionStore.write
orionis.session.contracts.ISessionStore.html#write
Function
Method
PUBLIC
Persist record, creating or overwriting the existing entry.
-
orionis.session.contracts.ISessionStore.update
orionis.session.contracts.ISessionStore.html#update
Function
Method
PUBLIC
Update a live session atomically without creating a missing record.
-
orionis.session.contracts.ISessionStore.delete
orionis.session.contracts.ISessionStore.html#delete
Function
Method
PUBLIC
Remove the record for session_id; a no-op when absent.
-
orionis.session.contracts.ISessionStore.gc
orionis.session.contracts.ISessionStore.html#gc
Function
Method
PUBLIC
Remove all records whose expires_at is in the past.
-
orionis.session.exceptions.SessionException
orionis.session.exceptions.SessionException.html
Class
Exception
PUBLIC
Base class for all session-related exceptions.
-
orionis.session.exceptions.SessionStorageException
orionis.session.exceptions.SessionStorageException.html
Class
Exception
PUBLIC
Raised when a backing-store operation fails unexpectedly.
-
orionis.session.stores.cache._KEY_PREFIX
orionis.session.stores.cache.html#_KEY_PREFIX
Attribute
Constant
PUBLIC
Namespace prefix keeping session entries away from unrelated cache keys.
-
orionis.session.stores.cache.CacheSessionStore
orionis.session.stores.cache.CacheSessionStore.html
Class
Class
PUBLIC
Session store backed by the framework's cache system.
-
orionis.session.stores.cache.CacheSessionStore.__slots__
orionis.session.stores.cache.CacheSessionStore.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.session.stores.cache.CacheSessionStore.__init__
orionis.session.stores.cache.CacheSessionStore.html#__init__
Function
Method
PUBLIC
Bind the store to the requested (or default) cache repository.
-
orionis.session.stores.cache.CacheSessionStore._repository
orionis.session.stores.cache.CacheSessionStore.html#_repository
Attribute
Instance Variable
PUBLIC
Repository produced by cache.store.
-
orionis.session.stores.cache.CacheSessionStore.read
orionis.session.stores.cache.CacheSessionStore.html#read
Function
Method
PUBLIC
Return the stored record for session_id, or None.
-
orionis.session.stores.cache.CacheSessionStore.write
orionis.session.stores.cache.CacheSessionStore.html#write
Function
Method
PUBLIC
Insert or replace the record keyed by its identifier.
-
orionis.session.stores.cache.CacheSessionStore.update
orionis.session.stores.cache.CacheSessionStore.html#update
Function
Method
PUBLIC
Replace a live cache session without recreating a missing key.
-
orionis.session.stores.cache.CacheSessionStore.delete
orionis.session.stores.cache.CacheSessionStore.html#delete
Function
Method
PUBLIC
Remove the record for session_id (no-op when absent).
-
orionis.session.stores.cache.CacheSessionStore.gc
orionis.session.stores.cache.CacheSessionStore.html#gc
Function
Method
PUBLIC
Leave expiration cleanup to the cache backend's TTL.
-
orionis.session.stores.file._SessionPayload
orionis.session.stores.file._SessionPayload.html
Class
Class
PUBLIC
Represent the serialized payload stored for a session.
-
orionis.session.stores.file._SessionPayload.id
orionis.session.stores.file._SessionPayload.html#id
Attribute
Instance Variable
PUBLIC
Unique session identifier.
-
orionis.session.stores.file._SessionPayload.expires_at
orionis.session.stores.file._SessionPayload.html#expires_at
Attribute
Instance Variable
PUBLIC
Expiration timestamp in UTC.
-
orionis.session.stores.file._SessionPayload.data
orionis.session.stores.file._SessionPayload.html#data
Attribute
Instance Variable
PUBLIC
Session key-value data.
-
orionis.session.stores.file._ENCODER
orionis.session.stores.file.html#_ENCODER
Attribute
Constant
PUBLIC
msgspec resolves the struct layout at construction time instead of on every encode/decode call.
-
orionis.session.stores.file._DECODER
orionis.session.stores.file.html#_DECODER
Attribute
Constant
PUBLIC
Decoder used by file.
-
orionis.session.stores.file._STALE_TEMP_SECONDS
orionis.session.stores.file.html#_STALE_TEMP_SECONDS
Attribute
Constant
PUBLIC
A staging file younger than this may still belong to an in-flight write.
-
orionis.session.stores.file._REPLACE_ATTEMPTS
orionis.session.stores.file.html#_REPLACE_ATTEMPTS
Attribute
Constant
PUBLIC
Windows refuses a rename while another process swaps the same destination.
-
orionis.session.stores.file._REPLACE_BACKOFF_SECONDS
orionis.session.stores.file.html#_REPLACE_BACKOFF_SECONDS
Attribute
Constant
PUBLIC
Replace backoff seconds value used by file.
-
orionis.session.stores.file._LOCK_STRIPES
orionis.session.stores.file.html#_LOCK_STRIPES
Attribute
Constant
PUBLIC
Lock stripes value used by file.
-
orionis.session.stores.file._VALID_ID
orionis.session.stores.file.html#_VALID_ID
Attribute
Constant
PUBLIC
Compiled pattern used to recognize valid id.
-
orionis.session.stores.file._VALID_FILE
orionis.session.stores.file.html#_VALID_FILE
Attribute
Constant
PUBLIC
Recognize filenames that can be produced from valid session identifiers.
-
orionis.session.stores.file._VALID_TEMP
orionis.session.stores.file.html#_VALID_TEMP
Attribute
Constant
PUBLIC
Recognize staging files created by the session writer.
-
orionis.session.stores.file.FileSessionStore
orionis.session.stores.file.FileSessionStore.html
Class
Class
PUBLIC
Session store that persists each session as a JSON file on disk.
-
orionis.session.stores.file.FileSessionStore.__slots__
orionis.session.stores.file.FileSessionStore.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.session.stores.file.FileSessionStore.__init__
orionis.session.stores.file.FileSessionStore.html#__init__
Function
Method
PUBLIC
Resolve the storage directory and create it when missing.
-
orionis.session.stores.file.FileSessionStore._directory
orionis.session.stores.file.FileSessionStore.html#_directory
Attribute
Instance Variable
PUBLIC
Canonical absolute directory containing the session files.
-
orionis.session.stores.file.FileSessionStore._rename_lock
orionis.session.stores.file.FileSessionStore.html#_rename_lock
Attribute
Instance Variable
PUBLIC
Writes run on worker threads, so publishing two payloads for the same session must not overlap inside this process.
-
orionis.session.stores.file.FileSessionStore._locks
orionis.session.stores.file.FileSessionStore.html#_locks
Attribute
Instance Variable
PUBLIC
Locks produced by tuple.
-
orionis.session.stores.file.FileSessionStore._lock
orionis.session.stores.file.FileSessionStore.html#_lock
Function
Method
PUBLIC
Select a bounded, stable cross-process lock for a session file.
-
orionis.session.stores.file.FileSessionStore._path
orionis.session.stores.file.FileSessionStore.html#_path
Function
Method
PUBLIC
Return the absolute path to the JSON file for session_id.
-
orionis.session.stores.file.FileSessionStore._serialize
orionis.session.stores.file.FileSessionStore.html#_serialize
Function
Method
PUBLIC
Encode record to compact JSON bytes via msgspec.
-
orionis.session.stores.file.FileSessionStore._deserialize
orionis.session.stores.file.FileSessionStore.html#_deserialize
Function
Method
PUBLIC
Decode JSON bytes into a session record.
-
orionis.session.stores.file.FileSessionStore._readFile
orionis.session.stores.file.FileSessionStore.html#_readFile
Function
Method
PUBLIC
Read path as raw bytes, returning None if absent.
-
orionis.session.stores.file.FileSessionStore._tempPath
orionis.session.stores.file.FileSessionStore.html#_tempPath
Function
Static Method
PUBLIC
Build a unique staging path for an atomic write.
-
orionis.session.stores.file.FileSessionStore._writeFile
orionis.session.stores.file.FileSessionStore.html#_writeFile
Function
Method
PUBLIC
Atomically write content to path.
-
orionis.session.stores.file.FileSessionStore._replace
orionis.session.stores.file.FileSessionStore.html#_replace
Function
Method
PUBLIC
Publish tmp as path, retrying a transient sharing violation.
-
orionis.session.stores.file.FileSessionStore._deleteFile
orionis.session.stores.file.FileSessionStore.html#_deleteFile
Function
Method
PUBLIC
Unlink path, silently ignoring a missing-file error.
-
orionis.session.stores.file.FileSessionStore._readRecord
orionis.session.stores.file.FileSessionStore.html#_readRecord
Function
Method
PUBLIC
Load, decode and validate the record stored at path.
-
orionis.session.stores.file.FileSessionStore._writeRecord
orionis.session.stores.file.FileSessionStore.html#_writeRecord
Function
Method
PUBLIC
Serialise record and store it atomically at path.
-
orionis.session.stores.file.FileSessionStore._updateRecord
orionis.session.stores.file.FileSessionStore.html#_updateRecord
Function
Method
PUBLIC
Replace an existing live session under its cross-process lock.
-
orionis.session.stores.file.FileSessionStore._deleteStaleTemp
orionis.session.stores.file.FileSessionStore.html#_deleteStaleTemp
Function
Method
PUBLIC
Remove stale staging data after its session writer releases ownership.
-
orionis.session.stores.file.FileSessionStore._gcSweep
orionis.session.stores.file.FileSessionStore.html#_gcSweep
Function
Method
PUBLIC
Scan the store directory and remove stale or corrupt files.
-
orionis.session.stores.file.FileSessionStore.read
orionis.session.stores.file.FileSessionStore.html#read
Function
Method
PUBLIC
Load and return the live record for session_id, or None.
-
orionis.session.stores.file.FileSessionStore.write
orionis.session.stores.file.FileSessionStore.html#write
Function
Method
PUBLIC
Serialise and persist record to disk atomically.
-
orionis.session.stores.file.FileSessionStore.update
orionis.session.stores.file.FileSessionStore.html#update
Function
Method
PUBLIC
Update only a live session without recreating a deleted file.
-
orionis.session.stores.file.FileSessionStore.delete
orionis.session.stores.file.FileSessionStore.html#delete
Function
Method
PUBLIC
Remove the session file for session_id (no-op when absent).
-
orionis.session.stores.file.FileSessionStore.gc
orionis.session.stores.file.FileSessionStore.html#gc
Function
Method
PUBLIC
Remove all expired, corrupt, or incomplete session files.
-
orionis.session.stores.memory.MemorySessionStore
orionis.session.stores.memory.MemorySessionStore.html
Class
Class
PUBLIC
In-process session store backed by a plain dictionary.
-
orionis.session.stores.memory.MemorySessionStore.__slots__
orionis.session.stores.memory.MemorySessionStore.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.session.stores.memory.MemorySessionStore.__init__
orionis.session.stores.memory.MemorySessionStore.html#__init__
Function
Method
PUBLIC
Initialise an empty in-memory session store.
-
orionis.session.stores.memory.MemorySessionStore._storage
orionis.session.stores.memory.MemorySessionStore.html#_storage
Attribute
Instance Variable
PUBLIC
Entries retained by the in-memory storage backend.
-
orionis.session.stores.memory.MemorySessionStore.read
orionis.session.stores.memory.MemorySessionStore.html#read
Function
Method
PUBLIC
Return the stored record for session_id, or None.
-
orionis.session.stores.memory.MemorySessionStore.write
orionis.session.stores.memory.MemorySessionStore.html#write
Function
Method
PUBLIC
Insert or replace the record keyed by its identifier.
-
orionis.session.stores.memory.MemorySessionStore.update
orionis.session.stores.memory.MemorySessionStore.html#update
Function
Method
PUBLIC
Replace a live record without yielding between checking and writing.
-
orionis.session.stores.memory.MemorySessionStore.delete
orionis.session.stores.memory.MemorySessionStore.html#delete
Function
Method
PUBLIC
Remove the record for session_id (no-op when absent).
-
orionis.session.stores.memory.MemorySessionStore.gc
orionis.session.stores.memory.MemorySessionStore.html#gc
Function
Method
PUBLIC
Evict all records whose expires_at is in the past.
-
orionis.storage.Directory
orionis.storage.Directory.html
Class
Class
PUBLIC
Represent a directory on a storage disk.
-
orionis.storage.Directory.__slots__
orionis.storage.Directory.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.storage.Directory.__init__
orionis.storage.Directory.html#__init__
Function
Method
PUBLIC
Initialize the directory with its driver and canonical path.
-
orionis.storage.Directory._driver
orionis.storage.Directory.html#_driver
Attribute
Instance Variable
PUBLIC
Driver of the disk that owns the directory.
-
orionis.storage.Directory._path
orionis.storage.Directory.html#_path
Attribute
Instance Variable
PUBLIC
Root-relative directory path; normalized on ingestion. The empty string denotes the disk root.
-
orionis.storage.Directory.path
orionis.storage.Directory.html#path
Function
Method
PUBLIC
Return the canonical root-relative path of the directory.
-
orionis.storage.Directory.create
orionis.storage.Directory.html#create
Function
Method
PUBLIC
Create the directory, including any missing parents.
-
orionis.storage.Directory.delete
orionis.storage.Directory.html#delete
Function
Method
PUBLIC
Recursively delete the directory and its contents.
-
orionis.storage.Directory.exists
orionis.storage.Directory.html#exists
Function
Method
PUBLIC
Check whether the directory exists on its disk.
-
orionis.storage.Directory.files
orionis.storage.Directory.html#files
Function
Method
PUBLIC
List the files directly contained in the directory.
-
orionis.storage.Directory.allFiles
orionis.storage.Directory.html#allFiles
Function
Method
PUBLIC
List every file contained in the directory tree.
-
orionis.storage.Directory.directories
orionis.storage.Directory.html#directories
Function
Method
PUBLIC
List the directories directly contained in the directory.
-
orionis.storage.Directory.allDirectories
orionis.storage.Directory.html#allDirectories
Function
Method
PUBLIC
List every directory contained in the directory tree.
-
orionis.storage.Disk
orionis.storage.Disk.html
Class
Class
PUBLIC
Represent a configured storage disk.
-
orionis.storage.Disk.__slots__
orionis.storage.Disk.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.storage.Disk.__init__
orionis.storage.Disk.html#__init__
Function
Method
PUBLIC
Initialize the disk with its configuration name and driver.
-
orionis.storage.Disk._name
orionis.storage.Disk.html#_name
Attribute
Instance Variable
PUBLIC
Disk name as declared in the filesystems configuration.
-
orionis.storage.Disk._driver
orionis.storage.Disk.html#_driver
Attribute
Instance Variable
PUBLIC
Driver instance backing the disk.
-
orionis.storage.Disk.name
orionis.storage.Disk.html#name
Function
Method
PUBLIC
Return the configuration name of the disk.
-
orionis.storage.Disk.file
orionis.storage.Disk.html#file
Function
Method
PUBLIC
Build a file object for path on this disk.
-
orionis.storage.Disk.directory
orionis.storage.Disk.html#directory
Function
Method
PUBLIC
Build a directory object for path on this disk.
-
orionis.storage.Disk.put
orionis.storage.Disk.html#put
Function
Method
PUBLIC
Write contents to path on this disk.
-
orionis.storage.Disk.exists
orionis.storage.Disk.html#exists
Function
Method
PUBLIC
Check whether a file exists at path on this disk.
-
orionis.storage.Disk.delete
orionis.storage.Disk.html#delete
Function
Method
PUBLIC
Delete the file at path from this disk.
-
orionis.storage.Disk.copy
orionis.storage.Disk.html#copy
Function
Method
PUBLIC
Copy the file at source to target on this disk.
-
orionis.storage.Disk.move
orionis.storage.Disk.html#move
Function
Method
PUBLIC
Move the file at source to target on this disk.
-
orionis.storage.buffering.READ_BUFFER_SIZE
orionis.storage.buffering.html#READ_BUFFER_SIZE
Attribute
Constant
PUBLIC
Read buffer size used by buffering.
-
orionis.storage.buffering._close_buffer
orionis.storage.buffering.html#_close_buffer
Function
Function
PUBLIC
Drain one owned resource close without replacing an active failure.
-
orionis.storage.buffering.read_chunks
orionis.storage.buffering.html#read_chunks
Function
Function
PUBLIC
Read bounded batches while preserving logical chunks and first-byte latency.
-
orionis.storage.buffering.iterate_chunks
orionis.storage.buffering.html#iterate_chunks
Function
Function
PUBLIC
Batch SDK iterator advances with bounded read-ahead and deterministic close.
-
orionis.storage.buffering.spool_stream
orionis.storage.buffering.html#spool_stream
Function
Function
PUBLIC
Buffer an async upload once for the cloud drivers.
-
orionis.storage.drivers.functions._ALLOWED_MODES
orionis.storage.drivers.functions.html#_ALLOWED_MODES
Attribute
Constant
PUBLIC
Binary modes accepted by driver open() implementations.
-
orionis.storage.drivers.functions._ModeBuffer
orionis.storage.drivers.functions._ModeBuffer.html
Class
Class
PUBLIC
Enforce binary access modes while owning a buffered storage payload.
-
orionis.storage.drivers.functions._ModeBuffer.__slots__
orionis.storage.drivers.functions._ModeBuffer.html#__slots__
Attribute
Class Variable
PUBLIC
Reserve the binary mode and the owned underlying buffer.
-
orionis.storage.drivers.functions._ModeBuffer.__init__
orionis.storage.drivers.functions._ModeBuffer.html#__init__
Function
Method
PUBLIC
Own a buffer and apply the driver's validated binary mode.
-
orionis.storage.drivers.functions._ModeBuffer.raw
orionis.storage.drivers.functions._ModeBuffer.html#raw
Attribute
Instance Variable
PUBLIC
Keep the underlying buffer available to persistence callbacks.
-
orionis.storage.drivers.functions._ModeBuffer._mode
orionis.storage.drivers.functions._ModeBuffer.html#_mode
Attribute
Instance Variable
PUBLIC
Store the binary mode controlling the wrapper's I/O permissions.
-
orionis.storage.drivers.functions._ModeBuffer.closed
orionis.storage.drivers.functions._ModeBuffer.html#closed
Attribute
Property
PUBLIC
Report whether the wrapper or its owned buffer has closed.
-
orionis.storage.drivers.functions._ModeBuffer._requireOpen
orionis.storage.drivers.functions._ModeBuffer.html#_requireOpen
Function
Method
PUBLIC
Reject operations after the buffer has closed.
-
orionis.storage.drivers.functions._ModeBuffer.readable
orionis.storage.drivers.functions._ModeBuffer.html#readable
Function
Method
PUBLIC
Report whether the selected mode permits reading.
-
orionis.storage.drivers.functions._ModeBuffer.writable
orionis.storage.drivers.functions._ModeBuffer.html#writable
Function
Method
PUBLIC
Report whether the selected mode permits writing.
-
orionis.storage.drivers.functions._ModeBuffer.seekable
orionis.storage.drivers.functions._ModeBuffer.html#seekable
Function
Method
PUBLIC
Report whether the owned buffer supports seeking.
-
orionis.storage.drivers.functions._ModeBuffer._requireReadable
orionis.storage.drivers.functions._ModeBuffer.html#_requireReadable
Function
Method
PUBLIC
Reject reads disallowed by the selected mode.
-
orionis.storage.drivers.functions._ModeBuffer._requireWritable
orionis.storage.drivers.functions._ModeBuffer.html#_requireWritable
Function
Method
PUBLIC
Reject writes disallowed by the selected mode.
-
orionis.storage.drivers.functions._ModeBuffer.read
orionis.storage.drivers.functions._ModeBuffer.html#read
Function
Method
PUBLIC
Read at most the requested number of bytes.
-
orionis.storage.drivers.functions._ModeBuffer.read1
orionis.storage.drivers.functions._ModeBuffer.html#read1
Function
Method
PUBLIC
Read one logical block from the already buffered payload.
-
orionis.storage.drivers.functions._ModeBuffer.readinto
orionis.storage.drivers.functions._ModeBuffer.html#readinto
Function
Method
PUBLIC
Read into a writable byte buffer when reading is permitted.
-
orionis.storage.drivers.functions._ModeBuffer.readline
orionis.storage.drivers.functions._ModeBuffer.html#readline
Function
Method
PUBLIC
Read one line within the selected mode's permissions.
-
orionis.storage.drivers.functions._ModeBuffer.write
orionis.storage.drivers.functions._ModeBuffer.html#write
Function
Method
PUBLIC
Write permitted bytes and force append-mode writes to EOF.
-
orionis.storage.drivers.functions._ModeBuffer.truncate
orionis.storage.drivers.functions._ModeBuffer.html#truncate
Function
Method
PUBLIC
Resize the buffer only when the selected mode permits writing.
-
orionis.storage.drivers.functions._ModeBuffer.seek
orionis.storage.drivers.functions._ModeBuffer.html#seek
Function
Method
PUBLIC
Move the position without changing append-mode write behavior.
-
orionis.storage.drivers.functions._ModeBuffer.tell
orionis.storage.drivers.functions._ModeBuffer.html#tell
Function
Method
PUBLIC
Return the current position of the owned buffer.
-
orionis.storage.drivers.functions._ModeBuffer.flush
orionis.storage.drivers.functions._ModeBuffer.html#flush
Function
Method
PUBLIC
Flush the underlying buffer without exposing prohibited reads.
-
orionis.storage.drivers.functions._ModeBuffer.close
orionis.storage.drivers.functions._ModeBuffer.html#close
Function
Method
PUBLIC
Close the wrapper and its owned buffer while preserving failures.
-
orionis.storage.drivers.functions._close_failed_buffer
orionis.storage.drivers.functions.html#_close_failed_buffer
Function
Function
PUBLIC
Close an unpublished buffer without replacing its opening failure.
-
orionis.storage.drivers.functions.import_driver_dependency
orionis.storage.drivers.functions.html#import_driver_dependency
Function
Function
PUBLIC
Import an optional SDK module required by a storage driver.
-
orionis.storage.drivers.functions.assert_binary_mode
orionis.storage.drivers.functions.html#assert_binary_mode
Function
Function
PUBLIC
Validate a stream mode against the supported binary modes.
-
orionis.storage.drivers.functions.resolve_download_target
orionis.storage.drivers.functions.html#resolve_download_target
Function
Function
PUBLIC
Resolve the local target path for a download operation.
-
orionis.storage.drivers.functions.filter_files
orionis.storage.drivers.functions.html#filter_files
Function
Function
PUBLIC
Select the object keys that represent files under base.
-
orionis.storage.drivers.functions._directory_ancestors
orionis.storage.drivers.functions.html#_directory_ancestors
Function
Function
PUBLIC
Yield every directory prefix implied by key down to base.
-
orionis.storage.drivers.functions.derive_directories
orionis.storage.drivers.functions.html#derive_directories
Function
Function
PUBLIC
Derive the directory paths implied by object keys under base.
-
orionis.storage.drivers.functions._LEGACY_EXPORTS
orionis.storage.drivers.functions.html#_LEGACY_EXPORTS
Attribute
Constant
PUBLIC
Legacy exports definitions used by functions.
-
orionis.storage.drivers.functions.__getattr__
orionis.storage.drivers.functions.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a legacy driver helper name.
-
orionis.storage.drivers.azure._CHUNK_SIZE
orionis.storage.drivers.azure.html#_CHUNK_SIZE
Attribute
Constant
PUBLIC
Default chunk size for streaming operations (64 KiB).
-
orionis.storage.drivers.azure._SPOOL_THRESHOLD
orionis.storage.drivers.azure.html#_SPOOL_THRESHOLD
Attribute
Constant
PUBLIC
In-memory bytes before spooled buffers spill to disk (8 MiB).
-
orionis.storage.drivers.gcs._CHUNK_SIZE
orionis.storage.drivers.gcs.html#_CHUNK_SIZE
Attribute
Constant
PUBLIC
Default chunk size for streaming operations (64 KiB).
-
orionis.storage.drivers.gcs._SPOOL_THRESHOLD
orionis.storage.drivers.gcs.html#_SPOOL_THRESHOLD
Attribute
Constant
PUBLIC
In-memory bytes before spooled buffers spill to disk (8 MiB).
-
orionis.storage.drivers.gcs._DEFAULT_CONTENT_TYPE
orionis.storage.drivers.gcs.html#_DEFAULT_CONTENT_TYPE
Attribute
Constant
PUBLIC
Content type applied when the MIME type cannot be guessed.
-
orionis.storage.drivers.gcs._ACL_MAP
orionis.storage.drivers.gcs.html#_ACL_MAP
Attribute
Constant
PUBLIC
Predefined ACLs applied per visibility level.
-
orionis.storage.drivers.local._CHUNK_SIZE
orionis.storage.drivers.local.html#_CHUNK_SIZE
Attribute
Constant
PUBLIC
Default chunk size for streaming operations (64 KiB).
-
orionis.storage.drivers.local._FILE_MODES
orionis.storage.drivers.local.html#_FILE_MODES
Attribute
Constant
PUBLIC
POSIX permission bits applied per visibility level.
-
orionis.storage.drivers.local._ALLOWED_MODES
orionis.storage.drivers.local.html#_ALLOWED_MODES
Attribute
Constant
PUBLIC
Binary modes accepted by open().
-
orionis.storage.drivers.local._STAGING_SUFFIX
orionis.storage.drivers.local.html#_STAGING_SUFFIX
Attribute
Constant
PUBLIC
Identify the reserved sibling suffix used for atomic publication.
-
orionis.storage.drivers.local._path_mode
orionis.storage.drivers.local.html#_path_mode
Function
Function
PUBLIC
Read path metadata while distinguishing absence from an I/O failure.
-
orionis.storage.drivers.local._raise_walk_error
orionis.storage.drivers.local.html#_raise_walk_error
Function
Function
PUBLIC
Propagate a directory scan error instead of returning a partial listing.
-
orionis.storage.drivers.memory._CHUNK_SIZE
orionis.storage.drivers.memory.html#_CHUNK_SIZE
Attribute
Constant
PUBLIC
Default chunk size for streaming operations (64 KiB).
-
orionis.storage.drivers.memory._ALLOWED_MODES
orionis.storage.drivers.memory.html#_ALLOWED_MODES
Attribute
Constant
PUBLIC
Binary modes accepted by open().
-
orionis.storage.drivers.memory._now
orionis.storage.drivers.memory.html#_now
Function
Function
PUBLIC
Return the current timezone-aware UTC timestamp.
-
orionis.storage.drivers.memory._MemoryEntry
orionis.storage.drivers.memory._MemoryEntry.html
Class
Class
PUBLIC
Hold the content and metadata of a single in-memory file.
-
orionis.storage.drivers.memory._MemoryEntry.content
orionis.storage.drivers.memory._MemoryEntry.html#content
Attribute
Instance Variable
PUBLIC
Raw file contents.
-
orionis.storage.drivers.memory._MemoryEntry.visibility
orionis.storage.drivers.memory._MemoryEntry.html#visibility
Attribute
Instance Variable
PUBLIC
Visibility level of the file.
-
orionis.storage.drivers.memory._MemoryEntry.created_at
orionis.storage.drivers.memory._MemoryEntry.html#created_at
Attribute
Instance Variable
PUBLIC
Timestamp of the first write.
-
orionis.storage.drivers.memory._MemoryEntry.modified_at
orionis.storage.drivers.memory._MemoryEntry.html#modified_at
Attribute
Instance Variable
PUBLIC
Timestamp of the most recent write.
-
orionis.storage.drivers.s3._CHUNK_SIZE
orionis.storage.drivers.s3.html#_CHUNK_SIZE
Attribute
Constant
PUBLIC
Default chunk size for streaming operations (64 KiB).
-
orionis.storage.drivers.s3._SPOOL_THRESHOLD
orionis.storage.drivers.s3.html#_SPOOL_THRESHOLD
Attribute
Constant
PUBLIC
In-memory bytes before spooled buffers spill to disk (8 MiB).
-
orionis.storage.drivers.s3._DELETE_BATCH
orionis.storage.drivers.s3.html#_DELETE_BATCH
Attribute
Constant
PUBLIC
Maximum number of keys per S3 batch-delete request.
-
orionis.storage.drivers.s3._MISSING_CODES
orionis.storage.drivers.s3.html#_MISSING_CODES
Attribute
Constant
PUBLIC
Error codes reported by S3 for missing objects.
-
orionis.storage.drivers.s3._ACL_MAP
orionis.storage.drivers.s3.html#_ACL_MAP
Attribute
Constant
PUBLIC
Canned ACLs applied per visibility level.
-
orionis.storage.drivers.s3._ALL_USERS_URI
orionis.storage.drivers.s3.html#_ALL_USERS_URI
Attribute
Constant
PUBLIC
Grantee URI identifying anonymous users in S3 ACL grants. This is the canonical identifier defined by AWS, not a network endpoint, so the scheme must remain exactly as documented.
-
orionis.storage.File
orionis.storage.File.html
Class
Class
PUBLIC
Represent a single file on a storage disk.
-
orionis.storage.File.__slots__
orionis.storage.File.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.storage.File.__init__
orionis.storage.File.html#__init__
Function
Method
PUBLIC
Initialize the file with its driver and canonical path.
-
orionis.storage.File._driver
orionis.storage.File.html#_driver
Attribute
Instance Variable
PUBLIC
Driver of the disk that owns the file.
-
orionis.storage.File._path
orionis.storage.File.html#_path
Attribute
Instance Variable
PUBLIC
Root-relative file path; normalized on ingestion.
-
orionis.storage.File.path
orionis.storage.File.html#path
Function
Method
PUBLIC
Return the canonical root-relative path of the file.
-
orionis.storage.File.absolutePath
orionis.storage.File.html#absolutePath
Function
Method
PUBLIC
Return the absolute filesystem path of the file.
-
orionis.storage.File.relativePath
orionis.storage.File.html#relativePath
Function
Method
PUBLIC
Return the filesystem path relative to the application base path.
-
orionis.storage.File.read
orionis.storage.File.html#read
Function
Method
PUBLIC
Read the full contents of the file.
-
orionis.storage.File.readStream
orionis.storage.File.html#readStream
Function
Method
PUBLIC
Stream the contents of the file in chunks.
-
orionis.storage.File.write
orionis.storage.File.html#write
Function
Method
PUBLIC
Write contents to the file, replacing existing data.
-
orionis.storage.File.writeStream
orionis.storage.File.html#writeStream
Function
Method
PUBLIC
Write the chunks produced by stream to the file.
-
orionis.storage.File.open
orionis.storage.File.html#open
Function
Method
PUBLIC
Open an asynchronous binary stream over the file.
-
orionis.storage.File.delete
orionis.storage.File.html#delete
Function
Method
PUBLIC
Delete the file from its disk.
-
orionis.storage.File.exists
orionis.storage.File.html#exists
Function
Method
PUBLIC
Check whether the file exists on its disk.
-
orionis.storage.File.copyTo
orionis.storage.File.html#copyTo
Function
Method
PUBLIC
Copy the file to target on the same disk.
-
orionis.storage.File.moveTo
orionis.storage.File.html#moveTo
Function
Method
PUBLIC
Move the file to target on the same disk.
-
orionis.storage.File.rename
orionis.storage.File.html#rename
Function
Method
PUBLIC
Rename the file within its current directory.
-
orionis.storage.File.size
orionis.storage.File.html#size
Function
Method
PUBLIC
Return the size of the file in bytes.
-
orionis.storage.File.mimeType
orionis.storage.File.html#mimeType
Function
Method
PUBLIC
Guess the MIME type of the file.
-
orionis.storage.File.lastModified
orionis.storage.File.html#lastModified
Function
Method
PUBLIC
Return the last-modification timestamp of the file.
-
orionis.storage.File.url
orionis.storage.File.html#url
Function
Method
PUBLIC
Build the public URL of the file.
-
orionis.storage.File.temporaryUrl
orionis.storage.File.html#temporaryUrl
Function
Method
PUBLIC
Build a signed, time-limited URL for the file.
-
orionis.storage.File.visibility
orionis.storage.File.html#visibility
Function
Method
PUBLIC
Return the visibility of the file.
-
orionis.storage.File.setVisibility
orionis.storage.File.html#setVisibility
Function
Method
PUBLIC
Change the visibility of the file.
-
orionis.storage.File.download
orionis.storage.File.html#download
Function
Method
PUBLIC
Copy the file to a location on the local filesystem.
-
orionis.storage.File.hash
orionis.storage.File.html#hash
Function
Method
PUBLIC
Compute the content hash of the file.
-
orionis.storage.File.info
orionis.storage.File.html#info
Function
Method
PUBLIC
Collect a metadata snapshot for the file.
-
orionis.storage.StorageManager
orionis.storage.StorageManager.html
Class
Class
PUBLIC
Coordinate disk resolution for the storage component.
-
orionis.storage.StorageManager.__slots__
orionis.storage.StorageManager.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.storage.StorageManager.__init__
orionis.storage.StorageManager.html#__init__
Function
Method
PUBLIC
Initialize the manager and resolve the active configuration.
-
orionis.storage.StorageManager._app
orionis.storage.StorageManager.html#_app
Attribute
Instance Variable
PUBLIC
Application container used to read the configuration and the base path.
-
orionis.storage.StorageManager._base_path
orionis.storage.StorageManager.html#_base_path
Attribute
Instance Variable
PUBLIC
Base path obtained from app.basePath.
-
orionis.storage.StorageManager._config
orionis.storage.StorageManager.html#_config
Attribute
Instance Variable
PUBLIC
Validated configuration used to construct and operate the service.
-
orionis.storage.StorageManager._default
orionis.storage.StorageManager.html#_default
Attribute
Instance Variable
PUBLIC
Value used when the client omits this argument.
-
orionis.storage.StorageManager._disks
orionis.storage.StorageManager.html#_disks
Attribute
Instance Variable
PUBLIC
Storage disks cached after their first resolution.
-
orionis.storage.StorageManager._custom
orionis.storage.StorageManager.html#_custom
Attribute
Instance Variable
PUBLIC
Custom implementations registered by the application.
-
orionis.storage.StorageManager._lock
orionis.storage.StorageManager.html#_lock
Attribute
Instance Variable
PUBLIC
Serialize disk publication while allowing nested synchronous factories.
-
orionis.storage.StorageManager.disk
orionis.storage.StorageManager.html#disk
Function
Method
PUBLIC
Resolve the disk registered under name.
-
orionis.storage.StorageManager.default
orionis.storage.StorageManager.html#default
Function
Method
PUBLIC
Resolve the default disk from the configuration.
-
orionis.storage.StorageManager.extend
orionis.storage.StorageManager.html#extend
Function
Method
PUBLIC
Register a custom driver factory under driver.
-
orionis.storage.StorageManager.uploaded
orionis.storage.StorageManager.html#uploaded
Function
Method
PUBLIC
Wrap an HTTP multipart payload as a storable uploaded file.
-
orionis.storage.StorageManager.__diskConfig
orionis.storage.StorageManager.html#__diskConfig
Function
Method
PUBLIC
Return the configuration entity for the disk named name.
-
orionis.storage.StorageManager.__buildDriver
orionis.storage.StorageManager.html#__buildDriver
Function
Method
PUBLIC
Instantiate the driver for the disk named name.
-
orionis.storage.StorageManager.__buildLocalDriver
orionis.storage.StorageManager.html#__buildLocalDriver
Function
Method
PUBLIC
Build a local driver from a disk configuration entity.
-
orionis.storage.AsyncStream
orionis.storage.AsyncStream.html
Class
Class
PUBLIC
Asynchronous wrapper around a lazily opened binary handle.
-
orionis.storage.AsyncStream.__slots__
orionis.storage.AsyncStream.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.storage.AsyncStream.__init__
orionis.storage.AsyncStream.html#__init__
Function
Method
PUBLIC
Initialize the stream with its handle factory.
-
orionis.storage.AsyncStream._opener
orionis.storage.AsyncStream.html#_opener
Attribute
Instance Variable
PUBLIC
Zero-argument callable returning the binary handle. It is invoked lazily on a worker thread.
-
orionis.storage.AsyncStream._on_close
orionis.storage.AsyncStream.html#_on_close
Attribute
Instance Variable
PUBLIC
Optional callback executed with the open handle right before it is closed.
-
orionis.storage.AsyncStream._handle
orionis.storage.AsyncStream.html#_handle
Attribute
Instance Variable
PUBLIC
Open stream handle used for asynchronous file operations.
-
orionis.storage.AsyncStream._lock
orionis.storage.AsyncStream.html#_lock
Attribute
Instance Variable
PUBLIC
Lock protecting concurrent access to shared state.
-
orionis.storage.AsyncStream.__ensureHandle
orionis.storage.AsyncStream.html#__ensureHandle
Function
Method
PUBLIC
Open the underlying handle on first use and return it.
-
orionis.storage.AsyncStream.read
orionis.storage.AsyncStream.html#read
Function
Method
PUBLIC
Read up to size bytes from the stream.
-
orionis.storage.AsyncStream.chunks
orionis.storage.AsyncStream.html#chunks
Function
Method
PUBLIC
Yield logical chunks with bounded batching of synchronous reads.
-
orionis.storage.AsyncStream.write
orionis.storage.AsyncStream.html#write
Function
Method
PUBLIC
Write data to the stream at the current position.
-
orionis.storage.AsyncStream.seek
orionis.storage.AsyncStream.html#seek
Function
Method
PUBLIC
Move the stream position to offset.
-
orionis.storage.AsyncStream.close
orionis.storage.AsyncStream.html#close
Function
Method
PUBLIC
Flush pending data and release the underlying handle.
-
orionis.storage.AsyncStream.__close
orionis.storage.AsyncStream.html#__close
Function
Method
PUBLIC
Persist and close the handle without replacing an existing failure.
-
orionis.storage.AsyncStream.__aenter__
orionis.storage.AsyncStream.html#__aenter__
Function
Method
PUBLIC
Open the underlying handle and return the stream.
-
orionis.storage.AsyncStream.__aexit__
orionis.storage.AsyncStream.html#__aexit__
Function
Method
PUBLIC
Close the stream when leaving the async context.
-
orionis.storage.UploadedFile
orionis.storage.UploadedFile.html
Class
Class
PUBLIC
Represent a file received through HTTP, ready to be stored.
-
orionis.storage.UploadedFile.__slots__
orionis.storage.UploadedFile.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.storage.UploadedFile.__init__
orionis.storage.UploadedFile.html#__init__
Function
Method
PUBLIC
Initialize the uploaded file with its payload and manager.
-
orionis.storage.UploadedFile._source
orionis.storage.UploadedFile.html#_source
Attribute
Instance Variable
PUBLIC
Buffered multipart payload produced by the HTTP layer.
-
orionis.storage.UploadedFile._manager
orionis.storage.UploadedFile.html#_manager
Attribute
Instance Variable
PUBLIC
Manager used to resolve target disks.
-
orionis.storage.UploadedFile._hash_name
orionis.storage.UploadedFile.html#_hash_name
Attribute
Instance Variable
PUBLIC
Generated filename retained for repeated storage operations.
-
orionis.storage.UploadedFile.originalName
orionis.storage.UploadedFile.html#originalName
Function
Method
PUBLIC
Return the sanitized client-supplied file name.
-
orionis.storage.UploadedFile.extension
orionis.storage.UploadedFile.html#extension
Function
Method
PUBLIC
Return the lowercase file extension including the dot.
-
orionis.storage.UploadedFile.size
orionis.storage.UploadedFile.html#size
Function
Method
PUBLIC
Return the size of the uploaded payload in bytes.
-
orionis.storage.UploadedFile.mimeType
orionis.storage.UploadedFile.html#mimeType
Function
Method
PUBLIC
Return the MIME type declared by the client.
-
orionis.storage.UploadedFile.hashName
orionis.storage.UploadedFile.html#hashName
Function
Method
PUBLIC
Return a random, collision-safe name for the file.
-
orionis.storage.UploadedFile.read
orionis.storage.UploadedFile.html#read
Function
Method
PUBLIC
Read the full uploaded payload.
-
orionis.storage.UploadedFile.store
orionis.storage.UploadedFile.html#store
Function
Method
PUBLIC
Persist the payload under a generated hash name.
-
orionis.storage.UploadedFile.storeAs
orionis.storage.UploadedFile.html#storeAs
Function
Method
PUBLIC
Persist the payload under an explicit file name.
-
orionis.storage.UploadedFile.move
orionis.storage.UploadedFile.html#move
Function
Method
PUBLIC
Persist the payload and release the upload buffer.
-
orionis.storage.UploadedFile.copy
orionis.storage.UploadedFile.html#copy
Function
Method
PUBLIC
Persist the payload while keeping the upload buffer usable.
-
orionis.storage._EXPORTS
orionis.storage.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.storage.__getattr__
orionis.storage.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public storage export.
-
orionis.storage.__dir__
orionis.storage.html#__dir__
Function
Function
PUBLIC
List loaded attributes and public storage exports.
-
orionis.storage.contracts.IDirectory
orionis.storage.contracts.IDirectory.html
Class
Class
PUBLIC
Define the contract for a directory on a storage disk.
-
orionis.storage.contracts.IDirectory.__slots__
orionis.storage.contracts.IDirectory.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.storage.contracts.IDirectory.path
orionis.storage.contracts.IDirectory.html#path
Function
Method
PUBLIC
Return the canonical root-relative path of the directory.
-
orionis.storage.contracts.IDirectory.create
orionis.storage.contracts.IDirectory.html#create
Function
Method
PUBLIC
Create the directory, including any missing parents.
-
orionis.storage.contracts.IDirectory.delete
orionis.storage.contracts.IDirectory.html#delete
Function
Method
PUBLIC
Recursively delete the directory and its contents.
-
orionis.storage.contracts.IDirectory.exists
orionis.storage.contracts.IDirectory.html#exists
Function
Method
PUBLIC
Check whether the directory exists on its disk.
-
orionis.storage.contracts.IDirectory.files
orionis.storage.contracts.IDirectory.html#files
Function
Method
PUBLIC
List the files directly contained in the directory.
-
orionis.storage.contracts.IDirectory.allFiles
orionis.storage.contracts.IDirectory.html#allFiles
Function
Method
PUBLIC
List every file contained in the directory tree.
-
orionis.storage.contracts.IDirectory.directories
orionis.storage.contracts.IDirectory.html#directories
Function
Method
PUBLIC
List the directories directly contained in the directory.
-
orionis.storage.contracts.IDirectory.allDirectories
orionis.storage.contracts.IDirectory.html#allDirectories
Function
Method
PUBLIC
List every directory contained in the directory tree.
-
orionis.storage.contracts.IDisk
orionis.storage.contracts.IDisk.html
Class
Class
PUBLIC
Define the contract for a configured storage disk.
-
orionis.storage.contracts.IDisk.__slots__
orionis.storage.contracts.IDisk.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.storage.contracts.IDisk.name
orionis.storage.contracts.IDisk.html#name
Function
Method
PUBLIC
Return the configuration name of the disk.
-
orionis.storage.contracts.IDisk.file
orionis.storage.contracts.IDisk.html#file
Function
Method
PUBLIC
Build a file object for path on this disk.
-
orionis.storage.contracts.IDisk.directory
orionis.storage.contracts.IDisk.html#directory
Function
Method
PUBLIC
Build a directory object for path on this disk.
-
orionis.storage.contracts.IDisk.put
orionis.storage.contracts.IDisk.html#put
Function
Method
PUBLIC
Write contents to path on this disk.
-
orionis.storage.contracts.IDisk.exists
orionis.storage.contracts.IDisk.html#exists
Function
Method
PUBLIC
Check whether a file exists at path on this disk.
-
orionis.storage.contracts.IDisk.delete
orionis.storage.contracts.IDisk.html#delete
Function
Method
PUBLIC
Delete the file at path from this disk.
-
orionis.storage.contracts.IDisk.copy
orionis.storage.contracts.IDisk.html#copy
Function
Method
PUBLIC
Copy the file at source to target on this disk.
-
orionis.storage.contracts.IDisk.move
orionis.storage.contracts.IDisk.html#move
Function
Method
PUBLIC
Move the file at source to target on this disk.
-
orionis.storage.contracts.IStorageDriver
orionis.storage.contracts.IStorageDriver.html
Class
Class
PUBLIC
Define the low-level contract every storage backend must implement.
-
orionis.storage.contracts.IStorageDriver.__slots__
orionis.storage.contracts.IStorageDriver.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.storage.contracts.IStorageDriver.absolutePath
orionis.storage.contracts.IStorageDriver.html#absolutePath
Function
Method
PUBLIC
Return the absolute filesystem path of the file at path.
-
orionis.storage.contracts.IStorageDriver.relativePath
orionis.storage.contracts.IStorageDriver.html#relativePath
Function
Method
PUBLIC
Return the filesystem path relative to the application base path.
-
orionis.storage.contracts.IStorageDriver.read
orionis.storage.contracts.IStorageDriver.html#read
Function
Method
PUBLIC
Read the full contents of the file at path.
-
orionis.storage.contracts.IStorageDriver.readStream
orionis.storage.contracts.IStorageDriver.html#readStream
Function
Method
PUBLIC
Stream the contents of the file at path in chunks.
-
orionis.storage.contracts.IStorageDriver.write
orionis.storage.contracts.IStorageDriver.html#write
Function
Method
PUBLIC
Write contents to path, replacing any existing file.
-
orionis.storage.contracts.IStorageDriver.writeStream
orionis.storage.contracts.IStorageDriver.html#writeStream
Function
Method
PUBLIC
Write the chunks produced by stream to path.
-
orionis.storage.contracts.IStorageDriver.delete
orionis.storage.contracts.IStorageDriver.html#delete
Function
Method
PUBLIC
Delete the file at path.
-
orionis.storage.contracts.IStorageDriver.exists
orionis.storage.contracts.IStorageDriver.html#exists
Function
Method
PUBLIC
Check whether a file exists at path.
-
orionis.storage.contracts.IStorageDriver.copy
orionis.storage.contracts.IStorageDriver.html#copy
Function
Method
PUBLIC
Copy the file at source to target.
-
orionis.storage.contracts.IStorageDriver.move
orionis.storage.contracts.IStorageDriver.html#move
Function
Method
PUBLIC
Move the file at source to target.
-
orionis.storage.contracts.IStorageDriver.size
orionis.storage.contracts.IStorageDriver.html#size
Function
Method
PUBLIC
Return the size in bytes of the file at path.
-
orionis.storage.contracts.IStorageDriver.mimeType
orionis.storage.contracts.IStorageDriver.html#mimeType
Function
Method
PUBLIC
Guess the MIME type of the file at path.
-
orionis.storage.contracts.IStorageDriver.lastModified
orionis.storage.contracts.IStorageDriver.html#lastModified
Function
Method
PUBLIC
Return the last-modification timestamp of the file at path.
-
orionis.storage.contracts.IStorageDriver.createDirectory
orionis.storage.contracts.IStorageDriver.html#createDirectory
Function
Method
PUBLIC
Create the directory at path, including missing parents.
-
orionis.storage.contracts.IStorageDriver.deleteDirectory
orionis.storage.contracts.IStorageDriver.html#deleteDirectory
Function
Method
PUBLIC
Recursively delete the directory at path.
-
orionis.storage.contracts.IStorageDriver.directoryExists
orionis.storage.contracts.IStorageDriver.html#directoryExists
Function
Method
PUBLIC
Check whether a directory exists at path.
-
orionis.storage.contracts.IStorageDriver.files
orionis.storage.contracts.IStorageDriver.html#files
Function
Method
PUBLIC
List the file paths contained in the directory at path.
-
orionis.storage.contracts.IStorageDriver.directories
orionis.storage.contracts.IStorageDriver.html#directories
Function
Method
PUBLIC
List the directory paths contained in the directory at path.
-
orionis.storage.contracts.IStorageDriver.url
orionis.storage.contracts.IStorageDriver.html#url
Function
Method
PUBLIC
Build the public URL for the file at path.
-
orionis.storage.contracts.IStorageDriver.temporaryUrl
orionis.storage.contracts.IStorageDriver.html#temporaryUrl
Function
Method
PUBLIC
Build a signed, time-limited URL for the file at path.
-
orionis.storage.contracts.IStorageDriver.visibility
orionis.storage.contracts.IStorageDriver.html#visibility
Function
Method
PUBLIC
Return the visibility of the file at path.
-
orionis.storage.contracts.IStorageDriver.setVisibility
orionis.storage.contracts.IStorageDriver.html#setVisibility
Function
Method
PUBLIC
Change the visibility of the file at path.
-
orionis.storage.contracts.IStorageDriver.download
orionis.storage.contracts.IStorageDriver.html#download
Function
Method
PUBLIC
Copy the file at path to a location on the local filesystem.
-
orionis.storage.contracts.IStorageDriver.hash
orionis.storage.contracts.IStorageDriver.html#hash
Function
Method
PUBLIC
Compute the content hash of the file at path.
-
orionis.storage.contracts.IStorageDriver.info
orionis.storage.contracts.IStorageDriver.html#info
Function
Method
PUBLIC
Collect a metadata snapshot for the file at path.
-
orionis.storage.contracts.IStorageDriver.open
orionis.storage.contracts.IStorageDriver.html#open
Function
Method
PUBLIC
Open an asynchronous binary stream for the file at path.
-
orionis.storage.contracts.IFile
orionis.storage.contracts.IFile.html
Class
Class
PUBLIC
Define the contract for a single file on a storage disk.
-
orionis.storage.contracts.IFile.__slots__
orionis.storage.contracts.IFile.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.storage.contracts.IFile.path
orionis.storage.contracts.IFile.html#path
Function
Method
PUBLIC
Return the canonical root-relative path of the file.
-
orionis.storage.contracts.IFile.absolutePath
orionis.storage.contracts.IFile.html#absolutePath
Function
Method
PUBLIC
Return the absolute filesystem path of the file.
-
orionis.storage.contracts.IFile.relativePath
orionis.storage.contracts.IFile.html#relativePath
Function
Method
PUBLIC
Return the filesystem path relative to the application base path.
-
orionis.storage.contracts.IFile.read
orionis.storage.contracts.IFile.html#read
Function
Method
PUBLIC
Read the full contents of the file.
-
orionis.storage.contracts.IFile.readStream
orionis.storage.contracts.IFile.html#readStream
Function
Method
PUBLIC
Stream the contents of the file in chunks.
-
orionis.storage.contracts.IFile.write
orionis.storage.contracts.IFile.html#write
Function
Method
PUBLIC
Write contents to the file, replacing existing data.
-
orionis.storage.contracts.IFile.writeStream
orionis.storage.contracts.IFile.html#writeStream
Function
Method
PUBLIC
Write the chunks produced by stream to the file.
-
orionis.storage.contracts.IFile.open
orionis.storage.contracts.IFile.html#open
Function
Method
PUBLIC
Open an asynchronous binary stream over the file.
-
orionis.storage.contracts.IFile.delete
orionis.storage.contracts.IFile.html#delete
Function
Method
PUBLIC
Delete the file from its disk.
-
orionis.storage.contracts.IFile.exists
orionis.storage.contracts.IFile.html#exists
Function
Method
PUBLIC
Check whether the file exists on its disk.
-
orionis.storage.contracts.IFile.copyTo
orionis.storage.contracts.IFile.html#copyTo
Function
Method
PUBLIC
Copy the file to target on the same disk.
-
orionis.storage.contracts.IFile.moveTo
orionis.storage.contracts.IFile.html#moveTo
Function
Method
PUBLIC
Move the file to target on the same disk.
-
orionis.storage.contracts.IFile.rename
orionis.storage.contracts.IFile.html#rename
Function
Method
PUBLIC
Rename the file within its current directory.
-
orionis.storage.contracts.IFile.size
orionis.storage.contracts.IFile.html#size
Function
Method
PUBLIC
Return the size of the file in bytes.
-
orionis.storage.contracts.IFile.mimeType
orionis.storage.contracts.IFile.html#mimeType
Function
Method
PUBLIC
Guess the MIME type of the file.
-
orionis.storage.contracts.IFile.lastModified
orionis.storage.contracts.IFile.html#lastModified
Function
Method
PUBLIC
Return the last-modification timestamp of the file.
-
orionis.storage.contracts.IFile.url
orionis.storage.contracts.IFile.html#url
Function
Method
PUBLIC
Build the public URL of the file.
-
orionis.storage.contracts.IFile.temporaryUrl
orionis.storage.contracts.IFile.html#temporaryUrl
Function
Method
PUBLIC
Build a signed, time-limited URL for the file.
-
orionis.storage.contracts.IFile.visibility
orionis.storage.contracts.IFile.html#visibility
Function
Method
PUBLIC
Return the visibility of the file.
-
orionis.storage.contracts.IFile.setVisibility
orionis.storage.contracts.IFile.html#setVisibility
Function
Method
PUBLIC
Change the visibility of the file.
-
orionis.storage.contracts.IFile.download
orionis.storage.contracts.IFile.html#download
Function
Method
PUBLIC
Copy the file to a location on the local filesystem.
-
orionis.storage.contracts.IFile.hash
orionis.storage.contracts.IFile.html#hash
Function
Method
PUBLIC
Compute the content hash of the file.
-
orionis.storage.contracts.IFile.info
orionis.storage.contracts.IFile.html#info
Function
Method
PUBLIC
Collect a metadata snapshot for the file.
-
orionis.storage.contracts.IStorageManager
orionis.storage.contracts.IStorageManager.html
Class
Class
PUBLIC
Define the contract for the storage manager.
-
orionis.storage.contracts.IStorageManager.__slots__
orionis.storage.contracts.IStorageManager.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.storage.contracts.IStorageManager.disk
orionis.storage.contracts.IStorageManager.html#disk
Function
Method
PUBLIC
Resolve the disk registered under name.
-
orionis.storage.contracts.IStorageManager.default
orionis.storage.contracts.IStorageManager.html#default
Function
Method
PUBLIC
Resolve the default disk from the configuration.
-
orionis.storage.contracts.IStorageManager.extend
orionis.storage.contracts.IStorageManager.html#extend
Function
Method
PUBLIC
Register a custom driver factory under driver.
-
orionis.storage.contracts.IStorageManager.uploaded
orionis.storage.contracts.IStorageManager.html#uploaded
Function
Method
PUBLIC
Wrap an HTTP multipart payload as a storable uploaded file.
-
orionis.storage.contracts.IStorageStream
orionis.storage.contracts.IStorageStream.html
Class
Class
PUBLIC
Define the contract for an asynchronous binary stream handle.
-
orionis.storage.contracts.IStorageStream.__slots__
orionis.storage.contracts.IStorageStream.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.storage.contracts.IStorageStream.chunks
orionis.storage.contracts.IStorageStream.html#chunks
Function
Method
PUBLIC
Yield bounded reads; native streams may batch within the buffer budget.
-
orionis.storage.contracts.IStorageStream.read
orionis.storage.contracts.IStorageStream.html#read
Function
Method
PUBLIC
Read up to size bytes from the stream.
-
orionis.storage.contracts.IStorageStream.write
orionis.storage.contracts.IStorageStream.html#write
Function
Method
PUBLIC
Write data to the stream at the current position.
-
orionis.storage.contracts.IStorageStream.seek
orionis.storage.contracts.IStorageStream.html#seek
Function
Method
PUBLIC
Move the stream position to offset.
-
orionis.storage.contracts.IStorageStream.close
orionis.storage.contracts.IStorageStream.html#close
Function
Method
PUBLIC
Flush pending data and release the underlying handle.
-
orionis.storage.contracts.IStorageStream.__aenter__
orionis.storage.contracts.IStorageStream.html#__aenter__
Function
Method
PUBLIC
Open the underlying handle and return the stream.
-
orionis.storage.contracts.IStorageStream.__aexit__
orionis.storage.contracts.IStorageStream.html#__aexit__
Function
Method
PUBLIC
Close the stream when leaving the async context.
-
orionis.storage.contracts.IUploadedFile
orionis.storage.contracts.IUploadedFile.html
Class
Class
PUBLIC
Define the contract for a file received through HTTP.
-
orionis.storage.contracts.IUploadedFile.__slots__
orionis.storage.contracts.IUploadedFile.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.storage.contracts.IUploadedFile.originalName
orionis.storage.contracts.IUploadedFile.html#originalName
Function
Method
PUBLIC
Return the sanitized client-supplied file name.
-
orionis.storage.contracts.IUploadedFile.extension
orionis.storage.contracts.IUploadedFile.html#extension
Function
Method
PUBLIC
Return the lowercase file extension including the dot.
-
orionis.storage.contracts.IUploadedFile.size
orionis.storage.contracts.IUploadedFile.html#size
Function
Method
PUBLIC
Return the size of the uploaded payload in bytes.
-
orionis.storage.contracts.IUploadedFile.mimeType
orionis.storage.contracts.IUploadedFile.html#mimeType
Function
Method
PUBLIC
Return the MIME type declared by the client.
-
orionis.storage.contracts.IUploadedFile.hashName
orionis.storage.contracts.IUploadedFile.html#hashName
Function
Method
PUBLIC
Return a random, collision-safe name for the file.
-
orionis.storage.contracts.IUploadedFile.read
orionis.storage.contracts.IUploadedFile.html#read
Function
Method
PUBLIC
Read the full uploaded payload.
-
orionis.storage.contracts.IUploadedFile.store
orionis.storage.contracts.IUploadedFile.html#store
Function
Method
PUBLIC
Persist the payload under a generated hash name.
-
orionis.storage.contracts.IUploadedFile.storeAs
orionis.storage.contracts.IUploadedFile.html#storeAs
Function
Method
PUBLIC
Persist the payload under an explicit file name.
-
orionis.storage.contracts.IUploadedFile.move
orionis.storage.contracts.IUploadedFile.html#move
Function
Method
PUBLIC
Persist the payload and release the upload buffer.
-
orionis.storage.contracts.IUploadedFile.copy
orionis.storage.contracts.IUploadedFile.html#copy
Function
Method
PUBLIC
Persist the payload while keeping the upload buffer usable.
-
orionis.storage.drivers.AzureStorageDriver
orionis.storage.drivers.AzureStorageDriver.html
Class
Class
PUBLIC
Storage driver backed by Azure Blob Storage.
-
orionis.storage.drivers.AzureStorageDriver.__slots__
orionis.storage.drivers.AzureStorageDriver.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.storage.drivers.AzureStorageDriver.__init__
orionis.storage.drivers.AzureStorageDriver.html#__init__
Function
Method
PUBLIC
Initialize the driver from an Azure disk configuration entity.
-
orionis.storage.drivers.AzureStorageDriver._connection_string
orionis.storage.drivers.AzureStorageDriver.html#_connection_string
Attribute
Instance Variable
PUBLIC
Connection string produced by str.
-
orionis.storage.drivers.AzureStorageDriver._account_name
orionis.storage.drivers.AzureStorageDriver.html#_account_name
Attribute
Instance Variable
PUBLIC
Account name produced by str.
-
orionis.storage.drivers.AzureStorageDriver._account_key
orionis.storage.drivers.AzureStorageDriver.html#_account_key
Attribute
Instance Variable
PUBLIC
Account key produced by str.
-
orionis.storage.drivers.AzureStorageDriver._container_name
orionis.storage.drivers.AzureStorageDriver.html#_container_name
Attribute
Instance Variable
PUBLIC
Container name produced by str.
-
orionis.storage.drivers.AzureStorageDriver._base_url
orionis.storage.drivers.AzureStorageDriver.html#_base_url
Attribute
Instance Variable
PUBLIC
Base URL used when constructing public resource URLs.
-
orionis.storage.drivers.AzureStorageDriver._client_lock
orionis.storage.drivers.AzureStorageDriver.html#_client_lock
Attribute
Instance Variable
PUBLIC
Serialize lazy SDK initialization across worker threads.
-
orionis.storage.drivers.AzureStorageDriver._container
orionis.storage.drivers.AzureStorageDriver.html#_container
Attribute
Instance Variable
PUBLIC
Azure Blob container used by the storage driver.
-
orionis.storage.drivers.AzureStorageDriver._sdk
orionis.storage.drivers.AzureStorageDriver.html#_sdk
Attribute
Instance Variable
PUBLIC
Loaded cloud-storage SDK used by the configured driver.
-
orionis.storage.drivers.AzureStorageDriver._not_found
orionis.storage.drivers.AzureStorageDriver.html#_not_found
Attribute
Instance Variable
PUBLIC
Not found supplied through Exception.
-
orionis.storage.drivers.AzureStorageDriver._http_error
orionis.storage.drivers.AzureStorageDriver.html#_http_error
Attribute
Instance Variable
PUBLIC
Http error supplied through Exception.
-
orionis.storage.drivers.AzureStorageDriver.__containerClient
orionis.storage.drivers.AzureStorageDriver.html#__containerClient
Function
Method
PUBLIC
Return the container client, bootstrapping it on first use.
-
orionis.storage.drivers.AzureStorageDriver.__blob
orionis.storage.drivers.AzureStorageDriver.html#__blob
Function
Method
PUBLIC
Return the blob client for normalized.
-
orionis.storage.drivers.AzureStorageDriver.__missing
orionis.storage.drivers.AzureStorageDriver.html#__missing
Function
Method
PUBLIC
Build the framework exception for a missing blob.
-
orionis.storage.drivers.AzureStorageDriver.__propsSync
orionis.storage.drivers.AzureStorageDriver.html#__propsSync
Function
Method
PUBLIC
Fetch blob properties or raise when the blob is absent.
-
orionis.storage.drivers.AzureStorageDriver.__listKeysSync
orionis.storage.drivers.AzureStorageDriver.html#__listKeysSync
Function
Method
PUBLIC
List every blob name under prefix.
-
orionis.storage.drivers.AzureStorageDriver.__contentSettings
orionis.storage.drivers.AzureStorageDriver.html#__contentSettings
Function
Method
PUBLIC
Build the content settings for an upload, when derivable.
-
orionis.storage.drivers.AzureStorageDriver.__urlFor
orionis.storage.drivers.AzureStorageDriver.html#__urlFor
Function
Method
PUBLIC
Compose the public URL of a blob without SDK involvement.
-
orionis.storage.drivers.AzureStorageDriver.read
orionis.storage.drivers.AzureStorageDriver.html#read
Function
Method
PUBLIC
Read the full contents of the blob at path.
-
orionis.storage.drivers.AzureStorageDriver.readStream
orionis.storage.drivers.AzureStorageDriver.html#readStream
Function
Method
PUBLIC
Stream the contents of the blob at path in chunks.
-
orionis.storage.drivers.AzureStorageDriver.exists
orionis.storage.drivers.AzureStorageDriver.html#exists
Function
Method
PUBLIC
Check whether a blob exists at path.
-
orionis.storage.drivers.AzureStorageDriver.write
orionis.storage.drivers.AzureStorageDriver.html#write
Function
Method
PUBLIC
Write contents to path, replacing any existing blob.
-
orionis.storage.drivers.AzureStorageDriver.writeStream
orionis.storage.drivers.AzureStorageDriver.html#writeStream
Function
Method
PUBLIC
Write the chunks produced by stream to path.
-
orionis.storage.drivers.AzureStorageDriver.delete
orionis.storage.drivers.AzureStorageDriver.html#delete
Function
Method
PUBLIC
Delete the blob at path.
-
orionis.storage.drivers.AzureStorageDriver.copy
orionis.storage.drivers.AzureStorageDriver.html#copy
Function
Method
PUBLIC
Copy the blob at source to target.
-
orionis.storage.drivers.AzureStorageDriver.move
orionis.storage.drivers.AzureStorageDriver.html#move
Function
Method
PUBLIC
Move the blob at source to target.
-
orionis.storage.drivers.AzureStorageDriver.size
orionis.storage.drivers.AzureStorageDriver.html#size
Function
Method
PUBLIC
Return the size in bytes of the blob at path.
-
orionis.storage.drivers.AzureStorageDriver.mimeType
orionis.storage.drivers.AzureStorageDriver.html#mimeType
Function
Method
PUBLIC
Return the MIME type of the blob at path.
-
orionis.storage.drivers.AzureStorageDriver.lastModified
orionis.storage.drivers.AzureStorageDriver.html#lastModified
Function
Method
PUBLIC
Return the last-modification timestamp of the blob at path.
-
orionis.storage.drivers.AzureStorageDriver.visibility
orionis.storage.drivers.AzureStorageDriver.html#visibility
Function
Method
PUBLIC
Return the effective visibility of the blob at path.
-
orionis.storage.drivers.AzureStorageDriver.setVisibility
orionis.storage.drivers.AzureStorageDriver.html#setVisibility
Function
Method
PUBLIC
Change the visibility of the blob at path.
-
orionis.storage.drivers.AzureStorageDriver.hash
orionis.storage.drivers.AzureStorageDriver.html#hash
Function
Method
PUBLIC
Compute the content hash of the blob at path.
-
orionis.storage.drivers.AzureStorageDriver.info
orionis.storage.drivers.AzureStorageDriver.html#info
Function
Method
PUBLIC
Collect a metadata snapshot for the blob at path.
-
orionis.storage.drivers.AzureStorageDriver.createDirectory
orionis.storage.drivers.AzureStorageDriver.html#createDirectory
Function
Method
PUBLIC
Create a zero-byte directory marker at path.
-
orionis.storage.drivers.AzureStorageDriver.deleteDirectory
orionis.storage.drivers.AzureStorageDriver.html#deleteDirectory
Function
Method
PUBLIC
Recursively delete every blob under path.
-
orionis.storage.drivers.AzureStorageDriver.directoryExists
orionis.storage.drivers.AzureStorageDriver.html#directoryExists
Function
Method
PUBLIC
Check whether any blob exists under path.
-
orionis.storage.drivers.AzureStorageDriver.files
orionis.storage.drivers.AzureStorageDriver.html#files
Function
Method
PUBLIC
List the blob names that represent files under path.
-
orionis.storage.drivers.AzureStorageDriver.directories
orionis.storage.drivers.AzureStorageDriver.html#directories
Function
Method
PUBLIC
List the directory prefixes contained under path.
-
orionis.storage.drivers.AzureStorageDriver.url
orionis.storage.drivers.AzureStorageDriver.html#url
Function
Method
PUBLIC
Build the public URL for the blob at path.
-
orionis.storage.drivers.AzureStorageDriver.temporaryUrl
orionis.storage.drivers.AzureStorageDriver.html#temporaryUrl
Function
Method
PUBLIC
Build a SAS URL for the blob at path.
-
orionis.storage.drivers.AzureStorageDriver.download
orionis.storage.drivers.AzureStorageDriver.html#download
Function
Method
PUBLIC
Download the blob at path to the local filesystem.
-
orionis.storage.drivers.AzureStorageDriver.open
orionis.storage.drivers.AzureStorageDriver.html#open
Function
Method
PUBLIC
Open an asynchronous binary stream for the blob at path.
-
orionis.storage.drivers.AzureStorageDriver.__seedStream
orionis.storage.drivers.AzureStorageDriver.html#__seedStream
Function
Method
PUBLIC
Seed a stream buffer and position it for the requested mode.
-
orionis.storage.drivers.GoogleStorageDriver
orionis.storage.drivers.GoogleStorageDriver.html
Class
Class
PUBLIC
Storage driver backed by Google Cloud Storage.
-
orionis.storage.drivers.GoogleStorageDriver.__slots__
orionis.storage.drivers.GoogleStorageDriver.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.storage.drivers.GoogleStorageDriver.__init__
orionis.storage.drivers.GoogleStorageDriver.html#__init__
Function
Method
PUBLIC
Initialize the driver from a GCS disk configuration entity.
-
orionis.storage.drivers.GoogleStorageDriver._project
orionis.storage.drivers.GoogleStorageDriver.html#_project
Attribute
Instance Variable
PUBLIC
Project produced by str.
-
orionis.storage.drivers.GoogleStorageDriver._key_file
orionis.storage.drivers.GoogleStorageDriver.html#_key_file
Attribute
Instance Variable
PUBLIC
Credential file used to initialize the cloud-storage client.
-
orionis.storage.drivers.GoogleStorageDriver._bucket_name
orionis.storage.drivers.GoogleStorageDriver.html#_bucket_name
Attribute
Instance Variable
PUBLIC
Bucket name produced by str.
-
orionis.storage.drivers.GoogleStorageDriver._base_url
orionis.storage.drivers.GoogleStorageDriver.html#_base_url
Attribute
Instance Variable
PUBLIC
Base URL used when constructing public resource URLs.
-
orionis.storage.drivers.GoogleStorageDriver._client_lock
orionis.storage.drivers.GoogleStorageDriver.html#_client_lock
Attribute
Instance Variable
PUBLIC
Serialize lazy SDK initialization across worker threads.
-
orionis.storage.drivers.GoogleStorageDriver._bucket
orionis.storage.drivers.GoogleStorageDriver.html#_bucket
Attribute
Instance Variable
PUBLIC
Cloud-storage bucket containing the driver resources.
-
orionis.storage.drivers.GoogleStorageDriver._not_found
orionis.storage.drivers.GoogleStorageDriver.html#_not_found
Attribute
Instance Variable
PUBLIC
Not found supplied through Exception.
-
orionis.storage.drivers.GoogleStorageDriver._cloud_error
orionis.storage.drivers.GoogleStorageDriver.html#_cloud_error
Attribute
Instance Variable
PUBLIC
Cloud error supplied through Exception.
-
orionis.storage.drivers.GoogleStorageDriver.__bucket
orionis.storage.drivers.GoogleStorageDriver.html#__bucket
Function
Method
PUBLIC
Return the bucket handle, bootstrapping the client on first use.
-
orionis.storage.drivers.GoogleStorageDriver.__blob
orionis.storage.drivers.GoogleStorageDriver.html#__blob
Function
Method
PUBLIC
Return a lightweight blob handle for normalized.
-
orionis.storage.drivers.GoogleStorageDriver.__missing
orionis.storage.drivers.GoogleStorageDriver.html#__missing
Function
Method
PUBLIC
Build the framework exception for a missing object.
-
orionis.storage.drivers.GoogleStorageDriver.__blobOrFail
orionis.storage.drivers.GoogleStorageDriver.html#__blobOrFail
Function
Method
PUBLIC
Fetch a blob with loaded metadata or raise when absent.
-
orionis.storage.drivers.GoogleStorageDriver.__listKeysSync
orionis.storage.drivers.GoogleStorageDriver.html#__listKeysSync
Function
Method
PUBLIC
List every object name under prefix.
-
orionis.storage.drivers.GoogleStorageDriver.__aclFor
orionis.storage.drivers.GoogleStorageDriver.html#__aclFor
Function
Method
PUBLIC
Map a visibility level onto a GCS predefined ACL.
-
orionis.storage.drivers.GoogleStorageDriver.__urlFor
orionis.storage.drivers.GoogleStorageDriver.html#__urlFor
Function
Method
PUBLIC
Compose the public URL of an object without SDK involvement.
-
orionis.storage.drivers.GoogleStorageDriver.__isPublicSync
orionis.storage.drivers.GoogleStorageDriver.html#__isPublicSync
Function
Method
PUBLIC
Check whether a blob grants read access to anonymous users.
-
orionis.storage.drivers.GoogleStorageDriver.read
orionis.storage.drivers.GoogleStorageDriver.html#read
Function
Method
PUBLIC
Read the full contents of the object at path.
-
orionis.storage.drivers.GoogleStorageDriver.readStream
orionis.storage.drivers.GoogleStorageDriver.html#readStream
Function
Method
PUBLIC
Stream the contents of the object at path in chunks.
-
orionis.storage.drivers.GoogleStorageDriver.exists
orionis.storage.drivers.GoogleStorageDriver.html#exists
Function
Method
PUBLIC
Check whether an object exists at path.
-
orionis.storage.drivers.GoogleStorageDriver.write
orionis.storage.drivers.GoogleStorageDriver.html#write
Function
Method
PUBLIC
Write contents to path, replacing any existing object.
-
orionis.storage.drivers.GoogleStorageDriver.writeStream
orionis.storage.drivers.GoogleStorageDriver.html#writeStream
Function
Method
PUBLIC
Write the chunks produced by stream to path.
-
orionis.storage.drivers.GoogleStorageDriver.delete
orionis.storage.drivers.GoogleStorageDriver.html#delete
Function
Method
PUBLIC
Delete the object at path.
-
orionis.storage.drivers.GoogleStorageDriver.copy
orionis.storage.drivers.GoogleStorageDriver.html#copy
Function
Method
PUBLIC
Copy the object at source to target server-side.
-
orionis.storage.drivers.GoogleStorageDriver.move
orionis.storage.drivers.GoogleStorageDriver.html#move
Function
Method
PUBLIC
Move the object at source to target.
-
orionis.storage.drivers.GoogleStorageDriver.size
orionis.storage.drivers.GoogleStorageDriver.html#size
Function
Method
PUBLIC
Return the size in bytes of the object at path.
-
orionis.storage.drivers.GoogleStorageDriver.mimeType
orionis.storage.drivers.GoogleStorageDriver.html#mimeType
Function
Method
PUBLIC
Return the MIME type of the object at path.
-
orionis.storage.drivers.GoogleStorageDriver.lastModified
orionis.storage.drivers.GoogleStorageDriver.html#lastModified
Function
Method
PUBLIC
Return the last-modification timestamp of the object at path.
-
orionis.storage.drivers.GoogleStorageDriver.visibility
orionis.storage.drivers.GoogleStorageDriver.html#visibility
Function
Method
PUBLIC
Return the visibility of the object at path.
-
orionis.storage.drivers.GoogleStorageDriver.setVisibility
orionis.storage.drivers.GoogleStorageDriver.html#setVisibility
Function
Method
PUBLIC
Change the visibility of the object at path.
-
orionis.storage.drivers.GoogleStorageDriver.hash
orionis.storage.drivers.GoogleStorageDriver.html#hash
Function
Method
PUBLIC
Compute the content hash of the object at path.
-
orionis.storage.drivers.GoogleStorageDriver.info
orionis.storage.drivers.GoogleStorageDriver.html#info
Function
Method
PUBLIC
Collect a metadata snapshot for the object at path.
-
orionis.storage.drivers.GoogleStorageDriver.createDirectory
orionis.storage.drivers.GoogleStorageDriver.html#createDirectory
Function
Method
PUBLIC
Create a zero-byte directory marker at path.
-
orionis.storage.drivers.GoogleStorageDriver.deleteDirectory
orionis.storage.drivers.GoogleStorageDriver.html#deleteDirectory
Function
Method
PUBLIC
Recursively delete every object under path.
-
orionis.storage.drivers.GoogleStorageDriver.directoryExists
orionis.storage.drivers.GoogleStorageDriver.html#directoryExists
Function
Method
PUBLIC
Check whether any object exists under path.
-
orionis.storage.drivers.GoogleStorageDriver.files
orionis.storage.drivers.GoogleStorageDriver.html#files
Function
Method
PUBLIC
List the object names that represent files under path.
-
orionis.storage.drivers.GoogleStorageDriver.directories
orionis.storage.drivers.GoogleStorageDriver.html#directories
Function
Method
PUBLIC
List the directory prefixes contained under path.
-
orionis.storage.drivers.GoogleStorageDriver.url
orionis.storage.drivers.GoogleStorageDriver.html#url
Function
Method
PUBLIC
Build the public URL for the object at path.
-
orionis.storage.drivers.GoogleStorageDriver.temporaryUrl
orionis.storage.drivers.GoogleStorageDriver.html#temporaryUrl
Function
Method
PUBLIC
Build a V4 signed URL for the object at path.
-
orionis.storage.drivers.GoogleStorageDriver.download
orionis.storage.drivers.GoogleStorageDriver.html#download
Function
Method
PUBLIC
Download the object at path to the local filesystem.
-
orionis.storage.drivers.GoogleStorageDriver.open
orionis.storage.drivers.GoogleStorageDriver.html#open
Function
Method
PUBLIC
Open an asynchronous binary stream for the object at path.
-
orionis.storage.drivers.GoogleStorageDriver.__seedStream
orionis.storage.drivers.GoogleStorageDriver.html#__seedStream
Function
Method
PUBLIC
Seed a stream buffer and position it for the requested mode.
-
orionis.storage.drivers.LocalStorageDriver
orionis.storage.drivers.LocalStorageDriver.html
Class
Class
PUBLIC
Storage driver backed by the local filesystem.
-
orionis.storage.drivers.LocalStorageDriver.__slots__
orionis.storage.drivers.LocalStorageDriver.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.storage.drivers.LocalStorageDriver.__init__
orionis.storage.drivers.LocalStorageDriver.html#__init__
Function
Method
PUBLIC
Initialize the driver rooted at root.
-
orionis.storage.drivers.LocalStorageDriver._root
orionis.storage.drivers.LocalStorageDriver.html#_root
Attribute
Instance Variable
PUBLIC
Directory acting as the disk root. It is created when missing.
-
orionis.storage.drivers.LocalStorageDriver._base_path
orionis.storage.drivers.LocalStorageDriver.html#_base_path
Attribute
Instance Variable
PUBLIC
Application base path used for project-relative file paths.
-
orionis.storage.drivers.LocalStorageDriver._base_url
orionis.storage.drivers.LocalStorageDriver.html#_base_url
Attribute
Instance Variable
PUBLIC
Base URL used to build public file URLs, or None when the disk does not expose URLs.
-
orionis.storage.drivers.LocalStorageDriver.absolutePath
orionis.storage.drivers.LocalStorageDriver.html#absolutePath
Function
Method
PUBLIC
Return the absolute filesystem path of the file at path.
-
orionis.storage.drivers.LocalStorageDriver.relativePath
orionis.storage.drivers.LocalStorageDriver.html#relativePath
Function
Method
PUBLIC
Return the filesystem path relative to the application base path.
-
orionis.storage.drivers.LocalStorageDriver.__absolute
orionis.storage.drivers.LocalStorageDriver.html#__absolute
Function
Method
PUBLIC
Return the absolute path for an already normalized path.
-
orionis.storage.drivers.LocalStorageDriver.__relative
orionis.storage.drivers.LocalStorageDriver.html#__relative
Function
Method
PUBLIC
Return the canonical relative path for absolute.
-
orionis.storage.drivers.LocalStorageDriver.__fileMode
orionis.storage.drivers.LocalStorageDriver.html#__fileMode
Function
Method
PUBLIC
Return the POSIX file mode for visibility.
-
orionis.storage.drivers.LocalStorageDriver.__statOrFail
orionis.storage.drivers.LocalStorageDriver.html#__statOrFail
Function
Method
PUBLIC
Stat the file at normalized or raise when it is absent.
-
orionis.storage.drivers.LocalStorageDriver.__readSync
orionis.storage.drivers.LocalStorageDriver.html#__readSync
Function
Method
PUBLIC
Read the file at normalized synchronously.
-
orionis.storage.drivers.LocalStorageDriver.__openRead
orionis.storage.drivers.LocalStorageDriver.html#__openRead
Function
Method
PUBLIC
Open the file at normalized synchronously.
-
orionis.storage.drivers.LocalStorageDriver.__openTemp
orionis.storage.drivers.LocalStorageDriver.html#__openTemp
Function
Method
PUBLIC
Open a temporary sibling file for writing synchronously.
-
orionis.storage.drivers.LocalStorageDriver.__tempPath
orionis.storage.drivers.LocalStorageDriver.html#__tempPath
Function
Static Method
PUBLIC
Build a unique staging path for an atomic write.
-
orionis.storage.drivers.LocalStorageDriver.__writeSync
orionis.storage.drivers.LocalStorageDriver.html#__writeSync
Function
Method
PUBLIC
Atomically write data to normalized synchronously.
-
orionis.storage.drivers.LocalStorageDriver.__commitStream
orionis.storage.drivers.LocalStorageDriver.html#__commitStream
Function
Method
PUBLIC
Promote a finished temp file to its final destination.
-
orionis.storage.drivers.LocalStorageDriver.__copySync
orionis.storage.drivers.LocalStorageDriver.html#__copySync
Function
Method
PUBLIC
Copy source to target synchronously.
-
orionis.storage.drivers.LocalStorageDriver.__moveSync
orionis.storage.drivers.LocalStorageDriver.html#__moveSync
Function
Method
PUBLIC
Move source to target synchronously.
-
orionis.storage.drivers.LocalStorageDriver.__walkEntries
orionis.storage.drivers.LocalStorageDriver.html#__walkEntries
Function
Static Method
PUBLIC
Yield every nested entry of the requested kind under base.
-
orionis.storage.drivers.LocalStorageDriver.__iterEntries
orionis.storage.drivers.LocalStorageDriver.html#__iterEntries
Function
Static Method
PUBLIC
Yield the direct children of the requested kind under base.
-
orionis.storage.drivers.LocalStorageDriver.__listSync
orionis.storage.drivers.LocalStorageDriver.html#__listSync
Function
Method
PUBLIC
List entries under normalized synchronously.
-
orionis.storage.drivers.LocalStorageDriver.__hashSync
orionis.storage.drivers.LocalStorageDriver.html#__hashSync
Function
Method
PUBLIC
Compute the content hash of normalized synchronously.
-
orionis.storage.drivers.LocalStorageDriver.__visibilityFromMode
orionis.storage.drivers.LocalStorageDriver.html#__visibilityFromMode
Function
Method
PUBLIC
Derive the visibility level from POSIX permission bits.
-
orionis.storage.drivers.LocalStorageDriver.__infoSync
orionis.storage.drivers.LocalStorageDriver.html#__infoSync
Function
Method
PUBLIC
Build a metadata snapshot for normalized synchronously.
-
orionis.storage.drivers.LocalStorageDriver.__buildUrl
orionis.storage.drivers.LocalStorageDriver.html#__buildUrl
Function
Method
PUBLIC
Build the public URL for normalized.
-
orionis.storage.drivers.LocalStorageDriver.__downloadSync
orionis.storage.drivers.LocalStorageDriver.html#__downloadSync
Function
Method
PUBLIC
Copy normalized to a local destination synchronously.
-
orionis.storage.drivers.LocalStorageDriver.read
orionis.storage.drivers.LocalStorageDriver.html#read
Function
Method
PUBLIC
Read the full contents of the file at path.
-
orionis.storage.drivers.LocalStorageDriver.readStream
orionis.storage.drivers.LocalStorageDriver.html#readStream
Function
Method
PUBLIC
Stream the contents of the file at path in chunks.
-
orionis.storage.drivers.LocalStorageDriver.exists
orionis.storage.drivers.LocalStorageDriver.html#exists
Function
Method
PUBLIC
Check whether a file exists at path.
-
orionis.storage.drivers.LocalStorageDriver.write
orionis.storage.drivers.LocalStorageDriver.html#write
Function
Method
PUBLIC
Write contents to path, replacing any existing file.
-
orionis.storage.drivers.LocalStorageDriver.writeStream
orionis.storage.drivers.LocalStorageDriver.html#writeStream
Function
Method
PUBLIC
Write the chunks produced by stream to path.
-
orionis.storage.drivers.LocalStorageDriver.delete
orionis.storage.drivers.LocalStorageDriver.html#delete
Function
Method
PUBLIC
Delete the file at path.
-
orionis.storage.drivers.LocalStorageDriver.copy
orionis.storage.drivers.LocalStorageDriver.html#copy
Function
Method
PUBLIC
Copy the file at source to target.
-
orionis.storage.drivers.LocalStorageDriver.move
orionis.storage.drivers.LocalStorageDriver.html#move
Function
Method
PUBLIC
Move the file at source to target.
-
orionis.storage.drivers.LocalStorageDriver.size
orionis.storage.drivers.LocalStorageDriver.html#size
Function
Method
PUBLIC
Return the size in bytes of the file at path.
-
orionis.storage.drivers.LocalStorageDriver.mimeType
orionis.storage.drivers.LocalStorageDriver.html#mimeType
Function
Method
PUBLIC
Guess the MIME type of the file at path.
-
orionis.storage.drivers.LocalStorageDriver.lastModified
orionis.storage.drivers.LocalStorageDriver.html#lastModified
Function
Method
PUBLIC
Return the last-modification timestamp of the file at path.
-
orionis.storage.drivers.LocalStorageDriver.visibility
orionis.storage.drivers.LocalStorageDriver.html#visibility
Function
Method
PUBLIC
Return the visibility of the file at path.
-
orionis.storage.drivers.LocalStorageDriver.setVisibility
orionis.storage.drivers.LocalStorageDriver.html#setVisibility
Function
Method
PUBLIC
Change the visibility of the file at path.
-
orionis.storage.drivers.LocalStorageDriver.hash
orionis.storage.drivers.LocalStorageDriver.html#hash
Function
Method
PUBLIC
Compute the content hash of the file at path.
-
orionis.storage.drivers.LocalStorageDriver.info
orionis.storage.drivers.LocalStorageDriver.html#info
Function
Method
PUBLIC
Collect a metadata snapshot for the file at path.
-
orionis.storage.drivers.LocalStorageDriver.createDirectory
orionis.storage.drivers.LocalStorageDriver.html#createDirectory
Function
Method
PUBLIC
Create the directory at path, including missing parents.
-
orionis.storage.drivers.LocalStorageDriver.deleteDirectory
orionis.storage.drivers.LocalStorageDriver.html#deleteDirectory
Function
Method
PUBLIC
Recursively delete the directory at path.
-
orionis.storage.drivers.LocalStorageDriver.directoryExists
orionis.storage.drivers.LocalStorageDriver.html#directoryExists
Function
Method
PUBLIC
Check whether a directory exists at path.
-
orionis.storage.drivers.LocalStorageDriver.files
orionis.storage.drivers.LocalStorageDriver.html#files
Function
Method
PUBLIC
List the file paths contained in the directory at path.
-
orionis.storage.drivers.LocalStorageDriver.directories
orionis.storage.drivers.LocalStorageDriver.html#directories
Function
Method
PUBLIC
List the directory paths contained in the directory at path.
-
orionis.storage.drivers.LocalStorageDriver.url
orionis.storage.drivers.LocalStorageDriver.html#url
Function
Method
PUBLIC
Build the public URL for the file at path.
-
orionis.storage.drivers.LocalStorageDriver.temporaryUrl
orionis.storage.drivers.LocalStorageDriver.html#temporaryUrl
Function
Method
PUBLIC
Build a signed, time-limited URL for the file at path.
-
orionis.storage.drivers.LocalStorageDriver.download
orionis.storage.drivers.LocalStorageDriver.html#download
Function
Method
PUBLIC
Copy the file at path to a location on the local filesystem.
-
orionis.storage.drivers.LocalStorageDriver.open
orionis.storage.drivers.LocalStorageDriver.html#open
Function
Method
PUBLIC
Open an asynchronous binary stream for the file at path.
-
orionis.storage.drivers.MemoryStorageDriver
orionis.storage.drivers.MemoryStorageDriver.html
Class
Class
PUBLIC
Storage driver keeping every object in process memory.
-
orionis.storage.drivers.MemoryStorageDriver.__slots__
orionis.storage.drivers.MemoryStorageDriver.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.storage.drivers.MemoryStorageDriver.__init__
orionis.storage.drivers.MemoryStorageDriver.html#__init__
Function
Method
PUBLIC
Initialize an empty in-memory disk.
-
orionis.storage.drivers.MemoryStorageDriver._files
orionis.storage.drivers.MemoryStorageDriver.html#_files
Attribute
Instance Variable
PUBLIC
File contents retained by the in-memory storage backend.
-
orionis.storage.drivers.MemoryStorageDriver._directories
orionis.storage.drivers.MemoryStorageDriver.html#_directories
Attribute
Instance Variable
PUBLIC
Directories produced by set.
-
orionis.storage.drivers.MemoryStorageDriver._base_url
orionis.storage.drivers.MemoryStorageDriver.html#_base_url
Attribute
Instance Variable
PUBLIC
Base URL used to build public file URLs, or None when the disk does not expose URLs.
-
orionis.storage.drivers.MemoryStorageDriver.__entryOrFail
orionis.storage.drivers.MemoryStorageDriver.html#__entryOrFail
Function
Method
PUBLIC
Return the entry stored at normalized or raise when absent.
-
orionis.storage.drivers.MemoryStorageDriver.__storeSync
orionis.storage.drivers.MemoryStorageDriver.html#__storeSync
Function
Method
PUBLIC
Persist data under normalized, preserving creation time.
-
orionis.storage.drivers.MemoryStorageDriver.__allDirectories
orionis.storage.drivers.MemoryStorageDriver.html#__allDirectories
Function
Method
PUBLIC
Return every explicit and implicit directory path.
-
orionis.storage.drivers.MemoryStorageDriver.__ancestors
orionis.storage.drivers.MemoryStorageDriver.html#__ancestors
Function
Static Method
PUBLIC
Return every ancestor prefix of path.
-
orionis.storage.drivers.MemoryStorageDriver.__listSync
orionis.storage.drivers.MemoryStorageDriver.html#__listSync
Function
Method
PUBLIC
List entries under normalized.
-
orionis.storage.drivers.MemoryStorageDriver.__buildUrl
orionis.storage.drivers.MemoryStorageDriver.html#__buildUrl
Function
Method
PUBLIC
Build the public URL for normalized.
-
orionis.storage.drivers.MemoryStorageDriver.__digest
orionis.storage.drivers.MemoryStorageDriver.html#__digest
Function
Method
PUBLIC
Compute the hex digest of data using algorithm.
-
orionis.storage.drivers.MemoryStorageDriver.read
orionis.storage.drivers.MemoryStorageDriver.html#read
Function
Method
PUBLIC
Read the full contents of the file at path.
-
orionis.storage.drivers.MemoryStorageDriver.readStream
orionis.storage.drivers.MemoryStorageDriver.html#readStream
Function
Method
PUBLIC
Stream the contents of the file at path in chunks.
-
orionis.storage.drivers.MemoryStorageDriver.exists
orionis.storage.drivers.MemoryStorageDriver.html#exists
Function
Method
PUBLIC
Check whether a file exists at path.
-
orionis.storage.drivers.MemoryStorageDriver.write
orionis.storage.drivers.MemoryStorageDriver.html#write
Function
Method
PUBLIC
Write contents to path, replacing any existing file.
-
orionis.storage.drivers.MemoryStorageDriver.writeStream
orionis.storage.drivers.MemoryStorageDriver.html#writeStream
Function
Method
PUBLIC
Write the chunks produced by stream to path.
-
orionis.storage.drivers.MemoryStorageDriver.delete
orionis.storage.drivers.MemoryStorageDriver.html#delete
Function
Method
PUBLIC
Delete the file at path.
-
orionis.storage.drivers.MemoryStorageDriver.copy
orionis.storage.drivers.MemoryStorageDriver.html#copy
Function
Method
PUBLIC
Copy the file at source to target.
-
orionis.storage.drivers.MemoryStorageDriver.move
orionis.storage.drivers.MemoryStorageDriver.html#move
Function
Method
PUBLIC
Move the file at source to target.
-
orionis.storage.drivers.MemoryStorageDriver.size
orionis.storage.drivers.MemoryStorageDriver.html#size
Function
Method
PUBLIC
Return the size in bytes of the file at path.
-
orionis.storage.drivers.MemoryStorageDriver.mimeType
orionis.storage.drivers.MemoryStorageDriver.html#mimeType
Function
Method
PUBLIC
Guess the MIME type of the file at path.
-
orionis.storage.drivers.MemoryStorageDriver.lastModified
orionis.storage.drivers.MemoryStorageDriver.html#lastModified
Function
Method
PUBLIC
Return the last-modification timestamp of the file at path.
-
orionis.storage.drivers.MemoryStorageDriver.visibility
orionis.storage.drivers.MemoryStorageDriver.html#visibility
Function
Method
PUBLIC
Return the visibility of the file at path.
-
orionis.storage.drivers.MemoryStorageDriver.setVisibility
orionis.storage.drivers.MemoryStorageDriver.html#setVisibility
Function
Method
PUBLIC
Change the visibility of the file at path.
-
orionis.storage.drivers.MemoryStorageDriver.__validateVisibility
orionis.storage.drivers.MemoryStorageDriver.html#__validateVisibility
Function
Static Method
PUBLIC
Return a supported visibility value or reject it before mutation.
-
orionis.storage.drivers.MemoryStorageDriver.hash
orionis.storage.drivers.MemoryStorageDriver.html#hash
Function
Method
PUBLIC
Compute the content hash of the file at path.
-
orionis.storage.drivers.MemoryStorageDriver.info
orionis.storage.drivers.MemoryStorageDriver.html#info
Function
Method
PUBLIC
Collect a metadata snapshot for the file at path.
-
orionis.storage.drivers.MemoryStorageDriver.createDirectory
orionis.storage.drivers.MemoryStorageDriver.html#createDirectory
Function
Method
PUBLIC
Create the directory at path, including missing parents.
-
orionis.storage.drivers.MemoryStorageDriver.deleteDirectory
orionis.storage.drivers.MemoryStorageDriver.html#deleteDirectory
Function
Method
PUBLIC
Recursively delete the directory at path.
-
orionis.storage.drivers.MemoryStorageDriver.directoryExists
orionis.storage.drivers.MemoryStorageDriver.html#directoryExists
Function
Method
PUBLIC
Check whether a directory exists at path.
-
orionis.storage.drivers.MemoryStorageDriver.files
orionis.storage.drivers.MemoryStorageDriver.html#files
Function
Method
PUBLIC
List the file paths contained in the directory at path.
-
orionis.storage.drivers.MemoryStorageDriver.directories
orionis.storage.drivers.MemoryStorageDriver.html#directories
Function
Method
PUBLIC
List the directory paths contained in the directory at path.
-
orionis.storage.drivers.MemoryStorageDriver.url
orionis.storage.drivers.MemoryStorageDriver.html#url
Function
Method
PUBLIC
Build the public URL for the file at path.
-
orionis.storage.drivers.MemoryStorageDriver.temporaryUrl
orionis.storage.drivers.MemoryStorageDriver.html#temporaryUrl
Function
Method
PUBLIC
Build a signed, time-limited URL for the file at path.
-
orionis.storage.drivers.MemoryStorageDriver.download
orionis.storage.drivers.MemoryStorageDriver.html#download
Function
Method
PUBLIC
Copy the file at path to a location on the local filesystem.
-
orionis.storage.drivers.MemoryStorageDriver.open
orionis.storage.drivers.MemoryStorageDriver.html#open
Function
Method
PUBLIC
Open an asynchronous binary stream for the file at path.
-
orionis.storage.drivers.S3StorageDriver
orionis.storage.drivers.S3StorageDriver.html
Class
Class
PUBLIC
Storage driver backed by Amazon S3 (or S3-compatible services).
-
orionis.storage.drivers.S3StorageDriver.__slots__
orionis.storage.drivers.S3StorageDriver.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.storage.drivers.S3StorageDriver.__init__
orionis.storage.drivers.S3StorageDriver.html#__init__
Function
Method
PUBLIC
Initialize the driver from an S3 disk configuration entity.
-
orionis.storage.drivers.S3StorageDriver._bucket
orionis.storage.drivers.S3StorageDriver.html#_bucket
Attribute
Instance Variable
PUBLIC
Cloud-storage bucket containing the driver resources.
-
orionis.storage.drivers.S3StorageDriver._region
orionis.storage.drivers.S3StorageDriver.html#_region
Attribute
Instance Variable
PUBLIC
Region produced by str.
-
orionis.storage.drivers.S3StorageDriver._key
orionis.storage.drivers.S3StorageDriver.html#_key
Attribute
Instance Variable
PUBLIC
Key produced by str.
-
orionis.storage.drivers.S3StorageDriver._secret
orionis.storage.drivers.S3StorageDriver.html#_secret
Attribute
Instance Variable
PUBLIC
Secret produced by str.
-
orionis.storage.drivers.S3StorageDriver._endpoint
orionis.storage.drivers.S3StorageDriver.html#_endpoint
Attribute
Instance Variable
PUBLIC
Configured endpoint used to contact the storage service.
-
orionis.storage.drivers.S3StorageDriver._use_path_style
orionis.storage.drivers.S3StorageDriver.html#_use_path_style
Attribute
Instance Variable
PUBLIC
Use path style produced by bool.
-
orionis.storage.drivers.S3StorageDriver._base_url
orionis.storage.drivers.S3StorageDriver.html#_base_url
Attribute
Instance Variable
PUBLIC
Base URL used when constructing public resource URLs.
-
orionis.storage.drivers.S3StorageDriver._client_lock
orionis.storage.drivers.S3StorageDriver.html#_client_lock
Attribute
Instance Variable
PUBLIC
Serialize lazy SDK initialization across worker threads.
-
orionis.storage.drivers.S3StorageDriver._client
orionis.storage.drivers.S3StorageDriver.html#_client
Attribute
Instance Variable
PUBLIC
Client used to communicate with the configured backend.
-
orionis.storage.drivers.S3StorageDriver._client_error
orionis.storage.drivers.S3StorageDriver.html#_client_error
Attribute
Instance Variable
PUBLIC
Client error supplied through Exception.
-
orionis.storage.drivers.S3StorageDriver.__client
orionis.storage.drivers.S3StorageDriver.html#__client
Function
Method
PUBLIC
Return the boto3 S3 client, bootstrapping it on first use.
-
orionis.storage.drivers.S3StorageDriver.__isMissing
orionis.storage.drivers.S3StorageDriver.html#__isMissing
Function
Method
PUBLIC
Check whether an SDK error denotes a missing object.
-
orionis.storage.drivers.S3StorageDriver.__missing
orionis.storage.drivers.S3StorageDriver.html#__missing
Function
Method
PUBLIC
Build the framework exception for a missing object.
-
orionis.storage.drivers.S3StorageDriver.__headSync
orionis.storage.drivers.S3StorageDriver.html#__headSync
Function
Method
PUBLIC
Fetch object metadata or raise when the object is absent.
-
orionis.storage.drivers.S3StorageDriver.__listKeysSync
orionis.storage.drivers.S3StorageDriver.html#__listKeysSync
Function
Method
PUBLIC
List every object key under prefix.
-
orionis.storage.drivers.S3StorageDriver.__aclFor
orionis.storage.drivers.S3StorageDriver.html#__aclFor
Function
Method
PUBLIC
Map a visibility level onto an S3 canned ACL.
-
orionis.storage.drivers.S3StorageDriver.__putArgs
orionis.storage.drivers.S3StorageDriver.html#__putArgs
Function
Method
PUBLIC
Build the optional arguments for an object upload.
-
orionis.storage.drivers.S3StorageDriver.__visibilitySync
orionis.storage.drivers.S3StorageDriver.html#__visibilitySync
Function
Method
PUBLIC
Resolve the object visibility from its ACL grants.
-
orionis.storage.drivers.S3StorageDriver.__urlFor
orionis.storage.drivers.S3StorageDriver.html#__urlFor
Function
Method
PUBLIC
Compose the public URL of an object without SDK involvement.
-
orionis.storage.drivers.S3StorageDriver.read
orionis.storage.drivers.S3StorageDriver.html#read
Function
Method
PUBLIC
Read the full contents of the object at path.
-
orionis.storage.drivers.S3StorageDriver.readStream
orionis.storage.drivers.S3StorageDriver.html#readStream
Function
Method
PUBLIC
Stream the contents of the object at path in chunks.
-
orionis.storage.drivers.S3StorageDriver.exists
orionis.storage.drivers.S3StorageDriver.html#exists
Function
Method
PUBLIC
Check whether an object exists at path.
-
orionis.storage.drivers.S3StorageDriver.write
orionis.storage.drivers.S3StorageDriver.html#write
Function
Method
PUBLIC
Write contents to path, replacing any existing object.
-
orionis.storage.drivers.S3StorageDriver.writeStream
orionis.storage.drivers.S3StorageDriver.html#writeStream
Function
Method
PUBLIC
Write the chunks produced by stream to path.
-
orionis.storage.drivers.S3StorageDriver.delete
orionis.storage.drivers.S3StorageDriver.html#delete
Function
Method
PUBLIC
Delete the object at path.
-
orionis.storage.drivers.S3StorageDriver.copy
orionis.storage.drivers.S3StorageDriver.html#copy
Function
Method
PUBLIC
Copy the object at source to target server-side.
-
orionis.storage.drivers.S3StorageDriver.move
orionis.storage.drivers.S3StorageDriver.html#move
Function
Method
PUBLIC
Move the object at source to target.
-
orionis.storage.drivers.S3StorageDriver.size
orionis.storage.drivers.S3StorageDriver.html#size
Function
Method
PUBLIC
Return the size in bytes of the object at path.
-
orionis.storage.drivers.S3StorageDriver.mimeType
orionis.storage.drivers.S3StorageDriver.html#mimeType
Function
Method
PUBLIC
Return the MIME type of the object at path.
-
orionis.storage.drivers.S3StorageDriver.lastModified
orionis.storage.drivers.S3StorageDriver.html#lastModified
Function
Method
PUBLIC
Return the last-modification timestamp of the object at path.
-
orionis.storage.drivers.S3StorageDriver.visibility
orionis.storage.drivers.S3StorageDriver.html#visibility
Function
Method
PUBLIC
Return the visibility of the object at path.
-
orionis.storage.drivers.S3StorageDriver.setVisibility
orionis.storage.drivers.S3StorageDriver.html#setVisibility
Function
Method
PUBLIC
Change the visibility of the object at path.
-
orionis.storage.drivers.S3StorageDriver.hash
orionis.storage.drivers.S3StorageDriver.html#hash
Function
Method
PUBLIC
Compute the content hash of the object at path.
-
orionis.storage.drivers.S3StorageDriver.info
orionis.storage.drivers.S3StorageDriver.html#info
Function
Method
PUBLIC
Collect a metadata snapshot for the object at path.
-
orionis.storage.drivers.S3StorageDriver.createDirectory
orionis.storage.drivers.S3StorageDriver.html#createDirectory
Function
Method
PUBLIC
Create a zero-byte directory marker at path.
-
orionis.storage.drivers.S3StorageDriver.deleteDirectory
orionis.storage.drivers.S3StorageDriver.html#deleteDirectory
Function
Method
PUBLIC
Recursively delete every object under path.
-
orionis.storage.drivers.S3StorageDriver.directoryExists
orionis.storage.drivers.S3StorageDriver.html#directoryExists
Function
Method
PUBLIC
Check whether any object exists under path.
-
orionis.storage.drivers.S3StorageDriver.files
orionis.storage.drivers.S3StorageDriver.html#files
Function
Method
PUBLIC
List the object keys that represent files under path.
-
orionis.storage.drivers.S3StorageDriver.directories
orionis.storage.drivers.S3StorageDriver.html#directories
Function
Method
PUBLIC
List the directory prefixes contained under path.
-
orionis.storage.drivers.S3StorageDriver.url
orionis.storage.drivers.S3StorageDriver.html#url
Function
Method
PUBLIC
Build the public URL for the object at path.
-
orionis.storage.drivers.S3StorageDriver.temporaryUrl
orionis.storage.drivers.S3StorageDriver.html#temporaryUrl
Function
Method
PUBLIC
Build a presigned URL for the object at path.
-
orionis.storage.drivers.S3StorageDriver.download
orionis.storage.drivers.S3StorageDriver.html#download
Function
Method
PUBLIC
Download the object at path to the local filesystem.
-
orionis.storage.drivers.S3StorageDriver.open
orionis.storage.drivers.S3StorageDriver.html#open
Function
Method
PUBLIC
Open an asynchronous binary stream for the object at path.
-
orionis.storage.drivers.S3StorageDriver.__seedStream
orionis.storage.drivers.S3StorageDriver.html#__seedStream
Function
Method
PUBLIC
Seed buffer with the current object content for a stream.
-
orionis.storage.drivers._EXPORTS
orionis.storage.drivers.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.storage.drivers.__getattr__
orionis.storage.drivers.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public storage driver.
-
orionis.storage.drivers.__dir__
orionis.storage.drivers.html#__dir__
Function
Function
PUBLIC
List loaded attributes and public storage drivers.
-
orionis.storage.entities.FileInfo
orionis.storage.entities.FileInfo.html
Class
Class
PUBLIC
Immutable snapshot of a stored file's metadata.
-
orionis.storage.entities.FileInfo.path
orionis.storage.entities.FileInfo.html#path
Attribute
Instance Variable
PUBLIC
Canonical root-relative path of the file on its disk.
-
orionis.storage.entities.FileInfo.size
orionis.storage.entities.FileInfo.html#size
Attribute
Instance Variable
PUBLIC
File size in bytes.
-
orionis.storage.entities.FileInfo.lastModified
orionis.storage.entities.FileInfo.html#lastModified
Attribute
Instance Variable
PUBLIC
Timezone-aware timestamp of the last modification.
-
orionis.storage.entities.FileInfo.visibility
orionis.storage.entities.FileInfo.html#visibility
Attribute
Instance Variable
PUBLIC
Visibility level of the file ('public' or 'private').
-
orionis.storage.entities.FileInfo.mimeType
orionis.storage.entities.FileInfo.html#mimeType
Attribute
Instance Variable
PUBLIC
Guessed MIME type, or None when it cannot be determined.
-
orionis.storage.entities.FileInfo.createdAt
orionis.storage.entities.FileInfo.html#createdAt
Attribute
Instance Variable
PUBLIC
Timezone-aware creation timestamp, or None when the driver cannot provide it.
-
orionis.storage.entities.FileInfo.etag
orionis.storage.entities.FileInfo.html#etag
Attribute
Instance Variable
PUBLIC
Backend entity tag, which need not be a complete-content MD5 digest, or None when unavailable.
-
orionis.storage.entities.FileInfo.checksum
orionis.storage.entities.FileInfo.html#checksum
Attribute
Instance Variable
PUBLIC
SHA-256 hex digest of the content, or None when unavailable.
-
orionis.storage.entities.FileInfo.url
orionis.storage.entities.FileInfo.html#url
Attribute
Instance Variable
PUBLIC
Public URL of the file, or None when the disk does not expose URLs.
-
orionis.storage.enums.Visibility
orionis.storage.enums.Visibility.html
Class
Class
PUBLIC
Enumerate the visibility levels supported by storage drivers.
-
orionis.storage.enums.Visibility.PUBLIC
orionis.storage.enums.Visibility.html#PUBLIC
Attribute
Constant
PUBLIC
The object is readable by anyone (e.g. world-readable file or publicly accessible cloud object).
-
orionis.storage.enums.Visibility.PRIVATE
orionis.storage.enums.Visibility.html#PRIVATE
Attribute
Constant
PUBLIC
The object is only readable by the owning application.
-
orionis.storage.provider.StorageProvider
orionis.storage.provider.StorageProvider.html
Class
Class
PUBLIC
Service provider for the Orionis storage system.
-
orionis.storage.provider.StorageProvider.provides
orionis.storage.provider.StorageProvider.html#provides
Function
Class Method
PUBLIC
Return the services registered by this provider.
-
orionis.storage.provider.StorageProvider.register
orionis.storage.provider.StorageProvider.html#register
Function
Method
PUBLIC
Bind IStorageManager to StorageManager as a singleton.
-
orionis.storage.provider.StorageProvider.boot
orionis.storage.provider.StorageProvider.html#boot
Function
Method
PUBLIC
Pin the Storage facade after all services are registered.
-
orionis.support.entities.BaseEntity
orionis.support.entities.BaseEntity.html
Class
Class
PUBLIC
Provide a shared constructor, serialization and dataclass metadata.
-
orionis.support.entities.BaseEntity.__slots__
orionis.support.entities.BaseEntity.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.support.entities.BaseEntity._orionis_field_metadata
orionis.support.entities.BaseEntity.html#_orionis_field_metadata
Attribute
Class Variable
PUBLIC
Cache declared fields and normalized type names for each concrete class.
-
orionis.support.entities.BaseEntity.__init__
orionis.support.entities.BaseEntity.html#__init__
Function
Method
PUBLIC
Initialize declared fields and public extra attributes.
-
orionis.support.entities.BaseEntity.__post_init__
orionis.support.entities.BaseEntity.html#__post_init__
Function
Method
PUBLIC
Provide a no-op hook for subclass validation and normalization.
-
orionis.support.entities.BaseEntity._cachedFieldMetadata
orionis.support.entities.BaseEntity.html#_cachedFieldMetadata
Function
Class Method
PUBLIC
Retrieve field definitions and normalized types cached by class.
-
orionis.support.entities.BaseEntity._dynamicAttributes
orionis.support.entities.BaseEntity.html#_dynamicAttributes
Function
Method
PUBLIC
Return public instance attributes that are not declared fields.
-
orionis.support.entities.BaseEntity.toDict
orionis.support.entities.BaseEntity.html#toDict
Function
Method
PUBLIC
Return a recursively copied dictionary of declared and extra values.
-
orionis.support.entities.BaseEntity.getFields
orionis.support.entities.BaseEntity.html#getFields
Function
Method
PUBLIC
Describe declared fields and, optionally, dynamic attributes.
-
orionis.support.formatter.serializer.Parser
orionis.support.formatter.serializer.Parser.html
Class
Class
PUBLIC
Convert supported Python values into serializable representations.
-
orionis.support.formatter.serializer.Parser.exception
orionis.support.formatter.serializer.Parser.html#exception
Function
Static Method
PUBLIC
Create and return an ExceptionParser instance for the given exception.
-
orionis.support.inspirational.quotes.INSPIRATIONAL_QUOTES
orionis.support.inspirational.quotes.html#INSPIRATIONAL_QUOTES
Attribute
Constant
PUBLIC
Inspirational quotes definitions used by quotes.
-
orionis.support.inspirational.Inspire
orionis.support.inspirational.Inspire.html
Class
Class
PUBLIC
Select inspirational quotations for console output.
-
orionis.support.inspirational.Inspire.__slots__
orionis.support.inspirational.Inspire.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.support.inspirational.Inspire._FALLBACK
orionis.support.inspirational.Inspire.html#_FALLBACK
Attribute
Constant
PUBLIC
Fallback definitions used by Inspire.
-
orionis.support.inspirational.Inspire.__init__
orionis.support.inspirational.Inspire.html#__init__
Function
Method
PUBLIC
Initialize the service with inspirational quotes.
-
orionis.support.inspirational.Inspire._quotes
orionis.support.inspirational.Inspire.html#_quotes
Attribute
Instance Variable
PUBLIC
Quote dictionaries with quote and author keys. If omitted or empty, use INSPIRATIONAL_QUOTES.
-
orionis.support.inspirational.Inspire.random
orionis.support.inspirational.Inspire.html#random
Function
Method
PUBLIC
Select a random quote or the fallback quote.
-
orionis.support.inspirational.Inspire.printQuote
orionis.support.inspirational.Inspire.html#printQuote
Function
Method
PUBLIC
Print a random quote to the console.
-
orionis.support.inspirational._EXPORTS
orionis.support.inspirational.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.support.inspirational.__getattr__
orionis.support.inspirational.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.support.inspirational.__dir__
orionis.support.inspirational.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.support.inspirational.contracts.IInspire
orionis.support.inspirational.contracts.IInspire.html
Class
Class
PUBLIC
Define the contract for inspire implementations.
-
orionis.support.inspirational.contracts.IInspire.random
orionis.support.inspirational.contracts.IInspire.html#random
Function
Method
PUBLIC
Return a random inspirational quote from the available list.
-
orionis.support.patterns.final.Final
orionis.support.patterns.final.Final.html
Class
Class
PUBLIC
Prevent subclassing of classes marked final by this metaclass.
-
orionis.support.patterns.final.Final.__new__
orionis.support.patterns.final.Final.html#__new__
Function
Method
PUBLIC
Create a new class and enforce final class inheritance rules.
-
orionis.support.performance.PerformanceCounter
orionis.support.performance.PerformanceCounter.html
Class
Class
PUBLIC
Measure elapsed execution time with a high-resolution counter.
-
orionis.support.performance.PerformanceCounter.__slots__
orionis.support.performance.PerformanceCounter.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.support.performance.PerformanceCounter.__init__
orionis.support.performance.PerformanceCounter.html#__init__
Function
Method
PUBLIC
Initialize the PerformanceCounter instance.
-
orionis.support.performance.PerformanceCounter._start_time
orionis.support.performance.PerformanceCounter.html#_start_time
Attribute
Instance Variable
PUBLIC
Initialize the counter state.
-
orionis.support.performance.PerformanceCounter._diff_time
orionis.support.performance.PerformanceCounter.html#_diff_time
Attribute
Instance Variable
PUBLIC
Elapsed duration between the recorded performance-counter samples.
-
orionis.support.performance.PerformanceCounter._is_async_mode
orionis.support.performance.PerformanceCounter.html#_is_async_mode
Attribute
Instance Variable
PUBLIC
Is async mode flag used by PerformanceCounter.
-
orionis.support.performance.PerformanceCounter.start
orionis.support.performance.PerformanceCounter.html#start
Function
Method
PUBLIC
Start the performance counter.
-
orionis.support.performance.PerformanceCounter.astart
orionis.support.performance.PerformanceCounter.html#astart
Function
Method
PUBLIC
Start the performance counter asynchronously.
-
orionis.support.performance.PerformanceCounter.stop
orionis.support.performance.PerformanceCounter.html#stop
Function
Method
PUBLIC
Stop the performance counter and compute elapsed time.
-
orionis.support.performance.PerformanceCounter.astop
orionis.support.performance.PerformanceCounter.html#astop
Function
Method
PUBLIC
Stop the performance counter asynchronously.
-
orionis.support.performance.PerformanceCounter.elapsedTime
orionis.support.performance.PerformanceCounter.html#elapsedTime
Function
Method
PUBLIC
Return the elapsed time in seconds between the last start and stop calls.
-
orionis.support.performance.PerformanceCounter.aelapsedTime
orionis.support.performance.PerformanceCounter.html#aelapsedTime
Function
Method
PUBLIC
Return the elapsed time in seconds asynchronously.
-
orionis.support.performance.PerformanceCounter.getMicroseconds
orionis.support.performance.PerformanceCounter.html#getMicroseconds
Function
Method
PUBLIC
Return the elapsed time in microseconds.
-
orionis.support.performance.PerformanceCounter.agetMicroseconds
orionis.support.performance.PerformanceCounter.html#agetMicroseconds
Function
Method
PUBLIC
Return the elapsed time in microseconds asynchronously.
-
orionis.support.performance.PerformanceCounter.getMilliseconds
orionis.support.performance.PerformanceCounter.html#getMilliseconds
Function
Method
PUBLIC
Return the elapsed time in milliseconds.
-
orionis.support.performance.PerformanceCounter.agetMilliseconds
orionis.support.performance.PerformanceCounter.html#agetMilliseconds
Function
Method
PUBLIC
Return the elapsed time in milliseconds asynchronously.
-
orionis.support.performance.PerformanceCounter.getSeconds
orionis.support.performance.PerformanceCounter.html#getSeconds
Function
Method
PUBLIC
Return the elapsed time in seconds.
-
orionis.support.performance.PerformanceCounter.agetSeconds
orionis.support.performance.PerformanceCounter.html#agetSeconds
Function
Method
PUBLIC
Return the elapsed time in seconds asynchronously.
-
orionis.support.performance.PerformanceCounter.getMinutes
orionis.support.performance.PerformanceCounter.html#getMinutes
Function
Method
PUBLIC
Return the elapsed time in minutes.
-
orionis.support.performance.PerformanceCounter.agetMinutes
orionis.support.performance.PerformanceCounter.html#agetMinutes
Function
Method
PUBLIC
Return the elapsed time in minutes asynchronously.
-
orionis.support.performance.PerformanceCounter.restart
orionis.support.performance.PerformanceCounter.html#restart
Function
Method
PUBLIC
Restart the performance counter.
-
orionis.support.performance.PerformanceCounter.arestart
orionis.support.performance.PerformanceCounter.html#arestart
Function
Method
PUBLIC
Restart the performance counter asynchronously.
-
orionis.support.performance.PerformanceCounter.__enter__
orionis.support.performance.PerformanceCounter.html#__enter__
Function
Method
PUBLIC
Enter the context manager and start the counter.
-
orionis.support.performance.PerformanceCounter.__exit__
orionis.support.performance.PerformanceCounter.html#__exit__
Function
Method
PUBLIC
Exit the context manager and stop the counter.
-
orionis.support.performance.PerformanceCounter.__aenter__
orionis.support.performance.PerformanceCounter.html#__aenter__
Function
Method
PUBLIC
Enter the async context manager and start the counter asynchronously.
-
orionis.support.performance.PerformanceCounter.__aexit__
orionis.support.performance.PerformanceCounter.html#__aexit__
Function
Method
PUBLIC
Exit the async context manager and stop the counter asynchronously.
-
orionis.support.system.contracts.workers.IWorkers
orionis.support.system.contracts.workers.IWorkers.html
Class
Class
PUBLIC
Define the contract for workers implementations.
-
orionis.support.system.contracts.workers.IWorkers.setRamPerWorker
orionis.support.system.contracts.workers.IWorkers.html#setRamPerWorker
Function
Class Method
PUBLIC
Update the RAM allocation per worker.
-
orionis.support.system.contracts.workers.IWorkers.calculate
orionis.support.system.contracts.workers.IWorkers.html#calculate
Function
Class Method
PUBLIC
Calculate the recommended maximum number of worker processes.
-
orionis.support.system.workers._get_cpu_count
orionis.support.system.workers.module.html#_get_cpu_count
Function
Function
PUBLIC
Return the logical CPU count available to this process.
-
orionis.support.system.workers._CPU_COUNT
orionis.support.system.workers.module.html#_CPU_COUNT
Attribute
Constant
PUBLIC
Store the process resource limits for the lifetime of this process.
-
orionis.support.system.workers._RAM_TOTAL_BYTES
orionis.support.system.workers.module.html#_RAM_TOTAL_BYTES
Attribute
Constant
PUBLIC
Ram total bytes used by workers.
-
orionis.support.system.workers._BYTES_PER_GB
orionis.support.system.workers.module.html#_BYTES_PER_GB
Attribute
Constant
PUBLIC
Bytes per gb used by workers.
-
orionis.support.system.workers._DEFAULT_RAM_PER_WORKER_BYTES
orionis.support.system.workers.module.html#_DEFAULT_RAM_PER_WORKER_BYTES
Attribute
Constant
PUBLIC
Default ram per worker bytes used by workers.
-
orionis.support.system.workers._ERR_INVALID_RAM_PER_WORKER
orionis.support.system.workers.module.html#_ERR_INVALID_RAM_PER_WORKER
Attribute
Constant
PUBLIC
RAM per worker must be a finite positive
value..
-
orionis.support.system.workers._ERR_RAM_PER_WORKER_TOO_SMALL
orionis.support.system.workers.module.html#_ERR_RAM_PER_WORKER_TOO_SMALL
Attribute
Constant
PUBLIC
RAM per worker must be at least one
byte..
-
orionis.support.system.Workers
orionis.support.system.Workers.html
Class
Class
PUBLIC
Calculate worker counts from the current process and CPU environment.
-
orionis.support.system.Workers.__slots__
orionis.support.system.Workers.html#__slots__
Attribute
Class Variable
PUBLIC
Keep instances without per-object state.
-
orionis.support.system.Workers.setRamPerWorker
orionis.support.system.Workers.html#setRamPerWorker
Function
Class Method
PUBLIC
Update the RAM allocation per worker.
-
orionis.support.system.Workers.calculate
orionis.support.system.Workers.html#calculate
Function
Class Method
PUBLIC
Calculate the recommended maximum number of worker processes.
-
orionis.support.types.Collection
orionis.support.types.Collection.html
Class
Class
PUBLIC
Provide collection operations over an ordered sequence of values.
-
orionis.support.types.Collection.__hash__
orionis.support.types.Collection.html#__hash__
Function
Method
PUBLIC
Compute the hash value of the collection.
-
orionis.support.types.Collection.__init__
orionis.support.types.Collection.html#__init__
Function
Method
PUBLIC
Initialize a new Collection instance.
-
orionis.support.types.Collection._items
orionis.support.types.Collection.html#_items
Attribute
Instance Variable
PUBLIC
Initial items for the collection (default is None).
-
orionis.support.types.Collection.__appends__
orionis.support.types.Collection.html#__appends__
Attribute
Instance Variable
PUBLIC
Computed attributes appended when collection items are serialized.
-
orionis.support.types.Collection.take
orionis.support.types.Collection.html#take
Function
Method
PUBLIC
Take a specific number of items from the collection.
-
orionis.support.types.Collection.first
orionis.support.types.Collection.html#first
Function
Method
PUBLIC
Return the first item in the collection, optionally filtered by a callback.
-
orionis.support.types.Collection.last
orionis.support.types.Collection.html#last
Function
Method
PUBLIC
Return the last item in the collection, optionally filtered by a callback.
-
orionis.support.types.Collection.all
orionis.support.types.Collection.html#all
Function
Method
PUBLIC
Return all items in the collection.
-
orionis.support.types.Collection.avg
orionis.support.types.Collection.html#avg
Function
Method
PUBLIC
Compute the average of the items.
-
orionis.support.types.Collection.max
orionis.support.types.Collection.html#max
Function
Method
PUBLIC
Return the maximum value from the items.
-
orionis.support.types.Collection.min
orionis.support.types.Collection.html#min
Function
Method
PUBLIC
Return the minimum value from the items.
-
orionis.support.types.Collection.chunk
orionis.support.types.Collection.html#chunk
Function
Method
PUBLIC
Divide the collection into smaller collections of a specified size.
-
orionis.support.types.Collection.collapse
orionis.support.types.Collection.html#collapse
Function
Method
PUBLIC
Collapse the collection of arrays into a single, flat collection.
-
orionis.support.types.Collection.contains
orionis.support.types.Collection.html#contains
Function
Method
PUBLIC
Check if the collection contains a given item.
-
orionis.support.types.Collection.count
orionis.support.types.Collection.html#count
Function
Method
PUBLIC
Return the number of items in the collection.
-
orionis.support.types.Collection.diff
orionis.support.types.Collection.html#diff
Function
Method
PUBLIC
Return items not present in the given collection.
-
orionis.support.types.Collection.each
orionis.support.types.Collection.html#each
Function
Method
PUBLIC
Iterate over items and apply the callback to each.
-
orionis.support.types.Collection.every
orionis.support.types.Collection.html#every
Function
Method
PUBLIC
Determine whether all items satisfy the given callback condition.
-
orionis.support.types.Collection.filter
orionis.support.types.Collection.html#filter
Function
Method
PUBLIC
Filter items in the collection using a callback.
-
orionis.support.types.Collection.flatten
orionis.support.types.Collection.html#flatten
Function
Method
PUBLIC
Flatten the collection into a single dimension.
-
orionis.support.types.Collection.forget
orionis.support.types.Collection.html#forget
Function
Method
PUBLIC
Remove items from the collection by their keys.
-
orionis.support.types.Collection.forPage
orionis.support.types.Collection.html#forPage
Function
Method
PUBLIC
Slice the collection for pagination.
-
orionis.support.types.Collection.get
orionis.support.types.Collection.html#get
Function
Method
PUBLIC
Retrieve an item from the collection by key.
-
orionis.support.types.Collection.implode
orionis.support.types.Collection.html#implode
Function
Method
PUBLIC
Join all items in the collection into a single string.
-
orionis.support.types.Collection.isEmpty
orionis.support.types.Collection.html#isEmpty
Function
Method
PUBLIC
Check if the collection is empty.
-
orionis.support.types.Collection.map
orionis.support.types.Collection.html#map
Function
Method
PUBLIC
Apply a function to each item in the collection.
-
orionis.support.types.Collection.mapInto
orionis.support.types.Collection.html#mapInto
Function
Method
PUBLIC
Map items into instances of the given class.
-
orionis.support.types.Collection.merge
orionis.support.types.Collection.html#merge
Function
Method
PUBLIC
Merge the collection with the given items.
-
orionis.support.types.Collection.pluck
orionis.support.types.Collection.html#pluck
Function
Method
PUBLIC
Extract values for a given key from all items.
-
orionis.support.types.Collection.pop
orionis.support.types.Collection.html#pop
Function
Method
PUBLIC
Remove and return the last item from the collection.
-
orionis.support.types.Collection.prepend
orionis.support.types.Collection.html#prepend
Function
Method
PUBLIC
Prepend an item to the beginning of the collection.
-
orionis.support.types.Collection.pull
orionis.support.types.Collection.html#pull
Function
Method
PUBLIC
Remove and return an item from the collection by key.
-
orionis.support.types.Collection.push
orionis.support.types.Collection.html#push
Function
Method
PUBLIC
Add an item to the end of the collection.
-
orionis.support.types.Collection.put
orionis.support.types.Collection.html#put
Function
Method
PUBLIC
Insert or update an item in the collection at the specified key.
-
orionis.support.types.Collection.random
orionis.support.types.Collection.html#random
Function
Method
PUBLIC
Return one or more random items from the collection.
-
orionis.support.types.Collection.reduce
orionis.support.types.Collection.html#reduce
Function
Method
PUBLIC
Reduce the collection to a single value using a callback.
-
orionis.support.types.Collection.reject
orionis.support.types.Collection.html#reject
Function
Method
PUBLIC
Reject items that pass a given truth test.
-
orionis.support.types.Collection.reverse
orionis.support.types.Collection.html#reverse
Function
Method
PUBLIC
Reverse the order of items in the collection.
-
orionis.support.types.Collection.serialize
orionis.support.types.Collection.html#serialize
Function
Method
PUBLIC
Serialize the collection items as a list.
-
orionis.support.types.Collection.shift
orionis.support.types.Collection.html#shift
Function
Method
PUBLIC
Remove and return the first item from the collection.
-
orionis.support.types.Collection.sort
orionis.support.types.Collection.html#sort
Function
Method
PUBLIC
Sort the items in the collection.
-
orionis.support.types.Collection.sum
orionis.support.types.Collection.html#sum
Function
Method
PUBLIC
Compute the sum of the given values.
-
orionis.support.types.Collection.toJson
orionis.support.types.Collection.html#toJson
Function
Method
PUBLIC
Return the collection items as a JSON string.
-
orionis.support.types.Collection.groupBy
orionis.support.types.Collection.html#groupBy
Function
Method
PUBLIC
Group items in the collection by a specified key.
-
orionis.support.types.Collection.transform
orionis.support.types.Collection.html#transform
Function
Method
PUBLIC
Transform each item in the collection using a callback.
-
orionis.support.types.Collection.unique
orionis.support.types.Collection.html#unique
Function
Method
PUBLIC
Return unique items from the collection.
-
orionis.support.types.Collection._getUniqueItemsWithoutKey
orionis.support.types.Collection.html#_getUniqueItemsWithoutKey
Function
Method
PUBLIC
Return unique items from the collection without using a key.
-
orionis.support.types.Collection._getUniqueItemsByKey
orionis.support.types.Collection.html#_getUniqueItemsByKey
Function
Method
PUBLIC
Get unique items from the collection based on a specified key.
-
orionis.support.types.Collection.where
orionis.support.types.Collection.html#where
Function
Method
PUBLIC
Filter items by a given key-value pair or comparison.
-
orionis.support.types.Collection.whereIn
orionis.support.types.Collection.html#whereIn
Function
Method
PUBLIC
Filter items where a given key's value is in a list of values.
-
orionis.support.types.Collection.whereNotIn
orionis.support.types.Collection.html#whereNotIn
Function
Method
PUBLIC
Filter items where a given key's value is not in a list of values.
-
orionis.support.types.Collection.zip
orionis.support.types.Collection.html#zip
Function
Method
PUBLIC
Zip the collection with the given items by index.
-
orionis.support.types.Collection.setAppends
orionis.support.types.Collection.html#setAppends
Function
Method
PUBLIC
Set the attributes to append to the Collection.
-
orionis.support.types.Collection.addRelation
orionis.support.types.Collection.html#addRelation
Function
Method
PUBLIC
Add relation data to the collection.
-
orionis.support.types.Collection.__getValue
orionis.support.types.Collection.html#__getValue
Function
Method
PUBLIC
Retrieve values from items using a key or callback.
-
orionis.support.types.Collection.__dataGet
orionis.support.types.Collection.html#__dataGet
Function
Method
PUBLIC
Retrieve a value from an item using a nested key notation.
-
orionis.support.types.Collection.__value
orionis.support.types.Collection.html#__value
Function
Method
PUBLIC
Return the evaluated value if callable, otherwise return the value itself.
-
orionis.support.types.Collection.__checkIsCallable
orionis.support.types.Collection.html#__checkIsCallable
Function
Method
PUBLIC
Check if the given callback is callable.
-
orionis.support.types.Collection.__makeComparison
orionis.support.types.Collection.html#__makeComparison
Function
Method
PUBLIC
Compare two values using the specified operator.
-
orionis.support.types.Collection.__iter__
orionis.support.types.Collection.html#__iter__
Function
Method
PUBLIC
Iterate over the items in the collection.
-
orionis.support.types.Collection.__eq__
orionis.support.types.Collection.html#__eq__
Function
Method
PUBLIC
Compare the collection with another object for equality.
-
orionis.support.types.Collection.__getitem__
orionis.support.types.Collection.html#__getitem__
Function
Method
PUBLIC
Retrieve an item or a slice from the collection.
-
orionis.support.types.Collection.__setitem__
orionis.support.types.Collection.html#__setitem__
Function
Method
PUBLIC
Set the value at the specified key in the collection.
-
orionis.support.types.Collection.__delitem__
orionis.support.types.Collection.html#__delitem__
Function
Method
PUBLIC
Delete an item from the collection at the specified key.
-
orionis.support.types.Collection.__ne__
orionis.support.types.Collection.html#__ne__
Function
Method
PUBLIC
Determine if the collection is not equal to another object.
-
orionis.support.types.Collection.__len__
orionis.support.types.Collection.html#__len__
Function
Method
PUBLIC
Return the number of items in the collection.
-
orionis.support.types.Collection.__le__
orionis.support.types.Collection.html#__le__
Function
Method
PUBLIC
Compare if the current collection is less than or equal to another object.
-
orionis.support.types.Collection.__lt__
orionis.support.types.Collection.html#__lt__
Function
Method
PUBLIC
Compare if the current collection is less than another object.
-
orionis.support.types.Collection.__ge__
orionis.support.types.Collection.html#__ge__
Function
Method
PUBLIC
Compare if the current collection is greater than or equal to another object.
-
orionis.support.types.Collection.__gt__
orionis.support.types.Collection.html#__gt__
Function
Method
PUBLIC
Compare if the current collection is greater than another object.
-
orionis.support.types.Collection.__getItems
orionis.support.types.Collection.html#__getItems
Function
Class Method
PUBLIC
Extract the underlying items from a Collection or return the input as-is.
-
orionis.support.types.dot_dict._MISSING
orionis.support.types.dot_dict.html#_MISSING
Attribute
Constant
PUBLIC
Sentinel distinguishing missing from ordinary values.
-
orionis.support.types.dot_dict._copy_mapping
orionis.support.types.dot_dict.html#_copy_mapping
Function
Function
PUBLIC
Copy a mapping into DotDict using the shared deepcopy memo.
-
orionis.support.types.DotDict
orionis.support.types.DotDict.html
Class
Class
PUBLIC
Expose nested dictionary values through attribute access.
-
orionis.support.types.DotDict.__slots__
orionis.support.types.DotDict.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.support.types.DotDict.__getattr__
orionis.support.types.DotDict.html#__getattr__
Function
Method
PUBLIC
Retrieve a value using attribute-style access.
-
orionis.support.types.DotDict.__setattr__
orionis.support.types.DotDict.html#__setattr__
Function
Method
PUBLIC
Set an attribute on the DotDict instance.
-
orionis.support.types.DotDict.__delattr__
orionis.support.types.DotDict.html#__delattr__
Function
Method
PUBLIC
Delete an attribute from the DotDict instance.
-
orionis.support.types.DotDict.get
orionis.support.types.DotDict.html#get
Function
Method
PUBLIC
Get the value for a key, returning default if the key is not found.
-
orionis.support.types.DotDict.export
orionis.support.types.DotDict.html#export
Function
Method
PUBLIC
Export the DotDict as a standard dictionary recursively.
-
orionis.support.types.DotDict.copy
orionis.support.types.DotDict.html#copy
Function
Method
PUBLIC
Create a deep copy of the DotDict.
-
orionis.support.types.DotDict.__deepcopy__
orionis.support.types.DotDict.html#__deepcopy__
Function
Method
PUBLIC
Copy values while preserving shared references and cycles.
-
orionis.support.types.MISSING
orionis.support.types.html#MISSING
Attribute
Constant
PUBLIC
Instance representing a missing value sentinel.
-
orionis.support.types._html._TagStripper
orionis.support.types._html._TagStripper.html
Class
Class
PUBLIC
Collect text and explicitly allowed markup without sanitizing attributes.
-
orionis.support.types._html._TagStripper.__init__
orionis.support.types._html._TagStripper.html#__init__
Function
Method
PUBLIC
Initialize the parser with permitted lower-case tag names.
-
orionis.support.types._html._TagStripper.allowed
orionis.support.types._html._TagStripper.html#allowed
Attribute
Instance Variable
PUBLIC
Tag names retained in the output.
-
orionis.support.types._html._TagStripper.parts
orionis.support.types._html._TagStripper.html#parts
Attribute
Instance Variable
PUBLIC
Text and markup fragments in encounter order.
-
orionis.support.types._html._TagStripper.handle_starttag
orionis.support.types._html._TagStripper.html#handle_starttag
Function
Method
PUBLIC
Retain an allowed opening tag exactly as supplied.
-
orionis.support.types._html._TagStripper.handle_startendtag
orionis.support.types._html._TagStripper.html#handle_startendtag
Function
Method
PUBLIC
Retain an allowed self-closing tag without adding an end tag.
-
orionis.support.types._html._TagStripper.handle_endtag
orionis.support.types._html._TagStripper.html#handle_endtag
Function
Method
PUBLIC
Retain the closing tag of an allowed element.
-
orionis.support.types._html._TagStripper.handle_data
orionis.support.types._html._TagStripper.html#handle_data
Function
Method
PUBLIC
Retain text content, including content within removed elements.
-
orionis.support.types._html._TagStripper.handle_entityref
orionis.support.types._html._TagStripper.html#handle_entityref
Function
Method
PUBLIC
Preserve an entity when automatic entity conversion is disabled.
-
orionis.support.types._html._TagStripper.handle_charref
orionis.support.types._html._TagStripper.html#handle_charref
Function
Method
PUBLIC
Preserve a numeric reference when entity conversion is disabled.
-
orionis.support.types.stringable._RE_CAMEL_SEP
orionis.support.types.stringable.module.html#_RE_CAMEL_SEP
Attribute
Constant
PUBLIC
Word separators shared by camel-case and StudlyCase conversion.
-
orionis.support.types.stringable._RE_KEBAB_CAMEL
orionis.support.types.stringable.module.html#_RE_KEBAB_CAMEL
Attribute
Constant
PUBLIC
Boundary between a lowercase letter or digit and an uppercase letter.
-
orionis.support.types.stringable._RE_KEBAB_SEP
orionis.support.types.stringable.module.html#_RE_KEBAB_SEP
Attribute
Constant
PUBLIC
Whitespace and underscore runs replaced by kebab-case separators.
-
orionis.support.types.stringable._RE_KEBAB_MULTI
orionis.support.types.stringable.module.html#_RE_KEBAB_MULTI
Attribute
Constant
PUBLIC
Repeated dashes collapsed during kebab-case conversion.
-
orionis.support.types.stringable._RE_SQUISH
orionis.support.types.stringable.module.html#_RE_SQUISH
Attribute
Constant
PUBLIC
Whitespace runs collapsed by squish.
-
orionis.support.types.stringable._RE_NUMBERS
orionis.support.types.stringable.module.html#_RE_NUMBERS
Attribute
Constant
PUBLIC
Characters excluded by numeric-character extraction.
-
orionis.support.types.stringable._RE_HEADLINE
orionis.support.types.stringable.module.html#_RE_HEADLINE
Attribute
Constant
PUBLIC
Word tokens used to construct headline case.
-
orionis.support.types.stringable._RE_UCSPLIT
orionis.support.types.stringable.module.html#_RE_UCSPLIT
Attribute
Constant
PUBLIC
Uppercase-led words, lowercase words and digit runs for ucsplit.
-
orionis.support.types.stringable._RE_PASCAL_WORDS
orionis.support.types.stringable.module.html#_RE_PASCAL_WORDS
Attribute
Constant
PUBLIC
Word segments used by PascalCase pluralization.
-
orionis.support.types.stringable._ULID_RE
orionis.support.types.stringable.module.html#_ULID_RE
Attribute
Constant
PUBLIC
Crockford Base32 encoding constrained to the 128-bit ULID range.
-
orionis.support.types.stringable._INTEGER_LIMIT_ERROR
orionis.support.types.stringable.module.html#_INTEGER_LIMIT_ERROR
Attribute
Constant
PUBLIC
Validation message shared by non-integer limit arguments.
-
orionis.support.types.stringable._pluralize_word
orionis.support.types.stringable.module.html#_pluralize_word
Function
Function
PUBLIC
Apply the supported regular English plural suffix rules.
-
orionis.support.types.stringable._replacement_values
orionis.support.types.stringable.module.html#_replacement_values
Function
Function
PUBLIC
Validate and normalize one replacement parameter.
-
orionis.support.types.stringable._replace_portion
orionis.support.types.stringable.module.html#_replace_portion
Function
Function
PUBLIC
Replace one bounded portion of the current string.
-
orionis.support.types.Stringable
orionis.support.types.Stringable.html
Class
Class
PUBLIC
Provide chainable operations over a string value.
-
orionis.support.types.Stringable.__slots__
orionis.support.types.Stringable.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.support.types.Stringable.after
orionis.support.types.Stringable.html#after
Function
Method
PUBLIC
Return the substring after the first occurrence of a value.
-
orionis.support.types.Stringable.afterLast
orionis.support.types.Stringable.html#afterLast
Function
Method
PUBLIC
Return the substring after the last occurrence of a value.
-
orionis.support.types.Stringable.append
orionis.support.types.Stringable.html#append
Function
Method
PUBLIC
Append one or more string values to the end of the string.
-
orionis.support.types.Stringable.newLine
orionis.support.types.Stringable.html#newLine
Function
Method
PUBLIC
Append newline characters to the end of the string.
-
orionis.support.types.Stringable.before
orionis.support.types.Stringable.html#before
Function
Method
PUBLIC
Return the substring before the first occurrence of a value.
-
orionis.support.types.Stringable.beforeLast
orionis.support.types.Stringable.html#beforeLast
Function
Method
PUBLIC
Return the substring before the last occurrence of a value.
-
orionis.support.types.Stringable.contains
orionis.support.types.Stringable.html#contains
Function
Method
PUBLIC
Check if the string contains any of the given values.
-
orionis.support.types.Stringable.endsWith
orionis.support.types.Stringable.html#endsWith
Function
Method
PUBLIC
Determine if the string ends with any of the given substrings.
-
orionis.support.types.Stringable.exactly
orionis.support.types.Stringable.html#exactly
Function
Method
PUBLIC
Return True if the string exactly matches the given value.
-
orionis.support.types.Stringable.isEmpty
orionis.support.types.Stringable.html#isEmpty
Function
Method
PUBLIC
Check if the string is empty.
-
orionis.support.types.Stringable.isNotEmpty
orionis.support.types.Stringable.html#isNotEmpty
Function
Method
PUBLIC
Return True if the string is not empty.
-
orionis.support.types.Stringable.lower
orionis.support.types.Stringable.html#lower
Function
Method
PUBLIC
Convert to lowercase.
-
orionis.support.types.Stringable.upper
orionis.support.types.Stringable.html#upper
Function
Method
PUBLIC
Convert all characters to uppercase.
-
orionis.support.types.Stringable.reverse
orionis.support.types.Stringable.html#reverse
Function
Method
PUBLIC
Reverse the string.
-
orionis.support.types.Stringable.repeat
orionis.support.types.Stringable.html#repeat
Function
Method
PUBLIC
Repeat the string a specified number of times.
-
orionis.support.types.Stringable.replace
orionis.support.types.Stringable.html#replace
Function
Method
PUBLIC
Replace occurrences of substrings with replacements.
-
orionis.support.types.Stringable.stripTags
orionis.support.types.Stringable.html#stripTags
Function
Method
PUBLIC
Remove HTML and PHP tags from the string.
-
orionis.support.types.Stringable.toBase64
orionis.support.types.Stringable.html#toBase64
Function
Method
PUBLIC
Encode the string as Base64.
-
orionis.support.types.Stringable.fromBase64
orionis.support.types.Stringable.html#fromBase64
Function
Method
PUBLIC
Decode the string from Base64.
-
orionis.support.types.Stringable.md5
orionis.support.types.Stringable.html#md5
Function
Method
PUBLIC
Compute the MD5 hash of the string.
-
orionis.support.types.Stringable.sha1
orionis.support.types.Stringable.html#sha1
Function
Method
PUBLIC
Compute the SHA1 hash of the string.
-
orionis.support.types.Stringable.sha256
orionis.support.types.Stringable.html#sha256
Function
Method
PUBLIC
Generate a SHA256 hash of the string.
-
orionis.support.types.Stringable.length
orionis.support.types.Stringable.html#length
Function
Method
PUBLIC
Return the number of characters in the string.
-
orionis.support.types.Stringable.value
orionis.support.types.Stringable.html#value
Function
Method
PUBLIC
Return the string value.
-
orionis.support.types.Stringable.toInteger
orionis.support.types.Stringable.html#toInteger
Function
Method
PUBLIC
Convert the string to an integer.
-
orionis.support.types.Stringable.toFloat
orionis.support.types.Stringable.html#toFloat
Function
Method
PUBLIC
Convert the string to a float.
-
orionis.support.types.Stringable.toBoolean
orionis.support.types.Stringable.html#toBoolean
Function
Method
PUBLIC
Convert to a boolean value.
-
orionis.support.types.Stringable.__getitem__
orionis.support.types.Stringable.html#__getitem__
Function
Method
PUBLIC
Return a substring or character by index or slice.
-
orionis.support.types.Stringable.__str__
orionis.support.types.Stringable.html#__str__
Function
Method
PUBLIC
Return the string representation of the object.
-
orionis.support.types.Stringable.isAlnum
orionis.support.types.Stringable.html#isAlnum
Function
Method
PUBLIC
Check if all characters are alphanumeric.
-
orionis.support.types.Stringable.isAlpha
orionis.support.types.Stringable.html#isAlpha
Function
Method
PUBLIC
Check if all characters in the string are alphabetic.
-
orionis.support.types.Stringable.isDecimal
orionis.support.types.Stringable.html#isDecimal
Function
Method
PUBLIC
Check if all characters in the string are decimal characters.
-
orionis.support.types.Stringable.isDigit
orionis.support.types.Stringable.html#isDigit
Function
Method
PUBLIC
Check if all characters are digits.
-
orionis.support.types.Stringable.isIdentifier
orionis.support.types.Stringable.html#isIdentifier
Function
Method
PUBLIC
Check if the string is a valid Python identifier.
-
orionis.support.types.Stringable.isLower
orionis.support.types.Stringable.html#isLower
Function
Method
PUBLIC
Check if all cased characters in the string are lowercase.
-
orionis.support.types.Stringable.isNumeric
orionis.support.types.Stringable.html#isNumeric
Function
Method
PUBLIC
Check if all characters in the string are numeric.
-
orionis.support.types.Stringable.isPrintable
orionis.support.types.Stringable.html#isPrintable
Function
Method
PUBLIC
Return True if all characters in the string are printable.
-
orionis.support.types.Stringable.isSpace
orionis.support.types.Stringable.html#isSpace
Function
Method
PUBLIC
Determine if the string contains only whitespace characters.
-
orionis.support.types.Stringable.isTitle
orionis.support.types.Stringable.html#isTitle
Function
Method
PUBLIC
Check if the string is titlecased.
-
orionis.support.types.Stringable.isUpper
orionis.support.types.Stringable.html#isUpper
Function
Method
PUBLIC
Check if all cased characters in the string are uppercase.
-
orionis.support.types.Stringable.lStrip
orionis.support.types.Stringable.html#lStrip
Function
Method
PUBLIC
Remove leading characters from the string.
-
orionis.support.types.Stringable.rStrip
orionis.support.types.Stringable.html#rStrip
Function
Method
PUBLIC
Remove trailing characters from the string.
-
orionis.support.types.Stringable.swapCase
orionis.support.types.Stringable.html#swapCase
Function
Method
PUBLIC
Swap the case of each character in the string.
-
orionis.support.types.Stringable.zFill
orionis.support.types.Stringable.html#zFill
Function
Method
PUBLIC
Pad the string with leading zeros to a given width.
-
orionis.support.types.Stringable.ascii
orionis.support.types.Stringable.html#ascii
Function
Method
PUBLIC
Transliterate to ASCII using Unicode normalization.
-
orionis.support.types.Stringable.camel
orionis.support.types.Stringable.html#camel
Function
Method
PUBLIC
Convert the string to camel case.
-
orionis.support.types.Stringable.kebab
orionis.support.types.Stringable.html#kebab
Function
Method
PUBLIC
Convert the string to kebab case.
-
orionis.support.types.Stringable.snake
orionis.support.types.Stringable.html#snake
Function
Method
PUBLIC
Convert the string to snake_case using the specified delimiter.
-
orionis.support.types.Stringable.studly
orionis.support.types.Stringable.html#studly
Function
Method
PUBLIC
Convert to StudlyCase (PascalCase).
-
orionis.support.types.Stringable.pascal
orionis.support.types.Stringable.html#pascal
Function
Method
PUBLIC
Convert the string to PascalCase.
-
orionis.support.types.Stringable.slug
orionis.support.types.Stringable.html#slug
Function
Method
PUBLIC
Generate a URL-friendly slug from the string.
-
orionis.support.types.Stringable.title
orionis.support.types.Stringable.html#title
Function
Method
PUBLIC
Convert the string to title case.
-
orionis.support.types.Stringable.headline
orionis.support.types.Stringable.html#headline
Function
Method
PUBLIC
Convert to headline case.
-
orionis.support.types.Stringable.apa
orionis.support.types.Stringable.html#apa
Function
Method
PUBLIC
Convert to APA-style title case.
-
orionis.support.types.Stringable.ucfirst
orionis.support.types.Stringable.html#ucfirst
Function
Method
PUBLIC
Capitalize the first character of the string.
-
orionis.support.types.Stringable.lcfirst
orionis.support.types.Stringable.html#lcfirst
Function
Method
PUBLIC
Convert the first character of the string to lowercase.
-
orionis.support.types.Stringable.isAscii
orionis.support.types.Stringable.html#isAscii
Function
Method
PUBLIC
Check if the string contains only 7-bit ASCII characters.
-
orionis.support.types.Stringable.isJson
orionis.support.types.Stringable.html#isJson
Function
Method
PUBLIC
Check if the string is valid JSON.
-
orionis.support.types.Stringable.isUrl
orionis.support.types.Stringable.html#isUrl
Function
Method
PUBLIC
Determine if the string is a valid URL.
-
orionis.support.types.Stringable.isUuid
orionis.support.types.Stringable.html#isUuid
Function
Method
PUBLIC
Determine if the string is a valid UUID.
-
orionis.support.types.Stringable.isUlid
orionis.support.types.Stringable.html#isUlid
Function
Method
PUBLIC
Check if the string is a valid ULID.
-
orionis.support.types.Stringable.chopStart
orionis.support.types.Stringable.html#chopStart
Function
Method
PUBLIC
Remove the given string(s) from the start if present.
-
orionis.support.types.Stringable.chopEnd
orionis.support.types.Stringable.html#chopEnd
Function
Method
PUBLIC
Remove the given string(s) from the end if present.
-
orionis.support.types.Stringable.deduplicate
orionis.support.types.Stringable.html#deduplicate
Function
Method
PUBLIC
Replace consecutive occurrences of a character with a single instance.
-
orionis.support.types.Stringable.mask
orionis.support.types.Stringable.html#mask
Function
Method
PUBLIC
Mask a portion of the string with a repeated character.
-
orionis.support.types.Stringable.limit
orionis.support.types.Stringable.html#limit
Function
Method
PUBLIC
Limit the string to a maximum number of characters.
-
orionis.support.types.Stringable.padBoth
orionis.support.types.Stringable.html#padBoth
Function
Method
PUBLIC
Pad both sides of the string to a specified total length.
-
orionis.support.types.Stringable.padLeft
orionis.support.types.Stringable.html#padLeft
Function
Method
PUBLIC
Pad the left side of the string to a specified total length.
-
orionis.support.types.Stringable.padRight
orionis.support.types.Stringable.html#padRight
Function
Method
PUBLIC
Pad the right side of the string to a specified total length.
-
orionis.support.types.Stringable.trim
orionis.support.types.Stringable.html#trim
Function
Method
PUBLIC
Trim characters from both ends of the string.
-
orionis.support.types.Stringable.ltrim
orionis.support.types.Stringable.html#ltrim
Function
Method
PUBLIC
Remove leading characters from the string.
-
orionis.support.types.Stringable.rtrim
orionis.support.types.Stringable.html#rtrim
Function
Method
PUBLIC
Remove trailing characters from the string.
-
orionis.support.types.Stringable.charAt
orionis.support.types.Stringable.html#charAt
Function
Method
PUBLIC
Return the character at a given index.
-
orionis.support.types.Stringable.position
orionis.support.types.Stringable.html#position
Function
Method
PUBLIC
Find the position of the first occurrence of a substring.
-
orionis.support.types.Stringable.match
orionis.support.types.Stringable.html#match
Function
Method
PUBLIC
Return the first substring matching the given regular expression pattern.
-
orionis.support.types.Stringable.matchAll
orionis.support.types.Stringable.html#matchAll
Function
Method
PUBLIC
Find all substrings matching the given regular expression pattern.
-
orionis.support.types.Stringable.isMatch
orionis.support.types.Stringable.html#isMatch
Function
Method
PUBLIC
Determine if the string matches any regular expression pattern.
-
orionis.support.types.Stringable.test
orionis.support.types.Stringable.html#test
Function
Method
PUBLIC
Test whether the string matches a regular expression pattern.
-
orionis.support.types.Stringable.numbers
orionis.support.types.Stringable.html#numbers
Function
Method
PUBLIC
Remove all non-numeric characters from the string.
-
orionis.support.types.Stringable.excerpt
orionis.support.types.Stringable.html#excerpt
Function
Method
PUBLIC
Extract an excerpt containing the first occurrence of a phrase.
-
orionis.support.types.Stringable.basename
orionis.support.types.Stringable.html#basename
Function
Method
PUBLIC
Return the trailing name component of the path.
-
orionis.support.types.Stringable.dirname
orionis.support.types.Stringable.html#dirname
Function
Method
PUBLIC
Return the parent directory path.
-
orionis.support.types.Stringable.between
orionis.support.types.Stringable.html#between
Function
Method
PUBLIC
Return substring between two delimiters.
-
orionis.support.types.Stringable.betweenFirst
orionis.support.types.Stringable.html#betweenFirst
Function
Method
PUBLIC
Return the substring between the first pair of delimiters.
-
orionis.support.types.Stringable.finish
orionis.support.types.Stringable.html#finish
Function
Method
PUBLIC
Ensure the string ends with the given value.
-
orionis.support.types.Stringable.start
orionis.support.types.Stringable.html#start
Function
Method
PUBLIC
Ensure the string starts with the given prefix.
-
orionis.support.types.Stringable.explode
orionis.support.types.Stringable.html#explode
Function
Method
PUBLIC
Split the string into a list using a delimiter.
-
orionis.support.types.Stringable.split
orionis.support.types.Stringable.html#split
Function
Method
PUBLIC
Split the string by whitespace, a regular expression, or chunk length.
-
orionis.support.types.Stringable.ucsplit
orionis.support.types.Stringable.html#ucsplit
Function
Method
PUBLIC
Split the string by uppercase characters.
-
orionis.support.types.Stringable.squish
orionis.support.types.Stringable.html#squish
Function
Method
PUBLIC
Normalize whitespace in the string.
-
orionis.support.types.Stringable.words
orionis.support.types.Stringable.html#words
Function
Method
PUBLIC
Limit the string to a maximum number of words.
-
orionis.support.types.Stringable.wordCount
orionis.support.types.Stringable.html#wordCount
Function
Method
PUBLIC
Count words in the string.
-
orionis.support.types.Stringable.wordWrap
orionis.support.types.Stringable.html#wordWrap
Function
Method
PUBLIC
Wrap text to a specified line width.
-
orionis.support.types.Stringable.wrap
orionis.support.types.Stringable.html#wrap
Function
Method
PUBLIC
Wrap the string with a prefix and suffix.
-
orionis.support.types.Stringable.unwrap
orionis.support.types.Stringable.html#unwrap
Function
Method
PUBLIC
Remove the specified prefix and suffix from the string.
-
orionis.support.types.Stringable.replaceArray
orionis.support.types.Stringable.html#replaceArray
Function
Method
PUBLIC
Replace a substring sequentially with elements from a list.
-
orionis.support.types.Stringable.replaceFirst
orionis.support.types.Stringable.html#replaceFirst
Function
Method
PUBLIC
Replace the first occurrence of a substring with a replacement.
-
orionis.support.types.Stringable.replaceLast
orionis.support.types.Stringable.html#replaceLast
Function
Method
PUBLIC
Replace the last occurrence of a substring with a replacement.
-
orionis.support.types.Stringable.replaceStart
orionis.support.types.Stringable.html#replaceStart
Function
Method
PUBLIC
Replace the first occurrence of a value at the start of the string.
-
orionis.support.types.Stringable.replaceEnd
orionis.support.types.Stringable.html#replaceEnd
Function
Method
PUBLIC
Replace the last occurrence of a value at the end of the string.
-
orionis.support.types.Stringable.replaceMatches
orionis.support.types.Stringable.html#replaceMatches
Function
Method
PUBLIC
Replace pattern matches in the string using regular expressions.
-
orionis.support.types.Stringable.remove
orionis.support.types.Stringable.html#remove
Function
Method
PUBLIC
Remove all occurrences of specified substrings from the string.
-
orionis.support.types.Stringable.plural
orionis.support.types.Stringable.html#plural
Function
Method
PUBLIC
Apply regular English plural suffix heuristics to a word.
-
orionis.support.types.Stringable.pluralStudly
orionis.support.types.Stringable.html#pluralStudly
Function
Method
PUBLIC
Pluralize the last word of an English, studly caps case string.
-
orionis.support.types.Stringable.pluralPascal
orionis.support.types.Stringable.html#pluralPascal
Function
Method
PUBLIC
Pluralize the last word of an English Pascal case string.
-
orionis.support.types.Stringable.singular
orionis.support.types.Stringable.html#singular
Function
Method
PUBLIC
Apply regular English singular suffix heuristics to a word.
-
orionis.support.types.Stringable.parseCallback
orionis.support.types.Stringable.html#parseCallback
Function
Method
PUBLIC
-
orionis.support.types.Stringable.when
orionis.support.types.Stringable.html#when
Function
Method
PUBLIC
Execute the given callback if condition is true.
-
orionis.support.types.Stringable.whenContains
orionis.support.types.Stringable.html#whenContains
Function
Method
PUBLIC
Execute callback if the string contains a given substring.
-
orionis.support.types.Stringable.whenContainsAll
orionis.support.types.Stringable.html#whenContainsAll
Function
Method
PUBLIC
Execute callback if the string contains all specified substrings.
-
orionis.support.types.Stringable.whenEmpty
orionis.support.types.Stringable.html#whenEmpty
Function
Method
PUBLIC
Execute callback if the string is empty.
-
orionis.support.types.Stringable.whenNotEmpty
orionis.support.types.Stringable.html#whenNotEmpty
Function
Method
PUBLIC
Execute the callback if the string is not empty.
-
orionis.support.types.Stringable.whenEndsWith
orionis.support.types.Stringable.html#whenEndsWith
Function
Method
PUBLIC
Execute the callback if the string ends with the given substring(s).
-
orionis.support.types.Stringable.whenDoesntEndWith
orionis.support.types.Stringable.html#whenDoesntEndWith
Function
Method
PUBLIC
Execute callback if the string does not end with the given substring(s).
-
orionis.support.types.Stringable.whenExactly
orionis.support.types.Stringable.html#whenExactly
Function
Method
PUBLIC
Execute callback if the string exactly matches the given value.
-
orionis.support.types.Stringable.whenNotExactly
orionis.support.types.Stringable.html#whenNotExactly
Function
Method
PUBLIC
Execute callback if string does not exactly match the given value.
-
orionis.support.types.Stringable.whenStartsWith
orionis.support.types.Stringable.html#whenStartsWith
Function
Method
PUBLIC
Execute callback if the string starts with a given substring.
-
orionis.support.types.Stringable.whenDoesntStartWith
orionis.support.types.Stringable.html#whenDoesntStartWith
Function
Method
PUBLIC
Execute callback if the string does not start with the given substring(s).
-
orionis.support.types.Stringable.whenTest
orionis.support.types.Stringable.html#whenTest
Function
Method
PUBLIC
Execute callback if the string matches the given regular expression.
-
orionis.support.types.Stringable.convertCase
orionis.support.types.Stringable.html#convertCase
Function
Method
PUBLIC
Convert string case using specified mode.
-
orionis.support.types.Stringable.transliterate
orionis.support.types.Stringable.html#transliterate
Function
Method
PUBLIC
Transliterate a string to its closest ASCII representation.
-
orionis.support.types.Stringable.hash
orionis.support.types.Stringable.html#hash
Function
Method
PUBLIC
Hash the string using the specified algorithm.
-
orionis.support.types.Stringable.pipe
orionis.support.types.Stringable.html#pipe
Function
Method
PUBLIC
Pass the string through the given callback and return the result.
-
orionis.support.types.Stringable.take
orionis.support.types.Stringable.html#take
Function
Method
PUBLIC
Take a specified number of characters from the start or end.
-
orionis.support.types.Stringable.swap
orionis.support.types.Stringable.html#swap
Function
Method
PUBLIC
Swap multiple keywords in a string with other keywords.
-
orionis.support.types.Stringable.substrCount
orionis.support.types.Stringable.html#substrCount
Function
Method
PUBLIC
Count the number of substring occurrences in the string.
-
orionis.support.types.Stringable.substrReplace
orionis.support.types.Stringable.html#substrReplace
Function
Method
PUBLIC
Replace text within a portion of a string.
-
orionis.support.types.Stringable.scan
orionis.support.types.Stringable.html#scan
Function
Method
PUBLIC
Parse input from a string according to a format pattern.
-
orionis.support.types.Stringable.prepend
orionis.support.types.Stringable.html#prepend
Function
Method
PUBLIC
Prepend values to the beginning of the string.
-
orionis.support.types.Stringable.substr
orionis.support.types.Stringable.html#substr
Function
Method
PUBLIC
Return the portion of the string specified by start and length parameters.
-
orionis.support.types.Stringable.doesntContain
orionis.support.types.Stringable.html#doesntContain
Function
Method
PUBLIC
Determine if the string doesn't contain any given substring.
-
orionis.support.types.Stringable.doesntStartWith
orionis.support.types.Stringable.html#doesntStartWith
Function
Method
PUBLIC
Determine if the string doesn't start with any given substring.
-
orionis.support.types.Stringable.doesntEndWith
orionis.support.types.Stringable.html#doesntEndWith
Function
Method
PUBLIC
Determine if string doesn't end with any given substring.
-
orionis.support.types.Stringable.startsWith
orionis.support.types.Stringable.html#startsWith
Function
Method
PUBLIC
Determine if the string starts with any of the given substrings.
-
orionis.support.types.Stringable.jsonSerialize
orionis.support.types.Stringable.html#jsonSerialize
Function
Method
PUBLIC
Convert the object to a string when JSON encoded.
-
orionis.support.types.Stringable.offsetExists
orionis.support.types.Stringable.html#offsetExists
Function
Method
PUBLIC
Determine if the given offset exists in the string.
-
orionis.support.types.Stringable.offsetGet
orionis.support.types.Stringable.html#offsetGet
Function
Method
PUBLIC
Get the character at the specified offset.
-
orionis.support.types.Stringable.isPattern
orionis.support.types.Stringable.html#isPattern
Function
Method
PUBLIC
Check if the string matches any of the given patterns.
-
orionis.support.types.Stringable.containsAll
orionis.support.types.Stringable.html#containsAll
Function
Method
PUBLIC
Check if the string contains all specified substrings.
-
orionis.support.types.Stringable.whenIs
orionis.support.types.Stringable.html#whenIs
Function
Method
PUBLIC
Execute the callback if the string matches the given pattern.
-
orionis.support.types.Stringable.whenIsAscii
orionis.support.types.Stringable.html#whenIsAscii
Function
Method
PUBLIC
Execute the callback if the string is 7-bit ASCII.
-
orionis.support.types.Stringable.whenIsUuid
orionis.support.types.Stringable.html#whenIsUuid
Function
Method
PUBLIC
Execute the callback if the string is a valid UUID.
-
orionis.support.types.Stringable.whenIsUlid
orionis.support.types.Stringable.html#whenIsUlid
Function
Method
PUBLIC
Execute the callback if the string is a valid ULID.
-
orionis.support.types.Stringable.toDate
orionis.support.types.Stringable.html#toDate
Function
Method
PUBLIC
Convert string to a datetime object.
-
orionis.support.types.Stringable.encrypt
orionis.support.types.Stringable.html#encrypt
Function
Method
PUBLIC
Encrypt the string using the Crypt facade.
-
orionis.support.types.Stringable.decrypt
orionis.support.types.Stringable.html#decrypt
Function
Method
PUBLIC
Decrypt the string using the Crypt facade.
-
orionis.support.types.Stringable.toHtmlString
orionis.support.types.Stringable.html#toHtmlString
Function
Method
PUBLIC
Escape HTML entities in the string.
-
orionis.support.types.Stringable.tap
orionis.support.types.Stringable.html#tap
Function
Method
PUBLIC
Call the callback with the string and return the string.
-
orionis.support.types.contracts.std.IStdClass
orionis.support.types.contracts.std.IStdClass.html
Class
Class
PUBLIC
Define the contract for std class implementations.
-
orionis.support.types.contracts.std.IStdClass.__slots__
orionis.support.types.contracts.std.IStdClass.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.support.types.contracts.std.IStdClass.toDict
orionis.support.types.contracts.std.IStdClass.html#toDict
Function
Method
PUBLIC
Convert the object's attributes to a dictionary.
-
orionis.support.types.contracts.std.IStdClass.update
orionis.support.types.contracts.std.IStdClass.html#update
Function
Method
PUBLIC
Update the object's attributes dynamically.
-
orionis.support.types.contracts.std.IStdClass.remove
orionis.support.types.contracts.std.IStdClass.html#remove
Function
Method
PUBLIC
Remove one or more attributes from the object.
-
orionis.support.types.std._DUNDER
orionis.support.types.std.html#_DUNDER
Attribute
Constant
PUBLIC
__.
-
orionis.support.types.StdClass
orionis.support.types.StdClass.html
Class
Class
PUBLIC
Represent dynamically assigned attributes as a simple data object.
-
orionis.support.types.StdClass.RESERVED
orionis.support.types.StdClass.html#RESERVED
Attribute
Class Variable
PUBLIC
Attribute names reserved by the class and its inheritance hierarchy.
-
orionis.support.types.StdClass.__init_subclass__
orionis.support.types.StdClass.html#__init_subclass__
Function
Class Method
PUBLIC
Rebuild the reserved-names set for every subclass.
-
orionis.support.types.StdClass.__hash__
orionis.support.types.StdClass.html#__hash__
Function
Method
PUBLIC
Compute the hash value of the object based on its attributes.
-
orionis.support.types.StdClass.__init__
orionis.support.types.StdClass.html#__init__
Function
Method
PUBLIC
Initialize attributes from keyword arguments.
-
orionis.support.types.StdClass.__repr__
orionis.support.types.StdClass.html#__repr__
Function
Method
PUBLIC
Return an unambiguous string representation for debugging.
-
orionis.support.types.StdClass.__str__
orionis.support.types.StdClass.html#__str__
Function
Method
PUBLIC
Return a readable string representation of the object.
-
orionis.support.types.StdClass.__eq__
orionis.support.types.StdClass.html#__eq__
Function
Method
PUBLIC
Compare this object with another for attribute equality.
-
orionis.support.types.StdClass.toDict
orionis.support.types.StdClass.html#toDict
Function
Method
PUBLIC
Convert the object's attributes to a dictionary.
-
orionis.support.types.StdClass.update
orionis.support.types.StdClass.html#update
Function
Method
PUBLIC
Update the object's attributes dynamically.
-
orionis.support.types.StdClass.remove
orionis.support.types.StdClass.html#remove
Function
Method
PUBLIC
Remove one or more attributes from the object.
-
orionis.support.types.StdClass.fromDict
orionis.support.types.StdClass.html#fromDict
Function
Class Method
PUBLIC
Create a StdClass instance from a dictionary.
-
orionis.support.types._EXPORTS
orionis.support.types.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.support.types.__getattr__
orionis.support.types.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.support.types.__dir__
orionis.support.types.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.test.cases.case._LIFECYCLE_HOOKS
orionis.test.cases.case.html#_LIFECYCLE_HOOKS
Attribute
Constant
PUBLIC
Lifecycle hooks that must never be wrapped regardless of naming pattern.
-
orionis.test.cases.case._DEFAULT_PATTERN
orionis.test.cases.case.html#_DEFAULT_PATTERN
Attribute
Constant
PUBLIC
Precompiled regex for the default glob pattern avoids repeated fnmatch compilation.
-
orionis.test.cases.case._SLOW_CALLBACK_DURATION
orionis.test.cases.case.html#_SLOW_CALLBACK_DURATION
Attribute
Constant
PUBLIC
unittest enables asyncio debug for every isolated test. Its 0.1-second default reports routine test work as a slow task; retain debug with a threshold that highlights substantial event-loop blocking.
-
orionis.test.cases.case._METHOD_PATTERN
orionis.test.cases.case.html#_METHOD_PATTERN
Attribute
Constant
PUBLIC
a value set by one run is never seen by another run executing in a different task or thread.
-
orionis.test.McpTestClient
orionis.test.McpTestClient.html
Class
Class
PUBLIC
Open scopes on the supplied container; never create a parallel application.
-
orionis.test.McpTestClient.__slots__
orionis.test.McpTestClient.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.test.McpTestClient.__init__
orionis.test.McpTestClient.html#__init__
Function
Method
PUBLIC
Reuse native service bindings and one compiled server.
-
orionis.test.McpTestClient.app
orionis.test.McpTestClient.html#app
Attribute
Instance Variable
PUBLIC
Application container supplying configuration and dependencies.
-
orionis.test.McpTestClient.dispatcher
orionis.test.McpTestClient.html#dispatcher
Attribute
Instance Variable
PUBLIC
Dispatcher sharing this client's configuration and event bus.
-
orionis.test.McpTestClient.stream
orionis.test.McpTestClient.html#stream
Function
Method
PUBLIC
Keep the existing application's scope alive through the entire stream.
-
orionis.test.McpTestClient.request
orionis.test.McpTestClient.html#request
Function
Method
PUBLIC
Collect a finite exchange; use stream() for subscriptions.
-
orionis.test.McpTestClient.tool
orionis.test.McpTestClient.html#tool
Function
Method
PUBLIC
Invoke a tool through JSON-RPC input and output bytes.
-
orionis.test.McpTestResponse
orionis.test.McpTestResponse.html
Class
Class
PUBLIC
Decoded result and notifications from a complete wire round trip.
-
orionis.test.McpTestResponse.message
orionis.test.McpTestResponse.html#message
Attribute
Class Variable
PUBLIC
Final decoded JSON-RPC response, or an empty mapping when none arrived.
-
orionis.test.McpTestResponse.notifications
orionis.test.McpTestResponse.html#notifications
Attribute
Class Variable
PUBLIC
Decoded notifications received before the final response.
-
orionis.test.McpTestResponse.assertOk
orionis.test.McpTestResponse.html#assertOk
Function
Method
PUBLIC
Require a successful protocol and tool result.
-
orionis.test.McpTestResponse.assertTextContains
orionis.test.McpTestResponse.html#assertTextContains
Function
Method
PUBLIC
Check returned tool text without bypassing response serialization.
-
orionis.test._EXPORTS
orionis.test.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.test.__getattr__
orionis.test.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.test.__dir__
orionis.test.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.test.cases.TestCase
orionis.test.cases.TestCase.html
Class
Class
PUBLIC
Run synchronous and asynchronous tests through the application container.
-
orionis.test.cases.TestCase.setMethodPattern
orionis.test.cases.TestCase.html#setMethodPattern
Function
Class Method
PUBLIC
Set the method pattern for identifying test methods.
-
orionis.test.cases.TestCase.__init__
orionis.test.cases.TestCase.html#__init__
Function
Method
PUBLIC
Initialize the test case and eagerly wrap the designated test method.
-
orionis.test.cases.TestCase.mcp
orionis.test.cases.TestCase.html#mcp
Function
Method
PUBLIC
Create an MCP client using the test runner's application.
-
orionis.test.cases.TestCase._setupAsyncioRunner
orionis.test.cases.TestCase.html#_setupAsyncioRunner
Function
Method
PUBLIC
Configure the event loop's slow-callback threshold.
-
orionis.test.cases.TestCase._resolveTest
orionis.test.cases.TestCase.html#_resolveTest
Function
Method
PUBLIC
Wrap a test method to initialize the application context before execution.
-
orionis.test.executors.results._STATUS_STYLE
orionis.test.executors.results.html#_STATUS_STYLE
Attribute
Constant
PUBLIC
Status-to-color mapping for Rich console output.
-
orionis.test.executors.results._FAILURE_STATUSES
orionis.test.executors.results.html#_FAILURE_STATUSES
Attribute
Constant
PUBLIC
Statuses that require detailed error rendering in verbosity=2 panels.
-
orionis.test.executors.results._V2_BOLD_WHITE
orionis.test.executors.results.html#_V2_BOLD_WHITE
Attribute
Constant
PUBLIC
Reusable Rich style strings for verbosity=2 panel content.
-
orionis.test.executors.results._V2_DIM
orionis.test.executors.results.html#_V2_DIM
Attribute
Constant
PUBLIC
dim white.
-
orionis.test.executors.results._DETAILED_VERBOSITY
orionis.test.executors.results.html#_DETAILED_VERBOSITY
Attribute
Constant
PUBLIC
Verbosity level rendering a complete result panel.
-
orionis.test.executors.results._SOURCE_LINE_WIDTH
orionis.test.executors.results.html#_SOURCE_LINE_WIDTH
Attribute
Constant
PUBLIC
Maximum displayed source width, including an ellipsis when truncated.
-
orionis.test.executors.results.TestResultProcessor
orionis.test.executors.results.TestResultProcessor.html
Class
Class
PUBLIC
Collect test outcomes and render configured console feedback.
-
orionis.test.executors.results.TestResultProcessor.__init__
orionis.test.executors.results.TestResultProcessor.html#__init__
Function
Method
PUBLIC
Initialize the TestResultProcessor instance.
-
orionis.test.executors.results.TestResultProcessor.__print_verbosity
orionis.test.executors.results.TestResultProcessor.html#__print_verbosity
Attribute
Instance Variable
PUBLIC
1 prints one compact line per test and 2 prints a detailed panel. Any other value, including None, prints nothing. Supplied by the runner through unittest.TextTestRunner._makeResult, by default None.
-
orionis.test.executors.results.TestResultProcessor.__test_results
orionis.test.executors.results.TestResultProcessor.html#__test_results
Attribute
Instance Variable
PUBLIC
Structured outcomes collected during the current test run.
-
orionis.test.executors.results.TestResultProcessor.__console
orionis.test.executors.results.TestResultProcessor.html#__console
Attribute
Instance Variable
PUBLIC
Console produced by Console.
-
orionis.test.executors.results.TestResultProcessor.__max_width
orionis.test.executors.results.TestResultProcessor.html#__max_width
Attribute
Instance Variable
PUBLIC
Maximum width used when rendering test-result panels.
-
orionis.test.executors.results.TestResultProcessor.__start_time
orionis.test.executors.results.TestResultProcessor.html#__start_time
Attribute
Instance Variable
PUBLIC
Start time of the active test, or None between test methods.
-
orionis.test.executors.results.TestResultProcessor.startTest
orionis.test.executors.results.TestResultProcessor.html#startTest
Function
Method
PUBLIC
Start timing for a test case execution.
-
orionis.test.executors.results.TestResultProcessor.stopTest
orionis.test.executors.results.TestResultProcessor.html#stopTest
Function
Method
PUBLIC
Clear the active timer after completing a test.
-
orionis.test.executors.results.TestResultProcessor.addSuccess
orionis.test.executors.results.TestResultProcessor.html#addSuccess
Function
Method
PUBLIC
Record a successful test result and print it.
-
orionis.test.executors.results.TestResultProcessor.addFailure
orionis.test.executors.results.TestResultProcessor.html#addFailure
Function
Method
PUBLIC
Record a failed test result and print it.
-
orionis.test.executors.results.TestResultProcessor.addError
orionis.test.executors.results.TestResultProcessor.html#addError
Function
Method
PUBLIC
Record an errored test result and print it.
-
orionis.test.executors.results.TestResultProcessor.addSkip
orionis.test.executors.results.TestResultProcessor.html#addSkip
Function
Method
PUBLIC
Record a skipped test result and print it.
-
orionis.test.executors.results.TestResultProcessor.addSubTest
orionis.test.executors.results.TestResultProcessor.html#addSubTest
Function
Method
PUBLIC
Record a failed subtest in both native and exported results.
-
orionis.test.executors.results.TestResultProcessor.addExpectedFailure
orionis.test.executors.results.TestResultProcessor.html#addExpectedFailure
Function
Method
PUBLIC
Report an expected failure as a skipped outcome.
-
orionis.test.executors.results.TestResultProcessor.addUnexpectedSuccess
orionis.test.executors.results.TestResultProcessor.html#addUnexpectedSuccess
Function
Method
PUBLIC
Report an unexpected success as a failed outcome.
-
orionis.test.executors.results.TestResultProcessor.__printTestResult
orionis.test.executors.results.TestResultProcessor.html#__printTestResult
Function
Method
PUBLIC
Print a test outcome at the configured verbosity.
-
orionis.test.executors.results.TestResultProcessor.__createTestResult
orionis.test.executors.results.TestResultProcessor.html#__createTestResult
Function
Method
PUBLIC
Create and return a TestResult instance for the given test.
-
orionis.test.executors.results.TestResultProcessor.getTestResults
orionis.test.executors.results.TestResultProcessor.html#getTestResults
Function
Method
PUBLIC
Retrieve the list of test results collected during execution.
-
orionis.test.executors.runner.TestRunner
orionis.test.executors.runner.TestRunner.html
Class
Class
PUBLIC
Execute test suites and report their structured results.
-
orionis.test.executors.runner.TestRunner.__init__
orionis.test.executors.runner.TestRunner.html#__init__
Function
Method
PUBLIC
Initialize the test runner with custom settings.
-
orionis.test.executors.runner.TestRunner.__console
orionis.test.executors.runner.TestRunner.html#__console
Attribute
Instance Variable
PUBLIC
Initialize a Rich console for output.
-
orionis.test.executors.runner.TestRunner.__with_panel
orionis.test.executors.runner.TestRunner.html#__with_panel
Attribute
Instance Variable
PUBLIC
Render the Rich start and summary panels around the run. When False both panels are skipped and the console is never cleared, by default True.
-
orionis.test.executors.runner.TestRunner.__startPanel
orionis.test.executors.runner.TestRunner.html#__startPanel
Function
Method
PUBLIC
Display the test suite start panel using Rich.
-
orionis.test.executors.runner.TestRunner.__endPanel
orionis.test.executors.runner.TestRunner.html#__endPanel
Function
Method
PUBLIC
Display the test summary panel using Rich.
-
orionis.test.executors.runner.TestRunner.run
orionis.test.executors.runner.TestRunner.html#run
Function
Method
PUBLIC
Execute the given test suite or test case.
-
orionis.test.core.engine._DEFAULT_VERBOSITY
orionis.test.core.engine.html#_DEFAULT_VERBOSITY
Attribute
Constant
PUBLIC
Fallbacks mirroring orionis.foundation.config.testing.Testing, applied when a configuration key is absent (app.config returns None for unknown keys).
-
orionis.test.core.engine._DEFAULT_START_DIR
orionis.test.core.engine.html#_DEFAULT_START_DIR
Attribute
Constant
PUBLIC
tests.
-
orionis.test.core.engine._DEFAULT_FILE_PATTERN
orionis.test.core.engine.html#_DEFAULT_FILE_PATTERN
Attribute
Constant
PUBLIC
test_*.py.
-
orionis.test.core.engine._DEFAULT_METHOD_PATTERN
orionis.test.core.engine.html#_DEFAULT_METHOD_PATTERN
Attribute
Constant
PUBLIC
test*.
-
orionis.test.core.engine._raise_discovery_error
orionis.test.core.engine.html#_raise_discovery_error
Function
Function
PUBLIC
Propagate traversal errors instead of silently omitting test directories.
-
orionis.test.core.engine._PatternTestLoader
orionis.test.core.engine._PatternTestLoader.html
Class
Class
PUBLIC
Filter short method names before constructing test case instances.
-
orionis.test.core.engine._PatternTestLoader.__init__
orionis.test.core.engine._PatternTestLoader.html#__init__
Function
Method
PUBLIC
Store the configured matcher and accept any method prefix.
-
orionis.test.core.engine._PatternTestLoader.testMethodPrefix
orionis.test.core.engine._PatternTestLoader.html#testMethodPrefix
Attribute
Instance Variable
PUBLIC
Allow the configured matcher to select any method prefix.
-
orionis.test.core.engine._PatternTestLoader.__matcher
orionis.test.core.engine._PatternTestLoader.html#__matcher
Attribute
Instance Variable
PUBLIC
Compiled pattern selecting short test method names.
-
orionis.test.core.engine._PatternTestLoader.getTestCaseNames
orionis.test.core.engine._PatternTestLoader.html#getTestCaseNames
Function
Method
PUBLIC
Return callable methods matching the configured short-name pattern.
-
orionis.test.core.engine.TestingEngine
orionis.test.core.engine.TestingEngine.html
Class
Class
PUBLIC
Discover configured tests, execute them and persist optional result caches.
-
orionis.test.core.engine.TestingEngine.__init__
orionis.test.core.engine.TestingEngine.html#__init__
Function
Method
PUBLIC
Initialize the TestingEngine with application configuration.
-
orionis.test.core.engine.TestingEngine.__base_path
orionis.test.core.engine.TestingEngine.html#__base_path
Attribute
Instance Variable
PUBLIC
Retrieve configuration values from the application instance.
-
orionis.test.core.engine.TestingEngine.__verbosity
orionis.test.core.engine.TestingEngine.html#__verbosity
Attribute
Instance Variable
PUBLIC
Configured detail level for test-runner output.
-
orionis.test.core.engine.TestingEngine.__fail_fast
orionis.test.core.engine.TestingEngine.html#__fail_fast
Attribute
Instance Variable
PUBLIC
Whether the test run stops after the first failure.
-
orionis.test.core.engine.TestingEngine.__start_dir
orionis.test.core.engine.TestingEngine.html#__start_dir
Attribute
Instance Variable
PUBLIC
Directory from which test discovery begins.
-
orionis.test.core.engine.TestingEngine.__file_pattern
orionis.test.core.engine.TestingEngine.html#__file_pattern
Attribute
Instance Variable
PUBLIC
Filename pattern selecting modules for test discovery.
-
orionis.test.core.engine.TestingEngine.__method_pattern
orionis.test.core.engine.TestingEngine.html#__method_pattern
Attribute
Instance Variable
PUBLIC
Method-name pattern selecting test cases.
-
orionis.test.core.engine.TestingEngine.__json_cache
orionis.test.core.engine.TestingEngine.html#__json_cache
Attribute
Instance Variable
PUBLIC
Json cache produced by bool.
-
orionis.test.core.engine.TestingEngine.__cache_folder
orionis.test.core.engine.TestingEngine.html#__cache_folder
Attribute
Instance Variable
PUBLIC
Directory used to persist structured test-run results.
-
orionis.test.core.engine.TestingEngine.__with_panel
orionis.test.core.engine.TestingEngine.html#__with_panel
Attribute
Instance Variable
PUBLIC
With panel flag used by TestingEngine.
-
orionis.test.core.engine.TestingEngine.setVerbosity
orionis.test.core.engine.TestingEngine.html#setVerbosity
Function
Method
PUBLIC
Set the verbosity level for the testing engine.
-
orionis.test.core.engine.TestingEngine.setFailFast
orionis.test.core.engine.TestingEngine.html#setFailFast
Function
Method
PUBLIC
Set the fail-fast behavior for the testing engine.
-
orionis.test.core.engine.TestingEngine.setStartDir
orionis.test.core.engine.TestingEngine.html#setStartDir
Function
Method
PUBLIC
Set the directory or Python file used for test discovery.
-
orionis.test.core.engine.TestingEngine.setFilePattern
orionis.test.core.engine.TestingEngine.html#setFilePattern
Function
Method
PUBLIC
Set the file pattern for test file discovery.
-
orionis.test.core.engine.TestingEngine.setMethodPattern
orionis.test.core.engine.TestingEngine.html#setMethodPattern
Function
Method
PUBLIC
Set the method pattern for test method discovery.
-
orionis.test.core.engine.TestingEngine.withoutPanel
orionis.test.core.engine.TestingEngine.html#withoutPanel
Function
Method
PUBLIC
Disable the start panel display for the testing engine.
-
orionis.test.core.engine.TestingEngine.__testFiles
orionis.test.core.engine.TestingEngine.html#__testFiles
Function
Method
PUBLIC
Yield matching Python files without traversing an explicit file path.
-
orionis.test.core.engine.TestingEngine.discover
orionis.test.core.engine.TestingEngine.html#discover
Function
Method
PUBLIC
Discover and filter tests using configuration parameters.
-
orionis.test.core.engine.TestingEngine.__saveCache
orionis.test.core.engine.TestingEngine.html#__saveCache
Function
Method
PUBLIC
Save test results to an independent JSON cache file.
-
orionis.test.core.engine.TestingEngine.run
orionis.test.core.engine.TestingEngine.html#run
Function
Method
PUBLIC
Run the discovered test suite asynchronously.
-
orionis.test.provider.TestingProvider
orionis.test.provider.TestingProvider.html
Class
Class
PUBLIC
Register testing services in the application container.
-
orionis.test.provider.TestingProvider.provides
orionis.test.provider.TestingProvider.html#provides
Function
Class Method
PUBLIC
Return the list of services provided by this provider.
-
orionis.test.provider.TestingProvider.register
orionis.test.provider.TestingProvider.html#register
Function
Method
PUBLIC
Bind the deferred testing engine as a singleton.
-
orionis.test.provider.TestingProvider.boot
orionis.test.provider.TestingProvider.html#boot
Function
Method
PUBLIC
Initialize the testing facade asynchronously.
-
orionis.view._failures.capture_service_failure
orionis.view._failures.html#capture_service_failure
Function
Function
PUBLIC
Observe a view-service failure when its binding exists or cannot be checked.
-
orionis.view.cache._TEMPLATE_EXTENSIONS
orionis.view.cache.html#_TEMPLATE_EXTENSIONS
Attribute
Constant
PUBLIC
Extensions stripped before building the cache filename.
-
orionis.view.cache._DIGEST_LENGTH
orionis.view.cache.html#_DIGEST_LENGTH
Attribute
Constant
PUBLIC
Digest characters appended to distinguish flattened template names.
-
orionis.view.cache._CACHE_TRANSLATION
orionis.view.cache.html#_CACHE_TRANSLATION
Attribute
Constant
PUBLIC
Flatten separators and replace characters forbidden in Windows filenames.
-
orionis.view.cache.OrionisBytecodeCache
orionis.view.cache.OrionisBytecodeCache.html
Class
Class
PUBLIC
Store compiled Jinja templates in the configured bytecode directory.
-
orionis.view.cache.OrionisBytecodeCache.getCacheKey
orionis.view.cache.OrionisBytecodeCache.html#getCacheKey
Function
Method
PUBLIC
Convert a template name into a human-readable cache key.
-
orionis.view.cache.OrionisBytecodeCache._getCacheFilename
orionis.view.cache.OrionisBytecodeCache.html#_getCacheFilename
Function
Method
PUBLIC
Join the configured cache directory with the filename for bucket.
-
orionis.view.contracts.environment.IViewEnvironment
orionis.view.contracts.environment.IViewEnvironment.html
Class
Class
PUBLIC
Define the operations provided by the view-environment wrapper.
-
orionis.view.contracts.environment.IViewEnvironment.__slots__
orionis.view.contracts.environment.IViewEnvironment.html#__slots__
Attribute
Class Variable
PUBLIC
Declare that this class introduces no additional instance slots.
-
orionis.view.contracts.environment.IViewEnvironment.addGlobal
orionis.view.contracts.environment.IViewEnvironment.html#addGlobal
Function
Method
PUBLIC
Register a global variable or callable available in all templates.
-
orionis.view.contracts.environment.IViewEnvironment.addFilter
orionis.view.contracts.environment.IViewEnvironment.html#addFilter
Function
Method
PUBLIC
Register a filter callable that templates can apply with |.
-
orionis.view.contracts.environment.IViewEnvironment.addTest
orionis.view.contracts.environment.IViewEnvironment.html#addTest
Function
Method
PUBLIC
Register a test callable used in Jinja2 is expressions.
-
orionis.view.contracts.environment.IViewEnvironment.addExtension
orionis.view.contracts.environment.IViewEnvironment.html#addExtension
Function
Method
PUBLIC
Register a Jinja2 extension class with the environment.
-
orionis.view.contracts.environment.IViewEnvironment.getJinjaEnvironment
orionis.view.contracts.environment.IViewEnvironment.html#getJinjaEnvironment
Function
Method
PUBLIC
Return the underlying Jinja2 Environment instance.
-
orionis.view.engine._DEFAULT_EXT
orionis.view.engine.html#_DEFAULT_EXT
Attribute
Constant
PUBLIC
Template extension appended when the identifier carries no extension.
-
orionis.view.engine._PATH_CACHE
orionis.view.engine.html#_PATH_CACHE
Attribute
Constant
PUBLIC
Store recently normalized template identifiers and their loader paths.
-
orionis.view.engine._PATH_CACHE_MAX
orionis.view.engine.html#_PATH_CACHE_MAX
Attribute
Constant
PUBLIC
Path cache max value used by engine.
-
orionis.view.engine._PATH_CACHE_LOCK
orionis.view.engine.html#_PATH_CACHE_LOCK
Attribute
Constant
PUBLIC
Synchronization primitive controlling access to path cache lock.
-
orionis.view.engine._TEMPLATE_WORKERS
orionis.view.engine.html#_TEMPLATE_WORKERS
Attribute
Constant
PUBLIC
Template workers used by engine.
-
orionis.view.engine.Jinja2Engine
orionis.view.engine.Jinja2Engine.html
Class
Class
PUBLIC
Render templates with Jinja2 through the view-engine contract.
-
orionis.view.engine.Jinja2Engine.__slots__
orionis.view.engine.Jinja2Engine.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.view.engine.Jinja2Engine.__init__
orionis.view.engine.Jinja2Engine.html#__init__
Function
Method
PUBLIC
Initialise the engine with the configured view environment.
-
orionis.view.engine.Jinja2Engine._environment
orionis.view.engine.Jinja2Engine.html#_environment
Attribute
Instance Variable
PUBLIC
View environment providing the configured Jinja2 Environment instance.
-
orionis.view.engine.Jinja2Engine._jinja
orionis.view.engine.Jinja2Engine.html#_jinja
Attribute
Instance Variable
PUBLIC
The environment instance is built once and mutated in place, so the reference stays valid for the whole application lifetime.
-
orionis.view.engine.Jinja2Engine._load_lock
orionis.view.engine.Jinja2Engine.html#_load_lock
Attribute
Instance Variable
PUBLIC
Synchronization primitive controlling access to load lock.
-
orionis.view.engine.Jinja2Engine._load
orionis.view.engine.Jinja2Engine.html#_load
Function
Method
PUBLIC
Serialize loader and compiler access to this environment.
-
orionis.view.engine.Jinja2Engine.warmup
orionis.view.engine.Jinja2Engine.html#warmup
Function
Method
PUBLIC
Compile known templates before serving requests, without rendering globals.
-
orionis.view.engine.Jinja2Engine.render
orionis.view.engine.Jinja2Engine.html#render
Function
Method
PUBLIC
Render a template asynchronously using Jinja2.
-
orionis.view.engine.Jinja2Engine._normalisePath
orionis.view.engine.Jinja2Engine.html#_normalisePath
Function
Static Method
PUBLIC
Convert a template identifier to a Jinja2-loader-compatible path.
-
orionis.view.environment.ViewEnvironment
orionis.view.environment.ViewEnvironment.html
Class
Class
PUBLIC
Encapsulate and configure a Jinja2 Environment instance.
-
orionis.view.environment.ViewEnvironment.__slots__
orionis.view.environment.ViewEnvironment.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.view.environment.ViewEnvironment.__init__
orionis.view.environment.ViewEnvironment.html#__init__
Function
Method
PUBLIC
Build the Jinja2 environment from the application view configuration.
-
orionis.view.environment.ViewEnvironment._jinja_env
orionis.view.environment.ViewEnvironment.html#_jinja_env
Attribute
Instance Variable
PUBLIC
the engine only ever calls render_async and every template global is awaited by Jinja2.
-
orionis.view.environment.ViewEnvironment.addGlobal
orionis.view.environment.ViewEnvironment.html#addGlobal
Function
Method
PUBLIC
Register a global variable or callable in all templates.
-
orionis.view.environment.ViewEnvironment.addFilter
orionis.view.environment.ViewEnvironment.html#addFilter
Function
Method
PUBLIC
Register a filter callable that templates can apply with |.
-
orionis.view.environment.ViewEnvironment.addTest
orionis.view.environment.ViewEnvironment.html#addTest
Function
Method
PUBLIC
Register a test callable used in Jinja2 is expressions.
-
orionis.view.environment.ViewEnvironment.addExtension
orionis.view.environment.ViewEnvironment.html#addExtension
Function
Method
PUBLIC
Register a Jinja2 extension class with the environment.
-
orionis.view.environment.ViewEnvironment.getJinjaEnvironment
orionis.view.environment.ViewEnvironment.html#getJinjaEnvironment
Function
Method
PUBLIC
Return the configured Jinja2 Environment instance.
-
orionis.view.extensions.csrf._CSRF_FIELD_GLOBAL
orionis.view.extensions.csrf.html#_CSRF_FIELD_GLOBAL
Attribute
Constant
PUBLIC
Template global the tag delegates to; registered by ViewServiceProvider.
-
orionis.view.extensions.CsrfExtension
orionis.view.extensions.CsrfExtension.html
Class
Class
PUBLIC
Provide the {% csrf %} statement tag.
-
orionis.view.extensions.CsrfExtension.tags
orionis.view.extensions.CsrfExtension.html#tags
Attribute
Class Variable
PUBLIC
Template tag names recognized by this Jinja extension.
-
orionis.view.extensions.CsrfExtension.parse
orionis.view.extensions.CsrfExtension.html#parse
Function
Method
PUBLIC
Compile the {% csrf %} tag into an output node.
-
orionis.view.extensions.CsrfExtension._renderField
orionis.view.extensions.CsrfExtension.html#_renderField
Function
Method
PUBLIC
Render the hidden CSRF input through the csrf_field global.
-
orionis.view.factory.ViewFactory
orionis.view.factory.ViewFactory.html
Class
Class
PUBLIC
Prepare named templates for deferred rendering into HTML responses.
-
orionis.view.factory.ViewFactory.__slots__
orionis.view.factory.ViewFactory.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.view.factory.ViewFactory.__init__
orionis.view.factory.ViewFactory.html#__init__
Function
Method
PUBLIC
Initialise the factory with a rendering engine.
-
orionis.view.factory.ViewFactory._engine
orionis.view.factory.ViewFactory.html#_engine
Attribute
Instance Variable
PUBLIC
The view engine used to render templates.
-
orionis.view.factory.ViewFactory.make
orionis.view.factory.ViewFactory.html#make
Function
Method
PUBLIC
Prepare a template render as an awaitable, chainable response.
-
orionis.view.filters._filter_json
orionis.view.filters.html#_filter_json
Function
Function
PUBLIC
Build the json template filter.
-
orionis.view.filters._filter_markdown
orionis.view.filters.html#_filter_markdown
Function
Function
PUBLIC
Build the markdown template filter.
-
orionis.view.filters._EXPORTS
orionis.view.filters.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.view.filters.__getattr__
orionis.view.filters.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.view.filters.__dir__
orionis.view.filters.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.view.globals._global_app
orionis.view.globals.html#_global_app
Function
Function
PUBLIC
Build the app template global.
-
orionis.view.globals.url._split_scheme
orionis.view.globals.url.html#_split_scheme
Function
Function
PUBLIC
Split an explicit URL scheme without normalizing its remaining content.
-
orionis.view.globals.url._request_base_url
orionis.view.globals.url.html#_request_base_url
Function
Function
PUBLIC
Return the base URL of the request currently in scope.
-
orionis.view.globals.url._absolute_url
orionis.view.globals.url.html#_absolute_url
Function
Function
PUBLIC
Build a URL from a path, prefixing the current request base URL.
-
orionis.view.globals.url._to_secure_url
orionis.view.globals.url.html#_to_secure_url
Function
Function
PUBLIC
Rewrite an already built URL so it uses the HTTPS scheme.
-
orionis.view.globals.asset._disk_file_url
orionis.view.globals.asset.html#_disk_file_url
Function
Function
PUBLIC
Resolve the public URL of a file stored on a disk.
-
orionis.view.globals._global_asset
orionis.view.globals.html#_global_asset
Function
Function
PUBLIC
Build the async asset template global bound to the application.
-
orionis.view.globals._global_secure_asset
orionis.view.globals.html#_global_secure_asset
Function
Function
PUBLIC
Build the async secure_asset template global bound to the app.
-
orionis.view.globals._global_auth
orionis.view.globals.html#_global_auth
Function
Function
PUBLIC
Build the auth template global.
-
orionis.view.globals._global_decrypt
orionis.view.globals.html#_global_decrypt
Function
Function
PUBLIC
Build the decrypt template global.
-
orionis.view.globals._global_encrypt
orionis.view.globals.html#_global_encrypt
Function
Function
PUBLIC
Build the encrypt template global.
-
orionis.view.globals._global_cache
orionis.view.globals.html#_global_cache
Function
Function
PUBLIC
Build the cache template global.
-
orionis.view.globals._global_collect
orionis.view.globals.html#_global_collect
Function
Function
PUBLIC
Build the collect template global.
-
orionis.view.globals._global_config
orionis.view.globals.html#_global_config
Function
Function
PUBLIC
Build the config template global bound to the application.
-
orionis.view.globals.csrf._CSRF_SESSION_KEY
orionis.view.globals.csrf.html#_CSRF_SESSION_KEY
Attribute
Constant
PUBLIC
_csrf_token.
-
orionis.view.globals.csrf._CSRF_FIELD_NAME
orionis.view.globals.csrf.html#_CSRF_FIELD_NAME
Attribute
Constant
PUBLIC
Form field read back by CSRFTokenMiddleware on unsafe requests.
-
orionis.view.globals.csrf._CSRF_FIELD_TEMPLATE
orionis.view.globals.csrf.html#_CSRF_FIELD_TEMPLATE
Attribute
Constant
PUBLIC
Template of the hidden input; Markup.format escapes the token.
-
orionis.view.globals._global_csrf_field
orionis.view.globals.html#_global_csrf_field
Function
Function
PUBLIC
Build the async csrf_field template global bound to the application.
-
orionis.view.globals._global_csrf_token
orionis.view.globals.html#_global_csrf_token
Function
Function
PUBLIC
Build the async csrf_token template global bound to the application.
-
orionis.view.globals._global_now
orionis.view.globals.html#_global_now
Function
Function
PUBLIC
Build the now template global.
-
orionis.view.globals._global_today
orionis.view.globals.html#_global_today
Function
Function
PUBLIC
Build the today template global.
-
orionis.view.globals._global_dump
orionis.view.globals.html#_global_dump
Function
Function
PUBLIC
Build the dump template global.
-
orionis.view.globals.errors.ErrorBag
orionis.view.globals.errors.ErrorBag.html
Class
Class
PUBLIC
Expose validation errors from the current request session.
-
orionis.view.globals.errors.ErrorBag.__slots__
orionis.view.globals.errors.ErrorBag.html#__slots__
Attribute
Class Variable
PUBLIC
Declare the instance attribute slots reserved by this class.
-
orionis.view.globals.errors.ErrorBag.__init__
orionis.view.globals.errors.ErrorBag.html#__init__
Function
Method
PUBLIC
Bind the bag to the application container.
-
orionis.view.globals.errors.ErrorBag._app
orionis.view.globals.errors.ErrorBag.html#_app
Attribute
Instance Variable
PUBLIC
Application container used for service resolution.
-
orionis.view.globals.errors.ErrorBag.__resolve
orionis.view.globals.errors.ErrorBag.html#__resolve
Function
Method
PUBLIC
Return the flashed error mapping, or an empty mapping.
-
orionis.view.globals.errors.ErrorBag.all
orionis.view.globals.errors.ErrorBag.html#all
Function
Method
PUBLIC
Return every error grouped by field.
-
orionis.view.globals.errors.ErrorBag.any
orionis.view.globals.errors.ErrorBag.html#any
Function
Method
PUBLIC
Report whether at least one field failed validation.
-
orionis.view.globals.errors.ErrorBag.has
orionis.view.globals.errors.ErrorBag.html#has
Function
Method
PUBLIC
Report whether field has at least one error.
-
orionis.view.globals.errors.ErrorBag.get
orionis.view.globals.errors.ErrorBag.html#get
Function
Method
PUBLIC
Return every message recorded for field.
-
orionis.view.globals.errors.ErrorBag.first
orionis.view.globals.errors.ErrorBag.html#first
Function
Method
PUBLIC
Return the first message for field, or the first of any field.
-
orionis.view.globals._global_errors
orionis.view.globals.html#_global_errors
Function
Function
PUBLIC
Build the errors template global.
-
orionis.view.globals._global_flash
orionis.view.globals.html#_global_flash
Function
Function
PUBLIC
Build the async flash template global.
-
orionis.view.globals._global_choice
orionis.view.globals.html#_global_choice
Function
Function
PUBLIC
Build the choice template global.
-
orionis.view.globals._global_locale
orionis.view.globals.html#_global_locale
Function
Function
PUBLIC
Build the locale template global.
-
orionis.view.globals._global_locales
orionis.view.globals.html#_global_locales
Function
Function
PUBLIC
Build the locales template global.
-
orionis.view.globals._global_trans
orionis.view.globals.html#_global_trans
Function
Function
PUBLIC
Build the trans (and __) template global.
-
orionis.view.globals._global_old
orionis.view.globals.html#_global_old
Function
Function
PUBLIC
Build the async old template global.
-
orionis.view.globals._global_request
orionis.view.globals.html#_global_request
Function
Function
PUBLIC
Build the async request template global.
-
orionis.view.globals.route._ROUTE_PARAM_RE
orionis.view.globals.route.html#_ROUTE_PARAM_RE
Attribute
Constant
PUBLIC
Matches route path placeholders such as {id} or {id:int}.
-
orionis.view.globals.route._MISSING
orionis.view.globals.route.html#_MISSING
Attribute
Constant
PUBLIC
Sentinel telling a missing placeholder apart from a legitimate None value.
-
orionis.view.globals.route._compile_route_template
orionis.view.globals.route.html#_compile_route_template
Function
Function
PUBLIC
Split a route template into literal chunks and placeholder names.
-
orionis.view.globals.route._build_route_path
orionis.view.globals.route.html#_build_route_path
Function
Function
PUBLIC
Replace path placeholders with their values.
-
orionis.view.globals.route._load_named_routes
orionis.view.globals.route.html#_load_named_routes
Function
Function
PUBLIC
Collect every named route as a mapping of name to path template.
-
orionis.view.globals._global_route
orionis.view.globals.html#_global_route
Function
Function
PUBLIC
Build the async route template global bound to the application.
-
orionis.view.globals._global_session
orionis.view.globals.html#_global_session
Function
Function
PUBLIC
Build the async session template global.
-
orionis.view.globals._global_stringable
orionis.view.globals.html#_global_stringable
Function
Function
PUBLIC
Build the stringable template global.
-
orionis.view.globals._global_secure_url
orionis.view.globals.html#_global_secure_url
Function
Function
PUBLIC
Build the async secure_url template global bound to the application.
-
orionis.view.globals._global_url
orionis.view.globals.html#_global_url
Function
Function
PUBLIC
Build the async url template global bound to the application.
-
orionis.view.globals._global_framework_version
orionis.view.globals.html#_global_framework_version
Function
Function
PUBLIC
Build the framework_version template global.
-
orionis.view.globals._global_python_version
orionis.view.globals.html#_global_python_version
Function
Function
PUBLIC
Build the python_version template global.
-
orionis.view.globals._LANG_MODULE
orionis.view.globals.html#_LANG_MODULE
Attribute
Constant
PUBLIC
Locate the shared translation global builders.
-
orionis.view.globals._EXPORTS
orionis.view.globals.html#_EXPORTS
Attribute
Constant
PUBLIC
Public export names mapped to their defining modules and attributes.
-
orionis.view.globals.__getattr__
orionis.view.globals.html#__getattr__
Function
Function
PUBLIC
Resolve and cache a public package export.
-
orionis.view.globals.__dir__
orionis.view.globals.html#__dir__
Function
Function
PUBLIC
List loaded attributes and declared public exports.
-
orionis.view.provider.ViewServiceProvider
orionis.view.provider.ViewServiceProvider.html
Class
Class
PUBLIC
Register and boot the view system into the application container.
-
orionis.view.provider.ViewServiceProvider.register
orionis.view.provider.ViewServiceProvider.html#register
Function
Method
PUBLIC
Bind view services as singletons in the application container.
-
orionis.view.provider.ViewServiceProvider.boot
orionis.view.provider.ViewServiceProvider.html#boot
Function
Method
PUBLIC
Register globals, filters, and extensions; then pin the facade.