如何在Python 3.8中使用Positional-Only参数定义类方法

冬瑶大大_3437

冬瑶大大_3437

2026-11-05

194人浏览

原创

Python 3.8中类方法的positional-only参数必须将/置于self之后、其他参数之间,self不可被标记为仅位置,且/前参数仅能位置传入、/后可混用,*后则强制关键字;例如def add(self, x, y, /, z=10, *, w=100)。

如何在python 3.8中使用positional-only参数定义类方法

Python 3.8 中类方法怎么写 positional-only 参数

必须用 / 符号显式分隔,且只能放在参数列表中间或末尾(不能在 * 或 ** 后),类方法中和普通函数一样生效,但要注意 self 的位置。

常见错误是把 / 放在 self 前面,比如 def method(/, self, x) —— 这会直接报 SyntaxError: invalid syntax。正确写法是 self 必须作为第一个形参,positional-only 参数紧随其后。

  • self 永远是第一个参数,不可省略,也不可标为 positional-only
  • 所有想设为仅位置传参的参数,必须放在 / 左侧,且在 self 之后
  • / 右侧的参数可以位置或关键字传入;* 右侧的才强制关键字(keyword-only)
  • 不支持 def method(self, /, x, y, /) 这种多个 / —— 一个函数最多一个 /

实际定义示例:带 positional-only 的类方法

下面这个例子中,x 和 y 是仅位置参数,z 可位置或关键字,w 强制关键字:

class Calc:
    def add(self, x, y, /, z=10, *, w=100):
        return x + y + z + w

调用时:

  • c = Calc(); c.add(1, 2) ✅ 允许(z 用默认值,w 用默认值)
  • c.add(1, 2, 3) ✅ 允许(z=3,w 仍用默认)
  • c.add(1, 2, z=3) ✅ 允许(z 改为关键字传入)
  • c.add(1, 2, w=5) ✅ 允许(w 是 keyword-only)
  • c.add(x=1, y=2) ❌ 报 TypeError: add() got some positional-only arguments passed as keyword arguments

为什么类方法里用 positional-only 参数?

主要是为了接口稳定性与语义清晰:比如你后续想把某个参数从“支持关键字”改成“仅位置”,又不想破坏已有调用(因为用户可能误用了关键字形式),提前设为 positional-only 能尽早暴露问题。

Python Hardener
Python Hardener

通过完整的安全审查、代码整洁重构、健壮的错误处理、正确的日志记录以及完整的文档字符串覆盖,强化 Python 脚本。

下载

另一个典型场景是封装 C 扩展或仿照内置函数行为(如 str.replace(old, new, /, count)),让 Python 层接口和底层逻辑对齐。

  • 参数名未来可能重命名(比如从 axis 改成 dim),但位置不变 —— positional-only 避免用户依赖旧参数名
  • 避免用户混淆同义参数(如 inplace=True vs mutate=True),干脆不给关键字名
  • CPython 内部大量使用(dict.pop(key, /, default)),学它不是为了炫技,而是减少歧义

容易忽略的兼容性细节

Python 3.8+ 才支持 / 语法,低于 3.8 会直接 SyntaxError;而且类型检查工具(如 mypy)直到 0.930+ 才完整支持 positional-only 标注,旧版可能报错或静默忽略。

  • 类型注解要写成 def method(self, x: int, y: str, /, z: float = ...),mypy 0.930+ 才能正确校验
  • docstring 里别写 :param x: 这种,因为 x 不接受关键字传入;建议注明 “(positional-only)”
  • inspect.signature() 能识别 /,但旧版 IDE(如 PyCharm 2020.1 之前)可能无法正确渲染参数提示
  • 如果方法被装饰(如 @classmethod 或自定义装饰器),确保装饰器不修改签名,否则 / 可能失效

最常被跳过的点:没检查运行环境 Python 版本就提交代码,CI 上直接挂掉 —— 务必在 pyproject.toml 或 setup.py 里锁死 python_requires=">=3.8"。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关专题

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

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

2023.07.20

1871

4

python能做什么
python能做什么

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

2023.07.25

5104

7

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

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

2023.07.31

1809

3

python教程
python教程

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

2023.08.03

30777

23

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

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

2023.08.04

3647

5

python eval
python eval

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

2023.08.04

3667

5

scratch和python区别
scratch和python区别

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

2023.08.11

1243

5

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

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

2023.08.10

616

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2843

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程