Source code for armpicom.setup.opt_validator

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

'''
Module
    opt_validator.py
Copyright
    Copyright (C) 2026 Vladimir Roncevic <elektron.ronca@gmail.com>
    armpicom 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.
    armpicom 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
    Validator for the armpicom bundle options.
'''

from __future__ import annotations

from collections.abc import Mapping
from ats_utilities.exceptions import ATSValueError, ATSTypeError

from ats_utilities.validation.check_type import istype
from ats_utilities.validation.check_value import not_none

from armpicom.setup.options import ARMPicomBundleOptions
from armpicom.setup.keys import ARMPicomBundleKeys

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




class ARMPicomBundleOptionsValidator:
    '''
        Validator for the armpicom bundle options.

        It defines:

            :methods:
                | validate - Validates the armpicom bundle options.
                | is_valid - Checks if the armpicom bundle options is valid.
    '''



    @classmethod
    def validate(cls, options: ARMPicomBundleOptions) -> None:
        '''
            Validates the armpicom bundle options.

            :param options: The armpicom bundle options to be validated.
            :exceptions:
                | ATSValueError: The armpicom bundle options must be provided and have proper values.
                | ATSTypeError:  The armpicom bundle options must be an instance of Mapping and its
                |                attributes must be instances of their respective types.
        '''
        ctx: str = 'armpicom_bundle_options_validator::validate(...)'
        msg_options_none: str = 'the armpicom bundle options must be provided'
        msg_options_istype: str = 'the armpicom bundle options must be a Mapping'

        not_none(options, ctx, msg_options_none)
        istype(options, Mapping, ctx, msg_options_istype)

        for attr_name, expected_type in ARMPicomBundleKeys.get_option_to_type().items():
            msg_attr_name_istype: str = f'the {attr_name.replace("_", " ")} must be an instance of {expected_type.__name__}'

            attribute = options.get(attr_name)

            istype(attribute, expected_type, ctx, msg_attr_name_istype)




    @classmethod
    def is_valid(cls, options: ARMPicomBundleOptions) -> bool:
        '''
            Checks if the armpicom bundle options is valid.

            :param options: The armpicom bundle options to be checked.
            :return: True if valid, False otherwise.
        '''
        try:
            cls.validate(options)
            return True

        except (ATSValueError, ATSTypeError):
            return False