xtl.common.validators module

This modules defines custom validators to be used with Pydantic models.

xtl.common.validators.CastAsNoneIfEmpty()

Pydantic validator to cast a value to None if it is empty.

Return type:

BeforeValidator

xtl.common.validators.CastAsPathOrNone()

Pydantic validator to cast a value to a Path or return None if the value is empty.

Return type:

BeforeValidator

xtl.common.validators.CastAsValidator(type_)

Pydantic validator to cast a value to the specified type.

Parameters:

type_ (type | Callable)

Return type:

BeforeValidator

xtl.common.validators.ChoicesValidator(choices)

Pydantic validator to check if a value is in the provided choices.

Parameters:

choices (str | tuple[Any, ...])

Return type:

AfterValidator

xtl.common.validators.LengthValidator(length)

Pydantic validator to check if the length of a value is equal to the provided length.

Parameters:

length (int)

Return type:

AfterValidator

xtl.common.validators.PathExistsValidator()

Pydantic validator to check if a path exists.

Return type:

AfterValidator

xtl.common.validators.PathIsAbsoluteValidator()

Pydantic validator to check if a path is absolute.

Return type:

AfterValidator

xtl.common.validators.PathIsDirValidator()

Pydantic validator to check if a path is a directory.

Return type:

AfterValidator

xtl.common.validators.PathIsFileValidator()

Pydantic validator to check if a path is a file.

Return type:

AfterValidator