Python 编码风格指南

pythonserver side programmingprogramming更新于 2025/10/23 12:28:17

在本教程中,我们将学习 Python 项目中应遵循的标准风格指南。遵循任何编程语言的标准风格指南将使所有团队成员保持相同的步调。此外,它看起来很专业。

对于 Python,大多数用户遵循 PEP 8 风格指南。代码看起来很漂亮,更易读。您可以在此处找到完整的风格指南列表。我们在本文中介绍了风格指南的精选列表。

使用制表符进行缩进

在代码中使用 制表符 进行缩进可以使代码更具可读性,而不是对多个函数和方法使用随机空格。您可以在任何代码编辑器中设置制表符的空格数设置。

您可以在下面看到一些示例。

# 示例
def sample(random):
   # 语句 1
   # 语句 2
   # ...
   return random

Python 默认的 UTF-8 或 ASCII 编码

使用 Python 默认的 UTF-8 或 ASCII 编码是国际环境的最佳实践。

元组中的尾随逗号

在元组中使用尾随逗号是最佳实践之一。但这不是强制性的。

# example
tup = (1, 2, 3,)

使用文档字符串

在函数和类中使用文档字符串。我们可以对文档字符串使用三重引号。请参阅下面的一些示例。

def sample():
   """This is a function"""
   """
   This
   is
   a function
   """
class Smaple:
   """This is a class"""
   """
   This
   is
   a class
   """

一行中不要写超过 79 个字符

在 PEP 8 样式指南中,不建议一行中写超过 79 个字符。通过使用 转义字符 () 将行拆分为多行来避免这种情况。请参阅以下示例。

# 示例
def assess(a, b, c, d):
   return (2 ** (a + b) / (c // d) ** d + a - d * b) \ - (3 ** (a + b) / (c // d) ** d + a - d * b)

使用空格

在运算符前后使用空格是最佳实践之一。在逗号后也使用空格以提高可读性。

# 示例
import random
result = random.randint(1, 3) + random.randint(1, 2)

命名变量、常量、类和函数

在整个程序中对变量、常量、类和函数遵循相同的大小写。大多数 Python 用户会使用 snake_case 命名函数和变量,使用 PascalCase 命名类。对于常量,请使用所有大写字母并用下划线分隔(例如:PI_TWO)。

snake_case => this_is_function

PascalCase => ThisIsClass

CONSTANT => THIS_IS_CONSTANT

一次导入一个模块

不要尝试一次导入多个模块,即使它在语法上是正确的。请参阅下面的示例。

# don't
import math, random
# do
import math
import random

注释更新

始终保持注释为最新。更新代码时不要忘记更新注释。这是编码中最重要的事情之一。大多数用户都会忘记它。记住这一点。

不应单独用作变量名的字符

我们有一些不应单独用作变量名的字符。它们是 I (大写 i)和 l(小写 L),因为它们看起来与罗马字母相似。

不要在标识符中使用 ASCII 字符

在标识符中使用 ASCII 字符绝对不是一个好习惯。请避免使用它们。


相关文章


有用资源