大数跨境

PEP 487 - 更简单地自定义类的创建方式

PEP 487 - 更简单地自定义类的创建方式 Python程序员
2017-10-29
0
导读:该PEP建议通过类主体中的一个新的__init_subclass__钩子和一个用于初始化属性的钩子来支持广泛的定制场景。

Python部落(python.freelycode.com)组织翻译,禁止转载,欢迎转发。

概要

目前,自定义类创建需要使用自定义元类。 然后,这个自定义元类在类的整个生命周期持续存在,可能引起潜在的伪元类冲突。

该PEP建议通过类主体中的一个新的__init_subclass__钩子和一个用于初始化属性的钩子来支持广泛的定制场景。

新的机制应该比实现自定义元类更容易理解和使用,因此应该提供一个比较简单的对Python的元类机制的强大功能的介绍。

背景

元类是自定义类创建的强大工具。 但是,其问题在于没有自动合并元类的方式。 如果想要为一个类使用两个元类,那么需要创建一个包含两种需求的一个新的元类,通常是手动完成的。

这通常对用户来说很吃惊:从两个不同库中的两个基类继承,突然需要手动创建新的合并元类,然而通常这里根本不关心这些库的细节。 如果一个库开始使用以前没有创建过的元类,这会变得更糟。 虽然库本身继续工作,但突然间,将这些类与其他库中的类结合在一起的所有代码都将失败。

建议

尽管有许多可能的方式来使用元类,绝大多数用例可分为三类:在类创建之后运行初始化代码,描述符初始化和类属性定义保持固定的顺序。

前两个类别可以通过在类创建中调用简单的钩子实现:

  • 一个__init_subclass__钩子,用于初始化给定类的所有子类。

  • 在类创建时,在类中定义的所有属性(描述符)上调用__set_name__钩子。

  • 第三种类别是在另一个PEP(PEP 520)的主题详述。

例如,第一个用例如下所示:

基类对象包含一个空的__init_subclass__方法,它用作协作多重继承的端点。请注意,此方法没有关键字参数,这意味着具体实现的所有方法必须处理所有关键字参数。

这个总的建议不是一个新的想法(最早在10多年前首先在语言定义中提到[1],而且Zope的ExtensionClass [2]也早已支持类似的机制),但近年来情况发生了很大的变化,这个想法值得重新考虑纳入。

该建议的第二部分为类属性(特别是如果它们是描述符时)添加了一个__set_name__初始值。描述符是在一个类的正文中定义的,但是他们并不知道该类的任何内容,甚至不知道调用者的名字。一旦__get__被调用,他们就会知道调用者,但是他们还是不知道调用者的名字。这是不幸的,例如他们不能将关联值放在调用者对象的以其名字存放的__dict__中,因为他们不知道这个名字。这个问题已经解决了很多次,而且最重要的原因之一是使用了元类。虽然使用建议的第一部分来实现这样的机制很容易,但是为每个人提供一个解决这个问题的方法是有道理的。

为了给出其用法的一个例子,想象一个代表弱引用值的描述符:

例如,这样的WeakAttribute可以在树结构中使用,其中希望通过父节点避免循环引用:

请注意,父属性像普通属性一样使用,但是树不包含循环引用,因此在不使用时可以轻松地进行垃圾回收。 一旦父属性不存在了,父属性就会变成“None”。

虽然这个例子看起来很简单,但应该指出的是,到目前为止,这种属性在不使用元类的情况下是无法定义的。 使用元类会使情况变得非常糟糕,而不用元类,需要的这种属性还不存在。

初始化描述符可以简单地在__init_subclass__钩子中完成。 但是这将意味着描述符只能在具有适当钩子的类中使用,在该示例中的通用版本将无法正常工作。 也可以从object.__ init_subclass__的基本实现中调用__set_name__。 但是,由于忘记调用super()是一个常见的错误,所以描述符不会被初始化的错误会经常碰到。

主要优点

定义时间行为的继承更容易

了解Python的元类需要深入了解类型系统和类构造过程。由于需要在头脑中明确区分多个活动件(代码,元类提示,实际元类,类对象,类对象的实例),这是具有挑战性的。即使你知道规则,如果你不是非常小心的话,还是很容易犯错误的。

了解所提出的隐式类初始化钩子只需要普通的方法继承,这不是一个令人生畏的任务。新的钩子提供了一个更渐进的方式来了解类定义过程中涉及的所有阶段。

减少元类冲突的几率

使库作者不愿使用元类的一个大问题(即使它们适合)就是元类冲突的风险。当类定义的父类使用两个不相关的元类时,就会出现这种情况。这种风险也使得很难将元类添加到以前发布过的没有使用元类的类中。

相比之下,将__init_subclass__方法添加到现有类型中会增加类似的__init__方法风险级别:从技术上讲,存在执行不良实现的子类的风险,但是当发生这种情况时,它被认为是子类中的错误而不是库作者违反向后兼容性保证。

使用类的新方法

子类注册

特别是在编写插件系统时,喜欢注册插件基类的新子类。 这可以如下方法做到:

在此示例中,PluginBase.subclasses将包含整个继承树中所有子类的简单列表。 应该注意,这也能作为一个混合类正常工作。

特征描述符

有许多非官方的Python描述符的设计,例如检查值的边界。 通常这些“特征”需要一个元类来支持工作。 这是这个PEP的样子:

实现细节

钩子按以下顺序调用:在新类初始化之后,type.__ new__调用描述符上的__set_name__钩子。然后在基类(super())上调用__init_subclass__。这意味着子类初始化器已经看到完全初始化的描述符。这样,如果需要,__init_subclass__用户可以再次修改所有描述符。

