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
http.client request and send method have some datatype issues #67928
Comments
While committing the patch for bpo-23539 I decided to rewrite the 'request' docs for clarity. I doing so I found that http.client isn't as consistent as it could be about how it handles bytes and strings. Two points specifically: it will only take the length of a bytes-like object (to supply a default Content-Length header) if isinstance(x, bytes) is true (that is, it doesn't take the length of eg array or memoryview objects), and (2) if an iterable is passed in, it must be an iterable of bytes-like objects. Since it already automatically encodes string objects and text files, for consistency it should probably also encode strings if they are passed in via an iterator. |
Summary of the main supported types as I see them, whether documented, undocumented, or only working by accident:
Arbitrary bytes-like objects are not properly supported by SSLSocket.sendall(). After all, the non-SSL socket.sendall() documentation does not explicitly mention supporting arbitrary bytes-like objects either, though it does seem to support them in practice. Suggested documentation fixes and additions:
I would support encoding iterables of str() objects for consistency. The patch for bpo-23350 already does this, although I am starting to question the wisdom of special-casing lists and tuples in that patch. |
As well as encoding iterables of str(), text files could also be handled more consistently by checking the read() return type. That would eliminate the complication of checking for a "b" mode. |
FWIW, I've done some additional work to request/send in issue bpo-12319 where I've added support for chunked request encoding.
This specific issue is addressed in the patch in bpo-23350.
I wouldn't be opposed to this at all. In fact, I was going to initially make that change in bpo-12319, but wanted to keep the change surface minimal and realistically, peeking at the data type rather than checking for 'b' in mode doesn't /really/ make that much of a difference. |
Yeah, if we're going to check the type for iterables to convert strings, we might as well check the type for read() as well. The bit about the len not being set except for str and bytes was me mis-remembering what I read in the code. (The isinstance check is about whether _send_output sends the body in the same packet.) |
Note that for file-like objects we have also the same issue as bpo-22468. Content-Length is not determined correctly for GzipFile and like. |
The priority of file-like objects versus bytes-like and iterable objects should be well defined. See bpo-5038: mmap objects seem to satisfy all three interfaces, but the result may be different depending on the file position. |
I’ve decided I would prefer deprecating the Latin-1 encoding, rather than adding more encoding support for iterables and text files. If not deprecating it altogether, at least prefer just ASCII encoding (like Python 2). The urlopen() function already rejects text str, and in bpo-26045 people often want or expect UTF-8. Here is a summary I made of the different data types handled for the body object, from highest priority to lowest priority.
body _send_output() Content-Length urlopen()
|
A data point found while I researched this MyPy typeshed [1] currently declares _DataType = Union[bytes, IO[Any], Iterable[bytes], str]
class HTTPConnection:
def send(self, data: _DataType) -> None: ... |
First stab at characterising http.client.HTTPConnnection.send(). https://github.com/moreati/bpo-23740 This uses a webserver that returns request details, in the body of the response. Raw (TCP level) content is included. It shares a similar purpose to HTTP TRACE command. In principal the bytes that HTTPConection.send() writes will match to the bytes returned (after they're decapsulated from the JSON). I've not tested that aspect yet. TODO
|
http_dump.py now covers CPython 3.6-3.10 (via Tox), and HTTPSConnection https://github.com/moreati/bpo-23740 |
Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.
Show more details
GitHub fields:
bugs.python.org fields:
The text was updated successfully, but these errors were encountered: