Coverage for fastagency/api/openapi/fastapi_code_generator_helpers.py: 100%

1from collections.abc import Iterator 9 ctx1ahfegibcd

2from contextlib import contextmanager 9 ctx1ahfegibcd

3from functools import cached_property 9 ctx1ahfegibcd

4from typing import Optional, Union 9 ctx1ahfegibcd

5 

6from fastapi_code_generator.parser import ( 9 ctx1ahfegibcd

7 Argument, 

8 OpenAPIParser, 

9 ParameterObject, 

10 ReferenceObject, 

11) 

12 

13 

14class ArgumentWithDescription(Argument): # type: ignore[misc] 9 ctx1ahfegibcd

15 description: Optional[str] = None 9 ctx1ahfegibcd

16 

17 @cached_property 9 ctx1ahfegibcd

18 def argument(self) -> str: 9 ctx1ahfegibcd

19 if self.description: 7 ctx1afegbcd

20 description = self.description.replace('"""', '"""') 6 ctx1aegbcd

21 type_hint = f'Annotated[{self.type_hint}, """{description}"""]' 6 ctx1aegbcd

22 else: 

23 type_hint = self.type_hint 5 ctx1afbcd

24 

25 if self.default is None and self.required: 7 ctx1afegbcd

26 return f"{self.name}: {type_hint}" 7 ctx1afegbcd

27 

28 return f"{self.name}: {type_hint} = {self.default}" 6 ctx1afebcd

29 

30 

31@contextmanager 9 ctx1ahfegibcd

32def patch_get_parameter_type() -> Iterator[None]: 9 ctx1ahfegibcd

33 original_get_parameter_type = OpenAPIParser.get_parameter_type 7 ctx1afegbcd

34 

35 def get_parameter_type( 7 ctx1afegbcd

36 self: OpenAPIParser, 

37 parameters: Union[ReferenceObject, ParameterObject], 

38 snake_case: bool, 

39 path: list[str], 

40 ) -> Optional[Argument]: 

41 # get the original argument 

42 argument = original_get_parameter_type(self, parameters, snake_case, path) 7 ctx1afegbcd

43 

44 # add description to the argument 

45 parameters = self.resolve_object(parameters, ParameterObject) 7 ctx1afegbcd

46 argument_with_description = ArgumentWithDescription( 7 ctx1afegbcd

47 description=parameters.description, **argument.model_dump() 

48 ) 

49 return argument_with_description 7 ctx1afegbcd

50 

51 OpenAPIParser.get_parameter_type = get_parameter_type 7 ctx1afegbcd

52 

53 try: 7 ctx1afegbcd

54 yield 7 ctx1afegbcd

55 finally: 

56 OpenAPIParser.get_parameter_type = original_get_parameter_type 7 ctx1afegbcd