后端#

什么是后端?#

后端用于在屏幕上显示 Matplotlib 图形(参见图介绍),或写入文件。网站和邮件列表中的许多文档都提到了“后端”一词,许多新用户对此感到困惑。Matplotlib 针对许多不同的用例和输出格式。有些人从 Python shell 交互式使用 Matplotlib,当他们输入命令时,绘图窗口会弹出。有些人运行Jupyter 笔记本并绘制内联图以进行快速数据分析。其他人将 Matplotlib 嵌入到像 PyQt 或 PyGObject 这样的图形用户界面中,以构建丰富的应用程序。有些人使用 Matplotlib 在批处理脚本中从数值模拟生成 postscript 图像,还有一些人运行 Web 应用程序服务器来动态提供图表。

为了支持所有这些用例,Matplotlib 可以针对不同的输出,这些能力中的每一种都被称为后端;“前端”是面向用户的代码,即绘图代码,而“后端”则在幕后完成所有艰苦的工作来创建图形。后端分为两种类型:用户界面后端(用于 PyQt/PySide、PyGObject、Tkinter、wxPython 或 macOS/Cocoa);也称为“交互式后端”)和用于生成图像文件(PNG、SVG、PDF、PS;也称为“非交互式后端”)的硬拷贝后端。

选择后端#

有三种配置后端的方式

以下是更详细的描述。

如果存在多个配置,则列表中的最后一个优先;例如,调用 matplotlib.use() 将覆盖您的 matplotlibrc 文件中的设置。

如果未显式设置后端,Matplotlib 会根据您系统上可用的后端以及 GUI 事件循环是否已在运行来自动检测可用的后端。将选择以下列表中第一个可用的后端:MacOSX、QtAgg、GTK4Agg、Gtk3Agg、TkAgg、WxAgg、Agg。最后一个 Agg 是一个非交互式后端,只能写入文件。如果 Matplotlib 无法连接到 X 显示器或 Wayland 显示器,则在 Linux 上使用它。

以下是配置方法的详细描述

  1. 在您的 matplotlibrc 文件中设置 rcParams["backend"]

    backend : qtagg   # use pyqt with antigrain (agg) rendering
    

    另请参见使用样式表和 rcParams 自定义 Matplotlib

  2. 设置 MPLBACKEND 环境变量

    您可以为当前 shell 或单个脚本设置此环境变量。

    在 Unix 上

    > export MPLBACKEND=qtagg
    > python simple_plot.py
    
    > MPLBACKEND=qtagg python simple_plot.py
    

    在 Windows 上,只有前者是可能的

    > set MPLBACKEND=qtagg
    > python simple_plot.py
    

    设置此环境变量将覆盖 任何 matplotlibrc 中的 backend 参数,即使在您当前的工作目录中存在 matplotlibrc。因此,不建议全局设置 MPLBACKEND,例如在您的 .bashrc.profile 中,因为它可能导致反直觉的行为。

  3. 如果您的脚本依赖于特定的后端,您可以使用函数 matplotlib.use()

    import matplotlib
    matplotlib.use('qtagg')
    

    这应该在创建任何图形之前完成,否则 Matplotlib 可能无法切换后端并引发 ImportError。

    如果用户想要使用不同的后端,则使用 use 将需要更改您的代码。因此,除非绝对必要,否则应避免显式调用 use

内置后端#

默认情况下,Matplotlib 应该会自动选择一个默认后端,它允许交互式工作和从脚本绘图,并将输出显示在屏幕上和/或写入文件,因此至少在开始时,您无需担心后端问题。最常见的例外是,如果您的 Python 发行版不带 tkinter 并且您没有安装其他 GUI 工具包。这在某些 Linux 发行版中会发生,您需要安装一个名为 python-tk(或类似名称)的 Linux 包。

然而,如果您想编写图形用户界面,或一个 Web 应用程序服务器(嵌入到 Web 应用程序服务器中(Flask)),或需要更好地理解正在发生的事情,请继续阅读。为了使图形用户界面更容易定制,Matplotlib 将渲染器(实际执行绘图的组件)的概念与画布(绘图的位置)的概念分离开来。用户界面的标准渲染器是 Agg,它使用 Anti-Grain Geometry C++ 库来生成图形的栅格(像素)图像;它被 QtAggGTK4AggGTK3AggwxAggTkAggmacosx 后端使用。另一种渲染器基于 Cairo 库,由 QtCairo 等使用。

对于渲染引擎,用户还可以区分 矢量栅格 渲染器。矢量图形语言发出“从A点到B点画一条线”之类的绘图命令,因此是无缩放的。栅格后端生成线的像素表示,其精度取决于 DPI 设置。

静态后端#

以下是 Matplotlib 渲染器的摘要(每个渲染器都有一个同名的后端;这些是非交互式后端,能够写入文件)

渲染器

文件类型

描述

AGG

png

栅格 图形 — 使用 Anti-Grain Geometry 引擎的高质量图像。

PDF

pdf

矢量 图形 — 可移植文档格式 输出。

PS

ps, eps

矢量 图形 — PostScript 输出。

SVG

svg

矢量 图形 — 可伸缩矢量图形 输出。

