Skip to content

Add option to keep the same method for 301/302 redirects #3783

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kajinamit wants to merge 1 commit into
base: master
Choose a base branch
from
+53 −0
Open

Add option to keep the same method for 301/302 redirects #3783

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions httpx/_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,7 @@ def __init__(
timeout: TimeoutTypes = DEFAULT_TIMEOUT_CONFIG,
follow_redirects: bool = False,
max_redirects: int = DEFAULT_MAX_REDIRECTS,
keep_method_for_redirects: bool = False,
event_hooks: None | (typing.Mapping[str, list[EventHook]]) = None,
base_url: URL | str = "",
trust_env: bool = True,
Expand All @@ -212,6 +213,7 @@ def __init__(
self._timeout = Timeout(timeout)
self.follow_redirects = follow_redirects
self.max_redirects = max_redirects
self.keep_method_for_redirects = keep_method_for_redirects
self._event_hooks = {
"request": list(event_hooks.get("request", [])),
"response": list(event_hooks.get("response", [])),
Expand Down Expand Up @@ -502,6 +504,9 @@ def _redirect_method(self, request: Request, response: Response) -> str:
if response.status_code == codes.SEE_OTHER and method != "HEAD":
method = "GET"

if self.keep_method_for_redirects:
return method

# Do what the browsers do, despite standards...
# Turn 302s into GETs.
if response.status_code == codes.FOUND and method != "HEAD":
Expand Down Expand Up @@ -622,9 +627,13 @@ class Client(BaseClient):
* **proxy** - *(optional)* A proxy URL where all the traffic should be routed.
* **timeout** - *(optional)* The timeout configuration to use when sending
requests.
* **follow_redirects** - *(optional)* Follow redirects and send a new
* request to the redirected url automatically.
* **limits** - *(optional)* The limits configuration to use.
* **max_redirects** - *(optional)* The maximum number of redirect responses
that should be followed.
* **keep_method_for_redirects* - *(optional)* Keep the original HTTP method
when following redirects. This is effective only for 301 and 302 .
* **base_url** - *(optional)* A URL to use as the base when building
request URLs.
* **transport** - *(optional)* A transport class to use for sending requests
Expand Down Expand Up @@ -654,6 +663,7 @@ def __init__(
follow_redirects: bool = False,
limits: Limits = DEFAULT_LIMITS,
max_redirects: int = DEFAULT_MAX_REDIRECTS,
keep_method_for_redirects: bool = False,
event_hooks: None | (typing.Mapping[str, list[EventHook]]) = None,
base_url: URL | str = "",
transport: BaseTransport | None = None,
Expand All @@ -667,6 +677,7 @@ def __init__(
timeout=timeout,
follow_redirects=follow_redirects,
max_redirects=max_redirects,
keep_method_for_redirects=keep_method_for_redirects,
event_hooks=event_hooks,
base_url=base_url,
trust_env=trust_env,
Expand Down Expand Up @@ -1336,9 +1347,13 @@ class AsyncClient(BaseClient):
* **proxy** - *(optional)* A proxy URL where all the traffic should be routed.
* **timeout** - *(optional)* The timeout configuration to use when sending
requests.
* **follow_redirects** - *(optional)* Follow redirects and send a new
* request to the redirected url automatically.
* **limits** - *(optional)* The limits configuration to use.
* **max_redirects** - *(optional)* The maximum number of redirect responses
that should be followed.
* **keep_method_for_redirects* - *(optional)* Keep the original HTTP method
when following redirects. This is effective only for 301 and 302 .
* **base_url** - *(optional)* A URL to use as the base when building
request URLs.
* **transport** - *(optional)* A transport class to use for sending requests
Expand Down Expand Up @@ -1367,6 +1382,7 @@ def __init__(
follow_redirects: bool = False,
limits: Limits = DEFAULT_LIMITS,
max_redirects: int = DEFAULT_MAX_REDIRECTS,
keep_method_for_redirects: bool = False,
event_hooks: None | (typing.Mapping[str, list[EventHook]]) = None,
base_url: URL | str = "",
transport: AsyncBaseTransport | None = None,
Expand All @@ -1381,6 +1397,7 @@ def __init__(
timeout=timeout,
follow_redirects=follow_redirects,
max_redirects=max_redirects,
keep_method_for_redirects=keep_method_for_redirects,
event_hooks=event_hooks,
base_url=base_url,
trust_env=trust_env,
Expand Down
36 changes: 36 additions & 0 deletions tests/client/test_redirects.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,18 @@ def test_redirect_301():
response = client.post("https://example.org/redirect_301", follow_redirects=True)
assert response.status_code == httpx.codes.OK
assert response.url == "https://example.org/"
assert response.request.method == "GET"
assert len(response.history) == 1


def test_redirect_301_keep_method():
client = httpx.Client(
transport=httpx.MockTransport(redirects), keep_method_for_redirects=True
)
response = client.post("https://example.org/redirect_301", follow_redirects=True)
assert response.status_code == httpx.codes.OK
assert response.url == "https://example.org/"
assert response.request.method == "POST"
assert len(response.history) == 1


Expand All @@ -126,6 +138,18 @@ def test_redirect_302():
response = client.post("https://example.org/redirect_302", follow_redirects=True)
assert response.status_code == httpx.codes.OK
assert response.url == "https://example.org/"
assert response.request.method == "GET"
assert len(response.history) == 1


def test_redirect_302_keep_method():
client = httpx.Client(
transport=httpx.MockTransport(redirects), keep_method_for_redirects=True
)
response = client.post("https://example.org/redirect_302", follow_redirects=True)
assert response.status_code == httpx.codes.OK
assert response.url == "https://example.org/"
assert response.request.method == "POST"
assert len(response.history) == 1


Expand All @@ -134,6 +158,18 @@ def test_redirect_303():
response = client.get("https://example.org/redirect_303", follow_redirects=True)
assert response.status_code == httpx.codes.OK
assert response.url == "https://example.org/"
assert response.request.method == "GET"
assert len(response.history) == 1


def test_redirect_303_keep_method():
client = httpx.Client(
transport=httpx.MockTransport(redirects), keep_method_for_redirects=True
)
response = client.get("https://example.org/redirect_303", follow_redirects=True)
assert response.status_code == httpx.codes.OK
assert response.url == "https://example.org/"
assert response.request.method == "GET"
assert len(response.history) == 1


Expand Down