gh-125761: Clarify repeated warning suppression criteria in warnings module (gh-126326)

This commit is contained in:
고병찬 2024-11-02 20:37:26 +09:00 committed by GitHub
parent cfb1b2f0cb
commit 10eeec2d4f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View 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