pdfminer.six API reference

72 public APIs from pdfminer.six (pdfminer/pdfminer.six) — 28 classes, 31 functions, 13 methods. Signatures extracted by static analysis of the actual source.

Repository: pdfminer/pdfminer.six

Kind	Count
Classes	28
Functions	31
Methods	13

API list

funcfuzzing.utils.prepare_pdfminer_fuzzing() -> None

Used to disable logging of the pdfminer module

funcpdfminer._saslprep.saslprep(data:str, prohibit_unassigned_code_points:bool=True) -> str

An implementation of RFC4013 SASLprep.

classpdfminer.data_structures.NumberTree

A PDF number tree.

funcpdfminer.encodingdb.name2unicode(name:str) -> str

Converts Adobe glyph names to Unicode numbers.

funcpdfminer.fontmetrics.convert_font_metrics(path:str) -> None

Convert an AFM file to a mapping of font metrics.

funcpdfminer.glyphlist.convert_glyphlist(path:str) -> None

Convert a glyph list into a python representation.

classpdfminer.jbig2.JBIG2StreamReader

Read segments from a JBIG2 byte stream

classpdfminer.jbig2.JBIG2StreamWriter

Write JBIG2 segments to a file in JBIG2 format

classpdfminer.layout.LTAnno

Actual letter in the text as a Unicode string.

classpdfminer.layout.LTChar

Actual letter in the text as a Unicode string.

classpdfminer.layout.LTComponent

Object with a bounding box

classpdfminer.layout.LTContainer

Object that can be extended and analyzed

classpdfminer.layout.LTFigure

Represents an area used by PDF Form objects.

classpdfminer.layout.LTImage

An image object.

classpdfminer.layout.LTItem

Interface for things that can be analyzed

methodpdfminer.layout.LTItem.analyze(laparams:LAParams) -> None

Perform the layout analysis.

funcpdfminer.layout.LTLayoutContainer.dist(obj1:LTComponent, obj2:LTComponent) -> float

A distance function between two TextBoxes.

funcpdfminer.layout.LTLayoutContainer.isany(obj1:ElementT, obj2:ElementT) -> set[ElementT]

Check if there's any other object between obj1 and obj2.

classpdfminer.layout.LTLine

A single straight line.

classpdfminer.layout.LTPage

Represents an entire page.

classpdfminer.layout.LTRect

A rectangle.

classpdfminer.layout.LTText

Interface for things that have text

methodpdfminer.layout.LTText.get_text() -> str

Text contained in this object

classpdfminer.layout.LTTextBox

Represents a group of text chunks in a rectangular area.

classpdfminer.pdfdocument.PDFDocument

PDFDocument object represents a PDF document.

methodpdfminer.pdfdocument.PDFDocument.find_xref(parser:PDFParser) -> int

Internal function used to locate the first XRef.

methodpdfminer.pdfdocument.PDFDocument.get_page_labels() -> Iterator[str]

Generate page label strings for the PDF document.

methodpdfminer.pdfdocument.PDFDocument.read_xref_from(parser:PDFParser, start:int, xrefs:list[PDFBaseXRef]) -> None

Reads XRefs from the given location.

classpdfminer.pdfdocument.PDFEncryptionWarning

Legacy warning for failed decryption.

classpdfminer.pdfdocument.PDFNoValidXRefWarning

Legacy warning for missing xref.

classpdfminer.pdfdocument.PageLabels

PageLabels from the document catalog.

funcpdfminer.pdffont.get_widths(seq:Iterable[object]) -> dict[str | int, float]

Build a mapping of character widths for horizontal writing.

funcpdfminer.pdffont.get_widths2(seq:Iterable[object]) -> dict[int, tuple[float, Point]]

Build a mapping of character widths for vertical writing.

classpdfminer.pdfinterp.PDFResourceManager

Repository of shared resources.

classpdfminer.pdfpage.PDFPage

An object that holds the information about a page.

classpdfminer.pdfparser.PDFParser

PDFParser fetch PDF objects from a file stream.

methodpdfminer.pdfparser.PDFParser.do_keyword(pos:int, token:PSKeyword) -> None

Handles PDF-related keywords.

methodpdfminer.pdfparser.PDFParser.set_document(doc:'PDFDocument') -> None

Associates the parser with a PDFDocument object.

classpdfminer.pdftypes.DecipherCallable

