[Python] PEP 8 스타일 가이드

PEP8(Python Enhancement Proposal #8)은 파이썬 코드를 일관성 있게 작성하여 유지보수와 가독성에 도움을 주는 가이드입니다.

오늘은 PEP8에 대한 내용을 소개하려고 합니다.

 

자세한 내용은 아래의 링크에서 확인할 수 있습니다

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

PEP 8 – Style Guide for Python Code | peps.python.org

 

공백 처리(whitespace)

1. tab이 아닌 space로 들여쓴다.

2. 변수 할당 앞뒤에 space를 하나만 사용한다.

3. 문법적으로 의미 있는 들여쓰기는 스페이스 네 개를 사용한다.

4. 표현식이 길면 들여쓰기 + 스페이스 네 개를 사용한다.

5. 파일 내에서 함수와 클래스는 빈 줄 두 개로 구분한다.

6. 클래스 내에서 메서드는 빈 줄 하나로 구분한다.

7. 리스트 인덱스, 함수 호출, 키워드 인수 할당에는 스페이스를 사용하지 않는다.

 

Naming

1. 함수, 변수, 속성은 lowercase_underscore 형식을 따른다.

2. protected 인스턴스 속성은 _leading_underscore 형식을 따른다.

3. private 인스턴스 속성은 __double_leading_underscore 형식을 따른다.

4. 클래스 및 예외는 CapitalizedWord 형식을 따른다.

5. 모듈 수준 상수는 ALL_CAPS를 따른다.

6. 클래스의 인스턴스 메서드에서는 첫 번째 파라미터의 이름을 self로 지정한다.

7. 클래스 메서드에서는 첫 번째 파라미터의 이름을 cls로 지정한다.

 

표현식과 문장

1. 길이를 확인하여 빈 값을 확인하지 않는다.

2. if, for, while, except는 여러 줄로 나눠서 작성한다.

3. import는 맨 위에 놓는다.