API Reference
Top-level facade
The two classes every user starts from. App owns the COM engine lifecycle; Document owns per-document state via app.doc.
| App | Slim facade โ lifecycle + window-level concerns. |
| Document | Per-document facade โ text, cursor, collections. |
Collections
Dict-like + iterable + filterable collections under app.doc.*. Every collection implements the Collection Protocol.
| fields | Field (๋๋ฆํ) collection. |
| bookmarks | Bookmark (์ฑ ๊ฐํผ) collection. |
| hyperlinks | Hyperlink collection. |
| images | Image collection. |
| paragraphs | Paragraph collection with Run element. |
| styles | Style collection. |
| tables | Table collection with Table/Cell elements. |
Context managers
Formatting scopes extracted from the v1 App. All three live at module level so you can drive them from any App instance.
| context.scopes | charshape_scope / parashape_scope / styled_text. |
I/O and export
Thin, error-wrapping shortcuts over the raw COM open/save calls.
| io.open | open_file / new_document. |
| io.export | export_pdf / export_image / export_text. |
Errors
Exception hierarchy every public call promises to raise.
| errors | HwpApiError and subclasses. |
Units
mm / cm / inch / pt โ๏ธ HWPUNIT conversion helpers.
| units | Unit conversion module. |
Low-level escape hatch
Raw action wrappers, ParameterSet classes, and the COM engine. Prefer the top-level facade unless you need something the facade does not expose yet.
| low.actions | 900+ HWP action wrappers. |
| low.engine | Engine / Engines / Apps. |
| low.parametersets | ParameterSet classes (CharShape, ParaShape, โฆ). |