Skip to content

bpo-33649: Clarify protocol_factory as a method parameter #9330

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

Merged
merged 1 commit into from
Sep 16, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 17 additions & 4 deletions Doc/library/asyncio-eventloop.rst
Original file line number Diff line number Diff line change
Expand Up @@ -535,6 +535,9 @@ Creating network servers

Arguments:

* *protocol_factory* must be a callable returning a
:ref:`protocol <asyncio-protocol>` implementation.

* The *host* parameter can be set to several types which determine behavior:
- If *host* is a string, the TCP server is bound to *host* and *port*.
- if *host* is a sequence of strings, the TCP server is bound to all
Expand Down Expand Up @@ -617,6 +620,9 @@ Creating network servers
:class:`str`, :class:`bytes`, and :class:`~pathlib.Path` paths
are supported.

See the documentation of the :meth:`loop.create_server` method
for information about arguments to this method.

Availability: UNIX.

.. versionadded:: 3.7
Expand All @@ -637,6 +643,9 @@ Creating network servers

Parameters:

* *protocol_factory* must be a callable returning a
:ref:`protocol <asyncio-protocol>` implementation.

* *sock* is a preexisting socket object returned from
:meth:`socket.accept <socket.socket.accept>`.

Expand Down Expand Up @@ -909,7 +918,8 @@ Working with pipes
*pipe* is a :term:`file-like object <file object>`.

Return pair ``(transport, protocol)``, where *transport* supports
the :class:`ReadTransport` interface.
the :class:`ReadTransport` interface and *protocol* is an object
instantiated by the *protocol_factory*.

With :class:`SelectorEventLoop` event loop, the *pipe* is set to
non-blocking mode.
Expand All @@ -924,7 +934,8 @@ Working with pipes
*pipe* is :term:`file-like object <file object>`.

Return pair ``(transport, protocol)``, where *transport* supports
:class:`WriteTransport` interface.
:class:`WriteTransport` interface and *protocol* is an object
instantiated by the *protocol_factory*.

With :class:`SelectorEventLoop` event loop, the *pipe* is set to
non-blocking mode.
Expand Down Expand Up @@ -1159,7 +1170,8 @@ async/await code consider using high-level convenient
for documentation on other arguments.

Returns a pair of ``(transport, protocol)``, where *transport*
conforms to the :class:`asyncio.SubprocessTransport` base class.
conforms to the :class:`asyncio.SubprocessTransport` base class and
*protocol* is an object instantiated by the *protocol_factory*.

.. coroutinemethod:: loop.subprocess_shell(protocol_factory, cmd, \*, \
stdin=subprocess.PIPE, stdout=subprocess.PIPE, \
Expand All @@ -1180,7 +1192,8 @@ async/await code consider using high-level convenient
the remaining arguments.

Returns a pair of ``(transport, protocol)``, where *transport*
conforms to the :class:`SubprocessTransport` base class.
conforms to the :class:`SubprocessTransport` base class and
*protocol* is an object instantiated by the *protocol_factory*.

.. note::
It is the application's responsibility to ensure that all whitespace
Expand Down