+
i0 R t ^ RIHt ^ RIt^ RIHtHtHt ^ RI H
t
^ RI H t ^ RI
HtHtHt ^ RIHtHtHtHt ]' d
^ RIHt ^ R IHt ! R
R ]4 t ! R R
]4 tR# )z4Custom element classes related to document comments.) annotationsN)
TYPE_CHECKINGCallablecast)nsdecls) parse_xml) ST_DateTimeST_DecimalNumber ST_String)BaseOxmlElementOptionalAttributeRequiredAttribute
ZeroOrMore)CT_Tbl)CT_Pc Z ] tR t^t$ RtR]R& ]! R4 tR R ltR R lt R R
lt
R t R # )
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:commentc V ^8 d QhRR/# ) return
CT_Comment )formats "Y/Users/agent/.openclaw/workspace/.venv/lib/python3.14/site-packages/docx/oxml/comments.py __annotate__CT_Comments.__annotate__ s Z c
V P 4 p\ \ \ R\ R4 RV R24 4 pV P V4 V# )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 & r add_commentCT_Comments.add_comment sU 113 gcl^77) <
$
G r c V ^8 d QhRRRR/# )r
comment_idintr zCT_Comment | Noner )r s "r r r ? s 9 9C 94E 9r c
R V P RV R24 pV' d
V^ , # R# )zRReturn the `w:comment` element identified by `comment_id`, or |None| if not found.z(./w:comment[@w:id='z'])[1]Nxpath)r" r( comment_elmss && r get_comment_by_id CT_Comments.get_comment_by_id? s+ zz$8 F"KL ".|A8D8r c V ^8 d QhRR/# )r r r) r )r s "r r r D s C r c
V P R4 Uu. uF p\ V4 NK pp\ VRR7 ^, pVR8: d V# \ \ V4 4 F w rEWE8w g K
Vu # \ V4 # u upi )aF 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.
z./w:comment/@w:id)defaulti)r, r) max enumeratesortedlen)r" xused_idsr# expectedactuals & r r &CT_Comments._next_available_comment_idD s| %)JJ/B$CD$CqCF$CDh+a/ i N !*&*: ; H! !< 8} Es A9r N) __name__
__module__ __qualname____firstlineno____doc____annotations__r r$ r% r. r __static_attributes__r r r r r s- "!%G >9
r r c ] tR t^[t$ Rt]! R]4 tR]R& ]! R] 4 t
R]R& ] ! R] 4 t R ]R
& ] ! R ]
4 tR ]R
& ]! RRR7 t]! RRR7 tR]R& R]R& R]R& R]R& ]R R l4 tRtR # ) r aA `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:p)
successorszw:tblzCallable[[], CT_P]add_pz
list[CT_P]p_lstz list[CT_Tbl]tbl_lstzCallable[[CT_Tbl], CT_Tbl] _insert_tblc V ^8 d QhRR/# )r r zlist[CT_P | CT_Tbl]r )r s "r r CT_Comment.__annotate__z s - -(; -r c
$ V P R4 # )z8Generate all `w:p` and `w:tbl` elements in this comment.z./w:p | ./w:tblr+ )r" s &r inner_content_elements!CT_Comment.inner_content_elementsy s zz+,,r r N)r= r> r? r@ rA r
r rE rB r
rG r rH r rI r ptblpropertyrR rC r r r r r [ s (89B9#J :FC:,i Hj 1+ D
5R(A
W
,C
++
- -r r ) rA
__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 ra sJ : " 0 0 & J J ` `&-F / F R!- !-r