Python のベストプラクティス: クリーンで保守可能なコードを作成する-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)

ログイン後にコピー