Merge pull request python-openxml#7 from BayooG/feature/add_comments_on_run_level

BayooG · web-flow · commit 2e68bb322e71 · 2020-05-02T19:21:13.000+03:00
Feature/add comments on run level
diff --git a/HISTORY.rst b/HISTORY.rst
@@ -4,13 +4,13 @@
 #Release History BayooG/bayoo-docx forked from (python-openxmm/python-docx)
 
 
-###0.2.7 (2020-05-01)
-
+0.2.8 (2020-05-02)
 
+- add comments implementation on a run level
 - fix issue with comments date (comments dates are set to current date)
 
 
-###0.2.4 (2019-9-4)
+0.2.4 (2019-9-4)
 
 - loop over all the document chieldern (Paragraphs, Tables, Sections) with the right order `document.elements`
 - addons to Paragraph Object (delete, heading_level, merge_paragraph )
diff --git a/README.rst b/README.rst
@@ -1,33 +1,42 @@
-#Bayoo-docx
+Bayoo-docx
+==========
 
 Python library forked from  `python-docx <github.com/python-openxml/python-docx/>`_.
 
 The main purpose of the fork was to add implementation for comments and footnotes to the library
 
-##Installation
-
+Installation
+------------
 
 Use the package manager `pip <pypi.org/project/bayoo-docx/>`_ to install bayoo-docx.
 
 
 `pip install bayoo-docx`
 
-##Usage
+Usage
+-----
 
 ::
     
     import docx
     
     document = docx.Document()
 
-    paragraph = document.add_paragraph('text') # create new paragraph
+    paragraph1 = document.add_paragraph('text') # create new paragraph
+
+    comment = paragraph.add_comment('comment',author='Obay Daba',initials= 'od') # add a comment on the entire paragraph
+
+    paragraph2 = document.add_paragraph('text') # create another paragraph
+
+    run = paragraph2.add_run('texty') add a run to the paragraph
 
-    comment = paragraph.add_comment('comment',author='Obay Daba',initials= 'od') # create a comment'
+    run.add_comment('comment') # add a comment only for the run text 
 
     paragraph.add_footnote('footnote text') # add a footnote
 
 
 
-##License
+License
+-------
 
 `MIT <https://choosealicense.com/licenses/mit/>`_
diff --git a/docx/__init__.py b/docx/__init__.py
@@ -2,7 +2,7 @@
 
 from docx.api import Document  # noqa
 
-__version__ = '0.2.7' 
+__version__ = '0.2.8' 
 
 
 # register custom Part classes with opc package reader
diff --git a/docx/oxml/text/run.py b/docx/oxml/text/run.py
@@ -58,6 +58,24 @@ def add_drawing(self, inline_or_anchor):
         drawing.append(inline_or_anchor)
         return drawing
 
+    def add_comm(self, author, comment_part, initials, dtime, comment_text):
+        
+        comment = comment_part.add_comment(author, initials, dtime)
+        comment._add_p(comment_text)
+        # _r = self.add_r()
+        self.add_comment_reference(comment._id)
+        self.link_comment(comment._id)
+
+        return comment
+    
+    def link_comment(self, _id):
+        rStart = OxmlElement('w:commentRangeStart')
+        rStart._id = _id
+        rEnd = OxmlElement('w:commentRangeEnd')
+        rEnd._id = _id
+        self.insert(0,rStart)
+        self.append(rEnd)
+
     def add_comment_reference(self, _id):
         reference = OxmlElement('w:commentReference')
         reference._id = _id
diff --git a/docx/text/run.py b/docx/text/run.py
@@ -5,6 +5,7 @@
 """
 
 from __future__ import absolute_import, print_function, unicode_literals
+from datetime import datetime
 
 from docx.oxml.ns import qn
 
@@ -82,6 +83,13 @@ def add_text(self, text):
         t = self._r.add_t(text)
         return _Text(t)
 
+    def add_comment(self, text, author='python-docx', initials='pd', dtime=None):
+        comment_part = self.part._comments_part.element
+        if dtime is None:
+            dtime = str( datetime.now() ).replace(' ', 'T')
+        comment =  self._r.add_comm(author, comment_part, initials, dtime, text)
+
+        return comment
     @property
     def bold(self):
         """
diff --git a/setup.py b/setup.py
@@ -6,7 +6,7 @@
 from setuptools import find_packages, setup
 
 
-def text_of(relpath):
+def text_of(relpath, long_description=False):
     """
     Return string containing the contents of the file at *relpath* relative to
     this file.
@@ -15,6 +15,9 @@ def text_of(relpath):
     file_path = os.path.join(thisdir, os.path.normpath(relpath))
     with open(file_path) as f:
         text = f.read()
+        if long_description:
+            text = re.sub(text, '=+\n', '\n')
+            text = re.sub(text, '-+\n', '\n')
     return text
 
 
@@ -58,7 +61,7 @@ def text_of(relpath):
     'Topic :: Software Development :: Libraries'
 ]
 
-LONG_DESCRIPTION = text_of('README.rst') + '\n\n' + text_of('HISTORY.rst')
+LONG_DESCRIPTION = text_of('README.rst',long_description=True) + '\n\n' + text_of('HISTORY.rst')
 
 
 params = {
diff --git a/test.py b/test.py
@@ -0,0 +1,13 @@
+import docx
+
+print(docx.__version__)
+
+d= docx.Document()
+
+p = d.add_paragraph('r1')
+
+r = p.add_run('r2')
+
+r.add_comment('hola comm')
+
+d.save('d.docx')
