-
Notifications
You must be signed in to change notification settings - Fork 0
/
prepare_tei.py
489 lines (385 loc) · 18.9 KB
/
prepare_tei.py
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
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
"""
Submodule which prepares CLiGS-TEI-files for annotation with FreeLing and NLTK WordNet or HeidelTime.
After the annotation (external to this module), the annotated files are brought together in new TEI files.
Check out the documentation for the functions prepare_anno and postpare_anno for more details.
- for chapterwise annotation (preserving chapter structure) or annotation of the whole text at once (without preserving chapter structure)
- just the body text is preserved
- headings, notes and inline markup are discarded
@author: Ulrike Henny-Krahmer
@filename: prepare_tei.py
"""
import os
import glob
import sys
import io
from lxml import etree
from pathlib import Path
class FileResolver(etree.Resolver):
def resolve(self, url, pubid, context):
return self.resolve_filename(url, context)
# XSLT snippets
# wrapper for chapterwise annotation
xslt_TEIwrapper = etree.XML('''\
<xsl:stylesheet xmlns:xsl="http:https://www.w3.org/1999/XSL/Transform" xmlns:tei="http:https://www.tei-c.org/ns/1.0" version="1.0" exclude-result-prefixes="tei">
<xsl:output method="xml" encoding="UTF-8" indent="yes"/>
<xsl:variable name="cligsID" select="//tei:idno[@type='cligs']"/>
<xsl:template match="/">
<xsl:processing-instruction name="xml-model">href="https://raw.githubusercontent.com/cligs/reference/master/tei/cligs.rng" type="application/xml" schematypens="http:https://relaxng.org/ns/structure/1.0"</xsl:processing-instruction>
<TEI xmlns="http:https://www.tei-c.org/ns/1.0" xmlns:cligs="https://cligs.hypotheses.org/ns/cligs">
<xsl:apply-templates select="tei:TEI/tei:teiHeader"/>
<text>
<body>
<xsl:apply-templates select="tei:TEI/tei:text/tei:body"/>
</body>
</text>
</TEI>
</xsl:template>
<xsl:template match="tei:div[ancestor::tei:body][not(descendant::tei:div[not(ancestor::tei:floatingText)])][not(ancestor::tei:floatingText)]">
<xsl:copy>
<xsl:attribute name="xml:id"><xsl:value-of select="$cligsID"/>_d<xsl:value-of select="count(preceding::tei:div[ancestor::tei:body][not(descendant::tei:div[not(ancestor::tei:floatingText)])][not(ancestor::tei:floatingText)]) + 1"/></xsl:attribute>
</xsl:copy>
</xsl:template>
<xsl:template match="tei:teiHeader | tei:teiHeader//node() | tei:teiHeader//@* | tei:teiHeader//processing-instruction() | tei:teiHeader//comment()">
<xsl:copy>
<xsl:apply-templates select="node() | @* | processing-instruction() | comment()"/>
</xsl:copy>
</xsl:template>
<xsl:template match="text()[not(ancestor::tei:teiHeader)]"/>
</xsl:stylesheet>
''')
# wrapper for annotation by paragraphs
xslt_TEIwrapper_p = etree.XML('''\
<xsl:stylesheet xmlns:xsl="http:https://www.w3.org/1999/XSL/Transform" xmlns:tei="http:https://www.tei-c.org/ns/1.0" version="1.0" exclude-result-prefixes="tei">
<xsl:output method="xml" encoding="UTF-8" indent="yes"/>
<xsl:variable name="cligsID" select="//tei:idno[@type='cligs']"/>
<xsl:template match="/">
<xsl:processing-instruction name="xml-model">href="https://raw.githubusercontent.com/cligs/reference/master/tei/cligs.rng" type="application/xml" schematypens="http:https://relaxng.org/ns/structure/1.0"</xsl:processing-instruction>
<TEI xmlns="http:https://www.tei-c.org/ns/1.0" xmlns:cligs="https://cligs.hypotheses.org/ns/cligs">
<xsl:apply-templates select="tei:TEI/tei:teiHeader"/>
<text>
<body>
<xsl:apply-templates select="tei:TEI/tei:text/tei:body"/>
</body>
</text>
</TEI>
</xsl:template>
<xsl:template match="tei:div[@type='part' or @type='subpart' or @type='chapter' or @type='subchapter']">
<xsl:copy>
<xsl:copy-of select="@*"/>
<xsl:apply-templates/>
</xsl:copy>
</xsl:template>
<xsl:template match="tei:p | tei:l | tei:head[not(parent::tei:div[@type='part' or @type='subpart' or @type='chapter' or @type='subchapter'])]">
<xsl:copy>
<xsl:attribute name="xml:id"><xsl:value-of select="$cligsID"/>_p<xsl:value-of select="count(preceding::tei:p[ancestor::tei:body] | preceding::tei:l[ancestor::tei:body] | preceding::tei:head[ancestor::tei:body][not(parent::tei:div[@type='part' or @type='subpart' or @type='chapter' or @type='subchapter'])]) + 1"/></xsl:attribute>
</xsl:copy>
</xsl:template>
<xsl:template match="tei:teiHeader | tei:teiHeader//node() | tei:teiHeader//@* | tei:teiHeader//processing-instruction() | tei:teiHeader//comment()">
<xsl:copy>
<xsl:apply-templates select="node() | @* | processing-instruction() | comment()"/>
</xsl:copy>
</xsl:template>
<xsl:template match="text()[not(ancestor::tei:teiHeader)]"/>
</xsl:stylesheet>
''')
# wrapper for annotation of the whole text
xslt_TEIwrapper_1 = etree.XML('''\
<xsl:stylesheet xmlns:xsl="http:https://www.w3.org/1999/XSL/Transform" xmlns:tei="http:https://www.tei-c.org/ns/1.0" version="1.0" exclude-result-prefixes="tei">
<xsl:output method="xml" encoding="UTF-8" indent="yes"/>
<xsl:variable name="cligsID" select="//tei:idno[@type='cligs']"/>
<xsl:template match="/">
<xsl:processing-instruction name="xml-model">href="https://raw.githubusercontent.com/cligs/reference/master/tei/cligs.rng" type="application/xml" schematypens="http:https://relaxng.org/ns/structure/1.0"</xsl:processing-instruction>
<TEI xmlns="http:https://www.tei-c.org/ns/1.0" xmlns:cligs="https://cligs.hypotheses.org/ns/cligs">
<xsl:apply-templates select="tei:TEI/tei:teiHeader"/>
<text>
<body>
<div>
<xsl:attribute name="xml:id"><xsl:value-of select="$cligsID"/>_d1</xsl:attribute>
</div>
</body>
</text>
</TEI>
</xsl:template>
<xsl:template match="tei:teiHeader | tei:teiHeader//node() | tei:teiHeader//@* | tei:teiHeader//processing-instruction() | tei:teiHeader//comment()">
<xsl:copy>
<xsl:apply-templates select="node() | @* | processing-instruction() | comment()"/>
</xsl:copy>
</xsl:template>
<xsl:template match="text()[not(ancestor::tei:teiHeader)]"/>
</xsl:stylesheet>
''')
# extract full text of div snippets
xslt_extractDIVs = etree.XML('''\
<xsl:stylesheet xmlns:xsl="http:https://www.w3.org/1999/XSL/Transform" xmlns:tei="http:https://www.tei-c.org/ns/1.0" version="1.0">
<xsl:output method="text" encoding="UTF-8" indent="yes"/>
<xsl:template match="tei:head|tei:note">
<xsl:text> </xsl:text>
</xsl:template>
<xsl:template match="tei:*[not(name() = 'head') and not(name() = 'note')]">
<xsl:text> </xsl:text><xsl:apply-templates /><xsl:text> </xsl:text>
</xsl:template>
<xsl:template match="text()">
<xsl:value-of select="normalize-space(.)"/>
</xsl:template>
</xsl:stylesheet>
''')
# extract full text of p snippets
xslt_extractPs = etree.XML('''\
<xsl:stylesheet xmlns:xsl="http:https://www.w3.org/1999/XSL/Transform" xmlns:tei="http:https://www.tei-c.org/ns/1.0" version="1.0">
<xsl:output method="text" encoding="UTF-8" indent="yes"/>
<xsl:template match="tei:*">
<xsl:text> </xsl:text><xsl:apply-templates /><xsl:text> </xsl:text>
</xsl:template>
<xsl:template match="text()">
<xsl:value-of select="normalize-space(.)"/>
</xsl:template>
</xsl:stylesheet>
''')
xslt_joinDIVs = '''\
<xsl:stylesheet xmlns:xsl="http:https://www.w3.org/1999/XSL/Transform" xmlns:tei="http:https://www.tei-c.org/ns/1.0" xmlns:cligs="https://cligs.hypotheses.org/ns/cligs" version="1.0" exclude-result-prefixes="tei">
<xsl:param name="annofolder"/>
<xsl:param name="mode"/>
<xsl:output method="xml" encoding="UTF-8" indent="yes" />
<xsl:template match="node() | @* | processing-instruction() | comment()">
<xsl:copy>
<xsl:apply-templates select="node() | @* | processing-instruction() | comment()"/>
</xsl:copy>
</xsl:template>
<xsl:template match="tei:text/tei:body/tei:div">
<xsl:copy>
<xsl:copy-of select="@*"/>
<xsl:choose>
<xsl:when test="$mode='ht'">
<xsl:for-each select="document(concat($annofolder, @xml:id,'.xml'))//wrapper">
<xsl:copy-of select="."/>
</xsl:for-each>
</xsl:when>
<xsl:otherwise>
<xsl:for-each select="document(concat($annofolder, @xml:id,'.xml'))//s">
<xsl:element name="ab" namespace="http:https://www.tei-c.org/ns/1.0">
<xsl:element name="{local-name()}" namespace="http:https://www.tei-c.org/ns/1.0">
<xsl:copy-of select="@*"/>
<xsl:for-each select="w">
<xsl:element name="{local-name()}" namespace="http:https://www.tei-c.org/ns/1.0">
<xsl:for-each select="@*">
<xsl:choose>
<xsl:when test="local-name()='ctag' or local-name()='form' or local-name()='tag' or local-name()='wnlex' or local-name()='wnsyn' or local-name()='mood'
or local-name()='num' or local-name()='person' or local-name()='tense' or local-name()='gen' or local-name()='possessornum' or local-name()='nec'
or local-name()='neclass' or local-name()='case' or local-name()='punctenclose' or local-name()='degree' or local-name()='polite' or local-name()='possessorpers'">
<xsl:attribute name="cligs:{local-name()}">
<xsl:value-of select="."/>
</xsl:attribute>
</xsl:when>
<xsl:otherwise>
<xsl:attribute name="{local-name()}" xmlns="http:https://www.tei-c.org/ns/1.0">
<xsl:value-of select="."/>
</xsl:attribute>
</xsl:otherwise>
</xsl:choose>
</xsl:for-each>
<xsl:value-of select="."/>
</xsl:element>
</xsl:for-each>
</xsl:element>
</xsl:element>
</xsl:for-each>
</xsl:otherwise>
</xsl:choose>
</xsl:copy>
</xsl:template>
</xsl:stylesheet>
'''
xslt_joinPs = '''\
<xsl:stylesheet xmlns:xsl="http:https://www.w3.org/1999/XSL/Transform" xmlns:tei="http:https://www.tei-c.org/ns/1.0" xmlns:cligs="https://cligs.hypotheses.org/ns/cligs" version="1.0" exclude-result-prefixes="tei">
<xsl:param name="annofolder"/>
<xsl:param name="mode"/>
<xsl:output method="xml" encoding="UTF-8" indent="no" />
<xsl:template match="node() | @* | processing-instruction() | comment()">
<xsl:copy>
<xsl:apply-templates select="node() | @* | processing-instruction() | comment()"/>
</xsl:copy>
</xsl:template>
<xsl:template match="tei:p[ancestor::tei:body] | tei:l[ancestor::tei:body] | tei:head[ancestor::tei:body][not(parent::tei:div[@type='part' or @type='subpart' or @type='chapter' or @type='subchapter'])]">
<xsl:copy>
<xsl:copy-of select="@*"/>
<xsl:choose>
<xsl:when test="$mode='ht'">
<xsl:for-each select="document(concat($annofolder, @xml:id,'.xml'))//wrapper">
<xsl:copy-of select="."/>
</xsl:for-each>
</xsl:when>
<xsl:otherwise>
<xsl:text>
</xsl:text>
<xsl:for-each select="document(concat($annofolder, @xml:id,'.xml'))//s">
<xsl:element name="{local-name()}" namespace="http:https://www.tei-c.org/ns/1.0">
<xsl:copy-of select="@*"/>
<xsl:text>
</xsl:text>
<xsl:for-each select="w">
<xsl:element name="{local-name()}" namespace="http:https://www.tei-c.org/ns/1.0">
<xsl:for-each select="@*">
<xsl:choose>
<xsl:when test="local-name()='ctag' or local-name()='form' or local-name()='tag' or local-name()='wnlex' or local-name()='wnsyn' or local-name()='mood'
or local-name()='num' or local-name()='person' or local-name()='tense' or local-name()='gen' or local-name()='possessornum' or local-name()='nec'
or local-name()='neclass' or local-name()='case' or local-name()='punctenclose' or local-name()='degree' or local-name()='polite' or local-name()='possessorpers'">
<xsl:attribute name="cligs:{local-name()}">
<xsl:value-of select="."/>
</xsl:attribute>
</xsl:when>
<xsl:otherwise>
<xsl:attribute name="{local-name()}" xmlns="http:https://www.tei-c.org/ns/1.0">
<xsl:value-of select="."/>
</xsl:attribute>
</xsl:otherwise>
</xsl:choose>
</xsl:for-each>
<xsl:value-of select="."/>
</xsl:element>
<xsl:text>
</xsl:text>
</xsl:for-each>
</xsl:element>
</xsl:for-each>
</xsl:otherwise>
</xsl:choose>
</xsl:copy>
</xsl:template>
</xsl:stylesheet>
'''
def prepare_anno(infolder, outfolder, mode="split"):
"""
Takes a collection of TEI files and prepares them for annotation.
Arguments:
infolder (string): path to the input folder (which should contain the input TEI files)
outfolder (string): path to the output folder (which is created if it does not exist)
mode (string): default is "split" (chapterwise), also possible is "split-1" (text as a whole), "split-p" (split by paragraphs)
"""
print("Starting...")
inpath = os.path.join(infolder, "*.xml")
filecounter = 0
# check output folders
if not os.path.exists(outfolder):
os.makedirs(outfolder)
out_tei = os.path.join(outfolder, "temp")
out_txt = os.path.join(outfolder, "txt")
if not os.path.exists(out_tei):
os.makedirs(out_tei)
if not os.path.exists(out_txt):
os.makedirs(out_txt)
for filepath in glob.glob(inpath):
filecounter+= 1
fn = os.path.basename(filepath)[:-4]
outfile_x = fn + ".xml"
doc = etree.parse(filepath)
if mode == "split-1":
transform = etree.XSLT(xslt_TEIwrapper_1)
elif mode == "split-p":
transform = etree.XSLT(xslt_TEIwrapper_p)
else:
transform = etree.XSLT(xslt_TEIwrapper)
result_tree = transform(doc)
result = str(result_tree)
# create TEI wrapper for future annotation results
with open(os.path.join(outfolder, "temp", outfile_x), "w") as output:
output.write(result)
# create one full text file per chapter (or for the whole text, or for each paragraph)
tei = {'tei':'http:https://www.tei-c.org/ns/1.0'}
cligs_id = doc.xpath("//tei:idno[@type='cligs']/text()", namespaces=tei)
if mode == "split-1":
results = doc.xpath("//tei:text/tei:body", namespaces=tei)
elif mode == "split-p":
results = doc.xpath("//tei:p[ancestor::tei:body] | //tei:l[ancestor::tei:body] | //tei:head[ancestor::tei:body][not(parent::tei:div[@type='part' or @type='subpart' or @type='chapter' or @type='subchapter'])]", namespaces=tei)
else:
results = doc.xpath("//tei:div[ancestor::tei:body][not(descendant::tei:div[not(ancestor::tei:floatingText)])][not(ancestor::tei:floatingText)]", namespaces=tei)
if isinstance(cligs_id, list):
cligs_id = cligs_id[0]
elif isinstance(cligs_id, str) == False:
raise ValueError("This type (" + str(type(cligs_id)) + ") is not supported for cligs_id. Must be list or string.")
for i,r in enumerate(results):
if mode == "split-p":
transform = etree.XSLT(xslt_extractPs)
else:
transform = etree.XSLT(xslt_extractDIVs)
result_tree = transform(r)
result = str(result_tree)
if mode == "split-p":
outfile = cligs_id + "_p" + str(i + 1) + ".txt"
else:
outfile = cligs_id + "_d" + str(i + 1) + ".txt"
with open(os.path.join(outfolder, "txt", outfile), "w") as output:
output.write(result)
print("Done. " + str(filecounter) + " files treated.")
def postpare_anno(infolder, outfolder, mode="fl"):
"""
Creates a TEI file from a collection of annotated full text files (one per chapter or for the whole text).
Needs an input folder with two subfolders: 'temp' with the TEI file templates and 'anno' with the annotated text in XML format.
Expects the annotated files to be named according to the following example/pattern: nh0006_d1.xml / [cligs_id]_d[division_id].xml
Arguments:
infolder (string): path to the input folder (which should contain a folder "temp" with the templates for the new TEI files and a folder "annotated_temp" with the annotations in XML format)
outfolder (string): path to the output folder (which is created if it does not exist)
mode (string): which kind of annotation to treat; default: "fl" (= FreeLing), alternative: "ht" (= HeidelTime), "fl-p" (= FreeLing, paragraph structure)
"""
print("Starting...")
if not os.path.exists(infolder):
raise ValueError("The input folder could not be found.")
in_temp = os.path.join(infolder, "temp")
in_anno = os.path.join(infolder, "annotated_temp")
if not os.path.exists(in_temp):
raise ValueError("The folder 'temp' could not be found inside the input folder.")
if not os.path.exists(in_anno):
raise ValueError("The folder 'annotated_temp' could not be found inside the input folder.")
if not os.path.exists(outfolder):
os.makedirs(outfolder)
filecounter = 0
# fetch annotated snippets for each TEI template file
for filepath in glob.glob(os.path.join(in_temp, "*.xml")):
print("doing file " + filepath)
filecounter+= 1
fn = os.path.basename(filepath)
annofolder = os.path.join(Path(os.path.join(infolder, "annotated_temp")).as_uri(), "")
# which annotation mode are we in?
annomode = mode
parser = etree.XMLParser(encoding="UTF-8")
parser.resolvers.add(FileResolver())
doc = etree.parse(filepath, parser)
if mode == "fl-p":
xslt_root = etree.parse(io.StringIO(xslt_joinPs), parser)
else:
xslt_root = etree.parse(io.StringIO(xslt_joinDIVs), parser)
transform = etree.XSLT(xslt_root)
result_tree = transform(doc, annofolder= "'" + annofolder + "'", mode= "'" + annomode + "'")
result = str(result_tree)
# save the results
with open(os.path.join(outfolder, fn), "w") as output:
output.write(result)
print("Done. " + str(filecounter) + " files treated.")
def prepare(mode, infolder, outfolder):
"""
Preparations for linguistically annotated versions of a collection of TEI files.
There are two phases:
- input phase: the full text is extracted chapterwise (or as a whole) from the TEI files, templates for new TEI files meant to hold the annotated text are created
- output phase: the annotated full text snippets are brought together in the new TEI files
Arguments:
mode (string): possible values are "split" (chapterwise), "split-1" (the whole text at once), "split-p" (split by paragraphs) or "merge"
infolder (string): in split-mode: path to the input folder (which should contain the input TEI files); in merge-mode: path to the annotation output folder (with subfolder "temp" and "annotated_temp")
outfolder (string): in split-mode: path to the output folder for annotation working files; in merge-mode: path to the output folder for annotated TEI result files. The folders are created if they do not exist.
"""
if mode == "split":
prepare_anno(infolder, outfolder, mode="split")
elif mode == "split-1":
prepare_anno(infolder, outfolder, mode="split-1")
elif mode == "split-p":
prepare_anno(infolder, outfolder, mode="split-p")
elif mode == "merge":
postpare_anno(infolder, outfolder, mode="fl")
elif mode == "merge-p":
postpare_anno(infolder, outfolder, mode="fl-p")
elif mode == "merge-hdt":
postpare_anno(infolder, outfolder, mode="ht")
else:
raise ValueError("Please indicate one of the following as the value for the first argument: 'split', 'merge'")
if __name__ == "__main__":
prepare(int(sys.argv[1]))