Merge tag 'v0.2.12' into feature/paragraph_all_runs

BayooG · BayooG · commit 1b7ddf01b9ca · 2020-11-03T15:05:09.000+02:00
diff --git a/README.rst b/README.rst
@@ -32,9 +32,19 @@ Usage
 
     run.add_comment('comment') # add a comment only for the run text 
 
+    run.add_comment('comment2')
+
+    run_comments = run.comments
+
     paragraph.add_footnote('footnote text') # add a footnote
 
 
+Donation
+------------
+::
+
+    bitcoin: bc1q9dftn4ndufwzyzkm8ryu0kky0v8y7w00zdah9r
+
 
 License
 -------
diff --git a/docx/__init__.py b/docx/__init__.py
@@ -2,7 +2,7 @@
 
 from docx.api import Document  # noqa
 
-__version__ = '0.2.10' 
+__version__ = '0.2.12' 
 
 
 # register custom Part classes with opc package reader
diff --git a/docx/oxml/comments.py b/docx/oxml/comments.py
@@ -52,8 +52,6 @@ def paragraph(self):
 		return Paragraph(self.p, self)
 		
 	
-
-
 class CT_Comments(BaseOxmlElement):
 	"""
 	A ``<w:comments>`` element, a container for Comments properties
diff --git a/docx/text/comment.py b/docx/text/comment.py
@@ -0,0 +1,23 @@
+from ..shared import Parented
+
+class Comment(Parented):
+    """[summary]
+
+    :param Parented: [description]
+    :type Parented: [type]
+    """
+    def __init__(self, com, parent):
+        super(Comment, self).__init__(parent)
+        self._com = self._element = self.element = com
+    
+    @property
+    def paragraph(self):
+        return self.element.paragraph
+    
+    @property
+    def text(self):
+        return self.element.paragraph.text
+    
+    @text.setter
+    def text(self, text):
+        self.element.paragraph.text = text
diff --git a/docx/text/paragraph.py b/docx/text/paragraph.py
@@ -48,8 +48,9 @@ def delete(self):
         self._p.getparent().remove(self._p)
         self._p = self._element = None
     
-    def add_comment(self, text, author='python-docx', initials='pd', dtime=None ,rangeStart=0, rangeEnd=0):
-        comment_part = self.part._comments_part.element
+    def add_comment(self, text, author='python-docx', initials='pd', dtime=None ,rangeStart=0, rangeEnd=0, comment_part=None):
+        if comment_part is None:
+            comment_part = self.part._comments_part.element
         if dtime is None:
             dtime = str( datetime.now() ).replace(' ', 'T')
         comment =  self._p.add_comm(author, comment_part, initials, dtime, text, rangeStart, rangeEnd)
@@ -224,6 +225,11 @@ def footnotes(self):
         else :
             return False
 
+    @property
+    def comments(self):
+        runs_comments = [run.comments for run in self.runs]
+        return [comment for comments in runs_comments for comment in comments]
+
     @text.setter
     def text(self, text):
         self.clear()
diff --git a/docx/text/run.py b/docx/text/run.py
@@ -15,6 +15,7 @@
 from ..shape import InlineShape
 from ..shared import Parented
 
+from .comment import Comment
 
 class Run(Parented):
     """
@@ -230,7 +231,15 @@ def get_hyperLink(self):
                 return '', False
         else:
             return 'None'
-        
+
+    @property
+    def comments(self):
+        comment_part = self._parent._parent.part._comments_part.element
+        comment_refs = self._element.findall(qn('w:commentReference'))
+        ids = [int(ref.get(qn('w:id'))) for ref in comment_refs]
+        coms = [com for com in comment_part if com._id in ids]
+        return [Comment(com, comment_part) for com in coms]
+ 
 
 class _Text(object):
     """
