怎样使用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 相关文章推荐
在Django的URLconf中进行函数导入的方法
Jul 18 Python
Python的Django应用程序解决AJAX跨域访问问题的方法
May 31 Python
asyncio 的 coroutine对象 与 Future对象使用指南
Sep 11 Python
Python生成随机密码的方法
Jun 16 Python
Python编程之微信推送模板消息功能示例
Aug 21 Python
对TensorFlow的assign赋值用法详解
Jul 30 Python
浅谈Python 多进程默认不能共享全局变量的问题
Jan 11 Python
python使用Plotly绘图工具绘制散点图、线形图
Apr 02 Python
python3.7环境下安装Anaconda的教程图解
Sep 10 Python
在pycharm中为项目导入anacodna环境的操作方法
Feb 12 Python
Python计算信息熵实例
Jun 18 Python
python 判断字符串当中是否包含字符(str.contain)
Jun 01 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
DC四月将推出百页特刊漫画 纪念小丑诞生80周年
2020/04/09 欧美动漫
PHP 类商品秒杀计时实现代码
2010/05/05 PHP
php格式化时间戳显示友好的时间实现思路及代码
2014/10/23 PHP
PHP生成随机密码方法汇总
2015/08/27 PHP
PHP中addslashes()和stripslashes()实现字符串转义和还原用法实例
2016/01/07 PHP
thinkphp5 URL和路由的功能详解与实例
2017/12/26 PHP
html下载本地
2006/06/19 Javascript
js下通过getList函数实现分页效果的代码
2010/09/17 Javascript
用方法封装javascript的new操作符(一)
2010/12/25 Javascript
Js 导出table内容到Excel的简单实例
2013/11/19 Javascript
javaScript对文字按照拼音排序实现代码
2013/12/27 Javascript
Bootstrap每天必学之表单
2015/11/23 Javascript
js面向对象实现canvas制作彩虹球喷枪效果
2016/09/24 Javascript
微信小程序 wxapp导航 navigator详解
2016/10/31 Javascript
微信小程序 引入es6 promise
2017/04/12 Javascript
Vue.js tab实现选项卡切换
2017/05/16 Javascript
jQuery实现拖动效果的实例代码
2017/06/25 jQuery
vue中配置mint-ui报css错误问题的解决方法
2017/10/11 Javascript
浅谈vue,angular,react数据双向绑定原理分析
2017/11/28 Javascript
基于Koa(nodejs框架)对json文件进行增删改查的示例代码
2019/02/02 NodeJs
JavaScript隐式类型转换代码实例
2020/05/29 Javascript
[14:20]刀塔大凶女神互压各路奇葩屌丝
2014/05/16 DOTA
Python的Bottle框架的一些使用技巧介绍
2015/04/08 Python
解决Python运行文件出现out of memory框的问题
2018/12/03 Python
python绘制随机网络图形示例
2019/11/21 Python
python 数据分析实现长宽格式的转换
2020/05/18 Python
html5如何及时更新缓存文件(js、css或图片)
2013/06/24 HTML / CSS
国贸专业个人求职信分享
2013/12/04 职场文书
旅游专业职业生涯规划范文
2014/01/13 职场文书
关于人生的感言
2014/01/17 职场文书
国际贸易毕业生求职信
2014/07/20 职场文书
2014年卫生工作总结
2014/11/27 职场文书
铁路安全反思材料
2014/12/24 职场文书
社会实践活动总结
2015/02/05 职场文书
Mysql服务添加 iptables防火墙策略的方案
2021/04/29 MySQL
vscode远程免密登入Linux服务器的配置方法
2022/06/28 Servers