10 个基本的 Python 编码约定

这篇博客将介绍Python 编程的 10 个编码约定，可以帮助编写更好、更易于维护的代码。

1. 使用描述性变量名

变量名应该是描述性的并反映变量的用途。避免使用缩写或单字母变量名，因为这会使代码难以阅读和理解。

2. 遵循 PEP 8 标准

PEP 8 是 Python 代码的官方风格指南。它涵盖了诸如命名约定、缩进和行长等主题。遵循这些标准可以使代码更加一致并且更易于他人阅读。

3. 使用文档字符串记录函数

文档字符串用于为函数、类和模块提供文档。主要描述这个函数做了什么，它需要什么参数，以及它返回什么。这可以使其他人更容易使用代码并理解其用途。

4.避免全局变量

全局变量会使跟踪代码中发生更改的位置变得困难。相反，使用函数参数和返回值在函数之间传递数据。

5. DRY（Don’t Repeat Yourself）不要重复自己

DRY 原则指出，代码不应不必要地重复。相反，使用函数和类来封装多次使用的功能。

6. 使用列表表达式

列表推导式是在 Python 中创建列表的简洁方法。它们通常比使用 for 循环创建列表更快、更易读。

7. 使用异常进行错误处理

异常是一种比使用返回码或 if 语句更明确的错误处理方式。它们使跟踪错误并以一致的方式处理它们变得更加容易。

8. 使用生成器生成内存高效的代码

生成器是一种创建迭代器的方法，它可以动态生成值，而不是创建一个列表或其他将所有值存储在内存中的数据结构。对于大型数据集，这可以提高内存效率和速度。

9.使用上下文管理器进行资源清理

上下文管理器是一种确保文件句柄和网络连接等资源在使用后得到正确清理的方法。它们可以使您的代码更加健壮和可靠。

10. 使用虚拟环境进行包管理

虚拟环境是一种将 Python 环境与其他项目或系统级 Python 安装隔离开来的方法。它们允许您为单个项目安装包和管理依赖项，而不会影响其他项目或系统 Python 安装。

python -m venv myenv
source myenv/bin/activate
pip install requests

源码

# 1. 使用描述性变量名
# 变量名应该是描述性的并反映变量的用途。避免使用缩写或单字母变量名，因为这会使代码难以阅读和理解。

# 坏例子：
s = "Hello World"
n = len(s)

# 好例子：
message = "Hello World"
message_length = len(message)


# 2. 遵循 PEP 8 标准
# PEP 8 是 Python 代码的官方风格指南。它涵盖了诸如命名约定、缩进和行长等主题。遵循这些标准可以使代码更加一致并且更易于他人阅读。

# 好例子：
def example():
    return 1 + 2


# 3. 使用文档字符串记录函数
# 文档字符串用于为函数、类和模块提供文档。主要描述这个函数做了什么，它需要什么参数，以及它返回什么。这可以使其他人更容易使用代码并理解其用途。
def add_numbers(a, b):
    """
    将两个数相加并返回结果。

    参数：
        a (int)：要相加的第一个数。
        b (int)：要相加的第二个数。

    返回：
        int：相加的总和两个数字。
    """
    return a + b


# 4.避免全局变量
# 全局变量会使跟踪代码中发生更改的位置变得困难。相反，使用函数参数和返回值在函数之间传递数据。

# 错误的例子：
x = 0


def increment_x():
    global x
    x += 1


# 很好的例子：
def increment(x):
    return x + 1


x = 0
x = increment(x)

# 5. DRY（Don’t Repeat Yourself）不要重复自己
# DRY 原则指出，代码不应不必要地重复。相反，使用函数和类来封装多次使用的功能。

# Bad example:
print("Hello")
print("World")
print("Hello")
print("World")


# Good example:
def print_hello_world():
    print("Hello")
    print("World")


print_hello_world()
print_hello_world()

# 6. 使用列表表达式
# 列表推导式是在 Python 中创建列表的简洁方法。它们通常比使用 for 循环创建列表更快、更易读。
# Bad example:
squares = []
for i in range(10):
    squares.append(i * i)

# Good example:
squares = [i * i for i in range(10)]
print(squares)


# 7. 使用异常进行错误处理
# 异常是一种比使用返回码或 if 语句更明确的错误处理方式。它们使跟踪错误并以一致的方式处理它们变得更加容易。

def divide(dividend, divisor):
    try:
        return dividend / divisor
    except ZeroDivisionError:
        raise ValueError("Cannot divide by zero.")


divide(10, 0)


# 8. 使用生成器生成内存高效的代码
# 生成器是一种创建迭代器的方法，它可以动态生成值，而不是创建一个列表或其他将所有值存储在内存中的数据结构。对于大型数据集，这可以提高内存效率和速度。
# 错误示例：
def squares(n):
    results = []
    for i in range(n):
        results.append(i * i)
    return results


# 9.使用上下文管理器进行资源清理
# 上下文管理器是一种确保文件句柄和网络连接等资源在使用后得到正确清理的方法。它们可以使您的代码更加健壮和可靠。
# 错误的例子：
f = open("file.txt", "w")
f.write('你好世界')
f.close()

# 10. 使用虚拟环境进行包管理
# 虚拟环境是一种将 Python 环境与其他项目或系统级 Python 安装隔离开来的方法。它们允许您为单个项目安装包和管理依赖项，而不会影响其他项目或系统 Python 安装。
# 很好的例子：
# python -m venv myenv
# source myenv/bin/activate
# pip install requests

参考

• https://medium.com/@bobbykboseoffice/10-essential-python-coding-conventions-aaf5c3761622