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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
|
#!/usr/bin/env python3
# $Id$
# Author: David Goodger <goodger@python.org>
# Copyright: This module has been placed in the public domain.
"""
Generates .html from all the .txt files in a directory.
Ordinary .txt files are understood to be standalone reStructuredText.
Files named ``pep-*.txt`` are interpreted as reStructuredText PEPs.
"""
# Once PySource is here, build .html from .py as well.
__docformat__ = 'reStructuredText'
try:
import locale
locale.setlocale(locale.LC_ALL, '')
except Exception:
pass
from fnmatch import fnmatch
import os
import os.path
import sys
import warnings
import docutils
import docutils.io
from docutils import core, frontend, utils, ApplicationError
from docutils.parsers import rst
from docutils.readers import standalone, pep
from docutils.writers import html4css1, html5_polyglot, pep_html
usage = '%prog [options] [<directory> ...]'
description = ('Generates .html from all the reStructuredText .txt files '
'(including PEPs) in each <directory> '
'(default is the current directory).')
class SettingsSpec(docutils.SettingsSpec):
"""
Runtime settings & command-line options for the "buildhtml" front end.
"""
prune_default = ['.hg', '.bzr', '.git', '.svn', 'CVS']
# Can't be included in OptionParser below because we don't want to
# override the base class.
settings_spec = (
'Build-HTML Options',
None,
(('Recursively scan subdirectories for files to process. This is '
'the default.',
['--recurse'],
{'action': 'store_true', 'default': 1,
'validator': frontend.validate_boolean}),
('Do not scan subdirectories for files to process.',
['--local'], {'dest': 'recurse', 'action': 'store_false'}),
('Do not process files in <directory> (shell globbing patterns, '
'separated by colons). This option may be used '
'more than once to specify multiple directories. Default: "%s".'
% ':'.join(prune_default),
['--prune'],
{'metavar': '<directory>', 'action': 'append',
'validator': frontend.validate_colon_separated_string_list,
'default': prune_default}),
('Recursively ignore files matching any of the given '
'wildcard (shell globbing) patterns (separated by colons).',
['--ignore'],
{'metavar': '<patterns>', 'action': 'append',
'default': [],
'validator': frontend.validate_colon_separated_string_list}),
('Docutils writer, one of "html", "html4", "html5". '
'Default: "html" (use Docutils\' default HTML writer).',
['--writer'],
{'metavar': '<writer>',
'choices': ['html', 'html4', 'html5'],
# 'default': 'html' (set below)
}),
(frontend.SUPPRESS_HELP, # Obsoleted by "--writer"
['--html-writer'],
{'metavar': '<writer>',
'choices': ['html', 'html4', 'html5']}),
('Work silently (no progress messages). Independent of "--quiet".',
['--silent'],
{'action': 'store_true', 'validator': frontend.validate_boolean}),
('Do not process files, show files that would be processed.',
['--dry-run'],
{'action': 'store_true', 'validator': frontend.validate_boolean}),))
relative_path_settings = ('prune',)
config_section = 'buildhtml application'
config_section_dependencies = ('applications',)
class OptionParser(frontend.OptionParser):
"""
Command-line option processing for the ``buildhtml.py`` front end.
"""
def check_values(self, values, args):
super().check_values(values, args)
values._source = None
return values
def check_args(self, args):
self.values._directories = args or [os.getcwd()]
# backwards compatibility:
return None, None
class Struct:
"""Stores data attributes for dotted-attribute access."""
def __init__(self, **keywordargs):
self.__dict__.update(keywordargs)
class Builder:
def __init__(self):
self.publishers = {
'': Struct(components=(pep.Reader, rst.Parser, pep_html.Writer,
SettingsSpec)),
'html4': Struct(components=(rst.Parser, standalone.Reader,
html4css1.Writer, SettingsSpec),
reader_name='standalone',
writer_name='html4'),
'html5': Struct(components=(rst.Parser, standalone.Reader,
html5_polyglot.Writer, SettingsSpec),
reader_name='standalone',
writer_name='html5'),
'PEPs': Struct(components=(rst.Parser, pep.Reader,
pep_html.Writer, SettingsSpec),
reader_name='pep',
writer_name='pep_html')}
"""Publisher-specific settings. Key '' is for the front-end script
itself. ``self.publishers[''].components`` must contain a superset of
all components used by individual publishers."""
self.setup_publishers()
# default html writer (may change to html5 some time):
self.publishers['html'] = self.publishers['html4']
def setup_publishers(self):
"""
Manage configurations for individual publishers.
Each publisher (combination of parser, reader, and writer) may have
its own configuration defaults, which must be kept separate from those
of the other publishers. Setting defaults are combined with the
config file settings and command-line options by
`self.get_settings()`.
"""
with warnings.catch_warnings():
warnings.filterwarnings('ignore', category=DeprecationWarning)
for name, publisher in self.publishers.items():
option_parser = OptionParser(
components=publisher.components, read_config_files=True,
usage=usage, description=description)
publisher.option_parser = option_parser
publisher.setting_defaults = option_parser.get_default_values()
frontend.make_paths_absolute(
publisher.setting_defaults.__dict__,
option_parser.relative_path_settings)
publisher.config_settings = (
option_parser.get_standard_config_settings())
self.settings_spec = self.publishers[''].option_parser.parse_args(
values=frontend.Values()) # no defaults; just the cmdline opts
self.initial_settings = self.get_settings('')
if self.initial_settings.html_writer is not None:
warnings.warn('The configuration setting "html_writer" '
'will be removed in Docutils 2.0. '
'Use setting "writer" instead.',
FutureWarning, stacklevel=5)
if self.initial_settings.writer is None:
self.initial_settings.writer = (self.initial_settings.html_writer
or 'html')
def get_settings(self, publisher_name, directory=None):
"""
Return a settings object, from multiple sources.
Copy the setting defaults, overlay the startup config file settings,
then the local config file settings, then the command-line options.
Assumes the current directory has been set.
"""
publisher = self.publishers[publisher_name]
with warnings.catch_warnings():
warnings.filterwarnings('ignore', category=DeprecationWarning)
settings = frontend.Values(publisher.setting_defaults.__dict__)
settings.update(publisher.config_settings, publisher.option_parser)
if directory:
local_config = publisher.option_parser.get_config_file_settings(
os.path.join(directory, 'docutils.conf'))
frontend.make_paths_absolute(
local_config, publisher.option_parser.relative_path_settings,
directory)
settings.update(local_config, publisher.option_parser)
settings.update(self.settings_spec.__dict__, publisher.option_parser)
return settings
def run(self, directory=None, recurse=1):
recurse = recurse and self.initial_settings.recurse
if directory:
self.directories = [directory]
elif self.settings_spec._directories:
self.directories = self.settings_spec._directories
else:
self.directories = [os.getcwd()]
for directory in self.directories:
for root, dirs, files in os.walk(directory):
# os.walk by default this recurses down the tree,
# influence by modifying dirs.
if not recurse:
del dirs[:]
self.visit(root, files, dirs)
def visit(self, directory, names, subdirectories):
settings = self.get_settings('', directory)
errout = docutils.io.ErrorOutput(encoding=settings.error_encoding)
if settings.prune and (os.path.abspath(directory) in settings.prune):
errout.write('/// ...Skipping directory (pruned): %s\n' %
directory)
sys.stderr.flush()
del subdirectories[:]
return
if not self.initial_settings.silent:
errout.write('/// Processing directory: %s\n' % directory)
sys.stderr.flush()
# settings.ignore grows many duplicate entries as we recurse
# if we add patterns in config files or on the command line.
for pattern in utils.uniq(settings.ignore):
for i in range(len(names) - 1, -1, -1):
if fnmatch(names[i], pattern):
# Modify in place!
del names[i]
for name in names:
if name.endswith('.txt'):
self.process_txt(directory, name)
def process_txt(self, directory, name):
if name.startswith('pep-'):
publisher = 'PEPs'
else:
publisher = self.initial_settings.writer
settings = self.get_settings(publisher, directory)
errout = docutils.io.ErrorOutput(encoding=settings.error_encoding)
pub_struct = self.publishers[publisher]
settings._source = os.path.normpath(os.path.join(directory, name))
settings._destination = settings._source[:-4] + '.html'
if not self.initial_settings.silent:
errout.write(' ::: Processing: %s\n' % name)
sys.stderr.flush()
if not settings.dry_run:
try:
core.publish_file(source_path=settings._source,
destination_path=settings._destination,
reader_name=pub_struct.reader_name,
parser_name='restructuredtext',
writer_name=pub_struct.writer_name,
settings=settings)
except ApplicationError as err:
errout.write(f' {type(err).__name__}: {err}\n')
if __name__ == "__main__":
Builder().run()
|
