SuperAPI AI 工具集

python-guidelines

编程与开发

查看项目

更新于 10-16 05:46

技能介绍

用途:在编写、审查或重构 Python 代码时使用,强调融入现有代码而非追加代码,遵循 PEP 20(简洁优于复杂、扁平优于嵌套、错误不应静默通过)。

主要能力:规范代码哲学(匹配现有命名、导入和签名模式,复用现有工具与数据结构)、简单优于抽象(YAGNI,避免单实现抽象类、无谓配置项、不可能场景的错误处理、单函数包装类等,三行相似代码优于过早抽象,但保持函数名清晰、模块分组、命名一致、I/O 与逻辑分离、显式参数)、环境规范(包管理器用 uv 而非 pip,虚拟环境用 source .venv/bin/activate 或 uv run python -c "...",第三方包可用 python -c "import pkg; print(pkg.file)" 定位源码)、测试纪律(不假设,建议先用 python -c 验证行为)、Google 风格 docstring 规则(摘要用祈使语气、Args 含类型与说明、Returns 类型加括号、类只用 Attributes、测试用单行)。

使用方式:编写代码前先按需阅读参考文件——references/idiomatic-patterns.md(循环、推导式、解包、上下文管理器、dataclass 等 18 个惯用法)、references/zen-of-python.md、references/google-style-guide.md、references/effective-python-tips.md。

适用场景:Python 项目开发、代码审查、重构、文档字符串规范。

限制:资料未提供安装命令、平台、收费或效果信息,暂未提供。