Coverage for src / rendercv / schema / json_schema_generator.py: 100%

1import json (empty)

2import pathlib (empty)

3 

4import pydantic (empty)

5import pydantic_core (empty)

6 

7from rendercv import __description__ (empty)

8 

9from .models.rendercv_model import RenderCVModel (empty)

10 

11 

12def generate_json_schema() -> dict: (empty)

13 """Generate JSON Schema (Draft-07) from RenderCV Pydantic models. 

14 

15 Why: 

16 IDEs and validators need machine-readable schema for autocompletion 

17 and real-time validation. Custom generator adds RenderCV-specific 

18 metadata like title, description, and canonical schema URL. 

19 

20 Returns: 

21 Draft-07 JSON Schema dictionary. 

22 """ 

23 

24 class RenderCVSchemaGenerator(pydantic.json_schema.GenerateJsonSchema): (empty)

25 def generate( (empty)

26 self, 

27 schema: pydantic_core.CoreSchema, 

28 mode: pydantic.json_schema.JsonSchemaMode = "validation", 

29 ) -> pydantic.json_schema.JsonSchemaValue: 

30 json_schema = super().generate(schema, mode=mode) (empty)

31 json_schema["title"] = "RenderCV" (empty)

32 json_schema["description"] = __description__ (empty)

33 json_schema["$id"] = ( (empty)

34 "https://raw.githubusercontent.com/rendercv/rendercv/main/schema.json" 

35 ) 

36 json_schema["$schema"] = "http://json-schema.org/draft-07/schema#" (empty)

37 return json_schema (empty)

38 

39 return RenderCVModel.model_json_schema(schema_generator=RenderCVSchemaGenerator) (empty)

40 

41 

42def generate_json_schema_file(json_schema_path: pathlib.Path) -> None: (empty)

43 """Generate and save JSON Schema to file. 

44 

45 Args: 

46 json_schema_path: Target file path for schema output. 

47 """ 

48 schema = generate_json_schema() (empty)

49 schema_json = json.dumps(schema, indent=2, ensure_ascii=False) (empty)

50 json_schema_path.write_text(schema_json, encoding="utf-8") (empty)