Doc/library/warnings.rst

   1
   2 :mod:`warnings` --- Warning control
   3 ===================================
   4
   5 .. index:: single: warnings
   6
   7 .. module:: warnings
   8    :synopsis: Issue warning messages and control their disposition.
   9
  10
  11 .. versionadded:: 2.1
  12
  13 Warning messages are typically issued in situations where it is useful to alert
  14 the user of some condition in a program, where that condition (normally) doesn't
  15 warrant raising an exception and terminating the program.  For example, one
  16 might want to issue a warning when a program uses an obsolete module.
  17
  18 Python programmers issue warnings by calling the :func:`warn` function defined
  19 in this module.  (C programmers use :cfunc:`PyErr_Warn`; see
  20 :ref:`exceptionhandling` for details).
  21
  22 Warning messages are normally written to ``sys.stderr``, but their disposition
  23 can be changed flexibly, from ignoring all warnings to turning them into
  24 exceptions.  The disposition of warnings can vary based on the warning category
  25 (see below), the text of the warning message, and the source location where it
  26 is issued.  Repetitions of a particular warning for the same source location are
  27 typically suppressed.
  28
  29 There are two stages in warning control: first, each time a warning is issued, a
  30 determination is made whether a message should be issued or not; next, if a
  31 message is to be issued, it is formatted and printed using a user-settable hook.
  32
  33 The determination whether to issue a warning message is controlled by the
  34 warning filter, which is a sequence of matching rules and actions. Rules can be
  35 added to the filter by calling :func:`filterwarnings` and reset to its default
  36 state by calling :func:`resetwarnings`.
  37
  38 The printing of warning messages is done by calling :func:`showwarning`, which
  39 may be overridden; the default implementation of this function formats the
  40 message by calling :func:`formatwarning`, which is also available for use by
  41 custom implementations.
  42
  43
  44 .. _warning-categories:
  45
  46 Warning Categories
  47 ------------------
  48
  49 There are a number of built-in exceptions that represent warning categories.
  50 This categorization is useful to be able to filter out groups of warnings.  The
  51 following warnings category classes are currently defined:
  52
  53 +----------------------------------+-----------------------------------------------+
  54 | Class                            | Description                                   |
  55 +==================================+===============================================+
  56 | :exc:`Warning`                   | This is the base class of all warning         |
  57 |                                  | category classes.  It is a subclass of        |
  58 |                                  | :exc:`Exception`.                             |
  59 +----------------------------------+-----------------------------------------------+
  60 | :exc:`UserWarning`               | The default category for :func:`warn`.        |
  61 +----------------------------------+-----------------------------------------------+
  62 | :exc:`DeprecationWarning`        | Base category for warnings about deprecated   |
  63 |                                  | features.                                     |
  64 +----------------------------------+-----------------------------------------------+
  65 | :exc:`SyntaxWarning`             | Base category for warnings about dubious      |
  66 |                                  | syntactic features.                           |
  67 +----------------------------------+-----------------------------------------------+
  68 | :exc:`RuntimeWarning`            | Base category for warnings about dubious      |
  69 |                                  | runtime features.                             |
  70 +----------------------------------+-----------------------------------------------+
  71 | :exc:`FutureWarning`             | Base category for warnings about constructs   |
  72 |                                  | that will change semantically in the future.  |
  73 +----------------------------------+-----------------------------------------------+
  74 | :exc:`PendingDeprecationWarning` | Base category for warnings about features     |
  75 |                                  | that will be deprecated in the future         |
  76 |                                  | (ignored by default).                         |
  77 +----------------------------------+-----------------------------------------------+
  78 | :exc:`ImportWarning`             | Base category for warnings triggered during   |
  79 |                                  | the process of importing a module (ignored by |
  80 |                                  | default).                                     |
  81 +----------------------------------+-----------------------------------------------+
  82 | :exc:`UnicodeWarning`            | Base category for warnings related to         |
  83 |                                  | Unicode.                                      |
  84 +----------------------------------+-----------------------------------------------+
  85
  86 While these are technically built-in exceptions, they are documented here,
  87 because conceptually they belong to the warnings mechanism.
  88
  89 User code can define additional warning categories by subclassing one of the
  90 standard warning categories.  A warning category must always be a subclass of
  91 the :exc:`Warning` class.
  92
  93
  94 .. _warning-filter:
  95
  96 The Warnings Filter
  97 -------------------
  98
  99 The warnings filter controls whether warnings are ignored, displayed, or turned
 100 into errors (raising an exception).
 101
 102 Conceptually, the warnings filter maintains an ordered list of filter
 103 specifications; any specific warning is matched against each filter
 104 specification in the list in turn until a match is found; the match determines
 105 the disposition of the match.  Each entry is a tuple of the form (*action*,
 106 *message*, *category*, *module*, *lineno*), where:
 107
 108 * *action* is one of the following strings:
 109
 110   +---------------+----------------------------------------------+
 111   | Value         | Disposition                                  |
 112   +===============+==============================================+
 113   | ``"error"``   | turn matching warnings into exceptions       |
 114   +---------------+----------------------------------------------+
 115   | ``"ignore"``  | never print matching warnings                |
 116   +---------------+----------------------------------------------+
 117   | ``"always"``  | always print matching warnings               |
 118   +---------------+----------------------------------------------+
 119   | ``"default"`` | print the first occurrence of matching       |
 120   |               | warnings for each location where the warning |
 121   |               | is issued                                    |
 122   +---------------+----------------------------------------------+
 123   | ``"module"``  | print the first occurrence of matching       |
 124   |               | warnings for each module where the warning   |
 125   |               | is issued                                    |
 126   +---------------+----------------------------------------------+
 127   | ``"once"``    | print only the first occurrence of matching  |
 128   |               | warnings, regardless of location             |
 129   +---------------+----------------------------------------------+
 130
 131 * *message* is a string containing a regular expression that the warning message
 132   must match (the match is compiled to always be  case-insensitive)
 133
 134 * *category* is a class (a subclass of :exc:`Warning`) of which the warning
 135   category must be a subclass in order to match
 136
 137 * *module* is a string containing a regular expression that the module name must
 138   match (the match is compiled to be case-sensitive)
 139
 140 * *lineno* is an integer that the line number where the warning occurred must
 141   match, or ``0`` to match all line numbers
 142
 143 Since the :exc:`Warning` class is derived from the built-in :exc:`Exception`
 144 class, to turn a warning into an error we simply raise ``category(message)``.
 145
 146 The warnings filter is initialized by :option:`-W` options passed to the Python
 147 interpreter command line.  The interpreter saves the arguments for all
 148 :option:`-W` options without interpretation in ``sys.warnoptions``; the
 149 :mod:`warnings` module parses these when it is first imported (invalid options
 150 are ignored, after printing a message to ``sys.stderr``).
 151
 152 The warnings that are ignored by default may be enabled by passing :option:`-Wd`
 153 to the interpreter. This enables default handling for all warnings, including
 154 those that are normally ignored by default. This is particular useful for
 155 enabling ImportWarning when debugging problems importing a developed package.
 156 ImportWarning can also be enabled explicitly in Python code using::
 157
 158    warnings.simplefilter('default', ImportWarning)
 159
 160
 161 .. _warning-functions:
 162
 163 Available Functions
 164 -------------------
 165
 166
 167 .. function:: warn(message[, category[, stacklevel]])
 168
 169    Issue a warning, or maybe ignore it or raise an exception.  The *category*
 170    argument, if given, must be a warning category class (see above); it defaults to
 171    :exc:`UserWarning`.  Alternatively *message* can be a :exc:`Warning` instance,
 172    in which case *category* will be ignored and ``message.__class__`` will be used.
 173    In this case the message text will be ``str(message)``. This function raises an
 174    exception if the particular warning issued is changed into an error by the
 175    warnings filter see above.  The *stacklevel* argument can be used by wrapper
 176    functions written in Python, like this::
 177
 178       def deprecation(message):
 179           warnings.warn(message, DeprecationWarning, stacklevel=2)
 180
 181    This makes the warning refer to :func:`deprecation`'s caller, rather than to the
 182    source of :func:`deprecation` itself (since the latter would defeat the purpose
 183    of the warning message).
 184
 185
 186 .. function:: warn_explicit(message, category, filename, lineno[, module[, registry[, module_globals]]])
 187
 188    This is a low-level interface to the functionality of :func:`warn`, passing in
 189    explicitly the message, category, filename and line number, and optionally the
 190    module name and the registry (which should be the ``__warningregistry__``
 191    dictionary of the module).  The module name defaults to the filename with
 192    ``.py`` stripped; if no registry is passed, the warning is never suppressed.
 193    *message* must be a string and *category* a subclass of :exc:`Warning` or
 194    *message* may be a :exc:`Warning` instance, in which case *category* will be
 195    ignored.
 196
 197    *module_globals*, if supplied, should be the global namespace in use by the code
 198    for which the warning is issued.  (This argument is used to support displaying
 199    source for modules found in zipfiles or other non-filesystem import
 200    sources).
 201
 202    .. versionchanged:: 2.5
 203       Added the `module_globals` parameter.
 204
 205
 206 .. function:: warnpy3k(message[, category[, stacklevel]])
 207
 208    Issue a warning related to Python 3.x deprecation. Warnings are only shown
 209    when Python is started with the -3 option. Like :func:`warn` *message* must
 210    be a string and *category* a subclass of :exc:`Warning`. :func:`warnpy3k`
 211    is using :exc:`DeprecationWarning` as default warning class.
 212
 213
 214 .. function:: showwarning(message, category, filename, lineno[, file])
 215
 216    Write a warning to a file.  The default implementation calls
 217    ``formatwarning(message, category, filename, lineno)`` and writes the resulting
 218    string to *file*, which defaults to ``sys.stderr``.  You may replace this
 219    function with an alternative implementation by assigning to
 220    ``warnings.showwarning``.
 221
 222
 223 .. function:: formatwarning(message, category, filename, lineno)
 224
 225    Format a warning the standard way.  This returns a string  which may contain
 226    embedded newlines and ends in a newline.
 227
 228
 229 .. function:: filterwarnings(action[, message[, category[, module[, lineno[, append]]]]])
 230
 231    Insert an entry into the list of warnings filters.  The entry is inserted at the
 232    front by default; if *append* is true, it is inserted at the end. This checks
 233    the types of the arguments, compiles the message and module regular expressions,
 234    and inserts them as a tuple in the  list of warnings filters.  Entries closer to
 235    the front of the list override entries later in the list, if both match a
 236    particular warning.  Omitted arguments default to a value that matches
 237    everything.
 238
 239
 240 .. function:: simplefilter(action[, category[, lineno[, append]]])
 241
 242    Insert a simple entry into the list of warnings filters. The meaning of the
 243    function parameters is as for :func:`filterwarnings`, but regular expressions
 244    are not needed as the filter inserted always matches any message in any module
 245    as long as the category and line number match.
 246
 247
 248 .. function:: resetwarnings()
 249
 250    Reset the warnings filter.  This discards the effect of all previous calls to
 251    :func:`filterwarnings`, including that of the :option:`-W` command line options
 252    and calls to :func:`simplefilter`.
 253