matplotlib绘图函数应返回什么？多场景适配疑问

核心原则：让函数接受外部传入的Axes/Figure对象，而非内部创建 #

解决多场景复用问题的关键是不要让函数自行创建Figure或Axes，而是让调用者传入已有的绘图容器，函数只负责在容器内绘制内容。这样能适配所有场景的渲染需求，同时避免重复显示、堆叠等问题。

具体实现方案 #

• 函数参数设计：

  • 可选参数ax，默认值为None。当ax为None时，才内部创建Figure和Axes（仅作为兜底兼容）；否则直接使用传入的ax进行绘制。
  • 对于双轴场景，函数可以返回创建的所有Axes对象（比如一个包含主副轴的元组），或者完全由调用者传入主轴，函数负责创建副轴并返回。

• 示例代码：

import matplotlib.pyplot as plt

class PlotGenerator:
    def plot_with_twin_axis(self, ax=None):
        # 处理传入的Axes，没有则创建
        if ax is None:
            fig, ax = plt.subplots()
        # 创建副轴
        ax2 = ax.twinx()
        # 绘制主副轴内容
        ax.plot([1,2,3], [4,5,6], label='主轴数据')
        ax2.plot([1,2,3], [10,20,15], color='red', label='副轴数据')
        # 返回所有用到的Axes（如果是内部创建的也可以返回Figure）
        return ax, ax2

各场景适配方式 #

• Jupyter Notebook：
  调用时可以直接让函数创建Axes，或者手动创建后传入，避免重复显示：

  # 方式1：自动创建（Notebook中默认会渲染返回的Axes）
  gen = PlotGenerator()
  ax1, ax2 = gen.plot_with_twin_axis()
  # 方式2：手动创建，更可控
  fig, ax = plt.subplots()
  ax1, ax2 = gen.plot_with_twin_axis(ax=ax)
  plt.close(fig)  # 避免自动渲染，手动用display(fig)控制
  display(fig)
  

• Qt应用/Widget：
  提前创建好Qt对应的FigureCanvas，将其Axes传入函数，绘制后直接更新画布即可，不会出现堆叠：

  from matplotlib.backends.backend_qt5agg import FigureCanvasQTAgg as FigureCanvas
  
  # 初始化Qt画布
  fig = plt.Figure()
  canvas = FigureCanvas(fig)
  ax = fig.add_subplot(111)
  # 调用绘图函数
  gen = PlotGenerator()
  ax1, ax2 = gen.plot_with_twin_axis(ax=ax)
  # 更新画布
  canvas.draw()
  

• 交互组件（Widget）：
  同样采用传入已有Axes的方式，在交互回调中只需要清除Axes内容，重新调用绘图函数即可实现更新：

  def on_widget_change(value):
      # 清除已有内容
      ax.clear()
      ax2.clear()
      # 重新绘制
      ax1, ax2 = gen.plot_with_twin_axis(ax=ax)
      # 更新显示
      plt.draw()
  

避免返回值陷阱的注意事项 #

• 不要默认返回Figure：在Notebook中，返回Figure会触发自动渲染，容易导致重复显示；Qt场景中返回Figure也不利于和已有画布绑定。
• 多轴场景返回所有Axes：用元组或列表返回所有创建/使用的Axes，方便调用者后续修改样式、添加图例等操作。
• 兜底逻辑仅作为兼容：优先让调用者传入Axes，内部创建仅作为无传入时的 fallback，保证灵活性。

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