【Python】ロギングのコンフィグで環境設定- fileConfig(), dictConfig()

ここではPythonを使ったロギングの環境設定(config)について見ていこうと思います。

ロギングは３種類の方法で設定することができます。

まず、設定メソッドを呼び出すPythonコードを明示的に使って、ロガー、ハンドラ、フォーマッタを生成する方法で、これまでにすでにやってきた方法です。

残りの2つは、ロギングの設定ファイルを作り、それをfileConfig()関数を使って読み込む方法と、設定情報を辞書型で記述し、それをdictConfig()関数に渡す方法があります。

著者, Vinay Sajip ,. このページはチュートリアルです。レファレンスやロギングクックブックは、その他のリソースを参照してください。基本 logging チュートリアル: logging は、あるソフトウェアが実行されてい...

ここではこのfileConfig()とdictConfig()を使った方法を見ていきましょう。

fileConfig()でiniファイルを読み込む
dictConfig()に辞書型データの設定を渡す
まとめ

fileConfig()でiniファイルを読み込む

ロギングの設定ファイルを作り、それをfileConfig()関数を使って読み込む方法から見ていきましょう。

まず、メインの処理を行うコードを次のように書いてみます。ここでのファイル名はlogging_lesson.pyとしています。

import logging.config


logging.config.fileConfig('logging.ini')
logger = logging.getLogger(__name__)

logger.debug('debug message')
logger.info('info message')
logger.warning('warning message')
logger.error('error message')
logger.critical('critical message')

これまでのログ出力のコードとほぼ同じようなコードです。

違うところはlogging.confgをインポートしているところと、fileConfig()でlogging.iniファイルを読み込んでいるところです。

ここでfileConfig()で読み込むlogging.iniファイルを作って設定を記述してみます。ここでは公式ドキュメントにある設定を利用しています。

[loggers]
keys=root,simpleExample

[handlers]
keys=consoleHandler

[formatters]
keys=simpleFormatter

[logger_root]
level=WARNING
handlers=consoleHandler

[logger_simpleExample]
level=DEBUG
handlers=consoleHandler
qualname=simpleExample
propagate=0

[handler_consoleHandler]
class=StreamHandler
level=DEBUG
formatter=simpleFormatter
args=(sys.stdout,)

[formatter_simpleFormatter]
format=%(asctime)s - %(name)s - %(levelname)s - %(message)s

このファイルと同じ作業ディレクトリに保存して、ターミナルで実行してみます。

logging.iniの最終行で記述しているフォーマットで結果が表示されます。

logging.iniの部分のコード表示は、スペースの都合で途中までになっていますが、結果はWARNINGまでの表示となっています。これは、logging.iniの[logger_root]をlevel=WARNINGと指定し、メインのコードはgetLogger(__name__)としているからです。

ここで、logging.iniの[logger_simpleExample]がlevel=DEBUGとなっているので、メインのコードをgetLogger(simpleExample)にしてみます。

import logging.config


logging.config.fileConfig('logging.ini')
logger = logging.getLogger('simpleExample')

logger.debug('debug message')
logger.info('info message')
logger.warning('warning message')
logger.error('error message')
logger.critical('critical message')

実行するとこうなります。

結果がDEBUGまで表示されているのがわかります。

dictConfig()に辞書型データの設定を渡す

設定情報を辞書型で記述し、dictConfig()関数に渡す方法を見ていきます。

上記のlogging.iniに記述していた設定情報をdict型で記述し、dictConfig()に次のように渡します。

import logging.config


logging.config.dictConfig({
    'version': 1,
    'formatters': {
        'simpleFormatter': {
            'format': '%(asctime)s - %(name)s - %(levelname)s - %(message)s'
        }
    },
    'handlers': {
        'consoleHandler': {
            'class': 'logging.StreamHandler',
            'formatter': 'simpleFormatter',
            'level': logging.DEBUG
        }
    },
    'root': {
        'handlers': ['consoleHandler'],
        'level': logging.WARNING
    },
    'loggers': {
        'simpleExample': {
            'handlers': ['consoleHandler'],
            'level': logging.DEBUG,
            'propagate': 0
        }
    }
})

logger = logging.getLogger('simpleExample')

logger.debug('debug message')
logger.info('info message')
logger.warning('warning message')
logger.error('error message')
logger.critical('critical message')

実行するとこうなります。

DEBUGまで表示されているのがわかります。

logging.iniファイルで設定するよりも、このdictConfig()で記述した設定ファイルを使って開発することが多いそうです。

まとめ

ここではPythonを使ったロギングの環境設定(config)について扱いました。

ロギングの設定には、既に別のところで扱ったように、設定メソッドを呼び出すPythonコードを明示的に使って、ロガー、ハンドラ、フォーマッタを生成してきましたが、ここでは、ロギングの設定ファイルを作ってfileConfig()関数を使って読み込む方法と、設定情報を辞書型で記述し、それをdictConfig()関数に渡す方法を見てきました。

fileConfig()を使ってlogging.iniファイルなどを利用するよりも、dictConfig()で記述した設定ファイルを使って開発する場面が多いようなので、このあたりも念頭に置いておくと良いでしょう。