什么是PEP 8？

PEP 8是Python官方的代码风格指南，命名来源于“Python Enhancement Proposal”（Python增强建议书）第8个提案。PEP 8规定了Python代码中的命名规范、代码布局、注释风格等方面的规定，旨在为Python代码提供一致的编程风格，使代码易读、易懂、易维护。

阅读更多：Python 教程

为什么要遵循PEP 8？

遵循PEP 8的规范，可以使人们编写出易于阅读、易于理解和易于维护的Python代码。下面是PEP 8规定的一些常见规范。

空格

在二元操作符、赋值操作符前后保留一个空格，例如：x = y + 1
在逗号、分号、冒号前不加空格，其后加一个空格，例如：x, y = 1, 2
函数的参数列表中，在逗号后保留一个空格，例如：def func(a, b):
在圆括号、方括号和花括号前后加一个空格，例如：spam(1, [2, 3])

命名规范

变量名使用小写字母和下划线的组合，例如：my_variable
常量名使用大写字母和下划线的组合，例如：MY_CONSTANT
函数名使用小写字母和下划线的组合，例如：my_function
类名使用驼峰命名法，例如：MyClass

注释

注释应该在需要说明的代码行前一行
使用井号（#）开头表示注释
使用文档字符串（docstring）来描述模块、函数和类

示例代码

下面的示例代码演示了如何遵循PEP 8规范编写Python代码。

# 定义常量
MY_CONSTANT = 1

# 定义变量
my_variable = 2

# 定义函数
def my_function(arg1, arg2):
    """
    描述函数的功能、参数和返回值
    """
    return arg1 + arg2

# 定义类
class MyClass:
    """
    描述类的功能和使用方法
    """
    def __init__(self, arg1, arg2):
        self.arg1 = arg1
        self.arg2 = arg2

    def my_method(self):
        """
        描述类的方法的功能和使用方法
        """
        print(self.arg1 + self.arg2)

# 调用函数和类
result = my_function(3, 4)
obj = MyClass(1, 2)
obj.my_method()