如何让%matplotlib widget仅在VS Code交互式模式执行并避免语法错误？

问题场景 #

在VS Code中使用带有# %%分隔符的.py脚本时，希望仅在交互式运行单个代码块时启用%matplotlib widget，而执行整个脚本时不启用该魔法命令——因为交互式模式下无法将图表保存为.pgf格式，整脚本运行时的窗口支持此格式。

最初尝试的逻辑在单独运行代码块时有效，但执行整个文件时，VS Code会将%matplotlib widget判定为语法错误：

if src.visualization.isNotebook():
    %matplotlib widget

其中isNotebook()函数用于检测是否处于交互式环境：

def isNotebook() -> bool:
    try:
        shell = get_ipython().__class__.__name__
        if shell == 'ZMQInteractiveShell':
            return True   # Jupyter notebook 或 qtconsole
        elif shell == 'TerminalInteractiveShell':
            return False  # 终端运行的IPython
        else:
            return False  # 其他类型环境
    except NameError:
        return False      # 标准Python解释器

问题原因 #

%matplotlib是IPython专属的魔法命令，普通Python解释器无法解析该语法。当执行整个脚本时，解释器会直接扫描到这行代码并抛出语法错误，即便它处于if分支中。

解决方案 #

改用IPython提供的run_line_magic()方法替代直接书写魔法命令，这是一个标准的Python函数调用，普通解释器可以正常解析，且仅在交互式环境下才会执行魔法命令逻辑。

修改后的代码如下：

if src.visualization.isNotebook():
    from IPython import get_ipython
    get_ipython().run_line_magic('matplotlib', 'widget')

说明 #

• run_line_magic()方法接受两个参数：第一个是魔法命令的名称（此处为matplotlib），第二个是命令的参数（此处为widget），作用和直接写%matplotlib widget完全一致。
• 将from IPython import get_ipython放在if分支内部，确保只有在交互式环境下才会导入该模块，避免在普通Python环境中产生不必要的依赖。

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