为什么Python的classmethod第一个参数必须是cls

落雪君_6597

落雪君_6597

2026-11-11

778人浏览

原创

classmethod的第一个参数必须是cls,因为Python解释器会自动将调用该方法的类对象作为第一个参数传入,缺省即报TypeError;cls是位置强制、不可省略的约定参数,用于访问类属性和实现工厂方法等类级别操作。

为什么python的classmethod第一个参数必须是cls

classmethod 的第一个参数为什么必须是 cls

因为 @classmethod 的本质是让 Python 自动把「调用该方法的类对象」作为第一个参数传进来,而 cls 只是一个约定俗成的名字——你写成 klass 或 clazz 也能运行,但必须存在且是第一个位置。

这个参数不是可选的,也不是装饰器“建议”你加的;它是 Python 解释器在调用类方法时强制注入的。不写,就会报 TypeError: xxx() missing 1 required positional argument: 'cls'。

不写 cls 会出什么错

常见错误现象:定义了 @classmethod,但参数列表里漏了 cls,比如:

class User:
    @classmethod
    def create(username, password):  # ❌ 缺少 cls
        return User(username=username, password=password)

调用 User.create("alice", "123") 时,Python 实际上传入的是 User, "alice", "123" —— 三个参数,但函数只声明了两个形参,于是触发:

TypeError: create() takes 2 positional arguments but 3 were given

更隐蔽的情况是混用关键字参数:

  • 定义为 def register(username=None, password=None)(无 cls)
  • 调用为 User.register(username="a", password="b")
  • 结果报 TypeError: register() got multiple values for argument 'username'

原因:解释器把 User 当作第一个隐式参数塞进去,又通过关键字给了 username,导致重复赋值。

Python Hardener
Python Hardener

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

下载

cls 和 self 的根本区别在哪

区别不在名字,而在绑定对象的类型和生命周期:

  • self 绑定的是实例对象,它的属性、方法调用都依赖具体实例的状态
  • cls 绑定的是类对象,它能访问 cls.attr、调用其他 @classmethod 或 @staticmethod,甚至做 cls() 实例化
  • 继承时差异最明显:子类调用父类的 @classmethod,cls 是子类本身,不是父类 —— 这正是工厂方法能正确返回子类实例的关键

比如:

class Animal:
    @classmethod
    def spawn(cls):
        return cls()  # 注意:这里返回的是调用者的类,不是 Animal
<p>class Dog(Animal):
pass</p><p>d = Dog.spawn()  # d 是 Dog() 实例,不是 Animal()
</p>

可以改名吗?会影响什么

可以,但没必要。只要它是第一个参数,名字任意,例如:

@classmethod
def load(kls, data):  # ✅ 合法,kls 就是 cls
    return kls(**data)

但要注意:

  • 所有团队成员都得认这个新名字,协作成本上升
  • IDE 和静态检查工具(如 mypy)默认按 cls 做类型推导,换名可能触发误报
  • 文档和注释若仍写 “cls”,会造成理解断层

真正容易被忽略的是:即使你写了 cls,如果把它放在非首位(比如加了 *args 在前),一样会报错 —— 位置比名字重要。

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

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

python

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

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

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

2023.07.20

1911

4

python能做什么
python能做什么

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

2023.07.25

5304

7

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

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

2023.07.31

1849

3

python教程
python教程

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

2023.08.03

32037

23

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

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

2023.08.04

3787

5

python eval
python eval

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

2023.08.04

3807

5

scratch和python区别
scratch和python区别

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

2023.08.11

1263

5

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

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

2023.08.10

616

4

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

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

2023.08.11

2943

5

热门下载

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

精品课程

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