Better Way 2. PEP 8 스타일 가이드

Effective Python 파이썬 코딩의 기술을 공부하며 '새롭게 배운 내용'을 기록하며 정리하기 위한 글 입니다.

Better Way 2. PEP 8 스타일 가이드

PEP8은 Python 코드를 어떤 형식으로 작성할 지 알려주는 스타일 가이드이다. 이를 참고해 일관된 스타일을 사용하면 가독성 좋은 코드를 작성할 수 있고, 효율적인 협업이 가능하다.

공식 문서 : https://peps.python.org/pep-0008/
(번역 : https://wikidocs.net/7914)

공백

• Tab 대신 스페이스를 사용해 4칸 들여쓰기 하기
• 각 함수와 클래스 사이에는 빈 줄을 2줄 넣기
• 클래스 안에서 메서드 사이에는 빈 줄을 1줄 넣기
• Dictionary에서 키와 콜론 사이에는 공백 X, 한 줄 안에 키와 값을 넣는 경우에는 콜론 다음 스페이스 하나({'apple': 2})
• 변수 대입에서 = 전후에는 스페이스 하나 넣기
• 키워드인수, 매개변수를 작성할 때는 = 주위 공백 X

Naming Conventions

• 함수, 변수, 어트리뷰트는 lower_case_undercase와 같이 소문자 + 밑줄
• 보호되야 하는 인스턴스 어트리뷰트는 _lowercase_undercase와 같이 _로 시작
• Private 인스턴스는 __lowercase_undercase 밑줄 2개로 시작
• 'l'(소문자 엘), 'O'(대문자 오), 'I'(대문자 아이)는 헷갈릴 수 있으므로 단일 문자 변수명으로 사용 X

Programming Recon

• if not ~ 보다 if ~ is not ~ 사용하기
• 빈 문자열 같은 것을 검사할 때 if len(L) == 0 보단, 비어있는 문자열 값이 False로 취급된다는 것을 이용해 if not L 사용하기
• 여러 줄에 걸치는 식을 쓸 때는 괄호로 둘러 싸고 줄 바꿈과 들여쓰기 활용하기

import

• 모듈을 임포트 할 때는 절대경로 사용하기, No : import apple / yes : from red import apple
• 상대경로를 사용해야 할 때는 form . import apple와 같이 명시적으로 사용
• 임포트 순서는 표준 라이브러리 - 서드 파티 - 유저 모듈 순으로 작성