PEP 8은 파이썬 코드를 어떻게 구성해야 가독성이 좋아지는지에 대한 권장 사항을 제공합니다. 여기에는 네이밍 규칙도 포함되어 있어, 파이썬에서 변수, 함수, 클래스 등을 명명할 때 일관된 방식을 유지할 수 있게 도와줌.
주요 네이밍 규칙
- 변수(variables) 및 함수(functions)명: 소문자로 시작하며 필요한 경우 언더스코어(_)로 단어를 구분합니다.
- 예)
my_variable, calculate_value()
- 상수(constants)명: 모든 글자를 대문자로 하고, 필요한 경우 언더스코어로 단어를 구분합니다.
- 클래스(class)명: CapWords 방식(각 단어의 첫 글자를 대문자로)을 사용합니다.
- 예)
MyClass, DataProcessor
- 모듈(module)명: 짧은 소문자로 구성되며, 필요한 경우 언더스코어로 단어를 구분합니다. 가능한 한 간결하게 명명합니다.
- 예)
my_module.py, data_utils.py
- 패키지(package)명: 모듈명과 유사하게 짧은 소문자를 사용하며, 언더스코어는 사용하지 않는 것을 권장합니다.
추가적인 권장사항
- 내부적으로 사용하는 변수나 함수명: 앞에 언더스코어(_) 하나를 추가하여 내부적으로 사용한다는 것을 나타냅니다.
- 예)
_internal, _secret_method()
- 매직 메소드(magic methods) 및 속성(properties): 양쪽에 언더스코어를 두 개씩 추가합니다.
- 예)
__init__, __str__, __call__
- 충돌을 피하기 위해 변수명 끝에 언더스코어(_) 추가하기: 파이썬 키워드나 내장 함수와 이름이 충돌할 경우, 변수명 끝에 언더스코어를 추가합니다.