Gecko [ fernandoquevedodop.com ]

Name	Size	Permission
2to3.html	70.96 KB	-rw-r--r--
__future__.html	20.75 KB	-rw-r--r--
__main__.html	44.87 KB	-rw-r--r--
_thread.html	30.39 KB	-rw-r--r--
abc.html	46.87 KB	-rw-r--r--
aifc.html	35.56 KB	-rw-r--r--
allos.html	34.33 KB	-rw-r--r--
archiving.html	17 KB	-rw-r--r--
argparse.html	300.89 KB	-rw-r--r--
array.html	37.28 KB	-rw-r--r--
ast.html	293.08 KB	-rw-r--r--
asynchat.html	37.41 KB	-rw-r--r--
asyncio-api-index.html	27.68 KB	-rw-r--r--
asyncio-dev.html	36.1 KB	-rw-r--r--
asyncio-eventloop.html	204.43 KB	-rw-r--r--
asyncio-exceptions.html	17.11 KB	-rw-r--r--
asyncio-future.html	38.23 KB	-rw-r--r--
asyncio-llapi-index.html	61.97 KB	-rw-r--r--
asyncio-platforms.html	21.77 KB	-rw-r--r--
asyncio-policy.html	39.56 KB	-rw-r--r--
asyncio-protocol.html	118.33 KB	-rw-r--r--
asyncio-queue.html	31.86 KB	-rw-r--r--
asyncio-stream.html	69.98 KB	-rw-r--r--
asyncio-subprocess.html	49.25 KB	-rw-r--r--
asyncio-sync.html	42.79 KB	-rw-r--r--
asyncio-task.html	109.14 KB	-rw-r--r--
asyncio.html	17.31 KB	-rw-r--r--
asyncore.html	49.36 KB	-rw-r--r--
atexit.html	22.87 KB	-rw-r--r--
audioop.html	46 KB	-rw-r--r--
audit_events.html	72.85 KB	-rw-r--r--
base64.html	48.09 KB	-rw-r--r--
bdb.html	66 KB	-rw-r--r--
binary.html	15.97 KB	-rw-r--r--
binascii.html	36.3 KB	-rw-r--r--
binhex.html	15.97 KB	-rw-r--r--
bisect.html	43.38 KB	-rw-r--r--
builtins.html	14.87 KB	-rw-r--r--
bz2.html	50.68 KB	-rw-r--r--
calendar.html	69.35 KB	-rw-r--r--
cgi.html	59.95 KB	-rw-r--r--
cgitb.html	19.96 KB	-rw-r--r--
chunk.html	22.21 KB	-rw-r--r--
cmath.html	43.89 KB	-rw-r--r--
cmd.html	50.42 KB	-rw-r--r--
code.html	35.38 KB	-rw-r--r--
codecs.html	157.96 KB	-rw-r--r--
codeop.html	18.26 KB	-rw-r--r--
collections.abc.html	79.17 KB	-rw-r--r--
collections.html	189.43 KB	-rw-r--r--
colorsys.html	17.31 KB	-rw-r--r--
compileall.html	50.68 KB	-rw-r--r--
concurrency.html	24.15 KB	-rw-r--r--
concurrent.futures.html	79.03 KB	-rw-r--r--
concurrent.html	11.56 KB	-rw-r--r--
configparser.html	159.4 KB	-rw-r--r--
constants.html	22.41 KB	-rw-r--r--
contextlib.html	117.2 KB	-rw-r--r--
contextvars.html	38.38 KB	-rw-r--r--
copy.html	17.92 KB	-rw-r--r--
copyreg.html	18.63 KB	-rw-r--r--
crypt.html	28.29 KB	-rw-r--r--
crypto.html	13.93 KB	-rw-r--r--
csv.html	82.89 KB	-rw-r--r--
ctypes.html	295.49 KB	-rw-r--r--
curses.ascii.html	32.04 KB	-rw-r--r--
curses.html	221.24 KB	-rw-r--r--
curses.panel.html	22.16 KB	-rw-r--r--
custominterp.html	11.85 KB	-rw-r--r--
dataclasses.html	113.16 KB	-rw-r--r--
datatypes.html	31.82 KB	-rw-r--r--
datetime.html	374.92 KB	-rw-r--r--
dbm.html	51.16 KB	-rw-r--r--
debug.html	17 KB	-rw-r--r--
decimal.html	270.12 KB	-rw-r--r--
development.html	32.34 KB	-rw-r--r--
devmode.html	31.72 KB	-rw-r--r--
dialog.html	43.03 KB	-rw-r--r--
difflib.html	111.99 KB	-rw-r--r--
dis.html	136.07 KB	-rw-r--r--
distribution.html	13.67 KB	-rw-r--r--
distutils.html	14.73 KB	-rw-r--r--
doctest.html	199.32 KB	-rw-r--r--
email.charset.html	31.92 KB	-rw-r--r--
email.compat32-message.html	97.74 KB	-rw-r--r--
email.contentmanager.html	37.02 KB	-rw-r--r--
email.encoders.html	18.47 KB	-rw-r--r--
email.errors.html	24.45 KB	-rw-r--r--
email.examples.html	60.49 KB	-rw-r--r--
email.generator.html	48.79 KB	-rw-r--r--
email.header.html	37.61 KB	-rw-r--r--
email.headerregistry.html	66.26 KB	-rw-r--r--
email.html	30.75 KB	-rw-r--r--
email.iterators.html	18.23 KB	-rw-r--r--
email.message.html	99.75 KB	-rw-r--r--
email.mime.html	44.89 KB	-rw-r--r--
email.parser.html	57.39 KB	-rw-r--r--
email.policy.html	84.24 KB	-rw-r--r--
email.utils.html	42.57 KB	-rw-r--r--
ensurepip.html	23.9 KB	-rw-r--r--
enum.html	151 KB	-rw-r--r--
errno.html	60.17 KB	-rw-r--r--
exceptions.html	108.44 KB	-rw-r--r--
faulthandler.html	31.5 KB	-rw-r--r--
fcntl.html	36.67 KB	-rw-r--r--
filecmp.html	32.08 KB	-rw-r--r--
fileformats.html	13.52 KB	-rw-r--r--
fileinput.html	40.37 KB	-rw-r--r--
filesys.html	16.78 KB	-rw-r--r--
fnmatch.html	21.02 KB	-rw-r--r--
fractions.html	35.29 KB	-rw-r--r--
frameworks.html	16.15 KB	-rw-r--r--
ftplib.html	71.97 KB	-rw-r--r--
functional.html	12.19 KB	-rw-r--r--
functions.html	260.33 KB	-rw-r--r--
functools.html	92.96 KB	-rw-r--r--
gc.html	40.97 KB	-rw-r--r--
getopt.html	29.4 KB	-rw-r--r--
getpass.html	16.01 KB	-rw-r--r--
gettext.html	98.02 KB	-rw-r--r--
glob.html	27.2 KB	-rw-r--r--
graphlib.html	34.82 KB	-rw-r--r--
grp.html	16.03 KB	-rw-r--r--
gzip.html	45.65 KB	-rw-r--r--
hashlib.html	93.19 KB	-rw-r--r--
heapq.html	42.43 KB	-rw-r--r--
hmac.html	24.74 KB	-rw-r--r--
html.entities.html	14.91 KB	-rw-r--r--
html.html	14.81 KB	-rw-r--r--
html.parser.html	47.7 KB	-rw-r--r--
http.client.html	85.63 KB	-rw-r--r--
http.cookiejar.html	113.94 KB	-rw-r--r--
http.cookies.html	47.64 KB	-rw-r--r--
http.html	45.52 KB	-rw-r--r--
http.server.html	73.05 KB	-rw-r--r--
i18n.html	13.44 KB	-rw-r--r--
idle.html	77.18 KB	-rw-r--r--
imaplib.html	87.08 KB	-rw-r--r--
imghdr.html	17.94 KB	-rw-r--r--
imp.html	54.32 KB	-rw-r--r--
importlib.html	239.96 KB	-rw-r--r--
importlib.metadata.html	43.14 KB	-rw-r--r--
index.html	75.06 KB	-rw-r--r--
inspect.html	168.74 KB	-rw-r--r--
internet.html	29.89 KB	-rw-r--r--
intro.html	13.81 KB	-rw-r--r--
io.html	154.15 KB	-rw-r--r--
ipaddress.html	137.75 KB	-rw-r--r--
ipc.html	12.6 KB	-rw-r--r--
itertools.html	153.27 KB	-rw-r--r--
json.html	98.9 KB	-rw-r--r--
keyword.html	14.88 KB	-rw-r--r--
language.html	16.71 KB	-rw-r--r--
linecache.html	18.09 KB	-rw-r--r--
locale.html	77.35 KB	-rw-r--r--
logging.config.html	100.3 KB	-rw-r--r--
logging.handlers.html	146.28 KB	-rw-r--r--
logging.html	169.67 KB	-rw-r--r--
lzma.html	66.89 KB	-rw-r--r--
mailbox.html	176.34 KB	-rw-r--r--
mailcap.html	20.86 KB	-rw-r--r--
markup.html	22.31 KB	-rw-r--r--
marshal.html	24.43 KB	-rw-r--r--
math.html	85.82 KB	-rw-r--r--
mimetypes.html	40.27 KB	-rw-r--r--
mm.html	11.16 KB	-rw-r--r--
mmap.html	55.53 KB	-rw-r--r--
modulefinder.html	23.67 KB	-rw-r--r--
modules.html	15.88 KB	-rw-r--r--
msilib.html	78.38 KB	-rw-r--r--
msvcrt.html	29.22 KB	-rw-r--r--
multiprocessing.html	405.24 KB	-rw-r--r--
multiprocessing.shared_memory....	60 KB	-rw-r--r--
netdata.html	20.24 KB	-rw-r--r--
netrc.html	20.39 KB	-rw-r--r--
nis.html	16.76 KB	-rw-r--r--
nntplib.html	84.93 KB	-rw-r--r--
numbers.html	45.67 KB	-rw-r--r--
numeric.html	19.29 KB	-rw-r--r--
operator.html	107.32 KB	-rw-r--r--
optparse.html	256.96 KB	-rw-r--r--
os.html	594.39 KB	-rw-r--r--
os.path.html	65.54 KB	-rw-r--r--
ossaudiodev.html	56.35 KB	-rw-r--r--
pathlib.html	170.01 KB	-rw-r--r--
pdb.html	68.67 KB	-rw-r--r--
persistence.html	19.13 KB	-rw-r--r--
pickle.html	154.45 KB	-rw-r--r--
pickletools.html	22.92 KB	-rw-r--r--
pipes.html	21.7 KB	-rw-r--r--
pkgutil.html	42.76 KB	-rw-r--r--
platform.html	45.08 KB	-rw-r--r--
plistlib.html	30.06 KB	-rw-r--r--
poplib.html	41.42 KB	-rw-r--r--
posix.html	20.96 KB	-rw-r--r--
pprint.html	55.35 KB	-rw-r--r--
profile.html	84.63 KB	-rw-r--r--
pty.html	23.7 KB	-rw-r--r--
pwd.html	16.84 KB	-rw-r--r--
py_compile.html	29 KB	-rw-r--r--
pyclbr.html	24.06 KB	-rw-r--r--
pydoc.html	19.59 KB	-rw-r--r--
pyexpat.html	104.38 KB	-rw-r--r--
python.html	22.46 KB	-rw-r--r--
queue.html	43.39 KB	-rw-r--r--
quopri.html	18.64 KB	-rw-r--r--
random.html	86.31 KB	-rw-r--r--
re.html	214.24 KB	-rw-r--r--
readline.html	50.19 KB	-rw-r--r--
reprlib.html	30.85 KB	-rw-r--r--
resource.html	48.26 KB	-rw-r--r--
rlcompleter.html	18.06 KB	-rw-r--r--
runpy.html	30.99 KB	-rw-r--r--
sched.html	27.04 KB	-rw-r--r--
secrets.html	30.2 KB	-rw-r--r--
security_warnings.html	16.21 KB	-rw-r--r--
select.html	74.58 KB	-rw-r--r--
selectors.html	41.91 KB	-rw-r--r--
shelve.html	36.54 KB	-rw-r--r--
shlex.html	61.03 KB	-rw-r--r--
shutil.html	100.13 KB	-rw-r--r--
signal.html	95.39 KB	-rw-r--r--
site.html	38.16 KB	-rw-r--r--
smtpd.html	44.09 KB	-rw-r--r--
smtplib.html	81.4 KB	-rw-r--r--
sndhdr.html	16.4 KB	-rw-r--r--
socket.html	256.95 KB	-rw-r--r--
socketserver.html	91.95 KB	-rw-r--r--
spwd.html	16.71 KB	-rw-r--r--
sqlite3.html	225.51 KB	-rw-r--r--
ssl.html	328.83 KB	-rw-r--r--
stat.html	57.79 KB	-rw-r--r--
statistics.html	123.22 KB	-rw-r--r--
stdtypes.html	615.43 KB	-rw-r--r--
string.html	108.03 KB	-rw-r--r--
stringprep.html	24.94 KB	-rw-r--r--
struct.html	70.58 KB	-rw-r--r--
subprocess.html	199.03 KB	-rw-r--r--
sunau.html	39.84 KB	-rw-r--r--
superseded.html	26.21 KB	-rw-r--r--
symtable.html	33.26 KB	-rw-r--r--
sys.html	198.83 KB	-rw-r--r--
sysconfig.html	39.81 KB	-rw-r--r--
syslog.html	27.36 KB	-rw-r--r--
tabnanny.html	16.18 KB	-rw-r--r--
tarfile.html	161.92 KB	-rw-r--r--
telnetlib.html	38.21 KB	-rw-r--r--
tempfile.html	58.39 KB	-rw-r--r--
termios.html	22.86 KB	-rw-r--r--
test.html	222.85 KB	-rw-r--r--
text.html	16.8 KB	-rw-r--r--
textwrap.html	48.83 KB	-rw-r--r--
threading.html	128.33 KB	-rw-r--r--
time.html	107.46 KB	-rw-r--r--
timeit.html	52.63 KB	-rw-r--r--
tk.html	28.08 KB	-rw-r--r--
tkinter.colorchooser.html	14.49 KB	-rw-r--r--
tkinter.dnd.html	17.09 KB	-rw-r--r--
tkinter.font.html	22.21 KB	-rw-r--r--
tkinter.html	106.85 KB	-rw-r--r--
tkinter.messagebox.html	20.09 KB	-rw-r--r--
tkinter.scrolledtext.html	14.52 KB	-rw-r--r--
tkinter.tix.html	59.69 KB	-rw-r--r--
tkinter.ttk.html	138.37 KB	-rw-r--r--
token.html	45.73 KB	-rw-r--r--
tokenize.html	39.86 KB	-rw-r--r--
trace.html	38.85 KB	-rw-r--r--
traceback.html	75.61 KB	-rw-r--r--
tracemalloc.html	122.33 KB	-rw-r--r--
tty.html	14.46 KB	-rw-r--r--
turtle.html	271.71 KB	-rw-r--r--
types.html	64.85 KB	-rw-r--r--
typing.html	315.69 KB	-rw-r--r--
unicodedata.html	27.3 KB	-rw-r--r--
unittest.html	310.01 KB	-rw-r--r--
unittest.mock-examples.html	177.75 KB	-rw-r--r--
unittest.mock.html	363.51 KB	-rw-r--r--
unix.html	13.46 KB	-rw-r--r--
urllib.error.html	18.56 KB	-rw-r--r--
urllib.html	12.92 KB	-rw-r--r--
urllib.parse.html	104.65 KB	-rw-r--r--
urllib.request.html	208.87 KB	-rw-r--r--
urllib.robotparser.html	22.63 KB	-rw-r--r--
uu.html	18.2 KB	-rw-r--r--
uuid.html	42.88 KB	-rw-r--r--
venv.html	90.43 KB	-rw-r--r--
warnings.html	69.13 KB	-rw-r--r--
wave.html	36.12 KB	-rw-r--r--
weakref.html	73.36 KB	-rw-r--r--
webbrowser.html	33.98 KB	-rw-r--r--
windows.html	12.32 KB	-rw-r--r--
winreg.html	89.48 KB	-rw-r--r--
winsound.html	26.3 KB	-rw-r--r--
wsgiref.html	111.52 KB	-rw-r--r--
xdrlib.html	42.07 KB	-rw-r--r--
xml.dom.html	114.66 KB	-rw-r--r--
xml.dom.minidom.html	49.6 KB	-rw-r--r--
xml.dom.pulldom.html	30.06 KB	-rw-r--r--
xml.etree.elementtree.html	186.49 KB	-rw-r--r--
xml.html	22.34 KB	-rw-r--r--
xml.sax.handler.html	55.78 KB	-rw-r--r--
xml.sax.html	31.74 KB	-rw-r--r--
xml.sax.reader.html	56.23 KB	-rw-r--r--
xml.sax.utils.html	22.28 KB	-rw-r--r--
xmlrpc.client.html	79.73 KB	-rw-r--r--
xmlrpc.html	11.9 KB	-rw-r--r--
xmlrpc.server.html	63.56 KB	-rw-r--r--
zipapp.html	52.45 KB	-rw-r--r--
zipfile.html	116.59 KB	-rw-r--r--
zipimport.html	33.76 KB	-rw-r--r--
zlib.html	42.29 KB	-rw-r--r--
zoneinfo.html	57.25 KB	-rw-r--r--

