Pythonのloggingモジュールで色付きのログを出力する方法を現役エンジニアが解説【初心者向け】

初心者向けにPythonのloggingモジュールで色付きのログを出力する方法について現役エンジニアが解説しています。loggingモジュールとは、ログを記録するために使うPythonの標準モジュールです。色付きのログを出力するときには、サードパーティーのモジュールとしてcoloredlogsを使います。

TechAcademyマガジンは受講者数No.1のオンラインプログラミングスクールTechAcademy [テックアカデミー]が運営。初心者向けに解説した記事を公開中。現役エンジニアの方はこちらをご覧ください。

Pythonのloggingモジュールで色付きのログを出力する方法について、TechAcademyのメンター(現役エンジニア)が実際のコードを使用して初心者向けに解説します。

そもそもPythonについてよく分からないという方は、Pythonとは何なのか解説した記事を読むとさらに理解が深まります。

 

なお本記事は、TechAcademyのオンラインブートキャンプPython講座の内容をもとに紹介しています。

 

田島悠介

今回は、Pythonに関する内容だね!

大石ゆかり

どういう内容でしょうか?

田島悠介

Pythonのloggingモジュールで色付きのログを出力する方法について詳しく説明していくね!

大石ゆかり

お願いします!

 

目次

 

loggingモジュールとは

loggingモジュールとは、ログを記録するためのシステムを実装するときに使うPythonの標準モジュールです。

通常運用しているプログラムが正常に起動しているか、そして問題が起きているかを確認するには実行しているターミナルやコンソールからログを確認します。

loggingモジュールを使えばログを記録した時間、そしてログのレベル(デバッグやエラー等)とその内容を出力します。print文も使うことがありますが、これだとデバッグの種類が特定できないのと、サーバーのログ解析では何も出力されないことがあるので運用しているプログラムに使うには不十分です。

loggingモジュールはWebアプリを動かしているサーバーのログを記録するときに使われますが、Webフレームワークでもloggingモジュールを提供していることがあるのでそれでログを記録するのも一つの手だと思います。

[PR] Pythonで挫折しない学習方法を動画で公開中

色付きのログを出力する方法

色付きのログを出力するときには、loggingのメソッドではできませんが、サードパーティーのモジュールとしてcoloredlogsというモジュールを使って設定することで色付きのモジュールを出力します。

coloredlogsは以下のpipコマンドでインストールできます。

pip install coloredlogs

インストールできたら色付きのログを出力させる方法を紹介します。まずは、loggingのgetLoggerメソッドを使ってログを出力するときのオブジェクトを定義します。このとき、引数にはモジュール名を指定して実行しているコードのログと分かるようにします。

今回はモジュール名にappと指定します。

logging.getLogger('app')

続けて、ログ出力の設定を行います。単に色付きのログを出力したいだけであれば、coloredlogsのinstallメソッドを実行するだけで出力設定まで完了します。引数にはログを出力させたい最低レベルを指定したり、ログ出力のフォーマットを指定できます。デフォルトではデバッグが出力されないので出力されるように設定をします。

coloredlogs.install(level='DEBUG')

あとは、logging.debugのようにログのレベルのメソッドと出力するメッセージを指定すると画像のように色付きのメッセージが出力されます。(諸事情により、一部出力を伏せています)

実際に書いてみよう

それでは実際に色付きのログを出力させてみましょう。

以下のサンプルコードを任意のフォルダに保存します。

import logging
import coloredlogs

# 出力の設定
logger = logging.getLogger('app')
coloredlogs.install(level='DEBUG')

# ログを出力
logger.debug('デバッグログです')
logger.info('インフォログです')
logger.warning('ワーニングログです')
logger.error('エラーログです')
logger.critical('クリティカルログです')

実行すると、以下のようにレベルに応じて色分けされたログが出力されると思います。

まとめ

今回はエラーログを色付きで出力させる方法を紹介しました。

Pythonではログ出力をするときは色が付きませんが、サードパーティモジュールを使えば簡単に色をつけてログ出力をさせることができます。単色のサーバーログがぐっと見やすくなるのでぜひ使ってみてください。

監修してくれたメンター

メンター三浦

モバイルゲームを運用している会社のエンジニアをしています。趣味でWEB開発やクラウドコンピューティングもやっており、ソフトもハードもなんでもやります。

TechAcademyジュニアではPythonロボティクスコースを担当しています。好きな言語はPython, Node.js。

 

大石ゆかり

内容分かりやすくて良かったです!

田島悠介

ゆかりちゃんも分からないことがあったら質問してね!

大石ゆかり

分かりました。ありがとうございます!

 

TechAcademyでは、初心者でも最短4週間でPythonを使った人工知能(AI)や機械学習の基礎を習得できるオンラインブートキャンプPython講座を開催しています。

挫折しない学習方法を知れる説明動画や、現役エンジニアとのビデオ通話とチャットサポート、学習用カリキュラムを体験できる無料体験も実施しているので、ぜひ参加してみてください。