Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

[doc] Improve punctuation atexit doc

This commit is contained in:
Géry Ogam 2021-06-22 18:49:12 +02:00 committed by GitHub
parent 35ad425866
commit a6b47de07a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
Doc/library/atexit.rst
View File

@ -39,7 +39,7 @@ internal error is detected, or when :func:`os._exit` is called.
If an exception is raised during execution of the exit handlers, a traceback is If an exception is raised during execution of the exit handlers, a traceback is
printed (unless :exc:`SystemExit` is raised) and the exception information is printed (unless :exc:`SystemExit` is raised) and the exception information is
saved. After all exit handlers have had a chance to run the last exception to saved. After all exit handlers have had a chance to run, the last exception to
be raised is re-raised. be raised is re-raised.
This function returns *func*, which makes it possible to use it as a This function returns *func*, which makes it possible to use it as a
@ -73,7 +73,7 @@ automatically when the program terminates without relying on the application
making an explicit call into this module at termination. :: making an explicit call into this module at termination. ::
try: try:
with open("counterfile") as infile: with open('counterfile') as infile:
_count = int(infile.read()) _count = int(infile.read())
except FileNotFoundError: except FileNotFoundError:
_count = 0 _count = 0
@ -83,21 +83,22 @@ making an explicit call into this module at termination. ::
_count = _count + n _count = _count + n
def savecounter(): def savecounter():
with open("counterfile", "w") as outfile: with open('counterfile', 'w') as outfile:
outfile.write("%d" % _count) outfile.write('%d' % _count)
import atexit import atexit
atexit.register(savecounter) atexit.register(savecounter)
Positional and keyword arguments may also be passed to :func:`register` to be Positional and keyword arguments may also be passed to :func:`register` to be
passed along to the registered function when it is called:: passed along to the registered function when it is called::
def goodbye(name, adjective): def goodbye(name, adjective):
print('Goodbye, %s, it was %s to meet you.' % (name, adjective)) print('Goodbye %s, it was %s to meet you.' % (name, adjective))
import atexit import atexit
atexit.register(goodbye, 'Donny', 'nice')
atexit.register(goodbye, 'Donny', 'nice')
# or: # or:
atexit.register(goodbye, adjective='nice', name='Donny') atexit.register(goodbye, adjective='nice', name='Donny')
@ -107,6 +108,6 @@ Usage as a :term:`decorator`::
@atexit.register @atexit.register
def goodbye(): def goodbye():
print("You are now leaving the Python sector.") print('You are now leaving the Python sector.')
This only works with functions that can be called without arguments. This only works with functions that can be called without arguments.