ats_utilities.context_bundle module

Module

context_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 parameter bundle dataclass for component dependency management. Encapsulates core runtime components for simplifcation.

class ats_utilities.context_bundle.ContextBundle(checker: IChecker | None = None, reporter: IReporter | None = None, verbose: bool = False)[source]

Bases: object

Encapsulates core runtime components for simplifcation. Enables passing dependencies to other components.

It defines:

attributes:
checker - Checker for parameters (default None).
reporter - Reporter for providing all types of messages (default None).
verbose - Flag for enabling verbose output (default False).
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.
checker: IChecker | None = None
merge(other: ContextBundle) → None[source]

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

Parameters:

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

Exceptions:

None.

reporter: IReporter | None = None
to_dict() → dict[str, Any][source]

Converts the bundle attributes to a dictionary.

Returns:

Dictionary representation of the bundle attributes.

Return type:

<dict[str, Any]>

Exceptions:

None.

validate() → None[source]

Validates that essential components are set.

Exceptions:

ATSValueError - Raised if the checker or reporter is not set.

verbose: bool = False