pikepdf
Introduction
Installation
Building from source
Tutorial
Release notes
Release notes
Topics
PDF split, merge, and document assembly
Working with pages
Object model
PDF type safety with explicit mode
Accessing nested objects with NamePath
Stream objects
Working with content streams
Working with images
Overlays, underlays, watermarks, n-up
Working with interactive forms
Character encoding
Metadata
PDF/A validation and repair
Outlines
Name trees
Attaching files to a PDF
Default appearance in PDF viewers
PDF security
Sanitizing PDFs
Batch operations with JobBuilder
qpdf JSON
API
Main objects
Support models
Sanitization
PDF/A validation
Canvas
Form
Content streams
Exceptions
Settings
Reference
Architecture
Locks
Build process notes
Contributing guidelines
Debugging
Resources
pikepdf
Index
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
K
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
|
X
|
Z
_
__abs__() (pikepdf.Object method)
__add__() (pikepdf.Object method)
__and__() (pikepdf.Rectangle method)
__array__() (pikepdf.Matrix method)
__bool__() (pikepdf.Object method)
__bytes__() (pikepdf.Object method)
__ceil__() (pikepdf.Object method)
__contains__() (pikepdf.Object method)
__copy__() (pikepdf.Object method)
__delattr__() (pikepdf.Object method)
__delitem__() (pikepdf.Object method)
__dir__() (pikepdf.Object method)
__divmod__() (pikepdf.Object method)
__eq__() (pikepdf.Object method)
__float__() (pikepdf.Object method)
__floor__() (pikepdf.Object method)
__floordiv__() (pikepdf.Object method)
__format__() (pikepdf.Object method)
__ge__() (pikepdf.Object method)
__getattr__() (pikepdf.Object method)
__getitem__() (pikepdf.Object method)
__gt__() (pikepdf.Object method)
__hash__() (pikepdf.Object method)
__index__() (pikepdf.Object method)
__init__() (pikepdf.AttachedFileSpec method)
(pikepdf.Job method)
(pikepdf.Matrix method)
(pikepdf.Rectangle method)
__int__() (pikepdf.Object method)
__iter__() (pikepdf.Object method)
__le__() (pikepdf.Object method)
__len__() (pikepdf.Object method)
__lt__() (pikepdf.Object method)
__matmul__() (pikepdf.Matrix method)
__mod__() (pikepdf.Object method)
__mul__() (pikepdf.Object method)
__neg__() (pikepdf.Object method)
__new__() (pikepdf.Array method)
(pikepdf.Dictionary method)
(pikepdf.Name method)
(pikepdf.Operator method)
(pikepdf.Stream method)
(pikepdf.String method)
__pos__() (pikepdf.Object method)
__pow__() (pikepdf.Object method)
__radd__() (pikepdf.Object method)
__rdivmod__() (pikepdf.Object method)
__rfloordiv__() (pikepdf.Object method)
__rmod__() (pikepdf.Object method)
__rmul__() (pikepdf.Object method)
__round__() (pikepdf.Object method)
__rpow__() (pikepdf.Object method)
__rsub__() (pikepdf.Object method)
__rtruediv__() (pikepdf.Object method)
__setattr__() (pikepdf.Object method)
__setitem__() (pikepdf.Object method)
__sub__() (pikepdf.Object method)
__truediv__() (pikepdf.Object method)
__trunc__() (pikepdf.Object method)
_CanvasAccessor (class in pikepdf.canvas)
_FieldWrapper (class in pikepdf.form)
_ObjectList (class in pikepdf._core)
A
a (pikepdf.Matrix property)
accessibility (pikepdf.Permissions attribute)
AcroForm (class in pikepdf)
acroform (pikepdf.Pdf property)
AcroFormField (class in pikepdf)
Action (class in pikepdf.models.actions)
action (pikepdf.models.OutlineItem attribute)
add() (pikepdf.models.Outline method)
(pikepdf.ObjectSet method)
add_and_rename_fields() (pikepdf.AcroForm method)
add_attachment() (pikepdf.JobBuilder method)
add_blank_page() (pikepdf.Pdf method)
add_content_token_filter() (pikepdf.Page method)
add_field() (pikepdf.AcroForm method)
add_font() (pikepdf.canvas.Canvas method)
add_overlay() (pikepdf.JobBuilder method)
(pikepdf.Page method)
add_pages() (pikepdf.JobBuilder method)
add_pages_from() (pikepdf.Pdf method)
add_resource() (pikepdf.Page method)
add_underlay() (pikepdf.JobBuilder method)
(pikepdf.Page method)
aes (pikepdf.Encryption attribute)
(pikepdf.models.Encryption attribute)
(pikepdf.models.EncryptionMethod attribute)
aesv3 (pikepdf.models.EncryptionMethod attribute)
af_relationships_set (pikepdf.pdfa.PrepareResult attribute)
all (pikepdf.StreamDecodeLevel attribute)
allow (pikepdf.Encryption attribute)
(pikepdf.models.Encryption attribute)
(pikepdf.Pdf property)
allow_edit (pikepdf.form.ChoiceField property)
allow_weak_crypto() (pikepdf.JobBuilder method)
alternate_name (pikepdf.AcroFormField property)
alternate_presentations_removed (pikepdf.pdfa.PrepareResult attribute)
Annotation (class in pikepdf)
AnnotationRepairResult (class in pikepdf.pdfa)
annotations_removed (pikepdf.pdfa.PrepareResult attribute)
annotations_removed_pages (pikepdf.pdfa.PrepareResult attribute)
appearance_dict (pikepdf.Annotation property)
appearance_state (pikepdf.Annotation property)
AppearanceStreamGenerator (class in pikepdf.form)
append() (pikepdf._core._ObjectList method)
(pikepdf._core.PageList method)
(pikepdf.Object method)
append_rectangle() (pikepdf.canvas.ContentStreamBuilder method)
apply() (pikepdf.sanitize.Sanitizer 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_bool() (in module pikepdf)
(pikepdf.Object method)
as_bytes() (in module pikepdf)
(pikepdf.Object method)
as_decimal() (in module pikepdf)
(pikepdf.Object method)
as_dict() (in module pikepdf)
(pikepdf.Object method)
as_float() (in module pikepdf)
(pikepdf.Object method)
as_form_xobject() (pikepdf.Page method)
as_int() (in module pikepdf)
(pikepdf.Object method)
as_list() (in module pikepdf)
(pikepdf.Object method)
as_pil_image() (pikepdf.PdfImage method)
as_str() (in module pikepdf)
(pikepdf.Object method)
ascent (pikepdf.canvas.SimpleFont property)
associated_files_added (pikepdf.pdfa.PrepareResult attribute)
AttachedFile (class in pikepdf._core)
AttachedFileSpec (class in pikepdf)
Attachments (class in pikepdf._core)
attachments (pikepdf.Pdf property)
B
b (pikepdf.Matrix property)
bad (pikepdf.TokenType attribute)
base_encodings_added (pikepdf.pdfa.PrepareResult attribute)
begin_marked_content() (pikepdf.canvas.ContentStreamBuilder method)
begin_marked_content_proplist() (pikepdf.canvas.ContentStreamBuilder method)
begin_text() (pikepdf.canvas.ContentStreamBuilder method)
bits (pikepdf.models.EncryptionInfo property)
bits_per_component (pikepdf.PdfImage property)
bleedbox (pikepdf.Page property)
bold (pikepdf.models.OutlineItem property)
Bold (pikepdf.OutlineItemFlag attribute)
bool (pikepdf.TokenType attribute)
Boolean (class in pikepdf)
boolean (pikepdf.ObjectType attribute)
bottom (pikepdf.Destination attribute)
brace_close (pikepdf.TokenType attribute)
brace_open (pikepdf.TokenType attribute)
build() (pikepdf.canvas.ContentStreamBuilder method)
(pikepdf.JobBuilder method)
built-in function
pikepdf.new()
pikepdf.open()
C
c (pikepdf.Matrix property)
calc_form_xobject_placement() (pikepdf.Page method)
can_toggle_off (pikepdf.form.RadioButtonGroup property)
Canvas (class in pikepdf.canvas)
changed (pikepdf.pdfa.PrepareResult property)
check() (in module pikepdf.pdfa)
(pikepdf.JobBuilder method)
check_configuration() (pikepdf.Job method)
check_linearization() (pikepdf.Pdf method)
check_pdf_syntax() (pikepdf.Pdf method)
CheckboxField (class in pikepdf.form)
checked (pikepdf.form.CheckboxField property)
(pikepdf.form.RadioButtonOption property)
children (pikepdf.models.OutlineItem attribute)
ChoiceField (class in pikepdf.form)
ChoiceFieldOption (class in pikepdf.form)
choices (pikepdf.AcroFormField property)
cidsets_added (pikepdf.pdfa.PrepareResult attribute)
clear() (pikepdf._core._ObjectList method)
(pikepdf.Object method)
(pikepdf.ObjectSet method)
close() (pikepdf.Pdf method)
cm() (pikepdf.canvas._CanvasAccessor method)
(pikepdf.canvas.ContentStreamBuilder method)
coalesce_contents() (pikepdf.JobBuilder method)
collate() (pikepdf.JobBuilder method)
color (pikepdf.models.OutlineItem attribute)
colorspace (pikepdf.PdfImage property)
comment (pikepdf.TokenType attribute)
compress() (pikepdf.JobBuilder method)
content (pikepdf.ContentScope attribute)
content_scopes() (pikepdf.Page method)
(pikepdf.Pdf method)
contents_add() (pikepdf.Page method)
contents_coalesce() (pikepdf.Page method)
ContentScope (class in pikepdf)
ContentStreamBuilder (class in pikepdf.canvas)
ContentStreamInlineImage (class in pikepdf)
ContentStreamInstruction (class in pikepdf)
conversion_mode (pikepdf.Pdf attribute)
convert_width() (pikepdf.canvas.SimpleFont method)
convert_width_reverse() (pikepdf.canvas.SimpleFont method)
copy() (pikepdf.Object method)
copy_annotations() (pikepdf.Page method)
copy_attachments_from() (pikepdf.JobBuilder method)
copy_foreign() (pikepdf.Pdf method)
copy_properties() (pikepdf.models.PdfMetadata method)
count() (pikepdf._core._ObjectList method)
(pikepdf.Object method)
create_pdf() (pikepdf.Job method)
(pikepdf.JobBuilder method)
creates_output (pikepdf.Job property)
creation_date (pikepdf._core.AttachedFile attribute)
cropbox (pikepdf.Page property)
D
d (pikepdf.Matrix property)
dashes() (pikepdf.canvas._CanvasAccessor method)
data (pikepdf.canvas.SimpleFont attribute)
DataDecodingError
dates_zoned (pikepdf.pdfa.PrepareResult attribute)
decode_parms (pikepdf.PdfImage property)
decrypt() (pikepdf.JobBuilder method)
default_appearance (pikepdf.AcroFormField property)
default_resources (pikepdf.AcroFormField property)
default_value (pikepdf.AcroFormField property)
(pikepdf.form.TextField property)
default_value_as_string (pikepdf.AcroFormField property)
DefaultAppearanceStreamGenerator (class in pikepdf.form)
DeletedObjectError
DependencyError
descent (pikepdf.canvas.SimpleFont property)
describe() (pikepdf.pdfa.PrepareResult method)
description (pikepdf.AttachedFileSpec property)
Destination (class in pikepdf)
destination (pikepdf.models.actions.GoToAction property)
(pikepdf.models.actions.GoToEAction property)
(pikepdf.models.actions.GoToRAction property)
(pikepdf.models.OutlineItem attribute)
deterministic_id() (pikepdf.JobBuilder method)
dict_close (pikepdf.TokenType attribute)
dict_open (pikepdf.TokenType attribute)
Dictionary (class in pikepdf)
dictionary (pikepdf.ObjectType attribute)
disable (pikepdf.ObjectStreamMode attribute)
disable_digital_signatures() (pikepdf.AcroForm method)
disable_qpdf_default_limits() (in module pikepdf.settings)
discard() (pikepdf.ObjectSet method)
display_value (pikepdf.form.ChoiceFieldOption property)
do (pikepdf.canvas.Canvas property)
docinfo (pikepdf.Pdf property)
DOCINFO_MAPPING (pikepdf.models.PdfMetadata attribute)
document_javascript_removed (pikepdf.pdfa.PrepareResult attribute)
dpart (pikepdf.models.actions.GoToDpAction property)
draw_image() (pikepdf.canvas._CanvasAccessor method)
draw_text() (pikepdf.canvas._CanvasAccessor method)
draw_xobject() (pikepdf.canvas.ContentStreamBuilder method)
dropped_dests (pikepdf.PageCopyResult attribute)
E
e (pikepdf.Matrix property)
embedded_file_subtypes_set (pikepdf.pdfa.PrepareResult attribute)
emplace() (pikepdf.Object method)
(pikepdf.Page method)
empty() (pikepdf.JobBuilder method)
encode() (pikepdf.canvas.SimpleFont method)
(pikepdf.Matrix method)
encrypt() (pikepdf.JobBuilder 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)
EncryptionMethod (class in pikepdf.models)
end_marked_content() (pikepdf.canvas.ContentStreamBuilder method)
end_text() (pikepdf.canvas.ContentStreamBuilder method)
eof (pikepdf.TokenType attribute)
error_msg (pikepdf.Token property)
exists (pikepdf.AcroForm 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)
explicit_conversion() (in module pikepdf)
export_enabled (pikepdf.form._FieldWrapper property)
export_value (pikepdf.form.ChoiceFieldOption property)
extend() (pikepdf._core._ObjectList method)
(pikepdf._core.PageList method)
(pikepdf.canvas.ContentStreamBuilder method)
(pikepdf.Object method)
ExtendedAppearanceStreamGenerator (class in pikepdf.form)
extension_level (pikepdf.Pdf property)
externalize_inline_images() (pikepdf.JobBuilder method)
(pikepdf.Page method)
extract (pikepdf.Permissions attribute)
extract_to() (pikepdf.PdfImage method)
F
f (pikepdf.Matrix property)
field_type (pikepdf.AcroFormField property)
fields (pikepdf.AcroForm property)
fields_added (pikepdf.PageCopyResult attribute)
file (pikepdf.JSONStreamData attribute)
file_method (pikepdf.models.EncryptionInfo property)
file_spec (pikepdf.models.actions.GoToEAction property)
(pikepdf.models.actions.GoToRAction property)
(pikepdf.models.actions.LaunchAction property)
filename (pikepdf.AttachedFileSpec property)
(pikepdf.Pdf property)
fill() (pikepdf.canvas.ContentStreamBuilder method)
fill_color() (pikepdf.canvas._CanvasAccessor method)
filter_decodeparms (pikepdf.PdfImage property)
filters (pikepdf.PdfImage property)
Finding (class in pikepdf.pdfa)
findings (pikepdf.pdfa.Report attribute)
Fit (pikepdf.PageLocation attribute)
fit_type (pikepdf.Destination property)
FitB (pikepdf.PageLocation attribute)
FitBH (pikepdf.PageLocation attribute)
FitBV (pikepdf.PageLocation attribute)
FitH (pikepdf.PageLocation attribute)
FitR (pikepdf.PageLocation attribute)
FitV (pikepdf.PageLocation attribute)
fix_copied_annotations() (pikepdf.AcroForm method)
fix_dangling_references() (pikepdf.Pdf method)
flags (pikepdf.AcroFormField property)
(pikepdf.Annotation property)
(pikepdf.models.OutlineItem attribute)
flatten_annotations() (pikepdf.JobBuilder method)
(pikepdf.Pdf method)
flatten_rotation() (pikepdf.JobBuilder method)
(pikepdf.Page method)
Flavour (class in pikepdf.pdfa)
flavour (pikepdf.pdfa.Report attribute)
Font (class in pikepdf.canvas)
font() (pikepdf.canvas.Text method)
force_version() (pikepdf.JobBuilder method)
ForeignObjectError
Form (class in pikepdf.form)
form (pikepdf.form.AppearanceStreamGenerator attribute)
form_xobjects (pikepdf.Page property)
forms (pikepdf.PageCopyResult attribute)
from_array() (pikepdf.Destination class method)
from_dictionary() (pikepdf.models.actions.Action class method)
from_dictionary_object() (pikepdf.models.OutlineItem class method)
from_filepath() (pikepdf.AttachedFileSpec static method)
from_objgen() (pikepdf._core.PageList method)
from_qpdf_json() (pikepdf.Pdf static method)
fully_qualified_name (pikepdf.AcroFormField property)
G
generalized (pikepdf.StreamDecodeLevel attribute)
generate (pikepdf.ObjectStreamMode attribute)
generate_appearance() (pikepdf.AcroFormField method)
generate_appearance_streams() (pikepdf.Pdf method)
generate_appearances (pikepdf.form.Form attribute)
generate_appearances() (pikepdf.JobBuilder method)
generate_appearances_if_needed() (pikepdf.AcroForm method)
generate_choice() (pikepdf.form.AppearanceStreamGenerator method)
(pikepdf.form.DefaultAppearanceStreamGenerator method)
generate_text() (pikepdf.form.AppearanceStreamGenerator method)
(pikepdf.form.DefaultAppearanceStreamGenerator method)
(pikepdf.form.ExtendedAppearanceStreamGenerator method)
get() (pikepdf.Object method)
(pikepdf.Page method)
get_all_filenames() (pikepdf.AttachedFileSpec method)
get_annotations_for_field() (pikepdf.AcroForm method)
get_appearance_stream() (pikepdf.Annotation method)
get_bool() (pikepdf.Object method)
get_bytes() (pikepdf.Object method)
get_decimal() (pikepdf.Object method)
get_decimal_precision() (in module pikepdf.settings)
get_dict() (pikepdf.Object method)
get_field_for_annotation() (pikepdf.AcroForm method)
get_fields_with_qualified_name() (pikepdf.AcroForm method)
get_file() (pikepdf.AttachedFileSpec method)
get_filtered_contents() (pikepdf.Page method)
get_float() (pikepdf.Object method)
get_form_fields_for_page() (pikepdf.AcroForm method)
get_images() (pikepdf.Page method)
get_inheritable_field_value() (pikepdf.AcroFormField method)
get_inheritable_field_value_as_name() (pikepdf.AcroFormField method)
get_inheritable_field_value_as_string() (pikepdf.AcroFormField method)
get_int() (pikepdf.Object method)
get_list() (pikepdf.Object method)
get_matrix_for_form_xobject_placement() (pikepdf.Page method)
get_matrix_for_transformations() (pikepdf.Page method)
get_object() (pikepdf.Pdf method)
get_object_conversion_mode() (in module pikepdf)
get_objects_with_ctm() (in module pikepdf.models.ctm)
get_page_content_for_appearance() (pikepdf.Annotation method)
get_qpdf_limits() (in module pikepdf.settings)
get_raw() (pikepdf.Object method)
get_raw_stream_buffer() (pikepdf.Object method)
get_resources() (pikepdf.Page method)
get_str() (pikepdf.Object method)
get_stream_buffer() (pikepdf.Object method)
(pikepdf.PdfImage method)
get_warnings() (pikepdf.Pdf method)
get_widget_annotations_for_page() (pikepdf.AcroForm method)
get_xref_table() (pikepdf.Pdf method)
GoToAction (class in pikepdf.models.actions)
GoToDpAction (class in pikepdf.models.actions)
GoToEAction (class in pikepdf.models.actions)
GoToRAction (class in pikepdf.models.actions)
H
handle_eof() (pikepdf.StreamParser method)
handle_object() (pikepdf.StreamParser method)
handle_token() (pikepdf.TokenFilter method)
has_warnings (pikepdf.Job property)
height (pikepdf.PdfImage property)
(pikepdf.Rectangle property)
Helvetica (class in pikepdf.canvas)
HifiPrintImageNotTranscodableError
horiz_scale() (pikepdf.canvas.Text method)
I
icc (pikepdf.PdfImage property)
identity() (pikepdf.Matrix class method)
ignore_max_length (pikepdf.form.Form attribute)
iimage (pikepdf.ContentStreamInlineImage property)
image (pikepdf.canvas.LoadedImage attribute)
image_mask (pikepdf.PdfImage property)
ImageDecompressionError
images (pikepdf.Object property)
(pikepdf.Page property)
implicit_conversion() (in module pikepdf)
index (pikepdf.Page property)
index() (pikepdf._core.PageList method)
(pikepdf.Object method)
indexed (pikepdf.PdfImage property)
inline (pikepdf.JSONStreamData attribute)
inline_image (pikepdf.TokenType attribute)
inlineimage (pikepdf.ObjectType attribute)
input() (pikepdf.JobBuilder method)
insert() (pikepdf._core._ObjectList method)
(pikepdf._core.PageList method)
(pikepdf.Object method)
Integer (class in pikepdf)
integer (pikepdf.ObjectType attribute)
(pikepdf.TokenType attribute)
interpolation_removed (pikepdf.pdfa.PrepareResult attribute)
invalidate_cache() (pikepdf.AcroForm method)
InvalidPdfImageError
inverse() (pikepdf.Matrix method)
is_checkbox (pikepdf.AcroFormField property)
is_checked (pikepdf.AcroFormField property)
is_choice (pikepdf.AcroFormField property)
is_closed (pikepdf.models.OutlineItem attribute)
is_combed (pikepdf.form.TextField property)
is_combobox (pikepdf.form.ChoiceField property)
is_device_n (pikepdf.PdfImage property)
is_encrypted (pikepdf.Pdf property)
is_file_select (pikepdf.form.TextField property)
is_hidden (pikepdf.form.ChoiceFieldOption property)
is_indirect (pikepdf.Object property)
is_linearized (pikepdf.Pdf property)
is_map (pikepdf.models.actions.URIAction property)
is_multiline (pikepdf.form.TextField property)
is_multiselect (pikepdf.form.ChoiceField property)
is_null (pikepdf.AcroFormField property)
is_owned_by() (pikepdf.Object method)
is_password (pikepdf.form.TextField property)
is_preset (pikepdf.form.ChoiceFieldOption property)
is_pushbutton (pikepdf.AcroFormField property)
is_radio_button (pikepdf.AcroFormField property)
is_read_only (pikepdf.form._FieldWrapper property)
is_rectangle (pikepdf.Object property)
is_required (pikepdf.form._FieldWrapper property)
is_rich_text (pikepdf.form.TextField property)
is_same_object_as() (pikepdf.Object method)
is_separation (pikepdf.PdfImage property)
is_text (pikepdf.AcroFormField property)
italic (pikepdf.models.OutlineItem property)
Italic (pikepdf.OutlineItemFlag attribute)
items() (pikepdf.form.Form method)
(pikepdf.Object method)
J
javascript (pikepdf.models.actions.JavaScriptAction property)
JavaScriptAction (class in pikepdf.models.actions)
Job (class in pikepdf)
job_json_schema() (pikepdf.Job static method)
JobBuilder (class in pikepdf)
JobUsageError
json_out_schema() (pikepdf.Job static method)
JSONStreamData (class in pikepdf)
K
keys() (pikepdf.Object method)
kind (pikepdf.ContentScope attribute)
(pikepdf.pdfa.Finding attribute)
L
label (pikepdf.Page property)
LATEST_JOB_JSON (pikepdf.Job attribute)
LATEST_JSON (pikepdf.Job attribute)
LaunchAction (class in pikepdf.models.actions)
layers (pikepdf.PageCopyResult attribute)
layers_added (pikepdf.PageCopyResult attribute)
leading (pikepdf.canvas.SimpleFont property)
left (pikepdf.Destination attribute)
limits() (pikepdf.JobBuilder method)
line() (pikepdf.canvas._CanvasAccessor method)
(pikepdf.canvas.ContentStreamBuilder method)
line_width() (pikepdf.canvas._CanvasAccessor method)
linearize() (pikepdf.JobBuilder method)
llx (pikepdf.Rectangle attribute)
lly (pikepdf.Rectangle attribute)
load() (pikepdf.canvas.SimpleFont class method)
load_from_docinfo() (pikepdf.models.PdfMetadata method)
LoadedImage (class in pikepdf.canvas)
lock() (pikepdf.Pdf method)
lower_left (pikepdf.Rectangle property)
lower_right (pikepdf.Rectangle property)
LTR (pikepdf.canvas.TextDirection attribute)
M
MAIN_COLORSPACES (pikepdf.PdfImage attribute)
make_indirect() (pikepdf.Pdf method)
make_page_destination() (in module pikepdf)
make_stream() (pikepdf.Pdf method)
mapping_name (pikepdf.AcroFormField property)
mark (pikepdf.models.PdfMetadata attribute)
Matrix (class in pikepdf)
MatrixStack (class in pikepdf.models.ctm)
MAX_IMAGE_PIXELS (pikepdf.PdfImage attribute)
max_length (pikepdf.form.TextField property)
md5 (pikepdf._core.AttachedFile property)
mediabox (pikepdf.Page property)
message (pikepdf.pdfa.Finding attribute)
message_prefix (pikepdf.Job property)
messages() (pikepdf.pdfa.PrepareResult method)
metadata (pikepdf.Encryption attribute)
(pikepdf.models.Encryption attribute)
mime_type (pikepdf._core.AttachedFile attribute)
min_version() (pikepdf.JobBuilder method)
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)
module
pikepdf.form
pikepdf.pdfa
pikepdf.sanitize
move_cursor() (pikepdf.canvas.ContentStreamBuilder method)
(pikepdf.canvas.Text method)
move_cursor_new_line() (pikepdf.canvas.ContentStreamBuilder method)
N
Name (class in pikepdf)
name (pikepdf.canvas.LoadedImage attribute)
(pikepdf.models.actions.NamedAction property)
name_ (pikepdf.ObjectType attribute)
(pikepdf.TokenType attribute)
named_dests_added (pikepdf.PageCopyResult attribute)
NamedAction (class in pikepdf.models.actions)
NamePath (class in pikepdf)
NameTree (class in pikepdf)
needs_appearances (pikepdf.AcroForm property)
new() (pikepdf.NameTree static method)
(pikepdf.NumberTree static method)
(pikepdf.Pdf class method)
new_window (pikepdf.models.actions.GoToEAction property)
(pikepdf.models.actions.GoToRAction property)
(pikepdf.models.actions.LaunchAction property)
next (pikepdf.models.actions.Action property)
none (pikepdf.JSONStreamData attribute)
(pikepdf.models.EncryptionMethod attribute)
NONE (pikepdf.OutlineItemFlag attribute)
none (pikepdf.StreamDecodeLevel attribute)
normalize_content() (pikepdf.JobBuilder method)
NotExtractableError
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.models.actions.Action attribute)
(pikepdf.models.OutlineItem attribute)
(pikepdf.NameTree property)
(pikepdf.NumberTree property)
(pikepdf.ObjectHelper property)
(pikepdf.Page property)
(pikepdf.PdfImage attribute)
obj_stream_index (pikepdf.XrefEntry property)
obj_stream_number (pikepdf.XrefEntry property)
Object (class in pikepdf)
object_type (pikepdf.Boolean attribute)
(pikepdf.Integer attribute)
(pikepdf.Real attribute)
ObjectHelper (class in pikepdf)
objects (pikepdf.Pdf property)
ObjectSet (class in pikepdf)
ObjectStreamMode (class in pikepdf)
ObjectType (class in pikepdf)
objgen (pikepdf.Object property)
offset (pikepdf.XrefEntry property)
on_value (pikepdf.form.CheckboxField property)
(pikepdf.form.RadioButtonOption 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)
optimize_images() (pikepdf.JobBuilder method)
options (pikepdf.form.ChoiceField property)
(pikepdf.form.RadioButtonGroup property)
Outline (class in pikepdf.models)
outline_items_added (pikepdf.PageCopyResult attribute)
outline_items_dropped (pikepdf.PageCopyResult attribute)
OutlineItem (class in pikepdf.models)
OutlineItemFlag (class in pikepdf)
outlines (pikepdf.PageCopyResult attribute)
OutlineStructureError
output() (pikepdf.JobBuilder method)
output_intent (pikepdf.pdfa.PrepareResult attribute)
(pikepdf.pdfa.Report attribute)
output_intent_replaced (pikepdf.pdfa.PrepareResult attribute)
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)
page (pikepdf.ContentScope attribute)
(pikepdf.Destination attribute)
page_location (pikepdf.models.OutlineItem attribute)
page_location_kwargs (pikepdf.models.OutlineItem attribute)
page_size (pikepdf.canvas.Canvas attribute)
PageCopyResult (class in pikepdf)
PageCopyWarning
PageList (class in pikepdf._core)
PageLocation (class in pikepdf)
pages (pikepdf.Pdf property)
pages_added (pikepdf.PageCopyResult attribute)
palette (pikepdf.PdfImage property)
parent (pikepdf.AcroFormField property)
parse() (pikepdf.Object static method)
parse_content_stream() (in module pikepdf)
parse_contents() (pikepdf.Page method)
parsed_action (pikepdf.models.OutlineItem property)
part (pikepdf.pdfa.Flavour property)
partial_fields (pikepdf.PageCopyResult attribute)
partial_name (pikepdf.AcroFormField property)
passed (pikepdf.pdfa.Report property)
PasswordError
Pdf (class in pikepdf)
pdf (pikepdf.form.AppearanceStreamGenerator attribute)
pdf_version (pikepdf.Pdf property)
PDFA_1B (pikepdf.pdfa.Flavour attribute)
PDFA_2B (pikepdf.pdfa.Flavour attribute)
PDFA_3B (pikepdf.pdfa.Flavour attribute)
pdfa_declared (pikepdf.pdfa.PrepareResult attribute)
pdfa_status (pikepdf.models.PdfMetadata property)
PdfaError
PdfError
PdfImage (class in pikepdf)
PdfInlineImage (class in pikepdf)
PdfMetadata (class in pikepdf.models)
PdfParsingError
pdfx_status (pikepdf.models.PdfMetadata property)
Permissions (class in pikepdf)
pikepdf.DecompressionBombError
pikepdf.DecompressionBombWarning
pikepdf.form
module
pikepdf.new()
built-in function
pikepdf.open()
built-in function
pikepdf.pdfa
module
pikepdf.sanitize
module
PikepdfError
PikepdfWarning
pop() (pikepdf._core._ObjectList method)
(pikepdf.canvas._CanvasAccessor method)
(pikepdf.canvas.ContentStreamBuilder method)
(pikepdf.Object method)
prepare() (in module pikepdf.pdfa)
prepared (pikepdf.pdfa.Report attribute)
PrepareResult (class in pikepdf.pdfa)
preserve (pikepdf.ObjectStreamMode attribute)
preserve_rb (pikepdf.models.actions.SetOCGStateAction property)
PRINT_COLORSPACES (pikepdf.PdfImage attribute)
print_flags_set (pikepdf.pdfa.AnnotationRepairResult attribute)
(pikepdf.pdfa.PrepareResult attribute)
print_highres (pikepdf.Permissions attribute)
print_lowres (pikepdf.Permissions attribute)
push() (pikepdf.canvas._CanvasAccessor method)
(pikepdf.canvas.ContentStreamBuilder method)
PushbuttonField (class in pikepdf.form)
Python Enhancement Proposals
PEP 20
Q
qdf() (pikepdf.JobBuilder method)
qpdf_limit_errors() (in module pikepdf.settings)
QpdfRuntimeError
quadding (pikepdf.AcroFormField property)
R
R (pikepdf.Encryption attribute)
(pikepdf.models.Encryption attribute)
(pikepdf.models.EncryptionInfo property)
RadioButtonGroup (class in pikepdf.form)
RadioButtonOption (class in pikepdf.form)
random() (pikepdf.Name class method)
raw_value (pikepdf.Token property)
rc4 (pikepdf.models.EncryptionMethod attribute)
read_bytes() (pikepdf._core.AttachedFile method)
(pikepdf.Object method)
(pikepdf.PdfImage method)
read_raw_bytes() (pikepdf.Object method)
Real (class in pikepdf)
real (pikepdf.ObjectType attribute)
(pikepdf.TokenType attribute)
recovered (pikepdf.models.PdfMetadata property)
rect (pikepdf.Annotation property)
rect() (pikepdf.canvas._CanvasAccessor method)
Rectangle (class in pikepdf)
ReferenceCycleError
register() (pikepdf.canvas.Font method)
(pikepdf.canvas.Helvetica method)
(pikepdf.canvas.SimpleFont method)
register_xml_namespace() (pikepdf.models.PdfMetadata class method)
relationship (pikepdf.AttachedFileSpec property)
remove() (pikepdf._core._ObjectList method)
(pikepdf._core.PageList method)
(pikepdf.Object method)
remove_acroform() (pikepdf.JobBuilder method)
remove_attachment() (pikepdf.JobBuilder method)
remove_attachments() (in module pikepdf.sanitize)
(pikepdf.sanitize.Sanitizer method)
remove_collection() (in module pikepdf.sanitize)
(pikepdf.sanitize.Sanitizer method)
remove_external_access() (in module pikepdf.sanitize)
(pikepdf.sanitize.Sanitizer method)
remove_fields() (pikepdf.AcroForm method)
remove_info() (pikepdf.JobBuilder method)
remove_javascript() (in module pikepdf.sanitize)
(pikepdf.sanitize.Sanitizer method)
remove_metadata() (pikepdf.JobBuilder method)
remove_multimedia() (in module pikepdf.sanitize)
(pikepdf.sanitize.Sanitizer method)
remove_page_labels() (pikepdf.JobBuilder method)
remove_private_app_data() (in module pikepdf.sanitize)
(pikepdf.sanitize.Sanitizer method)
remove_restrictions() (pikepdf.JobBuilder method)
remove_search_index() (in module pikepdf.sanitize)
(pikepdf.sanitize.Sanitizer method)
remove_structure() (pikepdf.JobBuilder method)
remove_thumbnails() (in module pikepdf.sanitize)
(pikepdf.sanitize.Sanitizer method)
remove_unreferenced_resources() (pikepdf.Page method)
(pikepdf.Pdf method)
remove_web_capture() (in module pikepdf.sanitize)
(pikepdf.sanitize.Sanitizer method)
removed (pikepdf.pdfa.AnnotationRepairResult attribute)
removed_pages (pikepdf.pdfa.AnnotationRepairResult attribute)
renamed_dests (pikepdf.PageCopyResult attribute)
renamed_fields (pikepdf.PageCopyResult attribute)
render_mode() (pikepdf.canvas.Text method)
repair_annotation_flags() (in module pikepdf.pdfa)
replace_input() (pikepdf.JobBuilder method)
Report (class in pikepdf.pdfa)
report (pikepdf.pdfa.PdfaError attribute)
reserved (pikepdf.ObjectType attribute)
resolve_destination() (pikepdf.models.actions.GoToAction method)
resolve_save_kwargs() (in module pikepdf.pdfa)
resolved_destination() (pikepdf.models.OutlineItem method)
resources (pikepdf.ContentScope attribute)
(pikepdf.Page property)
reverse() (pikepdf._core.PageList method)
(pikepdf.Object method)
REVERSE_NS (pikepdf.models.PdfMetadata attribute)
right (pikepdf.Destination attribute)
root (pikepdf.models.Outline property)
Root (pikepdf.Pdf property)
root (pikepdf.Pdf property)
rotate() (pikepdf.JobBuilder method)
(pikepdf.Page method)
rotated() (pikepdf.Matrix method)
rotation (pikepdf.Page property)
RTL (pikepdf.canvas.TextDirection attribute)
rule (pikepdf.pdfa.Finding attribute)
run() (pikepdf.Job method)
(pikepdf.JobBuilder method)
S
same_owner_as() (pikepdf.Object method)
Sanitizer (class in pikepdf.sanitize)
save() (in module pikepdf.pdfa)
(pikepdf.Pdf method)
save_kwargs (pikepdf.pdfa.Report attribute)
save_state() (pikepdf.canvas._CanvasAccessor method)
scaled() (pikepdf.Matrix method)
scrolling_enabled (pikepdf.form.TextField property)
select() (pikepdf.form.ChoiceFieldOption method)
(pikepdf.form.RadioButtonOption method)
selected (pikepdf.form.ChoiceField property)
(pikepdf.form.ChoiceFieldOption property)
(pikepdf.form.RadioButtonGroup property)
set() (pikepdf.JobBuilder method)
set_dashes() (pikepdf.canvas.ContentStreamBuilder method)
set_decimal_precision() (in module pikepdf.settings)
set_field_name() (pikepdf.AcroForm method)
set_fill_color() (pikepdf.canvas.ContentStreamBuilder method)
set_flate_compression_level() (in module pikepdf.settings)
set_line_width() (pikepdf.canvas.ContentStreamBuilder method)
set_object_conversion_mode() (in module pikepdf)
set_page_labels() (pikepdf.JobBuilder method)
set_qpdf_limits() (in module pikepdf.settings)
set_stroke_color() (pikepdf.canvas.ContentStreamBuilder method)
set_text_char_spacing() (pikepdf.canvas.ContentStreamBuilder method)
set_text_font() (pikepdf.canvas.ContentStreamBuilder method)
set_text_horizontal_scaling() (pikepdf.canvas.ContentStreamBuilder method)
set_text_leading() (pikepdf.canvas.ContentStreamBuilder method)
set_text_matrix() (pikepdf.canvas.ContentStreamBuilder method)
set_text_rendering() (pikepdf.canvas.ContentStreamBuilder method)
set_text_word_spacing() (pikepdf.canvas.ContentStreamBuilder method)
set_value() (pikepdf.AcroFormField method)
SetOCGStateAction (class in pikepdf.models.actions)
shorthand (pikepdf.Matrix property)
show() (pikepdf.canvas.Text method)
(pikepdf.PdfImage method)
show_text() (pikepdf.canvas.ContentStreamBuilder method)
show_text_line() (pikepdf.canvas.ContentStreamBuilder method)
show_text_line_with_spacing() (pikepdf.canvas.ContentStreamBuilder method)
show_text_with_kerning() (pikepdf.canvas.ContentStreamBuilder method)
show_xref_table() (pikepdf.Pdf method)
SignatureField (class in pikepdf.form)
SIMPLE_COLORSPACES (pikepdf.PdfImage attribute)
SimpleFont (class in pikepdf.canvas)
size (pikepdf._core.AttachedFile property)
(pikepdf.PdfImage property)
space (pikepdf.TokenType attribute)
specialized (pikepdf.StreamDecodeLevel attribute)
spell_check_enabled (pikepdf.form.ChoiceField property)
(pikepdf.form.TextField property)
split_pages() (pikepdf.JobBuilder method)
stamp_overlay() (pikepdf.form.SignatureField method)
state (pikepdf.models.actions.SetOCGStateAction property)
states (pikepdf.form.CheckboxField property)
(pikepdf.form.RadioButtonGroup property)
(pikepdf.form.RadioButtonOption property)
static_id() (pikepdf.JobBuilder method)
Stream (class in pikepdf)
stream (pikepdf.ObjectType attribute)
stream_dict (pikepdf.Object property)
stream_method (pikepdf.models.EncryptionInfo property)
StreamDecodeLevel (class in pikepdf)
StreamParser (class in pikepdf)
String (class in pikepdf)
string (pikepdf.ObjectType attribute)
(pikepdf.TokenType attribute)
string_method (pikepdf.models.EncryptionInfo property)
stroke_and_close() (pikepdf.canvas.ContentStreamBuilder method)
stroke_color() (pikepdf.canvas._CanvasAccessor method)
structure_destination (pikepdf.models.actions.GoToAction property)
structure_element (pikepdf.models.OutlineItem attribute)
subtype (pikepdf.Annotation property)
(pikepdf.models.actions.Action property)
summary() (pikepdf.pdfa.Report method)
sync_docinfo (pikepdf.models.PdfMetadata attribute)
T
target (pikepdf.models.actions.GoToEAction property)
Text (class in pikepdf.canvas)
text_transform() (pikepdf.canvas.Text method)
text_width() (pikepdf.canvas.Font method)
(pikepdf.canvas.Helvetica method)
(pikepdf.canvas.SimpleFont method)
TextDirection (class in pikepdf.canvas)
TextField (class in pikepdf.form)
title (pikepdf.models.OutlineItem attribute)
to_array() (pikepdf.Destination method)
to_bbox() (pikepdf.Rectangle method)
to_dictionary_object() (pikepdf.models.OutlineItem method)
to_json() (pikepdf.JobBuilder method)
(pikepdf.Object method)
to_json_str() (pikepdf.JobBuilder method)
to_pdf() (pikepdf.canvas.Canvas method)
Token (class in pikepdf)
TokenFilter (class in pikepdf)
TokenType (class in pikepdf)
top (pikepdf.Destination attribute)
top_level_field (pikepdf.AcroFormField property)
trailer (pikepdf.Pdf property)
transform() (pikepdf.Matrix method)
transform_annotations() (pikepdf.AcroForm method)
translated() (pikepdf.Matrix method)
trimbox (pikepdf.Page property)
type (pikepdf.XrefEntry property)
type_ (pikepdf.Token property)
U
unbox() (in module pikepdf)
uninitialized (pikepdf.ObjectType attribute)
unknown (pikepdf.models.EncryptionMethod attribute)
unparse() (pikepdf.Object method)
unparse_content_stream() (in module pikepdf)
unscaled_char_width() (pikepdf.canvas.SimpleFont method)
unsupported (pikepdf.pdfa.Report property)
UnsupportedImageTypeError
update() (pikepdf.Object method)
update_from_qpdf_json() (pikepdf.Pdf method)
upper_left (pikepdf.Rectangle property)
upper_right (pikepdf.Rectangle property)
uri (pikepdf.models.actions.URIAction property)
URIAction (class in pikepdf.models.actions)
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)
validate() (pikepdf.AcroForm method)
validate_written() (in module pikepdf.pdfa)
value (pikepdf.AcroFormField property)
(pikepdf.form.CheckboxField property)
(pikepdf.form.ChoiceField property)
(pikepdf.form.RadioButtonGroup property)
(pikepdf.form.TextField property)
(pikepdf.Token property)
value_as_string (pikepdf.AcroFormField property)
values() (pikepdf.Object method)
verdict (pikepdf.pdfa.Report property)
violations (pikepdf.pdfa.Report property)
W
where (pikepdf.pdfa.Finding attribute)
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)
write_qpdf_json() (pikepdf.Pdf method)
X
xmp_dropped (pikepdf.pdfa.PrepareResult attribute)
xmp_problem (pikepdf.pdfa.PrepareResult attribute)
xmp_unreadable (pikepdf.pdfa.PrepareResult attribute)
XmpTypeWarning
XrefEntry (class in pikepdf)
XYZ (pikepdf.PageLocation attribute)
Z
zoom (pikepdf.Destination attribute)