orionis.logging.contracts.ILogger

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 ILogger(ABC): (source)

Known subclasses: orionis.logging.Logger

View In Hierarchy

Undocumented

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.
Property	`name`	Return the name of the logger service.

@abstractmethod

def close(self): (source) ¶

overridden in orionis.logging.Logger

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.

@abstractmethod

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

overridden in orionis.logging.Logger

Log a critical message.

Parameters
message:`str`	Critical message to log.

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

@abstractmethod

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

overridden in orionis.logging.Logger

Log a debug message.

Parameters
message:`str`	Debug message to log.

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

@abstractmethod

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

overridden in orionis.logging.Logger

Log an error message.

Parameters
message:`str`	Error message to log.

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

@abstractmethod

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

overridden in orionis.logging.Logger

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.

@abstractmethod

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

overridden in orionis.logging.Logger

Return the names of active logging channels.

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

@abstractmethod

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

overridden in orionis.logging.Logger

Return all available logging channels from configuration.

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

@abstractmethod

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

overridden in orionis.logging.Logger

Return the internal logger instance for advanced usage.

Returns
`logging.Logger`	The configured logger instance.

Raises
`RuntimeError`	If the logger is not available.

@abstractmethod

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

overridden in orionis.logging.Logger

Log an informational message.

Parameters
message:`str`	The message to log.

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

@abstractmethod

def reloadConfiguration(self): (source) ¶

overridden in orionis.logging.Logger

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.

@abstractmethod

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

overridden in orionis.logging.Logger

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.

@abstractmethod

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

overridden in orionis.logging.Logger

Log a warning message.

Parameters
message:`str`	Warning message to log.

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

@property
@abstractmethod

name: str = (source) ¶

overridden in orionis.logging.Logger

Return the name of the logger service.

Returns
`str`	The name of the logger service.