Skip to content

education

BaseEducationEntry

Bases: BaseEntry

Education entry fields without date and complex fields.

Why

Separating education-specific fields (institution, area, degree) from date/location fields enables EducationEntry to inherit from both this class and BaseEntryWithComplexFields, controlling field ordering in the final model so institution/area/degree appear before dates.

area = pydantic.Field(description='Field of study or major.', examples=['Mechanical Engineering', 'Computer Science', 'Electrical Engineering']) class-attribute instance-attribute

degree = pydantic.Field(default=None, examples=['BS', 'BA', 'PhD', 'MS']) class-attribute instance-attribute

entry_type_in_snake_case cached property

Convert class name to snake_case for template attribute lookup.

Why

Template collections store entry templates keyed by snake_case entry type names (e.g., education_entry). This property enables dynamic lookup from the class name.

Returns:

  • str –

    Snake_case version of the entry class name.

institution = pydantic.Field(examples=['Boğaziçi University', 'MIT', 'Harvard University']) class-attribute instance-attribute

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

EducationEntry

Bases: BaseEntryWithComplexFields, BaseEducationEntry

area = pydantic.Field(description='Field of study or major.', examples=['Mechanical Engineering', 'Computer Science', 'Electrical Engineering']) class-attribute instance-attribute

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

degree = pydantic.Field(default=None, examples=['BS', 'BA', 'PhD', 'MS']) 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

Convert class name to snake_case for template attribute lookup.

Why

Template collections store entry templates keyed by snake_case entry type names (e.g., education_entry). This property enables dynamic lookup from the class name.

Returns:

  • str –

    Snake_case version of the entry class name.

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

institution = pydantic.Field(examples=['Boğaziçi University', 'MIT', 'Harvard University']) 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 
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
169
170
171
@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