PGF

pgf, pdf

矢量 图形 — 使用 pgf 包。

Cairo

png, ps, pdf, svg

栅格矢量 图形 — 使用 Cairo 库(需要 pycairocairocffi)。

要使用非交互式后端保存绘图,请使用 matplotlib.pyplot.savefig('filename') 方法。

交互式后端#

这些是支持的用户界面和渲染器组合;这些是交互式后端,能够显示在屏幕上并使用上表中适当的渲染器写入文件

后端

描述

QtAgg

Qt 画布中进行 Agg 渲染(需要 PyQtQt for Python,又称 PySide)。可以在 IPython 中通过 %matplotlib qt 激活此后端。Qt 绑定可以通过 QT_API 环境变量选择;有关详细信息,请参阅 Qt 绑定

ipympl

Agg 渲染嵌入在 Jupyter 小部件中(需要 ipympl)。可以在 Jupyter 笔记本中通过 %matplotlib ipympl%matplotlib widget 启用此后端。适用于 Jupyter labnotebook>=7

GTK3Agg

GTK 3.x 画布中进行 Agg 渲染(需要 PyGObjectpycairo)。可以在 IPython 中通过 %matplotlib gtk3 激活此后端。

GTK4Agg

GTK 4.x 画布中进行 Agg 渲染(需要 PyGObjectpycairo)。可以在 IPython 中通过 %matplotlib gtk4 激活此后端。

macosx

在 macOS 的 Cocoa 画布中进行 Agg 渲染。可以在 IPython 中通过 %matplotlib osx 激活此后端。

TkAgg

Tk 画布中进行 Agg 渲染(需要 TkInter)。可以在 IPython 中通过 %matplotlib tk 激活此后端。

nbAgg

将交互式图形嵌入到 Jupyter 经典笔记本中。可以在 Jupyter 笔记本中通过 %matplotlib notebook%matplotlib nbagg 启用此后端。适用于 Jupyter notebook<7nbclassic

WebAgg

调用 show() 时将启动一个带有交互式图形的 tornado 服务器。

GTK3Cairo

GTK 3.x 画布中进行 Cairo 渲染(需要 PyGObjectpycairo)。

GTK4Cairo

GTK 4.x 画布中进行 Cairo 渲染(需要 PyGObjectpycairo)。

wxAgg

wxWidgets 画布中进行 Agg 渲染(需要 wxPython 4)。可以在 IPython 中通过 %matplotlib wx 激活此后端。

注意

内置后端名称不区分大小写;例如,'QtAgg' 和 'qtagg' 是等效的。

ipympl#

ipympl 后端位于一个单独的包中,如果您希望使用它,则必须显式安装,例如

pip install ipympl

conda install ipympl -c conda-forge

有关详细信息,请参阅安装 ipympl

使用非内置后端#

更一般地,可以使用上述任何方法选择任何可导入的后端。如果 name.of.the.backend 是包含后端的模块,则使用 module://name.of.the.backend 作为后端名称,例如 matplotlib.use('module://name.of.the.backend')

后端实现者的信息可在 编写后端——pyplot 接口 获取。

调试图形窗口不显示的问题#

有时事情并非如预期般顺利,通常在安装过程中。

如果您正在使用 Notebook 或集成开发环境(参见 Notebooks 和 IDEs),请查阅其文档以调试图形在其环境中无法工作的问题。

如果您正在使用 Matplotlib 的图形后端之一(参见 独立脚本和交互式使用),请确保您知道正在使用哪一个

import matplotlib

print(matplotlib.get_backend())

尝试一个简单的绘图,看看 GUI 是否打开

import matplotlib
import matplotlib.pyplot as plt

print(matplotlib.get_backend())
plt.plot((1, 4, 6))
plt.show()

如果没有打开,您可能存在安装问题。此时一个好的步骤是确保您的 GUI 工具包已正确安装,将 Matplotlib 排除在测试之外。几乎所有 GUI 工具包都有一个可以运行的小型测试程序来测试基本功能。如果此测试失败,请尝试重新安装。

QtAgg, QtCairo, Qt5Agg, and Qt5Cairo#

测试 PyQt5

如果您安装的是 PySidePyQt6 而不是 PyQt5,只需相应地更改导入即可

python -c "from PyQt5.QtWidgets import *; app = QApplication([]); win = QMainWindow(); win.show(); app.exec()"

TkAgg and TkCairo#

测试 tkinter

python3 -c "from tkinter import Tk; Tk().mainloop()"

GTK3Agg, GTK4Agg, GTK3Cairo, GTK4Cairo#

测试 Gtk

python3 -c "from gi.repository import Gtk; win = Gtk.Window(); win.connect('destroy', Gtk.main_quit); win.show(); Gtk.main()"

wxAgg and wxCairo#

测试 wx

import wx

app = wx.App(False)  # Create a new app, don't redirect stdout/stderr to a window.
frame = wx.Frame(None, wx.ID_ANY, "Hello World") # A Frame is a top-level window.
frame.Show(True)     # Show the frame.
app.MainLoop()

如果测试对您所需的后端有效,但您仍然无法让 Matplotlib 显示图形,请联系我们(参见 获取帮助)。