orionis.logging.Logger

THE ORIONIS API

Build with clarity.

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

Explore modules View classes

class documentation

class Logger(ILogger): (source)

Constructor: Logger(app)

View In Hierarchy

Undocumented

Method	`__createChannelHandler`	Create a handler for a specific channel.
Method	`__createFormatter`	Create and return an optimized log formatter with caching.
Method	`__del__`	Release resources when the logger is destroyed.
Method	`__ensureLoggerReady`	Ensure the logger is initialized and ready for use with ultra-fast lazy init.
Method	`__init__`	Initialize the Logger instance with ultra-fast optimization.
Method	`__initializeLogger`	Build the standard library logger for the default channel.
Method	`__normalizeChannelConfig`	Normalize the channel configuration for logging.
Method	`close`	Close all handlers and release logger resources.
Method	`critical`	Log a critical message.
Method	`debug`	Log a debug message.
Method	`error`	Log an error message.
Method	`getActiveChannel`	Return the name of the currently active logging channel.
Method	`getActiveChannels`	Return the names of active logging channels.
Method	`getAvailableChannels`	Return all available logging channels from configuration.
Method	`getLogger`	Return the internal logger instance for advanced usage.
Method	`info`	Log an informational message.
Method	`reloadConfiguration`	Reload the logger configuration from the application.
Method	`switchChannel`	Switch to a different logging channel.
Method	`warning`	Log a warning message.
Class Variable	`_formatter_cache`	Undocumented
Class Variable	`name`	Return the name of the logger service.
Instance Variable	`__app`	Undocumented
Instance Variable	`__config`	Undocumented
Instance Variable	`__date_format`	Undocumented
Instance Variable	`__default_level`	Undocumented
Instance Variable	`__handlers_cache`	Undocumented
Instance Variable	`__init_lock`	Undocumented
Instance Variable	`__log_format`	Undocumented
Instance Variable	`__logger`	Undocumented
Instance Variable	`__logger_name`	Undocumented

def __createChannelHandler(self, channel_name: str, channel_config: dict, app_root: str) -> logging.Handler | None: (source) ¶

Create a handler for a specific channel.

Parameters
channel_name:`str`	The name of the channel.
channel_config:`dict`	The configuration dictionary for the channel.
app_root:`str`	The root path of the application.

Returns
`logging.Handler \| None`	The configured handler instance, or None if creation fails.

def __createFormatter(self) -> logging.Formatter: (source) ¶

Create and return an optimized log formatter with caching.

Returns
`logging.Formatter`	The configured formatter instance for log messages.

def __del__(self): (source) ¶

Release resources when the logger is destroyed.

Calls the close method to ensure all handlers and resources are properly released when the logger instance is garbage collected.

Returns
`None`	This method does not return a value.

def __ensureLoggerReady(self): (source) ¶

Ensure the logger is initialized and ready for use with ultra-fast lazy init.

Uses optimized double-checked locking for maximum performance.

Returns
`None`	This method does not return a value.

Raises
`RuntimeError`	If the logger cannot be initialized.

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

Initialize the Logger instance with ultra-fast optimization.

Parameters
app:`IApplication`	Application instance providing configuration.

Returns
`None`	This method does not return a value.

def __initializeLogger(self): (source) ¶

Build the standard library logger for the default channel.

Configure the shared logger, create the handler declared by the default channel and cache it. Fall back to a basic file handler when the default channel is not present in the configuration.

Returns
`None`	This method does not return a value.

Raises
`RuntimeError`	If the logger cannot be initialized.

def __normalizeChannelConfig(self, config: dict) -> dict: (source) ¶

Normalize the channel configuration for logging.

Parameters
config:`dict`	Original channel configuration.

Returns
`dict`	Normalized channel configuration with ensured defaults.

def close(self): (source) ¶

overrides orionis.logging.contracts.ILogger.close

Close all handlers and release logger resources.

This method should be called when the logger is no longer needed to ensure that all file handles and resources are properly released.

Returns
`None`	This method does not return a value.

def critical(self, message: str): (source) ¶

overrides orionis.logging.contracts.ILogger.critical

Log a critical message.

Parameters
message:`str`	Critical message to log.

Returns
`None`	This method does not return a value.

def debug(self, message: str): (source) ¶

overrides orionis.logging.contracts.ILogger.debug

Log a debug message.

Parameters
message:`str`	Debug message to log.

Returns
`None`	This method does not return a value.

def error(self, message: str): (source) ¶

overrides orionis.logging.contracts.ILogger.error

Log an error message.

Parameters
message:`str`	Error message to log.

Returns
`None`	This method does not return a value.

def getActiveChannel(self) -> str | None: (source) ¶

overrides orionis.logging.contracts.ILogger.getActiveChannel

Return the name of the currently active logging channel.

Returns
`str \| None`	The name of the active channel, or None if no channel is active.

def getActiveChannels(self) -> list[str]: (source) ¶

overrides orionis.logging.contracts.ILogger.getActiveChannels

Return the names of active logging channels.

Returns
`list[str]`	List containing the names of active logging channels.

def getAvailableChannels(self) -> list[str]: (source) ¶

overrides orionis.logging.contracts.ILogger.getAvailableChannels

Return all available logging channels from configuration.

Returns
`list[str]`	List of all configured channel names.

def getLogger(self) -> logging.Logger: (source) ¶

overrides orionis.logging.contracts.ILogger.getLogger

Return the internal logger instance for advanced usage.

Returns
`logging.Logger`	The configured logger instance.

Raises
`RuntimeError`	If the logger is not available.

def info(self, message: str): (source) ¶

overrides orionis.logging.contracts.ILogger.info

Log an informational message.

Parameters
message:`str`	The message to log.

Returns
`None`	This method does not return a value.

def reloadConfiguration(self): (source) ¶

overrides orionis.logging.contracts.ILogger.reloadConfiguration

Reload the logger configuration from the application.

This method allows dynamic reloading of logger settings without restarting the application.

Returns
`None`	This method does not return a value.

def switchChannel(self, channel_name: str) -> bool: (source) ¶

overrides orionis.logging.contracts.ILogger.switchChannel

Switch to a different logging channel.

Initialize the logger when needed, close current handlers, clear caches, and create a new handler for the specified channel. Only one channel is active at a time.

Parameters
channel_name:`str`	Name of the channel to switch to.

Returns
`bool`	True if the switch was successful, False otherwise.

def warning(self, message: str): (source) ¶

overrides orionis.logging.contracts.ILogger.warning

Log a warning message.

Parameters
message:`str`	Warning message to log.

Returns
`None`	This method does not return a value.

_formatter_cache: dict[str, logging.Formatter] = (source) ¶

Undocumented

name: ClassVar[str] = (source) ¶

overrides orionis.logging.contracts.ILogger.name

Return the name of the logger service.

Returns
`str`	The name of the logger service.

__app: IApplication = (source) ¶

Undocumented

__config: dict = (source) ¶

Undocumented

__date_format: str = (source) ¶

Undocumented

__default_level: int = (source) ¶

Undocumented

__handlers_cache: dict[str, logging.Handler] = (source) ¶

Undocumented

__init_lock = (source) ¶

Undocumented

__log_format: str = (source) ¶

Undocumented

__logger: logging.Logger | None = (source) ¶

Undocumented

__logger_name: str = (source) ¶

Undocumented