*h0 S r SSKJr SSKrSSKJrJrJr SSK J
r
SSK J r SSK
JrJrJr SSKJrJrJrJr \( a SS KJr SS
KJr " S S \5 r " S
S\5 rg)z4Custom element classes related to document comments. ) annotationsN)
TYPE_CHECKINGCallablecast)nsdecls) parse_xml) ST_DateTimeST_DecimalNumber ST_String)BaseOxmlElementOptionalAttributeRequiredAttribute
ZeroOrMore)CT_Tbl)CT_Pc R \ rS rSr% SrS\S' \" S5 rS S jrS S jr S
S jr
S r g
) CT_Comments a~ `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
U R 5 n[ [ [ S[ S5 SU S35 5 nU R U5 U$ )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
CT_Commentr r append)selfnext_idcomments O/home/mande/repo/quber/.venv/lib/python3.13/site-packages/docx/oxml/comments.py add_commentCT_Comments.add_comment sU 113 gcl^77) <
$
G c H U R SU S35 nU( a US $ S$ )zRReturn the `w:comment` element identified by `comment_id`, or |None| if not found.z(./w:comment[@w:id='z'])[1]r Nxpath)r
comment_id comment_elmss r get_comment_by_id CT_Comments.get_comment_by_id? s+ zz$8 F"KL ".|A8D8r! c U R S5 Vs/ s H n[ U5 PM nn[ USS9S- nUS:: a U$ [ [ U5 5 H u pEXE:w d M Us $ [ U5 $ s snf )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)default i)r$ intmax 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 A1 N)returnr )r% r- r8 zCT_Comment | None)r8 r- ) __name__
__module__ __qualname____firstlineno____doc____annotations__r r r r' r __static_attributes__r7 r! r r r s( "!%G >9
r! r c \ rS rSr% Sr\" S\5 rS\S' \" S\ 5 r
S\S' \ " S \ 5 r S
\S ' \ " S \
5 rS
\S' \" SSS9r\" SSS9rS\S' S\S' S\S' S\S' \S S j5 rSrg ) 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:pr7 )
successorszw:tblzCallable[[], CT_P]add_pz
list[CT_P]p_lstz list[CT_Tbl]tbl_lstzCallable[[CT_Tbl], CT_Tbl] _insert_tblc $ U R S5 $ )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! N)r8 zlist[CT_P | CT_Tbl])r9 r: r; r< r= r r
rB r> r rD r
rE r rF r ptblpropertyrM r? r7 r! r r r [ s (89B9#J :FC:,i Hj 1+ D
5R(A
W
,C
++
- -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 r7 r! r r\ sJ : " 0 0 & J J ` `&-F / F R!- !-r!