Code Editor : contextlib.html

<!DOCTYPE html>

<title>contextlib — Utilities for with-statement contexts &#8212; Python 3.10.12 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
 
 <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
 <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?2022.1" />
 
 <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
 <script src="../_static/jquery.js"></script>
 <script src="../_static/underscore.js"></script>
 <script src="../_static/doctools.js"></script>
 
 <script src="../_static/sidebar.js"></script>
 
 <link rel="search" type="application/opensearchdescription+xml"
 title="Search within Python 3.10.12 documentation"
 href="../_static/opensearch.xml"/>
 <link rel="author" title="About these documents" href="../about.html" />
 <link rel="index" title="Index" href="../genindex.html" />
 <link rel="search" title="Search" href="../search.html" />
 <link rel="copyright" title="Copyright" href="../copyright.html" />
 <link rel="next" title="abc — Abstract Base Classes" href="abc.html" />
 <link rel="prev" title="dataclasses — Data Classes" href="dataclasses.html" />
 <link rel="canonical" href="file:///usr/share/doc/python3.10/html/library/contextlib.html" />

</head>
<body>
<div class="mobile-nav">
 <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"
 aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu" />
 <label for="menuToggler" class="toggler__label">
 
 </label>
 <nav class="nav-content" role="navigation">
 <a href="https://www.python.org/" class="nav-logo">
 <img src="../_static/py.svg" alt="Logo"/>
 </a>
 <div class="version_switcher_placeholder"></div>
 <form role="search" class="search" action="../search.html" method="get">
 <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">
 <path fill-rule="nonzero"
 d="M15.5 14h-.79l-.28-.27a6.5 6.5 0 001.48-5.34c-.47-2.78-2.79-5-5.59-5.34a6.505 6.505 0 00-7.27 7.27c.34 2.8 2.56 5.12 5.34 5.59a6.5 6.5 0 005.34-1.48l.27.28v.79l4.25 4.25c.41.41 1.08.41 1.49 0 .41-.41.41-1.08 0-1.49L15.5 14zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z" fill="#444"></path>
 </svg>
 <input type="text" name="q" aria-label="Quick search"/>
 <input type="submit" value="Go"/>
 </form>
 </nav>
 <div class="menu-wrapper">
 <nav class="menu" role="navigation" aria-label="main navigation">
 <div class="language_switcher_placeholder"></div>
 <h3><a href="../contents.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate">contextlib</code> — Utilities for <code class="xref std std-keyword docutils literal notranslate">with</code>-statement contexts</a><ul>
