API reference
API reference
Overview of the complete public pdfspine API, with a map of how the reference pages are organised.
This reference documents the complete public API of pdfspine — every name
exported from the top-level package (pdfspine.__all__). Each class, function
and constant is rendered directly from its docstring, so the reference never
drifts from the implementation.
import pdfspineMethods that exist but raise PdfUnsupportedError are documented as such in
their docstrings; see Migrating from PyMuPDF
for the deferred / out-of-scope surface.
How this reference is organised
| Page | Covers |
|---|---|
| Documents & pages | Document, Page |
| Text extraction | TextPage |
| Rendering | Pixmap, DisplayList |
| Annotations & forms | Annot, Widget |
| Drawing & text | Shape, Font, TextWriter |
| Tables | Table, TableFinder |
| Navigation | Link, linkDest, Outline |
| Color | Colorspace |
| Tools | Tools |
| Geometry | Rect, IRect, Point, Matrix, Quad |
| Functions | open, install_fitz_shim, identity_matrix, helpers |
| Exceptions | PdfError hierarchy |
| Constants | PDF_* / TEXT_* / STAMP_* values, colorspace singletons |