/
generator.py
413 lines (319 loc) · 11.7 KB
/
generator.py
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
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
import glob
import json
import logging
import operator
import os
import os.path
import pickle
import re
import shutil
import subprocess
import sys
import tarfile
import urllib2
import xml.etree.ElementTree
import zipfile
import zlib
class GeneratorError(Exception):
pass
class Generator(object):
OUTPUT_DATA = "appengine/static/data/%s-%s.js"
OUTPUT_ZIP = "appengine/%s.zip"
EPYDOC_MAGIC = "@@BABBLEDRIVE_NAMEVERSION@@"
SPHINX_V2_MARKER = "# Sphinx inventory version 2"
SPHINX_ZLIB_MARKER = "# The remainder of this file is compressed using zlib.\n"
TYPES = {
# Sphinx version 1
"mod": 0,
"class": 1,
"exception": 2,
"ctype": 3,
"cmacro": 4,
"classmethod": 5,
"function": 6,
"method": 7,
"cfunction": 8,
"data": 9,
"attribute": 10,
"cvar": 11,
"cmember": 12,
# Sphinx version 2
"py:module": 0,
"py:class": 1,
"py:exception": 2,
"py:staticmethod": 5,
"py:classmethod": 5,
"py:function": 6,
"py:method": 7,
"py:data": 9,
"py:attribute": 10,
}
PYDOCTOR_TYPES = {
"Package": 0,
"Module": 0,
"Class": 1,
"Interface": 1,
"Class Method": 5,
"Static Method": 5,
"Function": 6,
"Method": 7,
"Attribute": 10,
}
# Set by main.py
OPTIONS = None
def __init__(self, name, version):
self.name = name
self.version = version
self.logger = logging.getLogger("generator.%s-%s" % (name, version))
self.cwd = os.path.dirname(__file__)
# Get the environment
self._env = dict(os.environ)
path = self._env.get("PATH", "").split(":")
pythonpath = self._env.get("PYTHONPATH", "").split(":")
# Add epydoc paths to the environment
epydoc = os.path.join(self.cwd, "generator-epydoc")
path.insert(0, os.path.join(epydoc, "scripts"))
pythonpath.insert(0, epydoc)
# Add pydoctor paths to the environment
pydoctor = os.path.join(self.cwd, "generator-pydoctor")
path.insert(0, os.path.join(pydoctor, "bin"))
pythonpath.insert(0, pydoctor)
self._env["PATH"] = ":".join(path)
self._env["PYTHONPATH"] = ":".join(pythonpath)
# pydoctor goes on our own pythonpath too
sys.path.insert(0, pydoctor)
# Create the downloads directory
self.downloads = os.path.join(self.cwd, "_downloads")
# Create the working directory for this package
self.work = os.path.join(self.cwd, "_work/%s-%s" % (name, version))
if os.path.exists(self.work):
shutil.rmtree(self.work)
os.makedirs(self.work)
# Output directories
self.safe_name = "%s_%s" % (name, version)
for bad_char in "-.":
self.safe_name = self.safe_name.replace(bad_char, "_")
self.output_data = os.path.join(self.cwd, self.OUTPUT_DATA % (name, version))
self.output_zip = os.path.join(self.cwd, self.OUTPUT_ZIP % self.safe_name)
def AdjustSphinxConf(self, filename):
contents = open(filename).read()
contents += '\nhtml_theme="sphinx-theme"' + \
'\nhtml_theme_path=["%s"]\n' % \
os.path.join(self.cwd, "generator-sphinx")
contents = re.sub(r'html_use_opensearch .*', '', contents)
open(filename, 'w').write(contents)
def DownloadSource(self, url):
self.logger.info("downloading %s" % url)
opener = urllib2.build_opener(urllib2.HTTPRedirectHandler())
handle = opener.open(url)
actual_url = handle.geturl()
filename = actual_url[actual_url.rindex("/")+1:]
path = os.path.join(self.downloads, filename)
if not os.path.exists(self.downloads):
os.makedirs(self.downloads)
if os.path.exists(path):
self.logger.info("already exists, not redownloading %s" % path)
else:
self.logger.info("saving %s" % path)
open(path, 'w').write(handle.read())
handle.close()
return path
def CloneMecurial(self, url, tag=None):
self.Run(["hg", "clone", url, self.work])
if tag is not None:
self.Run(["hg", "checkout", tag], cwd=self.work)
return self.work
def ExtractSource(self, path):
self.logger.info("extracting %s" % path)
tar = tarfile.open(path)
directory = tar.getnames()[0].split('/')[0]
tar.extractall(self.work)
tar.close()
return os.path.join(self.work, directory)
def Run(self, args, **kwargs):
self.logger.info("running %s" % " ".join(args))
kwargs.update({
"env": self._env,
})
if not self.OPTIONS.verbose:
kwargs.update({
"stdout": subprocess.PIPE,
"stderr": subprocess.STDOUT,
})
handle = subprocess.Popen(args, **kwargs)
stdout = handle.communicate()[0]
if handle.returncode != 0:
if not self.OPTIONS.verbose:
print >> sys.stderr, stdout
raise GeneratorError("Command '%s' exited with status %d" % (
args[0], handle.returncode))
def RunPydoctor(self, project_name, project_url, packages, system_class=None,
html_viewsource_base=None, **kwargs):
args = ["pydoctor",
"--project-name", project_name,
"--project-url", project_url,
"--html-output", "babbledrive-apidocs",
"--project-base-dir", kwargs["cwd"],
"--output-pickle", "babbledrive-pickle",
"--quiet", "--make-html",
]
for package in packages:
args += ["--add-package", package]
if system_class is not None:
args += ["--system-class", system_class]
if html_viewsource_base is not None:
args += ["--html-viewsource-base", html_viewsource_base]
self.Run(args, **kwargs)
def TakeEpydocOutput(self, path):
self.logger.info("taking epydoc output from %s" % path)
babbledrive_data = os.path.join(path, "babbledrive-data.js")
if not os.path.exists(babbledrive_data):
raise GeneratorError("The generated file '%s' was not found" % babbledrive_data)
# Replace the magic string in the babbledrive data file
data = open(babbledrive_data).read()
data = data.replace(self.EPYDOC_MAGIC, "%s-%s" % (self.name, self.version))
open(babbledrive_data, 'w').write(data)
# Replace references to epydoc.css or epydoc.js in the html files
for filename in glob.glob(os.path.join(path, "*.html")):
data = open(filename).read()
data = re.sub(r'(epydoc.(css|js))', r'../../\1', data)
data = re.sub(r'(crarr.png)', r'../../images/\1', data)
open(filename, 'w').write(data)
# Remove shared files
for filename in ["epydoc.css", "epydoc.js", "crarr.png"]:
filepath = os.path.join(path, filename)
if os.path.exists(filepath):
os.remove(filepath)
self._RemoveOldOutput()
self._TakeData(babbledrive_data)
self._TakeDocs(path)
def _RemoveOldOutput(self):
self.logger.info("removing old data")
if os.path.exists(self.output_data):
os.remove(self.output_data)
if os.path.exists(self.output_zip):
os.remove(self.output_zip)
def _TakeData(self, path):
self.logger.info("installing %s" % self.output_data)
shutil.move(path, self.output_data)
def _TakeDocs(self, path):
self.logger.info("archiving %s to %s" % (path, self.output_zip))
output = zipfile.ZipFile(self.output_zip, 'w', zipfile.ZIP_DEFLATED)
for dirpath, dirnames, filenames in os.walk(path):
for filename in filenames:
filepath = os.path.join(dirpath, filename)
relpath = os.path.relpath(filepath, path)
output.write(filepath, relpath)
output.close()
def TakeSphinxOutput(self, path):
self.logger.info("taking sphinx output from %s" % path)
objects_inv = os.path.join(path, "objects.inv")
if not os.path.exists(objects_inv):
raise GeneratorError("The generated file '%s' was not found" % objects_inv)
# Process the objects.inv file
data = open(objects_inv).read()
items = []
is_v2 = self.SPHINX_V2_MARKER in data
# Decompress the data inside if it's compressed
if self.SPHINX_ZLIB_MARKER in data:
start = data.index(self.SPHINX_ZLIB_MARKER) + len(self.SPHINX_ZLIB_MARKER)
data = zlib.decompress(data[start:])
# Process each line
for line in data.split("\n"):
line = line.strip()
if not line or line.startswith("#") or " std:" in line:
continue
fields = line.split(" ")
name = fields[0]
# Map the type to a number
try:
type_index = self.TYPES[fields[1]]
except KeyError:
raise GeneratorError("Unknown sphinx type '%s' in line '%s'" % (
fields[1], line))
if type_index is None:
# Ignore this line
continue
# Get a destination URL
if not is_v2:
if fields[1] == "mod":
destination = "%s#module-%s" % (fields[2], name)
else:
destination = "%s#%s" % (fields[2], name)
else:
destination = fields[3].replace('$', name)
# Add the item to the list
items.append([name.lower(), name, type_index, destination])
# Sort the list by name
items = sorted(items, key=operator.itemgetter(0))
self._RemoveOldOutput()
self._TakeDocs(path)
# Write out the data file
self.logger.info("installing %s" % self.output_data)
output_file = open(self.output_data, 'w')
output_file.write('library.register_package_data("%s-%s",%s);' % (
self.name, self.version, json.dumps(items, separators=(',', ':'))))
output_file.close()
def TakePydoctorOutput(self, path):
self.logger.info("taking pydoctor output from %s" % path)
pickle_path = os.path.join(path, "babbledrive-pickle")
html_path = os.path.join(path, "babbledrive-apidocs")
system = pickle.load(open(pickle_path))
items = []
for o in system.allobjects.values():
name = o.fullName()
type_index = self.PYDOCTOR_TYPES[o.kind]
if o.kind == "Class" and "Exception" in o.bases:
type_index = 2
if o.kind in ["Method", "Function"]:
url = "%s.html#%s" % (o.parent.fullName(), o.name)
else:
url = "%s.html" % name
items.append([name.lower(), name, type_index, url])
# Sort the list by name
items = sorted(items, key=operator.itemgetter(0))
self._RemoveOldOutput()
self._TakeDocs(html_path)
# Write out the data file
self.logger.info("installing %s" % self.output_data)
output_file = open(self.output_data, 'w')
output_file.write('library.register_package_data("%s-%s",%s);' % (
self.name, self.version, json.dumps(items, separators=(',', ':'))))
output_file.close()
def TakeDevhelpOutput(self, path):
self.logger.info("taking devhelp output from %s" % path)
index_path = glob.glob(os.path.join(path, "*.devhelp"))[0]
tree = xml.etree.ElementTree.parse(index_path)
items = []
for element in tree.getiterator():
if not element.tag.endswith("sub") and not element.tag.endswith("function"):
continue
name = element.get("name")
link = element.get("link")
if name is None or link is None or " " in name or "." not in name:
continue
if "#method-" in link or "#constructor-" in link:
type_index = 7
elif "#function-" in link:
type_index = 6
elif "#" not in link:
type_index = 1
else:
raise GeneratorError("Unknown devhelp type in link '%s'" % link)
print link
items.append([name.lower(), name, type_index, link])
# Sort the list by name
items = sorted(items, key=operator.itemgetter(0))
# Copy the css file
shutil.copy(os.path.join(path, "../style.css"),
os.path.join(path, "style.css"))
self._RemoveOldOutput()
self._TakeDocs(path)
# Write out the data file
self.logger.info("installing %s" % self.output_data)
output_file = open(self.output_data, 'w')
output_file.write('library.register_package_data("%s-%s",%s);' % (
self.name, self.version, json.dumps(items, separators=(',', ':'))))
output_file.close()
def Generate(self):
raise NotImplementedError()