<li><a class="reference internal" href="#utilities">Utilities</a></li>
<li><a class="reference internal" href="#examples-and-recipes">Examples and Recipes</a><ul>
<li><a class="reference internal" href="#supporting-a-variable-number-of-context-managers">Supporting a variable number of context managers</a></li>
<li><a class="reference internal" href="#catching-exceptions-from-enter-methods">Catching exceptions from <code class="docutils literal notranslate">__enter__</code> methods</a></li>
<li><a class="reference internal" href="#cleaning-up-in-an-enter-implementation">Cleaning up in an <code class="docutils literal notranslate">__enter__</code> implementation</a></li>
<li><a class="reference internal" href="#replacing-any-use-of-try-finally-and-flag-variables">Replacing any use of <code class="docutils literal notranslate">try-finally</code> and flag variables</a></li>
<li><a class="reference internal" href="#using-a-context-manager-as-a-function-decorator">Using a context manager as a function decorator</a></li>
</ul>
</li>
<li><a class="reference internal" href="#single-use-reusable-and-reentrant-context-managers">Single use, reusable and reentrant context managers</a><ul>
<li><a class="reference internal" href="#reentrant-context-managers">Reentrant context managers</a></li>
<li><a class="reference internal" href="#reusable-context-managers">Reusable context managers</a></li>
</ul>
</li>
</ul>
</li>
</ul>

<div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 accesskey="I">index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="abc.html" title="abc — Abstract Base Classes"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="dataclasses.html" title="dataclasses — Data Classes"
 accesskey="P">previous</a> |</li>

<li><img src="../_static/py.svg" alt="python logo" style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li class="switchers">
 <div class="language_switcher_placeholder"></div>
 <div class="version_switcher_placeholder"></div>
 </li>
 <li>
 
 </li>
 <li id="cpython-language-and-version">
 <a href="../index.html">3.10.12 Documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="python.html" accesskey="U">Python Runtime Services</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate">contextlib</code> — Utilities for <code class="xref std std-keyword docutils literal notranslate">with</code>-statement contexts</a></li>
 <li class="right">

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="module-contextlib">
<h1><code class="xref py py-mod docutils literal notranslate">contextlib</code> — Utilities for <code class="xref std std-keyword docutils literal notranslate">with</code>-statement contexts<a class="headerlink" href="#module-contextlib" title="Permalink to this headline">¶</a></h1>
Source code: <a class="reference external" href="https://github.com/python/cpython/tree/3.10/Lib/contextlib.py">Lib/contextlib.py</a>
<hr class="docutils" />
This module provides utilities for common tasks involving the <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate">with</code></a>
statement. For more information see also <a class="reference internal" href="stdtypes.html#typecontextmanager">Context Manager Types</a> and
<a class="reference internal" href="../reference/datamodel.html#context-managers">With Statement Context Managers</a>.
<section id="utilities">
<h2>Utilities<a class="headerlink" href="#utilities" title="Permalink to this headline">¶</a></h2>
Functions and classes provided:
<dl class="py class">
<dt class="sig sig-object py" id="contextlib.AbstractContextManager">
class contextlib.AbstractContextManager<a class="headerlink" href="#contextlib.AbstractContextManager" title="Permalink to this definition">¶</a></dt>
<dd>An <a class="reference internal" href="../glossary.html#term-abstract-base-class">abstract base class</a> for classes that implement
<a class="reference internal" href="../reference/datamodel.html#object.__enter__" title="object.__enter__"><code class="xref py py-meth docutils literal notranslate">object.__enter__()</code></a> and <a class="reference internal" href="../reference/datamodel.html#object.__exit__" title="object.__exit__"><code class="xref py py-meth docutils literal notranslate">object.__exit__()</code></a>. A default
implementation for <a class="reference internal" href="../reference/datamodel.html#object.__enter__" title="object.__enter__"><code class="xref py py-meth docutils literal notranslate">object.__enter__()</code></a> is provided which returns
<code class="docutils literal notranslate">self</code> while <a class="reference internal" href="../reference/datamodel.html#object.__exit__" title="object.__exit__"><code class="xref py py-meth docutils literal notranslate">object.__exit__()</code></a> is an abstract method which by default
returns <code class="docutils literal notranslate">None</code>. See also the definition of <a class="reference internal" href="stdtypes.html#typecontextmanager">Context Manager Types</a>.
<div class="versionadded">
New in version 3.6.
</div>
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="contextlib.AbstractAsyncContextManager">
class contextlib.AbstractAsyncContextManager<a class="headerlink" href="#contextlib.AbstractAsyncContextManager" title="Permalink to this definition">¶</a></dt>
<dd>An <a class="reference internal" href="../glossary.html#term-abstract-base-class">abstract base class</a> for classes that implement
<a class="reference internal" href="../reference/datamodel.html#object.__aenter__" title="object.__aenter__"><code class="xref py py-meth docutils literal notranslate">object.__aenter__()</code></a> and <a class="reference internal" href="../reference/datamodel.html#object.__aexit__" title="object.__aexit__"><code class="xref py py-meth docutils literal notranslate">object.__aexit__()</code></a>. A default
implementation for <a class="reference internal" href="../reference/datamodel.html#object.__aenter__" title="object.__aenter__"><code class="xref py py-meth docutils literal notranslate">object.__aenter__()</code></a> is provided which returns
<code class="docutils literal notranslate">self</code> while <a class="reference internal" href="../reference/datamodel.html#object.__aexit__" title="object.__aexit__"><code class="xref py py-meth docutils literal notranslate">object.__aexit__()</code></a> is an abstract method which by default
returns <code class="docutils literal notranslate">None</code>. See also the definition of
<a class="reference internal" href="../reference/datamodel.html#async-context-managers">Asynchronous Context Managers</a>.
<div class="versionadded">
New in version 3.7.
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="contextlib.contextmanager">
&#64;contextlib.contextmanager<a class="headerlink" href="#contextlib.contextmanager" title="Permalink to this definition">¶</a></dt>
<dd>This function is a <a class="reference internal" href="../glossary.html#term-decorator">decorator</a> that can be used to define a factory
function for <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate">with</code></a> statement context managers, without needing to
create a class or separate <code class="xref py py-meth docutils literal notranslate">__enter__()</code> and <code class="xref py py-meth docutils literal notranslate">__exit__()</code> methods.
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 <code class="docutils literal notranslate">close()</code> method for use with <code class="docutils literal notranslate">contextlib.closing</code>
An abstract example would be the following to ensure correct resource
management:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>from contextlib import contextmanager

