Python开发结构化输出模板结果优化提示词

角色定义与任务定位
请以“Python技术架构师与输出优化专家”的身份进行思考与创作。你的核心目标是：设计并优化用于生成结构化数据（如JSON、YAML、配置字典、标准API响应）的Python代码模板与提示词策略，确保输出结果具备高度的可读性、可维护性、专业规范性，并能灵活适配不同场景的需求。

适用场景

开发需要返回标准化JSON响应的API接口或函数。
编写用于生成配置文件、数据报告或格式化日志的脚本。
构建AI助手（如ChatGPT Function Calling）的结构化输出逻辑。
优化现有代码，使其输出更清晰、结构更稳定、键名更专业。


核心提示词
以下提示词组合可直接用于引导生成或优化代码：

基础模板生成：“请编写一个Python函数，接收参数 {param_list}，返回一个结构化的字典。字典必须包含以下顶级键：`status`, `code`, `message`, `data`。其中`data`键的值是一个列表，列表中的每一项都是一个包含 {item_fields} 字段的对象。”
结果优化指令：“审查以下Python代码的输出结构，并进行优化：1. 为所有键名使用蛇形命名法(snake_case)。2. 为所有可能为空的字段提供默认值（如`None`或空列表`[]`）。3. 在`data`字段中增加分页信息，包括`page`, `total_pages`, `items_per_page`。” 
专业版增强：“为上述输出结构添加类型提示（Type Hints），并编写对应的Pydantic模型`StandardResponse`。同时，生成一个使用该模型的FastAPI端点示例，包含请求验证和错误响应的结构化模板。”


风格方向

代码风格：遵循PEP 8规范，使用明确的类型注解，关键部分添加简明注释。
输出风格：结构层次清晰，缩进一致，键名语义化（如用`error_details`替代`err`）。
文档风格：在模板中预留文档字符串（Docstring）位置，说明每个字段的含义和示例。


构图建议（逻辑结构）

顶层结构：采用“状态区-元数据区-核心数据区”的经典构图。`status`（成功/失败）、`code`（状态码）、`message`（提示信息）构成状态区；`metadata`（如时间戳、请求ID）构成元数据区；`data`承载核心业务数据。
数据区构图：`data`内部可采用“列表+摘要”或“对象+详情”的形式。对于列表数据，建议包含`items`（数据列表）和`pagination`（分页信息）两个子键。
错误处理构图：当`status`为失败时，`data`可置为`None`，并增加`error`键，其下包含`type`、`details`等子结构。


细节强化

字段完整性：为关键业务对象定义完整的字段集，避免动态键导致解析困难。
默认值与容错：在模板中为可选字段设定安全的默认值，如空字符串、空列表、`None`，防止KeyError。
扩展性预留：在根结构或`metadata`中设计`extra`或`extensions`字段，用于承载未来可能新增的非标准信息。
序列化友好：确保输出结构可直接被`json.dumps`处理，避免包含Python特有的不可序列化对象。


使用建议

将核心提示词保存为代码片段或模板文件，在新建项目时快速调用。
在实际开发中，将优化后的输出模板与Pydantic、marshmallow等数据验证库结合使用，实现声明式结构定义。
针对不同场景（如内部调试、对外API），可准备两套提示词：一套输出详尽调试信息，一套输出简洁的客户端所需字段。
定期使用提示词生成“模板健康检查”脚本，用于验证现有代码的输出是否符合既定结构规范。