如何基于ACTIONS元组生成Python抽象基类以强制子类实现指定方法？

我正好解决过类似的需求，咱们可以利用Python的抽象基类（ABC）机制，结合__init_subclass__钩子来实现动态根据ACTIONS元组要求子类实现对应方法的功能，完全不用硬编码每个抽象方法。

核心思路 #

我们创建一个基础的抽象基类，当子类继承它并定义ACTIONS元组时，基类会自动遍历元组里的每个动作：

• 如果子类没有实现该动作方法，就自动为这个动作添加一个标记为@abstractmethod的方法存根
• 这样Python的ABC机制就会阻止未实现所有动作方法的子类被实例化，抛出明确的错误提示

代码实现（Python 3.6+ 推荐） #

from abc import ABC, abstractmethod

class ActionRequiredABC(ABC):
    def __init_subclass__(cls, **kwargs):
        super().__init_subclass__(**kwargs)
        # 检查子类是否定义了ACTIONS元组
        if hasattr(cls, 'ACTIONS'):
            for action in cls.ACTIONS:
                # 判断子类是否已经实现了该方法
                method = getattr(cls, action, None)
                if not callable(method) or isinstance(method, abstractmethod):
                    # 定义抽象方法存根
                    def _abstract_method(self):
                        raise NotImplementedError(f"Subclass must implement `{action}()`")
                    # 将方法标记为抽象方法并绑定到子类
                    setattr(cls, action, abstractmethod(_abstract_method))

用法示例 #

正确实现所有动作的子类

class Sample(ActionRequiredABC):
    ACTIONS = ('run', 'sleep', 'kill')

    def run(self):
        print("Executing run action...")
    
    def sleep(self):
        print("Executing sleep action...")
    
    def kill(self):
        print("Executing kill action...")

# 实例化正常执行
sample = Sample()
sample.run()  # 输出: Executing run action...

未实现全部动作的子类（会触发错误）

class FooBar(ActionRequiredABC):
    ACTIONS = ('run', 'sleep')

    def sleep(self):
        print("Executing sleep action...")

# 尝试实例化会抛出TypeError
try:
    foobar = FooBar()
except TypeError as e:
    print(e)  # 输出: Can't instantiate abstract class FooBar with abstract method run

兼容旧版本Python（3.5及以下） #

如果需要支持Python 3.5或更早版本，可以用元类来实现相同的逻辑：

from abc import ABCMeta, abstractmethod

class ActionRequiredMeta(ABCMeta):
    def __new__(cls, name, bases, namespace):
        new_class = super().__new__(cls, name, bases, namespace)
        if hasattr(new_class, 'ACTIONS'):
            for action in new_class.ACTIONS:
                # 检查子类是否在定义时就实现了该方法
                if action not in namespace or not callable(namespace[action]):
                    def _abstract_method(self):
                        raise NotImplementedError(f"Subclass must implement `{action}()`")
                    setattr(new_class, action, abstractmethod(_abstract_method))
        return new_class

# 使用元类的抽象基类
class ActionRequiredABC(metaclass=ActionRequiredMeta):
    pass

方案优势 #

• 无硬编码：子类只需要维护ACTIONS元组，不用手动给每个方法加@abstractmethod装饰器
• 自动校验：基类自动检查动作方法的实现情况，未实现的会被标记为抽象方法，阻止实例化
• 错误清晰：抛出的TypeError会明确指出哪个抽象方法未实现，便于调试

内容的提问来源于stack exchange，提问作者Shyam Sunder