Pythonのロガーの設定をどうすればいいのか。

を元に模索してみた。今使っている設定すべてのファイルの先頭にはこれだけ書いておく。いわばログ入力の設定。

from logging import getLogger
logger = getLogger(__name__)

これとは別に、ログ出力の設定を一か所だけ記述する。メインの始まるところがいいんでないか。他のライブラリをimportするより前に書きたいということもあるだろうからその辺はお好みで。

if __name__=='__main__':
    # defaultのlogレベルではdebug出ないよ
    logger.debug('before')

    from logging import basicConfig, DEBUG
    basicConfig(
        level=DEBUG,
        datefmt='%H:%M:%S',
        format='%(asctime)s[%(levelname)s][%(name)s.%(funcName)s] %(message)s'
    )

    # 以降出る
    logger.debug('after')

以上で、デフォルトのログ設定を使ってログが画面に出力される。デフォルトのログ設定とは上記のプログラムでは以下のようにログが流れる。

logger.debug('message')
  |
  v            propagate(親にメッセージが伝搬する)
logger(__name__) -> logger('')
  handlers[           handlers[
  ]                     Streamhandler -> コンソール画面
                      ]

pythonのロガーは木構造 getLogger(__name__) で得たロガーは __name__ という名前になり、'' という名のロガーが親になる。

print(getLogger(''))
<RootLogger root (WARNING)>

というように '' ロガーはルートロガーである。どういう基準で親子が決まるかというと名前ベースで '' がすべての親、その子 'hoge' 、さらにその子 'hoge.fuga' というように . をセパレータとしたパス名で決めているぽい。 getLogger(__name__) という風にロガーを得れば、とりあえず getLogger('') の子孫になる。

15.7. logging — Logging facility for Python — Python 2.7.18 documentation

https://docs.python.org/2/library/logging.html#logger-objects

さらにログは木構造を親に向かって遡りながら、通り道にあったhandlerに出力される。なのですべての親になるルートロガーにひとつだけhandlerをセットしておけばよい。

print(logger.handlers)
[]

ルートロガーにはデフォルトでStreamHandlerがセットされている

print(getLogger('').handlers)
[<StreamHandler <stderr> (NOTSET)>]

親に向かって流すかどうかを設定するには以下のようにする。

親に流さない

logger.propagate=False

前知識としてこれくらいあればカスタマイズできる。出力のカスタマイズ基本的に、ルートロガーに好みのフォーマットやハンドラを設定することになると思う。デフォルトのStreamHandlerを削除する

getLogger('').handlers.clear()

Formatを変えよう

サーバー風の時刻付きのフォーマットとか。

デフォルトのハンドラを得る

handler=getLogger('').handlers[0]

もしくは自前で作る

from logging import StreamHandler
handler=StreamHandler()
getLogger('').addHandler(handler)

from logging import Formatter
formatter=Formatter('%(name)s => %(asctime)s [%(levelname)s] %(message)s')
handler.setFormatter(formatter)

使える変数は、LogRecord attributesらしい。

15.7. logging — Logging facility for Python — Python 2.7.18 documentation

https://docs.python.org/2/library/logging.html#logrecord-attributes

日付のカスタマイズは？

basicConfig(
       datefmt='%H:%M:%S',
       format='%(asctime)s[%(levelname)s] %(name)s.%(funcName)s => %(message)s')
       )

色付きにしよう

おされなコンソール

Pythonで色つきログを - rainbow_logging_handler をPyPIにリリースしました

from rainbow_logging_handler import RainbowLoggingHandler
handler = RainbowLoggingHandler(sys.stderr)
getLogger('').addHandler(handler)

QtのWidgetに出力する StackOverflowとかで見つけた気がするがとりあえず。

gpibcs/qplaintexteditlogger.py at master · buha/gpibcs

A graphical GPIB command sequencer. Contribute to buha/gpibcs development by creating an account on GitHub.

https://github.com/buha/gpibcs/blob/master/qplaintexteditlogger.py

gpibcs/qplaintexteditlogger.py at master · buha/gpibcs

class QPlainTextEditLogger(logging.Handler):
    '''
    Logger
    '''
    def __init__(self):
        super().__init__()
        self.widget=None

    def set_widget(self, widget):
        self.widget = widget
        self.widget.setReadOnly(True)

    def emit(self, record):

        msg = self.format(record)
        if not self.widget:
            print(msg)
            return

        if not msg.endswith("\n"):
            msg+="\n"
        self.widget.textCursor().movePosition(QtGui.QTextCursor.Start)
        self.widget.textCursor().insertText(msg)
        #self.widget.insertPlainText(msg)

    def write(self, m):
        pass

handler=QPlainTextEditLogger()
getLogger('').addHandler(handler)

ログレベル別に色を付けてみる

    def emit(self, record):
        msg = self.format(record)
        if not self.widget:
            print(msg)
            return

        if record.levelno == DEBUG:
            msg = f'<font color="gray">{msg}</font><br>'
        elif record.levelno == WARNING:
            msg = f'<font color="orange">{msg}</font><br>'
        elif record.levelno == ERROR:
            msg = f'<font color="red">{msg}</font><br>'
        else:
            msg = f'{msg}<br>'

        self.widget.textCursor().movePosition(QtGui.QTextCursor.Start)
        self.widget.textCursor().insertHtml(msg)