1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
|
#!/usr/bin/env python3
# Copyright 2020-2022 Louis Paternault
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
"""Compile a `.tex` file, executing commands that are set inside the file itself."""
import argparse
import logging
import os
import pathlib
import re
import subprocess
import sys
NAME = "SpiX"
VERSION = "1.3.0"
RE_EMPTY = re.compile("^ *$")
RE_COMMENT = re.compile("^ *%")
RE_COMMAND = re.compile(r"^%\$ ?(.*)$")
class SpixError(Exception):
"""Exception that should be catched and nicely displayed to user."""
def parse_lines(lines):
"""Parse line to find code snippets.
:param iterable lines: Lines to parte (typically ``open("foo.tex").readlines()``.
:return: Iterator over snippets (as strings).
"""
snippet = None
for line in lines:
line = line.rstrip("\n")
if RE_COMMAND.match(line):
match = RE_COMMAND.match(line)
if snippet is None:
snippet = ""
else:
snippet += "\n"
snippet += match.groups()[0]
elif RE_EMPTY.match(line) or RE_COMMENT.match(line):
if snippet is not None:
yield snippet
snippet = None
else:
break
if snippet is not None:
yield snippet
def compiletex(filename, *, dryrun=False):
"""Read commands from file, and execute them.
:param str filename: File to process.
:param bool dryrun: If ``True``, print commands to run, but do not execute them.
"""
env = os.environ
filename = pathlib.Path(filename)
env["texname"] = filename.name
env["basename"] = filename.stem
try:
# pylint: disable=unspecified-encoding
with open(filename, errors="ignore") as file:
for snippet in parse_lines(file.readlines()):
print(snippet)
sys.stdout.flush()
if dryrun:
continue
subprocess.check_call(
["sh", "-c", snippet, NAME, filename.name],
cwd=(pathlib.Path.cwd() / filename).parent,
env=env,
)
except subprocess.CalledProcessError as error:
raise SpixError() from error
except IsADirectoryError as error:
raise SpixError(str(error)) from error
def commandline_parser():
"""Return a command line parser.
:rtype: argparse.ArgumentParser
"""
parser = argparse.ArgumentParser(
prog="spix",
description=(
"Compile a `.tex` file, "
"executing commands that are set inside the file itself."
),
)
parser.add_argument(
"-n",
"--dry-run",
action="store_true",
help="Print the commands that would be executed, but do not execute them.",
)
parser.add_argument(
"--version",
help="Show version and exit.",
action="version",
version=f"{NAME} {VERSION}",
)
parser.add_argument("FILE", nargs=1, help="File to process.")
return parser
def main():
"""Main function."""
arguments = commandline_parser().parse_args()
if os.path.exists(arguments.FILE[0]):
arguments.FILE = arguments.FILE[0]
elif os.path.exists(f"{arguments.FILE[0]}.tex"):
arguments.FILE = f"{arguments.FILE[0]}.tex"
else:
logging.error("""File not found: "%s".""", arguments.FILE[0])
sys.exit(1)
try:
compiletex(arguments.FILE, dryrun=arguments.dry_run)
except SpixError as error:
if str(error):
logging.error(error)
sys.exit(1)
if __name__ == "__main__":
main()
|
