num: add NumberingPart.numbering_definitions

Steve Canny · Steve Canny · commit 0340c71a2f83 · 2014-02-02T14:44:48.000-08:00
diff --git a/docx/parts/numbering.py b/docx/parts/numbering.py
@@ -10,6 +10,7 @@
 
 from ..opc.package import Part
 from ..oxml.shared import oxml_fromstring
+from ..shared import lazyproperty
 
 
 class NumberingPart(Part):
@@ -39,3 +40,21 @@ def new(cls):
         ``<w:numbering>`` element.
         """
         raise NotImplementedError
+
+    @lazyproperty
+    def numbering_definitions(self):
+        """
+        The |_NumberingDefinitions| instance containing the numbering
+        definitions (<w:num> element proxies) for this numbering part.
+        """
+        return _NumberingDefinitions(self._element)
+
+
+class _NumberingDefinitions(object):
+    """
+    Collection of |_NumberingDefinition| instances corresponding to the
+    ``<w:num>`` elements in a numbering part.
+    """
+    def __init__(self, numbering_elm):
+        super(_NumberingDefinitions, self).__init__()
+        self._numbering = numbering_elm
diff --git a/tests/parts/test_numbering.py b/tests/parts/test_numbering.py
@@ -13,10 +13,10 @@
 from docx.opc.packuri import PackURI
 from docx.oxml.parts.numbering import CT_Numbering
 from docx.package import Package
-from docx.parts.numbering import NumberingPart
+from docx.parts.numbering import NumberingPart, _NumberingDefinitions
 
 from ..unitutil import (
-    function_mock, initializer_mock, instance_mock, method_mock
+    function_mock, class_mock, initializer_mock, instance_mock, method_mock
 )
 
 
@@ -51,6 +51,14 @@ def it_can_be_constructed_by_opc_part_factory(self, construct_fixture):
         )
         assert isinstance(numbering_part, NumberingPart)
 
+    def it_provides_access_to_the_numbering_definitions(
+            self, num_defs_fixture):
+        (numbering_part, _NumberingDefinitions_, numbering_elm_,
+         numbering_definitions_) = num_defs_fixture
+        numbering_definitions = numbering_part.numbering_definitions
+        _NumberingDefinitions_.assert_called_once_with(numbering_elm_)
+        assert numbering_definitions is numbering_definitions_
+
     # fixtures -------------------------------------------------------
 
     @pytest.fixture
@@ -83,6 +91,27 @@ def load_fixture(
             numbering_part_load_, partname_, blob_, package_, numbering_part_
         )
 
+    @pytest.fixture
+    def _NumberingDefinitions_(self, request, numbering_definitions_):
+        return class_mock(
+            request, 'docx.parts.numbering._NumberingDefinitions',
+            return_value=numbering_definitions_
+        )
+
+    @pytest.fixture
+    def num_defs_fixture(
+            self, _NumberingDefinitions_, numbering_elm_,
+            numbering_definitions_):
+        numbering_part = NumberingPart(None, None, numbering_elm_, None)
+        return (
+            numbering_part, _NumberingDefinitions_, numbering_elm_,
+            numbering_definitions_
+        )
+
+    @pytest.fixture
+    def numbering_definitions_(self, request):
+        return instance_mock(request, _NumberingDefinitions)
+
     @pytest.fixture
     def numbering_elm_(self, request):
         return instance_mock(request, CT_Numbering)
