先生と生徒の会話形式で理解しよう

生徒

「Pythonでプログラムの動作を記録する方法ってありますか？あとで見返したいんですが…」

先生

「それなら、loggingモジュールを使うといいですね。ログという記録を自動で残せるんです。」

生徒

「エラーとか動作の流れを、ファイルに保存できたりしますか？」

先生

「はい、できますよ。では、初心者の方でもわかるように、基本からloggingモジュールの使い方を説明していきますね。」

-

1. ログファイルとは？loggingモジュールを使う理由

ログファイルとは、プログラムが実行されたときの情報やエラーなどを記録するファイルのことです。ログという言葉は、「記録」や「日誌」という意味で使われます。

Pythonでは、logging（ロギング）という標準モジュールを使うことで、簡単にログを記録できます。標準モジュールとは、Pythonに最初から入っている機能で、追加インストールなしで使えます。

2. loggingモジュールの基本的な使い方

まずは、ログをファイルに書き込むための基本的なコードを紹介します。これでログファイルが作成され、メッセージが自動で記録されます。


import logging

logging.basicConfig(filename='app.log', level=logging.INFO)

logging.info('プログラムが開始されました')

basicConfigはログの設定をするための関数で、filenameで保存するファイル名を指定します。levelは記録する重要度のレベルです。

3. ログレベルとは？種類と使い分け

ログには、「どれくらい重要な情報か」を表すログレベルがあります。以下は主な種類です。

DEBUG（デバッグ）：開発中の細かい情報
INFO（インフォ）：一般的な実行情報
WARNING（ワーニング）：注意が必要な情報
ERROR（エラー）：問題が起きたとき
CRITICAL（クリティカル）：重大なエラー

たとえば、ログレベルをWARNINGにすると、INFOやDEBUGの情報は記録されません。重要な情報だけ残したい場合に便利です。

4. 実際に複数のログを出力してみよう

それぞれのログレベルを使って、ログファイルに複数のメッセージを記録してみましょう。


import logging

logging.basicConfig(filename='sample.log', level=logging.DEBUG)

logging.debug('デバッグ情報')
logging.info('通常の情報')
logging.warning('警告が出ました')
logging.error('エラーが発生しました')
logging.critical('致命的な問題が起きました')

このコードを実行すると、"sample.log"というファイルが作成され、その中に各ログメッセージが追記されます。

-

5. ログファイルの出力例

ログファイルには次のような形で記録されます。


    DEBUG:root:デバッグ情報
    INFO:root:通常の情報
    WARNING:root:警告が出ました
    ERROR:root:エラーが発生しました
    CRITICAL:root:致命的な問題が起きました

rootはログの出力元を示すもので、特に設定しないとこう表示されます。日時を表示したいときは、設定を追加すれば対応可能です。

6. ログに日付や時間を表示するには？

ログに時間や日付を含めたい場合は、formatというオプションを使います。以下のように設定します。


import logging

logging.basicConfig(
    filename='time.log',
    level=logging.INFO,
    format='%(asctime)s - %(levelname)s - %(message)s'
)

logging.info('ログに時間を追加しました')

%(asctime)sは日付と時刻、%(levelname)sはレベル名、%(message)sはメッセージ本文を表します。

7. コンソールにもログを出力する方法

ログをファイルだけでなく、画面（コンソール）にも表示したい場合は、StreamHandlerを使います。


import logging

logger = logging.getLogger()
logger.setLevel(logging.INFO)

file_handler = logging.FileHandler('both.log')
stream_handler = logging.StreamHandler()

logger.addHandler(file_handler)
logger.addHandler(stream_handler)

logger.info('ファイルと画面に出力されます')

この設定をすると、ログはファイルと画面の両方に出力され、プログラムの状態をリアルタイムで確認できます。

8. よくあるエラーと対策

初心者がloggingモジュールを使うときに、よくあるミスを紹介します。

ログが出力されない：
ログレベルの設定が原因のことが多いです。INFOにしているのにdebug()だけ使っていませんか？
同じメッセージが2回表示される：
basicConfigとaddHandlerを両方使っていると、重複出力されることがあります。
ファイルが開けない：
すでにファイルを別のソフトで開いていると、ログが書き込めないことがあります。

9. loggingモジュールを使うメリットとは？

print()関数でも動作の確認はできますが、loggingモジュールを使うと次のような利点があります。

ログファイルとして記録が残る
ログレベルで重要度を区別できる
エラーの原因をあとから確認しやすくなる
コンソールとファイル両方に出力できる

Pythonのログ機能は、初心者でも使いやすいように設計されています。ぜひ積極的に活用して、プログラムの動作を記録する習慣をつけましょう。

まとめ

この記事では、Pythonのloggingモジュールを使ってログファイルを記録する方法を、初めて学ぶ人でも理解しやすいように流れに沿ってふり返りました。ログという仕組みは、プログラムがどのように動いたのか、どこで問題が起きたのかをあとから確認するための大切な情報であり、開発の規模に関わらず役立つ考え方です。とくにPythonに標準で用意されているloggingモジュールは、設定によって必要な情報だけを記録したり、重要度ごとにログの種類を分けたりできる柔軟な機能を持っています。初心者にとってはとっつきやすく、慣れてくると応用の幅が大きい特徴があります。まず、ログファイルとは何かという基本から始めました。ログはプログラムの動作やエラーを記録する情報であり、日誌のように後から振り返るためのものです。loggingモジュールを使うと、文字列をファイルに書き込むだけでなく、ログレベルを設定して詳細な情報を自動的に整理しながら保存することができます。レベルにはDEBUG、INFO、WARNING、ERROR、CRITICALといった種類があり、重要度に応じて必要な情報だけを記録できます。例えばINFOレベルに設定すれば、日常的な処理の状況をそのまま残せますし、DEBUGレベルにすれば開発段階の詳しい情報まで確認できます。また、basicConfigを使った基本設定では、ファイル名、ログレベル、フォーマットなどをまとめて指定することで、ログをすぐに記録できるようになります。初めてログを扱う場合でも、数行のコードでログファイルを作ることができます。さらに、STREAMハンドラーを追加する方法も紹介され、ファイルに記録するだけでなく、画面にもログを同時に表示できることを学びました。開発中のリアルタイムな動作確認にとても便利で、複雑な処理の追跡にも役立ちます。フォーマット機能では、%(asctime)sを使うことでログに日時を追加でき、どのタイミングでエラーや動作が起きたのかをはっきり把握できます。プログラムが長時間動く環境では、日時が記録されていないと不便なので、format設定は特に重要です。プログラムの記録が、単なるメッセージの列ではなく、時系列で整理された「読みやすい情報」に変わる点はloggingモジュールの大きな魅力だと言えます。さらに、複数のログメッセージを試すサンプルコードでは、さまざまなログレベルを出力してログファイルに蓄積される様子を確認しました。ログは追記されるため、実行を重ねるごとにファイルが増えていきます。開発や調査が進むなかで、過去の履歴を追跡できる利点があります。逆に、ファイルが開かれていると書き込めなかったり、basicConfigとaddHandlerを重複して使うと同じメッセージが複数回記録されてしまうなど、よくあるエラーについても触れました。こうした注意点を理解しておくことで、ログ関連の問題を避けながらスムーズに開発を進めることができます。最後に、loggingモジュールを使うメリットとして、単なるprint文とは異なりログレベルで重要度を管理しながら記録を残せることや、後から原因を追跡しやすくなることなどが挙げられます。開発を続けていくなかで、ログを活用する習慣を身につければ、問題が発生したときの調査や動作確認が格段に効率よくなります。Pythonではloggingが標準で利用できるため、初心者でも気軽に取り組めるうえ、応用次第でさまざまな用途に対応できる柔軟性があります。

ログをまとめて出力するサンプルプログラム

ここでは、記事全体の内容をふり返りながら、実際に複数のログレベルを使い分けて出力する復習のコードを紹介します。ファイルと画面の両方に記録したい場合にも応用しやすい形にしています。


import logging

logger = logging.getLogger('example')
logger.setLevel(logging.DEBUG)

file_handler = logging.FileHandler('review.log')
stream_handler = logging.StreamHandler()

formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(message)s')

file_handler.setFormatter(formatter)
stream_handler.setFormatter(formatter)

logger.addHandler(file_handler)
logger.addHandler(stream_handler)

logger.debug('復習用のデバッグログです')
logger.info('まとめのサンプルコードが出力されています')
logger.warning('設定の確認が必要な部分があります')
logger.error('処理中に何らかの問題が発生しました')
logger.critical('重大なエラーが検出されました')

logger.getLoggerで新しいロガーを作成し、ファイルハンドラーとストリームハンドラーを追加することで、ログを複数の出力先に振り分けています。フォーマット設定を加えれば日時とレベル付きで読みやすいログになり、初心者でも実務に近い形で管理できるようになります。今回のまとめを通して、loggingモジュールがPythonの開発における強力な道具であることを実感していただけるはずです。

先生と生徒の振り返り会話

生徒「ログってただの記録だと思っていたけれど、レベルを分けたり、ファイルと画面の両方に出したりできるのは便利ですね。」

先生「そうなんです。loggingモジュールは使いこなせばとても強力で、プログラムの動作を細かく記録できます。あとで原因を調べたいときには欠かせませんよ。」

生徒「format設定で時間が付くだけでも読みやすさが全然変わりますね。実務でも役に立ちそうです。」

先生「その通りです。時間やレベルがあるだけで、どのタイミングで何が起きたのかひと目で分かりますし、原因の追跡も簡単になります。」

生徒「間違えて重複出力されたり、レベルの設定で記録されなかったりするのも気をつけるポイントなんですね。」

先生「はい、よくあるミスなので覚えておくと安心です。基本を押さえればloggingはとても扱いやすくなりますよ。」

生徒「今回の内容を使って、自分のプログラムにもログを入れてみます！」

先生「すばらしいですね。ログを活用すれば開発がもっと楽になりますから、ぜひいろいろ工夫してみてください。」