From 801b505840b698858c48761c640d52a5fa5ec3fb Mon Sep 17 00:00:00 2001 From: Michael Williamson Date: Sat, 9 Jan 2021 13:52:02 +0000 Subject: Support numbering defined by paragraph style --- tests/docx/body_xml_tests.py | 38 +++++++++++++++++++++++++++++++++++--- tests/docx/numbering_xml_tests.py | 24 ++++++++++++++++++++++++ 2 files changed, 59 insertions(+), 3 deletions(-) (limited to 'tests') diff --git a/tests/docx/body_xml_tests.py b/tests/docx/body_xml_tests.py index 20f89a9..0f47ca2 100644 --- a/tests/docx/body_xml_tests.py +++ b/tests/docx/body_xml_tests.py @@ -9,6 +9,7 @@ import funk from mammoth import documents, results from mammoth.docx.xmlparser import element as xml_element, text as xml_text from mammoth.docx import body_xml +from mammoth.docx.numbering_xml import Numbering from mammoth.docx.relationships_xml import Relationships, Relationship from mammoth.docx.styles_xml import Styles, Style from .document_matchers import ( @@ -113,6 +114,26 @@ class ParagraphTests(object): assert_equal("1", paragraph.numbering.level_index) assert_equal(True, paragraph.numbering.is_ordered) + @istest + def numbering_on_paragraph_style_takes_precedence_over_numpr(self): + numbering_properties_xml = xml_element("w:numPr", {}, [ + xml_element("w:ilvl", {"w:val": "1"}), + xml_element("w:numId", {"w:val": "42"}), + ]) + properties_xml = xml_element("w:pPr", {}, [ + xml_element("w:pStyle", {"w:val": "List"}), + numbering_properties_xml, + ]) + paragraph_xml = xml_element("w:p", {}, [properties_xml]) + + numbering = _NumberingMap( + nums={"42": {"1": documents.numbering_level("1", False)}}, + levels_by_paragraph_style_id={"List": documents.numbering_level("1", True)} + ) + paragraph = _read_and_get_document_xml_element(paragraph_xml, numbering=numbering) + + assert_equal(True, paragraph.numbering.is_ordered) + @istest def numbering_properties_are_ignored_if_lvl_is_missing(self): paragraph_xml = self._paragraph_with_numbering_properties([ @@ -1200,8 +1221,9 @@ def _read_and_get_document_xml_elements(*args, **kwargs): def _read_and_get_document_xml(func, *args, **kwargs): + numbering = kwargs.pop("numbering", Numbering.EMPTY) styles = kwargs.pop("styles", FakeStyles()) - result = _read_document_xml(func, *args, styles=styles, **kwargs) + result = _read_document_xml(func, *args, numbering=numbering, styles=styles, **kwargs) assert_equal([], result.messages) return result.value @@ -1221,7 +1243,8 @@ def _read_document_xml_elements(*args, **kwargs): def _read_document_xml(func, element, *args, **kwargs): - reader = body_xml.reader(*args, **kwargs) + numbering = kwargs.pop("numbering", Numbering.EMPTY) + reader = body_xml.reader(*args, numbering=numbering, **kwargs) return func(reader, element) @@ -1338,8 +1361,17 @@ def _image_relationship(relationship_id, target): class _NumberingMap(object): - def __init__(self, nums): + def __init__(self, nums=None, levels_by_paragraph_style_id=None): + if nums is None: + nums = {} + if levels_by_paragraph_style_id is None: + levels_by_paragraph_style_id = {} + self._nums = nums + self._levels_by_paragraph_style_id = levels_by_paragraph_style_id def find_level(self, num_id, level): return self._nums[num_id][level] + + def find_level_by_paragraph_style_id(self, style_id): + return self._levels_by_paragraph_style_id.get(style_id) diff --git a/tests/docx/numbering_xml_tests.py b/tests/docx/numbering_xml_tests.py index b707ba1..45102c7 100644 --- a/tests/docx/numbering_xml_tests.py +++ b/tests/docx/numbering_xml_tests.py @@ -74,6 +74,30 @@ def when_abstract_num_has_num_style_link_then_style_is_used_to_find_num(): assert_equal(True, numbering.find_level("201", "0").is_ordered) +# See: 17.9.23 pStyle (Paragraph Style's Associated Numbering Level) in ECMA-376, 4th Edition +@istest +def numbering_level_can_be_found_by_paragraph_style_id(): + numbering = _read_numbering_xml_element( + xml_element("w:numbering", {}, [ + xml_element("w:abstractNum", {"w:abstractNumId": "42"}, [ + xml_element("w:lvl", {"w:ilvl": "0"}, [ + xml_element("w:numFmt", {"w:val": "bullet"}), + ]), + ]), + xml_element("w:abstractNum", {"w:abstractNumId": "43"}, [ + xml_element("w:lvl", {"w:ilvl": "0"}, [ + xml_element("w:pStyle", {"w:val": "List"}), + xml_element("w:numFmt", {"w:val": "decimal"}), + ]), + ]), + ]), + styles=Styles.create(numbering_styles={"List1": NumberingStyle(num_id="200")}), + ) + + assert_equal(True, numbering.find_level_by_paragraph_style_id("List").is_ordered) + assert_equal(None, numbering.find_level_by_paragraph_style_id("Paragraph")) + + def _read_numbering_xml_element(element, styles=None): if styles is None: styles = Styles.EMPTY -- cgit v1.2.3