o Zh @sddlZddlZddlmZddlmZddlmZmZmZm Z m Z m Z m Z m Z mZmZmZddlmZddlmZmZddlmZdd lmZmZmZdd lmZdd lm Z!dd lm"Z"m#Z#m$Z$dd lm%Z&ddlm'Z(ddlm)Z*ddlm+Z,ddlm-Z.ddl/m0Z0m1Z1ddl2m3Z3m4Z4m5Z5m6Z6m7Z7m8Z8m9Z9m:Z:m;Z;mZ>m?Z?m@Z@mAZAmBZBmCZCmDZDmEZEddlFmGZGddlHmIZImJZJddlKmLZLdeMdeNdeeNeedfffddZOGddde7ZPGdd d ZQGd!d"d"e eefZRdS)#N)abstractmethod)datetime) AnyDict GeneratorIterableIteratorListMappingOptionalTupleUnioncast) Encryption) PageObject _VirtualList) index2label)deprecate_with_replacementlogger_warningparse_iso8824_date)CatalogAttributes)CatalogDictionary)CheckboxRadioButtonAttributesGoToActionArgumentsUserAccessPermissions)Core)DocumentInformationAttributes)FieldDictionaryAttributes)PageAttributes)PagesAttributes) PdfReadError PyPdfError) ArrayObject BooleanObjectByteStringObject DestinationDictionaryObjectEncodedStreamObjectFieldFit FloatObjectIndirectObject NameObject NullObject NumberObject PdfObjectTextStringObject TreeObjectViewerPreferencescreate_string_objectis_null_or_none) EmbeddedFile) OutlineType PagemodeType)XmpInformationdsizereturn.cCs4|dkrtdd|}|dd}td|dS)NzInvalid size in convert_to_intsiz>qr)r!structunpack)r:r;r@H/var/www/html/lang_env/lib/python3.10/site-packages/pypdf/_doc_common.pyconvert_to_int`s  rBc@seZdZdZd)ddZdedeefddZedeefd d Z edeefd d Z edeefd dZ edeefddZ edeefddZ edeefddZedeefddZedeefddZedeefddZedeefddZedeefddZedeefdd Zedeefd!d"Zedeefd#d$Zedeefd%d&Zedeefd'd(ZdS)*DocumentInformationa A class representing the basic document metadata provided in a PDF File. This class is accessible through :py:class:`PdfReader.metadata`. All text properties of the document metadata have *two* properties, e.g. author and author_raw. The non-raw property will always return a ``TextStringObject``, making it ideal for a case where the metadata is being displayed. The raw property can sometimes return a ``ByteStringObject``, if pypdf was unable to decode the string's text encoding; this requires additional safety in the caller and therefore is not as commonly accessed. r<NcCst|dSN)r'__init__selfr@r@rArEwszDocumentInformation.__init__keycCs0||d}t|tr |St|trt|SdSrD)get isinstancer1r%str)rGrHretvalr@r@rA _get_textzs   zDocumentInformation._get_textcCs,|tjr|tjp|tjSdS)z Read-only property accessing the document's title. Returns a ``TextStringObject`` or ``None`` if the title is not specified. N)rIDITITLErM get_objectrFr@r@rAtitles zDocumentInformation.titlecC |tjS)z>The "raw" version of title; can return a ``ByteStringObject``.)rIrNrOrFr@r@rA title_raw zDocumentInformation.title_rawcCrR)z Read-only property accessing the document's author. Returns a ``TextStringObject`` or ``None`` if the author is not specified. )rMrNAUTHORrFr@r@rAauthor zDocumentInformation.authorcCrR)z?The "raw" version of author; can return a ``ByteStringObject``.)rIrNrUrFr@r@rA author_rawrTzDocumentInformation.author_rawcCrR)z Read-only property accessing the document's subject. Returns a ``TextStringObject`` or ``None`` if the subject is not specified. )rMrNSUBJECTrFr@r@rAsubjectrWzDocumentInformation.subjectcCrR)z@The "raw" version of subject; can return a ``ByteStringObject``.)rIrNrYrFr@r@rA subject_rawrTzDocumentInformation.subject_rawcCrR)ac Read-only property accessing the document's creator. If the document was converted to PDF from another format, this is the name of the application (e.g. OpenOffice) that created the original document from which it was converted. Returns a ``TextStringObject`` or ``None`` if the creator is not specified. )rMrNCREATORrFr@r@rAcreator zDocumentInformation.creatorcCrR)z@The "raw" version of creator; can return a ``ByteStringObject``.)rIrNr\rFr@r@rA creator_rawrTzDocumentInformation.creator_rawcCrR)aI Read-only property accessing the document's producer. If the document was converted to PDF from another format, this is the name of the application (for example, macOS Quartz) that converted it to PDF. Returns a ``TextStringObject`` or ``None`` if the producer is not specified. )rMrNPRODUCERrFr@r@rAproducerr^zDocumentInformation.producercCrR)zAThe "raw" version of producer; can return a ``ByteStringObject``.)rIrNr`rFr@r@rA producer_rawrTz DocumentInformation.producer_rawcCt|tjS)z:Read-only property accessing the document's creation date.)rrMrN CREATION_DATErFr@r@rA creation_datesz!DocumentInformation.creation_datecCrR)z The "raw" version of creation date; can return a ``ByteStringObject``. Typically in the format ``D:YYYYMMDDhhmmss[+Z-]hh'mm`` where the suffix is the offset from UTC. )rIrNrdrFr@r@rAcreation_date_rawrWz%DocumentInformation.creation_date_rawcCrc)z Read-only property accessing the document's modification date. The date and time the document was most recently modified. )rrMrNMOD_DATErFr@r@rAmodification_datesz%DocumentInformation.modification_datecCrR)z The "raw" version of modification date; can return a ``ByteStringObject``. Typically in the format ``D:YYYYMMDDhhmmss[+Z-]hh'mm`` where the suffix is the offset from UTC. )rIrNrgrFr@r@rAmodification_date_raws z)DocumentInformation.modification_date_rawcCrR)z Read-only property accessing the document's keywords. Returns a ``TextStringObject`` or ``None`` if keywords are not specified. )rMrNKEYWORDSrFr@r@rAkeywordsrWzDocumentInformation.keywordscCrR)zAThe "raw" version of keywords; can return a ``ByteStringObject``.)rIrNrjrFr@r@rA keywords_rawrTz DocumentInformation.keywords_raw)r<N)__name__ __module__ __qualname____doc__rErKr rMpropertyrQrSrVrXrZr[r]r_rarbrrerfrhrirkrlr@r@r@rArChsH         rCc@seZdZUdZdZeed<dZee e ed<dZ ee ed<dZ eed<eedefd d Zeedefd d Zed eeefdeefddZedededefddZeedeefddZedeefddZedeefddZedeefddZ defddZ!dede fdd Z"dede#eeffd!d"Z$ede%ee&ffd#d$Z'de(fd%d&Z)  dd'ee*dfd(ee%ee&fde%ee&ffd)d*Z+    dd'ee*d(ee%e,e,fd+ee,d,ee edee%ee,ff d-d.Z-d/edefd0d1Z.d2ee*efd(e%e,e,fd+e,d3e,d,e eddf d4d5Z/d'ee*efd(e,d+e,d,e eddf d6d7Z0d+e,d2e,d3e,ddfd8d9Z1dd:ede%ee,ffd;d<Z2d2ee3eefde e fd=d>Z4edede&e5e6ffd?d@Z7e7j8dAedee&e fddfdBd@Z7ede9fdCdDZ: ddEeedFee,de9fdGdHZ;edee(fdIdJZdMe deefdNdOZ?dPe&deefdQdRZ@dSedTee eeAede=efde&fdUdVZBdEedee&fdWdXZCede e fdYdZZDede efd[d\ZEedeefd]d^ZFedeeGfd_d`ZH    ddaedbedee fdcee%ee,fd eeddf dddeZI ddMeee efdfeddfdgdhZJdiedjedeefdkdlZKdmede%eeffdndoZLedeeMfdpdqZNeedefdrdsZOedee%ee,ffdtduZPedeQee eRffdvdwZSedeTeUddffdxdyZVde efdzd{ZWd|ede eRfd}d~ZX ddeede%eeeRe eRfffddZYe  ddedeZefdedeZefde%ee,ffddZ[dS) PdfDocCommonzm Common functions from PdfWriter and PdfReader objects. This root class is strongly abstracted. FstrictNflattened_pages _encryption _readonlyr<cCdSrDr@rFr@r@rA root_objectzPdfDocCommon.root_objectcCrwrDr@rFr@r@rA pdf_headerryzPdfDocCommon.pdf_headerindirect_referencecCrwrDr@rGr{r@r@rArP!zPdfDocCommon.get_objectindirectobjcCrwrDr@)rGr~rr@r@rA_replace_object'zPdfDocCommon._replace_objectcCrwrDr@rFr@r@rA_info+ryzPdfDocCommon._infocCs$t}|jdur dS||j|S)a Retrieve the PDF file's document information dictionary, if it exists. Note that some PDF files use metadata streams instead of document information dictionaries, and these metadata streams will not be accessed by this function. N)rCrupdate)rGrLr@r@rAmetadata0s   zPdfDocCommon.metadatacCrwrDr@rFr@r@rA xmp_metadata?rzPdfDocCommon.xmp_metadatacCsf|jtjd}|durdS|}t|ts1t|}t|dr)||j ||S||jt tj<|S)zCReturns the existing ViewerPreferences as an overloaded dictionary.Nr{) rxrICDZVIEWER_PREFERENCESrPrJr3hasattrrr{r-)rGor@r@rAviewer_preferencesCs  zPdfDocCommon.viewer_preferencescCsB|jr |jddS|jdur||j|jdusJt|jS)z Calculate the number of pages in this PDF file. Returns: The number of pages of the parsed PDF file. Raises: PdfReadError: If restrictions prevent this action. /Pages/CountN) is_encryptedrxrt_flattenrvlenrFr@r@rA get_num_pagesRs    zPdfDocCommon.get_num_pages page_numbercCs2|jdur ||j|jdusJd|j|S)a? Retrieve a page by number from this PDF file. Most of the time ``.pages[page_number]`` is preferred. Args: page_number: The page number to retrieve (pages begin at zero) Returns: A :class:`PageObject` instance. Nz hint for mypy)rtrrv)rGrr@r@rAget_pagegs  zPdfDocCommon.get_pagecsbtt|jddtdtdttttfffdd d\}}t|ts-Jd||fS) z Retrieve the node and position within the /Kids containing the page. If page_number is greater than the number of pages, it returns the top node, -1. rnodemir<cstt|dd}|ddkr|kr|dfSd|dfS||kr1|kr+dfSd||fSttt|dD](\}}tt|}||\}}|dur`|dkrZ||fS||fS|}q:td) Nrrz/Type/Page/Kidsrz"Unexpectedly cannot find the node.)rintrI enumerater#r'rPr")rrmaidxkidnirrecursive_calltopr@rArs$      z6PdfDocCommon._get_page_in_node..recursive_callrZmypy)rr'rxrr r r0rJ)rGrrrr@rrA_get_page_in_nodeyszPdfDocCommon._get_page_in_nodecC|S)z8A read-only dictionary which maps names to destinations.)_get_named_destinationsrFr@r@rAnamed_destinationsszPdfDocCommon.named_destinationscCs6t}tj|jvrnt|jtjtrntt|jtj}|j}tj|vrQt|tjtrQtt|tj}|j}tj|vrEtt|tj}|St}||t tj<|St |drlt}| |}||t tj<||t tj<|St |drt}| |}||jt tj<t}| |}||t tj<||t tj<|S)N _add_object) r#CANAMESrxrJr'rr{DESTSr-rr)rGZ named_destnamesZ names_refZdestsZ dests_refr@r@rAget_named_dest_roots<       z PdfDocCommon.get_named_dest_roottreerLcCs|dur1i}|j}tj|vrtt|tj}ntj|vr1tt|tj}tj|vr1tt|tj}|dur7|Stj|vrQtt |tjD] }| | |qD|Stj|vrtt|tj}d}|t |kr|| }|d7}t |ttfsxq`t|}z|| } Wn tyY|Sw|d7}t | trd| vr| d} nq`||| } | dur| ||<|t |ksf|S|D]'\} } | } t | trd| vr| d } nq|| | } | dur| || <q|S)a Retrieve the named destinations present in the document. Args: tree: The current tree. retval: The previously retrieved destinations for nested calls. Returns: A dictionary which maps names to destinations. Nrr/D)rxrrrr2rr'PAKIDSr#rrPrrJbytesrK IndexError_build_destinationitems)rGrrLcatalogrrrZ original_keyrHvaluedestZk__Zv__valr@r@rArsf    #          z$PdfDocCommon._get_named_destinationsfileobjstackc st}|t|dur(i}|j}g}tj|vr&ttt |tjndSdur.|S|dus4JdvrStt d}|D]}| } | | ||||qA|St fdd|Drg| |||||S)a Extract field data if this PDF contains interactive form fields. The *tree*, *retval*, *stack* parameters are for recursive use. Args: tree: Current object to parse. retval: In-progress list of fields. fileobj: A file object (usually a text file) to write a report to on all interactive form fields found. stack: List of already parsed objects. Returns: A dictionary where each key is a field name, and each value is a :class:`Field` object. By default, the mapping name is used for keys. ``None`` if form data could not be located. Nz/Fieldsc3s|]}|vVqdSrDr@.0attrrr@rA =z*PdfDocCommon.get_fields..)FAZattributes_dictrrrxrZ ACRO_FORMrr r2r#rP _build_fieldany) rGrrLrrfield_attributesrfieldsffieldr@rrA get_fieldss*  zPdfDocCommon.get_fieldsparentcCsZd|vr tt|dSd|vr$|tt|ddtt|ddStt|ddS)N/TM/Parent./T)rrK_get_qualified_field_namer'rI)rGrr@r@rArBs z&PdfDocCommon._get_qualified_field_namerrc stfdddDr dS|}|r ||||dt||<||j}|tj ddkrC|t tj ||t d<|tj ddkrxd |vrxt t |d d ||t d<d ||dvrw||t dt d ns|tj ddkr|tjd tjj@d krg}t |||t d<|tjiD]&} | } t | d d D] } | |vr|| qt |||t d<q|tjd tjj@d krd ||dvr||d||dd =||||dS) Nc3s|]}|vVqdSrDr@rrr@rArWrz,PdfDocCommon._build_field..)rr r/Chz /_States_/Btnz/APz/Nz/Offr)allr _write_fieldwriter)r{rPrIrFTr-ZOptr#listkeysappendZFfZFfBitsZRadioKidsZ NoToggleToOffindex _check_kids) rGrrLrrrrHrZstatesksr@rrArOs>   , zPdfDocCommon._build_fieldcCsf||vrt||dtdS||tj|vr/|tjD]}|}|||||q dSdS)Nz already parsed)rrrmrrrrPr)rGrrLrrrr@r@rArys  zPdfDocCommon._check_kidsc Cst}|t}|D]t}|tjtjfvrq ||}z\|tjkr>ddddd}|||vr=||d|||dn8|tjkriz ||tj}Wnt y\||tj }Ynw||d|dn ||d||dWq t yYq wdS)NZButtonTextZChoice Signature)r/Txrz/Sig: r) r attributesrrZAArrZParentZTMKeyErrorT) rGrrrZfield_attributes_tupler attr_nametypesnamer@r@rArsB      zPdfDocCommon._write_fieldfull_qualified_namecCsdtdtttfdtfdd}|}|duriSi}|D]$\}}|ddkrC|r4|d ||<q|d ||tt|d |<q|S) a Retrieve form fields from the document with textual data. Args: full_qualified_name: to get full name Returns: A dictionary. The key is the name of the form field, the value is the content of the field. If the document contains multiple form fields with the same name, the second and following will get the suffix .2, .3, ... rrr<cs2|vrSdttfdd|DdS)Nrc3s"|] }|drdVqdS)rrN) startswith)rkkrr@rArs zIPdfDocCommon.get_form_text_fields..indexed_key..)rKsum)rrr@rrA indexed_keysz6PdfDocCommon.get_form_text_fields..indexed_keyN/FTrz/Vr)rKrrrrrIr)rGrrZ formfieldsffrrr@r@rAget_form_text_fieldss z!PdfDocCommon.get_form_text_fieldsc s&dtdtdtffdd z ttjWnty(}ztd|d}~wwtdr4td g} d d d krUd vrJd g}n@fddj D}n5 dd}|D], d d d krdvrd vr}|d g7}q]|fddj D7}q]fdd|DS)a Provides list of pages where the field is called. Args: field: Field Object, PdfObject or IndirectObject referencing a Field Returns: List of pages: - Empty list: The field has no widgets attached (either hidden field or ancestor field). - Single page list: Page where the widget is present (most common). - Multi-page list: Field with multiple kids widgets (example: radio buttons, field repeated on multiple pages). rrHr<cs4||vr||Sd|vrtt|d|SdS)Nr)rr'rP)rrH)_get_inheritedr@rArsz._get_inheritedzField type is invalidNrzField is not validz/Subtyperz/Widgetz/Pc"g|] }j|ddvr|qSz/Annotsrr{rIrprr@rA  z8PdfDocCommon.get_pages_showing_field..rr@rcrrrrrr@rArrcs,g|]}t|tr |nj|jqSr@)rJrpages_get_page_number_by_indirectr{)rxrFr@rArs ) r'rKrrr{rP Exception ValueErrorr5rIr)rGrexcretZkidsr@)rrrrGrAget_pages_showing_fields:      z$PdfDocCommon.get_pages_showing_fieldc Csd|jvrdS|jd}t|tr|}t|trt|St|trMz|^}}}t|t|}t d||WSt yL}z t d|d|d}~wwdS)z Property to access the opening destination (``/OpenAction`` entry in the PDF catalog). It returns ``None`` if the entry does not exist or is not set. Raises: Exception: If a destination is invalid. z /OpenActionNZ OpenActionzInvalid Destination r) rxrJrdecoderKr4r#r*tupler&r)rGZoapagetyparrayfitrr@r@rAopen_destinations"      zPdfDocCommon.open_destinationrcCstd)NzNo setter for open_destination)NotImplementedError)rGrr@r@rAr;scCr)z Read-only property for the outline present in the document (i.e., a collection of 'outline items' which are also known as 'bookmarks'). ) _get_outlinerFr@r@rAoutline?szPdfDocCommon.outlinerr cCs|dur1g}|j}tj|vr,tt|tj}t|tr|St|s,d|vr,tt|d}||_ |dur7|S | |}|rD| |d|vr\g}| tt|d||r\| |d|vrc |Stt|d}q8)Nz/FirstTz/Next) rxCOZOUTLINESrr'rJr.r5r_named_destinations_build_outline_itemrr )rGrr rlinesZ outline_objZ sub_outliner@r@rAr Hs4      zPdfDocCommon._get_outlinecCs$|j}tj|vrtd|tjSdS)uN Read-only property for the list of threads. See §12.4.3 from the PDF 1.7 or 2.0 specification. It is an array of dictionaries with "/F" (the first bead in the thread) and "/I" (a thread information dictionary containing information about the thread, such as its title, author, and creation date) properties or None if there are no articles. Since PDF 2.0 it can also contain an indirect reference to a metadata stream containing information about the thread, such as its title, author, and creation date. r#N)rxr ZTHREADSr)rGrr@r@rAthreadsqs zPdfDocCommon.threadscCrwrDr@r|r@r@rArr}z)PdfDocCommon._get_page_number_by_indirectrcC ||jS)a Retrieve page number of a given PageObject. Args: page: The page to get page number. Should be an instance of :class:`PageObject` Returns: The page number or None if page is not found )rr{)rGrr@r@rAget_page_numbers zPdfDocCommon.get_page_number destinationcCr)z Retrieve page number of a given Destination object. Args: destination: The destination to get page number. Returns: The page number or None if page is not found )rr)rGrr@r@rAget_destination_page_numbers z(PdfDocCommon.get_destination_page_numberrQrcCsd\}}t|ttfst|trt|dks|dur%t}t||tS|^}}}z t||t||dWStydt d|d|t |j rK|j dj }|durXtn|}t||tYSw)NNNr)Zfit_typeZfit_argszUnknown destination:  )rJr.rKr#rr&r*rr!rrmrsrr{)rGrQrrrtmpr{r@r@rArs(     zPdfDocCommon._build_destinationcCsd\}}}z td|d}Wnty#|jrtd|d}Ynwd|vrQtt|d}tt|tj}|dkrPtj|vrF|tj}n |jrPtd|nd |vrf|d }t |trfd |vrf|d }t |t rr| ||}nEt |t rz | ||j |j}Wn3ty| |d}Yn%w|dur| ||}n|jrtd |td |d t| |d}|rd|vrt dd|dD|td<d|vr|d|td<d|vr|d|td<t|dddk|td<||_z|j|_W|StyY|Sw)N)NNNrKz/Titlez(Outline Entry Missing /Title attribute: rz/Az/GoToz%Outline Action Missing /D attribute: z/DestrzUnexpected destination zRemoved unexpected destination z from destinationz/Ccss|]}t|VqdSrD)r+)rcr@r@rArrz3PdfDocCommon._build_outline_item..z/Frrz /%is_open%)rrrsr!r'r-rSDrJr#rrKr Z dest_arrayrrmr$rIrr{AttributeError)rGrrrQZ outline_itemactionZ action_typer@r@rArst            z PdfDocCommon._build_outline_itemcCst|j|jS)aW Property that emulates a list of :class:`PageObject`. This property allows to get a page or a range of pages. Note: For PdfWriter only: Provides the capability to remove a page/range of page from the list (using the del operator). Remember: Only the page entry is removed, as the objects beneath can be used elsewhere. A solution to completely remove them - if they are not used anywhere - is to write to a buffer/temporary file and then load it into a new PdfWriter. )rrrrFr@r@rArszPdfDocCommon.pagescsfddttjDS)z A list of labels for the pages in this document. This property is read-only. The labels are in the order that the pages appear in the document. csg|]}t|qSr@)page_index2page_label)rrrFr@rAr+sz,PdfDocCommon.page_labels..)rangerrrFr@rFrA page_labels#szPdfDocCommon.page_labelscCs*z tt|jtjWStyYdSw)a Get the page layout currently being used. .. list-table:: Valid ``layout`` values :widths: 50 200 * - /NoLayout - Layout explicitly not specified * - /SinglePage - Show one page at a time * - /OneColumn - Show one column at a time * - /TwoColumnLeft - Show pages in two columns, odd-numbered pages on the left * - /TwoColumnRight - Show pages in two columns, odd-numbered pages on the right * - /TwoPageLeft - Show two pages at a time, odd-numbered pages on the left * - /TwoPageRight - Show two pages at a time, odd-numbered pages on the right N)rr-rxrZ PAGE_LAYOUTrrFr@r@rA page_layout-s  zPdfDocCommon.page_layoutcCs"z|jdWStyYdSw)a2 Get the page mode currently being used. .. list-table:: Valid ``mode`` values :widths: 50 200 * - /UseNone - Do not show outline or thumbnails panels * - /UseOutlines - Show outline (aka bookmarks) panel * - /UseThumbs - Show page thumbnails panel * - /FullScreen - Fullscreen view * - /UseOC - Show Optional Content Group (OCG) panel * - /UseAttachments - Show attachments panel z /PageModeN)rxrrFr@r@rA page_modeIs   zPdfDocCommon.page_mode list_onlyrinheritc Cs~ttjttjttjttjf}|duri}|dur2|j}|d}t |t s/t dg|_ t j|vr@tt|t j}n t j|vrHd}nd}|dkr|D] }||vr\||||<qPtt|t jD],} i} t | trr| | d<| } | rz |j|| |fi| Wqetyt dwqedS|dkr|D] \} } | |vr| || <qt||}|s|||j |dSdS)a Process the document pages to ease searching. Attributes of a page may inherit from ancestor nodes in the page tree. Flattening means moving any inheritance data into descendant nodes, effectively removing the inheritance dependency. Note: It is distinct from another use of "flattening" applied to PDFs. Flattening a PDF also means combining all the contents into one single layer and making the file less editable. Args: list_only: Will only list the pages within _flatten_pages. pages: inherit: indirect_reference: Used recursively to flatten the /Pages object. NrzInvalid object in /Pagesrr{z7Maximum recursion depth reached during page flattening.)r-PGZ RESOURCESZMEDIABOXZCROPBOXZROTATErxrIrPrJr'r!rtrZTYPErrKrr#r,rRecursionErrorrrrr)rGr"rr#r{Zinheritable_page_attributesrtrrZaddtrZattr_inrZpage_objr@r@rArcs`         zPdfDocCommon._flattencleancCs|jdur ||j|jdusJt|tr)|}t|ts'tdtdS|}t|t sFz|j |}Wnt yEtdtYdSwd|krSt |jks[ntdtdS|j |j}|j |=|rt|durv||tdSdSdS)a Remove page from pages list. Args: page: * :class:`int`: Page number to be removed. * :class:`~pypdf._page.PageObject`: page to be removed. If the page appears many times only the first one will be removed. * :class:`~pypdf.generic.IndirectObject`: Reference to page to be removed. clean: replace PageObject with NullObject to prevent annotations or destinations to reference a detached page. Nz(IndirectObject is not referencing a pagezCannot find page in pagesrzPage number is out of range)rtrrvrJr,rPrrrmrrrrrr{rr.)rGrr'rindr@r@rA remove_pages0           zPdfDocCommon.remove_pagenumgencCst|||S)a0 Used to ease development. This is equivalent to generic.IndirectObject(num,gen,self).get_object() Args: num: The object number of the indirect object. gen: The generation number of the indirect object. Returns: A PdfObject )r,rP)rGr*r+r@r@rA_get_indirect_objectsz!PdfDocCommon._get_indirect_objectpermissions_codec sJtddddtjtjtjtjtjtjtjtj d}fdd| DS)z>Take the permissions as an integer, return the allowed access.decode_permissionsuser_access_permissionsz5.0.0)Zold_namenew_nameZ removed_in)printmodifycopy annotationsZformsZ accessabilityassembleZprint_high_qualitycsi|] \}}||@dkqS)rr@)rrHflagr-r@rA s z3PdfDocCommon.decode_permissions..) rrZPRINTZMODIFYZEXTRACTZ ADD_OR_MODIFYZFILL_FORM_FIELDSZEXTRACT_TEXT_AND_GRAPHICSZ ASSEMBLE_DOCZPRINT_TO_REPRESENTATIONr)rGr-Zpermissions_mappingr@r7rAr.s" zPdfDocCommon.decode_permissionscCs|jdurdSt|jjS)zWGet the user access permissions for encrypted documents. Returns None if not encrypted.N)rurPrFr@r@rAr/ s  z$PdfDocCommon.user_access_permissionscCdS)z Read-only boolean property showing whether this PDF file is encrypted. Note that this property, if true, will remain true even after the :meth:`decrypt()` method is called. Nr@rFr@r@rArs zPdfDocCommon.is_encryptedc Csd}i}|j}d|vs|dsdStt|d}d|vrLtt|d}t|}|D]"}|}t|}t|trKttt | }|rKt |j } | ||<q)|S)Nz /AcroFormz/XFA)rxrr2r#iternextrJr,r r(rPzlib decompress_data) rGrrLrrrrtagresr@r@rAxfas&  zPdfDocCommon.xfacstfddDS)z1Mapping of attachment filenames to their content.csi|]}|j|fqSr@)_get_attachment_list)rrrFr@rAr89s z,PdfDocCommon.attachments..)LazyDict_list_attachmentsrFr@rFrA attachments5s  zPdfDocCommon.attachmentsccst|jEdHdS)zIterable of attachment objects.N)r6_loadrxrFr@r@rAattachment_list?szPdfDocCommon.attachment_listcCs>g}|jD]}||j|j}|jkr|r||q|S)zw Retrieves the list of filenames of file attachments. Returns: list of filenames )rHrralternative_name)rGrentryrr@r@rArEDs   zPdfDocCommon._list_attachmentsrcCs"|||}t|tr|S|gSrD)_get_attachmentsrJr)rGroutr@r@rArCSs z!PdfDocCommon._get_attachment_listfilenamecCsi}|jD]S}t}|j}|dur)||j|hvr(||jkr |jn|}||nq|j|h}|D]'}|dur7q0||vrRt||tsI||g||<|||jq0|j||<q0q|S)a Retrieves all or selected file attachments of the PDF as a dictionary of file names and the file data as a bytestring. Args: filename: If filename is None, then a dictionary of all attachments will be returned, where the key is the filename and the value is the content. Otherwise, a dictionary with just a single key - the filename - and its content will be returned. Returns: dictionary of filename -> Union[bytestring or List[ByteString]] If the filename exists multiple times a list of the different versions will be provided. N) rHsetrIraddrJrrcontent)rGrMrFrJrrIrr@r@rArKYs(     zPdfDocCommon._get_attachmentsincludeexcludecCr:)z Integration into Jupyter Notebooks. This method returns a dictionary that maps a mime-type to its representation. .. seealso:: https://ipython.readthedocs.io/en/stable/config/integrating.html Nr@)rGrQrRr@r@rA_repr_mimebundle_szPdfDocCommon._repr_mimebundle_r)NNNN)F)FNNNrD)\rmrnrorprsbool__annotations__rtr r rrurrvrqrr'rxrKrzr rr,r0rPrrrCrr9rr3rrrr rrr&rr#rr2rrrrrrrrr)rr1r%rsetterr7r r rr.rrrr/rrrrr r8r!rr)r,r.rr/rrBr rrFrr6rHrErCrKrrSr@r@r@rArrs       %%   L  2   *  %&  F    )   M   T  ,     * rrc@sbeZdZdededdfddZdedefdd Zdeefd d Zde fd d Z defddZ dS)rDargskwargsr<NcOst|i||_dSrD)dict _raw_dict)rGrWrXr@r@rArEzLazyDict.__init__rHcCs|j|\}}||SrD)rZ __getitem__)rGrHfuncargr@r@rAr\szLazyDict.__getitem__cC t|jSrD)r;rZrFr@r@rA__iter__ zLazyDict.__iter__cCr_rD)rrZrFr@r@rA__len__razLazyDict.__len__cCsdt|dS)NzLazyDict(keys=))rrrFr@r@rA__str__r[zLazyDict.__str__) rmrnrorrErKr\rr`rrbrdr@r@r@rArDs rD)Sr>r=abcrrtypingrrrrrr r r r r rrurZ_pagerrZ _page_labelsrrZ_utilsrrr constantsrrrrrrrrr rrNrrrr$r rerrorsr!r"Zgenericr#r$r%r&r'r(r)r*r+r,r-r.r/r0r1r2r3r4r5Zgeneric._filesr6rr7r8Zxmpr9rrrBrCrrrDr@r@r@rAsH  4         T  &!