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
|
"""
sphinxcontrib.autohttp.bottle
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The sphinx.ext.autodoc-style HTTP API reference builder (from Bottle)
for sphinxcontrib.httpdomain.
:copyright: Copyright 2012 by Jameel Al-Aziz
:license: BSD, see LICENSE for details.
"""
import re
import six
from docutils import nodes
from docutils.parsers.rst import directives
from docutils.statemachine import ViewList
from sphinx.util import force_decode
from sphinx.util.compat import Directive
from sphinx.util.nodes import nested_parse_with_titles
from sphinx.util.docstrings import prepare_docstring
from sphinx.pycode import ModuleAnalyzer
from sphinxcontrib import httpdomain
from sphinxcontrib.autohttp.common import http_directive, import_object
def translate_bottle_rule(app, rule):
buf = six.StringIO()
if hasattr(app.router, "parse_rule"):
iterator = app.router.parse_rule(rule) # bottle 0.11
else:
iterator = app.router._itertokens(rule) # bottle 0.12
for name, filter, conf in iterator:
if filter:
buf.write('(')
buf.write(name)
if (filter != app.router.default_filter and filter != 'default')\
or conf:
buf.write(':')
buf.write(filter)
if conf:
buf.write(':')
buf.write(conf)
buf.write(')')
else:
buf.write(name)
return buf.getvalue()
def get_routes(app):
for route in app.routes:
path = translate_bottle_rule(app, route.rule)
yield route.method, path, route
class AutobottleDirective(Directive):
has_content = True
required_arguments = 1
option_spec = {'endpoints': directives.unchanged,
'undoc-endpoints': directives.unchanged,
'include-empty-docstring': directives.unchanged}
@property
def endpoints(self):
endpoints = self.options.get('endpoints', None)
if not endpoints:
return None
return frozenset(re.split(r'\s*,\s*', endpoints))
@property
def undoc_endpoints(self):
undoc_endpoints = self.options.get('undoc-endpoints', None)
if not undoc_endpoints:
return frozenset()
return frozenset(re.split(r'\s*,\s*', undoc_endpoints))
def make_rst(self):
app = import_object(self.arguments[0])
for method, path, target in get_routes(app):
endpoint = target.name or target.callback.__name__
if self.endpoints and endpoint not in self.endpoints:
continue
if endpoint in self.undoc_endpoints:
continue
view = target.callback
docstring = view.__doc__ or ''
if not isinstance(docstring, six.text_type):
analyzer = ModuleAnalyzer.for_module(view.__module__)
docstring = force_decode(docstring, analyzer.encoding)
if not docstring and 'include-empty-docstring' not in self.options:
continue
docstring = prepare_docstring(docstring)
for line in http_directive(method, path, docstring):
yield line
def run(self):
node = nodes.section()
node.document = self.state.document
result = ViewList()
for line in self.make_rst():
result.append(line, '<autobottle>')
nested_parse_with_titles(self.state, result, node)
return node.children
def setup(app):
if 'http' not in app.domains:
httpdomain.setup(app)
app.add_directive('autobottle', AutobottleDirective)
|
