编写充满 Python 代码的 Latex 书的困难工作流程
Difficult workflow writing Latex book full of Python code
我正在写一本关于 python 使用 Latex 编码的书。我计划在整个文本中穿插 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 中。
优点：
- 只需更新一小段代码即可轻松完成。
缺点：
- 输出需要在python中运行，分别复制、粘贴。
- 初写SLOW，每章要刷上百遍
找到解决方案 2（错误）
使用带有 markdown 的 jupyter notebook，导出到 Latex，\include 文件到主 Latex 文档中。
优点：
- 精简
- 其中包含输出。
缺点：
- 要进行小的更改，需要重新导入整个文档，在 Latex 编辑器中对 markdown 文本所做的任何更改都不会保存
- 在 jupyter notebook 之后重命名 python 中的单个变量可能需要数小时。
- 编辑似乎是一个巨大的苦差事。
理想解
- 用 Latex 编写文本
- 在jupyter notebook中写入python，导出到latex。
- 以某种方式将代码片段（导出文件的小部分）包含到主要乳胶书中的不同部分。 这是我想不通的部分
- 当需要 python 更改时，在 jupyter 中更改，然后重新导出为具有相同名称的乳胶文件
- Latex 书籍会自动从包含内容更新。
这里的关键是导出的 python 笔记本被拆分并发送到文档的不同部分。为了让它工作，它需要以某种方式在笔记本的降价或代码中进行标记或标记，所以当我重新导出它时，那些相同的部分会被发送到书中的相同位置。
优点：
- Python 编辑容易，传播回书很容易。
- 用latex写的文字，可以利用latex的力量
任何帮助提出更接近我的理想解决方案的解决方案将不胜感激。快要死了。
可能无关紧要，但我正在 VS Code 中编写 latex 和 jupyter notebooks。如果这意味着解决这些问题，我愿意改变工具。
Jupyter 不允许从笔记本中导出特定的单元格——它只允许您导出整个笔记本。为了尽可能接近您的理想场景，您需要一个模块化的 Jupyter 设置：
- 将您的单个 Jupyter 笔记本拆分成更小的笔记本。
- 然后可以通过“文件”>“下载为”>“LaTeX (.tex)”将每个笔记本导出到 LaTeX
在 LaTeX 中，您可以通过
导入生成的 .tex 文件
\输入{filname.tex}
如果您想将较小的笔记本导入到主笔记本的单元格中，您可以通过（参见魔术命令 run）
执行此操作
%run my_other_notebook.ipynb #or %run 'my notebook with spaces.ipynb'
您也可以通过（见魔术命令load）插入python个文件
%load python_file.py
加载 Python 文件并允许您在主笔记本中执行它。
您也可以有小的 .py 片段，将它们加载到您的小型 Jupyter 笔记本中，然后 运行 将小笔记本加载到您的大笔记本中。
你对 VS Code 的使用很好，不过，浏览器中的 Jupyter 可能会让你编辑得更快。
我会使用 bookdown 将测试代码和源代码放在同一个文档中（为方便起见拆分成多个文件）。这个包起源于 R 世界，但也可以与其他语言一起使用。这里有一个非常简单的例子：
---
output: bookdown::pdf_document2
---
```{r setup, include=FALSE}
knitr::opts_chunk$set(echo = TRUE)
```
# Setup data
First we define some varialbes with data.
```{python data}
bob = ['Bob Smith', 42, 30000, 'software']
sue = ['Sue Jones', 45, 40000, 'music']
```
# Output data
then we output some of the data.
```{python output}
bob[0], sue[2]
```
# Reference code block
Finally lets repeate the code block without evaluating it.
```{python, ref.label="output", eval = FALSE}
```
输出：
这是我写的一个小脚本。它拆分单个 *.ipynb 文件并将其转换为多个 *.tex 文件。
用法是：
- 复制以下脚本并另存为
main.py
- 执行
python main.py init。它将创建 main.tex 和 style_ipython_custom.tplx
- 在你的 jupyther notebook 中，添加额外的行
#latex:tag_a, #latex:tag_b, .. 到你想要提取的每个单元格。相同的标签将被提取到相同的 *.tex 文件。
- 将其另存为
*.ipynb 文件。幸运的是，当前的 VSCode python 插件支持导出到 *.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
此脚本背后的想法：
使用默认 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()
我正在写一本关于 python 使用 Latex 编码的书。我计划在整个文本中穿插 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 中。
优点：
- 只需更新一小段代码即可轻松完成。
缺点：
- 输出需要在python中运行，分别复制、粘贴。
- 初写SLOW，每章要刷上百遍
找到解决方案 2（错误）
使用带有 markdown 的 jupyter notebook，导出到 Latex，\include 文件到主 Latex 文档中。
优点：
- 精简
- 其中包含输出。
缺点：
- 要进行小的更改，需要重新导入整个文档，在 Latex 编辑器中对 markdown 文本所做的任何更改都不会保存
- 在 jupyter notebook 之后重命名 python 中的单个变量可能需要数小时。
- 编辑似乎是一个巨大的苦差事。
理想解
- 用 Latex 编写文本
- 在jupyter notebook中写入python，导出到latex。
- 以某种方式将代码片段（导出文件的小部分）包含到主要乳胶书中的不同部分。 这是我想不通的部分
- 当需要 python 更改时，在 jupyter 中更改，然后重新导出为具有相同名称的乳胶文件
- Latex 书籍会自动从包含内容更新。
这里的关键是导出的 python 笔记本被拆分并发送到文档的不同部分。为了让它工作，它需要以某种方式在笔记本的降价或代码中进行标记或标记，所以当我重新导出它时，那些相同的部分会被发送到书中的相同位置。
优点：
- Python 编辑容易，传播回书很容易。
- 用latex写的文字，可以利用latex的力量
任何帮助提出更接近我的理想解决方案的解决方案将不胜感激。快要死了。
可能无关紧要，但我正在 VS Code 中编写 latex 和 jupyter notebooks。如果这意味着解决这些问题，我愿意改变工具。
Jupyter 不允许从笔记本中导出特定的单元格——它只允许您导出整个笔记本。为了尽可能接近您的理想场景，您需要一个模块化的 Jupyter 设置：
- 将您的单个 Jupyter 笔记本拆分成更小的笔记本。
- 然后可以通过“文件”>“下载为”>“LaTeX (.tex)”将每个笔记本导出到 LaTeX
在 LaTeX 中，您可以通过
导入生成的 .tex 文件\输入{filname.tex}
如果您想将较小的笔记本导入到主笔记本的单元格中，您可以通过（参见魔术命令 run）
执行此操作%run my_other_notebook.ipynb #or %run 'my notebook with spaces.ipynb'
您也可以通过（见魔术命令load）插入python个文件
%load python_file.py
加载 Python 文件并允许您在主笔记本中执行它。
您也可以有小的 .py 片段，将它们加载到您的小型 Jupyter 笔记本中，然后 运行 将小笔记本加载到您的大笔记本中。
你对 VS Code 的使用很好，不过，浏览器中的 Jupyter 可能会让你编辑得更快。
我会使用 bookdown 将测试代码和源代码放在同一个文档中（为方便起见拆分成多个文件）。这个包起源于 R 世界，但也可以与其他语言一起使用。这里有一个非常简单的例子：
---
output: bookdown::pdf_document2
---
```{r setup, include=FALSE}
knitr::opts_chunk$set(echo = TRUE)
```
# Setup data
First we define some varialbes with data.
```{python data}
bob = ['Bob Smith', 42, 30000, 'software']
sue = ['Sue Jones', 45, 40000, 'music']
```
# Output data
then we output some of the data.
```{python output}
bob[0], sue[2]
```
# Reference code block
Finally lets repeate the code block without evaluating it.
```{python, ref.label="output", eval = FALSE}
```
输出：
这是我写的一个小脚本。它拆分单个 *.ipynb 文件并将其转换为多个 *.tex 文件。
用法是：
- 复制以下脚本并另存为
main.py - 执行
python main.py init。它将创建main.tex和style_ipython_custom.tplx - 在你的 jupyther notebook 中，添加额外的行
#latex:tag_a,#latex:tag_b, .. 到你想要提取的每个单元格。相同的标签将被提取到相同的*.tex文件。 - 将其另存为
*.ipynb文件。幸运的是，当前的 VSCode python 插件支持导出到*.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
此脚本背后的想法：
使用默认 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()