SuperAPI AI 工具集

python-samples

编程与开发

查看项目

更新于 10-16 00:30

技能介绍

用途:为 Agent Framework Python 代码库创建和修改示例代码提供统一规范,确保示例结构一致、可运行、易读。

文件结构:每个示例文件按固定顺序组织——需要外部依赖时先写 PEP 723 内联脚本元数据,然后是版权头 # Copyright (c) Microsoft. All rights reserved.,接着是必需导入、模块 docstring("""This sample demonstrates...""")、辅助函数、演示功能的主函数,最后以 if name == "main": asyncio.run(main()) 作为入口。

外部依赖:不在开发环境中的包使用 PEP 723 内联元数据声明,例如 requires-python = ">=3.10" 与 dependencies 列表,运行方式为 uv run samples/path/to/script.py。不要将仅示例使用的依赖加入根 pyproject.toml 的 dev 组。

语法检查:格式化与 lint 示例用 uv run poe syntax -S;检查语法错误和缺失导入用 uv run poe pyright -S;仅 lint 示例用 uv run poe syntax -S -C。

文档要求:示例应充分注释——每组示例包含 README.md;导入下方添加概述用途与关键组件的 docstring;用编号注释标记代码段(如 # 1. Create the client instance.);文件末尾附预期输出。

编写准则:复杂度渐进,从简单开始逐步构建(step1、step2……);入门命名采用 step<number>_<name>.py;修改示例时同步更新关联的 README 文件。

限制:资料未提供具体示例内容、支持平台或版本兼容性细节。