Coverage for src/somesy/julia/writer.py: 81%

1"""Julia writer.""" 

2 

3import logging 

4from pathlib import Path 

5from typing import Optional, Union 

6 

7import tomlkit 

8from rich.pretty import pretty_repr 

9 

10from somesy.core.models import Entity, Person, ProjectMetadata 

11from somesy.core.writer import ProjectMetadataWriter 

12 

13from .models import JuliaConfig 

14 

15logger = logging.getLogger("somesy") 

16 

17 

18class Julia(ProjectMetadataWriter): 

19 """Julia config file handler parsed from Project.toml.""" 

20 

21 def __init__( 

22 self, 

23 path: Path, 

24 pass_validation: Optional[bool] = False, 

25 ): 

26 """Julia config file handler parsed from Project.toml. 

27 

28 See [somesy.core.writer.ProjectMetadataWriter.__init__][]. 

29 """ 

30 super().__init__( 

31 path, 

32 create_if_not_exists=False, 

33 pass_validation=pass_validation, 

34 ) 

35 

36 def _load(self) -> None: 

37 """Load Project.toml file.""" 

38 with open(self.path) as f: 

39 self._data = tomlkit.load(f) 

40 

41 def _validate(self) -> None: 

42 """Validate poetry config using pydantic class. 

43 

44 In order to preserve toml comments and structure, tomlkit library is used. 

45 Pydantic class only used for validation. 

46 """ 

47 if self.pass_validation: 

48 return 

49 config = dict(self._get_property([])) 

50 logger.debug( 

51 f"Validating config using {JuliaConfig.__name__}: {pretty_repr(config)}" 

52 ) 

53 JuliaConfig(**config) 

54 

55 def save(self, path: Optional[Path] = None) -> None: 

56 """Save the julia file.""" 

57 path = path or self.path 

58 with open(path, "w") as f: 

59 tomlkit.dump(self._data, f) 

60 

61 @staticmethod 

62 def _from_person(person: Union[Person, Entity]): 

63 """Convert project metadata person object to a name+email string.""" 

64 return person.to_name_email_string() 

65 

66 @staticmethod 

67 def _to_person(person: str) -> Optional[Person]: 

68 """Convert from free string to person or entity object.""" 

69 try: 

70 return Person.from_name_email_string(person) 

71 except (ValueError, AttributeError): 

72 logger.info(f"Cannot convert {person} to Person object, trying Entity.") 

73 

74 try: 

75 return Entity.from_name_email_string(person) 

76 except (ValueError, AttributeError): 

77 logger.warning(f"Cannot convert {person} to Entity.") 

78 return None 

79 

80 def sync(self, metadata: ProjectMetadata) -> None: 

81 """Sync output file with other metadata files.""" 

82 # overridden to not sync fields that are not present in the Project.toml file 

83 self.name = metadata.name 

84 self.version = metadata.version 

85 

86 self._sync_authors(metadata)