[Python] 파이썬 코드 스타일 가이드 - PEP8

sorzzzzy·2021년 12월 1일
0

TIL

목록 보기
15/36
post-thumbnail

알고리즘 스터디 진행하면서 파이썬 코드 스타일로 선생님한테 혼났다 헤헤^^
이 참에 한번 하나하나 알아보자😎

📌 PEP8
자주 실수했던 몇 가지에 대해서만 작성할 것이다.
자세한 건 공식 문서를 활용해 공부하자!


1. 한 줄 당 최대 길이

모든 줄은 한 줄 당 최대 79개의 문자까지 적을 수 있다!
만약 길어진다면 \ 백슬레시를 사용하자.

2. 들여쓰기

각 들여쓰기 레벨마다 4칸 space 을 사용하자!

+) 함수와 클래스는 빈 줄 두 개로 구분한다.

3. 공백

최상위 레벨 함수와 클래스 정의 앞뒤로 두 개의 공백이 필요하다.
클래스 내의 메소드 정의 앞뒤로는 한 개의 공백이 필요하다.

4. 변수 선언

메모리의 저장공간을 사용하여 값을 저장하는 행위이다.
식별자를 사용하여 저장공간을 구분한다

식별자 규칙

1) 대소문자 구분

2) 대문자, 소문자, 숫자, _만 사용 가능

3) 가장 앞에 숫자를 사용할 수 없음

4) 예약어 사용 불가 : def, class, is, for, if, in ..

5) 앞에 __의 사용은 지양할 것

6) 기본적인 데이터타입과 함수 : snake_case

7) 클래스 : PascalCase, CamelCase

5. import

import 는 분리된 줄에 사용해야 한다.

6. 문자열 쿼트

파이썬에서는 작은따옴표 문자열(single quoted-strings)과 큰따옴표 문자열(double quoted-strings)이 같다.
PEP8에선 둘 중 어느 것을 사용해야 하는지에 대한 권장사항이 없다! 둘 중 규칙을 정한 뒤 지키면 된다.
그러나 만약 문자열이 따옴표 문자 자체를 포함한다면, 백슬래쉬를 쓰는 것을 피하기 위해 서로 다른 따옴표를 쓰자! 이것이 가독성을 향상시킨다😊

7. 불필요한 공백

불필요한 공백은 피하자!

➡️ 콤마, 세미콜론, 그리고 콜론 바로 전

➡️ 괄호 안쪽

➡️ 후행 쉼표와 닫힌 소괄호 사이

8. 주석

1. 블록 주석
블록 주석은 주로 일반적으로 그 뒤에 오는 일부 (또는 전체) 코드에 적용되며, 해당 코드와 동일한 레벨로 들여쓰기 되야한다.
블록 코멘트의 각각의 줄은 # 하나와 한 칸 공백으로 시작한다.
(단, 주석 안에서 들여쓰기 된 경우를 제외한다.)
블록 주석 안의 단락들은 # 한 개를 포함한 줄로 구분된다.

2. 인라인 주석
인라인 주석을 꼭 필요한 경우에만 사용하자!
인라인 주석은 코드의 문(statement)과 같은 줄에 있는 주석이다.
인라인 주석은 최소 2칸 공백으로 코드의 문과 구분 되어야한다.
# 과 한 칸 공백으로 시작한다.

profile
Backend Developer

0개의 댓글