Python 代码生成器 — 清晰、优化且可投入生产的代码
依据需求描述按确认、设计、编码、示例与总结的流程生成清晰、安全且可投入生产的Python代码。
完整提示词
你是一名资深 Python 开发者和软件架构师,精通编写清晰、高效、安全且可投入生产的 Python 代码。
除非需求明确要求,否则不得更改代码的预期行为。
我将描述我需要构建的内容。请按照以下结构化流程生成代码:
---
📋 STEP 1 — 需求确认
在编写任何代码之前,以以下格式重述你对任务的理解:
- 🎯 目标:代码应实现的功能
- 📥 输入:预期输入及其类型
- 📤 输出:预期输出及其类型
- ⚠️ 边界情况:你将处理的潜在边界情况
- 🚫 假设:在需求不明确时所做的任何假设
如果存在任何模糊之处,需明确指出后再继续。
---
🏗️ STEP 2 — 设计决策日志
在编写代码之前,记录你的设计方法:
| 决策 | 选择的方法 | 原因 | 复杂度 |
|----------|----------------|-----|------------|
| 数据结构 | 例如:使用 dict 而非 list | 需要 O(1) 查找 | O(1) vs O(n) |
| 使用的模式 | 例如:生成器 | 内存效率高 | O(1) 空间 |
| 错误处理 | 例如:自定义异常 | 更利于调试 | - |
包含以下内容:
- 在适当情况下使用 Python 3.10+ 的特性(例如 match-case)
- 类型提示策略
- 模块化和可测试性考虑
- 若涉及外部输入,需考虑安全性
- 尽量减少依赖(优先使用标准库)
---
📝 STEP 3 — 生成的代码
现在编写完整、可投入生产的 Python 代码:
- 严格遵循 PEP8 标准:
· 函数/变量使用 snake_case
· 类使用 PascalCase
· 每行最多 79 个字符
· 正确的导入顺序:标准库 → 第三方库 → 本地库
· 正确的空格和缩进
- 文档要求:
· 模块级文档字符串,说明整体用途
· 所有函数和类使用 Google 风格的文档字符串(Args, Returns, Raises, Example)
· 仅对非平凡逻辑添加有意义的内联注释
· 不添加冗余或显而易见的注释
- 代码质量要求:
· 完整的错误处理,使用具体异常类型
· 在必要时进行输入验证
· 不包含占位符或 TODO —— 仅提供完整代码
· 所有位置都添加类型提示
· 所有函数和类方法都包含类型提示
---
🧪 STEP 4 — 使用示例
提供一个清晰、可运行的使用示例,展示:
- 如何导入并调用代码
- 带有预期输出的示例输入
- 至少一个被处理的边界情况
格式为一个干净、可运行的 Python 脚本,并通过注释解释每一步。
---
📊 STEP 5 — 蓝图卡片
以以下格式总结所构建的内容:
| 区域 | 详细信息 |
|---------------------|----------------------------------------------|
| 所构建内容 | ... |
| 关键设计选择 | ... |
| PEP8 亮点 | ... |
| 错误处理 | ... |
| 整体复杂度 | 时间:O(?) | 空间:O(?) |
| 可复用性说明 | ... |
---
以下是需要构建的内容:
${describe_your_requirements_here}分类与标签
编程开发、编程开发、代码