bpo-31965: fix doc for multiprocessing.connection.Client and Listener… · python/cpython@1e5d54c (original) (raw)

`@@ -2296,7 +2296,7 @@ multiple connections at the same time.

2296

` If a welcome message is not received, then

2297

`` :exc:~multiprocessing.AuthenticationError is raised.

2298

2299

.. function:: Client(address[, family[, authenticate[, authkey]]])

2299

.. function:: Client(address[, family[, authkey]])

2300

2301

` Attempt to set up a connection to the listener which is using address

2302

`` address, returning a :class:~multiprocessing.Connection.

`@@ -2305,14 +2305,13 @@ multiple connections at the same time.

2305

` generally be omitted since it can usually be inferred from the format of

2306

`` address. (See :ref:multiprocessing-address-formats)

2307

2308


 If *authenticate* is ``True`` or *authkey* is a byte string then digest

2309

authentication is used. The key used for authentication will be either

2310


 *authkey* or ``current_process().authkey`` if *authkey* is ``None``.

2311

If authentication fails then

2312

`` -

:exc:~multiprocessing.AuthenticationError is raised. See

2313

`` -

:ref:multiprocessing-auth-keys.

2308

If authkey is given and not None, it should be a byte string and will be

2309

used as the secret key for an HMAC-based authentication challenge. No

2310

authentication is done if authkey is None.

2311

`` +

:exc:~multiprocessing.AuthenticationError is raised if authentication fails.

2312

`` +

See :ref:multiprocessing-auth-keys.

2314

2313

2315

.. class:: Listener([address[, family[, backlog[, authenticate[, authkey]]]]])

2314

.. class:: Listener([address[, family[, backlog[, authkey]]]])

2316

2315

2317

2316

` A wrapper for a bound socket or Windows named pipe which is 'listening' for

2318

2317

` connections.

`@@ -2341,17 +2340,10 @@ multiple connections at the same time.

2341

2340

`` to the :meth:~socket.socket.listen method of the socket once it has been

2342

2341

` bound.

2343

2342

2344


 If *authenticate* is ``True`` (``False`` by default) or *authkey* is not

2345


 ``None`` then digest authentication is used.

2346

-

2347

If authkey is a byte string then it will be used as the

2348


 authentication key; otherwise it must be ``None``.

2349

-

2350


 If *authkey* is ``None`` and *authenticate* is ``True`` then

2351


 ``current_process().authkey`` is used as the authentication key. If

2352


 *authkey* is ``None`` and *authenticate* is ``False`` then no

2353

authentication is done. If authentication fails then

2354

`` -

:exc:~multiprocessing.AuthenticationError is raised.

2343

If authkey is given and not None, it should be a byte string and will be

2344

used as the secret key for an HMAC-based authentication challenge. No

2345

authentication is done if authkey is None.

2346

`` +

:exc:~multiprocessing.AuthenticationError is raised if authentication fails.

2355

2347

`` See :ref:multiprocessing-auth-keys.

2356

2348

2357

2349

` .. method:: accept()