eyhc
/
rendercv
mirror of https://github.com/eyhc1/rendercv.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

data_models: make date optional in `PublicationEntry`s

This commit is contained in:
Sina Atalay 2024-05-16 00:56:40 +03:00
parent 5118f431eb
commit c15afbc313
1 changed files with 16 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
rendercv/data_models.py
View File

@ -68,13 +68,11 @@ locale_catalog = {
# This type is used to validate the date fields in the data. # This type is used to validate the date fields in the data.
# See https://docs.pydantic.dev/2.5/concepts/types/#custom-types for more information # See https://docs.pydantic.dev/2.5/concepts/types/#custom-types for more information
# about custom types. # about custom types.
date_pattern_for_json_schema = r"\d{4}(-\d{2})?(-\d{2})?"
date_pattern_for_validation = r"\d{4}-\d{2}(-\d{2})?" date_pattern_for_validation = r"\d{4}-\d{2}(-\d{2})?"
RenderCVDate = Annotated[ RenderCVDate = Annotated[
str, str,
pydantic.Field( pydantic.Field(
pattern=date_pattern_for_validation, pattern=date_pattern_for_validation,
json_schema_extra={"pattern": date_pattern_for_json_schema},
), ),
] ]
@ -187,13 +185,14 @@ class PublicationEntry(RenderCVBaseModel):
description="The DOI of the publication.", description="The DOI of the publication.",
examples=["10.48550/arXiv.2310.03138"], examples=["10.48550/arXiv.2310.03138"],
) )
date: int | RenderCVDate = pydantic.Field( date: Optional[RenderCVDate | int | str] = pydantic.Field(
title="Publication Date", default=None,
title="Date",
description=( description=(
"The date of the publication in YYYY-MM-DD, YYYY-MM, or YYYY format." "The publication date can be filled in YYYY-MM-DD, YYYY-MM, or YYYY format."
' Also, any custom date string can be used (like "Fall 2020").'
), ),
examples=["2021-10-31", "2010"], examples=["2020-09-24", "My Custom Date"],
json_schema_extra={"default": "2020-01-01"},
) )
journal: Optional[str] = pydantic.Field( journal: Optional[str] = pydantic.Field(
default=None, default=None,
@ -277,7 +276,6 @@ class EntryBase(RenderCVBaseModel):
"The start date of the event in YYYY-MM-DD, YYYY-MM, or YYYY format." "The start date of the event in YYYY-MM-DD, YYYY-MM, or YYYY format."
), ),
examples=["2020-09-24"], examples=["2020-09-24"],
json_schema_extra={"default": "2000-01-01"},
) )
end_date: Optional[Literal["present"] | int | RenderCVDate] = pydantic.Field( end_date: Optional[Literal["present"] | int | RenderCVDate] = pydantic.Field(
default=None, default=None,
@ -288,7 +286,6 @@ class EntryBase(RenderCVBaseModel):
" start_date." " start_date."
), ),
examples=["2020-09-24", "present"], examples=["2020-09-24", "present"],
json_schema_extra={"default": "2020-01-01"},
) )
date: Optional[RenderCVDate | int | str] = pydantic.Field( date: Optional[RenderCVDate | int | str] = pydantic.Field(
default=None, default=None,
@ -299,7 +296,6 @@ class EntryBase(RenderCVBaseModel):
' a custom date string (like "Fall 2020").' ' a custom date string (like "Fall 2020").'
), ),
examples=["2020-09-24", "My Custom Date"], examples=["2020-09-24", "My Custom Date"],
json_schema_extra={"default": "Custom Date or 2020-01-01"},
) )
highlights: Optional[list[str]] = pydantic.Field( highlights: Optional[list[str]] = pydantic.Field(
default=None, default=None,
@ -316,7 +312,8 @@ class EntryBase(RenderCVBaseModel):
date_is_provided = date is not None date_is_provided = date is not None
if date_is_provided: if date_is_provided:
if re.fullmatch(date_pattern_for_json_schema, date): date_pattern = r"\d{4}(-\d{2})?(-\d{2})?"
if re.fullmatch(date_pattern, date):
# Then it is in YYYY-MM-DD, YYYY-MM, or YYYY format # Then it is in YYYY-MM-DD, YYYY-MM, or YYYY format
# Check if it is a valid date: # Check if it is a valid date:
get_date_object(date) get_date_object(date)
@ -601,7 +598,6 @@ class EducationEntryBase(RenderCVBaseModel):
title="Degree", title="Degree",
description="The type of the degree.", description="The type of the degree.",
examples=["BS", "BA", "PhD", "MS"], examples=["BS", "BA", "PhD", "MS"],
json_schema_extra={"default": "PhD"},
) )
@ -810,8 +806,6 @@ SectionInput = Annotated[
# Full RenderCV data models: =========================================================== # Full RenderCV data models: ===========================================================
# ====================================================================================== # ======================================================================================
url_validator = pydantic.TypeAdapter(pydantic.HttpUrl) # type: ignore
class SocialNetwork(RenderCVBaseModel): class SocialNetwork(RenderCVBaseModel):
"""This class is the data model of a social network.""" """This class is the data model of a social network."""
@ -842,11 +836,15 @@ class SocialNetwork(RenderCVBaseModel):
return username return username
@pydantic.model_validator(mode="after") # type: ignore @pydantic.model_validator(mode="after") # type: ignore
def validate_urls(self) -> "SocialNetwork": def check_url(self) -> "SocialNetwork":
"""Validate the URLs of the social networks.""" """Validate the URLs of the social networks."""
url = self.url try:
urlopen(self.url)
url_validator.validate_strings(url) except HTTPError:
# 404 or other errors are not important for us
pass
except InvalidURL:
raise ValueError(f"This social network URL ({self.url}) is not valid!")
return self return self