ats_utilities.logging.logger_bundle module

Module

logger_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 data classes for dependency group simplification. Encapsulates core utilities to minimize constructor overhead.

class ats_utilities.logging.logger_bundle.LoggerBundle(name: str | None = None, configure_logging: bool = True, log_stdout: bool = True, log_file: str | None = None)[source]

Bases: object

Encapsulates the core system tracking, verification, and infrastructure components. Simplifies dependency passing for checker, reporter and verbosity settings.

It defines:

attributes:
name - Logger name in string format (default None).
configure_logging - Flag for configuring logging (default True).
log_stdout - Flag for enabling logging to standard output (default True).
log_file - Logger file path in string format (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.
configure_logging: bool = True
log_file: str | None = None
log_stdout: bool = True
merge(other: LoggerBundle) → None[source]

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

Parameters:

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

Exceptions:

None.

name: str | None = None
to_dict() → dict[source]

Converts the bundle attributes to a dictionary.

Returns:

Dictionary representation of the bundle attributes.

Return type:

<dict>

Exceptions:

None.

validate() → None[source]

Validates that essential components are set.

Exceptions:

None.