diff options
author | Steve Dower <steve.dower@python.org> | 2019-06-27 17:47:59 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-06-27 17:47:59 (GMT) |
commit | 44f91c388a6f4da9ed3300df32ca290b8aa104ea (patch) | |
tree | 6e02d501dbcb28708fa662a33da2715a505389e5 /Doc/library/functions.rst | |
parent | 21cfae107e410bf4b0ab3c142ca4449bc33290f5 (diff) | |
download | cpython-44f91c388a6f4da9ed3300df32ca290b8aa104ea.zip cpython-44f91c388a6f4da9ed3300df32ca290b8aa104ea.tar.gz cpython-44f91c388a6f4da9ed3300df32ca290b8aa104ea.tar.bz2 |
bpo-37390: Add audit event table to documentations (GH-14406)
Also updates some (unreleased) event names to be consistent with the others.
Diffstat (limited to 'Doc/library/functions.rst')
-rw-r--r-- | Doc/library/functions.rst | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst index 637c82b..e146f5a 100644 --- a/Doc/library/functions.rst +++ b/Doc/library/functions.rst @@ -128,7 +128,7 @@ are always available. They are listed here in alphabetical order. :func:`breakpoint` will automatically call that, allowing you to drop into the debugger of choice. - .. audit-event:: builtins.breakpoint "sys.breakpointhook" + .. audit-event:: builtins.breakpoint breakpointhook breakpoint .. versionadded:: 3.7 @@ -277,7 +277,7 @@ are always available. They are listed here in alphabetical order. If you want to parse Python code into its AST representation, see :func:`ast.parse`. - .. audit-event:: compile "source filename" + .. audit-event:: compile source,filename compile Raises an :ref:`auditing event <auditing>` ``compile`` with arguments ``source`` and ``filename``. This event may also be raised by implicit @@ -490,7 +490,7 @@ are always available. They are listed here in alphabetical order. See :func:`ast.literal_eval` for a function that can safely evaluate strings with expressions containing only literals. - .. audit-event:: exec code_object + .. audit-event:: exec code_object eval Raises an :ref:`auditing event <auditing>` ``exec`` with the code object as the argument. Code compilation events may also be raised. @@ -525,7 +525,7 @@ are always available. They are listed here in alphabetical order. builtins are available to the executed code by inserting your own ``__builtins__`` dictionary into *globals* before passing it to :func:`exec`. - .. audit-event:: exec code_object + .. audit-event:: exec code_object exec Raises an :ref:`auditing event <auditing>` ``exec`` with the code object as the argument. Code compilation events may also be raised. @@ -779,12 +779,12 @@ are always available. They are listed here in alphabetical order. If the :mod:`readline` module was loaded, then :func:`input` will use it to provide elaborate line editing and history features. - .. audit-event:: builtins.input prompt + .. audit-event:: builtins.input prompt input Raises an :ref:`auditing event <auditing>` ``builtins.input`` with argument ``prompt`` before reading input - .. audit-event:: builtins.input/result result + .. audit-event:: builtins.input/result result input Raises an auditing event ``builtins.input/result`` with the result after successfully reading input. @@ -1222,7 +1222,7 @@ are always available. They are listed here in alphabetical order. (where :func:`open` is declared), :mod:`os`, :mod:`os.path`, :mod:`tempfile`, and :mod:`shutil`. - .. audit-event:: open "file mode flags" + .. audit-event:: open file,mode,flags open The ``mode`` and ``flags`` arguments may have been modified or inferred from the original call. |