Python 파일의 표준적인 헤더 구조
Python 개발자들은 일반적으로 다음과 같은 순서로 모듈 또는 Python 파일을 구성합니다. 이러한 규칙을 따르면 코드의 가독성이 높아지고, 다른 개발자와의 협업 시에도 일관성을 유지할 수 있습니다.
1. 셔뱅(Shebang) 라인
파일의 첫 번째 줄에는 #!/usr/bin/env python을 작성합니다. 이 셔뱅 라인이 있으면 인터프리터를 명시적으로 호출하지 않고도 해당 파일을 스크립트로 직접 실행할 수 있습니다. /usr/bin/env를 사용하면 시스템 환경에 설치된 Python 경로를 자동으로 찾아주므로 이식성이 더 좋습니다.
2. 독스트링(Docstring)
그다음 줄에는 모듈에 대한 설명을 담은 독스트링을 작성합니다. 독스트링은 해당 파일이 어떤 기능을 수행하는지, 누가 작성했는지 등의 메타 정보를 담는 역할을 하며, help() 함수나 자동 문서화 도구에서 활용됩니다.
3. 임포트(Import) 문
독스트링 이후에 모든 코드를 배치하며, import 문도 여기에 포함됩니다. 임포트 순서는 다음과 같이 정리하는 것이 관례입니다.
- 표준 라이브러리(내장 모듈):
os,sys,re등 Python에 기본으로 포함된 모듈을 먼저 임포트합니다. - 서드파티(외부) 모듈: pip로 설치한 외부 패키지를 그다음에 임포트합니다.
- 경로 설정 및 자체 모듈: 마지막으로 sys.path 변경과 같은 경로 수정 작업과 프로젝트 내에서 직접 작성한 모듈을 임포트합니다.
각 임포트 그룹 사이에는 빈 줄을 한 줄씩 넣어 구분해 주면 가독성이 더욱 향상됩니다. 이러한 정렬 규칙은 PEP 8 스타일 가이드에서도 권장하고 있는 내용입니다.