0

0

Python 返回值设计的最佳实践

舞姬之光

舞姬之光

发布时间:2026-02-18 16:04:04

|

163人浏览过

|

来源于php中文网

原创

应根据失败是否可预期来选择:可预期且可恢复时返回none或哨兵值,否则抛异常;多值返回优先用命名元组或数据类;提前返回宜限于函数开头的守门检查;显式标注->none有助于防止误用。

python 返回值设计的最佳实践

返回 None 还是抛异常?看调用方是否能合理处理失败

Python 不强制函数必须有明确返回值,但随意返回 None 容易埋雷。比如 dict.get() 返回 None 是安全的——调用方本就预期“可能没找到”;但 json.loads() 遇到非法 JSON 直接抛 JSONDecodeError,因为解析失败不是“正常分支”,而是输入错误。

  • 如果失败是业务逻辑中可预期、可恢复的情况(如查缓存未命中),返回 None 或特殊哨兵值(如 sentinel = object())更合适
  • 如果失败意味着输入违法、状态异常或外部依赖不可用(如文件不存在、网络超时),该抛异常,别默默返回 None
  • 别在同一个函数里混用:一会儿返回 dict,一会儿返回 None,又不加类型提示,调用方只能靠 try/except 猜
def find_user_by_id(user_id: int) -> Optional[User]:
    # 明确标注可能为 None,调用方有心理准备
    return db.query(User).filter(User.id == user_id).first()

多值返回要不要用 tuple?优先考虑命名元组或数据类

Python 支持 return a, b, c,解包也方便,但问题在于语义模糊:x, y = process() 中的 xy 到底代表什么?几个月后连你自己都得翻源码。

  • 简单脚本、临时计算、且返回值含义极其明确(如 divmod())可用 tuple
  • 一旦涉及两个以上值,或值有业务含义(如 status_code, headers, body),立刻改用 namedtupledataclassTypedDict
  • typing.NamedTuple 比普通 namedtuple 更好,支持类型注解,IDE 能补全,mypy 能校验
from typing import NamedTuple
class HttpResponse(NamedTuple):
    status_code: int
    headers: dict
    body: bytes
<p>def fetch(url: str) -> HttpResponse:
...</p>

return 提前退出太多?说明函数职责过重

满屏 if ... return 看起来“简洁”,实则掩盖了逻辑分层问题。比如一个函数开头检查参数类型、非空、权限、配额、限流……每项失败都提前 return,后续主逻辑缩进深、难测试、难复用。

  • 提前返回只适合守门人式检查(如 if not user: return),且应集中放在函数开头
  • 权限、配额、限流等属于横切关注点,该抽成装饰器或中间件,别塞进业务函数里
  • 如果不得不做多重校验,用 guard clause 模式:每个检查独立成行,失败统一抛特定异常(如 ValidationError),让上层决定怎么响应
def create_order(items: list, user: User) -> Order:
    if not items:
        raise ValueError("items cannot be empty")
    if not user.is_active:
        raise PermissionError("user is disabled")
    # 主逻辑从这里开始,缩进浅、意图清
    return Order.create(items, user)

类型提示写不写 -> None?写了比不写强,但别为了类型而类型

def cleanup() -> None: 看似多余,其实有用:它告诉调用方“别指望这个函数给你回东西”,也堵死了误用 result = cleanup() 的可能。但问题在于,很多人把 -> None 当成形式主义,反而漏掉真正该标注的返回类型。

立即学习Python免费学习笔记(深入)”;

  • 所有无显式 return 的函数,Python 默认返回 None,此时显式写 -> None 是好习惯
  • 但如果你写了 -> None,却在某个分支里 return "done",mypy 会报错——这反而是好事,逼你修正逻辑
  • 别为了加类型提示硬拆函数:比如把 -> List[User] 改成 -> Optional[List[User]] 只为覆盖空列表场景,不如让空列表本身成为合法返回值

最常被忽略的一点:返回值设计不是孤立问题,它和错误传播路径、调用方的防御性编程习惯、以及团队对“空值容忍度”的共识强相关。写完一个函数,不妨问自己一句:如果我三天后第一次调用它,看到这个返回类型,会不会犹豫要不要加 if result is not None:

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
什么是中间件
什么是中间件

中间件是一种软件组件,充当不兼容组件之间的桥梁,提供额外服务,例如集成异构系统、提供常用服务、提高应用程序性能,以及简化应用程序开发。想了解更多中间件的相关内容,可以阅读本专题下面的文章。

180

2024.05.11

Golang 中间件开发与微服务架构
Golang 中间件开发与微服务架构

本专题系统讲解 Golang 在微服务架构中的中间件开发,包括日志处理、限流与熔断、认证与授权、服务监控、API 网关设计等常见中间件功能的实现。通过实战项目,帮助开发者理解如何使用 Go 编写高效、可扩展的中间件组件,并在微服务环境中进行灵活部署与管理。

224

2025.12.18

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

442

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

544

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

322

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

81

2025.09.10

if什么意思
if什么意思

if的意思是“如果”的条件。它是一个用于引导条件语句的关键词,用于根据特定条件的真假情况来执行不同的代码块。本专题提供if什么意思的相关文章,供大家免费阅读。

817

2023.08.22

pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法
pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法

本专题系统整理pixiv网页版官网入口及登录访问方式,涵盖官网登录页面直达路径、在线阅读入口及快速进入方法说明,帮助用户高效找到pixiv官方网站,实现便捷、安全的网页端浏览与账号登录体验。

472

2026.02.13

微博网页版主页入口与登录指南_官方网页端快速访问方法
微博网页版主页入口与登录指南_官方网页端快速访问方法

本专题系统整理微博网页版官方入口及网页端登录方式,涵盖首页直达地址、账号登录流程与常见访问问题说明,帮助用户快速找到微博官网主页,实现便捷、安全的网页端登录与内容浏览体验。

157

2026.02.13

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 22.4万人学习

Django 教程
Django 教程

共28课时 | 4.4万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.6万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号