如何在 Python Shiny 中绘制 Matplotlib 直方图

本文详细介绍了在 Python Shiny 应用中正确渲染 Matplotlib 直方图的方法。核心在于理解 `render.plot` 如何处理 Matplotlib 对象的返回机制。我们探讨了两种有效的解决方案：通过隐式捕获当前 Matplotlib 图形或显式返回 `plt.hist()` 产生的图形艺术家集合，并提供了完整的代码示例和最佳实践建议，帮助开发者避免常见错误并高效地在 Shiny 中展示数据可视化。

引言

Python Shiny 提供了一个强大的框架，用于构建交互式 Web 应用程序。结合 Matplotlib 这样的流行绘图库，开发者可以轻松地在 Shiny 应用中展示复杂的数据可视化。然而，对于初学者来说，在 Shiny 中集成 Matplotlib 图形时可能会遇到一些挑战，尤其是在处理像直方图这类返回特定元组而非直接图形对象的函数时。本文将深入探讨如何在 Python Shiny 中正确绘制 Matplotlib 直方图，并提供两种解决方案。

理解问题：为什么直接返回 plt.hist() 会出错？

在 Matplotlib 中，plt.scatter() 等函数通常会直接在当前活动的 Axes 上绘制图形，并且 render.plot 能够很好地捕获这些操作。然而，plt.hist() 函数的行为略有不同。它不仅绘制直方图，还会返回一个包含三个元素的元组：

1. n: 直方图每个 bin 的计数。
2. bins: bin 的边界。
3. patches: 构成直方图的矩形（bar）的 Matplotlib Patch 对象集合。

当尝试直接 return plt.hist(random_data()) 时，render.plot 接收到的是这个元组，而不是一个可以直接渲染的 Matplotlib Figure 或 Axes 对象，因此会导致渲染失败或错误。

立即学习“Python免费学习笔记（深入）”；

解决方案一：隐式捕获当前 Matplotlib 图形（推荐）

这是最简洁且推荐的方法，尤其适用于简单的绘图场景。@render.plot 装饰器具有一个特性：如果被装饰的函数没有明确返回任何 Matplotlib 对象（如 Figure 或 Axes），它会自动尝试捕获当前活动的 Matplotlib 图形并进行渲染。这意味着我们只需要调用 plt.hist() 来绘制图形，而无需返回其结果。

示例代码：

Bolt.new

Bolt.new是一个免费的AI全栈开发工具

下载

import matplotlib.pyplot as plt
import numpy as np
from shiny import App, ui, reactive, render

# ... (app_ui 部分与原代码相同) ...

def server(input, output, session):
  @reactive.Calc
  def random_data():
    return np.random.rand(input.nr_of_observations())

  @output
  @render.plot
  def my_scatter():
    # plt.scatter() 隐式地在当前 Axes 上绘制
    plt.scatter(random_data(), random_data())
    # 无需返回任何内容，render.plot 会捕获当前图形

  @output
  @render.plot
  def my_histogram():
    # 只需调用 plt.hist() 进行绘制，无需返回其结果
    plt.hist(random_data())
    # render.plot 会自动捕获当前 Matplotlib 图形并渲染

  @output
  @render.text
  def my_summary():
    return str(random_data()) # 将 numpy 数组转换为字符串以便显示

app = App(app_ui, server)

工作原理： 当 my_histogram 函数被调用时，plt.hist(random_data()) 会在 Matplotlib 的当前活动 Figure 和 Axes 上绘制直方图。由于函数没有显式返回任何值，@render.plot 会检测到这一点，并自动获取当前活动的 Matplotlib Figure 对象，然后将其渲染到 Shiny UI 中。

解决方案二：返回特定的 Matplotlib 艺术家集合

虽然不如第一种方法通用，但这种方法也能够解决问题。它利用了 plt.hist() 返回元组中的第三个元素 patches，这是一个 BarContainer 对象，包含构成直方图的所有矩形（bar）的 Matplotlib Patch 对象集合。render.plot 有时能够直接渲染这类艺术家集合。

示例代码：

import matplotlib.pyplot as plt
import numpy as np
from shiny import App, ui, reactive, render

# ... (app_ui 部分与原代码相同) ...

