2010-12-13 6 views
3

저는 새로운 Python 프로젝트를 시작하고 가능한 한 표준 규약을 따르기를 원합니다. 예를 들어 import 문이 먼저 와야한다는 것을 읽었습니다. 그러나 모든 클래스 정의 앞이나 뒤에 모든 함수 정의를 두는 것과 같은 규칙을 찾지 못했습니다. 이런 일에 관례가 있습니까? 아니면 모든 사람이 일반적으로 함수 나 클래스 정의 같은 것을 순서대로 구성해야합니까?Python 소스 파일 구성

+0

도움 주셔서 감사합니다. 두 가지 대답 모두 훌륭했기 때문에 두 가지 모두 투표를 시도했지만 나에게 허락하지 않았습니다. 그래서 저는 그 중 하나를 동전을 뒤집어서 가장 좋은 것으로 선택했습니다. – Dan

답변

0

아니요, 기능 및 클래스 구성에 대한 규정이 없습니다. 그러나 소스 흐름을 개선하고 독자에게 더 이해를 돕기위한 몇 가지 기본 지침이 있습니다.

  • 문서. 무엇을 하든지, 클래스와 함수의 사용법 (그리고 어떤 경우에는 구현)이 평이한 영어로 기술되어 있는지 확인하십시오.
  • 같은 것을 함께 그룹화하십시오. 비슷한 기능을 수행하는 두 가지 기능은 무엇입니까? 함께 넣어.
  • 상식을 사용하십시오. 클래스가 다른 클래스를 확장하면 기본 클래스가 먼저 와야합니다. 함수가 정의한 클래스의 인스턴스를 사용하는 경우 클래스 정의가 먼저 오는지 확인하십시오.

이 작업을 수행하는 방법에 대한 예제는 Python 표준 라이브러리를 참조하십시오. 일부 모듈의 소스 파일은 소스가 파이썬으로 어떻게 구성되어 있는지를 알려줍니다.

5

PEP8 파이썬 스타일 가이드 : 메소드 수준의 수입이 허용 되더라도 http://www.python.org/dev/peps/pep-0008/

수입은 파일의 상단에 온다.

클래스와 함수에는 특별한 순서가 없습니다. 의미있는 것을 사용하십시오.