转换为（不是）ipython Notebook格式

Question

IPython Notebook附带nbconvert，可以将笔记本导出为其他格式。但是如何以相反的方向转换文本？我问，因为我已经拥有不同格式的材料和良好的工作流程，但我想利用Notebook的交互式环境。

一个可能的解决方案：可以通过导入.py文件来创建笔记本，并且文档指出当nbconvert将笔记本导出为python脚本时，它会在可用于重新创建笔记本的注释中嵌入指令。但a disclaimer提供的信息是关于这种方法的局限性，并且在我能找到的任何地方都没有记录可接受的格式。 （奇怪的是，在描述笔记本的JSON format的部分中显示了一个示例）。任何人都可以提供更多信息，或更好的选择吗？

编辑（2016年3月1日）：已接受的答案不再有效，因为出于某种原因，Notebook API的第4版不支持此输入格式。我添加了a self-answer，展示了如何使用当前（v4）API导入笔记本。 （我不是不接受当前的答案，因为它解决了我当时的问题并指出了我在自我回答中使用的资源。）

Answer 1

以下适用于IPython 3，但不适用于IPython 4。

IPython API具有读写笔记本文件的功能。您应该使用此API而不是直接创建JSON。例如，以下代码段将脚本test.py转换为笔记本test.ipynb。

import IPython.nbformat.current as nbf
nb = nbf.read(open('test.py', 'r'), 'py')
nbf.write(nb, open('test.ipynb', 'w'), 'ipynb')

关于nbf.read理解的.py文件格式，最好只查看解析器类IPython.nbformat.v3.nbpy.PyReader。代码可以在这里找到（它不是很大）：

https://github.com/ipython/ipython/blob/master/jupyter_nbformat/v3/nbpy.py

编辑：这个答案最初是为IPyhton 3编写的。我不知道如何使用IPython 4正确地做到这一点。这是上面链接的更新版本，指向IPython 3.2.1版本中的nbpy.py版本：

https://github.com/ipython/ipython/blob/rel-3.2.1/IPython/nbformat/v3/nbpy.py

基本上，您使用# <codecell>或# <markdowncell>等特殊注释来分隔单个单元格。查看line.startswith中的PyReader.to_notebook语句以获取完整列表。

Answer 2

由于接受的答案中的代码不再起作用，我添加了这个自我答案，显示如何使用当前（v4）API导入到笔记本中。

输入格式

IPython Notebook API的第2版和第3版可以导入带有特殊结构注释的python脚本，并根据需要将其分解为单元格。这是一个示例输入文件（原始文档here）。前两行被忽略，并且是可选的。 （事实上​​，读者会忽略文件中任何位置的coding:和<nbformat>行。）

# -*- coding: utf-8 -*-
# <nbformat>3.0</nbformat>

# <markdowncell>

# The simplest notebook. Markdown cells are embedded in comments, 
# so the file is a valid `python` script. 
# Be sure to **leave a space** after the comment character!

# <codecell>

print("Hello, IPython")

# <rawcell>

# Raw cell contents are not formatted as markdown

（API还接受过时的指令<htmlcell>和<headingcell level=...>，它们会立即转换为其他类型。）

How to import it

出于某种原因，Notebook API的第4版不支持此格式。它仍然是一个很好的格式，因此通过导入版本3和升级来支持它是值得的。原则上它只是两行代码，加上i / o：

from IPython.nbformat import v3, v4

with open("input-file.py") as fpin:
    text = fpin.read()

nbook = v3.reads_py(text)
nbook = v4.upgrade(nbook)  # Upgrade v3 to v4

jsonform = v4.writes(nbook) + "\n"
with open("output-file.ipynb", "w") as fpout:
    fpout.write(jsonform)

但不是那么快！事实上，笔记本API有一个令人讨厌的错误：如果输入中的最后一个单元格是降价单元格，v3.reads_py()将失去它。最简单的解决方法是在最后处理一个虚假的<markdown>单元：该bug将删除它，每个人都很高兴。在将text传递给v3.reads_py()之前，请执行以下操作：

text += """
# <markdowncell>

# If you can read this, reads_py() is no longer broken! 
"""

Answer 3

很老的问题，我知道。但是有jupytext（也可以在pypi上找到）可以从ipynb转换成几种格式并返回。

当安装jupytext时你可以使用

$ jupytext --to notebook test.py

为了生成test.ipynb。

jupytext有许多有趣的功能，在使用笔记本电脑时可以派上用场。

---

这是关于那个主题的a more recent question。

Answer 4

Python代码示例如何构建IPython笔记本V4：

# -*- coding: utf-8 -*-
import os
from base64 import encodestring

from IPython.nbformat.v4.nbbase import (
    new_code_cell, new_markdown_cell, new_notebook,
    new_output, new_raw_cell
)

