U cqeh@sdZddlmZddlmZmZmZmZddlm Z ddl m Z ddl m Z ddlmZmZddlmZmZerdd lmZdd lmZmZdd lmZdd lmZdd lmZddlm Z m!Z!ddl"m#Z#ddl$m%Z%GdddeZ&Gddde Z'dS)z'|Document| and closely related objects.) annotations)IO TYPE_CHECKINGIteratorList)BlockItemContainer) WD_SECTION)WD_BREAK)SectionSections) ElementProxyEmu)types)CT_Body CT_Document) DocumentPart)Settings)Length)ParagraphStyle _TableStyle)Table) ParagraphcsPeZdZdZdddfdd ZdDd d d d d ZddZdEd dddddZdFddddddZe j fddddZ dGd d dd d!d"Z e d#d$Ze d%d&Zd'd(d)d*Ze d+d(d,d-Ze dd(d.d/Zdd0d1d2Ze d3d(d4d5Ze d6d(d7d8Ze d9d:Ze d;d(dd(d?d@Ze dAd(dBdCZZS)HDocumentzWordprocessingML (WML) document. Not intended to be constructed directly. Use :func:`docx.Document` to open or create a document. rr)elementpartcs&tt||||_||_d|_dSN)superr__init___element_part_Document__body)selfrr __class__1/tmp/pip-unpacked-wheel-gx5hpqp3/docx/document.pyr"szDocument.__init__strint)textlevelcCsBd|krdks"ntd||dkr.dnd|}|||S)aReturn a heading paragraph newly added to the end of the document. The heading paragraph will contain `text` and have its paragraph style determined by `level`. If `level` is 0, the style is set to `Title`. If `level` is 1 (or omitted), `Heading 1` is used. Otherwise the style is set to `Heading {level}`. Raises |ValueError| if `level` is outside the range 0-9. r z"level must be in range 0-9, got %dZTitlez Heading %d) ValueError add_paragraph)r!r*r+styler$r$r% add_heading(s zDocument.add_headingcCs|}|tj|S)z=Return newly |Paragraph| object containing only a page break.)r.add_runZ add_breakr ZPAGE)r!Z paragraphr$r$r%add_page_break5szDocument.add_page_breakNzstr | ParagraphStyle | Noner)r*r/returncCs|j||S)aReturn paragraph newly added to the end of the document. The paragraph is populated with `text` and having paragraph style `style`. `text` can contain tab (``\t``) characters, which are converted to the appropriate XML form for a tab. `text` can also include newline (``\n``) or carriage return (``\r``) characters, each of which is converted to a line break. )_bodyr.)r!r*r/r$r$r%r.;s zDocument.add_paragraphzstr | IO[bytes]zint | Length | None)image_path_or_streamwidthheightcCs|}||||S)aReturn new picture shape added in its own paragraph at end of the document. The picture contains the image at `image_path_or_stream`, scaled based on `width` and `height`. If neither width nor height is specified, the picture appears at its native size. If only one is specified, it is used to compute a scaling factor that is then applied to the unspecified dimension, preserving the aspect ratio of the image. The native size of the picture is calculated using the dots-per-inch (dpi) value specified in the image file, defaulting to 72 dpi if no value is specified, as is often the case. )r.r1 add_picture)r!r5r6r7runr$r$r%r8Is zDocument.add_picturer) start_typecCs|jj}||_t||jS)zReturn a |Section| object newly added at the end of the document. The optional `start_type` argument must be a member of the :ref:`WdSectionStart` enumeration, and defaults to ``WD_SECTION.NEW_PAGE`` if not provided. )rbodyZadd_section_breakr:r r)r!r:Z new_sectPrr$r$r% add_section\s zDocument.add_sectionzstr | _TableStyle | None)rowscolsr/cCs|j|||j}||_|S)zAdd a table having row and column counts of `rows` and `cols` respectively. `style` may be a table style object or a table style name. If `style` is |None|, the table inherits the default table style of the document. )r4 add_table _block_widthr/)r!r=r>r/tabler$r$r%r?fszDocument.add_tablecCs|jjS)zGA |CoreProperties| object providing Dublin Core properties of document.)rcore_propertiesr!r$r$r%rBpszDocument.core_propertiescCs|jjS)zThe |InlineShapes| collection for this document. An inline shape is a graphical object, such as a picture, contained in a run of text and behaving like a character glyph, being flowed like other text in a paragraph. )r inline_shapesrCr$r$r%rDuszDocument.inline_shapeszIterator[Paragraph | Table])r3cCs |jS)zHGenerate each `Paragraph` or `Table` in this document in document order.)r4iter_inner_contentrCr$r$r%rEszDocument.iter_inner_contentzList[Paragraph]cCs|jjS)zThe |Paragraph| instances in the document, in document order. Note that paragraphs within revision marks such as ```` or ```` do not appear in this list. )r4 paragraphsrCr$r$r%rFszDocument.paragraphscCs|jS)z+The |DocumentPart| object of this document.)rrCr$r$r%rsz Document.part)path_or_streamcCs|j|dS)zSave this document to `path_or_stream`. `path_or_stream` can be either a path to a filesystem location (a string) or a file-like object. N)rsave)r!rGr$r$r%rHsz Document.saver cCst|j|jS)zD|Sections| object providing access to each section in this document.)r rrrCr$r$r%sectionsszDocument.sectionsrcCs|jjS)zDA |Settings| object providing access to the document-level settings.)rsettingsrCr$r$r%rJszDocument.settingscCs|jjS)zBA |Styles| object providing access to the styles in this document.)rstylesrCr$r$r%rKszDocument.stylesz List[Table]cCs|jjS)aPAll |Table| instances in the document, in document order. Note that only tables appearing at the top level of the document appear in this list; a table nested inside a table cell does not appear. A table within revision marks such as ```` or ```` will also not appear in the list. )r4tablesrCr$r$r%rLs zDocument.tablesrcCs |jd}t|j|j|jS)zGA |Length| object specifying the space between margins in last section.)rIr Z page_widthZ left_marginZ right_margin)r!sectionr$r$r%r@s zDocument._block_width_BodycCs |jdkrt|jj||_|jS)z>The |_Body| instance containing the content for this document.N)r rOrr;rCr$r$r%r4s zDocument._body)r&r')r&N)NN)N)__name__ __module__ __qualname____doc__rr0r2r.r8rZNEW_PAGEr<r?propertyrBrDrErFrrHrIrJrKrLr@r4 __classcell__r$r$r"r%rsD       rcs0eZdZdZdddfdd ZddZZS) rOzoProxy for `` element in this document. It's primary role is a container for document content. rzt.ProvidesStoryPart)body_elmparentcstt|||||_dSr)rrOrr4)r!rVrWr"r$r%rsz_Body.__init__cCs|j|S)zReturn this |_Body| instance after clearing it of all content. Section properties for the main document story, if present, are preserved. )r4 clear_contentrCr$r$r%rXs z_Body.clear_content)rPrQrRrSrrXrUr$r$r"r%rOsrON)(rS __future__rtypingrrrrZ docx.blkcntnrrZdocx.enum.sectionrZdocx.enum.textr Z docx.sectionr r Z docx.sharedr r ZdocxrtZdocx.oxml.documentrrZdocx.parts.documentrZ docx.settingsrrZdocx.styles.stylerrZ docx.tablerZdocx.text.paragraphrrrOr$r$r$r%s&          '