下面是我的放到code rule里的Python代码编写规则

代码风格规范

1. 文档字符串

• 每个使用 def 定义的函数、方法，以及每个使用 class 定义的类，都必须添加 """...""" 形式的文档字符串。
• 文档字符串应清晰说明函数或类的功能和用途。
• 函数或方法的文档字符串应说明关键参数的类型、含义，以及返回值的类型和含义。

2. 类型表达方式

• 函数和方法的参数及返回值不得使用 Python 类型注解。
• 禁止使用 arg: int、name: str、-> bool 等类型注解写法。
• 参数及返回值的类型信息应统一写在文档字符串中。

示例：

def get_user_name(user_id):
    """根据用户 ID 获取用户名。

    Args:
        user_id (int): 用户的唯一标识。

    Returns:
        str: 用户名。
    """

3. 行宽限制

• 每行代码的长度不得超过 120 个字符。
• 该限制适用于代码、注释、字符串以及文档字符串中的代码示例。
• 超过限制时，应通过换行、括号或拆分表达式的方式调整，禁止仅为缩短行宽而使用含义不清的缩写。

4. 二元运算符空格

• 所有二元运算符的前后必须各保留一个空格。
• 本规则适用于算术运算符、比较运算符、赋值运算符、逻辑运算符、位运算符等。
• 一元运算符不适用本规则。

正确示例：

x == 1
x < 1
total = a + b
remainder = value % divisor
is_valid = enabled and ready
flags = read_flag | write_flag