我试图在运行 IPython 笔记本时获取当前的笔记本名称。我知道我可以在笔记本顶部看到它。我追求的是什么
currentNotebook = IPython.foo.bar.notebookname()
我需要在变量中获取名称。
问问题
60084 次
12 回答
45
添加到以前的答案，
要获取笔记本名称，请在单元格中运行以下命令：
%%javascript
IPython.notebook.kernel.execute('nb_name = "' + IPython.notebook.notebook_name + '"')
这将为您提供 nb_name 中的文件名
然后要获得完整路径，您可以在单独的单元格中使用以下内容：
import os
nb_full_path = os.path.join(os.getcwd(), nb_name)
于 2017-06-16T12:17:24.643 回答
43
我有以下适用于 IPython 2.0 的内容。我观察到笔记本的名称存储为页面标签中'data-notebook-name'的属性值。<body>因此，想法是首先要求 Javascript 检索属性--javascripts 可以从代码单元中调用，这要归功于%%javascript魔术。然后可以通过调用 Python 内核访问 Javascript 变量，使用设置 Python 变量的命令。由于最后一个变量是从内核中知道的，因此也可以在其他单元中访问它。
%%javascript
var kernel = IPython.notebook.kernel;
var body = document.body,
attribs = body.attributes;
var command = "theNotebook = " + "'"+attribs['data-notebook-name'].value+"'";
kernel.execute(command);
来自 Python 代码单元
print(theNotebook)
Out[ ]: HowToGetTheNameOfTheNoteBook.ipynb
该解决方案的一个缺陷是，当更改笔记本的标题（名称）时，该名称似乎不会立即更新（可能存在某种缓存），因此需要重新加载笔记本才能访问新名字。
[编辑]经过反思，一个更有效的解决方案是寻找笔记本名称的输入字段而不是<body>标签。查看源代码，该字段的 id 似乎为“notebook_name”。然后可以通过 a 捕获该值document.getElementById()，然后遵循与上述相同的方法。代码变成了，仍然使用 javascript 魔法
%%javascript
var kernel = IPython.notebook.kernel;
var thename = window.document.getElementById("notebook_name").innerHTML;
var command = "theNotebook = " + "'"+thename+"'";
kernel.execute(command);
然后，从 ipython 单元格中，
In [11]: print(theNotebook)
Out [11]: HowToGetTheNameOfTheNoteBookSolBis
与第一种解决方案相反，笔记本名称的修改会立即更新，无需刷新笔记本。
于 2014-05-12T21:54:21.440 回答
28
如前所述，您可能不应该真正做到这一点，但我确实找到了一种方法。这是一个燃烧的黑客，所以不要依赖这个：
import json
import os
import urllib2
import IPython
from IPython.lib import kernel
connection_file_path = kernel.get_connection_file()
connection_file = os.path.basename(connection_file_path)
kernel_id = connection_file.split('-', 1)[1].split('.')[0]
# Updated answer with semi-solutions for both IPython 2.x and IPython < 2.x
if IPython.version_info[0] < 2:
## Not sure if it's even possible to get the port for the
## notebook app; so just using the default...
notebooks = json.load(urllib2.urlopen('http://127.0.0.1:8888/notebooks'))
for nb in notebooks:
if nb['kernel_id'] == kernel_id:
print nb['name']
break
else:
sessions = json.load(urllib2.urlopen('http://127.0.0.1:8888/api/sessions'))
for sess in sessions:
if sess['kernel']['id'] == kernel_id:
print sess['notebook']['name']
break
我更新了我的答案，以包含一个在 IPython 2.0 中“有效”的解决方案，至少通过一个简单的测试。如果有多个笔记本连接到同一个内核等，则可能无法保证给出正确答案。
于 2012-10-24T18:35:29.157 回答
28
看来我无法发表评论，所以我必须将其发布为答案。
@iguananaut 接受的解决方案和@mbdevpl 的更新似乎不适用于笔记本的最新版本。我修复了它，如下所示。我在 Python v3.6.1 + Notebook v5.0.0 以及 Python v3.6.5 和 Notebook v5.5.0 上检查了它。
import jupyterlab
if jupyterlab.__version__.split(".")[0] == "3":
from jupyter_server import serverapp as app
key_srv_directory = 'root_dir'
else :
from notebook import notebookapp as app
key_srv_directory = 'notebook_dir'
import urllib
import json
import os
import ipykernel
def notebook_path(key_srv_directory, ):
"""Returns the absolute path of the Notebook or None if it cannot be determined
NOTE: works only when the security is token-based or there is also no password
"""
connection_file = os.path.basename(ipykernel.get_connection_file())
kernel_id = connection_file.split('-', 1)[1].split('.')[0]
for srv in app.list_running_servers():
try:
if srv['token']=='' and not srv['password']: # No token and no password, ahem...
req = urllib.request.urlopen(srv['url']+'api/sessions')
else:
req = urllib.request.urlopen(srv['url']+'api/sessions?token='+srv['token'])
sessions = json.load(req)
for sess in sessions:
if sess['kernel']['id'] == kernel_id:
return os.path.join(srv[key_srv_directory],sess['notebook']['path'])
except:
pass # There may be stale entries in the runtime directory
return None
如文档字符串中所述，这仅在没有身份验证或身份验证是基于令牌的情况下才有效。
请注意，正如其他人所报告的那样，基于 Javascript 的方法在执行“运行所有单元格”时似乎不起作用（但在“手动”执行单元格时起作用），这对我来说是一个交易破坏者。
于 2018-09-05T14:16:18.617 回答
27
在 Jupyter 3.0 上，以下工作。在这里，我显示了 Jupyter 服务器上的整个路径，而不仅仅是笔记本名称：
将 存储NOTEBOOK_FULL_PATH在当前笔记本前端：
%%javascript
var nb = IPython.notebook;
var kernel = IPython.notebook.kernel;
var command = "NOTEBOOK_FULL_PATH = '" + nb.base_url + nb.notebook_path + "'";
kernel.execute(command);
然后显示它：
print("NOTEBOOK_FULL_PATH:\n", NOTEBOOK_FULL_PATH)
运行第一个Javascript单元不会产生任何输出。运行第二个Python单元会产生如下内容：
NOTEBOOK_FULL_PATH:
/user/zeph/GetNotebookName.ipynb
于 2015-06-19T15:55:59.043 回答
23
ipyparams包可以很容易地做到这一点。
import ipyparams
currentNotebook = ipyparams.notebook_name
于 2020-03-19T12:10:36.520 回答
4
另一个 hacky 解决方案，因为我的笔记本服务器可以更改。基本上，您打印一个随机字符串，保存它，然后在工作目录中搜索包含该字符串的文件。while 是必需的，因为 save_checkpoint 是异步的。
from time import sleep
from IPython.display import display, Javascript
import subprocess
import os
import uuid
def get_notebook_path_and_save():
magic = str(uuid.uuid1()).replace('-', '')
print(magic)
# saves it (ctrl+S)
display(Javascript('IPython.notebook.save_checkpoint();'))
nb_name = None
while nb_name is None:
try:
sleep(0.1)
nb_name = subprocess.check_output(f'grep -l {magic} *.ipynb', shell=True).decode().strip()
except:
pass
return os.path.join(os.getcwd(), nb_name)
于 2020-07-28T13:03:15.090 回答
1
假设您拥有 Jupyter Notebook 服务器的主机、端口和身份验证令牌，这应该适合您。它基于这个答案。
import os
import json
import posixpath
import subprocess
import urllib.request
import psutil
def get_notebook_path(host, port, token):
process_id = os.getpid();
notebooks = get_running_notebooks(host, port, token)
for notebook in notebooks:
if process_id in notebook['process_ids']:
return notebook['path']
def get_running_notebooks(host, port, token):
sessions_url = posixpath.join('http://%s:%d' % (host, port), 'api', 'sessions')
sessions_url += f'?token={token}'
response = urllib.request.urlopen(sessions_url).read()
res = json.loads(response)
notebooks = [{'kernel_id': notebook['kernel']['id'],
'path': notebook['notebook']['path'],
'process_ids': get_process_ids(notebook['kernel']['id'])} for notebook in res]
return notebooks
def get_process_ids(name):
child = subprocess.Popen(['pgrep', '-f', name], stdout=subprocess.PIPE, shell=False)
response = child.communicate()[0]
return [int(pid) for pid in response.split()]
示例用法：
get_notebook_path('127.0.0.1', 17004, '344eb91bee5742a8501cc8ee84043d0af07d42e7135bed90')
于 2019-10-22T17:36:19.280 回答
1
要了解为什么使用这些基于 JS 的解决方案无法获取笔记本名称，请运行此代码并注意在 python 完成单元/整个笔记本执行后消息框出现的延迟：
%%javascript
function sayHello() {
alert('Hello world!');
}
setTimeout(sayHello, 1000);
- 更多信息
Javascript调用是异步的，因此不能保证在python开始运行另一个单元格之前完成，该单元格包含期望这个笔记本名称变量已经创建的代码......导致NameError尝试访问应该包含笔记本名称的不存在变量时。
我怀疑这个页面上的一些赞成票在选民发现所有%%javascript基于解决方案最终都不起作用之前就被锁定了……当生产者和消费者笔记本单元一起执行（或快速连续）时。
于 2021-03-17T11:53:32.027 回答
1
在 Jupyterlab 中还没有真正的方法可以做到这一点。但截至 2021 年 8 月，目前正在积极讨论/开发一种官方方式：
https://github.com/jupyter/jupyter_client/pull/656
与此同时，达到api/sessionsREST 端点jupyter_server似乎是最好的选择。这是该方法的清理版本：
from jupyter_server import serverapp
from jupyter_server.utils import url_path_join
from pathlib import Path
import re
import requests
kernelIdRegex = re.compile(r"(?<=kernel-)[\w\d\-]+(?=\.json)")
def getNotebookPath():
kernelId = kernelIdRegex.search(get_ipython().config["IPKernelApp"]["connection_file"])[0]
for jupServ in serverapp.list_running_servers():
for session in requests.get(url_path_join(jupServ["url"], "api/sessions"), params={"token": jupServ["token"]}).json():
if kernelId == session["kernel"]["id"]:
return Path(jupServ["root_dir"]) / session["notebook"]['path']
经测试与
python==3.9
jupyter_server==1.8.0
jupyterlab==4.0.0a7
于 2021-09-08T03:46:54.240 回答
1
修改@jfb 方法，给出以下在 ipykernel-5.3.4 上运行良好的函数。
def getNotebookName():
display(Javascript('IPython.notebook.kernel.execute("NotebookName = " + "\'"+window.document.getElementById("notebook_name").innerHTML+"\'");'))
try:
_ = type(NotebookName)
return NotebookName
except:
return None
请注意，显示的javascript需要一些时间才能到达浏览器，执行JS并返回内核也需要一些时间。我知道这听起来可能很愚蠢，但最好在两个单元格中运行该函数，如下所示：
nb_name = getNotebookName()
并在以下单元格中：
for i in range(10):
nb_name = getNotebookName()
if nb_name is not None:
break
但是，如果您不需要定义函数，明智的方法是在一个单元格中运行display(Javascript(..))，并在另一个单元格中检查笔记本名称。这样，浏览器就有足够的时间执行代码并返回笔记本名称。
如果您不介意使用库，最可靠的方法是：
import ipynbname
nb_name = ipynbname.name()
于 2021-11-24T20:10:26.190 回答
0
如果我们一次执行多个单元格，所有基于 Json 的解决方案都会失败，因为直到执行结束后结果才会准备好（这不是使用睡眠或等待任何时间的问题，请自行检查，但请记住重新启动内核并运行所有测试）
基于以前的解决方案，这避免了使用 %% 魔法，以防您需要将它放在其他一些代码的中间：
from IPython.display import display, Javascript
# can have comments here :)
js_cmd = 'IPython.notebook.kernel.execute(\'nb_name = "\' + IPython.notebook.notebook_name + \'"\')'
display(Javascript(js_cmd))
对于python 3，以下基于@Iguananaut 的回答并针对最新的python 进行了更新，并且可能多个服务器都可以工作：
import os
import json
try:
from urllib2 import urlopen
except:
from urllib.request import urlopen
import ipykernel
connection_file_path = ipykernel.get_connection_file()
connection_file = os.path.basename(connection_file_path)
kernel_id = connection_file.split('-', 1)[1].split('.')[0]
running_servers = !jupyter notebook list
running_servers = [s.split('::')[0].strip() for s in running_servers[1:]]
nb_name = '???'
for serv in running_servers:
uri_parts = serv.split('?')
uri_parts[0] += 'api/sessions'
sessions = json.load(urlopen('?'.join(uri_parts)))
for sess in sessions:
if sess['kernel']['id'] == kernel_id:
nb_name = os.path.basename(sess['notebook']['path'])
break
if nb_name != '???':
break
print (f'[{nb_name}]')
于 2020-09-24T05:25:10.563 回答