Source code for ats_utilities.checker.check_reporter

# -*- coding: UTF-8 -*-

'''
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.
'''

from ats_utilities.factory_class import format_instance_to_string
from ats_utilities.checker.icheck_reporter import ICheckReporter
from ats_utilities.checker.checker_reporter_bundle import CheckerReporterBundle
from ats_utilities.exceptions.ats_value_error import ATSValueError

__author__: str = 'Vladimir Roncevic'
__copyright__: str = '(C) 2026, https://vroncevic.github.io/ats_utilities'
__credits__: list[str] = ['Vladimir Roncevic', 'Python Software Foundation']
__license__: str = 'https://github.com/vroncevic/ats_utilities/blob/dev/LICENSE'
__version__: str = '3.3.8'
__maintainer__: str = 'Vladimir Roncevic'
__email__: str = 'elektron.ronca@gmail.com'
__status__: str = 'Updated'




class CheckReporter(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.
    '''



    def build_message_format(self, report_bundle: CheckerReporterBundle | None = None) -> str:
        '''
            Builds the final message report for checker.

            :param report_bundle: Bundle with parameters | None.
            :type report_bundle: <CheckerReporterBundle | None>
            :return: Formatted message report.
            :rtype: <str>
            :exceptions: ATSValueError.
        '''
        if not report_bundle:
            raise ATSValueError('Missing parameters for build_message_format()')

        message = getattr(report_bundle, 'context')
        err_set = set(getattr(report_bundle, 'err_indices'))

        for i, (pname, ptype, inst) in enumerate(getattr(report_bundle, 'parameters_meta')):
            message += f'\n    expected {pname} <{ptype}> object at {hex(id(inst))}'

            if i in err_set:
                message += ' wrong type'

        if getattr(report_bundle, 'is_fmt_err'):
            message += ' format wrong during checking parameters_meta'

        return message


    def __str__(self) -> str:
        '''
            Returns the ATS check reporter as string representation.

            :return: The ATS check reporter as string representation.
            :rtype: <str>
            :exceptions: None..
        '''
        return format_instance_to_string(self)