# some random base64-encoded *text*
png = encodestring(os.urandom(5)).decode('ascii')
jpeg = encodestring(os.urandom(6)).decode('ascii')

cells = []
cells.append(new_markdown_cell(
    source='Some NumPy Examples',
))


cells.append(new_code_cell(
    source='import numpy',
    execution_count=1,
))

cells.append(new_markdown_cell(
    source='A random array',
))

cells.append(new_raw_cell(
    source='A random array',
))

cells.append(new_markdown_cell(
    source=u'## My Heading',
))

cells.append(new_code_cell(
    source='a = numpy.random.rand(100)',
    execution_count=2,
))
cells.append(new_code_cell(
    source='a = 10\nb = 5\n',
    execution_count=3,
))
cells.append(new_code_cell(
    source='a = 10\nb = 5',
    execution_count=4,
))

cells.append(new_code_cell(
    source=u'print "ünîcødé"',
    execution_count=3,
    outputs=[new_output(
        output_type=u'execute_result',
        data={
            'text/plain': u'<array a>',
            'text/html': u'The HTML rep',
            'text/latex': u'$a$',
            'image/png': png,
            'image/jpeg': jpeg,
            'image/svg+xml': u'<svg>',
            'application/json': {
                'key': 'value'
            },
            'application/javascript': u'var i=0;'
        },
        execution_count=3
    ),new_output(
        output_type=u'display_data',
        data={
            'text/plain': u'<array a>',
            'text/html': u'The HTML rep',
            'text/latex': u'$a$',
            'image/png': png,
            'image/jpeg': jpeg,
            'image/svg+xml': u'<svg>',
            'application/json': {
                'key': 'value'
            },
            'application/javascript': u'var i=0;'
        },
    ),new_output(
        output_type=u'error',
        ename=u'NameError',
        evalue=u'NameError was here',
        traceback=[u'frame 0', u'frame 1', u'frame 2']
    ),new_output(
        output_type=u'stream',
        text='foo\rbar\r\n'
    ),new_output(
        output_type=u'stream',
        name='stderr',
        text='\rfoo\rbar\n'
    )]
))

nb0 = new_notebook(cells=cells,
    metadata={
        'language': 'python',
    }
)

import IPython.nbformat as nbf
import codecs
f = codecs.open('test.ipynb', encoding='utf-8', mode='w')
nbf.write(nb0, f, 4)
f.close()

Answer 5

考虑到Volodimir Kopey的例子，我整理了一个简单的脚本，将.ipynb导出的.py转换回V4 .ipynb。

当我编辑（在适当的IDE中）我从笔记本导出的.py时，我一起攻击了这个脚本，我想回到Notebook，逐个单元地运行它。

该脚本仅处理代码单元格。无论如何，导出的.py不包含太多其他内容。

import nbformat
from nbformat.v4 import new_code_cell,new_notebook

import codecs

sourceFile = "changeMe.py"     # <<<< change
destFile = "changeMe.ipynb"    # <<<< change


def parsePy(fn):
    """ Generator that parses a .py file exported from a IPython notebook and
extracts code cells (whatever is between occurrences of "In[*]:").
Returns a string containing one or more lines
"""
    with open(fn,"r") as f:
        lines = []
        for l in f:
            l1 = l.strip()
            if l1.startswith('# In[') and l1.endswith(']:') and lines:
                yield "".join(lines)
                lines = []
                continue
            lines.append(l)
        if lines:
            yield "".join(lines)

# Create the code cells by parsing the file in input
cells = []
for c in parsePy(sourceFile):
    cells.append(new_code_cell(source=c))

# This creates a V4 Notebook with the code cells extracted above
nb0 = new_notebook(cells=cells,
                   metadata={'language': 'python',})

with codecs.open(destFile, encoding='utf-8', mode='w') as f:
    nbformat.write(nb0, f, 4)

没有保证，但它对我有用

Answer 6

采取和修改P.Toccateli和亚历克西斯的代码是自由的，这样它也可以与pycharm和spyder一起使用，就像细胞标记一样，并在github上发布它。

Answer 7

我为vscode写了一个可能有帮助的扩展。它将python文件转换为ipython笔记本。它处于早期阶段，因此如果发生任何错误，请随时提交问题。

Jupyter Notebook Converter

Answer 8

希望我不会太晚。

我刚刚在PyPI上发布了一个名为p2j的Python包。这个包从Python源代码.ipynb创建了一个Jupyter笔记本.py。

pip install p2j
p2j script.py

从.py文件生成的Jupyter笔记本示例：

皮普：赌场

GitHub：https://pypi.org/project/p2j/

Answer 9

您可以使用https://github.com/raibosome/python2jupyter中的脚本py2nb

您将不得不为* .py使用某种语法，但使用起来相当简单（查看'samples'文件夹中的示例）