编写符合 PEP 8 规范的 Python 代码不仅能让你的代码更易读、更专业，还能提高团队协作的效率。以下是一些具体的建议和示例，帮助你编写漂亮的 Python 代码。

1.代码布局

缩进

• 使用 4 个空格 作为缩进，不要使用 Tab。
• 续行时，缩进应与上一行对齐。

PYTHON
# 正确的缩进
def my_function(param1, param2):
    if param1 > param2:
        print("param1 is greater than param2")
    else:
        print("param2 is greater than or equal to param1")

最大行长度

• 每行代码不应超过 79 个字符。
• 如果一行过长，可以使用括号、反斜杠或换行符来换行。

PYTHON
# 正确的换行方式
result = (some_long_variable_name +
          another_long_variable_name -
          yet_another_long_variable_name)

2.导入

• 导入应分组，顺序为：标准库导入第三方库导入本地模块导入
• 每组导入之间用空行分隔。

PYTHON
# 正确的导入方式
import os
import sys
import requests
from flask import Flas
from my_local_module import MyClass

3.命名约定

• 变量和函数名使用 小写字母，单词之间用下划线分隔（snake_case）。
• 类名使用 首字母大写的驼峰命名法（CamelCase）。
• 常量名使用 全大写字母，单词之间用下划线分隔（UPPER_CASE）。

PYTHON
# 正确的命名方式
MAX_VALUE = 100
def calculate_average(numbers):
    pass
class MyClass:
    pass

4.空格的使用

• 在二元运算符两侧各放置一个空格。
• 不要在逗号、分号、冒号前面加空格，但在它们后面应该加空格。
• 函数调用时，参数列表的左括号前不加空格。

PYTHON
# 正确的空格使用
x = 5
y = 10
result = x + y
if x > y:
    print("x is greater than y")
my_function(param1, param2)

5.注释

• 注释应该完整且清晰，解释代码的意图。
• 注释应该与代码保持同步更新。

PYTHON
# 正确的注释方式
def calculate_average(numbers):
    """计算列表中所有数字的平均值。
    Args:
        numbers (list): 包含数字的列表。
    Returns:
        float: 平均值。
    """
    total = sum(numbers)
    count = len(numbers)
    return total / count

6.文档字符串

• 模块、类、函数和方法应该包含文档字符串（docstring）。
• 文档字符串应该遵循一定的格式，通常使用三重引号（"""）来定义。

PYTHON
# 正确的文档字符串
class MyClass:
    """这是一个示例类。"""
    def __init__(self, name):
        """初始化 MyClass 实例。
        Args:
            name (str): 实例的名称。
        """
        self.name = name
    def greet(self):
        """打印问候语。"""
        print(f"Hello, {self.name}!")

7.其他建议

• 避免使用不必要的括号。
• 避免使用单字符变量名（除非在循环或数学表达式中）。
• 使用 is 和 is not 来比较 None，而不是 == 或 !=。

PYTHON
# 正确的比较方式
if x is None:
    print("x is None")

# 避免不必要的括号
if x > 10 and y < 20:
    print("Condition met")

完整示例

以下是一个符合 PEP 8 规范的完整示例：

PYTHON
# 导入标准库
import os
import sys
# 导入第三方库
import requests
# 导入本地模块
from my_module import MyClass

def calculate_average(numbers):
    """计算列表中所有数字的平均值。
    Args:
        numbers (list): 包含数字的列表。
    Returns:
        float: 平均值。
    """
    total = sum(numbers)
    count = len(numbers)
    return total / count
def main():
    """主函数，用于测试 calculate_average 函数。"""
    numbers = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
    result = calculate_average(numbers)
    print("The average is:", result)
if __name__ == "__main__":
    main()

工具支持

为了更方便地遵循 PEP 8，你可以使用以下工具：

autopep8依赖库：自动格式化代码以符合 PEP 8。

pip install autopep8
autopep8 --in-place --aggressive your_script.py

flake8依赖库：检查代码是否符合 PEP 8。

BASH
pip install flake8 flake8 your_script.py

IDE/编辑器插件：例如 VS Code 的 Python 插件、PyCharm 等，都支持自动格式化代码。

概括

遵循 PEP 8 规范可以让你的代码更清晰、更易读，同时也能提高团队协作的效率。通过工具和良好的编程习惯，你可以轻松编写出漂亮的 Python 代码。