Google Python Style Guide

• 语言: 英语
• 格式: .pdf
• 来源: github.com/fgaray

摘要

文档是Google的Python编程风格指南，主要涵盖了Python语言和代码风格的规范。内容包括如何使用注释、字符串、导入、缩进等代码格式规则，强调了代码的一致性和可读性。文档还提到了避免使用某些高级Python特性，如元类和反射，建议使用更清晰的替代方法。此外，文档强调了关闭文件和套接字的重要性，以及如何避免潜在的资源消耗问题。

AI总结

《Google Python Style Guide》是Google为统一Python代码风格而制定的指南，旨在提高代码的可读性和可维护性。以下是文档的核心内容总结：

### 1. **背景**
- Python是Google的主要脚本语言。
- 该风格指南提供了编码规范，帮助开发者正确格式化代码。
- 推荐使用Vim的设置文件，Emacs默认设置已适用。

### 2. **Python语言规则**
- **Lint**：使用`pylint`进行代码检查，避免容易忽略的错误（如拼写错误、变量在赋值前使用等）。
- **Shebang行**：仅在可执行文件中使用`#!/usr/bin/env python`（可带`2`或`3`后缀）。
- **命名规则**：
- 模块、函数、方法和内联注释需使用正确的风格。
- 文档字符串使用三双引号（`"""`），格式需简洁明了。
- **避免复杂特性**：尽量避免使用元类、动态继承、反射等高级特性，除非绝对必要。

### 3. **Python风格规则**
- **分号**：禁止使用分号将两条命令放在一行。
- **行长度**：最大行长不超过80字符，长导入语句和URL例外。
- **对齐**：避免使用空格对齐符号（如`:`、`#`、`=`等）。
- **括号换行**：使用括号实现隐式行合并，避免使用反斜杠续行。

### 4. **文件和套接字**
- 显式关闭文件和套接字，避免资源泄漏。
- 避免不必要的文件或套接字操作。

### 5. **装饰器**
- 谨慎使用装饰器，确保其功能明确。
- 装饰器应遵循与函数相同的导入和命名规范。
- 装饰器代码应提供单元测试，并避免依赖外部资源。

### 6. **线程**
- 避免依赖内置类型（如字典）的原子性。
- 使用`Queue`模块或`threading`模块，并正确使用条件变量。

### 7. **强大功能**
- 避免使用可能增加代码复杂性的高级Python特性，如动态继承、对象重定向等。

### 8. **弃用的语言特性**
- 使用函数调用代替`apply`。
- 优先使用列表推导式和`for`循环代替`filter`和`map`。
- 使用字符串方法代替`string`模块。

### 9. **其他注意事项**
- **全局变量**：仅在明确需要时使用。
- **局部变量**：避免在函数内部随意修改外部变量。
- **装饰器**：避免在导入时执行可能失败的操作。

### 总结
《Google Python Style Guide》强调代码的可读性、简洁性和一致性，旨在帮助开发者编写更规范、更易维护的Python代码。遵循这些规则可以减少潜在错误，提高团队协作效率。