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
|
import re
from sphinx.util.compat import Directive
from docutils.statemachine import StringList
from docutils import nodes
import textwrap
import itertools
import collections
def _comma_list(text):
return re.split(r"\s*,\s*", text.strip())
def _parse_content(content):
d = {}
d['text'] = []
idx = 0
for line in content:
idx += 1
m = re.match(r' *\:(.+?)\:(?: +(.+))?', line)
if m:
attrname, value = m.group(1, 2)
d[attrname] = value or ''
else:
break
d["text"] = content[idx:]
return d
class EnvDirective(object):
@property
def env(self):
return self.state.document.settings.env
class ChangeLogDirective(EnvDirective, Directive):
has_content = True
type_ = "change"
default_section = 'misc'
def _organize_by_section(self, changes):
compound_sections = [(s, s.split(" ")) for s in
self.sections if " " in s]
bysection = collections.defaultdict(list)
all_sections = set()
for rec in changes:
inner_tag = rec['tags'].intersection(self.inner_tag_sort)
if inner_tag:
inner_tag = inner_tag.pop()
else:
inner_tag = ""
for compound, comp_words in compound_sections:
if rec['tags'].issuperset(comp_words):
bysection[(compound, inner_tag)].append(rec)
all_sections.add(compound)
break
intersect = rec['tags'].intersection(self.sections)
if intersect:
sec = intersect.pop()
bysection[(sec, inner_tag)].append(rec)
all_sections.add(sec)
continue
bysection[(self.default_section, inner_tag)].append(rec)
return bysection, all_sections
@classmethod
def changes(cls, env):
return env.temp_data['ChangeLogDirective_%s_changes' % cls.type_]
def _setup_run(self):
self.sections = self.env.config.changelog_sections
self.inner_tag_sort = self.env.config.changelog_inner_tag_sort + [""]
self.env.temp_data['ChangeLogDirective_%s_changes' % self.type_] = []
self._parsed_content = _parse_content(self.content)
p = nodes.paragraph('', '',)
self.state.nested_parse(self.content[1:], 0, p)
def run(self):
self._setup_run()
changes = self.changes(self.env)
output = []
version = self._parsed_content.get('version', '')
id_prefix = "%s-%s" % (self.type_, version)
topsection = self._run_top(id_prefix)
output.append(topsection)
bysection, all_sections = self._organize_by_section(changes)
counter = itertools.count()
sections_to_render = [s for s in self.sections if s in all_sections]
if not sections_to_render:
for cat in self.inner_tag_sort:
append_sec = self._append_node()
for rec in bysection[(self.default_section, cat)]:
rec["id"] = "%s-%s" % (id_prefix, next(counter))
self._render_rec(rec, None, cat, append_sec)
if append_sec.children:
topsection.append(append_sec)
else:
for section in sections_to_render + [self.default_section]:
sec = nodes.section('',
nodes.title(section, section),
ids=["%s-%s" % (id_prefix, section.replace(" ", "-"))]
)
append_sec = self._append_node()
sec.append(append_sec)
for cat in self.inner_tag_sort:
for rec in bysection[(section, cat)]:
rec["id"] = "%s-%s" % (id_prefix, next(counter))
self._render_rec(rec, section, cat, append_sec)
if append_sec.children:
topsection.append(sec)
return output
def _append_node(self):
return nodes.bullet_list()
def _run_top(self, id_prefix):
version = self._parsed_content.get('version', '')
topsection = nodes.section('',
nodes.title(version, version),
ids=[id_prefix]
)
if self._parsed_content.get("released"):
topsection.append(nodes.Text("Released: %s" %
self._parsed_content['released']))
else:
topsection.append(nodes.Text("no release date"))
return topsection
def _render_rec(self, rec, section, cat, append_sec):
para = rec['node'].deepcopy()
insert_ticket = nodes.paragraph('')
para.append(insert_ticket)
for i, ticket in enumerate(rec['tickets']):
if i > 0:
insert_ticket.append(nodes.Text(", ", ", "))
else:
insert_ticket.append(nodes.Text(" ", " "))
refuri = self.env.config.changelog_render_ticket
if refuri is not None:
refuri = refuri % ticket
insert_ticket.append(
nodes.reference('', '',
nodes.Text("#%s" % ticket, "#%s" % ticket),
refuri=refuri
)
)
else:
insert_ticket.append(
nodes.Text("#%s" % ticket, "#%s" % ticket)
)
if rec['tags']:
tag_node = nodes.strong('',
" ".join("[%s]" % t for t
in
[t1 for t1 in [section, cat]
if t1 in rec['tags']] +
list(rec['tags'].difference([section, cat]))
) + " "
)
para.children[0].insert(0, tag_node)
append_sec.append(
nodes.list_item('',
nodes.target('', '', ids=[rec['id']]),
para
)
)
class ChangeDirective(EnvDirective, Directive):
has_content = True
type_ = "change"
parent_cls = ChangeLogDirective
def run(self):
content = _parse_content(self.content)
p = nodes.paragraph('', '',)
rec = {
'tags': set(_comma_list(content.get('tags', ''))).difference(['']),
'tickets': set(_comma_list(content.get('tickets', ''))).difference(['']),
'node': p,
'type': self.type_,
"title": content.get("title", None)
}
if "declarative" in rec['tags']:
rec['tags'].add("orm")
self.state.nested_parse(content['text'], 0, p)
self.parent_cls.changes(self.env).append(rec)
return []
def _rst2sphinx(text):
return StringList(
[line.strip() for line in textwrap.dedent(text).split("\n")]
)
def setup(app):
app.add_directive('changelog', ChangeLogDirective)
app.add_directive('change', ChangeDirective)
app.add_config_value("changelog_sections", [], 'env')
app.add_config_value("changelog_inner_tag_sort", [], 'env')
app.add_config_value("changelog_render_ticket",
None,
'env'
)
|
