是否有可能装饰/扩展Python标准日志系统,以便在调用日志方法时,它也记录调用它的文件和行号,或者可能是调用它的方法?
是否有可能装饰/扩展Python标准日志系统,以便在调用日志方法时,它也记录调用它的文件和行号,或者可能是调用它的方法?
可以查看logging文档中的格式化程序。具体来说,使用lineno
和pathname
变量。
%(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')
除了Seb的非常有用的回答之外,这里还有一个方便的代码片段,演示了使用合理格式的记录器的用法:
#!/usr/bin/env python
import logging
logging.basicConfig(format='%(asctime)s,%(msecs)03d %(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
import logging
# 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 ...
# A very naive sample of usage:
try:
logger.info('Sample of info log')
# your code here
except Exception as e:
logger.error(e)
不同于其他答案,这个方法会记录出现错误的完整文件路径和函数名。如果你的项目有多个模块,并且这些模块中分布了几个同名文件,那么这个方法就非常有用。2022-12-02:10:00:00,000 INFO [<stdin>:2 in function <module>] Sample of info log
2022-12-02:10:00:00,000 INFO [<full path>/logging_test_file.py:15 in function <module>] Sample of info log
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)
logging.debug("I am sent to standard out.")
debug_logging_example.py
的文件中,会产生以下输出:[debug_logging_example.py:14 - <module>() ] I am sent to standard out.
如果您想关闭日志记录,则可以将root.setLevel(logging.DEBUG)
注释掉。
对于单个文件(例如班级作业),与使用print()
语句相比,我发现这是一种更好的方法。它允许您在提交之前在一个地方关闭调试输出。
对于使用PyCharm或Eclipse PyDev的开发人员,以下内容将在控制台日志输出中生成指向日志语句源代码的链接:
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源文件超链接在Eclipse控制台中的应用,获取更详细的讨论和历史记录。
%(name)s
格式化记录器。您可以使用GetLogger函数在每个文件中指定不同的名称,当生成日志时,您将通过设置的名称知道来自哪个文件。
示例:
import logging
logging.getLogger("main")
logging.basicConfig(#filename=log_fpath,
level=log_level,
format='[%(asctime)s] src:%(name)s %(levelname)s:%(message)s',
handlers=[logging.FileHandler(log_fpath)])
pytest.ini
log_format = %(asctime)s %(levelname) %(message)s (%(pathname)s:%(lineno)s)
log_cli_level = DEBUG
stacklevel
属性,我将用一段代码进行演示:logging.basicConfig(
format=('%(asctime)s,%(msecs)03d %(levelname)-8s '
'[%(filename)s:%(lineno)d] %(message)s'),
level=logging.DEBUG,
datefmt='%H:%M:%S')
def my_log(*args, **kwargs):
indent = kwargs.pop('indent', 0)
msg = ' ' * indent + ' '.join([str(a) for a in args])
print(f'[MYLOG] {msg}')
return logging.info(msg, stacklevel=2, **kwargs)
{}
和...)d}
? - Charlie Parkerp%(process)s
是什么意思?特别是p和s。 - Charlie Parker