Merge pull request python-openxml#1 from BayooG/feature/comments_lower_level

Feature/comments lower level

Author: BayooG

docx/__init__.py

@@ -16,6 +16,7 @@
 from docx.parts.numbering import NumberingPart
 from docx.parts.settings import SettingsPart
 from docx.parts.styles import StylesPart
+from docx.parts.comments import CommentsPart
 
 
 def part_class_selector(content_type, reltype):
@@ -25,13 +26,14 @@ def part_class_selector(content_type, reltype):
 
 
 PartFactory.part_class_selector = part_class_selector
+PartFactory.part_type_for[CT.WML_COMMENTS] = CommentsPart
 PartFactory.part_type_for[CT.OPC_CORE_PROPERTIES] = CorePropertiesPart
 PartFactory.part_type_for[CT.WML_DOCUMENT_MAIN] = DocumentPart
 PartFactory.part_type_for[CT.WML_NUMBERING] = NumberingPart
 PartFactory.part_type_for[CT.WML_SETTINGS] = SettingsPart
 PartFactory.part_type_for[CT.WML_STYLES] = StylesPart
 
 del (
-    CT, CorePropertiesPart, DocumentPart, NumberingPart, PartFactory,
-    StylesPart, part_class_selector
+    CT, CorePropertiesPart, CommentsPart, DocumentPart, NumberingPart, PartFactory,
+    StylesPart, part_class_selector,
 )

docx/document.py

@@ -108,6 +108,15 @@ def core_properties(self):
         """
         return self._part.core_properties
 
+    @property
+    def comments_part(self):
+        """
+        A |Comments| object providing read/write access to the core
+        properties of this document.
+        """
+        return self._part._package._comments_part
+
+
     @property
     def inline_shapes(self):
         """

docx/opc/package.py

@@ -11,6 +11,7 @@
 from .packuri import PACKAGE_URI
 from .part import PartFactory
 from .parts.coreprops import CorePropertiesPart
+from docx.parts.comments import CommentsPart
 from .pkgreader import PackageReader
 from .pkgwriter import PackageWriter
 from .rel import Relationships
@@ -171,6 +172,19 @@ def _core_properties_part(self):
             core_properties_part = CorePropertiesPart.default(self)
             self.relate_to(core_properties_part, RT.CORE_PROPERTIES)
             return core_properties_part
+    
+    @property
+    def _comments_part(self):
+        """
+        |CommentsPart| object related to this package. Creates
+        a default Comments part if one is not present.
+        """
+        try:
+            return self.part_related_by(RT.COMMENTS)
+        except KeyError:
+            comments_part = CommentsPart.default(self) 
+            self.relate_to(comments_part, RT.COMMENTS)
+            return comments_part
 
 
 class Unmarshaller(object):

docx/oxml/__init__.py

@@ -203,3 +203,11 @@ def OxmlElement(nsptag_str, attrs=None, nsdecls=None):
 register_element_cls('w:br', CT_Br)
 register_element_cls('w:r',  CT_R)
 register_element_cls('w:t',  CT_Text)
+
+
+from .comments import CT_Comments,CT_Com, CT_CRE, CT_CRS, CT_CRef
+register_element_cls('w:comments', CT_Comments)
+register_element_cls('w:comment', CT_Com)
+register_element_cls('w:commentRangeStart', CT_CRS)
+register_element_cls('w:commentRangeEnd', CT_CRE)
+register_element_cls('w:commentReference', CT_CRef)

docx/oxml/comments.py

