
The single parameter of theĬallback is a reference to the page just appended to the document.ĬloneDocumentFromReader ( reader : PyPDF2._reader.PdfReader, after_page_append : Optional, None ] ] = None ) → None ĭeprecated since version 1.28.0: Use clone_reader_document_root() instead. Signature includes a reference to the appended page The writer’s annotsĪfter_page_append ( Callable, None ]) – Callback function that is invoked after each page is appended to Reader ( PdfReader) – a PdfReader object from which to copy pageĪnnotations to this writer object. Which is invoked after pages are appended to the writer. append_pages_from_reader ( reader : PyPDF2._reader.PdfReader, after_page_append : Optional, None ] ] = None ) → None Ĭopy pages from reader to writer. No border will beĪppendPagesFromReader ( reader : PyPDF2._reader.PdfReader, after_page_append : Optional, None ] ] = None ) → None ĭeprecated since version 1.28.0: Use append_pages_from_reader() instead. , or string in the form "".īorder ( ArrayObject) – if provided, an array describing border-drawing Integers specifying the clickable rectangular area Rect ( Tuple ) – RectangleObject or array of four Pagenum ( int) – index of the page on which to place the URI action. This uses the basic structure of add_link() Parameters Should beĪn instance of PageObject add_uri ( pagenum : int, uri : str, rect : PyPDF2.generic._rectangle.RectangleObject, border : Optional = None ) → None Īdd an URI from a rectangular area to the specified page. Page ( PageObject) – The page to add to the document. The page is usually acquired from a PdfReader SeeĪdd_outline_item_destination ( dest : Union, parent : Union = None ) → PyPDF2.generic._base.IndirectObject add_outline_item_dict ( outline_item : Union, parent : Optional = None ) → PyPDF2.generic._base.IndirectObject add_page ( page : PyPDF2._page.PageObject ) → None Italic ( bool) – Outline item font is italicįit ( str) – The fit of the destination page.

Parent – A reference to a parent outline item to create nestedĬolor ( tuple) – Color of the outline item’s font as a red, green, blue tupleįrom 0.0 to 1.0 or as a Hex String (#RRGGBB) Pagenum ( int) – Page number this outline item will point to. Title ( str) – Title to use for this outline item.
PYTHON PDFWRITER PDF
add_named_destination ( title : str, pagenum : int ) → PyPDF2.generic._base.IndirectObject add_named_destination_object ( dest : PyPDF2.generic._base.PdfObject ) → PyPDF2.generic._base.IndirectObject add_outline ( ) → None add_outline_item ( title: str, pagenum: int, parent: typing.Union = None, color: typing.Optional, str]] = None, bold: bool = False, italic: bool = False, fit: typing_extensions.Literal = '/Fit', *args: typing.Union ) → PyPDF2.generic._base.IndirectObject Īdd an outline item (commonly referred to as a “Bookmark”) to this PDF file. Infos ( dict) – a Python dictionary where each key is a fieldĪnd each value is your new metadata. add_link ( pagenum: int, pagedest: int, rect: PyPDF2.generic._rectangle.RectangleObject, border: typing.Optional = None, fit: typing_extensions.Literal = '/Fit', *args: typing.Union ) → None add_metadata ( infos : Dict ) → None Īdd custom metadata to the output.


add_js ( "this.print() " ) # Example: This will launch the print window when the PDF is opened. add_bookmark ( title: str, pagenum: int, parent: typing.Union = None, color: typing.Optional] = None, bold: bool = False, italic: bool = False, fit: typing_extensions.Literal = '/Fit', *args: typing.Union ) → PyPDF2.generic._base.IndirectObject

PageSizeNotDefinedError – if width and height are not definedĪnd previous page does not exist. Height ( float) – The height of the new page expressed in default Width ( float) – The width of the new page expressed in default user Is specified, use the size of the last page. Section 7.11.3 add_blank_page ( width : Optional = None, height : Optional = None ) → PyPDF2._page.PageObject Īppend a blank page to this PDF file and returns it. add_annotation ( page_number : int, annotation : Dict ) → None add_attachment ( filename : str, data : Union ) → None įilename ( str) – The filename to display. Deprecated since version 1.28.0: Use add_uri() instead.
