Skip to content

Commit

Permalink
Fix for gen-delims escaping behaviour in path/query/fragment (#2701)
Browse files Browse the repository at this point in the history
  • Loading branch information
tomchristie committed May 9, 2023
1 parent df5dbc0 commit ee432c0
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 3 deletions.
13 changes: 10 additions & 3 deletions httpx/_urlparse.py
Original file line number Diff line number Diff line change
Expand Up @@ -253,12 +253,19 @@ def urlparse(url: str = "", **kwargs: typing.Optional[str]) -> ParseResult:
if has_authority:
path = normalize_path(path)

parsed_path: str = quote(path, safe=SUB_DELIMS + ":@/")
# The GEN_DELIMS set is... : / ? # [ ] @
# These do not need to be percent-quoted unless they serve as delimiters for the
# specific component.

# For 'path' we need to drop ? and # from the GEN_DELIMS set.
parsed_path: str = quote(path, safe=SUB_DELIMS + ":/[]@")
# For 'query' we need to drop '#' from the GEN_DELIMS set.
parsed_query: typing.Optional[str] = (
None if query is None else quote(query, safe=SUB_DELIMS + "/?")
None if query is None else quote(query, safe=SUB_DELIMS + ":/?[]@")
)
# For 'fragment' we can include all of the GEN_DELIMS set.
parsed_fragment: typing.Optional[str] = (
None if fragment is None else quote(fragment, safe=SUB_DELIMS + "/?")
None if fragment is None else quote(fragment, safe=SUB_DELIMS + ":/?#[]@")
)

# The parsed ASCII bytestrings are our canonical form.
Expand Down
30 changes: 30 additions & 0 deletions tests/test_urlparse.py
Original file line number Diff line number Diff line change
Expand Up @@ -247,3 +247,33 @@ def test_copy_with():

url = url.copy_with(path="/abc")
assert str(url) == "http://example.com/abc"


# Tests for percent encoding across path, query, and fragement...


def test_path_percent_encoding():
# Test percent encoding for SUB_DELIMS ALPHA NUM and allowable GEN_DELIMS
url = httpx.URL("https://example.com/!$&'()*+,;= abc ABC 123 :/[]@")
assert url.raw_path == b"/!$&'()*+,;=%20abc%20ABC%20123%20:/[]@"
assert url.path == "/!$&'()*+,;= abc ABC 123 :/[]@"
assert url.query == b""
assert url.fragment == ""


def test_query_percent_encoding():
# Test percent encoding for SUB_DELIMS ALPHA NUM and allowable GEN_DELIMS
url = httpx.URL("https://example.com/?!$&'()*+,;= abc ABC 123 :/[]@" + "?")
assert url.raw_path == b"/?!$&'()*+,;=%20abc%20ABC%20123%20:/[]@?"
assert url.path == "/"
assert url.query == b"!$&'()*+,;=%20abc%20ABC%20123%20:/[]@?"
assert url.fragment == ""


def test_fragment_percent_encoding():
# Test percent encoding for SUB_DELIMS ALPHA NUM and allowable GEN_DELIMS
url = httpx.URL("https://example.com/#!$&'()*+,;= abc ABC 123 :/[]@" + "?#")
assert url.raw_path == b"/"
assert url.path == "/"
assert url.query == b""
assert url.fragment == "!$&'()*+,;= abc ABC 123 :/[]@?#"

0 comments on commit ee432c0

Please sign in to comment.