遵循Google Python风格指南：函数文档字符串是否需含日志/打印语句？

首先得明确：按照Google Python风格指南的核心原则，普通的logging或者print语句完全不需要写进docstring里，咱们具体拆解下原因：

为什么不用写？ #

• Docstring的作用是给调用者看的核心契约：它要描述函数「做什么」「输入输出是什么」「有哪些明确的行为约束」，而内部的调试、监控实现（比如日志）属于细节，调用者根本不需要关心这些——人家用你的函数，只在乎能不能得到正确的返回值，至于你内部打不打debug日志，完全是你实现层面的事。
• 日志内容随时可能变：比如哪天你觉得logger.debug(bar)不够详细，改成logger.debug(f"Processing bar: {bar}")，或者干脆把这条日志删掉了，如果之前写进了docstring，你还得同步修改，平白增加维护成本。
• Print语句就更没必要了：print大多是临时调试用的，正式代码里甚至应该尽量替换成日志，本身就不属于函数的核心功能，更不该出现在docstring里。

那什么时候可以提日志？ #

只有一种例外情况：如果某些日志是函数对外承诺的固定行为（比如必须打审计日志、关键操作的记录是调用方依赖的），这时候可以在docstring的Notes或者Side Effects板块提一句，比如：

Note: 函数会在debug级别记录输入的原始字符串，用于调试追踪。

但这种情况非常少，普通的调试日志完全没必要加。

给你的示例函数优化后的Docstring #

def foo(bar):
    """
    给输入字符串追加固定后缀"blabla"

    Args:
        bar (str): 待处理的基础字符串
    Returns:
        str: 追加了"blabla"的结果字符串
    """
    fooed_bar = bar + "blabla"
    logger.debug(bar)
    return fooed_bar

内容的提问来源于stack exchange，提问作者Rutger Hofste