Paper Office
paper-pptxAPI referencecompose

ImportReport

paper-pptx 0.2.0 API reference

What one import did. Deterministic; .to_dict() is goldenable.

Fields:

  • mode -- the reconciliation mode used ("adopt_theme", "keep_appearance", "bake").
  • source_slide -- partname of the imported slide in the source presentation.
  • dest_slide / dest_slide_id -- partname and permanent slide id of the new slide in the destination.
  • position -- 0-based index the new slide was inserted at.
  • layout_binding -- partname of the destination layout the slide is bound to.
  • layout_binding_method -- how that layout was chosen ("name-match", "type-match", "explicit", "transplant", or "blank-fallback"). Automatic methods always identify a unique candidate at their matching tier.
  • placeholder_map_used -- the complete resolved (source_idx, target_idx) mapping for adopt-theme reconciliation; target_idx is None for an orphan. Empty for keep-appearance and bake.
  • parts_added -- partnames added to the destination package by this import.
  • parts_reused -- partnames of existing destination parts reused via content-hash deduplication (keep_appearance).
  • notes_copied -- whether the source slide's speaker-notes part was imported.
  • comments_dropped -- count of comment parts dropped (comments never travel).
  • section / section_id -- name and exact GUID of the destination section the slide was enrolled in, or None when it was not enrolled in a section.
  • baked_shapes -- names of placeholders converted to free baked shapes.
  • dropped_placeholders -- names of furniture placeholders (dt/ftr/sldNum) removed under "bake".
  • run_shifts -- :class:pptx.rebind.RunShift entries for every run whose resolved appearance changed (populated for "adopt_theme"; empty for keep_appearance).
ImportReport(mode: str, source_slide: str, dest_slide: str, dest_slide_id: int, position: int, layout_binding: str, layout_binding_method: str, placeholder_map_used: Tuple[Tuple[int, Optional[int]], ...], parts_added: Tuple[str, ...], parts_reused: Tuple[str, ...], notes_copied: bool, comments_dropped: int, section: Optional[str], section_id: Optional[str], baked_shapes: Tuple[str, ...], dropped_placeholders: Tuple[str, ...], run_shifts: tuple)

Attributes

baked_shapes

attributebaked_shapesTuple[str, ...]

comments_dropped

attributecomments_droppedint

dest_slide

attributedest_slidestr

dest_slide_id

attributedest_slide_idint

dropped_placeholders

attributedropped_placeholdersTuple[str, ...]

layout_binding

attributelayout_bindingstr

layout_binding_method

attributelayout_binding_methodstr

mode

attributemodestr

notes_copied

attributenotes_copiedbool

parts_added

attributeparts_addedTuple[str, ...]

parts_reused

attributeparts_reusedTuple[str, ...]

placeholder_map_used

attributeplaceholder_map_usedTuple[Tuple[int, Optional[int]], ...]

position

attributepositionint

run_shifts

attributerun_shiftstuple

section

attributesectionOptional[str]

section_id

attributesection_idOptional[str]

source_slide

attributesource_slidestr

Functions

to_dict

functo_dict() -> dict

Return the import report as a JSON-ready dict stamped with its schema and version.

Returns

dict

On this page