Commit Graph

64 Commits

Author SHA1 Message Date
Miss Islington (bot) 414d58f745 Clarify that AsyncExitStack works with coroutine functions (GH-9405) (GH-9408)
The docs were ambiguous about whether you pass in a coroutine function
or a coroutine object, e.g. is it:

  aestack.push_async_exit(some_async_func)

or

  aestack.push_async_exit(some_async_func())

(It's the first one.)
(cherry picked from commit a3c88ef12c)

Co-authored-by: Nathaniel J. Smith <njs@pobox.com>
2018-10-05 22:29:17 -04:00
Miss Islington (bot) 1f9621cb9b
Fixed typo with asynccontextmanager code example (GH-8845)
`yield conn`, instead of just `yield`.
(cherry picked from commit 416cbce22d)

Co-authored-by: Alexander Vasin <hi@alvass.in>
2018-08-24 22:51:10 -04:00
Miss Islington (bot) 4e166ffd29 bpo-33468: Add try-finally contextlib.contextmanager example (GH-7816) (GH-8425)
(cherry picked from commit bde782bb59)

Co-authored-by: Matthias Bussonnier <bussonniermatthias@gmail.com>
2018-07-24 00:38:18 +03:00
Miss Islington (bot) 1b6e217304
bpo-34067: Include a more easily understood example for nullcontext (GH-8158)
Include a more easily understood example for nullcontext
(cherry picked from commit c287545d62)

Co-authored-by: Daniel Porteous <danielporteous1@gmail.com>
2018-07-09 07:11:42 -07:00
Ilya Kulakov 1aa094f740 bpo-29302: Implement contextlib.AsyncExitStack. (#4790) 2018-01-25 15:51:18 -05:00
Jelle Zijlstra 176baa326b bpo-30241: implement contextlib.AbstractAsyncContextManager (#1412) 2017-12-13 20:19:17 -05:00
Jesse-Bakker 0784a2e5b1 bpo-10049: Add a "no-op" (null) context manager to contextlib (GH-4464)
Adds a simpler and faster alternative to ExitStack for handling
single optional context managers without having to change the
lexical structure of your code.
2017-11-23 10:23:28 +10:00
Jelle Zijlstra 2e624690bd bpo-29679: Implement @contextlib.asynccontextmanager (#360) 2017-04-30 18:25:58 -07:00
Vinay Sajip dd917f84e3 Closes #27904: Improved logging statements to defer formatting until needed. 2016-08-31 08:22:29 +01:00
Brett Cannon 516f5461b0 Add a missing :term:. 2016-06-09 15:55:52 -07:00
Serhiy Storchaka c499f30286 Issue #23921: Standardized documentation whitespace formatting.
Original patch by James Edwards.
2016-05-10 12:01:56 +03:00
Serhiy Storchaka dba903993a Issue #23921: Standardized documentation whitespace formatting.
Original patch by James Edwards.
2016-05-10 12:01:23 +03:00
Brett Cannon 9e080e0e74 Issue #25609: Introduce contextlib.AbstractContextManager and
typing.ContextManager.
2016-04-08 12:15:27 -07:00
Serhiy Storchaka e4ba872543 Remove redundant leading zeroes in PEP references. 2016-03-31 15:30:54 +03:00
Serhiy Storchaka a84f6c3dd3 Issue #25523: Merge a-to-an corrections from 3.4. 2015-11-02 14:39:05 +02:00
Serhiy Storchaka d65c9496da Issue #25523: Further a-to-an corrections. 2015-11-02 14:10:23 +02:00
Martin Panter 84835ab1cb Issue #25161: Merge full stops from 3.4 into 3.5 2015-10-10 10:44:25 +00:00
Martin Panter d21e0b52f1 Issue #25161: Add full stops in documentation; patch by Takase Arihiro 2015-10-10 10:36:22 +00:00
Berker Peksag bb44fe0a0b Issue #22389: Add contextlib.redirect_stderr(). 2014-11-28 23:28:06 +02:00
Nick Coghlan 36d8ef9cc7 Issue #21061: correctly note redirect_stdout is reentrant 2014-10-12 10:25:00 +10:00
Terry Jan Reedy f9bd920cfa Issue 22603: add missing 'self'. Patch by Francisco Fernández Castaño. 2014-10-10 16:00:18 -04:00
Raymond Hettinger e8e2df3daa Issue 21558: Fix a typo in the contextlib docs 2014-05-25 18:06:04 -07:00
Nick Coghlan 8e113b418d Close #19403: make contextlib.redirect_stdout reentrant 2013-11-03 17:00:51 +10:00
Nick Coghlan 0acceb7697 What's New updates prior to alpha 2013-10-20 13:22:21 +10:00
Nick Coghlan 8608d26e81 contextlib doc updates and refactoring
- explain single use, reusable and reentrant in docs
- converted suppress to a reentrant class based impl
- converted redirect_stdout to a reusable impl
- moved both suppress and redirect_stdout behind a functional
  facade
- added reentrancy tests for the updated suppress
- added reusability tests for the updated redirect_stdio
- slightly cleaned up an exception from contextmanager
2013-10-20 00:30:51 +10:00
Nick Coghlan 240f86d7dd Close #19266: contextlib.ignore -> contextlib.suppress
Patch by Zero Piraeus.
2013-10-17 23:40:57 +10:00
Georg Brandl a7c17e552d Fix spacing of toplevel items. 2013-10-13 22:25:10 +02:00
Nick Coghlan b4534ae704 Docs tweaks for contextlib additions 2013-10-13 23:23:08 +10:00
Raymond Hettinger 1254b407ac Rename contextlib.ignored() to contextlib.ignore(). 2013-10-10 22:39:39 -07:00
Raymond Hettinger 088cbf2d39 Issue #15805: Add contextlib.redirect_stdout() 2013-10-10 00:46:57 -07:00
Barry Warsaw 8c01ffa6ed Merge 3.3 2013-05-10 11:36:23 -04:00
Barry Warsaw d8f870d0fa I was confused before. It's correct to not call .close() inside the with
statement, but add a comment that clarifies the purpose of the code.
2013-05-10 11:35:38 -04:00
Barry Warsaw 24aa15959b Merge 3.3 2013-04-19 11:32:54 -04:00
Barry Warsaw 0aa685a33c Minor typo in example. 2013-04-19 11:32:25 -04:00
Ned Deily 05bdd853ec Issue #17586: fix typo in contextlib.rst 2013-03-31 17:06:15 -07:00
Ezio Melotti a41fb4be5b #17351: merge with 3.3. 2013-03-11 09:43:25 +02:00
Ezio Melotti c9cfcf1e6c #17351: merge with 3.2. 2013-03-11 09:42:40 +02:00
Raymond Hettinger e318a883fe Issue #15806: Add contextlib.ignored(). 2013-03-10 22:26:51 -07:00
Andrew Svetlov 5b89840d9c Issue #16714: use 'raise' exceptions, don't 'throw'.
Patch by Serhiy Storchaka.
2012-12-18 21:26:36 +02:00
Nick Coghlan b7a455f326 Typo fix 2012-05-31 22:34:59 +10:00
Nick Coghlan 2722827071 Additional ExitStack examples, and a few other cleanups for the ExitStack docs 2012-05-31 22:17:08 +10:00
Nick Coghlan a497b44238 Fix the versionadded tags for a couple of my recent changes 2012-05-22 23:02:00 +10:00
Nick Coghlan 3267a30de1 Close #13585: add contextlib.ExitStack to replace the ill-fated contextlib.nested API 2012-05-21 22:54:43 +10:00
Nick Coghlan 0ded3e307b Issue #11647: allow contextmanager objects to be used as decorators as described in the docs. Initial patch by Ysj Ray. 2011-05-05 23:49:25 +10:00
Raymond Hettinger 4f707fd316 Separate source link from main text. 2011-01-10 19:54:11 +00:00
Raymond Hettinger 1048094037 Move source links to consistent location and remove wordy, big yellow boxes. 2011-01-10 03:26:08 +00:00
Éric Araujo 6e6cb8e0e4 Provide links to Python source where the code is short, readable and
informative adjunct to the docs.  Forward-port of Raymond's r86225 and
r86245 using the new source reST role added in #10334.
2010-11-16 19:13:50 +00:00
Georg Brandl 8a1caa2361 #6522: add a "decorator" directive to explicitly document decorators, and use it in a few places. 2010-07-29 16:01:11 +00:00
Georg Brandl 86e78d1f2d #9110: update to ContextDecorator doc. 2010-07-18 13:43:32 +00:00
Michael Foord b3a8984488 Issue 9110. Adding ContextDecorator to contextlib. This enables the creation of APIs that act as decorators as well as context managers. contextlib.contextmanager changed to use ContextDecorator. 2010-06-30 12:17:50 +00:00