Python 파일의 일반적인 헤더 형식

질문 : Python 파일의 일반적인 헤더 형식은 무엇입니까?

---

Python 코딩 지침에 대한 문서에서 Python 소스 파일에 대한 다음 헤더 형식을 발견했습니다.

#!/usr/bin/env python

"""Foobar.py: Description of what foobar does."""

__author__      = "Barack Obama"
__copyright__   = "Copyright 2009, Planet Earth"

이것이 파이썬 세계에서 표준 헤더 형식입니까? 헤더에 어떤 다른 필드 / 정보를 넣을 수 있습니까? Python 전문가가 좋은 Python 소스 헤더에 대한 지침을 공유합니다. :-)

답변

---

Foobar 모듈에 대한 모든 메타 데이터입니다.

첫 번째 docstring 으로 Peter의 답변 에서 이미 설명되어 있습니다.

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

각 파일의 첫 번째 줄은 #!/usr/bin/env python 입니다. 이것은 예를 들어 CGI 컨텍스트에서 암시 적으로 인터프리터를 호출하는 스크립트로 파일을 실행할 수있게합니다.

다음은 설명이있는 독 스트링이어야합니다. 설명이 길면 첫 번째 줄은 그 자체로 의미가있는 짧은 요약이어야하며 나머지 줄은 줄 바꿈으로 구분해야합니다.

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

먼저 내장 모듈을 가져온 다음 타사 모듈을 가져온 다음 경로 및 자체 모듈을 변경합니다. 특히 모듈의 경로와 이름에 대한 추가 사항은 빠르게 변경 될 수 있습니다. 한곳에 보관하면 쉽게 찾을 수 있습니다.

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

__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"

상태는 일반적으로 "Prototype", "Development"또는 "Production"중 하나 여야합니다. __maintainer__ 는 버그를 수정하고 가져올 경우 개선 할 사람이어야합니다. __credits__ 다르다 __author__ 점에서 __credits__ 등 버그 수정, 제작 제안을보고 있지만, 실제로 코드를 작성하지 않은 사람들을 포함한다.

여기에 __author__ , __authors__ , __contact__ , __copyright__ , __license__ , __deprecated__ , __date__ 및 __version__ 을 인식 된 메타 데이터로 나열하는 자세한 정보가 있습니다.

출처 : https://stackoverflow.com/questions/1523427/what-is-the-common-header-format-of-python-files