Pythonプログラムにおける警告の制御方法【warningsモジュール徹底解説】

Pythonにおいて「警告」と「エラー」はまったく異なるものです。エラーが発生するとPythonプログラムは即座に終了しますが、警告は致命的ではありません。メッセージは表示されるものの、プログラムはそのまま実行を続けます。警告は、厳密には例外ではない特定の状態についてユーザーに注意を促すために発せられます。典型的な例としては、キーワード・関数・クラスなど、あるプログラミング要素の非推奨（deprecated）な使い方が検出された場合に警告が表示されます。

警告メッセージは、Python標準ライブラリの「warnings」モジュールで定義されている warn() 関数によって表示されます。Warning クラスは、組み込みクラス階層における Exception のサブクラスです。多数の組み込み警告サブクラスが用意されており、ユーザーが独自のサブクラスを定義することも可能です。

主な組み込み警告カテゴリ

警告の使用例

次のコードでは、非推奨となったメソッドと、将来のバージョンで非推奨になる予定のメソッドを持つクラスを定義しています。

# warningexample.py
import warnings
class WarnExample:
   def __init__(self):
      self.text = "Warning"

   def method1(self):
      warnings.warn(
         "method1 is deprecated, use new_method instead",
         DeprecationWarning
      )
      print ('method1', len(self.text))

   def method2(self):
      warnings.warn(
         "method2 will be deprecated in version 2, use new_method instead",
         PendingDeprecationWarning
      )
      print ('method2', len(self.text))

   def new_method(self):
      print ('new method', len(self.text))

if __name__=='__main__':
   e = WarnExample()
   e.method1()
   e.method2()
   e.new_method()

このスクリプトをコマンドプロンプトから以下のように実行しても、端末には警告メッセージは表示されません。

E:\python37>python warningexample.py

警告を表示するには、次のように -Wd スイッチを使用します。

E:\python37>python -Wd warningexample.py
warningexample.py:10: DeprecationWarning: method1 is deprecated, use new_method instead
DeprecationWarning
method1 7
warningexample.py:19: PendingDeprecationWarning: method2 will be deprecated in version 2, use new_method instead
PendingDeprecationWarning
method2 7
new method 7

同様に、以下のような対話型セッションでも警告メッセージは表示されません。

E:\python37>python
>>> from warningexample import WarnExample
>>> e = WarnExample()
>>> e.method1()
method1 7
>>> e.method2()
method2 7
>>> e.new_method()
new method 7

警告を確認したい場合は、-Wd オプションを付けてPythonセッションを開始します。

E:\python37>python -Wd
>>> from warningexample import WarnExample
>>> e=WarnExample()
>>> e.method1()
E:\python37\warningexample.py:10: DeprecationWarning: method1 is deprecated, use new_method instead
DeprecationWarning
method1 7
>>> e.method2()
E:\python37\warningexample.py:17: PendingDeprecationWarning: method2 will be deprecated in version 2, use new_method instead
PendingDeprecationWarning
method2 7
>>> e.new_method()
new method 7

警告フィルタ（Warnings Filters）

警告フィルタを使用すると、警告を無視するか、表示するか、あるいは例外として扱うか（例外を発生させるか）を制御できます。

次の対話型セッションでは、simplefilter() 関数を使ってフィルタを「default」に設定しています。

E:\python37>python
>>> import warnings
>>> warnings.simplefilter('default')
>>> from warningexample import WarnExample
>>> e=WarnExample()
>>> e.method1()
E:\python37\warningexample.py:10: DeprecationWarning: method1 is deprecated, use new_method instead
DeprecationWarning
method1 7
>>> e.method2()
E:\python37\warningexample.py:17: PendingDeprecationWarning: method2 will be deprecated in version 2, use new_method instead
PendingDeprecationWarning
method2 7
>>> e.new_method()
new method 7

また、警告を一時的に抑制したい場合は、simplefilter を「ignore」に設定します。catch_warnings() コンテキストマネージャと組み合わせると、そのブロック内でのみ設定が有効になり、ブロックを抜けると元の設定に自動的に戻るため便利です。

import warnings

def function():
    warnings.warn("deprecated", DeprecationWarning)

with warnings.catch_warnings():
    warnings.simplefilter("ignore")
    function()