[파이썬] 표준 코딩 스타일, PEP8

표준 코딩 스타일, PEP8

PEP 8은 파이썬 코드를 작성할 때 따르는 표준 스타일 가이드입니다. PEP 8은 Python Enhancement Proposal의 약자로, 파이썬 코드의 일관성과 가독성을 높이기 위한 규칙과 권장 사항을 정의합니다. PEP 8은 파이썬 커뮤니티에서 널리 사용되며, 특히 협업 프로젝트나 오픈 소스 프로젝트에서 중요한 역할을 합니다. 주요 규칙과 권장 사항을 살펴보겠습니다.

1. 들여쓰기 (Indentation)

• 들여쓰기는 공백 4칸을 사용합니다.
• 탭(\t) 대신 공백을 사용해야 합니다.
• 동일한 프로젝트 내에서는 일관된 들여쓰기 스타일을 유지해야 합니다.

def my_function():
    for i in range(10):
        print(i)

2. 최대 줄 길이 (Maximum Line Length)

• 한 줄의 최대 길이는 79자를 넘지 않는 것이 좋습니다.
• 긴 줄을 나누기 위해서는 괄호를 사용하거나, 백슬래시(\)를 사용하여 줄을 나눌 수 있습니다.

# 올바른 예시
if (first_variable > second_variable and
        first_variable > third_variable):
    print("First is the largest")

# 잘못된 예시
if first_variable > second_variable and first_variable > third_variable: print("First is the largest")

3. 공백 (Whitespace)

• 연산자 양쪽에 공백을 한 칸씩 넣어 가독성을 높입니다.
• 함수 호출 시 괄호와 인수 사이에 공백을 넣지 않습니다.
• 인덱싱이나 슬라이싱에서 대괄호와 인덱스 사이에는 공백을 넣지 않습니다.

# 올바른 예시
x = 10 + 5
my_list = [1, 2, 3, 4]

# 잘못된 예시
x = 10+5
my_list = [ 1, 2, 3, 4 ]

4. 빈 줄 (Blank Lines)

• 상단 레벨 함수와 클래스 정의 사이에는 두 줄의 빈 줄을 사용합니다.
• 클래스 내의 메서드 정의 사이에는 한 줄의 빈 줄을 사용합니다.

# 올바른 예시
class MyClass:

    def method_one(self):
        pass

    def method_two(self):
        pass

5. 주석 (Comments)

• 주석은 가능하면 코드와 같은 수준의 들여쓰기를 사용합니다.
• 중요한 코드 블록 위에 블록 주석을 사용하여 코드의 목적을 설명합니다.
• 코드 옆에 짧은 설명을 덧붙일 때는 인라인 주석을 사용할 수 있습니다.

# 올바른 예시
def calculate_area(radius):
    # 반지름을 받아 원의 면적을 계산합니다.
    return 3.14 * radius ** 2

x = calculate_area(5)  # 반지름이 5인 원의 면적을 계산합니다.

6. 변수 및 함수 이름 (Naming Conventions)

• 변수와 함수 이름은 소문자와 밑줄(_)을 사용하여 작성합니다. (snake_case)
• 클래스 이름은 첫 글자를 대문자로 하고, 단어마다 대문자를 사용합니다. (CamelCase)
• 상수는 모든 글자를 대문자로 작성하고, 단어 사이에 밑줄(_)을 사용합니다.

# 변수 및 함수 이름
def calculate_sum():
    my_variable = 10

# 클래스 이름
class MyClass:
    pass

# 상수 이름
PI = 3.14159

7. 임포트 (Imports)

• 임포트는 항상 파일의 맨 위에 위치해야 하며, 표준 라이브러리, 서드파티 라이브러리, 로컬 모듈 순으로 작성합니다.
• 한 줄에 여러 모듈을 임포트하지 않도록 합니다.

# 올바른 예시
import os
import sys

import requests

from mymodule import my_function

8. 기타 권장 사항

• 함수나 메서드에 인수를 전달할 때, 위치 인수와 키워드 인수를 명확히 구분합니다.
• 비교 시 가능하면 ==나 != 대신 is나 is not을 사용하여 명확성을 높입니다.

PEP 8을 따름으로써 코드의 일관성, 가독성, 유지보수성을 높일 수 있습니다. 대부분의 IDE나 코드 편집기에서는 PEP 8을 자동으로 검사해 주는 기능을 제공하므로 이를 적극 활용하는 것이 좋습니다.