PyMuPDF Documentation

• Introduction
  • Note on the Name fitz
  • License and Copyright
  • Covered Version
• Installation
  • Option 1: Install from Sources
    • Step 1: Download PyMuPDF
    • Step 2: Download and Generate MuPDF
    • Step 3: Build / Setup PyMuPDF
  • Option 2: Install from Binaries
• Tutorial
  • Importing the Bindings
  • Opening a Document
  • Some Document Methods and Attributes
  • Accessing Meta Data
  • Working with Outlines
  • Working with Pages
    • Inspecting the Links, Annotations or Form Fields of a Page
    • Rendering a Page
    • Saving the Page Image in a File
    • Displaying the Image in GUIs
      • wxPython
      • Tkinter
      • PyQt4, PyQt5, PySide
    • Extracting Text and Images
    • Searching for Text
  • PDF Maintenance
    • Modifying, Creating, Re-arranging and Deleting Pages
    • Joining and Splitting PDF Documents
    • Embedding Data
    • Saving
  • Closing
  • Further Reading
• Collection of Recipes
  • Images
    • How to Make Images from Document Pages
    • How to Increase Image Resolution
    • How to Create Partial Pixmaps (Clips)
    • How to Zoom a Clip to a GUI Window
    • How to Create or Suppress Annotation Images
    • How to Extract Images: Non-PDF Documents
    • How to Extract Images: PDF Documents
    • How to Handle Stencil Masks
    • How to Make one PDF of all your Pictures (or Files)
    • How to Create Vector Images
    • How to Convert Images
    • How to Use Pixmaps: Glueing Images
    • How to Use Pixmaps: Making a Fractal
    • How to Interface with NumPy
    • How to Add Images to a PDF Page
    • How to Control the Size of Inserted Images
  • Text
    • How to Extract all Document Text
    • How to Extract Text from within a Rectangle
    • How to Extract Text in Natural Reading Order
    • How to Extract Tables from Documents
    • How to Mark Extracted Text
    • How to Mark Searched Text
    • How to Mark Non-horizontal Text
    • How to Analyze Font Characteristics
    • How to Insert Text
      • How to Write Text Lines
      • How to Fill a Text Box
      • How to Use Non-Standard Encoding
  • Annotations
    • How to Add and Modify Annotations
    • How to Use FreeText
    • Using Buttons and JavaScript
    • How to Use Ink Annotations
  • Drawing and Graphics
  • Extracting Drawings
  • Multiprocessing
  • General
    • How to Open with a Wrong File Extension
    • How to Embed or Attach Files
    • How to Delete and Re-Arrange Pages
    • How to Join PDFs
    • How to Add Pages
    • How To Dynamically Clean Up Corrupt PDFs
    • How to Split Single Pages
    • How to Combine Single Pages
    • How to Convert Any Document to PDF
    • How to Deal with Messages Issued by MuPDF
    • How to Deal with PDF Encryption
  • Common Issues and their Solutions
    • Changing Annotations: Unexpected Behaviour
      • Problem
      • Cause
      • Solutions
    • Misplaced Item Insertions on PDF Pages
      • Problem
      • Cause
      • Solutions
  • Low-Level Interfaces
    • How to Iterate through the xref Table
    • How to Handle Object Streams
    • How to Handle Page Contents
    • How to Access the PDF Catalog
    • How to Access the PDF File Trailer
    • How to Access XML Metadata
    • How to Extend PDF Metadata
    • How to Read and Update PDF Objects
• Using fitz as a Module
  • Invocation
  • Cleaning and Copying
  • Extracting Fonts and Images
  • Joining PDF Documents
  • Low Level Information
  • Embedded Files Commands
    • Information
    • Extraction
    • Deletion
    • Insertion
    • Updates
    • Copying
• Classes
  • Annot
    • Annotation Icons in MuPDF
    • Example
  • Colorspace
  • DisplayList
  • Document
    • set_metadata() Example
    • set_toc() Demonstration
    • insert_pdf() Examples
    • Other Examples
  • Font
  • Identity
  • IRect
  • Link
  • linkDest
  • Matrix
    • Examples
    • Shifting
    • Flipping
    • Shearing
    • Rotating
  • Outline
  • Page
    • Modifying Pages
    • Description of get_links() Entries
    • Notes on Supporting Links
      • Reading (pertains to method get_links() and the first_link property chain)
      • Writing
    • Homologous Methods of Document and Page
  • Pixmap
    • Supported Input Image Formats
    • Supported Output Image Formats
  • Point
  • Quad
    • Remark
  • Rect
  • Shape
    • Usage
    • Examples
    • Common Parameters
  • TextPage
    • Structure of Dictionary Outputs
      • Page Dictionary
      • Block Dictionaries
      • Line Dictionary
      • Span Dictionary
      • Character Dictionary for extractRAWDICT()
  • TextWriter
  • Tools
    • Example Session
  • Widget
    • Standard Fonts for Widgets
    • Supported Widget Types
• Operator Algebra for Geometry Objects
  • General Remarks
  • Unary Operations
  • Binary Operations
  • Some Examples
    • Manipulation with numbers
    • Manipulation with “like” Objects
• Low Level Functions and Classes
  • Functions
  • Device
  • Working together: DisplayList and TextPage
    • Create a DisplayList
    • Generate Pixmap
    • Perform Text Search
    • Extract Text
    • Further Performance improvements
      • Pixmap
      • TextPage
