Python 3.12 Descriptor - 04 - classmethod

Python 3.12 Descriptor -classmethod在 Python 的面向对象编程中类方法class method是一种特殊的方法它通过classmethod装饰器定义方法的第一个参数是类本身通常命名为cls而不是实例self。类方法既可以由类调用也可以由实例调用并且它能够访问和修改类属性同时支持继承多态。与staticmethod不同类方法能够接收绑定到调用它的类的隐式参数。classmethod的实现依赖于描述符协议。理解classmethod的描述符本质不仅能更好地运用这个特性还能深入掌握 Python 的方法解析机制。本文将全面解析classmethod的语法、用途、与实例方法和静态方法的对比并深入其描述符实现原理通过模拟classmethod的内部代码揭示其如何实现类绑定。1. 类方法classmethod基础1.1 定义与语法类方法使用classmethod装饰器定义第一个参数通常命名为cls代表调用该方法的类而不是实例。例如classMyClass:class_attr42classmethoddefshow_class_attr(cls):print(fClass attribute value:{cls.class_attr})调用方式通过类调用MyClass.show_class_attr()通过实例调用obj MyClass(); obj.show_class_attr()两种调用方式都会将类MyClass自动作为第一个参数传入。1.2 为什么需要类方法类方法适用于以下场景需要访问或修改类属性而不是实例属性。作为工厂方法根据参数返回类的实例支持继承多态子类调用时返回子类实例。定义替代构造函数如dict.fromkeys。封装与类相关但不依赖特定实例的逻辑。1.3 与实例方法和静态方法的区别特性实例方法类方法静态方法第一个参数self实例cls类无通过实例调用自动传入self自动传入cls即实例的类不传入额外参数通过类调用需传入self通常不推荐自动传入cls不传入额外参数访问实例属性是否但可通过传入实例否访问类属性通过self.__class__是直接使用cls否可通过类名显式访问继承多态实例方法被子类继承但调用的仍是子类实例支持子类调用类方法时cls绑定到子类不支持多态被子类继承但不会自动识别子类常用场景操作实例数据工厂方法、操作类属性、替代构造函数工具函数、与类相关但不依赖类状态2.classmethod的描述符实现2.1 函数和方法的基本描述符行为在 Python 中普通函数也是非数据描述符它们实现了__get__方法。当通过实例访问一个函数属性时__get__返回一个绑定方法bound method对象该对象将实例作为第一个参数预填充当通过类访问时返回原始函数。例如classExample:definstance_method(self):passobjExample()print(obj.instance_method)# bound method Example.instance_method of ...print(Example.instance_method)# function Example.instance_method at ...2.2classmethod的描述符行为classmethod装饰器返回的是一个非数据描述符其__get__方法的行为与普通函数不同它不绑定到实例而是绑定到类。具体来说当通过实例访问时__get__会将实例的类type(instance)作为第一个参数并返回一个新的可调用对象该对象会调用原始函数并传入该类。当通过类访问时__get__直接将类绑定为第一个参数。因此无论通过实例还是类调用类方法第一个参数总是类而非实例。2.3 用 Python 模拟classmethod的实现我们可以用纯 Python 模拟classmethod的核心逻辑来揭示其描述符本质classClassMethod:def__init__(self,func):self.funcfuncdef__get__(self,instance,owner):# owner 是类instance 是实例可能为 Nonedefwrapper(*args,**kwargs):# 调用原始函数将 owner(类) 作为第一个参数returnself.func(owner,*args,**kwargs)returnwrapper验证classDemo:class_attrHelloClassMethoddefgreet(cls,name):print(f{cls.class_attr},{name})Demo.greet(World)# Hello, WorlddDemo()d.greet(Alice)# Hello, Alice__get__方法返回的是wrapper函数该函数捕获了owner即类并传递给原始函数self.func。注意wrapper每次调用都会创建一个新的函数对象这可能会产生轻微的性能开销但通常可以忽略。内置的classmethod是用 C 实现的效率更高。2.4 C 层面的实现简要在 CPython 中classmethod对应的 C 结构是classmethodobject其descr_get函数类似于staticPyObject*classmethod_descr_get(PyObject*meth,PyObject*obj,PyObject*type){// 如果从类访问type 就是该类如果从实例访问取 type(instance)if(obj!NULL)type(PyObject*)Py_TYPE(obj);// 创建一个绑定到 type 的方法对象实际上是一个偏函数returnPyCFunction_NewEx(???,type,NULL);}简单说它返回一个可调用对象该对象将type作为第一个参数固化下来。3.classmethod的使用场景与示例3.1 访问和修改类属性classCounter:count0classmethoddefincrement(cls):cls.count1classmethoddefget_count(cls):returncls.count Counter.increment()Counter.increment()print(Counter.get_count())# 23.2 替代构造函数工厂方法classDate:def__init__(self,year,month,day):self.yearyear self.monthmonth self.daydayclassmethoddeffrom_string(cls,date_str):year,month,daymap(int,date_str.split(-))returncls(year,month,day)classmethoddeftoday(cls):importtime ttime.localtime()returncls(t.tm_year,t.tm_mon,t.tm_mday)d1Date.from_string(2023-12-25)d2Date.today()3.3 支持继承的多态工厂classAnimal:classmethoddefcreate(cls,name):returncls(name)classDog(Animal):def__init__(self,name):self.namenameclassCat(Animal):def__init__(self,name):self.namename dogDog.create(Buddy)catCat.create(Whiskers)print(type(dog))# class __main__.Dogprint(type(cat))# class __main__.Cat子类没有重写create但调用Dog.create时cls绑定到Dog因此返回的是Dog实例。如果用staticmethod则做不到这一点。3.4 作为类级别的缓存或注册表classRegistry:_registry{}classmethoddefregister(cls,name,value):cls._registry[name]valueclassmethoddefget(cls,name):returncls._registry.get(name)Registry.register(pi,3.14)print(Registry.get(pi))# 3.143.5 与继承配合使用子类覆盖类方法子类可以覆盖类方法并且覆盖后的方法仍然通过cls正确绑定到子类。classBase:classmethoddefidentify(cls):returncls.__name__classDerived(Base):classmethoddefidentify(cls):子类重写类方法返回类名带有不同前缀returnfDerived version:{cls.__name__}print(Base.identify())print(Derived.identify())# Base version: Base# Derived version: Derived4.classmethod与staticmethod的对比特性classmethodstaticmethod是否接收隐式参数是接收类cls否能否访问/修改类属性是可通过类名显式访问但不推荐能否被继承且多态是cls会绑定到子类是但不会自动识别子类函数本身继承但调用的仍然是原函数没有动态绑定典型用途工厂方法、替代构造函数、操作类状态工具函数、命名空间分组选择原则如果需要动态绑定到调用它的类支持多态或者需要访问类属性使用classmethod。如果仅仅是将一个函数放到类内部作为工具且不依赖类状态使用staticmethod或普通模块级函数。5.classmethod与继承、方法覆盖的细节5.1 子类调用父类的类方法如果子类没有重写类方法调用子类的类方法时cls仍然绑定到子类而非父类。例如classParent:classmethoddefshow(cls):print(fClass:{cls.__name__})classChild(Parent):passChild.show()# Class: Child5.2 覆盖类方法子类可以重写类方法覆盖后通过子类调用将执行子类版本通过父类调用执行父类版本。classParent:classmethoddefaction(cls):print(Parent action)classChild(Parent):classmethoddefaction(cls):print(Child action)Parent.action()# Parent actionChild.action()# Child action5.3 在类方法中调用其他类方法使用cls可以调用同一个类中的其他类方法从而实现良好的协作。classMyClass:classmethoddefhelper(cls):return42classmethoddefmain(cls):returncls.helper()15.4super()与类方法在类方法中可以使用super()来调用父类的类方法super()会自动处理类的绑定。classA:classmethoddefgreet(cls):returnfHello from{cls.__name__}classB(A):classmethoddefgreet(cls):returnsuper().greet() (B)print(B.greet())# Hello from B (B)6. 高级话题自定义类似classmethod的描述符我们可以编写自己的描述符实现类似classmethod的行为同时增加额外功能例如日志记录或权限检查。classLoggedClassMethod:def__init__(self,func):self.funcfuncdef__get__(self,instance,owner):defwrapper(*args,**kwargs):print(fCalling class method{self.func.__name__}on{owner.__name__})returnself.func(owner,*args,**kwargs)returnwrapperclassDemo:LoggedClassMethoddeftest(cls,x):print(fcls:{cls}, x:{x})Demo.test(10)# 输出# Calling class method test on Demo# cls: class __main__.Demo, x: 10注意每次访问__get__都会返回一个新的wrapper函数因此会有轻微的性能开销。实际内置classmethod是用 C 实现的效率更高。7. 常见误区与最佳实践7.1 误区在类方法中使用self类方法的第一个参数是cls不是self。如果在类方法中使用self会导致参数名混淆但 Python 不会报错只是语义不对。应始终使用cls。7.2 误区类方法只能由类调用实际上类方法也可以由实例调用此时第一个参数仍然是类type(instance)而不是实例。通过实例调用类方法虽然合法但会让人困惑通常建议通过类调用。7.3 误区classmethod与staticmethod的选择有些开发者习惯在不需要实例的情况下总是使用staticmethod但若将来可能需要子类多态应使用classmethod。最好默认使用classmethod除非明确不需要访问类且不需要多态。7.4 最佳实践在类方法中尽量使用cls操作类属性而不要硬编码类名以支持继承。将类方法作为替代构造函数时务必返回cls(...)而不是固定的类名。如果类方法只需要类常量而不需要动态绑定可以使用staticmethod配合类属性访问但牺牲了多态性。8.classmethod与其他装饰器的组合类方法可以与其他装饰器如property、abstractmethod组合使用。8.1classmethod与property直接组合classmethod和property会出错因为property返回的是描述符而类方法期望可调用。Python 3.9 提供了classmethod与property的合理组合方式先classmethod再property会报错但可以通过classmethod的__get__返回一个property实例实际上要实现类级别的只读属性可以定义一个类方法来返回属性值或者使用元类。更常用的模式是使用classmethod直接定义方法。8.2classmethod与abstractmethod抽象基类ABC中可以定义抽象类方法要求子类实现。使用abstractmethod和classmethod组合时应将classmethod作为外层装饰器如fromabcimportABC,abstractmethodclassBase(ABC):classmethodabstractmethoddeffactory(cls):pass9. 性能与底层优化访问类方法的开销比普通实例方法略大因为涉及描述符查找和函数包装。但在大多数应用中差异可以忽略。如果对性能要求极高可以考虑使用普通函数替代类方法但会失去语义清晰度。内置的classmethod是 C 实现的比 Python 模拟版本快得多。10. 总结特性classmethod作用定义与类相关的方法接收类作为第一个参数描述符类型非数据描述符绑定行为无论通过类还是实例调用都将类绑定为第一个参数调用方式Class.method()或instance.method()适用场景工厂方法、操作类属性、替代构造函数、支持继承多态与staticmethod的区别接收cls能访问类属性且支持多态staticmethod不接收隐式参数底层实现C 实现的描述符返回一个将类预填充为第一个参数的可调用对象classmethod是 Python 中实现类级别多态和灵活工厂模式的关键工具。通过描述符协议它巧妙地拦截属性访问将类作为第一个参数注入从而在不实例化的情况下操作类状态。理解其描述符本质不仅有助于避免常见陷阱还能激发我们设计更优雅的 API。通过深入理解classmethod的描述符原理你可以更自信地使用类方法并在必要时设计自己的类绑定机制。如果在学习过程中遇到问题欢迎在评论区留言讨论!