함수

2009-04-03 8 views
114

에서 문서화 문자열을 얻기 I에는 다음과 같은 기능 :함수

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

어떻게 문서화 문자열에 접근 할 수 있습니까?

+9

참고를 확인에만 사용합니다. 코드를 다른 사람에게 배포하려는 경우 해당 코드를 다른 사람에게 배포 할 수 있음을 명심하십시오. 당신의 코드가 문서 문자열에 의존한다면 그 사람들은 정말로 불행하게 만들지 만 존재하지 않는 경우는 잡아 내지 못합니다. – DNS

+1

건배, 그게 아주 유용한 정보입니다. – Teifion

+0

@DNS 감사합니다. 왜 모든 문서화 문자열이 없음인지 궁금합니다. – Timo

답변

157

대화식으로, 당신은

help(my_func) 

로 표시 할 수 있습니다 또는 코드에서 당신은 또한 inspect.getdoc을 사용할 수 있습니다

my_func.__doc__ 
+1

BTW :이 기술은 내장 함수뿐만 아니라 모듈 및 클래스 (테스트 도움말()도 함께 사용 가능)와 함께 작동합니다. 이렇게하면 파이썬 셸이 대화식 도움말 셸이됩니다! –

+2

ipython 프롬프트에서 my_func을 할 수 있습니까 ?? 그리고 그것은 문서화 문자열을 보여줄 것이다. – ronak

+3

파이썬은 너무 괴롭다. – ThorSummoner

56

로를 검색 할 수 있습니다. 탭을 공백으로 정규화하고 문서 본문을 왼쪽으로 이동하여 일반적인 선행 공백을 제거하여 __doc__을 정리합니다. ipython 또는 jupyter 노트북에

+1

지금 내가 그 자신을하려고했던 정확하게 그 것이다. 고마워. – ereOn

1

, 당신은 모든 위에서 언급 한 방법을 사용할 수 있습니다,하지만 난 방법 서명 및 문서화 문자열 모두의 빠른 요약

my_func? 

또는

?my_func 

과 함께 할 것입니다.

나는 문서화 문자열에 대한 (@rohan에 의해 주석으로)

my_func?? 

을 사용하지 않도록하고 -OO 파이썬을 실행하는 문서화 문자열을 스트립하는 소스 코드를