orionis.foundation.config.validation

THE ORIONIS API

Build with clarity.

Explore the building blocks of an async-first Python framework. Every module, class, and method — connected, searchable, and ready to build with.

Explore modules View classes

module documentation

(source)

Undocumented

Function	`_enum_values`	Index enum names and values in declaration order.
Function	`copy_string_list`	Validate a list of non-empty strings and return an independent copy.
Function	`normalize_enum`	Normalize an enum member, member name, or string value.
Function	`validate_boolean`	Require a boolean without coercing truthy values.
Function	`validate_cookie_name`	Validate a cookie name with the HTTP response serializer.
Function	`validate_driver`	Require the driver implemented by a connection entity.
Function	`validate_http_origin`	Require an explicit serialized HTTP(S) origin without wildcards.
Function	`validate_integer`	Validate an integer within an inclusive range.
Function	`validate_name`	Require a safe connection, queue, or SQL table identifier.
Function	`validate_seconds`	Require finite nonnegative or strictly positive seconds.
Function	`validate_string`	Validate a string and optionally allow blank values.
Constant	`_ENUM_SCALAR_TYPES`	Undocumented
Constant	`_NAME_PATTERN`	Undocumented
Constant	`_TABLE_PATTERN`	Undocumented

@lru_cache(maxsize=64)

def _enum_values(enum_type: type[Enum], _member_count: int) -> MappingProxyType | None: (source) ¶

Index enum names and values in declaration order.

Parameters
enum_type:`type[Enum]`	Enum class defining the accepted names and values.
_member_count:`int`	Number of declared names, including aliases, used as a cache revision.

Returns
`MappingProxyType or None`	Read-only scalar lookup preserving declaration order, or None when values require their current string representation on every lookup.

def copy_string_list(value: object, name: str) -> list[str]: (source) ¶

Validate a list of non-empty strings and return an independent copy.

Parameters
value:`object`	List to validate and copy.
name:`str`	Field name used in validation errors.

Returns
`list[str]`	A new list containing the validated strings.

Raises
`TypeError`	If `value` is not a list or an item is not a string.
`ValueError`	If an item is blank.

def normalize_enum(value: object, enum_type: type[Enum], name: str) -> object: (source) ¶

Normalize an enum member, member name, or string value.

Parameters
value:`object`	Enum member, member name, or string value to normalize.
enum_type:`type[Enum]`	Enum class that defines the accepted members.
name:`str`	Field name used in validation errors.

Returns
`object`	The normalized enum member value.

Raises
`TypeError`	If `value` is neither an enum member nor a string.
`ValueError`	If the string does not match an enum member or value.

def validate_boolean(value: object, name: str): (source) ¶

Require a boolean without coercing truthy values.

Parameters
value:`object`	Value to validate.
name:`str`	Field name used in validation errors.

Returns
`None`	This function validates the value without returning a result.

Raises
`TypeError`	If `value` is not a boolean.

def validate_cookie_name(value: object, name: str): (source) ¶

Validate a cookie name with the HTTP response serializer.

Parameters
value:`object`	Cookie name to validate.
name:`str`	Field name used in validation errors.

Returns
`None`	This function validates the name without returning a result.

Raises
`TypeError`	If `value` is not a non-empty string.
`ValueError`	If the serializer rejects `value` as a cookie name.

def validate_driver(value: object, expected: Drivers): (source) ¶

Require the driver implemented by a connection entity.

Parameters
value:`object`	Configured driver name or enum member.
expected:`Drivers`	Driver supported by the entity.

Returns
`None`	Validate the driver without changing its representation.

Raises
`TypeError`	If the driver is not a string or string enum.
`ValueError`	If the driver does not match the connection entity.

def validate_http_origin(origin: str): (source) ¶

Require an explicit serialized HTTP(S) origin without wildcards.

Parameters
origin:`str`	One trusted browser origin from configuration.

Returns
`None`	Accept the validated origin without changing its spelling.

Raises
`TypeError`	If the configured origin is not a string.
`ValueError`	If its syntax could permit ambiguous or unrestricted matching.

def validate_integer(value: object, name: str, *, minimum: int = 0, maximum: int | None = None): (source) ¶

Validate an integer within an inclusive range.

Parameters
value:`object`	Value to validate.
name:`str`	Field name used in validation errors.
minimum:`int, optional`	Minimum allowed value, inclusive.
maximum:`int \| None, optional`	Maximum allowed value, inclusive, or `None` for no upper bound.

Returns
`None`	This function validates the value without returning a result.

Raises
`TypeError`	If `value` is not an integer or is a boolean.
`ValueError`	If `value` is outside the configured range.

def validate_name(value: object, name: str, *, table: bool = False): (source) ¶

Require a safe connection, queue, or SQL table identifier.

Parameters
value:`object`	Identifier to validate.
name:`str`	Configuration field used in errors.
table:`bool, optional`	Restrict the identifier to an unqualified SQL table name.

Returns
`None`	Validate the identifier without changing it.

Raises
`TypeError`	If the identifier is not a string.
`ValueError`	If the identifier is empty or unsafe.

def validate_seconds(value: object, name: str, *, positive: bool = False): (source) ¶

Require finite nonnegative or strictly positive seconds.

Parameters
value:`object`	Numeric duration to validate.
name:`str`	Configuration field used in errors.
positive:`bool, optional`	Reject zero when true.

Returns
`None`	Validate the duration without coercion.

Raises
`TypeError`	If the duration is not numeric or is a boolean.
`ValueError`	If the duration is nonfinite or outside its allowed range.

def validate_string(value: object, name: str, *, allow_empty: bool = False): (source) ¶

Validate a string and optionally allow blank values.

Parameters
value:`object`	Value to validate.
name:`str`	Field name used in validation errors.
allow_empty:`bool, optional`	Whether to allow strings containing only whitespace.

Returns
`None`	This function validates the value without returning a result.

Raises
`TypeError`	If `value` is not a string.
`ValueError`	If `value` is blank and empty strings are not allowed.

_ENUM_SCALAR_TYPES = (source) ¶

Undocumented

Value

frozenset(set([str, bytes, int, float, complex, bool, type(None)]))

_NAME_PATTERN = (source) ¶

Undocumented

Value

re.compile(r'[A-Za-z0-9][A-Za-z0-9_\.-]{,127}')

_TABLE_PATTERN = (source) ¶

Undocumented

Value

re.compile(r'[A-Za-z_]\w*',
           re.ASCII)