ats_utilities.config_io.file_bundle module

Module

file_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 file configuration and processor utilities to minimize constructor overhead.

class ats_utilities.config_io.file_bundle.ATSFileBundle(file_path: str | None = None, file_mode: str | None = None, file_format: str | None = None)[source]

Bases: object

Defines class ATSFileBundle with attribute(s) and method(s). Encapsulates file configuration and processor utilities to minimize constructor overhead. Acts as a Parameter Object to clean up highly repetitive constructor arguments.

It defines:

attributes:
file_path - File path (default None).
file_mode - File mode (default None).
file_format - File 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.
file_format: str | None = None
file_mode: str | None = None
file_path: str | None = None
merge(other: ATSFileBundle) → None[source]

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

Parameters:

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

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..

validate() → None[source]

Validates that essential components are set.

Exceptions:

None..