Paper Office
paper-docxAPI referencecomposition

CompositionReport

paper-docx 0.2.0 API reference

Everything one composition call did — the declared changed-part budget, the reconciliation maps, and what was reported instead of done.

CompositionReport(inserted_blocks: int = 0, style_map: Dict[str, str] = dict(), imported_styles: List[str] = list(), renamed_styles: Dict[str, str] = dict(), numbering_map: Dict[int, int] = dict(), media_copied: List[str] = list(), bookmarks_renamed: Dict[str, str] = dict(), findings: List[CompositionFinding] = list(), declared_parts: List[str] = list())

Attributes

bookmarks_renamed

attributebookmarks_renamedDict[str, str]
= field(default_factory=dict)

declared_parts

attributedeclared_partsList[str]
= field(default_factory=list)

findings

attributefindingsList[CompositionFinding]
= field(default_factory=list)

imported_styles

attributeimported_stylesList[str]
= field(default_factory=list)

inserted_blocks

attributeinserted_blocksint
= 0

media_copied

attributemedia_copiedList[str]
= field(default_factory=list)

numbering_map

attributenumbering_mapDict[int, int]
= field(default_factory=dict)

renamed_styles

attributerenamed_stylesDict[str, str]
= field(default_factory=dict)

style_map

attributestyle_mapDict[str, str]
= field(default_factory=dict)

Functions

to_dict

functo_dict() -> dict

Returns

dict

On this page