Python 모범 사례: 깔끔하고 유지 관리 가능한 코드 작성-파이썬 튜토리얼-php.cn

Python 모범 사례: 깔끔하고 유지 관리 가능한 코드 작성

Mary-Kate Olsen

풀어 주다： 2025-01-03 15:20:38

원래의

354명이 탐색했습니다.

Python Best Practices: Writing Clean and Maintainable Code

Python은 단순성과 가독성으로 인해 초보자와 숙련된 개발자 모두에게 환상적인 언어입니다. 그러나 깔끔하고 유지 관리가 가능한 코드를 작성하려면 기본적인 구문 지식 이상이 필요합니다. 이 가이드에서는 Python 코드 품질을 향상시키는 필수 모범 사례를 살펴보겠습니다.

PEP 8의 힘

PEP 8은 Python의 스타일 가이드이며 이를 일관되게 따르면 코드를 더 읽기 쉽고 유지 관리하기 쉽게 만들 수 있습니다. 몇 가지 주요 원칙을 살펴보겠습니다.

# Bad example
def calculate_total(x,y,z):
    return x+y+z

# Good example
def calculate_total(price, tax, shipping):
    """Calculate the total cost including tax and shipping."""
    return price + tax + shipping

로그인 후 복사

유형 힌트 수용

Python 3의 유형 힌트는 코드 명확성을 향상하고 더 나은 도구 지원을 가능하게 합니다.

from typing import List, Dict, Optional

def process_user_data(
    user_id: int,
    settings: Dict[str, str],
    tags: Optional[List[str]] = None
) -> bool:
    """Process user data and return success status."""
    if tags is None:
        tags = []
    # Processing logic here
    return True

로그인 후 복사

리소스 관리를 위한 컨텍스트 관리자

with 문과 함께 컨텍스트 관리자를 사용하면 적절한 리소스 정리가 보장됩니다.

# Bad approach
file = open('data.txt', 'r')
content = file.read()
file.close()

# Good approach
with open('data.txt', 'r') as file:
    content = file.read()
    # File automatically closes after the block

로그인 후 복사

깔끔한 오류 처리 구현

적절한 예외 처리는 코드를 더욱 강력하게 만듭니다.

def fetch_user_data(user_id: int) -> dict:
    try:
        # Attempt to fetch user data
        user = database.get_user(user_id)
        return user.to_dict()
    except DatabaseConnectionError as e:
        logger.error(f"Database connection failed: {e}")
        raise
    except UserNotFoundError:
        logger.warning(f"User {user_id} not found")
        return {}

로그인 후 복사

목록 이해를 현명하게 사용하세요

목록 이해는 코드를 더 간결하게 만들 수 있지만 가독성을 희생하지 마세요.

# Simple and readable - good!
squares = [x * x for x in range(10)]

# Too complex - break it down
# Bad example
result = [x.strip().lower() for x in text.split(',') if x.strip() and not x.startswith('#')]

# Better approach
def process_item(item: str) -> str:
    return item.strip().lower()

def is_valid_item(item: str) -> bool:
    item = item.strip()
    return bool(item) and not item.startswith('#')

result = [process_item(x) for x in text.split(',') if is_valid_item(x)]

로그인 후 복사

구조화된 데이터를 위한 데이터 클래스

Python 3.7 데이터 클래스는 데이터 컨테이너의 상용구를 줄입니다.

from dataclasses import dataclass
from datetime import datetime

@dataclass
class UserProfile:
    username: str
    email: str
    created_at: datetime = field(default_factory=datetime.now)
    is_active: bool = True

    def __post_init__(self):
        self.email = self.email.lower()

로그인 후 복사

테스트는 협상할 수 없습니다

항상 pytest를 사용하여 코드에 대한 테스트를 작성하세요.

import pytest
from myapp.calculator import calculate_total

def test_calculate_total_with_valid_inputs():
    result = calculate_total(100, 10, 5)
    assert result == 115

def test_calculate_total_with_zero_values():
    result = calculate_total(100, 0, 0)
    assert result == 100

def test_calculate_total_with_negative_values():
    with pytest.raises(ValueError):
        calculate_total(100, -10, 5)

로그인 후 복사