Coverage for rendercv/api/functions.py: 78%

1""" 

2The `rendercv.api.functions` package contains the basic functions that are used to 

3interact with the RenderCV. 

4""" 

5 

6import pydantic (empty)

7 

8from .. import data, renderer (empty)

9 

10 

11def create_contents_of_a_typst_file( (empty)

12 yaml_file_as_string: str, 

13) -> str | list[dict]: 

14 """ 

15 Validate the input file given as a string, generate a Typst file and return it as a 

16 string. If there are any validation errors, return them as a list of dictionaries. 

17 

18 Args: 

19 yaml_file_as_string: The input file as a string. 

20 

21 Returns: 

22 The Typst file as a string or a list of dictionaries that contain the error 

23 messages, locations, and the input values. 

24 """ 

25 

26 try: (empty)

27 input_file_as_a_dict = data.read_a_yaml_file(yaml_file_as_string) (empty)

28 data_model = data.validate_input_dictionary_and_return_the_data_model( (empty)

29 input_file_as_a_dict, 

30 ) 

31 except pydantic.ValidationError as e: 

32 return data.parse_validation_errors(e) 

33 

34 return renderer.create_contents_of_a_typst_file(data_model) (empty)