ats_utilities.checker.format_validator module

Module

format_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 class FormatValidator with attribute(s) and method(s). Creates an API for handling parameter description format validation.

class ats_utilities.checker.format_validator.FormatValidator[source]

Bases: IFormatValidator

Defines class FormatValidator with attribute(s) and method(s). Creates an API for parameter description format validation. Mechanism for checking function or method parameters (format).

It defines:

attributes:
EXPECTED_FORMAT_PARTS - Expected number of parts in the format string.
methods:
is_valid - Checks if the string follows the expected format.
split - Splits the format string into type and name parts.
__str__ - Returns the ATS format validator as string representation.
EXPECTED_FORMAT_PARTS: Final[int] = 2
_abc_impl = <_abc._abc_data object>
is_valid(exp_type: str) → bool[source]

Checks if the string follows the expected format. Checks if the string follows the “type:name” format.

Parameters:

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

Returns:

True (success), False (fail).

Return type:

<bool>

Exceptions:

None..

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

Splits the format string into type and name parts.

Parameters:

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

Returns:

A tuple containing the split components.

Return type:

<tuple[str, str]>

Exceptions:

None..