Python 最佳实践：编写简洁且可维护的代码-Python教程-PHP中文网

首页

后端开发

Python教程

Python 最佳实践：编写简洁且可维护的代码

Mary-Kate Olsen

Jan 03, 2025 pm 03:20 PM

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)

登录后复制