在LaTeX中使用Python的简单介绍

一、概述

Python语言自1991年2月发布最初代码开始，到现在已经有31年的历史，目前已经成为最热门的计算机语言之一。经过这么多年的发展，python得到了极大的扩展，把python的功能应用到LaTeX中也必然会增强LaTeX的灵活性、便捷性和应用面。

本文将简单介绍在LaTeX中使用pythontex宏包与pythontex引擎，来实现在LaTeX文档中调用python代码的方法。以前我推荐使用LuaTeX引擎来实现latex调用lua代码，现在介绍pythontex后，最后选择哪一种，咱们按照自己的实际情况边用边看吧。

二、环境

下面会列举一些例子，这些代码验证过的环境如下：

• 操作系统：Ubuntu 20.04
• 引擎一：XeTeX 3.14159265-2.6-0.999991
• 引擎二：PythonTeX 0.17

这里之所以列出两个引擎来，是因为两个都必须用。大家可以看到，我在引擎选择上已经从原来的LuaTeX改成XeTeX，主要原因是这些例子中不会调用lua代码，并且XeTeX对汉字的支持更好一些，至少在XeTeX中使用ctex宏包时，不会再出现那些烦人的警告。另外，相较于pdfTeX，XeTeX支持的字符范围更大，所以我也不选用pdfTeX引擎。

三、编译步骤

对于普通的latex文档，编译时一般就只需要一步就可完成，例如：

xelatex test1.tex

只要没有错误，就可以生成相应的pdf文件。加入python代码后，步骤就从一步变为三步：

xelatex test1.tex

pythontex test1.tex

xelatex test1.tex

第一步运行后一般都会报错，但不用管，继续用第二步来编译latex中的python代码，最后用xelatex再编译一次就能正常完成。第一步虽然会报错，但会生成第二步中需要的文件，因此不能省略。

这个过程看上去有些繁琐，习惯就好。我编写latex文档用的是VSCode，里面可以完成xelatex的编译，另外还开了一个终端窗口，用来执行pythontex，所以在实际使用时，就是在VSCode和终端窗口间切换。

四、完整示例

1. 示例一

1.1 test1.tex完整代码

% 博客园，繁星间漫步，陆巍的博客
/documentclass{ctexart}

/usepackage{pythontex}

/begin{pycode}
def test():
    print("Make you feel my love")
    return ""
/end{pycode}

/begin{document}
  /section{在LaTeX中使用Python}

  /begin{pycode} 
print("Hello, it's me")
  /end{pycode}

  /py{test()}

/end{document}

1.2 编译步骤

我们先来试一下开始就用pythontex命令编译test1.tex文件，结果如下：

可以看到提示错误，并且在此文件夹下没有任何文件（夹）产生。我们还是得按照“三步走”来执行，先用xelatex引擎编译，在项目文件夹中出现了以下文件：

这里就出现了错误提示中需要的test1.pytxcode文件。接下来执行第二步，运行pythontex命令：

经过pythontex的编译后，我们看到项目文件夹内多出一个文件夹：pythontex-files-test1

在执行第三步之前，我们可以看到tex文档的编辑窗口中，“/py{print(str1)}”代码下一直有问题提示，不用管。继续往下走，再一次使用xelatex引擎编译。这里要注意一点，此时tex文档中的内容与第一步时的内容并没有发生任何改变，如果使用的是VSCode编写tex文档，那么当我们点击xelatex编译时，有时候不会进行编译，这样我们看到的pdf文件中python代码输出的内容处就是些问号。因此，随便对tex中做一点修改，比如打一个空格，然后再用xelatex编译。本例编译后生成的pdf文件内容如下：

1.3 说明

• latex中调用的python代码格式同样要遵循相关的规定。比如说代码中的“print(“Hello, it’s me”)”前面就不能有空格，def定义中的第二行同样要严格遵循4个空格缩进的规定。
• test()函数返回值为””，是为了避免在pdf文件中显示出讨厌的“None”。

2. 示例二

2.1 完整代码

a. test2.tex

% 博客园，繁星间漫步，陆巍的博客
/documentclass{ctexart}

/usepackage{pythontex}
/usepackage{graphicx}

/begin{pycode}
from draw_test import *
DrawTest()
/end{pycode}

/begin{document}
  /section{在LaTeX中使用Python}

  /subsection{调用库、调用外部py文件与绘图示例}
 
  /includegraphics[width=0.9/textwidth]{draw_test.png}
/end{document}

b. draw_test.py

# 博客园，繁星间漫步，陆巍的博客
from pylab import *

def DrawTest():
    figure(figsize=(4,3))
    x = linspace(0, 4, 1001)
    plot(x, 2*sin(2*pi*x/4))
    xlabel('$x$ (m)')
    ylabel('$y$ (m)')
    grid(True)
    savefig('draw_test.png', bbox_inches='tight')
    return ""

2.2 编译步骤

编译步骤与示例一一样，也是三步走。可能示例一在第一步时不一定会提示错误，但示例二的第一步肯定会提示找不到draw_test.png文件的错误，没关系，因为这个图片文件还没有产生。执行第二步后就会在项目文件夹内生成draw_test.png文件。

三步完成后生成的pdf文件内容如下：

2.3 说明

• 尽量把python代码与latex代码分别处理，道理在介绍调用lua代码时已经讲过。
• 本例中的draw_test.py文件中调用了pylab库，请在使用前先安装此库。
• 还是那个老问题，函数返回值可以设成空字符，以免在pdf文件上出现None。
• 在本示例的latex文档中，加载图形支持宏包时不要用graphics宏包，应该使用graphicx宏包，否则/includegraphics命令会报错，