ats_utilities.splasher.splash_center_bundle module

Module

splash_center_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 splash screen bundle for centering console output.

class ats_utilities.splasher.splash_center_bundle.SplashCenterBundle(columns: int = 0, additional_shifter: int = 0, text: str | None = None)[source]

Bases: object

Defines splash screen bundle for centering console output.

It defines:

attributes:
columns - Column count for console session (default 0).
additional_shifter - Additional shifters (default 0).
text - Text for console session (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.
additional_shifter: int = 0
columns: int = 0
merge(other: SplashCenterBundle) → None[source]

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

Parameters:

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

Exceptions:

None.

text: 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:

ATSTypeError, ATSValueError.