Issue 34613: asyncio.StreamReader initialization documentation incorrectly declare limit as None (original) (raw)

Issue34613

➜

This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

This issue has been migrated to GitHub: https://github.com/python/cpython/issues/78794

classification

Title:	asyncio.StreamReader initialization documentation incorrectly declare limit as None
Type:	enhancement	Stage:	resolved
Components:	asyncio, Documentation	Versions:	Python 3.8, Python 3.7, Python 3.6, Python 3.5

process

Status:	closed	Resolution:	fixed
Dependencies:		Superseder:
Assigned To:	docs@python	Nosy List:	asvetlov, docs@python, miss-islington, psycojoker, yselivanov
Priority:	normal	Keywords:	patch

Created on 2018-09-09 07:00 by psycojoker, last changed 2022-04-11 14:59 by admin. This issue is now closed.

Pull Requests
URL	Status	Linked	Edit
PR 9121	merged	python-dev,2018-09-09 07:05
PR 9175	merged	miss-islington,2018-09-11 18:45
PR 9176	merged	miss-islington,2018-09-11 18:45

Messages (4)
msg324873 - (view)	Author: Laurent Peuch (psycojoker) *	Date: 2018-09-09 07:00
asyncio.StreamReader documentation incorrectly declare its initialization argument "limit" to be "None" by default https://docs.python.org/3/library/asyncio-stream.html#asyncio.StreamReader In the source code it is set to _DEFAULT_LIMIT https://github.com/python/cpython/blob/0afada163c7ef25c3a9d46ed445481fb69f2ecaf/Lib/asyncio/streams.py#L353 _DEFAULT_LIMIT is set to "2 ** 16 # 64 KiB" https://github.com/python/cpython/blob/0afada163c7ef25c3a9d46ed445481fb69f2ecaf/Lib/asyncio/streams.py#L19 This information is especially needed when you get the exception "asyncio.streams.LimitOverrunError: Separator is not found, and chunk exceed the limit" and want to increase the limit, but you don't have the initial value and you have to look at the source code to get it. PS: this is my first ticket, I don't know if I should have open one for such a minor detail in the documentation
msg325048 - (view)	Author: miss-islington (miss-islington)	Date: 2018-09-11 18:45
New changeset b4ec36200a959da70eba94c19826446a8efdffdd by Miss Islington (bot) (Bram) in branch 'master': bpo-34613: document the correct value of limit argument of asyncio.StreamReader (GH-9121) https://github.com/python/cpython/commit/b4ec36200a959da70eba94c19826446a8efdffdd
msg325050 - (view)	Author: miss-islington (miss-islington)	Date: 2018-09-11 18:57
New changeset cb51dd7cac6a6e2a7ba67fa4cd328a68f630095b by Miss Islington (bot) in branch '3.6': bpo-34613: document the correct value of limit argument of asyncio.StreamReader (GH-9121) https://github.com/python/cpython/commit/cb51dd7cac6a6e2a7ba67fa4cd328a68f630095b
msg325052 - (view)	Author: miss-islington (miss-islington)	Date: 2018-09-11 18:59
New changeset e02ca4270ef258162215e345c23025bec27f9eb0 by Miss Islington (bot) in branch '3.7': bpo-34613: document the correct value of limit argument of asyncio.StreamReader (GH-9121) https://github.com/python/cpython/commit/e02ca4270ef258162215e345c23025bec27f9eb0

History
Date	User	Action	Args
2022-04-11 14:59:05	admin	set	github: 78794
2019-05-25 22:25:08	asvetlov	set	status: open -> closedresolution: fixedstage: patch review -> resolved
2018-09-11 18:59:33	miss-islington	set	messages: +
2018-09-11 18:57:51	miss-islington	set	messages: +
2018-09-11 18:45:58	miss-islington	set	pull_requests: + <pull%5Frequest8615>
2018-09-11 18:45:46	miss-islington	set	pull_requests: + <pull%5Frequest8614>
2018-09-11 18:45:31	miss-islington	set	nosy: + miss-islingtonmessages: +
2018-09-09 07:05:55	python-dev	set	keywords: + patchstage: patch reviewpull_requests: + <pull%5Frequest8574>
2018-09-09 07:00:39	psycojoker	create

Supported by The Python Software Foundation,
Powered by Roundup