python 编程规范有哪些？

来源：cnblogs　　作者：捷后愚生　　时间：2023/4/28 16:42:45　　对本文有异议

Python 编程规范主要包括代码布局、命名规范、注释规范、函数编写规范等多个方面，下面给出一些常见的编程规范及其示例代码。

1. 代码布局规范

代码布局规范主要是指代码的缩进、行宽、空行、换行等方面，下面是一些常见的代码布局规范：

使用四个空格作为一个缩进级别，不要使用制表符。
每行代码最多不超过 79 个字符，如果需要换行可以使用括号、\ 符号或者三个双引号。
在函数之间、类之间和逻辑块之间添加一行空白行，以提高代码可读性。

示例代码：

def my_function(arg1, arg2):
    if arg1 == 'value':
        result = arg1 + arg2
    else:
        result = arg2 - arg1
     return result

2. 命名规范

命名规范主要是指变量名、函数名、类名等的命名规则，下面是一些常见的命名规范：

使用全小写的单词或下划线分隔的多个单词来命名变量或函数。
类名首字母大写，采用驼峰命名法。
使用前缀或后缀来命名私有变量或函数，以单下划线或双下划线开头或结尾。

示例代码：

class MyClass:
    def __init__(self, name):
        self._name = name
     def get_name(self):
        return self._name
     def _helper_method(self):
        pass
my_object = MyClass('John')
print(my_object.get_name())

3. 注释规范

注释规范主要是指如何编写注释，以方便别人理解你的代码，下面是一些常见的注释规范：

在代码中适当添加注释，以解释代码的目的和实现方法。
给函数和类添加文档字符串，以描述其功能和参数等信息。
避免使用无意义的注释，例如 “增加变量 x 的值”。

示例代码：

# This function calculates the sum of two numbers
def add_numbers(num1, num2):
    """
    Calculate the sum of two numbers.
     Args:
        num1: First number to add.
        num2: Second number to add.
     Returns:
        The sum of the two numbers.
    """
    return num1 + num2

python的文档字符串是什么？

Python 的文档字符串是指在模块、类、方法、函数等代码段的开头使用 """ 进行多行字符串注释来描述代码段的功能、参数、返回值等信息的规范化方式。这些文档字符串可以被工具程序提取和转换为 HTML、PDF、Unix 手册页等格式的文档，并且可以被编程编辑器、交互式帮助工具等程序自动读取和显示，对于代码的使用与维护十分有帮助。

文档字符串应该被写在代码段的开头，并包含以下部分：

描述代码段的功能和用途。
描述代码段的参数名称、类型、范围和意义。
描述代码段的返回值类型、范围和意义。
描述代码段的异常和错误处理信息。
其他相关的注释和说明。

下面是一个函数的文档字符串示例：

def my_function(arg1, arg2):
    """
    This function adds two numbers.
     Args:
        arg1 (int): The first number.
        arg2 (int): The second number.
     Returns:
        int: The sum of the two numbers.
     Raises:
        ValueError: If either input is not an int.
     Examples:
        >>> my_function(2, 3)
        5
        >>> my_function(2, "three")
        ValueError: arg2 must be an int.
    """
    if not isinstance(arg1, int) or not isinstance(arg2, int):
        raise ValueError("arg1 and arg2 must be ints.")
    return arg1 + arg2

注意，文档字符串中的参数类型和异常处理信息只是规范化的描述，实际代码中还需要进行相应的类型判断和错误处理。

4. 函数编写规范

函数编写规范主要是指如何编写函数，以方便别人阅读和使用你的代码，下面是一些常见的函数编写规范：

函数应该尽可能短小，不要超过 20 行。
函数应该只完成一个明确的任务，而不是多个任务。
函数应该有一个明确的返回值，或者返回 None。

示例代码：

def calc_sum(nums):
    """
    Calculate the sum of a list of numbers.
     Args:
        nums: A list of numbers to sum.
     Returns:
        The sum of the list of numbers.
    """
    total = 0
    for num in nums:
        total += num
    return total