⬆ Upgrade Starlette to `0.21.0`, including the new [`TestClient` based on HTTPX](https://github.com/encode/starlette/releases/tag/0.21.0) #5471

pawelrubin · 2022-10-07T09:34:20Z

This PR updates the starlette version to the latest 0.21.0 release.

The latest starlette release comes with some breaking changes to the TestClient as mentioned in the release notes:

This release replaces the underlying HTTP client used on the TestClient (requests ➡️ httpx), and as those clients differ a bit on their API, your test suite will likely break. To make the migration smoother, you can use the bump-testclient tool.

I've used the bump-testclient tool and fixed other issues myself.

github-actions · 2022-10-07T09:39:57Z

📝 Docs preview for commit b5a22a2 at: https://633ff3b942952d32ba54f470--fastapi.netlify.app

tests/test_enforce_once_required_parameter.py

github-actions · 2022-10-07T09:46:54Z

📝 Docs preview for commit 3f447ff at: https://633ff566f692d72eb442e9b1--fastapi.netlify.app

github-actions · 2022-10-07T09:57:20Z

📝 Docs preview for commit a682e85 at: https://633ff7ce2ec6962f37f8e7db--fastapi.netlify.app

github-actions · 2022-10-07T10:03:47Z

📝 Docs preview for commit 431f420 at: https://633ff94a4c600e2842d094a0--fastapi.netlify.app

github-actions · 2022-10-07T10:14:59Z

📝 Docs preview for commit b4f7e87 at: https://633ffbea31944f35e7bcf770--fastapi.netlify.app

codecov · 2022-10-07T10:21:21Z

Codecov Report

Base: 100.00% // Head: 100.00% // No change to project coverage 👍

Coverage data is based on head (982e7ca) compared to base (cf73051).
Patch coverage: 100.00% of modified lines in pull request are covered.

❗ Current head 982e7ca differs from pull request most recent head ce5b5f7. Consider uploading reports for the commit ce5b5f7 to get more accurate results

Additional details and impacted files

@@            Coverage Diff            @@
##            master     #5471   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          540       540           
  Lines        13969     13958   -11     
=========================================
- Hits         13969     13958   -11

Impacted Files	Coverage Δ
fastapi/security/api_key.py	`100.00% <100.00%> (ø)`
fastapi/security/http.py	`100.00% <100.00%> (ø)`
fastapi/security/oauth2.py	`100.00% <100.00%> (ø)`
fastapi/security/open_id_connect_url.py	`100.00% <100.00%> (ø)`
fastapi/security/utils.py	`100.00% <100.00%> (ø)`
tests/test_enforce_once_required_parameter.py	`100.00% <100.00%> (ø)`
tests/test_extra_routes.py	`100.00% <100.00%> (ø)`
tests/test_get_request_body.py	`100.00% <100.00%> (ø)`
tests/test_param_include_in_schema.py	`100.00% <100.00%> (ø)`
tests/test_security_api_key_cookie.py	`100.00% <100.00%> (ø)`
... and 17 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

github-actions · 2022-10-07T10:23:18Z

📝 Docs preview for commit 359684e at: https://633ffde84e2f313c833a0d36--fastapi.netlify.app

yezz123

Looks compatible with the changes in Starlette ✨ 🚀

pyproject.toml

github-actions · 2022-10-07T12:34:48Z

📝 Docs preview for commit 7607ea7 at: https://63401cb41ade06008e6c0692--fastapi.netlify.app

github-actions · 2022-10-07T12:39:11Z

📝 Docs preview for commit 01c4960 at: https://63401dc0f8e580024f94ca9d--fastapi.netlify.app

github-actions · 2022-10-07T12:52:56Z

📝 Docs preview for commit cf84079 at: https://634020f91ade0602a76c06ab--fastapi.netlify.app

github-actions · 2022-10-07T12:59:30Z

📝 Docs preview for commit 5d8a327 at: https://634022871fbcbd077dc05162--fastapi.netlify.app

Kludex

@tiangolo You have the release notes, but remember that WebSocketException is included in this version. I guess you'd like to document that. 👀

pyproject.toml

github-actions · 2022-10-07T16:29:52Z

📝 Docs preview for commit b0ec5cf at: https://634053cd241aac22df3cf2c9--fastapi.netlify.app

github-actions · 2022-10-12T08:06:31Z

📝 Docs preview for commit e0a4aa9 at: https://6346755ac01af03a63982f2c--fastapi.netlify.app

github-actions · 2022-10-21T09:59:46Z

📝 Docs preview for commit 982e7ca at: https://63526d604b095122142240ab--fastapi.netlify.app

pawelrubin · 2022-10-28T10:35:00Z

Hi @tiangolo, could you have a look at this PR? 🙏🏻

pyproject.toml

github-actions · 2022-11-01T08:31:29Z

📝 Docs preview for commit 68fad0b at: https://6360d932a824d00074759e57--fastapi.netlify.app

- Adapt tests suite after breaking changes to the starlette's TestClient - Fix issues found by mypy caused by more precise type annotations in starlette

github-actions · 2022-11-04T06:07:48Z

📝 Docs preview for commit 175022a at: https://6364ac09c42e4e5066030b85--fastapi.netlify.app

thomasleveil · 2022-11-04T07:01:05Z

Since This release replaces the underlying HTTP client used on the TestClient (requests arrow_right httpx), should this be considered introducing breaking changes ?

pawelrubin · 2022-11-04T08:32:27Z

@thomasleveil Yes, it does introduce a breaking change, but only to the TestClient. Assuming that the TestClient is not used in any application code, this change will break only the test suites, which shouldn't be a big deal.

Whether such a breaking change should result in a new major or minor version is up to @tiangolo I guess.

Kludex · 2022-11-04T08:47:06Z

It's going to be a minor.

tiangolo · 2022-11-13T14:22:57Z

Amazing, great job @pawelrubin, thanks! 🍰 ☕

And thanks for the help and comments everyone! 🤓

I just fixed a couple of tests and it's now ready. It will be available in the next version 0.87.0, released in the next hours. 🎉

fix/upgrade dependencies upgrades python version to 3.10.5 upgrades dependencies to their latest versions this is needed because of pinned httpx version is outdated and TestClient breaks starlette and FastAPI references encode/starlette#1376 tiangolo/fastapi#5471 tiangolo/fastapi#5749

pawelrubin force-pushed the update-starlette branch from b5a22a2 to 7b115bc Compare October 7, 2022 09:42

pawelrubin commented Oct 7, 2022

View changes

tests/test_enforce_once_required_parameter.py Show resolved Hide resolved

pawelrubin force-pushed the update-starlette branch from 3f447ff to 763544f Compare October 7, 2022 09:50

pawelrubin marked this pull request as ready for review October 7, 2022 09:51

pawelrubin force-pushed the update-starlette branch from ebb8c6a to a682e85 Compare October 7, 2022 09:53

pawelrubin force-pushed the update-starlette branch from a682e85 to ecfd850 Compare October 7, 2022 09:59

pawelrubin force-pushed the update-starlette branch from 431f420 to b4f7e87 Compare October 7, 2022 10:11

pawelrubin force-pushed the update-starlette branch 2 times, most recently from 07d5cda to 359684e Compare October 7, 2022 10:18

yezz123 approved these changes Oct 7, 2022

View changes

gertcuykens reviewed Oct 7, 2022

View changes

pyproject.toml Show resolved Hide resolved

pawelrubin force-pushed the update-starlette branch from 7607ea7 to 01c4960 Compare October 7, 2022 12:35

pawelrubin force-pushed the update-starlette branch from 01c4960 to cf84079 Compare October 7, 2022 12:48

pawelrubin force-pushed the update-starlette branch from cf84079 to 5d8a327 Compare October 7, 2022 12:54

Kludex reviewed Oct 7, 2022

View changes

pyproject.toml Outdated Show resolved Hide resolved

pawelrubin force-pushed the update-starlette branch from 7838344 to b0ec5cf Compare October 7, 2022 16:25

thomasleveil mentioned this pull request Oct 11, 2022

Await dont work in BackgroundTaks (Fastapi, Beanie, MongoDB) #5403

Open

9 tasks

pawelrubin force-pushed the update-starlette branch from b0ec5cf to e0a4aa9 Compare October 12, 2022 08:01

robotadam mentioned this pull request Oct 13, 2022

db session middleware with custom exception middleware raises AnyIO EndOfSteam when client closes early #4544

Open

9 tasks

JarroVGIT mentioned this pull request Oct 21, 2022

The starlette must be upgraded to 0.21.0 to solve this bug:https://github.com/tiangolo/fastapi/issues/5403 #5529

Open

9 tasks

tiangolo added hacktoberfest-accepted investigate labels Oct 31, 2022

musicinmybrain reviewed Nov 1, 2022

View changes

pyproject.toml Outdated Show resolved Hide resolved

pawelrubin force-pushed the update-starlette branch 2 times, most recently from 54ca46f to 68fad0b Compare November 1, 2022 08:26

Update starlette to 0.21.0.

175022a

- Adapt tests suite after breaking changes to the starlette's TestClient - Fix issues found by mypy caused by more precise type annotations in starlette

pawelrubin force-pushed the update-starlette branch from 68fad0b to 175022a Compare November 4, 2022 06:03

vergeev mentioned this pull request Nov 6, 2022

⬆ Bump starlette from 0.20.4 to 0.21.0 #5570

Closed

csuriano23 mentioned this pull request Nov 10, 2022

Adding a middleware causes background tasks cancellation #5606

Closed

9 tasks

✅ Fix data in test for tuples with new client

ce5b5f7

tiangolo changed the title ~~Update starlette to 0.21.0.~~ ⬆ Upgrade Starlette to 0.21.0, including the new [TestClient based on HTTPX](https://github.com/encode/starlette/releases/tag/0.21.0) Nov 13, 2022

tiangolo merged commit fdbd48b into tiangolo:master Nov 13, 2022
9 checks passed

freddyaboulton mentioned this pull request Nov 14, 2022

Pin fastapi test version to 0.87.0 gradio-app/gradio#2647

Merged

7 tasks

⬆ Upgrade Starlette to `0.21.0`, including the new [`TestClient` based on HTTPX](https://github.com/encode/starlette/releases/tag/0.21.0) #5471

⬆ Upgrade Starlette to `0.21.0`, including the new [`TestClient` based on HTTPX](https://github.com/encode/starlette/releases/tag/0.21.0) #5471

pawelrubin commented Oct 7, 2022 •

edited

github-actions bot commented Oct 7, 2022

github-actions bot commented Oct 7, 2022

github-actions bot commented Oct 7, 2022

github-actions bot commented Oct 7, 2022

github-actions bot commented Oct 7, 2022

codecov bot commented Oct 7, 2022 •

edited

github-actions bot commented Oct 7, 2022

yezz123 left a comment

github-actions bot commented Oct 7, 2022

github-actions bot commented Oct 7, 2022

github-actions bot commented Oct 7, 2022

github-actions bot commented Oct 7, 2022

Kludex left a comment

github-actions bot commented Oct 7, 2022

github-actions bot commented Oct 12, 2022

github-actions bot commented Oct 21, 2022

pawelrubin commented Oct 28, 2022

github-actions bot commented Nov 1, 2022

github-actions bot commented Nov 4, 2022

thomasleveil commented Nov 4, 2022

pawelrubin commented Nov 4, 2022 •

edited

Kludex commented Nov 4, 2022

tiangolo commented Nov 13, 2022

⬆ Upgrade Starlette to 0.21.0, including the new [TestClient based on HTTPX](https://github.com/encode/starlette/releases/tag/0.21.0) #5471

⬆ Upgrade Starlette to 0.21.0, including the new [TestClient based on HTTPX](https://github.com/encode/starlette/releases/tag/0.21.0) #5471

Conversation

pawelrubin commented Oct 7, 2022 • edited

github-actions bot commented Oct 7, 2022

github-actions bot commented Oct 7, 2022

github-actions bot commented Oct 7, 2022

github-actions bot commented Oct 7, 2022

github-actions bot commented Oct 7, 2022

codecov bot commented Oct 7, 2022 • edited

Codecov Report

github-actions bot commented Oct 7, 2022

yezz123 left a comment

Choose a reason for hiding this comment

github-actions bot commented Oct 7, 2022

github-actions bot commented Oct 7, 2022

github-actions bot commented Oct 7, 2022

github-actions bot commented Oct 7, 2022

Kludex left a comment

Choose a reason for hiding this comment

github-actions bot commented Oct 7, 2022

github-actions bot commented Oct 12, 2022

github-actions bot commented Oct 21, 2022

pawelrubin commented Oct 28, 2022

github-actions bot commented Nov 1, 2022

github-actions bot commented Nov 4, 2022

thomasleveil commented Nov 4, 2022

pawelrubin commented Nov 4, 2022 • edited

Kludex commented Nov 4, 2022

tiangolo commented Nov 13, 2022

⬆ Upgrade Starlette to `0.21.0`, including the new [`TestClient` based on HTTPX](https://github.com/encode/starlette/releases/tag/0.21.0) #5471

⬆ Upgrade Starlette to `0.21.0`, including the new [`TestClient` based on HTTPX](https://github.com/encode/starlette/releases/tag/0.21.0) #5471

pawelrubin commented Oct 7, 2022 •

edited

codecov bot commented Oct 7, 2022 •

edited

pawelrubin commented Nov 4, 2022 •

edited