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
|
#
# Generates the dynamic parts of the ZeekControl documentation.
#
import inspect
def api(*deco_args):
if len(deco_args) == 1 and callable(deco_args[0]):
# No argument to decorator.
method = deco_args[0]
method._doc = ""
return method
else:
# Tag argument.
def _api(method):
method._doc = deco_args[0]
return method
return _api
def print_indented(text, level):
out = ""
if not isinstance(text, list):
text = text.splitlines()
for line in text:
out += "%s %s\n" % (" " * level, line)
out += "\n"
return out
# Prints API documentation for a class. Includes all methods tagged with
# @api(tag). (Use an unknown tag to not exclude all methods.) If header is
# False, the class's name and doc string is not included.
def print_class(cls, tag="", header=True):
out = ""
methods = {}
for (key, val) in cls.__dict__.items():
if not inspect.isfunction(val):
continue
if not "_doc" in val.__dict__:
continue
if val.__dict__["_doc"] == tag:
methods[key] = val
if header:
out += ".. _%s:\n\n" % cls.__name__
out += "Class ``%s``\n" % cls.__name__
out += "~~~~~~~~%s~~" % ("~" * len(cls.__name__))
out += "\n\n"
out += "class **%s**\n" % cls.__name__
out += print_indented(inspect.getdoc(cls), 1)
for name in sorted(methods.keys()):
func = methods[name]
args, varargs, keywords, defaults = inspect.getargspec(func)
out += print_indented(".. _%s.%s:" % (cls.__name__, name), 1)
out += print_indented("**%s** (%s)" % (name, ", ".join(args)), 1)
out += print_indented(inspect.getdoc(func), 2)
return out
|
