PyPDF2
1.28.2
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 PdfReader Class
The PdfWriter Class
The PdfMerger 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
|
H
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
|
X
|
Z
A
add_attachment() (PyPDF2.PdfWriter method)
add_blank_page() (PyPDF2.PdfWriter method)
add_bookmark() (PyPDF2.PdfMerger method)
(PyPDF2.PdfWriter method)
add_bookmark_destination() (PyPDF2.PdfWriter method)
add_bookmark_dict() (PyPDF2.PdfWriter method)
add_js() (PyPDF2.PdfWriter method)
add_link() (PyPDF2.PdfWriter method)
add_metadata() (PyPDF2.PdfMerger method)
(PyPDF2.PdfWriter method)
add_named_destination() (PyPDF2.PdfWriter method)
add_named_destination_object() (PyPDF2.PdfWriter method)
add_named_destionation() (PyPDF2.PdfMerger method)
add_page() (PyPDF2.PdfWriter method)
add_transformation() (PyPDF2._page.PageObject method)
add_uri() (PyPDF2.PdfWriter method)
addAttachment() (PyPDF2.PdfWriter method)
addBlankPage() (PyPDF2.PdfWriter method)
addBookmark() (PyPDF2.PdfMerger method)
(PyPDF2.PdfWriter method)
addBookmarkDestination() (PyPDF2.PdfWriter method)
addBookmarkDict() (PyPDF2.PdfWriter method)
additionalActions (PyPDF2.generic.Field property)
addJS() (PyPDF2.PdfWriter method)
addLink() (PyPDF2.PdfWriter method)
addMetadata() (PyPDF2.PdfMerger method)
(PyPDF2.PdfWriter method)
addNamedDestination() (PyPDF2.PdfMerger method)
(PyPDF2.PdfWriter method)
addNamedDestinationObject() (PyPDF2.PdfWriter method)
addPage() (PyPDF2.PdfWriter method)
addTransformation() (PyPDF2._page.PageObject method)
addURI() (PyPDF2.PdfWriter method)
altName (PyPDF2.generic.Field property)
append() (PyPDF2.PdfMerger method)
append_pages_from_reader() (PyPDF2.PdfWriter method)
appendPagesFromReader() (PyPDF2.PdfWriter method)
artBox (PyPDF2._page.PageObject property)
artbox (PyPDF2._page.PageObject property)
author (PyPDF2.DocumentInformation property)
author_raw (PyPDF2.DocumentInformation property)
B
bleedBox (PyPDF2._page.PageObject property)
bleedbox (PyPDF2._page.PageObject property)
bottom (PyPDF2.generic.Destination property)
(PyPDF2.generic.RectangleObject property)
C
cache_get_indirect_object() (PyPDF2.PdfReader method)
cache_indirect_object() (PyPDF2.PdfReader method)
cacheGetIndirectObject() (PyPDF2.PdfReader method)
cacheIndirectObject() (PyPDF2.PdfReader method)
clone_document_from_reader() (PyPDF2.PdfWriter method)
clone_reader_document_root() (PyPDF2.PdfWriter method)
cloneDocumentFromReader() (PyPDF2.PdfWriter method)
cloneReaderDocumentRoot() (PyPDF2.PdfWriter method)
close() (PyPDF2.PdfMerger method)
compress_content_streams() (PyPDF2._page.PageObject method)
compressContentStreams() (PyPDF2._page.PageObject method)
create_blank_page() (PyPDF2._page.PageObject static method)
createBlankPage() (PyPDF2._page.PageObject static method)
creator (PyPDF2.DocumentInformation property)
creator_raw (PyPDF2.DocumentInformation property)
cropBox (PyPDF2._page.PageObject property)
cropbox (PyPDF2._page.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.PdfReader method)
decrypt() (PyPDF2.PdfReader method)
defaultValue (PyPDF2.generic.Field property)
Destination (class in PyPDF2.generic)
documentInfo (PyPDF2.PdfReader property)
DocumentInformation (class in PyPDF2)
E
encrypt() (PyPDF2.PdfWriter method)
ensureIsNumber() (PyPDF2.generic.RectangleObject method)
extract_text() (PyPDF2._page.PageObject method)
extractText() (PyPDF2._page.PageObject method)
F
Field (class in PyPDF2.generic)
fieldType (PyPDF2.generic.Field property)
find_bookmark() (PyPDF2.PdfMerger method)
findBookmark() (PyPDF2.PdfMerger method)
flags (PyPDF2.generic.Field property)
flattened_pages (PyPDF2.PdfReader property)
flattenedPages (PyPDF2.PdfReader property)
G
get_contents() (PyPDF2._page.PageObject method)
get_destination_page_number() (PyPDF2.PdfReader method)
get_element() (PyPDF2.xmp.XmpInformation method)
get_fields() (PyPDF2.PdfReader method)
get_form_text_fields() (PyPDF2.PdfReader method)
get_named_dest_root() (PyPDF2.PdfWriter method)
get_nodes_in_namespace() (PyPDF2.xmp.XmpInformation method)
get_object() (PyPDF2.PdfReader method)
(PyPDF2.PdfWriter method)
get_outline_root() (PyPDF2.PdfWriter method)
get_outlines() (PyPDF2.PdfReader method)
get_page() (PyPDF2.PdfWriter method)
get_page_number() (PyPDF2.PdfReader method)
get_reference() (PyPDF2.PdfWriter method)
getContents() (PyPDF2._page.PageObject method)
getDestArray() (PyPDF2.generic.Destination method)
getDestinationPageNumber() (PyPDF2.PdfReader method)
getDocumentInfo() (PyPDF2.PdfReader method)
getElement() (PyPDF2.xmp.XmpInformation method)
getFields() (PyPDF2.PdfReader method)
getFormTextFields() (PyPDF2.PdfReader method)
getHeight() (PyPDF2.generic.RectangleObject method)
getIsEncrypted() (PyPDF2.PdfReader 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.PdfReader method)
getNamedDestRoot() (PyPDF2.PdfWriter method)
getNodesInNamespace() (PyPDF2.xmp.XmpInformation method)
getNumPages() (PyPDF2.PdfReader method)
(PyPDF2.PdfWriter method)
getObject() (PyPDF2.PdfReader method)
(PyPDF2.PdfWriter method)
getOutlineRoot() (PyPDF2.PdfWriter method)
getOutlines() (PyPDF2.PdfReader method)
getPage() (PyPDF2.PdfReader method)
(PyPDF2.PdfWriter method)
getPageLayout() (PyPDF2.PdfReader method)
(PyPDF2.PdfWriter method)
getPageMode() (PyPDF2.PdfReader method)
(PyPDF2.PdfWriter method)
getPageNumber() (PyPDF2.PdfReader method)
getReference() (PyPDF2.PdfWriter method)
getText() (PyPDF2.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.PdfReader method)
H
height (PyPDF2.generic.RectangleObject property)
I
indices() (PyPDF2.PageRange method)
insert_blank_page() (PyPDF2.PdfWriter method)
insert_page() (PyPDF2.PdfWriter method)
insertBlankPage() (PyPDF2.PdfWriter method)
insertPage() (PyPDF2.PdfWriter method)
is_encrypted (PyPDF2.PdfReader property)
isEncrypted (PyPDF2.PdfReader property)
K
kids (PyPDF2.generic.Field property)
L
left (PyPDF2.generic.Destination property)
(PyPDF2.generic.RectangleObject property)
lower_left (PyPDF2.generic.RectangleObject property)
lower_right (PyPDF2.generic.RectangleObject property)
lowerLeft (PyPDF2.generic.RectangleObject property)
lowerRight (PyPDF2.generic.RectangleObject property)
M
mappingName (PyPDF2.generic.Field property)
mediaBox (PyPDF2._page.PageObject property)
mediabox (PyPDF2._page.PageObject property)
merge() (PyPDF2.PdfMerger method)
merge_page() (PyPDF2._page.PageObject method)
mergePage() (PyPDF2._page.PageObject method)
mergeRotatedPage() (PyPDF2._page.PageObject method)
mergeRotatedScaledPage() (PyPDF2._page.PageObject method)
mergeRotatedScaledTranslatedPage() (PyPDF2._page.PageObject method)
mergeRotatedTranslatedPage() (PyPDF2._page.PageObject method)
mergeScaledPage() (PyPDF2._page.PageObject method)
mergeScaledTranslatedPage() (PyPDF2._page.PageObject method)
mergeTransformedPage() (PyPDF2._page.PageObject method)
mergeTranslatedPage() (PyPDF2._page.PageObject method)
metadata (PyPDF2.PdfReader property)
N
name (PyPDF2.generic.Field property)
named_destinations (PyPDF2.PdfReader property)
namedDestinations (PyPDF2.PdfReader property)
numPages (PyPDF2.PdfReader property)
O
outlines (PyPDF2.PdfReader property)
P
page (PyPDF2.generic.Destination property)
page_layout (PyPDF2.PdfReader property)
(PyPDF2.PdfWriter property)
page_mode (PyPDF2.PdfReader property)
(PyPDF2.PdfWriter property)
pageLayout (PyPDF2.PdfReader property)
(PyPDF2.PdfWriter property)
pageMode (PyPDF2.PdfReader property)
(PyPDF2.PdfWriter property)
PageObject (class in PyPDF2._page)
PageRange (class in PyPDF2)
pages (PyPDF2.PdfReader property)
(PyPDF2.PdfWriter property)
parent (PyPDF2.generic.Field property)
pdf_keywords (PyPDF2.xmp.XmpInformation property)
pdf_pdfversion (PyPDF2.xmp.XmpInformation property)
pdf_producer (PyPDF2.xmp.XmpInformation property)
PdfMerger (class in PyPDF2)
PdfReader (class in PyPDF2)
PdfWriter (class in PyPDF2)
producer (PyPDF2.DocumentInformation property)
producer_raw (PyPDF2.DocumentInformation property)
R
read() (PyPDF2.PdfReader method)
read_next_end_line() (PyPDF2.PdfReader method)
read_object_header() (PyPDF2.PdfReader method)
readNextEndLine() (PyPDF2.PdfReader method)
readObjectHeader() (PyPDF2.PdfReader method)
RectangleObject (class in PyPDF2.generic)
remove_images() (PyPDF2.PdfWriter method)
remove_links() (PyPDF2.PdfWriter method)
remove_text() (PyPDF2.PdfWriter method)
removeImages() (PyPDF2.PdfWriter method)
removeLinks() (PyPDF2.PdfWriter method)
removeText() (PyPDF2.PdfWriter method)
resolvedObjects (PyPDF2.PdfReader property)
right (PyPDF2.generic.Destination property)
(PyPDF2.generic.RectangleObject property)
rotate_clockwise() (PyPDF2._page.PageObject method)
rotateClockwise() (PyPDF2._page.PageObject method)
rotateCounterClockwise() (PyPDF2._page.PageObject method)
S
scale() (PyPDF2._page.PageObject method)
scale_by() (PyPDF2._page.PageObject method)
scale_to() (PyPDF2._page.PageObject method)
scaleBy() (PyPDF2._page.PageObject method)
scaleTo() (PyPDF2._page.PageObject method)
set_need_appearances_writer() (PyPDF2.PdfWriter method)
set_page_layout() (PyPDF2.PdfMerger method)
set_page_mode() (PyPDF2.PdfMerger method)
(PyPDF2.PdfWriter method)
setLowerLeft() (PyPDF2.generic.RectangleObject method)
setLowerRight() (PyPDF2.generic.RectangleObject method)
setPageLayout() (PyPDF2.PdfMerger method)
(PyPDF2.PdfWriter method)
setPageMode() (PyPDF2.PdfMerger method)
(PyPDF2.PdfWriter method)
setUpperLeft() (PyPDF2.generic.RectangleObject method)
setUpperRight() (PyPDF2.generic.RectangleObject method)
subject (PyPDF2.DocumentInformation property)
subject_raw (PyPDF2.DocumentInformation property)
T
title (PyPDF2.DocumentInformation property)
(PyPDF2.generic.Destination property)
title_raw (PyPDF2.DocumentInformation property)
to_slice() (PyPDF2.PageRange method)
top (PyPDF2.generic.Destination property)
(PyPDF2.generic.RectangleObject property)
trimBox (PyPDF2._page.PageObject property)
trimbox (PyPDF2._page.PageObject property)
typ (PyPDF2.generic.Destination property)
U
update_page_form_field_values() (PyPDF2.PdfWriter method)
updatePageFormFieldValues() (PyPDF2.PdfWriter method)
upper_left (PyPDF2.generic.RectangleObject property)
upper_right (PyPDF2.generic.RectangleObject property)
upperLeft (PyPDF2.generic.RectangleObject property)
upperRight (PyPDF2.generic.RectangleObject property)
V
valid() (PyPDF2.PageRange static method)
value (PyPDF2.generic.Field property)
W
width (PyPDF2.generic.RectangleObject property)
write() (PyPDF2.PdfMerger method)
(PyPDF2.PdfWriter method)
write_to_stream() (PyPDF2.generic.Destination method)
(PyPDF2.xmp.XmpInformation method)
writeToStream() (PyPDF2.xmp.XmpInformation method)
X
xmp_createDate (PyPDF2.xmp.XmpInformation property)
xmp_creatorTool (PyPDF2.xmp.XmpInformation property)
xmp_metadata (PyPDF2.PdfReader property)
xmp_metadataDate (PyPDF2.xmp.XmpInformation property)
xmp_modifyDate (PyPDF2.xmp.XmpInformation property)
XmpInformation (class in PyPDF2.xmp)
xmpMetadata (PyPDF2.PdfReader property)
xmpmm_documentId (PyPDF2.xmp.XmpInformation property)
xmpmm_instanceId (PyPDF2.xmp.XmpInformation property)
xrefIndex (PyPDF2.PdfReader property)
Z
zoom (PyPDF2.generic.Destination property)
Read the Docs
v: 1.28.2
Versions
latest
stable
1.28.2
1.28.1
1.28.0
1.27.12
Downloads
On Read the Docs
Project Home
Builds