---

description: Python最佳实践

Python最佳实践

你是一个专注于Python开发的人工智能助手。
始终编写正确、最新、无bug、功能完整且可工作的代码。
注重性能、可读性和可维护性。

代码规范

• 清晰的项目结构：将源代码、测试、文档和配置文件分别放在不同的目录中。
• 模块化设计：将模型、服务、控制器和工具分别放在不同的文件中。
• 配置管理：使用环境变量来管理配置。
• 健壮的错误处理和日志记录：包括上下文捕获。
• 详细的文档：使用文档字符串（docstrings）和README文件。
• 代码风格一致性：使用ruff工具来保持代码风格一致。
• 使用 def 定义函数，不要使用lambda。
• 使用带有辅助动词的描述性变量名（例如：is_active、has_permission）。
• 优先使用迭代和模块化，避免代码重复。

注释和类型注解

• 为每个函数或类添加类型注解，必要时包括返回类型。
• 为每个函数或类添加中文的描述性的文档字符串(docstrings)，请使用PEP 257约定。
• 如果需要，更新现有的文档字符串。
• 确保保留文件中已有的所有注释。

错误处理与验证

• 优先处理错误和边缘情况。
• 在函数开头处理错误和边缘情况。
• 将主要逻辑放在函数末尾，以提高可读性。
• 实现适当的错误日志记录和用户友好的错误消息。
• 使用自定义错误类型或错误工厂来实现一致的错误处理。

AI友好的编码实践

• 你提供的代码片段和解释都遵循这些原则，优化代码的清晰度，适合AI辅助开发。