doc: add DocumentPart.numbering_part

Steve Canny · Steve Canny · commit 382073ee408e · 2015-02-15T01:12:23.000-08:00
diff --git a/docx/parts/document.py b/docx/parts/document.py
@@ -12,6 +12,7 @@
 
 from ..blkcntnr import BlockItemContainer
 from ..document import Document
+from .numbering import NumberingPart
 from ..opc.constants import RELATIONSHIP_TYPE as RT
 from ..opc.part import XmlPart
 from ..section import Section
@@ -98,6 +99,20 @@ def next_id(self):
             if n not in used_ids:
                 return n
 
+    @lazyproperty
+    def numbering_part(self):
+        """
+        A |NumberingPart| object providing access to the numbering
+        definitions for this document. Creates an empty numbering part if one
+        is not present.
+        """
+        try:
+            return self.part_related_by(RT.NUMBERING)
+        except KeyError:
+            numbering_part = NumberingPart.new()
+            self.relate_to(numbering_part, RT.NUMBERING)
+            return numbering_part
+
     @property
     def paragraphs(self):
         """
diff --git a/features/num-access-numbering-part.feature b/features/num-access-numbering-part.feature
@@ -4,7 +4,6 @@ Feature: Access the document numbering part
   I need access to the numbering part of the document
 
 
-  @wip
   Scenario: Get an existing numbering part from document
     Given a document having a numbering part
      When I get the numbering part from the document
diff --git a/tests/parts/test_document.py b/tests/parts/test_document.py
@@ -15,6 +15,7 @@
 from docx.package import ImageParts, Package
 from docx.parts.document import _Body, DocumentPart, InlineShapes, Sections
 from docx.parts.image import ImagePart
+from docx.parts.numbering import NumberingPart
 from docx.parts.styles import StylesPart
 from docx.section import Section
 from docx.shape import InlineShape
@@ -74,6 +75,21 @@ def it_provides_access_to_the_inline_shapes_in_the_document(
         InlineShapes_.assert_called_once_with(body_elm, document)
         assert inline_shapes is InlineShapes_.return_value
 
+    def it_provides_access_to_the_numbering_part(self, nmprt_get_fixture):
+        document_part, numbering_part_ = nmprt_get_fixture
+        numbering_part = document_part.numbering_part
+        document_part.part_related_by.assert_called_once_with(RT.NUMBERING)
+        assert numbering_part is numbering_part_
+
+    def it_creates_numbering_part_if_not_present(self, nmprt_create_fixture):
+        document_part, NumberingPart_, numbering_part_ = nmprt_create_fixture
+        numbering_part = document_part.numbering_part
+        NumberingPart_.new.assert_called_once_with()
+        document_part.relate_to.assert_called_once_with(
+            numbering_part_, RT.NUMBERING
+        )
+        assert numbering_part is numbering_part_
+
     def it_can_add_an_image_part_to_the_document(
             self, get_or_add_image_fixture):
         (document, image_descriptor_, image_parts_, relate_to_, image_part_,
@@ -182,6 +198,20 @@ def next_id_fixture(self, request):
         document = DocumentPart(None, None, document_elm, None)
         return document, expected_id
 
+    @pytest.fixture
+    def nmprt_create_fixture(self, part_related_by_, relate_to_,
+                             NumberingPart_, numbering_part_):
+        document_part = DocumentPart(None, None, None, None)
+        part_related_by_.side_effect = KeyError
+        NumberingPart_.new.return_value = numbering_part_
+        return document_part, NumberingPart_, numbering_part_
+
+    @pytest.fixture
+    def nmprt_get_fixture(self, part_related_by_, numbering_part_):
+        document_part = DocumentPart(None, None, None, None)
+        part_related_by_.return_value = numbering_part_
+        return document_part, numbering_part_
+
     @pytest.fixture
     def paragraphs_fixture(self, document_part_body_, body_, paragraphs_):
         document_part = DocumentPart(None, None, None, None)
@@ -271,6 +301,14 @@ def image_parts_(self, request, image_part_):
     def InlineShapes_(self, request):
         return class_mock(request, 'docx.parts.document.InlineShapes')
 
+    @pytest.fixture
+    def NumberingPart_(self, request):
+        return class_mock(request, 'docx.parts.document.NumberingPart')
+
+    @pytest.fixture
+    def numbering_part_(self, request):
+        return instance_mock(request, NumberingPart)
+
     @pytest.fixture
     def p_(self, request):
         return instance_mock(request, Paragraph)
