[python] PEP 8(코딩 스타일 가이드) -- Style Guide for Python Code & 파이썬의 변수 이름 규칙

1.  PEP8이란

파이썬 공식 홈페이지에서 PEP8를 아래와 같이 소개하고 있다.

This document gives coding conventions for the Python code comprising the standard library in the main Python distribution. Please see the companion informational PEP describing style guidelines for the C code in the C implementation of Python. - python PEP8 Introduction 
PEP8은 "python 코드에 대한 코딩 규칙"을 제공한다.

공식 문서 내용을 확인해 보면, python을 만든 Guido van Rossum(귀도 반 로섬) 선생님을 포함한 세 분이 작성하신 "파이써닉(pythonic)한 코드"를 위한 가이드이다. 

개발은 혼자 하는 것이 아니기 때문에, 가독성 있고 일관성 있는 코드는 통해 협업 간 매우 중요한 요소이다.

---

2.  주요 가이드

1. 이름 규칙

1) 모든 변수^[각주:1]와 함수 이름은 소문자로 쓰고, 여러 단어일 경우 _ 로 나눈다.

# bad
someVariableName = 1
SomeVariableName = 1


def someFunctionName():
    print("Hello")


# good : 추상화를 잘한 예는 아니다. 여러 단어의 구분을 _로 잘한 예
some_variable_name = 1


def some_function_name():
    print("Hello")

2) 모든 상수 ^[각주:2] 이름은 대문자로 쓰고, 여러 단어일 경우 _ 로 나눈다.

# bad
someConstant = 3.14
SomeConstant = 3.14
some_constant = 3.14

# good : 추상화를 잘한 예는 아니다. 여러 단어의 구분을 _로 잘한 예
SOME_CONSTANT = 3.14

# excellent : 추상화까지 잘한 예
PI = 3.14

---

2. 의미 있는 이름 : 추상화

추상화란 복잡한 내용은 숨기고, 필수 주요 기능에만 신경쓰는 것 - 참고 : [OOP] (4) 추상화(Abstraction)

• 클래스, 변수, 메소드의 이름을 어디에 쓸 수 있고, 어떻게 사용하는지 직관적으로 유추되는 이름을 사용하자
• 필자가 코세라에서 파이썬 강의에서 배운 변수 이름을 니모닉(mnemonic)하게 짓는 것도 여기에 해당된다.
• 🥕니모닉 변수 이름(mnemonic varaiable name) : 보는 사람을 위해 적절히 선택된 변수 이름, 기억하기 쉬운

## --- 상수, 변수 ---
# bad (의미 없는 이름)
a = 2
b = 3.14
print(b * a * a)

# good (의미 있는 이름)
radius = 2 # 변수
PI = 3.14 # 상수는 대문자로
print(PI * radius * radius)

## --- 함수 ---
# bad (의미 없는 이름)
def do_something():
    print("Hello, world!")


# good (의미 있는 이름)
def say_hello():
    print("Hello, world!")

---

3. 화이트 스페이스(white space) 사용 

1) 들여쓰기 : 들여쓰기는 무조건 스페이스 4개를 사용

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


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

 

2) 함수 정의 : 함수 정의 위아래로 빈 줄이 두 개 씩 있어야 함. 

# Wrong:
def add(x, y):
    return x + y
def subtract(x, y):
    return x - y

def multiply(x, y):
    return x * y

# Correct:
def add(x, y):
    return x + y
    
    
def subtract(x, y):
    return x - y


def multiply(x, y):
    return x * y

 

3) 괄호 안 : 괄호 바로 안에는 띄어쓰기를 하지 않음

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

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

 

4) 함수 괄호 : 함수를 정의하거나 호출할 때, 함수 이름과 괄호 사이에 띄어쓰기하지 않음

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


spam (1)

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


spam(1)

 

5) 쉼표 : 쉼표 앞에는 띄어쓰기를 하지 않음

# Wrong:
print(x , y)

# Correct:
print(x, y)

 

6) 지정 연산자(=) : 지정 연산자 앞뒤로 띄어쓰기를 하나씩만 해준다.

# Wrong:
x=1
x    = 1

# Correct:
x = 1

 

7) 연산자^[각주:3] : 기본적으로 연산자 앞뒤로 띄어쓰기를 하나씩만 해준다.

                 (연산의 "우선순위"를 강조하기 위해서는, 연산자 앞뒤로 띄어쓰기 붙이는 것 권장)

