Python进阶技巧二三事(五):PEP8之必须遵守的规范

PEP8规范

链接www.python.org/dev/peps/pe... 建议每位python开发者都自己看一遍规则详情,下面列出几条绝对应该遵守的规则。

空白:Python中的空白(whitespace)会影响代码的含义。Python程序员使用空白的时候尤其在意,因为它们还会影响代码的清晰程度。

  • 使用space(空格)来表示缩进,而不要用tab(制表符)。
  • 和语法相关的每一层缩进都用4个空格来表示。又每行的字符数不应超过79。
  • 对于占据多行的长表达式来说,除了首行之外的其余各行都应该在通常的缩进级别之上再加4个空格。
  • 文件中的函数与类之间应该用两个空行隔开。
  • 在同一个类中,各方法之间应该用一个空行隔开。
  • 在使用下标来获取列表元素、调用函数或给关键字参数赋值的时候,不要在两旁添加空格。
  • 为变量赋值的时候,赋值符号的左侧和右侧应该各自写上一个空格,而且只写一个就好。

命名:PEP8提倡采用不同的命名风格来编写Python代码中的各个部分,以便在阅读代码时可以根据这些名称看出它们在Python语言中的角色

  • 函数、变量及属性应该用小写字母来拼写,各单词之间以下划线相连,例如,lowercase_underscore
  • 受保护的实例属性,语义是在内部使用,不应该从类的外部直接访问或者修改,但子类仍然可以访问和修改它,应该以单个下划线开头,例如,_leading_underscore。
  • 私有的实例属性,强制在类外部不能直接使用,可以封一个方法返回,应该以两个下划线开头,例如__double_leading_underscore。
  • 类与异常,应该以每个单词首字母均大写的形式来命名,例如,CapitalizedWord。
  • 模块级别的常量,应该全部采用大写字母来拼写,各单词之间以下划线相连,例如,ALL_CAPS。
  • 类中的实例方法(instancemethod),应该把首个参数命名为self,以表示该对象自身。
  • 类方法(classmethod)的首个参数,应该命名为cls,以表示该类自身。

表达式和语句: 《TheZenofPython》中说:"每件事都应该有直白的做法,而且最好只有一种。"PEP8在制定表达式和语句的风格时,就试着体现了这种思想。

  • 采用内联形式的否定词,而不要把否定词放在整个表达式的前面,例如,应该写if a is not b而不是if not a is b
  • 不要通过检测长度的办法(如if len(somelist) == 0)来判断somelist是否为[]""等空值,而是应该采用if not somelist这种写法来判断,它会假定空值将自动评估为False
  • 检测somelist是否为[1]'hi'等非空值时,也应如此,if somelist语句默认会把非空的值判断为True
  • 不要编写单行的if语句、for循环、while循环及except复合语句,而是应该把这些语句分成多行来书写,以示清晰。
  • import语句应该总是放在文件开头,如果项目庞大有循环依赖问题之后,才考虑放在函数内部。
  • 引入模块的时候,总是应该使用绝对名称,而不应该根据当前模块的路径来使用相对名称。例如,引入bar包中的foo模块时,应该完整地写出from bar import foo,而不应该简写为import foo
  • 如果一定要以相对名称来编写import语句,那就采用明确的写法:from . import foo
  • 文件中的那些import语句应该按顺序划分成三个部分,分别表示标准库模块、第三方模块以及自用模块。在每一部分之中,各import语句应该按模块的字母顺序来排列。
相关推荐
清水白石0081 小时前
隔离的艺术:用 `unittest.mock` 驯服外部依赖,让测试真正可控
python
码农小韩1 小时前
AIAgent应用开发——大模型理论基础与应用(五)
人工智能·python·提示词工程·aiagent
百锦再1 小时前
Java中的char、String、StringBuilder与StringBuffer 深度详解
java·开发语言·python·struts·kafka·tomcat·maven
上进小菜猪2 小时前
基于 YOLOv8 的水体污染目标检测系统 [目标检测完整源码]
后端
Jonathan Star2 小时前
Ant Design (antd) Form 组件中必填项的星号(*)从标签左侧移到右侧
人工智能·python·tensorflow
努力努力再努力wz2 小时前
【Linux网络系列】:TCP 的秩序与策略:揭秘传输层如何从不可靠的网络中构建绝对可靠的通信信道
java·linux·开发语言·数据结构·c++·python·算法
deep_drink2 小时前
【论文精读(三)】PointMLP:大道至简,无需卷积与注意力的纯MLP点云网络 (ICLR 2022)
人工智能·pytorch·python·深度学习·3d·point cloud
njsgcs3 小时前
langchain+vlm示例
windows·python·langchain
勇气要爆发3 小时前
LangGraph 实战:10分钟打造带“人工审批”的智能体流水线 (Python + LangChain)
开发语言·python·langchain
jz_ddk3 小时前
[实战] 从冲击响应函数计算 FIR 系数
python·fpga开发·信号处理·fir·根升余弦·信号成形