ats_utilities.logging.ilogger module

Module

ilogger.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 ILogger with attribute(s) and method(s). Interface for the ATS logging mechanism.

class ats_utilities.logging.ilogger.ILogger[source]

Bases: ABC

Defines abstract class ILogger with attribute(s) and method(s). Interface for the ATS logging mechanism.

It defines:

attributes:
LOG_FORMATS - Log formats.
LOG_LEVELS - Log levels.
methods:
write_log - Writes message to log output.
ok - Checks if logger component is ok.
__str__ - Returns the ATS logger as string representation.
LOG_FORMATS

alias of LogFormats

LOG_LEVELS

alias of LogLevels

_abc_impl = <_abc._abc_data object>
abstractmethod is_initialized() → bool[source]

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[source]

Writes message to log output.

Parameters:

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

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

Returns:

True (success) | False (fail)

Return type:

<bool>

Exceptions:

NotImplementedError.

class ats_utilities.logging.ilogger.LogFormats(value)[source]

Bases: str, Enum

Defines class LogFormats with attribute(s). Log formats for the ATS logging mechanism.

It defines:

attributes:
ATS_LOG_MSG_FORMAT - Log message format.
ATS_LOG_DATE_FORMAT - Log date format.
methods:

None

ATS_LOG_DATE_FORMAT = '%m/%d/%Y %I:%M:%S %p'
ATS_LOG_MSG_FORMAT = '%(asctime)s - %(levelname)s - %(message)s'
class ats_utilities.logging.ilogger.LogLevels(value)[source]

Bases: int, Enum

Defines class LogLevels with attribute(s). Log levels for the ATS logging mechanism.

It defines:

attributes:
ATS_LOG_DEBUG - Debug log level.
ATS_LOG_INFO - Info log level.
ATS_LOG_WARNING - Warning log level.
ATS_LOG_ERROR - Error log level.
ATS_LOG_CRITICAL - Critical log level.
methods:

None

ATS_LOG_CRITICAL = 50
ATS_LOG_DEBUG = 10
ATS_LOG_ERROR = 40
ATS_LOG_INFO = 20
ATS_LOG_WARNING = 30