Skip to content
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

Add raw_path to scope in ASGITransport #1357

Merged
merged 2 commits into from
Oct 9, 2020
Merged

Add raw_path to scope in ASGITransport #1357

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f8b814b
Add raw_path to scope in ASGITransport, closes #1356
simonw Oct 9, 2020
6a81b21
Tweaked test
simonw Oct 9, 2020
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
1 change: 1 addition & 0 deletions httpx/_transports/asgi.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@ async def arequest(
"headers": [(k.lower(), v) for (k, v) in headers],
"scheme": scheme.decode("ascii"),
"path": unquote(path.decode("ascii")),
"raw_path": path,
"query_string": query,
"server": (host.decode("ascii"), port),
"client": self.client,
Expand Down
19 changes: 19 additions & 0 deletions tests/test_asgi.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,15 @@ async def echo_path(scope, receive, send):
await send({"type": "http.response.body", "body": output})


async def echo_raw_path(scope, receive, send):
status = 200
output = json.dumps({"raw_path": repr(scope["raw_path"])}).encode("utf-8")
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm using repr(scope["raw_path"]) here as an easy way to confirm that the value is indeed a Python bytestring - it ends up being returned as "b'/user%40example.org'" in the JSON.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yup that make sense.

I guess it might look a bit confusing to future readers, so we could either:

  1. Comment it.
  2. Switch it around to {"raw_path": scope["raw_path"].decode("ascii")}

I'd marginally prefer (2), since it's actually perfectly sufficient here, but I'm okay enough with either.

headers = [(b"content-type", "text/plain"), (b"content-length", str(len(output)))]

await send({"type": "http.response.start", "status": status, "headers": headers})
await send({"type": "http.response.body", "body": output})


async def echo_body(scope, receive, send):
status = 200
headers = [(b"content-type", "text/plain")]
Expand Down Expand Up @@ -80,6 +89,16 @@ async def test_asgi_urlencoded_path():
assert response.json() == {"path": "/[email protected]"}


@pytest.mark.usefixtures("async_environment")
async def test_asgi_raw_path():
async with httpx.AsyncClient(app=echo_raw_path) as client:
url = httpx.URL("http://www.example.org/").copy_with(path="/[email protected]")
response = await client.get(url)

assert response.status_code == 200
assert response.json() == {"raw_path": "b'/user%40example.org'"}


@pytest.mark.usefixtures("async_environment")
async def test_asgi_upload():
async with httpx.AsyncClient(app=echo_body) as client:
Expand Down