summaryrefslogtreecommitdiffstats
path: root/Doc/library/contextlib.rst
diff options
context:
space:
mode:
authorStanley <46876382+slateny@users.noreply.github.com>2022-10-12 03:56:32 (GMT)
committerGitHub <noreply@github.com>2022-10-12 03:56:32 (GMT)
commit3b33c2010aa00ef5877bc35b02ae658e3c9f27af (patch)
treeca4859eefd082f6690e97317d51b9714592120ea /Doc/library/contextlib.rst
parente3bf125c81d5da0734429c1cb6ae75e6086e35ae (diff)
downloadcpython-3b33c2010aa00ef5877bc35b02ae658e3c9f27af.zip
cpython-3b33c2010aa00ef5877bc35b02ae658e3c9f27af.tar.gz
cpython-3b33c2010aa00ef5877bc35b02ae658e3c9f27af.tar.bz2
Formatting fixes in contextlib docs (#98111)
Diffstat (limited to 'Doc/library/contextlib.rst')
-rw-r--r--Doc/library/contextlib.rst28
1 files changed, 17 insertions, 11 deletions
diff --git a/Doc/library/contextlib.rst b/Doc/library/contextlib.rst
index 2d28fb3..1b55868 100644
--- a/Doc/library/contextlib.rst
+++ b/Doc/library/contextlib.rst
@@ -66,6 +66,8 @@ Functions and classes provided:
# Code to release resource, e.g.:
release_resource(resource)
+ The function can then be used like this::
+
>>> 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
@@ -140,9 +142,9 @@ Functions and classes provided:
finally:
print(f'it took {time.monotonic() - now}s to run')
- @timeit()
- async def main():
- # ... async code ...
+ @timeit()
+ async def main():
+ # ... async code ...
When used as a decorator, a new generator instance is implicitly created on
each function call. This allows the otherwise "one-shot" context managers
@@ -249,15 +251,15 @@ Functions and classes provided:
:ref:`asynchronous context managers <async-context-managers>`::
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)
+ 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
+ async with cm as session:
+ # Send http requests with session
.. versionadded:: 3.7
@@ -396,6 +398,8 @@ Functions and classes provided:
print('Finishing')
return False
+ The class can then be used like this::
+
>>> @mycontext()
... def function():
... print('The bit in the middle')
@@ -466,6 +470,8 @@ Functions and classes provided:
print('Finishing')
return False
+ The class can then be used like this::
+
>>> @mycontext()
... async def function():
... print('The bit in the middle')