PyLint消息:logging-format-interpolation

Question

对于以下代码:

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

pylint 产生以下警告:

记录格式插值(W1202):

在日志记录函数中使用%格式并将%参数作为参数传递当日志语句的调用形式为"logging.(format_string.format(format_args ...))"时使用.此类调用应使用%格式,但通过将参数作为参数传递,将插值留给日志记录功能.

我知道我可以关掉这个警告,但我喜欢理解它.我假设使用format()是打印输出语句的首选方法pylint.为什么记录器语句不适用？

Answer 1

对于logger语句来说并不是这样,因为它依赖于像string这样的前"%"格式,使用给予记录器调用的额外参数来提供此字符串的延迟插值.例如,而不是做:

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

你应该做

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

所以只有在实际发出消息时才会插入字符串.

使用时,您无法受益于此功能.format().

根据文档的优化部分logging:

消息参数的格式化将被推迟,直到无法避免.但是,计算传递给日志记录方法的参数也可能很昂贵,如果记录器只是丢弃您的事件,您可能希望避免这样做.

Answer 2

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

以下描述不是您问题的答案，但可以帮助人们。

如果您想使用 fstrings（文字字符串插值）进行日志记录，那么您可以使用 将其从.pylintrc文件中禁用disable=logging-fstring-interpolation，请参阅：相关问题和评论。

您也可以禁用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

对于旧的( logging-format-style=old)：

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

对于新的( logging-format-style=new)：

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

注意：即使您选择了选项，您也无法使用。.format()new

pylint 仍然对此代码给出相同的警告：

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

对于fstr ( logging-format-style=fstr)：

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

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

Answer 3

根据我的经验，比优化（对于大多数用例）延迟插值更令人信服的原因是它与 Sentry 等日志聚合器配合得很好。

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

Answer 4

下面的示例说明了为什么在日志记录中使用 %s 而不是 f 字符串更好。

>>> import logging
>>> logging.basicConfig(level=logging.INFO)
>>> logger = logging.getLogger('MyLogger')
>>>
>>> class MyClass:
...     def __init__(self, name: str) -> None:
...         self._name = name
...     def __str__(self) -> str:
...         print('GENERATING STRING')
...         return self._name
...
>>> c = MyClass('foo')
>>> logger.debug('Created: %s', c)
>>> logger.debug(f'Created: {c}')
GENERATING STRING

受到Python 3.7 日志记录的启发：f-strings 与 %。