1、日志的重要性
日志的作用非常重要,日志可以记录用户的操作、程序的异常,还可以为数据分析提供依据,日志的存在意义就是为了能够在程序在运行过程中记录错误,方便维护和调试,能够快速定位出错的地方,减少维护成本。每个程序员都应该知道,不是为了记录日志而记录日志,日志也不是随意记的。要实现能够只通过日志文件还原整个程序执行的过程,达到能透明地看到程序里执行情况,每个线程、每个过程到底执行到哪的目的。日志就像飞机的黑匣子一样,应当能够复原异常的整个现场乃至细节!
常见日志记录方式
print()
最常见的是把输出函数 print()
当作日志记录的方式,直接打印各种提示信息,常见于个人练习项目里,通常是懒得单独配置日志,而且项目太小不需要日志信息,不需要上线,不需要持续运行,完整的项目不推荐直接打印日志信息,现实中也几乎没有人这么做。
自写模板
在不少小项目里面可以看到作者自己写了一个日志模板,通常利用 print() 或者 sys.stdout 稍微封装一下即可实现简单的日志输出,这里的 sys.stdout 是 Python 中的标准输出流,print() 函数是对 sys.stdout 的高级封装,当我们在 Python 中打印对象调用 print(obj) 时候,事实上是调用了 sys.stdout.write(obj+'\n'),print() 将内容打印到了控制台,然后追加了一个换行符 \n。
自写日志模板适合比较小的项目,可以按照自己的喜好编写模板,不需要太多复杂配置,方便快捷,但是这种记录日志的方式并不是很规范,有可能你自己觉得阅读体验不错,但是别人在接触你的项目的时候往往需要花费一定的时间去学习日志的逻辑、格式、输出方式等,比较大的项目同样不推荐这种方法。
一个简单的自写日志模板举例:
日志模板 log.py:
import sys
import traceback
import datetime
def getnowtime():
return datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S")
def _log(content, level, *args):
sys.stdout.write("%s - %s - %s\n" % (getnowtime(), level, content))
for arg in args:
sys.stdout.write("%s\n" % arg)
def debug(content, *args):
_log(content, 'DEBUG', *args)
def info(content, *args):
_log(content, 'INFO', *args)
def warn(content, *args):
_log(content, 'WARN', *args)
def error(content, *args):
_log(content, 'ERROR', *args)
def exception(content):
sys.stdout.write("%s - %s\n" % (getnowtime(), content))
traceback.print_exc(file=sys.stdout)
调用日志模块:
import log
log.info("This is log info!")
log.warn("This is log warn!")
log.error("This is log error!")
log.debug("This is log debug!")
people_info = {"name": "Bob", "age": 20}
try:
gender = people_info["gender"]
except Exception as error:
log.exception(error)
日志输出:
2021-10-19 09:50:58 - INFO - This is log info!
2021-10-19 09:50:58 - WARN - This is log warn!
2021-10-19 09:50:58 - ERROR - This is log error!
2021-10-19 09:50:58 - DEBUG - This is log debug!
2021-10-19 09:50:58 - 'gender'
Traceback (most recent call last):
File "D:/python3Project/test.py", line 18, in <module>
gender = people_info["gender"]
KeyError: 'gender'
Logging
在一个完整的项目中,大多数人都会引入专门的日志记录库,而 Python 自带的标准库 logging 就是专门为日志记录而生的,logging 模块定义的函数和类为应用程序和库的开发实现了一个灵活的事件日志系统。由标准库模块提供日志记录 API 的关键好处是所有 Python 模块都可以使用这个日志记录功能。所以,你的应用日志可以将你自己的日志信息与来自第三方模块的信息整合起来。
logging 模块虽然强大,但是其配置也是比较繁琐的,在大型项目中通常需要单独初始化日志、配置日志格式等等,K哥在日常使用中通常都会对 logging 做如下的封装写法,使日志可以按天保存,保留15天的日志,可以配置是否输出到控制台和文件,如下所示:
# 实现按天分割保留日志
import os
import sys
import logging
from logging import handlers
PARENT_DIR = os.path.split(os.path.realpath(__file__))[0] # 父目录
LOGGING_DIR = os.path.join(PARENT_DIR, "log") # 日志目录
LOGGING_NAME = "test"