Warning filters only work in configuration files and not the command line

[FelixBenning]

[tool.pytest.ini_options]
filterwarnings = [
    "ignore::DeprecationWarning:tensorflow[.*]",
]

works, but the command line version does not

(env) PS D:\code\tf-optimizer-stochastic-runge-kutta> pytest tests -W module::DeprecationWarning -W ignore::DeprecationWarning:tensorflow[.*]
==================================================================================================== test session starts =====================================================================================================
platform win32 -- Python 3.9.5, pytest-6.2.4, py-1.10.0, pluggy-0.13.1
rootdir: D:\code\tf-optimizer-stochastic-runge-kutta
collected 1 item

tests\test_basics.py .                                                                                                                                                                                                  [100%]

====================================================================================================== warnings summary ====================================================================================================== 
env\lib\site-packages\tensorflow\core\framework\tensor_shape_pb2.py:18
  d:\code\tf-optimizer-stochastic-runge-kutta\env\lib\site-packages\tensorflow\core\framework\tensor_shape_pb2.py:18: DeprecationWarning: Call to deprecated create function FileDescriptor(). Note: Create unlinked descriptors is going to go away. Please use get/find descriptors from generated code or query the descriptor_pool.
    DESCRIPTOR = _descriptor.FileDescriptor(

env\lib\site-packages\tensorflow\core\framework\tensor_shape_pb2.py:36
  d:\code\tf-optimizer-stochastic-runge-kutta\env\lib\site-packages\tensorflow\core\framework\tensor_shape_pb2.py:36: DeprecationWarning: Call to deprecated create function FieldDescriptor(). Note: Create unlinked descriptors is going to go away. Please use get/find descriptors from generated code or query the descriptor_pool.
    _descriptor.FieldDescriptor(

env\lib\site-packages\tensorflow\core\framework\tensor_shape_pb2.py:29
  d:\code\tf-optimizer-stochastic-runge-kutta\env\lib\site-packages\tensorflow\core\framework\tensor_shape_pb2.py:29: DeprecationWarning: Call to deprecated create function Descriptor(). Note: Create unlinked descriptors is going to go away. Please use get/find descriptors from generated code or query the descriptor_pool.
    _TENSORSHAPEPROTO_DIM = _descriptor.Descriptor(

env\lib\site-packages\tensorflow\core\framework\types_pb2.py:19
  d:\code\tf-optimizer-stochastic-runge-kutta\env\lib\site-packages\tensorflow\core\framework\types_pb2.py:19: DeprecationWarning: Call to deprecated create function FileDescriptor(). Note: Create unlinked descriptors is going to go away. Please use get/find descriptors from generated code or query the descriptor_pool.
    DESCRIPTOR = _descriptor.FileDescriptor(

env\lib\site-packages\tensorflow\core\framework\types_pb2.py:33
  d:\code\tf-optimizer-stochastic-runge-kutta\env\lib\site-packages\tensorflow\core\framework\types_pb2.py:33: DeprecationWarning: Call to deprecated create function EnumValueDescriptor(). Note: Create unlinked descriptors 
is going to go away. Please use get/find descriptors from generated code or query the descriptor_pool.
    _descriptor.EnumValueDescriptor(
env\lib\site-packages\tensorflow\core\framework\types_pb2.py:27
  d:\code\tf-optimizer-stochastic-runge-kutta\env\lib\site-packages\tensorflow\core\framework\types_pb2.py:27: DeprecationWarning: Call to deprecated create function EnumDescriptor(). Note: Create unlinked descriptors is going to go away. Please use get/find descriptors from generated code or query the descriptor_pool.
    _DATATYPE = _descriptor.EnumDescriptor(

env\lib\site-packages\tensorflow\core\framework\resource_handle_pb2.py:20
  d:\code\tf-optimizer-stochastic-runge-kutta\env\lib\site-packages\tensorflow\core\framework\resource_handle_pb2.py:20: DeprecationWarning: Call to deprecated create function FileDescriptor(). Note: Create unlinked descriptors is going to go away. Please use get/find descriptors from generated code or query the descriptor_pool.
    DESCRIPTOR = _descriptor.FileDescriptor(

env\lib\site-packages\tensorflow\core\framework\resource_handle_pb2.py:39
  d:\code\tf-optimizer-stochastic-runge-kutta\env\lib\site-packages\tensorflow\core\framework\resource_handle_pb2.py:39: DeprecationWarning: Call to deprecated create function FieldDescriptor(). Note: Create unlinked descriptors is going to go away. Please use get/find descriptors from generated code or query the descriptor_pool.
    _descriptor.FieldDescriptor(

env\lib\site-packages\tensorflow\core\framework\resource_handle_pb2.py:32
  d:\code\tf-optimizer-stochastic-runge-kutta\env\lib\site-packages\tensorflow\core\framework\resource_handle_pb2.py:32: DeprecationWarning: Call to deprecated create function Descriptor(). Note: Create unlinked descriptors is going to go away. Please use get/find descriptors from generated code or query the descriptor_pool.
    _RESOURCEHANDLEPROTO_DTYPEANDSHAPE = _descriptor.Descriptor(

env\lib\site-packages\tensorflow\core\framework\tensor_pb2.py:21
  d:\code\tf-optimizer-stochastic-runge-kutta\env\lib\site-packages\tensorflow\core\framework\tensor_pb2.py:21: DeprecationWarning: Call to deprecated create function FileDescriptor(). Note: Create unlinked descriptors is going to go away. Please use get/find descriptors from generated code or query the descriptor_pool.
    DESCRIPTOR = _descriptor.FileDescriptor(

env\lib\site-packages\tensorflow\core\framework\tensor_pb2.py:40
  d:\code\tf-optimizer-stochastic-runge-kutta\env\lib\site-packages\tensorflow\core\framework\tensor_pb2.py:40: DeprecationWarning: Call to deprecated create function FieldDescriptor(). Note: Create unlinked descriptors is 
going to go away. Please use get/find descriptors from generated code or query the descriptor_pool.
    _descriptor.FieldDescriptor(

env\lib\site-packages\tensorflow\core\framework\tensor_pb2.py:33
  d:\code\tf-optimizer-stochastic-runge-kutta\env\lib\site-packages\tensorflow\core\framework\tensor_pb2.py:33: DeprecationWarning: Call to deprecated create function Descriptor(). Note: Create unlinked descriptors is going to go away. Please use get/find descriptors from generated code or query the descriptor_pool.
    _TENSORPROTO = _descriptor.Descriptor(

env\lib\site-packages\tensorflow\core\framework\attr_value_pb2.py:21
  d:\code\tf-optimizer-stochastic-runge-kutta\env\lib\site-packages\tensorflow\core\framework\attr_value_pb2.py:21: DeprecationWarning: Call to deprecated create function FileDescriptor(). Note: Create unlinked descriptors 
is going to go away. Please use get/find descriptors from generated code or query the descriptor_pool.
    DESCRIPTOR = _descriptor.FileDescriptor(

env\lib\site-packages\tensorflow\core\framework\attr_value_pb2.py:40
  d:\code\tf-optimizer-stochastic-runge-kutta\env\lib\site-packages\tensorflow\core\framework\attr_value_pb2.py:40: DeprecationWarning: Call to deprecated create function FieldDescriptor(). Note: Create unlinked descriptors is going to go away. Please use get/find descriptors from generated code or query the descriptor_pool.
    _descriptor.FieldDescriptor(

env\lib\site-packages\tensorflow\python\autograph\impl\api.py:22
  d:\code\tf-optimizer-stochastic-runge-kutta\env\lib\site-packages\tensorflow\python\autograph\impl\api.py:22: DeprecationWarning: the imp module is deprecated in favour of importlib; see the module's documentation for alternative uses
    import imp

-- Docs: https://docs.pytest.org/en/stable/warnings.html
=============================================================================================== 1 passed, 15 warnings in 4.20s =============================================================================================== 

Output of pip freeze

(env) PS D:\code\tf-optimizer-stochastic-runge-kutta> pip freeze
absl-py==0.12.0
astunparse==1.6.3
atomicwrites==1.4.0
attrs==21.2.0
cachetools==4.2.2
certifi==2021.5.30
chardet==4.0.0
colorama==0.4.4
flatbuffers==1.12
gast==0.4.0
google-auth==1.31.0
google-auth-oauthlib==0.4.4
google-pasta==0.2.0
grpcio==1.34.1
h5py==3.1.0
idna==2.10
iniconfig==1.1.1
keras-nightly==2.5.0.dev2021032900
Keras-Preprocessing==1.1.2
Markdown==3.3.4
my-optimizer==0.1
numpy==1.19.5
oauthlib==3.1.1
opt-einsum==3.3.0
packaging==20.9
pluggy==0.13.1
protobuf==3.17.3
py==1.10.0
pyasn1==0.4.8
pyasn1-modules==0.2.8
pyparsing==2.4.7
pytest==6.2.4
requests==2.25.1
requests-oauthlib==1.3.0
rsa==4.7.2
-e [email protected]:FelixBenning/tf-optimizer-stochastic-runge-kutta.git@979e49e84e8707d9ea1be3f2bd1c5241e8583933#egg=SGD_G2
six==1.15.0
tensorboard==2.5.0
tensorboard-data-server==0.6.1
tensorboard-plugin-wit==1.8.0
tensorflow==2.5.0
tensorflow-estimator==2.5.0
termcolor==1.1.0
toml==0.10.2
typing-extensions==3.7.4.3
urllib3==1.26.5
Werkzeug==2.0.1
wrapt==1.12.1

pytest and operating system versions:

• windows 10
• pytest==6.2.4

See also Comment below a StackOverflow Answer

@colini that failed for me as an argument to the -W flag, but it worked for me in my pytest.ini file. – WhiteHotLoveTiger Oct 15 '19 at 18:14

[nicoddemus]

Hi @FelixBenning,

I cannot try exactly your case, but this simple example works for me:

import warnings

def test():
    warnings.warn(DeprecationWarning("my warning"))

[tool.pytest.ini_options]
filterwarnings = ["ignore:my warning"]

λ pytest .tmp\test_warning.py --no-header
======================== test session starts ========================
collected 1 item

.tmp\test_warning.py .                                         [100%]

========================= 1 passed in 0.00s =========================

Commenting out filterwarnings:

[tool.pytest.ini_options]
#filterwarnings = ["ignore:my warning"]

λ pytest .tmp\test_warning.py --no-header
======================== test session starts ========================
collected 1 item

.tmp\test_warning.py .                                         [100%]

========================= warnings summary ==========================
test_warning.py::test
  e:\projects\pytest\.tmp\test_warning.py:5: DeprecationWarning: my warning
    warnings.warn(DeprecationWarning("my warning"))

-- Docs: https://docs.pytest.org/en/stable/warnings.html
=================== 1 passed, 1 warning in 0.01s ====================

But now passing -W on the command-line:

λ pytest .tmp\test_warning.py --no-header -W "ignore:my warning"
======================== test session starts ========================
collected 1 item

.tmp\test_warning.py .                                         [100%]

========================= 1 passed in 0.01s =========================

---

I suspect your problem might be related to the shell escaping the [.*] characters? The module argument doesn't need to match the whole path (I think), have you tried just using "ignore::DeprecationWarning:tensorflow"?

Otherwise, please provide a minimal reproducible example so we can take a look.

[FelixBenning]

I have tried "ignore::DeprecationWarning:tensorflow" I'll see if I have time to figure out a minimal reproducible example some time

[nicoddemus]

Please try with "ignore::DeprecationWarning" too.

[ezio-melotti]

A few things to keep in mind:

• in the pytest.ini you can use regular expressions for the message and module fields, from the command line with -W you can't because they gets escaped before being passed to re.match
• if you are using pytest.ini, you might have to put it in the root dir -- not in the test dir (despite what the docs say)
• -W seems to override the pytest.ini
• pytest.ini should take precedence over other files (I haven't tested this though)
• the mymodule[.*] suggested in the Python docs is likely a typo (and since it's a regex, it wouldn't work with -W anyway)

A few tips:

• while finding a regex that matches, testing with error instead of ignore might be easier
• if pytest finds the pytest.ini, it will show it at the beginning after the rootdir; if not, it will just show the rootdir:

  ======================================== test session starts ========================================
  platform linux -- Python 3.10.4, pytest-7.1.2, pluggy-1.0.0 -- /home/.../venv/bin/python3
  cachedir: .pytest_cache
  rootdir: /home/..., configfile: pytest.ini
  

• while using -W watch out for chacters that have a special meaning in the shell and might need to be escaped and/or enclosed in quotes
• you can use pyproject.toml too
• the module you want to use in the filter is the one listed in the first line of the warning summary (see below)

---

Examle, given the warning:

======================================== warnings summary ========================================
venv/lib/python3.10/site-packages/flatbuffers/compat.py:19
  /home/.../venv/lib/python3.10/site-packages/flatbuffers/compat.py:19: DeprecationWarning: the imp module is deprecated in favour of importlib and slated for removal in Python 3.12; see the module's documentation for alternative uses
    import imp

-- Docs: https://docs.pytest.org/en/stable/how-to/capture-warnings.html

You can ignore it using a pytest.ini in the root directory with:

[pytest]
filterwarnings =
    ignore:the imp module is deprecated:DeprecationWarning:flatbuffers\.compat:19

This example is very specific -- generally you want to omit the line number at the end and possibly other fields.

Other filters that work that you can put in the pytest.ini instead of the one above:

• ignore::DeprecationWarning:: catches all DeprecationWarnings (probably too generic)
• ignore::DeprecationWarning:flatbuffers: same but from the flatbuffers package (or any other 3rd-party package you have no control over)
• ignore::DeprecationWarning:flatbuffers\.compat: same but only from flatbuffers.compat module/sub-package
• ignore:the imp module:DeprecationWarning:: catches all DeprecationWarnings with a message that starts with the imp module (remember that it uses re.match(), which matches from the beginning of the string)
• ignore:.*imp module:DeprecationWarning:: same but with messages that contains imp module

Some examples that don't work:

• ignore::DeprecationWarning:compat: you need to include the root of the package (flatbuffers)
• ignore::DeprecationWarning:imp: you need to use the name of the package that imported this (the one listed in the warning summary)
• ignore:imp module:DeprecationWarning:: you need to either start from the beginning of the msg (i.e. the imp module), or use a regex like .*imp module

If you want to use -W from the command line, you can use:

• pytest -v -W 'ignore:the imp:DeprecationWarning:flatbuffers.compat:19'
• pytest -v -W 'ignore:the imp:DeprecationWarning:flatbuffers.compat:'
• pytest -v -W 'ignore::DeprecationWarning:flatbuffers.compat:'
• pytest -v -W 'ignore:the imp:DeprecationWarning::' (the start of the message is enough)

Some examples with -W that don't work:

• pytest -v -W 'ignore:the imp:DeprecationWarning:flatbuffers:' you can't provide the root package -- you have to specify the exact package.module
• pytest -v -W 'ignore:the imp module:DeprecationWarning:flatbuffers\.compat:' you can't use regex in the module field (use a literal ., not an escaped \.)
• pytest -v -W 'ignore:.*imp module:DeprecationWarning::' you can't use regex in the message field
• pytest -v -W 'ignore:imp module:DeprecationWarning::' you can't use part of the message, unless it's the beginning (i.e. the imp module)

Hope this helps whoever runs into similar issues!