o h@sdZddlmZddlZddlmZmZddlm Z er6ddl 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@sDeZdZdZdddZdd d Zdd dZd d!ddZd"ddZdS)#Commentsz:Collection containing the comments added to this document. comments_elmr comments_partrcCs||_||_dSN) _comments_elm_comments_part)selfr r rM/var/www/html/premium_crap/venv/lib/python3.10/site-packages/docx/comments.py__init__s zComments.__init__returnIterator[Comment]csfddjjDS)z.Iterator over the comments in this collection.c3s|] }t|jVqdSr)Commentr).0 comment_elmrrr s  z$Comments.__iter__..)r comment_lstrrrr__iter__s zComments.__iter__intcCs t|jjS)z*The number of comments in this collection.)lenrrrrrr__len__ zComments.__len__textstrauthorinitials str | Nonerc Cs|j}||_||_tjtjj|_ t ||j }|dkr |St | d}t|}|jd}|||D]} |j| dq7|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 paragraphsadd_run add_paragraph) rr#r%r&rcommentpara_text_iterfirst_para_text first_parasrrrr*#s    zComments.add_comment comment_idComment | NonecCs$|j|}|durt||jSdS)zFReturn the comment identified by `comment_id`, or |None| if not found.N)rget_comment_by_idrr)rr<rrrrgetMs z Comments.getN)r rr r)rrrr)r"r"r")r#r$r%r$r&r'rr)r<rrr=) __name__ __module__ __qualname____doc__rrr r*r?rrrrr s    *r cseZdZdZd"fdd Zd#d$fdd Zed%ddZejd&ddZed'ddZ ed(ddZ e jd)ddZ ed%ddZ ed*d d!Z 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. rrr rcst||||_dSr)superr _comment_elm)rrr  __class__rrras zComment.__init__r"Nr#r$stylestr | ParagraphStyle | Nonerr cs"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. N CommentText)rEr6_prI)rr#rI paragraphrGrrr6eszComment.add_paragraphcC|jjS)z}Read/write. The recorded author of this comment. This field is required but can be set to the empty string. rFr%rrrrr%uzComment.authorvaluecC ||j_dSrrOrrQrrrr%}r!rcCrN)z&The unique identifier of this comment.)rFidrrrrr<szComment.comment_idr'cCrN)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. rFr&rrrrr&szComment.initialscCrRrrUrSrrrr&r!cCsddd|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))rprrrrszComment.text..)joinr4rrrrr#sz Comment.textdt.datetime | NonecCrN)zThe date and time this comment was authored. This attribute is optional in the XML, returns |None| if not set. )rFr0rrrr timestamprPzComment.timestamp)rrr r)r"N)r#r$rIrJrr )rr$)rQr$r@)rr')rQr')rrX)rArBrCrDrr6propertyr%setterr<r&r#rY __classcell__rrrGrrSs$        r)rD __future__rr,r+typingrr docx.blkcntnrrdocx.oxml.commentsrrdocx.parts.commentsrdocx.styles.styler docx.text.paragraphr r rrrrrs     B