如何在Python中记录源文件名和行号

时间:2009-02-10 16:29:23

标签: python logging

是否可以装饰/扩展python标准日志记录系统,以便在调用日志记录方法时,它还会记录文件以及调用它的行号或调用它的方法?

5 个答案:

答案 0 :(得分:163)

当然,请在日志记录文档中查看formatters。特别是lineno和pathname变量。

  

%(路径名)s 发出日志记录调用的源文件的完整路径名(如果可用)。

     

%(filename)s 路径名的文件名部分。

     

%(module)s 模块(文件名的名称部分)。

     

%(funcName)s 包含日志记录调用的函数名称。

     

%(lineno)d 发出日志记录调用的源行号(如果可用)。

看起来像这样:

formatter = logging.Formatter('[%(asctime)s] p%(process)s {%(pathname)s:%(lineno)d} %(levelname)s - %(message)s','%m-%d %H:%M:%S')

答案 1 :(得分:49)

Seb's very useful answer之上,这是一个方便的代码段,以合理的格式演示记录器使用情况:

#!/usr/bin/env python
import logging

logging.basicConfig(format='%(asctime)s,%(msecs)d %(levelname)-8s [%(filename)s:%(lineno)d] %(message)s',
    datefmt='%Y-%m-%d:%H:%M:%S',
    level=logging.DEBUG)

logger = logging.getLogger(__name__)
logger.debug("This is a debug log")
logger.info("This is an info log")
logger.critical("This is critical")
logger.error("An error occurred")

生成此输出:

2017-06-06:17:07:02,158 DEBUG    [log.py:11] This is a debug log
2017-06-06:17:07:02,158 INFO     [log.py:12] This is an info log
2017-06-06:17:07:02,158 CRITICAL [log.py:13] This is critical
2017-06-06:17:07:02,158 ERROR    [log.py:14] An error occurred

答案 2 :(得分:1)

对于使用PyCharm或Eclipse pydev的开发人员,以下内容将在控制台日志输出中生成指向log语句源的链接:

import logging, sys, os
logging.basicConfig(stream=sys.stdout, level=logging.DEBUG, format='%(message)s | \'%(name)s:%(lineno)s\'')
log = logging.getLogger(os.path.basename(__file__))


log.debug("hello logging linked to source")

有关更长的讨论和历史记录,请参见Pydev source file hyperlinks in Eclipse console

答案 3 :(得分:1)

# your imports above ...


logging.basicConfig(
    format='%(asctime)s,%(msecs)d %(levelname)-8s [%(pathname)s:%(lineno)d in 
    function %(funcName)s] %(message)s',
    datefmt='%Y-%m-%d:%H:%M:%S',
    level=logging.DEBUG
)

logger = logging.getLogger(__name__)

# your classes and methods below ...
# An naive Sample of usage:
try:
    logger.info('Sample of info log')
    # your code here
except Exception as e:
    logger.error(e)

与其他答案不同,这将记录文件的完整路径以及可能发生错误的函数名称。如果您的项目中有多个模块,并且在这些模块中分布了多个具有相同名称的文件,这将很有用。

答案 4 :(得分:0)

以上述方式构建,将调试日志发送到标准输出:

import logging
import sys

root = logging.getLogger()
root.setLevel(logging.DEBUG)

ch = logging.StreamHandler(sys.stdout)
ch.setLevel(logging.DEBUG)
FORMAT = "[%(filename)s:%(lineno)s - %(funcName)20s() ] %(message)s"
formatter = logging.Formatter(FORMAT)
ch.setFormatter(formatter)
root.addHandler(ch)

然后,如果您要关闭评论root.setLevel(logging.DEBUG)

对于单个文件(例如,类分配),我发现这是比使用print()语句更好的方法。在此允许您在提交调试输出之前在一个位置关闭调试输出。