o
h0 @ s d Z ddlmZ ddlZddlmZmZmZ ddl m
Z
ddl m Z ddl
mZmZmZ ddlmZmZmZmZ erFdd lmZ dd
lmZ G d d d eZG d
d deZdS )z4Custom element classes related to document comments. ) annotationsN)
TYPE_CHECKINGCallablecast)nsdecls) parse_xml) ST_DateTimeST_DecimalNumber ST_String)BaseOxmlElementOptionalAttributeRequiredAttribute
ZeroOrMore)CT_Tbl)CT_Pc @ s@ e Zd ZU dZded< edZdddZdd d
ZdddZ dS ) 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 C s6 | }tttdtd 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_idcomment r R/var/www/html/premium_crap/venv/lib/python3.10/site-packages/docx/oxml/comments.py add_comment s
zCT_Comments.add_comment
comment_idintCT_Comment | Nonec C s" | d| d}|r|d S dS )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_elmsr r r get_comment_by_id? s z CT_Comments.get_comment_by_idc C s^ dd | dD }t|ddd }|dkr|S tt|D ] \}}||kr*| S q 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 S s g | ]}t |qS r )r ).0xr r r
L s z:CT_Comments._next_available_comment_id..z./w:comment/@w:id)default i)r" max enumeratesortedlen)r used_idsr expectedactualr r r r D s z&CT_Comments._next_available_comment_idN)r r )r r r r )r r )
__name__
__module__ __qualname____doc____annotations__r r r r$ r r r r r r s
r c @ s e Zd ZU dZedeZded< edeZ ded< e
deZ d ed
< e
d e Z
d ed
< edddZedddZded< ded< ded< ded< ed d 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 C s
| dS )z8Generate all `w:p` and `w:tbl` elements in this comment.z./w:p | ./w:tblr! )r r r r inner_content_elementsy s
z!CT_Comment.inner_content_elementsN)r rA )r2 r3 r4 r5 r
r r7 r6 r
r9 r r: r r; r ptblpropertyrB r r r r r [ s$
r ) r5
__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 r s I