Pythonのwarningsを制御する7つの実践テクニック【非表示・例外化・ログ化】

import warnings

def old_function():
    # 将来的に廃止予定の関数だと仮定
    warnings.warn(
        "old_function() は将来的に削除されます。new_function() を使用してください。",
        category=DeprecationWarning,
        stacklevel=2,  # 呼び出し元の行を警告場所として表示
    )
    return 42

def main():
    result = old_function()
    print(result)

if __name__ == "__main__":
    main()

import warnings

def use_legacy_library():
    # ここでは仮に非推奨APIを呼び出しているとする
    warnings.warn(
        "このAPIは非推奨です。",
        category=DeprecationWarning,
        stacklevel=2,
    )

def main():
    print("=== 通常の動作 (警告が表示される) ===")
    use_legacy_library()

    print("\n=== 一時的に警告を無効化 ===")
    # catch_warnings() コンテキスト内では警告を一時的に制御できる
    with warnings.catch_warnings():
        # すべての警告を無視する設定
        warnings.simplefilter("ignore")
        use_legacy_library()

    print("\n=== コンテキスト外では再び警告が表示される ===")
    use_legacy_library()

if __name__ == "__main__":
    main()

python -W ignore your_script.py

python -W error your_script.py

import warnings
import some_legacy_lib  # 仮の古いライブラリ名とする

# 1. ライブラリ内で発生する DeprecationWarning だけ無視
warnings.filterwarnings(
    action="ignore",                          # 無視する
    category=DeprecationWarning,             # DeprecationWarningのみ
    module=r"^some_legacy_lib(\.|$)",        # 正規表現でモジュール名を指定
)

def main():
    # ここで old_api() が DeprecationWarning を出すと仮定
    some_legacy_lib.old_api()

if __name__ == "__main__":
    main()

python -W "ignore::DeprecationWarning" your_script.py

# すべての警告をエラーにする (推奨: CIなどで利用)
pytest -W error

# 特定カテゴリだけ無視する例
pytest -W "ignore::DeprecationWarning"

# pytest.ini
[pytest]
filterwarnings =
    # プロジェクト外ライブラリからの DeprecationWarning を無視
    ignore::DeprecationWarning:third_party_lib\.
    # 自分のコードの DeprecationWarning はエラーにする
    error::DeprecationWarning:my_project\.

import warnings

def risky_calculation(x, y):
    if y == 0:
        # 本来はエラーにしたい状況だが、既存挙動の都合で警告だけ出していると仮定
        warnings.warn(
            "0除算が発生します。結果は無限大になります。",
            category=RuntimeWarning,
            stacklevel=2,
        )
        return float("inf")
    return x / y

def main():
    # RuntimeWarning をエラーとして扱う
    warnings.filterwarnings("error", category=RuntimeWarning)

    try:
        result = risky_calculation(10, 0)
        print(result)
    except RuntimeWarning as e:
        print("RuntimeWarning を例外として捕捉:", e)

if __name__ == "__main__":
    main()

# conftest.py (pytest の共通設定ファイルとして利用する想定)
import warnings

def pytest_configure(config):
    # テスト実行時は、すべての Warning をエラー(例外)として扱う
    warnings.filterwarnings("error")

# 例: まずは DeprecationWarning だけ厳しくする
warnings.filterwarnings("error", category=DeprecationWarning)

import logging
import warnings
import sys

# ログ設定
logger = logging.getLogger("app")
logger.setLevel(logging.INFO)

handler = logging.StreamHandler(sys.stdout)
formatter = logging.Formatter(
    "[%(asctime)s] [%(levelname)s] %(name)s - %(message)s"
)
handler.setFormatter(formatter)
logger.addHandler(handler)

def log_warning_to_logger(message, category, filename, lineno, file=None, line=None):
    """
    warnings.showwarning と同じシグネチャの関数を定義し、
    ここで logging に流し込む。
    """
    logger.warning(
        "Warning (%s) at %s:%d: %s",
        category.__name__,
        filename,
        lineno,
        message,
    )

def setup_warning_logging():
    # デフォルトの showwarning を差し替える
    warnings.showwarning = log_warning_to_logger

def main():
    setup_warning_logging()

    # 適当に警告を発生させてみる
    warnings.warn("これはテスト用の警告です。", UserWarning)

if __name__ == "__main__":
    main()

import logging
import warnings
import sys

logger = logging.getLogger("app")
logger.setLevel(logging.INFO)
handler = logging.StreamHandler(sys.stdout)
formatter = logging.Formatter(
    "[%(asctime)s] [%(levelname)s] %(name)s - %(message)s"
)
handler.setFormatter(formatter)
logger.addHandler(handler)

def log_warning_with_levels(message, category, filename, lineno, file=None, line=None):
    """
    Warning カテゴリに応じてログレベルを変える例。
    """
    text = f"Warning ({category.__name__}) at {filename}:{lineno}: {message}"

    if issubclass(category, DeprecationWarning):
        # 非推奨は情報レベルで記録
        logger.info(text)
    elif issubclass(category, RuntimeWarning):
        # 実行時の危険な状態はエラーレベルで記録
        logger.error(text)
    else:
        # その他は通常の警告レベル
        logger.warning(text)

def setup_warning_logging():
    warnings.showwarning = log_warning_with_levels

def main():
    setup_warning_logging()

    warnings.warn("古いAPIを使用しています。", DeprecationWarning)
    warnings.warn("0除算が発生しました。", RuntimeWarning)
    warnings.warn("その他の注意喚起です。", UserWarning)

if __name__ == "__main__":
    main()

# mylib/old_module.py
import warnings

def old_api():
    warnings.warn(
        "old_api() は非推奨です。new_api() を使用してください。",
        category=DeprecationWarning,
        stacklevel=2,
    )
    # 旧来の処理…
    return "old"

def new_api():
    return "new"

# 例: 本番環境で DeprecationWarning を非表示、RuntimeWarning をエラー化
export PYTHONWARNINGS="ignore::DeprecationWarning,error::RuntimeWarning"
python app.py

# 例: GitHub Actions での pytest 実行 (抜粋)
- name: Run tests with strict warnings
  run: |
    export PYTHONWARNINGS="error::DeprecationWarning"
    pytest -W error

# フェーズ1: まずは表示だけ
export PYTHONWARNINGS="default"

# フェーズ2: DeprecationWarning だけ例外化
export PYTHONWARNINGS="error::DeprecationWarning"

# フェーズ3: すべての Warning を例外化 (一時的に)
export PYTHONWARNINGS="error"