@@ -0,0 +1,110 @@
+"""
+Custom element classes related to the comments part
+"""
+
+from . import OxmlElement
+from .simpletypes import ST_DecimalNumber, ST_String
+from docx.text.run import Run
+from .xmlchemy import (
+	BaseOxmlElement, OneAndOnlyOne, RequiredAttribute, ZeroOrMore, ZeroOrOne
+)
+
+class CT_Com(BaseOxmlElement):
+	"""
+	A ``<w:comment>`` element, a container for Comment properties 
+	"""
+	initials = RequiredAttribute('w:initials', ST_String)
+	_id = RequiredAttribute('w:id', ST_DecimalNumber)
+	date = RequiredAttribute('w:date', ST_String)
+	author = RequiredAttribute('w:author', ST_String)
+	
+	paragraph = ZeroOrOne('w:p', successors=('w:comment',))
+
+	@classmethod
+	def new(cls, initials, comm_id, date, author):
+		"""
+		Return a new ``<w:comment>`` element having _id of *comm_id* and having
+		the passed params as meta data 
+		"""
+		comment = OxmlElement('w:comment')
+		comment.initials = initials
+		comment.date = date
+		comment._id = comm_id
+		comment.author = author
+		return comment
+		
+	def _add_p(self, text):
+		_p = OxmlElement('w:p')
+		_r = _p.add_r()
+		run = Run(_r,self)
+		run.text = text
+		self._insert_paragraph(_p)
+		return _p
+
+class CT_Comments(BaseOxmlElement):
+	"""
+	A ``<w:comments>`` element, a container for Comments properties
+	"""
+	comment = ZeroOrMore ('w:comment', successors=('w:comments',))
+
+	def add_comment(self,author, initials, date):
+		_next_id = self._next_commentId
+		comment = CT_Com.new(initials, _next_id, date, author)
+		comment = self._insert_comment(comment)
+
+		return comment
+	
+	@property
+	def _next_commentId(self):
+		ids = self.xpath('./w:comment/@w:id')
+		len(ids)
+		_ids = [int(_str) for _str in ids]
+		_ids.sort()
+
+		print(_ids)
+		try:
+			return _ids[-1] + 2
+		except:
+			return 0
+	
+
+class CT_CRS(BaseOxmlElement):
+	"""
+	A ``<w:commentRangeStart>`` element
+	"""
+	_id = RequiredAttribute('w:id', ST_DecimalNumber)
+
+	@classmethod
+	def new(cls, _id):
+		commentRangeStart = OxmlElement('w:commentRangeStart')
+		commentRangeStart._id =_id
+
+		return commentRangeStart
+
+	
+
+class CT_CRE(BaseOxmlElement):
+	"""
+	A ``w:commentRangeEnd`` element
+	"""
+	_id = RequiredAttribute('w:id', ST_DecimalNumber)
+
+
+	@classmethod
+	def new(cls, _id):
+		commentRangeEnd = OxmlElement('w:commentRangeEnd')
+		commentRangeEnd._id =_id
+		return commentRangeEnd
+	
+	
+class CT_CRef(BaseOxmlElement):
+	"""
+	w:commentReference 
+	"""
+	_id = RequiredAttribute('w:id', ST_DecimalNumber)
+
+	@classmethod
+	def new (cls, _id):
+		commentReference = OxmlElement('w:commentReference')
+		commentReference._id =_id
+		return commentReference

docx/oxml/text/paragraph.py

@@ -26,6 +26,34 @@ def add_p_before(self):
         new_p = OxmlElement('w:p')
         self.addprevious(new_p)
         return new_p
+    
+    def link_comment(self, _id, rangeStart=0, rangeEnd=0):
+        rStart = OxmlElement('w:commentRangeStart')
+        rStart._id = _id
+        rEnd = OxmlElement('w:commentRangeEnd')
+        rEnd._id = _id
+        if rangeStart == 0 and rangeEnd == 0:
+            self.insert(0,rStart)
+            self.append(rEnd)
+        else:
+            self.insert(rangeStart,rStart)
+            if rangeEnd == len(self.getchildren() ) - 1 :
+                self.append(rEnd)
+            else:
+                self.insert(rangeEnd+1, rEnd)
+
+    def add_comm(self, author, comment_part, initials, dtime, comment_text, rangeStart, rangeEnd):
+        
+        comment = comment_part.add_comment(author, initials, dtime)
+        comment._add_p(comment_text)
+        _r = self.add_r()
+        _r.add_comment_reference(comment._id)
+        self.link_comment(comment._id, rangeStart= rangeStart, rangeEnd=rangeEnd)
+
+        return comment
+
+
+        
 
     @property
     def alignment(self):
@@ -71,6 +99,15 @@ def style(self):
         if pPr is None:
             return None
         return pPr.style
+    
+    @property
+    def comment_id(self):
+        _id = self.xpath('./w:commentRangeStart/@w:id')    
+        if(len(_id)>1):
+            return None
+        else:
+            return int(_id[0])
+        
 
     @style.setter
     def style(self, style):

docx/oxml/text/run.py

@@ -6,10 +6,13 @@
 
 from ..ns import qn
 from ..simpletypes import ST_BrClear, ST_BrType
+from .. import OxmlElement
 from ..xmlchemy import (
     BaseOxmlElement, OptionalAttribute, ZeroOrMore, ZeroOrOne
 )
 
+from .. import OxmlElement
+
 
 class CT_Br(BaseOxmlElement):
     """
@@ -24,6 +27,8 @@ class CT_R(BaseOxmlElement):
     ``<w:r>`` element, containing the properties and text for a run.
     """
     rPr = ZeroOrOne('w:rPr')
+    ###wrong 
+    ref = ZeroOrOne('w:commentRangeStart', successors=('w:r',))
     t = ZeroOrMore('w:t')
     br = ZeroOrMore('w:br')
     cr = ZeroOrMore('w:cr')
@@ -52,6 +57,12 @@ def add_drawing(self, inline_or_anchor):
         drawing.append(inline_or_anchor)
         return drawing
 
+    def add_comment_reference(self, _id):
+        reference = OxmlElement('w:commentReference')
+        reference._id = _id
+        self.append(reference)
+        return reference
+    
     def clear_content(self):
         """
         Remove all child elements except the ``<w:rPr>`` element if present.
@@ -60,6 +71,12 @@ def clear_content(self):
         for child in content_child_elms:
             self.remove(child)
 
+    def add_comment_reference(self, _id):
+        reference = OxmlElement('w:commentReference')
+        reference._id = _id
+        self.append(reference)
+        return reference
+
     @property
     def style(self):
         """

