如何检测当前代码是否运行在 Jupyter Notebook 环境里

胖雪姑娘_9831

胖雪姑娘_9831

2026-01-18

787人浏览

原创

最可靠方法是检查get_ipython()是否存在且其类型包含'ZMQInteractiveShell',再辅以JPY_PARENT_PID环境变量验证,可准确区分Jupyter Notebook、JupyterLab、Colab等与普通Python环境。

如何检测当前代码是否运行在 jupyter notebook 环境里

可以通过检查 Python 的运行环境变量或导入特定模块来判断代码是否在 Jupyter Notebook(或 JupyterLab)中执行。最常用、可靠的方法是检测 get_ipython() 是否存在且其类型是否为 Jupyter 相关的交互式 shell。

方法一:检查 get_ipython() 和其类型

这是最主流、兼容性最好的方式,适用于 Jupyter Notebook、JupyterLab、Google Colab 等基于 IPython 的环境:

  • 调用 get_ipython(),若在 IPython/Jupyter 中会返回一个 shell 实例;在普通 Python 解释器或脚本中会抛出 NameError
  • 进一步检查其 __class__.__name__ 或模块路径,可区分 Jupyter 与普通 IPython 终端(如 QtConsole)

示例代码:

def is_running_in_jupyter():
    try:
        from IPython import get_ipython
        ipython = get_ipython()
        if ipython is None:
            return False
        # 检查是否为 Jupyter 内核(而非 IPython 终端)
        return 'ZMQInteractiveShell' in str(type(ipython))
    except ImportError:
        return False
    except NameError:
        return False
<p>if is_running_in_jupyter():
print("正在 Jupyter 环境中运行")
else:
print("不在 Jupyter 环境中")
</p>

方法二:检查环境变量 JUPYTER_ENV 或 JPY_PARENT_PID

Jupyter 启动时通常会设置一些进程级环境变量,其中较稳定的是 JPY_PARENT_PID(Jupyter Python Parent PID),它在 notebook kernel 启动时被注入:

  • 该变量存在且非空,大概率说明运行在 Jupyter kernel 中
  • 注意:它也可能出现在 JupyterLab 扩展或某些嵌入式场景中,但误判率较低

示例:

Gmail 日历和驱动程序的 Google Workspace MCP 服务器
Gmail 日历和驱动程序的 Google Workspace MCP 服务器

Google Workspace MCP 服务器通过任何支持 MCP 的 AI 助手,提供对 Gmail、Google Calendar、Drive、Docs、Sheets、Slides、Forms、Tasks、Contacts 和 Chat 的全面自然语言控制。它支持 OAuth 2.1 多用户认证,并包含用于编码代理的 CLI。

下载
import os
is_jupyter = 'JPY_PARENT_PID' in os.environ and os.environ['JPY_PARENT_PID'].isdigit()

方法三:结合多种信号提高鲁棒性

单一判断可能有边界情况(例如某些定制内核或测试 mock 环境),推荐组合使用:

  • 先尝试 get_ipython() + 类型校验(主依据)
  • 再 fallback 到 JPY_PARENT_PID 环境变量(辅助验证)
  • 避免依赖 sys.argv 或工作目录等易变特征

这样能覆盖 notebook、lab、colab、kaggle notebook 等主流场景,同时对本地脚本、终端 IPython、VS Code Python Interactive 窗口也能合理区分。

注意事项

不要仅靠 sys.argv[0] 是否含 "jupyter" 来判断——那是启动命令,不是当前运行上下文;也不建议依赖 __file__ 是否为 ,因为该字符串格式不稳定且可能被覆盖。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.03

1938

5

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

3224

5

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

2023.10.24

6404

49

字符串介绍
字符串介绍

字符串是一种数据类型,它可以是任何文本,包括字母、数字、符号等。字符串可以由不同的字符组成,例如空格、标点符号、数字等。在编程中,字符串通常用引号括起来,如单引号、双引号或反引号。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

2023.11.24

6609

6

java读取文件转成字符串的方法
java读取文件转成字符串的方法

Java8引入了新的文件I/O API,使用java.nio.file.Files类读取文件内容更加方便。对于较旧版本的Java,可以使用java.io.FileReader和java.io.BufferedReader来读取文件。在这些方法中,你需要将文件路径替换为你的实际文件路径,并且可能需要处理可能的IOException异常。想了解更多java的相关内容,可以阅读本专题下面的文章。

2024.03.22

8134

16

php中定义字符串的方式
php中定义字符串的方式

php中定义字符串的方式:单引号;双引号;heredoc语法等等。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

2024.04.29

12674

11

go语言字符串相关教程
go语言字符串相关教程

本专题整合了go语言字符串相关教程,阅读专题下面的文章了解更多详细内容。

2025.07.29

6599

17

c++字符串相关教程
c++字符串相关教程

本专题整合了c++字符串相关教程,阅读专题下面的文章了解更多详细内容。

2025.08.07

7407

13

常用字符串方法大全
常用字符串方法大全

常用字符串方法大全

2025.08.08

3628

14

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程