]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-125761: Clarify repeated warning suppression criteria in warnings module (gh-126326)
author고병찬 <70642609+byungchanKo99@users.noreply.github.com>
Sat, 2 Nov 2024 11:37:26 +0000 (20:37 +0900)
committerGitHub <noreply@github.com>
Sat, 2 Nov 2024 11:37:26 +0000 (21:37 +1000)
Doc/library/warnings.rst

index 1e7c4c8b915e7e1b80b80cddbe7ebe9c5b293906..0c7e8543f331db9666e986b4eb54a2b9bd048a17 100644 (file)
@@ -180,6 +180,19 @@ If a warning is reported and doesn't match any registered filter then the
 "default" action is applied (hence its name).
 
 
+
+.. _repeated-warning-suppression-criteria:
+
+Repeated Warning Suppression Criteria
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The filters that suppress repeated warnings apply the following criteria to determine if a warning is considered a repeat:
+
+- ``"default"``: A warning is considered a repeat only if the (*message*, *category*, *module*, *lineno*) are all the same.
+- ``"module"``: A warning is considered a repeat if the (*message*, *category*, *module*) are the same, ignoring the line number.
+- ``"once"``: A warning is considered a repeat if the (*message*, *category*) are the same, ignoring the module and line number.
+
+
 .. _describing-warning-filters:
 
 Describing Warning Filters