diff --git a/docs/en/docs/advanced/custom-response.md b/docs/en/docs/advanced/custom-response.md index 20b694ced..546adad2a 100644 --- a/docs/en/docs/advanced/custom-response.md +++ b/docs/en/docs/advanced/custom-response.md @@ -198,14 +198,24 @@ Takes an async generator or a normal generator/iterator and streams the response #### Using `StreamingResponse` with file-like objects -If you have a file-like object (e.g. the object returned by `open()`), you can return it in a `StreamingResponse`. +If you have a file-like object (e.g. the object returned by `open()`), you can create a generator function to iterate over that file-like object. + +That way, you don't have to read it all first in memory, and you can pass that generator function to the `StreamingResponse`, and return it. This includes many libraries to interact with cloud storage, video processing, and others. -```Python hl_lines="2 10-11" +```{ .python .annotate hl_lines="2 10-12 14" } {!../../../docs_src/custom_response/tutorial008.py!} ``` +1. This is the generator function. It's a "generator function" because it contains `yield` statements inside. +2. By using a `with` block, we make sure that the file-like object is closed after the generator function is done. So, after it finishes sending the response. +3. This `yield from` tells the function to iterate over that thing named `file_like`. And then, for each part iterated, yield that part as coming from this generator function. + + So, it is a generator function that transfers the "generating" work to something else internally. + + By doing it this way, we can put it in a `with` block, and that way, ensure that it is closed after finishing. + !!! tip Notice that here as we are using standard `open()` that doesn't support `async` and `await`, we declare the path operation with normal `def`. diff --git a/docs/ja/docs/advanced/custom-response.md b/docs/ja/docs/advanced/custom-response.md index 8d23ae2fc..d8b47629a 100644 --- a/docs/ja/docs/advanced/custom-response.md +++ b/docs/ja/docs/advanced/custom-response.md @@ -179,7 +179,7 @@ HTTPリダイレクトを返します。デフォルトでは307ステータス これにはクラウドストレージとの連携や映像処理など、多くのライブラリが含まれています。 -```Python hl_lines="2 10-11" +```Python hl_lines="2 10-12 14" {!../../../docs_src/custom_response/tutorial008.py!} ``` diff --git a/docs/zh/docs/advanced/custom-response.md b/docs/zh/docs/advanced/custom-response.md index b67ef6c2e..5f1a74e9e 100644 --- a/docs/zh/docs/advanced/custom-response.md +++ b/docs/zh/docs/advanced/custom-response.md @@ -183,7 +183,7 @@ FastAPI（实际上是 Starlette）将自动包含 Content-Length 的头。它 包括许多与云存储，视频处理等交互的库。 -```Python hl_lines="2 10 11" +```Python hl_lines="2 10-12 14" {!../../../docs_src/custom_response/tutorial008.py!} ``` diff --git a/docs_src/custom_response/tutorial008.py b/docs_src/custom_response/tutorial008.py index d33273674..fc071cbee 100644 --- a/docs_src/custom_response/tutorial008.py +++ b/docs_src/custom_response/tutorial008.py @@ -7,5 +7,8 @@ app = FastAPI() @app.get("/") def main(): - file_like = open(some_file_path, mode="rb") - return StreamingResponse(file_like, media_type="video/mp4") + def iterfile(): # (1) + with open(some_file_path, mode="rb") as file_like: # (2) + yield from file_like # (3) + + return StreamingResponse(iterfile(), media_type="video/mp4") diff --git a/pyproject.toml b/pyproject.toml index dcb03504c..45880cc31 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -43,8 +43,8 @@ Documentation = "https://fastapi.tiangolo.com/" [tool.flit.metadata.requires-extra] test = [ - "pytest ==5.4.3", - "pytest-cov ==2.10.0", + "pytest >=6.2.4,<7.0.0", + "pytest-cov >=2.12.0,<3.0.0", "pytest-asyncio >=0.14.0,<0.15.0", "mypy ==0.812", "flake8 >=3.8.3,<4.0.0", @@ -99,3 +99,18 @@ all = [ [tool.isort] profile = "black" known_third_party = ["fastapi", "pydantic", "starlette"] + +[tool.pytest.ini_options] +addopts = [ + "--strict-config", + "--strict-markers", +] +xfail_strict = true +junit_family = "xunit2" +filterwarnings = [ + "error", + 'ignore:"@coroutine" decorator is deprecated since Python 3\.8, use "async def" instead:DeprecationWarning', + # TODO: if these ignores are needed, enable them, otherwise remove them + # 'ignore:The explicit passing of coroutine objects to asyncio\.wait\(\) is deprecated since Python 3\.8:DeprecationWarning', + # 'ignore:Exception ignored in. ") +def test_post_file(tmp_path): + path = tmp_path / "test.txt" + path.write_bytes(b"") client = TestClient(app) - response = client.post("/files/", files={"file": open(path, "rb")}) + with path.open("rb") as file: + response = client.post("/files/", files={"file": file}) assert response.status_code == 200, response.text assert response.json() == {"file_size": 14} -def test_post_large_file(tmpdir): +def test_post_large_file(tmp_path): default_pydantic_max_size = 2 ** 16 - path = os.path.join(tmpdir, "test.txt") - with open(path, "wb") as file: - file.write(b"x" * (default_pydantic_max_size + 1)) + path = tmp_path / "test.txt" + path.write_bytes(b"x" * (default_pydantic_max_size + 1)) client = TestClient(app) - response = client.post("/files/", files={"file": open(path, "rb")}) + with path.open("rb") as file: + response = client.post("/files/", files={"file": file}) assert response.status_code == 200, response.text assert response.json() == {"file_size": default_pydantic_max_size + 1} -def test_post_upload_file(tmpdir): - path = os.path.join(tmpdir, "test.txt") - with open(path, "wb") as file: - file.write(b"") +def test_post_upload_file(tmp_path): + path = tmp_path / "test.txt" + path.write_bytes(b"") client = TestClient(app) - response = client.post("/uploadfile/", files={"file": open(path, "rb")}) + with path.open("rb") as file: + response = client.post("/uploadfile/", files={"file": file}) assert response.status_code == 200, response.text assert response.json() == {"filename": "test.txt"} diff --git a/tests/test_tutorial/test_request_files/test_tutorial002.py b/tests/test_tutorial/test_request_files/test_tutorial002.py index 58fe4269f..4e33ef464 100644 --- a/tests/test_tutorial/test_request_files/test_tutorial002.py +++ b/tests/test_tutorial/test_request_files/test_tutorial002.py @@ -1,5 +1,3 @@ -import os - from fastapi.testclient import TestClient from docs_src.request_files.tutorial002 import app @@ -172,42 +170,40 @@ def test_post_body_json(): assert response.json() == file_required -def test_post_files(tmpdir): - path = os.path.join(tmpdir, "test.txt") - with open(path, "wb") as file: - file.write(b"") - path2 = os.path.join(tmpdir, "test2.txt") - with open(path2, "wb") as file: - file.write(b"") +def test_post_files(tmp_path): + path = tmp_path / "test.txt" + path.write_bytes(b"") + path2 = tmp_path / "test2.txt" + path2.write_bytes(b"") client = TestClient(app) - response = client.post( - "/files/", - files=( - ("files", ("test.txt", open(path, "rb"))), - ("files", ("test2.txt", open(path2, "rb"))), - ), - ) + with path.open("rb") as file, path2.open("rb") as file2: + response = client.post( + "/files/", + files=( + ("files", ("test.txt", file)), + ("files", ("test2.txt", file2)), + ), + ) assert response.status_code == 200, response.text assert response.json() == {"file_sizes": [14, 15]} -def test_post_upload_file(tmpdir): - path = os.path.join(tmpdir, "test.txt") - with open(path, "wb") as file: - file.write(b"") - path2 = os.path.join(tmpdir, "test2.txt") - with open(path2, "wb") as file: - file.write(b"") +def test_post_upload_file(tmp_path): + path = tmp_path / "test.txt" + path.write_bytes(b"") + path2 = tmp_path / "test2.txt" + path2.write_bytes(b"") client = TestClient(app) - response = client.post( - "/uploadfiles/", - files=( - ("files", ("test.txt", open(path, "rb"))), - ("files", ("test2.txt", open(path2, "rb"))), - ), - ) + with path.open("rb") as file, path2.open("rb") as file2: + response = client.post( + "/uploadfiles/", + files=( + ("files", ("test.txt", file)), + ("files", ("test2.txt", file2)), + ), + ) assert response.status_code == 200, response.text assert response.json() == {"filenames": ["test.txt", "test2.txt"]} diff --git a/tests/test_tutorial/test_request_forms_and_files/test_tutorial001.py b/tests/test_tutorial/test_request_forms_and_files/test_tutorial001.py index 6a98ee324..10cce5e61 100644 --- a/tests/test_tutorial/test_request_forms_and_files/test_tutorial001.py +++ b/tests/test_tutorial/test_request_forms_and_files/test_tutorial001.py @@ -1,6 +1,3 @@ -import os -from pathlib import Path - from fastapi.testclient import TestClient from docs_src.request_forms_and_files.tutorial001 import app @@ -163,32 +160,30 @@ def test_post_body_json(): assert response.json() == file_and_token_required -def test_post_file_no_token(tmpdir): - path = os.path.join(tmpdir, "test.txt") - with open(path, "wb") as file: - file.write(b"") +def test_post_file_no_token(tmp_path): + path = tmp_path / "test.txt" + path.write_bytes(b"") client = TestClient(app) - response = client.post("/files/", files={"file": open(path, "rb")}) + with path.open("rb") as file: + response = client.post("/files/", files={"file": file}) assert response.status_code == 422, response.text assert response.json() == token_required -def test_post_files_and_token(tmpdir): - patha = Path(tmpdir) / "test.txt" - pathb = Path(tmpdir) / "testb.txt" +def test_post_files_and_token(tmp_path): + patha = tmp_path / "test.txt" + pathb = tmp_path / "testb.txt" patha.write_text("") pathb.write_text("") client = TestClient(app) - response = client.post( - "/files/", - data={"token": "foo"}, - files={ - "file": patha.open("rb"), - "fileb": ("testb.txt", pathb.open("rb"), "text/plain"), - }, - ) + with patha.open("rb") as filea, pathb.open("rb") as fileb: + response = client.post( + "/files/", + data={"token": "foo"}, + files={"file": filea, "fileb": ("testb.txt", fileb, "text/plain")}, + ) assert response.status_code == 200, response.text assert response.json() == { "file_size": 14,