# Wrong:
i=i+1
submitted +=1
x = x * 2 - 1
hypot2 = x * x + y * y
c = (a + b) * (a - b)

# Correct:
i = i + 1
submitted += 1
x = x*2 - 1
hypot2 = x*x + y*y
c = (a+b) * (a-b)

 

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

# Wrong:
x = x + 1# 코멘트

# Correct:
x = x + 1  # 코멘트

---

📎 Variable in python : 추가 학습

variable : 변수(變數)는 변하는 값을 나타내는 문자다. 다양한 값이나 양을 넣을 수 있는 빈 자리를 나타내는 기호로 종종 주어진 집합에 있는 임의의 원소를 나타낼 때 쓴다. 변수는 수뿐만 아니라 벡터, 행렬과 함수를 나타낼 때도 쓴다. - 위키백과

각주에서도 언급했듯이, 값을 저장하는 곳이라고 생각하면 쉽다. 파이썬에서 =는 값을 "할당한다", "저장한다"의 의미로 생각하면 된다. 

파이썬에는 변수명에 대한 규칙이 있다.

• 영문자, 숫자, _(외의 기호는 불가)의 조합으로만 구성 가능
• 첫글자는 숫자 불가, 띄워쓰기 불가
• 영어 대문자와 소분자를 구분함 ➡️ 가능한 소문자 사용 권장
• 니모닉한 이름을 사용하자(mnemonic varaiable name)
• 예약어(reserved words)는 변수이름으로 사용할 수 없으니 주의(35개) : 마찬가지로 대소문자를 구분함

  and  del  global  not  with  as  elif  if  or  yield
  assert  else  import  pass  break  except  in raise
  class finally  is  return  continue  for  lambda 
  try  def  from  nonlocal  while True False None continue

🥕 TIP

• 니모닉한 변수 이름을 짓는 것이 어려울 때는 영어사전, 영어 유의어 사전을 이용하자
• 변수를 정의할 때, 2개 이상도 가능하다

  # 1개 변수 정의
  num = 1
  
  # 2개 이상 변수 정의
  num1, num2 = 1, 2​

🔍 Scope(범위) : 변수의 사용 가능한 범위

1. 로컬 변수(local vatiable)
   • 변수를 정의한 함수 내에서만 사용 가능
   • 함수의 파라미터(parameter)도 로컬 변수
   • 로컬 변수의 scope는 해당 함수 내로 국한됨
2. 전역 변수, 글로벌 변수(global vatiable)
   • 모든 곳에서 사용 가능
   • 글로벌 변수의 scope는 코드 전체

# example
x = 2 # 글로벌 변수
def my_function():
    x = 3 # 로컬 변수
    print(x)

my_function() # out: 3
print(x) # out: 2

---

조금 더 전문적인, 파이써닉한 개발자가 되기 위해 꼭 지녀야 할 덕목인 PEP8 그리고 추가로 파이썬에서의 변수에 대해 정리해 보았다.

다른 개발자와 협업 프로젝트 진행 간에 꼭 참고해야할 좋은 참고서이다. :) 

---

📎 Reference

• 각종 위키백과 : 해당 단어 클릭 시, 하이퍼링크를 통해 사이트로 이동
• 파이썬 공식 홈페이지
• 추상화에 대해 궁금하다면, 해당 블로그의 OOP series 중 [OOP] (4) 추상화(Abstraction) : docstring, type hinting, 정적 동적 타입 언어를 추천한다.
• 파이썬 기초 강좌 추천 
  • youtube : 미운코딩새끼 | 파이썬 강좌 코딩 기초 강의 Python | 김왼손의 왼손코딩
  • codeit : 프로그래밍 기초 in python 

📎 각주

1.  variable : 변수(變數)는 변하는 값을 나타내는 문자다. - 위키백과 ➡️ 🥕 값을 저장하는 곳이라고 생각하면 쉽다. [본문으로]
2. constant : 상수란 수식에서 변하지 않는 값을 뜻한다. 이것은 변하는 값 변수와 반대이다 - 위키백과  [본문으로]
3. 할당 연산자, 산술 연산자, 문자열 연산자, 비교 연산자 등 다양한 연산자가 있다. 잘 모른다면 여기서는 우선 + - * / 등의 산술 연산자로 생각하자. [본문으로]