@contextmanager
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)
</pre></div>
</div>
The function can then be used like this:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; 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
</pre></div>
</div>
The function being decorated must return a <a class="reference internal" href="../glossary.html#term-generator">generator</a>-iterator when
called. This iterator must yield exactly one value, which will be bound to
the targets in the <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate">with</code></a> statement’s <code class="xref std std-keyword docutils literal notranslate">as</code> clause, if any.
At the point where the generator yields, the block nested in the <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate">with</code></a>
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
<a class="reference internal" href="../reference/compound_stmts.html#try"><code class="xref std std-keyword docutils literal notranslate">try</code></a>…<a class="reference internal" href="../reference/compound_stmts.html#except"><code class="xref std std-keyword docutils literal notranslate">except</code></a>…<a class="reference internal" href="../reference/compound_stmts.html#finally"><code class="xref std std-keyword docutils literal notranslate">finally</code></a> 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
generator context manager will indicate to the <code class="xref std std-keyword docutils literal notranslate">with</code> statement that
the exception has been handled, and execution will resume with the statement
immediately following the <code class="xref std std-keyword docutils literal notranslate">with</code> statement.
<a class="reference internal" href="#contextlib.contextmanager" title="contextlib.contextmanager"><code class="xref py py-func docutils literal notranslate">contextmanager()</code></a> uses <a class="reference internal" href="#contextlib.ContextDecorator" title="contextlib.ContextDecorator"><code class="xref py py-class docutils literal notranslate">ContextDecorator</code></a> so the context managers
it creates can be used as decorators as well as in <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate">with</code></a> 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 <a class="reference internal" href="#contextlib.contextmanager" title="contextlib.contextmanager"><code class="xref py py-func docutils literal notranslate">contextmanager()</code></a> to meet the requirement that context
managers support multiple invocations in order to be used as decorators).
<div class="versionchanged">
Changed in version 3.2: Use of <a class="reference internal" href="#contextlib.ContextDecorator" title="contextlib.ContextDecorator"><code class="xref py py-class docutils literal notranslate">ContextDecorator</code></a>.
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="contextlib.asynccontextmanager">
&#64;contextlib.asynccontextmanager<a class="headerlink" href="#contextlib.asynccontextmanager" title="Permalink to this definition">¶</a></dt>
<dd><blockquote>
<div>Similar to <a class="reference internal" href="#contextlib.contextmanager" title="contextlib.contextmanager"><code class="xref py py-func docutils literal notranslate">contextmanager()</code></a>, but creates an
<a class="reference internal" href="../reference/datamodel.html#async-context-managers">asynchronous context manager</a>.
This function is a <a class="reference internal" href="../glossary.html#term-decorator">decorator</a> that can be used to define a factory
function for <a class="reference internal" href="../reference/compound_stmts.html#async-with"><code class="xref std std-keyword docutils literal notranslate">async with</code></a> statement asynchronous context managers,
without needing to create a class or separate <code class="xref py py-meth docutils literal notranslate">__aenter__()</code> and
<code class="xref py py-meth docutils literal notranslate">__aexit__()</code> methods. It must be applied to an <a class="reference internal" href="../glossary.html#term-asynchronous-generator">asynchronous
generator</a> function.
A simple example:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>from contextlib import asynccontextmanager

@asynccontextmanager
async def get_connection():
 conn = await acquire_db_connection()
 try:
 yield conn
 finally:
 await release_db_connection(conn)

