PEP 8-Python编码规范

1、命名约定

  • 文件名
    全小写,可使用下划线,尽量简短且可读性高

  • 应该是简短的、小写的名字。如果下划线可以改善可读性可以加入。如my_package
  • 模块
    与包的规范同。如mymodule

  • 总是使用首字母大写单词串。如MyClass。内部类可以使用额外的前导下划线。
  • 函数&方法
    函数名应该为小写,可以用下划线风格单词以增加可读性。如:myfunction,my_example_function。
    注意:混合大小写仅被允许用于这种风格已经占据优势的时候,以便保持向后兼容。

2、每个 import 语句只导入一个模块,尽量避免一次导入多个模块,例如:

# 推荐
import os
import sys
# 不推荐
import os,sys

3、建议每行不超过 80 个字符,如果超过,建议使用小括号将多行内容隐式的连接起来,而不推荐使用反斜杠 \ 进行连接。例如,如果一个字符串文本无法实现一行完全显示,则可以使用小括号将其分开显示,代码如下:

# 推荐
edit_component_button = Element(
        xpath="//span[@class='el-cascader-node__label']", describe="编辑-添加组件-按钮组件", index=5)
# 不推荐
edit_component_button = Element(xpath="//span[@class='el-cascader-node__label']", describe="编辑-添加组件-按钮组件", index=5)
edit_component_button = Element(\
  xpath="//span[@class='el-cascader-node__label']", describe="编辑-添加组件-按钮组件", index=5)

4、使用必要的空行可以增加代码的可读性,通常在顶级定义(如函数或类的定义)之间空两行,而方法定义之间空一行,另外在用于分隔某些功能的位置也可以空一行。

5、通常情况下,在运算符两侧、函数参数之间以及逗号两侧,都建议使用空格进行分隔。

6、注释

  • 1、代码更改时,相应的注释也要随之更改。
  • 2、块注释:块注释通常适用于后面的一些(或全部)代码,并缩进到与该代码相同的级别。块注释的每一行都以#和一个空格开始。
  • 3、行注释:顾名思义就是对某一语句行进行注释,注释应该与语句至少隔开两个空格,用#和一个空格开始。举例:# 空仪表盘时,添加图表
posted @ 2022-01-19 11:15  小喜_ww  阅读(212)  评论(0编辑  收藏  举报