讲师中心 微信公众号
AI工具推荐 视频效率加速

如何在Python中实现只允许通过关键字传参的函数接口?

梦芳姑娘_8821

梦芳姑娘_8821

发布时间:2026-09-03 09:57:22

|

750人浏览过

|

来源于php中文网

原创

Python 3.8+用*可强制仅关键字参数,如def send_email(*, to, subject, body),调用必须显式命名参数,否则报错;其核心是将所有参数置于*后且前方无位置参数,体现调用契约。

如何在python中实现只允许通过关键字传参的函数接口?

Python 3.8+:用 /* 明确分隔参数类型

Python 3.8 引入了仅限位置参数(/)和仅限关键字参数(*)的语法,这是实现“只允许关键字传参”的最直接方式。关键不是只用 *,而是把所有参数放在 * 后面,且前面不放任何可位置传的参数。

常见错误是写成 def f(*, a, b) 却仍尝试 f(1, 2)——这会报 TypeError: f() takes 0 positional arguments but 2 were given,但用户可能误以为是函数没定义好,其实是调用姿势错了。

  • def send_email(*, to: str, subject: str, body: str) —— 正确:必须写成 send_email(to="a@b.c", subject="Hi", body="...")
  • 不能省略参数名,哪怕只有一个参数:send_email("a@b.c", ...) 直接报错
  • 如果函数已有部分位置参数,又想强制后续为关键字,用 def f(a, b, *, c, d);但“只允许关键字”意味着前面不能有可位置传的参数,所以开头不能有普通参数

兼容旧版本(Py**kwargs + 手动校验

低于 3.8 的环境无法用 * 语法,只能退而求其次:接受任意关键字参数,再显式检查必需字段、拒绝多余字段、拒绝位置参数。

容易踩的坑是只校验 **kwargs 是否包含必要键,却忘了检查是否传了位置参数——func("x", y=1) 中的 "x" 会被忽略或引发逻辑错误。

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

python全能编程助手
python全能编程助手

SkillSub Pro - Python 题解与代码注释双功能技能功能概述SkillSub Pro - Python 题解与代码注释双功能技能是一项面向实际任务的技能,主要用于SkillSub Pro 是一个 Python 题解生成与代码注释的 双功能合体技能 ,专为学生、算法学习者和开发者设计;✅ 一个技能,两种用途 :;核心要点📝 题解模式 :输入题目/题号,自动生成完整 Python 题解(含详细注释、解题思路、复杂度分析);💬 注释模式 :输入 Python 代码,自动添加详细中。它将相关步骤、

下载
  • 必须在函数开头检查 len(args) == 0,否则位置参数悄悄溜进来了
  • required = {"to", "subject", "body"}if not required.issubset(kwargs.keys()) 校验必填项
  • 额外建议加 if kwargs.keys() - required: 警告或拒绝未知参数,避免静默忽略拼写错误(如 subjet

为什么不用 @functools.wraps 或装饰器自动处理?

有人想封装一个通用装饰器,比如 @keyword_only,自动拦截位置参数并校验关键字。理论上可行,但实际中问题不少:

  • 装饰器无法改变 Python 解析调用时的参数绑定行为,f(1, 2) 在进入装饰器前就已经被解释为两个位置参数,你只能在运行时抛错,无法让 IDE 或类型检查器(如 mypy)提前感知
  • 签名(inspect.signature)会被装饰器污染,导致文档生成、自动补全、help() 显示混乱
  • 性能上多一层调用开销,对高频函数(如数据处理内层循环)不友好

除非项目强约束所有函数都走统一网关(如 API 层),否则不如直接用原生 * 语法或手写校验更透明可控。

类型提示与静态检查配合使用

仅靠运行时限制不够。mypy 等工具能提前发现错误调用,但前提是签名正确标注。注意 * 本身不带类型信息,需配合 typing 注解。

  • 正确写法:def load_config(*, path: str, encoding: str = "utf-8") -> dict: ...
  • mypy 能识别 load_config("x.yml") 是错的,并提示 “Too many positional arguments”
  • 如果用了 **kwargs 方案,必须加 -> None 并配 # type: ignore 或自定义协议(Protocol),否则类型检查形同虚设

真正难的不是写出来,而是让团队所有人一致理解:这个函数的调用方式是契约的一部分,不是可选项。一旦松动,比如某处临时改成位置调用绕过校验,整个约束就失效了。

热门AI工具

更多
音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

Laper
Laper Hot

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

UpDream
UpDream Hot

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

DeepSeek

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

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

豆包大模型

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

Atoms
Atoms Hot

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

WorkBuddy

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

相关专题

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

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

1551

2023.07.20

python能做什么
python能做什么

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

3664

2023.07.25

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

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

1569

2023.07.31

python教程
python教程

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

20897

2023.08.03

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

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

2587

2023.08.04

python eval
python eval

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

2647

2023.08.04

scratch和python区别
scratch和python区别

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

1063

2023.08.11

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

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

576

2023.08.10

Vibeknow在线使用入口合集
Vibeknow在线使用入口合集

本专题汇总了Vibeknow在线创作视频的官方入口及网页版使用教程,涵盖PPT、PDF、Word等文档一键转讲解视频的核心操作,并整理了免费版水印规则与手机端浏览器访问指南,助你快速将知识内容视频化。

0

2026.09.21

热门下载

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

精品课程

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

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