@wg= ddlZddlZddlmZddlmZddlmZmZmZm Z m Z m Z m Z m Z mZmZddlmZddlmZmZddlmZdd lmZmZmZdd lmZdd lmZ dd lm!Z!m"Z"m#Z#dd lm$Z%ddlm&Z'ddlm(Z)ddlm*Z+ddlm,Z-ddl.m/Z/m0Z0ddl1m2Z2m3Z3m4Z4m5Z5m6Z6m7Z7m8Z8m9Z9m:Z:m;Z;mZ>m?Z?m@Z@mAZAmBZBmCZCmDZDddlEmFZFmGZGddlHmIZIdeJdeKdeeKe edfffdZLGdde6ZMGddZNGdd e eefZOy)!N)abstractmethod)datetime) AnyDictIterableIteratorListMappingOptionalTupleUnioncast) 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) OutlineType PagemodeType)XmpInformationdsizereturn.ch|dkDr tdd|z}|dd}tjd|dS)NzInvalid size in convert_to_intsiz>qr)r!structunpack)r9r:s H/var/www/horilla/myenv/lib/python3.12/site-packages/pypdf/_doc_common.pyconvert_to_intrA^s@ ax;<<+a/A "#A ==q !! $$ceZdZdZddZdedeefdZedeefdZ edeefdZ edeefd Z edeefd Z edeefd Z edeefd Zedeefd ZedeefdZedeefdZedeefdZedeefdZedeefdZedeefdZedeefdZy)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;Nc.tj|yN)r'__init__selfs r@rGzDocumentInformation.__init__us!!$'rBkeycL|j|d}t|tr|SyrF)get isinstancer1)rIrJretvals r@ _get_textzDocumentInformation._get_textxs%#t$ f. /MrBc|jtjrN|jtjxs-|jtjj SdS)z Read-only property accessing the document's title. Returns a ``TextStringObject`` or ``None`` if the title is not specified. N)rLDITITLErO get_objectrHs r@titlezDocumentInformation.title~sPxx! NN288 $ G(:(E(E(G  rBc@|jtjS)z>The "raw" version of title; can return a ``ByteStringObject``.)rLrQrRrHs r@ title_rawzDocumentInformation.title_rawsxx!!rBc@|jtjS)z Read-only property accessing the document's author. Returns a ``TextStringObject`` or ``None`` if the author is not specified. )rOrQAUTHORrHs r@authorzDocumentInformation.authors~~bii((rBc@|jtjS)z?The "raw" version of author; can return a ``ByteStringObject``.)rLrQrXrHs r@ author_rawzDocumentInformation.author_rawsxx ""rBc@|jtjS)z Read-only property accessing the document's subject. Returns a ``TextStringObject`` or ``None`` if the subject is not specified. )rOrQSUBJECTrHs r@subjectzDocumentInformation.subjects~~bjj))rBc@|jtjS)z@The "raw" version of subject; can return a ``ByteStringObject``.)rLrQr]rHs r@ subject_rawzDocumentInformation.subject_rawxx ##rBc@|jtjS)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. )rOrQCREATORrHs r@creatorzDocumentInformation.creators~~bjj))rBc@|jtjS)z@The "raw" version of creator; can return a ``ByteStringObject``.)rLrQrcrHs r@ creator_rawzDocumentInformation.creator_rawrarBc@|jtjS)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. )rOrQPRODUCERrHs r@producerzDocumentInformation.producers~~bkk**rBc@|jtjS)zAThe "raw" version of producer; can return a ``ByteStringObject``.)rLrQrhrHs r@ producer_rawz DocumentInformation.producer_rawsxx $$rBcRt|jtjS)z:Read-only property accessing the document's creation date.)rrOrQ CREATION_DATErHs r@ creation_datez!DocumentInformation.creation_dates"$..1A1A"BCCrBc@|jtjS)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. )rLrQrmrHs r@creation_date_rawz%DocumentInformation.creation_date_rawsxx(())rBcRt|jtjS)z Read-only property accessing the document's modification date. The date and time the document was most recently modified. )rrOrQMOD_DATErHs r@modification_datez%DocumentInformation.modification_dates"$.."=>>rBc@|jtjS)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. )rLrQrrrHs r@modification_date_rawz)DocumentInformation.modification_date_rawsxx $$rB)r;N)__name__ __module__ __qualname____doc__rGstrr rOpropertyrTrVrYr[r^r`rdrfrirkrrnrprsrurBr@rDrDfs (SXc]   x}    "8C="") ))#HSM##*#**$Xc]$$ *# * *$Xc]$$ +(3- + +%hsm%%Dx1DD*8C=**?8H#5??%x}%%rBrDceZdZUdZdZeed<dZee ed<dZ eed<e e de fdZe e defd Ze d eeefdeefd Ze d ed edefdZe e dee fdZe deefdZe deefdZe dVdedeefdedeefdeeeffdZe dee fdZ!dZ"ee#e$ed<defdZ%dede$fdZ&dede'e effdZ(e deeeffdZ)de*fdZ+ dVdee,dfdeedeeeffdZ- dWdee,deeeefd eed!ee#edeeeeff d"Z.d#e defd$Z/d%ee,e fdeeefd ed&ed!e#eddf d'Z0dee,e fded ed!e#eddf d(Z1d ed%ed&eddfd)Z2dXd*edeeeffd+Z3d%ee4eefde#e$fd,Z5e dede6e7e8ffd-Z9e9jtd.edee6e$fddfd/Z9e de;fd0Z< dVd1ee d2eede;fd3Z=e dee*fd4Z>e d edee?efdeefd5Z@d6e$deefd7ZAd8e6deefd9ZBd:ed;ee#eeCede?e fde6fd<ZDd1e dee6fd=ZEe de#e$fd>ZFe de#efd?ZGe deefd@ZHe deeIfdAZJ dYdBedCede e$fdDeeeefd eeddf dEZK dXd6eee$efdFeddfdGZLdHedIedeefdJZMdKedeeeffdLZNe deeOfdMZPe e defdNZQe deeeeffdOZRe deSee#eTffdPZUde#efdQZVdRede#eTfdSZW dZdTeedeeeeTe#eTfffdUZXy)[ PdfDocCommonzm Common functions from PdfWriter and PdfReader objects. This root class is strongly abstracted. FstrictN _encryption _readonlyr;cyrFr|rHs r@ root_objectzPdfDocCommon.root_object rBcyrFr|rHs r@ pdf_headerzPdfDocCommon.pdf_headerrrBindirect_referencecyrFr|rIrs r@rSzPdfDocCommon.get_object  rBindirectobjcyrFr|)rIrrs r@_replace_objectzPdfDocCommon._replace_object rBcyrFr|rHs r@_infozPdfDocCommon._inforrBcjt}|jy|j|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)rDrupdate)rIrNs r@metadatazPdfDocCommon.metadatas.%& ::  djj! rBcyrFr|rHs r@ xmp_metadatazPdfDocCommon.xmp_metadata*rrBincludeexcludecy)z Integration into Jupyter Notebooks. This method returns a dictionary that maps a mime-type to its representation. See https://ipython.readthedocs.io/en/stable/config/integrating.html Nr|)rIrrs r@_repr_mimebundle_zPdfDocCommon._repr_mimebundle_.s rBcV|jjtjd}|y|j }t |t s[t |}t|dr|j|j||S||jttj<|S)zCReturns the existing ViewerPreferences as an overloaded dictionary.Nr) rrLCDVIEWER_PREFERENCESrSrMr3hasattrrrr-)rIos r@viewer_preferenceszPdfDocCommon.viewer_preferences>s    !6!6 = 9 LLN!./!!$Aq./$$Q%9%91=GH  B,A,A!BCrBflattened_pagesc|jr|jddS|j|j|j|jJt |jS)a Calculate the number of pages in this PDF file. Returns: The number of pages of the parsed PDF file. Raises: PdfReadError: if file is encrypted and restrictions prevent this action. /Pages/Count) is_encryptedrr_flattenrlenrHs r@ get_num_pageszPdfDocCommon.get_num_pagesOsb   ##H-h7 7##+ dnn-''3 33t++, ,rB page_numberc|j|j|j|jJd|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. z hint for mypy)rrr)rIrs r@get_pagezPdfDocCommon.get_pagefsH    ' MM$.. )##/@@/##K00rBctt|jddtdtdtt t tfffd d\}}t|tsJd||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;ctt|jdd}|ddk(r|k(r|dfSd|dzfS|z |k\r| k(r dfSd||zfSttt|dD]D\}}tt |j }||\}}||dkr||fcS||fcS|}Ftd) Nrrz/Type/Page/Kidsrz"Unexpectedly cannot find the node.)rintrL enumerater#r'rSr") rrmaidxkidnirrecursive_calltops r@rz6PdfDocCommon._get_page_in_node..recursive_callsc488Ha01BG}'"$8OR!V|#b R'3;7NR"W}$%d;W &FG S+S^^-=>%c2.1=1u#Sy(a4K AB BrBrmypy)rr'rrr r r0rM)rIrrrrrs ` @@r@_get_page_in_nodezPdfDocCommon._get_page_in_nodexs#T%5%5h%?@ C" C(+ C 8I&+ , C2#3* c$ 019691SyrBc"|jS)zu A read-only dictionary which maps names to :class:`Destinations` )_get_named_destinationsrHs r@named_destinationszPdfDocCommon.named_destinationss ++--rBct}tj|jvrt |jtjt rUt t |jtj}|j}tj|vrt |tjt rt t |tj}|j}tj|vr#t t|tj}|St}||ttj<|St|drSt }|j|}||ttj<||ttj<|St|drt }|j|}||jttj<t }|j|}||ttj<||ttj<|S)N _add_object) r#CANAMESrrMr'rrDESTSr-rr)rI named_destnames names_refdests dests_refs r@get_named_dest_rootz PdfDocCommon.get_named_dest_roots ] 88t'' 'J   RXX &(8- )4+;+;BHH+EFE00Ixx5 ZbhhAQ%R-uRXX?!44 88u$!%k5?!CJ&#"-J2D  Z1 2$&E((/I*3E*RXX& '*4E*RXX& 'rBtreerNc|i}|j}tj|vr"tt|tj}nftj |vrTtt |tj }tj|vr!tt|tj}||Stj|vrHtt|tjD]"}|j|j|$|Stj |vrtt |tj }d}|t|krtt||j}|dz }t|tsE ||j}|dz }t|t r d|vr|d}ny|j!||} | | ||<|t|kr|S|j#D]X\} } | j} t| t rd| vr| dj} n?|j!| | } | T| || <Z|S#t$rY|SwxYw)z Retrieve the named destinations present in the document. Args: tree: retval: Returns: A dictionary which maps names to :class:`Destinations`. rr/D)rrrrr2rr'PAKIDSr#rrSrrzrM IndexError_build_destinationitems) rIrrNcatalogrrrrJvaluedestk__v__vals r@rz$PdfDocCommon._get_named_destinationss;" >F&&Gxx7"J(9:W$-wrxx/@A88u$ E"((O:EAc%j.3a 3 3 56Q!#s+!!H//1EQe%56u} %d  ..sE:#"&F3K#c%j.: !JJL 'Snn&c#34s{!$i224 ..sC8#"&F3K ' -"* -sI IIfileobjstackctj}|jtj|Li}|j}g}t j |vr)ttt|t j ny|S|JdvrAttd}|D]'}|j} |j| ||||)|Stfd|Dr|j|||||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/Fieldsc3&K|]}|v ywrFr|).0attrrs r@ z*PdfDocCommon.get_fields..As;$;)FAattributes_dictrrrr ACRO_FORMrr r2r#rS _build_fieldany) rIrrNrrfield_attributesrfieldsffields ` r@ get_fieldszPdfDocCommon.get_fieldss4--/ = M M OP >F&&GE||w&HZ0'",,2GH <M    +tI7F S !!%:JER S  ;*:; ;   dFG5Eu M rBparentcd|vrtt|dSd|vrF|jtt|ddztt|j ddzStt|j ddS)N/TM/Parent./T)rrz_get_qualified_field_namer'rL)rIrs r@rz&PdfDocCommon._get_qualified_field_nameFs F?VE]+ + & ..)6)+<=sFJJtR01 2 VZZb12 2rBrrctfddDry|j}|r$|j|||jdt ||<||j j }|jtjddk(r+|ttj||td<|jtjddk(rqd|vrmtt|dd j||td<d ||dvr||tdjtd nn|jtjddk(rJ|jtj d tj"j$zd k7r g}t|||td<|jtj&iD]f} | j } t| dd jD]} | |vs|j| t|||td<h|jtj d tj"j(zd k7r(d ||dvr||d||dj+d =|j-|||y) Nc3&K|]}|v ywrFr|)rrrs r@rz,PdfDocCommon._build_field..\s;Tt5 ;r)rr r/Chz /_States_/Btnz/APz/Nz/Offr)allr _write_fieldwriter)rrSrLrFTr-Optr#listkeysappendFfFfBitsRadioKids NoToggleToOffindex _check_kids) rIrrNrrrrJrstateskss ` r@rzPdfDocCommon._build_fieldTsp ;]; ; ,,U3    gu.> ? MM$ Els Sk,,779 77255"  &36z"&&7I3JF3K ;/ 0 77255"  'ESL3>SZ%**,-4F3K ;/ 0VC[55s J{34;;Jvv3FF3K ;/ 0WWRWWb) KLLNahtn1134)A a()8C67Js J{34  Kq!BII$;$;;q@fSk+663K ,VC[-E-K-KF-ST 7rBc||vr#t|j|dty|j|tj |vr=|tj D]&}|j }|j||||(yy)Nz already parsed)rrrvrrrrSr)rIrrNrrrs r@rzPdfDocCommon._check_kids~s 5= 11$78H(   T 77d?BGG} =nn&VWe< = rBcXtj}|tjz}|D]}|tjtjfvr&||} |tj k(r,ddddd}|||vrz|j |d|||dn\|tjk(r/ ||tj}|j |d|dn|j |d||dy#t$r||tj}YVwxYw#t$rYwxYw)NButtonTextChoice Signature)r/Txrz/Sig: r) r attributesrrAArrParentTMKeyErrorT) rIrrrfield_attributes_tupler attr_nametypesnames r@rzPdfDocCommon._write_fieldsH!# "%B%M%M%O O + D(.I 255=!)%' + E T{e+  2eE$K6H5I&LMRYY&1$T{2551MMYKr$r":;MMYKr%+b"AB5 ,$1$T{24401   s7AD-C82D8DDDD D)(D)full_qualified_namec Xdtdtttfdtfd}|j}|iSi}|j D]]\}}|j ddk(s|r|j d||<2|j d||t t|d|<_|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, ... r rr;c ||vr|S|dztt|Dcgc]}|j|dzsdc}dzzScc}w)Nrr)rzsum startswith)r rkks r@ indexed_keyz6PdfDocCommon.get_form_text_fields..indexed_keysY#6LRR]]1s75KqLMPQQRSMs AA/FTrz/Vr)rzrrrrrLr)rIrr$ formfieldsffrrs r@get_form_text_fieldsz!PdfDocCommon.get_form_text_fieldss  3 S#X 3 __&  I &,,. RLE5yy5(& % $BuIBG))D/B{4U4[#92>?  R  rBc dtdtdtffd  tt|jj }t|dr tdg}|jd d d k(rQd |vr|d j g}n|jDcgc]"}|j|jd d vr|$}}n|jdd}|D]}|j }|jd d d k(s)d|vs.d |vr||d j gz }J||jDcgc]"}|j|jd d vr|$c}z }|Dcgc]<}t|tr|n'|j|j|j>c}S#t $r}td|d}~wwxYwcc}wcc}wcc}w)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). rrJr;cp||vr||Sd|vr(tt|dj|Sy)Nr)rr'rS)rrJ_get_inheriteds r@r+z._get_inheritedsGcz3xc!%)3y>+D+D+FGrBzField type is invalidNr%zField is not validz/Subtyperz/Widgetz/Pz/Annotsrr|r)r'rzrrrrS Exception ValueErrorr5rLpagesrMr_get_page_number_by_indirect) rIrexcretpkidsr xr+s @r@get_pages_showing_fieldz$PdfDocCommon.get_pages_showing_fields.  0 s s  ?)5+C+C+N+N+PQE >%7 812 2 99Z $ 1u}T{--/0"ZZ//155B3GG 99Wb)D LLNEE*b)Y6T]qy$ 2 2 455%)ZZ  ! 33quuY7KK     !Z( **T>>q?S?STU W  9 ?453 > ?   s*(F+'G5'G 'AG+ G4 GGczd|jvry|jd}t|tr|j}t|tr t |St|t r0 |dd\}}|dd}t|t|}td||Sy#t$r}td|d|d}~wwxYw)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 /OpenActionNrr  OpenActionzInvalid Destination r) rrMbytesdecoderzr4r#r*tupler&r,)rIoapagetyparrayfitr0s r@open_destinationzPdfDocCommon.open_destination$s  0 0 0""=1 b% B b# '+ + K ( DqG c12#uU|,"<s;; D"6rd"SE BCC Ds+.B B:$B55B:rctd)NzNo setter for open_destination)NotImplementedError)rIrs r@r@zPdfDocCommon.open_destinationCs!"BCCrBc"|jS)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_outlinerHs r@outlinezPdfDocCommon.outlineGs  ""rBrrEc|g}|j}tj|vrUtt|tj}t |t r|St|sd|vrtt|d}|j|_ ||S |j|}|r|j|d|vr8g}|jtt|d||r|j|d|vr |Stt|d}{)Nz/Firstz/Next) rCOOUTLINESrr'rMr.r5r_named_destinations_build_outline_itemrrD)rIrrErlines outline_obj sub_outlines r@rDzPdfDocCommon._get_outlinePs ?G&&G{{g%-wr{{/CDeZ0"N'u-(e2C 0%/BD'+'C'C'ED $ <N2248K{+4)+ !!$'7h"H+VNN;/d"($w-8DrBcz|j}tj|vrtd|tjSy)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)rrGTHREADSr)rIrs r@threadszPdfDocCommon.threadsys4 "" ::  wrzz':; ;rBcyrFr|rs r@r/z)PdfDocCommon._get_page_number_by_indirectrrBr<c8|j|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 )r/r)rIr<s r@get_page_numberzPdfDocCommon.get_page_numbers001H1HIIrB destinationc8|j|jS)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 )r/r<)rIrTs r@get_destination_page_numberz(PdfDocCommon.get_destination_page_numbers001A1ABBrBrTr>cd\}}t|ttfs t|trt |dk(s|)t}t ||t jS|dd\}}|dd} t ||t ||S#t$rltd|d|t|jr|jdj}| tn|}t ||t jcYSwxYw)NNNrr )fit_typefit_argszUnknown destination:  )rMr.rzr#rr&r*r?r!rrvrr.r)rIrTr>r<r=tmprs r@rzPdfDocCommon._build_destinations c uz3/ 05+.3u:?}.s<`PQ[^<`s/Frrz /%is_open%)rrrr!r'r-rSDrMr#rrzrI dest_arrayrrvr$rLrrAttributeError)rIrrrT outline_itemaction action_types r@rJz PdfDocCommon._build_outline_itemsl$4!e\ X/E 4<*DJ7Fz62E2G2G+HIKg%1334 _=D$ 01ddlDz dK (225$?L c " D#66433D9DD  \ 225$?L{{"%)G?H %G<;G<?HH H-,H-cBt|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. )rrrrHs r@r.zPdfDocCommon.pagessD.. >>rBcxtt|jDcgc]}t||c}Scc}w)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. )rangerr.page_index2page_label)rIrs r@ page_labelszPdfDocCommon.page_labels,s-9>c$**o8NO1%dA.OOOs7cx tt|jtjS#t $rYywxYw)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-rr PAGE_LAYOUTrrHs r@ page_layoutzPdfDocCommon.page_layout6s5.  D$4$4R^^$DE E  s *- 99c@ |jdS#t$rYywxYw)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)rrrHs r@ page_modezPdfDocCommon.page_modeRs** ##K0 0  s   list_onlyr.inheritc ttjttjttjttj f}|i}|M|j }|jdj}t|ts tdg|_ tj|vr"tt |tj}ntj"|vrd}nd}|dk(r{|D]}||vs||||<tt$|tj"D]B} i} t| t&r| | d<| j} | s- |j(|| |fi| Dy|dk(rft-|j/D]\} } | |vs | || <t1||}|s|j3||jj5|yy#t*$r tdwxYw)a  Prepare the document pages to ease searching 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 /Pagesrrz7Maximum recursion depth reached during page flattening.)r-PG RESOURCESMEDIABOXCROPBOXROTATErrLrSrMr'r!rrTYPErrzrr#r,rRecursionErrorrrrrr)rIrrr.rsrinheritable_page_attributesrtrr<addtrattr_inrpage_objs r@rzPdfDocCommon._flattenls$ r|| $ r{{ # rzz " ryy ! ' # ?G =&&GKK)446Ee%56"#=>>#%D 77e S%.)A WWE !AA =3 05=$)$KGDM 0[%.9 dN315D-.oo'% igFF '\"&w}}"7 +%'%*E'N  + "$(:;H&  ' ' 1 **Us )G--Hcleancx|j|j|j|jJt|tr3|j }t|t stdty|}t|ts |jj|}d|cxkrt|jksntdty|j|j}|j|=|r||j|t!yyy#t$rtdtYywxYw)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)rrrrMr,rSrrrvrrr-rr.rrr.)rIr<rr2inds r@ remove_pagezPdfDocCommon.remove_pages&    ' MM$.. )##/// dN +!Aa,I8TD$$ ++11$7T5C 4 455 8( C jj11 JJt  S_  jl 3%5 :HE s DD98D9numgenc8t|||jS)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,rS)rIrrs r@_get_indirect_objectz!PdfDocCommon._get_indirect_objectsc3-88::rBpermissions_codec ttdddtjtjtjtj tj tjtjtjd}|jDcic]\}}|||zdk7c}}Scc}}w)z>Take the permissions as an integer, return the allowed access.decode_permissionsuser_access_permissionsz5.0.0)old_namenew_name removed_in)printmodifycopy annotationsforms accessabilityassembleprint_high_qualityr) rrPRINTMODIFYEXTRACT ADD_OR_MODIFYFILL_FORM_FIELDSEXTRACT_TEXT_AND_GRAPHICS ASSEMBLE_DOCPRINT_TO_REPRESENTATIONr)rIrpermissions_mappingrJflags r@rzPdfDocCommon.decode_permissionss #). +00+22)110>>*;;2LL-::"7"O"O  1668 T !D(A- -   sB4cZ|jyt|jjS)zWGet the user access permissions for encrypted documents. Returns None if not encrypted.N)rrPrHs r@rz$PdfDocCommon.user_access_permissions s*    #$T%5%5%7%788rBcy)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|rHs r@rzPdfDocCommon.is_encrypteds rBcd}i}|j}d|vs|dsytt|d}d|vrtt|d}t |}|D]l}|}t |}t |ts!ttt|j}|sItj|j} | ||<n|S)Nz /AcroFormz/XFA)rrr2r#iternextrMr,r r(rSzlib decompress_data) rIrrNrrrrtagress r@xfazPdfDocCommon.xfas%)!#"" g %W[-AJ 45 T>+tF|4FV A )Ga0 *=!> OE!__U[[9&(s  ) rBctt|jDcic]}||j|fc}Scc}wrF)LazyDict_list_attachments_get_attachment_list)rIrs r@ attachmentszPdfDocCommon.attachments5sE!224 t00$77    s5c |j} tttttt|ddd}|Dcgc]}t |t s|}}|S#t$rgcYSwxYwcc}w)zw Retrieves the list of filenames of file attachments. Returns: list of filenames /Names/EmbeddedFiles)rrr#r'rrMrz)rIr filenamesrattachments_namess r@rzPdfDocCommon._list_attachments>s"" $)78+<=>NOI)2H1Z35GQHH   I Hs5A%A6A6% A32A3rcT|j||}t|tr|S|gSrF)_get_attachmentsrMr)rIrouts r@rz!PdfDocCommon._get_attachment_listUs-##D)$/ c4 Ju rBfilenamec |j} tttttt|ddd}i}t t |D]}||}t|ts|||k7r!|}||dzj}|ddj} ||vr1t||ts ||g||<||j| | ||<|S#t$ricYSwxYw)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. rrrz/EFr`) rrr#r'rrjrrMrzrSget_datarr) rIrrrrrrrf_dictf_datas r@rzPdfDocCommon._get_attachments[s$$"" $)78+<=>NOI=? s9~& /A! A!S!'AM"1q5)446t,557;&%k$&7>-8->,? D)%,,V4(.K% /% I s5C&& C43C4rX)NNNN)F)FNNNrF)Yrvrwrxryrbool__annotations__rr rrr{rr'rrzrr rr,r0rSrrrDrr8rrrrrr3rrr rrrr rrr#rr2rrrrrrr(r)r5r&r1r%r@setterr6rErDrPr.r/rSrVr/rrJr.rlror7rqrrrrrrrrr r8rrrrr|rBr@r~r~s FD(,K*%,It  -   C   "'^(;"< )     Y 9   x 01   (#67   h~6  /3.2  tXc]*+  tXc]*+   c3h     H->$?  37OXd:./6-s-.1C1J1$%% $ %%N.DcN.. [ J)- $EJ$%E E c3h EX&*+/!%+/ 0z"0c3h(0# 0 Y( 0 $sCx. ! 0d 30@ 3S 3(8Z!112(8S#X(8 (8  (8 I (8 (8T=J 001== = I =  =&#C##s#t#J%%cSVh%NE 5)^;<E j E N t["24DD E<DU4k:+M%NDSWDD###QU'-.'@H ' 'R+.* "'c:~(M"N #  JJ J8C= J C{ CxPS} CII lND*FVVW  I I@I(8IXk=RIV?tJ'?? PT#YPPXc]68L16 ;?,07; F2F2T+Z78F2$sCx.) F2 %^4 F2  F2V*4C^34*4*4  *4X;;#;(9:M;  # c4i 692G)H99  d  Xd38n-. WS$u+%56  !49!.e)-.  . c5U +,, -.rBr~cZeZdZdededdfdZdedefdZdeefdZde fd Z defd Z y) rargskwr;Nc$t|i||_yrF)dict _raw_dict)rIrrs r@rGzLazyDict.__init__st*r*rBrJcN|jj|\}}||SrF)r __getitem__)rIrJfuncargs r@rzLazyDict.__getitem__s$NN..s3 cCyrBc,t|jSrF)rrrHs r@__iter__zLazyDict.__iter__sDNN##rBc,t|jSrF)rrrHs r@__len__zLazyDict.__len__s4>>""rBc<dt|jdS)NzLazyDict(keys=))rrrHs r@__str__zLazyDict.__str__sTYY[ 12!44rB) rvrwrxrrGrzrrrrrrr|rBr@rrsW+c+++ss$(3-$##55rBr)Pr>rabcrrtypingrrrrr r r r r rrr_pagerr _page_labelsrrk_utilsrrr constantsrrrrrrrrrGrrQrrrrur rerrorsr!r"genericr#r$r%r&r'r(r)r*r+r,r-r.r/r0r1r2r3r4r5rr6r7xmpr8r8rrArDr~rr|rBr@rs>    $+> /. ":6+,,*-%e%3%5eCHo1E+F%L%*L%^TTn$5wsCx 5rB