Skip to content

entry_with_complex_fields

ExactDate = Annotated[str | int, pydantic.AfterValidator(validate_exact_date)]

BaseEntryWithComplexFields

Bases: BaseEntryWithDate

date = pydantic.Field(default=None, description="The date of this event in YYYY-MM-DD, YYYY-MM, or YYYY format, or any custom text like 'Fall 2023'. Use this for single-day or imprecise dates. For date ranges, use `start_date` and `end_date` instead.", examples=['2020-09-24', '2020-09', '2020', 'Fall 2023', 'Summer 2020']) class-attribute instance-attribute

end_date = pydantic.Field(default=None, description='The end date in YYYY-MM-DD, YYYY-MM, or YYYY format. Use "present" for ongoing events, or omit it to indicate the event is ongoing.', examples=['2024-05-20', '2024-05', '2024', 'present']) class-attribute instance-attribute

entry_type_in_snake_case cached property

highlights = pydantic.Field(default=None, description='Bullet points for key achievements, responsibilities, or contributions.', examples=[['Increased system performance by 40% through optimization.', 'Mentored 3 junior developers and conducted code reviews.', 'Implemented CI/CD pipeline reducing deployment time by 60%.']]) class-attribute instance-attribute

location = pydantic.Field(default=None, examples=['Istanbul, Türkiye', 'New York, NY', 'Remote']) class-attribute instance-attribute

model_config = pydantic.ConfigDict(json_schema_extra={'description': None}) class-attribute instance-attribute

start_date = pydantic.Field(default=None, description='The start date in YYYY-MM-DD, YYYY-MM, or YYYY format.', examples=['2020-09-24', '2020-09', '2020']) class-attribute instance-attribute

summary = pydantic.Field(default=None, examples=['Led a team of 5 engineers to develop innovative solutions.', 'Completed advanced coursework in machine learning and artificial intelligence.']) class-attribute instance-attribute

check_and_adjust_dates(info)

Source code in src/rendercv/schema/models/cv/entries/bases/entry_with_complex_fields.py 
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
@pydantic.model_validator(mode="after")
def check_and_adjust_dates(self, info: pydantic.ValidationInfo) -> Self:
    date_is_provided = self.date is not None
    start_date_is_provided = self.start_date is not None
    end_date_is_provided = self.end_date is not None

    if date_is_provided:
        # If only date is provided, ignore start_date and end_date:
        self.start_date = None
        self.end_date = None
    elif not start_date_is_provided and end_date_is_provided:
        # If only end_date is provided, assume it is a one-day event and act like
        # only the date is provided:
        self.date = self.end_date
        self.start_date = None
        self.end_date = None
    elif start_date_is_provided and not end_date_is_provided:
        # If only start_date is provided, assume it is an ongoing event, i.e., the
        # end_date is present:
        self.end_date = "present"

    if self.start_date and self.end_date:
        # Check if the start_date is before the end_date:
        current_date = get_current_date(info)
        start_date_object = get_date_object(self.start_date, current_date)
        end_date_object = get_date_object(self.end_date, current_date)
        if start_date_object > end_date_object:
            raise pydantic_core.PydanticCustomError(
                CustomPydanticErrorTypes.other.value,
                "`start_date` cannot be after `end_date`. The `start_date` is"
                " {start_date} and the `end_date` is {end_date}.",
                {
                    "start_date": self.start_date,
                    "end_date": self.end_date,
                },
            )

    return self

get_date_object(date, current_date=None)

Convert date string/int to Python Date object.

Why

Date arithmetic (start/end comparison, duration calculation) requires Python Date objects. This parser handles multiple formats including "present" keyword for ongoing positions.

Example 
date_obj = get_date_object("2023-05", Date(2025, 1, 1))
# Returns Date(2023, 5, 1)

present_obj = get_date_object("present", Date(2025, 1, 1))
# Returns Date(2025, 1, 1)

Parameters:

  • date (str | int) –

    Date in YYYY-MM-DD, YYYY-MM, YYYY format, or "present".

  • current_date (date | None, default: None ) –

    Reference date for "present" keyword.

Returns:

  • date –

    Python Date object.

Source code in src/rendercv/schema/models/cv/entries/bases/entry_with_complex_fields.py 
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
def get_date_object(date: str | int, current_date: Date | None = None) -> Date:
    """Convert date string/int to Python Date object.

    Why:
        Date arithmetic (start/end comparison, duration calculation) requires
        Python Date objects. This parser handles multiple formats including
        "present" keyword for ongoing positions.

    Example:
        ```py
        date_obj = get_date_object("2023-05", Date(2025, 1, 1))
        # Returns Date(2023, 5, 1)

        present_obj = get_date_object("present", Date(2025, 1, 1))
        # Returns Date(2025, 1, 1)
        ```

    Args:
        date: Date in YYYY-MM-DD, YYYY-MM, YYYY format, or "present".
        current_date: Reference date for "present" keyword.

    Returns:
        Python Date object.
    """
    if isinstance(date, int):
        date_object = Date.fromisoformat(f"{date}-01-01")
    elif re.fullmatch(r"\d{4}-\d{2}-\d{2}", date):
        # Then it is in YYYY-MM-DD format
        date_object = Date.fromisoformat(date)
    elif re.fullmatch(r"\d{4}-\d{2}", date):
        # Then it is in YYYY-MM format
        date_object = Date.fromisoformat(f"{date}-01")
    elif re.fullmatch(r"\d{4}", date):
        # Then it is in YYYY format
        date_object = Date.fromisoformat(f"{date}-01-01")
    elif date == "present":
        assert current_date is not None
        date_object = current_date
    else:
        raise RenderCVInternalError("This is not a valid date!")

    return date_object

validate_exact_date(date)

Validate date conforms to strict format requirements.

Why

start_date/end_date need strict formats for date arithmetic (calculating duration). Unlike arbitrary dates, these must parse to actual Date objects for comparison and duration rendering.

Parameters:

  • date (str | int) –

    Date value to validate.

Returns:

  • str | int –

    Original date if valid.

Source code in src/rendercv/schema/models/cv/entries/bases/entry_with_complex_fields.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
def validate_exact_date(date: str | int) -> str | int:
    """Validate date conforms to strict format requirements.

    Why:
        start_date/end_date need strict formats for date arithmetic (calculating
        duration). Unlike arbitrary dates, these must parse to actual Date objects
        for comparison and duration rendering.

    Args:
        date: Date value to validate.

    Returns:
        Original date if valid.
    """
    try:
        get_date_object(date)
    except RenderCVInternalError as e:
        raise pydantic_core.PydanticCustomError(
            CustomPydanticErrorTypes.other.value,
            "This is not a valid date! Please use either YYYY-MM-DD, YYYY-MM, or YYYY"
            " format.",
        ) from e
    return date