呼叫jupyter notebook檔案內的函式一種簡單方法

python開發環境jupyter notebook良好的互動式和模組化受到很多python開發人員的青睞,但是jupyter notebook是以json格式儲存檔案內容的,而不是python檔案那樣的普通格式,所以不能直接被python解析器解析,如何呼叫.ipynb中的module也成為一個問題。本文介紹一種方法,使得只要在我們的工作目錄下放置一個python檔案,就可以正常呼叫其他jupyter notebook檔案。

Jupyter Notebook官網介紹了一種簡單的方法:http://jupyter-notebook.readthedocs.io/en/latest/examples/Notebook/Importing%20Notebooks.html

新增jupyter notebook解析檔案

    首先,建立一個python檔案,例如Ipynb_importer.py,程式碼如下:

import io, os,sys,types
from IPython import get_ipython
from nbformat import read
from IPython.core.interactiveshell import InteractiveShell
class NotebookFinder(object):
"""Module finder that locates Jupyter Notebooks"""
def __init__(self):
self.loaders = {}
def find_module(self, fullname, path=None):
nb_path = find_notebook(fullname, path)
if not nb_path:
return
key = path
if path:
# lists aren't hashable
key = os.path.sep.join(path)
if key not in self.loaders:
self.loaders[key] = NotebookLoader(path)
return self.loaders[key]
def find_notebook(fullname, path=None):
"""find a notebook, given its fully qualified name and an optional path
This turns "foo.bar" into "foo/bar.ipynb"
and tries turning "Foo_Bar" into "Foo Bar" if Foo_Bar
does not exist.
"""
name = fullname.rsplit('.', 1)[-1]
if not path:
path = ['']
for d in path:
nb_path = os.path.join(d, name   ".ipynb")
if os.path.isfile(nb_path):
return nb_path
# let import Notebook_Name find "Notebook Name.ipynb"
nb_path = nb_path.replace("_", " ")
if os.path.isfile(nb_path):
return nb_path
class NotebookLoader(object):
"""Module Loader for Jupyter Notebooks"""
def __init__(self, path=None):
self.shell = InteractiveShell.instance()
self.path = path
def load_module(self, fullname):
"""import a notebook as a module"""
path = find_notebook(fullname, self.path)
print ("importing Jupyter notebook from %s" % path)
# load the notebook object
with io.open(path, 'r', encoding='utf-8') as f:
nb = read(f, 4)
# create the module and add it to sys.modules
# if name in sys.modules:
#    return sys.modules[name]
mod = types.ModuleType(fullname)
mod.__file__ = path
mod.__loader__ = self
mod.__dict__['get_ipython'] = get_ipython
sys.modules[fullname] = mod
# extra work to ensure that magics that would affect the user_ns
# actually affect the notebook module's ns
save_user_ns = self.shell.user_ns
self.shell.user_ns = mod.__dict__
try:
for cell in nb.cells:
if cell.cell_type == 'code':
# transform the input to executable Python
code = self.shell.input_transformer_manager.transform_cell(cell.source)
# run the code in themodule
exec(code, mod.__dict__)
finally:
self.shell.user_ns = save_user_ns
return mod
sys.meta_path.append(NotebookFinder())

呼叫jupyter notebook module

    在我們的jupyter notebook檔案裡呼叫Ipynb_importer.py,接下來我們就可以像呼叫普通python檔案一樣呼叫其他.ipynb檔案裡的module了,例如有一個IpynbModule.ipynb檔案,裡面定義了一個foo函式:

被呼叫函式

呼叫例子如下:

呼叫ipynb函式

    只要在我們的工作目錄下放置Ipynb_importer.py檔案,就可以正常呼叫所有的jupyter notebook檔案。 這種方法的本質就是使用一個jupyter notenook解析器先對.ipynb檔案進行解析,把檔案內的各個模組載入到記憶體裡供其他python檔案呼叫。

參考資料:

http://jupyter-notebook.readthedocs.io/en/latest/examples/Notebook/Importing%20Notebooks.html