2018-12-19 02:09:46 -04:00
|
|
|
:mod:`!contextlib` --- Utilities for :keyword:`!with`\ -statement contexts
|
|
|
|
==========================================================================
|
2007-08-15 11:28:22 -03:00
|
|
|
|
|
|
|
.. module:: contextlib
|
|
|
|
:synopsis: Utilities for with-statement contexts.
|
|
|
|
|
2011-01-09 23:26:08 -04:00
|
|
|
**Source code:** :source:`Lib/contextlib.py`
|
2007-08-15 11:28:22 -03:00
|
|
|
|
2011-01-10 15:54:11 -04:00
|
|
|
--------------
|
|
|
|
|
2007-08-15 11:28:22 -03:00
|
|
|
This module provides utilities for common tasks involving the :keyword:`with`
|
|
|
|
statement. For more information see also :ref:`typecontextmanager` and
|
|
|
|
:ref:`context-managers`.
|
|
|
|
|
|
|
|
|
2012-05-21 09:54:43 -03:00
|
|
|
Utilities
|
|
|
|
---------
|
|
|
|
|
|
|
|
Functions and classes provided:
|
2007-08-15 11:28:22 -03:00
|
|
|
|
2016-04-08 16:15:27 -03:00
|
|
|
.. class:: AbstractContextManager
|
|
|
|
|
2016-06-09 19:55:52 -03:00
|
|
|
An :term:`abstract base class` for classes that implement
|
2016-04-08 16:15:27 -03:00
|
|
|
:meth:`object.__enter__` and :meth:`object.__exit__`. A default
|
|
|
|
implementation for :meth:`object.__enter__` is provided which returns
|
|
|
|
``self`` while :meth:`object.__exit__` is an abstract method which by default
|
|
|
|
returns ``None``. See also the definition of :ref:`typecontextmanager`.
|
|
|
|
|
|
|
|
.. versionadded:: 3.6
|
|
|
|
|
|
|
|
|
2017-12-13 21:19:17 -04:00
|
|
|
.. class:: AbstractAsyncContextManager
|
|
|
|
|
|
|
|
An :term:`abstract base class` for classes that implement
|
|
|
|
:meth:`object.__aenter__` and :meth:`object.__aexit__`. A default
|
|
|
|
implementation for :meth:`object.__aenter__` is provided which returns
|
|
|
|
``self`` while :meth:`object.__aexit__` is an abstract method which by default
|
|
|
|
returns ``None``. See also the definition of
|
|
|
|
:ref:`async-context-managers`.
|
|
|
|
|
|
|
|
.. versionadded:: 3.7
|
|
|
|
|
2016-04-08 16:15:27 -03:00
|
|
|
|
2010-07-29 13:01:11 -03:00
|
|
|
.. decorator:: contextmanager
|
2007-08-15 11:28:22 -03:00
|
|
|
|
Merged revisions 59259-59274 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk
........
r59260 | lars.gustaebel | 2007-12-01 22:02:12 +0100 (Sat, 01 Dec 2007) | 5 lines
Issue #1531: Read fileobj from the current offset, do not seek to
the start.
(will backport to 2.5)
........
r59262 | georg.brandl | 2007-12-01 23:24:47 +0100 (Sat, 01 Dec 2007) | 4 lines
Document PyEval_* functions from ceval.c.
Credits to Michael Sloan from GHOP.
........
r59263 | georg.brandl | 2007-12-01 23:27:56 +0100 (Sat, 01 Dec 2007) | 2 lines
Add a few refcount data entries.
........
r59264 | georg.brandl | 2007-12-01 23:38:48 +0100 (Sat, 01 Dec 2007) | 4 lines
Add test suite for cmd module.
Written by Michael Schneider for GHOP.
........
r59265 | georg.brandl | 2007-12-01 23:42:46 +0100 (Sat, 01 Dec 2007) | 3 lines
Add examples to the ElementTree documentation.
Written by h4wk.cz for GHOP.
........
r59266 | georg.brandl | 2007-12-02 00:12:45 +0100 (Sun, 02 Dec 2007) | 3 lines
Add "Using Python on Windows" document, by Robert Lehmann.
Written for GHOP.
........
r59271 | georg.brandl | 2007-12-02 15:34:34 +0100 (Sun, 02 Dec 2007) | 3 lines
Add example to mmap docs.
Written for GHOP by Rafal Rawicki.
........
r59272 | georg.brandl | 2007-12-02 15:37:29 +0100 (Sun, 02 Dec 2007) | 2 lines
Convert bdb.rst line endings to Unix style.
........
r59274 | georg.brandl | 2007-12-02 15:58:50 +0100 (Sun, 02 Dec 2007) | 4 lines
Add more entries to the glossary.
Written by Jeff Wheeler for GHOP.
........
2007-12-02 11:22:16 -04:00
|
|
|
This function is a :term:`decorator` that can be used to define a factory
|
|
|
|
function for :keyword:`with` statement context managers, without needing to
|
|
|
|
create a class or separate :meth:`__enter__` and :meth:`__exit__` methods.
|
2007-08-15 11:28:22 -03:00
|
|
|
|
2018-07-23 18:10:56 -03:00
|
|
|
While many objects natively support use in with statements, sometimes a
|
|
|
|
resource needs to be managed that isn't a context manager in its own right,
|
|
|
|
and doesn't implement a ``close()`` method for use with ``contextlib.closing``
|
|
|
|
|
|
|
|
An abstract example would be the following to ensure correct resource
|
|
|
|
management::
|
2007-08-15 11:28:22 -03:00
|
|
|
|
|
|
|
from contextlib import contextmanager
|
|
|
|
|
|
|
|
@contextmanager
|
2018-07-23 18:10:56 -03:00
|
|
|
def managed_resource(*args, **kwds):
|
|
|
|
# Code to acquire resource, e.g.:
|
|
|
|
resource = acquire_resource(*args, **kwds)
|
|
|
|
try:
|
|
|
|
yield resource
|
|
|
|
finally:
|
|
|
|
# Code to release resource, e.g.:
|
|
|
|
release_resource(resource)
|
|
|
|
|
|
|
|
>>> with managed_resource(timeout=3600) as resource:
|
|
|
|
... # Resource is released at the end of this block,
|
|
|
|
... # even if code in the block raises an exception
|
2007-08-15 11:28:22 -03:00
|
|
|
|
#1370: Finish the merge r58749, log below, by resolving all conflicts in Doc/.
Merged revisions 58221-58741 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk
........
r58221 | georg.brandl | 2007-09-20 10:57:59 -0700 (Thu, 20 Sep 2007) | 2 lines
Patch #1181: add os.environ.clear() method.
........
r58225 | sean.reifschneider | 2007-09-20 23:33:28 -0700 (Thu, 20 Sep 2007) | 3 lines
Issue1704287: "make install" fails unless you do "make" first. Make
oldsharedmods and sharedmods in "libinstall".
........
r58232 | guido.van.rossum | 2007-09-22 13:18:03 -0700 (Sat, 22 Sep 2007) | 4 lines
Patch # 188 by Philip Jenvey.
Make tell() mark CRLF as a newline.
With unit test.
........
r58242 | georg.brandl | 2007-09-24 10:55:47 -0700 (Mon, 24 Sep 2007) | 2 lines
Fix typo and double word.
........
r58245 | georg.brandl | 2007-09-24 10:59:28 -0700 (Mon, 24 Sep 2007) | 2 lines
#1196: document default radix for int().
........
r58247 | georg.brandl | 2007-09-24 11:08:24 -0700 (Mon, 24 Sep 2007) | 2 lines
#1177: accept 2xx responses for https too, not only http.
........
r58249 | andrew.kuchling | 2007-09-24 16:45:51 -0700 (Mon, 24 Sep 2007) | 1 line
Remove stray odd character; grammar fix
........
r58250 | andrew.kuchling | 2007-09-24 16:46:28 -0700 (Mon, 24 Sep 2007) | 1 line
Typo fix
........
r58251 | andrew.kuchling | 2007-09-24 17:09:42 -0700 (Mon, 24 Sep 2007) | 1 line
Add various items
........
r58268 | vinay.sajip | 2007-09-26 22:34:45 -0700 (Wed, 26 Sep 2007) | 1 line
Change to flush and close logic to fix #1760556.
........
r58269 | vinay.sajip | 2007-09-26 22:38:51 -0700 (Wed, 26 Sep 2007) | 1 line
Change to basicConfig() to fix #1021.
........
r58270 | georg.brandl | 2007-09-26 23:26:58 -0700 (Wed, 26 Sep 2007) | 2 lines
#1208: document match object's boolean value.
........
r58271 | vinay.sajip | 2007-09-26 23:56:13 -0700 (Wed, 26 Sep 2007) | 1 line
Minor date change.
........
r58272 | vinay.sajip | 2007-09-27 00:35:10 -0700 (Thu, 27 Sep 2007) | 1 line
Change to LogRecord.__init__() to fix #1206. Note that archaic use of type(x) == types.DictType is because of keeping 1.5.2 compatibility. While this is much less relevant these days, there probably needs to be a separate commit for removing all archaic constructs at the same time.
........
r58288 | brett.cannon | 2007-09-30 12:45:10 -0700 (Sun, 30 Sep 2007) | 9 lines
tuple.__repr__ did not consider a reference loop as it is not possible from
Python code; but it is possible from C. object.__str__ had the issue of not
expecting a type to doing something within it's tp_str implementation that
could trigger an infinite recursion, but it could in C code.. Both found
thanks to BaseException and how it handles its repr.
Closes issue #1686386. Thanks to Thomas Herve for taking an initial stab at
coming up with a solution.
........
r58289 | brett.cannon | 2007-09-30 13:37:19 -0700 (Sun, 30 Sep 2007) | 3 lines
Fix error introduced by r58288; if a tuple is length 0 return its repr and
don't worry about any self-referring tuples.
........
r58294 | facundo.batista | 2007-10-02 10:01:24 -0700 (Tue, 02 Oct 2007) | 11 lines
Made the various is_* operations return booleans. This was discussed
with Cawlishaw by mail, and he basically confirmed that to these is_*
operations, there's no need to return Decimal(0) and Decimal(1) if
the language supports the False and True booleans.
Also added a few tests for the these functions in extra.decTest, since
they are mostly untested (apart from the doctests).
Thanks Mark Dickinson
........
r58295 | facundo.batista | 2007-10-02 11:21:18 -0700 (Tue, 02 Oct 2007) | 4 lines
Added a class to store the digits of log(10), so that they can be made
available when necessary without recomputing. Thanks Mark Dickinson
........
r58299 | mark.summerfield | 2007-10-03 01:53:21 -0700 (Wed, 03 Oct 2007) | 4 lines
Added note in footnote about string comparisons about
unicodedata.normalize().
........
r58304 | raymond.hettinger | 2007-10-03 14:18:11 -0700 (Wed, 03 Oct 2007) | 1 line
enumerate() is no longer bounded to using sequences shorter than LONG_MAX. The possibility of overflow was sending some newsgroup posters into a tizzy.
........
r58305 | raymond.hettinger | 2007-10-03 17:20:27 -0700 (Wed, 03 Oct 2007) | 1 line
itertools.count() no longer limited to sys.maxint.
........
r58306 | kurt.kaiser | 2007-10-03 18:49:54 -0700 (Wed, 03 Oct 2007) | 3 lines
Assume that the user knows when he wants to end the line; don't insert
something he didn't select or complete.
........
r58307 | kurt.kaiser | 2007-10-03 19:07:50 -0700 (Wed, 03 Oct 2007) | 2 lines
Remove unused theme that was causing a fault in p3k.
........
r58308 | kurt.kaiser | 2007-10-03 19:09:17 -0700 (Wed, 03 Oct 2007) | 2 lines
Clean up EditorWindow close.
........
r58309 | kurt.kaiser | 2007-10-03 19:53:07 -0700 (Wed, 03 Oct 2007) | 7 lines
textView cleanup. Patch 1718043 Tal Einat.
M idlelib/EditorWindow.py
M idlelib/aboutDialog.py
M idlelib/textView.py
M idlelib/NEWS.txt
........
r58310 | kurt.kaiser | 2007-10-03 20:11:12 -0700 (Wed, 03 Oct 2007) | 3 lines
configDialog cleanup. Patch 1730217 Tal Einat.
........
r58311 | neal.norwitz | 2007-10-03 23:00:48 -0700 (Wed, 03 Oct 2007) | 4 lines
Coverity #151: Remove deadcode.
All this code already exists above starting at line 653.
........
r58325 | fred.drake | 2007-10-04 19:46:12 -0700 (Thu, 04 Oct 2007) | 1 line
wrap lines to <80 characters before fixing errors
........
r58326 | raymond.hettinger | 2007-10-04 19:47:07 -0700 (Thu, 04 Oct 2007) | 6 lines
Add __asdict__() to NamedTuple and refine the docs.
Add maxlen support to deque() and fixup docs.
Partially fix __reduce__(). The None as a third arg was no longer supported.
Still needs work on __reduce__() to handle recursive inputs.
........
r58327 | fred.drake | 2007-10-04 19:48:32 -0700 (Thu, 04 Oct 2007) | 3 lines
move descriptions of ac_(in|out)_buffer_size to the right place
http://bugs.python.org/issue1053
........
r58329 | neal.norwitz | 2007-10-04 20:39:17 -0700 (Thu, 04 Oct 2007) | 3 lines
dict could be NULL, so we need to XDECREF.
Fix a compiler warning about passing a PyTypeObject* instead of PyObject*.
........
r58330 | neal.norwitz | 2007-10-04 20:41:19 -0700 (Thu, 04 Oct 2007) | 2 lines
Fix Coverity #158: Check the correct variable.
........
r58332 | neal.norwitz | 2007-10-04 22:01:38 -0700 (Thu, 04 Oct 2007) | 7 lines
Fix Coverity #159.
This code was broken if save() returned a negative number since i contained
a boolean value and then we compared i < 0 which should never be true.
Will backport (assuming it's necessary)
........
r58334 | neal.norwitz | 2007-10-04 22:29:17 -0700 (Thu, 04 Oct 2007) | 1 line
Add a note about fixing some more warnings found by Coverity.
........
r58338 | raymond.hettinger | 2007-10-05 12:07:31 -0700 (Fri, 05 Oct 2007) | 1 line
Restore BEGIN/END THREADS macros which were squashed in the previous checkin
........
r58343 | gregory.p.smith | 2007-10-06 00:48:10 -0700 (Sat, 06 Oct 2007) | 3 lines
Stab in the dark attempt to fix the test_bsddb3 failure on sparc and S-390
ubuntu buildbots.
........
r58344 | gregory.p.smith | 2007-10-06 00:51:59 -0700 (Sat, 06 Oct 2007) | 2 lines
Allows BerkeleyDB 4.6.x >= 4.6.21 for the bsddb module.
........
r58348 | gregory.p.smith | 2007-10-06 08:47:37 -0700 (Sat, 06 Oct 2007) | 3 lines
Use the host the author likely meant in the first place. pop.gmail.com is
reliable. gmail.org is someones personal domain.
........
r58351 | neal.norwitz | 2007-10-06 12:16:28 -0700 (Sat, 06 Oct 2007) | 3 lines
Ensure that this test will pass even if another test left an unwritable TESTFN.
Also use the safe unlink in test_support instead of rolling our own here.
........
r58368 | georg.brandl | 2007-10-08 00:50:24 -0700 (Mon, 08 Oct 2007) | 3 lines
#1123: fix the docs for the str.split(None, sep) case.
Also expand a few other methods' docs, which had more info in the deprecated string module docs.
........
r58369 | georg.brandl | 2007-10-08 01:06:05 -0700 (Mon, 08 Oct 2007) | 2 lines
Update docstring of sched, also remove an unused assignment.
........
r58370 | raymond.hettinger | 2007-10-08 02:14:28 -0700 (Mon, 08 Oct 2007) | 5 lines
Add comments to NamedTuple code.
Let the field spec be either a string or a non-string sequence (suggested by Martin Blais with use cases).
Improve the error message in the case of a SyntaxError (caused by a duplicate field name).
........
r58371 | raymond.hettinger | 2007-10-08 02:56:29 -0700 (Mon, 08 Oct 2007) | 1 line
Missed a line in the docs
........
r58372 | raymond.hettinger | 2007-10-08 03:11:51 -0700 (Mon, 08 Oct 2007) | 1 line
Better variable names
........
r58376 | georg.brandl | 2007-10-08 07:12:47 -0700 (Mon, 08 Oct 2007) | 3 lines
#1199: docs for tp_as_{number,sequence,mapping}, by Amaury Forgeot d'Arc.
No need to merge this to py3k!
........
r58380 | raymond.hettinger | 2007-10-08 14:26:58 -0700 (Mon, 08 Oct 2007) | 1 line
Eliminate camelcase function name
........
r58381 | andrew.kuchling | 2007-10-08 16:23:03 -0700 (Mon, 08 Oct 2007) | 1 line
Eliminate camelcase function name
........
r58382 | raymond.hettinger | 2007-10-08 18:36:23 -0700 (Mon, 08 Oct 2007) | 1 line
Make the error messages more specific
........
r58384 | gregory.p.smith | 2007-10-08 23:02:21 -0700 (Mon, 08 Oct 2007) | 10 lines
Splits Modules/_bsddb.c up into bsddb.h and _bsddb.c and adds a C API
object available as bsddb.db.api. This is based on the patch submitted
by Duncan Grisby here:
http://sourceforge.net/tracker/index.php?func=detail&aid=1551895&group_id=13900&atid=313900
See this thread for additional info:
http://sourceforge.net/mailarchive/forum.php?thread_name=E1GAVDK-0002rk-Iw%40apasphere.com&forum_name=pybsddb-users
It also cleans up the code a little by removing some ifdef/endifs for
python prior to 2.1 and for unsupported Berkeley DB <= 3.2.
........
r58385 | gregory.p.smith | 2007-10-08 23:50:43 -0700 (Mon, 08 Oct 2007) | 5 lines
Fix a double free when positioning a database cursor to a non-existant
string key (and probably a few other situations with string keys).
This was reported with a patch as pybsddb sourceforge bug 1708868 by
jjjhhhlll at gmail.
........
r58386 | gregory.p.smith | 2007-10-09 00:19:11 -0700 (Tue, 09 Oct 2007) | 3 lines
Use the highest cPickle protocol in bsddb.dbshelve. This comes from
sourceforge pybsddb patch 1551443 by w_barnes.
........
r58394 | gregory.p.smith | 2007-10-09 11:26:02 -0700 (Tue, 09 Oct 2007) | 2 lines
remove another sleepycat reference
........
r58396 | kurt.kaiser | 2007-10-09 12:31:30 -0700 (Tue, 09 Oct 2007) | 3 lines
Allow interrupt only when executing user code in subprocess
Patch 1225 Tal Einat modified from IDLE-Spoon.
........
r58399 | brett.cannon | 2007-10-09 17:07:50 -0700 (Tue, 09 Oct 2007) | 5 lines
Remove file-level typedefs that were inconsistently used throughout the file.
Just move over to the public API names.
Closes issue1238.
........
r58401 | raymond.hettinger | 2007-10-09 17:26:46 -0700 (Tue, 09 Oct 2007) | 1 line
Accept Jim Jewett's api suggestion to use None instead of -1 to indicate unbounded deques.
........
r58403 | kurt.kaiser | 2007-10-09 17:55:40 -0700 (Tue, 09 Oct 2007) | 2 lines
Allow cursor color change w/o restart. Patch 1725576 Tal Einat.
........
r58404 | kurt.kaiser | 2007-10-09 18:06:47 -0700 (Tue, 09 Oct 2007) | 2 lines
show paste if > 80 columns. Patch 1659326 Tal Einat.
........
r58415 | thomas.heller | 2007-10-11 12:51:32 -0700 (Thu, 11 Oct 2007) | 5 lines
On OS X, use os.uname() instead of gestalt.sysv(...) to get the
operating system version. This allows to use ctypes when Python
was configured with --disable-toolbox-glue.
........
r58419 | neal.norwitz | 2007-10-11 20:01:01 -0700 (Thu, 11 Oct 2007) | 1 line
Get rid of warning about not being able to create an existing directory.
........
r58420 | neal.norwitz | 2007-10-11 20:01:30 -0700 (Thu, 11 Oct 2007) | 1 line
Get rid of warnings on a bunch of platforms by using a proper prototype.
........
r58421 | neal.norwitz | 2007-10-11 20:01:54 -0700 (Thu, 11 Oct 2007) | 4 lines
Get rid of compiler warning about retval being used (returned) without
being initialized. (gcc warning and Coverity 202)
........
r58422 | neal.norwitz | 2007-10-11 20:03:23 -0700 (Thu, 11 Oct 2007) | 1 line
Fix Coverity 168: Close the file before returning (exiting).
........
r58423 | neal.norwitz | 2007-10-11 20:04:18 -0700 (Thu, 11 Oct 2007) | 4 lines
Fix Coverity 180: Don't overallocate. We don't need structs, but pointers.
Also fix a memory leak.
........
r58424 | neal.norwitz | 2007-10-11 20:05:19 -0700 (Thu, 11 Oct 2007) | 5 lines
Fix Coverity 185-186: If the passed in FILE is NULL, uninitialized memory
would be accessed.
Will backport.
........
r58425 | neal.norwitz | 2007-10-11 20:52:34 -0700 (Thu, 11 Oct 2007) | 1 line
Get this module to compile with bsddb versions prior to 4.3
........
r58430 | martin.v.loewis | 2007-10-12 01:56:52 -0700 (Fri, 12 Oct 2007) | 3 lines
Bug #1216: Restore support for Visual Studio 2002.
Will backport to 2.5.
........
r58433 | raymond.hettinger | 2007-10-12 10:53:11 -0700 (Fri, 12 Oct 2007) | 1 line
Fix test of count.__repr__() to ignore the 'L' if the count is a long
........
r58434 | gregory.p.smith | 2007-10-12 11:44:06 -0700 (Fri, 12 Oct 2007) | 4 lines
Fixes http://bugs.python.org/issue1233 - bsddb.dbshelve.DBShelf.append
was useless due to inverted logic. Also adds a test case for RECNO dbs
to test_dbshelve.
........
r58445 | georg.brandl | 2007-10-13 06:20:03 -0700 (Sat, 13 Oct 2007) | 2 lines
Fix email example.
........
r58450 | gregory.p.smith | 2007-10-13 16:02:05 -0700 (Sat, 13 Oct 2007) | 2 lines
Fix an uncollectable reference leak in bsddb.db.DBShelf.append
........
r58453 | neal.norwitz | 2007-10-13 17:18:40 -0700 (Sat, 13 Oct 2007) | 8 lines
Let the O/S supply a port if none of the default ports can be used.
This should make the tests more robust at the expense of allowing
tests to be sloppier by not requiring them to cleanup after themselves.
(It will legitamitely help when running two test suites simultaneously
or if another process is already using one of the predefined ports.)
Also simplifies (slightLy) the exception handling elsewhere.
........
r58459 | neal.norwitz | 2007-10-14 11:30:21 -0700 (Sun, 14 Oct 2007) | 2 lines
Don't raise a string exception, they don't work anymore.
........
r58460 | neal.norwitz | 2007-10-14 11:40:37 -0700 (Sun, 14 Oct 2007) | 1 line
Use unittest for assertions
........
r58468 | armin.rigo | 2007-10-15 00:48:35 -0700 (Mon, 15 Oct 2007) | 2 lines
test_bigbits was not testing what it seemed to.
........
r58471 | guido.van.rossum | 2007-10-15 08:54:11 -0700 (Mon, 15 Oct 2007) | 3 lines
Change a PyErr_Print() into a PyErr_Clear(),
per discussion in issue 1031213.
........
r58500 | raymond.hettinger | 2007-10-16 12:18:30 -0700 (Tue, 16 Oct 2007) | 1 line
Improve error messages
........
r58506 | raymond.hettinger | 2007-10-16 14:28:32 -0700 (Tue, 16 Oct 2007) | 1 line
More docs, error messages, and tests
........
r58507 | andrew.kuchling | 2007-10-16 15:58:03 -0700 (Tue, 16 Oct 2007) | 1 line
Add items
........
r58508 | brett.cannon | 2007-10-16 16:24:06 -0700 (Tue, 16 Oct 2007) | 3 lines
Remove ``:const:`` notation on None in parameter list. Since the markup is not
rendered for parameters it just showed up as ``:const:`None` `` in the output.
........
r58509 | brett.cannon | 2007-10-16 16:26:45 -0700 (Tue, 16 Oct 2007) | 3 lines
Re-order some functions whose parameters differ between PyObject and const char
* so that they are next to each other.
........
r58522 | armin.rigo | 2007-10-17 11:46:37 -0700 (Wed, 17 Oct 2007) | 5 lines
Fix the overflow checking of list_repeat.
Introduce overflow checking into list_inplace_repeat.
Backport candidate, possibly.
........
r58530 | facundo.batista | 2007-10-17 20:16:03 -0700 (Wed, 17 Oct 2007) | 7 lines
Issue #1580738. When HTTPConnection reads the whole stream with read(),
it closes itself. When the stream is read in several calls to read(n),
it should behave in the same way if HTTPConnection knows where the end
of the stream is (through self.length). Added a test case for this
behaviour.
........
r58531 | facundo.batista | 2007-10-17 20:44:48 -0700 (Wed, 17 Oct 2007) | 3 lines
Issue 1289, just a typo.
........
r58532 | gregory.p.smith | 2007-10-18 00:56:54 -0700 (Thu, 18 Oct 2007) | 4 lines
cleanup test_dbtables to use mkdtemp. cleanup dbtables to pass txn as a
keyword argument whenever possible to avoid bugs and confusion. (dbtables.py
line 447 self.db.get using txn as a non-keyword was an actual bug due to this)
........
r58533 | gregory.p.smith | 2007-10-18 01:34:20 -0700 (Thu, 18 Oct 2007) | 4 lines
Fix a weird bug in dbtables: if it chose a random rowid string that contained
NULL bytes it would cause the database all sorts of problems in the future
leading to very strange random failures and corrupt dbtables.bsdTableDb dbs.
........
r58534 | gregory.p.smith | 2007-10-18 09:32:02 -0700 (Thu, 18 Oct 2007) | 3 lines
A cleaner fix than the one committed last night. Generate random rowids that
do not contain null bytes.
........
r58537 | gregory.p.smith | 2007-10-18 10:17:57 -0700 (Thu, 18 Oct 2007) | 2 lines
mention bsddb fixes.
........
r58538 | raymond.hettinger | 2007-10-18 14:13:06 -0700 (Thu, 18 Oct 2007) | 1 line
Remove useless warning
........
r58539 | gregory.p.smith | 2007-10-19 00:31:20 -0700 (Fri, 19 Oct 2007) | 2 lines
squelch the warning that this test is supposed to trigger.
........
r58542 | georg.brandl | 2007-10-19 05:32:39 -0700 (Fri, 19 Oct 2007) | 2 lines
Clarify wording for apply().
........
r58544 | mark.summerfield | 2007-10-19 05:48:17 -0700 (Fri, 19 Oct 2007) | 3 lines
Added a cross-ref to each other.
........
r58545 | georg.brandl | 2007-10-19 10:38:49 -0700 (Fri, 19 Oct 2007) | 2 lines
#1284: "S" means "seen", not unread.
........
r58548 | thomas.heller | 2007-10-19 11:11:41 -0700 (Fri, 19 Oct 2007) | 4 lines
Fix ctypes on 32-bit systems when Python is configured --with-system-ffi.
See also https://bugs.launchpad.net/bugs/72505.
Ported from release25-maint branch.
........
r58550 | facundo.batista | 2007-10-19 12:25:57 -0700 (Fri, 19 Oct 2007) | 8 lines
The constructor from tuple was way too permissive: it allowed bad
coefficient numbers, floats in the sign, and other details that
generated directly the wrong number in the best case, or triggered
misfunctionality in the alorithms.
Test cases added for these issues. Thanks Mark Dickinson.
........
r58559 | georg.brandl | 2007-10-20 06:22:53 -0700 (Sat, 20 Oct 2007) | 2 lines
Fix code being interpreted as a target.
........
r58561 | georg.brandl | 2007-10-20 06:36:24 -0700 (Sat, 20 Oct 2007) | 2 lines
Document new "cmdoption" directive.
........
r58562 | georg.brandl | 2007-10-20 08:21:22 -0700 (Sat, 20 Oct 2007) | 2 lines
Make a path more Unix-standardy.
........
r58564 | georg.brandl | 2007-10-20 10:51:39 -0700 (Sat, 20 Oct 2007) | 2 lines
Document new directive "envvar".
........
r58567 | georg.brandl | 2007-10-20 11:08:14 -0700 (Sat, 20 Oct 2007) | 6 lines
* Add new toplevel chapter, "Using Python." (how to install,
configure and setup python on different platforms -- at least
in theory.)
* Move the Python on Mac docs in that chapter.
* Add a new chapter about the command line invocation, by stargaming.
........
r58568 | georg.brandl | 2007-10-20 11:33:20 -0700 (Sat, 20 Oct 2007) | 2 lines
Change title, for now.
........
r58569 | georg.brandl | 2007-10-20 11:39:25 -0700 (Sat, 20 Oct 2007) | 2 lines
Add entry to ACKS.
........
r58570 | georg.brandl | 2007-10-20 12:05:45 -0700 (Sat, 20 Oct 2007) | 2 lines
Clarify -E docs.
........
r58571 | georg.brandl | 2007-10-20 12:08:36 -0700 (Sat, 20 Oct 2007) | 2 lines
Even more clarification.
........
r58572 | andrew.kuchling | 2007-10-20 12:25:37 -0700 (Sat, 20 Oct 2007) | 1 line
Fix protocol name
........
r58573 | andrew.kuchling | 2007-10-20 12:35:18 -0700 (Sat, 20 Oct 2007) | 1 line
Various items
........
r58574 | andrew.kuchling | 2007-10-20 12:39:35 -0700 (Sat, 20 Oct 2007) | 1 line
Use correct header line
........
r58576 | armin.rigo | 2007-10-21 02:14:15 -0700 (Sun, 21 Oct 2007) | 3 lines
Add a crasher for the long-standing issue with closing a file
while another thread uses it.
........
r58577 | georg.brandl | 2007-10-21 03:01:56 -0700 (Sun, 21 Oct 2007) | 2 lines
Remove duplicate crasher.
........
r58578 | georg.brandl | 2007-10-21 03:24:20 -0700 (Sun, 21 Oct 2007) | 2 lines
Unify "byte code" to "bytecode". Also sprinkle :term: markup for it.
........
r58579 | georg.brandl | 2007-10-21 03:32:54 -0700 (Sun, 21 Oct 2007) | 2 lines
Add markup to new function descriptions.
........
r58580 | georg.brandl | 2007-10-21 03:45:46 -0700 (Sun, 21 Oct 2007) | 2 lines
Add :term:s for descriptors.
........
r58581 | georg.brandl | 2007-10-21 03:46:24 -0700 (Sun, 21 Oct 2007) | 2 lines
Unify "file-descriptor" to "file descriptor".
........
r58582 | georg.brandl | 2007-10-21 03:52:38 -0700 (Sun, 21 Oct 2007) | 2 lines
Add :term: for generators.
........
r58583 | georg.brandl | 2007-10-21 05:10:28 -0700 (Sun, 21 Oct 2007) | 2 lines
Add :term:s for iterator.
........
r58584 | georg.brandl | 2007-10-21 05:15:05 -0700 (Sun, 21 Oct 2007) | 2 lines
Add :term:s for "new-style class".
........
r58588 | neal.norwitz | 2007-10-21 21:47:54 -0700 (Sun, 21 Oct 2007) | 1 line
Add Chris Monson so he can edit PEPs.
........
r58594 | guido.van.rossum | 2007-10-22 09:27:19 -0700 (Mon, 22 Oct 2007) | 4 lines
Issue #1307, patch by Derek Shockey.
When "MAIL" is received without args, an exception happens instead of
sending a 501 syntax error response.
........
r58598 | travis.oliphant | 2007-10-22 19:40:56 -0700 (Mon, 22 Oct 2007) | 1 line
Add phuang patch from Issue 708374 which adds offset parameter to mmap module.
........
r58601 | neal.norwitz | 2007-10-22 22:44:27 -0700 (Mon, 22 Oct 2007) | 2 lines
Bug #1313, fix typo (wrong variable name) in example.
........
r58609 | georg.brandl | 2007-10-23 11:21:35 -0700 (Tue, 23 Oct 2007) | 2 lines
Update Pygments version from externals.
........
r58618 | guido.van.rossum | 2007-10-23 12:25:41 -0700 (Tue, 23 Oct 2007) | 3 lines
Issue 1307 by Derek Shockey, fox the same bug for RCPT.
Neal: please backport!
........
r58620 | raymond.hettinger | 2007-10-23 13:37:41 -0700 (Tue, 23 Oct 2007) | 1 line
Shorter name for namedtuple()
........
r58621 | andrew.kuchling | 2007-10-23 13:55:47 -0700 (Tue, 23 Oct 2007) | 1 line
Update name
........
r58622 | raymond.hettinger | 2007-10-23 14:23:07 -0700 (Tue, 23 Oct 2007) | 1 line
Fixup news entry
........
r58623 | raymond.hettinger | 2007-10-23 18:28:33 -0700 (Tue, 23 Oct 2007) | 1 line
Optimize sum() for integer and float inputs.
........
r58624 | raymond.hettinger | 2007-10-23 19:05:51 -0700 (Tue, 23 Oct 2007) | 1 line
Fixup error return and add support for intermixed ints and floats/
........
r58628 | vinay.sajip | 2007-10-24 03:47:06 -0700 (Wed, 24 Oct 2007) | 1 line
Bug #1321: Fixed logic error in TimedRotatingFileHandler.__init__()
........
r58641 | facundo.batista | 2007-10-24 12:11:08 -0700 (Wed, 24 Oct 2007) | 4 lines
Issue 1290. CharacterData.__repr__ was constructing a string
in response that keeped having a non-ascii character.
........
r58643 | thomas.heller | 2007-10-24 12:50:45 -0700 (Wed, 24 Oct 2007) | 1 line
Added unittest for calling a function with paramflags (backport from py3k branch).
........
r58645 | matthias.klose | 2007-10-24 13:00:44 -0700 (Wed, 24 Oct 2007) | 2 lines
- Build using system ffi library on arm*-linux*.
........
r58651 | georg.brandl | 2007-10-24 14:40:38 -0700 (Wed, 24 Oct 2007) | 2 lines
Bug #1287: make os.environ.pop() work as expected.
........
r58652 | raymond.hettinger | 2007-10-24 19:26:58 -0700 (Wed, 24 Oct 2007) | 1 line
Missing DECREFs
........
r58653 | matthias.klose | 2007-10-24 23:37:24 -0700 (Wed, 24 Oct 2007) | 2 lines
- Build using system ffi library on arm*-linux*, pass --with-system-ffi to CONFIG_ARGS
........
r58655 | thomas.heller | 2007-10-25 12:47:32 -0700 (Thu, 25 Oct 2007) | 2 lines
ffi_type_longdouble may be already #defined.
See issue 1324.
........
r58656 | kurt.kaiser | 2007-10-25 15:43:45 -0700 (Thu, 25 Oct 2007) | 3 lines
Correct an ancient bug in an unused path by removing that path: register() is
now idempotent.
........
r58660 | kurt.kaiser | 2007-10-25 17:10:09 -0700 (Thu, 25 Oct 2007) | 4 lines
1. Add comments to provide top-level documentation.
2. Refactor to use more descriptive names.
3. Enhance tests in main().
........
r58675 | georg.brandl | 2007-10-26 11:30:41 -0700 (Fri, 26 Oct 2007) | 2 lines
Fix new pop() method on os.environ on ignorecase-platforms.
........
r58696 | neal.norwitz | 2007-10-27 15:32:21 -0700 (Sat, 27 Oct 2007) | 1 line
Update URL for Pygments. 0.8.1 is no longer available
........
r58697 | hyeshik.chang | 2007-10-28 04:19:02 -0700 (Sun, 28 Oct 2007) | 3 lines
- Add support for FreeBSD 8 which is recently forked from FreeBSD 7.
- Regenerate IN module for most recent maintenance tree of FreeBSD 6 and 7.
........
r58698 | hyeshik.chang | 2007-10-28 05:38:09 -0700 (Sun, 28 Oct 2007) | 2 lines
Enable platform-specific tweaks for FreeBSD 8 (exactly same to FreeBSD 7's yet)
........
r58700 | kurt.kaiser | 2007-10-28 12:03:59 -0700 (Sun, 28 Oct 2007) | 2 lines
Add confirmation dialog before printing. Patch 1717170 Tal Einat.
........
r58706 | guido.van.rossum | 2007-10-29 13:52:45 -0700 (Mon, 29 Oct 2007) | 3 lines
Patch 1353 by Jacob Winther.
Add mp4 mapping to mimetypes.py.
........
r58709 | guido.van.rossum | 2007-10-29 15:15:05 -0700 (Mon, 29 Oct 2007) | 6 lines
Backport fixes for the code that decodes octal escapes (and for PyString
also hex escapes) -- this was reaching beyond the end of the input string
buffer, even though it is not supposed to be \0-terminated.
This has no visible effect but is clearly the correct thing to do.
(In 3.0 it had a visible effect after removing ob_sstate from PyString.)
........
r58710 | kurt.kaiser | 2007-10-29 19:38:54 -0700 (Mon, 29 Oct 2007) | 7 lines
check in Tal Einat's update to tabpage.py
Patch 1612746
M configDialog.py
M NEWS.txt
AM tabbedpages.py
........
r58715 | georg.brandl | 2007-10-30 10:51:18 -0700 (Tue, 30 Oct 2007) | 2 lines
Use correct markup.
........
r58716 | georg.brandl | 2007-10-30 10:57:12 -0700 (Tue, 30 Oct 2007) | 2 lines
Make example about hiding None return values at the prompt clearer.
........
r58728 | neal.norwitz | 2007-10-30 23:33:20 -0700 (Tue, 30 Oct 2007) | 1 line
Fix some compiler warnings for signed comparisons on Unix and Windows.
........
r58731 | martin.v.loewis | 2007-10-31 10:19:33 -0700 (Wed, 31 Oct 2007) | 2 lines
Adding Christian Heimes.
........
r58737 | raymond.hettinger | 2007-10-31 14:57:58 -0700 (Wed, 31 Oct 2007) | 1 line
Clarify the reasons why pickle is almost always better than marshal
........
r58739 | raymond.hettinger | 2007-10-31 15:15:49 -0700 (Wed, 31 Oct 2007) | 1 line
Sets are marshalable.
........
2007-11-01 17:32:30 -03:00
|
|
|
The function being decorated must return a :term:`generator`-iterator when
|
|
|
|
called. This iterator must yield exactly one value, which will be bound to
|
2018-12-19 02:09:46 -04:00
|
|
|
the targets in the :keyword:`with` statement's :keyword:`!as` clause, if any.
|
2007-08-15 11:28:22 -03:00
|
|
|
|
|
|
|
At the point where the generator yields, the block nested in the :keyword:`with`
|
|
|
|
statement is executed. The generator is then resumed after the block is exited.
|
|
|
|
If an unhandled exception occurs in the block, it is reraised inside the
|
|
|
|
generator at the point where the yield occurred. Thus, you can use a
|
|
|
|
:keyword:`try`...\ :keyword:`except`...\ :keyword:`finally` statement to trap
|
|
|
|
the error (if any), or ensure that some cleanup takes place. If an exception is
|
|
|
|
trapped merely in order to log it or to perform some action (rather than to
|
|
|
|
suppress it entirely), the generator must reraise that exception. Otherwise the
|
2018-12-19 02:09:46 -04:00
|
|
|
generator context manager will indicate to the :keyword:`!with` statement that
|
2007-08-15 11:28:22 -03:00
|
|
|
the exception has been handled, and execution will resume with the statement
|
2018-12-19 02:09:46 -04:00
|
|
|
immediately following the :keyword:`!with` statement.
|
2007-08-15 11:28:22 -03:00
|
|
|
|
2011-05-05 10:49:25 -03:00
|
|
|
:func:`contextmanager` uses :class:`ContextDecorator` so the context managers
|
|
|
|
it creates can be used as decorators as well as in :keyword:`with` statements.
|
|
|
|
When used as a decorator, a new generator instance is implicitly created on
|
|
|
|
each function call (this allows the otherwise "one-shot" context managers
|
|
|
|
created by :func:`contextmanager` to meet the requirement that context
|
|
|
|
managers support multiple invocations in order to be used as decorators).
|
2010-06-30 09:17:50 -03:00
|
|
|
|
|
|
|
.. versionchanged:: 3.2
|
|
|
|
Use of :class:`ContextDecorator`.
|
2007-08-15 11:28:22 -03:00
|
|
|
|
2010-07-18 10:43:32 -03:00
|
|
|
|
2017-04-30 22:25:58 -03:00
|
|
|
.. decorator:: asynccontextmanager
|
|
|
|
|
|
|
|
Similar to :func:`~contextlib.contextmanager`, but creates an
|
|
|
|
:ref:`asynchronous context manager <async-context-managers>`.
|
|
|
|
|
|
|
|
This function is a :term:`decorator` that can be used to define a factory
|
|
|
|
function for :keyword:`async with` statement asynchronous context managers,
|
|
|
|
without needing to create a class or separate :meth:`__aenter__` and
|
|
|
|
:meth:`__aexit__` methods. It must be applied to an :term:`asynchronous
|
|
|
|
generator` function.
|
|
|
|
|
|
|
|
A simple example::
|
|
|
|
|
|
|
|
from contextlib import asynccontextmanager
|
|
|
|
|
|
|
|
@asynccontextmanager
|
|
|
|
async def get_connection():
|
|
|
|
conn = await acquire_db_connection()
|
|
|
|
try:
|
2018-08-24 23:38:11 -03:00
|
|
|
yield conn
|
2017-04-30 22:25:58 -03:00
|
|
|
finally:
|
|
|
|
await release_db_connection(conn)
|
|
|
|
|
|
|
|
async def get_all_users():
|
|
|
|
async with get_connection() as conn:
|
|
|
|
return conn.query('SELECT ...')
|
|
|
|
|
|
|
|
.. versionadded:: 3.7
|
|
|
|
|
|
|
|
|
2007-08-15 11:28:22 -03:00
|
|
|
.. function:: closing(thing)
|
|
|
|
|
|
|
|
Return a context manager that closes *thing* upon completion of the block. This
|
|
|
|
is basically equivalent to::
|
|
|
|
|
|
|
|
from contextlib import contextmanager
|
|
|
|
|
|
|
|
@contextmanager
|
|
|
|
def closing(thing):
|
|
|
|
try:
|
|
|
|
yield thing
|
|
|
|
finally:
|
|
|
|
thing.close()
|
|
|
|
|
|
|
|
And lets you write code like this::
|
|
|
|
|
|
|
|
from contextlib import closing
|
2008-06-23 08:23:31 -03:00
|
|
|
from urllib.request import urlopen
|
2007-08-15 11:28:22 -03:00
|
|
|
|
2008-06-23 08:23:31 -03:00
|
|
|
with closing(urlopen('http://www.python.org')) as page:
|
2007-08-15 11:28:22 -03:00
|
|
|
for line in page:
|
2007-09-04 04:15:32 -03:00
|
|
|
print(line)
|
2007-08-15 11:28:22 -03:00
|
|
|
|
|
|
|
without needing to explicitly close ``page``. Even if an error occurs,
|
|
|
|
``page.close()`` will be called when the :keyword:`with` block is exited.
|
|
|
|
|
2013-10-13 17:25:10 -03:00
|
|
|
|
2017-11-22 20:23:28 -04:00
|
|
|
.. _simplifying-support-for-single-optional-context-managers:
|
|
|
|
|
|
|
|
.. function:: nullcontext(enter_result=None)
|
|
|
|
|
2018-07-09 10:49:29 -03:00
|
|
|
Return a context manager that returns *enter_result* from ``__enter__``, but
|
2017-11-22 20:23:28 -04:00
|
|
|
otherwise does nothing. It is intended to be used as a stand-in for an
|
|
|
|
optional context manager, for example::
|
|
|
|
|
2018-07-09 10:49:29 -03:00
|
|
|
def myfunction(arg, ignore_exceptions=False):
|
|
|
|
if ignore_exceptions:
|
|
|
|
# Use suppress to ignore all exceptions.
|
|
|
|
cm = contextlib.suppress(Exception)
|
|
|
|
else:
|
|
|
|
# Do not ignore any exceptions, cm has no effect.
|
|
|
|
cm = contextlib.nullcontext()
|
|
|
|
with cm:
|
|
|
|
# Do something
|
|
|
|
|
|
|
|
An example using *enter_result*::
|
|
|
|
|
2017-11-22 20:23:28 -04:00
|
|
|
def process_file(file_or_path):
|
|
|
|
if isinstance(file_or_path, str):
|
|
|
|
# If string, open file
|
|
|
|
cm = open(file_or_path)
|
|
|
|
else:
|
|
|
|
# Caller is responsible for closing file
|
|
|
|
cm = nullcontext(file_or_path)
|
|
|
|
|
|
|
|
with cm as file:
|
|
|
|
# Perform processing on the file
|
|
|
|
|
|
|
|
.. versionadded:: 3.7
|
|
|
|
|
|
|
|
|
2013-10-17 10:40:57 -03:00
|
|
|
.. function:: suppress(*exceptions)
|
2013-03-11 02:26:51 -03:00
|
|
|
|
2013-10-17 10:40:57 -03:00
|
|
|
Return a context manager that suppresses any of the specified exceptions
|
|
|
|
if they occur in the body of a with statement and then resumes execution
|
|
|
|
with the first statement following the end of the with statement.
|
2013-03-11 02:26:51 -03:00
|
|
|
|
2013-10-17 10:40:57 -03:00
|
|
|
As with any other mechanism that completely suppresses exceptions, this
|
|
|
|
context manager should be used only to cover very specific errors where
|
|
|
|
silently continuing with program execution is known to be the right
|
|
|
|
thing to do.
|
2013-10-13 10:23:08 -03:00
|
|
|
|
2013-03-11 02:26:51 -03:00
|
|
|
For example::
|
|
|
|
|
2013-10-17 10:40:57 -03:00
|
|
|
from contextlib import suppress
|
2013-03-11 02:26:51 -03:00
|
|
|
|
2013-10-17 10:40:57 -03:00
|
|
|
with suppress(FileNotFoundError):
|
2013-03-11 02:26:51 -03:00
|
|
|
os.remove('somefile.tmp')
|
|
|
|
|
2013-10-17 10:40:57 -03:00
|
|
|
with suppress(FileNotFoundError):
|
|
|
|
os.remove('someotherfile.tmp')
|
|
|
|
|
2013-03-11 02:26:51 -03:00
|
|
|
This code is equivalent to::
|
|
|
|
|
|
|
|
try:
|
|
|
|
os.remove('somefile.tmp')
|
2013-10-13 10:23:08 -03:00
|
|
|
except FileNotFoundError:
|
2013-03-11 02:26:51 -03:00
|
|
|
pass
|
|
|
|
|
2013-10-17 10:40:57 -03:00
|
|
|
try:
|
|
|
|
os.remove('someotherfile.tmp')
|
|
|
|
except FileNotFoundError:
|
|
|
|
pass
|
|
|
|
|
2013-10-19 11:30:51 -03:00
|
|
|
This context manager is :ref:`reentrant <reentrant-cms>`.
|
|
|
|
|
2013-03-11 02:26:51 -03:00
|
|
|
.. versionadded:: 3.4
|
2007-08-15 11:28:22 -03:00
|
|
|
|
2013-10-13 10:23:08 -03:00
|
|
|
|
2013-10-10 04:46:57 -03:00
|
|
|
.. function:: redirect_stdout(new_target)
|
|
|
|
|
|
|
|
Context manager for temporarily redirecting :data:`sys.stdout` to
|
|
|
|
another file or file-like object.
|
|
|
|
|
|
|
|
This tool adds flexibility to existing functions or classes whose output
|
|
|
|
is hardwired to stdout.
|
|
|
|
|
|
|
|
For example, the output of :func:`help` normally is sent to *sys.stdout*.
|
2015-11-02 08:10:23 -04:00
|
|
|
You can capture that output in a string by redirecting the output to an
|
2013-10-10 04:46:57 -03:00
|
|
|
:class:`io.StringIO` object::
|
|
|
|
|
|
|
|
f = io.StringIO()
|
|
|
|
with redirect_stdout(f):
|
|
|
|
help(pow)
|
|
|
|
s = f.getvalue()
|
|
|
|
|
|
|
|
To send the output of :func:`help` to a file on disk, redirect the output
|
|
|
|
to a regular file::
|
|
|
|
|
|
|
|
with open('help.txt', 'w') as f:
|
|
|
|
with redirect_stdout(f):
|
|
|
|
help(pow)
|
|
|
|
|
|
|
|
To send the output of :func:`help` to *sys.stderr*::
|
|
|
|
|
|
|
|
with redirect_stdout(sys.stderr):
|
|
|
|
help(pow)
|
|
|
|
|
2013-10-13 10:23:08 -03:00
|
|
|
Note that the global side effect on :data:`sys.stdout` means that this
|
|
|
|
context manager is not suitable for use in library code and most threaded
|
|
|
|
applications. It also has no effect on the output of subprocesses.
|
|
|
|
However, it is still a useful approach for many utility scripts.
|
|
|
|
|
2014-10-11 21:25:00 -03:00
|
|
|
This context manager is :ref:`reentrant <reentrant-cms>`.
|
2013-10-19 11:30:51 -03:00
|
|
|
|
2013-10-10 04:46:57 -03:00
|
|
|
.. versionadded:: 3.4
|
|
|
|
|
2013-10-13 17:25:10 -03:00
|
|
|
|
2014-11-28 17:28:06 -04:00
|
|
|
.. function:: redirect_stderr(new_target)
|
|
|
|
|
|
|
|
Similar to :func:`~contextlib.redirect_stdout` but redirecting
|
|
|
|
:data:`sys.stderr` to another file or file-like object.
|
|
|
|
|
|
|
|
This context manager is :ref:`reentrant <reentrant-cms>`.
|
|
|
|
|
|
|
|
.. versionadded:: 3.5
|
|
|
|
|
|
|
|
|
2010-06-30 09:17:50 -03:00
|
|
|
.. class:: ContextDecorator()
|
|
|
|
|
|
|
|
A base class that enables a context manager to also be used as a decorator.
|
|
|
|
|
|
|
|
Context managers inheriting from ``ContextDecorator`` have to implement
|
|
|
|
``__enter__`` and ``__exit__`` as normal. ``__exit__`` retains its optional
|
|
|
|
exception handling even when used as a decorator.
|
|
|
|
|
2010-07-18 10:43:32 -03:00
|
|
|
``ContextDecorator`` is used by :func:`contextmanager`, so you get this
|
|
|
|
functionality automatically.
|
|
|
|
|
|
|
|
Example of ``ContextDecorator``::
|
2010-06-30 09:17:50 -03:00
|
|
|
|
|
|
|
from contextlib import ContextDecorator
|
|
|
|
|
|
|
|
class mycontext(ContextDecorator):
|
2010-07-18 10:43:32 -03:00
|
|
|
def __enter__(self):
|
|
|
|
print('Starting')
|
|
|
|
return self
|
2010-06-30 09:17:50 -03:00
|
|
|
|
2010-07-18 10:43:32 -03:00
|
|
|
def __exit__(self, *exc):
|
|
|
|
print('Finishing')
|
|
|
|
return False
|
2010-06-30 09:17:50 -03:00
|
|
|
|
|
|
|
>>> @mycontext()
|
|
|
|
... def function():
|
2010-07-18 10:43:32 -03:00
|
|
|
... print('The bit in the middle')
|
2010-06-30 09:17:50 -03:00
|
|
|
...
|
|
|
|
>>> function()
|
|
|
|
Starting
|
|
|
|
The bit in the middle
|
|
|
|
Finishing
|
|
|
|
|
|
|
|
>>> with mycontext():
|
2010-07-18 10:43:32 -03:00
|
|
|
... print('The bit in the middle')
|
2010-06-30 09:17:50 -03:00
|
|
|
...
|
|
|
|
Starting
|
|
|
|
The bit in the middle
|
|
|
|
Finishing
|
|
|
|
|
2010-07-18 10:43:32 -03:00
|
|
|
This change is just syntactic sugar for any construct of the following form::
|
|
|
|
|
|
|
|
def f():
|
|
|
|
with cm():
|
|
|
|
# Do stuff
|
|
|
|
|
|
|
|
``ContextDecorator`` lets you instead write::
|
|
|
|
|
|
|
|
@cm()
|
|
|
|
def f():
|
|
|
|
# Do stuff
|
|
|
|
|
|
|
|
It makes it clear that the ``cm`` applies to the whole function, rather than
|
|
|
|
just a piece of it (and saving an indentation level is nice, too).
|
|
|
|
|
2010-06-30 09:17:50 -03:00
|
|
|
Existing context managers that already have a base class can be extended by
|
|
|
|
using ``ContextDecorator`` as a mixin class::
|
|
|
|
|
|
|
|
from contextlib import ContextDecorator
|
|
|
|
|
|
|
|
class mycontext(ContextBaseClass, ContextDecorator):
|
2010-07-18 10:43:32 -03:00
|
|
|
def __enter__(self):
|
|
|
|
return self
|
2010-06-30 09:17:50 -03:00
|
|
|
|
2010-07-18 10:43:32 -03:00
|
|
|
def __exit__(self, *exc):
|
|
|
|
return False
|
2010-06-30 09:17:50 -03:00
|
|
|
|
2011-05-05 10:49:25 -03:00
|
|
|
.. note::
|
|
|
|
As the decorated function must be able to be called multiple times, the
|
|
|
|
underlying context manager must support use in multiple :keyword:`with`
|
|
|
|
statements. If this is not the case, then the original construct with the
|
2018-12-19 02:09:46 -04:00
|
|
|
explicit :keyword:`!with` statement inside the function should be used.
|
2011-05-05 10:49:25 -03:00
|
|
|
|
2010-06-30 09:17:50 -03:00
|
|
|
.. versionadded:: 3.2
|
|
|
|
|
|
|
|
|
2012-05-21 09:54:43 -03:00
|
|
|
.. class:: ExitStack()
|
|
|
|
|
|
|
|
A context manager that is designed to make it easy to programmatically
|
|
|
|
combine other context managers and cleanup functions, especially those
|
|
|
|
that are optional or otherwise driven by input data.
|
|
|
|
|
|
|
|
For example, a set of files may easily be handled in a single with
|
|
|
|
statement as follows::
|
|
|
|
|
|
|
|
with ExitStack() as stack:
|
|
|
|
files = [stack.enter_context(open(fname)) for fname in filenames]
|
|
|
|
# All opened files will automatically be closed at the end of
|
|
|
|
# the with statement, even if attempts to open files later
|
2012-12-18 15:26:36 -04:00
|
|
|
# in the list raise an exception
|
2012-05-21 09:54:43 -03:00
|
|
|
|
|
|
|
Each instance maintains a stack of registered callbacks that are called in
|
|
|
|
reverse order when the instance is closed (either explicitly or implicitly
|
2012-05-31 09:17:08 -03:00
|
|
|
at the end of a :keyword:`with` statement). Note that callbacks are *not*
|
|
|
|
invoked implicitly when the context stack instance is garbage collected.
|
2012-05-21 09:54:43 -03:00
|
|
|
|
|
|
|
This stack model is used so that context managers that acquire their
|
|
|
|
resources in their ``__init__`` method (such as file objects) can be
|
|
|
|
handled correctly.
|
|
|
|
|
|
|
|
Since registered callbacks are invoked in the reverse order of
|
2012-05-31 09:17:08 -03:00
|
|
|
registration, this ends up behaving as if multiple nested :keyword:`with`
|
2012-05-21 09:54:43 -03:00
|
|
|
statements had been used with the registered set of callbacks. This even
|
|
|
|
extends to exception handling - if an inner callback suppresses or replaces
|
|
|
|
an exception, then outer callbacks will be passed arguments based on that
|
|
|
|
updated state.
|
|
|
|
|
|
|
|
This is a relatively low level API that takes care of the details of
|
|
|
|
correctly unwinding the stack of exit callbacks. It provides a suitable
|
|
|
|
foundation for higher level context managers that manipulate the exit
|
|
|
|
stack in application specific ways.
|
|
|
|
|
2012-05-22 10:02:00 -03:00
|
|
|
.. versionadded:: 3.3
|
|
|
|
|
2012-05-21 09:54:43 -03:00
|
|
|
.. method:: enter_context(cm)
|
|
|
|
|
|
|
|
Enters a new context manager and adds its :meth:`__exit__` method to
|
|
|
|
the callback stack. The return value is the result of the context
|
|
|
|
manager's own :meth:`__enter__` method.
|
|
|
|
|
|
|
|
These context managers may suppress exceptions just as they normally
|
2012-05-31 09:17:08 -03:00
|
|
|
would if used directly as part of a :keyword:`with` statement.
|
2012-05-21 09:54:43 -03:00
|
|
|
|
|
|
|
.. method:: push(exit)
|
|
|
|
|
|
|
|
Adds a context manager's :meth:`__exit__` method to the callback stack.
|
|
|
|
|
|
|
|
As ``__enter__`` is *not* invoked, this method can be used to cover
|
|
|
|
part of an :meth:`__enter__` implementation with a context manager's own
|
|
|
|
:meth:`__exit__` method.
|
|
|
|
|
|
|
|
If passed an object that is not a context manager, this method assumes
|
|
|
|
it is a callback with the same signature as a context manager's
|
|
|
|
:meth:`__exit__` method and adds it directly to the callback stack.
|
|
|
|
|
|
|
|
By returning true values, these callbacks can suppress exceptions the
|
|
|
|
same way context manager :meth:`__exit__` methods can.
|
|
|
|
|
|
|
|
The passed in object is returned from the function, allowing this
|
2012-05-31 09:17:08 -03:00
|
|
|
method to be used as a function decorator.
|
2012-05-21 09:54:43 -03:00
|
|
|
|
|
|
|
.. method:: callback(callback, *args, **kwds)
|
|
|
|
|
|
|
|
Accepts an arbitrary callback function and arguments and adds it to
|
|
|
|
the callback stack.
|
|
|
|
|
|
|
|
Unlike the other methods, callbacks added this way cannot suppress
|
|
|
|
exceptions (as they are never passed the exception details).
|
|
|
|
|
|
|
|
The passed in callback is returned from the function, allowing this
|
2012-05-31 09:17:08 -03:00
|
|
|
method to be used as a function decorator.
|
2012-05-21 09:54:43 -03:00
|
|
|
|
|
|
|
.. method:: pop_all()
|
|
|
|
|
|
|
|
Transfers the callback stack to a fresh :class:`ExitStack` instance
|
|
|
|
and returns it. No callbacks are invoked by this operation - instead,
|
|
|
|
they will now be invoked when the new stack is closed (either
|
2012-05-31 09:17:08 -03:00
|
|
|
explicitly or implicitly at the end of a :keyword:`with` statement).
|
2012-05-21 09:54:43 -03:00
|
|
|
|
|
|
|
For example, a group of files can be opened as an "all or nothing"
|
|
|
|
operation as follows::
|
|
|
|
|
|
|
|
with ExitStack() as stack:
|
|
|
|
files = [stack.enter_context(open(fname)) for fname in filenames]
|
2013-05-10 12:35:38 -03:00
|
|
|
# Hold onto the close method, but don't call it yet.
|
|
|
|
close_files = stack.pop_all().close
|
2012-05-21 09:54:43 -03:00
|
|
|
# If opening any file fails, all previously opened files will be
|
|
|
|
# closed automatically. If all files are opened successfully,
|
|
|
|
# they will remain open even after the with statement ends.
|
2013-05-10 12:35:38 -03:00
|
|
|
# close_files() can then be invoked explicitly to close them all.
|
2012-05-21 09:54:43 -03:00
|
|
|
|
|
|
|
.. method:: close()
|
|
|
|
|
|
|
|
Immediately unwinds the callback stack, invoking callbacks in the
|
|
|
|
reverse order of registration. For any context managers and exit
|
|
|
|
callbacks registered, the arguments passed in will indicate that no
|
|
|
|
exception occurred.
|
|
|
|
|
2018-01-25 16:51:18 -04:00
|
|
|
.. class:: AsyncExitStack()
|
|
|
|
|
|
|
|
An :ref:`asynchronous context manager <async-context-managers>`, similar
|
|
|
|
to :class:`ExitStack`, that supports combining both synchronous and
|
|
|
|
asynchronous context managers, as well as having coroutines for
|
|
|
|
cleanup logic.
|
|
|
|
|
|
|
|
The :meth:`close` method is not implemented, :meth:`aclose` must be used
|
|
|
|
instead.
|
|
|
|
|
|
|
|
.. method:: enter_async_context(cm)
|
|
|
|
|
|
|
|
Similar to :meth:`enter_context` but expects an asynchronous context
|
|
|
|
manager.
|
|
|
|
|
|
|
|
.. method:: push_async_exit(exit)
|
|
|
|
|
|
|
|
Similar to :meth:`push` but expects either an asynchronous context manager
|
2018-09-18 18:27:59 -03:00
|
|
|
or a coroutine function.
|
2018-01-25 16:51:18 -04:00
|
|
|
|
|
|
|
.. method:: push_async_callback(callback, *args, **kwds)
|
|
|
|
|
2018-09-18 18:27:59 -03:00
|
|
|
Similar to :meth:`callback` but expects a coroutine function.
|
2018-01-25 16:51:18 -04:00
|
|
|
|
|
|
|
.. method:: aclose()
|
|
|
|
|
|
|
|
Similar to :meth:`close` but properly handles awaitables.
|
|
|
|
|
|
|
|
Continuing the example for :func:`asynccontextmanager`::
|
|
|
|
|
|
|
|
async with AsyncExitStack() as stack:
|
|
|
|
connections = [await stack.enter_async_context(get_connection())
|
|
|
|
for i in range(5)]
|
|
|
|
# All opened connections will automatically be released at the end of
|
|
|
|
# the async with statement, even if attempts to open a connection
|
|
|
|
# later in the list raise an exception.
|
|
|
|
|
|
|
|
.. versionadded:: 3.7
|
2012-05-21 09:54:43 -03:00
|
|
|
|
|
|
|
Examples and Recipes
|
|
|
|
--------------------
|
|
|
|
|
|
|
|
This section describes some examples and recipes for making effective use of
|
|
|
|
the tools provided by :mod:`contextlib`.
|
|
|
|
|
|
|
|
|
2012-05-31 09:17:08 -03:00
|
|
|
Supporting a variable number of context managers
|
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
|
|
|
|
The primary use case for :class:`ExitStack` is the one given in the class
|
|
|
|
documentation: supporting a variable number of context managers and other
|
|
|
|
cleanup operations in a single :keyword:`with` statement. The variability
|
|
|
|
may come from the number of context managers needed being driven by user
|
|
|
|
input (such as opening a user specified collection of files), or from
|
|
|
|
some of the context managers being optional::
|
|
|
|
|
|
|
|
with ExitStack() as stack:
|
|
|
|
for resource in resources:
|
|
|
|
stack.enter_context(resource)
|
2014-05-25 22:06:04 -03:00
|
|
|
if need_special_resource():
|
2012-05-31 09:17:08 -03:00
|
|
|
special = acquire_special_resource()
|
|
|
|
stack.callback(release_special_resource, special)
|
|
|
|
# Perform operations that use the acquired resources
|
|
|
|
|
|
|
|
As shown, :class:`ExitStack` also makes it quite easy to use :keyword:`with`
|
|
|
|
statements to manage arbitrary resources that don't natively support the
|
|
|
|
context management protocol.
|
|
|
|
|
|
|
|
|
|
|
|
Catching exceptions from ``__enter__`` methods
|
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
|
|
|
|
It is occasionally desirable to catch exceptions from an ``__enter__``
|
|
|
|
method implementation, *without* inadvertently catching exceptions from
|
|
|
|
the :keyword:`with` statement body or the context manager's ``__exit__``
|
|
|
|
method. By using :class:`ExitStack` the steps in the context management
|
|
|
|
protocol can be separated slightly in order to allow this::
|
|
|
|
|
|
|
|
stack = ExitStack()
|
|
|
|
try:
|
|
|
|
x = stack.enter_context(cm)
|
|
|
|
except Exception:
|
|
|
|
# handle __enter__ exception
|
|
|
|
else:
|
|
|
|
with stack:
|
|
|
|
# Handle normal case
|
|
|
|
|
|
|
|
Actually needing to do this is likely to indicate that the underlying API
|
|
|
|
should be providing a direct resource management interface for use with
|
|
|
|
:keyword:`try`/:keyword:`except`/:keyword:`finally` statements, but not
|
|
|
|
all APIs are well designed in that regard. When a context manager is the
|
|
|
|
only resource management API provided, then :class:`ExitStack` can make it
|
|
|
|
easier to handle various situations that can't be handled directly in a
|
|
|
|
:keyword:`with` statement.
|
|
|
|
|
|
|
|
|
2012-05-21 09:54:43 -03:00
|
|
|
Cleaning up in an ``__enter__`` implementation
|
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
|
|
|
|
As noted in the documentation of :meth:`ExitStack.push`, this
|
|
|
|
method can be useful in cleaning up an already allocated resource if later
|
|
|
|
steps in the :meth:`__enter__` implementation fail.
|
|
|
|
|
|
|
|
Here's an example of doing this for a context manager that accepts resource
|
|
|
|
acquisition and release functions, along with an optional validation function,
|
|
|
|
and maps them to the context management protocol::
|
|
|
|
|
2016-04-08 16:15:27 -03:00
|
|
|
from contextlib import contextmanager, AbstractContextManager, ExitStack
|
2012-05-21 09:54:43 -03:00
|
|
|
|
2016-04-08 16:15:27 -03:00
|
|
|
class ResourceManager(AbstractContextManager):
|
2012-05-21 09:54:43 -03:00
|
|
|
|
|
|
|
def __init__(self, acquire_resource, release_resource, check_resource_ok=None):
|
|
|
|
self.acquire_resource = acquire_resource
|
|
|
|
self.release_resource = release_resource
|
|
|
|
if check_resource_ok is None:
|
|
|
|
def check_resource_ok(resource):
|
|
|
|
return True
|
|
|
|
self.check_resource_ok = check_resource_ok
|
|
|
|
|
|
|
|
@contextmanager
|
|
|
|
def _cleanup_on_error(self):
|
|
|
|
with ExitStack() as stack:
|
|
|
|
stack.push(self)
|
|
|
|
yield
|
|
|
|
# The validation check passed and didn't raise an exception
|
|
|
|
# Accordingly, we want to keep the resource, and pass it
|
|
|
|
# back to our caller
|
|
|
|
stack.pop_all()
|
|
|
|
|
|
|
|
def __enter__(self):
|
|
|
|
resource = self.acquire_resource()
|
|
|
|
with self._cleanup_on_error():
|
|
|
|
if not self.check_resource_ok(resource):
|
|
|
|
msg = "Failed validation for {!r}"
|
|
|
|
raise RuntimeError(msg.format(resource))
|
|
|
|
return resource
|
|
|
|
|
|
|
|
def __exit__(self, *exc_details):
|
|
|
|
# We don't need to duplicate any of our resource release logic
|
|
|
|
self.release_resource()
|
|
|
|
|
|
|
|
|
|
|
|
Replacing any use of ``try-finally`` and flag variables
|
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
|
|
|
|
A pattern you will sometimes see is a ``try-finally`` statement with a flag
|
|
|
|
variable to indicate whether or not the body of the ``finally`` clause should
|
|
|
|
be executed. In its simplest form (that can't already be handled just by
|
|
|
|
using an ``except`` clause instead), it looks something like this::
|
|
|
|
|
|
|
|
cleanup_needed = True
|
|
|
|
try:
|
|
|
|
result = perform_operation()
|
|
|
|
if result:
|
|
|
|
cleanup_needed = False
|
|
|
|
finally:
|
|
|
|
if cleanup_needed:
|
|
|
|
cleanup_resources()
|
|
|
|
|
|
|
|
As with any ``try`` statement based code, this can cause problems for
|
|
|
|
development and review, because the setup code and the cleanup code can end
|
|
|
|
up being separated by arbitrarily long sections of code.
|
|
|
|
|
|
|
|
:class:`ExitStack` makes it possible to instead register a callback for
|
|
|
|
execution at the end of a ``with`` statement, and then later decide to skip
|
|
|
|
executing that callback::
|
|
|
|
|
|
|
|
from contextlib import ExitStack
|
|
|
|
|
|
|
|
with ExitStack() as stack:
|
|
|
|
stack.callback(cleanup_resources)
|
|
|
|
result = perform_operation()
|
|
|
|
if result:
|
|
|
|
stack.pop_all()
|
|
|
|
|
|
|
|
This allows the intended cleanup up behaviour to be made explicit up front,
|
|
|
|
rather than requiring a separate flag variable.
|
|
|
|
|
|
|
|
If a particular application uses this pattern a lot, it can be simplified
|
|
|
|
even further by means of a small helper class::
|
|
|
|
|
|
|
|
from contextlib import ExitStack
|
|
|
|
|
|
|
|
class Callback(ExitStack):
|
|
|
|
def __init__(self, callback, *args, **kwds):
|
|
|
|
super(Callback, self).__init__()
|
|
|
|
self.callback(callback, *args, **kwds)
|
|
|
|
|
|
|
|
def cancel(self):
|
|
|
|
self.pop_all()
|
|
|
|
|
|
|
|
with Callback(cleanup_resources) as cb:
|
|
|
|
result = perform_operation()
|
|
|
|
if result:
|
|
|
|
cb.cancel()
|
|
|
|
|
|
|
|
If the resource cleanup isn't already neatly bundled into a standalone
|
|
|
|
function, then it is still possible to use the decorator form of
|
|
|
|
:meth:`ExitStack.callback` to declare the resource cleanup in
|
|
|
|
advance::
|
|
|
|
|
|
|
|
from contextlib import ExitStack
|
|
|
|
|
|
|
|
with ExitStack() as stack:
|
|
|
|
@stack.callback
|
|
|
|
def cleanup_resources():
|
|
|
|
...
|
|
|
|
result = perform_operation()
|
|
|
|
if result:
|
|
|
|
stack.pop_all()
|
|
|
|
|
|
|
|
Due to the way the decorator protocol works, a callback function
|
|
|
|
declared this way cannot take any parameters. Instead, any resources to
|
2015-10-10 07:36:22 -03:00
|
|
|
be released must be accessed as closure variables.
|
2012-05-21 09:54:43 -03:00
|
|
|
|
|
|
|
|
|
|
|
Using a context manager as a function decorator
|
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
|
|
|
|
:class:`ContextDecorator` makes it possible to use a context manager in
|
|
|
|
both an ordinary ``with`` statement and also as a function decorator.
|
|
|
|
|
|
|
|
For example, it is sometimes useful to wrap functions or groups of statements
|
|
|
|
with a logger that can track the time of entry and time of exit. Rather than
|
|
|
|
writing both a function decorator and a context manager for the task,
|
|
|
|
inheriting from :class:`ContextDecorator` provides both capabilities in a
|
|
|
|
single definition::
|
|
|
|
|
|
|
|
from contextlib import ContextDecorator
|
|
|
|
import logging
|
|
|
|
|
|
|
|
logging.basicConfig(level=logging.INFO)
|
|
|
|
|
|
|
|
class track_entry_and_exit(ContextDecorator):
|
|
|
|
def __init__(self, name):
|
|
|
|
self.name = name
|
|
|
|
|
|
|
|
def __enter__(self):
|
2016-08-31 04:22:29 -03:00
|
|
|
logging.info('Entering: %s', self.name)
|
2012-05-21 09:54:43 -03:00
|
|
|
|
|
|
|
def __exit__(self, exc_type, exc, exc_tb):
|
2016-08-31 04:22:29 -03:00
|
|
|
logging.info('Exiting: %s', self.name)
|
2012-05-21 09:54:43 -03:00
|
|
|
|
|
|
|
Instances of this class can be used as both a context manager::
|
|
|
|
|
|
|
|
with track_entry_and_exit('widget loader'):
|
|
|
|
print('Some time consuming activity goes here')
|
|
|
|
load_widget()
|
|
|
|
|
|
|
|
And also as a function decorator::
|
|
|
|
|
|
|
|
@track_entry_and_exit('widget loader')
|
|
|
|
def activity():
|
|
|
|
print('Some time consuming activity goes here')
|
|
|
|
load_widget()
|
|
|
|
|
|
|
|
Note that there is one additional limitation when using context managers
|
|
|
|
as function decorators: there's no way to access the return value of
|
|
|
|
:meth:`__enter__`. If that value is needed, then it is still necessary to use
|
|
|
|
an explicit ``with`` statement.
|
|
|
|
|
2007-08-15 11:28:22 -03:00
|
|
|
.. seealso::
|
|
|
|
|
2016-03-31 09:30:54 -03:00
|
|
|
:pep:`343` - The "with" statement
|
2007-08-15 11:28:22 -03:00
|
|
|
The specification, background, and examples for the Python :keyword:`with`
|
|
|
|
statement.
|
|
|
|
|
2013-10-20 00:22:21 -03:00
|
|
|
.. _single-use-reusable-and-reentrant-cms:
|
2013-10-19 11:30:51 -03:00
|
|
|
|
2013-10-20 00:22:21 -03:00
|
|
|
Single use, reusable and reentrant context managers
|
|
|
|
---------------------------------------------------
|
2013-10-19 11:30:51 -03:00
|
|
|
|
|
|
|
Most context managers are written in a way that means they can only be
|
|
|
|
used effectively in a :keyword:`with` statement once. These single use
|
|
|
|
context managers must be created afresh each time they're used -
|
|
|
|
attempting to use them a second time will trigger an exception or
|
|
|
|
otherwise not work correctly.
|
|
|
|
|
|
|
|
This common limitation means that it is generally advisable to create
|
|
|
|
context managers directly in the header of the :keyword:`with` statement
|
|
|
|
where they are used (as shown in all of the usage examples above).
|
|
|
|
|
|
|
|
Files are an example of effectively single use context managers, since
|
|
|
|
the first :keyword:`with` statement will close the file, preventing any
|
|
|
|
further IO operations using that file object.
|
|
|
|
|
|
|
|
Context managers created using :func:`contextmanager` are also single use
|
|
|
|
context managers, and will complain about the underlying generator failing
|
|
|
|
to yield if an attempt is made to use them a second time::
|
|
|
|
|
|
|
|
>>> from contextlib import contextmanager
|
|
|
|
>>> @contextmanager
|
|
|
|
... def singleuse():
|
|
|
|
... print("Before")
|
|
|
|
... yield
|
|
|
|
... print("After")
|
|
|
|
...
|
|
|
|
>>> cm = singleuse()
|
|
|
|
>>> with cm:
|
|
|
|
... pass
|
|
|
|
...
|
|
|
|
Before
|
|
|
|
After
|
|
|
|
>>> with cm:
|
2016-05-10 06:01:23 -03:00
|
|
|
... pass
|
2013-10-19 11:30:51 -03:00
|
|
|
...
|
|
|
|
Traceback (most recent call last):
|
|
|
|
...
|
|
|
|
RuntimeError: generator didn't yield
|
|
|
|
|
|
|
|
|
|
|
|
.. _reentrant-cms:
|
|
|
|
|
|
|
|
Reentrant context managers
|
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
|
|
|
|
More sophisticated context managers may be "reentrant". These context
|
|
|
|
managers can not only be used in multiple :keyword:`with` statements,
|
2018-12-19 02:09:46 -04:00
|
|
|
but may also be used *inside* a :keyword:`!with` statement that is already
|
2013-10-19 11:30:51 -03:00
|
|
|
using the same context manager.
|
|
|
|
|
2013-11-03 03:00:51 -04:00
|
|
|
:class:`threading.RLock` is an example of a reentrant context manager, as are
|
|
|
|
:func:`suppress` and :func:`redirect_stdout`. Here's a very simple example of
|
|
|
|
reentrant use::
|
|
|
|
|
|
|
|
>>> from contextlib import redirect_stdout
|
|
|
|
>>> from io import StringIO
|
|
|
|
>>> stream = StringIO()
|
|
|
|
>>> write_to_stream = redirect_stdout(stream)
|
|
|
|
>>> with write_to_stream:
|
|
|
|
... print("This is written to the stream rather than stdout")
|
|
|
|
... with write_to_stream:
|
|
|
|
... print("This is also written to the stream")
|
2013-10-19 11:30:51 -03:00
|
|
|
...
|
2013-11-03 03:00:51 -04:00
|
|
|
>>> print("This is written directly to stdout")
|
|
|
|
This is written directly to stdout
|
|
|
|
>>> print(stream.getvalue())
|
|
|
|
This is written to the stream rather than stdout
|
|
|
|
This is also written to the stream
|
|
|
|
|
|
|
|
Real world examples of reentrancy are more likely to involve multiple
|
|
|
|
functions calling each other and hence be far more complicated than this
|
|
|
|
example.
|
|
|
|
|
|
|
|
Note also that being reentrant is *not* the same thing as being thread safe.
|
|
|
|
:func:`redirect_stdout`, for example, is definitely not thread safe, as it
|
|
|
|
makes a global modification to the system state by binding :data:`sys.stdout`
|
|
|
|
to a different stream.
|
2013-10-19 11:30:51 -03:00
|
|
|
|
|
|
|
|
|
|
|
.. _reusable-cms:
|
|
|
|
|
|
|
|
Reusable context managers
|
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
|
|
|
|
Distinct from both single use and reentrant context managers are "reusable"
|
|
|
|
context managers (or, to be completely explicit, "reusable, but not
|
|
|
|
reentrant" context managers, since reentrant context managers are also
|
|
|
|
reusable). These context managers support being used multiple times, but
|
|
|
|
will fail (or otherwise not work correctly) if the specific context manager
|
|
|
|
instance has already been used in a containing with statement.
|
|
|
|
|
2013-11-03 03:00:51 -04:00
|
|
|
:class:`threading.Lock` is an example of a reusable, but not reentrant,
|
|
|
|
context manager (for a reentrant lock, it is necessary to use
|
|
|
|
:class:`threading.RLock` instead).
|
2013-10-19 11:30:51 -03:00
|
|
|
|
2013-11-03 03:00:51 -04:00
|
|
|
Another example of a reusable, but not reentrant, context manager is
|
|
|
|
:class:`ExitStack`, as it invokes *all* currently registered callbacks
|
|
|
|
when leaving any with statement, regardless of where those callbacks
|
|
|
|
were added::
|
|
|
|
|
|
|
|
>>> from contextlib import ExitStack
|
|
|
|
>>> stack = ExitStack()
|
|
|
|
>>> with stack:
|
|
|
|
... stack.callback(print, "Callback: from first context")
|
|
|
|
... print("Leaving first context")
|
2013-10-19 11:30:51 -03:00
|
|
|
...
|
2013-11-03 03:00:51 -04:00
|
|
|
Leaving first context
|
|
|
|
Callback: from first context
|
|
|
|
>>> with stack:
|
|
|
|
... stack.callback(print, "Callback: from second context")
|
|
|
|
... print("Leaving second context")
|
2013-10-19 11:30:51 -03:00
|
|
|
...
|
2013-11-03 03:00:51 -04:00
|
|
|
Leaving second context
|
|
|
|
Callback: from second context
|
|
|
|
>>> with stack:
|
|
|
|
... stack.callback(print, "Callback: from outer context")
|
|
|
|
... with stack:
|
|
|
|
... stack.callback(print, "Callback: from inner context")
|
|
|
|
... print("Leaving inner context")
|
|
|
|
... print("Leaving outer context")
|
2013-10-19 11:30:51 -03:00
|
|
|
...
|
2013-11-03 03:00:51 -04:00
|
|
|
Leaving inner context
|
|
|
|
Callback: from inner context
|
|
|
|
Callback: from outer context
|
|
|
|
Leaving outer context
|
|
|
|
|
|
|
|
As the output from the example shows, reusing a single stack object across
|
|
|
|
multiple with statements works correctly, but attempting to nest them
|
|
|
|
will cause the stack to be cleared at the end of the innermost with
|
|
|
|
statement, which is unlikely to be desirable behaviour.
|
|
|
|
|
|
|
|
Using separate :class:`ExitStack` instances instead of reusing a single
|
|
|
|
instance avoids that problem::
|
|
|
|
|
|
|
|
>>> from contextlib import ExitStack
|
|
|
|
>>> with ExitStack() as outer_stack:
|
|
|
|
... outer_stack.callback(print, "Callback: from outer context")
|
|
|
|
... with ExitStack() as inner_stack:
|
|
|
|
... inner_stack.callback(print, "Callback: from inner context")
|
|
|
|
... print("Leaving inner context")
|
|
|
|
... print("Leaving outer context")
|
|
|
|
...
|
|
|
|
Leaving inner context
|
|
|
|
Callback: from inner context
|
|
|
|
Leaving outer context
|
|
|
|
Callback: from outer context
|