SuperAPI AI 工具集

python-best-practices

编程与开发

查看项目

更新于 10-16 09:30

技能介绍

本技能是一份 Python 编程最佳实践参考,适用于编写或评审高质量 Python 代码时查阅。

用途与主要内容:覆盖类型注解、函数参数、文档字符串、数据结构选择、性能优化、并发与异步、错误处理、路径与文件操作、类型安全和常见陷阱规避等主题。

主要约定:始终为函数参数和返回值加类型注解;Python 3.10+ 用 Type | None 替代 Optional[Type];文件顶部加 from future import annotations;只读输入用 Mapping 而非 MutableMapping;位置参数最多 3 个,可选参数置于 * 之后;避免遮蔽内置名(用 next_item 替代 next);公开 API 使用 Google 风格 docstring,自定义异常需说明。

数据结构与性能:成员检测用 set;用 defaultdict、Counter、deque 替代低效容器;不可变小结构用 NamedTuple,可变结构用 dataclass,边界数据校验用 pydantic。大数据用生成器按需处理;纯函数用 @cache 或 @lru_cache;拼接字符串用 join 而非循环 +=。

并发:异步 I/O 用 asyncio,多线程/多进程统一用 joblib,I/O 阻塞用 prefer="threads",CPU 密集用 prefer="processes"。

陷阱与组织:可变默认参数用 None 占位;闭包循环变量用默认参数捕获;值比较用 ==,is 仅用于 None/True/False;延迟导入或 TYPE_CHECKING 避免循环导入;用 all 声明公共 API。

限制:资料未提供安装命令、运行方式、依赖版本要求、平台支持或收费信息,暂未提供。