Python: Docstrings und Typenannotationen

Question

mit einer Funktion wie:

def foo(x: int) -> float: 
    return float(x) 

Ich möchte eine NumPy artige docstring wie folgt verwenden:

def foo(x: int) -> float: 
    """ 
    Parameters 
    ---------- 
    x 
     Input parameter 

    Returns 
    ------- 
    The output value. 
    """ 
    return float(x) 

Beachten Sie, dass:

• Ich möchte den Parametertyp nicht erneut angeben.
• Ich möchte den Rückgabetyp nicht erneut angeben.
• Ich möchte diese Erweiterung in der Lage sein, die annotierten Typen zu lesen (und sie in die generierte HTML-Dokumentation schreiben).

Gibt es eine Sphinx-Erweiterung, die das unterstützt? Würden Sie eine andere Syntax empfehlen?

Answer 1

Standarderweiterung ist autodoc. Napoleon Erweiterung unterstützt Google- und NumPy-Stil Docstrings.