ORIONIS API REFERENCE

THE ORIONIS API

Build with clarity.

Explore the building blocks of an async-first Python framework. Every module, class, and method — connected, searchable, and ready to build with.

module documentation

Undocumented

Class RotatingHandlerFactory No class docstring; 1/1 static method documented
Function _create_chunked Create a size-based rotating file handler.
Function _create_daily Create a daily rotating file handler.
Function _create_hourly Create an hourly rotating file handler.
Function _create_monthly Create a monthly rotating file handler.
Function _create_stack Create a non-rotating file handler for the stack channel.
Function _create_weekly Create a weekly rotating file handler.
Constant _CHANNEL_CREATORS Undocumented
def _create_chunked(channel_config: dict, app_root: str, path_template: str, level: int) -> Handler: (source)

Create a size-based rotating file handler.

Parameters
channel_config:dictChannel settings containing optional mb_size and files values.
app_root:strRoot path of the application.
path_template:strRelative or absolute log file path template.
level:intLogging level to apply to the handler.
Returns
HandlerConfigured AdvancedRotatingFileHandler instance using chunked rotation and compressed rotated files.
def _create_daily(channel_config: dict, app_root: str, path_template: str, level: int) -> Handler: (source)

Create a daily rotating file handler.

Parameters
channel_config:dictChannel configuration dictionary. Supports at for rotation time and retention_days to control backup retention.
app_root:strRoot path of the application.
path_template:strRelative or absolute log file path template.
level:intLogging level to apply to the handler.
Returns
HandlerConfigured AdvancedRotatingFileHandler instance using a daily suffix resolver.
def _create_hourly(channel_config: dict, app_root: str, path_template: str, level: int) -> Handler: (source)

Create an hourly rotating file handler.

Parameters
channel_config:dictChannel configuration dictionary. Supports retention_hours to control backup retention.
app_root:strRoot path of the application.
path_template:strRelative or absolute log file path template.
level:intLogging level to apply to the handler.
Returns
HandlerConfigured AdvancedRotatingFileHandler instance using an hourly suffix resolver.
def _create_monthly(channel_config: dict, app_root: str, path_template: str, level: int) -> Handler: (source)

Create a monthly rotating file handler.

Parameters
channel_config:dictChannel configuration dictionary. Supports at for rotation time and retention_months to control backup retention.
app_root:strRoot path of the application.
path_template:strRelative or absolute log file path template.
level:intLogging level to apply to the handler.
Returns
HandlerConfigured AdvancedRotatingFileHandler instance using a monthly suffix resolver.
def _create_stack(_channel_config: dict, app_root: str, path_template: str, level: int) -> Handler: (source)

Create a non-rotating file handler for the stack channel.

Parameters
_channel_config:dictChannel configuration dictionary (unused for this handler type).
app_root:strRoot path of the application.
path_template:strRelative or absolute log file path template.
level:intLogging level to apply to the handler.
Returns
HandlerConfigured FileHandler instance.
def _create_weekly(channel_config: dict, app_root: str, path_template: str, level: int) -> Handler: (source)

Create a weekly rotating file handler.

Parameters
channel_config:dictChannel configuration dictionary. Supports at for rotation time and retention_weeks to control backup retention.
app_root:strRoot path of the application.
path_template:strRelative or absolute log file path template.
level:intLogging level to apply to the handler.
Returns
HandlerConfigured AdvancedRotatingFileHandler instance using a weekly suffix resolver.
_CHANNEL_CREATORS: dict[str, Callable[[dict, str, str, int], Handler]] = (source)

Undocumented

Value
{'stack': _create_stack,
 'hourly': _create_hourly,
 'daily': _create_daily,
 'weekly': _create_weekly,
 'monthly': _create_monthly,
 'chunked': _create_chunked}