快捷導(dǎo)航

使用Python創(chuàng)建和導(dǎo)出Jupyter Notebook的完整教程

更新時間：2026年01月12日 09:42:47 作者：weixin_46244623

在數(shù)據(jù)科學(xué)和機(jī)器學(xué)習(xí)的工作中,Jupyter Notebook 已成為不可或缺的工具,不過,許多時候我們希望自動化生成 Notebook 文件,并將其導(dǎo)出為 HTML 或其他格式,這篇文章將帶你通過 Python 來實(shí)現(xiàn)這一目標(biāo),需要的朋友可以參考下

引言

在數(shù)據(jù)科學(xué)和機(jī)器學(xué)習(xí)的工作中，Jupyter Notebook 已成為不可或缺的工具。它提供了一個交互式的環(huán)境，允許我們在文檔中同時編寫代碼、展示圖表以及添加文本說明。不過，許多時候我們希望自動化生成 Notebook 文件，并將其導(dǎo)出為 HTML 或其他格式，這篇文章將帶你通過 Python 來實(shí)現(xiàn)這一目標(biāo)。效果如下圖所示

1. 背景

有時候，我們可能需要根據(jù)特定的需求自動生成包含代碼單元格、Markdown 單元格和輸出的 Jupyter Notebook 文件，并將其導(dǎo)出為 .html 或 .ipynb 格式。為了完成這一任務(wù)，我們將使用 nbformat 和 nbconvert 這兩個 Python 庫。

本文將為大家展示如何使用這兩個庫實(shí)現(xiàn)以下功能：

創(chuàng)建新的 Jupyter Notebook。
添加代碼和 Markdown 單元格。
為代碼單元格添加執(zhí)行計數(shù)。
將 Notebook 導(dǎo)出為 HTML 文件。
保存為 .ipynb 文件。

2. 安裝必要的依賴

在開始之前，你需要安裝以下兩個庫：nbformat 和 nbconvert。你可以使用 pip 命令進(jìn)行安裝：

pip install nbformat nbconvert

3. 創(chuàng)建并修改 Notebook

接下來，我們將編寫 Python 代碼來生成一個 Jupyter Notebook，并為其添加代碼單元格、Markdown 單元格以及帶有執(zhí)行結(jié)果的代碼單元格。

import nbformat
from nbconvert import HTMLExporter

# 創(chuàng)建一個新的Jupyter Notebook
notebook = nbformat.v4.new_notebook()

# 添加代碼單元格
code1 = "result1 = 2 + 2"
notebook.cells.append(nbformat.v4.new_code_cell(code1))

code2 = "result2 = 'Hello, Jupyter!'"
notebook.cells.append(nbformat.v4.new_code_cell(code2))

# 添加Markdown單元格
markdown_text = "This is a markdown cell."
notebook.cells.append(nbformat.v4.new_markdown_cell(markdown_text))

# 添加帶有輸出的代碼單元格
code3 = "result3 = result1 * 2\nresult3"
notebook.cells.append(nbformat.v4.new_code_cell(code3))
notebook.cells[-1].outputs.append(nbformat.v4.new_output(
    output_type='execute_result',
    data={'text/plain': '4'},
))

# 為每個代碼單元格添加執(zhí)行計數(shù)
for i, cell in enumerate(notebook.cells):
    if cell.cell_type == 'code':
        cell['execution_count'] = i + 1

代碼解釋：

創(chuàng)建一個新的 Notebook：使用 nbformat.v4.new_notebook() 創(chuàng)建一個空的 Notebook 對象。
添加代碼單元格：我們通過 nbformat.v4.new_code_cell() 向 Notebook 中添加代碼單元格。例如，第一個代碼單元格執(zhí)行了簡單的加法運(yùn)算 result1 = 2 + 2。
添加 Markdown 單元格：使用 nbformat.v4.new_markdown_cell() 向 Notebook 中添加 Markdown 單元格。Markdown 允許你在文檔中插入文本、圖片、數(shù)學(xué)公式等。
添加帶有輸出的代碼單元格：最后，我們添加一個帶有輸出的代碼單元格，這個單元格計算 result1 * 2，并返回結(jié)果 4。

4. 導(dǎo)出為 HTML 文件

接下來，我們將使用 HTMLExporter 將 Notebook 轉(zhuǎn)換為 HTML 格式，并確保插入類似 In [1]: 的執(zhí)行計數(shù)。

# 將Notebook導(dǎo)出為HTML
html_exporter = HTMLExporter()
(body, _) = html_exporter.from_notebook_node(notebook)

