PyLint消息:logging-format-interpolation

对于以下代码:

logger.debug('message: {}'.format('test'))

pylint产生以下警告:

logging-format-interpolation (W1202):

在日志函数中使用%格式，并将%参数传递为 当日志语句的调用形式为 “日志记录。(format_string.format (format_args…)”。这样的 调用应该使用%格式，而将插值留给

. log函数通过传递参数作为参数

我知道我可以关闭这个警告，但我想了解它。我假设使用format()是Python 3中输出语句的首选方式。为什么记录器语句不是这样?

135273 次浏览
小开
最佳答案

记录器语句不是这样的，因为它依赖于以前的“%”格式，例如字符串，使用提供给记录器调用的额外参数来提供该字符串的惰性插值。例如，而不是做:

logger.error('oops caused by %s' % exc)

你应该这样做

logger.error('oops caused by %s', exc)

因此，只有在消息实际发出时，字符串才会被插入。

当使用.format()时，你不能从这个功能中获益。

根据logging文档的优化部分:

消息参数的格式化将被推迟，直到无法避免为止。但是，计算传递给日志记录方法的参数的开销也很大，如果日志记录器将丢弃您的事件，您可能希望避免这样做。

小开

也许这个时间的差异可以帮助你。

下面的描述并不能回答你的问题，但它可以帮助人们。

如果你想使用fstrings(字面字符串插值)来记录日志，那么你可以通过disable=logging-fstring-interpolation在.pylintrc文件中禁用它，参见:相关问题及评论。

你也可以禁用logging-format-interpolation。

对于pylint 2.4:

在.pylintrc文件中有3个日志样式选项:old， new， fstr

fstr选项添加在2.4和删除在2.5

来自.pylintrc文件(v2.4)的描述:

[LOGGING]


# Format style used to check logging format string. `old` means using %
# formatting, `new` is for `{}` formatting,and `fstr` is for f-strings.
logging-format-style=old

for 老 (logging-format-style=old):

foo = "bar"
self.logger.info("foo: %s", foo)

for 新 (logging-format-style=new):

foo = "bar"
self.logger.info("foo: {}", foo)
# OR
self.logger.info("foo: {foo}", foo=foo)

请注意:即使你选择了new选项，你也可以使用不。

pylint仍然为这段代码提供相同的警告:

self.logger.info("foo: {}".format(foo))  # W1202
# OR
self.logger.info("foo: {foo}".format(foo=foo))  # W1202

for fstr (logging-format-style=fstr):

foo = "bar"
self.logger.info(f"foo: {foo}")

就我个人而言，我更喜欢fstr选项，因为pep - 0498。

小开

根据我的经验，相比优化(对于大多数用例)，延迟插值的一个更有说服力的理由是，它可以很好地与Sentry等日志聚合器一起使用。

考虑一条“用户登录”日志消息。如果您将用户插入到格式字符串中，那么您将拥有与用户数量相同的不同日志消息。如果您使用像这样的惰性插值，日志聚合器可以更合理地将其解释为具有一堆不同实例的相同日志消息。

小开

可能是几年之后，但有一天我不得不处理这个问题，我简单地说;只是在记录器之前格式化了字符串。

message = 'message: {}'.format('test')
logger.debug(message)

这样就不需要从日志中更改任何设置，如果以后想要更改为正常打印，也不需要更改格式或代码。

小开
< p >“logging-format-interpolation (W1202)“;是pylint的另一个错误建议(就像许多来自pep8的建议一样)。 f字符串被描述为慢vs %，但你检查过吗? 使用f-string vs % >的500_000旋转日志记录;F-string:23.01秒，%:25.43秒。

所以使用f-string记录日志比%快。 当您查看日志记录源代码时:log.error() ->self.logger._log()→self.makeRecord()→self._logRecordFactory()→类LogRecord() >Home made等价于format()

代码:

import logging
import random
import time


loops = 500_000
r_fstr = 0.0
r_format = 0.0


def test_fstr():
global loops, r_fstr
for i in range(0, loops):
r1 = time.time()
logging.error(f'test {random.randint(0, 1000)}')
r2 = time.time()
r_fstr += r2 - r1


def test_format():
global loops, r_format
for i in range(0 ,loops):
r1 = time.time()
logging.error('test %d', random.randint(0, 1000))
r2 = time.time()
r_format += r2 - r1


test_fstr()
test_format()
print(f'Logging f-string:{round(r_fstr,2)} sec. , %:{round(r_format,2)} sec.')

提交答案