编写充满 Python 代码的 Latex 书的困难工作流程

Question

我正在写一本关于使用 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（糟糕）

我可以使用列表乳胶包将 python 代码复制并粘贴到乳胶中。

优点：

1. 易于更新仅一小部分代码。

缺点：

1. 对于需要在python中运行的输出，分别复制、粘贴。

2. 初写SLOW，每章需要做几百遍这个过程。

找到解决方案 2（坏）

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

优点：

1. 流线型

2. 包含输出。

缺点：

• 要进行小的更改，需要重新导入整个文档，Latex 编辑器中对 Markdown 文本所做的任何更改都不会保存

• 在 jupyter notebook 之后重命名 python 中的单个变量可能需要几个小时。

• 编辑似乎是一项艰巨的任务。

理想的解决方案

• 在 Latex 中写入文本

• 在jupyter notebook中写python，导出为latex。

• 以某种方式将代码片段（导出文件的小部分）包含到主要乳胶书的不同部分中。这是我想不通的部分

• 当需要更改python时，在jupyter中进行更改，然后重新导出为同名的latex文件

• Latex 书自动从包含更新。

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

优点：

1. Python 编辑容易，易于传播回书。

2. 用乳胶书写的文字，可以使用乳胶的力量

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

可能无关紧要，但我在 VS Code 中同时编写了 Latex 和 jupyter 笔记本。如果这意味着解决这些问题，我愿意改变工具。

Answer 1

这是我写的一个小脚本。它拆分单个*.ipynb文件并将其转换为多个*.tex文件。用法是：复制以下脚本并另存为&nbsp;main.py执行python main.py init。它将创建main.tex和style_ipython_custom.tplx在您的 jupyther 笔记本中，向您要提取的每个单元格添加额外的行#latex:tag_a,&nbsp;#latex:tag_b, .. 。相同的标签将被提取到相同的*.tex文件。将其保存为*.ipynb文件。幸运的是，目前VSCode蟒蛇插件支持出口到*.ipynb从，或使用jupytext转换*.py到*.ipynb。运行python main.py path/to/your.ipynb，它将创建tag_a.tex和tag_b.tex编辑main.tex和添加\input{tag_a.tex}或\input{tag_b.tex}任何你想要的地方。运行pdflatex main.tex它会产生main.pdf这个脚本背后的想法：使用默认值从 jupyter notebook 转换为 LaTexnbconvert.LatexExporter会生成包含宏定义的完整 LaTex 文件。使用它来转换每个单元格可能会创建大型 LaTex 文件。为避免该问题，脚本首先创建main.tex只有宏定义的单元格，然后将每个单元格转换为没有宏定义的 LaTex 文件。这可以使用自定义模板文件来完成，该文件从style_ipython.tplx标记或标记单元格可能使用单元格元数据完成，但我找不到如何在 VSCode python 插件（问题）中设置它，因此它使用正则表达式模式扫描每个单元格的源^#latex:(.*)，并在将其转换为 LaTex 文件之前将其删除.来源：import sysimport reimport osfrom collections import defaultdictimport nbformatfrom nbconvert import LatexExporter, exportersOUTPUT_FILES_DIR = './images'CUSTOM_TEMPLATE = 'style_ipython_custom.tplx'MAIN_TEX = 'main.tex'def create_main():&nbsp; &nbsp; # creates `main.tex` which only has macro definition&nbsp; &nbsp; latex_exporter = LatexExporter()&nbsp; &nbsp; book = nbformat.v4.new_notebook()&nbsp; &nbsp; book.cells.append(&nbsp; &nbsp; &nbsp; &nbsp; nbformat.v4.new_raw_cell(r'\input{__your_input__here.tex}'))&nbsp; &nbsp; (body, _) = latex_exporter.from_notebook_node(book)&nbsp; &nbsp; with open(MAIN_TEX, 'x') as fout:&nbsp; &nbsp; &nbsp; &nbsp; fout.write(body)&nbsp; &nbsp; print("created:", MAIN_TEX)def init():&nbsp; &nbsp; create_main()&nbsp; &nbsp; latex_exporter = LatexExporter()&nbsp; &nbsp; # copy `style_ipython.tplx` in `nbconvert.exporters` module to current directory,&nbsp; &nbsp; # and modify it so that it does not contain macro definition&nbsp; &nbsp; tmpl_path = os.path.join(&nbsp; &nbsp; &nbsp; &nbsp; os.path.dirname(exporters.__file__),&nbsp; &nbsp; &nbsp; &nbsp; latex_exporter.default_template_path)&nbsp; &nbsp; src = os.path.join(tmpl_path, 'style_ipython.tplx')&nbsp; &nbsp; target = CUSTOM_TEMPLATE&nbsp; &nbsp; with open(src) as fsrc:&nbsp; &nbsp; &nbsp; &nbsp; with open(target, 'w') as ftarget:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; for line in fsrc:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; # replace the line so than it does not contain macro definition&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; if line == "((*- extends 'base.tplx' -*))\n":&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; line = "((*- extends 'document_contents.tplx' -*))\n"&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; ftarget.write(line)&nbsp; &nbsp; print("created:", CUSTOM_TEMPLATE)def group_cells(note):&nbsp; &nbsp; # scan the cell source for tag with regexp `^#latex:(.*)`&nbsp; &nbsp; # if sames tags are found group it to same list&nbsp; &nbsp; pattern = re.compile(r'^#latex:(.*?)$(\n?)', re.M)&nbsp; &nbsp; group = defaultdict(list)&nbsp; &nbsp; for num, cell in enumerate(note.cells):&nbsp; &nbsp; &nbsp; &nbsp; m = pattern.search(cell.source)&nbsp; &nbsp; &nbsp; &nbsp; if m:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; tag = m.group(1).strip()&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; # remove the line which contains tag&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; cell.source = cell.source[:m.start(0)] + cell.source[m.end(0):]&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; group[tag].append(cell)&nbsp; &nbsp; &nbsp; &nbsp; else:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; print("tag not found in cell number {}. ignore".format(num + 1))&nbsp; &nbsp; return groupdef doit():&nbsp; &nbsp; with open(sys.argv[1]) as f:&nbsp; &nbsp; &nbsp; &nbsp; note = nbformat.read(f, as_version=4)&nbsp; &nbsp; group = group_cells(note)&nbsp; &nbsp; latex_exporter = LatexExporter()&nbsp; &nbsp; # use the template which does not contain LaTex macro definition&nbsp; &nbsp; latex_exporter.template_file = CUSTOM_TEMPLATE&nbsp; &nbsp; try:&nbsp; &nbsp; &nbsp; &nbsp; os.mkdir(OUTPUT_FILES_DIR)&nbsp; &nbsp; except FileExistsError:&nbsp; &nbsp; &nbsp; &nbsp; pass&nbsp; &nbsp; for (tag, g) in group.items():&nbsp; &nbsp; &nbsp; &nbsp; book = nbformat.v4.new_notebook()&nbsp; &nbsp; &nbsp; &nbsp; book.cells.extend(g)&nbsp; &nbsp; &nbsp; &nbsp; # unique_key will be prefix of image&nbsp; &nbsp; &nbsp; &nbsp; (body, resources) = latex_exporter.from_notebook_node(&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; book,&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; resources={&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; 'output_files_dir': OUTPUT_FILES_DIR,&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; 'unique_key': tag&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; })&nbsp; &nbsp; &nbsp; &nbsp; ofile = tag + '.tex'&nbsp; &nbsp; &nbsp; &nbsp; with open(ofile, 'w') as fout:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; fout.write(body)&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; print("created:", ofile)&nbsp; &nbsp; &nbsp; &nbsp; # the image data which is embedded as base64 in notebook&nbsp; &nbsp; &nbsp; &nbsp; # will be decoded and returned in `resources`, so write it to file&nbsp; &nbsp; &nbsp; &nbsp; for filename, data in resources.get('outputs', {}).items():&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; with open(filename, 'wb') as fres:&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; fres.write(data)&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; print("created:", filename)if len(sys.argv) <= 1:&nbsp; &nbsp; print("USAGE: this_script [init|yourfile.ipynb]")elif sys.argv[1] == "init":&nbsp; &nbsp; init()else:&nbsp; &nbsp; doit()

