结构化Python开发代码生成调试提示词

角色定义：结构化Python开发工程师
你是一位经验丰富的Python开发工程师，擅长将复杂的开发需求拆解为结构清晰、逻辑严谨的任务模块。你的核心目标是：与AI协作，高效生成高质量、可维护的代码，并系统化地进行调试与优化，确保代码的健壮性和专业性。

任务定位：模块化代码生成与系统化调试
本提示词方案旨在指导你完成从需求分析到代码交付的全流程。它并非简单的代码片段请求，而是要求你以项目驱动的思维，明确功能边界、输入输出、异常处理，并建立可复用的调试与优化框架。

适用场景

需要生成具备完整函数、类、模块结构的Python代码。
对现有代码进行逻辑重构、性能优化或增加健壮性。
系统性地定位、分析并修复代码中的错误与异常。
为特定功能（如数据处理、API接口、算法实现）编写标准化代码。


核心提示词（可直接使用）

生成模块化函数：“请以Python函数形式实现一个[具体功能，如：解析JSON配置文件并验证必填字段]。要求：1. 函数签名清晰，包含参数类型提示和返回类型提示；2. 包含详细的文档字符串（docstring），说明功能、参数、返回值和可能抛出的异常；3. 内部逻辑分步骤注释，并考虑边界条件与错误处理。”
生成完整类结构：“设计一个Python类 `[类名]`，用于管理[管理对象，如：数据库连接池]。要求：1. 定义清晰的 `__init__` 方法初始化关键属性；2. 实现核心方法 `[方法名A]` (负责[功能A]) 和 `[方法名B]` (负责[功能B])；3. 使用属性装饰器 `@property` 保护关键状态；4. 确保线程安全或给出相关注释。”
结构化调试请求：“以下代码片段在[描述具体场景，如：输入特定值]时出现了 `[具体错误类型或异常行为]`。请：1. 分析可能导致此问题的原因（列出1-3点）；2. 提供修复后的完整代码段；3. 建议一种添加日志或断言来预防同类问题的方法。”
代码审查与优化：“请对以下Python代码进行审查：1. 指出潜在的性能瓶颈（如循环内的低效操作）或代码风格问题（PEP 8）；2. 提出具体的优化建议（例如，使用列表推导式、缓存机制）；3. 给出优化后的代码版本。”


风格方向

代码风格：严格遵守PEP 8规范，变量命名具有描述性，避免魔法数字。
结构风格：模块化设计，高内聚低耦合，函数单一职责。
文档风格：所有公共函数、类及模块均需包含完整的类型提示和说明性文档字符串。
错误处理风格：使用具体的异常类型，提供有意义的错误信息，避免裸露的 `except:`。


构图建议（逻辑流程构图）

生成任务：需求分析 -> 定义接口（输入/输出） -> 编写主体逻辑 -> 添加错误处理与日志 -> 编写单元测试用例。
调试任务：复现问题 -> 定位错误位置（代码行、堆栈） -> 假设验证（提出可能原因） -> 实施修复 -> 验证修复效果（测试与回归）。
优化任务：性能剖析（定位热点） -> 算法/数据结构评估 -> 重构实施 -> 基准测试对比。


细节强化

扩展词：在提示中可加入“考虑使用 `typing` 模块进行更精确的类型注解”、“使用 `contextmanager` 管理资源”、“添加 `pytest` 格式的测试用例”。
氛围描述：代码应体现“工业级可靠性”、“清晰的逻辑流”和“易于协作的可读性”。
材质细节：像“打磨光滑的模块接口”、“坚固的异常处理边界”、“高效的算法内核”一样构建代码。


使用建议

在使用核心提示词时，请将方括号 `[]` 中的占位符替换为你的具体需求，描述越精确，生成结果越佳。
建议将“生成”与“调试/优化”提示词结合使用，形成“生成-审查-优化”的迭代闭环。
对于复杂任务，可拆分为多个子提示词依次执行，例如先生成类框架，再请求实现具体方法。
将常用的结构化提示词保存为模板，根据开发阶段（原型、测试、部署）快速调用。