[파이썬 스킬업 #1] PEP8 스타일 가이드 핵심 정리

파이썬 코딩의 기술 정리 #1

• 출판사 Github >> https://github.com/gilbutITbook/080235
• 저자 Github >> https://github.com/bslatkin/effectivepython

---

PEP8 스타일 가이드를 따릅시다 !

파이썬은 코딩 스타일을 친절히 설명해주고 있습니다.

자기 멋대로 코딩해도 코드는 잘 돌아갑니다 하지만....

다음과 같은 이유로 스타일 가이드를 지키는 것을 권장합니다.

1. 스타일 가이드를 준수하고, 알고 있다면 어떤 코드든 접근하기 쉬워진다.
2. 가독성이 높아지기 때문에 쉽게 이해하고 분석할 수 있다.
3. 다른 프로그래머 혹은 오픈 소스를 활용할 때, 협력을 용이하게 해준다.

따라서, 파이썬을 무기로 사용하고자 하는 개발자라면, 언젠가 보게될 문서라고 생각합니다.

 

---

해당 포스팅에서는, 서적에서 요약한 PEP8 핵심을 정리해보겠습니다.

 

 

1. 공백 (WhiteSpace)

• 탭(tab)을 사용하지 말자. 공백(whitespace) 4개를 사용하자.
• 코드 라인 길이는 79자를 넘기지 말자.
• 함수와 클래스 구분을 위해 줄바꿈 2번을 하자
• 클래스 내 메서드 구분을 위해 줄바꿈 1번을 하자
• 변수 대입 시, 등호(=) 양쪽에 공백을 1개 주자

변수 대입 시

2. 명명 규약

• 함수, 변수, 속성 => 소문자 + 언더바 조합
  • ex) lower_underscore

 

• 보호해야하는 인스턴스 속성 => 언더바로 시작하자
  • ex) _lower_start

 

• private 인스턴스 속성 => 더블 언더바로 시작하자
  • ex) __double_underscore

 

• class, exception => 첫 문자는 대문자 + 파스칼 표기법
  • 파스칼 표기법 : 언더바 없이 모든 문자를 이어서 표현하되, 대문자로 단어를 구분하는 표기법
  • ex) HelloWorld

 

• 상수 => 모든 글자를 대문자로 + 언더바 조합
  • ex) CAR_VECTOR

 

3. 식과 문 (문제 해결 방법에 대한 규칙)

• 빈 값을 확인할 때 => len() 메서드를 사용하지 않을 것
  • 기본적으로 모든 빈 값은 False로 취급한다.
  • 마찬가지로 값이 비어있지 않은지는 True인지 확인하면 된다.
  • 예시는 아래 사진 참고

 

• if, while 문을 한 줄에 모두 사용하지 않는다.

 

• 식을 한 줄에 다 쓰지 못할 경우 => 괄호로 감싸고, 줄바꿈과 들여쓰기를 이용한다.

 

• 두 줄 이상으로 길어질 경우 => \ (역슬레시) 를 활용하자

 

4. 임포트 (import에도 규칙이 있다.)

• 모든 import는 파일 맨 위에
• 상대적인 이름 사용 X, 절대적인 이름 사용하자

• 반드시 상대적인 경로로 지정해야할 경우 => 가능한 절대 경로를 명시해주자
  • ex) from . import module

---

파이썬 스타일 가이드인 PEP8에 대해 아주 간략하게 알아봤습니다.

해당 포스팅은 서적에 나오는 내용만 옮긴 것이며, 해당 내용 외 스타일 가이드는 더 많기 때문에 욕심이 있으시다면 공식 문서를 참조하시길 바랍니다.

 

PEP8 원본은 해당 페이지에서 확인할 수 있습니다.

https://www.python.org/dev/peps/pep-0008/

PEP 8 -- Style Guide for Python Code

 

해당 포스팅은 「파이썬 코딩의 기술」 서적을 참고하였습니다.
(저자:브렛 슬라킨/역자:오현석/출판사:길벗)