GNU Info
(python2.1-lib.info)Available Functions
Available Functions
-------------------
`warn(message[, category[, stacklevel]])'
Issue a warning, or maybe ignore it or raise an exception. The
CATEGORY argument, if given, must be a warning category class (see
above); it defaults to `UserWarning'. This function raises an
exception if the particular warning issued is changed into an
error by the warnings filter see above. The STACKLEVEL argument
can be used by wrapper functions written in Python, like this:
def deprecation(message):
warnings.warn(message, DeprecationWarning, stacklevel=2)
This makes the warning refer to `deprecation()''s caller, rather
than to the source of `deprecation()' itself (since the latter
would defeat the purpose of the warning message).
`warn_explicit(message, category, filename, lineno[, module[, registry]])'
This is a low-level interface to the functionality of `warn()',
passing in explicitly the message, category, filename and line
number, and optionally the module name and the registry (which
should be the `__warningregistry__' dictionary of the module).
The module name defaults to the filename with `.py' stripped; if
no registry is passed, the warning is never suppressed.
`showwarning(message, category, filename, lineno[, file])'
Write a warning to a file. The default implementation calls
`showwarning(MESSAGE, CATEGORY, FILENAME, LINENO)' and writes the
resulting string to FILE, which defaults to `sys.stderr'. You may
replace this function with an alternative implementation by
assigning to `warnings.showwarning'.
`formatwarning(message, category, filename, lineno)'
Format a warning the standard way. This returns a string which
may contain embedded newlines and ends in a newline.
`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 front of the warnings filter. Entries inserted
later override entries inserted earlier, if both match a
particular warning. Omitted arguments default to a value that
matches everything.
`resetwarnings()'
Reset the warnings filter. This discards the effect of all
previous calls to `filterwarnings()', including that of the `-W'
command line options.
automatically generated by info2www version 1.2.2.9