有什么理由将代码放在 Python 中的文档字符串之前？

Question

我在其他人的 Python 代码中看到他们在函数的文档字符串之前粘贴了一些检查；像这样：

def func(args):
  if x_version != 1.7:
    return
  """docstring is here"""
  # function body code
  # ...

是否存在您应该或必须在文档字符串之前放置一些代码以解决任何问题的情况？是否有任何特殊情况必须引入这种样式，或者它总是只是一种不好的样式，因此必须固定为这样的东西？

def func(args):
  """docstring is here"""
  if x_version != 1.7:
    return
  # function body code
  # ...

Answer 1

如果是函数体中的 first 语句，Python 只会选择一个文档字符串。将代码放在它之前意味着该字符串将被完全忽略：

>>> def func(args):
...   if x_version != 1.7:
...     return
...   """docstring is here"""
...
>>> func.__doc__ is None
True

如果您希望文档字符串真正发挥作用，您应该从不这样做。

来自Python reference documentation：

作为函数主体中的第一条语句出现的字符串文字被转换为函数的__doc__ 属性，从而转换为函数的文档字符串。

我的大胆强调。