0

0

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

冰川箭仙

冰川箭仙

发布时间:2026-01-18 21:06:08

|

767人浏览过

|

来源于php中文网

原创

最可靠方法是检查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

if is_running_in_jupyter(): print("正在 Jupyter 环境中运行") else: print("不在 Jupyter 环境中")

方法二:检查环境变量 JUPYTER_ENVJPY_PARENT_PID

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

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

示例:

喜鹊标书
喜鹊标书

AI智能标书制作平台,10分钟智能生成20万字投标方案,大幅提升中标率!

下载
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__ 是否为 ,因为该字符串格式不稳定且可能被覆盖。

相关专题

更多
python开发工具
python开发工具

php中文网为大家提供各种python开发工具,好的开发工具,可帮助开发者攻克编程学习中的基础障碍,理解每一行源代码在程序执行时在计算机中的过程。php中文网还为大家带来python相关课程以及相关文章等内容,供大家免费下载使用。

760

2023.06.15

python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

639

2023.07.20

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

762

2023.07.25

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

618

2023.07.31

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

1265

2023.08.03

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

549

2023.08.04

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

579

2023.08.04

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

709

2023.08.11

高德地图升级方法汇总
高德地图升级方法汇总

本专题整合了高德地图升级相关教程,阅读专题下面的文章了解更多详细内容。

72

2026.01.16

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 4.2万人学习

Django 教程
Django 教程

共28课时 | 3.2万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.2万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号