Python: docstrings và gõ chú thích

Question

Có một chức năng như:

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

Tôi muốn sử dụng một docstring NumPy giống như sau:

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

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

Lưu ý rằng:

• Tôi không muốn chỉ định kiểu tham số nữa.
• Tôi không muốn chỉ định loại trả lại.
• Tôi muốn tiện ích đó có thể đọc các loại chú thích (và viết chúng trong tài liệu HTML được tạo).

Có phần mở rộng Sphinx hỗ trợ điều đó không? Bạn có đề xuất một cú pháp khác không?

Answer 1

Tiện ích mở rộng tiêu chuẩn là autodoc. Tiện ích mở rộng Napoleon hỗ trợ Google- và NumPy-phong cách docstrings.