时间戳

首页 > 解决方案 > 写满 Python 代码的 Latex 书的艰难工作流程

python - 写满 Python 代码的 Latex 书的艰难工作流程

问题描述

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

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

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

和这个一样。 http://blog.juliusschulz.de/blog/ultimate-ipython-notebook

找到解决方案 1（糟糕）

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

优点：

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

缺点：

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

找到解决方案 2（错误）

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

优点：

  1. 流线型
  2. 包含输出。

缺点：

理想的解决方案

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

优点：

  1. Python 编辑很容易，很容易传播回书本。
  2. 用乳胶写的文字，可以使用乳胶的力量

任何帮助提出更接近我理想解决方案的解决方案将不胜感激。这太痛苦了。

可能没关系，但我在 VS Code 中同时编写了乳胶和 jupyter 笔记本。如果这意味着解决这些问题，我愿意更换工具。

标签： pythonlatexipythonworkflowjupyter

解决方案

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

用法是：

  1. 复制以下脚本并另存为main.py
  2. 执行python main.py init. 它将创建main.tex并style_ipython_custom.tplx
  3. 在您的 jupyther 笔记本中，将额外的行#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

这个脚本背后的想法：

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

标记或标记单元格可能使用单元格元数据完成，但我找不到如何在 VSCode python 插件（问题）中设置它，因此它使用正则表达式模式扫描每个单元格的源^#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()

推荐阅读