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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
|
# -*- coding: utf-8 -*-
"""build_manpage command -- Generate man page from setup()"""
import datetime
import optparse
import argparse
import os
import time
import warnings
from distutils.core import Command
from distutils.errors import DistutilsOptionError
from argparse_manpage.manpage import (
get_manpage_data_from_distribution,
get_footer,
)
from argparse_manpage.tooling import (
get_parser_from_file,
get_parser_from_module,
write_to_filename,
)
warnings.warn(
"The 'build_manpage' module will be removed in the next argparse-manpage "
"version v5. Please migrate to 'build_manpages'.", DeprecationWarning,
)
class ManPageWriter(object):
_parser = None
_command = None
_type = None
def __init__(self, parser, values):
self._parser = parser
self.values = values
self._today = datetime.datetime.utcfromtimestamp(
int(os.environ.get('SOURCE_DATE_EPOCH', time.time()))
)
if isinstance(parser, argparse.ArgumentParser):
self._type = 'argparse'
if parser.formatter_class == argparse.HelpFormatter:
# Hack for issue #36, to have reproducible manual page content
# regardless the terminal window size. Long term we should avoid
# using the built-in usage formatter, and generate our own.
parser.formatter_class = \
lambda prog: argparse.HelpFormatter(prog, width=78)
else:
self._parser.formatter = ManPageFormatter()
self._parser.formatter.set_parser(self._parser)
def _markup(self, txt):
return txt.replace('-', '\\-')
def _write_header(self):
version = self.values["version"]
prog = self.values["prog"]
ret = []
ret.append('.TH %s 1 %s "%s v.%s"\n' % (self._markup(prog),
self._today.strftime('%Y\\-%m\\-%d'), prog, version))
description = self.values.get("description")
if description:
name = self._markup('%s - %s' % (prog, description.splitlines()[0]))
else:
name = self._markup(prog)
ret.append('.SH NAME\n%s\n' % name)
if getattr(self._parser, 'format_usage', None):
synopsis = self._parser.format_usage()
else:
synopsis = self._parser.get_usage()
if synopsis:
synopsis = synopsis.replace('%s ' % prog, '')
ret.append('.SH SYNOPSIS\n.B %s\n%s\n' % (self._markup(prog),
synopsis))
long_desc = self.values.get("long_description", "")
if long_desc:
ret.append('.SH DESCRIPTION\n%s\n' % self._markup(long_desc))
return ''.join(ret)
def _write_options(self, action_name=None, parser=None):
if not parser:
parser = self._parser
if not action_name:
ret = ['.SH OPTIONS\n']
else:
ret = ['.SH OPTIONS ' + action_name.upper() + '\n']
ret.append(parser.format_option_help())
if self._type != 'argparse':
return ''.join(ret)
subparsers_actions = [
action for action in parser._actions
if isinstance(action, argparse._SubParsersAction)]
for subparser_action in subparsers_actions:
for name, obj in subparser_action.choices.items():
if action_name:
an = action_name + " " + name
else:
an = name
ret.append(self._write_options(an, obj))
return ''.join(ret)
def _write_seealso(self, text):
ret = []
ret.append('.SH "SEE ALSO"\n')
for i in text:
name, sect = i.split(":")
if len(ret) > 1:
ret.append(',\n')
ret.append('.BR %s (%s)' % (name, sect))
return ''.join(ret)
def write(self, filename, seealso=None):
manpage = []
manpage.append(self._write_header())
manpage.append(self._write_options())
manpage.append(get_footer(self.values))
if seealso:
manpage.append(self._write_seealso(seealso))
write_to_filename(''.join(manpage), filename)
class build_manpage(Command):
description = 'Generate man page from setup().'
user_options = [
('output=', 'O', 'output file'),
('parser=', None, 'module path to optparser (e.g. mymod:func'),
('parser-file=', None, 'file to the parser module'),
('file-and-object=', None, 'import parser object from file, e.g. "bin/blah.py:fooparser"'),
('seealso=', None, 'list of manpages to put into the SEE ALSO section (e.g. bash:1)')
]
def initialize_options(self):
self.output = None
self.parser = None
self.seealso = None
self.parser_file = None
self.file_and_object = None
def _get_parser_from_module(self):
mod_name, func_name = self.parser.split(':')
if self.parser_file:
# The 'modname' is entirely ignored in this case. This is a design
# issue from 516ca12512979ab8e1a45f24e502a9cd1331f284. But we keep
# the 'build_manpage' for compatibility reasons.
return get_parser_from_file(self.parser_file, func_name,
'function')
return get_parser_from_module(mod_name, func_name, 'function')
def finalize_options(self):
if self.output is None:
raise DistutilsOptionError('\'output\' option is required')
if self.parser is None and self.file_and_object is None:
raise DistutilsOptionError('\'parser\' or \'file-and-object\' option is required')
self.ensure_string_list('seealso')
if self.file_and_object:
filename, objname = self.file_and_object.split(':')
self._parser = get_parser_from_file(filename, objname)
else:
self._parser = self._get_parser_from_module()
def run(self):
self.announce('Writing man page %s' % self.output)
data = {}
get_manpage_data_from_distribution(self.distribution, data)
# the format is actually unused
mpw = ManPageWriter(self._parser, data)
mpw.write(self.output, seealso=self.seealso)
class ManPageFormatter(optparse.HelpFormatter):
def __init__(self,
indent_increment=2,
max_help_position=24,
width=None,
short_first=1):
optparse.HelpFormatter.__init__(self, indent_increment,
max_help_position, width, short_first)
def _markup(self, txt):
return txt.replace('-', '\\-')
def format_usage(self, usage):
return self._markup(usage)
def format_heading(self, heading):
if self.level == 0:
return ''
return '.TP\n%s\n' % self._markup(heading.upper())
def format_option(self, option):
result = []
opts = self.option_strings[option]
result.append('.TP\n.B %s\n' % self._markup(opts))
if option.help:
help_text = '%s\n' % self._markup(self.expand_default(option))
result.append(help_text)
return ''.join(result)
|
