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.

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

Stricter data typechecking #3128

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
29 changes: 26 additions & 3 deletions httpx/_content.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,22 @@
Iterable,
Iterator,
Mapping,
Tuple,
)
from urllib.parse import urlencode

from ._exceptions import StreamClosed, StreamConsumed
from ._multipart import MultipartStream
from ._types import (
AsyncByteStream,
PrimitiveData,
RequestContent,
RequestData,
RequestFiles,
ResponseContent,
SyncByteStream,
)
from ._utils import peek_filelike_length, primitive_value_to_str
from ._utils import peek_filelike_length

__all__ = ["ByteStream"]

Expand Down Expand Up @@ -133,15 +135,36 @@ def encode_content(
raise TypeError(f"Unexpected type for 'content', {type(content)!r}")


def _coerce_type(key: str, value: PrimitiveData) -> Tuple[str, str]:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
def _coerce_type(key: str, value: PrimitiveData) -> Tuple[str, str]:
def _coerce_type(key: str, value: PrimitiveData) -> tuple[str, str]:

if not isinstance(key, str):
raise TypeError(
f"Request data keys must be str. " f"Got type {type(key).__name__!r}."
)

if value is True:
return (key, "true")
elif value is False:
return (key, "false")
elif value is None:
return (key, "")
elif isinstance(value, (str, int, float)):
return (key, str(value))

raise TypeError(
f"Request data values must be str, int, float, bool, or None. "
f"Got type {type(value).__name__!r} for key {key!r}."
)


def encode_urlencoded_data(
data: RequestData,
) -> tuple[dict[str, str], ByteStream]:
plain_data = []
for key, value in data.items():
if isinstance(value, (list, tuple)):
plain_data.extend([(key, primitive_value_to_str(item)) for item in value])
plain_data.extend([_coerce_type(key, each) for each in value])
else:
plain_data.append((key, primitive_value_to_str(value)))
plain_data.append(_coerce_type(key, value))
body = urlencode(plain_data, doseq=True).encode("utf-8")
content_length = str(len(body))
content_type = "application/x-www-form-urlencoded"
Expand Down
23 changes: 19 additions & 4 deletions tests/test_content.py
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ async def test_urlencoded_content():

@pytest.mark.anyio
async def test_urlencoded_boolean():
request = httpx.Request(method, url, data={"example": True})
request = httpx.Request(method, url, data={"true": True, "false": False})
assert isinstance(request.stream, typing.Iterable)
assert isinstance(request.stream, typing.AsyncIterable)

Expand All @@ -209,11 +209,11 @@ async def test_urlencoded_boolean():

assert request.headers == {
"Host": "www.example.com",
"Content-Length": "12",
"Content-Length": "21",
"Content-Type": "application/x-www-form-urlencoded",
}
assert sync_content == b"example=true"
assert async_content == b"example=true"
assert sync_content == b"true=true&false=false"
assert async_content == b"true=true&false=false"


@pytest.mark.anyio
Expand Down Expand Up @@ -252,6 +252,21 @@ async def test_urlencoded_list():
assert async_content == b"example=a&example=1&example=true"


def test_urlencoded_invalid_key():
with pytest.raises(TypeError) as e:
httpx.Request(method, url, data={123: "value"}) # type: ignore
assert str(e.value) == "Request data keys must be str. Got type 'int'."


def test_urlencoded_invalid_value():
with pytest.raises(TypeError) as e:
httpx.Request(method, url, data={"key": {"this": "ain't json, buddy"}})
assert str(e.value) == (
"Request data values must be str, int, float, bool, or None. "
"Got type 'dict' for key 'key'."
)


@pytest.mark.anyio
async def test_multipart_files_content():
files = {"file": io.BytesIO(b"<file content>")}
Expand Down