파이썬 스타일 가이드 PEP8 살펴보기

브랜드 UX를 향상시기키 위해서는 스타일 가이드를 만드는 것이 좋다. (선택이 아닌 필수라고 봐도 무방)

 

프로그래밍을 할 때에도 좋은 코드와 나쁜 코드가 있다. 코드를 잘 짜면 구조를 한 눈에 파악하기 쉽고, 다른 사람들과 협업을 할 때에도 효율적으로 업무를 진행할 수 있다. 스타일 가이드에 '맞고 틀림'은 존재하지 않겠지만, 그래도 아직까지 수많은 개발자들이 규칙으로 정하고 그대로 지켜온 보편적인 룰을 익혀둘 필요가 있다고 생각한다.

 

 

파이썬 프로그래밍 언어는 PEP8 이라는 스타일 가이드를 제공하고 있어 아래 링크를 공유한다.

 

https://www.python.org/dev/peps/pep-0008/

PEP 8 -- Style Guide for Python Code

 

그 중에 몇가지를 아래에 정리해두려고 한다. (전체 내용은 위 사이트에 들어가서 숙지)

 

코드 레이아웃

들여쓰기 : 들여쓰기 수준당 4개의 공백을 사용한다.

최대 라인 길이 : 모든 행을 최대 79자로 제한한다.

빈 줄 : 두 개의 빈 줄로 최상위 함수 및 클래스 정의를 묶는다.

 

def say_hello():
    print("hello world!")  # 4칸 들여쓰기
    
   
print(say_hello)  # 함수 사이 2칸 빈 줄

 

 

문자열 따옴표

파이썬에서 작은 따옴표 문자열과 큰 따옴표 문자열은 동일하다. 

문자열에 작은 따옴표 또는 큰 따옴표 문자가 포함된 경우 다른 하나를 사용하여 문자열에서 백슬래시를 방지한다.

 

print("hello. I'm heina.")  # 문장 내부에 '(작은 따옴표)가 사용되어 "내용"(큰 따옴표)로 묶음

 

식 & 명령문의 공백

괄호, 대괄호 또는 중괄호 바로 내부에서는 공백을 사용하지 않는다.

쉼표, 세미콜론, 콜론 바로 앞에는 공백을 사용하지 않는다.

함수 이름과 괄호 사이에 공백을 사용하지 않는다.

지정연산자 앞뒤로 공백을 한칸씩 사용한다.

우선 순위가 다른 연사자를 사용하는 경우 우선 순위가 가장 낮은 연산자 주위에 공백을 추가하는 것이 좋다.

 

# 잘못된 예
a=1

# 잘된 예 : 지정연산자 = 뒤로는 앞뒤로 공백을 한칸씩 사용
a = 1

# 잘못된 예
def say_hello ():
    print ( "hello, world!" )

# 잘된 예 : 함수 이름과 괄호 사이, 괄호 내부 앞뒤로는 공백 사용 안 함
def say_hello():
    print("hello, world!")

 

주석

블록 주석 : 일반적으로 해당 코드와 동일한 수준으로 들여쓰기한다.

인라인 주석 : 주석 앞에 두 개 이상의 공백으로 구분하도록 한다. 

※주석의 각 줄은 #와 단일 공백으로 시작한다.

※코드와 모순되는 주석은 주석이 없는 것보다 더 나쁘다!

 

PI = 3.14  # 원주율(코드와 동일한 줄에 주석 사용할 때는 2칸 띄움)


def say_hello():
    print("Hello, world!")
    # 함수 주석 사용시 해당 코드와 동일 수준으로 들여쓰기

 

명명 규칙

알파벳 소문자 l(엘), 대문자 I(아이), 대문자 O(오)를 단일 문자 변수 이름으로 사용하지 않는다. 일부 글꼴에서 숫자 1, 0과 구별할 수 없기 때문이다. 소문자 l을 사용하고 싶을 때에는 대신 대문자 L을 사용한다.

변수, 함수 이름은 소문자여야 하며, 가독성을 높이기 위해 단어를 밑줄로 구분한다.

상수 이름은 단어를 구분하는 밑줄과 함께 모두 대문자로 작성한다.

 

# 잘못된 예
FastfoodCost
fastfoodCost

# 잘된 예 : 모두 소문자 사용, 단어는 밑줄로 구분
fastfood_cost