ats_utilities.checker.icheck_reporter module

Module

icheck_reporter.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 ICheckReporter with method(s). Creates an interface for formating message report in context of checker.

class ats_utilities.checker.icheck_reporter.ICheckReporter[source]

Bases: ABC

Defines abstract class ICheckReporter with method(s). Creates an interface for formating message report in context of checker.

It defines:

attributes:

None

methods:
build_message_format - Builds the final message report for checker.
__str__ - Returns the reporter as string representation.
_abc_impl = <_abc._abc_data object>
abstractmethod build_message_format(report_bundle: CheckerReporterBundle | None = None) → str[source]

Builds the final message report for checker.

Parameters:

report_bundle (<CheckerReporterBundle | None>) – Bundle with parameters | None

Returns:

Formatted message report

Return type:

<str>

Exceptions:

NotImplementedError.