Implemented working solution in the OXML layer

Benjamin-T · Benjamin-T · commit 2e9971f4e742 · 2017-11-17T19:05:40.000+01:00
diff --git a/docx/document.py b/docx/document.py
@@ -14,7 +14,7 @@
 from .section import Section, Sections
 from docx.shared import ElementProxy, Emu
 from docx.text.bookmarks import Bookmark, Bookmarks
-from docx.oxml.xmlchemy import BaseOxmlElement, ZeroOrOne, ZeroOrMore
+from docx.oxml.xmlchemy import ZeroOrOne, ZeroOrMore
 
 
 class Document(ElementProxy):
@@ -30,16 +30,16 @@ def __init__(self, element, part):
         self._part = part
         self.__body = None
 
-    def bookmark(self):
-        return Bookmarks(self._element.body)
-    # def add_bookmark_start(self, name):
-    #     paragraph = self.add_paragraph()
-    #     return paragraph.add_bookmark_start(id, name)
+    def start_bookmark(self, name):
+        bookmarkstart = self._body.add_bookmarkStart(name)
+        return Bookmark(bookmarkstart)
+
+    def end_bookmark(self, name=None):
+        bookmarkend = self._body.add_bookmarkEnd(name)
+        return Bookmark(bookmarkend)
 
-    # def add_bookmark_end(self, name):
-    #     id = 1
-    #     paragraph = self.add_paragraph()
-    #     return paragraph.add_bookmark_end(id)
+    def bookmarks(self):
+        return Bookmarks(self._element.body)
 
     def add_heading(self, text='', level=1):
         """
@@ -227,3 +227,19 @@ def clear_content(self):
         """
         self._body.clear_content()
         return self
+
+    def add_bookmarkStart(self, name):
+        bookmarkStart = self._body._add_bookmarkStart()
+        bookmarkStart.name = name
+        bookmarkStart.bmrk_id = bookmarkStart._next_id
+        return Bookmark(bookmarkStart)
+
+    def add_bookmarkEnd(self, name=None):
+        
+        bookmarkEnd = self._body._add_bookmarkEnd()
+        if name is not None:
+            bookmarkStart_id = bookmarkEnd.match_bookmarkstart(name)
+        else:
+            bookmarkStart_id = bookmarkEnd._next_id
+        bookmarkEnd.bmrk_id = bookmarkStart_id
+        return Bookmark(bookmarkEnd)
diff --git a/docx/oxml/bookmark.py b/docx/oxml/bookmark.py
@@ -16,10 +16,32 @@ class CT_BookmarkStart(BaseOxmlElement):
     """
     name = RequiredAttribute('w:name', ST_String)
     bmrk_id = RequiredAttribute('w:id', ST_RelationshipId)
+    
+    @property
+    def _next_id(self):
+        root = self.getroottree().getroot()
+        return str(len(root.xpath('.//w:bookmarkStart')))
+
 
 
 class CT_BookmarkEnd(BaseOxmlElement):
     """
     The ``<w:bookmarkEnd>`` element
     """
     bmrk_id = RequiredAttribute('w:id', ST_RelationshipId)
+
+    @property
+    def _next_id(self):
+        root = self.getroottree().getroot()
+        return str(len(root.xpath('.//w:bookmarkStart')))
+
+    def match_bookmarkstart(self, name):
+        """Returns `w:bookmarkStart` element having matching name, None if not present."""
+        root_element = self.getroottree().getroot() 
+        matching_bookmarkStarts = root_element.xpath(
+            './/w:bookmarkStart[@w:name=\'%s\']' % name
+        )
+        if not matching_bookmarkStarts:
+            raise ValueError('Bookmark name not found')
+            return None
+        return matching_bookmarkStarts[0].bmrk_id
diff --git a/docx/oxml/document.py b/docx/oxml/document.py
@@ -13,8 +13,7 @@ class CT_Document(BaseOxmlElement):
     ``<w:document>`` element, the root element of a document.xml file.
     """
     body = ZeroOrOne('w:body')
