ats_utilities.validation.check_value module

Module

check_value.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 value checking utility functions.

ats_utilities.validation.check_value.not_empty(value: Any, exc_message: str | None = None, exception_class: type[BaseException] = <class 'ats_utilities.exceptions.ats_value_error.ATSValueError'>) → None[source]

Requires a value to be not empty (not None, not empty sequence/mapping).

Parameters:

  • value (<Any>) – Value to check for emptiness.

  • exc_message (<str | None>) – Message to include in the exception message.

  • exception_class (<type[Exception]> (default ATSValueError)) – The exception class to raise if value is empty.

Exceptions:
Dynamically raises the provided exception_class (e.g., ATSValueError).
ats_utilities.validation.check_value.not_none(value: Any, exc_message: str | None = None, exception_class: type[BaseException] = <class 'ats_utilities.exceptions.ats_value_error.ATSValueError'>) → None[source]

Requires a value to be not None.

Parameters:

  • value (<Any>) – Value to check.

  • exc_message (<str | None>) – Message to include in the exception message.

  • exception_class (<type[Exception]> (default ATSValueError)) – The exception class to raise if value is None.

Exceptions:
Dynamically raises the provided exception_class (e.g., ATSValueError).
ats_utilities.validation.check_value.not_satisfied(status: bool, exc_message: str | None = None, exception_class: type[BaseException] = <class 'ats_utilities.exceptions.ats_value_error.ATSValueError'>) → None[source]

Ensures that an unhappy status is NOT True. Raises an exception if status is True (unhappy flow detected).

Parameters:

  • status (<bool>) – Status which indicates unhappy flow (True = unhappy flow).

  • exc_message (<str | None>) – Message to include in the exception message.

  • exception_class (<type[Exception]> (default ATSValueError)) – The exception class to raise if status is not True.

Exceptions:
Dynamically raises the provided exception_class (e.g., ATSValueError).