[Python-checkins] Formatting fixes in contextlib docs (GH-98111)
miss-islington
webhook-mailer at python.org
Wed Oct 12 00:05:18 EDT 2022
https://github.com/python/cpython/commit/59ddbc4ab6fbdc646d0f23c2f3a80fd2e71df0d8
commit: 59ddbc4ab6fbdc646d0f23c2f3a80fd2e71df0d8
branch: 3.11
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: miss-islington <31488909+miss-islington at users.noreply.github.com>
date: 2022-10-11T21:05:12-07:00
summary:
Formatting fixes in contextlib docs (GH-98111)
(cherry picked from commit 3b33c2010aa00ef5877bc35b02ae658e3c9f27af)
Co-authored-by: Stanley <46876382+slateny at users.noreply.github.com>
files:
M Doc/library/contextlib.rst
diff --git a/Doc/library/contextlib.rst b/Doc/library/contextlib.rst
index 2d28fb35a9e3..1b55868c3aa6 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')
More information about the Python-checkins
mailing list