Coverage for faststream / specification / asyncapi / v2_6_0 / schema / docs.py: 88%

1from typing import Any, cast, overload (empty)

2 

3from pydantic import AnyHttpUrl, BaseModel (empty)

4from typing_extensions import Self (empty)

5 

6from faststream._internal._compat import PYDANTIC_V2 (empty)

7from faststream._internal.utils.data import filter_by_dict (empty)

8from faststream.specification.schema.extra import ( (empty)

9 ExternalDocs as SpecDocs, 

10 ExternalDocsDict, 

11) 

12 

13 

14class ExternalDocs(BaseModel): (empty)

15 """A class to represent external documentation. 

16 

17 Attributes: 

18 url : URL of the external documentation 

19 description : optional description of the external documentation 

20 """ 

21 

22 url: AnyHttpUrl (empty)

23 # Use default values to be able build from dict 

24 description: str | None = None (empty)

25 

26 if PYDANTIC_V2: 26 ↛ 31line 26 didn't jump to line 31 because the condition on line 26 was always true(empty)

27 model_config = {"extra": "allow"} (empty)

28 

29 else: 

30 

31 class Config: 

32 extra = "allow" 

33 

34 @overload (empty)

35 @classmethod (empty)

36 def from_spec(cls, docs: None) -> None: ... (empty)

37 

38 @overload (empty)

39 @classmethod (empty)

40 def from_spec(cls, docs: SpecDocs) -> Self: ... (empty)

41 

42 @overload (empty)

43 @classmethod (empty)

44 def from_spec(cls, docs: ExternalDocsDict) -> Self: ... (empty)

45 

46 @overload (empty)

47 @classmethod (empty)

48 def from_spec(cls, docs: dict[str, Any]) -> dict[str, Any]: ... (empty)

49 

50 @classmethod (empty)

51 def from_spec( (empty)

52 cls, 

53 docs: SpecDocs | ExternalDocsDict | dict[str, Any] | None, 

54 ) -> Self | dict[str, Any] | None: 

55 if docs is None: (empty)

56 return None (empty)

57 

58 if isinstance(docs, SpecDocs): (empty)

59 return cls(url=docs.url, description=docs.description) (empty)

60 

61 docs = cast("dict[str, Any]", docs) (empty)

62 docs_data, custom_data = filter_by_dict(ExternalDocsDict, docs) (empty)

63 

64 if custom_data: (empty)

65 return docs (empty)

66 

67 return cls(**docs_data) (empty)