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
|
#! coding: utf-8
import collections
import itertools
from docutils import nodes
def render_changelog(changelog_directive):
changes = changelog_directive.get_changes_list(
changelog_directive.env, changelog_directive.version
).values()
output = []
id_prefix = "change-%s" % (changelog_directive.version,)
topsection = _run_top(changelog_directive, id_prefix)
output.append(topsection)
bysection, all_sections = _organize_by_section(
changelog_directive, changes
)
counter = itertools.count()
sections_to_render = [
s for s in changelog_directive.sections if s in all_sections
]
if not sections_to_render:
for cat in changelog_directive.inner_tag_sort:
append_sec = _append_node(changelog_directive)
for rec in bysection[(changelog_directive.default_section, cat)]:
rec["id"] = "%s-%s" % (id_prefix, next(counter))
_render_rec(changelog_directive, rec, None, cat, append_sec)
if append_sec.children:
topsection.append(append_sec)
else:
for section in sections_to_render + [
changelog_directive.default_section
]:
sec = nodes.section(
"",
nodes.title(section, section),
ids=["%s-%s" % (id_prefix, section.replace(" ", "-"))],
)
append_sec = _append_node(changelog_directive)
sec.append(append_sec)
for cat in changelog_directive.inner_tag_sort:
for rec in bysection[(section, cat)]:
rec["id"] = "%s-%s" % (id_prefix, next(counter))
_render_rec(
changelog_directive, rec, section, cat, append_sec
)
if append_sec.children:
topsection.append(sec)
return output
def _organize_by_section(changelog_directive, changes):
compound_sections = [
(s, s.split(" ")) for s in changelog_directive.sections if " " in s
]
bysection = collections.defaultdict(list)
all_sections = set()
for rec in changes:
assert changelog_directive.version == rec["render_for_version"]
inner_tag = rec["tags"].intersection(
changelog_directive.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
else:
intersect = rec["tags"].intersection(changelog_directive.sections)
if intersect:
for sec in rec["sorted_tags"]:
if sec in intersect:
bysection[(sec, inner_tag)].append(rec)
all_sections.add(sec)
break
else:
bysection[
(changelog_directive.default_section, inner_tag)
].append(rec)
return bysection, all_sections
def _append_node(changelog_directive):
return nodes.bullet_list()
def _run_top(changelog_directive, id_prefix):
version = changelog_directive._parsed_content.get("version", "")
topsection = nodes.section(
"",
nodes.title(version, version, classes=["release-version"]),
ids=[id_prefix],
version_string=version,
)
if changelog_directive._parsed_content.get("released"):
topsection.append(
nodes.Text(
"Released: %s"
% changelog_directive._parsed_content["released"]
)
)
else:
topsection.append(nodes.Text("no release date"))
intro_para = nodes.paragraph("", "")
len_ = -1
for len_, text in enumerate(changelog_directive._parsed_content["text"]):
if ".. change::" in text:
break
# if encountered any text elements that didn't start with
# ".. change::", those become the intro
if len_ > 0:
changelog_directive.state.nested_parse(
changelog_directive._parsed_content["text"][0:len_], 0, intro_para
)
topsection.append(intro_para)
return topsection
def _render_rec(changelog_directive, rec, section, cat, append_sec):
para = rec["node"].deepcopy()
targetid = "change-%s" % (
rec["version_to_hash"][changelog_directive.version],
)
targetnode = nodes.target("", "", ids=[targetid])
sections = section.split(" ") if section else []
section_tags = [tag for tag in sections if tag in rec["tags"]]
category_tags = [cat] if cat in rec["tags"] else []
other_tags = list(
sorted(rec["tags"].difference(section_tags + category_tags))
)
all_items = []
if not changelog_directive.hide_sections_from_tags:
all_items.extend(section_tags)
all_items.extend(category_tags)
all_items.extend(other_tags)
all_items = all_items or ["no_tags"]
permalink = nodes.reference(
"",
"",
nodes.Text(u"¶", u"¶"),
refid=targetid,
classes=["changelog-reference", "headerlink"],
)
if not changelog_directive.hide_tags_in_entry:
tag_node = nodes.strong("", " ".join("[%s]" % t for t in all_items))
targetnode.insert(0, nodes.Text(" ", " "))
targetnode.insert(0, tag_node)
targetnode.append(permalink)
para.insert(0, targetnode)
if len(rec["versions"]) > 1:
backported_changes = rec["sorted_versions"][
rec["sorted_versions"].index(changelog_directive.version) + 1 :
]
if backported_changes:
backported = nodes.paragraph("")
backported.append(nodes.Text("This change is also ", ""))
backported.append(nodes.strong("", "backported"))
backported.append(
nodes.Text(" to: %s" % ", ".join(backported_changes), "")
)
para.append(backported)
if changelog_directive.hide_tags_in_entry:
para.append(permalink)
insert_ticket = nodes.paragraph("")
para.append(insert_ticket)
i = 0
for collection, render, prefix in (
(
rec["tickets"],
changelog_directive.env.changelog_render_ticket,
"#%s",
),
(
rec["pullreq"],
changelog_directive.env.changelog_render_pullreq,
"pull request %s",
),
(
rec["changeset"],
changelog_directive.env.changelog_render_changeset,
"r%s",
),
):
for refname in sorted(collection):
if i > 0:
insert_ticket.append(nodes.Text(", ", ", "))
else:
insert_ticket.append(nodes.Text("References: " ""))
i += 1
if render is not None:
if isinstance(render, dict):
if ":" in refname:
typ, refval = refname.split(":")
else:
typ = "default"
refval = refname
refuri = render[typ] % refval
else:
refuri = render % refname
node = nodes.reference(
"",
"",
nodes.Text(prefix % refname, prefix % refname),
refuri=refuri,
)
else:
node = nodes.Text(prefix % refname, prefix % refname)
insert_ticket.append(node)
append_sec.append(
nodes.list_item("", nodes.target("", "", ids=[rec["id"]]), para)
)
|
