파이썬 PEP8 스타일 가이드, 이건 꼭 지키자!

안녕하세요. 린아저씨 입니다.

오늘은 파이썬 코드를 작성하는 여러가지 스타일 중 가장 일반적으로 쓰이는 PEP8 스타일에 대해 포스팅하려 합니다.

 

PEP8 스타일의 모든 것을 쓸 수는 없지만 개인적으로 이건 꼭 지키는게 좋겠다하는 부분 입니다.

 

이름 정하기

 

변수 및 함수

모든 변수 및 함수의 이름 스네이크(snake) 표기법으로 써줍니다. 즉, 한단어일 경우에는 소문자로만 써주시고 여러 단어일 경우에는 언더바( _ )를 이용해서 소문자로만 써서 연결해 줍니다.

# 나쁜 예시(카멜 명명법)
myHouseName = 'xi'

def myPhoneNumber():
    print('010-1234-5678')
    


# 좋은 예시 (스네이크 명명법)
my_house_name = 'xi'

def my_phone_number():
    print('010-1234-5678')

 

상수

상수일 경우에도 스네이크 표기법으로 써주시되 상수이기 때문에 소문자가 아닌 대문자로 써주시면 됩니다.

# 나쁜 예시
myName = 'Lin'


# 좋은 예시
MY_NAME = 'Lin'

참고 링크 : www.python.org/dev/peps/pep-0008/#descriptive-naming-styless

 

 

공백

 

들여쓰기

들여쓰기는 Tab과 Space 중에 Space 4개 쓰는 것을 채택하고 있습니다. Tab을 쓰는 경우는 작성되어 있는 코드가 이미 Tab으로 들여쓰기를 하였을 경우에만 사용하며, python3에서는 Tab과 Space를 혼용해서 쓰는 것을 허용하지 않습니다.

# 나쁜 예시(tab 사용)
def call_me():
	print('Hey, Lina!')
    
    
    
# 좋은 예시(space 4개 사용)
def call_me():
    print('Hey, Lina!')

참고 링크 : www.python.org/dev/peps/pep-0008/#indentation // www.python.org/dev/peps/pep-0008/#tabs-or-spaces

 

괄호

대/중/소 어떤 괄호던지, 괄호 안에서는 띄어쓰기를 하지 않습니다.

# 나쁜 예시
sandwich( egg[ 2 ], {ham: 3} )


# 좋은 예시
sandwich(egg[2], {ham: 3})

 

함수 호출

함수 호출 할때, 함수 이름과 괄호 사이에 띄어쓰기를 하지 않습니다.

# 나쁜 예시
sandwich (egg[2], {ham: 3})


# 좋은 예시
sandwich(egg[2], {ham: 3})

 

쉼표

comma( , ), semicolon( ; ), colon( : ) 앞에 띄어쓰기를 하지 않습니다.

# 나쁜 예시
if x == 2 : print x , y ; x , y = y , x


# 좋은 예시
if x == 2: print x, y; x, y = y, x

 

할당 연산자

할당 연산자 앞뒤로는 각각 한개의 띄어쓰기를 사용 합니다.

## 나쁜 예시
x=1 
y=2 
z=3


## 좋은 예시
x = 1 
y = 2 
z = 3

 

참고 링크 : www.python.org/dev/peps/pep-0008/#whitespace-in-expressions-and-statements

 

 

코멘트

 

블록 주석

블록 주석은 해당 코드와 동일한 수준의 들여쓰기를 해줍니다. 그리고 # 과 한칸의 띄어쓰기를 해줍니다.

 

인라인 주석

실행 코드와 같은 줄에 있는 인라인 주석은 되도록 사용하지 않는게 좋습니다. 단, 꼭 필요한 경우라면 실행 코드와 두 칸 이상의 띄어쓰기를 해준 뒤에 시작되야 합니다.

# 나쁜 예시
my_house_name = 'xi' # 나의 집 이름

def my_phone_number(): # 내 전화번호
    print('010-1234-5678')
    
    
# 좋은 예시
my_house_name = 'xi'        # 나의 집 이름

def my_phone_number():      # 내 전화번호
    print('010-1234-5678')

참고 링크 : www.python.org/dev/peps/pep-0008/#comments

 

 

여기까지 제가 꼭 지켰으면 좋겠다고 생각하는 PEP8 스타일에 대해 정리해보았습니다. 이외에도 구체적으로는 훨씬 많은 가이드가 존재하니 모든 가이드를 확인해 보고 싶다 하시면 아래 링크에서 확인이 가능합니다! 끝!

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

PEP 8 -- Style Guide for Python Code