讲师中心 微信公众号

工具推荐

视频效率加速
剧云
剧云

中文短剧剧本制作平台

Laper
Laper

剧本策划到成片协作

updream

一键生成高质量推广成片

立刻MV
立刻MV

低成本歌曲 MV、视频生成

正确处理异常与成功返回:Python API认证函数的最佳实践

风瑶同学_6559

风瑶同学_6559

发布时间:2026-11-16 18:32:06

|

508人浏览过

|

来源于php中文网

原创

正确处理异常与成功返回:Python API认证函数的最佳实践

本文详解如何在Python中设计健壮的API认证函数,确保异常被真实抛出而非静默吞并,并在成功时明确返回值,避免try/except/else逻辑误触发。

本文详解如何在python中设计健壮的api认证函数,确保异常被真实抛出而非静默吞并,并在成功时明确返回值,避免try/except/else逻辑误触发。

问题核心在于装饰器 @logger.catch 的行为——它默认会捕获并抑制所有未处理异常,使函数“看似正常结束”,从而导致 else 子句意外执行。这与开发者期望的“异常中断流程、仅成功才走 else”完全相悖。

? 为什么 else 仍被执行?

@logger.catch(来自 Loguru)本质是一个异常拦截器:当它捕获到 RuntimeError 后,不会重新抛出(除非显式配置),而是记录日志并让函数返回 None。此时 token = authenticate(...) 实际赋值为 None,但 except RuntimeError 却未触发(因异常已被 catch 拦截),控制流直接落入 else 分支。

验证这一点只需打印 token:

try:
    token = authenticate(...)
    print(f"Token received: {token}")  # 实际输出: Token received: None
except RuntimeError:
    logger.error("Authentication error!")
else:
    logger.info("Authentication successful")  # ❌ 错误地执行了

✅ 正确做法:禁用 @logger.catch 的异常抑制,或改用显式日志

方案一(推荐):移除 @logger.catch,手动记录 + 显式抛出

def authenticate(hostname, client_id, client_secret, username, password):
    """Authenticate via OAuth2 password grant. Returns token dict on success; raises RuntimeError on failure."""
    uri_path = '/oauth/token'
    headers = {'Content-Type': 'application/x-www-form-urlencoded'}
    params = {
        'grant_type': 'password',
        'client_id': client_id,
        'client_secret': client_secret,
        'username': username,
        'password': password
    }

    # 注意:hostname 应为 base URL(不含协议?需校验)
    # 正确拼接示例(避免重复 https://):
    if not hostname.startswith(('http://', 'https://')):
        hostname = 'https://' + hostname
    url = f"{hostname.rstrip('/')}{uri_path}"

    try:
        response = requests.post(url, data=params, headers=headers, timeout=30)
        response.raise_for_status()  # 自动对 4xx/5xx 抛出 HTTPError
        return response.json()
    except requests.exceptions.RequestException as e:
        logger.error(f"Network or request error during authentication: {e}")
        raise RuntimeError(f"ShareFile API Authentication failed: {e}") from e
    except ValueError as e:  # JSON decode error
        logger.error(f"Invalid JSON response: {response.text[:200]}")
        raise RuntimeError("ShareFile API returned invalid JSON") from e

方案二:若坚持使用 @logger.catch,必须启用 reraise=True

@logger.catch(reraise=True)  # ⚠️ 关键:强制重新抛出异常
def authenticate(...):
    # ... 同上逻辑,但可保留装饰器做统一日志
    if response.status_code != 200:
        raise RuntimeError(...)
    return response.json()

✅ reraise=True 是 @logger.catch 的关键参数——它确保异常被捕获记录后立即再次抛出,不破坏原有控制流。

Python 环境工具基础版
Python 环境工具基础版

管理 Python 项目环境,支持虚拟环境创建、依赖安装与环境诊断

下载

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

? 主调用逻辑(保持不变,现在能正确工作)

def main():
    try:
        token = authenticate(
            hostname="myaccount.sharefile.com",  # 注意:不要带 https:// 前缀,除非函数内已处理
            client_id="your_client_id",
            client_secret="your_client_secret",
            username="user@example.com",
            password="secret"
        )
        logger.info("Authentication successful")
        logger.debug(f"Access token: {token.get('access_token', 'N/A')}")
        return token
    except RuntimeError as e:
        logger.error(f"Authentication failed: {e}")
        raise  # 或根据业务决定是否继续传播

⚠️ 额外注意事项

  • URL 构造安全:原始代码中 f"{hostname}{uri_path}" 若 hostname 已含 https://,会导致双协议(如 https://sharefile.com/https://...)。建议统一处理:urlparse.urljoin(hostname.rstrip('/') + '/', uri_path) 或显式校验。
  • 超时设置:网络请求务必添加 timeout= 参数,防止永久阻塞。
  • 敏感信息脱敏:日志中避免打印 password、client_secret —— Loguru 默认不记录函数参数,但仍建议在异常消息中省略敏感字段。
  • HTTP 状态码判断优化:优先使用 response.raise_for_status(),它比手动检查 status_code == 200 更健壮(自动覆盖所有非 2xx 状态)。

✅ 总结

设计“成功返回值 / 失败抛异常”的函数时,切勿依赖会抑制异常的装饰器(如 @logger.catch 默认行为)。最佳实践是:

  1. 移除干扰性装饰器,用 try/except 显式处理并记录;
  2. 或严格启用 reraise=True;
  3. 结合 response.raise_for_status() 和结构化异常类型,提升可维护性;
  4. 在调用侧放心使用 try/except/else —— 它将真正反映执行结果。

这样,你的认证逻辑才能既健壮又可预测。

热门AI工具

更多
WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

花生AI
花生AI Hot

一款AI视频创作工具,主要用于B站推出的AI视频创作工具,适合需要提升相关任务效率的用户。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

讯飞智文

一款面向学习和办公场景的AI文档创作工具,可辅助生成PPT与Word文档,提高资料整理和内容制作效率。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

1931

2023.07.20

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

5464

2023.07.25

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

1889

2023.07.31

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

33357

2023.08.03

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

3927

2023.08.04

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

3927

2023.08.04

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

1283

2023.08.11

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

636

2023.08.10

Go-Zero API开发使用教程
Go-Zero API开发使用教程

本专题聚焦Go-Zero的API开发,拆解.api描述文件的语法结构、路由与分组定义、参数绑定与校验规则,说明统一响应体、JWT鉴权、跨域与接口文档生成的落地方式,并给出网关聚合与接口测试的实践建议。

140

2026.11.12

热门下载

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

精品课程

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn