adriano/formex-viewer
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix: Preserve XML tree order in Formex parser

Browse Source
This commit is contained in:
Adrian Rumpold
2025-05-20 09:05:32 +02:00
parent 56b5e3e3a4
commit f0d4214d17
4 changed files with 524 additions and 432 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
pyproject.toml
View File

@@ -20,3 +20,8 @@ formex-viewer = "formex_viewer:main"
[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"
[dependency-groups]
dev = [
"pytest>=8.3.5",
]

129
src/formex_viewer/formex4.py
View File

@@ -81,7 +81,7 @@ def extract_xrefs(el: ET._Element, language: Language) -> list[CrossReference]:
)
parag_num = match.groupdict().get("parag_num")
if not parag_num or key not in ["article", "annex"]:
if key not in ["article", "annex"]:
raise RuntimeError()
crossref_text = match.group(0)
@@ -89,7 +89,7 @@ def extract_xrefs(el: ET._Element, language: Language) -> list[CrossReference]:
CrossReference(
target=key,
id=crossref_id,
paragraph=int(parag_num),
paragraph=int(parag_num) if parag_num else None,
text=crossref_text,
)
)
@@ -360,32 +360,31 @@ class FormexArticleConverter:
identifier = parag.get("IDENTIFIER", "")
parag_id = self._create_id(identifier) if identifier else ""
# Get the paragraph number using XPath
no_parag_elems = parag.xpath(f"./{self._get_tag('NO.PARAG')}")
parag_num = self._get_text(no_parag_elems[0]) if no_parag_elems else ""
# Process the alineas within the paragraph
content = ""
for alinea in parag.xpath(f"./{self._get_tag('ALINEA')}"):
content += self._convert_alinea(alinea)
# Process any comments
for comment in parag.xpath(f"./{self._get_tag('COMMENT')}"):
content += f'<div class="comment">{self._convert_btx(comment)}</div>'
# Process any quotations
for quot in parag.xpath(f"./{self._get_tag('QUOT.S')}"):
for child in parag.iterchildren(tag="*"):
child_tag = child.tag.replace(self.ns_prefix, "")
if child_tag == "ALINEA":
content += self._convert_alinea(child)
elif child_tag == "COMMENT":
content += f'<div class="comment">{self._convert_btx(child)}</div>'
elif child_tag == "QUOT.S":
content += f'<blockquote class="quotation">{self._convert_btx(child)}</blockquote>'
elif child_tag == "NO.PARAG":
content += (
f'<blockquote class="quotation">{self._convert_btx(quot)}</blockquote>'
f'<span class="paragraph-number">{self._convert_btx(child)}</span>'
)
else:
raise RuntimeError(
f"Unexpected child element '{child_tag}' in PARAG: {text_content(child)}"
)
return f'<div class="paragraph" data-paragraph-id="{parag_id}"><span class="paragraph-number">{parag_num}</span>{content}</div>'
return f'<div class="paragraph" data-paragraph-id="{parag_id}">{content}</div>'
def _convert_subdiv(self, subdiv: ET._Element) -> str:
"""Convert a SUBDIV (subdivision) element to HTML."""
# Get the title using XPath
title_elems = subdiv.xpath(f"./{self._get_tag('TITLE')}")
"""Convert a SUBDIV (subdivision) element to HTML, preserving child order."""
# Get the title using XPath (should be the first TITLE child if present)
title = ""
title_elems = subdiv.xpath(f"./{self._get_tag('TITLE')}")
if title_elems:
title_elem = title_elems[0]
# Process TI (title) and STI (subtitle) elements
@@ -400,31 +399,27 @@ class FormexArticleConverter:
if sti_list:
title += f'<h5 class="subdivision-subtitle">{" ".join(sti_list)}</h5>'
# Process content: either paragraphs, alineas, or nested subdivisions
# Process all children in order, skipping TITLE (already handled)
content = ""
# Process paragraphs directly under this subdivision
for parag in subdiv.xpath(f"./{self._get_tag('PARAG')}"):
content += self._convert_parag(parag)
# Process alineas directly under this subdivision
for alinea in subdiv.xpath(f"./{self._get_tag('ALINEA')}"):
content += self._convert_alinea(alinea)
# Process comments directly under this subdivision
for comment in subdiv.xpath(f"./{self._get_tag('COMMENT')}"):
content += f'<div class="comment">{self._convert_btx(comment)}</div>'
# Process quotations directly under this subdivision
for quot in subdiv.xpath(f"./{self._get_tag('QUOT.S')}"):
content += (
f'<blockquote class="quotation">{self._convert_btx(quot)}</blockquote>'
for child in subdiv.iterchildren(tag="*"):
child_tag = child.tag.replace(self.ns_prefix, "")
if child_tag == "TITLE":
continue # already handled
elif child_tag == "PARAG":
content += self._convert_parag(child)
elif child_tag == "ALINEA":
content += self._convert_alinea(child)
elif child_tag == "COMMENT":
content += f'<div class="comment">{self._convert_btx(child)}</div>'
elif child_tag == "QUOT.S":
content += f'<blockquote class="quotation">{self._convert_btx(child)}</blockquote>'
elif child_tag == "SUBDIV":
content += self._convert_subdiv(child)
else:
raise RuntimeError(
f"Unexpected child element '{child_tag}' in SUBDIV: {text_content(child)}"
)
# Process nested subdivisions directly under this subdivision
for sub in subdiv.xpath(f"./{self._get_tag('SUBDIV')}"):
content += self._convert_subdiv(sub)
return f'<section class="subdivision">{title}{content}</section>'
def convert_article(self, article: Union[str, ET._Element]) -> str:
@@ -477,35 +472,25 @@ class FormexArticleConverter:
# Process the content based on what's present
content = ""
# Check if we have alineas directly under the article
alineas = article.xpath(f"./{self._get_tag('ALINEA')}")
if alineas:
for alinea in alineas:
content += self._convert_alinea(alinea)
# Check if we have paragraphs directly under the article
parags = article.xpath(f"./{self._get_tag('PARAG')}")
if parags:
for parag in parags:
content += self._convert_parag(parag)
# Check for comments directly under the article
comments = article.xpath(f"./{self._get_tag('COMMENT')}")
if comments:
for comment in comments:
content += f'<div class="comment">{self._convert_btx(comment)}</div>'
# Check for quotations directly under the article
quots = article.xpath(f"./{self._get_tag('QUOT.S')}")
if quots:
for quot in quots:
content += f'<blockquote class="quotation">{self._convert_btx(quot)}</blockquote>'
# Check for subdivisions directly under the article
subdivs = article.xpath(f"./{self._get_tag('SUBDIV')}")
if subdivs:
for subdiv in subdivs:
content += self._convert_subdiv(subdiv)
# Process all child elements (except TITLE) in tree order
for child in article.iterchildren(tag="*"):
child_tag = child.tag.replace(self.ns_prefix, "")
if child_tag in ["TI.ART", "STI.ART"]:
continue # already handled
elif child_tag == "ALINEA":
content += self._convert_alinea(child)
elif child_tag == "PARAG":
content += self._convert_parag(child)
elif child_tag == "COMMENT":
content += f'<div class="comment">{self._convert_btx(child)}</div>'
elif child_tag == "QUOT.S":
content += f'<blockquote class="quotation">{self._convert_btx(child)}</blockquote>'
elif child_tag == "SUBDIV":
content += self._convert_subdiv(child)
else:
raise RuntimeError(
f"Unexpected child element '{child_tag}' in ARTICLE: {text_content(child)}"
)
# Assemble the complete article
return f'<article id="{article_id}" class="formex-article">{header}<div class="article-content">{content}</div></article>'

52
tests/test_parser.py Normal file
View File

@@ -0,0 +1,52 @@
import pytest
from lxml import etree as ET
from formex_viewer.formex4 import FormexArticleConverter
from formex_viewer.main import Language
@pytest.fixture
def converter():
return FormexArticleConverter(language=Language.ENG)
def test_convert_tree_order(converter):
"""Test that the order of HTML blocks in the converted article matches the order of elements in the XML tree."""
xml = """
<ARTICLE>
<SUBDIV>
<TITLE>
<TI>Subdivision Title</TI>
<STI>Subdivision Subtitle</STI>
</TITLE>
<PARAG IDENTIFIER="001.001">
<NO.PARAG>1</NO.PARAG>
<ALINEA>Paragraph 1 text.</ALINEA>
</PARAG>
<COMMENT>Comment text.</COMMENT>
<ALINEA>Alinea text.</ALINEA>
<QUOT.S>Quotation text.</QUOT.S>
<SUBDIV>
<TITLE>
<TI>Nested Subdivision</TI>
</TITLE>
<ALINEA>Nested alinea.</ALINEA>
</SUBDIV>
</SUBDIV>
</ARTICLE>
"""
parser = ET.XMLParser(remove_blank_text=True)
el = ET.fromstring(xml, parser)
html = converter.convert_article(el)
# Check that the order of HTML blocks matches the order of elements in the XML tree
idx_title = html.index("Subdivision Title")
idx_parag = html.index('class="paragraph"')
idx_comment = html.index("Comment text.")
idx_alinea = html.index("Alinea text.")
idx_quot = html.index("Quotation text.")
idx_nested = html.index("Nested Subdivision")
# The order in the XML: title, parag, alinea, comment, quot, nested subdiv
assert idx_title < idx_parag < idx_comment < idx_alinea < idx_quot < idx_nested

764
uv.lock generated
View File

File diff suppressed because it is too large Load Diff