Python PEP 8 规范

象野VH

已于 2024-05-02 09:18:25 修改

阅读量227

点赞数 2

分类专栏： Python 文章标签： python

于 2024-04-30 06:46:52 首次发布

本文链接：https://blog.csdn.net/dafan0/article/details/138332762

版权

Python 专栏收录该内容

3 篇文章 0 订阅

订阅专栏

本文详细介绍了PEP8编码风格规范，包括命名规则（小驼峰、大驼峰、下划线命名），以及Python中变量、常量、函数、方法、类、模块和包的命名习惯。此外，还强调了注释的三种形式：块注释、行内注释和文档字符串的重要性，以及代码的缩进和空行规则。

摘要由CSDN通过智能技术生成

PEP 8 介绍

代码规范就是指在编写代码时，需要去遵循一些通用的编写方式或编写风格。注意，并不做强制性(也就是说不按规范写并不会报错)

PEP 8 的全称为 Style Guide for Python Code ，即 Python 编码风格规范，主要涵盖三个大的方面

   •命名规范
   •注释文档
   •代码布局

PEP 8 命名规范实际是一个非常具有扩展性的话题，我们需要了解主要的命令规则以及 python 中针对不同元素的常用命名方式

常见命名规则

小驼峰命名法

以一至多个逻辑单元构成，每个逻辑单元都可称为一个识别字，每个识别字首字母小写，其余识别字首字母大写，比如：newName

大驼峰命名法

与小驼峰命名法类似，区别为首字母大写。比如：NewName

下划线命名法

和驼峰命名法类似，区别为所有识别字均小写，识别字之间使用_连接，比如 new_name

除此之外，还有其他形式的命名规则，比如大写 NEWNAME、大写结合下划线NEW_NAME、小写 newname 等。另外在 Python 中也有前缀或者后缀下划线、双下划线等命名方式

Python 常用命名方式

变量和常量

变量名可小写，也可使用下划线命名
常量应使用全大写字母，必要时使用下划线分隔，并且要注意在 Python 中并没有类似其他语言中const的概念，常量仅仅是一种约定（常量通常放置在代码顶部、或单独的模块、或特定的配置文件中）
对于容器类变量，常采用复数名词形式；对于映射类变量，常采用 key_value 的形式，其中 key、value 为键和值的实际含义。比如：information_value = {“name”:“ycx”,“age”:20,“height”:180}
对于表示布尔值的变量或者常量（但不仅限于这两者），常采用 has、is 作为前缀

函数和方法

函数名、方法名应使用小写，也可使用下划线命名（但我们仍会在一些代码中看到一些方法或者函数名称采用了驼峰命名法，甚至在 Python 的标准库中也存在这样的现象，比如在 threading 模块中，因为这些代码的出现往往早于 PEP 8 规范的诞生，同时为了向后兼容而保留，但通常这些模块都会提供相同功能的以小写加下划线命名的方法，我们应该尽可能使用这些新的方法）
实例方法的首个参数名应为 self，类方法的首个参数应为 cls（ class作为关键字不能被使用，常被cls 或 klass替换）

类和异常

类名应使用大驼峰命名（这里不包括一些 Python 内置的类，比如 int、list ），类和属性常采用名词，方法多采用动词或者包含动词
基类常采用 Base 作为前缀，抽象类常采用 Abstract 作为前缀
异常名应使用大驼峰命名法，当此异常表示一个错误时，应添加 Error 后缀（并不是所有异常都代表代码运行错误，比如 KeyboardInterrupt、SystemExit ）

模块和包

模块（ modules ）名应尽可能使用小写，在必要时可以使用下划线命名（除了 init 模块以外）
包（ packages ）名应使用小写，最好不要使用下划线

特殊格式

单下划线前缀，比如 _name ，常称为 ”伪私有属性“（也可用于私有的方法、类等），这种命名方式在 Python 中是一种表示私有属性的约定（同时注意 from … import * 时不会导入这种形式的对象，并且这种伪私有变量通常会通过特定的方法来获取或者赋值），私有属性通常没有直接对外的功能，常用于记录内部状态或用于提供一些公共功能的方法内使用
单下划线后缀，比如 name_ ，常用于避免和 Python 的关键字发生冲突
双下划线前缀，比如 __name ，常用于基类避免和子类中的命名冲突，Python 会通过转换规则将其转换为类似 Class__name 的形式，这种方式通常称为命名修饰（这种方式通常用于多继承，应避免将这种形式用在私有属性的命名上）
前后双下划线，比如__name__，这是 Python 内部常用的魔法名称，不应自定义这类命名

注释编写

注释对于代码的阅读、扩展以及维护都非常重要。在 Python 中常用的注释方式有三种，分别为块注释（ Block Comments ）、行内注释（ Inline Comments ）、文档字符串（ Documentation Strings ）

块注释（ Block Comments ）

块注释在代码内部比较常见，其通常由一至多个段落构成，段落之间应使用开头为 # 的空行隔开，每个段落由完整的句子构成，在每行以 # 和一个空格开始。另外，块注释和被注释代码之间应具有同级别的缩进，这样有助于区分注释和代码之间关联关系。如下代码体现出块注释:

def my_name():
    # 这是第一条注释，保持缩进
    # 这是第二条注释，保持缩进
    # 这是第三条注释，保持缩进
    print('ycx')

my_name()

行内注释（ Inline Comments ）

行内注释是一种形式相对简单的注释，它和表达式或语句位于同一行，之间应通常使用两个空格隔开，注释部分应以 # 和一个空格开始:

new_list = []  # 创建新的列表

文档字符串（ Documentation Strings ）

在 Python 中，最重要的注释形式便是文档字符串，主要用于两方面：

用来对模块、类、函数、方法等进行说明
可以配合一些辅助工具来自动化生成代码文档

当然大家现在可能很难体会到文档字符串的重要性，但是提到开源这个词，我们就会知道，一个开源文档的质量取决于它的可读性，而可读性往往伴随着大量的说明文档

def no_function():
    """
    函数的文档注释
    :return: None
    """
    pass

代码布局

缩进与空格

Python 在语法上使用缩进来确定代码块的开始和结束，对于每一级缩进，都应该是 4个空格。当然，在 Pycharm 当中，我们可以设置使用 tab 键来进行缩进
那需要注意，缩进本身是强制性的，但是空格数量实际上语法并没有做限制。只不过同级代码缩进空格一致即可

代码之间的空行

函数与类之间应该使用两个空行隔开，而类的内部的方法之间应该使用一个空行隔开，函数或方法中不同功能的代码块可使用空行隔开

class OnePerson(object):
    def name(self):
        pass

    def weight(self):
        pass


def my_name():
    pass


def my_height():
    pass