pikepdf
stable
Introduction
Installation
Tutorial
Release notes
Release notes
Topics
PDF split, merge, and document assembly
Working with pages
Object model
Stream objects
Working with content streams
Working with images
Overlays, underlays, watermarks, n-up
Character encoding
Metadata
Outlines
Name trees
Attaching files to a PDF
Default appearance in PDF viewers
PDF security
API
Main objects
Support models
Content streams
Exceptions
Settings
Reference
Architecture
Build process notes
Contributing guidelines
Debugging
Resources
pikepdf
Index
Edit on GitHub
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
_
__and__() (pikepdf.Rectangle method)
__array__() (pikepdf.Matrix method)
(pikepdf.PdfMatrix method)
__bool__() (pikepdf.Object method)
__bytes__() (pikepdf.Object method)
__contains__() (pikepdf.Object method)
__copy__() (pikepdf.Object method)
__delattr__() (pikepdf.Object method)
__delitem__() (pikepdf.Object method)
__dir__() (pikepdf.Object method)
__eq__() (pikepdf.Object method)
__float__() (pikepdf.Object method)
__getattr__() (pikepdf.Object method)
__getitem__() (pikepdf.Object method)
__hash__() (pikepdf.Object method)
__init__() (pikepdf.AttachedFileSpec method)
(pikepdf.Job method)
(pikepdf.Matrix method)
(pikepdf.PdfMatrix method)
(pikepdf.Rectangle method)
__int__() (pikepdf.Object method)
__iter__() (pikepdf.Object method)
__len__() (pikepdf.Object method)
__matmul__() (pikepdf.Matrix method)
(pikepdf.PdfMatrix method)
__new__() (pikepdf.Array method)
(pikepdf.Dictionary method)
(pikepdf.Name method)
(pikepdf.Operator method)
(pikepdf.Stream method)
(pikepdf.String method)
__setattr__() (pikepdf.Object method)
__setitem__() (pikepdf.Object method)
_ObjectList (class in pikepdf._core)
A
a (pikepdf.Matrix property)
(pikepdf.PdfMatrix property)
accessibility (pikepdf.Permissions attribute)
add() (pikepdf.models.Outline method)
add_blank_page() (pikepdf.Pdf method)
add_content_token_filter() (pikepdf.Page method)
add_overlay() (pikepdf.Page method)
add_resource() (pikepdf.Page method)
add_underlay() (pikepdf.Page method)
aes (pikepdf.Encryption attribute)
(pikepdf.models.Encryption attribute)
all (pikepdf.StreamDecodeLevel attribute)
allow (pikepdf.Encryption attribute)
(pikepdf.models.Encryption attribute)
(pikepdf.Pdf property)
Annotation (class in pikepdf)
appearance_dict (pikepdf.Annotation property)
appearance_state (pikepdf.Annotation property)
append() (pikepdf._core._ObjectList method)
(pikepdf._core.PageList method)
(pikepdf.Object method)
Array (class in pikepdf)
array (pikepdf.ObjectType attribute)
array_close (pikepdf.TokenType attribute)
array_open (pikepdf.TokenType attribute)
artbox (pikepdf.Page property)
as_array() (pikepdf.Matrix method)
(pikepdf.Rectangle method)
as_dict() (pikepdf.Object method)
as_form_xobject() (pikepdf.Page method)
as_list() (pikepdf.Object method)
as_pil_image() (pikepdf.PdfImage method)
AttachedFile (class in pikepdf._core)
AttachedFileSpec (class in pikepdf)
Attachments (class in pikepdf._core)
attachments (pikepdf.Pdf property)
B
b (pikepdf.Matrix property)
(pikepdf.PdfMatrix property)
bad (pikepdf.TokenType attribute)
bits (pikepdf.models.EncryptionInfo property)
bits_per_component (pikepdf.PdfImage property)
bleedbox (pikepdf.Page property)
bool (pikepdf.TokenType attribute)
boolean (pikepdf.ObjectType attribute)
brace_close (pikepdf.TokenType attribute)
brace_open (pikepdf.TokenType attribute)
built-in function
pikepdf.new()
pikepdf.open()
C
c (pikepdf.Matrix property)
(pikepdf.PdfMatrix property)
calc_form_xobject_placement() (pikepdf.Page method)
check() (pikepdf.Pdf method)
check_configuration() (pikepdf.Job method)
check_linearization() (pikepdf.Pdf method)
clear() (pikepdf._core._ObjectList method)
close() (pikepdf.Pdf method)
colorspace (pikepdf.PdfImage property)
comment (pikepdf.TokenType attribute)
contents_add() (pikepdf.Page method)
contents_coalesce() (pikepdf.Page method)
ContentStreamInlineImage (class in pikepdf)
ContentStreamInstruction (class in pikepdf)
copy_foreign() (pikepdf.Pdf method)
count() (pikepdf._core._ObjectList method)
create_pdf() (pikepdf.Job method)
creates_output (pikepdf.Job property)
creation_date (pikepdf._core.AttachedFile attribute)
cropbox (pikepdf.Page property)
D
d (pikepdf.Matrix property)
(pikepdf.PdfMatrix property)
DataDecodingError
decode_parms (pikepdf.PdfImage property)
DeletedObjectError
description (pikepdf.AttachedFileSpec property)
dict_close (pikepdf.TokenType attribute)
dict_open (pikepdf.TokenType attribute)
Dictionary (class in pikepdf)
dictionary (pikepdf.ObjectType attribute)
disable (pikepdf.ObjectStreamMode attribute)
docinfo (pikepdf.Pdf property)
DOCINFO_MAPPING (pikepdf.models.PdfMetadata attribute)
E
e (pikepdf.Matrix property)
(pikepdf.PdfMatrix property)
emplace() (pikepdf.Object method)
(pikepdf.Page method)
encode() (pikepdf.Matrix method)
(pikepdf.PdfMatrix method)
Encryption (class in pikepdf)
(class in pikepdf.models)
encryption (pikepdf.Pdf property)
encryption_key (pikepdf.models.EncryptionInfo property)
encryption_status (pikepdf.Job property)
EncryptionInfo (class in pikepdf.models)
eof (pikepdf.TokenType attribute)
error_msg (pikepdf.Token property)
exit_code (pikepdf.Job property)
EXIT_CORRECT_PASSWORD (pikepdf.Job attribute)
EXIT_ERROR (pikepdf.Job attribute)
EXIT_IS_NOT_ENCRYPTED (pikepdf.Job attribute)
EXIT_WARNING (pikepdf.Job attribute)
extend() (pikepdf._core._ObjectList method)
(pikepdf._core.PageList method)
(pikepdf.Object method)
extension_level (pikepdf.Pdf property)
externalize_inline_images() (pikepdf.Page method)
extract (pikepdf.Permissions attribute)
extract_to() (pikepdf.PdfImage method)
F
f (pikepdf.Matrix property)
(pikepdf.PdfMatrix property)
file_method (pikepdf.models.EncryptionInfo property)
filename (pikepdf.AttachedFileSpec property)
(pikepdf.Pdf property)
filter_decodeparms (pikepdf.PdfImage property)
filters (pikepdf.PdfImage property)
flags (pikepdf.Annotation property)
flatten_annotations() (pikepdf.Pdf method)
ForeignObjectError
form_xobjects() (pikepdf.Page method)
from_dictionary_object() (pikepdf.models.OutlineItem class method)
from_filepath() (pikepdf.AttachedFileSpec static method)
from_objgen() (pikepdf._core.PageList method)
G
generalized (pikepdf.StreamDecodeLevel attribute)
generate (pikepdf.ObjectStreamMode attribute)
generate_appearance_streams() (pikepdf.Pdf method)
get() (pikepdf.Object method)
(pikepdf.Page method)
get_all_filenames() (pikepdf.AttachedFileSpec method)
get_appearance_stream() (pikepdf.Annotation method)
get_decimal_precision() (in module pikepdf.settings)
get_file() (pikepdf.AttachedFileSpec method)
get_filtered_contents() (pikepdf.Page method)
get_object() (pikepdf.Pdf method)
get_page_content_for_appearance() (pikepdf.Annotation method)
get_raw_stream_buffer() (pikepdf.Object method)
get_stream_buffer() (pikepdf.Object method)
(pikepdf.PdfImage method)
get_warnings() (pikepdf.Pdf method)
H
handle_token() (pikepdf.TokenFilter method)
has_warnings (pikepdf.Job property)
height (pikepdf.PdfImage property)
(pikepdf.Rectangle property)
I
icc (pikepdf.PdfImage property)
identity() (pikepdf.PdfMatrix static method)
iimage (pikepdf.ContentStreamInlineImage property)
image_mask (pikepdf.PdfImage property)
images (pikepdf.Object property)
(pikepdf.Page property)
index() (pikepdf._core.PageList method)
(pikepdf.Page method)
indexed (pikepdf.PdfImage property)
inline_image (pikepdf.TokenType attribute)
inlineimage (pikepdf.ObjectType attribute)
insert() (pikepdf._core._ObjectList method)
(pikepdf._core.PageList method)
integer (pikepdf.ObjectType attribute)
(pikepdf.TokenType attribute)
inverse() (pikepdf.Matrix method)
(pikepdf.PdfMatrix method)
is_device_n (pikepdf.PdfImage property)
is_encrypted (pikepdf.Pdf property)
is_indirect (pikepdf.Object property)
is_linearized (pikepdf.Pdf property)
is_owned_by() (pikepdf.Object method)
is_rectangle (pikepdf.Object property)
is_separation (pikepdf.PdfImage property)
items() (pikepdf.Object method)
J
Job (class in pikepdf)
job_json_schema() (pikepdf.Job static method)
json_out_schema() (pikepdf.Job static method)
K
keys() (pikepdf.Object method)
L
label() (pikepdf.Page method)
LATEST_JOB_JSON (pikepdf.Job attribute)
LATEST_JSON (pikepdf.Job attribute)
llx (pikepdf.Rectangle attribute)
lly (pikepdf.Rectangle attribute)
load_from_docinfo() (pikepdf.models.PdfMetadata method)
lower_left (pikepdf.Rectangle property)
lower_right (pikepdf.Rectangle property)
M
MAIN_COLORSPACES (pikepdf.PdfImage attribute)
make_indirect() (pikepdf.Pdf method)
make_stream() (pikepdf.Pdf method)
Matrix (class in pikepdf)
md5 (pikepdf._core.AttachedFile property)
mediabox (pikepdf.Page property)
message_prefix (pikepdf.Job property)
metadata (pikepdf.Encryption attribute)
(pikepdf.models.Encryption attribute)
mime_type (pikepdf._core.AttachedFile attribute)
mod_date (pikepdf._core.AttachedFile attribute)
mode (pikepdf.PdfImage property)
modify_annotation (pikepdf.Permissions attribute)
modify_assembly (pikepdf.Permissions attribute)
modify_form (pikepdf.Permissions attribute)
modify_other (pikepdf.Permissions attribute)
N
Name (class in pikepdf)
name_ (pikepdf.ObjectType attribute)
(pikepdf.TokenType attribute)
NameTree (class in pikepdf)
new() (pikepdf.NameTree static method)
(pikepdf.NumberTree static method)
(pikepdf.Pdf class method)
none (pikepdf.StreamDecodeLevel attribute)
NS (pikepdf.models.PdfMetadata attribute)
null (pikepdf.ObjectType attribute)
(pikepdf.TokenType attribute)
NumberTree (class in pikepdf)
O
obj (pikepdf._core.AttachedFile property)
(pikepdf.Annotation property)
(pikepdf.AttachedFileSpec property)
(pikepdf.NameTree property)
(pikepdf.NumberTree property)
(pikepdf.ObjectHelper property)
(pikepdf.Page property)
(pikepdf.PdfImage attribute)
Object (class in pikepdf)
ObjectHelper (class in pikepdf)
objects (pikepdf.Pdf property)
ObjectStreamMode (class in pikepdf)
ObjectType (class in pikepdf)
objgen (pikepdf.Object property)
open() (pikepdf.Pdf static method)
open_metadata() (pikepdf.Pdf method)
open_outline() (pikepdf.Pdf method)
operands (pikepdf.ContentStreamInlineImage property)
(pikepdf.ContentStreamInstruction property)
Operator (class in pikepdf)
operator (pikepdf.ContentStreamInlineImage property)
(pikepdf.ContentStreamInstruction property)
(pikepdf.ObjectType attribute)
Outline (class in pikepdf.models)
OutlineItem (class in pikepdf.models)
OutlineStructureError
owner (pikepdf.Encryption attribute)
(pikepdf.models.Encryption attribute)
owner_password_matched (pikepdf.Pdf property)
P
P (pikepdf.models.EncryptionInfo property)
p() (pikepdf._core.PageList method)
Page (class in pikepdf)
PageList (class in pikepdf._core)
pages (pikepdf.Pdf property)
palette (pikepdf.PdfImage property)
parse() (pikepdf.Object static method)
parse_content_stream() (in module pikepdf)
parse_contents() (pikepdf.Page method)
PasswordError
Pdf (class in pikepdf)
pdf_version (pikepdf.Pdf property)
pdfa_status (pikepdf.models.PdfMetadata property)
PdfError
PdfImage (class in pikepdf)
PdfInlineImage (class in pikepdf)
PdfMatrix (class in pikepdf)
PdfMetadata (class in pikepdf.models)
pdfx_status (pikepdf.models.PdfMetadata property)
Permissions (class in pikepdf)
pikepdf.new()
built-in function
pikepdf.open()
built-in function
pop() (pikepdf._core._ObjectList method)
preserve (pikepdf.ObjectStreamMode attribute)
PRINT_COLORSPACES (pikepdf.PdfImage attribute)
print_highres (pikepdf.Permissions attribute)
print_lowres (pikepdf.Permissions attribute)
R
R (pikepdf.Encryption attribute)
(pikepdf.models.Encryption attribute)
(pikepdf.models.EncryptionInfo property)
random() (pikepdf.Name class method)
raw_value (pikepdf.Token property)
read_bytes() (pikepdf._core.AttachedFile method)
(pikepdf.Object method)
(pikepdf.PdfImage method)
read_raw_bytes() (pikepdf.Object method)
real (pikepdf.ObjectType attribute)
(pikepdf.TokenType attribute)
Rectangle (class in pikepdf)
register_xml_namespace() (pikepdf.models.PdfMetadata class method)
relationship (pikepdf.AttachedFileSpec property)
remove() (pikepdf._core._ObjectList method)
(pikepdf._core.PageList method)
remove_unreferenced_resources() (pikepdf.Page method)
(pikepdf.Pdf method)
reserved (pikepdf.ObjectType attribute)
resources (pikepdf.Page property)
reverse() (pikepdf._core.PageList method)
REVERSE_NS (pikepdf.models.PdfMetadata attribute)
root (pikepdf.models.Outline property)
Root (pikepdf.Pdf property)
root (pikepdf.Pdf property)
rotate() (pikepdf.Page method)
rotated() (pikepdf.Matrix method)
(pikepdf.PdfMatrix method)
run() (pikepdf.Job method)
S
same_owner_as() (pikepdf.Object method)
save() (pikepdf.Pdf method)
scaled() (pikepdf.Matrix method)
(pikepdf.PdfMatrix method)
set_decimal_precision() (in module pikepdf.settings)
set_flate_compression_level() (in module pikepdf.settings)
shorthand (pikepdf.Matrix property)
(pikepdf.PdfMatrix property)
show() (pikepdf.PdfImage method)
show_xref_table() (pikepdf.Pdf method)
SIMPLE_COLORSPACES (pikepdf.PdfImage attribute)
size (pikepdf._core.AttachedFile property)
(pikepdf.PdfImage property)
space (pikepdf.TokenType attribute)
specialized (pikepdf.StreamDecodeLevel attribute)
Stream (class in pikepdf)
stream (pikepdf.ObjectType attribute)
stream_dict (pikepdf.Object property)
stream_method (pikepdf.models.EncryptionInfo property)
StreamDecodeLevel (class in pikepdf)
String (class in pikepdf)
string (pikepdf.ObjectType attribute)
(pikepdf.TokenType attribute)
string_method (pikepdf.models.EncryptionInfo property)
subtype (pikepdf.Annotation property)
T
to_dictionary_object() (pikepdf.models.OutlineItem method)
to_json() (pikepdf.Object method)
Token (class in pikepdf)
TokenFilter (class in pikepdf)
TokenType (class in pikepdf)
trailer (pikepdf.Pdf property)
transform() (pikepdf.Matrix method)
translated() (pikepdf.Matrix method)
(pikepdf.PdfMatrix method)
trimbox (pikepdf.Page property)
type_ (pikepdf.Token property)
U
uninitialized (pikepdf.ObjectType attribute)
unparse() (pikepdf.Object method)
unparse_content_stream() (in module pikepdf)
UnsupportedImageTypeError
upper_left (pikepdf.Rectangle property)
upper_right (pikepdf.Rectangle property)
urx (pikepdf.Rectangle attribute)
ury (pikepdf.Rectangle attribute)
user (pikepdf.Encryption attribute)
(pikepdf.models.Encryption attribute)
user_password (pikepdf.models.EncryptionInfo property)
user_password_matched (pikepdf.Pdf property)
V
V (pikepdf.models.EncryptionInfo property)
value (pikepdf.Token property)
W
width (pikepdf.PdfImage property)
(pikepdf.Rectangle property)
with_same_owner_as() (pikepdf.Object method)
word (pikepdf.TokenType attribute)
wrap_in_array() (pikepdf.Object method)
write() (pikepdf.Object method)
write_pdf() (pikepdf.Job method)
Read the Docs
v: stable
Versions
latest
stable
Downloads
On Read the Docs
Project Home
Builds