Python 3 ipucu yazabilir Doküman oluşturmak için kullanılabilir mi?

Question

Biz python docstring'ini kullanarak fonksiyon parametre türlerini belirtebilir:

piton 3'te

fun1(a) 
    Parameters : a (int) – an input. 
    Returns : the input integer. 
    Return type: int 

, türleri tip ipucu gösterilebilir:

f1 için

def f1(a): 
    """ 
    :param a: an input. 
    :type a: int 
    :return: the input integer. 
    :rtype: int 
    """ 
    return a 

, AutoDoc aşağıdaki belgeyi üretir yanı: biz AutoDoc çalıştırdığınızda

def f2(a: int): 
    """ 
    :param a: an input. 
    :return: the input integer. 
    :rtype: int 
    """ 
    return a 

, bu de parametre bildiriminde tarafından tipini koyar, ancak scription:

f2(a: int) 
    Parameters : a – an input. 
    Returns : the input integer. 
    Return type: int 

o ek açıklama yerine docstring'ini kullanılarak f1 olarak belgeleri oluşturmak mümkün olabilir mi? Python 3.6 kullanıyorum. Teşekkür ederim!

Answer 1

Henüz, Sphinx'in farkında olduğumdan henüz bunu desteklemiyor. Bir yorumda atıfta bulunulan hata, konumlarının değil, ipuçlarının temsiliyle ilgilidir.

Şu anda sizin için bu konuda ilgilenen bir Sphinx uzantısı var biliyorum, sphinx-autodoc-typehints denir. Bunu şu an için kullanabilirsin.