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

1import re (empty)

2from datetime import date as Date (empty)

3from typing import Annotated, Literal, Self (empty)

4 

5import pydantic (empty)

6import pydantic_core (empty)

7 

8from rendercv.exception import RenderCVInternalError (empty)

9 

10from .....pydantic_error_handling import CustomPydanticErrorTypes (empty)

11from ....validation_context import get_current_date (empty)

12from .entry_with_date import BaseEntryWithDate (empty)

13 

14 

15def validate_exact_date(date: str | int) -> str | int: (empty)

16 """Validate date conforms to strict format requirements. 

17 

18 Why: 

19 start_date/end_date need strict formats for date arithmetic (calculating 

20 duration). Unlike arbitrary dates, these must parse to actual Date objects 

21 for comparison and duration rendering. 

22 

23 Args: 

24 date: Date value to validate. 

25 

26 Returns: 

27 Original date if valid. 

28 """ 

29 try: (empty)

30 get_date_object(date) (empty)

31 except RenderCVInternalError as e: (empty)

32 raise pydantic_core.PydanticCustomError( (empty)

33 CustomPydanticErrorTypes.other.value, 

34 "This is not a valid date! Please use either YYYY-MM-DD, YYYY-MM, or YYYY" 

35 " format.", 

36 ) from e 

37 return date (empty)

38 

39 

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

41 

42 

43def get_date_object(date: str | int, current_date: Date | None = None) -> Date: (empty)

44 """Convert date string/int to Python Date object. 

45 

46 Why: 

47 Date arithmetic (start/end comparison, duration calculation) requires 

48 Python Date objects. This parser handles multiple formats including 

49 "present" keyword for ongoing positions. 

50 

51 Example: 

52 ```py 

53 date_obj = get_date_object("2023-05", Date(2025, 1, 1)) 

54 # Returns Date(2023, 5, 1) 

55 

56 present_obj = get_date_object("present", Date(2025, 1, 1)) 

57 # Returns Date(2025, 1, 1) 

58 ``` 

59 

60 Args: 

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

62 current_date: Reference date for "present" keyword. 

63 

64 Returns: 

65 Python Date object. 

66 """ 

67 if isinstance(date, int): (empty)

68 date_object = Date(date, 1, 1) (empty)

69 elif re.fullmatch(r"\d{4}-\d{2}-\d{2}", date): (empty)

70 # Then it is in YYYY-MM-DD format 

71 date_object = Date.fromisoformat(date) (empty)

72 elif re.fullmatch(r"\d{4}-\d{2}", date): (empty)

73 # Then it is in YYYY-MM format 

74 date_object = Date.fromisoformat(f"{date}-01") (empty)

75 elif re.fullmatch(r"\d{4}", date): (empty)

76 # Then it is in YYYY format 

77 date_object = Date.fromisoformat(f"{date}-01-01") (empty)

78 elif date == "present": (empty)

79 if current_date is None: (empty)

80 raise RenderCVInternalError( (empty)

81 "current_date is None when processing 'present' date" 

82 ) 

83 date_object = current_date (empty)

84 else: 

85 raise RenderCVInternalError("This is not a valid date!") (empty)

86 

87 return date_object (empty)

88 

89 

90class BaseEntryWithComplexFields(BaseEntryWithDate): (empty)

91 model_config = pydantic.ConfigDict(json_schema_extra={"description": None}) (empty)

92 

93 start_date: ExactDate | None = pydantic.Field( (empty)

94 default=None, 

95 description="The start date in YYYY-MM-DD, YYYY-MM, or YYYY format.", 

96 examples=["2020-09-24", "2020-09", "2020"], 

97 ) 

98 end_date: ExactDate | Literal["present"] | None = pydantic.Field( (empty)

99 default=None, 

100 description=( 

101 'The end date in YYYY-MM-DD, YYYY-MM, or YYYY format. Use "present" for' 

102 " ongoing events, or omit it to indicate the event is ongoing." 

103 ), 

104 examples=["2024-05-20", "2024-05", "2024", "present"], 

105 ) 

106 location: str | None = pydantic.Field( (empty)

107 default=None, 

108 examples=["Istanbul, Türkiye", "New York, NY", "Remote"], 

109 ) 

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

111 default=None, 

112 examples=[ 

113 "Led a team of 5 engineers to develop innovative solutions.", 

114 ( 

115 "Completed advanced coursework in machine learning and artificial" 

116 " intelligence." 

117 ), 

118 ], 

119 ) 

120 highlights: list[str] | None = pydantic.Field( (empty)

121 default=None, 

122 description=( 

123 "Bullet points for key achievements, responsibilities, or contributions." 

124 ), 

125 examples=[ 

126 [ 

127 "Increased system performance by 40% through optimization.", 

128 "Mentored 3 junior developers and conducted code reviews.", 

129 "Implemented CI/CD pipeline reducing deployment time by 60%.", 

130 ] 

131 ], 

132 ) 

133 

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

135 def check_and_adjust_dates(self, info: pydantic.ValidationInfo) -> Self: (empty)

136 date_is_provided = self.date is not None (empty)

137 start_date_is_provided = self.start_date is not None (empty)

138 end_date_is_provided = self.end_date is not None (empty)

139 

140 if date_is_provided: (empty)

141 # If only date is provided, ignore start_date and end_date: 

142 self.start_date = None (empty)

143 self.end_date = None (empty)

144 elif not start_date_is_provided and end_date_is_provided: (empty)

145 # If only end_date is provided, assume it is a one-day event and act like 

146 # only the date is provided: 

147 self.date = self.end_date (empty)

148 self.start_date = None (empty)

149 self.end_date = None (empty)

150 elif start_date_is_provided and not end_date_is_provided: (empty)

151 # If only start_date is provided, assume it is an ongoing event, i.e., the 

152 # end_date is present: 

153 self.end_date = "present" (empty)

154 

155 if self.start_date and self.end_date: (empty)

156 # Check if the start_date is before the end_date: 

157 current_date = get_current_date(info) (empty)

158 start_date_object = get_date_object(self.start_date, current_date) (empty)

159 end_date_object = get_date_object(self.end_date, current_date) (empty)

160 if start_date_object > end_date_object: (empty)

161 raise pydantic_core.PydanticCustomError( (empty)

162 CustomPydanticErrorTypes.other.value, 

163 "`start_date` cannot be after `end_date`. The `start_date` is" 

164 " {start_date} and the `end_date` is {end_date}.", 

165 { 

166 "start_date": self.start_date, 

167 "end_date": self.end_date, 

168 }, 

169 ) 

170 

171 return self (empty)