aboutsummaryrefslogtreecommitdiff
path: root/.venv/lib/python3.12/site-packages/docx/oxml/text/paragraph.py
diff options
context:
space:
mode:
Diffstat (limited to '.venv/lib/python3.12/site-packages/docx/oxml/text/paragraph.py')
-rw-r--r--.venv/lib/python3.12/site-packages/docx/oxml/text/paragraph.py106
1 files changed, 106 insertions, 0 deletions
diff --git a/.venv/lib/python3.12/site-packages/docx/oxml/text/paragraph.py b/.venv/lib/python3.12/site-packages/docx/oxml/text/paragraph.py
new file mode 100644
index 00000000..63e96f31
--- /dev/null
+++ b/.venv/lib/python3.12/site-packages/docx/oxml/text/paragraph.py
@@ -0,0 +1,106 @@
+# pyright: reportPrivateUsage=false
+
+"""Custom element classes related to paragraphs (CT_P)."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Callable, List, cast
+
+from docx.oxml.parser import OxmlElement
+from docx.oxml.xmlchemy import BaseOxmlElement, ZeroOrMore, ZeroOrOne
+
+if TYPE_CHECKING:
+ from docx.enum.text import WD_PARAGRAPH_ALIGNMENT
+ from docx.oxml.section import CT_SectPr
+ from docx.oxml.text.hyperlink import CT_Hyperlink
+ from docx.oxml.text.pagebreak import CT_LastRenderedPageBreak
+ from docx.oxml.text.parfmt import CT_PPr
+ from docx.oxml.text.run import CT_R
+
+
+class CT_P(BaseOxmlElement):
+ """`<w:p>` element, containing the properties and text for a paragraph."""
+
+ add_r: Callable[[], CT_R]
+ get_or_add_pPr: Callable[[], CT_PPr]
+ hyperlink_lst: List[CT_Hyperlink]
+ r_lst: List[CT_R]
+
+ pPr: CT_PPr | None = ZeroOrOne("w:pPr") # pyright: ignore[reportAssignmentType]
+ hyperlink = ZeroOrMore("w:hyperlink")
+ r = ZeroOrMore("w:r")
+
+ def add_p_before(self) -> CT_P:
+ """Return a new `<w:p>` element inserted directly prior to this one."""
+ new_p = cast(CT_P, OxmlElement("w:p"))
+ self.addprevious(new_p)
+ return new_p
+
+ @property
+ def alignment(self) -> WD_PARAGRAPH_ALIGNMENT | None:
+ """The value of the `<w:jc>` grandchild element or |None| if not present."""
+ pPr = self.pPr
+ if pPr is None:
+ return None
+ return pPr.jc_val
+
+ @alignment.setter
+ def alignment(self, value: WD_PARAGRAPH_ALIGNMENT):
+ pPr = self.get_or_add_pPr()
+ pPr.jc_val = value
+
+ def clear_content(self):
+ """Remove all child elements, except the `<w:pPr>` element if present."""
+ for child in self.xpath("./*[not(self::w:pPr)]"):
+ self.remove(child)
+
+ @property
+ def inner_content_elements(self) -> List[CT_R | CT_Hyperlink]:
+ """Run and hyperlink children of the `w:p` element, in document order."""
+ return self.xpath("./w:r | ./w:hyperlink")
+
+ @property
+ def lastRenderedPageBreaks(self) -> List[CT_LastRenderedPageBreak]:
+ """All `w:lastRenderedPageBreak` descendants of this paragraph.
+
+ Rendered page-breaks commonly occur in a run but can also occur in a run inside
+ a hyperlink. This returns both.
+ """
+ return self.xpath(
+ "./w:r/w:lastRenderedPageBreak | ./w:hyperlink/w:r/w:lastRenderedPageBreak"
+ )
+
+ def set_sectPr(self, sectPr: CT_SectPr):
+ """Unconditionally replace or add `sectPr` as grandchild in correct sequence."""
+ pPr = self.get_or_add_pPr()
+ pPr._remove_sectPr()
+ pPr._insert_sectPr(sectPr)
+
+ @property
+ def style(self) -> str | None:
+ """String contained in `w:val` attribute of `./w:pPr/w:pStyle` grandchild.
+
+ |None| if not present.
+ """
+ pPr = self.pPr
+ if pPr is None:
+ return None
+ return pPr.style
+
+ @style.setter
+ def style(self, style: str | None):
+ pPr = self.get_or_add_pPr()
+ pPr.style = style
+
+ @property
+ def text(self): # pyright: ignore[reportIncompatibleMethodOverride]
+ """The textual content of this paragraph.
+
+ Inner-content child elements like `w:r` and `w:hyperlink` are translated to
+ their text equivalent.
+ """
+ return "".join(e.text for e in self.xpath("w:r | w:hyperlink"))
+
+ def _insert_pPr(self, pPr: CT_PPr) -> CT_PPr:
+ self.insert(0, pPr)
+ return pPr