Coverage for fastapi/responses.py: 100%

1from typing import Any 5 ctx1abcde

2 

3from starlette.responses import FileResponse as FileResponse # noqa 5 ctx1abcde

4from starlette.responses import HTMLResponse as HTMLResponse # noqa 5 ctx1abcde

5from starlette.responses import JSONResponse as JSONResponse # noqa 5 ctx1abcde

6from starlette.responses import PlainTextResponse as PlainTextResponse # noqa 5 ctx1abcde

7from starlette.responses import RedirectResponse as RedirectResponse # noqa 5 ctx1abcde

8from starlette.responses import Response as Response # noqa 5 ctx1abcde

9from starlette.responses import StreamingResponse as StreamingResponse # noqa 5 ctx1abcde

10 

11try: 5 ctx1abcde

12 import ujson 5 ctx1abcde

13except ImportError: # pragma: nocover 

14 ujson = None # type: ignore 

15 

16 

17try: 5 ctx1abcde

18 import orjson 5 ctx1abcde

19except ImportError: # pragma: nocover 

20 orjson = None # type: ignore 

21 

22 

23class UJSONResponse(JSONResponse): 5 ctx1abcde

24 """ 

25 JSON response using the high-performance ujson library to serialize data to JSON. 

26 

27 Read more about it in the 

28 [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/). 

29 """ 

30 

31 def render(self, content: Any) -> bytes: 5 ctx1abcde

32 assert ujson is not None, "ujson must be installed to use UJSONResponse" 5 ctx1abcde

33 return ujson.dumps(content, ensure_ascii=False).encode("utf-8") 5 ctx1abcde

34 

35 

36class ORJSONResponse(JSONResponse): 5 ctx1abcde

37 """ 

38 JSON response using the high-performance orjson library to serialize data to JSON. 

39 

40 Read more about it in the 

41 [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/). 

42 """ 

43 

44 def render(self, content: Any) -> bytes: 5 ctx1abcde

45 assert orjson is not None, "orjson must be installed to use ORJSONResponse" 5 ctx1abcde

46 return orjson.dumps( 5 ctx1abcde

47 content, option=orjson.OPT_NON_STR_KEYS | orjson.OPT_SERIALIZE_NUMPY 

48 )