【自学Python】Python编码规范

灰太狼 2024-03-30 16:21 83阅读 0赞

## Python编码规范 ##

### Python编码规范教程 ###

**Python** 采用 PEP 8 作为编码规范，其中 PEP 是 Python Enhancement Proposal（Python 增强建议书）的缩写，8 代表的是 Python 代码的样式指南。

### Python编码规范 ###

#### 代码缩进 ####

在 Python 中，代码缩进推荐使用四个空格，而不是一个 tab 键。

#### 最大行宽 ####

限制所有行的最大行宽为 79 字符。文本长块，比如文档字符串或注释，行长度应限制为 72 个字符。

#### 空行 ####

使用空行分割顶层函数和类的定义。类中的方法的定义使用单个空行进行分割。

额外的空行可以必要的时候用于分割不同的函数组，但是要尽量节约使用。

额外的空行可以必要的时候在函数中用于分割不同的逻辑块，但是要尽量节约使用。

#### 空格 ####

各种右括号前不要加空格。

逗号、冒号、分号前不要加空格。

函数的左括号前不要加空格，如 `Func(1)`。

序列的左括号前不要加空格，如 `list[2]`。

操作符左右各加一个空格，不要为了对齐增加空格。

函数默认参数使用的赋值符左右省略空格。

#### import导入 ####

import导入始终在文件的顶部，在模块注释和文档字符串之后，在模块全局变量和常量之前。

导入顺序如下：标准库进口，相关的第三方库，本地库。各组的导入之间要有空行。

不要在一行 import 多个库，每行只能 import 一个库。

#### 注释 ####

总体原则，错误的注释不如没有注释。所以当一段代码发生变化时，第一件事就是要修改注释。

注释必须使用英文，最好是完整的句子，首字母大写，句后要有结束符，结束符后跟两个空格，开始下一句。如果是短语，可以省略结束符。

块注释，在一段代码前增加的注释。行注释，在一句代码后加注释。但是这种方式尽量少使用。

#### 命名规则 ####

模块命名尽量短小，使用全部小写的方式，可以使用下划线。

包命名尽量短小，使用全部小写的方式，不可以使用下划线。

类的命名使用 `CapWords` 的方式，模块内部使用的类采用 `_CapWords` 的方式。

异常命名使用 `CapWords+Error` 后缀的方式。

全局变量尽量只在模块内有效，类似 C语言 中的 static。

函数命名使用全部小写的方式，可以使用下划线。

常量命名使用全部大写的方式，可以使用下划线。

类的属性（方法和变量）命名使用全部小写的方式，可以使用下划线。类的属性若与关键字名字冲突，后缀一下划线，尽量不要使用缩略等其他方式。

为避免与子类属性命名冲突，在类的一些属性前，前缀两条下划线。

类的方法第一个参数必须是self，而静态方法第一个参数必须是cls。

### Python编码规范总结 ###

Python 采用 PEP 8 作为编码规范。

发表评论取消回复

表情：

评论列表（有 0 条评论，83人围观）

还没有评论，来说两句吧...

相关阅读

相关【自学Python】Python编码规范

Python编码规范 Python编码规范教程 Python 采用 PEP 8 作为编码规范，其中 PEP 是 Python Enhancement Proposa

灰太狼/ 2024年03月30日 16:21/ 0 赞/ 84 阅读

相关编码规范

编码规范 1. 代码清晰度 > 无规矩不成方圆，编程也是有套路的，好的代码不仅要好的性能，还要有好的规范。 > > 如果代码没有按照一定的规范进行编写，那么代码的

不念不忘少年蓝@/ 2023年02月27日 13:32/ 0 赞/ 28 阅读

相关编码规范

一　命名规则 1）包：命名应该都是名词或名词性词组，全部小写，单词之间用"."分开;一般使用本公司／组织网站域名的逆序后跟具体的软件内部模块名包命名举例： pac

小咪咪/ 2022年08月07日 09:41/ 0 赞/ 324 阅读

相关 JAVA编码规范

JAVA编码规范为什么要规范编码？？基本是从这三个方面考虑： 1）软件开发阶段，规范编码可以使项目开发的其他程序员理解你的代码。 2）软件生命周期中，80%的

待我称王封你为后i/ 2022年08月05日 01:29/ 0 赞/ 285 阅读

相关 PSR规范--php编码规范

前言:一开始写代码的时候，只是自己觉得怎么舒服怎么写，什么格式都是自己觉得顺眼就怎么安排，没有怎么阅读什么规范的代码，最近读了《PHP The Right Way》，发现写代码

偏执的太偏执、/ 2022年06月13日 13:27/ 0 赞/ 327 阅读

相关 Android编码规范

本文转自：[http://www.jianshu.com/p/0a984f999592][http_www.jianshu.com_p_0a984f999592] 1. 前

超、凢脫俗/ 2022年06月09日 10:48/ 0 赞/ 265 阅读

相关编码规范(二)----JAVA编码规范插件

一、前言在项目开发的过程中，很多时候，无法统一大家的编码规范，你有你的风格，我有我的风格，虽然每个公司都有自己的规范，但是有时候，作为开发人员的我们，写者写着，就

小鱼儿/ 2022年06月03日 04:15/ 0 赞/ 2484 阅读

相关 JavaScript 编码规范

> 注：此规范来自 Airbnb JavaScript Style Guide \[ 用更合理的方式写 JavaScript \] 目录

一时失言乱红尘/ 2022年05月23日 12:10/ 0 赞/ 284 阅读

相关 python编码规范

python中有很多不易发现的编码错误，比如我照着别人的写了一个，自己调试的时候发现了很多错误，还好有pyCharm编辑器的提示，就在这里零散的记录下，以免再犯 1. 空行

╰+哭是因爲堅強的太久メ/ 2022年05月10日 02:56/ 0 赞/ 284 阅读

相关前端编码规范

前端编码规范 > 说明：此编码规范为测试版本，适用于前后段分离项目的前端。如有不足请补充目录 1. IDE 2. 文件目录 3. 书写规范 4. 编码规

拼搏现实的明天。/ 2021年12月11日 17:07/ 0 赞/ 372 阅读