-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy path_cmd_helper.py
More file actions
164 lines (147 loc) · 4.82 KB
/
_cmd_helper.py
File metadata and controls
164 lines (147 loc) · 4.82 KB
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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
import glob
import os
from typing import Optional
from argparse import ArgumentParser, RawTextHelpFormatter
from tempfile import TemporaryDirectory
def get_parser():
parser = ArgumentParser(
prog="sphinx-runpython command line",
description="A collection of quick tools.",
formatter_class=RawTextHelpFormatter,
epilog="",
)
parser.add_argument(
"command",
help="Command to run, only 'nb2py', 'readme', 'img2pdf', 'api', "
"'latex' are available\n"
"- api - generates sphinx documentation api\n"
"- latex - improves latex rendering\n"
"- img2pdf - converts impage to pdf\n"
"- nb2py - converts notebooks into python\n"
"- readme - checks readme syntax",
)
parser.add_argument(
"-p", "--path", help="Folder or file which contains the files to process"
)
parser.add_argument(
"-r",
"--recursive",
help="Recursive search.",
action="store_true",
)
parser.add_argument(
"--hidden",
help="shows hidden submodules as well",
action="store_true",
)
parser.add_argument(
"-o",
"--output",
help="output",
)
parser.add_argument(
"--zoom",
default=1.0,
help="reduce images when img2pdf is used",
)
parser.add_argument(
"--rotate",
default=0.0,
help="rotate the image",
)
parser.add_argument("-v", "--verbose", help="verbosity", default=1, type=int)
return parser
def nb2py(infolder: str, recursive: bool = False, verbose: int = 0):
from .convert import convert_ipynb_to_gallery
if not os.path.exists(infolder):
raise FileNotFoundError(f"Unable to find {infolder!r}.")
patterns = [infolder + "/*.ipynb", infolder + "/**/*.ipynb"]
for pattern in patterns:
if verbose:
print(f"[nb2py] look with pattern {pattern!r}, recursive={recursive}")
for name in glob.iglob(pattern, recursive=recursive):
spl = os.path.splitext(name)
out = spl[0] + ".py"
if verbose:
print(f"process {name!r} -> {out!r}")
convert_ipynb_to_gallery(name, outfile=out)
def latex_process(
infolder: str,
recursive: bool = False,
output: Optional[str] = None,
verbose: int = 0,
):
from .tools.latex_functions import replace_latex_command
if not os.path.exists(infolder):
raise FileNotFoundError(f"Unable to find {infolder!r}.")
patterns = [infolder + "/*.rst", infolder + "/*.py"]
for pattern in patterns:
if verbose:
print(f"[latex] look with pattern {pattern!r}, recursive={recursive}")
for name in glob.iglob(pattern, recursive=recursive):
with open(name, "r") as f:
content = f.read()
new_content = replace_latex_command(content)
if new_content != content:
if output:
new_name = os.path.join(output, os.path.split(name)[-1])
if verbose:
print(f"[latex] write {new_name!r}")
with open(new_name, "w") as f:
f.write(new_content)
else:
if verbose:
print(f"[latex] replace inplace {name!r}")
with open(name, "w") as f:
f.write(new_content)
def sphinx_api(
infolder: str,
output: str,
recursive: bool = False,
hidden: bool = False,
verbose: int = 0,
):
from .tools.sphinx_api import sphinx_api as f
f(infolder, output, verbose=verbose, hidden=hidden)
def process_args(args):
cmd = args.command
if cmd == "nb2py":
nb2py(args.path, recursive=args.recursive, verbose=args.verbose)
return
if cmd == "api":
sphinx_api(
args.path,
recursive=args.recursive,
verbose=args.verbose,
output=args.output,
hidden=args.hidden,
)
return
if cmd == "latex":
latex_process(
args.path,
recursive=args.recursive,
verbose=args.verbose,
output=args.output,
)
return
if cmd == "img2pdf":
from .tools.img_export import images2pdf
images2pdf(
args.path,
args.output,
verbose=args.verbose,
zoom=float(args.zoom),
rotate=float(args.rotate),
)
return
if cmd == "readme":
from .readme import check_readme_syntax
with TemporaryDirectory() as temp:
check_readme_syntax(args.path, verbose=args.verbose, folder=temp)
return
raise ValueError(f"Command {cmd!r} is unknown.")
def main():
parser = get_parser()
args = parser.parse_args()
process_args(args)