14.5.2 基本的な使い方

バージョン 2.4 で変更された仕様: 以前は basicConfig はキーワード引数をとりませんでした

logging パッケージには高い柔軟性があり、その設定にたじろぐこともあるでしょう。そこでこの節では、 logging パッケージを簡単に使う方法もあることを示します。

上のスクリプトを実行すると、以下のようなメッセージを目にするでしょう:

ここではロガーを特定しなかったので、システムはルートロガーを使っています。デバッグメッセージや情報メッセージは表示されませんが、これはデフォルトのルートロガーが WARNING 以上の重要度を持つメッセージしか処理しないように設定されているからです。メッセージの書式もデフォルトの設定に従っています。出力先は sys.stderr で、これもデフォルトの設定です。重要度レベルやメッセージの形式、ログの出力先は、以下の例のように簡単に変更できます:

import logging

logging.basicConfig(level=logging.DEBUG,
                    format='%(asctime)s %(levelname)s %(message)s',
                    filename='/tmp/myapp.log',
                    filemode='w')
logging.debug('A debug message')
logging.info('Some information')
logging.warning('A shot across the bows')

ここでは、basicConfig() メソッドを使って、以下のような出力例になる (そして/tmp/myapp.log に書き込まれる) ように、デフォルト設定を変更しています:

今度は、重要度が DEBUG か、それ以上のメッセージが処理されました。メッセージの形式も変更され、出力はコンソールではなく特定のファイルに書き出されました。

出力の書式化には、通常の Python 文字列に対する初期化を使います - 3.6.2 節を参照してください。書式化文字列は、以下の指定子 (specifier) を常にとります。指定子の完全なリストについては Formatter のドキュメントを参照してください。

書式	説明
`%(name)s`	ロガーの名前 (ログチャネル) の名前です。
`%(levelname)s`	メッセージのログレベル (`'DEBUG'`, `'INFO'`, `'WARNING'`, `'ERROR'`, `'CRITICAL'`) です。
`%(asctime)s`	`LogRecord` が生成された際の時刻を、人間が読み取れる形式にしたものです。デフォルトでは、 ``2003-07-08 16:49:45,896'' のような形式 (コンマの後ろはミリ秒) です。
`%(message)s`	ログメッセージです。

以下のように、追加のキーワードパラメタ datefmt を渡すと日付や時刻の書式を変更できます:

import logging

logging.basicConfig(level=logging.DEBUG,
                    format='%(asctime)s %(levelname)-8s %(message)s',
                    datefmt='%a, %d %b %Y %H:%M:%S',
                    filename='/temp/myapp.log',
                    filemode='w')
logging.debug('A debug message')
logging.info('Some information')
logging.warning('A shot across the bows')

日付を書式化する文字列は、strftime() の要求に従います - time モジュールを参照してください。

コンソールやファイルではなく、別個に作成しておいたファイル類似オブジェクトにログを出力したい場合には、basicConfig() に stream キーワード引数で渡します。stream とfilename の両方の引数を指定した場合、stream は無視されるので注意してください。

状況に応じて変化する情報ももちろんログ出力できます。以下のように、単にメッセージを書式化文字列にして、その後ろに可変情報の引数を渡すだけです:

import logging

logging.basicConfig(level=logging.DEBUG,
                    format='%(asctime)s %(levelname)-8s %(message)s',
                    datefmt='%a, %d %b %Y %H:%M:%S',
                    filename='/temp/myapp.log',
                    filemode='w')
logging.error('Pack my box with %d dozen %s', 5, 'liquor jugs')