简单的 Python 日志记录 - 以及关于依赖项、信任和复制/粘贴代码的题外话

标题图片 (C) Tai Kedzierski

转到片段

这篇文章是有观点的。

Python 的默认日志设置没有帮助；它与我们所期望的“包含电池”的方法背道而驰。

从有用的日志消息中，我想知道何时、什么级别以及什么信息。我可能想要它在控制台上，我可能想要它在文件中。

这应该很简单 - 但在 Python 中，我每次都不得不查找如何创建具有自定义文件处理和字符串格式的完整日志记录实用程序。

它应该像logger = getLogger()一样简单，但是出于某种未知原因的默认行为是提供完全无用的格式，并且没有明智的默认值的简写。

或者我需要下载一些来源不明的 pip 包，相信它没有被名称劫持，或者进行一些混淆的泄露。我想到了 2016 年的 leftpad 事件，以及 2024 年的 Revival 劫持攻击，这在不同的回购系统中本质上是相同的问题。

事实上，任何没有命名空间的用户存储库都容易受到此攻击：Node 的 npm、Python 的 pip、Arch 的 AUR、Canonical 的 snap ...仅举几个允许用户上传任何内容的例子。即使命名空间也不能保证信任——我遇到过通过这些渠道分发软件的项目，不是通过项目的名称，而是通过一些任意的开发人员的绰号，这引起了人们对软件包真实性的怀疑。我在上一篇关于在工作环境中使用syncthing的文章中给出了关于如何决定是否信任来源的思考过程。

用户控制的存储库中的外部依赖关系是魔鬼，只有当问题的解决方案很复杂时才应该考虑。一般来说，简单的解决方案应该直接存在于代码库中 - 最好是自己编写的，但有时问题只是会进入“足够麻烦”的空间，使依赖感觉既合理又令人讨厌。

答案：写一次，将其存放在 Github gist 或您自己的“有用片段”存储库中。复制并粘贴。

复制粘贴？呃！

“复制和粘贴”代码可能会给任何经验丰富的编码人员敲响警钟。 “不要重复自己”、“使用包管理器”、“编写一次，随处更新”。这些都是良好的本能，但根据具体情况，了解何时复制粘贴是更好。

在这种情况下，要求是避免不必要的外部依赖以获得简单需求的简单解决方案。在 leftpad 中，与此迷你记录器一样，所需的代码片段是 short 且 易于理解 ；如果需要的话重新实现也没有什么损失。它也获得了适当的许可（是的，它可能只是一个片段；但是仍然值得推荐，以确保您复制的内容确实是允许的。小心复制随机的代码块。）

迷你记录器片段

我在下面包含了一个迷你记录器实用程序的代码片段，它允许以最少的配置进行一次调用：

from minilog import SimpleLogger

LOG = SimpleLogger(name="mylog", level=SimpleLogger.INFO)

LOG.info("this is useful")

哪个打印到控制台：

2024-11-20 10:43:44,567 | INFO | mylog : this is useful

迷你记录器代码

将其复制到项目中的 minilogger.py 文件中。 Tada - 不需要外部依赖。如果不受影响，它将永远保持不变。没有名字劫持。没有供应链注入。

# For completeness:
# (C) Tai Kedzierski - Provided under MIT license. Go wild.

import logging

class SimpleLogger(logging.Logger):
    FORMAT_STRING = '%(asctime)s | %(levelname)s | %(name)s : %(message)s'
    ERROR = logging.ERROR
    WARN = logging.WARN
    INFO = logging.INFO
    DEBUG = logging.DEBUG

    def __init__(self, name="main", fmt_string=FORMAT_STRING, level=logging.WARNING, console=True, files=None):
        logging.Logger.__init__(self, name, level)
        formatter_obj = logging.Formatter(fmt_string)

        if files is None:
            files = []
        elif isinstance(files, str):
            files = [files]

        def _add_stream(handler:logging.Handler, **kwargs):
            handler = handler(**kwargs)
            handler.setLevel(level)
            handler.setFormatter(formatter_obj)
            self.addHandler(handler)

        if console is True:
            _add_stream(logging.StreamHandler, stream=sys.stdout)

        for filepath in files:
            _add_stream(logging.FileHandler, filename=filepath)

麻省理工学院的许可证本质上允许你“用它做任何你想做的事”。没有任何附加条件。

我们到了。一个简单的日志？

以上是简单的 Python 日志记录 - 以及关于依赖项、信任和复制/粘贴代码的题外话的详细内容。更多信息请关注PHP中文网其他相关文章！