파이썬 코딩 스타일

1. 기본 규칙

들여쓰기

• 스페이스(space)로 4칸공백 사용

• 코드 블록을 명확하게 구분하기 위해 반드시 일관된 들여쓰기 사용

def greet_user(name):
    if name:
        print(f"Hello, {name}!")
    else:
        print("Hello, World!")

라인 길이

• 한 줄에 79자 이하로 작성 권장

• 초과시 백슬래쉬() 또는 괄호를 사용해 줄바꿈 처리

# 올바른 줄바꿈 예시
total = (first_value + second_value + third_value + 
         fourth_value + fifth_value)

공백

• 연산자와 쉼표 앞뒤에 적절한 공백을 유지

• 함수 정의 및 호출 시 괄호 바로 앞뒤에 공백을 넣지 않음

# 올바른 예시
x = 10
y = x + 5
result = my_function(arg1, arg2)

# 잘못된 예시
x=10
y = x+5
result = my_function( arg1 , arg2 )

2. 변수, 함수, 클래스 명명 규칙

변수 및 함수 이름

• snakecase 스타일을 사용(소문자와 언더스코어 조합)

• 의미 있는 이름을 사용하고, 약어는 지양합니다

# 올바른 예시
user_name = "Alice"
def calculate_sum(a, b):
    return a + b

상수 이름

• UPPER_SNAKE_CASE 사용(대문자와 언더스코어 조합)

MAX_SIZE = 100
DEFAULT_NAME = "Guest"

클래스 이름

• PascalCase 스타일 사용(모든단어의 첫글자를 대문자)

class UserProfile:

3. 주석

주석 작성

• 주석은 간결하고 명확하게 작성

• 코드와 관련 없는 불필요한 주석은 피하고, 왜 그런 코드를 작성했는지 설명하는 데 집중

• # 내용

# 잘못된 예시
x = 10  # x 값을 10으로 설정

# 올바른 예시
x = 10  # 사용자 입력 값의 기본 값 설정

문서화 주석

• 함수, 클래스, 모듈에 대한 설명을 위해 Docstring 사용

• """ 내용 """

def add(a, b):
    """두 숫자의 합을 반환합니다.

    Args:
        a (int): 첫 번째 숫자
        b (int): 두 번째 숫자

    Returns:
        int: 두 숫자의 합
    """
    return a + b