Answer 2

我会使用bookdown在同一个文档中同时包含测试和源代码（为了方便起见，分成几个文件）。这个包起源于 R 世界，但也可以与其他语言一起使用。这是一个非常简单的例子：---output: bookdown::pdf_document2---```{r setup, include=FALSE}knitr::opts_chunk$set(echo = TRUE)```# Setup dataFirst we define some varialbes with data.```{python data}bob = ['Bob Smith', 42, 30000, 'software']sue = ['Sue Jones', 45, 40000, 'music']```# Output datathen we output some of the data.```{python output}bob[0], sue[2]```# Reference code blockFinally lets repeate the code block without evaluating it.```{python, ref.label="output", eval = FALSE}```输出：

Answer 3

Jupyter 不允许从笔记本导出特定单元格——它只允许您导出整个笔记本。为了尽可能接近您的理想场景，您需要一个模块化的 Jupyter 设置：将您的单个 Jupyter 笔记本拆分为更小的笔记本。然后可以通过文件 > 下载为 > LaTeX (.tex) 将每个笔记本导出到 LaTeX在 LaTeX 中，您可以通过以下方式导入生成的 .tex 文件\input{文件名.tex}如果您想将较小的笔记本导入主笔记本的单元格中，您可以通过（请参阅魔术命令运行）%run&nbsp;my_other_notebook.ipynb&nbsp;#or&nbsp;%run&nbsp;'my&nbsp;notebook&nbsp;with&nbsp;spaces.ipynb'您还可以通过（请参阅magic command&nbsp;load）插入python文件%load&nbsp;python_file.py它加载 Python 文件并允许您在主笔记本中执行它。您还可以拥有小的 .py 片段，将它们加载到您的小型 Jupyter 笔记本中，然后在较大的笔记本中运行该小型笔记本。你对 VS Code 的使用很好，不过，浏览器中的 Jupyter 可能会让你编辑得更快。