父类初始化子类依赖数据：更优实现与契约强制方案

问题背景 #

我有一个父类WorldMapAnimator，负责初始化带有特定矩形配置的matplotlib.axes._axes.Axes对象——这是保证2048×1024尺寸图像无空白显示的必要条件（bbox_inches='tight'会裁剪空白导致尺寸不符合要求）。

子类可以重写_plot_initial_frame和_update_frame方法定制绘图，但当前设计存在两个问题：

• 无法强制子类调用super()._plot_initial_frame()，只能依赖文档说明，否则会丢失正确的Axes配置
• 子类直接修改父类的保护成员（如self._ax），设计上不够严谨

当前实现代码如下：

from matplotlib.pyplot import axes, figure
from cartopy.crs import Projection, PlateCarree


class WorldMapAnimator:

    def __init__(
            self, projection: Projection = PlateCarree(), n_frames: int = 3):
        self._projection = projection
        self._n_frames = n_frames

    @staticmethod
    def get_rectangle_for_full_plot():
        """Emulating a public static const"""
        rectangle_for_full_plot = [0, 0, 1, 1]
        return rectangle_for_full_plot

    def animate(self):
        self._plot_initial_frame()
        for frame in range(self._n_frames):
            self._update_frame(frame)

    def _plot_initial_frame(self):
        self._fig = figure()

        # IMPORTANT: The axes must have this type of rectangle configuration
        self._ax = axes(
            self.get_rectangle_for_full_plot(),
            projection=self._projection)

        self._ax.coastlines()

    def _update_frame(self):
        return


class PerlinNoiseAnimator(WorldMapAnimator):
    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)

    def _plot_initial_frame(self):
        # 必须调用super才能获得正确配置，依赖开发者自觉
        super()._plot_initial_frame()
        # 直接修改父类保护成员
        self._ax.pcolormesh(...)  # TODO: 绘制柏林噪声
        return

    def _update_frame(self):
        # 更新柏林噪声
        return

Pythonic解决方案 #

1. 钩子方法模式（推荐） #

将父类中必须执行的配置逻辑与子类可扩展的定制逻辑分离，父类负责强制执行核心配置，子类只需要实现钩子方法来添加自定义内容，无需手动调用super()。

修改后的父类：

from matplotlib.pyplot import axes, figure
from cartopy.crs import Projection, PlateCarree


class WorldMapAnimator:

    def __init__(
            self, projection: Projection = PlateCarree(), n_frames: int = 3):
        self._projection = projection
        self._n_frames = n_frames
        self._fig = None
        self._ax = None

    @staticmethod
    def get_rectangle_for_full_plot():
        return [0, 0, 1, 1]

    def animate(self):
        self._plot_initial_frame()
        for frame in range(self._n_frames):
            self._update_frame(frame)

    def _plot_initial_frame(self):
        # 强制执行核心配置，子类无法绕过
        self._fig = figure()
        self._ax = axes(
            self.get_rectangle_for_full_plot(),
            projection=self._projection)
        self._ax.coastlines()
        # 调用钩子方法，子类可重写该方法添加自定义初始化内容
        self._on_initial_frame_ready()

    def _on_initial_frame_ready(self):
        # 默认空实现，子类重写即可
        pass

    def _update_frame(self, frame):
        # 调用钩子方法，子类重写实现帧更新逻辑
        self._on_update_frame(frame)

    def _on_update_frame(self, frame):
        # 默认空实现
        pass

子类实现：

class PerlinNoiseAnimator(WorldMapAnimator):
    def _on_initial_frame_ready(self):
        # 无需调用super，直接添加自定义绘图
        self._ax.pcolormesh(...)  # 绘制柏林噪声

    def _on_update_frame(self, frame):
        # 实现帧更新逻辑
        # 例如更新柏林噪声数据并重新绘制
        pass

这种模式的优势：

• 父类完全控制核心配置的执行，子类无法绕过
• 子类只需关注定制逻辑，无需关心父类的初始化细节
• 避免了子类直接调用super()的依赖

2. 封装保护成员，提供受控访问API #

为了避免子类直接修改父类的保护变量（如self._ax），可以提供受控的访问方法，既保证子类能使用Axes对象，又限制不必要的修改：

在父类中添加：

@property
def axes(self):
    """提供只读的Axes对象访问"""
    return self._ax

def add_artist(self, artist):
    """统一添加绘图元素的方法，可额外做校验或日志"""
    self._ax.add_artist(artist)

子类中使用：

def _on_initial_frame_ready(self):
    # 通过属性访问Axes，而非直接修改保护变量
    self.axes.pcolormesh(...)
    # 或者使用统一接口
    # mesh = self.axes.pcolormesh(...)
    # self.add_artist(mesh)

3. 抽象基类（ABC）强化契约 #

如果需要强制子类实现特定的钩子方法，可以结合abc模块，确保子类必须实现定制逻辑：

from abc import ABC, abstractmethod

class WorldMapAnimator(ABC):
    # ... 其他代码不变 ...

    @abstractmethod
    def _on_initial_frame_ready(self):
        """子类必须实现该方法"""
        pass

    @abstractmethod
    def _on_update_frame(self, frame):
        """子类必须实现该方法"""
        pass

这样如果子类没有实现这两个抽象方法，在实例化时会直接抛出TypeError，强制子类遵守契约。

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