(2017-02)

策略

on_commit (): 去掉输出>的名称。Ipynb (nbstripout) 去掉输出> name.clean.ipynb (nbstripout，) 总是nbconvert to python: name.ipynb.py (nbconvert) 始终转换为markdown: name.ipynb.md (nbconvert, ipymd) vcs.configure (): Git difftool, mergetool: nbdiff和nbmerge from nbdime

工具

nbstripout: strip the outputs from a notebook src: https://gist.github.com/minrk/6176788 src: https://github.com/kynan/nbstripout pip install nbstripout; nbstripout install ipynb_output_filter: strip the outputs from a notebook src: https://github.com/toobaz/ipynb_output_filter/blob/master/ipynb_output_filter.py ipymd: convert between {Jupyter, Markdown, O'Reilly Atlas Markdown, OpenDocument, .py} src: https://github.com/rossant/ipymd nbdime: "Tools for diffing and merging of Jupyter notebooks." (2015) src: https://github.com/jupyter/nbdime docs: http://nbdime.readthedocs.io/ nbdiff: compare notebooks in a terminal-friendly way nbdime nbdiff works as a git diff tool: https://nbdime.readthedocs.io/en/latest/#git-integration-quickstart nbmerge: three-way merge of notebooks with automatic conflict resolution nbdime nbmerge works as a git merge tool nbdiff-web: shows you a rich rendered diff of notebooks nbmerge-web: gives you a web-based three-way merge tool for notebooks nbshow: present a single notebook in a terminal-friendly way

这是我的解决方案与git。它允许你像往常一样添加和提交(和diff):这些操作不会改变你的工作树，同时(重新)运行一个笔记本不会改变你的git历史。

虽然这可能适用于其他VSC，但我知道它不能满足您的要求(至少VSC不可知)。不过，它对我来说是完美的，尽管它没有什么特别出色的地方，而且很多人可能已经在使用它了，但我没有通过谷歌找到关于如何实现它的明确说明。所以它可能对其他人有用。

将包含此内容的文件保存在某个位置(对于下面的内容，让我们假设~/bin/ipynb_output_filter.py) (chmod +x ~/bin/ipynb_output_filter.py) 创建文件~/。Gitattributes，包含以下内容 *。ipynb过滤器= dropoutput_ipynb 执行如下命令: Git配置——全局核心。attributesfile ~ / .gitattributes Git配置——global filter.dropoutput_ipynb。干净的~ / bin / ipynb_output_filter.py Git配置——global filter.dropoutput_ipynb。涂抹的猫

完成了!

限制:

it works only with git in git, if you are in branch somebranch and you do git checkout otherbranch; git checkout somebranch, you usually expect the working tree to be unchanged. Here instead you will have lost the output and cells numbering of notebooks whose source differs between the two branches. more in general, the output is not versioned at all, as with Gregory's solution. In order to not just throw it away every time you do anything involving a checkout, the approach could be changed by storing it in separate files (but notice that at the time the above code is run, the commit id is not known!), and possibly versioning them (but notice this would require something more than a git commit notebook_file.ipynb, although it would at least keep git diff notebook_file.ipynb free from base64 garbage). that said, incidentally if you do pull code (i.e. committed by someone else not using this approach) which contains some output, the output is checked out normally. Only the locally produced output is lost.

我的解决方案反映了这样一个事实:我个人不喜欢对生成的东西进行版本控制——注意，涉及输出的合并几乎肯定会使输出或您的生产力无效，或者两者都无效。

编辑:

如果你确实采用了我建议的解决方案——也就是全局的解决方案——你会遇到一些麻烦，比如你想要版本输出的git repo。因此，如果你想禁用特定git存储库的输出过滤，只需在其中创建一个文件.git/info/attributes，使用 **ipynb过滤器=

作为内容。显然，以同样的方式也可以做相反的事情:仅为特定的存储库启用筛选。

代码现在在它自己的git repo中维护 如果上面的指令导致ImportErrors，尝试在脚本路径之前添加"ipython": Git配置——global filter.dropoutput_ipynb。清除ipython ~/bin/ipynb_output_filter.py

编辑:2016年5月(更新于2017年2月):我的脚本有几个替代方案-为了完整性，这里是我知道的列表:nbstripout(其他变体)，nbstrip, jq。

下面是Cyrille rosant为IPython 3.0提供的一个新解决方案，它坚持标记文件，而不是基于json的ipymd文件:

https://github.com/rossant/ipymd

不幸的是，我对Mercurial了解不多，但我可以为您提供一个与Git一起工作的可能解决方案，希望您能够将我的Git命令转换为对应的Mercurial命令。

对于后台，在Git中，add命令将对文件所做的更改存储到暂存区域。完成此操作后，Git将忽略对文件的任何后续更改，除非您告诉它也执行这些更改。因此，下面的脚本，对于每个给定的文件，剥离所有的输出和prompt_number部分，运行剥离的文件，然后恢复原始文件:

注意:如果运行此命令会得到类似ImportError的错误消息:没有名为IPython的模块。Nbformat，然后使用ipython而不是python来运行脚本。

from IPython.nbformat import current
import io
from os import remove, rename
from shutil import copyfile
from subprocess import Popen
from sys import argv

for filename in argv[1:]:
    # Backup the current file
    backup_filename = filename + ".backup"
    copyfile(filename,backup_filename)

    try:
        # Read in the notebook
        with io.open(filename,'r',encoding='utf-8') as f:
            notebook = current.reads(f.read(),format="ipynb")

        # Strip out all of the output and prompt_number sections
        for worksheet in notebook["worksheets"]:
            for cell in worksheet["cells"]:
               cell.outputs = []
               if "prompt_number" in cell:
                    del cell["prompt_number"]

        # Write the stripped file
        with io.open(filename, 'w', encoding='utf-8') as f:
            current.write(notebook,f,format='ipynb')

        # Run git add to stage the non-output changes
        print("git add",filename)
        Popen(["git","add",filename]).wait()

    finally:
        # Restore the original file;  remove is needed in case
        # we are running in windows.
        remove(filename)
        rename(backup_filename,filename)

一旦脚本在您想要提交的文件上运行，只需运行git commit。

我做了Albert & Rich所做的——不要给.ipynb文件做版本(因为这些文件可能包含图像，这会变得混乱)。相反，要么总是运行ipython notebook——script，要么放c.FileNotebookManager。在你的配置文件中save_script = True，这样当你保存你的笔记本时，总是会创建一个(可版本的).py文件。

为了重新生成笔记本(在签出一个repo或切换一个分支之后)，我将脚本py_file_to_notebook .py放在我存储笔记本的目录中。

现在，签出一个repo之后，只需运行python py_file_to_notebook .py来生成ipynb文件。切换分支后，您可能需要运行python py_file_to_notebook .py -ov来覆盖现有的ipynb文件。

为了安全起见，也可以加上 *。Ipynb到你的。gitignore文件。

编辑:我不再这样做了，因为(A)每次签出分支时，你都必须从py文件中重新生成你的笔记本，(B)在笔记本中有其他东西，如markdown，你会丢失。相反，我使用git过滤器从笔记本中剥离输出。关于如何做到这一点的讨论在这里。

刚刚遇到的“jupytext”看起来像一个完美的解决方案。它从笔记本生成一个.py文件，然后保持两者同步。您可以通过.py文件进行版本控制、差异和合并输入，而不会丢失输出。当你打开笔记本时，它使用.py作为输入单元格，使用.ipynb作为输出单元格。如果你想在git中包含输出，那么你可以添加ipynb。

https://github.com/mwouts/jupytext