python脚本格式

### Python 脚本编写规范和格式要求

#### 一、代码结构与布局

遵循 PEP 8 编码风格指南，这是 Python 社区广泛接受的标准[^1]。文件应以 UTF-8 编码保存，并在顶部声明编码方式。

对于导入语句，建议按照官方库、第三方库和个人模块分组排列，每组之间留有空行：

import os
import sys

from flask import Flask, request
from sqlalchemy.orm import sessionmaker

from myapp.models import User

函数定义间需保留两个空白行；类内部的方法则只需一个空白行即可区分不同部分。

#### 二、命名约定

变量名应当清晰易懂，推荐使用小写字母加下划线的方式表示多个单词组成的名称（snake_case）。常量通常全部大写并用下划线连接各个词项。而类名则采取首字母大写的驼峰式拼接法(CamelCase)[^2]。

def get_user_info(user_id): ...
MAX_CONNECTIONS = 50
class DatabaseConnectionManager: ...

#### 三、字符串引号的选择

单双引号均可用于创建字符串字面量，但在同一项目内最好保持一致。如果字符串中含有大量特殊字符，则可考虑选用另一种形式来简化转义操作。

message = "Hello world!"
path = 'C:\Users\name'  # 使用原始字符串避免反斜杠问题
raw_path = r'C:\Users\name'

#### 四、表达式的拆分行处理

当一行过长时可以利用括号自然断开而不必添加额外的续行符(\)，这不仅提高了可读性也减少了潜在错误的发生几率。列表推导式等复杂结构同样适用此原则。

long_variable_name = (
    very_long_function_call(
        argument_one,
        argument_two,
        argument_three))

#### 五、注释说明

良好的文档习惯有助于他人快速理解代码意图。除了必要的功能解释外，还应对算法逻辑做出适当阐述。注意控制好注释比例，过多反而影响阅读体验。

# 不要这样做：显而易见的事情无需特别指出
i += 1  # i 加上 1 

# 好的做法：提供有价值的信息帮助读者更好地把握上下文关系
if user.is_active and not user.has_permission('edit'):
    # 如果用户处于激活状态但不具备编辑权限...