Python スクリプトのロギング機能の使用

自動スクリプト ツールを開発するとします。プロジェクトの構造は次のとおりです。Common この package は、Scripts 関数の実装です。 code> ディレクトリは、私たちが作成したテスト スクリプトです (他の無関係なディレクトリは無視してください)。
Common这个package是框架功能的实现，Scripts目录是我们编写的测试用例脚本（请忽略其他不相关的目录）。

　　我们对日志功能的需求如下：

　　     1 为了便于日志的查看，每个脚本对应一个日志文件，日志文件以脚本的名字命名

　　     2 日志路径以及每个脚本保存的日志容量可以设置，比如设置为5MB，则超过后最老日志被自动覆盖

　　     3 日志功能要使用方便，减少与框架业务功能的耦合

　　

　　现在来逐一分析上述需求。

　　1 要实现每个脚本一个日志文件，则需要在日志模块中，根据用例脚本的名字来生成日志文件，这里的关键问题就是怎样在日志模块中获取用例脚本的名字。

　　获取文件名的常用方法有：os.getcwd(), sys.argv[0], __file__，来看下各种的作用：

　　先在一个文件(假设为test.py）中编写如下代码：

　　

　　然后在另一个文件中（假设为script1.py）中import test，然后调用func方法：

　　

　　运行script1.py，结果为：

　　

　　可见，os.getcwd()获取的是执行脚本的目录， sys.argv[0]是执行脚本的绝对路径名， __file__是被执行代码所在文件的绝对路径名。

　　现在就清楚了，我们应该用sys.argv[0]来获取执行脚本的名字，由于获取到的是绝对路径，需要做一点处理：sys.argv[0].split('/')[-1].split('.')[0]

　　2 日志容量问题，要实现超过容量后自动覆盖最老日志，采用logging中的RotatingFileHandler类即可，可以设置日志文件的大小，以及备份个数。

　　那么日志路径和容量配置放在哪里呢？让用户直接修改RotatingFileHandler的参数显然不好，最好不要让用户修改框架文件，用户只需调用接口写自己的脚本即可。

　　这里采用的方案是将配置信息写入一个文件，XML文件比较适合用来作为配置文件，用户通过修改XML文件来制定配置，日志模块从XML文件读取参数。

　　这里为了方便将XML文件放入Common下面，命名为config.xml，内容为：

<?xml version="1.0" encoding="utf-8"?>

<config>
  <!-- 日志保存路径 -->
  <logpath>E:\PythonLog</logpath>

  <!-- 每个脚本对应的日志文件大小，单位MB -->
  <logsize>8</logsize>

  <!-- 每个脚本保存的日志文件个数 -->
  <lognum>3</lognum>
</config>

　　读取XML文件内容，使用lxml库非常简单，后面再给出代码。

　　

　　3 日志功能要使用方便，减少与框架业务功能的耦合，最好就是对日志功能进行封装，只提供记录日志的接口即可。

　　日志接口采用类方法的形式就可以满足上述要求，用户只需要通过类调用日志记录接口，随处调用，使用方便，并且无需定义类实例，与框架业务没有耦合。　　　　

　　有了上述分析，我们来实现日志模块。

　　由于日志功能也是框架基础的一部分，我们将日志模块也放在Common这个package中，在Common下新建log.py文件，代码如下：

# coding: utf-8

from lxml import etree
import logging.handlers
import logging
import os
import sys

# 提供日志功能
class logger:
  # 先读取XML文件中的配置数据
  # 由于config.xml放置在与当前文件相同的目录下，因此通过 __file__ 来获取XML文件的目录，然后再拼接成绝对路径
  # 这里利用了lxml库来解析XML
  root = etree.parse(os.path.join(os.path.dirname(__file__), 'config.xml')).getroot()
  # 读取日志文件保存路径
  logpath = root.find('logpath').text
  # 读取日志文件容量，转换为字节
  logsize = 1024*1024*int(root.find('logsize').text)
  # 读取日志文件保存个数
  lognum = int(root.find('lognum').text)

  # 日志文件名：由用例脚本的名称，结合日志保存路径，得到日志文件的绝对路径
  logname = os.path.join(logpath, sys.argv[0].split('/')[-1].split('.')[0])

  # 初始化logger
  log = logging.getLogger()
  # 日志格式，可以根据需要设置
  fmt = logging.Formatter('[%(asctime)s][%(filename)s][line:%(lineno)d][%(levelname)s] %(message)s', '%Y-%m-%d %H:%M:%S')

  # 日志输出到文件，这里用到了上面获取的日志名称，大小，保存个数
  handle1 = logging.handlers.RotatingFileHandler(logname, maxBytes=logsize, backupCount=lognum)
  handle1.setFormatter(fmt)
  # 同时输出到屏幕，便于实施观察
  handle2 = logging.StreamHandler(stream=sys.stdout)
  handle2.setFormatter(fmt)
  log.addHandler(handle1)
  log.addHandler(handle2)

  # 设置日志基本，这里设置为INFO，表示只有INFO级别及以上的会打印
  log.setLevel(logging.INFO)

  # 日志接口，用户只需调用这里的接口即可，这里只定位了INFO, WARNING, ERROR三个级别的日志，可根据需要定义更多接口
  @classmethod
  def info(cls, msg):
    cls.log.info(msg)
    return

  @classmethod
  def warning(cls, msg):
    cls.log.warning(msg)
    return

  @classmethod
  def error(cls, msg):
    cls.log.error(msg)
    return

　　来测试一下，在脚本script1和script2

ログ機能の要件は次のとおりです:

1 ログの閲覧を容易にするために、各スクリプトはログファイルに対応し、ログファイルにはスクリプトの名前にちなんで名前が付けられます

2 ログ各スクリプトが保存するパスとログ 容量は設定可能、例えば5MBに設定すると、それを超えると古いログから自動的に上書きされます

3 ログ機能は使いやすく、連携を軽減できることフレームワークのビジネス機能🎜

🎜🎜 それでは、上記の要件を 1 つずつ分析してみましょう。 🎜🎜 1 各スクリプトのログ ファイルを実装するには、ユースケース スクリプトの名前に従ってログ ファイルを生成する必要があります。ログ モジュールでは、ここでの重要な問題は、ログ モジュール内のユース ケース スクリプトの名前を取得する方法です。 🎜🎜 ファイル名を取得する一般的なメソッドは次のとおりです: os.getcwd()、sys.argv[0]、__file__, さまざまな関数を見てみましょう: 🎜🎜まず、次のコードをファイル (test.py とします) に記述します: 🎜

🎜🎜次に、別のファイル (script1.py とします) の import test で、func メソッドを呼び出します。 🎜

🎜🎜 script1.py を実行すると、結果は次のようになります: 🎜

🎜🎜 os.getcwd() でスクリプトが実行されるディレクトリを取得し、 sys.argv[0] code> は実行されたスクリプトの絶対パス名、<code>__file__ は実行されたコードが配置されているファイルの絶対パス名です。 🎜🎜 これで、sys.argv[0] を使用して実行スクリプトの名前を取得する必要があることがわかりました。絶対パスが取得されるため、いくつかの処理を行う必要があります: sys。 .argv[ 0].split('/')[-1].split('.')[0]🎜🎜 2 ログ容量の問題 では、容量を超えたときに最も古いログを自動的に上書きするには、logging の RotatingFileHandler クラスを使用して、ログ ファイルのサイズを設定できます。個々のファイルの番号をバックアップします。 🎜🎜 では、ログのパスと容量の構成はどこにあるのでしょうか？ユーザーが RotatingFileHandler のパラメーターを直接変更できるようにするのは明らかに良くありません。ユーザーがインターフェイスを呼び出して独自のスクリプトを作成できるようにするのが最善です。 🎜🎜 ここで採用された解決策は、設定情報をファイルに書き込むことです。設定ファイルとしては、ユーザーが XML ファイルを変更することで設定を行い、ログ モジュールが XML ファイルからパラメータを読み取ることが考えられます。 🎜🎜 XML ファイルを Common の下に置きやすいように、config.xml という名前を付けます。内容は次のとおりです。 🎜🎜🎜

from Common.log import *

logger.info('This is info')
logger.warning('This is warning')
logger.error('This is error')

🎜🎜🎜 To read the content of XML ファイルを使用します。 lxml ライブラリは非常に単純で、コードは後で説明します。 🎜🎜 🎜🎜 3 ログ機能は使いやすく、フレームワークのビジネス機能との結合を減らすのがベストです。ロギング機能をカプセル化するため、ロギング用のインターフェイスのみが提供されます。 🎜🎜 ログインターフェイスはクラスメソッドの形で上記の要件を満たすことができ、ユーザーはクラスを通じてロギングインターフェイスを呼び出すだけで済み、どこでも呼び出すことができ、クラスを定義する必要はありません。インスタンスのみであり、フレームワーク ビジネスとのカップリングはありません。 🎜🎜 上記の分析を踏まえて、ログモジュールを実装してみましょう。 🎜🎜ロギング機能もフレームワークの基礎の一部であるため、ロギング モジュールも Common package に配置し、新しい Common >log.py ファイルのコードは次のとおりです: 🎜🎜🎜rrreee🎜🎜🎜 テストしてみましょう。スクリプト script1 とスクリプトに次のコードを記述します。それぞれ script2: 🎜 🎜🎜rrreee🎜🎜🎜 2 つのスクリプトをそれぞれ実行すると、コンソール出力は次のようになります: 🎜

生成されたログファイル:

ファイルの内容:

Python スクリプトのログ機能の使用に関するその他の記事については、PHP 中国語 Web サイトに注目してください。