Python でログ処理とデバッグを行う方法に関するベストプラクティスとヒント

王林

リリース： 2023-10-18 10:18:50

オリジナル

1518 人が閲覧しました

Python でログ処理とデバッグを行う方法に関するベストプラクティスとヒント

はじめに
大規模な Python アプリケーションを作成するときのログ処理とデバッグは非常に重要です。重要なのは、問題を追跡し、エラーを診断し、コードを改善するのに役立ちます。この記事では、Python でのログ処理とデバッグのベストプラクティスとテクニック、および具体的なコード例を紹介します。
標準ライブラリロギングの使用
Python には、ログ処理モジュールであるロギングが組み込まれており、ログレコードを処理するための包括的な API セットが提供され、非常に使いやすくなります。基本的なロギングの例を次に示します。

importlogging

ロガーを作成します

logger =logging.getLogger(__name__)
logger.setLevel (logging. DEBUG)

ファイルハンドラーを作成し、ログをファイルに書き込みます

file_handler =logging.FileHandler('app.log')
file_handler.setLevel(logging .DEBUG)

ログ形式を定義します

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

形式をハンドラーに適用します

file_handler.setFormatter(formatter)

ロガーにハンドラーを追加

logger.addHandler(file_handler)

コードを記述し、ログが格納されるロガーオブジェクトを呼び出します。記録する必要があります

logger.debug('これはデバッグレベルのログです')
logger.info('これは情報レベルのログです' )
logger.warning('これは警告レベルのログ')
logger.error('これはエラーレベルのログです')
logger.critical('これは重大レベルのログです')

上記のコードを実行した後、同じディレクトリに app.log という名前のファイルが表示されます。このファイルには、記録されたログ情報が含まれています。必要に応じて、ログレベル、ログ形式、ログの出力場所をカスタマイズできます。

デバッグにアサーションを使用する
ログに加えて、アサーションは非常に効果的なデバッグ手法でもあります。コードにいくつかのアサーションを追加して、プログラムのロジックとデータの正確さを検証できます。簡単な例を次に示します。

def dive(x, y):

assert y != 0, "除数不能为0"
return x / y

ログイン後にコピー

print(divide(10, 0))

この例では、除数が 0 の場合、アサーションは AssertionError 例外をトリガーしてスローします。例外情報に基づいてエラーの場所を簡単に特定できます。

pdb を使用した対話型デバッグ
Python 標準ライブラリには、強力な対話型デバッガー pdb も提供されています。コードに import pdb; pdb.set_trace() を挿入して、このコード行で pdb デバッグモードに入ります。ブレークポイントの設定、変数値の出力、コードのステップ実行などの一連の pdb コマンドを使用して、プログラムを 1 行ずつデバッグできます。以下に例を示します。

def add(a, b):

import pdb; pdb.set_trace()
return a + b

ログイン後にコピー

print(add(1, 2))

このコードを実行すると、プログラムが import pdb; pdb.set_trace() として実行されると、pdb デバッグモードに入ります。コマンドを入力して、変数の値を表示したり、コードをステップ実行したり、その他のデバッグ操作を実行したりできます。

高度なデバッグにはサードパーティライブラリを使用する
組み込みの pdb に加えて、より高度なデバッグの実行に役立つサードパーティライブラリがいくつかあります。最も人気のあるものの 1 つは py debugger (py debugger) で、リモートデバッグ、コードの編集、リロードなど、より豊富なデバッグ機能を提供できます。 pip を使用して py デバッガーをインストールできます: pip install py debugger。
結論
Python でのログ処理とデバッグは非常に重要であり、問題を追跡して修正し、プログラムの信頼性と安定性を向上させるのに役立ちます。 Python の組み込みロギングモジュール、アサーション、および PDB デバッガーを使用すると、デバッグ効率が向上し、問題を迅速に特定できます。さらに、サードパーティのライブラリを使用して、より高度なデバッグ操作を行うこともできます。これらの技術とツールをプロジェクトに適切に適用することは、開発作業に大きな助けとなります。

#参考資料: