Skip to content

[3.10] [doc] Improve punctuation atexit doc (GH-25629) #26856

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
iritkatriel merged 1 commit into from
Jun 22, 2021
Merged

[3.10] [doc] Improve punctuation atexit doc (GH-25629) #26856

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions Doc/library/atexit.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
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.

This function returns *func*, which makes it possible to use it as a
Expand Down Expand Up @@ -73,7 +73,7 @@ automatically when the program terminates without relying on the application
making an explicit call into this module at termination. ::

try:
with open("counterfile") as infile:
with open('counterfile') as infile:
_count = int(infile.read())
except FileNotFoundError:
_count = 0
Expand All @@ -83,21 +83,22 @@ making an explicit call into this module at termination. ::
_count = _count + n

def savecounter():
with open("counterfile", "w") as outfile:
outfile.write("%d" % _count)
with open('counterfile', 'w') as outfile:
outfile.write('%d' % _count)

import atexit

atexit.register(savecounter)

Positional and keyword arguments may also be passed to :func:`register` to be
passed along to the registered function when it is called::

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
atexit.register(goodbye, 'Donny', 'nice')

atexit.register(goodbye, 'Donny', 'nice')
# or:
atexit.register(goodbye, adjective='nice', name='Donny')

Expand All @@ -107,6 +108,6 @@ Usage as a :term:`decorator`::

@atexit.register
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.