开发者社区> AI悦创> 正文
阿里云
为了无法计算的价值
打开APP
阿里云APP内打开

PEP8 Python代码规范

简介: 笔记
+关注继续查看

一、PEP8简介

PEP8是一份关于Python编码规范指南, 遵循该规范能够帮助Python开发者编写出优雅的代码, 提高代码的可读性.


Python PEP8 编码规范官方文档:https://www.python.org/dev/peps/pep-0008/


Python PEP8 编码规范中文版:https://www.python.org/dev/peps/pep-0008/


二、代码规范

详细规范可查看Python PEP8 编码规范官方文档和Python PEP8 编码规范中文版


(1) 代码布局


缩进: 每个缩进使用4个空格, 不推荐使用Tab, 禁止混用空格与Tab

行的最大长度: 每行最大长度79, 换行可以使用反斜杠, 但建议使用圆括号

空白行: 顶层函数和定义的类之间空两行, 类中方法定义之间空一行; 函数内逻辑无关的代码段之间空一行, 其他地方尽量不要空行


(2) 空格的使用


右括号前不要加空格

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

函数的左括号前不要加空格, 如 fun(1)

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

操作符左右各加一个空格, 如 c = a + b

不要将多条语句写在同一行

if、for、while语句中, 即使执行语句只有一句, 也必须另起一行


总结

  • 前不加空格
  • 操作符左右各加一个空格
  • 不要写在同一行


(3) 代码注释


块注释: 块注释跟随被注释的代码,缩进至与代码相同的级别. 块注释使用”#”开头

行内注释: 与被注释的代码同行, 注释使用”#”开头, 与被注释的代码至少有两个空格分隔

文档字符串: 文档字符串指为所有公共模块、函数、类及方法编写的文档说明. 文档字符串使用三引号包裹


(4) 命名规范


不要使用字母 “l”(L的小写)、”O”(大写O)、”I”(大写I)作为单字符变量名

模块名、包名应简短且全为小写

函数名应该小写, 可以使用下划线分隔小写单词

类名首字母一般使用大写

常量通常采用全大写命名


(5)变量命名规范


有字母、数字、和下划线组成, 且不以数字开头

区分大小写

通熟易懂, 见名知意

如果由两个及以上单词组成,单词与单词之间使用下划线连接



版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

相关文章
30 个极简Python代码,拿走即用(真干货)五
学 Python 怎样才最快,当然是实战各种小项目,只有自己去想与写,才记得住规则。本文是 30 个极简任务,初学者可以尝试着自己实现;本文同样也是 30 段代码,Python 开发者也可以看看是不是有没想到的用法。
0 0
30 个极简Python代码,拿走即用(真干货)四
学 Python 怎样才最快,当然是实战各种小项目,只有自己去想与写,才记得住规则。本文是 30 个极简任务,初学者可以尝试着自己实现;本文同样也是 30 段代码,Python 开发者也可以看看是不是有没想到的用法。
0 0
30 个极简Python代码,拿走即用(真干货)二
学 Python 怎样才最快,当然是实战各种小项目,只有自己去想与写,才记得住规则。本文是 30 个极简任务,初学者可以尝试着自己实现;本文同样也是 30 段代码,Python 开发者也可以看看是不是有没想到的用法。
0 0
Python编程:MySQLdb模块对数据库的基本增删改查操作
Python编程:MySQLdb模块对数据库的基本增删改查操作
0 0
Python编程:entry_points将Python模块转变为命令行工具
Python编程:entry_points将Python模块转变为命令行工具
0 0
Python编程:SQLAlchemy查询数据没有变化
遇到一个问题,使用一条相同的sql,多次查询数据库,每次数据都一样,而且数据库更新了,也没有查到新数据 经过Google,发现是SQLAlchemy的缓存机制导致的 设置隔离级别参数isolation_level 就可以解决
0 0
Python程序设计 实验9:GUI编程
Python程序设计 实验9:GUI编程
0 0
Python编程:运行目录或zip压缩文件
Python编程:运行目录或zip压缩文件
0 0
Python编程:PyThink数据库交互模块提高爬虫编写速度
Python编程:PyThink数据库交互模块提高爬虫编写速度
0 0
+关注
AI悦创
浅者见浅,深者见深
文章
问答
文章排行榜
最热
最新
相关电子书
更多
Python 脚本速查手册
立即下载
Python系列直播第一讲——Python中的一切皆对象
立即下载
Python第五讲——关于爬虫如何做js逆向的思路
立即下载