Formatting fixes in contextlib docs (#98111)

This commit is contained in:
Stanley 2022-10-11 20:56:32 -07:00 committed by GitHub
parent e3bf125c81
commit 3b33c2010a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 11 deletions

View File

@ -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')