Skip to content

gh-124205: Align warning category documentation #157255

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

Open
owenthcarey wants to merge 2 commits into
base: main
Choose a base branch
from
+23 −20
Open

gh-124205: Align warning category documentation #157255

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3a428f0
gh-124205: Align warning category documentation
owenthcarey Sep 10, 2026
72d4620
Update Doc/library/warnings.rst
owenthcarey Sep 11, 2026
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
43 changes: 23 additions & 20 deletions Doc/library/warnings.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,45 +68,48 @@ The following warnings category classes are currently defined:
+----------------------------------+-----------------------------------------------+
| Class | Description |
+==================================+===============================================+
| :exc:`Warning` | This is the base class of all warning |
| | category classes. It is a subclass of |
| | :exc:`Exception`. |
| :exc:`Warning` | Base class for warning categories. It is a |
| | subclass of :exc:`Exception`. |
+----------------------------------+-----------------------------------------------+
| :exc:`UserWarning` | The default category for :func:`warn`. |
| :exc:`UserWarning` | Base class for warnings generated by user |
| | code. The default category for :func:`warn`. |
+----------------------------------+-----------------------------------------------+
| :exc:`DeprecationWarning` | Base category for warnings about deprecated |
| :exc:`DeprecationWarning` | Base class for warnings about deprecated |
| | features when those warnings are intended for |
| | other Python developers (ignored by default, |
| | unless triggered by code in ``__main__``). |
+----------------------------------+-----------------------------------------------+
| :exc:`SyntaxWarning` | Base category for warnings about dubious |
| | syntactic features (typically emitted when |
| | compiling Python source code, and hence |
| | may not be suppressed by runtime filters) |
| :exc:`PendingDeprecationWarning` | Base class for warnings about features |
| | that will be deprecated in the future |
| | (ignored by default). |
+----------------------------------+-----------------------------------------------+
| :exc:`RuntimeWarning` | Base category for warnings about dubious |
| | runtime features. |
| :exc:`SyntaxWarning` | Base class for warnings about dubious syntax |
| | (typically emitted when compiling Python |
| | source code, and hence may not be suppressed |
| | by runtime filters). |
+----------------------------------+-----------------------------------------------+
| :exc:`FutureWarning` | Base category for warnings about deprecated |
| :exc:`RuntimeWarning` | Base class for warnings about dubious runtime |
| | behavior. |
+----------------------------------+-----------------------------------------------+
| :exc:`FutureWarning` | Base class for warnings about deprecated |
| | features when those warnings are intended for |
| | end users of applications that are written in |
| | Python. |
+----------------------------------+-----------------------------------------------+
| :exc:`PendingDeprecationWarning` | Base category for warnings about features |
| | that will be deprecated in the future |
| | (ignored by default). |
+----------------------------------+-----------------------------------------------+
| :exc:`ImportWarning` | Base category for warnings triggered during |
| :exc:`ImportWarning` | Base class for warnings triggered during |
| | the process of importing a module (ignored by |
| | default). |
+----------------------------------+-----------------------------------------------+
| :exc:`UnicodeWarning` | Base category for warnings related to |
| :exc:`UnicodeWarning` | Base class for warnings related to |
| | Unicode. |
+----------------------------------+-----------------------------------------------+
| :exc:`BytesWarning` | Base category for warnings related to |
| :exc:`EncodingWarning` | Base class for warnings related to encodings. |
| | See :ref:`io-encoding-warning` for details. |
+----------------------------------+-----------------------------------------------+
| :exc:`BytesWarning` | Base class for warnings related to |
| | :class:`bytes` and :class:`bytearray`. |
+----------------------------------+-----------------------------------------------+
| :exc:`ResourceWarning` | Base category for warnings related to |
| :exc:`ResourceWarning` | Base class for warnings related to |
| | resource usage (ignored by default). |
+----------------------------------+-----------------------------------------------+

Expand Down
Loading