docx/parts/comments.py

@@ -0,0 +1,26 @@
+from __future__ import absolute_import, division, print_function, unicode_literals
+
+import os
+
+from docx.opc.constants import CONTENT_TYPE as CT
+from ..opc.packuri import PackURI
+
+from docx.oxml import parse_xml
+from ..opc.part import XmlPart
+
+class CommentsPart(XmlPart):
+    """Definition of Comments Part"""
+
+    @classmethod
+    def default(cls, package):
+        partname = PackURI("/word/comments.xml")
+        content_type = CT.WML_COMMENTS
+        element = parse_xml(cls._default_comments_xml())
+        return cls(partname, content_type, element, package)
+    
+    @classmethod
+    def _default_comments_xml(cls):
+        path = os.path.join(os.path.split(__file__)[0], '..', 'templates', 'default-comments.xml')
+        with open(path, 'rb') as f:
+           xml_bytes = f.read()
+        return xml_bytes 

docx/parts/document.py

@@ -17,6 +17,7 @@
 from ..shared import lazyproperty
 from .settings import SettingsPart
 from .styles import StylesPart
+from .comments import CommentsPart
 
 
 class DocumentPart(XmlPart):
@@ -121,6 +122,8 @@ def numbering_part(self):
             numbering_part = NumberingPart.new()
             self.relate_to(numbering_part, RT.NUMBERING)
             return numbering_part
+    
+    
 
     def save(self, path_or_stream):
         """
@@ -171,3 +174,19 @@ def _styles_part(self):
             styles_part = StylesPart.default(self.package)
             self.relate_to(styles_part, RT.STYLES)
             return styles_part
+    @lazyproperty
+    def comments_part(self):
+        """
+        A |Comments| object providing read/write access to the core
+        properties of this document.
+        """
+        # return self.package._comments_part
+
+    @property
+    def _comments_part(self):
+        try:
+            return self.part_related_by(RT.COMMENTS)
+        except KeyError:
+            comments_part = CommentsPart.default(self) 
+            self.relate_to(comments_part, RT.COMMENTS)
+            return comments_part

docx/templates/default-comments.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<w:comments xmlns:wpc="http://schemas.microsoft.com/office/word/2010/wordprocessingCanvas" xmlns:cx="http://schemas.microsoft.com/office/drawing/2014/chartex" xmlns:cx1="http://schemas.microsoft.com/office/drawing/2015/9/8/chartex" xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" xmlns:o="urn:schemas-microsoft-com:office:office" xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships" xmlns:m="http://schemas.openxmlformats.org/officeDocument/2006/math" xmlns:v="urn:schemas-microsoft-com:vml" xmlns:wp14="http://schemas.microsoft.com/office/word/2010/wordprocessingDrawing" xmlns:wp="http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing" xmlns:w10="urn:schemas-microsoft-com:office:word" xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main" xmlns:w14="http://schemas.microsoft.com/office/word/2010/wordml" xmlns:w15="http://schemas.microsoft.com/office/word/2012/wordml" xmlns:w16se="http://schemas.microsoft.com/office/word/2015/wordml/symex" xmlns:wpg="http://schemas.microsoft.com/office/word/2010/wordprocessingGroup" xmlns:wpi="http://schemas.microsoft.com/office/word/2010/wordprocessingInk" xmlns:wne="http://schemas.microsoft.com/office/word/2006/wordml" xmlns:wps="http://schemas.microsoft.com/office/word/2010/wordprocessingShape" mc:Ignorable="w14 w15 w16se wp14"></w:comments>

docx/text/paragraph.py

@@ -13,6 +13,7 @@
 from .run import Run
 from ..shared import Parented
 
+from datetime import datetime
 
 class Paragraph(Parented):
     """
@@ -39,6 +40,25 @@ def add_run(self, text=None, style=None):
             run.style = style
         return run
 
+    # def add_comment(self, author, initials, dt, comment_text, rangeStart=0, rangeEnd=0):
+    #     comment_part = self.part.comments_part.element
+    #     comment = comment_part.add_comment(author, initials, dt)
+    #     comment._add_p(comment_text)
+        
+    #     _r = self._p.add_r()
+    #     _r.add_comment_reference(comment._id)
+    #     self._p.link_comment(comment._id, rangeStart= rangeStart, rangeEnd=rangeEnd)
+
+    #     return comment
+
+    def add_comment(self, text, author='python-docx', initials='pd', dtime=None ,rangeStart=0, rangeEnd=0):
+        comment_part = self.part._comments_part.element
+        if dtime is None:
+            dtime = str( datetime.now )
+        comment =  self._p.add_comm(author, comment_part, initials, dtime, text, rangeStart, rangeEnd)
+
+        return comment
+
     @property
     def alignment(self):
         """