Functions¶
The following are miscellaneous functions and attributes on a fairly low-level technical detail.
Some functions provide detail access to PDF structures. Others are stripped-down, high performance versions of other functions which provide more information.
Yet others are handy, general-purpose utilities.
Function |
Short Description |
---|---|
PDF only: clean the annot’s |
|
|
PDF only: set the matrix of the appearance object |
|
PDF only: set the matrix of the appearance object |
|
PDF only: the matrix of the appearance object |
|
PDF only: bbox of the appearance object |
return header string for getText methods |
|
return trailer string for getText methods |
|
PDF only: remove XML metadata |
|
PDF only: delete an object |
|
PDF only: create and return a new |
|
PDF only: return / create |
|
PDF only: return the |
|
PDF only: return |
|
PDF only: same as _getPageObjNumber() |
|
PDF only: return the PDF file trailer string |
|
PDF only: return XML metadata |
|
PDF only: return length of |
|
PDF only: return object definition “source” |
|
PDF only: create a fast-access array of page numbers |
|
PDF only: extract embedded font |
|
PDF only: extract embedded image |
|
PDF only: return a list of glyph widths of a font |
|
PDF only: check whether an |
|
PDF only: information on inserted fonts |
|
return a dictionary of basic image properties |
|
return the current timestamp in PDF format |
|
return PDF-compatible string |
|
return string length for a given font & fontsize |
|
PDF only: clean the page’s |
|
PDF only: return a list of content numbers |
|
create the page’s display list |
|
extract text blocks as a Python list |
|
extract text words as a Python list |
|
run a page through a device |
|
PDF only: get complete, concatenated /Contents source |
|
wrap contents with stacking commands |
|
check whether contents wrapping is present |
|
matrix to map a line to the x-axis |
|
return width, height for a known paper format |
|
return rectangle for a known paper format |
|
return PDF RGB color tuple from a sRGB integer |
|
return (R, G, B) color tuple from a sRGB integer |
|
return list of table cells for a given rectangle |
|
dictionary of pre-defined paper formats |
PaperSize
(s)¶Convenience function to return width and height of a known paper format code. These values are given in pixels for the standard resolution 72 pixels = 1 inch.
Currently defined formats include ‘A0’ through ‘A10’, ‘B0’ through ‘B10’, ‘C0’ through ‘C10’, ‘Card-4x6’, ‘Card-5x7’, ‘Commercial’, ‘Executive’, ‘Invoice’, ‘Ledger’, ‘Legal’, ‘Legal-13’, ‘Letter’, ‘Monarch’ and ‘Tabloid-Extra’, each in either portrait or landscape format.
A format name must be supplied as a string (case in sensitive), optionally suffixed with “-L” (landscape) or “-P” (portrait). No suffix defaults to portrait.
- Parameters
s (str) – any format name from above (upper or lower case), like “A4” or “letter-l”.
- Return type
tuple
- Returns
(width, height) of the paper format. For an unknown format (-1, -1) is returned. Esamples: fitz.PaperSize(“A4”) returns (595, 842) and fitz.PaperSize(“letter-l”) delivers (792, 612).
PaperRect
(s)¶Convenience function to return a Rect for a known paper format.
- Parameters
s (str) – any format name supported by
PaperSize()
.- Return type
- Returns
fitz.Rect(0, 0, width, height) with width, height=fitz.PaperSize(s).
>>> import fitz >>> fitz.PaperRect("letter-l") fitz.Rect(0.0, 0.0, 792.0, 612.0) >>>
sRGB_to_pdf
(srgb)¶New in v1.17.4
Convenience function returning a PDF color triple (red, green, blue) for a given sRGB color integer as it occurs in
Page.getText()
dictionaries “dict” and “rawdict”.
- Parameters
srgb (int) – an integer of format RRGGBB, where each color component is an integer in range(255).
- Returns
a tuple (red, green, blue) with float items in intervall 0 <= item <= 1 representing the same color.
sRGB_to_rgb
(srgb)¶New in v1.17.4
Convenience function returning a color (red, green, blue) for a given sRGB color integer .
- Parameters
srgb (int) – an integer of format RRGGBB, where each color component is an integer in range(255).
- Returns
a tuple (red, green, blue) with integer items in intervall 0 <= item <= 255 representing the same color.
make_table
(rect=0, 0, 1, 1, cols=1, rows=1)¶New in v1.17.4
Convenience function returning a list of <rows x cols> Rect objects representing equal sized table cells for the given rectangle.
- Parameters
rect (rect_like) – the rectangle to contain the table.
cols (int) – the desired number of columns.
rows (int) – the desired number of rows.
- Returns
a list of Rect objects of equal size, whose union equals rect:
[
[cell00, cell01, …] # row 0 … […] # last row
]
planishLine
(p1, p2)¶(New in version 1.16.2)
Return a matrix which maps the line from p1 to p2 to the x-axis such that p1 will become (0,0) and p2 a point with the same distance to (0,0).
- Parameters
p1 (point_like) – starting point of the line.
p2 (point_like) – end point of the line.
- Return type
- Returns
a matrix which combines a rotation and a translation:
p1 = fitz.Point(1, 1) p2 = fitz.Point(4, 5) abs(p2 - p1) # distance of points 5.0 m = fitz.planishLine(p1, p2) p1 * m Point(0.0, 0.0) p2 * m Point(5.0, -5.960464477539063e-08) # distance of the resulting points abs(p2 * m - p1 * m) 5.0![]()
paperSizes
¶A dictionary of pre-defines paper formats. Used as basis for
PaperSize()
.
fitz_fontdescriptors
¶(New in v1.17.5)
A dictionary of usable fonts from repository pymupdf-fonts. Items are keyed by their reserved fontname and provide information like this:
In [2]: fitz.fitz_fontdescriptors.keys() Out[2]: dict_keys(['figbo', 'figo', 'figbi', 'figit', 'fimbo', 'fimo', 'spacembo', 'spacembi', 'spacemit', 'spacemo', 'math', 'music', 'symbol1', 'symbol2']) In [3]: fitz.fitz_fontdescriptors["fimo"] Out[3]: {'name': 'Fira Mono Regular', 'size': 125712, 'mono': True, 'bold': False, 'italic': False, 'serif': True, 'glyphs': 1485}
getPDFnow
()¶Convenience function to return the current local timestamp in PDF compatible format, e.g. D:20170501121525-04’00’ for local datetime May 1, 2017, 12:15:25 in a timezone 4 hours westward of the UTC meridian.
- Return type
str
- Returns
current local PDF timestamp.
getTextlength
(text, fontname='helv', fontsize=11, encoding=TEXT_ENCODING_LATIN)¶(New in version 1.14.7)
Calculate the length of text on output with a given builtin font, fontsize and encoding.
- Parameters
text (str) – the text string.
fontname (str) – the fontname. Must be one of either the PDF Base 14 Fonts or the CJK fonts, identified by their “reserved” fontnames (see table in :meth.`Page.insertFont`).
fontsize (float) – size of the font.
encoding (int) – the encoding to use. Besides 0 = Latin, 1 = Greek and 2 = Cyrillic (Russian) are available. Relevant for Base-14 fonts “Helvetica”, “Courier” and “Times” and their variants only. Make sure to use the same value as in the corresponding text insertion.
- Return type
float
- Returns
the length in points the string will have (e.g. when used in
Page.insertText()
).Note
This function will only do the calculation – it won’t insert font or text.
Warning
If you use this function to determine the required rectangle width for the (Page or Shape) insertTextbox methods, be aware that they calculate on a by-character level. Because of rounding effects, this will mostly lead to a slightly larger number: sum([fitz.getTextlength(c) for c in text]) > fitz.getTextlength(text). So either (1) do the same, or (2) use something like fitz.getTextlength(text + “’”) for your calculation.
getPDFstr
(text)¶Make a PDF-compatible string: if the text contains code points ord(c) > 255, then it will be converted to UTF-16BE with BOM as a hexadecimal character string enclosed in “<>” brackets like <feff…>. Otherwise, it will return the string enclosed in (round) brackets, replacing any characters outside the ASCII range with some special code. Also, every “(“, “)” or backslash is escaped with an additional backslash.
- Parameters
text (str) – the object to convert
- Return type
str
- Returns
PDF-compatible string enclosed in either () or <>.
ImageProperties
(stream)¶(New in version 1.14.14)
Return a number of basic properties for an image.
- Parameters
stream (bytes|bytearray|BytesIO|file) – an image either in memory or an opened file. A memory resident image maybe any of the formats bytes, bytearray or io.BytesIO.
- Returns
a dictionary with the following keys (an empty dictionary for any error):
Key
Value
width
(int) width in pixels
height
(int) height in pixels
colorspace
(int) colorspace.n (e.g. 3 = RGB)
bpc
(int) bits per component (usually 8)
format
(int) image format in range(15)
ext
(str) image file extension indicating the format
size
(int) length of the image in bytes
Example:
>>> fitz.ImageProperties(open("img-clip.jpg","rb")) {'bpc': 8, 'format': 9, 'colorspace': 3, 'height': 325, 'width': 244, 'ext': 'jpeg', 'size': 14161} >>>
ConversionHeader
("text", filename="UNKNOWN")¶Return the header string required to make a valid document out of page text outputs.
- Parameters
output (str) – type of document. Use the same as the output parameter of getText().
filename (str) – optional arbitrary name to use in output types “json” and “xml”.
- Return type
str
ConversionTrailer
(output)¶Return the trailer string required to make a valid document out of page text outputs. See
Page.getText()
for an example.
- Parameters
output (str) – type of document. Use the same as the output parameter of getText().
- Return type
str
Document.
_delXmlMetadata
()¶Delete an object containing XML-based metadata from the PDF. (Py-) MuPDF does not support XML-based metadata. Use this if you want to make sure that the conventional metadata dictionary will be used exclusively. Many thirdparty PDF programs insert their own metadata in XML format and thus may override what you store in the conventional dictionary. This method deletes any such reference, and the corresponding PDF object will be deleted during next garbage collection of the file.
Document.
_getTrailerString
(compressed=False)¶(New in version 1.14.9)
Return the trailer of the PDF (UTF-8), which is usually located at the PDF file’s end. If not a PDF or the PDF has no trailer (because of irrecoverable errors), None is returned.
- Parameters
compressed (bool) – (ew in version 1.14.14) whether to generate a compressed output or one with nice indentations to ease reading (default).
- Returns
a string with the PDF trailer information. This is the analogous method to
Document._getXrefString()
except that the trailer has no identifyingxref
number. As can be seen here, the trailer object points to other important objects:>>> doc=fitz.open("adobe.pdf") >>> # compressed output >>> print(doc._getTrailerString(True)) <</Size 334093/Prev 25807185/XRefStm 186352/Root 333277 0 R/Info 109959 0 R /ID[(\\227\\366/gx\\016ds\\244\\207\\326\\261\\\\\\305\\376u) (H\\323\\177\\346\\371pkF\\243\\262\\375\\346\\325\\002)]>> >>> # non-compressed otput: >>> print(doc._getTrailerString(False)) << /Size 334093 /Prev 25807185 /XRefStm 186352 /Root 333277 0 R /Info 109959 0 R /ID [ (\227\366/gx\016ds\244\207\326\261\\\305\376u) (H\323\177\346\371pkF\243\262\375\346\325\002) ] >>Note
MuPDF is capable of recovering from a number of damages a PDF may have. This includes re-generating a trailer, where the end of a file has been lost (e.g. because of incomplete downloads). If however None is returned for a PDF, then the recovery mechanisms were unsuccessful and you should check for any error messages (
Document.openErrCode
,Document.openErrMsg
,Tools.fitz_stderr
).
Document.
_make_page_map
()¶Create an internal array of page numbers, which significantly speeds up page lookup (
Document.loadPage()
). If this array exists, finding a page object will be up to two times faster. Functions which change the PDF’s page layout (copy, delete, move, select pages) will destroy this array again.
Document.
_getXmlMetadataXref
()¶Return the XML-based metadata
xref
of the PDF if present – also refer toDocument._delXmlMetadata()
. You can use it to retrieve the content viaDocument.xrefStream()
and then work with it using some XML software.
- Return type
int
- Returns
xref
of PDF file level XML metadata.
Document.
_getPDFroot
()¶Return the
xref
of the PDF catalog.
- Return type
int
- Returns
xref
of the PDF catalog – a centraldictionary
pointing to many other PDF information.
Page.
wrapContents
()¶Put string pair “q” / “Q” before, resp. after a page’s /Contents object(s) to ensure that any “geometry” changes are local only.
Use this method as an alternative, minimalistic version of
Page.cleanContents()
. Its advantage is a small footprint in terms of processing time and impact on incremental saves.
Page.
_isWrapped
¶Indicate whether
Page.wrapContents()
may be required for object insertions in standard PDF geometry. Please note that this is a quick, basic check only: a value of False may still be a false alarm.
Page.
getTextBlocks
(flags=None)¶Deprecated wrapper for
TextPage.extractBLOCKS()
.
Page.
getTextWords
(flags=None)¶Deprecated wrapper for
TextPage.extractWORDS()
.
Page.
getDisplayList
()¶Run a page through a list device and return its display list.
- Return type
- Returns
the display list of the page.
Page.
_getContents
()¶Return a list of
xref
numbers ofcontents
objects belonging to the page.
- Return type
list
- Returns
a list of
xref
integers.Each page may have zero to many associated contents objects (
stream
s) which contain some operator syntax describing what appears where and how on the page (like text or images, etc. See the Adobe PDF References, chapter “Operator Summary”, page 985). This function only enumerates the number(s) of such objects. To get the actual stream source, use functionDocument.xrefStream()
with one of the numbers in this list. UseDocument.updateStream()
to replace the content.
Page.
_setContents
(xref)¶PDF only: Set a given object (identified by its
xref
) as the page’s one and onlycontents
object. Useful for joining mutiplecontents
objects as in the following snippet:>>> c = b"" >>> xreflist = page._getContents() >>> for xref in xreflist: c += doc.xrefStream(xref) >>> doc.updateStream(xreflist[0], c) >>> page._setContents(xreflist[0]) >>> # doc.save(..., garbage=1) will remove the unused objects
Page.
cleanContents
(sanitize=True)¶(Changed in v1.17.6)
PDF only: Clean and concatenate all
contents
objects associated with this page. “Cleaning” includes syntactical corrections, standardizations and “pretty printing” of the contents stream. Discrepancies betweencontents
andresources
objects will also be corrected if sanitize is true. SeePage.getContents()
for more details.Changed in version 1.16.0 Annotations are no longer implicitely cleaned by this method. Use
Annot._cleanContents()
separately.
- Parameters
sanitize (bool) – (new in v1.17.6) if true, synchronization between resources and their actual use in the contents object is snychronized. For example, if a font is not actually used for any text of the page, then it will be deleted from the
/Resources/Font
object.Warning
This is a complex function which may generate large amounts of new data and render old data unused. It is not recommended using it together with the incremental save option. Also note that the resulting singleton new /Contents object is uncompressed. So you should save to a new file using options “deflate=True, garbage=3”.
Page.
readContents
()¶New in version 1.17.0. Return the concatenation of all
contents
objects associated with the page – without cleaning or otherwise modifying them. Use this method whenever you need to parse this source in its entirety whithout having to bother how many separate contents objects exist.
Annot.
_cleanContents
()¶Clean the
contents
streams associated with the annotation. This is the same type of action whichPage.cleanContents()
performs – just restricted to this annotation.
Document.
getCharWidths
(xref=0, limit=256)¶Return a list of character glyphs and their widths for a font that is present in the document. A font must be specified by its PDF cross reference number
xref
. This function is called automatically fromPage.insertText()
andPage.insertTextbox()
. So you should rarely need to do this yourself.
- Parameters
xref (int) – cross reference number of a font embedded in the PDF. To find a font
xref
, use e.g. doc.getPageFontList(pno) of page number pno and take the first entry of one of the returned list entries.limit (int) – limits the number of returned entries. The default of 256 is enforced for all fonts that only support 1-byte characters, so-called “simple fonts” (checked by this method). All PDF Base 14 Fonts are simple fonts.
- Return type
list
- Returns
a list of limit tuples. Each character c has an entry (g, w) in this list with an index of ord(c). Entry g (integer) of the tuple is the glyph id of the character, and float w is its normalized width. The actual width for some fontsize can be calculated as w * fontsize. For simple fonts, the g entry can always be safely ignored. In all other cases g is the basis for graphically representing c.
This function calculates the pixel width of a string called text:
def pixlen(text, widthlist, fontsize): try: return sum([widthlist[ord(c)] for c in text]) * fontsize except IndexError: m = max([ord(c) for c in text]) raise ValueError:("max. code point found: %i, increase limit" % m)
Document.
_getXrefString
(xref, compressed=False)¶Return the string (“source code”) representing an arbitrary object. For
stream
objects, only the non-stream part is returned. To get the stream data, useDocument.xrefStream()
.
- Parameters
xref (int) –
xref
number.compressed (bool) – (new in version 1.14.14) whether to generate a compressed output or one with nice indentations to ease reading or parsing (default).
- Return type
string
- Returns
the string defining the object identified by
xref
. Example:>>> doc = fitz.open("Adobe PDF Reference 1-7.pdf") # the PDF >>> page = doc[100] # some page in it >>> print(doc._getXrefString(page.xref, compressed=True)) <</CropBox[0 0 531 666]/Annots[4795 0 R 4794 0 R 4793 0 R 4792 0 R 4797 0 R 4796 0 R] /Parent 109820 0 R/StructParents 941/Contents 229 0 R/Rotate 0/MediaBox[0 0 531 666] /Resources<</Font<</T1_0 3914 0 R/T1_1 3912 0 R/T1_2 3957 0 R/T1_3 3913 0 R/T1_4 4576 0 R /T1_5 3931 0 R/T1_6 3944 0 R>>/ProcSet[/PDF/Text]/ExtGState<</GS0 333283 0 R>>>> /Type/Page>> >>> print(doc._getXrefString(page.xref, compressed=False)) << /CropBox [ 0 0 531 666 ] /Annots [ 4795 0 R 4794 0 R 4793 0 R 4792 0 R 4797 0 R 4796 0 R ] /Parent 109820 0 R /StructParents 941 /Contents 229 0 R /Rotate 0 /MediaBox [ 0 0 531 666 ] /Resources << /Font << /T1_0 3914 0 R /T1_1 3912 0 R /T1_2 3957 0 R /T1_3 3913 0 R /T1_4 4576 0 R /T1_5 3931 0 R /T1_6 3944 0 R >> /ProcSet [ /PDF /Text ] /ExtGState << /GS0 333283 0 R >> >> /Type /Page >>
Document.
isStream
(xref)¶(New in version 1.14.14)
PDF only: Check whether the object represented by
xref
is astream
type. Return is False if not a PDF or if the number is outside the valid xref range.
- Parameters
xref (int) –
xref
number.- Returns
True if the object definition is followed by data wrapped in keyword pair stream, endstream.
Document.
_getOLRootNumber
()¶Return
xref
number of the /Outlines root object (this is not the first outline entry!). If this object does not exist, a new one will be created.
- Return type
int
- Returns
xref
number of the /Outlines root object.
Document.
extractImage
(xref)¶PDF Only: Extract data and meta information of an image stored in the document. The output can directly be used to be stored as an image file, as input for PIL, Pixmap creation, etc. This method avoids using pixmaps wherever possible to present the image in its original format (e.g. as JPEG).
- Parameters
xref (int) –
xref
of an image object. If this is not in range(1, doc.xrefLength()), or the object is no image or other errors occur, None is returned and no exception is raised.- Return type
dict
- Returns
a dictionary with the following keys
ext (str) image type (e.g. ‘jpeg’), usable as image file extension
smask (int)
xref
number of a stencil (/SMask) image or zerowidth (int) image width
height (int) image height
colorspace (int) the image’s colorspace.n number.
cs-name (str) the image’s colorspace.name.
xres (int) resolution in x direction. Please also see
resolution
.yres (int) resolution in y direction. Please also see
resolution
.image (bytes) image data, usable as image file content
>>> d = doc.extractImage(1373) >>> d {'ext': 'png', 'smask': 2934, 'width': 5, 'height': 629, 'colorspace': 3, 'xres': 96, 'yres': 96, 'cs-name': 'DeviceRGB', 'image': b'\x89PNG\r\n\x1a\n\x00\x00\x00\rIHDR\x00\x00\x00\x05\ ...'} >>> imgout = open("image." + d["ext"], "wb") >>> imgout.write(d["image"]) 102 >>> imgout.close()Note
There is a functional overlap with pix = fitz.Pixmap(doc, xref), followed by a pix.getPNGData(). Main differences are that extractImage, (1) does not always deliver PNG image formats, (2) is very much faster with non-PNG images, (3) usually results in much less disk storage for extracted images, (4) returns None in error cases (generates no exception). Look at the following example images within the same PDF.
xref 1268 is a PNG – Comparable execution time and identical output:
In [23]: %timeit pix = fitz.Pixmap(doc, 1268);pix.getPNGData() 10.8 ms ± 52.4 µs per loop (mean ± std. dev. of 7 runs, 100 loops each) In [24]: len(pix.getPNGData()) Out[24]: 21462 In [25]: %timeit img = doc.extractImage(1268) 10.8 ms ± 86 µs per loop (mean ± std. dev. of 7 runs, 100 loops each) In [26]: len(img["image"]) Out[26]: 21462xref 1186 is a JPEG –
Document.extractImage()
is many times faster and produces a much smaller output (2.48 MB vs. 0.35 MB):In [27]: %timeit pix = fitz.Pixmap(doc, 1186);pix.getPNGData() 341 ms ± 2.86 ms per loop (mean ± std. dev. of 7 runs, 1 loop each) In [28]: len(pix.getPNGData()) Out[28]: 2599433 In [29]: %timeit img = doc.extractImage(1186) 15.7 µs ± 116 ns per loop (mean ± std. dev. of 7 runs, 100000 loops each) In [30]: len(img["image"]) Out[30]: 371177
Document.
extractFont
(xref, info_only=False)¶PDF Only: Return an embedded font file’s data and appropriate file extension. This can be used to store the font as an external file. The method does not throw exceptions (other than via checking for PDF and valid
xref
).
- Parameters
xref (int) – PDF object number of the font to extract.
info_only (bool) – only return font information, not the buffer. To be used for information-only purposes, avoids allocation of large buffer areas.
- Return type
tuple
- Returns
a tuple (basename, ext, subtype, buffer), where ext is a 3-byte suggested file extension (str), basename is the font’s name (str), subtype is the font’s type (e.g. “Type1”) and buffer is a bytes object containing the font file’s content (or b””). For possible extension values and their meaning see Font File Extensions. Return details on error:
(“”, “”, “”, b””) – invalid xref or xref is not a (valid) font object.
(basename, “n/a”, “Type1”, b””) – basename is one of the PDF Base 14 Fonts, which cannot be extracted.
Example:
>>> # store font as an external file >>> name, ext, buffer = doc.extractFont(4711) >>> # assuming buffer is not None: >>> ofile = open(name + "." + ext, "wb") >>> ofile.write(buffer) >>> ofile.close()Warning
The basename is returned unchanged from the PDF. So it may contain characters (such as blanks) which may disqualify it as a filename for your operating system. Take appropriate action.
Document.
FontInfos
¶Contains following information for any font inserted via
Page.insertFont()
in this session of PyMuPDF:
xref (int) – XREF number of the /Type/Font object.
info (dict) – detail font information with the following keys:
name (str) – name of the basefont
idx (int) – index number for multi-font files
type (str) – font type (like “TrueType”, “Type0”, etc.)
ext (str) – extension to be used, when font is extracted to a file (see Font File Extensions).
glyphs (list) – list of glyph numbers and widths (filled by textinsertion methods).
- Return type
list