Coverage for rendercv/data/models/rendercv_data_model.py: 100%

1""" 

2The `rendercv.data.models.rendercv_data_model` module contains the `RenderCVDataModel` 

3data model, which is the main data model that defines the whole input file structure. 

4""" 

5 

6import pathlib (empty)

7from typing import Optional (empty)

8 

9import pydantic (empty)

10 

11from ...themes import ClassicThemeOptions (empty)

12from .base import RenderCVBaseModelWithoutExtraKeys (empty)

13from .curriculum_vitae import CurriculumVitae (empty)

14from .design import RenderCVDesign (empty)

15from .locale import Locale (empty)

16from .rendercv_settings import RenderCVSettings (empty)

17 

18INPUT_FILE_DIRECTORY: Optional[pathlib.Path] = None (empty)

19 

20 

21class RenderCVDataModel(RenderCVBaseModelWithoutExtraKeys): (empty)

22 """This class binds both the CV and the design information together.""" 

23 

24 # `cv` is normally required, but don't enforce it in JSON Schema to allow 

25 # `design` or `locale` fields to have individual YAML files. 

26 model_config = pydantic.ConfigDict(json_schema_extra={"required": []}) (empty)

27 cv: CurriculumVitae = pydantic.Field( (empty)

28 title="Curriculum Vitae", 

29 description="The data of the CV.", 

30 ) 

31 design: RenderCVDesign = pydantic.Field( (empty)

32 default=ClassicThemeOptions(theme="classic"), 

33 title="Design", 

34 description=( 

35 "The design information of the CV. The default is the classic theme." 

36 ), 

37 ) 

38 locale: Locale = pydantic.Field( (empty)

39 default=None, # type: ignore 

40 title="Locale Catalog", 

41 description=( 

42 "The locale catalog of the CV to allow the support of multiple languages." 

43 ), 

44 ) 

45 rendercv_settings: RenderCVSettings = pydantic.Field( (empty)

46 default=RenderCVSettings(), 

47 title="RenderCV Settings", 

48 description="The settings of the RenderCV.", 

49 ) 

50 

51 @pydantic.model_validator(mode="before") (empty)

52 @classmethod (empty)

53 def update_paths( (empty)

54 cls, model, info: pydantic.ValidationInfo 

55 ) -> Optional[RenderCVSettings]: 

56 """Update the paths in the RenderCV settings.""" 

57 global INPUT_FILE_DIRECTORY # NOQA: PLW0603 

58 

59 context = info.context (empty)

60 if context: (empty)

61 input_file_directory = context.get("input_file_directory", None) (empty)

62 INPUT_FILE_DIRECTORY = input_file_directory (empty)

63 else: 

64 INPUT_FILE_DIRECTORY = None (empty)

65 

66 return model (empty)

67 

68 @pydantic.field_validator("locale", mode="before") (empty)

69 @classmethod (empty)

70 def update_locale(cls, value) -> Locale: (empty)

71 """Update the output folder name in the RenderCV settings.""" 

72 # Somehow, we need this for `test_if_local_catalog_resets` to pass. 

73 if value is None: (empty)

74 return Locale() (empty)

75 

76 return value (empty)

77 

78 

79rendercv_data_model_fields = tuple(RenderCVDataModel.model_fields.keys()) (empty)