;i0 d Z ddlmZ ddlZddlmZmZmZ ddl m
Z
ddl m Z ddl
mZmZmZ ddlmZmZmZmZ er dd lmZ dd
lmZ G d d e Z G d
de ZdS )z4Custom element classes related to document comments. ) annotationsN)
TYPE_CHECKINGCallablecast)nsdecls) parse_xml) ST_DateTimeST_DecimalNumber ST_String)BaseOxmlElementOptionalAttributeRequiredAttribute
ZeroOrMore)CT_Tbl)CT_Pc L e Zd ZU dZded< ed ZddZdd Zdd Z d
S ) CT_Commentsa `w:comments` element, the root element for the comments part.
Simply contains a collection of `w:comment` elements, each representing a single comment. Each
contained comment is identified by a unique `w:id` attribute, used to reference the comment
from the document text. The offset of the comment in this collection is arbitrary; it is
essentially a _set_ implemented as a list.
zlist[CT_Comment] comment_lstz w:commentreturn
CT_Commentc
| }t t t dt d d| d }| | |S )a Return newly added `w:comment` child of this `w:comments`.
The returned `w:comment` element is the minimum valid value, having a `w:id` value unique
within the existing comments and the required `w:author` attribute present but set to the
empty string. It's content is limited to a single run containing the necessary annotation
reference but no text. Content is added by adding runs to this first paragraph and by
adding additional paragraphs as needed.
z )_next_available_comment_idr r r r append)selfnext_idcomments FC:\PYTHON\MyICR_Workspace\venv\Lib\site-packages\docx/oxml/comments.py add_commentzCT_Comments.add_comment su 1133 gcll 7
$
G
comment_idintCT_Comment | Nonec L | d| d }|r|d ndS )zRReturn the `w:comment` element identified by `comment_id`, or |None| if not found.z(./w:comment[@w:id='z'])[1]r Nxpath)r r! comment_elmss r get_comment_by_idz CT_Comments.get_comment_by_id? s2 zz"K"K"K"KLL ".8|AD8r c d | d D }t |d dz }|dk r|S t t | D ]\ }}||k r|c S t | S )an The next available comment id.
According to the schema, this can be any positive integer, as big as you like, and the
default mechanism is to use `max() + 1`. However, if that yields a value larger than will
fit in a 32-bit signed integer, we take a more deliberate approach to use the first
ununsed integer starting from 0.
c , g | ]}t | S )r" ).0xs r
z:CT_Comments._next_available_comment_id..L s DDDqCFFDDDr z./w:comment/@w:id)default i)r& max enumeratesortedlen)r used_idsr expectedactuals r r z&CT_Comments._next_available_comment_idD s EDDJJ/B$C$CDDDh+++a/ i N !*&*:*: ; ; Hf6!! " 8}} r N)r r )r! r" r r# )r r" )
__name__
__module__ __qualname____doc____annotations__r r r r( r r+ r r r r sy "!!!j%%G >9 9 9 9
r r c e Zd ZU dZ ede Zded< ede Z ded< e
de Z d ed
< e
d e Z
d ed
< edd Z edd Zded< ded< ded< ded< ed d Zd S ) r aQ `w:comment` element, representing a single comment.
A comment is a so-called "story" and can contain paragraphs and tables much like a table-cell.
While probably most often used for a single sentence or phrase, a comment can contain rich
content, including multiple rich-text paragraphs, hyperlinks, images, and tables.
zw:idr" idzw:authorstrauthorz
w:initialsz
str | Noneinitialszw:datezdt.datetime | Nonedatezw:pr+ )
successorszw:tblzCallable[[], CT_P]add_pz
list[CT_P]p_lstz list[CT_Tbl]tbl_lstzCallable[[CT_Tbl], CT_Tbl] _insert_tblr list[CT_P | CT_Tbl]c , | d S )z8Generate all `w:p` and `w:tbl` elements in this comment.z./w:p | ./w:tblr% )r s r inner_content_elementsz!CT_Comment.inner_content_elementsy s zz+,,,r N)r rI )r9 r: r; r< r r
r? r= r rA r
rB r rC r ptblpropertyrK r+ r r r r [ s1 (899B9999##J ::F::::,,i H 1 0+ D
5R(((A
*W
,
,
,C ++++
- - - X- - -r r ) r<
__future__r datetimedttypingr r r docx.oxml.nsr docx.oxml.parserr docx.oxml.simpletypesr r
r docx.oxml.xmlchemyr r
r r docx.oxml.tabler docx.oxml.text.paragraphr r r r+ r r rY s@ : : " " " " " " 0 0 0 0 0 0 0 0 0 0 & & & & & & J J J J J J J J J J ` ` ` ` ` ` ` ` ` ` ` ` .&&&&&&------F F F F F / F F F R!- !- !- !- !- !- !- !- !- !-r