파이썬 코딩의 기술TIP 2일차

2. PEP8 스타일 가이드를 따르라

 

pep8은 파이썬 코드를 어떤 형식으로 작성할지 알려주는 스타일 가이드이다.

일관된 스타일을 사용해 코드 가독성을 높이는게 좋다

 

참고 링크 : https://www.python.org/dev/peps/pep-0008/

 

공백

- 탭 대신 스페이스를 사용해 들여쓰기해라

- 문법적으로 중요한 들여쓰기에는 4칸 스페이스를 사용하라

- 라인 길이는 79개 문자 이하여야한다

- 긴 식을 다음 줄에 이어서 쓸 경우에는 일반적인 들여쓰기보다 4스페이스를 더 들여써야한다

- 파일 안에서 각 함수와 클래스 사이에는 빈 줄 두 줄을 넣어라

- 클래스 안에서 메서드와 메서드 사이에는 빈 줄 한 줄을 넣어라

- 딕셔너리에서 키와 콜론 사이에는 공백을 넣지 않고 한줄안에 키와 값을 같이 넣는 경우에는 콜론 다음에 스페이스 하나 넣어라

- 변수 대입에서 = 전후에는 스페이스를 하나씩만 넣어라

 

 

명명규약

- 함수, 변수, 애트리뷰트는 소문자와 밑줄을 이용해라

- 보호되어야하는 인스턴스 애트리뷰트는 일반적인 이름규칙에 _밑줄을 앞에 붙여라

- 비공개는 일반적인 이름규칙에 __밑줄 두개를 앞에 붙여라

- 클래스는 여러단어를 이어붙이되 각 단어의 첫글자를 대문자로 만들어라

- 클래스에 들어있는 인스턴스 메서드는 호출 대상 객체를 가리키는 첫 번째 인자의 이름으로 반드시 self를 사용해야 한다

- 클래스 메서드는 클래스를 가리키는 첫 번째 인자의 이름으로 반드시 cls를 사용해야한다

 

 

식과문

- 부정을 내부에 넣어라 if a is not b

- 한줄짜리 if문이나 for, while 루프 등을 사용하지마라

- 식을 한줄 안에 다 쓸 수 없을 경우, 식을 괄호로 둘러싸고 줄바꿈과 들여쓰기를 추가해서 읽기 쉽게 만들어라

- 여러 줄에 걸쳐 식을 쓸 때는 줄이 계속된다는 표시를 위해 \보다는 괄호를 사용해라

 

 

임포트

- import문을 항상 파일 맨 앞에 위치해라

- 절대 적인 이름을 사용하고 현 모듈의 경로에 상대적인 이름은 사용하지 마라

- 상대적인 경로는 from . import foo 처럼 명시적 구문을 사요하라

- 표준 라이브러리 모듈, 서드 파티 모듈, 내가 만든 모듈 순으로 작성

 

본 블로그는 [파이썬 코딩의 기술] 서적을 참고하여 작성하였습니다.