Pierwsze docstring z funkcji

114

Mam następujących funkcji:Pierwsze docstring z funkcji

def my_func(): 
    """My docstring is both funny and informative""" 
    pass

Jak uzyskać dostęp do docstring?

Źródło

2009-04-03 Teifion

zanotuj kod źródłowy, który działa Python z -oo wycina docstrings. Jeśli zamierzasz rozpowszechniać swój kod na innych, pamiętaj, że mogą go uruchomić w ten sposób. Sprawi to, że ludzie będą naprawdę niezadowoleni, jeśli twój kod opiera się na docstruktach, ale nie łapie przypadku, w którym nie istnieją. – DNS

Wiwaty za to, to całkiem przydatne informacje. – Teifion

@DNS Dzięki, zastanawiałem się, dlaczego wszystkie moje docstrings były None. – Timo

157

Interaktywnie, można wyświetlić ją

help(my_func)

Albo z kodu można pobrać go z

my_func.__doc__

Źródło

2009-04-03 09:05:57 unwind

BTW: Ta technika działa z wbudowanymi funkcjami, jak również z modułami i klasami (pomoc testowa() również z obiektami - może również działać). To sprawia, że twoja powłoka Pythona jest interaktywną powłoką pomocy! –

W pytaniu o pseudython możesz zrobić my_func ?? i pokaże również docstring. – ronak

Python jest tak cholernie fajny – ThorSummoner

Można również użyć inspect.getdoc. Czyści on __doc__, normalizując tabulatory w spacje i lewo przesuwając ciało dokumentu, aby usunąć wspólne wiodące spacje.

Źródło

2011-05-06 18:47:14

Właśnie to właśnie próbowałem zrobić sam. Dziękuję za to. – ereOn

Na ipython lub jupyter notebooka, można korzystać ze wszystkich wyżej wymienionych sposobów, ale idę z

my_func?

lub

?my_func

do szybkiego podsumowania zarówno podpisu metody i docstring.

I unikać

my_func??

(jak komentował @rohan) dla docstring i używać go tylko w celu sprawdzenia

Źródło

2017-05-24 04:44:14

Pierwsze docstring z funkcji

Odpowiedz

Powiązane problemy