ats_utilities.info.info_ok.iinfo_ok module

Module

iinfo_ok.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 abstract class IInfoOk with method(s). Interface for the info status mechanism.

class ats_utilities.info.info_ok.iinfo_ok.IInfoOk[source]

Bases: ABC

Defines abstract class IInfoOk with method(s). Interface for the info status mechanism. Note: Info status is only prepared when it is set by user (not None).

It defines:

methods:
info_ok - Property methods for set/get operations.
not_none - Checks if info status is not None.
__str__ - Returns the info status as string representation.
_abc_impl = <_abc._abc_data object>
abstract property info_ok: bool

Property method for getting information status. Note: Info status is only prepared when it is set by user (not None).

Returns:

The information status in bool format

Return type:

<bool>

Exceptions:

None.

abstractmethod not_none() → bool[source]

Checks if info status is not None. Note: Info status is only prepared when it is set by user (not None).

Returns:

True (not None) | False (None).

Return type:

<bool>

Exceptions:

None.