[Python/파이썬] 파이썬스럽게 코딩하기: PEP8 가이드 정리

PEP8는 파이썬 코딩 스타일 가이드로, 코드를 일관되고 가독성 있게 작성할 수 있도록 권장하는 가이드라인입니다. 이를 따르면 코드의 가독성이 향상되고 협업 시 발생할 수 있는 오류를 줄일 수 있습니다. 아래에서는 파이썬스럽게 코딩하는 방법과 PEP8 가이드에 대해 설명하겠습니다.

1. 들여쓰기 (Indentation)

들여쓰기는 공백 4개를 사용하며, 탭 대신 공백을 사용해야 합니다.

예제 1: 들여쓰기

def greeting(name):
    print("Hello, " + name)

greeting("Alice")

위의 예제에서는 함수 정의와 함수 호출 사이에 4칸의 공백이 들여쓰기로 사용되었습니다.

2. 한 줄의 길이 (Line Length)

한 줄의 길이는 79자로 제한되며, 너무 긴 줄은 여러 줄로 나누어 작성해야 합니다.

예제 2: 한 줄의 길이

message = "This is a very long message that exceeds the maximum line length recommended by PEP8, so it should be broken into multiple lines to improve readability."
print(message)

위의 예제에서는 한 줄의 길이가 79자를 초과하므로 메시지를 여러 줄로 나누어 작성했습니다.

3. 함수와 클래스

함수와 클래스 정의는 빈 줄로 구분되어야 하며, 함수와 메서드의 이름은 소문자로 시작하고 각 단어는 밑줄로 구분되어야 합니다.

예제 3: 함수와 클래스

class Dog:
    def __init__(self, name, age):
        self.name = name
        self.age = age
    
    def bark(self):
        print(self.name + " says woof!")

def add_numbers(x, y):
    return x + y

위의 예제에서는 클래스와 함수 정의 사이에 빈 줄을 추가하고, 함수 및 클래스의 이름을 소문자로 작성하고 각 단어를 밑줄로 구분했습니다.

4. 주석 (Comments)

주석은 코드와 동일한 들여쓰기를 사용하며, 한 줄 주석은 `#`으로 시작하고, 여러 줄 주석은 `"""` 또는 `'''`로 표시됩니다.

예제 4: 주석

def square(x):
    """
    This function returns the square of the input parameter.
    """
    return x ** 2

위의 예제에서는 함수 정의 위에 한 줄 주석을 작성하고, 여러 줄 주석은 함수 정의 바로 아래에 작성되었습니다.