Pythonでdocstringの前にコードを置く理由は何ですか？

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

それは関数本体内最初の文であればPythonは唯一のドキュメンテーション文字列をピックアップします。それは文字列がちょうど完全に無視されることを意味する前にコードを置く：あなたはドキュメンテーション文字列が実際にどんな効果を持つようにしたい場合は

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

あなたははこれを行うべきではありません。 Python reference documentationから

：関数本体で

文字列リテラルとして登場する最初の文は、関数の__doc__属性、したがって、関数のドキュメンテーション文字列に変換されます。

太字強調。