Coverage for tests/test_inherited_custom_class.py: 100%

1import uuid 5 ctx1abcde

2 

3import pytest 5 ctx1abcde

4from fastapi import FastAPI 5 ctx1abcde

5from fastapi.testclient import TestClient 5 ctx1abcde

6from pydantic import BaseModel 5 ctx1abcde

7 

8from .utils import needs_pydanticv1, needs_pydanticv2 5 ctx1abcde

9 

10 

11class MyUuid: 5 ctx1abcde

12 def __init__(self, uuid_string: str): 5 ctx1abcde

13 self.uuid = uuid_string 5 ctx1abcde

14 

15 def __str__(self): 5 ctx1abcde

16 return self.uuid 5 ctx1abcde

17 

18 @property # type: ignore 5 ctx1abcde

19 def __class__(self): 5 ctx1abcde

20 return uuid.UUID 5 ctx1abcde

21 

22 @property 5 ctx1abcde

23 def __dict__(self): 5 ctx1abcde

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") 5 ctx1abcde

27 

28 

29@needs_pydanticv2 5 ctx1abcde

30def test_pydanticv2(): 5 ctx1abcde

31 from pydantic import field_serializer 5 ctx1abcde

32 

33 app = FastAPI() 5 ctx1abcde

34 

35 @app.get("/fast_uuid") 5 ctx1abcde

36 def return_fast_uuid(): 5 ctx1abcde

37 asyncpg_uuid = MyUuid("a10ff360-3b1e-4984-a26f-d3ab460bdb51") 5 ctx1abcde

38 assert isinstance(asyncpg_uuid, uuid.UUID) 5 ctx1abcde

39 assert type(asyncpg_uuid) != uuid.UUID 5 ctx1abcde

40 with pytest.raises(TypeError): 5 ctx1abcde

41 vars(asyncpg_uuid) 5 ctx1abcde

42 return {"fast_uuid": asyncpg_uuid} 5 ctx1abcde

43 

44 class SomeCustomClass(BaseModel): 5 ctx1abcde

45 model_config = {"arbitrary_types_allowed": True} 5 ctx1abcde

46 

47 a_uuid: MyUuid 5 ctx1abcde

48 

49 @field_serializer("a_uuid") 5 ctx1abcde

50 def serialize_a_uuid(self, v): 5 ctx1abcde

51 return str(v) 5 ctx1abcde

52 

53 @app.get("/get_custom_class") 5 ctx1abcde

54 def return_some_user(): 5 ctx1abcde

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

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

57 

58 client = TestClient(app) 5 ctx1abcde

59 

60 with client: 5 ctx1abcde

61 response_simple = client.get("/fast_uuid") 5 ctx1abcde

62 response_pydantic = client.get("/get_custom_class") 5 ctx1abcde

63 

64 assert response_simple.json() == { 5 ctx1abcde

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

66 } 

67 

68 assert response_pydantic.json() == { 5 ctx1abcde

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

70 } 

71 

72 

73# TODO: remove when deprecating Pydantic v1 

74@needs_pydanticv1 5 ctx1abcde

75def test_pydanticv1(): 5 ctx1abcde

76 app = FastAPI() 5 ctx1abcde

77 

78 @app.get("/fast_uuid") 5 ctx1abcde

79 def return_fast_uuid(): 5 ctx1abcde

80 asyncpg_uuid = MyUuid("a10ff360-3b1e-4984-a26f-d3ab460bdb51") 5 ctx1abcde

81 assert isinstance(asyncpg_uuid, uuid.UUID) 5 ctx1abcde

82 assert type(asyncpg_uuid) != uuid.UUID 5 ctx1abcde

83 with pytest.raises(TypeError): 5 ctx1abcde

84 vars(asyncpg_uuid) 5 ctx1abcde

85 return {"fast_uuid": asyncpg_uuid} 5 ctx1abcde

86 

87 class SomeCustomClass(BaseModel): 5 ctx1abcde

88 class Config: 5 ctx1abcde

89 arbitrary_types_allowed = True 5 ctx1abcde

90 json_encoders = {uuid.UUID: str} 5 ctx1abcde

91 

92 a_uuid: MyUuid 5 ctx1abcde

93 

94 @app.get("/get_custom_class") 5 ctx1abcde

95 def return_some_user(): 5 ctx1abcde

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

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

98 

99 client = TestClient(app) 5 ctx1abcde

100 

101 with client: 5 ctx1abcde

102 response_simple = client.get("/fast_uuid") 5 ctx1abcde

103 response_pydantic = client.get("/get_custom_class") 5 ctx1abcde

104 

105 assert response_simple.json() == { 5 ctx1abcde

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

107 } 

108 

109 assert response_pydantic.json() == { 5 ctx1abcde

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

111 }