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 bbox of the appearance object |
|
PDF only: the matrix of the appearance object |
|
PDF only: bbox of the appearance object |
return header string for get_text methods |
|
return trailer string for get_text methods |
|
PDF only: remove XML metadata |
|
PDF only: delete an object |
|
PDF only: create and return a new |
|
PDF only: return XML metadata |
|
PDF only: return length of |
|
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 |
|
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 |
|
list of rectangles that envelop text, drawing or image objects |
|
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 |
|
low-level text information |
|
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 an sRGB integer |
|
return (R, G, B) color tuple from an sRGB integer |
|
return the quad for a text span (“dict” / “rawdict”) |
|
return unicode from a glyph name |
|
return glyph name from a unicode |
|
split rectangle in sub-rectangles |
|
list of glyph names defined in Adobe Glyph List |
|
list of unicodes defined in Adobe Glyph List |
|
dictionary of pre-defined paper formats |
|
compute the quad of a span (“dict”, “rawdict”) |
|
compute the quad of a char (“rawdict”) |
|
compute the quad of a subset of span characters |
|
compute the quad of a subset of line spans |
|
dictionary of available supplement fonts |
paper_size
(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 in 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. Examples: fitz.paper_size(“A4”) returns (595, 842) and fitz.paper_size(“letter-l”) delivers (792, 612).
paper_rect
(s)¶Convenience function to return a Rect for a known paper format.
- Parameters
s (str) – any format name supported by
paper_size()
.- Return type
- Returns
fitz.Rect(0, 0, width, height) with width, height=fitz.paper_size(s).
>>> import fitz >>> fitz.paper_rect("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.get_text()
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. Example
sRGB_to_pdf(0xff0000) = (1, 0, 0)
(red).
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
range(256)
representing the same color. ExamplesRGB_to_pdf(0xff0000) = (255, 0, 0)
(red).
glyph_name_to_unicode
(name)¶New in v1.18.0
Return the unicode number of a glyph name based on the Adobe Glyph List.
- Parameters
name (str) – the name of some glyph. The function is based on the Adobe Glyph List.
- Return type
int
- Returns
the unicode. Invalid name entries return
0xfffd (65533)
.Note
A similar functionality is provided by package fontTools in its agl sub-package.
unicode_to_glyph_name
(ch)¶New in v1.18.0
Return the glyph name of a unicode number, based on the Adobe Glyph List.
- Parameters
ch (int) –
the unicode given by e.g.
ord("ß")
. The function is based on the Adobe Glyph List.- Return type
str
- Returns
the glyph name. E.g.
fitz.unicode_to_glyph_name(ord("Ä"))
returns'Adieresis'
.Note
A similar functionality is provided by package fontTools: in its agl sub-package.
recover_quad
(line_dir, span)¶New in v1.18.9
Convenience function returning the quadrilateral envelopping the text of a text span, as returned by
Page.get_text()
using the “dict” or “rawdict” options.
- Parameters
line_dict (tuple) – the value
line["dir"]
of the span’s line.span (dict) – the span sub-dictionary.
- Returns
the quadrilateral of the span’s text.
make_table
(rect, cols=1, rows=1)¶New in v1.17.4
Convenience function to split a rectangle into sub-rectangles. Returns a list of rows lists, each containing cols Rect items. Each sub-rectangle can then be addressed by its row and column index.
- Parameters
rect (rect_like) – the rectangle to split.
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. Here is the layout of a 3x4 table created by
cell = fitz.make_table(rect, cols=4, rows=3)
:![]()
planish_line
(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.planish_line(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![]()
paper_sizes
()¶A dictionary of pre-defines paper formats. Used as basis for
paper_size()
.
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}If
pymupdf-fonts
is not installed, the dictionary is empty.The dictionary keys can be used to define a Font via e.g.
font = fitz.Font("fimo")
– just like you can do it with the builtin fonts “Helvetica” and friends.
get_pdf_now
()¶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.
get_text_length
(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.insert_font`).
fontsize (float) – the fontsize.
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.insert_text()
).Note
This function will only do the calculation – it won’t insert font nor text.
Note
The Font class offers a similar method,
Font.text_length()
, which supports Base-14 fonts and any font with a character map (CMap, Type 0 fonts).Warning
If you use this function to determine the required rectangle width for the (Page or Shape) insert_textbox 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.get_text_length(c) for c in text]) > fitz.get_text_length(text). So either (1) do the same, or (2) use something like fitz.get_text_length(text + “’”) for your calculation.
get_pdf_str
(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 a backslash.
- Parameters
text (str) – the object to convert
- Return type
str
- Returns
PDF-compatible string enclosed in either () or <>.
image_properties
(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.image_properties(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 get_text().
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.get_text()
for an example.
- Parameters
output (str) – type of document. Use the same as the output parameter of get_text().
- Return type
str
Document.
del_xml_metadata
()¶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.
xml_metadata_xref
()¶Return the XML-based metadata
xref
of the PDF if present – also refer toDocument.del_xml_metadata()
. You can use it to retrieve the content viaDocument.xref_stream()
and then work with it using some XML software.
- Return type
int
- Returns
xref
of PDF file level XML metadata – or 0 if none exists.
Page.
get_bboxlog
()¶
New in v1.19.0
- Returns
a list of rectangles that envelop text, image or drawing objects. Each item is a tuple (type, (x0, y0, x1, y1)) where the second tuple consists of rectangle coordinates, and type is one of the following values:
"fill-text"
– normal text (painted without character borders)
"stroke-text"
– text showing character borders only
"ignore-text"
– text that should not be displayed (e.g. as used by OCR text layers)
"fill-path"
– drawing with fill color (and no border)
"stroke-path"
– drawing with border (and no fill color)
"fill-image"
– displays an image
"fill-shade"
– display a shadingThe item sequence represents the sequence in which these commands are executed to build the page’s appearance. Therefore, if an item’s bbox intersects or contains that of a previous item, then the previous item may be (partially) covered / hidden.
So this list is useful to detect such situations. An item’s index in this list equals the value of ``”seqno”` keys you will find in the dictionaries returned by
Page.get_drawings()
andPage.get_texttrace()
.
Page.
get_texttrace
()¶
New in v1.18.16
Changed in v1.19.0: added key “seqno”.
Changed in v1.19.1: stroke and fill colors now always are either RGB or GRAY
Return low-level text information of the page. The method is available for all document types. The result is a list of Python dictionaries with the following content:
{ 'ascender': 0.83251953125, # font ascender (1) 'bbox': (458.14019775390625, # span bbox x0 (7) 749.4671630859375, # span bbox y0 467.76458740234375, # span bbox x1 757.5071411132812), # span bbox y1 'bidi': 0, # bidirectional level (1) 'chars': ( # char information, tuple[tuple] (45, # unicode (4) 16, # glyph id (font dependent) (458.14019775390625, # origin.x (1) 755.3758544921875), # origin.y (1) (458.14019775390625, # char bbox x0 (6) 749.4671630859375, # char bbox y0 462.9649963378906, # char bbox x1 757.5071411132812)), # char bbox y1 ( ... ), # more characters ), 'color': (0.0,), # text color, tuple[float] (1) 'colorspace': 1, # number of colorspace components (1) 'descender': -0.30029296875, # font descender (1) 'dir': (1.0, 0.0), # writing direction (1) 'flags': 12, # font flags (1) 'font': 'CourierNewPSMT', # font name (1) 'linewidth': 0.4019999980926514, # current line width value (3) 'opacity': 1.0, # alpha value of the text (5) 'seqno': 246, # sequence number (8) 'size': 8.039999961853027, # font size (1) 'spacewidth': 4.824785133358091, # width of space char 'type': 0, # span type (2) 'wmode': 0 # writing mode (1) }Details:
Information above tagged with “(1)” has the same meaning and value as explained in TextPage.
Please note that the font
flags
value will never contain a superscript flag bit: the detection of superscripts is done within MuPDF TextPage code – it is not a property of any font.Also note, that the text color is encoded as the usual tuple of floats 0 <= f <= 1 – not in sRGB format. Depending on
span["type"]
, interpret this as fill color or stroke color.There are 3 text span types:
0: Filled text – equivalent to PDF text rendering mode 0 (
0 Tr
, the default in PDF), only each character’s “inside” is shown.1: Stroked text – equivalent to
1 Tr
, only the character borders are shown.3: Ignored text – equivalent to
3 Tr
(hidden text).Line width in this context is important only for processing
span["type"] != 0
: it determines the thickness of the character’s border line. This value may not be provided at all with the text data. In this case, a value of 5% of the fontsize (span["size"] * 0,05
) is generated. Often, an “artificial” bold text in PDF is created by2 Tr
. There is no equivalent span type for this case. Instead, respective text is represented by two consecutive spans – which are identical in every aspect, except for their types, which are 0, resp 1. It is your responsibility to handle this type of situation - inPage.get_text()
, MuPDF is doing this for you.For data compactness, the character’s unicode is provided here. Use built-in function
chr()
for the character itself.The alpha / opacity value of the span’s text,
0 <= opacity <= 1
, 0 is invisible text, 1 (100%) is intransparent. Depending inspan["type"]
, interpret this value as fill opacity or, resp. stroke opacity.(Changd in v1.19.0) This value is equal / close to the width of
char["bbox"]
. However, on occasion you may find a small delta. In particular, the bbox height value is always computed as if “small glyph heights” had been requested.(New in v1.19.0) This is the union of all character bboxes.
(New in v1.19.0) Enumerates the commands that build up the page’s appearance. Can be used to find out whether text is effectively hidden by objects, whch are painted “later”, or over some object. So if there is a drawing or image with a higher sequence number, whose bbox overlaps (parts of) this text span, one may assume that such an object hides the resp. text. Different text spans may have identical sequence numbers if they have been created consecutively.
Here is a list of similarities and differences of
page.get_texttrace()
compared topage.get_text("rawdict")
:
The method is up to twice as fast, compared to “rawdict” extraction. Depends on the amount of text.
The returned data is very much smaller in size – although it provides more information.
Additional types of text invisibility can be detected: opacity = 0 or type > 1 or overlapping bbox of an object with a higher sequence number.
If MuPDF returns unicode 0xFFFD (65533) for unrecognized characters, you may still be able to deduct desired information from the glyph id.
The
span["chars"]
contains no spaces, except the document creator has explicitely coded them. They will never be generated like it happens inPage.get_text()
methods. To provide some help for doing your own computations here, the width of a space character is given. This value is derived from the font where possible. Otherwise the value of a fallback font is taken.There is no effort to organize text like it happens for a TextPage (the hierarchy of blocks, lines, spans, and characters). Characters are simply extracted in sequence, one by one, and put in a span. Whenever any of the span’s characteristics changes, a new span is started. So you may find characters with different
origin.y
values in the same span (which means they would appear in different lines). You cannot assume, that span characters are sorted in any particular order – you must make sense of the info yourself, takingspan["dir"]
,span["wmode"]
, etc. into account.
- Ligatures are represented like this:
MuPDF handles the following ligatures: “fi”, “ff”, “fl”, “ft”, “st”, “ffi”, and “ffl” (only the first 3 are mostly ever used). If the page contains e.g. ligature “fi”, you will find the following two character items subsequent to each other:
(102, glyph, (x, y), (x0, y0, x1, y1)) # 102 = ord("f") (105, -1, (x, y), (x0, y0, x0, y1)) # 105 = ord("i"), empty bbox!This means that the bbox of the first ligature character is the area containing the complete, compound glyph. Subsequent ligature components are recognizable by their glyph value -1 and a bbox of width zero.
You may want to replace those 2 or 3 char tuples by one, that represents the ligature itself. Use the following mapping of ligatures to unicodes:
"ff" -> 0xFB00
"fi" -> 0xFB01
"fl" -> 0xFB02
"ffi" -> 0xFB03
"ffl" -> 0xFB04
"ft" -> 0xFB05
"st" -> 0xFB06
So you may want to replace the two example tuples above by the following single one:
(0xFB01, glyph, (x, y), (x0, y0, x1, y1))
(there is usually no need to lookup the correct glyph id for 0xFB01 in the resp. font, but you may executefont.has_glyph(0xFB01)
and use its return value).Similar to other text extraction methods, the character and span bboxes are correct only if text is written horizontally, left to right. This is indicated by
span["dir"] == (1, 0)
– which is the case in the vast majority of situations. Otherwise, you must transform character and span bboxes: Becausespan["dir"] = (cos, sin)
of the writing angle, you can compute the quad of the character bbox like this:bbox.morph(origin, mat)
, with the character’s origin (fitz.Point(c[2])
), and the rotation matrixmat = fitz.Matrix(cos, sin, -sin, cos, 0, 0)
derived fromspan["dir"]
. To compute the quad of the complete span (or any number of adjacent characters), sum up the characters’ widths and build the rectanglerect = fitz.Rect(x0, y0, x0 + width, y1)
where x0, y0 and y1 are the values of the first character’s bbox. Then the span quad isspan_quad = rect.morph(origin, mat)
with the origin of the first character.Note
If you plan to extract more / other information from this page after this method has been executed, you might need to first reload it:
page = doc.reload_page(page)
.
Page.
wrap_contents
()¶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.clean_contents()
. Its advantage is a small footprint in terms of processing time and impact on the data size of incremental saves. Multiple executions of this method have no functional impact:b"q q ... q contents Q Q ... Q"
is treated likeb"q contents Q"
.
Page.
is_wrapped
¶Indicate whether
Page.wrap_contents()
may be required for object insertions in standard PDF geometry. Note that this is a quick, basic check only: a value of False may still be a false alarm. But nevertheless executingPage.wrap_contents()
will have no negative side effects.
- Return type
bool
Page.
get_text_blocks
(flags=None)¶Deprecated wrapper for
TextPage.extractBLOCKS()
. UsePage.get_text()
with the “blocks” option instead.
- Return type
list[tuple]
Page.
get_text_words
(flags=None)¶Deprecated wrapper for
TextPage.extractWORDS()
. UsePage.get_text()
with the “words” option instead.
- Return type
list[tuple]
Page.
get_displaylist
()¶Run a page through a list device and return its display list.
- Return type
- Returns
the display list of the page.
Page.
get_contents
()¶PDF only: Retrieve a list of
xref
ofcontents
objects of a page. May be empty or contain multiple integers. If the page is cleaned (Page.clean_contents()
), it will be one entry at most. The “source” of each /Contents object can be individually read byDocument.xref_stream()
using an item of this list. MethodPage.read_contents()
in contrast walks through this list and concatenates the corresponding sources into onebytes
object.
- Return type
list[int]
Page.
set_contents
(xref)¶PDF only: Let the page’s
/Contents
key point to this xref. Any previously used contents objects will be ignored and can be removed via garbage collection.
Page.
clean_contents
(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.get_contents()
for more details.Changed in version 1.16.0 Annotations are no longer implicitely cleaned by this method. Use
Annot.clean_contents()
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.
read_contents
()¶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.
- Return type
bytes
Annot.
clean_contents
(sanitize=True)¶Clean the
contents
streams associated with the annotation. This is the same type of action whichPage.clean_contents()
performs – just restricted to this annotation.
Document.
get_char_widths
(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.insert_text()
andPage.insert_textbox()
. 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.get_page_fonts(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: raise ValueError:("max. code point found: %i, increase limit" % ord(max(text)))
Document.
is_stream
(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.
get_new_xref
()¶Increase the
xref
by one entry and return that number. This can then be used to insert a new object.
- Return type
int :returns: the number of the new
xref
entry. Please note, that only a new entry in the PDF’s cross reference table is created. At this point, there will not yet exist a PDF object associated with it. To create an (empty) object with this number usedoc.update_xref(xref, "<<>>")
.
Document.
extract_image
(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 inrange(1, doc.xref_length())
, 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.extract_image(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.tobytes(). Main differences are that extract_image, (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.tobytes() 10.8 ms ± 52.4 µs per loop (mean ± std. dev. of 7 runs, 100 loops each) In [24]: len(pix.tobytes()) Out[24]: 21462 In [25]: %timeit img = doc.extract_image(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.extract_image()
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.tobytes() 341 ms ± 2.86 ms per loop (mean ± std. dev. of 7 runs, 1 loop each) In [28]: len(pix.tobytes()) Out[28]: 2599433 In [29]: %timeit img = doc.extract_image(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.
extract_font
(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 not embedded and thus cannot be extracted. This is the case for e.g. the PDF Base 14 Fonts.
Example:
>>> # store font as an external file >>> name, ext, buffer = doc.extract_font(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.
recover_quad
(line_dir, span)¶Compute the quadrilateral of a text span extracted via options “dict” or “rawdict” of
Page.get_text()
.
- Parameters
line_dir (tuple) –
line["dir"]
of the owning line.span (dict) – the span.
- Returns
the Quad of the span, usable for text marker annotations (‘Highlight’, etc.).
recover_char_quad
(line_dir, span, char)¶Compute the quadrilateral of a text character extracted via option “rawdict” of
Page.get_text()
.
- Parameters
line_dir (tuple) –
line["dir"]
of the owning line.span (dict) – the span.
char (dict) – the character.
- Returns
the Quad of the character, usable for text marker annotations (‘Highlight’, etc.).
recover_span_quad
(line_dir, span, chars=None)¶Compute the quadrilateral of a subset of characters of a span extracted via option “rawdict” of
Page.get_text()
.
- Parameters
line_dir (tuple) –
line["dir"]
of the owning line.span (dict) – the span.
chars (list) – the characters to consider. If omitted, identical to
recoer_span()
. If given, the selected extraction option must be “rawdict”.- Returns
the Quad of the selected characters, usable for text marker annotations (‘Highlight’, etc.).
recover_line_quad
(line, spans=None)¶Compute the quadrilateral of a subset of spans of a text line extracted via options “dict” or “rawdict” of
Page.get_text()
.
- Parameters
line (dict) – the line.
spans (list) – a sub-list of
line["spans"]
. If omitted, the full line quad will be returned.- Returns
the Quad of the selected line spans, usable for text marker annotations (‘Highlight’, etc.).