summaryrefslogtreecommitdiffstats
path: root/Doc/library
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2019-06-27 18:07:16 (GMT)
committerGitHub <noreply@github.com>2019-06-27 18:07:16 (GMT)
commit4fee28aa42dbac7f08a6d2829546b7d8e848034d (patch)
tree119433f608f787c9e34aa68abd4277ec3e108e13 /Doc/library
parent60f24b23bf6ac485d195bb904635bdc3fe646b07 (diff)
downloadcpython-4fee28aa42dbac7f08a6d2829546b7d8e848034d.zip
cpython-4fee28aa42dbac7f08a6d2829546b7d8e848034d.tar.gz
cpython-4fee28aa42dbac7f08a6d2829546b7d8e848034d.tar.bz2
bpo-37390: Add audit event table to documentations (GH-14406)
Also updates some (unreleased) event names to be consistent with the others. (cherry picked from commit 44f91c388a6f4da9ed3300df32ca290b8aa104ea) Co-authored-by: Steve Dower <steve.dower@python.org>
Diffstat (limited to 'Doc/library')
-rw-r--r--Doc/library/array.rst2
-rw-r--r--Doc/library/audit_events.rst21
-rw-r--r--Doc/library/ctypes.rst6
-rw-r--r--Doc/library/debug.rst5
-rw-r--r--Doc/library/ensurepip.rst2
-rw-r--r--Doc/library/ftplib.rst6
-rw-r--r--Doc/library/functions.rst14
-rw-r--r--Doc/library/glob.rst4
-rw-r--r--Doc/library/imaplib.rst4
-rw-r--r--Doc/library/io.rst2
-rw-r--r--Doc/library/mmap.rst4
-rw-r--r--Doc/library/nntplib.rst20
-rw-r--r--Doc/library/os.rst12
-rw-r--r--Doc/library/pdb.rst2
-rw-r--r--Doc/library/pickle.rst2
-rw-r--r--Doc/library/poplib.rst20
-rw-r--r--Doc/library/shutil.rst6
-rw-r--r--Doc/library/smtplib.rst10
-rw-r--r--Doc/library/socket.rst30
-rw-r--r--Doc/library/sqlite3.rst2
-rw-r--r--Doc/library/subprocess.rst2
-rw-r--r--Doc/library/sys.rst15
-rw-r--r--Doc/library/telnetlib.rst4
-rw-r--r--Doc/library/tempfile.rst10
-rw-r--r--Doc/library/urllib.request.rst2
-rw-r--r--Doc/library/webbrowser.rst2
26 files changed, 123 insertions, 86 deletions
diff --git a/Doc/library/array.rst b/Doc/library/array.rst
index 1f95dd6..59b94f1 100644
--- a/Doc/library/array.rst
+++ b/Doc/library/array.rst
@@ -83,7 +83,7 @@ The module defines the following type:
to add initial items to the array. Otherwise, the iterable initializer is
passed to the :meth:`extend` method.
- .. audit-event:: array.__new__ "typecode initializer"
+ .. audit-event:: array.__new__ typecode,initializer array.array
.. data:: typecodes
diff --git a/Doc/library/audit_events.rst b/Doc/library/audit_events.rst
new file mode 100644
index 0000000..c23b9c6
--- /dev/null
+++ b/Doc/library/audit_events.rst
@@ -0,0 +1,21 @@
+.. _audit-events:
+
+.. index:: single: audit events
+
+Audit events table
+==================
+
+This table contains all events raised by :func:`sys.audit` or
+:c:func:`PySys_Audit` calls throughout the CPython runtime and the
+standard library.
+
+See :func:`sys.addaudithook` and :c:func:`PySys_AddAuditHook` for
+information on handling these events.
+
+.. impl-detail::
+
+ This table is generated from the CPython documentation, and may not
+ represent events raised by other implementations. See your runtime
+ specific documentation for actual events raised.
+
+.. audit-event-table::
diff --git a/Doc/library/ctypes.rst b/Doc/library/ctypes.rst
index c1218ad..2c57cc7 100644
--- a/Doc/library/ctypes.rst
+++ b/Doc/library/ctypes.rst
@@ -1509,13 +1509,13 @@ object is available:
:c:type:`int`, which is of course not always the truth, so you have to assign
the correct :attr:`restype` attribute to use these functions.
-.. audit-event:: ctypes.dlopen name
+.. audit-event:: ctypes.dlopen name ctypes.LibraryLoader
Loading a library through any of these objects raises an
:ref:`auditing event <auditing>` ``ctypes.dlopen`` with string argument
``name``, the name used to load the library.
-.. audit-event:: ctypes.dlsym "library name"
+.. audit-event:: ctypes.dlsym library,name ctypes.LibraryLoader
Accessing a function on a loaded library raises an auditing event
``ctypes.dlsym`` with arguments ``library`` (the library object) and ``name``
@@ -2043,7 +2043,7 @@ Data types
This method returns a ctypes type instance using the memory specified by
*address* which must be an integer.
- .. audit-event:: ctypes.cdata address
+ .. audit-event:: ctypes.cdata address ctypes._CData.from_address
This method, and others that indirectly call this method, raises an
:ref:`auditing event <auditing>` ``ctypes.cdata`` with argument
diff --git a/Doc/library/debug.rst b/Doc/library/debug.rst
index 88a2fa6..6022365 100644
--- a/Doc/library/debug.rst
+++ b/Doc/library/debug.rst
@@ -5,10 +5,13 @@ Debugging and Profiling
These libraries help you with Python development: the debugger enables you to
step through code, analyze stack frames and set breakpoints etc., and the
profilers run code and give you a detailed breakdown of execution times,
-allowing you to identify bottlenecks in your programs.
+allowing you to identify bottlenecks in your programs. Auditing events
+provide visibility into runtime behaviors that would otherwise require
+intrusive debugging or patching.
.. toctree::
+ audit_events.rst
bdb.rst
faulthandler.rst
pdb.rst
diff --git a/Doc/library/ensurepip.rst b/Doc/library/ensurepip.rst
index 3b6b01f..a2bb045 100644
--- a/Doc/library/ensurepip.rst
+++ b/Doc/library/ensurepip.rst
@@ -119,7 +119,7 @@ Module API
*verbosity* controls the level of output to :data:`sys.stdout` from the
bootstrapping operation.
- .. audit-event:: ensurepip.bootstrap root
+ .. audit-event:: ensurepip.bootstrap root ensurepip.bootstrap
.. note::
diff --git a/Doc/library/ftplib.rst b/Doc/library/ftplib.rst
index 36abfbd..e006d01 100644
--- a/Doc/library/ftplib.rst
+++ b/Doc/library/ftplib.rst
@@ -190,7 +190,7 @@ followed by ``lines`` for the text version or ``binary`` for the binary version.
*source_address* is a 2-tuple ``(host, port)`` for the socket to bind to as
its source address before connecting.
- .. audit-event:: ftplib.FTP.connect "self host port"
+ .. audit-event:: ftplib.connect self,host,port ftplib.FTP.connect
.. versionchanged:: 3.3
*source_address* parameter was added.
@@ -225,7 +225,7 @@ followed by ``lines`` for the text version or ``binary`` for the binary version.
Send a simple command string to the server and return the response string.
- .. audit-event:: ftplib.FTP.sendcmd "self cmd"
+ .. audit-event:: ftplib.sendcmd self,cmd ftplib.FTP.sendcmd
.. method:: FTP.voidcmd(cmd)
@@ -234,7 +234,7 @@ followed by ``lines`` for the text version or ``binary`` for the binary version.
nothing if a response code corresponding to success (codes in the range
200--299) is received. Raise :exc:`error_reply` otherwise.
- .. audit-event:: ftplib.FTP.sendcmd "self cmd"
+ .. audit-event:: ftplib.sendcmd self,cmd ftplib.FTP.voidcmd
.. method:: FTP.retrbinary(cmd, callback, blocksize=8192, rest=None)
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.
diff --git a/Doc/library/glob.rst b/Doc/library/glob.rst
index 1f29fc5..9658443 100644
--- a/Doc/library/glob.rst
+++ b/Doc/library/glob.rst
@@ -52,7 +52,7 @@ For example, ``'[?]'`` matches the character ``'?'``.
more directories and subdirectories. If the pattern is followed by an
``os.sep``, only directories and subdirectories match.
- .. audit-event:: glob.glob "pathname recursive"
+ .. audit-event:: glob.glob pathname,recursive glob.glob
.. note::
Using the "``**``" pattern in large directory trees may consume
@@ -67,7 +67,7 @@ For example, ``'[?]'`` matches the character ``'?'``.
Return an :term:`iterator` which yields the same values as :func:`glob`
without actually storing them all simultaneously.
- .. audit-event:: glob.glob "pathname recursive"
+ .. audit-event:: glob.glob pathname,recursive glob.iglob
.. function:: escape(pathname)
diff --git a/Doc/library/imaplib.rst b/Doc/library/imaplib.rst
index c08c0a5..df63d82 100644
--- a/Doc/library/imaplib.rst
+++ b/Doc/library/imaplib.rst
@@ -361,7 +361,7 @@ An :class:`IMAP4` instance has the following methods:
:meth:`IMAP4.send`, and :meth:`IMAP4.shutdown` methods. You may override
this method.
- .. audit-event:: imaplib.IMAP4.open "self host port"
+ .. audit-event:: imaplib.open self,host,port imaplib.IMAP4.open
.. method:: IMAP4.partial(message_num, message_part, start, length)
@@ -432,7 +432,7 @@ An :class:`IMAP4` instance has the following methods:
Sends ``data`` to the remote server. You may override this method.
- .. audit-event:: imaplib.IMAP4.send "self data"
+ .. audit-event:: imaplib.send self,data imaplib.IMAP4.send
.. method:: IMAP4.setacl(mailbox, who, what)
diff --git a/Doc/library/io.rst b/Doc/library/io.rst
index 28c5da9..fce9a74 100644
--- a/Doc/library/io.rst
+++ b/Doc/library/io.rst
@@ -120,7 +120,7 @@ High-level Module Interface
This is an alias for the builtin :func:`open` function.
- .. audit-event:: open "path mode flags"
+ .. audit-event:: open path,mode,flags io.open
This function raises an :ref:`auditing event <auditing>` ``open`` with
arguments ``path``, ``mode`` and ``flags``. The ``mode`` and ``flags``
diff --git a/Doc/library/mmap.rst b/Doc/library/mmap.rst
index c7a13ab..12b14d6 100644
--- a/Doc/library/mmap.rst
+++ b/Doc/library/mmap.rst
@@ -67,7 +67,7 @@ To map anonymous memory, -1 should be passed as the fileno along with the length
will be relative to the offset from the beginning of the file. *offset*
defaults to 0. *offset* must be a multiple of the :const:`ALLOCATIONGRANULARITY`.
- .. audit-event:: mmap.__new__ "fileno length access offset"
+ .. audit-event:: mmap.__new__ fileno,length,access,offset mmap.mmap
.. class:: mmap(fileno, length, flags=MAP_SHARED, prot=PROT_WRITE|PROT_READ, access=ACCESS_DEFAULT[, offset])
:noindex:
@@ -156,7 +156,7 @@ To map anonymous memory, -1 should be passed as the fileno along with the length
mm.close()
- .. audit-event:: mmap.__new__ "fileno length access offset"
+ .. audit-event:: mmap.__new__ fileno,length,access,offset mmap.mmap
Memory-mapped file objects support the following methods:
diff --git a/Doc/library/nntplib.rst b/Doc/library/nntplib.rst
index 297bbed..46f1c07 100644
--- a/Doc/library/nntplib.rst
+++ b/Doc/library/nntplib.rst
@@ -79,11 +79,13 @@ The module itself defines the following classes:
('211 1755 1 1755 gmane.comp.python.committers', 1755, 1, 1755, 'gmane.comp.python.committers')
>>>
- .. audit-event:: nntplib.NNTP "self host port"
+ .. audit-event:: nntplib.connect self,host,port nntplib.NNTP
- All commands will raise an :ref:`auditing event <auditing>`
- ``nntplib.NNTP.putline`` with arguments ``self`` and ``line``,
- where ``line`` is the bytes about to be sent to the remote host.
+ .. audit-event:: nntplib.putline self,line nntplib.NNTP
+
+ All commands will raise an :ref:`auditing event <auditing>`
+ ``nntplib.putline`` with arguments ``self`` and ``line``,
+ where ``line`` is the bytes about to be sent to the remote host.
.. versionchanged:: 3.2
*usenetrc* is now ``False`` by default.
@@ -105,11 +107,13 @@ The module itself defines the following classes:
STARTTLS as described below. However, some servers only support the
former.
- .. audit-event:: nntplib.NNTP "self host port"
+ .. audit-event:: nntplib.connect self,host,port nntplib.NNTP_SSL
+
+ .. audit-event:: nntplib.putline self,line nntplib.NNTP_SSL
- All commands will raise an :ref:`auditing event <auditing>`
- ``nntplib.NNTP.putline`` with arguments ``self`` and ``line``,
- where ``line`` is the bytes about to be sent to the remote host.
+ All commands will raise an :ref:`auditing event <auditing>`
+ ``nntplib.putline`` with arguments ``self`` and ``line``,
+ where ``line`` is the bytes about to be sent to the remote host.
.. versionadded:: 3.2
diff --git a/Doc/library/os.rst b/Doc/library/os.rst
index 45ce643..ee3c35c 100644
--- a/Doc/library/os.rst
+++ b/Doc/library/os.rst
@@ -851,7 +851,7 @@ as internal buffering of data.
most *length* bytes in size. As of Python 3.3, this is equivalent to
``os.truncate(fd, length)``.
- .. audit-event:: os.truncate "fd length"
+ .. audit-event:: os.truncate fd,length os.ftruncate
.. availability:: Unix, Windows.
@@ -938,7 +938,7 @@ as internal buffering of data.
This function can support :ref:`paths relative to directory descriptors
<dir_fd>` with the *dir_fd* parameter.
- .. audit-event:: open "path mode flags"
+ .. audit-event:: open path,mode,flags os.open
.. versionchanged:: 3.4
The new file descriptor is now non-inheritable.
@@ -1806,7 +1806,7 @@ features:
This function can also support :ref:`specifying a file descriptor
<path_fd>`; the file descriptor must refer to a directory.
- .. audit-event:: os.listdir path
+ .. audit-event:: os.listdir path os.listdir
.. note::
To encode ``str`` filenames to ``bytes``, use :func:`~os.fsencode`.
@@ -2185,7 +2185,7 @@ features:
This function can also support :ref:`specifying a file descriptor
<path_fd>`; the file descriptor must refer to a directory.
- .. audit-event:: os.scandir path
+ .. audit-event:: os.scandir path os.scandir
The :func:`scandir` iterator supports the :term:`context manager` protocol
and has the following method:
@@ -2793,7 +2793,7 @@ features:
This function can support :ref:`specifying a file descriptor <path_fd>`.
- .. audit-event:: os.truncate "path length"
+ .. audit-event:: os.truncate path,length os.truncate
.. availability:: Unix, Windows.
@@ -3799,7 +3799,7 @@ written in Python, such as a mail server's external command delivery program.
to using this function. See the :ref:`subprocess-replacements` section in
the :mod:`subprocess` documentation for some helpful recipes.
- .. audit-event:: os.system command
+ .. audit-event:: os.system command os.system
.. availability:: Unix, Windows.
diff --git a/Doc/library/pdb.rst b/Doc/library/pdb.rst
index 7ebad79..f26b6a8 100644
--- a/Doc/library/pdb.rst
+++ b/Doc/library/pdb.rst
@@ -181,7 +181,7 @@ access further features, you have to do this yourself:
import pdb; pdb.Pdb(skip=['django.*']).set_trace()
- .. audit-event:: pdb.Pdb
+ .. audit-event:: pdb.Pdb "" pdb.Pdb
.. versionadded:: 3.1
The *skip* argument.
diff --git a/Doc/library/pickle.rst b/Doc/library/pickle.rst
index 6aa3049..e6025ae 100644
--- a/Doc/library/pickle.rst
+++ b/Doc/library/pickle.rst
@@ -437,7 +437,7 @@ The :mod:`pickle` module exports three classes, :class:`Pickler`,
how they can be loaded, potentially reducing security risks. Refer to
:ref:`pickle-restrict` for details.
- .. audit-event:: pickle.find_class "module name"
+ .. audit-event:: pickle.find_class module,name pickle.Unpickler.find_class
.. class:: PickleBuffer(buffer)
diff --git a/Doc/library/poplib.rst b/Doc/library/poplib.rst
index d227b53..28b42fa 100644
--- a/Doc/library/poplib.rst
+++ b/Doc/library/poplib.rst
@@ -39,11 +39,13 @@ The :mod:`poplib` module provides two classes:
connection attempt (if not specified, the global default timeout setting will
be used).
- .. audit-event:: poplib.POP3 "self host port"
+ .. audit-event:: poplib.connect self,host,port poplib.POP3
- All commands will raise an :ref:`auditing event <auditing>`
- ``poplib.POP3.putline`` with arguments ``self`` and ``line``,
- where ``line`` is the bytes about to be sent to the remote host.
+ .. audit-event:: poplib.putline self,line poplib.POP3
+
+ All commands will raise an :ref:`auditing event <auditing>`
+ ``poplib.putline`` with arguments ``self`` and ``line``,
+ where ``line`` is the bytes about to be sent to the remote host.
.. class:: POP3_SSL(host, port=POP3_SSL_PORT, keyfile=None, certfile=None, timeout=None, context=None)
@@ -60,11 +62,13 @@ The :mod:`poplib` module provides two classes:
point to PEM-formatted private key and certificate chain files,
respectively, for the SSL connection.
- .. audit-event:: poplib.POP3 "self host port"
+ .. audit-event:: poplib.connect self,host,port poplib.POP3_SSL
+
+ .. audit-event:: poplib.putline self,line popplib.POP3_SSL
- All commands will raise an :ref:`auditing event <auditing>`
- ``poplib.POP3.putline`` with arguments ``self`` and ``line``,
- where ``line`` is the bytes about to be sent to the remote host.
+ All commands will raise an :ref:`auditing event <auditing>`
+ ``poplib.putline`` with arguments ``self`` and ``line``,
+ where ``line`` is the bytes about to be sent to the remote host.
.. versionchanged:: 3.2
*context* parameter added.
diff --git a/Doc/library/shutil.rst b/Doc/library/shutil.rst
index 3cca9c8..eaeee8d 100644
--- a/Doc/library/shutil.rst
+++ b/Doc/library/shutil.rst
@@ -249,7 +249,7 @@ Directory and files operations
  as arguments. By default, :func:`~shutil.copy2` is used, but any function
  that supports the same signature (like :func:`~shutil.copy`) can be used.
