Pythonのloggingモジュールで色付きのログを出力する方法を現役エンジニアが解説【初心者向け】
初心者向けにPythonのloggingモジュールで色付きのログを出力する方法について現役エンジニアが解説しています。loggingモジュールとは、ログを記録するために使うPythonの標準モジュールです。色付きのログを出力するときには、サードパーティーのモジュールとしてcoloredlogsを使います。
テックアカデミーマガジンは受講者数No.1のプログラミングスクール「テックアカデミー」が運営。初心者向けにプロが解説した記事を公開中。現役エンジニアの方はこちらをご覧ください。 ※ アンケートモニター提供元:GMOリサーチ株式会社 調査期間:2021年8月12日~8月16日 調査対象:2020年8月以降にプログラミングスクールを受講した18~80歳の男女1,000名 調査手法:インターネット調査
Pythonのloggingモジュールで色付きのログを出力する方法について、TechAcademyのメンター(現役エンジニア)が実際のコードを使用して初心者向けに解説します。
そもそもPythonについてよく分からないという方は、Pythonとは何なのか解説した記事を読むとさらに理解が深まります。
なお本記事は、TechAcademyのオンラインブートキャンプPython講座の内容をもとに紹介しています。

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

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

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

お願いします!
目次
loggingモジュールとは
loggingモジュールとは、ログを記録するためのシステムを実装するときに使うPythonの標準モジュールです。
通常運用しているプログラムが正常に起動しているか、そして問題が起きているかを確認するには実行しているターミナルやコンソールからログを確認します。
loggingモジュールを使えばログを記録した時間、そしてログのレベル(デバッグやエラー等)とその内容を出力します。print文も使うことがありますが、これだとデバッグの種類が特定できないのと、サーバーのログ解析では何も出力されないことがあるので運用しているプログラムに使うには不十分です。
loggingモジュールはWebアプリを動かしているサーバーのログを記録するときに使われますが、Webフレームワークでもloggingモジュールを提供していることがあるのでそれでログを記録するのも一つの手だと思います。
色付きのログを出力する方法
色付きのログを出力するときには、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('クリティカルログです')
実行すると、以下のようにレベルに応じて色分けされたログが出力されると思います。
実は私も!?独学で損する人の特徴
「スクールは高いから独学で成功する」という気持ちの方は多いと思います。
もちろんその方が金額は低く抑えられるでしょう。
ただ
独学には向き不向きがあり、実はスクールが向いている人も大勢います。
そんな方のために参考として、
テックアカデミー卒業生がスクールを選んだ理由
をご紹介します。
- ・困って挫折しそうなときに、質問や相談できる相手がいる環境で学んでいきたいなと思った
- ・わかった気になっているだけだったので、自分を追い込む環境に置いた方がいいと感じた
- ・スクールのカリキュラムで市場に求められるスキルを学ぶべきと思った

少しでも当てはまる部分があれば、
スクールが向いているかもしれません。
お試しのつもりで、まずは一度
無料相談
に参加してみませんか?
現役エンジニア・デザイナーに何でも気軽に相談できる30分
を
すべて無料で
できます。
無理な勧誘は一切ない
ので、お気軽にご参加ください。
まとめ
今回はエラーログを色付きで出力させる方法を紹介しました。
Pythonではログ出力をするときは色が付きませんが、サードパーティモジュールを使えば簡単に色をつけてログ出力をさせることができます。単色のサーバーログがぐっと見やすくなるのでぜひ使ってみてください。
監修してくれたメンター
メンター三浦
モバイルゲームを運用している会社のエンジニアをしています。趣味でWEB開発やクラウドコンピューティングもやっており、ソフトもハードもなんでもやります。 TechAcademyジュニアではPythonロボティクスコースを担当しています。好きな言語はPython, Node.js。 |

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

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

分かりました。ありがとうございます!
TechAcademyでは、初心者でもPythonを使った人工知能(AI)や機械学習の基礎を習得できるオンラインブートキャンプPython講座を開催しています。
挫折しない学習方法を知れる説明動画や、現役エンジニアとのビデオ通話とチャットサポート、学習用カリキュラムを体験できる無料体験も実施しているので、ぜひ参加してみてください。

プログラミングを独学していて、このように感じた経験はないでしょうか?
- ・調べてもほしい情報が見つからない
- ・独学のスキルが実際の業務で通用するのか不安
- ・目標への学習プランがわからず、迷子になりそう
テックアカデミーでは、このような
学習に不安を抱えている方へ、現役エンジニア講師とマンツーマンで相談できる機会を無料で提供
しています。
30分間、オンラインでどんなことでも質問し放題です。
「受けてよかった」と感じていただけるよう
厳しい試験を通過した講師
があなたの相談に真摯に向き合います。
「ただ気になることを相談したい」
「漠然としているがプロの話を聞いてみたい」
こんな気持ちでも大丈夫です。
無理な勧誘は一切ありません
ので、まずはお気軽にご参加ください。
※体験用のカリキュラムも無料で配布いたします。(1週間限定)