summaryrefslogtreecommitdiffstats
path: root/Doc/library/warnings.rst
diff options
context:
space:
mode:
authorBenjamin Peterson <benjamin@python.org>2009-09-11 22:24:02 (GMT)
committerBenjamin Peterson <benjamin@python.org>2009-09-11 22:24:02 (GMT)
commit8719ad5ddefadbc08b56a0af91515f050c89c678 (patch)
tree9530f8dfbc3448db17fa42a9114548296d3d6360 /Doc/library/warnings.rst
parent244f3545592eeaffe02d39f74fdd04e8ae937863 (diff)
downloadcpython-8719ad5ddefadbc08b56a0af91515f050c89c678.zip
cpython-8719ad5ddefadbc08b56a0af91515f050c89c678.tar.gz
cpython-8719ad5ddefadbc08b56a0af91515f050c89c678.tar.bz2
Merged revisions 74277,74321,74323,74326,74355,74465,74467,74488,74492,74513,74531,74549,74553,74625,74632,74643-74644,74647,74652,74666,74671,74727,74739 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk ........ r74277 | sean.reifschneider | 2009-08-01 18:54:55 -0500 (Sat, 01 Aug 2009) | 3 lines - Issue #6624: yArg_ParseTuple with "s" format when parsing argument with NUL: Bogus TypeError detail string. ........ r74321 | guilherme.polo | 2009-08-05 11:51:41 -0500 (Wed, 05 Aug 2009) | 1 line Easier reference to find (at least while svn continues being used). ........ r74323 | guilherme.polo | 2009-08-05 18:48:26 -0500 (Wed, 05 Aug 2009) | 1 line Typo. ........ r74326 | jesse.noller | 2009-08-05 21:05:56 -0500 (Wed, 05 Aug 2009) | 1 line Fix issue 4660: spurious task_done errors in multiprocessing, remove doc note for from_address ........ r74355 | gregory.p.smith | 2009-08-12 12:02:37 -0500 (Wed, 12 Aug 2009) | 2 lines comment typo fix ........ r74465 | vinay.sajip | 2009-08-15 18:23:12 -0500 (Sat, 15 Aug 2009) | 1 line Added section on logging to one file from multiple processes. ........ r74467 | vinay.sajip | 2009-08-15 18:34:47 -0500 (Sat, 15 Aug 2009) | 1 line Refined section on logging to one file from multiple processes. ........ r74488 | vinay.sajip | 2009-08-17 08:14:37 -0500 (Mon, 17 Aug 2009) | 1 line Further refined section on logging to one file from multiple processes. ........ r74492 | r.david.murray | 2009-08-17 14:26:49 -0500 (Mon, 17 Aug 2009) | 2 lines Issue 6685: 'toupper' -> 'upper' in cgi doc example explanation. ........ r74513 | skip.montanaro | 2009-08-18 09:37:52 -0500 (Tue, 18 Aug 2009) | 1 line missing module ref (issue6723) ........ r74531 | vinay.sajip | 2009-08-20 17:04:32 -0500 (Thu, 20 Aug 2009) | 1 line Added section on exceptions raised during logging. ........ r74549 | benjamin.peterson | 2009-08-24 12:42:36 -0500 (Mon, 24 Aug 2009) | 1 line fix pdf building by teaching latex the right encoding package ........ r74553 | r.david.murray | 2009-08-26 20:04:59 -0500 (Wed, 26 Aug 2009) | 2 lines Remove leftover text from end of sentence. ........ r74625 | benjamin.peterson | 2009-09-01 17:27:57 -0500 (Tue, 01 Sep 2009) | 1 line remove the check that classmethod's argument is a callable ........ r74632 | georg.brandl | 2009-09-03 02:27:26 -0500 (Thu, 03 Sep 2009) | 1 line #6828: fix wrongly highlighted blocks. ........ r74643 | georg.brandl | 2009-09-04 01:59:20 -0500 (Fri, 04 Sep 2009) | 2 lines Issue #2666: Handle BROWSER environment variable properly for unknown browser names in the webbrowser module. ........ r74644 | georg.brandl | 2009-09-04 02:55:14 -0500 (Fri, 04 Sep 2009) | 1 line #5047: remove Monterey support from configure. ........ r74647 | georg.brandl | 2009-09-04 03:17:04 -0500 (Fri, 04 Sep 2009) | 2 lines Issue #5275: In Cookie's Cookie.load(), properly handle non-string arguments as documented. ........ r74652 | georg.brandl | 2009-09-04 06:25:37 -0500 (Fri, 04 Sep 2009) | 1 line #6756: add some info about the "acct" parameter. ........ r74666 | georg.brandl | 2009-09-05 04:04:09 -0500 (Sat, 05 Sep 2009) | 1 line #6841: remove duplicated word. ........ r74671 | georg.brandl | 2009-09-05 11:47:17 -0500 (Sat, 05 Sep 2009) | 1 line #6843: add link from filterwarnings to where the meaning of the arguments is covered. ........ r74727 | benjamin.peterson | 2009-09-08 18:04:22 -0500 (Tue, 08 Sep 2009) | 1 line #6865 fix ref counting in initialization of pwd module ........ r74739 | georg.brandl | 2009-09-11 02:55:20 -0500 (Fri, 11 Sep 2009) | 1 line Move function back to its section. ........
Diffstat (limited to 'Doc/library/warnings.rst')
-rw-r--r--Doc/library/warnings.rst36
1 files changed, 19 insertions, 17 deletions
diff --git a/Doc/library/warnings.rst b/Doc/library/warnings.rst
index 1574e27..260323e 100644
--- a/Doc/library/warnings.rst
+++ b/Doc/library/warnings.rst
@@ -1,4 +1,3 @@
-
:mod:`warnings` --- Warning control
===================================
@@ -131,16 +130,16 @@ the disposition of the match. Each entry is a tuple of the form (*action*,
+---------------+----------------------------------------------+
* *message* is a string containing a regular expression that the warning message
- must match (the match is compiled to always be case-insensitive)
+ must match (the match is compiled to always be case-insensitive).
* *category* is a class (a subclass of :exc:`Warning`) of which the warning
- category must be a subclass in order to match
+ category must be a subclass in order to match.
* *module* is a string containing a regular expression that the module name must
- match (the match is compiled to be case-sensitive)
+ match (the match is compiled to be case-sensitive).
* *lineno* is an integer that the line number where the warning occurred must
- match, or ``0`` to match all line numbers
+ match, or ``0`` to match all line numbers.
Since the :exc:`Warning` class is derived from the built-in :exc:`Exception`
class, to turn a warning into an error we simply raise ``category(message)``.
@@ -285,18 +284,20 @@ Available Functions
.. function:: formatwarning(message, category, filename, lineno[, line])
- Format a warning the standard way. This returns a string which may contain
- embedded newlines and ends in a newline. *line* is
- a line of source code to be included in the warning message; if *line* is not supplied,
- :func:`formatwarning` will try to read the line specified by *filename* and *lineno*.
+ Format a warning the standard way. This returns a string which may contain
+ embedded newlines and ends in a newline. *line* is a line of source code to
+ be included in the warning message; if *line* is not supplied,
+ :func:`formatwarning` will try to read the line specified by *filename* and
+ *lineno*.
.. function:: filterwarnings(action[, message[, category[, module[, lineno[, append]]]]])
- Insert an entry into the list of warnings filters. The entry is inserted at the
- front by default; if *append* is true, it is inserted at the end. This checks
- the types of the arguments, compiles the message and module regular expressions,
- and inserts them as a tuple in the list of warnings filters. Entries closer to
+ Insert an entry into the list of :ref:`warnings filter specifications
+ <warning-filter>`. The entry is inserted at the front by default; if
+ *append* is true, it is inserted at the end. This checks the types of the
+ arguments, compiles the *message* and *module* regular expressions, and
+ inserts them as a tuple in the list of warnings filters. Entries closer to
the front of the list override entries later in the list, if both match a
particular warning. Omitted arguments default to a value that matches
everything.
@@ -304,10 +305,11 @@ Available Functions
.. function:: simplefilter(action[, category[, lineno[, append]]])
- Insert a simple entry into the list of warnings filters. The meaning of the
- function parameters is as for :func:`filterwarnings`, but regular expressions
- are not needed as the filter inserted always matches any message in any module
- as long as the category and line number match.
+ Insert a simple entry into the list of :ref:`warnings filter specifications
+ <warning-filter>`. The meaning of the function parameters is as for
+ :func:`filterwarnings`, but regular expressions are not needed as the filter
+ inserted always matches any message in any module as long as the category and
+ line number match.
.. function:: resetwarnings()