bagof.converters.strings

Converters for string types.

Classes

ToString(hint: Any = UNSET, compose: bool = False)

Converter for str.

Example

>>> from bagof.converters import get_converter
>>> get_converter(str)(b"hello")
'hello'

like(__reentrant: tuple = ()) -> Any

Accept strings and bytes as input.

__call__(value: Any) -> STR

Convert the value to a string.

ToRegexMatch(pattern: str | Pattern, hint: Any = UNSET, compose: bool = False)

Converter for strings that must match a regex pattern.

Parameters:

Name	Type	Description	Default
`pattern`	`str \| Pattern`	The regex pattern to match against.	required
`hint`	`Any`	The type hint to convert to.	`UNSET`
`compose`	`bool`	Whether to compose this converter with others, when they are found in `Annotated` metadata.	`False`

__call__(value: Any) -> STR

Convert the value to a string and check it matches the pattern.