另一个选择是在object.__ init_subclass__的基本实现中调用__set_name__。这样就可以防止__set_name__被调用。然而,大多数时候,这样的预防是偶然的,因为经常发生忘记调用super()。

作为第三个选项,所有的工作都可以在type.__ init__中完成。大多数元类在__new__中完成工作,因为这是文档建议的。许多元类在将它们传递给super().__ new__之前修改它们的参数。为了兼容这些类,钩子应该从__new__调用。

应该做的另一个小小的改变:在当前的CPython实现中,type.__ init__明确禁止使用关键字参数,然而type.__ new__允许其属性作为关键字参数。这是怪异的前后不连贯,所以应该是禁止的。虽然可以保留当前的行为,但是如果这是固定的,它可能会更好,因为它可能根本没有被使用:唯一的用例是在元类中使用name,bases和dict(是的,dict,不是主要用于现代元类的namespace或ns)作为关键字参数来调用自己的super().__ new__。不应该这么做。这个小小的改变简化了该PEP的实现,同时提高了Python整体的一致性。

第二个改变是,新的type.__ init__只是忽略关键字参数。目前,它坚持不给出关键字参数。如果给类声明定义关键字参数而元类不处理它们,则会导致(既定的)错误。元类作者要接受关键字参数必须通过覆盖__init___来过滤掉它们。

在新代码中,__init__不再抱怨关键字参数,而__init_subclass__(其默认实现不带参数)依然不支持。在使用方法解析顺序的经典继承方案中,每个__init_subclass__可以取出它的关键字参数,由__init_subclass__的默认实现来检查,直到都处理完。

对于喜欢使用英文阅读Python的读者,此PEP建议用以下内容替换当前type和object:

参考实现

本PEP的参考实现附于第27366号。

向后兼容性问题

type.__ new__中的确切调用顺序略有改变,引起了向后兼容性的担忧。 应该通过测试来确保常见的用例符合需要。

以下类定义(定义元类的定义除外)继续失败,并抛出TypeError,因为传递了多余的类参数:

仅定义一个对关键字参数感兴趣的__new__方法的元类现在不需要定义一个__init__方法作为默认类型.__ init__忽略关键字参数。 这很符合在元类中替代__init__来覆盖__new__的建议。 以下代码不会失败:

如果仅在元类中定义__init__方法并且给出关键字参数,将继续失败并抛出TypeError:

同时定义__init__和__new__将工作正常。

唯一不能正常工作的是传递type.__ new__的参数作为关键字参数:

这将抛出TypeError,但这是奇怪的代码,即使有人使用此功能也很容易修复。

被拒绝的设计选项

调用该类的钩子本身

在类本身上添加一个__autodecorate__钩子是PEP 422的提出的想法。大多数示例的工作方式相同,甚至只有在严格的子类中才调用该钩子。 一般来说,安排明确地在定义的类上显式调用钩子(以选择这种方式)比不使用这种方式更容易(通过记住检查cls是钩体中的__class ),这意味着一个人不希望在定义它的类上调用该钩子。

如果所讨论的类被设计为混合类,这是最明显的:对于混合类本身而言,mixin的代码是不太可能的,因为它本身不应该是一个完整的类。

原始提案也对类初始化过程做了重大改变,使得无法将提案反向移植到较旧的Python版本。

当需要在基类上调用钩子时,有两种机制可用:

引入一个额外的mixin类只是为了保存__init_subclass__实现。 原来的“基”类可以列出新的mixin作为其第一个父类。

作为一个独立的类装饰器实现所需的行为,并将该装饰器显式应用于基类,然后通过__init_subclass__隐式地分配给子类。

从类装饰器显式调用__init_subclass__通常是不受欢迎的,因为这通常也会在父类上再次调用__subclass_init__,这不太可能是期望的行为。

调用钩子的其他变体

提出了钩子的其他名称,即__decorate__或__autodecorate__。 此提案选择__init_subclass__,因为它非常接近__init__方法,仅用于子类,而它不是非常接近装饰器,因为它不返回类。

对于__set_name__钩子,还提出了其他名称,__set_owner__,__set_ownership__和__init_descriptor__。

在__init_subclass__上需要一个显式装饰器

可能需要在__init_subclass__装饰器上明确使用@classmethod。 这是隐含的,因为将其退出时没有明确的解释,因此需要检测这种情况,以便给出一个有用的错误信息。

在注意到定义__prepare__并忘记了@classmethod方法装饰器的用户体验是非常不可理解的(特别是因为PEP 3115将其作为普通方法进行文档化,并且当前文档没有明确说出任何一种方式或其他方式)。

一个更像__new __式的钩子

在PEP 422中,钩子更像__new__方法而非__init__方法,这意味着它返回一个类,而不是修改一个类。 这允许更多的灵活性,但代价是更难实现并且不可预知的副作用。

使用属性顺序添加类属性

它在PEP 520主题中描述。

历史

这曾经是Nick Coghlan和Daniel Urban对PEP 422的一个竞争性提案。 PEP 422旨在实现与此PEP相同的目标,但具有不同的实施方式。 同时,PEP 422已经撤回并且赞成这种做法。

引用

[1]https://mail.python.org/pipermail/python-dev/2001-November/018651.html

[2]http://docs.zope.org/zope_secrets/extensionclass.html

版权

该文件已被放置在公共领域。

源: https://github.com/python/peps/blob/master/pep-0487.txt


英文原文:https://www.python.org/dev/peps/pep-0487/
译者:jianli


【声明】内容源于网络
0
0
Python程序员
1234
内容 0
粉丝 0
Python程序员 1234
总阅读0
粉丝0
内容0