muck_out.validators

HtmlStringOrNone module-attribute

HtmlStringOrNone = Annotated[
    str | None, BeforeValidator(safe_html)
]

Used for strings, which may contain html

IdFieldOrNone module-attribute

IdFieldOrNone = Annotated[
    str | None, BeforeValidator(safe_id_for_object)
]

Used for fields meant to contain an id

TransformToListOfUris module-attribute

TransformToListOfUris = Annotated[
    list[str], BeforeValidator(transform_to_list_of_uris)
]

Transforms a list of recipients, ensuring it is a list of URIs

UrlList module-attribute

UrlList = Annotated[
    list[dict[str, Any]], BeforeValidator(transform_url)
]

Transforms a list of urls