- .. audit-event:: shutil.copytree "src dst"
+ .. audit-event:: shutil.copytree src,dst shutil.copytree
.. versionchanged:: 3.3
Copy metadata when *symlinks* is false.
@@ -298,7 +298,7 @@ Directory and files operations
*excinfo*, will be the exception information returned by
:func:`sys.exc_info`. Exceptions raised by *onerror* will not be caught.
- .. audit-event:: shutil.rmtree path
+ .. audit-event:: shutil.rmtree path shutil.rmtree
.. versionchanged:: 3.3
Added a symlink attack resistant version that is used automatically
@@ -562,7 +562,7 @@ provided. They rely on the :mod:`zipfile` and :mod:`tarfile` modules.
The *verbose* argument is unused and deprecated.
- .. audit-event:: shutil.make_archive "base_name format root_dir base_dir"
+ .. audit-event:: shutil.make_archive base_name,format,root_dir,base_dir shutil.make_archive
.. versionchanged:: 3.8
The modern pax (POSIX.1-2001) format is now used instead of
diff --git a/Doc/library/smtplib.rst b/Doc/library/smtplib.rst
index 8771f10..6176c35 100644
--- a/Doc/library/smtplib.rst
+++ b/Doc/library/smtplib.rst
@@ -55,9 +55,11 @@ Protocol) and :rfc:`1869` (SMTP Service Extensions).
(250, b'Ok')
>>>
- All commands will raise an :ref:`auditing event <auditing>`
- ``smtplib.SMTP.send`` with arguments ``self`` and ``data``,
- where ``data`` is the bytes about to be sent to the remote host.
+ .. audit-event:: smtplib.send self,data smtplib.SMTP
+
+ All commands will raise an :ref:`auditing event <auditing>`
+ ``smtplib.SMTP.send`` with arguments ``self`` and ``data``,
+ where ``data`` is the bytes about to be sent to the remote host.
.. versionchanged:: 3.3
Support for the :keyword:`with` statement was added.
@@ -246,7 +248,7 @@ An :class:`SMTP` instance has the following methods:
2-tuple of the response code and message sent by the server in its
connection response.
- .. audit-event:: smtplib.SMTP.connect "self host port"
+ .. audit-event:: smtplib.connect self,host,port smtplib.SMTP.connect
.. method:: SMTP.helo(name='')
diff --git a/Doc/library/socket.rst b/Doc/library/socket.rst
index e0dbbb4..f1010fb 100644
--- a/Doc/library/socket.rst
+++ b/Doc/library/socket.rst
@@ -526,7 +526,7 @@ The following functions all create :ref:`socket objects <socket-objects>`.
The newly created socket is :ref:`non-inheritable <fd_inheritance>`.
- .. audit-event:: socket.__new__ "self family type protocol"
+ .. audit-event:: socket.__new__ self,family,type,protocol socket.socket
.. versionchanged:: 3.3
The AF_CAN family was added.
@@ -720,7 +720,7 @@ The :mod:`socket` module also offers various network-related services:
:const:`AF_INET6`), and is meant to be passed to the :meth:`socket.connect`
method.
- .. audit-event:: socket.getaddrinfo "host port family type protocol"
+ .. audit-event:: socket.getaddrinfo host,port,family,type,protocol socket.getaddrinfo
The following example fetches address information for a hypothetical TCP
connection to ``example.org`` on port 80 (results may differ on your
@@ -757,7 +757,7 @@ The :mod:`socket` module also offers various network-related services:
interface. :func:`gethostbyname` does not support IPv6 name resolution, and
:func:`getaddrinfo` should be used instead for IPv4/v6 dual stack support.
- .. audit-event:: socket.gethostbyname hostname
+ .. audit-event:: socket.gethostbyname hostname socket.gethostbyname
.. function:: gethostbyname_ex(hostname)
@@ -771,7 +771,7 @@ The :mod:`socket` module also offers various network-related services:
resolution, and :func:`getaddrinfo` should be used instead for IPv4/v6 dual
stack support.
- .. audit-event:: socket.gethostbyname hostname
+ .. audit-event:: socket.gethostbyname hostname socket.gethostbyname_ex
.. function:: gethostname()
@@ -779,7 +779,7 @@ The :mod:`socket` module also offers various network-related services:
Return a string containing the hostname of the machine where the Python
interpreter is currently executing.
- .. audit-event:: socket.gethostname
+ .. audit-event:: socket.gethostname "" socket.gethostname
Note: :func:`gethostname` doesn't always return the fully qualified domain
name; use :func:`getfqdn` for that.
@@ -795,7 +795,7 @@ The :mod:`socket` module also offers various network-related services:
domain name, use the function :func:`getfqdn`. :func:`gethostbyaddr` supports
both IPv4 and IPv6.
- .. audit-event:: socket.gethostbyaddr ip_address
+ .. audit-event:: socket.gethostbyaddr ip_address socket.gethostbyaddr
.. function:: getnameinfo(sockaddr, flags)
@@ -810,7 +810,7 @@ The :mod:`socket` module also offers various network-related services:
For more information about *flags* you can consult :manpage:`getnameinfo(3)`.
- .. audit-event:: socket.getnameinfo sockaddr
+ .. audit-event:: socket.getnameinfo sockaddr socket.getnameinfo
.. function:: getprotobyname(protocolname)
@@ -827,7 +827,7 @@ The :mod:`socket` module also offers various network-related services:
service. The optional protocol name, if given, should be ``'tcp'`` or
``'udp'``, otherwise any protocol will match.
- .. audit-event:: socket.getservbyname "servicename protocolname"
+ .. audit-event:: socket.getservbyname servicename,protocolname socket.getservbyname
.. function:: getservbyport(port[, protocolname])
@@ -836,7 +836,7 @@ The :mod:`socket` module also offers various network-related services:
service. The optional protocol name, if given, should be ``'tcp'`` or
``'udp'``, otherwise any protocol will match.
- .. audit-event:: socket.getservbyport "port protocolname"
+ .. audit-event:: socket.getservbyport port,protocolname socket.getservbyport
.. function:: ntohl(x)
@@ -1021,7 +1021,7 @@ The :mod:`socket` module also offers various network-related services:
Set the machine's hostname to *name*. This will raise an
:exc:`OSError` if you don't have enough rights.
- .. audit-event:: socket.sethostname name
+ .. audit-event:: socket.sethostname name socket.sethostname
.. availability:: Unix.
@@ -1107,7 +1107,7 @@ to sockets.
Bind the socket to *address*. The socket must not already be bound. (The format
of *address* depends on the address family --- see above.)
- .. audit-event:: socket.bind "self address"
+ .. audit-event:: socket.bind self,address socket.socket.bind
.. method:: socket.close()
@@ -1145,7 +1145,7 @@ to sockets.
:exc:`InterruptedError` exception if the connection is interrupted by a
signal (or the exception raised by the signal handler).
- .. audit-event:: socket.connect "self address"
+ .. audit-event:: socket.connect self,address socket.socket.connect
.. versionchanged:: 3.5
The method now waits until the connection completes instead of raising an
@@ -1163,7 +1163,7 @@ to sockets.
:c:data:`errno` variable. This is useful to support, for example, asynchronous
connects.
- .. audit-event:: socket.connect "self address"
+ .. audit-event:: socket.connect self,address socket.socket.connect_ex
.. method:: socket.detach()
@@ -1505,7 +1505,7 @@ to sockets.
bytes sent. (The format of *address* depends on the address family --- see
above.)
- .. audit-event:: socket.sendto "self address"
+ .. audit-event:: socket.sendto self,address socket.socket.sendto
.. versionchanged:: 3.5
If the system call is interrupted and the signal handler does not raise
@@ -1546,7 +1546,7 @@ to sockets.
.. availability:: most Unix platforms, possibly others.
- .. audit-event:: socket.sendmsg "self address"
+ .. audit-event:: socket.sendmsg self,address socket.socket.sendmsg
.. versionadded:: 3.3
diff --git a/Doc/library/sqlite3.rst b/Doc/library/sqlite3.rst
index e0411fe..67ea2b1 100644
--- a/Doc/library/sqlite3.rst
+++ b/Doc/library/sqlite3.rst
@@ -224,7 +224,7 @@ Module functions and constants
More information about this feature, including a list of recognized options, can
be found in the `SQLite URI documentation <https://www.sqlite.org/uri.html>`_.
- .. audit-event:: sqlite3.connect "database"
+ .. audit-event:: sqlite3.connect database sqlite3.connect
.. versionchanged:: 3.4
Added the *uri* parameter.
diff --git a/Doc/library/subprocess.rst b/Doc/library/subprocess.rst
index ad49d7f..af33879 100644
--- a/Doc/library/subprocess.rst
+++ b/Doc/library/subprocess.rst
@@ -585,7 +585,7 @@ functions.
with Popen(["ifconfig"], stdout=PIPE) as proc:
log.write(proc.stdout.read())
- .. audit-event:: subprocess.Popen "executable args cwd env"
+ .. audit-event:: subprocess.Popen executable,args,cwd,env subprocess.Popen
Popen and the other functions in this module that use it raise an
:ref:`auditing event <auditing>` ``subprocess.Popen`` with arguments
diff --git a/Doc/library/sys.rst b/Doc/library/sys.rst
index c073431..0b53ee0 100644
--- a/Doc/library/sys.rst
+++ b/Doc/library/sys.rst
@@ -86,6 +86,9 @@ always available.
The native equivalent of this function is :c:func:`PySys_Audit`. Using the
native function is preferred when possible.
+ See the :ref:`audit events table <audit-events>` for all events raised by
+ ``CPython``.
+
.. versionadded:: 3.8
@@ -166,7 +169,7 @@ always available.
This function should be used for internal and specialized purposes only.
- .. audit-event:: sys._current_frames
+ .. audit-event:: sys._current_frames "" sys._current_frames
.. function:: breakpointhook()
@@ -675,7 +678,7 @@ always available.
that is deeper than the call stack, :exc:`ValueError` is raised. The default
for *depth* is zero, returning the frame at the top of the call stack.
- .. audit-event:: sys._getframe
+ .. audit-event:: sys._getframe "" sys._getframe
.. impl-detail::
@@ -1190,7 +1193,7 @@ always available.
``'return'``, ``'c_call'``, ``'c_return'``, or ``'c_exception'``. *arg* depends
on the event type.
- .. audit-event:: sys.setprofile
+ .. audit-event:: sys.setprofile "" sys.setprofile
The events have the following meaning:
@@ -1312,7 +1315,7 @@ always available.
For more information on code and frame objects, refer to :ref:`types`.
- .. audit-event:: sys.settrace
+ .. audit-event:: sys.settrace "" sys.settrace
.. impl-detail::
@@ -1334,9 +1337,9 @@ always available.
first time. The *finalizer* will be called when an asynchronous generator
is about to be garbage collected.
- .. audit-event:: sys.set_asyncgen_hooks_firstiter
+ .. audit-event:: sys.set_asyncgen_hooks_firstiter "" sys.set_asyncgen_hooks
- .. audit-event:: sys.set_asyncgen_hooks_finalizer
+ .. audit-event:: sys.set_asyncgen_hooks_finalizer "" sys.set_asyncgen_hooks
Two auditing events are raised because the underlying API consists of two
calls, each of which must raise its own event.
diff --git a/Doc/library/telnetlib.rst b/Doc/library/telnetlib.rst
index d238136..0262a9b 100644
--- a/Doc/library/telnetlib.rst
+++ b/Doc/library/telnetlib.rst
@@ -141,7 +141,7 @@ Telnet Objects
Do not try to reopen an already connected instance.
- .. audit-event:: telnetlib.Telnet.open "self host port"
+ .. audit-event:: telnetlib.Telnet.open self,host,port telnetlib.Telnet.open
.. method:: Telnet.msg(msg, *args)
@@ -178,7 +178,7 @@ Telnet Objects
block if the connection is blocked. May raise :exc:`OSError` if the
connection is closed.
- .. audit-event:: telnetlib.Telnet.write "self buffer"
+ .. audit-event:: telnetlib.Telnet.write self,buffer telnetlib.Telnet.write
.. versionchanged:: 3.3
This method used to raise :exc:`socket.error`, which is now an alias
diff --git a/Doc/library/tempfile.rst b/Doc/library/tempfile.rst
index 98069f2..0793e43 100644
--- a/Doc/library/tempfile.rst
+++ b/Doc/library/tempfile.rst
@@ -62,7 +62,7 @@ The module defines the following user-callable items:
The :py:data:`os.O_TMPFILE` flag is used if it is available and works
(Linux-specific, requires Linux kernel 3.11 or later).
- .. audit-event:: tempfile.mkstemp "full-path"
+ .. audit-event:: tempfile.mkstemp fullpath tempfile.TemporaryFile
.. versionchanged:: 3.5
@@ -87,7 +87,7 @@ The module defines the following user-callable items:
attribute is the underlying true file object. This file-like object can
be used in a :keyword:`with` statement, just like a normal file.
- .. audit-event:: tempfile.mkstemp "full-path"
+ .. audit-event:: tempfile.mkstemp fullpath tempfile.NamedTemporaryFile
.. versionchanged:: 3.8
Added *errors* parameter.
@@ -134,7 +134,7 @@ The module defines the following user-callable items:
The directory can be explicitly cleaned up by calling the
:func:`cleanup` method.
- .. audit-event:: tempfile.mkdtemp "full-path"
+ .. audit-event:: tempfile.mkdtemp fullpath tempfile.TemporaryDirectory
.. versionadded:: 3.2
@@ -183,7 +183,7 @@ The module defines the following user-callable items:
file (as would be returned by :func:`os.open`) and the absolute pathname
of that file, in that order.
- .. audit-event:: tempfile.mkstemp "full-path"
+ .. audit-event:: tempfile.mkstemp fullpath tempfile.mkstemp
.. versionchanged:: 3.5
*suffix*, *prefix*, and *dir* may now be supplied in bytes in order to
@@ -206,7 +206,7 @@ The module defines the following user-callable items:
:func:`mkdtemp` returns the absolute pathname of the new directory.
- .. audit-event:: tempfile.mkdtemp "full-path"
+ .. audit-event:: tempfile.mkdtemp fullpath tempfile.mkdtemp
.. versionchanged:: 3.5
*suffix*, *prefix*, and *dir* may now be supplied in bytes in order to
diff --git a/Doc/library/urllib.request.rst b/Doc/library/urllib.request.rst
index 9f8869c..3b75089 100644
--- a/Doc/library/urllib.request.rst
+++ b/Doc/library/urllib.request.rst
@@ -95,7 +95,7 @@ The :mod:`urllib.request` module defines the following functions:
parameter to ``urllib.urlopen``, can be obtained by using
:class:`ProxyHandler` objects.
- .. audit-event:: urllib.Request "fullurl data headers method"
+ .. audit-event:: urllib.Request fullurl,data,headers,method urllib.request.urlopen
The default opener raises an :ref:`auditing event <auditing>`
``urllib.Request`` with arguments ``fullurl``, ``data``, ``headers``,
diff --git a/Doc/library/webbrowser.rst b/Doc/library/webbrowser.rst
index 85e932d..b7bfb65 100644
--- a/Doc/library/webbrowser.rst
+++ b/Doc/library/webbrowser.rst
@@ -64,7 +64,7 @@ The following functions are defined:
may work and start the operating system's associated program. However, this
is neither supported nor portable.
- .. audit-event:: webbrowser.open "url"
+ .. audit-event:: webbrowser.open url webbrowser.open
.. function:: open_new(url)