能否用Python编写Pre-commit钩子确保TeX文件修改后同步编译PDF？

核心结论 #

不一定需要专门编写Python脚本，Pre-Commit钩子可以直接调用TeX编译命令，也能利用现成的社区钩子；只有当你需要处理复杂逻辑（比如动态判断文件、多环境兼容、清理辅助文件等）时，才需要编写Python脚本。

两种实现方案 #

方案1：直接调用编译命令（无需额外脚本） #

在项目根目录的.pre-commit-config.yaml中添加本地钩子，直接调用TeX编译器命令即可：

repos:
-   repo: local
    hooks:
    -   id: compile-tex-to-pdf
        name: Compile TeX to PDF
        files: \.tex$
        entry: pdflatex
        args: ["-interaction=nonstopmode", "{{}}"]
        language: system
        pass_filenames: true

• 说明：这个钩子会在提交匹配.tex后缀的文件时，自动执行pdflatex -interaction=nonstopmode 目标文件.tex，同步生成对应PDF。
• 前提：本地环境需安装TeX发行版（如TeX Live、MikTeX），确保pdflatex命令能正常运行。

方案2：编写Python脚本（适配复杂场景） #

如果需要更灵活的逻辑支持，比如仅编译被修改的TeX文件、兼容不同编译器（xelatex/lualatex）、自动清理编译辅助文件等，可以写一个简单的Python脚本compile_tex.py：

import subprocess
import sys
import os

def compile_tex(file_path):
    # 可根据需求替换为xelatex或lualatex
    compiler = "pdflatex"
    args = [compiler, "-interaction=nonstopmode", file_path]
    
    try:
        subprocess.run(args, check=True, capture_output=True, text=True)
        print(f"已成功编译 {file_path} 为PDF")
        # 可选：自动清理编译产生的辅助文件
        base_name = os.path.splitext(file_path)[0]
        aux_extensions = [".aux", ".log", ".out"]
        for ext in aux_extensions:
            aux_file = f"{base_name}{ext}"
            if os.path.exists(aux_file):
                os.remove(aux_file)
        return 0
    except subprocess.CalledProcessError as e:
        print(f"编译 {file_path} 失败：")
        print(e.stderr)
        return 1

if __name__ == "__main__":
    exit_code = 0
    for file in sys.argv[1:]:
        if file.endswith(".tex"):
            exit_code |= compile_tex(file)
    sys.exit(exit_code)

然后在.pre-commit-config.yaml中引用这个脚本：

repos:
-   repo: local
    hooks:
    -   id: compile-tex-with-script
        name: Compile TeX to PDF via Python script
        files: \.tex$
        entry: python compile_tex.py
        language: system
        pass_filenames: true

额外提示 #

• 要确保生成的PDF文件被加入版本控制，避免团队成员无法查看最新内容，不要在.gitignore中排除PDF文件（除非有特殊需求）。
• 如果团队成员本地环境不一致，也可以用Docker封装统一的TeX编译环境，在钩子中调用Docker命令执行编译，保证编译结果一致。

内容的提问来源于stack exchange，提问作者Tfloow