Python 스타일 가이드

파이썬 스타일 가이드란

 

• 일반적으로 PEP 8 (Python Enhancement Proposal 8)로 알려진 문서에 따라 파이썬 코드를 작성하는 데 도움을 주는 규칙들의 모음
• 코드를 일관적이고 가독성 있게 작성하기 위한 지침을 제공
• 스타일 가이드를 따르면 여러 개발자들이 협업할 때 코드의 일관성과 유지보수가 쉬워짐

 

PEP 8 문서의 일부 주요 규칙과 가이드라인

 

1. 들여쓰기

• 탭 사용하지 않고, 공백 4개 사용
• 코드 라인 길이는 79자를 넘기지 말것
• 변수 대입 시, 등호 양쪽에 공백 1개

# 좋은 예시
def my_function():
    if some_condition:
        do_something()
    else:
        do_something_else()

# 나쁜 예시 (탭 대신 공백을 사용하지 않음)
def my_function():
	if some_condition:
		do_something()
	else:
		do_something_else()

 

2. 빈 줄

• 함수 정의와 클래스 정의 위, 각 함수와 메서드 사이, 클래스 내의 메서드 사이에 빈 줄 하나씩 넣기
• 클래스 정의 위와 함수/메서드 정의 위에는 두 개의 빈 줄 넣기

# 좋은 예시
def function1():
    # some code

def function2():
    # some code

# 나쁜 예시 (빈 줄이 없음)
def function1():
    # some code
def function2():
    # some code

 

3. import 문

• import 문은 모듈을 알파벳 순서대로 그룹화하여 작성
• 각 그룹 사이에 빈 줄 넣기

# 좋은 예시
import os
import sys

from my_module import (
    function1,
    function2,
    MyClass,
)

# 나쁜 예시 (그룹화하지 않음)
import sys, os
from my_module import function1, function2, MyClass

 

4. 함수와 변수 이름

• 함수, 변수, 메서드의 이름은 소문자와 언더스코어(_)로 작성 (예 : my_function, my_variable)
• 비공개(private) 속성과 메서드의 이름은 밑줄 두 개로 시작 (예: __private_method)

# 좋은 예시
def calculate_total():
    total_amount = 0
    # some code

# 나쁜 예시 (소문자와 언더스코어를 사용하지 않음)
def CalculateTotal():
    TotalAmount = 0
    # some code

 

5. 상수

• 상수의 이름은 모두 대문자와 언더스코어로 작성 (예 : MY_CONSTANT)

# 좋은 예시
MY_CONSTANT = 42

# 나쁜 예시 (상수 이름이 소문자임)
my_constant = 42

 

6. 주석

• 주석은 코드의 의도를 설명하고, 어려운 부분이나 중요한 로직에 추가해야함
• 주석은 문장의 끝에서 2개의 공백 뒤에 작성함

# 좋은 예시
def divide(a, b):
    """
    Function to divide two numbers.

    Args:
        a (float): The dividend.
        b (float): The divisor.

    Returns:
        float: The result of the division.
    """
    return a / b

# 나쁜 예시 (주석이 없음)
def divide(a, b):
    return a / b

 

[참고]

구글 스타일 가이드 : https://google.github.io/styleguide/jsguide.html