Skip to content

path

ExistingPathRelativeToInput = Annotated[pathlib.Path, pydantic.AfterValidator(lambda path, info: resolve_relative_path(path, info, must_exist=True))]

PlannedPathRelativeToInput = Annotated[pathlib.Path, pydantic.AfterValidator(lambda path, info: resolve_relative_path(path, info, must_exist=False)), pydantic.PlainSerializer(serialize_path)]

resolve_relative_path(path, info, *, must_exist=True)

Convert relative path to absolute path based on input file location.

Why

Users reference files like photo: profile.jpg relative to their CV YAML. This validator resolves such paths to absolute form and validates existence, enabling file access during rendering.

Example 
# In validators: photo_path = resolve_relative_path(photo, info)
# Input: "photo.jpg" in /home/user/cv.yaml
# Output: /home/user/photo.jpg (absolute, validated to exist)

Parameters:

  • path (Path) –

    Path to resolve (may be relative or absolute).

  • info (ValidationInfo) –

    Validation context containing input file path.

  • must_exist (bool, default: True ) –

    Whether to raise error if path doesn't exist.

Returns:

  • Path –

    Absolute path.

Source code in src/rendercv/schema/models/path.py 
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
def resolve_relative_path(
    path: pathlib.Path, info: pydantic.ValidationInfo, *, must_exist: bool = True
) -> pathlib.Path:
    """Convert relative path to absolute path based on input file location.

    Why:
        Users reference files like `photo: profile.jpg` relative to their CV
        YAML. This validator resolves such paths to absolute form and validates
        existence, enabling file access during rendering.

    Example:
        ```py
        # In validators: photo_path = resolve_relative_path(photo, info)
        # Input: "photo.jpg" in /home/user/cv.yaml
        # Output: /home/user/photo.jpg (absolute, validated to exist)
        ```

    Args:
        path: Path to resolve (may be relative or absolute).
        info: Validation context containing input file path.
        must_exist: Whether to raise error if path doesn't exist.

    Returns:
        Absolute path.
    """
    if path:
        input_file_path = get_input_file_path(info)
        relative_to = input_file_path.parent if input_file_path else pathlib.Path.cwd()
        if not path.is_absolute():
            path = relative_to / path

        if must_exist:
            if not path.exists():
                raise pydantic_core.PydanticCustomError(
                    CustomPydanticErrorTypes.other.value,
                    "The file `{file_path}` does not exist.",
                    {"file_path": path.relative_to(relative_to)},
                )
            if not path.is_file():
                raise pydantic_core.PydanticCustomError(
                    CustomPydanticErrorTypes.other.value,
                    "The path `{path}` is not a file.",
                    {"path": path.relative_to(relative_to)},
                )

    return path

serialize_path(path)

Source code in src/rendercv/schema/models/path.py 
59
60
def serialize_path(path: pathlib.Path) -> str:
    return str(path.relative_to(pathlib.Path.cwd()))