Python: PEP8 스타일가이드

 스타일 가이드란 무엇일까?
 말그대로 그저 가이드일 뿐이다. 하지만 가이드는 코드에 일관성을 부여하여 가독성을 높인다. 

프로젝트나 다른 협업을 하게 되면 일관성 없는 코드 때문에 코드 스타일을 빠르게 알기 어렵다.

따라서 Python에서는 이와 같은 가이드를 제시한다.

---

1. 이름

 

1) 이름 규칙

 

모든 변수와 함수 이름은 소문자로 쓴다 여러 단어일 경우에는 언더바(_)와 같이 써준다.

string_name = "something"

def some_function_name():
    print("Hello")

 

2) 의미 있는 이름

#bad
a = 2
b = 3.14
print(b * a * a)


#good
radius = 2
pi = 3.14
print(pi * radius * radius)

 

---

2. 화이트 스페이스(띄어쓰기, 들여쓰기등등) 

 

1) 들여쓰기

 

들여쓰기는 스페이스 4개를 이용한다.

def say_hello():
    print("Hello, world!")

(print앞 스페이스 4개)

 

2) 함수 정의

 

함수와 함수 사이에는 빈줄이 두개씩 있어야 한다. 

def a():
    print('a')


def b():
    print('b')


def c();
    print('c')

 

3) 괄호 안

 

괄호 안에는 띄어쓰기를 하지 않는다.

#bad
person( age [ 0 ], sex [ 1 ] )


#good
person(age[0], sex[1])

 

4) 함수 괄호

 

함수 이름과 괄호 사이를 띄어쓰지 않는다.

#bad
def say_hello ():
    print ("Hello")
    
    
say_hello ()


#good
def say_hello():
    print("Hello")
    
    
say_hello()

 

5) 쉼표

 

쉼표 앞에는 띄어쓰기 하지 않는다.

#bad
say_hello(x , y)


#good
say_hello(x, y)

 

6) 지정 연산자

 

지정 연산자 앞뒤로 띄어쓰기는 하나씩

# bad
x=4
x   = 4


# good
x = 4

 

7) 연산자 

 

연산자 앞뒤로 띄어쓰기 하나씩

# bad
x=x+10
y +=1


# good
x = x + 10
y += 1

 

8) 코멘트

 

일반코드와 같은 줄에 코멘트를 쓸 경우, 코멘트 앞 띄어쓰기는 최소 두개

# bad
x = 1# 코멘트


# good
x = 1  # 코멘트