How to Suppress a Third-Party Warning Using Warnings. Filterwarnings
I Am Using Paramiko in My Python Code (For Sftp). Everything Works Fine Except That Everytime I Import or Call a Paramiko Function. This Warning Would Show up...
I am using Paramiko in my python code (for sftp). Everything works fine except that everytime I import or call a paramiko function. This warning would show up:
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
RandomPool_DeprecationWarning)
I know that this has to do with the fact that Paramiko is using some Deprecated functionalities of PyCrypto.
My question is, is there a way to suppress this warning programmatically ? I have tried this:
warnings.filterwarnings(action='ignore', \
category=DeprecationWarning, module='paramiko')
and even this:
warnings.filterwarnings(action='ignore', \
category=DeprecationWarning, module='randpool')
before 'import paramiko' statement and before paramiko-specific function calls, but nothing works. This warning keeps showing up no matter what. If it helps, here's the code in the third party library that prints the warning:
in randpool.py:
from Crypto.pct_warnings import RandomPool_DeprecationWarning
import Crypto.Random
import warnings
class RandomPool:
"""Deprecated. Use Random.new() instead.
See
"""
def __init__(self, numbytes = 160, cipher=None, hash=None, file=None):
warnings.warn("This application uses RandomPool, which is BROKEN in older releases. See ",
RandomPool_DeprecationWarning)
If you know a way around this, please help me shut this warning off.
4 Answers
Easiest way would be as the warnings module suggests here:
with warnings.catch_warnings():
warnings.simplefilter("ignore")
import paramiko
The module argument to warnings.filterwarnings takes a case-sensitive regular expression which should match the fully qualified module name, so
warnings.filterwarnings(
action='ignore',
category=DeprecationWarning,
module=r'.*randpool'
)
or
warnings.filterwarnings(
action='ignore',
category=DeprecationWarning,
module=r'Crypto\.Utils\.randpool'
)
should work. You may need to write RandomPool_DeprecationWarning explicitly instead of DeprecationWarning if for some reason RandomPool_DeprecationWarning is not a subclass of DeprecationWarning.
You can also disable the warning on the command line when you invoke the script by passing the -W option to the interpreter like so:
$ python -W ignore::RandomPool_DeprecationWarning:Crypto.Utils.randpool: my_script.py
The -W takes filters in the format action:message:category:module:lineno, where this time module must exactly match the (fully-qualified) module name where the warning is raised.
See and
To filter only a specific warning:
with warnings.catch_warnings():
warnings.simplefilter('ignore', SpecificWarningObject)
#do something that raises a Warning
The most flexible way is to combine warnings.filterwarnings() (or warnings.simplefilter()) with the warnings.catch_warnings() context manager. This way you ge the flexibility of filterwarnings but the filtering is only applied inside the with block:
import warnings
with warnings.catch_warnings():
warnings.filterwarnings(
action='ignore',
category=SomeWarningClass,
message='some message')
# Do stuff that causes the warning
See The Warnings Filter in the docs for the descriptions of the arguments for filterwarnings.
Must Read
Full example
Here is a full example with a custom warning:
import warnings
# Custom warning class for the example
class MyWarning(UserWarning):
pass
def function_that_raises_warning(num):
print(num)
warnings.warn("This is a warning", MyWarning)
with warnings.catch_warnings():
function_that_raises_warning(1) # raises warning
warnings.filterwarnings(
action="ignore", category=MyWarning, message="This is a warning"
)
function_that_raises_warning(2) # Warning is filtered
function_that_raises_warning(3) # raises warning
Example output
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)