Stowage/cpython
2
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-10-19 16:03:42 +00:00
Code Issues Projects Releases Packages Wiki Activity

gh-140241: Fix documentation for the registry parameter of warnings.warn_explicit() (GH-140242)

Browse source 
Co-authored-by: Petr Viktorin <encukou@gmail.com>
This commit is contained in:
Serhiy Storchaka 2025-10-18 13:55:26 +03:00 • committed by GitHub
parent 936de256a9
commit 78e1d65a4d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 11 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

15
Doc/library/warnings.rst
View file

@ -480,14 +480,21 @@ Available Functions
.. function:: warn_explicit(message, category, filename, lineno, module=None, registry=None, module_globals=None, source=None)
This is a low-level interface to the functionality of :func:`warn`, passing in
explicitly the message, category, filename and line number, and optionally the
module name and the registry (which should be the ``__warningregistry__``
dictionary of the module). The module name defaults to the filename with
``.py`` stripped; if no registry is passed, the warning is never suppressed.
explicitly the message, category, filename and line number, and optionally
other arguments.
*message* must be a string and *category* a subclass of :exc:`Warning` or
*message* may be a :exc:`Warning` instance, in which case *category* will be
ignored.
*module*, if supplied, should be the module name.
If no module is passed, the filename with ``.py`` stripped is used.
*registry*, if supplied, should be the ``__warningregistry__`` dictionary
of the module.
If no registry is passed, each warning is treated as the first occurrence,
that is, filter actions ``"default"``, ``"module"`` and ``"once"`` are
handled as ``"always"``.
*module_globals*, if supplied, should be the global namespace in use by the code
for which the warning is issued. (This argument is used to support displaying
source for modules found in zipfiles or other non-filesystem import