Gibt es einen Grund, Code vor den Docstring in Python zu setzen?

Question

Ich sehe in einigen Leuten Python-Code, dass sie einige Prüfungen vor dem Docstring der Funktion einfügen; so etwas wie dieses:

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

Gibt es Fälle, in denen Sie sollten oder zu setzen vor dem docstring einen Code haben, etwas zu umgehen? Gibt es irgendwelche speziellen Fälle, in denen dieser Stil eingeführt werden musste oder es ist immer nur ein schlechtes Styling und muss daher auf so etwas fixiert werden?

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

Answer 1

Python holt nur einen docstring wenn es die erste Anweisung in der Funktion Körper. Putting-Code, bevor es die Zeichenfolge bedeutet nur ganz ignoriert werden:

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

Sie sollen nie dies tun, wenn Sie den docstring wollen keine Auswirkungen tatsächlich haben.

Vom Python reference documentation:

Ein Stringliteral erscheint als die erste Anweisung in der Funktion Körper in die __doc__ Attribut der Funktion und damit die docstring der Funktion umgewandelt wird.

Fett Hervorhebung meins.