-    bookmarkStart = ZeroOrMore('w:bookmarkStart')
-    bookmarkEnd = ZeroOrMore('w:bookmarkEnd')
+
     @property
     def sectPr_lst(self):
         """
@@ -31,10 +30,10 @@ class CT_Body(BaseOxmlElement):
     """
     p = ZeroOrMore('w:p', successors=('w:sectPr',))
     tbl = ZeroOrMore('w:tbl', successors=('w:sectPr',))
+    bookmarkStart = ZeroOrMore('w:bookmarkStart', successors=('w:sectPr',))
+    bookmarkEnd = ZeroOrMore('w:bookmarkEnd', successors=('w:sectPr',))
     sectPr = ZeroOrOne('w:sectPr', successors=())
-    bookmarkStart = ZeroOrMore('w:bookmarkStart')
-    bookmarkEnd = ZeroOrMore('w:bookmarkEnd')
-    
+
     def add_section_break(self):
         """
         Return the current ``<w:sectPr>`` element after adding a clone of it
diff --git a/docx/oxml/text/paragraph.py b/docx/oxml/text/paragraph.py
@@ -15,8 +15,8 @@ class CT_P(BaseOxmlElement):
     """
     pPr = ZeroOrOne('w:pPr')
     r = ZeroOrMore('w:r')
-    bookmarkStart = ZeroOrMore('w:bookmarkStart')
-    bookmarkEnd = ZeroOrMore('w:bookmarkEnd')
+    bookmarkStart = ZeroOrMore('w:bookmarkStart', successors=('w:sectPr',))
+    bookmarkEnd = ZeroOrMore('w:bookmarkEnd', successors=('w:sectPr',))
 
     def _insert_pPr(self, pPr):
         self.insert(0, pPr)
diff --git a/docx/oxml/text/run.py b/docx/oxml/text/run.py
@@ -29,8 +29,8 @@ class CT_R(BaseOxmlElement):
     cr = ZeroOrMore('w:cr')
     tab = ZeroOrMore('w:tab')
     drawing = ZeroOrMore('w:drawing')
-    bookmarkStart = ZeroOrMore('w:bookmarkStart')
-    bookmarkEnd = ZeroOrMore('w:bookmarkEnd')
+    bookmarkStart = ZeroOrMore('w:bookmarkStart', successors=('w:sectPr',))
+    bookmarkEnd = ZeroOrMore('w:bookmarkEnd', successors=('w:sectPr',))
 
     def _insert_rPr(self, rPr):
         self.insert(0, rPr)
diff --git a/docx/text/bookmarks.py b/docx/text/bookmarks.py
@@ -35,26 +35,27 @@ def get(self, name, default=None):
                 return Bookmark(bookmarkStart)
         return default
 
-    def add_bookmark(self):
-        return Bookmark(self._element)
-
     @property
     def _bookmarkStarts(self):
         return self._document.xpath('.//w:bookmarkStart')
 
+    @property
+    def _bookmarkEnds(self):
+        return self._document.xpath('.//w:bookmarkEnd')
+
+    @property
+    def _next_id(self):
+        return str(len(self._bookmarkStarts))
 
 class Bookmark(ElementProxy):
     def __init__(self, doc_element):
         super(Bookmark, self).__init__(doc_element)
         self._element = doc_element
 
-    def add_bookmark_start(self, id, name):
-        bmrk = self._element._add_bookmarkStart()
-        bmrk.name = name
-        bmrk.bmrk_id = str(id)
-        return self._element.append(bmrk)
+    @property
+    def _id(self):
+        return self._element.bmrk_id
 
-    def add_bookmark_end(self, id):
-        bmrk = self._element._add_bookmarkEnd()
-        bmrk.bmrk_id = str(1)
-        return self._element.append(bmrk)
+    @property
+    def _name(self):
+        return self._element.name
