bump-testclient

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.

Why?

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

Transformations

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 <method> in ("delete", "get", "head", "options").
Using content, data, json or files parameters.

Replace client.<method>(..., allow_redirects=...) by client.<method>(..., follow_redirects=...)

HTTPX uses follow_redirects instead of allow_redirects.

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.

Installation

pip install bump-testclient

Usage

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: https://github.com/Kludex/bump-testclient
    rev: 0.3.0
    hooks:
      - id: bump_testclient

License

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