bmk: add _PartBookmarkFinder._iter_starts()

Benjamin Toornstra · scanny · commit e67fe2675bac · 2019-07-13T16:34:35.000-07:00
diff --git a/docx/bookmark.py b/docx/bookmark.py
@@ -6,6 +6,7 @@
 
 from itertools import chain
 
+from docx.oxml.ns import qn
 from docx.shared import lazyproperty
 
 
@@ -78,13 +79,23 @@ def _iter_start_end_pairs(self):
                 continue
             yield (bookmarkStart, bookmarkEnd)
 
+    @lazyproperty
+    def _all_starts_and_ends(self):
+        """list of all `w:bookmarkStart` and `w:bookmarkEnd` elements in part.
+
+        Elements appear in document order.
+        """
+        raise NotImplementedError
+
     def _iter_starts(self):
         """Generate (idx, bookmarkStart) elements in story.
 
         The *idx* value indicates the location of the bookmarkStart element
         among all the bookmarkStart and bookmarkEnd elements in the story.
         """
-        raise NotImplementedError
+        for idx, element in enumerate(self._all_starts_and_ends):
+            if element.tag == qn("w:bookmarkStart"):
+                yield idx, element
 
     def _matching_end(self, bookmarkStart, idx):
         """Return the `w:bookmarkEnd` element corresponding to *bookmarkStart*.
diff --git a/tests/test_bookmark.py b/tests/test_bookmark.py
@@ -164,8 +164,30 @@ def it_iterates_start_end_pairs_to_help(
             (bookmarkStarts[2], bookmarkEnds[2]),
         ]
 
+    def it_iterates_bookmarkStart_elements_to_help(self, _all_starts_and_ends_prop_):
+        starts_and_ends = (
+            element("w:bookmarkStart"),
+            element("w:bookmarkEnd"),
+            element("w:bookmarkStart"),
+            element("w:bookmarkEnd"),
+            element("w:bookmarkStart"),
+            element("w:bookmarkEnd"),
+        )
+        _all_starts_and_ends_prop_.return_value = list(starts_and_ends)
+        finder = _PartBookmarkFinder(None)
+
+        starts = list(finder._iter_starts())
+
+        assert starts == [
+            (0, starts_and_ends[0]), (2, starts_and_ends[2]), (4, starts_and_ends[4])
+        ]
+
     # fixture components ---------------------------------------------
 
+    @pytest.fixture
+    def _all_starts_and_ends_prop_(self, request):
+        return property_mock(request, _PartBookmarkFinder, '_all_starts_and_ends')
+
     @pytest.fixture
     def _init_(self, request):
         return initializer_mock(request, _PartBookmarkFinder)
