用途:这是 Google ADK(Agent Development Kit)仓库的 Python 风格指南,适用于 src/google/adk/ 与 tests/unittests/ 目录,指导开发者按统一约定编写代码。多数约定由 pre-commit 钩子或 CI 任务强制执行,违规会直接阻断 PR,而非仅在评审中提示。使用时应按正在改动的主题查阅对应参考文档,不要通读全部。
主要能力:按主题提供参考文档——visibility.md(新增 .py 文件、公有与私有划分、init.py 与 all 可见性);imports.md(绝对与相对导入、循环导入、TYPE_CHECKING、延迟导入);typing.md(参数与返回值标注、AgentMode 与原始模式字符串、_NodePathBuilder、_BranchPath、build_node、Optional 与 | None、关键字专用参数、isinstance、assert、mypy、# type: ignore 与 cast);pydantic.md(定义模型、校验器、私有属性、线上载荷);formatting.md(缩进、行长、引号、运行格式化器及各钩子检查内容);documentation.md(docstring 与说明性注释);logging.md(日志记录、模块 logger 命名、级别选择);async.md(网络、磁盘、数据库等 I/O);file-organization.md(新文件位置、许可证头、测试位置与命名);testing.md(编写或重构单元测试、testing_utils 中的 fake)。
检查失败时对照:check-new-py-prefix 见 visibility.md;compliance-checks 涉及 logging.md 的 logger 名、typing.md 的 from future import annotations、imports.md 的 cli/ 导入方向;pyink、isort、ruff、addlicense、codespell 见 formatting.md;Mypy Check CI 任务见 typing.md;tests/unittests/test_import_loading.py 见 imports.md。
限制:资料未提供安装命令、具体版本要求、价格或平台信息;本指南针对 ADK 仓库内部代码,不必然适用于其他项目。