[python] 코딩 스타일 가이드를 따를 때 주의해야 할 점은?

파이썬은 PEP 8이라는 코딩 스타일 가이드를 따르는 것이 좋습니다.

공백 사용

PEP 8에 따르면, 인터페이스(함수 또는 클래스)를 정의할 때, 주변의 빈 줄 수를 조정해야 합니다. 함수와 클래스 사이에는 두 개의 빈 줄을, 함수 내에서 관련이 있는 코드 블록들 사이에는 한 개의 빈 줄을 사용해야 합니다.

줄 길이

PEP 8에는 줄의 길이가 79자로 제한하는 것을 권장합니다. 이는 읽기 쉽고 커밋 히스토리가 분리되는 데 도움이 됩니다.

변수 및 함수 이름

변수와 함수의 이름은 소문자로 구성하고, 필요하다면 밑줄(_)로 단어를 구분해야 합니다. 클래스 이름은 카멜 케이스로 작성되어야 합니다.

주석

PEP 8은 코드에 설명적인 주석을 달라고 권장하지만, 너무 많은 주석은 오히려 코드를 혼란스럽게 만들 수 있습니다. 코드가 이해하기 어려울 정도의 복잡성을 가질 때에만 주석을 사용해야 합니다.

예외 처리

예외 처리의 경우 반복되는 예외처리 코드가 있다면 함수로 따로 처리하는 것이 가독성과 유지보수성 측면에서 좋습니다.

PEP 8을 준수하는 것은 코드의 가독성을 높이고, 팀원들과의 일관된 협업을 위해 중요합니다.

참고문헌: PEP 8 공식 문서