Skip to main content

Replace Starlette's TestClient from `requests` to `httpx`! 🎉

Project description


Package version

Starlette 0.21.0 changed the TestClient implementation: it replaced the requests library with httpx. As those libraries have different APIs, this change break tests for Starlette's users.

This codemod makes the transition to Starlette 0.21.0 easier. It makes the changes needed to make the tests work again.


Make your life easier. Suggested by Sebastián Ramírez as a joke, but well... I did it.


  1. Replace client.<method>(...) by client.request("<method>", ...)

The methods ("delete", "get", "head", "options") doesn't accept the content, data, json and files parameters.

Conditions for this transformation:

  • Using client.<method> and ` in ("delete", "get", "head", "options").
  • Using content, data, json or files parameters.
  1. Replace client.<method>(..., allow_redirects=...) by client.<method>(..., follow_redirects=...)

HTTPX uses follow_redirects instead of allow_redirects.

  1. Replace client.<method>(..., data=...) by client.<method>(..., content=...)

If the argument passed to data is either text or bytes, content should be used instead.

Conditions for this to happen:

  • data parameter receives a bytes/text argument.


pip install bump-testclient


Run the following on the repository you want to format:

python -m bump_testclient <files>

You can also use the pre-commit. Add the following to your .pre-commit-config.yaml file:

  - repo:
    rev: 0.3.0
      - id: bump_testclient


This project is licensed under the terms of the MIT license.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

bump_testclient-0.3.0-py3-none-any.whl (7.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page