1. 遵循 PEP 8

PEP 8 是 Python 代码的风格指南。它涵盖了从命名约定到缩进的广泛主题。如代码缩进使用4个空格、最大行长度限制为79个字符等等。我们可以借助IDE完成此风格的格式化，以Pycharm为例：

2. 见名知意

为变量、函数、类和模块选择描述性明确的名称。

# 不推荐
a = 10

# 推荐
timeout_seconds = 10

3. 使用列表推导式和生成器表达式

列表推导式和生成器表达式简洁且可读。

# 不推荐
squares = []
for x in range(10):
    squares.append(x**2)

# 推荐
squares = [x**2 for x in range(10)]

4. 正确处理异常

使用异常来处理错误和异常情况。避免使用异常来控制流。

# 不推荐
try:
    value = my_dict[key]
except KeyError:
    value = default_value

# 推荐
value = my_dict.get(key, default_value)

5. 使用文档字符串

为所有公共模块、函数、类和方法编写文档字符串。这有助于其他人（和您自己）理解您的代码的作用

def add(a, b):
    """
    将两个数字相加并返回结果。

    参数：
    a（int 或 float）：第一个数字。
    b（int 或 float）：第二个数字。

    返回：
    int 或 float：两个数字的和。
    """
    return a + b

6. 避免全局变量

全局变量可能会导致代码难以调试和理解。优先选择局部变量和函数参数。

7. 使用库和内置函数

利用Python的标准库和内置函数编写简洁高效的代码。

# 不推荐
result = []
for item in items:
    result.append(item.upper())

# 推荐
result = list(map(str.upper, items))

8. 编写测试

编写测试可确保您的代码按预期工作并有助于防止错误。

import unittest

def add(a, b):
    return a + b

class TestMathFunctions(unittest.TestCase):
    def test_add(self):
        self.assertEqual(add(1, 2), 3)
        self.assertEqual(add(-1, 1), 0)
        self.assertEqual(add(-1, -1), -2)

if __name__ == '__main__':
    unittest.main()