如何使用 warnings.filterwarnings 抑制第三方警告

Question

我在 python 代码中使用 Paramiko（用于 sftp）。除了每次导入或调用 paramiko 函数之外，一切都工作正常。将显示此警告：

C:\Python26\lib\site-packages\Crypto\Util\randpool.py:40: RandomPool_Deprecation
Warning: This application uses RandomPool, which is BROKEN in older releases.  S
ee http://www.pycrypto.org/randpool-broken
  RandomPool_DeprecationWarning)

我知道这与 Paramiko 正在使用 PyCrypto 的某些已弃用功能有关。

我的问题是，有没有办法以编程方式抑制此警告？ 我已经尝试过这个：

warnings.filterwarnings(action='ignore', \
category=DeprecationWarning, module='paramiko')

甚至这个：

warnings.filterwarnings(action='ignore', \
category=DeprecationWarning, module='randpool')

在“import paramiko”语句之前和特定于 paramiko 的函数调用之前，但没有任何效果。不管怎样，这个警告都会不断出现。 如果有帮助，这里是第三方库中打印警告的代码：

在 randpool.py 中：

from Crypto.pct_warnings import RandomPool_DeprecationWarning
import Crypto.Random
import warnings

class RandomPool:
    """Deprecated.  Use Random.new() instead.

    See http://www.pycrypto.org/randpool-broken
    """
    def __init__(self, numbytes = 160, cipher=None, hash=None, file=None):
        warnings.warn("This application uses RandomPool, which is BROKEN in older releases.  See http://www.pycrypto.org/randpool-broken",
            RandomPool_DeprecationWarning)

如果您知道解决此问题的方法，请帮我关闭此警告。

Answer 1

最简单的方法是警告模块此处建议的那样：

with warnings.catch_warnings():
    warnings.simplefilter("ignore")
    import paramiko

Answer 2

warnings.filterwarnings 的 module 参数采用区分大小写的正则表达式，该表达式应与完全限定的模块名称匹配，因此

warnings.filterwarnings(
    action='ignore',
    category=DeprecationWarning,
    module=r'.*randpool'
)

或

warnings.filterwarnings(
    action='ignore',
    category=DeprecationWarning,
    module=r'Crypto\.Utils\.randpool'
)

应该有效。如果由于某种原因 RandomPool_DeprecationWarning 不是 DeprecationWarning 的子类，您可能需要显式编写 RandomPool_DeprecationWarning 而不是 DeprecationWarning。

您还可以在调用脚本时通过将 -W 选项传递给解释器来禁用命令行上的警告，如下所示：

$ python -W ignore::RandomPool_DeprecationWarning:Crypto.Utils.randpool: my_script.py

-W 采用格式 < code>action:message:category:module:lineno，这次 module 必须与引发警告的（完全限定）模块名称完全匹配。

请参阅 https://docs.python.org/ 2/library/warnings.html?highlight=warnings#the-warnings-filter 和 https://docs.python.org/2/using/cmdline.html#cmdoption-w

Answer 3

仅过滤特定警告：

with warnings.catch_warnings():
    warnings.simplefilter('ignore', SpecificWarningObject)

    #do something that raises a Warning

Answer 4

最灵活的方法是结合 warnings.filterwarnings()< /code>（或 warnings.simplefilter( )) 和 警告.catch_warnings() 上下文管理器。通过这种方式，您可以获得 filterwarnings 的灵活性，但过滤仅应用于 with 块内：

import warnings

with warnings.catch_warnings():
    warnings.filterwarnings(
        action='ignore',
        category=SomeWarningClass,
        message='some message')
   
    # Do stuff that causes the warning

请参阅 文档中的警告过滤器，用于描述 filterwarnings 的参数。

完整示例

这是带有自定义警告的完整示例：

import warnings

# Custom warning class for the example
class MyWarning(UserWarning):
    pass

def function_that_issues_warning(num):
    print(num)
    warnings.warn("This is a warning", MyWarning)


with warnings.catch_warnings():
    function_that_issues_warning(1) # issues warning
    warnings.filterwarnings(
        action="ignore", category=MyWarning, message="This is a warning"
    )

    function_that_issues_warning(2) # Warning is filtered
function_that_issues_warning(3) # issues warning

示例输出

1
.\test_warnings.py:10: MyWarning: This is a warning
  warnings.warn("This is a warning", MyWarning)
2
3
.\test_warnings.py:10: MyWarning: This is a warning
  warnings.warn("This is a warning", MyWarning)