classification
Title: New asyncio streams API
Type: Stage: patch review
Components: Versions:
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: Nosy List: asvetlov
Priority: normal Keywords: patch

Created on 2018-09-11 21:18 by asvetlov, last changed 2018-09-11 21:18 by asvetlov.

Pull Requests
URL Status Linked Edit
PR 9183 open asvetlov, 2018-09-11 21:18
Messages (1)
msg325064 - (view) Author: Andrew Svetlov (asvetlov) * (Python committer) Date: 2018-09-11 21:18
Currently, we have separate classes: reader and writer.

It is very inconvenient: these classes are tightly coupled internally, there is no sense to have two objects to the single logical entity.

The second problem is `writer.write()` synchronous API. To support flow control user should call `await writer.drain()` after every `writer.write()` call. But he/she can forget about drain() easy.

`writer.write()` should be softly deprecated in favor of `await writer.send()`. `writer.writelines()` is not very useful, better to merge all buffers before `await stream.send(data)` call. `writelines` should be softly deprecated as well without async replacement.

The last issue is `writer.close()` which should always be used in conjunction with `await writer.wait_closed()`. Let's return a future from `writer.close()`. The encouraged usage becomes `await writer.close()`. 
To immediate closing let's add `writer.abort()` sync function which cleans up resources without waiting for actual closing.
History
Date User Action Args
2018-09-11 21:18:54asvetlovsetkeywords: + patch
stage: patch review
pull_requests: + pull_request8621
2018-09-11 21:18:02asvetlovcreate