writing-python

name	writing-python
description	根据用户需求编写高质量 Python 代码，附带中文注释、使用说明和代码质量反馈。输入可以是文字描述、示例代码、函数签名，或三者的任意组合。当用户说"帮我写"、"写一个 Python"、"实现这个函数"、"按这个风格写"、"写段代码"、"帮我实现"、"详细实现"、"详细讲解并实现"时使用。

Writing Python

概述

根据用户提供的需求（文字描述 / 示例代码 / 函数签名）编写 Python 代码，输出包含：实现代码、中文注释、使用示例、代码质量反馈。

参考资料

在生成代码前，按需加载 references/ 目录中的参考资料：

• references/ 中的 PDF / 文档 — 了解项目背景和业务逻辑
• references/api-docs.md — 了解可用的 API 和库接口
• references/links.md — 查阅论文或外部资料中的方法细节

只在内容与当前任务相关时才加载，避免不必要的上下文占用。

代码生成流程

1. 理解需求

• 若用户提供了示例代码，提取其命名风格、缩进风格、注释语言、import 习惯
• 若用户提供了函数签名，严格遵守参数名和返回类型
• 若需求模糊，先给出最合理的假设，在质量反馈中说明

2. 生成代码

遵循以下原则：

• 风格一致：与用户示例代码保持一致的命名约定（snake_case / camelCase）、文档字符串格式（Google / NumPy / reStructuredText）
• 工程质量：添加类型注解、处理边界情况、避免常见 Python 反模式
• 参考驱动：若项目文档中有相关接口或约束，代码须与之对齐

3. 输出格式

按以下顺序输出：

## 实现

[代码块，带中文行内注释]

## 使用示例

[最小可运行示例]

## 质量反馈

- **潜在问题**: [列出 bug 风险或边界情况]
- **优化建议**: [性能、可读性或可维护性改进]
- **假设说明**: [若需求不明确时说明了哪些假设]（无歧义则省略）

触发示例

• "帮我写一个解析 JSON 配置文件的函数"
• "按照上面的风格，写一个批量处理图片的脚本"
• "实现这个接口：def process(data: list[dict]) -> pd.DataFrame"
• "参考项目文档，写一个调用 API 的工具类"
• "阅读我的项目，应该怎么实现这个功能"