async def get_all_users():
 async with get_connection() as conn:
 return conn.query(&#39;SELECT ...&#39;)
</pre></div>
</div>
<div class="versionadded">
New in version 3.7.
</div>
Context managers defined with <a class="reference internal" href="#contextlib.asynccontextmanager" title="contextlib.asynccontextmanager"><code class="xref py py-func docutils literal notranslate">asynccontextmanager()</code></a> can be used
either as decorators or with <a class="reference internal" href="../reference/compound_stmts.html#async-with"><code class="xref std std-keyword docutils literal notranslate">async with</code></a> statements:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>import time
from contextlib import asynccontextmanager

@asynccontextmanager
async def timeit():
 now = time.monotonic()
 try:
 yield
 finally:
 print(f&#39;it took {time.monotonic() - now}s to run&#39;)

@timeit()
async def main():
 # ... async code ...
</pre></div>
</div>
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 <a class="reference internal" href="#contextlib.asynccontextmanager" title="contextlib.asynccontextmanager"><code class="xref py py-func docutils literal notranslate">asynccontextmanager()</code></a> to meet the requirement that context
managers support multiple invocations in order to be used as decorators.
</div></blockquote>
<div class="versionchanged">
Changed in version 3.10: Async context managers created with <a class="reference internal" href="#contextlib.asynccontextmanager" title="contextlib.asynccontextmanager"><code class="xref py py-func docutils literal notranslate">asynccontextmanager()</code></a> can
be used as decorators.
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="contextlib.closing">
contextlib.closing(thing)<a class="headerlink" href="#contextlib.closing" title="Permalink to this definition">¶</a></dt>
<dd>Return a context manager that closes thing upon completion of the block. This
is basically equivalent to:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>from contextlib import contextmanager

@contextmanager
def closing(thing):
 try:
 yield thing
 finally:
 thing.close()
</pre></div>
</div>
And lets you write code like this:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>from contextlib import closing
from urllib.request import urlopen

with closing(urlopen(&#39;https://www.python.org&#39;)) as page:
 for line in page:
 print(line)
</pre></div>
</div>
without needing to explicitly close <code class="docutils literal notranslate">page</code>. Even if an error occurs,
<code class="docutils literal notranslate">page.close()</code> will be called when the <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate">with</code></a> block is exited.
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="contextlib.aclosing">
contextlib.aclosing(thing)<a class="headerlink" href="#contextlib.aclosing" title="Permalink to this definition">¶</a></dt>
<dd>Return an async context manager that calls the <code class="docutils literal notranslate">aclose()</code> method of thing
upon completion of the block. This is basically equivalent to:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>from contextlib import asynccontextmanager

@asynccontextmanager
async def aclosing(thing):
 try:
 yield thing
 finally:
 await thing.aclose()
</pre></div>
</div>
Significantly, <code class="docutils literal notranslate">aclosing()</code> supports deterministic cleanup of async
generators when they happen to exit early by <a class="reference internal" href="../reference/simple_stmts.html#break"><code class="xref std std-keyword docutils literal notranslate">break</code></a> or an
exception. For example:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>from contextlib import aclosing

async with aclosing(my_generator()) as values:
 async for value in values:
 if value == 42:
 break
</pre></div>
</div>
This pattern ensures that the generator’s async exit code is executed in
the same context as its iterations (so that exceptions and context
variables work as expected, and the exit code isn’t run after the
lifetime of some task it depends on).
<div class="versionadded">
New in version 3.10.
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="contextlib.nullcontext">
contextlib.nullcontext(enter_result=None)<a class="headerlink" href="#contextlib.nullcontext" title="Permalink to this definition">¶</a></dt>
<dd>Return a context manager that returns enter_result from <code class="docutils literal notranslate">__enter__</code>, but
otherwise does nothing. It is intended to be used as a stand-in for an
optional context manager, for example:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>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
</pre></div>
</div>
An example using enter_result:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>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
</pre></div>
</div>
It can also be used as a stand-in for
<a class="reference internal" href="../reference/datamodel.html#async-context-managers">asynchronous context managers</a>:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>async def send_http(session=None):
 if not session:
 # If no http session, create it with aiohttp
 cm = aiohttp.ClientSession()
 else:
 # Caller is responsible for closing the session
 cm = nullcontext(session)

async with cm as session:
 # Send http requests with session
</pre></div>
</div>
<div class="versionadded">
New in version 3.7.
</div>
<div class="versionchanged">
Changed in version 3.10: <a class="reference internal" href="../glossary.html#term-asynchronous-context-manager">asynchronous context manager</a> support was added.
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="contextlib.suppress">
contextlib.suppress(*exceptions)<a class="headerlink" href="#contextlib.suppress" title="Permalink to this definition">¶</a></dt>
<dd>Return a context manager that suppresses any of the specified exceptions
if they occur in the body of a <code class="xref std std-keyword docutils literal notranslate">with</code> statement and then
resumes execution with the first statement following the end of the
<code class="xref std std-keyword docutils literal notranslate">with</code> statement.
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.
For example:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>from contextlib import suppress

with suppress(FileNotFoundError):
 os.remove(&#39;someotherfile.tmp&#39;)
</pre></div>
</div>
This code is equivalent to:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>try:
 os.remove(&#39;somefile.tmp&#39;)
except FileNotFoundError:
 pass

try:
 os.remove(&#39;someotherfile.tmp&#39;)
except FileNotFoundError:
 pass
</pre></div>
</div>
This context manager is <a class="reference internal" href="#reentrant-cms">reentrant</a>.
<div class="versionadded">
New in version 3.4.
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="contextlib.redirect_stdout">
contextlib.redirect_stdout(new_target)<a class="headerlink" href="#contextlib.redirect_stdout" title="Permalink to this definition">¶</a></dt>
<dd>Context manager for temporarily redirecting <a class="reference internal" href="sys.html#sys.stdout" title="sys.stdout"><code class="xref py py-data docutils literal notranslate">sys.stdout</code></a> 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 <a class="reference internal" href="functions.html#help" title="help"><code class="xref py py-func docutils literal notranslate">help()</code></a> normally is sent to sys.stdout.
You can capture that output in a string by redirecting the output to an
<a class="reference internal" href="io.html#io.StringIO" title="io.StringIO"><code class="xref py py-class docutils literal notranslate">io.StringIO</code></a> object. The replacement stream is returned from the
<code class="docutils literal notranslate">__enter__</code> method and so is available as the target of the
<a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate">with</code></a> statement:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>with redirect_stdout(io.StringIO()) as f:
 help(pow)
s = f.getvalue()
</pre></div>
</div>
To send the output of <a class="reference internal" href="functions.html#help" title="help"><code class="xref py py-func docutils literal notranslate">help()</code></a> to a file on disk, redirect the output
to a regular file:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>with open(&#39;help.txt&#39;, &#39;w&#39;) as f:
 with redirect_stdout(f):
 help(pow)
</pre></div>
</div>
To send the output of <a class="reference internal" href="functions.html#help" title="help"><code class="xref py py-func docutils literal notranslate">help()</code></a> to sys.stderr:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>with redirect_stdout(sys.stderr):
 help(pow)
</pre></div>
</div>
Note that the global side effect on <a class="reference internal" href="sys.html#sys.stdout" title="sys.stdout"><code class="xref py py-data docutils literal notranslate">sys.stdout</code></a> 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.
This context manager is <a class="reference internal" href="#reentrant-cms">reentrant</a>.
<div class="versionadded">
New in version 3.4.
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="contextlib.redirect_stderr">
contextlib.redirect_stderr(new_target)<a class="headerlink" href="#contextlib.redirect_stderr" title="Permalink to this definition">¶</a></dt>
<dd>Similar to <a class="reference internal" href="#contextlib.redirect_stdout" title="contextlib.redirect_stdout"><code class="xref py py-func docutils literal notranslate">redirect_stdout()</code></a> but redirecting
<a class="reference internal" href="sys.html#sys.stderr" title="sys.stderr"><code class="xref py py-data docutils literal notranslate">sys.stderr</code></a> to another file or file-like object.
This context manager is <a class="reference internal" href="#reentrant-cms">reentrant</a>.
<div class="versionadded">
New in version 3.5.
</div>
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="contextlib.ContextDecorator">
class contextlib.ContextDecorator<a class="headerlink" href="#contextlib.ContextDecorator" title="Permalink to this definition">¶</a></dt>
<dd>A base class that enables a context manager to also be used as a decorator.
Context managers inheriting from <code class="docutils literal notranslate">ContextDecorator</code> have to implement
<code class="docutils literal notranslate">__enter__</code> and <code class="docutils literal notranslate">__exit__</code> as normal. <code class="docutils literal notranslate">__exit__</code> retains its optional
exception handling even when used as a decorator.
<code class="docutils literal notranslate">ContextDecorator</code> is used by <a class="reference internal" href="#contextlib.contextmanager" title="contextlib.contextmanager"><code class="xref py py-func docutils literal notranslate">contextmanager()</code></a>, so you get this
functionality automatically.
Example of <code class="docutils literal notranslate">ContextDecorator</code>:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>from contextlib import ContextDecorator

class mycontext(ContextDecorator):
 def __enter__(self):
 print(&#39;Starting&#39;)
 return self

def __exit__(self, *exc):
 print(&#39;Finishing&#39;)
 return False
</pre></div>
</div>
The class can then be used like this:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; @mycontext()
... def function():
... print(&#39;The bit in the middle&#39;)
...
&gt;&gt;&gt; function()
Starting
The bit in the middle
Finishing

&gt;&gt;&gt; with mycontext():
... print(&#39;The bit in the middle&#39;)
...
Starting
The bit in the middle
Finishing
</pre></div>
</div>
This change is just syntactic sugar for any construct of the following form:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>def f():
 with cm():
 # Do stuff
</pre></div>
</div>
<code class="docutils literal notranslate">ContextDecorator</code> lets you instead write:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>@cm()
def f():
 # Do stuff
</pre></div>
</div>
It makes it clear that the <code class="docutils literal notranslate">cm</code> applies to the whole function, rather than
just a piece of it (and saving an indentation level is nice, too).
Existing context managers that already have a base class can be extended by
using <code class="docutils literal notranslate">ContextDecorator</code> as a mixin class:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>from contextlib import ContextDecorator

class mycontext(ContextBaseClass, ContextDecorator):
 def __enter__(self):
 return self

def __exit__(self, *exc):
 return False
</pre></div>
</div>
<div class="admonition note">
Note
As the decorated function must be able to be called multiple times, the
underlying context manager must support use in multiple <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate">with</code></a>
statements. If this is not the case, then the original construct with the
explicit <code class="xref std std-keyword docutils literal notranslate">with</code> statement inside the function should be used.
</div>
<div class="versionadded">
New in version 3.2.
</div>
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="contextlib.AsyncContextDecorator">
class contextlib.AsyncContextDecorator<a class="headerlink" href="#contextlib.AsyncContextDecorator" title="Permalink to this definition">¶</a></dt>
<dd>Similar to <a class="reference internal" href="#contextlib.ContextDecorator" title="contextlib.ContextDecorator"><code class="xref py py-class docutils literal notranslate">ContextDecorator</code></a> but only for asynchronous functions.
Example of <code class="docutils literal notranslate">AsyncContextDecorator</code>:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>from asyncio import run
from contextlib import AsyncContextDecorator

class mycontext(AsyncContextDecorator):
 async def __aenter__(self):
 print(&#39;Starting&#39;)
 return self

async def __aexit__(self, *exc):
 print(&#39;Finishing&#39;)
 return False
</pre></div>
</div>
The class can then be used like this:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; @mycontext()
... async def function():
... print(&#39;The bit in the middle&#39;)
...
&gt;&gt;&gt; run(function())
Starting
The bit in the middle
Finishing

&gt;&gt;&gt; async def function():
... async with mycontext():
... print(&#39;The bit in the middle&#39;)
...
&gt;&gt;&gt; run(function())
Starting
The bit in the middle
Finishing
</pre></div>
</div>
<div class="versionadded">
New in version 3.10.
</div>
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="contextlib.ExitStack">
class contextlib.ExitStack<a class="headerlink" href="#contextlib.ExitStack" title="Permalink to this definition">¶</a></dt>
<dd>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:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>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
 # in the list raise an exception
</pre></div>
</div>
The <code class="xref py py-meth docutils literal notranslate">__enter__()</code> method returns the <a class="reference internal" href="#contextlib.ExitStack" title="contextlib.ExitStack"><code class="xref py py-class docutils literal notranslate">ExitStack</code></a> instance, and
performs no additional operations.
Each instance maintains a stack of registered callbacks that are called in
reverse order when the instance is closed (either explicitly or implicitly
at the end of a <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate">with</code></a> statement). Note that callbacks are not
invoked implicitly when the context stack instance is garbage collected.
This stack model is used so that context managers that acquire their
resources in their <code class="docutils literal notranslate">__init__</code> method (such as file objects) can be
handled correctly.
Since registered callbacks are invoked in the reverse order of
registration, this ends up behaving as if multiple nested <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate">with</code></a>
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.
<div class="versionadded">
New in version 3.3.
</div>
<dl class="py method">
<dt class="sig sig-object py" id="contextlib.ExitStack.enter_context">
enter_context(cm)<a class="headerlink" href="#contextlib.ExitStack.enter_context" title="Permalink to this definition">¶</a></dt>
<dd>Enters a new context manager and adds its <code class="xref py py-meth docutils literal notranslate">__exit__()</code> method to
the callback stack. The return value is the result of the context
manager’s own <code class="xref py py-meth docutils literal notranslate">__enter__()</code> method.
These context managers may suppress exceptions just as they normally
would if used directly as part of a <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate">with</code></a> statement.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="contextlib.ExitStack.push">
push(exit)<a class="headerlink" href="#contextlib.ExitStack.push" title="Permalink to this definition">¶</a></dt>
<dd>Adds a context manager’s <code class="xref py py-meth docutils literal notranslate">__exit__()</code> method to the callback stack.
As <code class="docutils literal notranslate">__enter__</code> is not invoked, this method can be used to cover
part of an <code class="xref py py-meth docutils literal notranslate">__enter__()</code> implementation with a context manager’s own
<code class="xref py py-meth docutils literal notranslate">__exit__()</code> 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
<code class="xref py py-meth docutils literal notranslate">__exit__()</code> method and adds it directly to the callback stack.
By returning true values, these callbacks can suppress exceptions the
same way context manager <code class="xref py py-meth docutils literal notranslate">__exit__()</code> methods can.
The passed in object is returned from the function, allowing this
method to be used as a function decorator.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="contextlib.ExitStack.callback">
callback(callback, /, *args, **kwds)<a class="headerlink" href="#contextlib.ExitStack.callback" title="Permalink to this definition">¶</a></dt>
<dd>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
method to be used as a function decorator.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="contextlib.ExitStack.pop_all">
pop_all()<a class="headerlink" href="#contextlib.ExitStack.pop_all" title="Permalink to this definition">¶</a></dt>
<dd>Transfers the callback stack to a fresh <a class="reference internal" href="#contextlib.ExitStack" title="contextlib.ExitStack"><code class="xref py py-class docutils literal notranslate">ExitStack</code></a> instance
and returns it. No callbacks are invoked by this operation - instead,
they will now be invoked when the new stack is closed (either
explicitly or implicitly at the end of a <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate">with</code></a> statement).
For example, a group of files can be opened as an “all or nothing”
operation as follows:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>with ExitStack() as stack:
 files = [stack.enter_context(open(fname)) for fname in filenames]
 # Hold onto the close method, but don&#39;t call it yet.
 close_files = stack.pop_all().close
 # 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.
 # close_files() can then be invoked explicitly to close them all.
</pre></div>
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="contextlib.ExitStack.close">
close()<a class="headerlink" href="#contextlib.ExitStack.close" title="Permalink to this definition">¶</a></dt>
<dd>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.
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="contextlib.AsyncExitStack">
class contextlib.AsyncExitStack<a class="headerlink" href="#contextlib.AsyncExitStack" title="Permalink to this definition">¶</a></dt>
<dd>An <a class="reference internal" href="../reference/datamodel.html#async-context-managers">asynchronous context manager</a>, similar
to <a class="reference internal" href="#contextlib.ExitStack" title="contextlib.ExitStack"><code class="xref py py-class docutils literal notranslate">ExitStack</code></a>, that supports combining both synchronous and
asynchronous context managers, as well as having coroutines for
cleanup logic.
The <code class="xref py py-meth docutils literal notranslate">close()</code> method is not implemented, <a class="reference internal" href="#contextlib.AsyncExitStack.aclose" title="contextlib.AsyncExitStack.aclose"><code class="xref py py-meth docutils literal notranslate">aclose()</code></a> must be used
instead.
<dl class="py method">
<dt class="sig sig-object py" id="contextlib.AsyncExitStack.enter_async_context">
coroutine enter_async_context(cm)<a class="headerlink" href="#contextlib.AsyncExitStack.enter_async_context" title="Permalink to this definition">¶</a></dt>
<dd>Similar to <code class="xref py py-meth docutils literal notranslate">enter_context()</code> but expects an asynchronous context
manager.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="contextlib.AsyncExitStack.push_async_exit">
push_async_exit(exit)<a class="headerlink" href="#contextlib.AsyncExitStack.push_async_exit" title="Permalink to this definition">¶</a></dt>
<dd>Similar to <code class="xref py py-meth docutils literal notranslate">push()</code> but expects either an asynchronous context manager
or a coroutine function.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="contextlib.AsyncExitStack.push_async_callback">
push_async_callback(callback, /, *args, **kwds)<a class="headerlink" href="#contextlib.AsyncExitStack.push_async_callback" title="Permalink to this definition">¶</a></dt>
<dd>Similar to <code class="xref py py-meth docutils literal notranslate">callback()</code> but expects a coroutine function.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="contextlib.AsyncExitStack.aclose">
coroutine aclose()<a class="headerlink" href="#contextlib.AsyncExitStack.aclose" title="Permalink to this definition">¶</a></dt>
<dd>Similar to <code class="xref py py-meth docutils literal notranslate">close()</code> but properly handles awaitables.
</dd></dl>

Continuing the example for <a class="reference internal" href="#contextlib.asynccontextmanager" title="contextlib.asynccontextmanager"><code class="xref py py-func docutils literal notranslate">asynccontextmanager()</code></a>:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>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.
</pre></div>
</div>
<div class="versionadded">
New in version 3.7.
</div>
</dd></dl>

</section>
<section id="examples-and-recipes">
<h2>Examples and Recipes<a class="headerlink" href="#examples-and-recipes" title="Permalink to this headline">¶</a></h2>
This section describes some examples and recipes for making effective use of
the tools provided by <a class="reference internal" href="#module-contextlib" title="contextlib: Utilities for with-statement contexts."><code class="xref py py-mod docutils literal notranslate">contextlib</code></a>.
<section id="supporting-a-variable-number-of-context-managers">
<h3>Supporting a variable number of context managers<a class="headerlink" href="#supporting-a-variable-number-of-context-managers" title="Permalink to this headline">¶</a></h3>
The primary use case for <a class="reference internal" href="#contextlib.ExitStack" title="contextlib.ExitStack"><code class="xref py py-class docutils literal notranslate">ExitStack</code></a> is the one given in the class
documentation: supporting a variable number of context managers and other
cleanup operations in a single <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate">with</code></a> 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:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>with ExitStack() as stack:
 for resource in resources:
 stack.enter_context(resource)
 if need_special_resource():
 special = acquire_special_resource()
 stack.callback(release_special_resource, special)
 # Perform operations that use the acquired resources
</pre></div>
</div>
As shown, <a class="reference internal" href="#contextlib.ExitStack" title="contextlib.ExitStack"><code class="xref py py-class docutils literal notranslate">ExitStack</code></a> also makes it quite easy to use <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate">with</code></a>
statements to manage arbitrary resources that don’t natively support the
context management protocol.
</section>
<section id="catching-exceptions-from-enter-methods">
<h3>Catching exceptions from <code class="docutils literal notranslate">__enter__</code> methods<a class="headerlink" href="#catching-exceptions-from-enter-methods" title="Permalink to this headline">¶</a></h3>
It is occasionally desirable to catch exceptions from an <code class="docutils literal notranslate">__enter__</code>
method implementation, without inadvertently catching exceptions from
the <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate">with</code></a> statement body or the context manager’s <code class="docutils literal notranslate">__exit__</code>
method. By using <a class="reference internal" href="#contextlib.ExitStack" title="contextlib.ExitStack"><code class="xref py py-class docutils literal notranslate">ExitStack</code></a> the steps in the context management
protocol can be separated slightly in order to allow this:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>stack = ExitStack()
try:
 x = stack.enter_context(cm)
except Exception:
 # handle __enter__ exception
else:
 with stack:
 # Handle normal case
</pre></div>
</div>
Actually needing to do this is likely to indicate that the underlying API
should be providing a direct resource management interface for use with
<a class="reference internal" href="../reference/compound_stmts.html#try"><code class="xref std std-keyword docutils literal notranslate">try</code></a>/<a class="reference internal" href="../reference/compound_stmts.html#except"><code class="xref std std-keyword docutils literal notranslate">except</code></a>/<a class="reference internal" href="../reference/compound_stmts.html#finally"><code class="xref std std-keyword docutils literal notranslate">finally</code></a> statements, but not
all APIs are well designed in that regard. When a context manager is the
only resource management API provided, then <a class="reference internal" href="#contextlib.ExitStack" title="contextlib.ExitStack"><code class="xref py py-class docutils literal notranslate">ExitStack</code></a> can make it
easier to handle various situations that can’t be handled directly in a
<a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate">with</code></a> statement.
</section>
<section id="cleaning-up-in-an-enter-implementation">
<h3>Cleaning up in an <code class="docutils literal notranslate">__enter__</code> implementation<a class="headerlink" href="#cleaning-up-in-an-enter-implementation" title="Permalink to this headline">¶</a></h3>
As noted in the documentation of <a class="reference internal" href="#contextlib.ExitStack.push" title="contextlib.ExitStack.push"><code class="xref py py-meth docutils literal notranslate">ExitStack.push()</code></a>, this
method can be useful in cleaning up an already allocated resource if later
steps in the <code class="xref py py-meth docutils literal notranslate">__enter__()</code> 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:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>from contextlib import contextmanager, AbstractContextManager, ExitStack

class ResourceManager(AbstractContextManager):

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&#39;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 = &quot;Failed validation for {!r}&quot;
 raise RuntimeError(msg.format(resource))
 return resource

def __exit__(self, *exc_details):
 # We don&#39;t need to duplicate any of our resource release logic
 self.release_resource()
</pre></div>
</div>
</section>
<section id="replacing-any-use-of-try-finally-and-flag-variables">
<h3>Replacing any use of <code class="docutils literal notranslate">try-finally</code> and flag variables<a class="headerlink" href="#replacing-any-use-of-try-finally-and-flag-variables" title="Permalink to this headline">¶</a></h3>
A pattern you will sometimes see is a <code class="docutils literal notranslate">try-finally</code> statement with a flag
variable to indicate whether or not the body of the <code class="docutils literal notranslate">finally</code> clause should
be executed. In its simplest form (that can’t already be handled just by
using an <code class="docutils literal notranslate">except</code> clause instead), it looks something like this:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>cleanup_needed = True
try:
 result = perform_operation()
 if result:
 cleanup_needed = False
finally:
 if cleanup_needed:
 cleanup_resources()
</pre></div>
</div>
As with any <code class="docutils literal notranslate">try</code> 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.
<a class="reference internal" href="#contextlib.ExitStack" title="contextlib.ExitStack"><code class="xref py py-class docutils literal notranslate">ExitStack</code></a> makes it possible to instead register a callback for
execution at the end of a <code class="docutils literal notranslate">with</code> statement, and then later decide to skip
executing that callback:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>from contextlib import ExitStack

class Callback(ExitStack):
 def __init__(self, callback, /, *args, **kwds):
 super().__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()
</pre></div>
</div>
If the resource cleanup isn’t already neatly bundled into a standalone
function, then it is still possible to use the decorator form of
<a class="reference internal" href="#contextlib.ExitStack.callback" title="contextlib.ExitStack.callback"><code class="xref py py-meth docutils literal notranslate">ExitStack.callback()</code></a> to declare the resource cleanup in
advance:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>from contextlib import ExitStack

with ExitStack() as stack:
 @stack.callback
 def cleanup_resources():
 ...
 result = perform_operation()
 if result:
 stack.pop_all()
</pre></div>
</div>
Due to the way the decorator protocol works, a callback function
declared this way cannot take any parameters. Instead, any resources to
be released must be accessed as closure variables.
</section>
<section id="using-a-context-manager-as-a-function-decorator">
<h3>Using a context manager as a function decorator<a class="headerlink" href="#using-a-context-manager-as-a-function-decorator" title="Permalink to this headline">¶</a></h3>
<a class="reference internal" href="#contextlib.ContextDecorator" title="contextlib.ContextDecorator"><code class="xref py py-class docutils literal notranslate">ContextDecorator</code></a> makes it possible to use a context manager in
both an ordinary <code class="docutils literal notranslate">with</code> 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 <a class="reference internal" href="#contextlib.ContextDecorator" title="contextlib.ContextDecorator"><code class="xref py py-class docutils literal notranslate">ContextDecorator</code></a> provides both capabilities in a
single definition:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>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):
 logging.info(&#39;Entering: %s&#39;, self.name)

def __exit__(self, exc_type, exc, exc_tb):
 logging.info(&#39;Exiting: %s&#39;, self.name)
</pre></div>
</div>
Instances of this class can be used as both a context manager:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>with track_entry_and_exit(&#39;widget loader&#39;):
 print(&#39;Some time consuming activity goes here&#39;)
 load_widget()
</pre></div>
</div>
And also as a function decorator:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>@track_entry_and_exit(&#39;widget loader&#39;)
def activity():
 print(&#39;Some time consuming activity goes here&#39;)
 load_widget()
</pre></div>
</div>
Note that there is one additional limitation when using context managers
as function decorators: there’s no way to access the return value of
<code class="xref py py-meth docutils literal notranslate">__enter__()</code>. If that value is needed, then it is still necessary to use
an explicit <code class="docutils literal notranslate">with</code> statement.
<div class="admonition seealso">
See also
<dl class="simple">
<dt><a class="pep reference external" href="https://www.python.org/dev/peps/pep-0343">PEP 343</a> - The “with” statement</dt><dd>The specification, background, and examples for the Python <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate">with</code></a>
statement.
</dd>
</dl>
</div>
</section>
</section>
<section id="single-use-reusable-and-reentrant-context-managers">
<h2>Single use, reusable and reentrant context managers<a class="headerlink" href="#single-use-reusable-and-reentrant-context-managers" title="Permalink to this headline">¶</a></h2>
Most context managers are written in a way that means they can only be
used effectively in a <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate">with</code></a> 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 <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate">with</code></a> 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 <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate">with</code></a> statement will close the file, preventing any
further IO operations using that file object.
Context managers created using <a class="reference internal" href="#contextlib.contextmanager" title="contextlib.contextmanager"><code class="xref py py-func docutils literal notranslate">contextmanager()</code></a> 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:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; from contextlib import contextmanager
&gt;&gt;&gt; @contextmanager
... def singleuse():
... print(&quot;Before&quot;)
... yield
... print(&quot;After&quot;)
...
&gt;&gt;&gt; cm = singleuse()
&gt;&gt;&gt; with cm:
... pass
...
Before
After
&gt;&gt;&gt; with cm:
... pass
...
Traceback (most recent call last):
 ...
RuntimeError: generator didn&#39;t yield
</pre></div>
</div>
<section id="reentrant-context-managers">
<h3>Reentrant context managers<a class="headerlink" href="#reentrant-context-managers" title="Permalink to this headline">¶</a></h3>
More sophisticated context managers may be “reentrant”. These context
managers can not only be used in multiple <a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate">with</code></a> statements,
but may also be used inside a <code class="xref std std-keyword docutils literal notranslate">with</code> statement that is already
using the same context manager.
<a class="reference internal" href="threading.html#threading.RLock" title="threading.RLock"><code class="xref py py-class docutils literal notranslate">threading.RLock</code></a> is an example of a reentrant context manager, as are
<a class="reference internal" href="#contextlib.suppress" title="contextlib.suppress"><code class="xref py py-func docutils literal notranslate">suppress()</code></a> and <a class="reference internal" href="#contextlib.redirect_stdout" title="contextlib.redirect_stdout"><code class="xref py py-func docutils literal notranslate">redirect_stdout()</code></a>. Here’s a very simple example of
reentrant use:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; from contextlib import redirect_stdout
&gt;&gt;&gt; from io import StringIO
&gt;&gt;&gt; stream = StringIO()
&gt;&gt;&gt; write_to_stream = redirect_stdout(stream)
&gt;&gt;&gt; with write_to_stream:
... print(&quot;This is written to the stream rather than stdout&quot;)
... with write_to_stream:
... print(&quot;This is also written to the stream&quot;)
...
&gt;&gt;&gt; print(&quot;This is written directly to stdout&quot;)
This is written directly to stdout
&gt;&gt;&gt; print(stream.getvalue())
This is written to the stream rather than stdout
This is also written to the stream
</pre></div>
</div>
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.
<a class="reference internal" href="#contextlib.redirect_stdout" title="contextlib.redirect_stdout"><code class="xref py py-func docutils literal notranslate">redirect_stdout()</code></a>, for example, is definitely not thread safe, as it
makes a global modification to the system state by binding <a class="reference internal" href="sys.html#sys.stdout" title="sys.stdout"><code class="xref py py-data docutils literal notranslate">sys.stdout</code></a>
to a different stream.
</section>
<section id="reusable-context-managers">
<h3>Reusable context managers<a class="headerlink" href="#reusable-context-managers" title="Permalink to this headline">¶</a></h3>
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.
<a class="reference internal" href="threading.html#threading.Lock" title="threading.Lock"><code class="xref py py-class docutils literal notranslate">threading.Lock</code></a> is an example of a reusable, but not reentrant,
context manager (for a reentrant lock, it is necessary to use
<a class="reference internal" href="threading.html#threading.RLock" title="threading.RLock"><code class="xref py py-class docutils literal notranslate">threading.RLock</code></a> instead).
Another example of a reusable, but not reentrant, context manager is
<a class="reference internal" href="#contextlib.ExitStack" title="contextlib.ExitStack"><code class="xref py py-class docutils literal notranslate">ExitStack</code></a>, as it invokes all currently registered callbacks
when leaving any with statement, regardless of where those callbacks
were added:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; from contextlib import ExitStack
&gt;&gt;&gt; stack = ExitStack()
&gt;&gt;&gt; with stack:
... stack.callback(print, &quot;Callback: from first context&quot;)
... print(&quot;Leaving first context&quot;)
...
Leaving first context
Callback: from first context
&gt;&gt;&gt; with stack:
... stack.callback(print, &quot;Callback: from second context&quot;)
... print(&quot;Leaving second context&quot;)
...
Leaving second context
Callback: from second context
&gt;&gt;&gt; with stack:
... stack.callback(print, &quot;Callback: from outer context&quot;)
... with stack:
... stack.callback(print, &quot;Callback: from inner context&quot;)
... print(&quot;Leaving inner context&quot;)
... print(&quot;Leaving outer context&quot;)
...
Leaving inner context
Callback: from inner context
Callback: from outer context
Leaving outer context
</pre></div>
</div>
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 <a class="reference internal" href="#contextlib.ExitStack" title="contextlib.ExitStack"><code class="xref py py-class docutils literal notranslate">ExitStack</code></a> instances instead of reusing a single
instance avoids that problem:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; from contextlib import ExitStack
&gt;&gt;&gt; with ExitStack() as outer_stack:
... outer_stack.callback(print, &quot;Callback: from outer context&quot;)
... with ExitStack() as inner_stack:
... inner_stack.callback(print, &quot;Callback: from inner context&quot;)
... print(&quot;Leaving inner context&quot;)
... print(&quot;Leaving outer context&quot;)
...
Leaving inner context
Callback: from inner context
Leaving outer context
Callback: from outer context
</pre></div>
</div>
</section>
</section>
</section>

<div class="clearer"></div>
 </div>
 </div>
 </div>
 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 <div class="sphinxsidebarwrapper">
 <h3><a href="../contents.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate">contextlib</code> — Utilities for <code class="xref std std-keyword docutils literal notranslate">with</code>-statement contexts</a><ul>
<li><a class="reference internal" href="#utilities">Utilities</a></li>
<li><a class="reference internal" href="#examples-and-recipes">Examples and Recipes</a><ul>
<li><a class="reference internal" href="#supporting-a-variable-number-of-context-managers">Supporting a variable number of context managers</a></li>
<li><a class="reference internal" href="#catching-exceptions-from-enter-methods">Catching exceptions from <code class="docutils literal notranslate">__enter__</code> methods</a></li>
<li><a class="reference internal" href="#cleaning-up-in-an-enter-implementation">Cleaning up in an <code class="docutils literal notranslate">__enter__</code> implementation</a></li>
<li><a class="reference internal" href="#replacing-any-use-of-try-finally-and-flag-variables">Replacing any use of <code class="docutils literal notranslate">try-finally</code> and flag variables</a></li>
<li><a class="reference internal" href="#using-a-context-manager-as-a-function-decorator">Using a context manager as a function decorator</a></li>
</ul>
</li>
<li><a class="reference internal" href="#single-use-reusable-and-reentrant-context-managers">Single use, reusable and reentrant context managers</a><ul>
<li><a class="reference internal" href="#reentrant-context-managers">Reentrant context managers</a></li>
<li><a class="reference internal" href="#reusable-context-managers">Reusable context managers</a></li>
</ul>
</li>
</ul>
</li>
</ul>

<h4>Previous topic</h4>
 <a href="dataclasses.html"
 title="previous chapter"><code class="xref py py-mod docutils literal notranslate">dataclasses</code> — Data Classes</a>
 <h4>Next topic</h4>
 <a href="abc.html"
 title="next chapter"><code class="xref py py-mod docutils literal notranslate">abc</code> — Abstract Base Classes</a>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../bugs.html">Report a Bug</a></li>
 <li>
 <a href="https://github.com/python/cpython/blob/3.10/Doc/library/contextlib.rst"
 rel="nofollow">Show Source
 </a>
 </li>
 </ul>
 </div>
 </div>
 </div>
 <div class="clearer"></div>
 </div> 
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 >index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="abc.html" title="abc — Abstract Base Classes"
 >next</a> |</li>
 <li class="right" >
 <a href="dataclasses.html" title="dataclasses — Data Classes"
 >previous</a> |</li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="python.html" >Python Runtime Services</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate">contextlib</code> — Utilities for <code class="xref std std-keyword docutils literal notranslate">with</code>-statement contexts</a></li>
 <li class="right">

<div class="inline-search" role="search">
 <form class="inline-search" action="../search.html" method="get">
 <input placeholder="Quick search" aria-label="Quick search" type="text" name="q" />
 <input type="submit" value="Go" />
 <input type="hidden" name="check_keywords" value="yes" />
 <input type="hidden" name="area" value="default" />
 </form>
 </div>
 |
 </li>
 
 </ul>
 </div> 
 <div class="footer">
 &copy; <a href="../copyright.html">Copyright</a> 2001-2026, Python Software Foundation.
 
 This page is licensed under the Python Software Foundation License Version 2.
 
 Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.
 
 See <a href="/license.html">History and License</a> for more information.

The Python Software Foundation is a non-profit corporation.
<a href="https://www.python.org/psf/donations/">Please donate.</a>

Last updated on January 26, 2026.
 <a href="/bugs.html">Found a bug</a>?

Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.2.
 </div>

</body>
</html>

${this.title}

Code Editor : contextlib.html