python - PEP8

코딩 스타일이란? 프로그래밍을 짤때의 형식이나 규칙을 통해 일관된 코딩 스타일을 만들게한다. 이는 자신의 코드를 명료하게하고 다른 개발자간의 공유에서도 효율적이게한다. 파이썬은 귀도 반 로썸이 제안한 PEP8 코딩스타일 가이드를 주로 따른다고 한다.

코드레이아웃

들여쓰기

들여쓰기는 4칸 들여쓴다. if문, 반복문, 다른 함수등 들여쓰기가 필요할때 공백문자 4번을 이용한다. 탭기능은 공백문자 4번과 다르므로 웬만하면 스페이스 4번을 사용하자

최대 라인 길이

모든 줄을 최대 79자로 제한한다. 너무 한줄에 긴 코드로 짜있으면 가독성이 떨어진다. 코드가 너무 길어진다면 괄호를 이용해 여러 줄로 나누어 주도록하자.

빈 줄

최상위 함수 및 클래스 정의를 할때 두 개의 빈 줄을 사용한다. 클래스 내부에서 함수 정의는 한 개의 빈 줄을 사용한다.

소스 파일 이름

이름을 정할떄 UTF-8을 사용해야하고 ASCII코드가 아닌 문자는 가급적 사람, 장소만 나타내고 싶을 때 사용하고 그 외에는 영어를 주로 사용하는 것이 좋다.

표현식 및 명령문 사이의 공백

괄호 안에 공백 금지, if문 반복문의 :기호 사이의 공백 금지, 쉼표 앞 공백금지
일반적으로 후행 공백(코드작성 후 비어있는 공백)을 조심해야한다. 일반적으로 보이지 않아 혼동될 수 있다.

주석

코드와 모순되는 주석은 주석이 없는 것보다 나쁘다. 코드가 변경되면 주석을 최신 상태로 수정해 주어야 한다.
인라인 주석(같은 라인에 있는 주석)은 불필요하게 설명하면 산만해 보이므로 꼭 필요할 때 사용하고 두 개이상의 공배으로 분리해야한다.

기타

와일드카드

와일드카드(Whildcard)를 가져오기를 사용하는 것은 피해야 한다. 모듈에 포함된 모든 클래스와 함수를 불러오는데 이러면 어떤 이름이 네임공간에 있는지 헷갈리고, 자동화툴이나 에디터가 혼동할 수 있다.

후행쉼표

후행 쉼표는 목록 항목 뒤에 가야한다.

상수

상수는 모두 대문자로 지정해야한다.

추가로 보면 좋을 자료들

[PEP8 공식문서] : (https://peps.python.org/pep-0008/#blank-lines)
[PE8 song] : (https://www.youtube.com/watch?v=hgI0p1zf31k)