-
Notifications
You must be signed in to change notification settings - Fork 0
/
xmlbuilder.py
1283 lines (1128 loc) · 48 KB
/
xmlbuilder.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
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"""Utility classes and functions for building XML."""
import logging
from babel.dates import format_date
from lxml import etree
from common import Resources
from parsing import parse_organization_name, SessionParser
from nltk.tokenize import word_tokenize
from pathlib import Path
from common import StringFormatter
from common import build_speaker_id, Gender, OrganizationType
import subprocess
from collections import namedtuple
from dateutil import parser
class XmlElements:
"""Names of the XML elements to build or parse."""
TEI = '{http://www.tei-c.org/ns/1.0}TEI'
titleStmt = '{http://www.tei-c.org/ns/1.0}titleStmt'
title = '{http://www.tei-c.org/ns/1.0}title'
meeting = '{http://www.tei-c.org/ns/1.0}meeting'
u = '{http://www.tei-c.org/ns/1.0}u'
div = '{http://www.tei-c.org/ns/1.0}div'
extent = '{http://www.tei-c.org/ns/1.0}extent'
measure = '{http://www.tei-c.org/ns/1.0}measure'
date = '{http://www.tei-c.org/ns/1.0}date'
bibl = '{http://www.tei-c.org/ns/1.0}bibl'
setting = '{http://www.tei-c.org/ns/1.0}setting'
tagUsage = '{http://www.tei-c.org/ns/1.0}tagUsage'
text = '{http://www.tei-c.org/ns/1.0}text'
body = '{http://www.tei-c.org/ns/1.0}body'
head = '{http://www.tei-c.org/ns/1.0}head'
note = '{http://www.tei-c.org/ns/1.0}note'
seg = '{http://www.tei-c.org/ns/1.0}seg'
kinesic = '{http://www.tei-c.org/ns/1.0}kinesic'
desc = '{http://www.tei-c.org/ns/1.0}desc'
gap = '{http://www.tei-c.org/ns/1.0}gap'
idno = '{http://www.tei-c.org/ns/1.0}idno'
listOrg = '{http://www.tei-c.org/ns/1.0}listOrg'
org = '{http://www.tei-c.org/ns/1.0}org'
orgName = '{http://www.tei-c.org/ns/1.0}orgName'
event = '{http://www.tei-c.org/ns/1.0}event'
listPerson = '{http://www.tei-c.org/ns/1.0}listPerson'
person = '{http://www.tei-c.org/ns/1.0}person'
persName = '{http://www.tei-c.org/ns/1.0}persName'
forename = '{http://www.tei-c.org/ns/1.0}forename'
surname = '{http://www.tei-c.org/ns/1.0}surname'
sex = '{http://www.tei-c.org/ns/1.0}sex'
affiliation = '{http://www.tei-c.org/ns/1.0}affiliation'
figure = '{http://www.tei-c.org/ns/1.0}figure'
graphic = '{http://www.tei-c.org/ns/1.0}graphic'
s = '{http://www.tei-c.org/ns/1.0}s'
w = '{http://www.tei-c.org/ns/1.0}w'
pc = '{http://www.tei-c.org/ns/1.0}pc'
linkGrp = '{http://www.tei-c.org/ns/1.0}linkGrp'
link = '{http://www.tei-c.org/ns/1.0}link'
class XmlAttributes:
"""Constants used for names of XML attributes."""
xml_id = '{http://www.w3.org/XML/1998/namespace}id'
lang = '{http://www.w3.org/XML/1998/namespace}lang'
element_type = 'type'
meeting_n = 'n'
unit = 'unit'
quantity = 'quantity'
when = 'when'
gi = 'gi'
occurs = 'occurs'
ana = 'ana'
who = 'who'
full = 'full'
role = 'role'
event_start = 'from'
event_end = 'to'
value = 'value'
url = 'url'
ref = 'ref'
role = 'role'
msd = 'msd'
pos = 'pos'
lemma = 'lemma'
targFunc = 'targFunc'
type_ = 'type'
target = 'target'
corresp = 'corresp'
class SessionXmlBuilder:
"""Class responsible for building the XML file of a session transcript."""
def __init__(self,
input_file,
template_file,
output_directory,
output_file_prefix='ParlaMint-RO'):
"""Create a new instance of SessionXmlBuilder class.
Parameters
----------
input_file: str, required
The path to the HTML file containing the session transcription.
template_file: str, required
The path to the file containing the XML template of the output.
output_directory: str, required
The path to the output directory.
output_file_prefix: str, optional
The prefix of the output file name. Default is `ParlaMint-RO`.
"""
self.parser = SessionParser(input_file)
self.formatter = StringFormatter()
self.output_directory = output_directory
self.output_file_prefix = output_file_prefix
self.element_tree = parse_xml_file(template_file)
self.xml = self.element_tree.getroot()
for div in self.xml.iterdescendants(XmlElements.div):
if div.get(XmlAttributes.element_type) == "debateSection":
self.debate_section = div
def write_to_file(self,
file_name=None,
group_by_year=False,
use_xmllint=False):
"""Write the XML session to a file given by file_name or session id.
Parameters
----------
file_name: str, optional
The name of the output file. Default is the session id.
group_by_year: boolean, optional
Specifies whether to group output files into directories by year.
Default is `False`.
use_xmllint: boolean, optional
Specifies whether to use `xmllint` program for formatting the output xml.
Default is `False`.
"""
if not file_name:
file_name = "{}.xml".format(self.id_builder.session_id)
if group_by_year:
year = str(self.session_date.year)
directory = Path(self.output_directory, year)
if not directory.exists():
directory.mkdir(parents=True, exist_ok=True)
file_name = Path(directory, file_name)
else:
file_name = Path(self.output_directory, file_name)
file_name = str(file_name)
save_xml(self.element_tree, file_name, use_xmllint=use_xmllint)
def build_session_xml(self):
"""Builds the session XML from its transcription.
"""
self.session_date = self.parser.parse_session_date()
self.session_type = self.parser.parse_session_type()
self.id_builder = XmlIdBuilder(self.output_file_prefix,
self.session_date)
self._set_session_id()
self._set_session_title()
self._set_meeting_info()
self._set_session_idno()
self._set_session_date()
self._build_session_heading()
self._build_session_body()
self._build_session_footer()
self._cleanup_xml()
self._set_session_stats()
self._set_tag_usage()
def _cleanup_xml(self):
for u in self.debate_section.iterdescendants(tag=XmlElements.u):
if len(u) == 0:
self.debate_section.remove(u)
u.set(XmlAttributes.xml_id, self.id_builder.build_utterance_id())
def _build_session_footer(self):
"""Adds the end time segment(s) to the session description.
"""
end_time = self.parser.parse_session_end_time()
if end_time is not None:
note = etree.SubElement(self.debate_section, XmlElements.note)
note.set(XmlAttributes.element_type, "time")
note.text = self.formatter.to_single_line(end_time)
def _build_session_body(self):
"""Adds the session segments to the session description.
"""
is_first = True
utterance = None
for segment in self.parser.parse_session_segments():
text = segment.get_text()
if len(text) == 0:
continue
if segment.is_speaker:
note = etree.SubElement(self.debate_section, XmlElements.note)
note.set(XmlAttributes.element_type, "speaker")
note.text = self.formatter.to_single_line(text)
if segment.has_note:
note = etree.SubElement(self.debate_section,
XmlElements.note)
note.set(XmlAttributes.element_type, "editorial")
note.text = self.formatter.to_single_line(
segment.get_note_text())
utterance = etree.SubElement(self.debate_section,
XmlElements.u)
if is_first:
chairman = self.formatter.to_single_line(
segment.get_speaker())
is_first = False
speaker = self.formatter.to_single_line(segment.get_speaker())
utterance.set(XmlAttributes.ana,
"#chair" if speaker == chairman else "#regular")
utterance.set(XmlAttributes.who,
self.id_builder.get_speaker_id(speaker))
else:
seg = etree.SubElement(utterance, XmlElements.seg)
seg.set(XmlAttributes.xml_id,
self.id_builder.build_segment_id())
seg.text = self.formatter.to_single_line(text)
def _build_session_heading(self):
"""Adds the head elements to session description.
"""
head = etree.SubElement(self.debate_section, XmlElements.head)
head.text = Resources.Heading
session_head = etree.SubElement(self.debate_section, XmlElements.head)
session_head.set(XmlAttributes.element_type, "session")
session_head.text = Resources.SessionHeading.format(
format_date(self.session_date, "d MMMM yyyy"))
summary = self.parser.parse_session_summary()
if len(summary) > 0:
note = etree.SubElement(self.debate_section, XmlElements.note)
note.set(XmlAttributes.element_type, "editorial")
note.text = Resources.ToC
for summary_line in self.parser.parse_session_summary():
note = etree.SubElement(self.debate_section, XmlElements.note)
note.set(XmlAttributes.element_type, "summary")
note.text = self.formatter.normalize(summary_line)
heading = self.parser.parse_session_heading()
if heading is not None:
note = etree.SubElement(self.debate_section, XmlElements.note)
note.set(XmlAttributes.element_type, "editorial")
note.text = self.formatter.to_single_line(heading)
start_time = self.parser.parse_session_start_time()
if start_time is not None:
note = etree.SubElement(self.debate_section, XmlElements.note)
note.set(XmlAttributes.element_type, "time")
note.text = self.formatter.to_single_line(start_time)
chairmen = self.parser.parse_session_chairmen()
if chairmen is not None:
note = etree.SubElement(self.debate_section, XmlElements.note)
note.set(XmlAttributes.element_type, "chairman")
note.text = self.formatter.to_single_line(chairmen)
def _set_tag_usage(self):
"""Updates the values for tagUsage elements.
"""
name_map = {
"text": XmlElements.text,
"body": XmlElements.body,
"div": XmlElements.div,
"head": XmlElements.head,
"note": XmlElements.note,
"u": XmlElements.u,
"seg": XmlElements.seg,
"kinesic": XmlElements.kinesic,
"desc": XmlElements.desc,
"gap": XmlElements.gap
}
for tag_usage in self.xml.iterdescendants(tag=XmlElements.tagUsage):
tag_name = name_map[tag_usage.get(XmlAttributes.gi)]
num_occurences = self._get_num_occurences(tag_name)
tag_usage.set(XmlAttributes.occurs, str(num_occurences))
def _get_num_occurences(self, tag):
"""Computes the number of occurences for the specified tag.
Parameters
----------
tag: str
The tag for which to compute number of occurences.
Returns
-------
num_occurences: int
The number of times the tag is present in the document.
"""
tags = self.xml.iterdescendants(tag=tag)
num_occurences = len([t for t in tags])
return num_occurences
def _set_session_date(self):
"""Updates the session date in the XML file.
"""
for date in self.xml.iterdescendants(tag=XmlElements.date):
parent_tag = date.getparent().tag
if parent_tag == XmlElements.setting or parent_tag == XmlElements.bibl:
date.set(XmlAttributes.when,
format_date(self.session_date, "yyyy-MM-dd"))
date.text = format_date(self.session_date, "dd.MM.yyyy")
def _set_session_idno(self):
"""Updates the vale of `idno` element.
"""
for idno in self.xml.iterdescendants(tag=XmlElements.idno):
if idno.get(XmlAttributes.element_type) == 'URI':
date = format_date(self.session_date, "yyyyMMdd")
idno.text = "http://www.cdep.ro/pls/steno/steno2015.data?cam=2&dat={}".format(
date)
def _set_session_stats(self):
"""Updates the session statistics of the extent element.
"""
num_speeches = self._get_num_speeches()
num_words = self._get_num_words()
for m in self.xml.iterdescendants(tag=XmlElements.measure):
if m.getparent().tag != XmlElements.extent:
continue
lang = m.get(XmlAttributes.lang)
unit = m.get(XmlAttributes.unit)
qty = num_speeches if unit == 'speeches' else num_words
m.set(XmlAttributes.quantity, str(qty))
if unit == 'speeches':
txt = Resources.NumSpeechesRo if lang == 'ro' else Resources.NumSpeechesEn
else:
txt = Resources.NumWordsRo if lang == 'ro' else Resources.NumWordsEn
m.text = txt.format(qty)
def _get_num_words(self):
"""Computes the number of words from the session transcription.
Returns
-------
num_words: int
The number of words in the transcription.
"""
text = "".join(self.debate_section.itertext())
num_words = len(word_tokenize(text))
return num_words
def _get_num_speeches(self):
"""Computes the number of speeches (a.k.a. utterances).
Returns
-------
num_speeches: int
The number of speeches in the transcription.
"""
speeches = [s for s in self.xml.iterdescendants(tag=XmlElements.u)]
num_speeches = len(speeches)
return num_speeches
def _set_meeting_info(self):
"""Sets the contents of the meeting element.
"""
meeting_n = format_date(self.session_date, "yyyyMMdd")
for meeting in self.xml.iterdescendants(tag=XmlElements.meeting):
meeting.set(XmlAttributes.meeting_n, meeting_n)
def _set_session_title(self):
"""Sets the contents of th title elements.
"""
ro_date = format_date(self.session_date, "d MMMM yyyy", locale="ro")
en_date = format_date(self.session_date, "MMMM d yyyy", locale="en")
for elem in self.xml.iterdescendants(tag=XmlElements.title):
if elem.getparent().tag != XmlElements.titleStmt:
continue
title_type = elem.get(XmlAttributes.element_type)
lang = elem.get(XmlAttributes.lang)
if title_type == 'main' and lang == 'ro':
elem.text = Resources.SessionTitleRo.format(ro_date)
if title_type == 'main' and lang == 'en':
elem.text = Resources.SessionTitleEn.format(en_date)
if title_type == 'sub' and lang == 'ro':
elem.text = Resources.SessionSubtitleRo.format(ro_date)
if title_type == 'sub' and lang == 'en':
elem.text = Resources.SessionSubtitleEn.format(en_date)
def _set_session_id(self):
"""Sets the id of the TEI element.
"""
self.xml.set(XmlAttributes.xml_id, self.id_builder.session_id)
def apply_xmllint(file_name):
"""Formats the specified file using xmllint.
Parameters
----------
file_name: str, required
The full name of the file to be formatted.
"""
logging.info("Formatting file [{}] using xmllint.".format(file_name))
proc = subprocess.Popen(
['xmllint', '--format', '--output', file_name, file_name],
stderr=subprocess.PIPE,
stdout=subprocess.PIPE)
proc.wait()
def parse_xml_file(file_name):
"""Parses the specified XML file.
Parameters
----------
file_name: str, required
The name of the XML file.
Returns
-------
xml_tree: etree.ElementTree
The XML tree from the file.
"""
parser = etree.XMLParser(remove_blank_text=True)
xml_tree = etree.parse(file_name, parser)
for element in xml_tree.iter():
element.tail = None
return xml_tree
def save_xml(xml, file_name, use_xmllint=True):
"""Saves the provided XML tree to the specified file and optionally applies xmllint.
Parameters
----------
xml : etree.ElementRoot, required
The XML tree to save to disk.
file_name : str, required
The file where to save the XML.
use_xmllint: bool, optional
Specifies whether to apply xmllint or not.
Default is `True`.
"""
xml.write(file_name,
pretty_print=True,
encoding='utf-8',
xml_declaration=True)
if use_xmllint:
apply_xmllint(file_name)
def add_component_file_to_corpus_root(component_file, corpus_root):
"""Adds the `component_file` to the list of included files in the corpus.
Parameters
----------
component_file: pathlib.Path, required
The path of the component file.
corpus_root: etree.Element, required
The corpus root element.
"""
file_name = component_file.name
logging.info("Addind file {} to included files.".format(file_name))
# I don't have time to investigate how to do this properly so I'm applying this hack.
include_element = etree.fromstring(
'<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="{}"/>'.
format(file_name))
corpus_root.append(include_element)
DeputyInfo = namedtuple("DeputyInfo",
['first_name', 'last_name', 'gender', 'image_url'])
class RootXmlBuilder:
"""Builds the corpus root XML file.
"""
def __init__(self,
template_file,
deputy_info,
organizations,
parliament_id="RoParl",
id_char_replacements=None):
"""Creates a new instance of RootXmlBuilder.
Parameters
----------
template_file: str, required
The path to the template file for corpus root.
deputy_info: pandas.DataFrame, required
The data frame containing deputy names, gender, and link to profile picture.
organizations: iterable of str, required
The collection of organization names.
parliament_id: str, optional
The id of the organization with role='parliament'.
id_char_replacements: dict of (str, str), optional
A dict containing the uppercase and lowercase characters that are not valid for id strings and their replacements.
"""
self.xml_root = parse_xml_file(template_file)
self.corpus_root = self.xml_root.getroot()
self.deputy_info = deputy_info
self.organizations = organizations
self.id_char_replacements = id_char_replacements if id_char_replacements is not None else {}
self.name_map = self._build_name_map(self.deputy_info)
self.male_names = set()
self.female_names = set()
self._split_names_by_gender()
self.parliament_terms = self._parse_terms_list(parliament_id)
self.existing_persons = {}
self.person_affiliations = {}
self.ids_to_replace = {}
@property
def id_replacement_list(self):
"""Returns the list of ids to be replaced.
"""
return [(id_string, canonical_id)
for id_string, canonical_id in self.ids_to_replace.items()]
def build_corpus_root(self,
corpus_dir,
file_name="ParlaMint-RO.xml",
apply_postprocessing=True):
"""Builds the corpus root file by aggregating corpus files in corpus_dir.
Parameters
----------
corpus_dir: str, required
The path to the directory containing corpus files.
file_name: str, optional
The name of the output file. Default is `ParlaMint-RO.xml`.
apply_postprocessing: bool, optional
Specifies whether to apply any postprocessing actions like replacing invalid characters in ids.
Default is True.
"""
self.corpus_dir = Path(corpus_dir)
self._build_organizations_list()
for component_file in self._iter_files(self.corpus_dir, file_name):
logging.info("Adding file {} to corpus root.".format(
str(component_file)))
corpus_component = parse_xml_file(str(component_file)).getroot()
self._update_tag_usage(corpus_component)
self._add_or_update_speakers(corpus_component)
self._add_component_file(component_file)
self._write_file(file_name)
logging.info("Finished building root file of the corpus.")
if apply_postprocessing:
logging.info("Post-processing is enabled.")
self._apply_id_correction(self.corpus_dir, file_name)
def _apply_id_correction(self, corpus_dir, root_file_name):
"""Iterates over the files in corpus directory and replaces the ids containing invalid characters with the normalized ones.
Parameters
----------
corpus_dir: pathlib.Path, required
The path of the corpus directory.
root_file_name: str, required
The name of the root file of the corpus within `corpus_dir`.
"""
logging.info("Applying id correction to corpus files.")
for component_file in self._iter_files(corpus_dir, root_file_name):
self._correct_ids_in_file(component_file)
logging.info("Applying id correction to root file.")
for person in self.corpus_root.iterdescendants(tag=XmlElements.person):
speaker_id = person.get(XmlAttributes.xml_id)
if speaker_id in self.ids_to_replace:
person.set(XmlAttributes.xml_id,
self.ids_to_replace[speaker_id])
logging.info("Saving root file.")
self._write_file(root_file_name)
logging.info("Finished applying id correction.")
def _correct_ids_in_file(self, component_file):
"""Replaces the ids containing invalids values to canonical ones in the specified component file.
Parameters
----------
component_file: pathlib.Path, required
The path of the file to replace the ids in.
"""
file_name = str(component_file)
logging.info("Correcting the ids in file {}.".format(file_name))
xml_root = parse_xml_file(file_name)
corpus_component = xml_root.getroot()
corrections_applied = False
for u in corpus_component.iterdescendants(tag=XmlElements.u):
speaker_id = u.get(XmlAttributes.who).strip('#')
if speaker_id in self.ids_to_replace:
cannonical_id = self.ids_to_replace[speaker_id]
u.set(XmlAttributes.who, "#{}".format(cannonical_id))
corrections_applied = True
if corrections_applied:
logging.info("Saving file {}.".format(file_name))
save_xml(xml_root, file_name)
else:
logging.info(
"File {} has no ids to be corrected.".format(file_name))
def _add_component_file(self, component_file):
"""Adds the `component_file` to the list of included files in the corpus.
Parameters
----------
component_file: pathlib.Path, required
The path of the component file.
"""
file_name = Path(component_file)
add_component_file_to_corpus_root(file_name, self.corpus_root)
def _add_or_update_speakers(self, corpus_component):
"""Iterates over the speakers from the `corpus_component` and adds them to the list of speakers or updates their affiliation.
Parameters
----------
corpus_component: etree.ElementTree, required
The contents of the component file as an XML tree.
"""
logging.info("Updating speakers.")
session_date = None
for date_elem in corpus_component.iterdescendants(
tag=XmlElements.date):
if date_elem.getparent().tag == XmlElements.bibl:
session_date = parser.parse(date_elem.get(XmlAttributes.when))
if session_date is None:
logging.error("Could not parse session date.")
person_list = next(
self.corpus_root.iterdescendants(tag=XmlElements.listPerson))
for utterance in corpus_component.iterdescendants(tag=XmlElements.u):
speaker_id = utterance.get(XmlAttributes.who)
key = self._build_name_map_key(speaker_id)
speaker_id = speaker_id.strip('#')
existing_person = self._find_person_by_id(person_list, speaker_id)
if key not in self.name_map:
# This is an unknown person.
# If a person with the same id does not exist - add it. Otherwise do nothing.
if existing_person is None:
self._add_unknown_speaker(person_list, speaker_id)
else:
# This is a known person but it may not have been added to the persons list.
# If it is not added, add new element.
if existing_person is None:
dep_info = self.name_map[key]
existing_person = self._add_person(
person_list, speaker_id,
dep_info.first_name.split(' '),
dep_info.last_name.split(' '), Gender.Male
if dep_info.gender == "M" else Gender.Female,
dep_info.image_url)
# This is a known person that has already been added to the person list.
self._update_speaker_affiliation(existing_person, session_date)
def _update_speaker_affiliation(self,
speaker,
session_date,
parliament_id="RoParl"):
"""Adds a new affiliation element to the person with the reference to the parliament term if it doesn't exist.
Parameters
----------
speaker: etree.Element, required
The `person` element for which to update affiliation.
session_date: date, required
The date of the session. It will be used to identify the parliament term.
parliament_id: str, optional
The id value of the parliament organization.
"""
logging.info("Updating speaker affiliation.")
term = None
for start_date, end_date, term_id in self.parliament_terms:
if (start_date <= session_date) and ((end_date is None) or
(session_date <= end_date)):
term = (start_date, end_date, term_id)
if term is None:
logging.warning("Could not find term for session date {}.".format(
str(session_date)))
return
start_date, end_date, term_id = term
speaker_id = speaker.get(XmlAttributes.xml_id)
if self._affiliation_exists(speaker_id, term_id):
logging.info("Affiliation {}--{} already exists.".format(
speaker_id, term_id))
return
new_affiliation = self._build_affiliation_element(
start_date, end_date, term_id, parliament_id)
speaker.append(new_affiliation)
if speaker_id not in self.person_affiliations:
self.person_affiliations[speaker_id] = set()
speaker_affiliations = self.person_affiliations[speaker_id]
speaker_affiliations.add(term_id)
def _affiliation_exists(self, speaker_id, term_id):
"""Checks if there is an affiliation element for the specified person, which references the specified term.
Parameters
----------
speaker_id: str, required
The id of the person.
term_id: str, required
The id of the legislative term.
Returns
-------
True if affiliation element exists; False otherwise.
"""
if speaker_id not in self.person_affiliations:
return False
affiliations = self.person_affiliations[speaker_id]
return term_id in affiliations
def _build_affiliation_element(self, start_date, end_date, term_id,
parliament_id):
"""Builds a new affiliation element.
Parameters
----------
start_date: date, required
The start date of the affiliation.
end_date: date, required
The end date of the affiliation; may be None.
term_id: str, required
The id of the legislative term representing the affiliation.
parliament_id: str, required
The id of the parliament organization.
Returns
-------
affiliation: etree.Element
The affiliation element.
"""
logging.info("Building new affiliation element.")
affiliation = etree.Element(XmlElements.affiliation)
affiliation.set(XmlAttributes.event_start,
format_date(start_date, "yyyy-MM-dd"))
if end_date is not None:
affiliation.set(XmlAttributes.event_end,
format_date(end_date, "yyyy-MM-dd"))
affiliation.set(XmlAttributes.ana, '#{}'.format(term_id))
affiliation.set(XmlAttributes.ref, '#{}'.format(parliament_id))
affiliation.set(XmlAttributes.role, 'member')
return affiliation
def _find_person_by_id(self, person_list, person_id):
"""Iterates over `person_list` to find the person with the provided id.
Parameters
----------
person_list: etree.Element, required
The element containing the list of persons.
person_id: str, required
The id of the person to find.
Returns
-------
person: etree.Element
The person with the specified id if found; None otherwise.
"""
logging.info("Looking up person with id #{}.".format(person_id))
if person_id in self.existing_persons:
logging.info(
"Person with id #{} already exists.".format(person_id))
return self.existing_persons[person_id]
return None
def _add_person(self,
person_list,
person_id,
first_name,
last_name,
gender,
image_url=None):
"""Adds a new `person` element to the element specified by `person_list` with the provided values.
Parameters
----------
person_list: etree.Element, required
The parent element to which to add a new person.
person_id: str, required
The id of the new person.
first_name: iterable of str, required
The parts of the first name.
last_name: iterable of str, required
The parts of the last name.
gender: str, required
Male of Female - the gender of the person to be added.
image_url: str, optional
The URL of the person image if exists.
Returns
-------
person: etree.Element
The newly added person.
"""
logging.info(
"Adding person with id {} to the person list.".format(person_id))
if self._contains_invalid_characters(person_id):
self._add_id_to_post_processing(person_id)
person = etree.SubElement(person_list, XmlElements.person)
person.set(XmlAttributes.xml_id, person_id)
person_name = etree.SubElement(person, XmlElements.persName)
for part in first_name:
forename = etree.SubElement(person_name, XmlElements.forename)
forename.text = part.capitalize()
for part in last_name:
surname = etree.SubElement(person_name, XmlElements.surname)
surname.text = part.capitalize()
sex = etree.SubElement(person, XmlElements.sex)
sex.set(XmlAttributes.value, gender[0])
sex.text = gender
if (image_url is not None) and (len(image_url) > 0):
logging.info("Person with id {} has image URL {}.".format(
person_id, image_url))
figure = etree.SubElement(person, XmlElements.figure)
graphic = etree.SubElement(figure, XmlElements.graphic)
graphic.set(XmlAttributes.url, image_url)
self.existing_persons[person_id] = person
return person
def _add_id_to_post_processing(self, id_string):
"""Adds the specified id_string to the list of ids to be replaced.
Parameters
----------
id_string: str, required
The id containing invalid characters.
"""
logging.info(
"Person id {} contains invalid characters.".format(id_string))
if id_string in self.ids_to_replace:
logging.info(
"Id {} is already in the post-processing list.".format(
id_string))
return
canonical_id = self._build_canonical_id(id_string)
logging.info("Scheduling id {} to be replaced with {}.".format(
id_string, canonical_id))
self.ids_to_replace[id_string] = canonical_id
def _build_canonical_id(self, id_string):
"""Builds a canonical form of the `id_string` by replacing invalid characters.
Parameters
----------
id_string: str, required
The id to make canonical.
Returns
-------
canonical_id: str
The id where all the invalid characters were replaced.
"""
invalid_characters = [
letter for letter in id_string
if letter in self.id_char_replacements
]
canonical_id = id_string
for c in invalid_characters:
replacement = self.id_char_replacements[c]
canonical_id = canonical_id.replace(c, replacement)
return canonical_id
def _contains_invalid_characters(self, id_string):
"""Checks if the provided id contains invalid characters.
Parameters
----------
id_string: str, required
The id to check.
Returns
-------
contains_invalid_chars: bool
True if id contains invalid characters; False otherwise.
"""
for letter in id_string:
if letter in self.id_char_replacements:
return True
return False
def _add_unknown_speaker(self, person_list, speaker_id):
"""Adds an unknown speaker to the list of persons by trying to guess its name and gender.
Parameters
----------
person_list: etree.Element, required
The element to which to add new speaker if it does not exist.
speaker_id: str, required
The id of the unknown speaker without the leading # symbol.
"""
logging.info(
"Id {} not found in name map. Inferring deputy info.".format(
speaker_id))
name_parts = speaker_id.split('-')
first_name = name_parts[:-1]
last_name = name_parts[-1:]
self._add_person(person_list, speaker_id, first_name, last_name,
self._guess_gender(first_name))
def _guess_gender(self, first_names):
"""Tries to guess the gender of a person by looking at its first names.
Parameters
----------
first_names: iterable of str, required
The first names of the person.
Returns
-------
gender: str
The values can be 'Male' or 'Female'.
"""
for part in first_names:
if part in self.male_names:
return Gender.Male
if part in self.female_names:
return Gender.Female
# None of the first names are known
# Try to infer the gender
for part in first_names:
if part[-1] == 'a':
return Gender.Female
return Gender.Male
def _split_names_by_gender(self):
"""Iterates over the names map and splits the first names into male and female specific.
"""
for dep_info in self.name_map.values():
first_names = dep_info.first_name.replace('-', ' ').split()
for first_name in first_names:
if dep_info.gender == 'M':
self.male_names.add(first_name)
else:
self.female_names.add(first_name)
def _update_tag_usage(self, corpus_component):
"""Updates the `tagUsage` element with the values from `corpus_component.
Parameters
----------
corpus_component: etree.ElementTree, required
The contents of the component file as an XML tree.
"""
logging.info("Updating tagUsage.")
tag_usage_component = {
tu.get(XmlAttributes.gi): int(tu.get(XmlAttributes.occurs))
for tu in corpus_component.iterdescendants(
tag=XmlElements.tagUsage)
}
tag_usage_root = {
tu.get(XmlAttributes.gi): tu
for tu in self.corpus_root.iterdescendants(
tag=XmlElements.tagUsage)
}
for tag_type, num_occurences in tag_usage_component.items():
elem = tag_usage_root[tag_type]
num_occurences = num_occurences + int(
elem.get(XmlAttributes.occurs))
logging.info("Setting {} tag usage to {} occurences.".format(
tag_type, num_occurences))
elem.set(XmlAttributes.occurs, str(num_occurences))
def _iter_files(self, corpus_dir, root_file):
"""Iterates over the files in the `corpus_dir` and skips `root_file`.
Parameters
----------
corpus_dir: pathlib.Path, required
The path of the corpus directory.
root_file: str, required
The name of the corpus root file to be skipped.
Returns
-------
file_path: generator of pathlib.Path
The generator that returns path of each component file.
"""
for file_path in corpus_dir.glob('*.xml'):
if not root_file in str(file_path):
yield file_path
def _parse_terms_list(self, parliament_id):
"""Builds a list of parliament terms with their dates and event ids.
Returns
-------
terms: list of (start_date, end_date, id) tuples
The terms of the parliament. The parts `start_date` and `end_date` are dates and `id` is str.
"""
parliament = None