ats_utilities.checker.component_bundle module

Module

component_bundle.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 component bundle dataclass for dependency group simplification. Encapsulates checker components to minimize constructor overhead.

class ats_utilities.checker.component_bundle.CheckerComponentBundle(format_validator: IFormatValidator | None = None, type_validator: ITypeValidator | None = None, context_provider: IContextProvider | None = None, check_reporter: ICheckReporter | None = None)[source]

Bases: object

Defines component bundle dataclass for dependency group simplification. Encapsulates checker components to minimize constructor overhead.

It defines:

attributes:
format_validator - Validator for parameters format (default None).
type_validator - Validator for parameters type (default None).
context_provider - Provider for call context (default None).
check_reporter - Formatter for message reports (default None).
methods:
validate - Validates that essential components are set.
merge - Merges non-None values from another bundle into this one.
to_dict - Converts the bundle attributes to a dictionary.
check_reporter: ICheckReporter | None = None
context_provider: IContextProvider | None = None
format_validator: IFormatValidator | None = None
merge(other: CheckerComponentBundle) → None[source]

Merges non-None values from another bundle into this one.

Parameters:

other (<CheckerComponentBundle>) – Another bundle to merge into this one.

Returns:

None.

Return type:

<None>

Exceptions:

None..

to_dict() → dict[source]

Converts the bundle attributes to a dictionary.

Returns:

Dictionary representation of the bundle attributes.

Return type:

<dict>

Exceptions:

None..

type_validator: ITypeValidator | None = None
validate() → None[source]

Validates that essential components are set.

Returns:

None.

Return type:

<None>

Exceptions:

ValueError