怎样提高Python代码可读性,并实现风格一致

Admin 2022-08-22 群英技术资讯 271 次浏览

这篇文章给大家分享的是“怎样提高Python代码可读性,并实现风格一致”,对大家学习和理解有一定的参考价值和帮助,有这方面学习需要的朋友,接下来就跟随小编一起学习一下吧。

1,缩进使用4个空格, 空格是首选的缩进方式. Python3 不允许混合使用制表符和空格来缩进。

2,每一行最大长度限制在79个字符以内。

3,顶层函数、类的定义, 前后使用两个空行隔开。

4,import 导入

     4.1导入建议在不同的行, 例如:

import os
import sys
# 不建议如下导包
import os, sys
# 但是可以如下:
from subprocess import Popen, PIPE

     4.2导包位于文件顶部, 在模块注释、文档字符串之后, 全局变量、常量之前. 导入按照以下顺序分组:

          4.2.1标准库导入
                 4.2.2相关第三方导入
                 4.2.3本地应用/库导入
                 4.2.4在每一组导入之间加入空行

5,Python 中定义字符串使用双引号、单引号是相同的, 尽量保持使用同一方式定义字符串. 当一个字符串包含单引号或者双引号时, 在最外层使用不同的符号来避免使用反斜杠转义, 从而提高可读性。

6,表达式和语句中的空格:

   6.1避免在小括号、方括号、花括号后跟空格.
          6.2避免在逗号、分好、冒号之前添加空格.
          6.3冒号在切片中就像二元运算符, 两边要有相同数量的空格. 如果某个切片参数省略, 空格也省略.
          6.4避免为了和另外一个赋值语句对齐, 在赋值运算符附加多个空格.
          6.5避免在表达式尾部添加空格, 因为尾部空格通常看不见, 会产生混乱.
          6.6总是在二元运算符两边加一个空格, 赋值(=),增量赋值(+=,-=),比较(==,<,>,!=,<>,<=,>=,in,not,in,is,is not),布尔(and, or, not

7,避免将小的代码块和 if/for/while 放在同一行, 要避免代码行太长。

if foo == 'blah': do_blah_thing()
for x in lst: total += x
while t < 10: t = delay()

8,永远不要使用字母 'l'(小写的L), 'O'(大写的O), 或者 'I'(大写的I) 作为单字符变量名. 在有些字体里, 这些字符无法和数字0和1区分, 如果想用 'l', 用 'L' 代替。

9,类名一般使用首字母大写的约定。

10,函数名应该小写, 如果想提高可读性可以用下划线分隔

11,如果函数的参数名和已有的关键词冲突, 在最后加单一下划线比缩写或随意拼写更好. 因此 class_ 比 clss 更好.(也许最好用同义词来避免这种冲突)

12,方法名和实例变量使用下划线分割的小写单词, 以提高可读性


以上就是关于“怎样提高Python代码可读性,并实现风格一致”的相关知识,感谢各位的阅读,想要掌握这篇文章的知识点还需要大家自己动手实践使用过才能领会,如果想了解更多相关内容的文章,欢迎关注群英网络,小编每天都会为大家更新不同的知识。
群英智防CDN,智能加速解决方案
标签: Python代码

免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:mmqy2019@163.com进行举报,并提供相关证据,查实之后,将立刻删除涉嫌侵权内容。

猜你喜欢

成为群英会员,开启智能安全云计算之旅

立即注册
专业资深工程师驻守
7X24小时快速响应
一站式无忧技术支持
免费备案服务
免费拨打  400-678-4567
免费拨打  400-678-4567 免费拨打 400-678-4567 或 0668-2555555
在线客服
微信公众号
返回顶部
返回顶部 返回顶部
在线客服
在线客服