Repository navigation
Expand file tree
/
Copy pathdescribe.py
More file actions
567 lines (469 loc) 路 15.6 KB
/
Copy pathdescribe.py
File metadata and controls
567 lines (469 loc) 路 15.6 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
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
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
#!/usr/bin/python
#
# Copyright 2014 Google Inc. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Create documentation for generate API surfaces.
Command-line tool that creates documentation for all APIs listed in discovery.
The documentation is generated from a combination of the discovery document and
the generated API surface itself.
"""
from __future__ import print_function
__author__ = "jcgregorio@google.com (Joe Gregorio)"
import argparse
import collections
import json
import pathlib
import re
import string
import sys
import uritemplate
from googleapiclient.discovery import DISCOVERY_URI, build_from_document
from googleapiclient.http import build_http
DISCOVERY_DOC_DIR = (
pathlib.Path(__file__).resolve().parent
/ "googleapiclient"
/ "discovery_cache"
/ "documents"
)
CSS = """<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
"""
METHOD_TEMPLATE = """<div class="method">
<code class="details" id="$name">$name($params)</code>
<pre>$doc</pre>
</div>
"""
COLLECTION_LINK = """<p class="toc_element">
<code><a href="$href">$name()</a></code>
</p>
<p class="firstline">Returns the $name Resource.</p>
"""
METHOD_LINK = """<p class="toc_element">
<code><a href="#$name">$name($params)</a></code></p>
<p class="firstline">$firstline</p>"""
BASE = pathlib.Path(__file__).resolve().parent / "docs" / "dyn"
# Obtain the discovery index and artifacts from googleapis/discovery-artifact-manager
DIRECTORY_URI = "https://raw.githubusercontent.com/googleapis/discovery-artifact-manager/master/discoveries/index.json"
DISCOVERY_URI_TEMPLATE = "https://raw.githubusercontent.com/googleapis/discovery-artifact-manager/master/discoveries/{api}.{apiVersion}.json"
parser = argparse.ArgumentParser(description=__doc__)
parser.add_argument(
"--discovery_uri_template",
default=DISCOVERY_URI_TEMPLATE,
help="URI Template for discovery.",
)
parser.add_argument(
"--discovery_uri",
default="",
help=(
"URI of discovery document. If supplied then only "
"this API will be documented."
),
)
parser.add_argument(
"--directory_uri",
default=DIRECTORY_URI,
help=("URI of directory document. Unused if --discovery_uri" " is supplied."),
)
parser.add_argument(
"--dest", default=BASE, help="Directory name to write documents into."
)
def safe_version(version):
"""Create a safe version of the verion string.
Needed so that we can distinguish between versions
and sub-collections in URIs. I.e. we don't want
adsense_v1.1 to refer to the '1' collection in the v1
version of the adsense api.
Args:
version: string, The version string.
Returns:
The string with '.' replaced with '_'.
"""
return version.replace(".", "_")
def unsafe_version(version):
"""Undoes what safe_version() does.
See safe_version() for the details.
Args:
version: string, The safe version string.
Returns:
The string with '_' replaced with '.'.
"""
return version.replace("_", ".")
def method_params(doc):
"""Document the parameters of a method.
Args:
doc: string, The method's docstring.
Returns:
The method signature as a string.
"""
doclines = doc.splitlines()
if "Args:" in doclines:
begin = doclines.index("Args:")
if "Returns:" in doclines[begin + 1 :]:
end = doclines.index("Returns:", begin)
args = doclines[begin + 1 : end]
else:
args = doclines[begin + 1 :]
parameters = []
sorted_parameters = []
pname = None
desc = ""
def add_param(pname, desc):
if pname is None:
return
if "(required)" not in desc:
pname = pname + "=None"
parameters.append(pname)
else:
# required params should be put straight into sorted_parameters
# to maintain order for positional args
sorted_parameters.append(pname)
for line in args:
m = re.search(r"^\s+([a-zA-Z0-9_]+): (.*)", line)
if m is None:
desc += line
continue
add_param(pname, desc)
pname = m.group(1)
desc = m.group(2)
add_param(pname, desc)
sorted_parameters.extend(sorted(parameters))
sorted_parameters = ", ".join(sorted_parameters)
else:
sorted_parameters = ""
return sorted_parameters
def method(name, doc):
"""Documents an individual method.
Args:
name: string, Name of the method.
doc: string, The methods docstring.
"""
import html
params = method_params(doc)
doc = html.escape(doc)
return string.Template(METHOD_TEMPLATE).substitute(
name=name, params=params, doc=doc
)
def breadcrumbs(path, root_discovery):
"""Create the breadcrumb trail to this page of documentation.
Args:
path: string, Dot separated name of the resource.
root_discovery: Deserialized discovery document.
Returns:
HTML with links to each of the parent resources of this resource.
"""
parts = path.split(".")
crumbs = []
accumulated = []
for i, p in enumerate(parts):
prefix = ".".join(accumulated)
# The first time through prefix will be [], so we avoid adding in a
# superfluous '.' to prefix.
if prefix:
prefix += "."
display = p
if i == 0:
display = root_discovery.get("title", display)
crumbs.append('<a href="{}.html">{}</a>'.format(prefix + p, display))
accumulated.append(p)
return " . ".join(crumbs)
def document_collection(resource, path, root_discovery, discovery, css=CSS):
"""Document a single collection in an API.
Args:
resource: Collection or service being documented.
path: string, Dot separated name of the resource.
root_discovery: Deserialized discovery document.
discovery: Deserialized discovery document, but just the portion that
describes the resource.
css: string, The CSS to include in the generated file.
"""
collections = []
methods = []
resource_name = path.split(".")[-2]
html = [
"<html><body>",
css,
"<h1>%s</h1>" % breadcrumbs(path[:-1], root_discovery),
"<h2>Instance Methods</h2>",
]
# Which methods are for collections.
for name in dir(resource):
if not name.startswith("_") and callable(getattr(resource, name)):
if hasattr(getattr(resource, name), "__is_resource__"):
collections.append(name)
else:
methods.append(name)
# TOC
if collections:
for name in collections:
if not name.startswith("_") and callable(getattr(resource, name)):
href = path + name + ".html"
html.append(
string.Template(COLLECTION_LINK).substitute(href=href, name=name)
)
if methods:
for name in methods:
if not name.startswith("_") and callable(getattr(resource, name)):
doc = getattr(resource, name).__doc__
params = method_params(doc)
firstline = doc.splitlines()[0]
html.append(
string.Template(METHOD_LINK).substitute(
name=name, params=params, firstline=firstline
)
)
if methods:
html.append("<h3>Method Details</h3>")
for name in methods:
dname = name.rsplit("_")[0]
html.append(method(name, getattr(resource, name).__doc__))
html.append("</body></html>")
return "\n".join(html)
def document_collection_recursive(
resource,
path,
root_discovery,
discovery,
doc_destination_dir,
artifact_destination_dir=DISCOVERY_DOC_DIR,
):
html = document_collection(resource, path, root_discovery, discovery)
f = open(pathlib.Path(doc_destination_dir).joinpath(path + "html"), "w")
f.write(html)
f.close()
for name in dir(resource):
if (
not name.startswith("_")
and callable(getattr(resource, name))
and hasattr(getattr(resource, name), "__is_resource__")
and discovery != {}
):
dname = name.rsplit("_")[0]
collection = getattr(resource, name)()
document_collection_recursive(
collection,
path + name + ".",
root_discovery,
discovery["resources"].get(dname, {}),
doc_destination_dir,
artifact_destination_dir,
)
def document_api(
name,
version,
uri,
doc_destination_dir,
artifact_destination_dir=DISCOVERY_DOC_DIR,
):
"""Document the given API.
Args:
name (str): Name of the API.
version (str): Version of the API.
uri (str): URI of the API's discovery document
doc_destination_dir (str): relative path where the reference
documentation should be saved.
artifact_destination_dir (Optional[str]): relative path where the discovery
artifacts should be saved.
"""
http = build_http()
resp, content = http.request(uri)
if resp.status == 200:
discovery = json.loads(content)
service = build_from_document(discovery)
doc_name = "{}.{}.json".format(name, version)
discovery_file_path = artifact_destination_dir / doc_name
revision = None
pathlib.Path(discovery_file_path).touch(exist_ok=True)
# Write discovery artifact to disk if revision equal or newer
with open(discovery_file_path, "r+") as f:
try:
json_data = json.load(f)
revision = json_data["revision"]
except json.JSONDecodeError:
revision = None
if revision is None or discovery["revision"] >= revision:
# Reset position to the beginning
f.seek(0)
# Write the changes to disk
json.dump(discovery, f, indent=0, sort_keys=True)
# Truncate anything left as it's not needed
f.truncate()
elif resp.status == 404:
print(
"Warning: {} {} not found. HTTP Code: {}".format(name, version, resp.status)
)
return
else:
print(
"Warning: {} {} could not be built. HTTP Code: {}".format(
name, version, resp.status
)
)
return
document_collection_recursive(
service,
"{}_{}.".format(name, safe_version(version)),
discovery,
discovery,
doc_destination_dir,
artifact_destination_dir,
)
def document_api_from_discovery_document(
discovery_url, doc_destination_dir, artifact_destination_dir=DISCOVERY_DOC_DIR
):
"""Document the given API.
Args:
discovery_url (str): URI of discovery document.
doc_destination_dir (str): relative path where the reference
documentation should be saved.
artifact_destination_dir (str): relative path where the discovery
artifacts should be saved.
"""
http = build_http()
response, content = http.request(discovery_url)
discovery = json.loads(content)
service = build_from_document(discovery)
name = discovery["version"]
version = safe_version(discovery["version"])
document_collection_recursive(
service,
"{}_{}.".format(name, version),
discovery,
discovery,
doc_destination_dir,
artifact_destination_dir,
)
def generate_all_api_documents(
directory_uri=DIRECTORY_URI,
doc_destination_dir=BASE,
artifact_destination_dir=DISCOVERY_DOC_DIR,
discovery_uri_template=DISCOVERY_URI_TEMPLATE,
):
"""Retrieve discovery artifacts and fetch reference documentations
for all apis listed in the public discovery directory.
args:
directory_uri (Optional[str]): uri of the public discovery directory.
doc_destination_dir (Optional[str]): relative path where the reference
documentation should be saved.
artifact_destination_dir (Optional[str]): relative path where the discovery
artifacts should be saved.
discovery_uri_template (Optional[str]): URI template of the API's discovery
document.
"""
api_directory = collections.defaultdict(list)
http = build_http()
resp, content = http.request(directory_uri)
if resp.status == 200:
directory = json.loads(content)["items"]
for api in directory:
uri = uritemplate.expand(
discovery_uri_template or api["discoveryRestUrl"],
{"api": api["name"], "apiVersion": api["version"]},
)
document_api(
api["name"],
api["version"],
uri,
doc_destination_dir,
artifact_destination_dir,
)
api_directory[api["name"]].append(api["version"])
# sort by api name and version number
for api in api_directory:
api_directory[api] = sorted(api_directory[api])
api_directory = collections.OrderedDict(
sorted(api_directory.items(), key=lambda x: x[0])
)
markdown = []
for api, versions in api_directory.items():
markdown.append("## %s" % api)
for version in versions:
markdown.append(
"* [%s](http://googleapis.github.io/google-api-python-client/docs/dyn/%s_%s.html)"
% (version, api, safe_version(version))
)
markdown.append("\n")
with open(doc_destination_dir / "index.md", "w") as f:
markdown = "\n".join(markdown)
f.write(markdown)
else:
sys.exit("Failed to load the discovery document.")
if __name__ == "__main__":
FLAGS = parser.parse_args(sys.argv[1:])
if FLAGS.discovery_uri:
document_api_from_discovery_document(
discovery_url=FLAGS.discovery_uri,
doc_destination_dir=FLAGS.dest,
)
else:
generate_all_api_documents(
directory_uri=FLAGS.directory_uri,
doc_destination_dir=FLAGS.dest,
discovery_uri_template=FLAGS.discovery_uri_template,
)