怎样使用Python脚本日志功能


Posted in Python onAugust 14, 2016

假设要开发一个自动化脚本工具,工程结构如下,Common这个package是框架功能的实现,Scripts目录是我们编写的测试用例脚本(请忽略其他不相关的目录)。

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

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

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

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

怎样使用Python脚本日志功能

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

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

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

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

怎样使用Python脚本日志功能

然后在另一个文件中(假设为script1.py)中import test,然后调用func方法:

怎样使用Python脚本日志功能

运行script1.py,结果为:

怎样使用Python脚本日志功能

可见,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

来测试一下,在脚本script1script2中分别编写下面代码:

from Common.log import *

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

分别运行两个脚本,控制台输出为:

怎样使用Python脚本日志功能

产生的日志文件:

怎样使用Python脚本日志功能

文件内容:

怎样使用Python脚本日志功能

好了,现在不管是在框架的其他文件中,或是在用户脚本中,都可以方便的通过logger类的日志接口记录日志。以上就是怎样使用Python脚本日志功能的全部内容,希望本文对大家学习python能有所帮助。

Python 相关文章推荐
python下载文件时显示下载进度的方法
Apr 02 Python
Python删除空文件和空文件夹的方法
Jul 14 Python
Python 内置函数complex详解
Oct 23 Python
Python中你应该知道的一些内置函数
Mar 31 Python
python实现员工管理系统
Jan 11 Python
Python wxPython库使用wx.ListBox创建列表框示例
Sep 03 Python
centos6.8安装python3.7无法import _ssl的解决方法
Sep 17 Python
python调用摄像头拍摄数据集
Jun 01 Python
python求质数列表的例子
Nov 24 Python
python颜色随机生成器的实例代码
Jan 10 Python
使用python创建Excel工作簿及工作表过程图解
May 27 Python
Python的这些库,你知道多少?
Jun 09 Python
Python函数的周期性执行实现方法
Aug 13 #Python
Python图算法实例分析
Aug 13 #Python
Python实现八大排序算法
Aug 13 #Python
详解Python如何获取列表(List)的中位数
Aug 12 #Python
Python抓取框架 Scrapy的架构
Aug 12 #Python
判断网页编码的方法python版
Aug 12 #Python
Python利用IPython提高开发效率
Aug 10 #Python
You might like
PHP+MySQL5.0中文乱码解决方法
2006/11/20 PHP
php ckeditor上传图片文件名乱码解决方法
2013/11/15 PHP
PHP下获取上个月、下个月、本月的日期(strtotime,date)
2014/02/02 PHP
php生成QRcode实例
2014/09/22 PHP
浅谈PHP表单提交(POST&amp;GET&amp;URL编/解码)
2017/04/03 PHP
Js中sort()方法的用法
2006/11/04 Javascript
jQuery1.6 正式版发布并提供下载
2011/05/05 Javascript
基于jquery封装的一个js分页
2011/11/15 Javascript
表单元素与非表单元素刷新区别详细解析
2013/11/06 Javascript
JavaScript设计模式之适配器模式介绍
2014/12/28 Javascript
jquery插件uploadify实现带进度条的文件批量上传
2015/12/13 Javascript
JS+html5 canvas实现的简单绘制折线图效果示例
2017/03/13 Javascript
JavaScript基础进阶之数组方法总结(推荐)
2017/09/04 Javascript
日期时间范围选择插件:daterangepicker使用总结(必看篇)
2017/09/14 Javascript
JavaScript模拟实现封装的三种方式及写法区别
2017/10/27 Javascript
js的继承方法小结(prototype、call、apply)(推荐)
2019/04/17 Javascript
深入理解Vue keep-alive及实践总结
2019/08/21 Javascript
如何阻止小程序遮罩层下方图层滚动
2019/09/05 Javascript
详解django中自定义标签和过滤器
2017/07/03 Python
快速查询Python文档方法分享
2017/12/27 Python
Django+Ajax+jQuery实现网页动态更新的实例
2018/05/28 Python
浅谈django orm 优化
2018/08/18 Python
matlab中二维插值函数interp2的使用详解
2020/04/22 Python
基于python爬取链家二手房信息代码示例
2020/10/21 Python
澳大利亚便宜的家庭购物网站:CrazySales
2018/02/06 全球购物
诗普兰迪官方网站:Splendid
2018/09/18 全球购物
Notino匈牙利:购买香水和化妆品
2019/04/12 全球购物
安德玛菲律宾官网:Under Armour菲律宾
2020/07/28 全球购物
shell程序中如何注释
2012/01/28 面试题
计算机应用专业推荐信
2013/11/13 职场文书
厂办主管岗位职责范本
2014/02/28 职场文书
审计专业自荐信范文
2014/04/21 职场文书
2015年重阳节主持词
2015/07/04 职场文书
幼儿园亲子活动感想
2015/08/07 职场文书
2016党员干部廉政准则学习心得体会
2016/01/20 职场文书
Python中的 No Module named ***问题及解决
2022/07/23 Python