def server(input, output, session):
  @reactive.Calc
  def random_data():
    return np.random.rand(input.nr_of_observations())

  @output
  @render.plot
  def my_scatter():
    plt.scatter(random_data(), random_data())

  @output
  @render.plot
  def my_histogram():
    # 返回 plt.hist() 返回元组的第三个元素 (patches)
    return plt.hist(random_data())[2]

  @output
  @render.text
  def my_summary():
    return str(random_data())

app = App(app_ui, server)

工作原理： 此方法显式地从 plt.hist() 的返回值中提取 patches 集合并将其返回。@render.plot 能够识别并渲染这些 Matplotlib 艺术家对象。虽然这种方法有效，但它对 plt.hist() 的返回值结构有特定的依赖，不如第一种方法那样通用，特别是当你需要对整个 Figure 或 Axes 进行更复杂的控制时。

完整的 Shiny 应用示例

为了提供一个完整的上下文，以下是使用推荐的第一种解决方案的完整 Shiny 应用代码：

from shiny import App, ui, reactive, render
import numpy as np
import matplotlib.pyplot as plt

# 定义 UI 布局
app_ui = ui.page_fluid(
    ui.panel_title("My Shiny Test Application"),
    ui.layout_sidebar(
      ui.panel_sidebar(
        ui.input_slider(
          "nr_of_observations", 
          "Number of observations",
          min = 0,
          max = 100,
          value = 30
        )
      ),
      ui.panel_main(
        ui.navset_tab(
          ui.nav(
            "Scatter",
            ui.output_plot("my_scatter")
          ),
          ui.nav(
            "Histogram",
            ui.output_plot("my_histogram")
          ),
          ui.nav(
            "Summary",
            ui.output_text_verbatim("my_summary"),
          )
        )
      )
    )
  )

# 定义服务器逻辑
def server(input, output, session):
  # 响应式计算，生成随机数据
  @reactive.Calc
  def random_data():
    return np.random.rand(input.nr_of_observations())

  # 渲染散点图
  @output
  @render.plot
  def my_scatter():
    # 直接调用 Matplotlib 绘图函数，render.plot 会自动捕获当前图形
    plt.scatter(random_data(), random_data())

  # 渲染直方图
  @output
  @render.plot
  def my_histogram():
    # 直接调用 Matplotlib 绘图函数，render.plot 会自动捕获当前图形
    plt.hist(random_data())

  # 渲染摘要文本
  @output
  @render.text
  def my_summary():
    # 将 numpy 数组转换为字符串以便在文本输出中显示
    return str(random_data())

# 创建 Shiny 应用实例
app = App(app_ui, server)

总结与最佳实践

在 Python Shiny 中使用 Matplotlib 绘制图形时，理解 render.plot 的工作机制至关重要。

1. 隐式捕获是首选： 对于大多数简单的 Matplotlib 绘图，如 plt.scatter() 或 plt.hist()，最简洁且推荐的方法是直接调用绘图函数，而不要从 render.plot 装饰的函数中返回任何内容。render.plot 会自动捕获当前活动的 Matplotlib Figure 对象并进行渲染。
2. 显式创建和返回 Figure： 对于更复杂的场景，例如在同一个输出中绘制多个子图，或者需要对 Figure 和 Axes 对象进行精细控制时，最佳实践是显式地创建 Matplotlib Figure 和 Axes 对象，然后将 Figure 对象返回。例如：

   @output
   @render.plot
   def my_complex_plot():
       fig, ax = plt.subplots()
       ax.hist(random_data())
       ax.set_title("My Custom Histogram")
       return fig # 显式返回 Figure 对象

3. 清理 Matplotlib 状态： 尽管 Shiny 的 render.plot 通常能很好地管理图形状态，但在某些复杂情况下，手动清理 Matplotlib 的全局状态（例如 plt.clf() 或 plt.close()）可能有助于避免意外行为，尤其是在显式创建 Figure 时。

通过遵循这些指南，您将能够有效地在 Python Shiny 应用中集成和展示各种 Matplotlib 图形，为用户提供丰富的数据可视化体验。更多详细信息和高级用法，请参考 Shiny for Python 的官方文档。