ats_utilities.logging.logger.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.logger_bundle.LoggerBundle(*, name: str | None = None, configure_logging: bool = True, log_stdout: bool = True, log_file: str | None = None)

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 LoggerBundle is valid (can be called after merge).

merge - Merges non-None values from another LoggerBundle into this one.

to_dict - Converts the LoggerBundle instance to a dictionary.

configure_logging: bool

log_file: str | None

log_stdout: bool

merge(other: LoggerBundle) → None

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

Parameters:

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

Exceptions:

ATSTypeError: Other must be a LoggerBundle instance.

name: str | None

to_dict() → dict[str, Any]

Converts the LoggerBundle instance to a dictionary.

Returns:

Dictionary representation of the LoggerBundle instance.

Return type:

<dict[str, Any]>

Exceptions:

None.

validate() → None

Validates that LoggerBundle is valid (can be called after merge). Performs validation of name, configure_logging, log_stdout and log_file attributes. Name must be non-None. Configure logging must be non-None. Log to standard output must be non-None. Log file must be non-None.

Exceptions:

ATSValueError: Logger name must be provided.

ATSValueError: Configure logging must be provided.

ATSValueError: Log to standard output must be provided.

ATSValueError: Log file must be provided.

ATSTypeError: Configure logging must be a boolean.

ATSTypeError: Log to standard output must be a boolean.

ATSTypeError: Log file must be a string.

ATSTypeError: Name must be a string.