# 插入帶有執(zhí)行計數(shù)的In [1]:等
lines = []
for line in body.split('\n'):
    if line.startswith('In '):
        lines.append(f'In [{line[4:]}')
    else:
        lines.append(line)

# 將HTML輸出保存為文件
output_file_path_html = "output_notebook.html"
with open(output_file_path_html, "w", encoding="utf-8") as f:
    f.write('\n'.join(lines))

print(f"Jupyter Notebook HTML saved to {output_file_path_html}")

代碼解釋：

HTMLExporter：我們通過 HTMLExporter 將 Notebook 對象轉(zhuǎn)換為 HTML 格式。from_notebook_node() 方法會返回 HTML 內(nèi)容。
插入執(zhí)行計數(shù)：接著，我們遍歷生成的 HTML 內(nèi)容，將每個包含 In 的行轉(zhuǎn)化為 In [1]: 這樣的格式，以保證代碼單元格的執(zhí)行計數(shù)能夠正確顯示。
保存為 HTML 文件：最后，我們將處理過的 HTML 內(nèi)容保存到 output_notebook.html 文件中。

5. 將 Notebook 保存為.ipynb文件

除了導(dǎo)出為 HTML 格式，我們還需要將 Notebook 保存為 .ipynb 格式，這樣可以方便地在 Jupyter Notebook 中打開。

# 將Notebook保存為.ipynb文件
output_file_path_ipynb = "output_notebook.ipynb"
nbformat.write(notebook, output_file_path_ipynb)

print(f"Jupyter Notebook .ipynb saved to {output_file_path_ipynb}")

代碼解釋：

nbformat.write()：這行代碼將 Notebook 對象保存為 .ipynb 格式的文件。

6. 完整代碼

將上述所有代碼整合在一起，形成完整的 Python 腳本：

import nbformat
from nbconvert import HTMLExporter

# 創(chuàng)建一個新的Jupyter Notebook
notebook = nbformat.v4.new_notebook()

# 添加代碼單元格
code1 = "result1 = 2 + 2"
notebook.cells.append(nbformat.v4.new_code_cell(code1))

code2 = "result2 = 'Hello, Jupyter!'"
notebook.cells.append(nbformat.v4.new_code_cell(code2))

# 添加Markdown單元格
markdown_text = "This is a markdown cell."
notebook.cells.append(nbformat.v4.new_markdown_cell(markdown_text))

# 添加帶有輸出的代碼單元格
code3 = "result3 = result1 * 2\nresult3"
notebook.cells.append(nbformat.v4.new_code_cell(code3))
notebook.cells[-1].outputs.append(nbformat.v4.new_output(
    output_type='execute_result',
    data={'text/plain': '4'},
))

# 為每個代碼單元格添加執(zhí)行計數(shù)
for i, cell in enumerate(notebook.cells):
    if cell.cell_type == 'code':
        cell['execution_count'] = i + 1

# 將Notebook導(dǎo)出為HTML
html_exporter = HTMLExporter()
(body, _) = html_exporter.from_notebook_node(notebook)

# 插入帶有執(zhí)行計數(shù)的In [1]:等
lines = []
for line in body.split('\n'):
    if line.startswith('In '):
        lines.append(f'In [{line[4:]}')
    else:
        lines.append(line)

# 將HTML輸出保存為文件
output_file_path_html = "output_notebook.html"
with open(output_file_path_html, "w", encoding="utf-8") as f:
    f.write('\n'.join(lines))

print(f"Jupyter Notebook HTML saved to {output_file_path_html}")

# 將Notebook保存為.ipynb文件
output_file_path_ipynb = "output_notebook.ipynb"
nbformat.write(notebook, output_file_path_ipynb)

print(f"Jupyter Notebook .ipynb saved to {output_file_path_ipynb}")

7. 總結(jié)

通過本文的介紹，我們已經(jīng)學(xué)會了如何使用 Python 創(chuàng)建和導(dǎo)出 Jupyter Notebook 文件。無論是將其保存為 .ipynb 格式以供后續(xù)使用，還是將其導(dǎo)出為 .html 格式進(jìn)行展示，我們都可以通過簡單的 Python 腳本來實(shí)現(xiàn)這一切。

以上就是使用Python創(chuàng)建和導(dǎo)出Jupyter Notebook的完整教程的詳細(xì)內(nèi)容，更多關(guān)于Python創(chuàng)建和導(dǎo)出Jupyter Notebook的資料請關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: