Change Logs¶
Changes in Version 1.16.18¶
This version introduces several new features around PDF text output. The motivation is to simplify this task, while at the same time offering extending features.
One major achievement is using MuPDF’s capabilities to dynamically choosing fallback fonts whenever a character cannot be found in the predefined one. This seemlessly works for Base-14 fonts in combination with CJK fonts (China, Japan, Korea).
Fixed issue #493.
Pixmap(doc, xref)
should now again correctly resemble the loaded image object.Fixed issue #488. Widget names are now modifyable.
Added new class Font which represents a font.
Added new class TextWriter which serves as a container for text to be written on a page.
Added
Page.writeText()
to write one or more TextWriter objects to the page.
Changes in Version 1.16.17¶
Fixed issue #479. PyMuPDF should now more correctly report image resolutions. This applies to both, images (either from images files or extracted from PDF documents) and pixmaps created from images.
Added
Pixmap.setResolution()
which sets the image resolution in x and y directions.
Changes in Version 1.16.16¶
Changes in Version 1.16.14¶
Changed text marker annotations to accept parameters beyond just quadrilaterals such that now text lines between two given points can be marked.
Added
Document.scrub()
which removes potentially sensitive data from a PDF. Implements #453.Added
Annot.blendMode()
which returns the blend mode of annotations.Added
Annot.setBlendMode()
to set the annotation’s blend mode. This resolves issue #416.Changed
Annot.update()
to accept additional parameters for setting blend mode and opacity.Added advanced graphics features to control the anti-aliasing values,
Tools.set_aa_level()
. Resolves #467Fixed issue #474.
Fixed issue #466.
Changes in Version 1.16.13¶
Added
Document.getPageXObjectList()
which returns a list of Form XObjects of the page.Added
Page.setMediaBox()
for changing the physical PDF page size.Added Page methods which have been internal before:
Page.cleanContents()
(=Page._cleanContents()
),Page.getContents()
(=Page._getContents()
),Page.getTransformation()
(=Page._getTransformation()
).
Changes in Version 1.16.12¶
Fixed issue #447
Fixed issue #461.
Fixed issue #397.
Fixed issue #463.
Added JavaScript support to PDF form fields, thereby fixing #454.
Added a new annotation method
Annot.delete_responses()
, which removes ‘Popup’ and response annotations referring to the current one. Mainly serves data protection purposes.Added a new form field method
Widget.reset()
, which resets the field value to its default.Changed and extended handling of redactions: images and XObjects are removed if contained in a redaction rectangle. Any partial only overlaps will just be covered by the redaction background color. Now an overlay text can be specified to be inserted in the rectangle area to take the place the deleted original text. This resolves #434.
Changes in Version 1.16.11¶
Added Support for redaction annotations via method
Page.addRedactAnnot()
andPage.apply_redactions()
.Fixed issue #426 (“PolygonAnnotation in 1.16.10 version”).
Changes in Version 1.16.10¶
Fixed issue #421 (“annot.setRect(rect) has no effect on text Annotation”)
Fixed issue #417 (“Strange behavior for page.deleteAnnot on 1.16.9 compare to 1.13.20”)
Fixed issue #415 (“Annot.setOpacity throws mupdf warnings”)
Changed all “add annotation / widget” methods to store a unique name in the /NM PDF key.
Changed
Annot.setInfo()
to also accept direct parameters in addition to a dictionary.Changed
Annot.info
to now also show the annotation’s unique id (/NM PDF key) if present.Added
Page.annot_names()
which returns a list of all annotation names (/NM keys).Added
Page.load_annot()
which loads an annotation given its unique id (/NM key).Added
Document.reload_page()
which provides a new copy of a page after finishing any pending updates to it.
Changes in Version 1.16.9¶
Fixed #412 (“Feature Request: Allow controlling whether TOC entries should be collapsed”)
Fixed #411 (“Seg Fault with page.firstWidget”)
Fixed #407 (“Annot.setOpacity trouble”)
Changed methods
Annot.setBorder()
,Annot.setColors()
,Link.setBorder()
, andLink.setColors()
to also accept direct parameters, and not just cumbersome dictionaries.
Changes in Version 1.16.8¶
Added several new methods to the Document class, which make dealing with PDF low-level structures easier. I also decided to provide them as “normal” methods (as opposed to private ones starting with an underscore “_”). These are
Document.xrefObject()
,Document.xrefStream()
,Document.xrefStreamRaw()
,Document.PDFTrailer()
,Document.PDFCatalog()
,Document.metadataXML()
,Document.updateObject()
,Document.updateStream()
.Added
Tools.mupdf_disply_errors()
which sets the display of mupdf errors on sys.stderr.Added a commandline facility. This a major new feature: you can now invoke several utility functions via “python -m fitz …”. It should obsolete the need for many of the most trivial scripts. Please refer to Using fitz as a Module.
Changes in Version 1.16.7¶
Minor changes to better synchronize the binary image streams of TextPage image blocks and Document.extractImage()
images.
Fixed issue #394 (“PyMuPDF Segfaults when using TOOLS.mupdf_warnings()”).
Changed redirection of MuPDF error messages: apart from writing them to Python sys.stderr, they are now also stored with the MuPDF warnings.
Changed
Tools.mupdf_warnings()
to automatically empty the store (if not deactivated via a parameter).Changed
Page.getImageBbox()
to return an infinite rectangle if the image could not be located on the page – instead of raising an exception.
Changes in Version 1.16.6¶
Fixed issue #390 (“Incomplete deletion of annotations”).
Changed
Page.searchFor()
/Document.searchPageFor()
to also support the flags parameter, which controls the data included in a TextPage.Changed
Document.getPageImageList()
,Document.getPageFontList()
and their Page counterparts to support a new parameter full. If true, the returned items will contain thexref
of the Form XObject where the font or image is referenced.
Changes in Version 1.16.5¶
More performance improvements for text extraction.
Fixed second part of issue #381 (see item in v1.16.4).
Added
Page.getTextPage()
, so it is no longer required to create an intermediate display list for text extractions. Page level wrappers for text extraction and text searching are now based on this, which should improve performance by ca. 5%.
Changes in Version 1.16.4¶
Fixed issue #381 (“TextPage.extractDICT … failed … after upgrading … to 1.16.3”)
Added method
Document.pages()
which delivers a generator iterator over a page range.Added method
Page.links()
which delivers a generator iterator over the links of a page.Added method
Page.annots()
which delivers a generator iterator over the annotations of a page.Added method
Page.widgets()
which delivers a generator iterator over the form fields of a page.Changed
Document.isFormPDF
to now contain the number of widgets, and False if not a PDF or this number is zero.
Changes in Version 1.16.3¶
Minor changes compared to version 1.16.2. The code of the “dict” and “rawdict” variants of Page.getText()
has been ported to C which has greatly improved their performance. This improvement is mostly noticeable with text-oriented documents, where they now should execute almost two times faster.
Fixed issue #369 (“mupdf: cmsCreateTransform failed”) by removing ICC colorspace support.
Changed
Page.getText()
to accept additional keywords “blocks” and “words”. These will deliver the results ofPage.getTextBlocks()
andPage.getTextWords()
, respectively. So all text extraction methods are now available via a uniform API. Correspondingly, there are now new methodsTextPage.extractBLOCKS()
andTextPage.extractWords()
.Changed
Page.getText()
to default bit indicator TEXT_INHIBIT_SPACES to off. Insertion of additional spaces is not suppressed by default.
Changes in Version 1.16.2¶
Changed text extraction methods of Page to allow detail control of the amount of extracted data.
Added
planishLine()
which maps a given line (defined as a pair of points) to the x-axis.Fixed an issue (w/o Github number) which brought down the interpreter when encountering certain non-UTF-8 encodable characters while using
Page.getText()
with te “dict” option.Fixed issue #362 (“Memory Leak with getText(‘rawDICT’)”).
Changes in Version 1.16.1¶
Added property
Quad.isConvex
which checks whether a line is contained in the quad if it connects two points of it.Changed
Document.insertPDF()
to now allow dropping or including links and annotations independently during the copy. Fixes issue #352 (“Corrupt PDF data and …”), which seemed to intermittently occur when using the method for some problematic PDF files.Fixed a bug which, in matrix division using the syntax “m1/m2”, caused matrix “m1” to be replaced by the result instead of delivering a new matrix.
Fixed issue #354 (“SyntaxWarning with Python 3.8”). We now always use “==” for literals (instead of the “is” Python keyword).
Fixed issue #353 (“mupdf version check”), to no longer refuse the import when there are only patch level deviations from MuPDF.
Changes in Version 1.16.0¶
This major new version of MuPDF comes with several nice new or changed features. Some of them imply programming API changes, however. This is a synopsis of what has changed:
PDF document encryption and decryption is now fully supported. This includes setting permissions, passwords (user and owner passwords) and the desired encryption method.
In response to the new encryption features, PyMuPDF returns an integer (ie. a combination of bits) for document permissions, and no longer a dictionary.
Redirection of MuPDF errors and warnings is now natively supported. PyMuPDF redirects error messages from MuPDF to sys.stderr and no longer buffers them. Warnings continue to be buffered and will not be displayed. Functions exist to access and reset the warnings buffer.
Annotations are now only supported for PDF.
Annotations and widgets (form fields) are now separate object chains on a page (although widgets technically still are PDF annotations). This means, that you will never encounter widgets when using
Page.firstAnnot
orAnnot.next()
. You must usePage.firstWidget
andWidget.next()
to access form fields.As part of MuPDF’s changes regarding widgets, only the following four fonts are supported, when adding or changing form fields: Courier, Helvetica, Times-Roman and ZapfDingBats.
List of change details:
Added
Document.can_save_incrementally()
which checks conditions that are preventing use of option incremental=True ofDocument.save()
.Added
Page.firstWidget
which points to the first field on a page.Added
Page.getImageBbox()
which returns the rectangle occupied by an image shown on the page.Added
Annot.setName()
which lets you change the (icon) name field.Added outputting the text color in
Page.getText()
: the “dict”, “rawdict” and “xml” options now also show the color in sRGB format.Changed
Document.permissions
to now contain an integer of bool indicators – was a dictionary before.Changed
Document.save()
,Document.write()
, which now fully support password-based decryption and encryption of PDF files.Changed the names of all Python constants related to annotations and widgets. Please make sure to consult the Constants and Enumerations chapter if your script is dealing with these two classes. This decision goes back to the dropped support for non-PDF annotations. The old names (starting with “ANNOT_*” or “WIDGET_*”) will be available as deprecated synonyms.
Changed font support for widgets: only Cour (Courier), Helv (Helvetica, default), TiRo (Times-Roman) and ZaDb (ZapfDingBats) are accepted when adding or changing form fields. Only the plain versions are possible – not their italic or bold variations. Reading widgets, however will show its original font.
Changed the name of the warnings buffer to
Tools.mupdf_warnings()
and the function to empty this buffer is now calledTools.reset_mupdf_warnings()
.Changed
Page.getPixmap()
,Document.getPagePixmap()
: a new bool argument annots can now be used to suppress the rendering of annotations on the page.Changed
Page.addFileAnnot()
andPage.addTextAnnot()
to enable setting an icon.Removed widget-related methods and attributes from the Annot object.
Removed Document attributes openErrCode, openErrMsg, and Tools attributes / methods stderr, reset_stderr, stdout, and reset_stdout.
Removed thirdparty zlib dependency in PyMuPDF: there are now compression functions available in MuPDF. Source installers of PyMuPDF may now omit this extra installation step.
No version published for MuPDF v1.15.0¶
Changes in Version 1.14.20 / 1.14.21¶
Changed text marker annotations to support multiple rectangles / quadrilaterals. This fixes issue #341 (“Question : How to addhighlight so that a string spread across more than a line is covered by one highlight?”) and similar (#285).
Fixed issue #331 (“Importing PyMuPDF changes warning filtering behaviour globally”).
Changes in Version 1.14.19¶
Fixed issue #319 (“InsertText function error when use custom font”).
Added new method
Document.getSigFlags()
which returns information on whether a PDF is signed. Resolves issue #326 (“How to detect signature in a form pdf?”).
Changes in Version 1.14.17¶
Added
Document.fullcopyPage()
to make full page copies within a PDF (not just copied references asDocument.copyPage()
does).Changed
Page.getPixmap()
,Document.getPagePixmap()
now use alpha=False as default.Changed text extraction: the span dictionary now (again) contains its rectangle under the bbox key.
Changed
Document.movePage()
andDocument.copyPage()
to use direct functions instead of wrappingDocument.select()
– similar toDocument.deletePage()
in v1.14.16.
Changes in Version 1.14.16¶
Changed Document methods around PDF /EmbeddedFiles to no longer use MuPDF’s “portfolio” functions. That support will be dropped in MuPDF v1.15 – therefore another solution was required.
Changed
Document.embeddedFileCount()
to be a function (was an attribute).Added new method
Document.embeddedFileNames()
which returns a list of names of embedded files.Changed
Document.deletePage()
andDocument.deletePageRange()
to internally no longer useDocument.select()
, but instead use functions to perform the deletion directly. As it has turned out, theDocument.select()
method yields invalid outline trees (tables of content) for very complex PDFs and sophisticated use of annotations.
Changes in Version 1.14.15¶
Fixed issues #301 (“Line cap and Line join”), #300 (“How to draw a shape without outlines”) and #298 (“utils.updateRect exception”). These bugs pertain to drawing shapes with PyMuPDF. Drawing shapes without any border is fully supported. Line cap styles and line line join style are now differentiated and support all possible PDF values (0, 1, 2) instead of just being a bool. The previous parameter roundCap is deprecated in favor of lineCap and lineJoin and will be deleted in the next release.
Fixed issue #290 (“Memory Leak with getText(‘rawDICT’)”). This bug caused memory not being (completely) freed after invoking the “dict”, “rawdict” and “json” versions of
Page.getText()
.
Changes in Version 1.14.14¶
Added new low-level function
ImageProperties()
to determine a number of characteristics for an image.Added new low-level function
Document.isStream()
, which checks whether an object is of stream type.Changed low-level functions
Document._getXrefString()
andDocument._getTrailerString()
now by default return object definitions in a formatted form which makes parsing easy.
Changes in Version 1.14.13¶
Changed methods working with binary input: while ever supporting bytes and bytearray objects, they now also accept io.BytesIO input, using their getvalue() method. This pertains to document creation, embedded files, FileAttachment annotations, pixmap creation and others. Fixes issue #274 (“Segfault when using BytesIO as a stream for insertImage”).
Fixed issue #278 (“Is insertImage(keep_proportion=True) broken?”). Images are now correctly presented when keeping aspect ratio.
Changes in Version 1.14.12¶
Changed the draw methods of Page and Shape to support not only RGB, but also GRAY and CMYK colorspaces. This solves issue #270 (“Is there a way to use CMYK color to draw shapes?”). This change also applies to text insertion methods of Shape, resp. Page.
Fixed issue #269 (“AttributeError in Document.insertPage()”), which occurred when using
Document.insertPage()
with text insertion.
Changes in Version 1.14.11¶
Changed
Page.showPDFpage()
to always position the source rectangle centered in the target. This method now also supports rotation by arbitrary angles. The argument reuse_xref has been deprecated: prevention of duplicates is now handled internally.Changed
Page.insertImage()
to support rotated display of the image and keeping the aspect ratio. Only rotations by multiples of 90 degrees are supported here.Fixed issue #265 (“TypeError: insertText() got an unexpected keyword argument ‘idx’”). This issue only occurred when using
Document.insertPage()
with also inserting text.
Changes in Version 1.14.10¶
Changed
Page.showPDFpage()
to support rotation of the source rectangle. Fixes #261 (“Cannot rotate insterted pages”).Fixed a bug in
Page.insertImage()
which prevented insertion of multiple images provided as streams.
Changes in Version 1.14.9¶
Added new low-level method
Document._getTrailerString()
, which returns the trailer object of a PDF. This is much likeDocument._getXrefString()
except that the PDF trailer has no / needs noxref
to identify it.Added new parameters for text insertion methods. You can now set stroke and fill colors of glyphs (text characters) independently, as well as the thickness of the glyph border. A new parameter render_mode controls the use of these colors, and whether the text should be visible at all.
Fixed issue #258 (“Copying image streams to new PDF without size increase”): For JPX images embedded in a PDF,
Document.extractImage()
will now return them in their original format. Previously, the MuPDF base library was used, which returns them in PNG format (entailing a massive size increase).Fixed issue #259 (“Morphing text to fit inside rect”). Clarified use of
getTextlength()
and removed extra line breaks for long words.
Changes in Version 1.14.8¶
Added
Pixmap.setRect()
to change the pixel values in a rectangle. This is also an alternative to setting the color of a complete pixmap (Pixmap.clearWith()
).Fixed an image extraction issue with JBIG2 (monochrome) encoded PDF images. The issue occurred in
Page.getText()
(parameters “dict” and “rawdict”) and inDocument.extractImage()
methods.Fixed an issue with not correctly clearing a non-alpha Pixmap (
Pixmap.clearWith()
).Fixed an issue with not correctly inverting colors of a non-alpha Pixmap (
Pixmap.invertIRect()
).
Changes in Version 1.14.7¶
Added
Pixmap.setPixel()
to change one pixel value.Added documentation for image conversion in the Collection of Recipes.
Added new function
getTextlength()
to determine the string length for a given font.Added Postscript image output (changed
Pixmap.writeImage()
andPixmap.getImageData()
).Changed
Pixmap.writeImage()
andPixmap.getImageData()
to ensure valid combinations of colorspace, alpha and output format.Changed
Pixmap.writeImage()
: the desired format is now inferred from the filename.Changed FreeText annotations can now have a transparent background - see
Annot.update()
.
Changes in Version 1.14.5¶
Changed: Shape methods now strictly use the transformation matrix of the Page – instead of “manually” calculating locations.
Added method
Pixmap.pixel()
which returns the pixel value (a list) for given pixel coordinates.Added method
Pixmap.getImageData()
which returns a bytes object representing the pixmap in a variety of formats. Previously, this could be done for PNG outputs only (Pixmap.getPNGData()
).Changed: output of methods
Pixmap.writeImage()
and (the new)Pixmap.getImageData()
may now also be PSD (Adobe Photoshop Document).Added method
Shape.drawQuad()
which draws a Quad. This actually is a shorthand for aShape.drawPolyline()
with the edges of the quad.Changed method
Shape.drawOval()
: the argument can now be either a rectangle (rect_like
) or a quadrilateral (quad_like
).
Changes in Version 1.14.4¶
Fixes issue #239 “Annotation coordinate consistency”.
Changes in Version 1.14.3¶
This patch version contains minor bug fixes and CJK font output support.
Added support for the four CJK fonts as PyMuPDF generated text output. This pertains to methods
Page.insertFont()
,Shape.insertText()
,Shape.insertTextbox()
, and corresponding Page methods. The new fonts are available under “reserved” fontnames “china-t” (traditional Chinese), “china-s” (simplified Chinese), “japan” (Japanese), and “korea” (Korean).Added full support for the built-in fonts ‘Symbol’ and ‘Zapfdingbats’.
Changed: The 14 standard fonts can now each be referenced by a 4-letter abbreviation.
Changes in Version 1.14.1¶
This patch version contains minor performance improvements.
Added support for Document filenames given as pathlib object by using the Python str() function.
Changes in Version 1.14.0¶
To support MuPDF v1.14.0, massive changes were required in PyMuPDF – most of them purely technical, with little visibility to developers. But there are also quite a lot of interesting new and improved features. Following are the details:
Added “ink” annotation.
Added “rubber stamp” annotation.
Added “squiggly” text marker annotation.
Added new class Quad (quadrilateral or tetragon) – which represents a general four-sided shape in the plane. The special subtype of rectangular, non-empty tetragons is used in text marker annotations and as returned objects in text search methods.
Added a new option “decrypt” to
Document.save()
andDocument.write()
. Now you can keep encryption when saving a password protected PDF.Added suppression and redirection of unsolicited messages issued by the underlying C-library MuPDF. Consult Redirecting Error and Warning Messages for details.
Changed: Changes to annotations now always require
Annot.update()
to become effective.Changed free text annotations to support the full Latin character set and range of appearance options.
Changed text searching,
Page.searchFor()
, to optionally return Quad instead Rect objects surrounding each search hit.Changed plain text output: we now add a n to each line if it does not itself end with this character.
Fixed issue 211 (“Something wrong in the doc”).
Fixed issue 213 (“Rewritten outline is displayed only by mupdf-based applications”).
Fixed issue 214 (“PDF decryption GONE!”).
Fixed issue 215 (“Formatting of links added with pyMuPDF”).
Fixed issue 217 (“extraction through json is failing for my pdf”).
Behind the curtain, we have changed the implementation of geometry objects: they now purely exist in Python and no longer have “shadow” twins on the C-level (in MuPDF). This has improved processing speed in that area by more than a factor of two.
Because of the same reason, most methods involving geometry parameters now also accept the corresponding Python sequence. For example, in method “page.showPDFpage(rect, …)” parameter rect may now be any rect_like
sequence.
We also invested considerable effort to further extend and improve the Collection of Recipes chapter.
Changes in Version 1.13.19¶
This version contains some technical / performance improvements and bug fixes.
Changed memory management: for Python 3 builds, Python memory management is exclusively used across all C-level code (i.e. no more native malloc() in MuPDF code or PyMuPDF interface code). This leads to improved memory usage profiles and also some runtime improvements: we have seen > 2% shorter runtimes for text extractions and pixmap creations (on Windows machines only to date).
Fixed an error occurring in Python 2.7, which crashed the interpreter when using
TextPage.extractRAWDICT()
(= Page.getText(“rawdict”)).Fixed an error occurring in Python 2.7, when creating link destinations.
Extended the Collection of Recipes chapter with more examples.
Changes in Version 1.13.18¶
Added method
TextPage.extractRAWDICT()
, and a corresponding new string parameter “rawdict” to methodPage.getText()
. It extracts text and images from a page in Python dict form likeTextPage.extractDICT()
, but with the detail level ofTextPage.extractXML()
, which is position information down to each single character.
Changes in Version 1.13.17¶
Fixed an error that intermittently caused an exception in
Page.showPDFpage()
, when pages from many different source PDFs were shown.Changed method
Document.extractImage()
to now return more meta information about the extracted imgage. Also, its performance has been greatly improved. Several demo scripts have been changed to make use of this method.Changed method
Document._getXrefStream()
to now return None if the object is no stream and no longer raise an exception if otherwise.Added method
Document._deleteObject()
which deletes a PDF object identified by itsxref
. Only to be used by the experienced PDF expert.Added a method
PaperRect()
which returns a Rect for a supplied paper format string. Example: fitz.PaperRect(“letter”) = fitz.Rect(0.0, 0.0, 612.0, 792.0).Added a Collection of Recipes chapter to this document.
Changes in Version 1.13.16¶
Added support for correctly setting transparency (opacity) for certain annotation types.
Added a tool property (
Tools.fitz_config
) showing the configuration of this PyMuPDF version.Fixed issue #193 (‘insertText(overlay=False) gives “cannot resize a buffer with shared storage” error’) by avoiding read-only buffers.
Changes in Version 1.13.15¶
Fixed issue #189 (“cannot find builtin CJK font”), so we are supporting builtin CJK fonts now (CJK = China, Japan, Korea). This should lead to correctly generated pixmaps for documents using these languages. This change has consequences for our binary file size: it will now range between 8 and 10 MB, depending on the OS.
Fixed issue #191 (“Jupyter notebook kernel dies after ca. 40 pages”), which occurred when modifying the contents of an annotation.
Changes in Version 1.13.14¶
This patch version contains several improvements, mainly for annotations.
Changed
Annot.lineEnds
is now a list of two integers representing the line end symbols. Previously was a dict of strings.Added support of line end symbols for applicable annotations. PyMuPDF now can generate these annotations including the line end symbols.
Added
Annot.setLineEnds()
adds line end symbols to applicable annotation types (‘Line’, ‘PolyLine’, ‘Polygon’).Changed technical implementation of
Page.insertImage()
andPage.showPDFpage()
: they now create there own contents objects, thereby avoiding changes of potentially large streams with consequential compression / decompression efforts and high change volumes with incremental updates.
Changes in Version 1.13.13¶
This patch version contains several improvements for embedded files and file attachment annotations.
Added
Document.embeddedFileUpd()
which allows changing file content and metadata of an embedded file. It supersedes the old methodDocument.embeddedFileSetInfo()
(which will be deleted in a future version). Content is automatically compressed and metadata may be unicode.Changed
Document.embeddedFileAdd()
to now automatically compress file content. Accompanying metadata can now be unicode (had to be ASCII in the past).Changed
Document.embeddedFileDel()
to now automatically delete all entries having the supplied identifying name. The return code is now an integer count of the removed entries (was None previously).Changed embedded file methods to now also accept or show the PDF unicode filename as additional parameter ufilename.
Added
Page.addFileAnnot()
which adds a new file attachment annotation.Changed
Annot.fileUpd()
(file attachment annot) to now also accept the PDF unicode ufilename parameter. The description parameter desc correctly works with unicode. Furthermore, all parameters are optional, so metadata may be changed without also replacing the file content.Changed
Annot.fileInfo()
(file attachment annot) to now also show the PDF unicode filename as parameter ufilename.Fixed issue #180 (“page.getText(output=’dict’) return invalid bbox”) to now also work for vertical text.
Fixed issue #185 (“Can’t render the annotations created by PyMuPDF”). The issue’s cause was the minimalistic MuPDF approach when creating annotations. Several annotation types have no /AP (“appearance”) object when created by MuPDF functions. MuPDF, SumatraPDF and hence also PyMuPDF cannot render annotations without such an object. This fix now ensures, that an appearance object is always created together with the annotation itself. We still do not support line end styles.
Changes in Version 1.13.12¶
Fixed issue #180 (“page.getText(output=’dict’) return invalid bbox”). Note that this is a circumvention of an MuPDF error, which generates zero-height character rectangles in some cases. When this happens, this fix ensures a bbox height of at least fontsize.
Changed for ListBox and ComboBox widgets, the attribute list of selectable values has been renamed to
Widget.choice_values
.Changed when adding widgets, any missing of the PDF Base 14 Fonts is automatically added to the PDF. Widget text fonts can now also be chosen from existing widget fonts. Any specified field values are now honored and lead to a field with a preset value.
Added
Annot.updateWidget()
which allows changing existing form fields – including the field value.
Changes in Version 1.13.11¶
While the preceeding patch subversions only contained various fixes, this version again introduces major new features:
Added basic support for PDF widget annotations. You can now add PDF form fields of types Text, CheckBox, ListBox and ComboBox. Where necessary, the PDF is tranformed to a Form PDF with the first added widget.
Fixed issues #176 (“wrong file embedding”), #177 (“segment fault when invoking page.getText()”)and #179 (“Segmentation fault using page.getLinks() on encrypted PDF”).
Changes in Version 1.13.7¶
Added support of variable page sizes for reflowable documents (e-books, HTML, etc.): new parameters rect and fontsize in Document creation (open), and as a separate method
Document.layout()
.Added Annot creation of many annotations types: sticky notes, free text, circle, rectangle, line, polygon, polyline and text markers.
Added support of annotation transparency (
Annot.opacity
,Annot.setOpacity()
).Changed
Annot.vertices
: point coordinates are now grouped as pairs of floats (no longer as separate floats).Changed annotation colors dictionary: the two keys are now named “stroke” (formerly “common”) and “fill”.
Added
Document.isDirty
which is True if a PDF has been changed in this session. Reset to False on eachDocument.save()
orDocument.write()
.
Changes in Version 1.13.6¶
Fix #173: for memory-resident documents, ensure the stream object will not be garbage-collected by Python before document is closed.
Changes in Version 1.13.5¶
New low-level method
Page._setContents()
defines an object given by itsxref
to serve as thecontents
object.Changed and extended PDF form field support: the attribute widget_text has been renamed to
Annot.widget_value
. Values of all form field types (except signatures) are now supported. A new attributeAnnot.widget_choices
contains the selectable values of listboxes and comboboxes. All these attributes now contain None if no value is present.
Changes in Version 1.13.4¶
Document.convertToPDF()
now supports page ranges, reverted page sequences and page rotation. If the document already is a PDF, an exception is raised.Fixed a bug (introduced with v1.13.0) that prevented
Page.insertImage()
for transparent images.
Changes in Version 1.13.3¶
Introduces a way to convert any MuPDF supported document to a PDF. If you ever wanted PDF versions of your XPS, EPUB, CBZ or FB2 files – here is a way to do this.
Document.convertToPDF()
returns a Python bytes object in PDF format. Can be opened like normal in PyMuPDF, or be written to disk with the “.pdf” extension.
Changes in Version 1.13.2¶
The major enhancement is PDF form field support. Form fields are annotations of type (19, ‘Widget’). There is a new document method to check whether a PDF is a form. The Annot class has new properties describing field details.
Document.isFormPDF
is true if object type /AcroForm and at least one form field exists.Annot.widget_type
,Annot.widget_text
andAnnot.widget_name
contain the details of a form field (i.e. a “Widget” annotation).
Changes in Version 1.13.1¶
TextPage.extractDICT()
is a new method to extract the contents of a document page (text and images). All document types are supported as with the other TextPage extract*() methods. The returned object is a dictionary of nested lists and other dictionaries, and exactly equal to the JSON-deserialization of the oldTextPage.extractJSON()
. The difference is that the result is created directly – no JSON module is used. Because the user needs no JSON module to interpet the information, it should be easier to use, and also have a better performance, because it contains images in their original binary format – they need not be base64-decoded.Page.getText()
correspondingly supports the new parameter value “dict” to invoke the above method.TextPage.extractJSON()
(resp. Page.getText(“json”)) is still supported for convenience, but its use is expected to decline.
Changes in Version 1.13.0¶
This version is based on MuPDF v1.13.0. This release is “primarily a bug fix release”.
In PyMuPDF, we are also doing some bug fixes while introducing minor enhancements. There only very minimal changes to the user’s API.
Document construction is more flexible: the new filetype parameter allows setting the document type. If specified, any extension in the filename will be ignored. More completely addresses issue #156. As part of this, the documentation has been reworked.
- Changes to Pixmap constructors:
Colorspace conversion no longer allows dropping the alpha channel: source and target alpha will now always be the same. We have seen exceptions and even interpreter crashes when using alpha = 0.
As a replacement, the simple pixmap copy lets you choose the target alpha.
Document.save()
again offers the full garbage collection range 0 thru 4. Because of a bug inxref
maintenance, we had to temporarily enforce garbage > 1. Finally resolves issue #148.Document.save()
now offers to “prettify” PDF source via an additional argument.Page.insertImage()
has the additional stream -parameter, specifying a memory area holding an image.Issue with garbled PNGs on Linux systems has been resolved (“Problem writing PNG” #133).
Changes in Version 1.12.4¶
This is an extension of 1.12.3.
Fix of issue #147: methods
Document.getPageFontlist()
andDocument.getPageImagelist()
now also show fonts and images contained inresources
nested via “Form XObjects”.Temporary fix of issue #148: Saving to new PDF files will now automatically use garbage = 2 if a lower value is given. Final fix is to be expected with MuPDF’s next version. At that point we will remove this circumvention.
Preventive fix of illegally using stencil / image mask pixmaps in some methods.
Method
Document.getPageFontlist()
now includes the encoding name for each font in the list.Method
Document.getPageImagelist()
now includes the decode method name for each image in the list.
Changes in Version 1.12.3¶
This is an extension of 1.12.2.
Many functions now return None instead of 0, if the result has no other meaning than just indicating successful execution (
Document.close()
,Document.save()
,Document.select()
,Pixmap.writePNG()
and many others).
Changes in Version 1.12.2¶
This is an extension of 1.12.1.
Method
Page.showPDFpage()
now accepts the new clip argument. This specifies an area of the source page to which the display should be restricted.New
Page.CropBox
andPage.MediaBox
have been included for convenience.
Changes in Version 1.12.1¶
This is an extension of version 1.12.0.
New method
Page.showPDFpage()
displays another’s PDF page. This is a vector image and therefore remains precise across zooming. Both involved documents must be PDF.New method
Page.getSVGimage()
creates an SVG image from the page. In contrast to the raster image of a pixmap, this is a vector image format. The return is a unicode text string, which can be saved in a .svg file.Method
Page.getTextBlocks()
now accepts an additional bool parameter “images”. If set to true (default is false), image blocks (metadata only) are included in the produced list and thus allow detecting areas with rendered images.Minor bug fixes.
“text” result of
Page.getText()
concatenates all lines within a block using a single space character. MuPDF’s original uses “\n” instead, producing a rather ragged output.New properties of Page objects
Page.MediaBoxSize
andPage.CropBoxPosition
provide more information about a page’s dimensions. For non-PDF files (and for most PDF files, too) these will be equal toPage.rect.bottom_right
, resp.Page.rect.top_left
. For example, class Shape makes use of them to correctly position its items.
Changes in Version 1.12.0¶
This version is based on and requires MuPDF v1.12.0. The new MuPDF version contains quite a number of changes – most of them around text extraction. Some of the changes impact the programmer’s API.
Outline.saveText()
andOutline.saveXML()
have been deleted without replacement. You probably haven’t used them much anyway. But if you are looking for a replacement: the output ofDocument.getToC()
can easily be used to produce something equivalent.Class TextSheet does no longer exist.
Text “spans” (one of the hierarchy levels of TextPage) no longer contain positioning information (i.e. no “bbox” key). Instead, spans now provide the font information for its text. This impacts our JSON output variant.
HTML output has improved very much: it now creates valid documents which can be displayed by browsers to produce a similar view as the original document.
There is a new output format XHTML, which provides text and images in a browser-readable format. The difference to HTML output is, that no effort is made to reproduce the original layout.
All output formats of
Page.getText()
now support creating complete, valid documents, by wrapping them with appropriate header and trailer information. If you are interested in using the HTML output, please make sure to read Controlling Quality of HTML Output.To support finding text positions, we have added special methods that don’t need detours like
TextPage.extractJSON()
orTextPage.extractXML()
: usePage.getTextBlocks()
or resp.Page.getTextWords()
to create lists of text blocks or resp. words, which are accompanied by their rectangles. This should be much faster than the standard text extraction methods and also avoids using additional packages for interpreting their output.
Changes in Version 1.11.2¶
This is an extension of v1.11.1.
New
Page.insertFont()
creates a PDF /Font object and returns its object number.New
Document.extractFont()
extracts the content of an embedded font given its object number.Methods FontList(…) items no longer contain the PDF generation number. This value never had any significance. Instead, the font file extension is included (e.g. “pfa” for a “PostScript Font for ASCII”), which is more valuable information.
Fonts other than “simple fonts” (Type1) are now also supported.
New options to change Pixmap size:
Method
Pixmap.shrink()
reduces the pixmap proportionally in place.A new Pixmap copy constructor allows scaling via setting target width and height.
Changes in Version 1.11.1¶
This is an extension of v1.11.0.
New class Shape. It facilitates and extends the creation of image shapes on PDF pages. It contains multiple methods for creating elementary shapes like lines, rectangles or circles, which can be combined into more complex ones and be given common properties like line width or colors. Combined shapes are handled as a unit and e.g. be “morphed” together. The class can accumulate multiple complex shapes and put them all in the page’s foreground or background – thus also reducing the number of updates to the page’s
contents
object.All Page draw methods now use the new Shape class.
Text insertion methods insertText() and insertTextBox() now support morphing in addition to text rotation. They have become part of the Shape class and thus allow text to be freely combined with graphics.
A new Pixmap constructor allows creating pixmap copies with an added alpha channel. A new method also allows directly manipulating alpha values.
Binary algebraic operations with geometry objects (matrices, rectangles and points) now generally also support lists or tuples as the second operand. You can add a tuple (x, y) of numbers to a Point. In this context, such sequences are called “
point_like
” (resp.matrix_like
,rect_like
).Geometry objects now fully support in-place operators. For example, p /= m replaces point p with p * 1/m for a number, or p * ~m for a
matrix_like
object m. Similarly, if r is a rectangle, then r |= (3, 4) is the new rectangle that also includes fitz.Point(3, 4), and r &= (1, 2, 3, 4) is its intersection with fitz.Rect(1, 2, 3, 4).
Changes in Version 1.11.0¶
This version is based on and requires MuPDF v1.11.
Though MuPDF has declared it as being mostly a bug fix version, one major new feature is indeed contained: support of embedded files – also called portfolios or collections. We have extended PyMuPDF functionality to embrace this up to an extent just a little beyond the mutool utility as follows.
The Document class now support embedded files with several new methods and one new property:
embeddedFileInfo() returns metadata information about an entry in the list of embedded files. This is more than mutool currently provides: it shows all the information that was used to embed the file (not just the entry’s name).
embeddedFileGet() retrieves the (decompressed) content of an entry into a bytes buffer.
embeddedFileAdd(…) inserts new content into the PDF portfolio. We (in contrast to mutool) restrict this to entries with a new name (no duplicate names allowed).
embeddedFileDel(…) deletes an entry from the portfolio (function not offered in MuPDF).
embeddedFileSetInfo() – changes filename or description of an embedded file.
embeddedFileCount – contains the number of embedded files.
Several enhancements deal with streamlining geometry objects. These are not connected to the new MuPDF version and most of them are also reflected in PyMuPDF v1.10.0. Among them are new properties to identify the corners of rectangles by name (e.g. Rect.bottom_right) and new methods to deal with set-theoretic questions like Rect.contains(x) or IRect.intersects(x). Special effort focussed on supporting more “Pythonic” language constructs: if x in rect … is equivalent to rect.contains(x).
The Rect chapter now has more background on empty amd infinite rectangles and how we handle them. The handling itself was also updated for more consistency in this area.
We have started basic support for generation of PDF content:
Document.insertPage() adds a new page into a PDF, optionally containing some text.
Page.insertImage() places a new image on a PDF page.
Page.insertText() puts new text on an existing page
For FileAttachment annotations, content and name of the attached file can extracted and changed.
Changes in Version 1.10.0¶
MuPDF v1.10 Impact¶
MuPDF version 1.10 has a significant impact on our bindings. Some of the changes also affect the API – in other words, you as a PyMuPDF user.
Link destination information has been reduced. Several properties of the linkDest class no longer contain valuable information. In fact, this class as a whole has been deleted from MuPDF’s library and we in PyMuPDF only maintain it to provide compatibilty to existing code.
In an effort to minimize memory requirements, several improvements have been built into MuPDF v1.10:
A new config.h file can be used to de-select unwanted features in the C base code. Using this feature we have been able to reduce the size of our binary _fitz.o / _fitz.pyd by about 50% (from 9 MB to 4.5 MB). When UPX-ing this, the size goes even further down to a very handy 2.3 MB.
The alpha (transparency) channel for pixmaps is now optional. Letting alpha default to False significantly reduces pixmap sizes (by 20% – CMYK, 25% – RGB, 50% – GRAY). Many Pixmap constructors therefore now accept an alpha boolean to control inclusion of this channel. Other pixmap constructors (e.g. those for file and image input) create pixmaps with no alpha alltogether. On the downside, save methods for pixmaps no longer accept a savealpha option: this channel will always be saved when present. To minimize code breaks, we have left this parameter in the call patterns – it will just be ignored.
DisplayList and TextPage class constructors now require the mediabox of the page they are referring to (i.e. the page.bound() rectangle). There is no way to construct this information from other sources, therefore a source code change cannot be avoided in these cases. We assume however, that not many users are actually employing these rather low level classes explixitely. So the impact of that change should be minor.
Other Changes compared to Version 1.9.3¶
The new Document method write() writes an opened PDF to memory (as opposed to a file, like save() does).
An annotation can now be scaled and moved around on its page. This is done by modifying its rectangle.
Annotations can now be deleted. Page contains the new method deleteAnnot().
Various annotation attributes can now be modified, e.g. content, dates, title (= author), border, colors.
Method Document.insertPDF() now also copies annotations of source pages.
The Pages class has been deleted. As documents can now be accessed with page numbers as indices (like doc[n] = doc.loadPage(n)), and document object can be used as iterators, the benefit of this class was too low to maintain it. See the following comments.
loadPage(n) / doc[n] now accept arbitrary integers to specify a page number, as long as n < pageCount. So, e.g. doc[-500] is always valid and will load page (-500) % pageCount.
A document can now also be used as an iterator like this: for page in doc: …<do something with “page”> …. This will yield all pages of doc as page.
The Pixmap method getSize() has been replaced with property size. As before Pixmap.size == len(Pixmap) is true.
In response to transparency (alpha) being optional, several new parameters and properties have been added to Pixmap and Colorspace classes to support determining their characteristics.
The Page class now contains new properties firstAnnot and firstLink to provide starting points to the respective class chains, where firstLink is just a mnemonic synonym to method loadLinks() which continues to exist. Similarly, the new property rect is a synonym for method bound(), which also continues to exist.
Pixmap methods samplesRGB() and samplesAlpha() have been deleted because pixmaps can now be created without transparency.
Rect now has a property irect which is a synonym of method round(). Likewise, IRect now has property rect to deliver a Rect which has the same coordinates as floats values.
Document has the new method searchPageFor() to search for a text string. It works exactly like the corresponding Page.searchFor() with page number as additional parameter.
Changes in Version 1.9.3¶
This version is also based on MuPDF v1.9a. Changes compared to version 1.9.2:
As a major enhancement, annotations are now supported in a similar way as links. Annotations can be displayed (as pixmaps) and their properties can be accessed.
In addition to the document select() method, some simpler methods can now be used to manipulate a PDF:
copyPage() copies a page within a document.
movePage() is similar, but deletes the original.
deletePage() deletes a page
deletePageRange() deletes a page range
rotation or setRotation() access or change a PDF page’s rotation, respectively.
Available but undocumented before, IRect, Rect, Point and Matrix support the len() method and their coordinate properties can be accessed via indices, e.g. IRect.x1 == IRect[2].
For convenience, documents now support simple indexing: doc.loadPage(n) == doc[n]. The index may however be in range -pageCount < n < pageCount, such that doc[-1] is the last page of the document.
Changes in Version 1.9.2¶
This version is also based on MuPDF v1.9a. Changes compared to version 1.9.1:
fitz.open() (no parameters) creates a new empty PDF document, i.e. if saved afterwards, it must be given a .pdf extension.
Document now accepts all of the following formats (Document and open are synonyms):
open(),
open(filename) (equivalent to open(filename, None)),
open(filetype, area) (equivalent to open(filetype, stream = area)).
Type of memory area stream may be bytes or bytearray. Thus, e.g. area = open(“file.pdf”, “rb”).read() may be used directly (without first converting it to bytearray).
New method Document.insertPDF() (PDFs only) inserts a range of pages from another PDF.
Document objects doc now support the len() function: len(doc) == doc.pageCount.
New method Document.getPageImageList() creates a list of images used on a page.
New method Document.getPageFontList() creates a list of fonts referenced by a page.
New pixmap constructor fitz.Pixmap(doc, xref) creates a pixmap based on an opened PDF document and an
xref
number of the image.New pixmap constructor fitz.Pixmap(cspace, spix) creates a pixmap as a copy of another one spix with the colorspace converted to cspace. This works for all colorspace combinations.
Pixmap constructor fitz.Pixmap(colorspace, width, height, samples) now allows samples to also be bytes, not only bytearray.
Changes in Version 1.9.1¶
This version of PyMuPDF is based on MuPDF library source code version 1.9a published on April 21, 2016.
Please have a look at MuPDF’s website to see which changes and enhancements are contained herein.
Changes in version 1.9.1 compared to version 1.8.0 are the following:
New methods getRectArea() for both fitz.Rect and fitz.IRect
Pixmaps can now be created directly from files using the new constructor fitz.Pixmap(filename).
The Pixmap constructor fitz.Pixmap(image) has been extended accordingly.
fitz.Rect can now be created with all possible combinations of points and coordinates.
PyMuPDF classes and methods now all contain __doc__ strings, most of them created by SWIG automatically. While the PyMuPDF documentation certainly is more detailed, this feature should help a lot when programming in Python-aware IDEs.
A new document method of getPermits() returns the permissions associated with the current access to the document (print, edit, annotate, copy), as a Python dictionary.
The identity matrix fitz.Identity is now immutable.
The new document method select(list) removes all pages from a document that are not contained in the list. Pages can also be duplicated and re-arranged.
Various improvements and new members in our demo and examples collections. Perhaps most prominently: PDF_display now supports scrolling with the mouse wheel, and there is a new example program wxTableExtract which allows to graphically identify and extract table data in documents.
fitz.open() is now an alias of fitz.Document().
New pixmap method getPNGData() which will return a bytearray formatted as a PNG image of the pixmap.
New pixmap method samplesRGB() providing a samples version with alpha bytes stripped off (RGB colorspaces only).
New pixmap method samplesAlpha() providing the alpha bytes only of the samples area.
New iterator fitz.Pages(doc) over a document’s set of pages.
New matrix methods invert() (calculate inverted matrix), concat() (calculate matrix product), preTranslate() (perform a shift operation).
New IRect methods intersect() (intersection with another rectangle), translate() (perform a shift operation).
New Rect methods intersect() (intersection with another rectangle), transform() (transformation with a matrix), includePoint() (enlarge rectangle to also contain a point), includeRect() (enlarge rectangle to also contain another one).
Documented Point.transform() (transform a point with a matrix).
Matrix, IRect, Rect and Point classes now support compact, algebraic formulations for manipulating such objects.
Incremental saves for changes are possible now using the call pattern doc.save(doc.name, incremental=True).
A PDF’s metadata can now be deleted, set or changed by document method setMetadata(). Supports incremental saves.
A PDF’s bookmarks (or table of contents) can now be deleted, set or changed with the entries of a list using document method setToC(list). Supports incremental saves.