(파이썬) 파이썬 스타일 가이드 (PEP 8)

파이썬에서 좋은 코드를 만들기 위한 가이드 중 PEP8에 대해 알아보겠습니다.

 

1. 이름

1) 이름 규칙

모든 변수와 함수 이름은 소문자로 쓰고 여러 단어일 경우 _로 나눕니다.

# bad
someVariableName = 1
SomeVariableName = 1

def someFunctionName():
    print("Hello")

# good
some_variable_name = 1

def some_function_name():
    print("Hello")

• 모든 상수의 이름은 대문자로 쓰고 여러 단어일 경우 _로 나눕니다.

# bad
someConstant = 3.14
SomeConstant = 3.14
some_constant = 3.14

# good
SOME_CONSTANT = 3.14

2) 의미 있는 이름

# bad (의미 없는 이름)
a = 2
b = 3.14
print(b * a * a)

# good (의미 있는 이름)
radius = 2
PI = 3.14
print(PI * radius * radius)

2. 화이트 스페이스

1) 들여쓰기

• 들여쓰기는 무조건 스페이스 4개를 사용합니다.

# bad (스페이스 2개)
def do_something():
  print("Hello, world!")

# bad (스페이스 8개)
i = 0
while i < 10:
        print(i)

# good (스페이스 4개)
def say_hello():
    print("Hello, world!")

2) 함수 정의

• 함수 정의 위 아래로 빈 줄이 두 개씩 있어야 합니다.
• 하지만 파일의 첫 줄이 함수 정의인 경우 해당 함수 위에는 빈 줄이 없어도 됩니다.

 

3) 괄호 안

• 괄호 바로 안에는 띄어쓰기를 하지 않습니다.

# bad
spam( ham[ 1 ], { eggs: 2 } )

# good
spam(ham[1], {eggs: 2})

4) 함수 괄호

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

# bad
def spam(x):
    print(x + 2)

spam (1)

# good
def spam(x):
    print(x + 2)

spam(1)

5) 쉼표

• 쉼표 앞에는 띄어쓰기를 하지 않습니다.

# bad
print(x , y)

# good
print(x, y)

6) 지정 연산자

• 지정 연산자 앞 뒤로 띄어쓰기를 하나씩만 합니다.

# bad
x=1
x   = 1

# good
x = 1

7) 연산자

• 기본적으로는 연산자 앞뒤로 띄어쓰기를 하나씩 합니다.

# bad
i=i+1
submitted +=1

# good
i = i + 1
submitted += 1

• 하지만 연산의 "우선 순위"를 강조하기 위해서는, 연산자 앞뒤로 띄어쓰기를 붙이는 것을 권장합니다.

# bad
x = x * 2- 1
hypot2 = x * x + y * y
c = (a + b) * (a - b)

# good
x = x*2 - 1
hypot2 = x*x + y*y
c = (a+b) * (a-b)

8) 코멘트

• 일반 코드와 같은 줄에 코멘트를 쓸 경우, 코멘트 앞에 띄어쓰기를 최소 두 개 해줍니다.

# bad
x = x + 1# 코멘트

# good
x = x + 1  # 코멘트