ats_utilities.logging.ilogger_manager module

Module

ilogger_manager.py

Copyright

Copyright (C) 2017 - 2026 Vladimir Roncevic <elektron.ronca@gmail.com> ats_utilities is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. ats_utilities is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

Info

Defines abstract class ILoggerManager with method(s). Interface for the ATS logging manager mechanism.

class ats_utilities.logging.ilogger_manager.ILoggerManager

Bases: ABC

Defines abstract class ILoggerManager with method(s). Interface for the ATS logging manager mechanism.

It defines:

attributes:

None

methods:

get_logger - Gets logger instance.

write_log - Writes message to log output.

ok - Checks if logger manager component is ok.

__str__ - Returns the ATS logger manager as string representation.

_abc_impl = <_abc._abc_data object>

abstractmethod get_logger() → ILogger

Gets logger instance.

Returns:

Logger instance

Return type:

<ILogger>

Exceptions:

NotImplementedError.

abstractmethod is_initialized() → bool

Checks if logger component is ok.

Returns:

True (success) | False (fail)

Return type:

<bool>

Exceptions:

NotImplementedError.

abstractmethod write_log(message: str | None, ctrl: int) → bool

Writes message to log output.

Parameters:

• message (<str | None>) – Log message in string format for log output | None

• ctrl (<int>) – Control flag (debug, warning, critical, errors, info)

Returns:

True (success) | False (fail)

Return type:

<bool>

Exceptions:

NotImplementedError.