ats_utilities.checker.check_reporter module

Module

check_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 class CheckReporter with attribute(s) and method(s). Creates an API for checking parameters for methods and functions.

class ats_utilities.checker.check_reporter.CheckReporter

Bases: ICheckReporter

Defines class CheckReporter with attribute(s) and method(s). Standard human-readable report formatter. Mechanism for checking function or method parameters (report).

It defines:

attributes:

None

methods:

build_message_format - Builds the final message report.

__str__ - Returns the ATS check reporter as string representation.

_abc_impl = <_abc._abc_data object>

build_message_format(report_bundle: CheckerReporterBundle | None = None) → str

Builds the final message report for checker.

Parameters:

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

Returns:

Formatted message report.

Return type:

<str>

Exceptions:

ATSValueError.