[cad161]: / docs / scripts / bibtex.py

Download this file

293 lines (235 with data), 9.4 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
# Based on https://github.com/darwindarak/mdx_bib
import re
import string
from collections import Counter, OrderedDict
from typing import Tuple
from xml.etree import ElementTree as etree
from xml.etree.ElementTree import tostring as etree_to_string
from markdown.extensions import Extension
from markdown.inlinepatterns import Pattern
from markdown.preprocessors import Preprocessor
from mkdocs.config.config_options import Type as MkType
from mkdocs.plugins import BasePlugin
from pybtex.database.input import bibtex
from pybtex.exceptions import PybtexError
BRACKET_RE = re.compile(r"\[([^\[]+)\]")
CITE_RE = re.compile(r"@([\w_:-]+)")
DEF_RE = re.compile(r"\A {0,3}\[@([\w_:-]+)\]:\s*(.*)")
INDENT_RE = re.compile(r"\A\t| {4}(.*)")
CITATION_RE = r"(\[@(?:[\w_:-]+)(?: *, *@(?:[\w_:-]+))*\])"
class Bibliography(object):
"""Keep track of document references and citations for exporting"""
def __init__(self, extension, plugin, bibtex_file, order):
self.extension = extension
self.order = order
self.plugin = plugin
self.citations = OrderedDict()
self.references = dict()
if bibtex_file:
try:
parser = bibtex.Parser()
self.bibsource = parser.parse_file(bibtex_file).entries
self.labels = {
id: self.formatCitation(self.bibsource[id])
for id in self.bibsource.keys()
}
for value, occurrences in Counter(self.labels.values()).items():
if occurrences > 1:
for xkey, xvalue in self.labels.items():
i = 0
if xvalue == value:
self.labels[
xkey
] = f"{xvalue}{string.ascii_lowercase[i]}"
i += 1
except PybtexError:
print("Error loading bibtex file")
self.bibsource = dict()
self.labels = {}
else:
self.bibsource = dict()
def addCitation(self, citekey):
self.citations[citekey] = self.citations.get(citekey, 0) + 1
def setReference(self, citekey, reference):
self.references[citekey] = reference
def citationID(self, citekey):
return "cite-" + citekey
def referenceID(self, citekey):
return "ref-" + citekey
def formatAuthor(self, author):
out = (
author.last_names[0]
+ ((" " + author.first_names[0][0]) if author.first_names else "")
+ "."
)
if author.middle_names:
out += f"{author.middle_names[0][0]}."
return out.replace("{", "").replace("}", "")
def formatAuthorSurname(self, author):
out = author.last_names[0]
return out.replace("{", "").replace("}", "")
def formatReference(self, ref):
author_list = list(map(self.formatAuthor, ref.persons["author"]))
if len(author_list) == 1:
authors = author_list[0]
else:
authors = ", ".join(author_list[:-1])
authors += f" and {author_list[-1]}"
# Harvard style
# Surname, Initial, ... and Last_Surname,
# Initial, Year. Title. Journal, Volume(Issue), pages. doi.
title = ref.fields["title"].replace("{", "").replace("}", "")
journal = ref.fields.get("journal", "")
volume = ref.fields.get("volume", "")
issue = ref.fields.get("issue", "")
year = ref.fields.get("year")
pages = ref.fields.get("pages")
doi = ref.fields.get("doi")
url = ref.fields.get("url")
ref_id = self.referenceID(ref.key)
ref = f"<p id={repr(ref_id)}>{authors}, {year}. {title}."
if journal:
ref += f" <i>{journal}</i>."
if volume:
ref += f" <i>{volume}</i>"
if issue:
ref += f"({issue})"
if pages:
ref += f", pp.{pages}"
ref += "."
if doi:
ref += f' <a href="https://dx.doi.org/{doi}" target="_blank">{doi}</a>'
elif url:
ref += f' <a href="{url}" target="_blank">{url}</a>'
ref += "</p>"
return etree.fromstring(ref)
def formatCitation(self, ref):
author_list = list(map(self.formatAuthorSurname, ref.persons["author"]))
year = ref.fields.get("year")
if len(author_list) == 1:
citation = f"{author_list[0]}"
elif len(author_list) == 2:
citation = f"{author_list[0]} and {author_list[1]}"
else:
citation = f"{author_list[0]} et al."
citation += f", {year}"
return citation
def make_bibliography(self):
if self.order == "alphabetical":
raise (NotImplementedError)
div = etree.Element("div")
div.set("class", "footnote")
div.append(etree.Element("hr"))
ol = etree.SubElement(div, "ol")
if not self.citations:
return div
# table = etree.SubElement(div, "table")
# table.set("class", "references")
# tbody = etree.SubElement(table, "tbody")
etree.SubElement(div, "div")
for id in self.citations:
li = etree.SubElement(ol, "li")
li.set("id", self.referenceID(id))
# ref_id = etree.SubElement(li, "td")
ref_txt = etree.SubElement(li, "p")
if id in self.references:
self.extension.parser.parseChunk(ref_txt, self.references[id])
elif id in self.bibsource:
ref_txt.append(self.formatReference(self.bibsource[id]))
else:
ref_txt.text = "Missing citation for {}".format(id)
return div
def clear_citations(self):
self.citations = OrderedDict()
class CitationsPreprocessor(Preprocessor):
"""Gather reference definitions and citation keys"""
def __init__(self, bibliography):
self.bib = bibliography
def subsequentIndents(self, lines, i):
"""Concatenate consecutive indented lines"""
linesOut = []
while i < len(lines):
m = INDENT_RE.match(lines[i])
if m:
linesOut.append(m.group(1))
i += 1
else:
break
return " ".join(linesOut), i
def run(self, lines):
linesOut = []
i = 0
while i < len(lines):
# Check to see if the line starts a reference definition
m = DEF_RE.match(lines[i])
if m:
key = m.group(1)
reference = m.group(2)
indents, i = self.subsequentIndents(lines, i + 1)
reference += " " + indents
self.bib.setReference(key, reference)
continue
# Look for all @citekey patterns inside hard brackets
for bracket in BRACKET_RE.findall(lines[i]):
for c in CITE_RE.findall(bracket):
self.bib.addCitation(c)
linesOut.append(lines[i])
i += 1
return linesOut
class CitationsPattern(Pattern):
"""Handles converting citations keys into links"""
def __init__(self, pattern, bibliography):
super(CitationsPattern, self).__init__(pattern)
self.bib = bibliography
def handleMatch(self, m):
span = etree.Element("span")
for cite_match in CITE_RE.finditer(m.group(2)):
id = cite_match.group(1)
if id in self.bib.bibsource:
a = etree.Element("a")
a.set("id", self.bib.citationID(id))
a.set("href", "./#" + self.bib.referenceID(id))
a.set("class", "citation")
a.text = self.bib.labels[id]
span.append(a)
else:
continue
if len(span) == 0:
return None
return span
context_citations = None
class CitationsExtension(Extension):
def __init__(self):
super(CitationsExtension, self).__init__()
self.bib = None
def extendMarkdown(self, md):
md.registerExtension(self)
self.parser = md.parser
self.md = md
md.preprocessors.register(CitationsPreprocessor(self.bib), "mdx_bib", 15)
md.inlinePatterns.register(
CitationsPattern(CITATION_RE, self.bib), "mdx_bib", 175
)
def makeExtension(*args, **kwargs):
return CitationsExtension(*args, **kwargs)
class BibTexPlugin(BasePlugin):
config_scheme: Tuple[Tuple[str, MkType]] = (
("bibtex_file", MkType(str)), # type: ignore[assignment]
("order", MkType(str, default="unsorted")), # type: ignore[assignment]
)
def __init__(self):
self.citations = None
def on_config(self, config, **kwargs):
extension = CitationsExtension()
self.bib = Bibliography(
extension,
self,
self.config["bibtex_file"],
self.config["order"],
)
extension.bib = self.bib
config["markdown_extensions"].append(extension)
def on_page_content(self, html, page, config, files):
html += "\n" + etree_to_string(self.bib.make_bibliography()).decode()
self.bib.clear_citations()
return html