Python编码样式指南

2024-04-30 09:53:03 22

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

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

# example
def sample(random):
   # statement 1
   # statement 2
   # ...
   return random

Python的默认UTF-8或ASCII编码

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

元组中的尾随逗号

在元组中使用逗号结尾是最佳做法之一。但是，这不是强制性的。

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

使用文档字符串

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

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

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

PEP8样式指南不建议在一行中写入超过79个字符。通过使用转义字符()将行分成多行来避免这种情况。请参见下面的示例。

# example
def evaluate(a, b, c, d):
   return (2 ** (a + b) / (c // d) ** d + a - d * b) \ - (3 ** (a + b) / (c // d) ** d + a - d * b)

使用空格

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

# example
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字符根本不是一个好习惯。避免使用它们。