ats_utilities.checker.iformat_validator module

Module

iformat_validator.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 IFormatValidator with method(s). Creates an interface for validating parameters for method(s) and function(s).

class ats_utilities.checker.iformat_validator.IFormatValidator[source]

Bases: ABC

Defines abstract class IFormatValidator with method(s). Creates an interface for validating parameters for method(s) and function(s).

It defines:

attributes:

None

methods:
is_valid - Checks if the string follows the expected format.
split - Splits the format string into components.
__str__ - Returns the validator as string representation.
_abc_impl = <_abc._abc_data object>
abstractmethod is_valid(exp_type: str) → bool[source]

Checks if the string follows the expected format.

Parameters:

exp_type (<str>) – The expected format string to validate

Returns:

True (success), False (fail)

Return type:

<bool>

Exceptions:

NotImplementedError.

abstractmethod split(exp_type: str) → tuple[str, str][source]

Splits the format string into components.

Parameters:

exp_type (<str>) – The format string to split

Returns:

A tuple containing the split components

Return type:

<tuple[str, str]>

Exceptions:

NotImplementedError.