Zauważ, że uruchomienie Pythona z -OO usuwa dokumenty. Jeśli zamierzasz rozpowszechniać swój kod innym, pamiętaj, że mogą go uruchomić w ten sposób. Sprawi, że ci ludzie będą naprawdę niezadowoleni, jeśli twój kod będzie opierał się na dokumentach, ale nie wychwyci przypadku, w którym ich nie ma.
BTW: Ta technika działa z wbudowanymi funkcjami, a także modułami i klasami (pomoc testowa () również z obiektami - może również działać). To sprawia, że powłoka pytona jest interaktywną powłoką pomocy!
Daren Thomas
3
W wierszu polecenia ipython możesz zrobić my_func? i pokazywałoby również dokumentację.
ronak
1
help (func) daje czytelny wynik, a func .__ doc__ daje wynik wyjściowy. Dziękuję za odpowiedź.
imsrgadich,
77
Możesz także użyć inspect.getdoc. Czyści się __doc__, normalizując tabulatory do spacji i przesuwając w lewo treść dokumentu, aby usunąć typowe spacje wiodące.
Odpowiedzi:
Interaktywnie możesz to wyświetlić za pomocą
Lub z kodu możesz go odzyskać
źródło
Możesz także użyć
inspect.getdoc. Czyści się__doc__, normalizując tabulatory do spacji i przesuwając w lewo treść dokumentu, aby usunąć typowe spacje wiodące.źródło
Na ipython lub notatniku jupyter możesz używać wszystkich wyżej wymienionych sposobów, ale idę z tym
lub
do szybkiego podsumowania zarówno podpisu metody, jak i dokumentu.
Unikam używania
(skomentowane przez @rohan) do docstring i używaj go tylko do sprawdzania kodu źródłowego
źródło