Fully typed a decipher callback, with optional parameter.

funcpdfminer.pdftypes.decipher_all(decipher:DecipherCallable, objid:int, genno:int, x:object) -> Any

Recursively deciphers the given object.

funcpdfminer.pdftypes.resolve1(x:object, default:object=None) -> Any

Resolves an object.

funcpdfminer.pdftypes.resolve_all(x:object, default:object=None) -> Any

Recursively resolves the given object and all the internals.

funcpdfminer.pdftypes.uint_value(x:object, n_bits:int) -> int

Resolve number and interpret it as a two's-complement unsigned number

methodpdfminer.psparser.PSBaseParser.nextline() -> tuple[int, bytes]

Fetches a next line that ends either with \r or \n.

methodpdfminer.psparser.PSBaseParser.revreadlines() -> Iterator[bytes]

Fetches a next line backward.

methodpdfminer.psparser.PSBaseParser.seek(pos:int) -> None

Seeks the parser to the given position.

classpdfminer.psparser.PSKeyword

A class that represents a PostScript keyword.

classpdfminer.psparser.PSLiteral

A class that represents a PostScript literal.

classpdfminer.psparser.PSObject

Base class for all PS or PDF-related data types.

classpdfminer.psparser.PSSymbolTable

A utility class for storing PSLiteral/PSKeyword objects.

classpdfminer.utils.Plane

A set-like data structure for objects placed on a plane.

methodpdfminer.utils.Plane.add(obj:LTComponentT) -> None

Place an object.

methodpdfminer.utils.Plane.find(bbox:Rect) -> Iterator[LTComponentT]

Finds objects that are in a certain area.

methodpdfminer.utils.Plane.remove(obj:LTComponentT) -> None

Displace an object.

funcpdfminer.utils.apply_matrix_norm(m:Matrix, v:Point) -> Point

Equivalent to apply_matrix_pt(M, (p,q)) - apply_matrix_pt(M, (0,0))

funcpdfminer.utils.apply_matrix_pt(m:Matrix, v:Point) -> Point

Applies a matrix to a point.

funcpdfminer.utils.apply_matrix_rect(m:Matrix, rect:Rect) -> Rect

Applies a matrix to a rectangle.

funcpdfminer.utils.choplist(n:int, seq:Iterable[_T]) -> Iterator[tuple[_T, ...]]

Groups every n elements of the list.

funcpdfminer.utils.decode_text(s:bytes) -> str

Decodes a PDFDocEncoding string to Unicode.

funcpdfminer.utils.drange(v0:float, v1:float, d:int) -> range

Returns a discrete range.

funcpdfminer.utils.enc(x:str) -> str

Encodes a string for SGML/XML/HTML

funcpdfminer.utils.format_int_alpha(value:int) -> str

Format a number as lowercase letters a-z, aa-zz, etc.

funcpdfminer.utils.format_int_roman(value:int) -> str

Format a number as lowercase Roman numerals.

funcpdfminer.utils.fsplit(pred:Callable[[_T], bool], objs:Iterable[_T]) -> tuple[list[_T], list[_T]]

Split a list into two classes according to the predicate.

funcpdfminer.utils.get_bound(pts:Iterable[Point]) -> Rect

Compute a minimal rectangle that covers all the points.

funcpdfminer.utils.make_compat_bytes(in_str:str) -> bytes

Converts to bytes, encoding to unicode.

funcpdfminer.utils.make_compat_str(o:object) -> str

Converts everything to string, if bytes guessing the encoding.

funcpdfminer.utils.nunpack(s:bytes, default:int=0) -> int

Unpacks variable-length unsigned integers (big endian).

funcpdfminer.utils.pick(seq:Iterable[_T], func:Callable[[_T], float], maxobj:_T | None=None) -> _T | None

Picks the object obj where func(obj) has the highest value.

funcpdfminer.utils.translate_matrix(m:Matrix, v:Point) -> Matrix

Translates a matrix by (x, y) inside the projection.

funcpdfminer.utils.uniq(objs:Iterable[_T]) -> Iterator[_T]

Eliminates duplicated elements.

funcpdfminer.utils.vecBetweenBoxes(obj1:'LTComponent', obj2:'LTComponent') -> Point

A distance function between two TextBoxes.

About this data

These signatures were extracted from the public source of pdfminer/pdfminer.six using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries