par: add Paragraph._bookmarks

python-openxml · Benjamin-T · Nov 15, 2017 · Aug 25, 2018 · Jul 13, 2019 · Aug 25, 2018
commit 89ef8b72cf8e19327323b05fb04862e63f54f3cf
diff --git a/docx/text/paragraph.py b/docx/text/paragraph.py
@@ -57,7 +57,7 @@ def alignment(self, value):
     @lazyproperty
     def _bookmarks(self):
         """Global |Bookmarks| object for overall document."""
-        raise NotImplementedError
+        return self.part.bookmarks
 
     def clear(self):
         """
@@ -67,6 +67,10 @@ def clear(self):
         self._p.clear_content()
         return self
 
+    def end_bookmark(self, bookmark):
+        """Closes supplied bookmark at the end of this paragraph."""
+        raise NotImplementedError
+
     def insert_paragraph_before(self, text=None, style=None):
         """
         Return a newly created paragraph, inserted directly before this

diff --git a/features/par-paragraph.feature b/features/par-paragraph.feature
@@ -3,7 +3,7 @@ Feature: Paragraph properties and methods
   As a developer using python-docx
   I need properties and methods on the Paragraph object
 
-  @wip
+
   Scenario: Paragraph.start_bookmark()
     Given a Paragraph object as paragraph
      When I assign bookmark = paragraph.start_bookmark("Target")

diff --git a/tests/text/test_paragraph.py b/tests/text/test_paragraph.py
@@ -11,11 +11,11 @@
 from docx.oxml.text.paragraph import CT_P
 from docx.oxml.text.run import CT_R
 from docx.parts.document import DocumentPart
+from docx.parts.hdrftr import FooterPart, HeaderPart
 from docx.text.paragraph import Paragraph
 from docx.text.parfmt import ParagraphFormat
 from docx.text.run import Run
 from docx.bookmark import _Bookmark, Bookmarks
-from docx.blkcntnr import BlockItemContainer
 
 from ..unitutil.cxml import element, xml
 from ..unitutil.mock import (
@@ -93,6 +93,18 @@ def it_provides_access_to_its_paragraph_format(self, parfmt_fixture):
         ParagraphFormat_.assert_called_once_with(paragraph._element)
         assert paragraph_format is paragraph_format_
 
+    def it_provides_access_to_the_global_bookmarks_collection_to_help(
+        self, bookmarks_fixture, part_prop_, bookmarks_
+    ):
+        parent_part_ = bookmarks_fixture
+        parent_part_.bookmarks = bookmarks_
+        part_prop_.return_value = parent_part_
+        blkcntnr = Paragraph(None, None)
+
+        bookmarks = blkcntnr._bookmarks
+
+        assert bookmarks is bookmarks_
+
     def it_provides_access_to_the_runs_it_contains(self, runs_fixture):
         paragraph, Run_, r_, r_2_, run_, run_2_ = runs_fixture
         runs = paragraph.runs
@@ -176,6 +188,12 @@ def alignment_set_fixture(self, request):
         expected_xml = xml(expected_cxml)
         return paragraph, new_alignment_value, expected_xml
 
+    @pytest.fixture(params=[DocumentPart, HeaderPart, FooterPart])
+    def bookmarks_fixture(self, request):
+        PartCls = request.param
+        parent_part_ = instance_mock(request, PartCls)
+        return parent_part_
+
     @pytest.fixture(
         params=[
             ("w:p", "w:p"),