包括登录docstring？

Question

我正在根据googlepython风格guide编写python函数，我想知道是否应该在docstring中包含日志记录或打印语句？记录器在前面的语句中启动。你知道吗

def foo(bar):
    """ This function will foo the .. out of bar

    Args:
        bar (string) : bar

    Returns:
       fooed_bar (string) : bla bla
    """

    fooed_bar = bar + "blabla"
    logger.debug(bar)    
    return fooed_bar 

Answer 1

• 它不会添加任何关于函数的有用信息，但是会把docstring弄乱。你知道吗
• 它不影响函数的调用方式或返回的值，即与API无关。你知道吗
• 它要求您使函数体与docstring保持同步，尤其是您记录的内容在调试过程中可能会经常更改，因此几乎可以保证docstring和实际代码会发生分歧。
  • 更多元：你应该记录什么和为什么，而不是如何。你知道吗

你唯一应该提及的关于日志记录的事情是，它是否有某种相关性，例如：

Note: when the logging level is set to 'debug', this function may produce a ginormous amount of logging data; beware.

除此之外，这似乎是完全多余的。你知道吗