29.5. warnings
— Controle de avisos¶
Código Fonte: Lib/warnings.py
As mensagens de aviso são normalmente emitidas em situações em que é útil alertar o usuário sobre alguma condição em um programa, onde essa condição (normalmente) não garante o levantamento de uma exceção e o encerramento do programa. Por exemplo, pode-se querer emitir um aviso quando um programa usa um módulo obsoleto.
Os programadores Python emitem avisos chamando a função warn()
definida neste módulo. (Os programadores C usam PyErr_WarnEx()
; veja Manipulando Exceções para detalhes).
Warning messages are normally written to sys.stderr
, but their disposition
can be changed flexibly, from ignoring all warnings to turning them into
exceptions. The disposition of warnings can vary based on the warning category
(see below), the text of the warning message, and the source location where it
is issued. Repetitions of a particular warning for the same source location are
typically suppressed.
Existem duas etapas no controle de avisos: primeiro, cada vez que um aviso é emitido, é feita uma determinação se uma mensagem deve ser emitida ou não; a seguir, se uma mensagem deve ser emitida, ela é formatada e impressa usando um gancho configurável pelo usuário.
The determination whether to issue a warning message is controlled by the
warning filter, which is a sequence of matching rules and actions. Rules can be
added to the filter by calling filterwarnings()
and reset to its default
state by calling resetwarnings()
.
A exibição de mensagens de aviso é feita chamando showwarning()
, que pode ser substituída; a implementação padrão desta função formata a mensagem chamando formatwarning()
, que também está disponível para uso por implementações personalizadas.
Ver também
logging.captureWarnings()
permite que você manipule todos os avisos com a infraestrutura de registro padrão.
29.5.1. Categorias de avisos¶
There are a number of built-in exceptions that represent warning categories. This categorization is useful to be able to filter out groups of warnings. The following warnings category classes are currently defined:
Classe |
Description (descrição) |
---|---|
Esta é a classe base de todas as classes de categoria de aviso. É uma subclasse de |
|
A categoria padrão para |
|
Base category for warnings about deprecated features (ignored by default). |
|
Categoria base para avisos sobre recursos sintáticos duvidosos. |
|
Categoria base para avisos sobre recursos duvidosos de tempo de execução. |
|
Base category for warnings about constructs that will change semantically in the future. |
|
Categoria base para avisos sobre recursos que serão descontinuados no futuro (ignorados por padrão). |
|
Categoria base para avisos acionados durante o processo de importação de um módulo (ignorado por padrão). |
|
Categoria base para avisos relacionados a Unicode. |
|
Categoria base para avisos relacionados a |
|
Categoria base para avisos relacionados a uso de recursos. |
While these are technically built-in exceptions, they are documented here, because conceptually they belong to the warnings mechanism.
O código do usuário pode definir categorias de aviso adicionais criando uma subclasse de uma das categorias de aviso padrão. Uma categoria de aviso deve ser sempre uma subclasse da classe Warning
.
29.5.2. O filtro de avisos¶
O filtro de avisos controla se os avisos são ignorados, exibidos ou transformados em erros (levantando uma exceção).
Conceptually, the warnings filter maintains an ordered list of filter specifications; any specific warning is matched against each filter specification in the list in turn until a match is found; the match determines the disposition of the match. Each entry is a tuple of the form (action, message, category, module, lineno), where:
action é uma das seguintes strings:
Valor
Disposição
"error"
transforma avisos correspondentes em exceções
"ignore"
nunca exibe avisos correspondentes
"always"
sempre exibe avisos correspondentes
"default"
print the first occurrence of matching warnings for each location where the warning is issued
"module"
print the first occurrence of matching warnings for each module where the warning is issued
"once"
exibe apenas a primeira ocorrência de avisos correspondentes, independentemente da localização
message é uma string que contém uma expressão regular que deve corresponder ao início da mensagem de aviso. A expressão é compilada para não fazer distinção entre maiúsculas e minúsculas.
category é uma classe (uma subclasse de
Warning
) da qual a categoria de aviso deve ser uma subclasse para corresponder.module é uma string que contém uma expressão regular à qual o nome do módulo deve corresponder. A expressão é compilada para fazer distinção entre maiúsculas e minúsculas.
lineno é um número inteiro que deve corresponder ao número da linha onde ocorreu o aviso, ou
0
para corresponder a todos os números de linha.
Como a classe Warning
é derivada da classe embutida Exception
, para transformar um aviso em um erro, simplesmente levantamos category(message)
.
The warnings filter is initialized by -W
options passed to the Python
interpreter command line. The interpreter saves the arguments for all
-W
options without interpretation in sys.warnoptions
; the
warnings
module parses these when it is first imported (invalid options
are ignored, after printing a message to sys.stderr
).
29.5.2.1. Default Warning Filters¶
By default, Python installs several warning filters, which can be overridden by
the command-line options passed to -W
and calls to
filterwarnings()
.
DeprecationWarning
andPendingDeprecationWarning
, andImportWarning
are ignored.BytesWarning
is ignored unless the-b
option is given once or twice; in this case this warning is either printed (-b
) or turned into an exception (-bb
).ResourceWarning
is ignored unless Python was built in debug mode.
Alterado na versão 3.2: DeprecationWarning
is now ignored by default in addition to
PendingDeprecationWarning
.
29.5.3. Temporarily Suppressing Warnings¶
If you are using code that you know will raise a warning, such as a deprecated
function, but do not want to see the warning, then it is possible to suppress
the warning using the catch_warnings
context manager:
import warnings
def fxn():
warnings.warn("deprecated", DeprecationWarning)
with warnings.catch_warnings():
warnings.simplefilter("ignore")
fxn()
While within the context manager all warnings will simply be ignored. This
allows you to use known-deprecated code without having to see the warning while
not suppressing the warning for other code that might not be aware of its use
of deprecated code. Note: this can only be guaranteed in a single-threaded
application. If two or more threads use the catch_warnings
context
manager at the same time, the behavior is undefined.
29.5.4. Testing Warnings¶
To test warnings raised by code, use the catch_warnings
context
manager. With it you can temporarily mutate the warnings filter to facilitate
your testing. For instance, do the following to capture all raised warnings to
check:
import warnings
def fxn():
warnings.warn("deprecated", DeprecationWarning)
with warnings.catch_warnings(record=True) as w:
# Cause all warnings to always be triggered.
warnings.simplefilter("always")
# Trigger a warning.
fxn()
# Verify some things
assert len(w) == 1
assert issubclass(w[-1].category, DeprecationWarning)
assert "deprecated" in str(w[-1].message)
One can also cause all warnings to be exceptions by using error
instead of
always
. One thing to be aware of is that if a warning has already been
raised because of a once
/default
rule, then no matter what filters are
set the warning will not be seen again unless the warnings registry related to
the warning has been cleared.
Once the context manager exits, the warnings filter is restored to its state
when the context was entered. This prevents tests from changing the warnings
filter in unexpected ways between tests and leading to indeterminate test
results. The showwarning()
function in the module is also restored to
its original value. Note: this can only be guaranteed in a single-threaded
application. If two or more threads use the catch_warnings
context
manager at the same time, the behavior is undefined.
When testing multiple operations that raise the same kind of warning, it is important to test them in a manner that confirms each operation is raising a new warning (e.g. set warnings to be raised as exceptions and check the operations raise exceptions, check that the length of the warning list continues to increase after each operation, or else delete the previous entries from the warnings list before each new operation).
29.5.5. Updating Code For New Versions of Python¶
Warnings that are only of interest to the developer are ignored by default. As
such you should make sure to test your code with typically ignored warnings
made visible. You can do this from the command-line by passing -Wd
to the interpreter (this is shorthand for -W default
). This enables
default handling for all warnings, including those that are ignored by default.
To change what action is taken for encountered warnings you simply change what
argument is passed to -W
, e.g. -W error
. See the
-W
flag for more details on what is possible.
To programmatically do the same as -Wd
, use:
warnings.simplefilter('default')
Make sure to execute this code as soon as possible. This prevents the registering of what warnings have been raised from unexpectedly influencing how future warnings are treated.
Having certain warnings ignored by default is done to prevent a user from
seeing warnings that are only of interest to the developer. As you do not
necessarily have control over what interpreter a user uses to run their code,
it is possible that a new version of Python will be released between your
release cycles. The new interpreter release could trigger new warnings in your
code that were not there in an older interpreter, e.g.
DeprecationWarning
for a module that you are using. While you as a
developer want to be notified that your code is using a deprecated module, to a
user this information is essentially noise and provides no benefit to them.
The unittest
module has been also updated to use the 'default'
filter while running tests.
29.5.6. Available Functions¶
-
warnings.
warn
(message, category=None, stacklevel=1, source=None)¶ 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
. Alternatively message can be aWarning
instance, in which case category will be ignored andmessage.__class__
will be used. In this case the message text will bestr(message)
. 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 ofdeprecation()
itself (since the latter would defeat the purpose of the warning message).source, if supplied, is the destroyed object which emitted a
ResourceWarning
.Alterado na versão 3.6: Added source parameter.
-
warnings.
warn_explicit
(message, category, filename, lineno, module=None, registry=None, module_globals=None, source=None)¶ 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. message must be a string and category a subclass ofWarning
or message may be aWarning
instance, in which case category will be ignored.module_globals, if supplied, should be the global namespace in use by the code for which the warning is issued. (This argument is used to support displaying source for modules found in zipfiles or other non-filesystem import sources).
source, if supplied, is the destroyed object which emitted a
ResourceWarning
.Alterado na versão 3.6: Add the source parameter.
-
warnings.
showwarning
(message, category, filename, lineno, file=None, line=None)¶ Write a warning to a file. The default implementation calls
formatwarning(message, category, filename, lineno, line)
and writes the resulting string to file, which defaults tosys.stderr
. You may replace this function with any callable by assigning towarnings.showwarning
. line is a line of source code to be included in the warning message; if line is not supplied,showwarning()
will try to read the line specified by filename and lineno.
-
warnings.
formatwarning
(message, category, filename, lineno, line=None)¶ 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,
formatwarning()
will try to read the line specified by filename and lineno.
-
warnings.
filterwarnings
(action, message='', category=Warning, module='', lineno=0, append=False)¶ Insert an entry into the list of warnings filter specifications. 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.
-
warnings.
simplefilter
(action, category=Warning, lineno=0, append=False)¶ Insert a simple entry into the list of warnings filter specifications. The meaning of the function parameters is as for
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.
-
warnings.
resetwarnings
()¶ Reset the warnings filter. This discards the effect of all previous calls to
filterwarnings()
, including that of the-W
command line options and calls tosimplefilter()
.
29.5.7. Available Context Managers¶
-
class
warnings.
catch_warnings
(*, record=False, module=None)¶ A context manager that copies and, upon exit, restores the warnings filter and the
showwarning()
function. If the record argument isFalse
(the default) the context manager returnsNone
on entry. If record isTrue
, a list is returned that is progressively populated with objects as seen by a customshowwarning()
function (which also suppresses output tosys.stdout
). Each object in the list has attributes with the same names as the arguments toshowwarning()
.The module argument takes a module that will be used instead of the module returned when you import
warnings
whose filter will be protected. This argument exists primarily for testing thewarnings
module itself.Nota
The
catch_warnings
manager works by replacing and then later restoring the module’sshowwarning()
function and internal list of filter specifications. This means the context manager is modifying global state and therefore is not thread-safe.