Django中使用Zope.interface未触发接口实现完整性校验问题咨询

开发方向合理性说明 #

在Django项目中引入接口约束实现类的设计思路没有问题，zope.interface是成熟的接口实现库，也被不少Django生态的第三方组件使用，不存在开发方向错误的问题。

无报错的核心原因 #

zope.interface的@implementer装饰器本身仅做标记作用，默认不会在类定义、实例化阶段自动校验接口的实现完整性，这和Java接口在编译期强制校验的逻辑有本质区别，就是你代码中MyClass2缺少method2和属性x也不会报错的根本原因。

解决方法 #

你可以通过主动触发校验的方式实现类似Java的强制约束效果，有两种常用方案：

方案1：手动调用校验方法 #

使用zope.interface自带的verify模块的方法主动校验，适合零散校验的场景：

• verifyClass(接口类, 实现类)：校验类层面的实现完整性，类定义完成后调用即可
• verifyObject(接口类, 实例对象)：校验实例层面的实现完整性，实例化后调用
  修改后的示例代码如下：

import zope.interface
from zope.interface.verify import verifyClass, verifyObject

class MyInterface(zope.interface.Interface):
    x = zope.interface.Attribute("foo")
    def method1(self, x):
        pass
    def method2(self):
        pass
  
@zope.interface.implementer(MyInterface)
class MyClass:
    x = 1
    def method1(self, x):
        return x**2
    def method2(self):
        return "foo"

@zope.interface.implementer(MyInterface)
class MyClass2:
    def method1(self, x):
        return x**2

# 主动校验
verifyClass(MyInterface, MyClass) # 校验通过，无报错
verifyClass(MyInterface, MyClass2) # 直接抛出BrokenImplementation异常，提示缺少method2方法和x属性

# 实例层面校验示例
c = MyClass()
verifyObject(MyInterface, c) # 校验通过

方案2：元类实现自动校验 #

如果需要全局自动校验，不需要每次手动写校验代码，可以封装通用元类，所有接口实现类继承后会在类定义阶段自动触发校验：

import zope.interface
from zope.interface.verify import verifyClass

class AutoVerifyInterfaceMeta(type):
    def __new__(cls, name, bases, attrs):
        new_cls = super().__new__(cls, name, bases, attrs)
        # 遍历所有声明实现的接口做校验
        for iface in zope.interface.implementedBy(new_cls):
            verifyClass(iface, new_cls)
        return new_cls

# 使用示例
@zope.interface.implementer(MyInterface)
class MyClass2(metaclass=AutoVerifyInterfaceMeta):
    def method1(self, x):
        return x**2
# 类定义阶段就会直接抛出校验错误，不需要等到实例化或者调用

补充替代方案 #

如果不想引入zope.interface依赖，也可以用Python原生能力实现相同的接口约束效果，更符合Python的惯用写法：

• 使用abc.ABC抽象基类：通过@abstractmethod标记抽象方法和属性，子类未实现所有抽象成员的话，实例化时会自动抛出异常
• Python3.8+ 可以用typing.Protocol：添加@runtime_checkable装饰器后也支持运行时校验，更适合鸭子类型的接口约束场景

内容的提问来源于stack exchange，提问作者Shahzad Fateh Ali