Coverage for src / rendercv / schema / models / cv / entries / publication.py: 100%

1import functools (empty)

2from typing import Self (empty)

3 

4import pydantic (empty)

5 

6from .bases.entry import BaseEntry (empty)

7from .bases.entry_with_date import BaseEntryWithDate (empty)

8 

9url_validator = pydantic.TypeAdapter[pydantic.HttpUrl](pydantic.HttpUrl) (empty)

10 

11 

12class BasePublicationEntry(BaseEntry): (empty)

13 title: str = pydantic.Field( (empty)

14 examples=[ 

15 "Deep Learning for Computer Vision", 

16 "Advances in Quantum Computing", 

17 ], 

18 ) 

19 authors: list[str] = pydantic.Field( (empty)

20 description="You can bold your name with **double asterisks**.", 

21 examples=[["John Doe", "**Jane Smith**", "Bob Johnson"]], 

22 ) 

23 summary: str | None = pydantic.Field( (empty)

24 default=None, 

25 examples=["This paper presents a new method for computer vision."], 

26 ) 

27 doi: str | None = pydantic.Field( (empty)

28 default=None, 

29 description=( 

30 "The DOI (Digital Object Identifier). If provided, it will be used as the" 

31 " link instead of the URL." 

32 ), 

33 examples=["10.48550/arXiv.2310.03138"], 

34 pattern=r"\b10\..*", 

35 ) 

36 url: pydantic.HttpUrl | None = pydantic.Field( (empty)

37 default=None, 

38 description="A URL link to the publication. Ignored if DOI is provided.", 

39 ) 

40 journal: str | None = pydantic.Field( (empty)

41 default=None, 

42 description="The journal, conference, or venue where it was published.", 

43 examples=["Nature", "IEEE Conference on Computer Vision", "arXiv preprint"], 

44 ) 

45 

46 @pydantic.model_validator(mode="after") (empty)

47 def ignore_url_if_doi_is_given(self) -> Self: (empty)

48 """Prioritize DOI over custom URL when both provided. 

49 

50 Why: 

51 DOI is canonical, stable identifier for publications. When provided, 

52 ignore user's URL to ensure templates use official DOI link. 

53 

54 Returns: 

55 Publication instance with url cleared if DOI exists. 

56 """ 

57 doi_is_provided = self.doi is not None (empty)

58 

59 if doi_is_provided: (empty)

60 self.url = None (empty)

61 

62 return self (empty)

63 

64 @pydantic.model_validator(mode="after") (empty)

65 def validate_doi_url(self) -> Self: (empty)

66 """Validate generated DOI URL is well-formed. 

67 

68 Why: 

69 DOI URL generation from DOI string might produce invalid URLs. 

70 Post-validation ensures generated URLs are valid. 

71 

72 Returns: 

73 Validated publication instance. 

74 """ 

75 if self.doi_url: (empty)

76 url_validator.validate_strings(self.doi_url) (empty)

77 

78 return self (empty)

79 

80 @functools.cached_property (empty)

81 def doi_url(self) -> str | None: (empty)

82 """Generate DOI URL from DOI identifier. 

83 

84 Why: 

85 DOI identifiers need https://doi.org/ prefix for linking. 

86 Property generates complete URL from DOI string. 

87 

88 Returns: 

89 Complete DOI URL, or None if no DOI provided. 

90 """ 

91 doi_is_provided = self.doi is not None (empty)

92 

93 if doi_is_provided: (empty)

94 return f"https://doi.org/{self.doi}" (empty)

95 

96 return None (empty)

97 

98 

99# This approach ensures PublicationEntryBase keys appear first in the key order: 

100class PublicationEntry(BaseEntryWithDate, BasePublicationEntry): (empty)

101 pass (empty)