日志¶

参考：source

日志是对软件执行时所发生事件的一种追踪方式。软件开发人员对他们的代码添加日志调用，借此来指示某事件的发生。一个事件通过一些包含变量数据的描述信息来描述（比如：每个事件发生时的数据都是不同的）。开发者还会区分事件的重要性，重要性也被称为等级或 严重性。有一个好的日志实践，能让开发调试流程更顺畅，出现问题能更快速精准定位。日志模块自2.3版本开始便是Python标准库的一部分。它被简洁的描述在 PEP 282。

日志的两个目的：

诊断日志 记录与应用程序操作相关的日志。例如，用户遇到的报错信息，可通过搜索诊断日志获得上下文信息。
审计日志 为商业分析而记录的日志。从审计日志中，可提取用户的交易信息，并结合其他用户资料构成用户报告或者用来优化商业目标。

打印（Print）¶

当需要在命令行应用中显示帮助文档时， print 是一个相对于日志更好的选择。而在其他时候，日志总能优于 print ，理由如下：

日志事件产生的日志记录，包含清晰可用的诊断信息，如文件名称、路径、函数名和行号等。
包含日志模块的应用，默认可通过根记录器对应用的日志流进行访问，除非您将日志过滤了。
可通过 logging.Logger.setLevel() 方法有选择地记录日志，或可通过设置 logging.Logger.disabled 属性为 True 来禁用。

日志级别¶

日志等级可以分为5个，从低到高分别是:

DEBUG：程序调试bug时使用
INFO ：程序正常运行时使用
WARNING：程序未按预期运行时使用，但并不是错误，如:用户登录密码错误
ERROR ：程序出错误时使用，如:IO操作失败
CRITICAL ：特别严重的问题，导致程序不能再继续运行时使用，如:磁盘空间为空，一般很少使用。

日志信息输出到控制台的示例代码:

import logging
logging.debug('这是⼀个debug级别的⽇志信息')
logging.info('这是⼀个info级别的⽇志信息')
logging.warning('这是⼀个warning级别的⽇志信息')
logging.error('这是⼀个error级别的⽇志信息')
logging.critical('这是⼀个critical级别的⽇志信息')

默认的是WARNING等级，当在WARNING或WARNING之上等级的才记录日志信息。但是无法使用 debug 和 info 输出正常日志信息。想要使用所有logging等级功能，应该设置 level=logging.DEBUG。

配置日志¶

使用**INI**格式文件：
- 优点: 使用 logging.config.listen() 函数监听socket，可在运行过程中更新配置
- 缺点: 通过源码控制日志配置较少（例如子类化定制的过滤器或记录器）。
- 使用**字典**或**JSON**格式文件：
- 优点: 除了可在运行时动态更新，在Python 2.6之后，还可通过 json 模块从其它文件中导入配置。
- 缺点: 很难通过源码控制日志配置。
使用**源码**：
- 优点: 对配置绝对的控制。
- 缺点: 对配置的更改需要对源码进行修改。

通过INI文件进行配置的例子¶

我们假设文件名为 logging_config.ini 。关于文件格式的更多细节，请参见日志指南中的日志配置部分。

[loggers]
keys=root

[handlers]
keys=stream_handler

[formatters]
keys=formatter

[logger_root]
level=DEBUG
handlers=stream_handler

[handler_stream_handler]
class=StreamHandler
level=DEBUG
formatter=formatter
args=(sys.stderr,)

[formatter_formatter]
format=%(asctime)s %(name)-12s %(levelname)-8s %(message)s

然后在源码中调用 logging.config.fileConfig() 方法：

import logging
from logging.config import fileConfig

fileConfig('logging_config.ini')
logger = logging.getLogger()
logger.debug('often makes a very good meal of %s', 'visiting tourists')

通过字典进行配置的例子¶

Python 2.7中，您可以使用字典实现详细配置。PEP 391 包含了一系列字典配置的强制和非强制的元素。

import logging
from logging.config import dictConfig

logging_config = dict(
    version = 1,
    formatters = {
        'f': {'format':
              '%(asctime)s  %(name)-12s  %(levelname)-8s  %(message)s'}
        },
    handlers = {
        'h': {'class': 'logging.StreamHandler',
              'formatter': 'f',
              'level': logging.DEBUG}
        },
    root = {
        'handlers': ['h'],
        'level': logging.DEBUG,
        },
)

dictConfig(logging_config)

logger = logging.getLogger()
logger.debug('often makes a very good meal of %s', 'visiting tourists')

通过源码直接配置的例子¶

import logging

logger = logging.getLogger()
handler = logging.StreamHandler()
formatter = logging.Formatter(
        '%(asctime)s  %(name)-12s  %(levelname)-8s  %(message)s')
handler.setFormatter(formatter)
logger.addHandler(handler)
logger.setLevel(logging.DEBUG)

logger.debug('often makes a very good meal of %s', 'visiting tourists')

logger文件示例¶

# logger.py
# 创建Logger对象实例logger，然后其他模块只需要 from logger import logger
# 通过logger.info(""), logger.warning(str)等方法调用
# # logger.info("Houston, we have a %s", "interesting problem", exc_info=1)

def create_logger(log_file, level=logging.DEBUG):  
    # logging.basicConfig函数对日志的输出格式及方式做相关配置  
  logging.basicConfig(level=level,  
  format='%(asctime)s - %(filename)s[line:%(lineno)d] - %(levelname)s: %(message)s')  
  log = logging.getLogger()  
  log.setLevel(logging.INFO)  

  if not os.path.exists(os.path.dirname(log_file)):  
        os.makedirs(os.path.dirname(log_file))  
  # 创建一个handler，用于写入日志文件  
  fh = logging.FileHandler(log_file, mode='w')  
  fh.setLevel(level)  
  # 定义handler的输出格式  
  formatter = logging.Formatter("%(asctime)s - %(filename)s[line:%(lineno)d] - %(levelname)s: %(message)s")  
  fh.setFormatter(formatter)  

  # 将log添加到handler里面  
  log.addHandler(fh)  
  return log

log_file_dir = 'logs'
if not os.path.exists(log_file_dir):  
    os.makedirs(log_file_dir)  
now_time_format = time.strftime('%Y-%m-%d-%H-%M', time.localtime(time.time()))  
log_file = os.path.join(log_file_dir, now_time_format + '.log')
logger = create_logger(log_file)