• Glossary
• Constants and Enumerations
  • Constants
  • Document Permissions
  • PDF encryption method codes
  • Font File Extensions
  • Text Alignment
  • Text Extraction Flags
  • Link Destination Kinds
  • Link Destination Flags
  • Annotation Related Constants
    • Annotation Types
    • Annotation Flag Bits
    • Annotation Line Ending Styles
  • Widget Constants
    • Widget Types (field_type)
    • Text Widget Subtypes (text_format)
    • Widget flags (field_flags)
  • PDF Standard Blend Modes
  • Stamp Annotation Icons
• Color Database
  • Function getColor()
  • Printing the Color Database
• Appendix 1: Performance
  • Part 1: Parsing
  • Part 2: Text Extraction
  • Part 3: Image Rendering
• Appendix 2: Details on Text Extraction
  • General structure of a TextPage
  • Plain Text
  • BLOCKS
  • WORDS
  • HTML
  • Controlling Quality of HTML Output
  • DICT (or JSON)
  • RAWDICT
  • XML
  • XHTML
  • Text Extraction Flags Defaults
  • Performance
• Appendix 3: Considerations on Embedded Files
  • General
  • MuPDF Support
  • PyMuPDF Support
• Appendix 4: Assorted Technical Information
  • Image Transformation Matrix
  • PDF Base 14 Fonts
  • Adobe PDF References
  • Using Python Sequences as Arguments in PyMuPDF
  • Ensuring Consistency of Important Objects in PyMuPDF
  • Design of Method Page.show_pdf_page()
    • Purpose and Capabilities
    • Technical Implementation
  • Redirecting Error and Warning Messages
• Change Logs
  • Changes in Version 1.18.15
  • Changes in Version 1.18.14
  • Changes in Version 1.18.13
  • Changes in Version 1.18.11 / 1.18.12
  • Changes in Version 1.18.10
  • Changes in Version 1.18.9
  • Changes in Version 1.18.8
  • Changes in Version 1.18.7
  • Changes in Version 1.18.6
  • Changes in Version 1.18.5
  • Changes in Version 1.18.4
  • Changes in Version 1.18.3
  • Changes in Version 1.18.2
  • Changes in Version 1.18.1
  • Changes in Version 1.18.0
  • Changes in Version 1.17.7
  • Changes in Version 1.17.6
  • Changes in Version 1.17.5
  • Changes in Version 1.17.4
  • Changes in Version 1.17.3
  • Changes in Version 1.17.2
  • Changes in Version 1.17.1
  • Changes in Version 1.17.0
  • Changes in Version 1.16.18
  • Changes in Version 1.16.17
  • Changes in Version 1.16.16
  • Changes in Version 1.16.14
  • Changes in Version 1.16.13
  • Changes in Version 1.16.12
  • Changes in Version 1.16.11
  • Changes in Version 1.16.10
  • Changes in Version 1.16.9
  • Changes in Version 1.16.8
  • Changes in Version 1.16.7
  • Changes in Version 1.16.6
  • Changes in Version 1.16.5
  • Changes in Version 1.16.4
  • Changes in Version 1.16.3
  • Changes in Version 1.16.2
  • Changes in Version 1.16.1
  • Changes in Version 1.16.0
  • No version published for MuPDF v1.15.0
  • Changes in Version 1.14.20 / 1.14.21
  • Changes in Version 1.14.19
  • Changes in Version 1.14.17
  • Changes in Version 1.14.16
  • Changes in Version 1.14.15
  • Changes in Version 1.14.14
  • Changes in Version 1.14.13
  • Changes in Version 1.14.12
  • Changes in Version 1.14.11
  • Changes in Version 1.14.10
  • Changes in Version 1.14.9
  • Changes in Version 1.14.8
  • Changes in Version 1.14.7
  • Changes in Version 1.14.5
  • Changes in Version 1.14.4
  • Changes in Version 1.14.3
  • Changes in Version 1.14.1
  • Changes in Version 1.14.0
  • Changes in Version 1.13.19
  • Changes in Version 1.13.18
  • Changes in Version 1.13.17
  • Changes in Version 1.13.16
  • Changes in Version 1.13.15
  • Changes in Version 1.13.14
  • Changes in Version 1.13.13
  • Changes in Version 1.13.12
  • Changes in Version 1.13.11
  • Changes in Version 1.13.7
  • Changes in Version 1.13.6
  • Changes in Version 1.13.5
  • Changes in Version 1.13.4
  • Changes in Version 1.13.3
  • Changes in Version 1.13.2
  • Changes in Version 1.13.1
  • Changes in Version 1.13.0
  • Changes in Version 1.12.4
  • Changes in Version 1.12.3
  • Changes in Version 1.12.2
  • Changes in Version 1.12.1
  • Changes in Version 1.12.0
  • Changes in Version 1.11.2
  • Changes in Version 1.11.1
  • Changes in Version 1.11.0
  • Changes in Version 1.10.0
    • MuPDF v1.10 Impact
    • Other Changes compared to Version 1.9.3
  • Changes in Version 1.9.3
  • Changes in Version 1.9.2
  • Changes in Version 1.9.1
• Deprecated Names