如何在Jupyter Notebook中编程检查前端魔法命令可用性

我刚好碰到过类似的需求，给你几个靠谱的解决方案，分Python内核侧和前端JavaScript侧两种场景来介绍：

1. Python内核侧直接检测（最可靠） #

因为%%local是cell魔法命令，我们可以通过IPython的魔法管理器来检查它是否注册，或者直接尝试执行一个空的%%local命令来判断：

方法一：检查魔法命令注册表 #

from IPython import get_ipython

def has_local_magic():
    ip = get_ipython()
    if not ip:
        return False  # 非IPython环境
    # 检查cell魔法中是否存在'local'
    return 'local' in ip.magics_manager.magics.get('cell', {})

方法二：尝试执行空命令（容错性更强） #

有些情况下魔法可能注册了但无法正常运行，这种方法更稳妥：

from IPython import get_ipython

def has_local_magic():
    ip = get_ipython()
    if not ip:
        return False
    try:
        # 执行空的%%local cell，无副作用
        ip.run_cell_magic('local', '', '')
        return True
    except Exception:
        # 纯Python内核会抛出魔法命令不存在的异常
        return False

你可以在初始化comm的时候先调用这个函数，把结果传递给前端JS，这样JS就知道后续要不要使用%%local魔法了。

2. 前端JavaScript侧的检测方案 #

如果你想直接在JS侧判断，可以结合内核信息和sparkmagic的特性：

方法一：检查内核名称 #

PySpark3内核的名称通常带有spark或pyspark标识，你可以通过Jupyter的内核API获取：

function hasLocalMagic() {
    const kernelName = Jupyter.notebook.kernel.name;
    // 根据你的内核命名规则调整，比如'pyspark3'、'spark_python'等
    return kernelName.includes('spark') || kernelName.includes('pyspark');
}

这个方法的缺点是依赖内核的命名规范，如果你的内核名称自定义过可能不准。

方法二：利用sparkmagic的前端配置 #

sparkmagic确实会在前端注册一些配置，你可以检查IPython.CodeCell的默认配置里是否包含%%local相关的设置：

function hasLocalMagic() {
    // 检查sparkmagic是否给CodeCell添加了local魔法的支持
    return typeof IPython !== 'undefined' && 
           IPython.CodeCell && 
           IPython.CodeCell.config_defaults &&
           // sparkmagic会注册cell_magic的补全，或者检查相关配置
           (IPython.CodeCell.config_defaults.highlight_modes['magic_local'] !== undefined);
}

这个方法更贴近你提到的访问kernel.js配置的需求，sparkmagic在加载时会给CodeCell添加magic_local的高亮模式，通过这个可以判断是否支持。

结合你的场景使用 #

因为你是用ipykernel.comm在JS和Python之间通信，最推荐的流程是：

1. 页面加载时，JS通过comm发送一个检测请求到Python内核
2. Python内核调用上面的has_local_magic()函数，把结果返回给JS
3. JS根据返回的结果决定后续调用Python命令时是否使用%%local魔法

这样既兼容纯Python3内核，也能正确识别PySpark3内核的特性。

内容的提问来源于stack exchange，提问作者MPękalski