a ]j@sdZddlmZddlZddlmZmZddlm Z erlddl m Z m Z ddl mZddlmZdd lmZGd d d ZGd d d e ZdS)z?Collection providing access to comments added to this document.) annotationsN) TYPE_CHECKINGIterator)BlockItemContainer) CT_Comment CT_Comments) CommentsPart)ParagraphStyle) Paragraphc@sbeZdZdZdddddZddd d Zd dd d ZddddddddZd ddddZdS)Commentsz:Collection containing the comments added to this document.rr) comments_elm comments_partcCs||_||_dSN) _comments_elm_comments_part)selfr r rI/var/www/html/assistant/venv/lib/python3.9/site-packages/docx/comments.py__init__szComments.__init__zIterator[Comment]returncsfddjjDS)z.Iterator over the comments in this collection.c3s|]}t|jVqdSr)Commentr).0 comment_elmrrr sz$Comments.__iter__..)r comment_lstrrrr__iter__s zComments.__iter__intcCs t|jjS)z*The number of comments in this collection.)lenrrrrrr__len__szComments.__len__str str | Noner)textauthorinitialsrc Cs|j}||_||_tjtjj|_ t ||j }|dkr@|St | d}t|}|jd}|||D]} |j| dqn|S)aAdd a new comment to the document and return it. The comment is added to the end of the comments collection and is assigned a unique comment-id. If `text` is provided, it is added to the comment. This option provides for the common case where a comment contains a modest passage of plain text. Multiple paragraphs can be added using the `text` argument by separating their text with newlines (`"\\n"`). Between newlines, text is interpreted as it is in `Document.add_paragraph(text=...)`. The default is to place a single empty paragraph in the comment, which is the same behavior as the Word UI when you add a comment. New runs can be added to the first paragraph in the empty comment with `comments.paragraphs[0].add_run()` to adding more complex text with emphasis or images. Additional paragraphs can be added using `.add_paragraph()`. `author` is a required attribute, set to the empty string by default. `initials` is an optional attribute, set to the empty string by default. Passing |None| for the `initials` parameter causes that attribute to be omitted from the XML. r! rr$)r add_commentr%r&dtdatetimenowtimezoneutcdaterritersplitnext paragraphsZadd_run add_paragraph) rr$r%r&rcommentZpara_text_iterZfirst_para_textZ first_parasrrrr)#s    zComments.add_commentzComment | None) comment_idrcCs$|j|}|dur t||jSdS)zFReturn the comment identified by `comment_id`, or |None| if not found.N)rZget_comment_by_idrr)rr7rrrrgetMs z Comments.getN)r!r!r!) __name__ __module__ __qualname____doc__rrr r)r8rrrrr s *r cseZdZdZdddfdd Zd d d d d fd d Zed dddZejd dddZeddddZ eddddZ e jddddZ ed dddZ eddddZ Z S)!rasProxy for a single comment in the document. Provides methods to access comment metadata such as author, initials, and date. A comment is also a block-item container, similar to a table cell, so it can contain both paragraphs and tables and its paragraphs can contain rich text, hyperlinks and images, although the common case is that a comment contains a single paragraph of plain text like a sentence or phrase. Note that certain content like tables may not be displayed in the Word comment sidebar due to space limitations. Such "over-sized" content can still be viewed in the review pane. rr)rr cst||||_dSr)superr _comment_elm)rrr  __class__rrraszComment.__init__r!Nr"zstr | ParagraphStyle | Noner )r$stylercs"t||}|durd|j_|S)aAReturn paragraph newly added to the end of the content in this container. The paragraph has `text` in a single run if present, and is given paragraph style `style`. When `style` is |None| or ommitted, the "CommentText" paragraph style is applied, which is the default style for comments. NZ CommentText)r=r4_prA)rr$rAZ paragraphr?rrr4eszComment.add_paragraphrcCs|jjS)z}Read/write. The recorded author of this comment. This field is required but can be set to the empty string. r>r%rrrrr%uszComment.author)valuecCs ||j_dSrrCrrDrrrr%}srcCs|jjS)z&The unique identifier of this comment.)r>idrrrrr7szComment.comment_idr#cCs|jjS)zRead/write. The recorded initials of the comment author. This attribute is optional in the XML, returns |None| if not set. Assigning |None| removes any existing initials from the XML. r>r&rrrrr&szComment.initialscCs ||j_dSrrGrErrrr&scCsddd|jDS)zThe text content of this comment as a string. Only content in paragraphs is included and of course all emphasis and styling is stripped. Paragraph boundaries are indicated with a newline (`"\\n"`) r'css|] }|jVqdSrr()rprrrrzComment.text..)joinr3rrrrr$sz Comment.textzdt.datetime | NonecCs|jjS)zThe date and time this comment was authored. This attribute is optional in the XML, returns |None| if not set. )r>r/rrrr timestampszComment.timestamp)r!N)r9r:r;r<rr4propertyr%setterr7r&r$rK __classcell__rrr?rrSs"  r)r< __future__rr+r*typingrrZ docx.blkcntnrrZdocx.oxml.commentsrrZdocx.parts.commentsrZdocx.styles.styler Zdocx.text.paragraphr r rrrrrs     B