Google Python Style Guide

### 《Google Python Style Guide》总结 #### 概述 Google Python Style Guide 是为 Python 编程提供的一份编码规范指南，旨在帮助开发者编写符合 Google 代码风格的 Python 程序。以下是文档的核心内容总结： --- ### 1. **Python 语言规则** - **Lint**：使用 pylint 检查代码质量，避免潜在错误。 - **避免过于复杂的特性**：不要滥用 Python 的“酷”特性，保持代码简洁易读。 - **字符串方法**：尽量使用字符串方法，而非 `string` 模块。 - **现代化语言特性**：优先使用列表推导式、生成器和 `for` 循环，避免使用 `filter`、`map`（无 inline lambda）、`reduce` 和 `apply`。 - **缩进和作用域**：允许使用嵌套函数和词法作用域，但需注意变量赋值的作用域规则。 --- ### 2. **Python 样式规则** - **分号**：不要在行末使用分号，不要将多个语句写在同一行。 - **行长**：单行代码不超过 80 个字符，允许例外： - 长导入语句。 - 注释中的 URL。 - 使用隐式行连接（如括号内换行）。 - **括号**：不需要在返回语句或条件表达式中添加不必要的括号。 - **缩进**：使用 4 个空格缩进，避免混合缩进。 - **空白字符**：避免在代码中添加不必要的空白，例如不对齐赋值或字典键。 - **Shebang 行**：主程序文件顶部加入 `#!/usr/bin/env python`。 - **注释**：确保模块、函数、类等使用 docstring，其他注释要简洁明了。 - **字符串**：多行字符串优先使用 `"""`，避免使用 `\` 转义字符。 - **文件和套接字**：显式关闭文件和套接字，避免资源泄漏。 --- ### 3. **其他规则** - **命名惯例**： - **模块**：使用 `lower_with_under`。 - **类**：使用 CapWords。 - **函数、方法、参数**：使用 `lower_with_under`。 - **常量**：使用 `CAPS_WITH_UNDER`。 - **主程序**：确保脚本文件可导入，将主程序逻辑放入 `main()` 函数中，使用 `if __name__ == '__main__'` 判断。 - **一致性**：尽量与周围代码风格保持一致，避免显著差异。 --- ### 4. **修订信息** 本文档是 Google Python Style Guide 的修订版（Revision 2.59），由多位贡献者编写。 --- ### 总结 Google Python Style Guide 的核心目标是通过一致的代码风格规范，提升代码可读性和可维护性。通过避免不必要的复杂性、使用现代化语言特性、保持简洁的代码格式和一致的命名惯例，开发者可以更高效地协作并确保代码质量。