파이썬 스타일 가이드 – pep8

파이썬 프로젝트를 할 때, 어떻게 코딩 표준을 가져가면 좋을까요?

여러가지 가이드가 있겠지만, 그 중 많이 언급되고 필수적인 것은 아무래도 pep8입니다.

여러 사람들이 모여서 프로젝트를 하면, 저마다의 개성이 있기 때문에 코드 스타일의 일관성이 깨지기 쉽습니다.

배경이 다르고, 경험이 다르기 때문에 스타일은 다양할 수 밖에 없지만, 어느 정도 서로간 약속이 지켜져야 생산성을 해치지 않을 것입니다.

그런 면에서, 파이썬의 창시자인 Guido Van Rossum이 작성한 파이썬 스타일 가이드는 기본이 됩니다.

작성된지도 꽤 오래되었지만, 여전히 pep8이라는 이름으로 업데이트가 되고 있습니다.

pep8이란?

먼저 pep의 의미부터 짚고 가야겠군요.

Python Enhancement Proposals를 줄여서 PEPs라고 부릅니다.

PEP뒤에 s가 있는 것으로 보아, PEP가 여러 개 있다는 것을 알 수 있겠죠.

그리고, PEP는 파이썬을 보다 잘 쓰기 위한 제안을 뜻합니다.

pep에 대한 상세 내용은 아래 공식 사이트에서 확인할 수 있습니다.

사람들이 흔히 말하는 파이썬 스타일 가이드는 수많은 pep 중 하나입니다.

일부 내용에 대해 살펴 봅니다.

## 비추천
sum = a +
      b + 
      c

## 추천
sum = a
      + b
      + c

import 규칙
- 한 줄에 하나씩만 import
- 표준 라이브러리를 1순위로 먼저 선언
- 3rd party 라이브러리를 2순위로 선언
- 로컬 전용으로 사용하는 라이브러리는 3순위로 선언
CamelCase와 snake_case 용도 구분
- 모듈 이름은 소문자로만 작명
- 클래스는 CamelCase로만
- 함수명은 snake_case로만

import module

class MyClass:
  def do_something(self):
      pass

코드 레이아웃
- 클래스와 함수 사이는 두 줄 띄기
- 클래스내 메소드 사이에는 한 줄 띄어 작성하기
- import 문은 파일 상단에 작성하며, 표준 라이브러리 – 외부 라이브러리 – 로컬 애플리케이션 및 라이브러리 순으로 구분하여 작성할 것
줄이 바뀌면 일관된 들여쓰기를 사용할 것
괄호 내부에는 불필요한 공백 사용 금지
쉼표, 콜론, 세미콜론 앞에는 공백 넣지 않기
함수 호출시 함수 이름과 괄호 사이에 공백 넣지 않기
주석은 명확하고 간결하게

Python PEP 8은 파이썬 코드를 작성할 때 따라야 하는 스타일 가이드입니다. PEP 8과 같은 기준을 따름으로써, 코드의 이해를 돕고, 협업 시 다른 개발자들도 코드를 쉽게 읽고 함께 유지보수할 수 있게 도와줍니다.