Skip to content

typst_dimension

TypstDimension = Annotated[str, pydantic.AfterValidator(validate_typst_dimension)]

validate_typst_dimension(dimension)

Validate Typst dimension format with unit.

Why

Typst requires dimensions with explicit units (e.g., 1cm, 0.5in). Validation prevents compilation errors from missing or invalid units.

Parameters:

  • dimension (str) –

    Dimension string to validate.

Returns:

  • str –

    Original dimension if valid.

Source code in src/rendercv/schema/models/design/typst_dimension.py 
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
def validate_typst_dimension(dimension: str) -> str:
    """Validate Typst dimension format with unit.

    Why:
        Typst requires dimensions with explicit units (e.g., 1cm, 0.5in).
        Validation prevents compilation errors from missing or invalid units.

    Args:
        dimension: Dimension string to validate.

    Returns:
        Original dimension if valid.
    """
    if not re.fullmatch(r"-?\d+(?:\.\d+)?(cm|in|pt|mm|ex|em)", dimension):
        raise pydantic_core.PydanticCustomError(
            CustomPydanticErrorTypes.other.value,
            "The value must be a number followed by a unit (cm, in, pt, mm, ex, em)."
            " For example, 0.1cm.",
        )
    return dimension