python - 艰巨的工作流程编写 Latex 书全是 Python 代码

Question

我正在写一本关于使用 Latex 在 Python 中编码的书。我计划在整个过程中穿插大量带有 python 代码的文本及其输出。真正给我带来麻烦的是，当我需要返回并编辑我的 python 代码时，将它很好地恢复到我的最新文档中是一件非常痛苦的事情。

我已经做了很多研究，但似乎找不到好的解决方案。

这个包含完整的文件，不能解决我的问题 https://tex.stackexchange.com/questions/289385/workflow-for-including-jupyter-aka-ipython-notebooks-as-pages-in-a-latex-docum

与此相同。 http://blog.juliusschulz.de/blog/ultimate-ipython-notebook

找到解决方案 1(糟糕)

我可以使用 listings latex 包将 python 代码复制并粘贴到 latex 中。

优点:

1. 只需更新一小部分代码即可轻松完成。

缺点:

1. 对于需要在python中运行的输出，分别复制、粘贴。
2. 初写速度慢，每章需要数百次这样的过程。

找到解决方案 2(不好)

使用带有 markdown 的 jupyter notebook，导出到 Latex，\include 文件到主 Latex 文档中。

优点:

1. 精简
2. 包含输出。

缺点:

• 要进行小的更改，需要重新导入整个文档，在 Latex 编辑器中对 markdown 文本所做的任何更改都不会保存
• 在 jupyter notebook 之后重命名 python 中的单个变量可能需要几个小时。
• 编辑似乎是一项繁重的工作。

理想的解决方案

• 用 Latex 写文本
• 在 jupyter notebook 中编写 python，导出到 latex。
• 以某种方式将代码片段(导出文件的小部分)包含到主要 Latex 书籍的不同部分中。 这是我想不通的部分
• 当需要更改 python 时，更改 jupyter，然后重新导出为同名的 latex 文件
• Latex 书会自动从包含更新。

这里的关键是导出的 python 笔记本被拆分并发送到文档的不同部分。为了让它工作，它需要以某种方式在笔记本的 Markdown 或代码中进行标记或标记，所以当我重新导出它时，那些相同的部分会被发送到书中的相同位置。

优点:

1. Python 编辑起来很容易，很容易传播回书中。
2. 用latex写的文字，可以利用latex的力量

如果您能提供更接近我理想解决方案的解决方案，我们将不胜感激。我快要死了。

可能没关系，但我在 VS Code 中同时编写 latex 和 jupyter notebooks。如果这意味着解决这些问题，我愿意改变工具。

Answer 1

这是我写的一个小脚本。它拆分单个 *.ipynb 文件并将其转换为多个 *.tex 文件。

用法是:

1. 复制以下脚本并另存为main.py
2. 执行 python main.py init。它将创建 main.tex 和 style_ipython_custom.tplx
3. 在你的 jupyther notebook 中，添加额外的行 #latex:tag_a, #latex:tag_b, .. 到你想要提取的每个单元格。相同的标签将被提取到相同的 *.tex 文件。
4. 将其保存为*.ipynb 文件。幸运的是，当前的 VSCode python 插件支持导出到 *.ipynb，或者使用 jupytext 将 *.py 转换为 *.ipynb。<
5. 运行 python main.py path/to/your.ipynb 它将创建 tag_a.tex 和 tag_b.tex
6. 编辑 main.tex 并在任何你想要的地方添加 \input{tag_a.tex} 或 \input{tag_b.tex}。
7. 运行 pdflatex main.tex 它将生成 main.pdf

这个脚本背后的想法:

使用默认的 nbconvert.LatexExporter 从 jupyter notebook 转换为 LaTex 会生成包含宏定义的完整 LaTex 文件。使用它来转换每个单元格可能会创建大型 LaTex 文件。为了避免这个问题，脚本首先创建只有宏定义的 main.tex，然后将每个单元格转换为没有宏定义的 LaTex 文件。这可以使用从 style_ipython.tplx

稍微修改的自定义模板文件来完成

标记或标记单元格可能是使用单元格元数据完成的，但我找不到如何在 VSCode python 插件(Issue)中设置它，因此它使用正则表达式模式扫描每个单元格的源代码^# latex:(.*)，并在将其转换为 LaTex 文件之前将其删除。

来源:

import sys
import re
import os
from collections import defaultdict
import nbformat
from nbconvert import LatexExporter, exporters

OUTPUT_FILES_DIR = './images'
CUSTOM_TEMPLATE = 'style_ipython_custom.tplx'
MAIN_TEX = 'main.tex'


def create_main():
    # creates `main.tex` which only has macro definition
    latex_exporter = LatexExporter()
    book = nbformat.v4.new_notebook()
    book.cells.append(
        nbformat.v4.new_raw_cell(r'\input{__your_input__here.tex}'))
    (body, _) = latex_exporter.from_notebook_node(book)
    with open(MAIN_TEX, 'x') as fout:
        fout.write(body)
    print("created:", MAIN_TEX)


def init():
    create_main()
    latex_exporter = LatexExporter()
    # copy `style_ipython.tplx` in `nbconvert.exporters` module to current directory,
    # and modify it so that it does not contain macro definition
    tmpl_path = os.path.join(
        os.path.dirname(exporters.__file__),
        latex_exporter.default_template_path)
    src = os.path.join(tmpl_path, 'style_ipython.tplx')
    target = CUSTOM_TEMPLATE
    with open(src) as fsrc:
        with open(target, 'w') as ftarget:
            for line in fsrc:
                # replace the line so than it does not contain macro definition
                if line == "((*- extends 'base.tplx' -*))\n":
                    line = "((*- extends 'document_contents.tplx' -*))\n"
                ftarget.write(line)
    print("created:", CUSTOM_TEMPLATE)


def group_cells(note):
    # scan the cell source for tag with regexp `^#latex:(.*)`
    # if sames tags are found group it to same list
    pattern = re.compile(r'^#latex:(.*?)$(\n?)', re.M)
    group = defaultdict(list)
    for num, cell in enumerate(note.cells):
        m = pattern.search(cell.source)
        if m:
            tag = m.group(1).strip()
            # remove the line which contains tag
            cell.source = cell.source[:m.start(0)] + cell.source[m.end(0):]
            group[tag].append(cell)
        else:
            print("tag not found in cell number {}. ignore".format(num + 1))
    return group


def doit():
    with open(sys.argv[1]) as f:
        note = nbformat.read(f, as_version=4)
    group = group_cells(note)
    latex_exporter = LatexExporter()
    # use the template which does not contain LaTex macro definition
    latex_exporter.template_file = CUSTOM_TEMPLATE
    try:
        os.mkdir(OUTPUT_FILES_DIR)
    except FileExistsError:
        pass
    for (tag, g) in group.items():
        book = nbformat.v4.new_notebook()
        book.cells.extend(g)
        # unique_key will be prefix of image
        (body, resources) = latex_exporter.from_notebook_node(
            book,
            resources={
                'output_files_dir': OUTPUT_FILES_DIR,
                'unique_key': tag
            })
        ofile = tag + '.tex'
        with open(ofile, 'w') as fout:
            fout.write(body)
            print("created:", ofile)
        # the image data which is embedded as base64 in notebook
        # will be decoded and returned in `resources`, so write it to file
        for filename, data in resources.get('outputs', {}).items():
            with open(filename, 'wb') as fres:
                fres.write(data)
                print("created:", filename)


if len(sys.argv) <= 1:
    print("USAGE: this_script [init|yourfile.ipynb]")
elif sys.argv[1] == "init":
    init()
else:
    doit()