Clarifications :

• Stream object has mode that is an Enum. Does mode and enum values should be documented? StreamServer and connect that is recommended return Stream with READWRITE value.
• Given that StreamReader and StreamWriter are merged together should I copy paste their methods to Stream?
• StreamServer and UnixStreamServer have very similar API. I have copy pasted them but does it make sense to just redirect the user with a note to StreamServer that the methods are similar.

Thanks

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

I have made the requested changes; please review again

• Added doc for connect_read_pipe and connect_write_pipe. I have added a note that they can be used as context manager.
• Modified all the examples to use context managers.
• write calls are awaited.
• Changed enter to __aenter__ and exit to __aexit__.
• Added all public methods to StreamServer and also updated UnixStreamServer.

Clarifications :

• I feel StreamServer and UnixStreamServer are almost exact duplicates. Can UnixStreamServer be added a note that it provides all methods as StreamServer? The downside is that user who visits UnixStreamServer is redirected to StreamServer that there is a slight redirection overhead.
• I have documented connect_read_pipe and connect_write_pipe similar that they return Stream object of READ and Write mode. Should we document the StreamMode Enum?

Thanks for making the requested changes!

@asvetlov: please review the changes made to this pull request.

I feel StreamServer and UnixStreamServer are almost exact duplicates. Can UnixStreamServer be added a note that it provides all methods as StreamServer? The downside is that user who visits UnixStreamServer is redirected to StreamServer that there is a slight redirection overhead.

I don't know. I don't want to make their base class public, so duplication is probably ok. We keep references is a good shape at least.

I have documented connect_read_pipe and connect_write_pipe similar that they return Stream object of READ and Write mode. Should we document the StreamMode Enum?

Yes, please do. StreamMode is a public class

Changes made :

• Documented StreamMode and it's values. Linked the mode values in relevant places like connect, connect_unix, etc.
• Used PEP 572 in example for while loop.
• Added doc for constructor arguments in StreamServer and UnixStreamServer and a note on rest of the arguments.
• Added doc for limit parameter to the functions.
• Minor doc fixes to use double backticks and added more links to relevant StreamMode docs.

Please review the changes. Thanks.

Thanks @tirkarthi for the PR, and @asvetlov for merging it 🌮🎉.. I'm working now to backport this PR to: 3.8.
🐍🍒⛏🤖

GH-14349 is a backport of this pull request to the 3.8 branch.

Thank you very much for the guidance Andrew :)