PEP8编码规范

PEP8编码规范示例

"""
这是一个模块的文档字符串，描述了该模块的主要功能。
"""

# 分组导入模块（顺序：标准库、第三方库、本地模块）
import os
import math
import requests
from my_package import my_module


# 常量定义，大写字母加下划线
PI = 3.14159


# 定义类，采用首字母大写的驼峰命名法
class MySuperClass:
    """
    这个类的文档字符串，说明类的用途。
    """
    def __init__(self, parameter1, parameter2):
        # 实例变量使用小写字母加下划线命名
        self._private_attribute = parameter1  # 可以使用单个下划线表示内部使用的属性
        self.public_attribute = parameter2

    def my_public_method(self):
        """
        公共方法的文档字符串，描述方法的功能。
        """
        # 避免过长的行，可以适当分行（行不超过80）
        long_calculation = (self._private_attribute + self.public_attribute) * PI
        return long_calculation

    def _my_private_method(self):
        """
        私有方法的文档字符串，通常仅供内部使用。
        """
        return "This is a private method."


# 类和函数上下空两行
def my_function_with_long_name(argument1, argument2):
    """
    函数的文档字符串，解释函数的作用。
    """
    # 使用空行分隔不同的逻辑部分
    result1 = argument1 + argument2
    result2 = argument1 * argument2

    if result1 > result2:
        return result1
    else:
        return result2
    
    
if __name__ == '__main__':
    # 创建类的实例并调用方法和函数
    my_instance = MySuperClass(5, 10)
    print(my_instance.my_public_method())
    print(my_function_with_long_name(3, 4))

注释规范

• 三引号：文档字符串，提供了模块、类和函数的描述
• 块级注释：用于有同样的缩进层级的代码
• 行内注释：慎用行内注释，行内注释应是简短的且不干扰代码可读性

函数注释示例：

def fun(range, file_path):
    """
    函数介绍
    :param range:    ...
    :param file_path:    ...
    :return:   ...
    """

命名规范

• 变量名：小写字母 + 下划线
• 常量名：大写字母 + 下划线
• 函数名：小写字母 + 下划线
• 类名：首字母大写 + 驼峰命名
• 包和模块名：小写字母 + 下划线。应简短

对于类中只供该类使用的方法，名字一般为_函数名