API reference
Constants The 247 PyMuPDF-compatible module-level constants re-exported by pdfspine, grouped by family with names and values.
Full API for
pdfspine.constants — methods, signatures, and docstrings — is generated from source. See the
pdfspine API reference or your editor's autocomplete.
The 247 PyMuPDF-compatible module-level constants below are re-exported at the top level of pdfspine (e.g. pdfspine.PDF_ENCRYPT_AES_256) and match PyMuPDF 1.27 exactly. They are also reachable via the pdfspine.constants submodule.
Name Value CS_CMYK3CS_GRAY2CS_RGB1
Name Value PDF_ANNOT_3D26PDF_ANNOT_CARET14PDF_ANNOT_CIRCLE5PDF_ANNOT_FILE_ATTACHMENT17PDF_ANNOT_FREE_TEXT2PDF_ANNOT_HIGHLIGHT8PDF_ANNOT_INK15PDF_ANNOT_LINE3PDF_ANNOT_LINK1PDF_ANNOT_MOVIE19PDF_ANNOT_POLYGON6PDF_ANNOT_POLY_LINE7PDF_ANNOT_POPUP16PDF_ANNOT_PRINTER_MARK23PDF_ANNOT_PROJECTION27PDF_ANNOT_REDACT12PDF_ANNOT_RICH_MEDIA20PDF_ANNOT_SCREEN22PDF_ANNOT_SOUND18PDF_ANNOT_SQUARE4PDF_ANNOT_SQUIGGLY10PDF_ANNOT_STAMP13PDF_ANNOT_STRIKE_OUT11PDF_ANNOT_TEXT0PDF_ANNOT_TRAP_NET24PDF_ANNOT_UNDERLINE9PDF_ANNOT_UNKNOWN-1PDF_ANNOT_WATERMARK25PDF_ANNOT_WIDGET21
Name Value PDF_ANNOT_IS_HIDDEN2PDF_ANNOT_IS_INVISIBLE1PDF_ANNOT_IS_LOCKED128PDF_ANNOT_IS_LOCKED_CONTENTS512PDF_ANNOT_IS_NO_ROTATE16PDF_ANNOT_IS_NO_VIEW32PDF_ANNOT_IS_NO_ZOOM8PDF_ANNOT_IS_PRINT4PDF_ANNOT_IS_READ_ONLY64PDF_ANNOT_IS_TOGGLE_NO_VIEW256PDF_ANNOT_Q_CENTER1PDF_ANNOT_Q_LEFT0PDF_ANNOT_Q_RIGHT2
Name Value PDF_ANNOT_IT_DEFAULT0PDF_ANNOT_IT_FREETEXT_CALLOUT1PDF_ANNOT_IT_FREETEXT_TYPEWRITER2PDF_ANNOT_IT_LINE_ARROW3PDF_ANNOT_IT_LINE_DIMENSION4PDF_ANNOT_IT_POLYGON_CLOUD6PDF_ANNOT_IT_POLYGON_DIMENSION7PDF_ANNOT_IT_POLYLINE_DIMENSION5PDF_ANNOT_IT_STAMP_IMAGE8PDF_ANNOT_IT_STAMP_SNAPSHOT9PDF_ANNOT_IT_UNKNOWN255
Name Value PDF_ANNOT_LE_BUTT6PDF_ANNOT_LE_CIRCLE2PDF_ANNOT_LE_CLOSED_ARROW5PDF_ANNOT_LE_DIAMOND3PDF_ANNOT_LE_NONE0PDF_ANNOT_LE_OPEN_ARROW4PDF_ANNOT_LE_R_CLOSED_ARROW8PDF_ANNOT_LE_R_OPEN_ARROW7PDF_ANNOT_LE_SLASH9PDF_ANNOT_LE_SQUARE1
Name Value PDF_BM_Color'Color'PDF_BM_ColorBurn'ColorBurn'PDF_BM_ColorDodge'ColorDodge'PDF_BM_Darken'Darken'PDF_BM_Difference'Difference'PDF_BM_Exclusion'Exclusion'PDF_BM_HardLight'HardLight'PDF_BM_Hue'Hue'PDF_BM_Lighten'Lighten'PDF_BM_Luminosity'Luminosity'PDF_BM_Multiply'Multiply'PDF_BM_Normal'Normal'PDF_BM_Overlay'Overlay'PDF_BM_Saturation'Saturation'PDF_BM_Screen'Screen'PDF_BM_SoftLight'Softlight'
Name Value PDF_BORDER_STYLE_BEVELED2PDF_BORDER_STYLE_DASHED1PDF_BORDER_STYLE_INSET3PDF_BORDER_STYLE_SOLID0PDF_BORDER_STYLE_UNDERLINE4
Name Value PDF_ENCRYPT_AES_1284PDF_ENCRYPT_AES_2565PDF_ENCRYPT_KEEP0PDF_ENCRYPT_NONE1PDF_ENCRYPT_RC4_1283PDF_ENCRYPT_RC4_402PDF_ENCRYPT_UNKNOWN6
Name Value PDF_FIELD_IS_NO_EXPORT4PDF_FIELD_IS_READ_ONLY1PDF_FIELD_IS_REQUIRED2
Name Value PDF_PAGE_LABEL_ALPHA_LC'a'PDF_PAGE_LABEL_ALPHA_UC'A'PDF_PAGE_LABEL_DECIMAL'D'PDF_PAGE_LABEL_NONE0PDF_PAGE_LABEL_ROMAN_LC'r'PDF_PAGE_LABEL_ROMAN_UC'R'
Name Value PDF_PERM_ACCESSIBILITY512PDF_PERM_ANNOTATE32PDF_PERM_ASSEMBLE1024PDF_PERM_COPY16PDF_PERM_FORM256PDF_PERM_MODIFY8PDF_PERM_PRINT4PDF_PERM_PRINT_HQ2048
Name Value PDF_REDACT_IMAGE_NONE0PDF_REDACT_IMAGE_PIXELS2PDF_REDACT_IMAGE_REMOVE1PDF_REDACT_IMAGE_REMOVE_UNLESS_INVISIBLE3PDF_REDACT_LINE_ART_NONE0PDF_REDACT_LINE_ART_REMOVE_IF_COVERED1PDF_REDACT_LINE_ART_REMOVE_IF_TOUCHED2PDF_REDACT_TEXT_NONE1PDF_REDACT_TEXT_REMOVE0PDF_REDACT_TEXT_REMOVE_INVISIBLE2
Name Value PDF_SIGNATURE_DEFAULT_APPEARANCE63PDF_SIGNATURE_ERROR_DIGEST_FAILURE3PDF_SIGNATURE_ERROR_NOT_SIGNED7PDF_SIGNATURE_ERROR_NOT_TRUSTED6PDF_SIGNATURE_ERROR_NO_CERTIFICATE2PDF_SIGNATURE_ERROR_NO_SIGNATURES1PDF_SIGNATURE_ERROR_OKAY0PDF_SIGNATURE_ERROR_SELF_SIGNED4PDF_SIGNATURE_ERROR_SELF_SIGNED_IN_CHAIN5PDF_SIGNATURE_ERROR_UNKNOWN8PDF_SIGNATURE_SHOW_DATE4PDF_SIGNATURE_SHOW_DN2PDF_SIGNATURE_SHOW_GRAPHIC_NAME16PDF_SIGNATURE_SHOW_LABELS1PDF_SIGNATURE_SHOW_LOGO32PDF_SIGNATURE_SHOW_TEXT_NAME8
Name Value PDF_TOK_CLOSE_ARRAY3PDF_TOK_CLOSE_BRACE7PDF_TOK_CLOSE_DICT5PDF_TOK_ENDOBJ18PDF_TOK_ENDSTREAM20PDF_TOK_EOF1PDF_TOK_ERROR0PDF_TOK_FALSE15PDF_TOK_INT9PDF_TOK_KEYWORD12PDF_TOK_NAME8PDF_TOK_NEWOBJ24PDF_TOK_NULL16PDF_TOK_OBJ17PDF_TOK_OPEN_ARRAY2PDF_TOK_OPEN_BRACE6PDF_TOK_OPEN_DICT4PDF_TOK_R13PDF_TOK_REAL10PDF_TOK_STARTXREF23PDF_TOK_STREAM19PDF_TOK_STRING11PDF_TOK_TRAILER22PDF_TOK_TRUE14PDF_TOK_XREF21
Name Value PDF_WIDGET_TX_FORMAT_DATE3PDF_WIDGET_TX_FORMAT_NONE0PDF_WIDGET_TX_FORMAT_NUMBER1PDF_WIDGET_TX_FORMAT_SPECIAL2PDF_WIDGET_TX_FORMAT_TIME4
Name Value PDF_WIDGET_TYPE_BUTTON1PDF_WIDGET_TYPE_CHECKBOX2PDF_WIDGET_TYPE_COMBOBOX3PDF_WIDGET_TYPE_LISTBOX4PDF_WIDGET_TYPE_RADIOBUTTON5PDF_WIDGET_TYPE_SIGNATURE6PDF_WIDGET_TYPE_TEXT7PDF_WIDGET_TYPE_UNKNOWN0
Name Value STAMP_Approved0STAMP_AsIs1STAMP_Confidential2STAMP_Departmental3STAMP_Draft13STAMP_Experimental4STAMP_Expired5STAMP_Final6STAMP_ForComment7STAMP_ForPublicRelease8STAMP_NotApproved9STAMP_NotForPublicRelease10STAMP_Sold11STAMP_TopSecret12
Name Value SigFlag_AppendOnly2SigFlag_SignaturesExist1
Name Value TEXTFLAGS_BLOCKS195TEXTFLAGS_DICT199TEXTFLAGS_HTML199TEXTFLAGS_RAWDICT199TEXTFLAGS_SEARCH210TEXTFLAGS_TEXT195TEXTFLAGS_WORDS195TEXTFLAGS_XHTML199TEXTFLAGS_XML195
Name Value TEXT_ALIGN_CENTER1TEXT_ALIGN_JUSTIFY3TEXT_ALIGN_LEFT0TEXT_ALIGN_RIGHT2
Name Value TEXT_ENCODING_CYRILLIC2TEXT_ENCODING_GREEK1TEXT_ENCODING_LATIN0
Name Value TEXT_FONT_BOLD16TEXT_FONT_ITALIC2TEXT_FONT_MONOSPACED8TEXT_FONT_SERIFED4TEXT_FONT_SUPERSCRIPT1
Name Value TEXT_OUTPUT_HTML1TEXT_OUTPUT_JSON2TEXT_OUTPUT_TEXT0TEXT_OUTPUT_XHTML4TEXT_OUTPUT_XML3
Name Value TEXT_ACCURATE_ASCENDERS262144TEXT_ACCURATE_BBOXES512TEXT_ACCURATE_SIDE_BEARINGS524288TEXT_CID_FOR_UNKNOWN_UNICODE128TEXT_CLIP64TEXT_CLIP_RECT131072TEXT_COLLECT_STRUCTURE256TEXT_COLLECT_STYLES32768TEXT_COLLECT_VECTORS1024TEXT_DEHYPHENATE16TEXT_FUZZY_VECTORS2097152TEXT_IGNORE_ACTUALTEXT2048TEXT_INHIBIT_SPACES8TEXT_LAZY_VECTORS1048576TEXT_MEDIABOX_CLIP64TEXT_PARAGRAPH_BREAK8192TEXT_PRESERVE_IMAGES4TEXT_PRESERVE_LIGATURES1TEXT_PRESERVE_SPANS32TEXT_PRESERVE_WHITESPACE2TEXT_SEGMENT4096TEXT_STEXT_SEGMENT4096TEXT_TABLE_HUNT16384TEXT_USE_CID_FOR_UNKNOWN_UNICODE128TEXT_USE_GID_FOR_UNKNOWN_UNICODE65536
Name Value VersionBind'0.0.0'VersionDateNoneVersionFitz'0.0.0'version('0.0.0', '0.0.0', None)version_info('0.0.0', '0.0.0', None)
These pre-built objects are re-exported at the top level for PyMuPDF compatibility:
Name Type Description csGRAYColorspaceThe DeviceGray colorspace singleton. csRGBColorspaceThe DeviceRGB colorspace singleton. csCMYKColorspaceThe DeviceCMYK colorspace singleton. TOOLSToolsThe shared Tools helper instance (PyMuPDF fitz.TOOLS). Base14_fontnamestuple[str, ...]Names of the 14 standard PDF fonts. Base14_fontdictdict[str, str]Alias → canonical Base-14 font name. __version__strThe installed pdfspine version string.