python变量名必须用snake_case而非camelcase,类名用pascalcase,常量全大写;import须分组且禁用*;函数参数需语义化命名;__init__.py文件不可缺失。

变量名用 snake_case 而不是 camelCase 是硬性约定
Python 官方 PEP 8 明确要求模块、函数、变量、方法名全部使用 snake_case。这不是风格偏好,而是协作前提——当你写的 user_name 被别人读成 userName,IDE 自动补全会失效,dir() 输出也难对齐。
常见错误现象:def getUserName(): 在团队代码里被反复重命名;HTTPResponse 类里混着 status_code 和 statusCode 两个字段,类型检查工具直接报错。
- 类名和异常名必须用
PascalCase(如ValueError),但内部属性/方法仍走snake_case -
__dunder__名字只用于特殊方法,_private开头是弱约定,不阻止访问 - 常量全大写加下划线(
MAX_RETRY_COUNT),但仅限模块级不可变对象
import 顺序和别名混乱会让依赖关系一眼看不清
一个 import 行写成 from requests import get, post, Session as Sess,等于主动放弃可读性。别人 grep Session 找不到定义,IDE 无法跳转,静态分析工具也容易漏判。
使用场景:多人维护的 CLI 工具或 Web API 层,import 块一乱,新加个依赖可能触发循环引用,而你花半小时才意识到是 import 位置错了。
立即学习“Python免费学习笔记(深入)”;
- 标准库 → 第三方包 → 本地模块,每组空一行
- 避免
from xxx import *,它让pylint失效,也掩盖真实依赖 - 别名只在必要时用:
import numpy as np合理,import json as js没必要
函数参数命名暴露意图比缩写更重要
def calc(a, b, c): 这种写法在调试时等于自断后路。你得翻三遍调用处才能确认 c 是超时秒数还是重试次数,而 timeout_sec 或 retry_count 一眼可知。
性能影响几乎为零,但可读性落差极大——尤其当函数被用在异步上下文或作为回调传入时,参数含义模糊会导致错误的 timeout 设置或并发逻辑崩坏。
- 布尔参数必须用肯定式命名:
is_valid、allow_retry,禁用no_log、not_found - 避免单字母参数,除非是数学公式(
def distance(x1, y1, x2, y2):) - 长参数名不拖慢执行,但能减少文档字符串重复解释
__init__.py 空文件不是摆设,它决定包结构能否被正确识别
新建目录放了 utils.py 却没加 __init__.py,结果 from myproject.utils import helper 报 ModuleNotFoundError。这不是环境问题,是 Python 解释器根本没把这目录当包。
容易踩的坑:Git 忽略空文件导致 CI 构建失败;用 pip install -e . 时,缺失 __init__.py 让子模块无法被 find_packages() 发现;更隐蔽的是,Pytest 会跳过不含 __init__.py 的测试目录。
- 哪怕空文件也要存在,内容可以为空,但不能没有
- 如果想控制包导出内容,可在
__init__.py里写__all__ = ["helper"] - Python 3.3+ 支持隐式命名空间包,但仅限于特定部署场景,日常开发别依赖它
命名规范真正卡住人的地方,从来不是记不住规则,而是某次赶工删掉了 __init__.py,或者把 user_id 写成 userid 后,整个 ORM 查询链路的字段映射就悄悄错位了。










