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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
|
"""
Tests for the 'argparse-manpage' script.
"""
import datetime
import os
import shutil
import sys
import subprocess
import tempfile
import time
import warnings
from packaging import version
import setuptools
from test_examples import run_setup_py
from argparse_testlib import pushd
SIMPLE_FILE_CONTENTS = """\
import argparse
def get_parser():
parser = argparse.ArgumentParser({ap_arguments})
parser.add_argument("test")
return parser
def main():
print("here")
get_parser().parse_args()
if __name__ == "__main__":
main()
"""
SIMPLE_OUTPUT = """\
.TH {NAME} "1" "{DATE}" "{name}{version}" "Generated Python Manual"
.SH NAME
{name}
.SH SYNOPSIS
.B {name}
[-h] test
.TP
\\fBtest\\fR
"""
FULL_OUTPUT = """\
.TH {NAME} "3" "{DATE}" "Proj\\-On\\-Cmdline 1.alpha" "Some\\-long Manual Name"
.SH NAME
{name} \\- some description
.SH SYNOPSIS
.B {name}
[-h] test
.TP
\\fBtest\\fR
.SH EXTRA SECTION
This is an extra section.
.SH AUTHOR
.nf
John Doe <jdoe@example.com>
Developer extraordinaire.
.fi
.nf
Mr. Foo <mfoo@example.com> and friends
.fi
"""
SETUP_PY_FILE_CONTENTS = """\
from build_manpages import build_manpages, get_install_cmd, get_build_py_cmd
from setuptools import setup
setup(
cmdclass={
'build_manpages': build_manpages,
'build_py': get_build_py_cmd(),
'install': get_install_cmd(),
}
)
"""
PYPROJECT_TOML_FILE_CONTENTS = """\
[tool.build_manpages]
manpages = [
"some-file.1:project_name=some-file:module=somefile:function=get_parser",
]
"""
DATE = datetime.datetime.utcfromtimestamp(
int(os.environ.get('SOURCE_DATE_EPOCH', time.time()))
).strftime("%Y\\-%m\\-%d")
class TestsArgparseManpageScript:
def setup_method(self, _):
self.workdir = tempfile.mkdtemp(prefix="argparse-manpage-tests-")
os.environ["PYTHON"] = sys.executable
os.environ["PYTHONPATH"] = os.getcwd()
def teardown_method(self, _):
shutil.rmtree(self.workdir)
@staticmethod
def _get_am_executable():
testdir = os.path.dirname(__file__)
executable = os.path.join(testdir, '..', 'argparse-manpage')
return executable
def test_filepath_function(self):
"""
Test --pyfile && --function.
"""
name = "some-file"
expname = r"some\-file"
tested_executable = os.path.join(self.workdir, name)
with open(tested_executable, "w+") as script_fd:
script_fd.write(SIMPLE_FILE_CONTENTS.format(ap_arguments=""))
cmd = [
self._get_am_executable(),
"--pyfile", tested_executable,
"--function", "get_parser",
]
output = subprocess.check_output(cmd).decode("utf-8")
assert output == SIMPLE_OUTPUT.format(name=expname, version="",
NAME=expname.upper(), DATE=DATE)
def test_filepath_prog(self):
"""
Test --pyfile --function with prog explicitly specified in
ArgumentParser name.
"""
name = "some-file"
expname = "progname"
tested_executable = os.path.join(self.workdir, name)
with open(tested_executable, "w+") as script_fd:
script_fd.write(SIMPLE_FILE_CONTENTS.format(ap_arguments='"progname"'))
cmd = [
self._get_am_executable(),
"--pyfile", tested_executable,
"--function", "get_parser",
]
output = subprocess.check_output(cmd).decode("utf-8")
name="progname"
assert output == SIMPLE_OUTPUT.format(name=expname, version="",
NAME=expname.upper(), DATE=DATE)
def test_full_args(self):
"""
Submit as many commandline arguments as possible.
"""
name = "full_name"
tested_executable = os.path.join(self.workdir, name)
with open(tested_executable, "w+") as script_fd:
script_fd.write(SIMPLE_FILE_CONTENTS.format(ap_arguments='"progname"'))
cmd = [
self._get_am_executable(),
"--pyfile", tested_executable,
"--function", "get_parser",
"--manual-section", "3",
"--manual-title", "Some-long Manual Name",
"--version", "1.alpha",
"--author", "John Doe <jdoe@example.com>",
"--author", "Mr. Foo <mfoo@example.com> and friends",
"--project-name", "Proj-On-Cmdline",
"--description", "some description",
"--long-description", "Some long description.", # unused
"--include", "tests/extra.man",
]
output = subprocess.check_output(cmd).decode("utf-8")
name="progname"
assert output == FULL_OUTPUT.format(name=name, NAME=name.upper(),
DATE=DATE)
def test_pyproject_toml(self):
"""
Test that we can read information from pyproject.toml.
"""
current_dir = os.getcwd()
with pushd(self.workdir):
with open("pyproject.toml", "w+") as script_fd:
script_fd.write(PYPROJECT_TOML_FILE_CONTENTS.format(gitdir=current_dir))
with open("setup.py", "w+") as script_fd:
script_fd.write(SETUP_PY_FILE_CONTENTS)
modname = "somefile"
name = r"some\-file"
os.mkdir(modname)
with open(os.path.join(modname, "__init__.py"), "w+") as script_fd:
script_fd.write(SIMPLE_FILE_CONTENTS.format(ap_arguments=""))
assert 0 == run_setup_py(["build"])
if version.parse(setuptools.__version__) >= version.parse("62.2.0"):
with open("some-file.1") as script_fd:
output = script_fd.read()
assert output == SIMPLE_OUTPUT.format(name=name, version=" 0.0.0",
NAME=name.upper(), DATE=DATE)
else:
warnings.warn("setuptools >= 62.2.0 required to generate man pages with pyprojects.toml")
|
