Wie erhalte ich den aktuellen IPython / Jupyter Notebook-Namen?

Question

Ich versuche, den aktuellen Notebook-Namen beim Ausführen des IPython-Notebooks zu erhalten. Ich weiß, dass ich ihn oben im Notebook sehen kann. Wonach ich suche, ist etwas wie

currentNotebook = IPython.foo.bar.notebookname()

Ich muss den Namen in einer Variable erhalten.

Answer 1

Auf Jupyter 3.0 funktioniert das Folgende. Hier zeige ich den gesamten Pfad auf dem Jupyter-Server, nicht nur den Notebook-Namen:

Um den NOTEBOOK_FULL_PATH im aktuellen Notebook-Front-End zu speichern:

%%javascript
var nb = IPython.notebook;
var kernel = IPython.notebook.kernel;
var command = "NOTEBOOK_FULL_PATH = '" + nb.base_url + nb.notebook_path + "'";
kernel.execute(command);

Um es dann anzuzeigen:

print("NOTEBOOK_FULL_PATH:\n", NOTEBOOK_FULL_PATH)

Das Ausführen der ersten Javascript-Zelle erzeugt keine Ausgabe. Das Ausführen der zweiten Python-Zelle erzeugt etwas Ähnliches wie:

NOTEBOOK_FULL_PATH:
 /user/zeph/GetNotebookName.ipynb

Answer 2

Noch eine hacky Lösung, da sich mein Notebook-Server ändern kann. Im Grunde drucken Sie eine zufällige Zeichenfolge aus, speichern sie und suchen dann nach einer Datei, die diese Zeichenfolge im Arbeitsverzeichnis enthält. Die while-Schleife wird benötigt, weil save_checkpoint asynchron ist.

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)
    # speichert es (Strg+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)

Answer 3

Verwende einfach ipynbname, das praktisch ist

#! pip install ipynbname

import ipynbname
nb_fname = ipynbname.name()
nb_path = ipynbname.path()
print(f"{nb_fname=}")
print(f"{nb_path=}")

Ich habe das in https://stackoverflow.com/a/65907473/15497427 gefunden

Answer 4

Es gibt noch keinen echten Weg, das in Jupyterlab zu tun. Aber es gibt einen offiziellen Weg, der jetzt unter aktiver Diskussion/Entwicklung steht, Stand August 2021:

https://github.com/jupyter/jupyter_client/pull/656

In der Zwischenzeit scheint es am besten zu sein, auf den api/sessions REST-Endpunkt von jupyter_server zuzugreifen. Hier ist eine bereinigte Version dieses Ansatzes:

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']

Getestet und funktioniert mit

python==3.9
jupyter_server==1.8.0
jupyterlab==4.0.0a7

Answer 5

Wenn Sie Visual Studio Code verwenden:

import IPython ; IPython.extract_module_locals()[1]['__vsc_ipynb_file__']