PyPDF2
1.27.12
User Guide
Installation
Robustness and strict=False
Metadata
Extract Text from a PDF
Encryption and Decryption of PDFs
Merging PDF files
Cropping and Transforming PDFs
Adding a Watermark to a PDF
Reading PDF Annotations
Adding PDF Annotations
Interactions with PDF Forms
Streaming Data with PyPDF2
Reduce PDF Size
PDF Version Support
API Reference
The PdfFileReader Class
The PdfFileWriter Class
The PdfFileMerger Class
The PageObject Class
The DocumentInformation Class
The XmpInformation Class
The Destination Class
The RectangleObject Class
The Field Class
The PageRange Class
Developer Guide
Developer Intro
The PDF Format
CMaps
About PyPDF2
Project Governance
History of PyPDF2
PyPDF2 vs X
Frequently-Asked Questions
Scripts
pdfcat
PyPDF2
»
Index
Edit on GitHub
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
|
X
|
Z
A
addAttachment() (PyPDF2.pdf.PdfFileWriter method)
addBlankPage() (PyPDF2.pdf.PdfFileWriter method)
addBookmark() (PyPDF2.merger.PdfFileMerger method)
(PyPDF2.pdf.PdfFileWriter method)
addBookmarkDestination() (PyPDF2.pdf.PdfFileWriter method)
addBookmarkDict() (PyPDF2.pdf.PdfFileWriter method)
additionalActions (PyPDF2.pdf.Field property)
addJS() (PyPDF2.pdf.PdfFileWriter method)
addLink() (PyPDF2.pdf.PdfFileWriter method)
addMetadata() (PyPDF2.merger.PdfFileMerger method)
(PyPDF2.pdf.PdfFileWriter method)
addNamedDestination() (PyPDF2.merger.PdfFileMerger method)
(PyPDF2.pdf.PdfFileWriter method)
addNamedDestinationObject() (PyPDF2.pdf.PdfFileWriter method)
addPage() (PyPDF2.pdf.PdfFileWriter method)
addTransformation() (PyPDF2.pdf.PageObject method)
addURI() (PyPDF2.pdf.PdfFileWriter method)
altName (PyPDF2.pdf.Field property)
append() (PyPDF2.merger.PdfFileMerger method)
appendPagesFromReader() (PyPDF2.pdf.PdfFileWriter method)
artBox (PyPDF2.pdf.PageObject property)
author (PyPDF2.pdf.DocumentInformation property)
author_raw (PyPDF2.pdf.DocumentInformation property)
B
bleedBox (PyPDF2.pdf.PageObject property)
bottom (PyPDF2.pdf.Destination property)
C
cacheGetIndirectObject() (PyPDF2.pdf.PdfFileReader method)
cacheIndirectObject() (PyPDF2.pdf.PdfFileReader method)
cloneDocumentFromReader() (PyPDF2.pdf.PdfFileWriter method)
cloneReaderDocumentRoot() (PyPDF2.pdf.PdfFileWriter method)
close() (PyPDF2.merger.PdfFileMerger method)
compressContentStreams() (PyPDF2.pdf.PageObject method)
createBlankPage() (PyPDF2.pdf.PageObject static method)
creator (PyPDF2.pdf.DocumentInformation property)
creator_raw (PyPDF2.pdf.DocumentInformation property)
cropBox (PyPDF2.pdf.PageObject property)
custom_properties (PyPDF2.xmp.XmpInformation property)
D
dc_contributor (PyPDF2.xmp.XmpInformation property)
dc_coverage (PyPDF2.xmp.XmpInformation property)
dc_creator (PyPDF2.xmp.XmpInformation property)
dc_date (PyPDF2.xmp.XmpInformation property)
dc_description (PyPDF2.xmp.XmpInformation property)
dc_format (PyPDF2.xmp.XmpInformation property)
dc_identifier (PyPDF2.xmp.XmpInformation property)
dc_language (PyPDF2.xmp.XmpInformation property)
dc_publisher (PyPDF2.xmp.XmpInformation property)
dc_relation (PyPDF2.xmp.XmpInformation property)
dc_rights (PyPDF2.xmp.XmpInformation property)
dc_source (PyPDF2.xmp.XmpInformation property)
dc_subject (PyPDF2.xmp.XmpInformation property)
dc_title (PyPDF2.xmp.XmpInformation property)
dc_type (PyPDF2.xmp.XmpInformation property)
decode_permissions() (PyPDF2.pdf.PdfFileReader method)
decrypt() (PyPDF2.pdf.PdfFileReader method)
defaultValue (PyPDF2.pdf.Field property)
Destination (class in PyPDF2.pdf)
documentInfo (PyPDF2.pdf.PdfFileReader property)
DocumentInformation (class in PyPDF2.pdf)
E
encrypt() (PyPDF2.pdf.PdfFileWriter method)
ensureIsNumber() (PyPDF2.generic.RectangleObject method)
extractText() (PyPDF2.pdf.PageObject method)
F
Field (class in PyPDF2.pdf)
fieldType (PyPDF2.pdf.Field property)
findBookmark() (PyPDF2.merger.PdfFileMerger method)
flags (PyPDF2.pdf.Field property)
G
getContents() (PyPDF2.pdf.PageObject method)
getDestArray() (PyPDF2.pdf.Destination method)
getDestinationPageNumber() (PyPDF2.pdf.PdfFileReader method)
getDocumentInfo() (PyPDF2.pdf.PdfFileReader method)
getElement() (PyPDF2.xmp.XmpInformation method)
getFields() (PyPDF2.pdf.PdfFileReader method)
getFormTextFields() (PyPDF2.pdf.PdfFileReader method)
getHeight() (PyPDF2.generic.RectangleObject method)
getIsEncrypted() (PyPDF2.pdf.PdfFileReader method)
getLowerLeft() (PyPDF2.generic.RectangleObject method)
getLowerLeft_x() (PyPDF2.generic.RectangleObject method)
getLowerLeft_y() (PyPDF2.generic.RectangleObject method)
getLowerRight() (PyPDF2.generic.RectangleObject method)
getLowerRight_x() (PyPDF2.generic.RectangleObject method)
getLowerRight_y() (PyPDF2.generic.RectangleObject method)
getNamedDestinations() (PyPDF2.pdf.PdfFileReader method)
getNamedDestRoot() (PyPDF2.pdf.PdfFileWriter method)
getNodesInNamespace() (PyPDF2.xmp.XmpInformation method)
getNumPages() (PyPDF2.pdf.PdfFileReader method)
(PyPDF2.pdf.PdfFileWriter method)
getObject() (PyPDF2.pdf.PdfFileReader method)
(PyPDF2.pdf.PdfFileWriter method)
getOutlineRoot() (PyPDF2.pdf.PdfFileWriter method)
getOutlines() (PyPDF2.pdf.PdfFileReader method)
getPage() (PyPDF2.pdf.PdfFileReader method)
(PyPDF2.pdf.PdfFileWriter method)
getPageLayout() (PyPDF2.pdf.PdfFileReader method)
(PyPDF2.pdf.PdfFileWriter method)
getPageMode() (PyPDF2.pdf.PdfFileReader method)
(PyPDF2.pdf.PdfFileWriter method)
getPageNumber() (PyPDF2.pdf.PdfFileReader method)
getReference() (PyPDF2.pdf.PdfFileWriter method)
getText() (PyPDF2.pdf.DocumentInformation method)
getUpperLeft() (PyPDF2.generic.RectangleObject method)
getUpperLeft_x() (PyPDF2.generic.RectangleObject method)
getUpperLeft_y() (PyPDF2.generic.RectangleObject method)
getUpperRight() (PyPDF2.generic.RectangleObject method)
getUpperRight_x() (PyPDF2.generic.RectangleObject method)
getUpperRight_y() (PyPDF2.generic.RectangleObject method)
getWidth() (PyPDF2.generic.RectangleObject method)
getXmpMetadata() (PyPDF2.pdf.PdfFileReader method)
I
indices() (PyPDF2.pagerange.PageRange method)
insertBlankPage() (PyPDF2.pdf.PdfFileWriter method)
insertPage() (PyPDF2.pdf.PdfFileWriter method)
isEncrypted (PyPDF2.pdf.PdfFileReader property)
K
kids (PyPDF2.pdf.Field property)
L
left (PyPDF2.pdf.Destination property)
lowerLeft (PyPDF2.generic.RectangleObject property)
lowerRight (PyPDF2.generic.RectangleObject property)
M
mappingName (PyPDF2.pdf.Field property)
mediaBox (PyPDF2.pdf.PageObject property)
merge() (PyPDF2.merger.PdfFileMerger method)
mergePage() (PyPDF2.pdf.PageObject method)
mergeRotatedPage() (PyPDF2.pdf.PageObject method)
mergeRotatedScaledPage() (PyPDF2.pdf.PageObject method)
mergeRotatedScaledTranslatedPage() (PyPDF2.pdf.PageObject method)
mergeRotatedTranslatedPage() (PyPDF2.pdf.PageObject method)
mergeScaledPage() (PyPDF2.pdf.PageObject method)
mergeScaledTranslatedPage() (PyPDF2.pdf.PageObject method)
mergeTransformedPage() (PyPDF2.pdf.PageObject method)
mergeTranslatedPage() (PyPDF2.pdf.PageObject method)
N
name (PyPDF2.pdf.Field property)
namedDestinations (PyPDF2.pdf.PdfFileReader property)
numPages (PyPDF2.pdf.PdfFileReader property)
O
outlines (PyPDF2.pdf.PdfFileReader property)
P
page (PyPDF2.pdf.Destination property)
pageLayout (PyPDF2.pdf.PdfFileReader property)
(PyPDF2.pdf.PdfFileWriter property)
pageMode (PyPDF2.pdf.PdfFileReader property)
(PyPDF2.pdf.PdfFileWriter property)
PageObject (class in PyPDF2.pdf)
PageRange (class in PyPDF2.pagerange)
pages (PyPDF2.pdf.PdfFileReader property)
parent (PyPDF2.pdf.Field property)
pdf_keywords (PyPDF2.xmp.XmpInformation property)
pdf_pdfversion (PyPDF2.xmp.XmpInformation property)
pdf_producer (PyPDF2.xmp.XmpInformation property)
PdfFileMerger (class in PyPDF2.merger)
PdfFileReader (class in PyPDF2.pdf)
PdfFileWriter (class in PyPDF2.pdf)
producer (PyPDF2.pdf.DocumentInformation property)
producer_raw (PyPDF2.pdf.DocumentInformation property)
R
read() (PyPDF2.pdf.PdfFileReader method)
readNextEndLine() (PyPDF2.pdf.PdfFileReader method)
readObjectHeader() (PyPDF2.pdf.PdfFileReader method)
RectangleObject (class in PyPDF2.generic)
removeImages() (PyPDF2.pdf.PdfFileWriter method)
removeLinks() (PyPDF2.pdf.PdfFileWriter method)
removeText() (PyPDF2.pdf.PdfFileWriter method)
right (PyPDF2.pdf.Destination property)
rotateClockwise() (PyPDF2.pdf.PageObject method)
rotateCounterClockwise() (PyPDF2.pdf.PageObject method)
S
scale() (PyPDF2.pdf.PageObject method)
scaleBy() (PyPDF2.pdf.PageObject method)
scaleTo() (PyPDF2.pdf.PageObject method)
set_need_appearances_writer() (PyPDF2.pdf.PdfFileWriter method)
setLowerLeft() (PyPDF2.generic.RectangleObject method)
setLowerRight() (PyPDF2.generic.RectangleObject method)
setPageLayout() (PyPDF2.merger.PdfFileMerger method)
(PyPDF2.pdf.PdfFileWriter method)
setPageMode() (PyPDF2.merger.PdfFileMerger method)
(PyPDF2.pdf.PdfFileWriter method)
setUpperLeft() (PyPDF2.generic.RectangleObject method)
setUpperRight() (PyPDF2.generic.RectangleObject method)
subject (PyPDF2.pdf.DocumentInformation property)
subject_raw (PyPDF2.pdf.DocumentInformation property)
T
title (PyPDF2.pdf.Destination property)
(PyPDF2.pdf.DocumentInformation property)
title_raw (PyPDF2.pdf.DocumentInformation property)
to_slice() (PyPDF2.pagerange.PageRange method)
top (PyPDF2.pdf.Destination property)
trimBox (PyPDF2.pdf.PageObject property)
typ (PyPDF2.pdf.Destination property)
U
updatePageFormFieldValues() (PyPDF2.pdf.PdfFileWriter method)
upperLeft (PyPDF2.generic.RectangleObject property)
upperRight (PyPDF2.generic.RectangleObject property)
V
valid() (PyPDF2.pagerange.PageRange static method)
value (PyPDF2.pdf.Field property)
W
write() (PyPDF2.merger.PdfFileMerger method)
(PyPDF2.pdf.PdfFileWriter method)
writeToStream() (PyPDF2.pdf.Destination method)
(PyPDF2.xmp.XmpInformation method)
X
xmp_createDate (PyPDF2.xmp.XmpInformation property)
xmp_creatorTool (PyPDF2.xmp.XmpInformation property)
xmp_metadataDate (PyPDF2.xmp.XmpInformation property)
xmp_modifyDate (PyPDF2.xmp.XmpInformation property)
XmpInformation (class in PyPDF2.xmp)
xmpMetadata (PyPDF2.pdf.PdfFileReader property)
xmpmm_documentId (PyPDF2.xmp.XmpInformation property)
xmpmm_instanceId (PyPDF2.xmp.XmpInformation property)
Z
zoom (PyPDF2.pdf.Destination property)
Read the Docs
v: 1.27.12
Versions
latest
stable
1.27.12
1.26.0
Downloads
On Read the Docs
Project Home
Builds