파이썬 스크립트에 사용 설명서를 추가하는 방법

Question

파이썬 스크립트를위한 일련의 미니 설명서를 문서화하거나 작성하는 가장 좋은 방법은 무엇입니까? 예를 들어 -h를 실행하는 방법을 표시하는 스크립트. 템플릿이 있습니까?

Answer 1

파이썬에는이를 정확히 수행하기위한 내장 라이브러리가 있습니다. Python < = 2.7을 타겟팅하는 경우 optparse을 사용해야하며 2.7 이상이면 argparse을 사용해야합니다.

optparse 모듈은 다음과 같이 작동합니다. 스크립트에서 허용 할 인수를 지정한 다음 parse_args을 호출하십시오. 이렇게하면 -h이 전달되면 사용자의 인수가 처리되고 도움말 메시지가 인쇄됩니다. argparse 모듈도 비슷하게 작동합니다.

from optparse import OptionParser 

parser = OptionParser() 
parser.add_option("-f", "--file", dest="filename", 
       help="write report to FILE", metavar="FILE") 
parser.add_option("-q", "--quiet", 
       action="store_false", dest="verbose", default=True, 
       help="don't print status messages to stdout") 

(options, args) = parser.parse_args() 

Answer 2

프로그램 옵션을 처리하는 라이브러리를 사용할 수 있습니다. 대부분은 자동 생성되었습니다 -help 플래그

예를 들어 argparse (표준 라이브러리에 있음)이 자동으로 생성합니다.

Answer 3

argparse 모듈을 사용하십시오.

Answer 4

당신은 내가 위대한 사람이 될 http://pypi.python.org/pypi/plac을 발견했습니다 외부 종속성을 상관하지 않는 경우. the documentation에서

:

def main(dsn): 
    "Do something with the database" 
    print(dsn) 
    # ... 

if __name__ == '__main__': 
    import plac; plac.call(main)