ats_utilities.logger.ilogger module

Module

ilogger.py

Copyright

Copyright (C) 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 logger mechanism.

class ats_utilities.logger.ilogger.ILogger

Bases: ABC

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

It defines:

methods:

write_log - Writes message to log output.

is_initialized - Checks if logger is initialized.

set_level - Sets log level.

set_log_file - Sets log file.

stop_buffering - Stops log buffering.

__str__ - Returns the logger as string representation.

_abc_impl = <_abc._abc_data object>

abstractmethod is_initialized() → bool

Checks if logger is initialized.

Returns:

<True> if successful, <False> otherwise.

Return type:

<bool>

Exceptions:

None.

abstractmethod set_level(level: int) → None

Sets log level.

Parameters:

level (<int>) – Log level.

Exceptions:

None.

abstractmethod set_log_file(log_file: str) → None

Sets log file.

Parameters:

log_file (<str>) – Log file path.

Exceptions:

None.

abstractmethod stop_buffering() → None

Stops log buffering.

Exceptions:

None.

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

Writes message to log output.

Parameters:

• message (<str>) – Log message.

• ctrl (<int>) – Log control flag.

Exceptions:

None.