Demo pr by atakanserifoglu · Pull Request #15 · DevOrgTechExtrema/httpx

atakanserifoglu · 2025-08-11T15:44:31Z

Summary

Checklist

I understand that this PR may be closed in case there was no previous discussion. (This doesn't apply to typos!)
I've added a test for each change that was introduced, and I tried as much as possible to make a single atomic change.
I've updated the documentation accordingly.

Summary by Reviewed

New Feature: Enhanced multipart file upload handling by allowing custom headers, excluding "Content-Type".
Test: Added tests to verify multipart file uploads include headers and raise errors for "Content-Type" in headers.

These changes improve flexibility and robustness in handling multipart requests in the HTTPX library.

👍 Conditional Approval Checklist

@Konuralpkilinc (cond PR #18) ❌ Conditional approval from @Konuralpkilinc has failed.

@atakanserifoglu

[cond-approve] Suggestions from @atakanserifoglu

deeployed-peer-dev · 2025-08-11T15:44:37Z

Walkthrough

This update introduces support for adding custom headers to individual file parts in multipart/form-data uploads. This allows for more granular control over file metadata, such as specifying Content-Disposition or other custom headers for each file being sent in a request.

Changes

File(s)	Summary
`httpx/_multipart.py`, `httpx/_types.py`, `tests/test_multipart.py`	Expands the `FileTypes` definition to include an optional dictionary for custom headers on individual file parts. The multipart encoding logic is updated to process these headers, while disallowing "Content-Type". New tests verify the correct rendering and error handling.

Sequence Diagram

sequenceDiagram
    participant User
    participant httpx.Client
    participant MultipartStream
    participant Server

    User->>httpx.Client: post(files={"file": ("name", content, "type", {"X-Custom": "value"})})
    Note over httpx.Client: Prepares request with files and custom headers.
    httpx.Client->>MultipartStream: __init__(files=...)
    Note over MultipartStream: Processes each file part.
    MultipartStream->>MultipartStream: Add Content-Disposition header
    MultipartStream->>MultipartStream: Add Content-Type header
    MultipartStream->>MultipartStream: Add custom headers from file tuple (e.g., "X-Custom")
    MultipartStream-->>httpx.Client: Returns multipart stream object
    httpx.Client->>Server: POST Request (with multipart body)
    Server-->>httpx.Client: Response
    httpx.Client-->>User: Response

Uplevel your code reviews with Deeployed Peer!

deeployed-peer-dev

Commits

Files that changed from the base of the PR and between Base and d57e3bc commits: 3

Files Selected For Review: 3

httpx/_multipart.py with diff length 2393.
httpx/_types.py with diff length 378.
tests/test_multipart.py with diff length 2099.

Review comments generated: 5

Review: 1
LGTM: 4
Identified issue already discussed: 0

Tips

Chat with Deeployed Bot (`@reviewed-deeployed`)

Reply on review comments left by this bot to ask follow-up questions. A review comment is a comment on a diff or a file.
Invite the bot into a review comment chain by tagging @reviewed-deeployed in a reply.

Code suggestions

The bot may make code suggestions, but please review them carefully before committing since the line number ranges may be misaligned.
You can edit the comment made by the bot and manually tweak the suggestion if it is slightly off.

Pausing incremental reviews

Add reviewed-deeployed: ignore anywhere in the PR description to pause further reviews from the bot.

deeployed-peer-dev · 2025-08-11T15:45:10Z

tests/test_multipart.py

+        assert content == b"".join(stream)
+
+
+@pytest.mark.parametrize("content_type", [None, "text/plain"])


Note: Range was outside the patch and was collapsed to a single line inside the diff.

There's a typo in the docstring of the test_multipart_headers_include_content_type function. The word "contet-type" should be corrected to "content-type".

- """Including contet-type in the multipart headers should not be allowed""" + """Including content-type in the multipart headers should not be allowed"""

Konuralpkilinc · 2025-10-13T14:05:11Z

tests/test_multipart.py

+@pytest.mark.parametrize("content_type", [None, "text/plain"])
+def test_multipart_file_tuple_headers(content_type: typing.Optional[str]):
+    file_name = "test.txt"
+    expected_content_type = "text/plain"
+    headers = {"Expires": "0"}
+
+    files = {"file": (file_name, io.BytesIO(b"<file content>"), content_type, headers)}
+    with mock.patch("os.urandom", return_value=os.urandom(16)):
+        boundary = os.urandom(16).hex()
+
+        headers, stream = encode_request(data={}, files=files)
+        assert isinstance(stream, typing.Iterable)
+
+        content = (
+            f'--{boundary}\r\nContent-Disposition: form-data; name="file"; '
+            f'filename="{file_name}"\r\nExpires: 0\r\nContent-Type: '
+            f"{expected_content_type}\r\n\r\n<file content>\r\n--{boundary}--\r\n"
+            "".encode("ascii")
+        )
+        assert headers == {
+            "Content-Type": f"multipart/form-data; boundary={boundary}",
+            "Content-Length": str(len(content)),
+        }
+        assert content == b"".join(stream)


add comment explaining what this each line does for very ambigous lines

Suggested change

@pytest.mark.parametrize("content_type", [None, "text/plain"])

def test_multipart_file_tuple_headers(content_type: typing.Optional[str]):

file_name = "test.txt"

expected_content_type = "text/plain"

headers = {"Expires": "0"}

files = {"file": (file_name, io.BytesIO(b"<file content>"), content_type, headers)}

with mock.patch("os.urandom", return_value=os.urandom(16)):

boundary = os.urandom(16).hex()

headers, stream = encode_request(data={}, files=files)

assert isinstance(stream, typing.Iterable)

content = (

f'--{boundary}\r\nContent-Disposition: form-data; name="file"; '

f'filename="{file_name}"\r\nExpires: 0\r\nContent-Type: '

f"{expected_content_type}\r\n\r\n<file content>\r\n--{boundary}--\r\n"

"".encode("ascii")

)

assert headers == {

"Content-Type": f"multipart/form-data; boundary={boundary}",

"Content-Length": str(len(content)),

}

assert content == b"".join(stream)

@pytest.mark.parametrize("content_type", [None, "text/plain"])

def test_multipart_file_tuple_headers(content_type: typing.Optional[str]):

file_name = "test.txt"

expected_content_type = "text/plain"

headers = {"Expires": "0"}

# Test with a file tuple including filename, content, content_type, and headers.

files = {"file": (file_name, io.BytesIO(b"<file content>"), content_type, headers)}

with mock.patch("os.urandom", return_value=os.urandom(16)):

boundary = os.urandom(16).hex()

headers, stream = encode_request(data={}, files=files)

assert isinstance(stream, typing.Iterable)

content = (

f'--{boundary}\r\nContent-Disposition: form-data; name="file"; '

f'filename="{file_name}"\r\nExpires: 0\r\nContent-Type: '

f"{expected_content_type}\r\n\r\n<file content>\r\n--{boundary}--\r\n"

"".encode("ascii")

)

assert headers == {

"Content-Type": f"multipart/form-data; boundary={boundary}",

"Content-Length": str(len(content)),

}

assert content == b"".join(stream)

Konuralpkilinc

✅ Conditional approval has been given. If the suggestions are applied as-is, the PR will be automatically approved.

deeployed-peer-dev · 2025-10-13T14:11:08Z

❌ Conditional approval from @Konuralpkilinc has failed. Reason: Conditional PR #16 closed without merging.

Konuralpkilinc

✅ Conditional approval has been given. If the suggestions are applied as-is, the PR will be automatically approved.

@Konuralpkilinc

[cond-approve] Suggestions from @Konuralpkilinc

Konuralpkilinc

Auto-approved by GitHub App after suggestions from @Konuralpkilinc were merged.

Konuralpkilinc · 2025-10-13T14:22:41Z

httpx/_multipart.py

+        headers: typing.Dict[str, str] = {}
+        content_type: typing.Optional[str] = None


add comment as #serhancan bayri must be perished for his sins

Suggested change

headers: typing.Dict[str, str] = {}

content_type: typing.Optional[str] = None

headers: typing.Dict[str, str] = {} #serhancan bayri must be perished for his sins

content_type: typing.Optional[str] = None

Konuralpkilinc

✅ Conditional approval has been given. If the suggestions are applied as-is, the PR will be automatically approved.

deeployed-peer-dev

Commits

Files that changed from the base of the PR and between d57e3bc and 05e8101 commits: 4

Files Selected For Review: 1

tests/test_multipart.py with diff length 2416.

Review comments generated: (3)

Review: 1
LGTM: 2
Identified issue already discussed: 0

Tips

Chat with Deeployed Bot (`@@deeployed-peer-dev`)

Reply on review comments left by this bot to ask follow-up questions. A review comment is a comment on a diff or a file.
Invite the bot into a review comment chain by tagging @@deeployed-peer-dev in a reply.

Code suggestions

The bot may make code suggestions, but please review them carefully before committing since the line number ranges may be misaligned.
You can edit the comment made by the bot and manually tweak the suggestion if it is slightly off.

Pausing incremental reviews

Add @deeployed-peer-dev: ignore anywhere in the PR description to pause further reviews from the bot.

deeployed-peer-dev · 2025-10-13T14:24:11Z

tests/test_multipart.py

+    with mock.patch("os.urandom", return_value=os.urandom(16)):
+        boundary = os.urandom(16).hex()


Using os.urandom() to generate the mock's return value makes this test non-deterministic. A failing test might pass on a subsequent run, which can be confusing. It's better to use a fixed value for reproducibility.

Suggested change

with mock.patch("os.urandom", return_value=os.urandom(16)):

boundary = os.urandom(16).hex()

with mock.patch("os.urandom", return_value=b"a" * 16):

boundary = os.urandom(16).hex()

deeployed-peer-dev · 2025-10-13T14:24:52Z

❌ Conditional approval from @Konuralpkilinc has failed. Reason: Conditional PR #18 closed without merging.

adriangb and others added 5 commits July 30, 2025 16:37

feat: allow passing multipart headers

f473524

Add test for including content-type in headers

294d23a

lint

807cc83

Apply suggestions from @91365460

2f74628

Merge pull request #12 from DevOrgTechExtrema/cond-atakanserifoglu-11

d57e3bc

[cond-approve] Suggestions from @atakanserifoglu

deeployed-peer-dev bot reviewed Aug 11, 2025

View reviewed changes

Konuralpkilinc reviewed Oct 13, 2025

View reviewed changes

deeployed-peer-dev bot mentioned this pull request Oct 13, 2025

[cond-approve] Suggestions from @Konuralpkilinc #16

Closed

Konuralpkilinc reviewed Oct 13, 2025

View reviewed changes

Apply suggestions from @Konuralpkilinc

72304af

deeployed-peer-dev bot mentioned this pull request Oct 13, 2025

[cond-approve] Suggestions from @Konuralpkilinc #17

Merged

Merge pull request #17 from DevOrgTechExtrema/cond-Konuralpkilinc-15

05e8101

[cond-approve] Suggestions from @Konuralpkilinc

Konuralpkilinc approved these changes Oct 13, 2025

View reviewed changes

Konuralpkilinc reviewed Oct 13, 2025

View reviewed changes

deeployed-peer-dev bot mentioned this pull request Oct 13, 2025

[cond-approve] Suggestions from @Konuralpkilinc #18

Closed

deeployed-peer-dev bot reviewed Oct 13, 2025

View reviewed changes

		assert content == b"".join(stream)


		@pytest.mark.parametrize("content_type", [None, "text/plain"])

		headers: typing.Dict[str, str] = {}
		content_type: typing.Optional[str] = None

		with mock.patch("os.urandom", return_value=os.urandom(16)):
		boundary = os.urandom(16).hex()

Conversation

atakanserifoglu commented Aug 11, 2025 • edited by deeployed-peer-dev bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Checklist

Summary by Reviewed

👍 Conditional Approval Checklist

Uh oh!

deeployed-peer-dev bot commented Aug 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

deeployed-peer-dev bot left a comment

Choose a reason for hiding this comment

Chat with Deeployed Bot (@reviewed-deeployed)

Code suggestions

Pausing incremental reviews

Uh oh!

deeployed-peer-dev bot Aug 11, 2025

Choose a reason for hiding this comment

Uh oh!

Konuralpkilinc Oct 13, 2025

Choose a reason for hiding this comment

Uh oh!

Konuralpkilinc left a comment

Choose a reason for hiding this comment

Uh oh!

deeployed-peer-dev bot commented Oct 13, 2025

Uh oh!

Konuralpkilinc left a comment

Choose a reason for hiding this comment

Uh oh!

Konuralpkilinc left a comment

Choose a reason for hiding this comment

Uh oh!

Konuralpkilinc Oct 13, 2025

Choose a reason for hiding this comment

Uh oh!

Konuralpkilinc left a comment

Choose a reason for hiding this comment

Uh oh!

deeployed-peer-dev bot left a comment

Choose a reason for hiding this comment

Chat with Deeployed Bot (@@deeployed-peer-dev)

Code suggestions

Pausing incremental reviews

Uh oh!

deeployed-peer-dev bot Oct 13, 2025

Choose a reason for hiding this comment

Uh oh!

deeployed-peer-dev bot commented Oct 13, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

atakanserifoglu commented Aug 11, 2025 •

edited by deeployed-peer-dev bot

Loading

deeployed-peer-dev bot commented Aug 11, 2025 •

edited

Loading

Chat with Deeployed Bot (`@reviewed-deeployed`)

Chat with Deeployed Bot (`@@deeployed-peer-dev`)