Coverage for tests/test_inherited_custom_class.py: 100%

1import uuid 7 ctx1nopqrst

2 

3import pytest 7 ctx1nopqrst

4from fastapi import FastAPI 7 ctx1nopqrst

5from fastapi.testclient import TestClient 7 ctx1nopqrst

6from pydantic import BaseModel 7 ctx1nopqrst

7 

8from .utils import needs_pydanticv1, needs_pydanticv2 7 ctx1nopqrst

9 

10 

11class MyUuid: 7 ctx1nopqrst

12 def __init__(self, uuid_string: str): 7 ctx1nopqrst

13 self.uuid = uuid_string 13 ctx1haibjckdlemfg

14 

15 def __str__(self): 7 ctx1nopqrst

16 return self.uuid 13 ctx1haibjckdlemfg

17 

18 @property # type: ignore 7 ctx1nopqrst

19 def __class__(self): 7 ctx1nopqrst

20 return uuid.UUID 13 ctx1haibjckdlemfg

21 

22 @property 7 ctx1nopqrst

23 def __dict__(self): 7 ctx1nopqrst

24 """Spoof a missing __dict__ by raising TypeError, this is how 

25 asyncpg.pgroto.pgproto.UUID behaves""" 

26 raise TypeError("vars() argument must have __dict__ attribute") 13 ctx1haibjckdlemfg

27 

28 

29@needs_pydanticv2 7 ctx1nopqrst

30def test_pydanticv2(): 7 ctx1nopqrst

31 from pydantic import field_serializer 7 ctx1abcdefg

32 

33 app = FastAPI() 7 ctx1abcdefg

34 

35 @app.get("/fast_uuid") 7 ctx1abcdefg

36 def return_fast_uuid(): 7 ctx1abcdefg

37 asyncpg_uuid = MyUuid("a10ff360-3b1e-4984-a26f-d3ab460bdb51") 7 ctx1abcdefg

38 assert isinstance(asyncpg_uuid, uuid.UUID) 7 ctx1abcdefg

39 assert type(asyncpg_uuid) is not uuid.UUID 7 ctx1abcdefg

40 with pytest.raises(TypeError): 7 ctx1abcdefg

41 vars(asyncpg_uuid) 7 ctx1abcdefg

42 return {"fast_uuid": asyncpg_uuid} 7 ctx1abcdefg

43 

44 class SomeCustomClass(BaseModel): 7 ctx1abcdefg

45 model_config = {"arbitrary_types_allowed": True} 7 ctx1abcdefg

46 

47 a_uuid: MyUuid 7 ctx1abcdefg

48 

49 @field_serializer("a_uuid") 7 ctx1abcdefg

50 def serialize_a_uuid(self, v): 7 ctx1abcdefg

51 return str(v) 7 ctx1abcdefg

52 

53 @app.get("/get_custom_class") 7 ctx1abcdefg

54 def return_some_user(): 7 ctx1abcdefg

55 # Test that the fix also works for custom pydantic classes 

56 return SomeCustomClass(a_uuid=MyUuid("b8799909-f914-42de-91bc-95c819218d01")) 7 ctx1abcdefg

57 

58 client = TestClient(app) 7 ctx1abcdefg

59 

60 with client: 7 ctx1abcdefg

61 response_simple = client.get("/fast_uuid") 7 ctx1abcdefg

62 response_pydantic = client.get("/get_custom_class") 7 ctx1abcdefg

63 

64 assert response_simple.json() == { 7 ctx1abcdefg

65 "fast_uuid": "a10ff360-3b1e-4984-a26f-d3ab460bdb51" 

66 } 

67 

68 assert response_pydantic.json() == { 7 ctx1abcdefg

69 "a_uuid": "b8799909-f914-42de-91bc-95c819218d01" 

70 } 

71 

72 

73# TODO: remove when deprecating Pydantic v1 

74@needs_pydanticv1 7 ctx1nopqrst

75def test_pydanticv1(): 7 ctx1nopqrst

76 app = FastAPI() 6 ctx1hijklm

77 

78 @app.get("/fast_uuid") 6 ctx1hijklm

79 def return_fast_uuid(): 6 ctx1hijklm

80 asyncpg_uuid = MyUuid("a10ff360-3b1e-4984-a26f-d3ab460bdb51") 6 ctx1hijklm

81 assert isinstance(asyncpg_uuid, uuid.UUID) 6 ctx1hijklm

82 assert type(asyncpg_uuid) is not uuid.UUID 6 ctx1hijklm

83 with pytest.raises(TypeError): 6 ctx1hijklm

84 vars(asyncpg_uuid) 6 ctx1hijklm

85 return {"fast_uuid": asyncpg_uuid} 6 ctx1hijklm

86 

87 class SomeCustomClass(BaseModel): 6 ctx1hijklm

88 class Config: 6 ctx1hijklm

89 arbitrary_types_allowed = True 6 ctx1hijklm

90 json_encoders = {uuid.UUID: str} 6 ctx1hijklm

91 

92 a_uuid: MyUuid 6 ctx1hijklm

93 

94 @app.get("/get_custom_class") 6 ctx1hijklm

95 def return_some_user(): 6 ctx1hijklm

96 # Test that the fix also works for custom pydantic classes 

97 return SomeCustomClass(a_uuid=MyUuid("b8799909-f914-42de-91bc-95c819218d01")) 6 ctx1hijklm

98 

99 client = TestClient(app) 6 ctx1hijklm

100 

101 with client: 6 ctx1hijklm

102 response_simple = client.get("/fast_uuid") 6 ctx1hijklm

103 response_pydantic = client.get("/get_custom_class") 6 ctx1hijklm

104 

105 assert response_simple.json() == { 6 ctx1hijklm

106 "fast_uuid": "a10ff360-3b1e-4984-a26f-d3ab460bdb51" 

107 } 

108 

109 assert response_pydantic.json() == { 6 ctx1hijklm

110 "a_uuid": "b8799909-f914-42de-91bc-95c819218d01" 

111 }