[파이썬에서 살아남는법 제 1장] PEP 8 가이드를 따르라

※본 내용은 파이썬의 코딩 기술 (개정 2판)을 바탕으로 작성 했습니다.

 

PEP (python Enhancement Proposal) 은 파이썬 코드를 어떤 형식으로 작성할지 알려주는 스타일 가이드다. 

일관된 스타일을 사용하는것이 코드에 접근이 쉽고 쉽게 읽을수 있다. 나뿐만이 아니라 다른 독자들을 위한 방법이다. 

 

1.  공백 (whitespace)

• 탭 대신 스페이스를 사용하여 들여쓰기 하라
• 문법적으로 중요한 들여쓰기는 4스페이스 를 하라
• 라인의 길이는 79 문자 이하여야 한다. (한글=2명문)
• 긴서식을 이어쓸경우 일반적 들여쓰기 보다 4 스페이스를 더 들여써라
• 파일한 함수와 클래스 사이는 빈 2줄을 넣어라
• 클래스 안에서 메서드사이는 1줄을 넣어라
• 딕셔너리에서 키와 콜론 사이는 공백을 넣치말고, 한줄에 키와 값을 같이 넣는경우 콜론 다음에 스페이스를 넣으라
• 변수 대입에서 = 는 전후 한칸만 스페이스를 줘라
• 타입 표기를 덧붙이는 경우 변수 이름과 콜론 사이에 공백을 넣지 않도록 주의 하라

명명 규약

• 함수, 변수, 애트리뷰트는 lowecase_underscore 처럼 소문자, _ 를 사용한다 (뱀표기법)
• 보호돼야 하는 인스턴스 애트리뷰트는 뱀표기법을 따르되 _lowecase_underscore 처럼 밑줄로 시작한다.
• 비공개 (한클래스에만 쓰이는 경우) 는 __(밑줄 2개) 로 시작
• 클래스는 CapitalizedWord 처럼 이어붙이되 각단어의 첫글자를 대문자로 한다.(파스칼표기법)
• 모듈 수준의 상수는 ALL_CAPS 처럼 모든 글자를 대문자로 하고 단어와 단어사이를 _로 연결해라
• 클래스에있는 인스턴스 메서드는 호출대상 객체를 가르키는 첫번째 인자를 self 로 해라
• 클래스 메서드는 클래스를 가르키는 첫번째 인자의 이름으로 반드시 clc를 사용 해야한다.

식과문

• 긍정적인 식을 부정하지말고( if not a is b) 부정을 내부에 넣어라 (if a is not b)
• 빈 컨테이너나 시퀀스값은 암묵적으로 False , 이것들을 길이 0으로 비교 하지 말아라
• 한줄짜리 if문 for문, while 루프등의 복합문을 쓰지마라 가독성이 떨어진다
• 식을 한줄안에 다 쓸수 없는 경우 식을 관호로 둘러싸고 줄바꿈과 들여쓰기를 추가해서 읽기 쉽게 만들어라
• 여러줄에 글을 쓸때는 줄이 계속되는 \ 보다 괄호를 사용하라

임포트

• import 문을 항상 파일 맨 앞에 위치하라 
• form 패키지 import 모듈 처럼 경로를 다 적어 주어라
• 알파벳 순서로 하면 좋다.