测试开发技术网站

[TOC]

![](https://redrose2100.oss-cn-hangzhou.aliyuncs.com/img/86eddc30-7c4e-11ee-beb1-0242ac110004.png)

### PEP 8简介

PEP 8，或Python Enhancement Proposal 8，是一个官方文档，发布于2001年。它由Guido van Rossum，Python语言的创始人，以及Barry Warsaw和Nick Coghlan等社区成员共同编写。该文档提供了编写清晰代码的指南，这些指南自发布以来已成为Python开发者编程的基石。

### 基本遵循原则

#### 1. 缩进

使用4个空格进行缩进，不使用制表符（Tab）。这有助于保持代码在不同的编辑器和环境中的一致性。

#### 2. 行宽

每行代码不超过79个字符，这样可以不用滚动就能在编辑器中查看完整的代码行，也便于在代码审查时并排比较。

#### 3. 空行

在函数定义之间使用两个空行，类定义之间使用两个空行，方法定义之间使用一个空行。这有助于区分代码段，并提高可读性。

#### 4. 导入

每个导入应该分开写在不同的行上，而且应该放在文件的顶部。按照标准库，第三方库，应用程序指定部分的顺序导入。

#### 5. 空格

在二元运算符两侧使用一个空格，如赋值(=), 比较(==, <, >, !=, <>, <=, >=, in, not in, is, is not), 布尔(and, or, not)。不要用空格来垂直对齐代码。

#### 6. 命名约定

变量名应该小写，如有多个单词，用下划线分隔。类名应该使用首字母大写的约定。内部使用的变量和方法应该以一个下划线开头。常量应该用大写字母和下划线分隔。

#### 7. 表达式和语句中的空格

不要在小括号、中括号、或大括号内侧使用多余的空格。函数的参数列表中，逗号之后要有一个空格，但之前不要有空格。

#### 8. 注释

注释应该是完整的句子。如果注释是一段代码的一部分，则该注释应该与该代码在同一个缩进水平上。对于行注释，应该至少使用两个空格与代码隔开。

#### 9. 编码声明

在Python文件的顶部，应该有一个编码声明，尤其是当文件中有非ASCII字符时。通常使用 `# -*- coding: utf-8 -*-`。

#### 10. 文档字符串

对于公共模块、函数、类和方法，应当编写文档字符串。这些字符串后面应该紧跟着定义，使用三重双引号。

PEP 8不是强制性的，而是一套指导原则和最佳实践，旨在帮助Python开发者编写风格一致和易于维护的代码。然而，有时候在特定的情况下，有意识地违反这些规则也是可以接受的，尤其是当遵循这些规则会降低代码可读性时。重要的是开发团队之间要有共识，并保持代码风格的一致性。

测试开发技术网站

博客