Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity
118,448 Commits 6 Branches 593 Tags 2.8 GiB
Commit Graph

73 Commits

Author SHA1 Message Date
Jan Gosmann 77d95c8373
gh-100226: Clarify StreamReader.read behavior (#101807) 2023-02-17 13:01:26 -08:00
Viet Than 5c39daf50b
gh-100920: Update documentation for `asyncio.StreamWriter.wait_closed` (#101514) 2023-02-03 12:48:39 +05:30
beavailable cc407b9de6
gh-101317: Add `ssl_shutdown_timeout` parameter for `asyncio.StreamWriter.start_tls` (#101335) 
Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
 2023-02-01 16:33:59 +05:30
busywhitespace 9663853800
gh-100248: Add missing `ssl_shutdown_timeout` parameter in `asyncio` docs (#100249) 2022-12-14 22:27:02 +05:30
Stanley 4196ee5c8b
gh-84747: Add `async for` comment for StreamReader (#98633) 2022-10-25 19:16:18 -07:00
Guido van Rossum 74ea204634
GH-88968: Add notes about socket ownership transfers (#97936) 2022-10-05 16:42:01 -07:00
Adam Turner 0efe3a1636
gh-86986: Drop compatibility support for Sphinx 2 (GH-93737) 
* Revert "bpo-42843: Keep Sphinx 1.8 and Sphinx 2 compatibility (GH-24282)"

This reverts commit 5c1f15b4b1

* Revert "bpo-42579: Make workaround for various versions of Sphinx more robust (GH-23662)"

This reverts commit b63a620014.
 2022-06-21 17:04:46 +02:00
Oleg Iarygin 063e8ab72b
Fix the `versionadded` for asyncio.StreamWriter.start_tls() (#92378) 2022-05-08 08:44:54 -07:00
Oleg Iarygin 6217864fe5
gh-79156: Add start_tls() method to streams API (#91453) 
The existing event loop `start_tls()` method is not sufficient for
connections using the streams API. The existing StreamReader works
because the new transport passes received data to the original protocol.
The StreamWriter must then write data to the new transport, and the
StreamReaderProtocol must be updated to close the new transport
correctly.

The new StreamWriter `start_tls()` updates itself and the reader
protocol to the new SSL transport.

Co-authored-by: Ian Good <icgood@gmail.com>
 2022-04-15 14:23:14 +02:00
Illia Volochii 3543ddb4c4
bpo-43215: Document Happy Eyeballs args of asyncio.open_connection (GH-24525) 
Co-authored-by: Andrew Svetlov <andrew.svetlov@gmail.com>
 2022-03-13 01:54:59 +02:00
Serhiy Storchaka 2923d87ca2
bpo-46777: Fix incorrect use of directives in asyncio documentation (GH-31388) 2022-02-18 10:58:48 +02:00
Sergey Kolesnikov e0f8a3e9b9
Add missing 'await writer.drain()' call to example (GH-29162) 
Automerge-Triggered-By: GH:asvetlov
 2021-11-25 09:15:24 -08:00
Olaf van der Spek 659812b451
bpo-45351, asyncio: Enhance echo server example, print all addresses (GH-28828) 2021-10-11 20:54:44 +02:00
Ken Jin d8fd8c8568
bpo-42392: [docs] Add deprecated-removed loop labels for asyncio (GH-26357) 
* Add deprecated-removed loop labels for all reelvant functions/classes in asyncio
 2021-05-26 14:59:34 -07:00
Julien Palard 5c1f15b4b1
bpo-42843: Keep Sphinx 1.8 and Sphinx 2 compatibility (GH-24282) 2021-01-25 15:46:06 +01:00
Andre Delfino dcc997cd28
[doc] Fix erroneous backslashes in signatures and names (GH-23658) 
The issue being resolved is shown in the 3.10 docs (if you select docs for older versions you won't see a visual glitch).

The newer sphinx version that produces the 3.10 docs doesn't treat the backslash to escape things in some situations it previously did.
 2020-12-16 17:37:28 -08:00
Yurii Karabas 86150d39c8
bpo-42392: Remove deprecated loop parameter from docs (GH-23552) 2020-11-29 14:50:57 +02:00
Serhiy Storchaka 138ccbb022
bpo-38738: Fix formatting of True and False. (GH-17083) 
* "Return true/false" is replaced with "Return ``True``/``False``"
  if the function actually returns a bool.
* Fixed formatting of some True and False literals (now in monospace).
* Replaced "True/False" with "true/false" if it can be not only bool.
* Replaced some 1/0 with True/False if it corresponds the code.
* "Returns <bool>" is replaced with "Return <bool>".
 2019-11-12 16:57:03 +02:00
Kyle Stanley f900064ac4 docs: Add asyncio source code links (GH-16640) 2019-10-10 19:18:46 -04:00
Yury Selivanov 6758e6e12a
bpo-38242: Revert "bpo-36889: Merge asyncio streams (GH-13251)" (#16482) 
See https://bugs.python.org/issue38242 for more details
 2019-09-29 21:59:55 -07:00
Xtreak d31b31516c bpo-36889: Document Stream class and add docstrings (GH-14488) 
* This just copies the docs from `StreamWriter` and `StreamReader`.
* Add docstring for asyncio functions.


https://bugs.python.org/issue36889



Automerge-Triggered-By: @asvetlov
 2019-09-13 03:52:38 -07:00
Xtreak 6793cce155 bpo-36889: Document asyncio Stream and StreamServer (GH-14203) 2019-06-24 21:16:58 +03:00
Emmanuel Arias ed9f3562b6 bpo-37105: Add deprecated-remove information on stream doc (#13672) 
* Add deprecated-remove information on stream doc

According to the code on streams.py the functions:
``open_connection()``, ``start_server()``, ``open_unix_connection()``,
``start_unix_server()`` are deprecated. I infor that on
documentation.
 2019-05-31 23:48:57 +03:00
Andrew Svetlov a076e4f5e4
bpo-36802: Drop awrite()/aclose(), support await write() and await close() instead (#13099) 2019-05-09 15:14:58 -04:00
Cheryl Sabella 2d6097d027 bpo-11233: Create availability directive for documentation (GH-9692) 
Replace "Availability: xxx" with ".. availability:: xxx" in the doc.
Original patch by Georg Brandl.

Co-Authored-By: Georg Brandl <georg@python.org>
 2018-10-12 16:55:20 +02:00
Elvis Pranskevichus 1fa2ec49be bpo-33649: A copy-editing pass on asyncio documentation (GH-9376) 2018-09-17 19:16:44 -04:00
Yury Selivanov 394374e30c
bpo-33649: Add low-level APIs index. (GH-9364) 2018-09-17 15:35:24 -04:00
Yury Selivanov 7372c3bbef
bpo-33649: Add high-level APIs cheat-sheet (GH-9319) 2018-09-14 15:11:24 -07:00
Andrew Svetlov 11194c877c
bpo-34666: Implement stream.awrite() and stream.aclose() (GH-9274) 2018-09-13 16:53:49 -07:00
Yury Selivanov 8be876e44b
bpo-33649: Cleanup asyncio/streams and asyncio/synchronization docs (GH-9192) 2018-09-11 17:10:37 -07:00
Bram b4ec36200a bpo-34613: document the correct value of limit argument of asyncio.StreamReader (GH-9121) 
The default value of asyncio.StreamReader *limit* is `_DEFAULT_LIMIT` instead of `None`.

<!-- issue-number: [bpo-34613](https://www.bugs.python.org/issue34613) -->
https://bugs.python.org/issue34613
<!-- /issue-number -->
 2018-09-11 11:45:26 -07:00
Yury Selivanov 7c7605ff11
bpo-33649: First asyncio docs improvement pass (GH-9142) 
Rewritten/updated sections:

* Event Loop APIs
* Transports & Protocols
* Streams
* Exceptions
* Policies
* Queues
* Subprocesses
* Platforms
 2018-09-11 09:54:40 -07:00
Mikhail Terekhov d2ac400267 bpo-34335: Use async/await syntax in documentation examples (GH-8674) 2018-08-07 13:29:06 -07:00
Elvis Pranskevichus c0d062f523 bpo-33736: Improve the documentation of asyncio stream APIs (GH-7326) 2018-06-08 11:36:00 -04:00
Andrew Svetlov fe133aad52
bpo-32391: Implement StreamWriter.wait_closed() (#5281) 2018-01-25 00:30:30 +02:00
Andrew Svetlov 8874342cf3
bpo-32258: Replace 'yield from' to 'await' in asyncio docs (#4779) 
* Replace 'yield from' to 'await' in asyncio docs

* Fix docstrings
 2017-12-11 17:35:49 +02:00
Victor Stinner ac577d7d0b
bpo-32154: Remove asyncio.windows_utils.socketpair (#4609) 2017-11-28 21:33:20 +01:00
lf 627d2c8e8d Add the link to asyncio source code in the docs (GH-2373) 2017-07-25 16:03:51 -07:00
Berker Peksag e5b0bd1ba2 Fix default value of StreamReader.readuntil() 
Reported by Sam Lunt on docs@p.o.
 2016-10-18 00:34:46 +03:00
Guido van Rossum f68afd8544 Issue #27700: Document AbstractEventLoop, not BaseEventLoop. 2016-08-08 09:41:21 -07:00
Yury Selivanov 950204df9c docs: Update asyncio docs & whatsnew 2016-05-16 16:23:00 -04:00
Jesus Cea ded4c4967b Trivial typo 2016-04-19 21:50:19 +02:00
Ned Deily f38c93fb7f Issue #26368: fix typo in asynchio stream doc, reported by Ryan Stuart. 2016-02-16 13:27:04 +11:00
Yury Selivanov cba0053bef docs/asyncio: Twek sections names per Nick Coghlan suggestion 2015-12-16 21:30:52 -05:00
Guido van Rossum 19ff6977a7 Issue #24885: Update note in docs about stream convenience functions. 2015-10-19 13:18:04 -07:00
R David Murray 87d0066f1a Fix English phrasing. 2015-09-27 12:36:19 -04:00
Serhiy Storchaka 0424eaf753 Marked keystrokes with the :kbd: role. 
Fixed the case of the "Ctrl-" prefixes.
 2015-09-12 17:45:25 +03:00
Yury Selivanov d7e19bb566 docs/asyncio: Document new ensure_future() and deprecated async() 2015-05-11 16:33:41 -04:00
Victor Stinner 83704963c0 asyncio: add a note about (non) thread safety in each class 2015-02-25 14:24:15 +01:00
Victor Stinner bdd574d09a asyncio doc: annotate coroutine on coroutine functions and methods 2015-02-12 22:49:18 +01:00