Coverage for tests / test_ambiguous_params.py: 100%

1from typing import Annotated 4 ctx1efgh

2 

3import pytest 4 ctx1efgh

4from fastapi import Depends, FastAPI, Path 4 ctx1efgh

5from fastapi.param_functions import Query 4 ctx1efgh

6from fastapi.testclient import TestClient 4 ctx1efgh

7 

8app = FastAPI() 4 ctx1efgh

9 

10 

11def test_no_annotated_defaults(): 4 ctx1efgh

12 with pytest.raises( 4 ctx1ijkl

13 AssertionError, match="Path parameters cannot have a default value" 

14 ): 

15 

16 @app.get("/items/{item_id}/") 4 ctx1ijkl

17 async def get_item(item_id: Annotated[int, Path(default=1)]): 4 ctx1ijkl

18 pass # pragma: nocover 

19 

20 with pytest.raises( 4 ctx1ijkl

21 AssertionError, 

22 match=( 

23 "`Query` default value cannot be set in `Annotated` for 'item_id'. Set the" 

24 " default value with `=` instead." 

25 ), 

26 ): 

27 

28 @app.get("/") 4 ctx1ijkl

29 async def get(item_id: Annotated[int, Query(default=1)]): 4 ctx1ijkl

30 pass # pragma: nocover 

31 

32 

33def test_multiple_annotations(): 4 ctx1efgh

34 async def dep(): 4 ctx1abcd

35 pass # pragma: nocover 

36 

37 @app.get("/multi-query") 4 ctx1abcd

38 async def get(foo: Annotated[int, Query(gt=2), Query(lt=10)]): 4 ctx1abcd

39 return foo 4 ctx1abcd

40 

41 with pytest.raises( 4 ctx1abcd

42 AssertionError, 

43 match=( 

44 "Cannot specify `Depends` in `Annotated` and default value" 

45 " together for 'foo'" 

46 ), 

47 ): 

48 

49 @app.get("/") 4 ctx1abcd

50 async def get2(foo: Annotated[int, Depends(dep)] = Depends(dep)): 4 ctx1abcd

51 pass # pragma: nocover 

52 

53 with pytest.raises( 4 ctx1abcd

54 AssertionError, 

55 match=( 

56 "Cannot specify a FastAPI annotation in `Annotated` and `Depends` as a" 

57 " default value together for 'foo'" 

58 ), 

59 ): 

60 

61 @app.get("/") 4 ctx1abcd

62 async def get3(foo: Annotated[int, Query(min_length=1)] = Depends(dep)): 4 ctx1abcd

63 pass # pragma: nocover 

64 

65 client = TestClient(app) 4 ctx1abcd

66 response = client.get("/multi-query", params={"foo": "5"}) 4 ctx1abcd

67 assert response.status_code == 200 4 ctx1abcd

68 assert response.json() == 5 4 ctx1abcd

69 

70 response = client.get("/multi-query", params={"foo": "123"}) 4 ctx1abcd

71 assert response.status_code == 422 4 ctx1abcd

72 

73 response = client.get("/multi-query", params={"foo": "1"}) 4 ctx1abcd

74 assert response.status_code == 422 4 ctx1abcd