[python] 파이썬 파일의 일반적인 헤더 형식은 무엇입니까?

Foobar모듈 의 모든 메타 데이터입니다 .

첫 번째 docstring모듈은 Peter의 답변 에서 이미 설명한 모듈 입니다.

모듈 (소스 파일)을 어떻게 구성합니까? (아카이브)

각 파일의 첫 줄은 다음과 같습니다 #!/usr/bin/env python. 이를 통해 파일을 인터프리터를 암시 적으로 호출하는 스크립트 (예 : CGI 컨텍스트)로 스크립트로 실행할 수 있습니다.

다음은 설명이있는 docstring이어야합니다. 설명이 길면 첫 번째 줄은 그 자체로 이해하기 쉬운 짧은 요약이어야하며 나머지 줄은 줄 바꿈으로 구분해야합니다.

import 문을 포함한 모든 코드는 docstring을 따라야합니다. 그렇지 않으면 인터프리터가 docstring을 인식하지 못하므로 대화식 세션 (예 :)에서 obj.__doc__또는 자동화 된 도구로 문서를 생성 할 때 해당 docstring에 액세스 할 수 없습니다 .

내장 모듈을 먼저 가져온 다음 타사 모듈을 가져온 다음 경로 및 자신의 모듈을 변경하십시오. 특히, 모듈의 경로와 이름에 대한 추가 사항은 빠르게 변경 될 수 있습니다. 한 곳에서 유지하면 쉽게 찾을 수 있습니다.

다음은 저작자 정보입니다. 이 정보는 다음 형식을 따라야합니다.

__author__ = "Rob Knight, Gavin Huttley, and Peter Maxwell"
__copyright__ = "Copyright 2007, The Cogent Project"
__credits__ = ["Rob Knight", "Peter Maxwell", "Gavin Huttley",
                    "Matthew Wakefield"]
__license__ = "GPL"
__version__ = "1.0.1"
__maintainer__ = "Rob Knight"
__email__ = "rob@spot.colorado.edu"
__status__ = "Production"

상태는 일반적으로 “프로토 타입”, “개발”또는 “생산”중 하나 여야합니다. __maintainer__버그를 수정하고 가져올 경우 개선 할 사람이어야합니다. 버그 수정, 제안 등을보고했지만 실제로 코드를 작성하지 않은 사람들을 포함 한다는 __credits__점에서 다릅니다 .__author____credits__

여기에서 당신은 목록 자세한 내용을 __author__, __authors__, __contact__, __copyright__, __license__, __deprecated__, __date__와 __version__같은 인식 메타 데이터를.

답변

  import os    # standard library
  import sys

  import requests  # 3rd party packages

  import mypackage.mymodule  # local source
  import mypackage.myothermodule  

#!/usr/bin/env python
# -*- coding: utf-8 -*-

"""Module documentation goes here
   and here
   and ...
"""