HTTPResponse is missing an implementation of readinto

[bitdancer]

BPO	13464
Nosy	@orsenthil, @pitrou, @bitdancer, @fbidu
PRs	bpo-42060: Remove assert from http/client.py #22737
Files	issue13464.patch: Patch based on 06087f6890af issue13464_r1.patch: Updated Patch

^{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:

assignee = None
closed_at = <Date 2011-12-06.21:41:39.277>
created_at = <Date 2011-11-23.18:13:58.798>
labels = ['easy', 'type-feature', 'library']
title = 'HTTPResponse is missing an implementation of readinto'
updated_at = <Date 2020-10-23.19:09:49.240>
user = 'https://github.com/bitdancer'

bugs.python.org fields:

activity = <Date 2020-10-23.19:09:49.240>
actor = 'fbidu'
assignee = 'none'
closed = True
closed_date = <Date 2011-12-06.21:41:39.277>
closer = 'pitrou'
components = ['Library (Lib)']
creation = <Date 2011-11-23.18:13:58.798>
creator = 'r.david.murray'
dependencies = []
files = ['23847', '23850']
hgrepos = []
issue_num = 13464
keywords = ['patch', 'easy']
message_count = 7.0
messages = ['148199', '148837', '148846', '148852', '148939', '148940', '150627']
nosy_count = 6.0
nosy_names = ['orsenthil', 'pitrou', 'r.david.murray', 'python-dev', 'Jon.Kuhn', 'fbidu']
pr_nums = ['22737']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue13464'
versions = ['Python 3.3']

[bitdancer]

HTTPResponse subclasses RawIOBase, but does not provide an implementation of readinto, only read. This means that it is not conforming to the IO spec, and so it cannot be wrapped in a BufferedIOBase when using the C version of io.

[JonKuhn]

This is my first contribution to a real open source project.

Attached is my patch. Suggestions for improvements are welcome.

[pitrou]

Hello Jon, and thanks for the patch. I have a couple of comments:

• readinto() shouldn't return None but 0 when there is nothing to read (this corresponds to read() returning b"")

• I see _read_chunked() is only ever called with amt=None, so perhaps it can be simplified?

Also, a nitpick: the doc entry needs a "versionadded" tag.

[JonKuhn]

Thanks for the comments. Attached is an updated patch.

In the RawIOBase docs it says "If the object is in non-blocking mode and no bytes are available, None is returned." So I wasn't sure if that meant any time no bytes were available or just when no bytes are available and EOF has not been reached. -- I updated it to return 0 instead of None.

I simplified _read_chunked() and renamed it to _readall_chunked() since that is all it does.

I added the versionadded tag specifying that it was added in 3.3 since the patch is for the default branch.

[python-dev]

New changeset 806cfe39f729 by Antoine Pitrou in branch 'default':
Issue bpo-13464: Add a readinto() method to http.client.HTTPResponse.
http://hg.python.org/cpython/rev/806cfe39f729

[pitrou]

Ok, thank you. I've now committed the patch in the default branch. Congratulations!

(since the documentation doesn't claim that HTTPResponse implements RawIOBase, I tend to consider this a feature request rather than a bugfix, hence no 3.2 commit)

[python-dev]

New changeset 4b21f651eeee by Antoine Pitrou in branch 'default':
Issue bpo-13713: fix a regression in HTTP chunked reading after 806cfe39f729
http://hg.python.org/cpython/rev/4b21f651eeee