ats_utilities.reporter.ireporter module

Module

ireporter.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 IReporter with method(s). Creates an interface for reporting message.

class ats_utilities.reporter.ireporter.IReporter[source]

Bases: ABC

Defines abstract class IReporter with method(s). Creates an interface for reporting message.

It defines:

attributes:

None

methods:
error - Reports error message.
success - Reports success message.
verbose - Reports verbose message.
warning - Reports warning message.
is_initialized - Checks if the reporter component is initialized.
__str__ - Returns the ATS reporter as string representation.
_abc_impl = <_abc._abc_data object>
abstractmethod error(message: list[Any]) → None[source]

Reports error message.

Parameters:

message (<list[Any]>) – List with message.

Exceptions:

NotImplementedError.

abstractmethod is_initialized() → bool[source]

Returns whether the reporter component is initialized.

Returns:

True (success) | False (fail).

Return type:

<bool>

Exceptions:

NotImplementedError.

abstractmethod success(message: list[Any]) → None[source]

Reports success message.

Parameters:

message (<list[Any]>) – List with message.

Exceptions:

NotImplementedError.

abstractmethod verbose(is_verbose: bool, message: list[Any]) → None[source]

Reports verbose message.

Parameters:

  • is_verbose (<bool>) – Enable/Disable verbose option.

  • message (<list[Any]>) – List with message.

Exceptions:

NotImplementedError.

abstractmethod warning(message: list[Any]) → None[source]

Reports warning message.

Parameters:

message (<list[Any]>) – List with message.

Exceptions:

NotImplementedError.