U
    c                     @   s  d dl Z d dlZd dlZd dlZd dlZd dlZd dlZd dlZd dlZd dl	Z	d dl
mZ d dlmZmZmZ d dlmZ d dlmZ d dlmZmZmZmZmZmZmZmZmZmZmZm Z m!Z! ddl"m#Z# dd	l$m%Z%m&Z& dd
l'm(Z(m)Z)m*Z* ddl+m,Z, ddl-m.Z.m/Z/m0Z0 ddl1m2Z2m3Z3m4Z4m5Z5m6Z6m7Z7m8Z8m9Z9 ddl:m;Z; ddl:m<Z= ddl:m>Z> ddl:m?Z@ ddl:mAZB ddl:mCZCmDZDmEZEmFZFmGZG ddl:mHZI ddl:mJZJ ddl:mKZL ddl:mMZN ddl:mOZP ddl:mQZQmRZR ddlSmTZTmUZUmVZVmWZWmXZXmYZYmZZZm[Z[m\Z\m]Z]m^Z^m_Z_m`Z`maZambZbmcZcmdZdmeZemfZfmgZgmhZhmiZi ddljmkZkmlZl ddlmmZmmnZnmoZompZpmqZqmrZrmsZs eteuZveDd ZweRdZxG dd dZye eezef eze{ee f ecd d!d"Z|e de_f eze ee}e}e}f ezdf e~e~egd#d$d%ZG d&d' d'eyZdS )(    N)md5)BytesIOFileIOIOBase)Path)TracebackType)IOAnyCallableDequeDictIterableListOptionalPatternTupleTypeUnioncast   )
Encryption)
PageObject_VirtualList)nums_clear_rangenums_insert	nums_next)	PdfReader)_alg33_alg34_alg35)StrByteType
StreamType_get_max_pdf_version_headerb_deprecate_with_replacementdeprecation_bookmarkdeprecation_with_replacementlogger_warning)AnnotationDictionaryAttributes)CatalogAttributes)CatalogDictionary)Core)EncryptionDictAttributes)FieldDictionaryAttributes	FieldFlag"FileSpecificationDictionaryEntriesGoToActionArgumentsInteractiveFormDictEntries)PageAttributes)PageLabelStyle)PagesAttributes)StreamAttributes)TrailerKeys)TypFitArgumentsUserAccessPermissions)PAGE_FITAnnotationBuilderArrayObjectBooleanObjectByteStringObjectContentStreamDecodedStreamObjectDestinationDictionaryObjectFitFloatObjectIndirectObject
NameObject
NullObjectNumberObject	PdfObjectRectangleObjectStreamObjectTextStringObject
TreeObjectcreate_string_object
hex_to_rgb)	PageRangePageRangeSpec)BorderArrayTypeFitType
LayoutTypeOutlineItemTypeOutlineTypePagemodeTypeZoomArgTypeic                   @   s  e Zd ZdZd.eddddZd ddd	Zeee	  ee	 ee
 dd
ddZeedddZejeddddZeedddZd/edeef ee edddZeeef edddZeeef eedddZd0eeeegdf ee eddd Zddd!d"Zd1eee ed#d$d%Zd2eee ed#d&d'Z d3eeee ed)d*d+Z!d4eeee ed)d,d-Z"d5ee ee ed.d/d0Z#eed1d2d3Z$edd4d5Z%edd6d7Z&ee'e dd8d9Z(d6ee) ee) ed:d;d<Z*d7ee) ee) ed:d=d>Z+d8eee)e,j-f  eee)e,j-f  eed?d@dAZ.d9eee)e,j-f  eee)e,j-f  eed?dBdCZ/eede0e1e2f ddDdEZ3e3jedee0ef ddFdGdEZ3eddHdIdJZ4eddHdKdLZ5eeeef ddMdNdOZ6eeeef ddPdQdRZ7d:e8eeegdf  ddSdTdUZ9d;e8eeegdf  ddSdVdWZ:e;fee<eef e=ddXdYdZZ>e;fee<eef e=ddXd[d\Z?e8dd]d^d_Z@e8dd]d`daZAd<edeBef ee<eef  ee ddbdcddZCd=e8eeegdf  ddSdedfZDd>e8eeegdf  ddSdgdhZEdddieFddfee ee eGeHee ee ddjdkdlZIeJddmdndoZKeeLef eMeGeNf dmdpdqZOeJe'e dmdrdsZPeJe'e edtdudvZQeJddmdwdxZRe<eef ddydzd{ZSe<eef ddyd|d}ZTeeUeVeBeWeeXeeYe1eZf
 dd~ddZ[eedddZ\eedddZ]eedddZ^e_dddZ`eUdddZaeeUdddZbe_dddZceUdddZdeUdddZed?edee_f ede_ef ede_ef edee_f edddZfd@eee_f ede_ef edddZgdAeee_ edddZheidddBejede_ef ede_ef edddZkeidddCejee_ edddZleidddDejee_ edddZmdddddendfeedeeef ede_ef ede_ef eeeMe)e)e)f ef  eGeGeoee ed
ddZpdEeeede_ef eeMe)e)e)f  eGeGeqered	ddZsdFeeede_ef eeMe)e)e)f  eGeGeqered	ddZtddddZue1eeeUf ddddZvdGee ee edddZwe0edFddZxdHeee ee edddZyeeedddZzddddZ{ddddÄZ|dIeGddĜddƄZ}dJeGddǜddɄZ~dKeGddĜdd˄ZdLeGddǜdd̈́ZdMeeeeeU ee ddΜddЄZdNeeeeeU ddќddӄZdOeeeeeU eqerddԜddքZdPeeeeeU eqerddԜdd؄ZdZee dddۄZee ddd݄ZeeXef ddޜddZeddޜddZeddޜddZeee dddZejeddޜddZeee dddZejeddޜddZdZee dddZee dddZeddddZeddddZeee dddZejeddddZeee dddZejeddddZee<eef ddddZeeef eddd ZeeLee8f eMeee f dddZdQeee8eLf eedeeMeef eMeeef e'e f edeeMeef eMeeef e'e f eGeee'e eMedf f  ddddZeiddddRee eeLee8f ee ee eGeee'e eMedf f  dd	d
dZeBe<eef e8edddZeeef e<eef e8ddddZedeeeeZf e<eef e8ee dddZeee'eB f ee<eef e8e'e0 dddZee<eef e8e'e0 dddZe0e_dFddZdSe'e0 ee_ef ede_ef ddddZddd d!ZdTe<eef ee ee'e  d"d#d$ZeidddUe<eef ee ee'e  d"d%d&ZdVede8ef dd]d'd(ZdWeeee ee ee dd)d*d+ZdXeeee ee ee dd)d,d-ZdS (Y  	PdfWriterz
    Write a PDF file out, given pages produced by another class.

    Typically data is added from a :class:`PdfReader<pypdf.PdfReader>`.
     N)fileobjreturnc                 C   s   d| _ g | _i | _i | _t }|ttjtdttj	t
dttjt i | || _t }|tdttjdd i | || _t | _| jttjttjttj| ji | | j| _|| _d| _d S )Ns   %PDF-1.3/Pagesr   z	/ProducerZpypdfzutf-16beF)_header_objects_idnum_hash_id_translatedrA   updaterE   PATYPECOUNTrG   KIDSr;   _add_object_pagesrM   codecsBOM_UTF16_BEencode_info_root_objectCOZCATALOGZPAGES_rootrZ   with_as_usage)selfrZ   pagesinfo rs   1/tmp/pip-unpacked-wheel-u_n6aelj/pypdf/_writer.py__init__   sF          zPdfWriter.__init__)r[   c                 C   s
   d| _ | S )z+Store that writer is initialized by 'with'.T)ro   rp   rs   rs   rt   	__enter__   s    zPdfWriter.__enter__)exc_typeexc	tracebackr[   c                 C   s   | j r| | j  dS )zWrite data to the fileobj.N)rZ   write)rp   rx   ry   rz   rs   rs   rt   __exit__   s    zPdfWriter.__exit__c                 C   s   | j S )z
        Header of the PDF document that is written.

        This should be something like ``b'%PDF-1.5'``. It is recommended to set
        the lowest version that supports all features which are used within the
        PDF file.
        r]   rv   rs   rs   rt   
pdf_header   s    	zPdfWriter.pdf_header)
new_headerr[   c                 C   s
   || _ d S Nr}   )rp   r   rs   rs   rt   r~      s    objr[   c                 C   sB   t |dr|jj| kr|jS | j| tt| jd| |_|jS )Nindirect_referencer   )hasattrr   pdfr^   appendrD   lenrp   r   rs   rs   rt   rf      s
    zPdfWriter._add_object)r   idor[   c                 C   sp   |d k	r*|d k	rt dn|}tdt |d k	s6tt|trN| j|d  S |j| kr`t d| j|j	d  S )NzGPlease only set 'indirect_reference'. The 'ido' argument is deprecated.zFThe parameter 'ido' is depreciated and will be removed in pypdf 4.0.0.r   pdf must be self)

ValueErrorwarningswarnDeprecationWarningAssertionError
isinstanceintr^   r   idnum)rp   r   r   rs   rs   rt   
get_object   s"    

zPdfWriter.get_object)r   r[   c                 C   s   t ddd | |S )zQ
        Use :meth:`get_object` instead.

        .. deprecated:: 1.28.0
        	getObjectr   3.0.0)r&   r   )rp   r   rs   rs   rt   r      s    zPdfWriter.getObject)r   r   r[   c                 C   sJ   t |tr|j| kst|j}|| j|d < | j|d  S | j|jd  S )Nr   r   )r   rD   r   r   r   r^   r   )rp   r   r   rs   rs   rt   _replace_object   s    
  zPdfWriter._replace_objectrs   )pageactionexcluded_keysr[   c                 C   s  t t|tj tjkst|}t|}|tjdg7 }z| j	t
|jj |jj= W n tk
rd   Y nX t d|| d|}|jd k	r|jj}t|tr| }t| j|| _| j|ttj< t t| | j}|jd k	st||tj |j t t|tj }t|d |ttj< |S )Nz/StructParentsr   Fr   )r   strrb   rc   rm   ZPAGEr   listPARENTr`   idr   r   r   	Exceptioncloner~   r   rj   r"   rg   rE   rA   r   re   r   rd   rG   )rp   r   r   r   Zpage_orgotherrq   Z
page_countrs   rs   rt   	_add_page  s.    

zPdfWriter._add_pagec              
   C   s   zV| j }tj|kr6| j ttjtt| jd| i ttj	}t
d| j tj |< W n2 tk
r } ztdt| W 5 d }~X Y nX d S )Nr   Tz&set_need_appearances_writer() catch : )rl   r*   Z	ACRO_FORMra   rE   rD   r   r^   r1   ZNeedAppearancesr<   r   loggererrorrepr)rp   catalogZneed_appearancesry   rs   rs   rt   set_need_appearances_writer/  s     
   
z%PdfWriter.set_need_appearances_writer)r   r   r[   c                 C   s   |  |tj|S )a  
        Add a page to this PDF file.

        Recommended for advanced usage including the adequate excluded_keys.

        The page is usually acquired from a :class:`PdfReader<pypdf.PdfReader>`
        instance.

        Args:
            page: The page to add to the document. Should be
                an instance of :class:`PageObject<pypdf._page.PageObject>`
            excluded_keys:

        Returns:
            The added PageObject.
        )r   r   r   rp   r   r   rs   rs   rt   add_pageC  s    zPdfWriter.add_pagec                 C   s   t ddd | ||S )zP
        Use :meth:`add_page` instead.

        .. deprecated:: 1.28.0.
        addPager   r   )r&   r   r   rs   rs   rt   r   Z  s    
zPdfWriter.addPager   )r   indexr   r[   c                    s   |  | fddS )a\  
        Insert a page in this PDF file. The page is usually acquired from a
        :class:`PdfReader<pypdf.PdfReader>` instance.

        Args:
            page: The page to add to the document.
            index: Position at which the page will be inserted.
            excluded_keys:

        Returns:
            The added PageObject.
        c                    s   |   |S r   )insert)Zkidspr   rs   rt   <lambda>y      z'PdfWriter.insert_page.<locals>.<lambda>)r   rp   r   r   r   rs   r   rt   insert_pageg  s    zPdfWriter.insert_pagec                 C   s   t ddd | |||S )zR
        Use :meth:`insert_page` instead.

        .. deprecated:: 1.28.0
        
insertPager   r   )r&   r   r   rs   rs   rt   r   {  s    zPdfWriter.insertPage)page_number
pageNumberr[   c                 C   sr   |dk	r(|dk	rt dtddd |}|dkr@|dkr@t dttttf | | j}tt|t	j
 |  S )z
        Retrieve a page by number from this PDF file.

        Args:
            page_number: The page number to retrieve
                (pages begin at zero)

        Returns:
            The page at the index given by *page_number*
        Nz)Please only use the page_number parameterzget_page(pageNumber)zget_page(page_number)4.0.0zPlease specify the page_number)r   r$   r   r   r   r	   r   rg   r   rb   re   )rp   r   r   rq   rs   rs   rt   get_page  s      zPdfWriter.get_page)r   r[   c                 C   s   t ddd | |S )z`
        Use :code:`writer.pages[page_number]` instead.

        .. deprecated:: 1.28.0
        getPagezwriter.pages[page_number]r   )r&   r   )rp   r   rs   rs   rt   r     s    zPdfWriter.getPagec                 C   s*   t tttf | | j}t|td S )Nz/Count)r   r   r   r	   r   rg   r   rE   )rp   rq   rs   rs   rt   _get_num_pages  s    zPdfWriter._get_num_pagesc                 C   s   t ddd |  S )zX
        Use :code:`len(writer.pages)` instead.

        .. deprecated:: 1.28.0
        getNumPageszlen(writer.pages)r   )r&   r   rv   rs   rs   rt   r     s    zPdfWriter.getNumPagesc                 C   s   t | j| jS )zMProperty that emulates a list of :class:`PageObject<pypdf._page.PageObject>`.)r   r   r   rv   rs   rs   rt   rq     s    zPdfWriter.pages)widthheightr[   c                 C   s   t | ||}| |S )a'  
        Append a blank page to this PDF file and returns it.

        If no page size is specified, use the size of the last page.

        Args:
            width: The width of the new page expressed in default user
                space units.
            height: The height of the new page expressed in default
                user space units.

        Returns:
            The newly appended page

        Raises:
            PageSizeNotDefinedError: if width and height are not defined
                and previous page does not exist.
        )r   create_blank_pager   )rp   r   r   r   rs   rs   rt   add_blank_page  s    zPdfWriter.add_blank_pagec                 C   s   t ddd | ||S )zU
        Use :meth:`add_blank_page` instead.

        .. deprecated:: 1.28.0
        addBlankPager   r   )r&   r   )rp   r   r   rs   rs   rt   r     s    zPdfWriter.addBlankPage)r   r   r   r[   c                 C   sX   |dks |dkr:|   d |kr:| j| }|jj}|jj}t| ||}| || |S )aT  
        Insert a blank page to this PDF file and returns it.

        If no page size is specified, use the size of the last page.

        Args:
            width: The width of the new page expressed in default user
                space units.
            height: The height of the new page expressed in default
                user space units.
            index: Position to add the page.

        Returns:
            The newly appended page

        Raises:
            PageSizeNotDefinedError: if width and height are not defined
                and previous page does not exist.
        Nr   )r   rq   Zmediaboxr   r   r   r   r   )rp   r   r   r   Zoldpager   rs   rs   rt   insert_blank_page  s     
zPdfWriter.insert_blank_pagec                 C   s   t ddd | |||S )zW
        Use :meth:`insertBlankPage` instead.

        .. deprecated:: 1.28.0.
        insertBlankPager   r   )r&   r   )rp   r   r   r   rs   rs   rt   r     s    zPdfWriter.insertBlankPagec              
   C   s   d| j krdS | j d }t|ttfr2tt|S t|trz8|dd \}}|dd }t|t|}td||W S  t	k
r } zt	d| d| W 5 d}~X Y qX ndS dS )z
        Property to access the opening destination (``/OpenAction`` entry in
        the PDF catalog). it returns `None` if the entry does not exist is not
        set.

        Raises:
            Exception: If a destination is invalid
        /OpenActionNr      Z
OpenActionzInvalid Destination : )
rl   r   r   bytesrM   r;   rB   tupler@   r   )rp   Zoar   typarrayfitry   rs   rs   rt   open_destination  s    


(zPdfWriter.open_destination)destr[   c                 C   s   |d kr,z| j d= W q tk
r(   Y qX nnt|trJt|| j td< nPt|trf|j| j td< n4t|trtd|j	d k	r|j	nt
 tj| j td< d S )Nr   ZOpening)rl   KeyErrorr   r   rK   rE   r@   
dest_arrayr   r   rF   r9   rp   r   rs   rs   rt   r   ,  s"    


)
javascriptr[   c              	   C   s   d| j krt | j ttj< tt| j tj }d|krPttdt i|td< tttt|d d }t }|ttj	tdtdtdtdt
| i |ttt  || | dS )a$  
        Add Javascript which will launch upon opening this PDF.

        Args:
            javascript: Your Javascript.

        >>> output.add_js("this.print({bUI:true,bSilent:false,bShrinkToFit:true});")
        # Example: This will launch the print window when the PDF is opened.
        z/Namesz/JavaScriptz/Action/Sz/JSN)rl   rA   rE   CANAMESr   r;   ra   rb   rc   rK   r   rM   r   uuidZuuid4rf   )rp   r   namesZjs_listZjsrs   rs   rt   add_js@  s.    
    	zPdfWriter.add_jsc                 C   s   t ddd | |S )zM
        Use :meth:`add_js` instead.

        .. deprecated:: 1.28.0
        addJSr   r   )r&   r   )rp   r   rs   rs   rt   r   c  s    zPdfWriter.addJS)filenamedatar[   c                 C   s   t  }|| |ttjtdi t }|td|i t }|ttjtdttjt	|ttj
|i t }|ttjtt	||gi t }|td|i | jttj|i dS )a  
        Embed a file inside the PDF.

        Reference:
        https://www.adobe.com/content/dam/Adobe/en/devnet/acrobat/pdfs/PDF32000_2008.pdf
        Section 7.11.3

        Args:
            filename: The filename to display.
            data: The data in the file.
        z/EmbeddedFile/Fz	/Filespecz/EmbeddedFilesN)r?   set_datara   rE   rb   rc   rA   r/   FrM   ZEFr   r   r;   rl   )rp   r   r   Z
file_entryZef_entryZfilespecZembedded_files_names_dictionaryZembedded_files_dictionaryrs   rs   rt   add_attachmentl  s<    
    

zPdfWriter.add_attachment)fnamefdatar[   c                 C   s   t ddd | ||S )zU
        Use :meth:`add_attachment` instead.

        .. deprecated:: 1.28.0
        addAttachmentr   r   )r&   r   )rp   r   r   rs   rs   rt   r     s    zPdfWriter.addAttachment)readerafter_page_appendr[   c                 C   s@   t |j}t|D ](}|j| }| |}t|r|| qdS )a  
        Copy pages from reader to writer. Includes an optional callback
        parameter which is invoked after pages are appended to the writer.

        `append` should be prefered.

        Args:
            reader: a PdfReader object from which to copy page
                annotations to this writer object.  The writer's annots
                will then be updated
            after_page_append:
                Callback function that is invoked after each page is appended to
                the writer. Signature includes a reference to the appended page
                (delegates to append_pages_from_reader). The single parameter of
                the callback is a reference to the page just appended to the
                document.
        N)r   rq   ranger   callable)rp   r   r   Zreader_num_pagesZreader_page_numberZreader_pageZwriter_pagers   rs   rt   append_pages_from_reader  s    


z"PdfWriter.append_pages_from_readerc                 C   s   t ddd | || dS )z_
        Use :meth:`append_pages_from_reader` instead.

        .. deprecated:: 1.28.0
        appendPagesFromReaderr   r   N)r&   r   rp   r   r   rs   rs   rt   r     s    
  zPdfWriter.appendPagesFromReader)r   fieldsflagsr[   c                 C   s  |    tj|kr tdt dS tt|tj D ]}|tj |  }i }tj|kr`|tj }|D ]}|	t
j|kr|	t
jdkr|ttjt|| i |tt
jt|| i |r|tt
jt|i qd|	t
j|krd|tt
jt|| i qdq2dS )a  
        Update the form field values for a given page from a fields dictionary.

        Copy field texts and values from fields to page.
        If the field links to a parent object, add the information to the parent.

        Args:
            page: Page reference from PDF writer where the
                annotations and field data will be updated.
            fields: a Python dictionary of field names (/T) and text
                values (/V)
            flags: An integer (0 to 7). The first bit sets ReadOnly, the
                second bit sets Required, the third bit sets NoExport. See
                PDF Reference Table 8.70 for details.
        z No fields to update on this pageNz/Btn)r   PGANNOTSr'   __name__r   r   r   r   getr-   TZFTra   rE   r(   ZASVrK   ZFfrG   )rp   r   r   r   jZwriter_annotZwriter_parent_annotfieldrs   rs   rt   update_page_form_field_values  sT    




   z'PdfWriter.update_page_form_field_valuesc                 C   s   t ddd | |||S )zd
        Use :meth:`update_page_form_field_values` instead.

        .. deprecated:: 1.28.0
        updatePageFormFieldValuesr   r   )r&   r   )rp   r   r   r   rs   rs   rt   r   :  s      z#PdfWriter.updatePageFormFieldValues)r   r[   c                 C   sZ   t t|jtj | | _| jj| _| j	d| _
|   | j| jtd td< | `dS )a  
        Copy the reader document root to the writer and all sub elements,
        including pages, threads, outlines,... For partial insertion, `append`
        should be considered.

        Args:
            reader: PdfReader from the document root should be copied.
        r\   /KidsN)r   rA   trailerTKROOTr   rl   r   rn   raw_getrg   _flattenflattened_pagesrE   rp   r   rs   rs   rt   clone_reader_document_rootJ  s    	
z$PdfWriter.clone_reader_document_rootc                 C   s   t ddd | | dS )za
        Use :meth:`clone_reader_document_root` instead.

        .. deprecated:: 1.28.0
        cloneReaderDocumentRootr   r   N)r&   r   r   rs   rs   rt   r   \  s      z!PdfWriter.cloneReaderDocumentRoot)rq   inheritr   r[   c                 C   sB  t tjt tjt tjt tjf}|d kr0i }|d krPtt| jd }t	 | _
|d k	s\td}tj|krztt|tj }|dkr|D ]}||kr|| ||< qtt	tt|tj D ].}i }t|tr||d< | j| |f| qnV|dkr>t| D ]\}	}
|	|kr|
||	< qtt| jd|t d< | j
| d S )Nr\   r   /Pagez/Parent)rE   r   Z	RESOURCESZMEDIABOXZCROPBOXZROTATEr   rA   rl   r;   r   r   rb   rc   r   re   r   rD   r   r   r   itemsr   r   )rp   rq   r   r   Zinheritable_page_attributestattrr   ZaddtZattr_invaluers   rs   rt   r   g  s@    



 
zPdfWriter._flattenc                 C   s   |  | |jtj | j| _z|jtj | | _W n t	k
rL   Y nX t
|rtttt| j d D ]}||  qpdS )az  
        Create a copy (clone) of a document from a PDF file reader cloning
        section '/Root' and '/Info' and '/ID' of the pdf.

        Args:
            reader: PDF file reader instance from which the clone
                should be created.
            after_page_append:
                Callback function that is invoked after each page is appended to
                the writer. Signature includes a reference to the appended page
                (delegates to append_pages_from_reader). The single parameter of
                the callback is a reference to the page just appended to the
                document.
        r   N)r   r   r   INFOr   r   rk   ID_IDr   r   r   r;   rA   rg   r   )rp   r   r   r   rs   rs   rt   clone_document_from_reader  s    
 z$PdfWriter.clone_document_from_readerc                 C   s   t ddd | || dS )za
        Use :meth:`clone_document_from_reader` instead.

        .. deprecated:: 1.28.0
        cloneDocumentFromReaderr  r   N)r&   r  r   rs   rs   rt   r    s    
  z!PdfWriter.cloneDocumentFromReaderT)user_passwordowner_password
use_128bitpermissions_flaguser_pwd	owner_pwdr[   c                 C   s  |dk	r(|dk	rt dntd |}|dkr8t d|dk	rx|dk	rRt dn&d}d}tj| d| d	td
 |}|dkr|}|rd}	d}
td}nd}	d}
td}|}tt|||
|}tttt		 
d }tttt 
d }t||f| _|
dkr(t||||\}}n&|
dks6tt||
||||d\}}t }td|ttj< t|	|td< |	dkrt|d |ttj< t|
|ttj< t||ttj< t||ttj< t||ttj< | || _|| _dS )a  
        Encrypt this PDF file with the PDF Standard encryption handler.

        Args:
            user_password: The password which allows for opening
                and reading the PDF file with the restrictions provided.
            owner_password: The password which allows for
                opening the PDF files without any restrictions.  By default,
                the owner password is the same as the user password.
            use_128bit: flag as to whether to use 128bit
                encryption.  When false, 40bit encryption will be used.
                By default, this flag is on.
            permissions_flag: permissions as described in
                TABLE 3.20 of the PDF 1.7 specification. A bit value of 1 means
                the permission is grantend.
                Hence an integer value of -1 will set all flags.
                Bit position 3 is for printing, 4 is for modifying content,
                5 and 6 control annotations, 9 for form fields,
                10 for extraction of text and graphics.
        NzGPlease only set 'user_password'. The 'user_pwd' argument is deprecated.z{Please use 'user_password' instead of 'user_pwd'. The 'user_pwd' argument is deprecated and will be removed in pypdf 4.0.0.zuser_password may not be NonezIThe argument owner_pwd of encrypt is deprecated. Use owner_password only.r  r  F is deprecated as an argument and will be removed in pypdf 4.0.0. Use  insteadmessagecategoryr      g      0@r   g      @utf8Fz	/Standard/V   ) r   r   r   r   r   r=   r   r   r   timerj   digestrandomr;   r  r   r   r   rA   rE   SAZFILTERrG   ZLENGTHEDROUPrf   _encrypt_encrypt_key)rp   r  r  r	  r
  r  r  old_termnew_termr   revZkeylenr  r  ZID_1ZID_2r  keyencryptrs   rs   rt   r%    sh    


zPdfWriter.encrypt)streamr[   c                 C   s   t |dr(d|jkr(td|j dt | js<| | j| _| | j | 	|}| 
||}| | |td| d d S )NmodebzFile <zH> to write to is not in binary mode. It may not be written to correctly.z
startxref
z
%%EOF
)r   r'  r'   namer   rn   rf   rl   _sweep_indirect_references_write_header_write_xref_table_write_trailerr{   r#   )rp   r&  object_positionsxref_locationrs   rs   rt   write_stream  s    


zPdfWriter.write_streamc                 C   s^   d}|dkrt d| dt|ttfr>t|d}d| _d}| | | jrV|  ||fS )a  
        Write the collection of pages added to this object out as a PDF file.

        Args:
            stream: An object to write the file to.  The object can support
                the write method and the tell method, similar to a file object, or
                be a file path, just like the fileobj, just named it stream to keep
                existing workflow.

        Returns:
            A tuple (bool, IO)
        FrY   zOutput(stream=z) is empty.wbT)r   r   r   r   r   ro   r0  close)rp   r&  Zmy_filers   rs   rt   r{   9  s    

zPdfWriter.writec           
      C   s$  g }| | jd  | d t| jD ]\}}| j| }|d k	r(|d }||  | tt|d  d }t| dr|| j	j
krtd|d d d }tddd d	 }| j| | }t|t| jd
 kstt| }	|	d tdt| jd
  }||| | d q(|S )N   
s   %
r   s    0 obj
r  z<ir  r   r         s   
endobj
)r{   r~   	enumerater^   r   tellr#   r   r   r  r   structpackr   r   r   r   r  minwrite_to_stream)
rp   r&  r.  ir   r   r$  Zpack1Zpack2Zmd5_hashrs   rs   rt   r+  W  s(    

zPdfWriter._write_header)r&  r.  r[   c                 C   s|   |  }|d |tdt| jd  d |tddddd	d
 |D ]"}|t|dddd	d qT|S )Ns   xref
z0 r   
r   z0>10 i  z0>5z f 
z n 
)r7  r{   r#   r   r^   )rp   r&  r.  r/  offsetrs   rs   rt   r,  n  s    
  zPdfWriter._write_xref_tablec                 C   s   | d t }|ttjtt| jd ttj	| j
ttj| ji t| drd| j|ttj< t| dr~| j|ttj< ||d  d S )Ns   trailer
r   r  r  )r{   rA   ra   rE   r   ZSIZErG   r   r^   r   rn   r  rk   r   r  r  r  ZENCRYPTr;  )rp   r&  r   rs   rs   rt   r-  w  s     
   

zPdfWriter._write_trailer)infosr[   c                 C   s@   i }t | D ]\}}t||t|< q| | j| dS )z
        Add custom metadata to the output.

        Args:
            infos: a Python dictionary where each key is a field
                and each value is your new metadata.
        N)r   r   rM   rE   r   rk   ra   )rp   r@  argsr$  r  rs   rs   rt   add_metadata  s    zPdfWriter.add_metadatac                 C   s   t ddd | | dS )zS
        Use :meth:`add_metadata` instead.

        .. deprecated:: 1.28.0
        addMetadatarB  r   N)r&   rB  )rp   r@  rs   rs   rt   rC    s    zPdfWriter.addMetadata)rootr[   c                 C   s~  t  }g }d }g }d }|||||f t|rz| \}}}}t|ttfr| D ],\}}	||	|||d k	r~||g ng f qZnNt|t	r|j
| kr| |}t||kr|t| || d d g f t|ttfr*t|tr| | |}g }
|| |kr4| gdd |D  }
|||< |
D ]>}| j|d }|d k	r8| }|d k	r8|| j| < q8q*d S )Nc                 S   s   g | ]}|  qS rs   )
hash_value).0Zgrant_parentrs   rs   rt   
<listcomp>  s    z8PdfWriter._sweep_indirect_references.<locals>.<listcomp>)collectionsdequer   r   popr   r;   rA   r   rD   r   _resolve_indirect_objectr   r   rJ   rf   rE  r_   )rp   rD  stackZ
discoveredparentZgrant_parentsZ	key_or_idr   r$  r  Zupdate_hashesZold_hashr   Zindirect_reference_objrs   rs   rt   r*    sT    





z$PdfWriter._sweep_indirect_references)r   r[   c                 C   s   t |jdr*|jjjr*td|jjj |j| kr8|S |j|}|dkrntd|jj	 d| dt	 t
 }| }|| jkr| j| S |j| krt|jd| | j|< n| || j|< | j| S )a   
        Resolves indirect object to this pdf indirect objects.

        If it is a new object then it is added to self._objects
        and new idnum is given and generation is always 0.

        Args:
            data:

        Returns:
            The resolved indirect object
        r&  zI/O operation on closed file: NzUnable to resolve [r   z], returning NullObject insteadr   )r   r   r&  closedr   r)  r   r'   	__class__r   rF   rE  r_   rD   r   rf   )rp   r   Zreal_objrE  rs   rs   rt   rK    s$    



z"PdfWriter._resolve_indirect_objectc                 C   s0   | j |d }t|d| }| |ks,t|S Nr   r   )r^   r   rD   r   r   )rp   r   r   refrs   rs   rt   get_reference  s    zPdfWriter.get_referencec                 C   s   t ddd | |S )zT
        Use :meth:`get_reference` instead.

        .. deprecated:: 1.28.0
        getReferencerR  r   )r&   rR  r   rs   rs   rt   rS  !  s    zPdfWriter.getReferencec                 C   sz   t j| jkrLtt| jt j }| j|d }t|d| }| |ksvt	n*t }|
i  | |}|| jtt j< |S rP  )rm   OUTLINESrl   r   rL   r^   r   rD   r   r   ra   rf   rE   )rp   outliner   Zoutline_refrs   rs   rt   get_outline_root*  s    

zPdfWriter.get_outline_rootc                 C   s:   t j| jkr tt| jt j }nt }|| jtt j< |S )u   
        The list of threads.

        See §8.3.2 from PDF 1.7 spec.

        Returns:
            An array (possibly empty) of Dictionaries with ``/F`` and
            ``/I`` properties.
        )rm   ZTHREADSrl   r   r;   rE   )rp   threadsrs   rs   rt   get_threads_root9  s
    
zPdfWriter.get_threads_rootc                 C   s   |   S )u   
        Read-only property for the list of threads.

        See §8.3.2 from PDF 1.7 spec.

        Each element is a dictionaries with ``/F`` and ``/I`` keys.
        )rX  rv   rs   rs   rt   rW  K  s    	zPdfWriter.threadsc                 C   s   t ddd |  S )zW
        Use :meth:`get_outline_root` instead.

        .. deprecated:: 1.28.0
        getOutlineRootrV  r   )r&   rV  rv   rs   rs   rt   rY  V  s    zPdfWriter.getOutlineRootc                 C   s"  t j| jkrt| jt j trtt| jt j }|j}t j|krt|t j trtt|t j }|j}t j|krtt|t j }qt }||t	t j< n2t }| 
|}||t	t j< t }||t	t j< nRt }| 
|}|| jt	t j< t }| 
|}||t	t j< t }||t	t j< |S r   )r   r   rl   r   rA   r   r   ZDESTSr;   rE   rf   )rp   r   Z	names_refZdestsZ	dests_refndrs   rs   rt   get_named_dest_root_  s6    
 



zPdfWriter.get_named_dest_rootc                 C   s   t ddd |  S )zZ
        Use :meth:`get_named_dest_root` instead.

        .. deprecated:: 1.28.0
        getNamedDestRootr[  r   )r&   r[  rv   rs   rs   rt   r\    s    zPdfWriter.getNamedDestRoot)page_destinationrM  beforer   r[   c                 C   s   |d k	r|d k	rt d|d k	rFd}d}tj| d| dtd |}|d krVt d|d krf|  }tt| }| |}|d k	r|j	}|
|||  |S )Nz[The argument dest of add_outline_item_destination is deprecated. Use page_destination only.r   r]  r  r  r   page_destination may not be None)r   r   r   r   rV  r   rL   r   rf   r   insert_child)rp   r]  rM  r^  r   r!  r"  page_destination_refrs   rs   rt   add_outline_item_destination  s,    
z&PdfWriter.add_outline_item_destination)r   rM  r[   c                 C   s   t ddd | ||S )zb
        Use :meth:`add_outline_item_destination` instead.

        .. deprecated:: 2.9.0
        add_bookmark_destinationrb  r   r&   rb  rp   r   rM  rs   rs   rt   rc    s    
  z"PdfWriter.add_bookmark_destinationc                 C   s   t ddd | ||S )zc
        Use :meth:`add_outline_item_destination` instead.

        .. deprecated:: 1.28.0
        addBookmarkDestinationrb  r   rd  re  rs   rs   rt   rf    s      z PdfWriter.addBookmarkDestinationoutline_item)bookmark)rg  rM  r^  r[   c           
      C   s   t  }t| D ]\}}||tt|< q|| d|krt }tt|d }t| D ]\}}||tt|< q^| |}	|	|td< | 	|||S )N/A)
rL   r   r   rE   r   ra   rA   r   rf   rb  )
rp   rg  rM  r^  Zoutline_item_objectkvr   Za_dict
action_refrs   rs   rt   add_outline_item_dict  s    

zPdfWriter.add_outline_item_dict)rg  rM  r[   c                 C   s   t ddd | ||S )z[
        Use :meth:`add_outline_item_dict` instead.

        .. deprecated:: 2.9.0
        add_bookmark_dictrm  r   r&   rm  rp   rg  rM  rs   rs   rt   rn    s    	  zPdfWriter.add_bookmark_dictc                 C   s   t ddd | ||S )z\
        Use :meth:`add_outline_item_dict` instead.

        .. deprecated:: 1.28.0
        addBookmarkDictrm  r   ro  rp  rs   rs   rt   rq    s    	  zPdfWriter.addBookmarkDictF)
titler   rM  r^  colorbolditalicr   pagenumr[   c
              
   C   sD  t |tr6|dk	r|dkr|}| |||d||||S |dk	rN|	dk	rNtd|dkr\d}
nt |trl|}nJt |tr~|j}n8t |trz| j| j}W n t	k
r   t
|}Y nX |dkrtd| t t }ttd| d ||}| tttj|jttjtdi}
t|
||||}|dkr6|  }| |||S )a  
        Add an outline item (commonly referred to as a "Bookmark") to the PDF file.

        Args:
            title: Title to use for this outline item.
            page_number: Page number this outline item will point to.
            parent: A reference to a parent outline item to create nested
                outline items.
            before:
            color: Color of the outline item's font as a red, green, blue tuple
                from 0.0 to 1.0 or as a Hex String (#RRGGBB)
            bold: Outline item font is bold
            italic: Outline item font is italic
            fit: The fit of the destination page.

        Returns:
            The added outline item as an indirect object.
        NMThe argument pagenum of add_outline_item is deprecated. Use page_number only.zcan not find reference of page /z outline item/GoTo)r   rB   add_outline_itemr   rD   r   r   r   rq   
IndexErrorrG   r'   r   rF   r@   rE   rf   rA   r0   Dr   S_create_outline_itemrV  rb  )rp   rr  r   rM  r^  rs  rt  ru  r   rv  rl  page_refr   rg  rs   rs   rt   rz    sh    
       


  
zPdfWriter.add_outline_item/Fit)	rr  rv  rM  rs  rt  ru  r   rA  r[   c           	      G   s*   t ddd | ||||||t||dS )zV
        Use :meth:`add_outline_item` instead.

        .. deprecated:: 2.9.0
        add_bookmarkrz  r   Zfit_typefit_argsr&   rz  rB   	rp   rr  rv  rM  rs  rt  ru  r   rA  rs   rs   rt   r  O  s    
zPdfWriter.add_bookmarkc           	      G   s,   t ddd | |||d|||t||dS )zW
        Use :meth:`add_outline_item` instead.

        .. deprecated:: 1.28.0
        addBookmarkrz  r   Nr  r  r  rs   rs   rt   r  j  s    
zPdfWriter.addBookmarkc                 C   s   t dd S )NzIThis method is not yet implemented. Use :meth:`add_outline_item` instead.)NotImplementedErrorrv   rs   rs   rt   add_outline  s    zPdfWriter.add_outline)rr  destinationr[   c                 C   sd   |   }d}|t|k rN||| k rD||| ||t| d S |d7 }q|t||g d S )Nr   r   )r[  r   r   rK   extend)rp   rr  r  rZ  r<  rs   rs   rt   add_named_destination_array  s    
z%PdfWriter.add_named_destination_array)r]  r   r[   c                 C   s|   |d k	r|d k	rt d|d k	rFd}d}tj| d| dtd |}|d krVt d| |j}| td|d	 | |S )
Nz[The argument dest of add_named_destination_object is deprecated. Use page_destination only.r   r]  r  r  r  r_  rK   /Title)r   r   r   r   rf   r   r  r   )rp   r]  r   r!  r"  ra  rs   rs   rt   add_named_destination_object  s(     z&PdfWriter.add_named_destination_objectc                 C   s   t ddd | |S )zc
        Use :meth:`add_named_destination_object` instead.

        .. deprecated:: 1.28.0
        addNamedDestinationObjectr  r   )r&   r  r   rs   rs   rt   r    s      z#PdfWriter.addNamedDestinationObject)rr  r   rv  r[   c           
      C   s   |d k	r|d k	rt d|d k	rFd}d}tj| d| dtd |}|d krVt d| | jtj | }t }|	t
tjt|t
tjtdgt
tjt
d	i | |}|  }	t|tstt|}|	||g |S )
Nrw  rv  r   r  r  r  zpage_number may not be Nonei:  ry  )r   r   r   r   r   rg   rb   re   rA   ra   rE   r0   r|  r;   r7   ZFIT_HrG   r}  rf   r[  r   rK   r   r  )
rp   rr  r   rv  r!  r"  r  r   Zdest_refrZ  rs   rs   rt   add_named_destination  s>      	

zPdfWriter.add_named_destination)rr  rv  r[   c                 C   s   t ddd | ||S )z\
        Use :meth:`add_named_destination` instead.

        .. deprecated:: 1.28.0
        addNamedDestinationr  r   )r&   r  )rp   rr  rv  rs   rs   rt   r    s      zPdfWriter.addNamedDestinationc                 C   sR   t t| | j}t t|tj }|D ]&}t t| |}tj|kr&|tj= q&dS )z.Remove links and annotations from this output.N)	r   rA   r   rg   r;   rb   re   r   r   )rp   pg_dictrq   r   r  rs   rs   rt   remove_links  s    
zPdfWriter.remove_linksc                 C   s   t ddd |  S )zS
        Use :meth:`remove_links` instead.

        .. deprecated:: 1.28.0
        removeLinksr  r   )r&   r  rv   rs   rs   rt   r    s    zPdfWriter.removeLinks)ignore_byte_string_objectr[   c                 C   s  t t| | j}t t|tj }d}|D ]P}t t| |}d|krN dS |d  }t|tsnt||}g }d}	|j	D ]\}
}|dkr|
d }|rt|t
st
 |
d< nn|dkr|
d }|rt|t
st
 |
d< nD|d	krtt|
d D ](}|rt|
d | t
st
 |
d |< q|d
kr*d}	|dkr8d}	|	rJ||krJq||dkrVq|||
|f q|||_	|td| q*dS )z
        Remove images from this output.

        Args:
            ignore_byte_string_object: optional parameter
                to ignore ByteString Objects.
        )s   cm   w   J   j   M   ds   ri   is   gs   W   b   s   S   f   F   n   m   l   c   v   y   h   Bs   Dos   sh	/ContentsNFs   Tj   'r      "r      TJ   qT   Qs   re)r   rA   r   rg   r;   rb   re   r   r>   
operationsrK   r   r   r   __setitem__rE   )rp   r  r  rq   Zjump_operatorsr   r  contentZ_operationsZseq_graphicsoperandsoperatortextr<  rs   rs   rt   remove_images  sZ    


  

 


zPdfWriter.remove_images)ignoreByteStringObjectr[   c                 C   s   t ddd | |S )zT
        Use :meth:`remove_images` instead.

        .. deprecated:: 1.28.0
        removeImagesr  r   )r&   r  rp   r  rs   rs   rt   r  _  s    zPdfWriter.removeImagesc                 C   s  t t| | j}t tt |tj }|D ]N}t t| |}|d  }t	|t
s`t
||}|jD ] \}}|dkr|d }	|st	|	trt |d< nt	|	ttfrt |d< qf|dkr|d }	|st	|	trt |d< nt	|	ttfrt |d< qf|dkrftt|d D ]V}
|s>t	|d |
 trdt |d |
< n&t	|d |
 ttfrt |d |
< qqf|td| q*dS )zx
        Remove text from this output.

        Args:
            ignore_byte_string_object: optional parameter
        r  r  r   r  r   r  N)r   rA   r   rg   r   rD   rb   re   r   r   r>   r  rK   r=   r   r   r  rE   )rp   r  r  rq   r   r  r  r  r  r  r<  rs   rs   rt   remove_texth  sB    





 zPdfWriter.remove_textc                 C   s   t ddd | |S )zR
        Use :meth:`remove_text` instead.

        .. deprecated:: 1.28.0
        
removeTextr  r   )r&   r  r  rs   rs   rt   r    s    zPdfWriter.removeText)r   urirectborderrv  r[   c                 C   s  |dk	rt jdtd |}| | jtj | }ttt	t
f | |}|dk	rdd |dd D }t|dkrtdd |d D }	||	 ntd	td	td	g}t|t	rt|}nt|trnt|}t }
|
td
tdtdt|i t }|ttjttjttjtdttj|ttj|tdtdttjt|td|
i | |}tj|kr|tj | nt|g|ttj< dS )a  
        Add an URI from a rectangular area to the specified page.

        This uses the basic structure of :meth:`add_link`

        Args:
            page_number: index of the page on which to place the URI action.
            uri: URI of resource to link to.
            rect: :class:`RectangleObject<pypdf.generic.RectangleObject>` or
                array of four integers specifying the clickable rectangular area
                ``[xLL, yLL, xUR, yUR]``, or string in the form
                ``"[ xLL yLL xUR yUR ]"``.
            border: if provided, an array describing border-drawing
                properties. See the PDF spec for details. No border will be
                drawn if this argument is omitted.
        NznThe 'pagenum' argument of add_uri is deprecated and will be removed in pypdf 4.0.0. Use 'page_number' instead.)r  c                 S   s   g | ]}t |qS rs   rE   rF  nrs   rs   rt   rG    s     z%PdfWriter.add_uri.<locals>.<listcomp>r     c                 S   s   g | ]}t |qS rs   r  r  rs   rs   rt   rG    s     r   r   z/URI/Linkz/H/Iri  )r   r   r   r   rg   rb   re   r   r   r   r	   r   r;   r   rG   r   rE   rI   rA   ra   rK   r(   r   r   r   ZSubtyper  ZRectZBorderrf   )rp   r   r  r  r  rv  Z	page_linkr  Z
border_arrZdash_patternZlnk2ZlnkZlnk_refrs   rs   rt   add_uri  sf    


         
zPdfWriter.add_uri)rv  r  r  r  r[   c                 C   s   t ddd | ||||S )zN
        Use :meth:`add_uri` instead.

        .. deprecated:: 1.28.0
        addURIr  r   )r&   r  )rp   rv  r  r  r  rs   rs   rt   r    s    zPdfWriter.addURI)rv  r]  r  r  r   rA  r[   c                 G   sz   t dd t|tr>| dd }tdd |dD }nt|trJnt|}tj|||t||dd	}| j	||d
S )Nadd_link+add_annotation(AnnotationBuilder.link(...))r   c                 S   s    g | ]}t |d krt|qS )r   )r   float)rF  numrs   rs   rt   rG  
  s      z&PdfWriter.add_link.<locals>.<listcomp>r>  r  )r  r  target_page_indexr   )r   
annotation)
r&   r   r   striprI   splitr:   linkrB   add_annotation)rp   rv  r]  r  r  r   rA  r  rs   rs   rt   r    s&    	 


zPdfWriter.add_linkc                 G   s$   t ddd | j|||||f| S )zO
        Use :meth:`add_link` instead.

        .. deprecated:: 1.28.0
        addLinkr  r   )r$   r  )rp   rv  r]  r  r  r   rA  rs   rs   rt   r    s      zPdfWriter.addLink)z	/NoLayoutz/SinglePagez
/OneColumnz/TwoColumnLeftz/TwoColumnRightz/TwoPageLeftz/TwoPageRightc                 C   s.   zt t| jd W S  tk
r(   Y d S X d S )N/PageLayout)r   rS   rl   r   rv   rs   rs   rt   _get_page_layout6  s    zPdfWriter._get_page_layoutc                 C   s   t ddd |  S )U
        Use :py:attr:`page_layout` instead.

        .. deprecated:: 1.28.0
        getPageLayoutpage_layoutr   )r&   r  rv   rs   rs   rt   r  <  s    zPdfWriter.getPageLayout)layoutr[   c                 C   sP   t |ts8|| jkr0tddd| jf t t|}| jtd|i dS )a  
        Set the page layout.

        Args:
            layout: The page layout to be used.

        .. list-table:: Valid ``layout`` arguments
           :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
        zLayout should be one of: rY   r  N)r   rE   _valid_layoutsr'   joinr   rl   ra   rp   r  rs   rs   rt   _set_page_layoutE  s    

zPdfWriter._set_page_layoutc                 C   s   |  | dS )a  
        Set the page layout.

        Args:
            layout: The page layout to be used

        .. list-table:: Valid ``layout`` arguments
           :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r  r  rs   rs   rt   set_page_layoutg  s    zPdfWriter.set_page_layoutc                 C   s   t ddd | |S )r  zwriter.setPageLayout(val)zwriter.page_layout = valr   )r&   r  r  rs   rs   rt   setPageLayout  s      zPdfWriter.setPageLayoutc                 C   s   |   S )a  
        Page layout property.

        .. 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
        )r  rv   rs   rs   rt   r    s    zPdfWriter.page_layoutc                 C   s   |  | d S r   r  r  rs   rs   rt   r    s    c                 C   s   t ddd | jS )r  
pageLayoutr  r   r&   r  rv   rs   rs   rt   r    s    zPdfWriter.pageLayoutc                 C   s   t ddd || _dS )r  r  r  r   Nr  r  rs   rs   rt   r    s    )z/UseNonez/UseOutlinesz
/UseThumbsz/FullScreenz/UseOCz/UseAttachmentsc                 C   s.   zt t| jd W S  tk
r(   Y d S X d S )N	/PageMode)r   rV   rl   r   rv   rs   rs   rt   _get_page_mode  s    zPdfWriter._get_page_modec                 C   s   t ddd |  S )S
        Use :py:attr:`page_mode` instead.

        .. deprecated:: 1.28.0
        getPageMode	page_moder   )r&   r  rv   rs   rs   rt   r    s    zPdfWriter.getPageMode)r'  r[   c                 C   sR   t |tr|}n*|| jkr2tdd| j t t|}| jtd|i dS )r  zMode should be one of: z, r  N)r   rE   _valid_modesr'   r  r   rl   ra   )rp   r'  Z	mode_namers   rs   rt   set_page_mode  s    

 zPdfWriter.set_page_modec                 C   s   t ddd | | dS )r  zwriter.setPageMode(val)zwriter.page_mode = valr   N)r&   r  rp   r'  rs   rs   rt   setPageMode  s      zPdfWriter.setPageModec                 C   s   |   S )a  
        Page mode property.

        .. 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
        )r  rv   rs   rs   rt   r    s    zPdfWriter.page_modec                 C   s   |  | d S r   )r  r  rs   rs   rt   r  	  s    c                 C   s   t ddd | jS )r  pageModer  r   r&   r  rv   rs   rs   rt   r  	  s    zPdfWriter.pageModec                 C   s   t ddd || _dS )r  r  r  r   Nr  r  rs   rs   rt   r  	  s    )r   r  r[   c                 C   s   t tt|}| | jd | |td< | j| }|jd krLt |td< |jd k	sZt	|
ddkrtd|krt t|td }ttd|d t|d	 t|d
 d}|j|td< | |}|j| d S )Nr   /P/Annots/Subtyper  /Destz	/LinkNamer  r   r  r  )r   rA   _pdf_objectifyr   rg   rE   rq   annotationsr;   r   r   dictr@   rB   r   rf   r   )rp   r   r  to_addr   tmpr   Zind_objrs   rs   rt   r   	  s&    

 

zPdfWriter.add_annotation)r   r[   c                 C   s   t d| }|dg D ]v}| }|dd}|dd}t|trZt||td< q|dk	r| }|dd}t|trt||td< q|S )z
        Perform some clean up in the page.
        Currently: convert NameObject nameddestination to TextStringObject
        (required for names/dests list)

        Args:
            page:

        Returns:
            The cleaned PageObject
        r   r  r  Nri  /D)r   r   r   r   rE   rK   )rp   r   aZa_objdZactrs   rs   rt   
clean_page9	  s    

zPdfWriter.clean_pagec              	   C   s   d }t |ttfr6t|d}t| }W 5 Q R X nt |tr~|jrL|j}|j	 }|j
d t|j }|j
| n8t|drt|dr|
d | }t|}ntd||fS )Nrbr   seekreadzPdfMerger.merge requires an object that PdfReader can parse. Typically, that is a Path or a string representing a Path, a file object, or an object implementing .seek and .read. Passing a PdfReader directly works as well.)r   r   r   r   r   r  r   _encryptionr&  r7  r  r   r  )rp   rZ   encryption_objfr&  Z	orig_tellZfilecontentrs   rs   rt   _create_streamS	  s&    	



zPdfWriter._create_stream.)rZ   rg  rq   import_outlineexcluded_fieldsr[   c                 C   sj   |dkrd}t |tttfrRt |tr8t |ts4|}|}|}| d|d||| n| d||||| dS )aP  
        Identical to the :meth:`merge()<merge>` method, but assumes you want to
        concatenate all pages onto the end of the file instead of specifying a
        position.

        Args:
            fileobj: A File Object or an object that supports the standard
                read and seek methods similar to a File Object. Could also be a
                string representing a path to a PDF file.
            outline_item: Optionally, you may specify a string to build an
                outline (aka 'bookmark') to identify the beginning of the
                included file.
            pages: Can be a :class:`PageRange<pypdf.pagerange.PageRange>`
                or a ``(start, stop[, step])`` tuple
                or a list of pages to be processed
                to merge only the specified range of pages from the source
                document into the output document.
            import_outline: You may prevent the source document's
                outline (collection of outline items, previously referred to as
                'bookmarks') from being imported by specifying this as ``False``.
            excluded_fields: Provide the list of fields/keys to be ignored
                if ``/Annots`` is part of the list, the annotation will be ignored
                if ``/B`` is part of the list, the articles will be ignored
        Nrs   )r   r   r   rO   boolmerge)rp   rZ   rg  rq   r  r  rs   rs   rt   r   w	  s0    $

	zPdfWriter.appendr  )rh  Zimport_bookmarks)positionrZ   rg  rq   r  r  r[   c              	   C   s  t |tr|}n| |\}}	t|dd}|dkr6d}|dkrTttdt|j}nft |trxtt|t|j }nBt |trn6t |t	rt|dkrtt| }nt |t	st
di }
|D ]}|j| }|jdk	st|dkr
| |t|dd	g |
|jj< n*| ||t|dd	g |
|jj< |d
7 }||
|jj _q|j|_|j D ]Z}|j}t |d trrn<|d jj|
krV|
|d jj j|td< | |d | qV|dk	rtd| jt|t|
 d jtd }n|  }td|jtj  }|r<t!j"|kr<| #|$t!j"d|
|}| %||d d	|kr|
 D ]D}| &|j$d	d||
|}t|dkr||t'd	< | (| qNdtt)|jd krd| j*kr| +tt)tt)|jd d ,| dd| j*t'd< t- }ntt-tt)| j*d d }| j.t/| }|jd d d D ]H}z*t0||j d| }||krX|1| W n t2k
rp   Y nX q,|tt)| j*d t'd< d|kr| 3d|
| dS )a  
        Merge the pages from the given file into the output file at the
        specified page number.

        Args:
            position: The *page number* to insert this file. File will
                be inserted after the given number.
            fileobj: A File Object or an object that supports the standard
                read and seek methods similar to a File Object. Could also be a
                string representing a path to a PDF file.
            outline_item: Optionally, you may specify a string to build an outline
                (aka 'bookmark') to identify the
                beginning of the included file.
            pages: can be a :class:`PageRange<pypdf.pagerange.PageRange>`
                or a ``(start, stop[, step])`` tuple
                or a list of pages to be processed
                to merge only the specified range of pages from the source
                document into the output document.
            import_outline: You may prevent the source document's
                outline (collection of outline items, previously referred to as
                'bookmarks') from being imported by specifying this as ``False``.
            excluded_fields: provide the list of fields/keys to be ignored
                if ``/Annots`` is part of the list, the annotation will be ignored
                if ``/B`` is part of the list, the articles will be ignored

        Raises:
            TypeError: The pages attribute is not configured properly
        F)strictNrs   r   r  z:"pages" must be a tuple of (start, stop[, step]) or a list/Br  r   r   r  rL   )r   rA   z	/AcroFormz/Root)/Fieldsr  rY   )4r   r   r   r   r   r   rq   rO   indicesr   	TypeErrorr   r   r   r   r   original_pageZnamed_destinationsZ_namedDestsvaluesr   rF   rG   r  r   rz  rK   r9   r   rV  r   r   r   rm   rT  _get_filtered_outliner   _insert_filtered_outline_insert_filtered_annotationsrE   r  rA   rl   rf   r   r;   r`   r   rD   r   r   add_filtered_articles)rp   r  rZ   rg  rq   r  r  r   r&  r  Zsrcpagesr<  Zpgr   arrZoutline_item_typZ_rorU  paglstZtrslatr  indrs   rs   rt   r  	  s    &





   

	    
     


zPdfWriter.merge)threadrq   r   r[   c                 C   sz  |j | ddd}| j|j td|d }|}d}|dk	rd| td|d ||}|dk	r,|dkrtd| t  }|}	|j|t	d< n4td| tt	d	|ji }
|
j|t	d
< |
}||t	d< |j|t	d< |d |t	d< td| }d|krt
 |t	d< td|d |j td|d
 }||kr4|	j|t	d
< |j|	t	d	< d}q4|jdk	stt|jS )z
        Clone the thread with only the applicable articles.

        Args:
            thread:
            pages:
            reader:

        Returns:
            The added thread as an indirect reference
        T)r   )Zforce_duplicateignore_fieldsrA   r   Nr   r  r  z/N/Tz/Rr  r;   )r   rW  r   r   r   _get_cloned_pagerf   rA   r   rE   r;   r   )rp   r  rq   r   ZnthreadZfirst_articleZcurrent_articleZnew_articler  Z	new_firstZnew_article2Zpag_objrs   rs   rt   _add_articles_threadM
  sb      
  

zPdfWriter._add_articles_thread)fltrrq   r   r[   c                 C   s   t |trt|}nt |ts*td}| D ]^}|j}|ddD ]F}| d }|j	j
| jt| krH||d d rH| ||| qHq2dS )z
        Add articles matching the defined criteria.

        Args:
            fltr:
            pages:
            reader:
        rY   r  rs   r  r  r  N)r   r   recompiler   r  r  r   r   r   r   r`   r   searchr  )rp   r  rq   r   r   ppr  Zthrrs   rs   rt   r  
  s    



zPdfWriter.add_filtered_articles)r   rq   r   r[   c                 C   s   t |trd S t |tr&|j| j}n0t |trH|dddkrH|j}nt |trV|}z||j jW S  t	k
rz   Y d S X d S )N/TyperY   r   )
r   rF   r   rq   r   rA   r   rD   r   r   )rp   r   rq   r   Z_irs   rs   rt   r  
  s    


zPdfWriter._get_cloned_page)annotsr   rq   r   r[   c                 C   s  t  }t|trtd| }|D ]}td| }|d dksjd|ksjtd|d d dksjd|kr d|kr|| ||  n|d }t|trt|| 	 kr||| j
 n^td	|}| |d
 ||}	|	d k	r|j| dd}
t |	g|dd   |
td< ||
j
 q"td|d d }t|trdt|| 	 kr||| j
 q"td	|}| |d
 ||}	|	d k	r"|j| dd}
td|
}
t |	g|dd   td|
d td< ||
j
 q"|S )Nr   rA   r  r  ri  r   ry  r  r;   r   )r  )r  r   r  )r  )r;   r   rD   r   r   r   rf   r   r   r[  r   r  rE   )rp   r   r   rq   r   ZoutlistZanZanor  r   Zancrs   rs   rt   r  
  sP    







z&PdfWriter._insert_filtered_annotations)noderq   r   r[   c                 C   s&  g }|dkrt  }| }t|t r*t }|dddksBd|krr|dd}|dk	rp| }|| |||7 }n|dk	r"| }td||}| td|d	 ||}|dkrt  }||t	d	< d|kr| |d |||_
ng |_
t|d	 t r
t|j
d
kr|| |dd}qr|S )z
        Extract outline item entries that are part of the specified page set.

        Args:
            node:
            pages:
            reader:

        Returns:
            A list of destination objects.
        Nr  rY   	/Outlinesr  /Firstr@   r   r   r   /Next)rF   r   r   rA   r   r  r   Z_build_outline_itemr  rE   childsr   r   )rp   r!  rq   r   Znew_outlineork  rs   rs   rt   r  
  s2    

 
zPdfWriter._get_filtered_outlinec                 C   s   t  }| | t|d |td< t|d tsn|jd k	r`d|jkr`|jd | |td< n|j|td< |jd k	rt	|j
dd|td< t|j
dtdtdtdg|td< |S )	Nr  r   ri  r  r   r   /Cg        )rL   rf   rK   rE   r   rF   r!  r   r   rG   r   r;   rC   )rp   r   Zn_olrs   rs   rt   _clone_outline  s     

 zPdfWriter._clone_outline)outlinesrM  r^  r[   c                 C   s^   |D ]T}| dddks d|kr&|}n"| |}tt| |||  | |j|d  qd S )Nr  rY   r"  r  )r   r(  r   rL   r   r`  r  r%  )rp   r)  rM  r^  r   nprs   rs   rt   r  /  s    
z"PdfWriter._insert_filtered_outlinec                 C   s   dS )z#To match the functions from Merger.Nrs   rv   rs   rs   rt   r2  ?  s    zPdfWriter.close)rg  rD  r[   c                 C   s   |d kr|   }n
td|}d}|d k	r|j|ksB|dd |krH|gS d|kr| |tt|d }|rd|krx|gng | S d|kr|d7 }tt|d }q d S q d S )NrL   r   r  r#  r$  r   )rV  r   r   r   find_outline_itemrU   rL   )rp   rg  rD  r&  r<  resrs   rs   rt   r+  D  s*    

 zPdfWriter.find_outline_itemc                 C   s   |  ||S )zZ
        .. deprecated:: 2.9.0
            Use :meth:`find_outline_item` instead.
        )r+  )rp   rg  rD  rs   rs   rt   find_bookmarkb  s    
zPdfWriter.find_bookmarkc                 C   s   |dkri | _ nnt|trBz| j t|= W q~ tk
r>   Y q~X n<t|trvz| j t|j= W q~ tk
rr   Y q~X ntddS )a/  
        Reset the translation table between reader and the writer object.

        Late cloning will create new independent objects.

        Args:
            reader: PdfReader or IndirectObject refering a PdfReader object.
                if set to None or omitted, all tables will be reset.
        Nzinvalid parameter {reader})r`   r   r   r   r   rD   r   r   rs   rs   rt   reset_translationn  s    

zPdfWriter.reset_translation)page_index_frompage_index_tostyleprefixstartr[   c                 C   s   |dkr|dkrt d|dk r(t d||k r8t d|t| jkrNt d|dk	rn|dkrn|dk rnt d| ||||| dS )	aD  
        Set a page label to a range of pages.

        Page indexes must be given starting from 0.
        Labels must have a style, a prefix or both.
        If to a range is not assigned any page label a decimal label starting from 1 is applied.

        Args:
            page_index_from: page index of the beginning of the range starting from 0
            page_index_to: page index of the beginning of the range starting from 0
            style:  The numbering style to be used for the numeric portion of each page label:
                        '/D' Decimal arabic numerals
                        '/R' Uppercase roman numerals
                        '/r' Lowercase roman numerals
                        '/A' Uppercase letters (A to Z for the first 26 pages,
                             AA to ZZ for the next 26, and so on)
                        '/a' Lowercase letters (a to z for the first 26 pages,
                             aa to zz for the next 26, and so on)
            prefix: The label prefix for page labels in this range.
            start:  The value of the numeric portion for the first page label
                    in the range.
                    Subsequent pages are numbered sequentially from this value,
                    which must be greater than or equal to 1.
                    Default value: 1.
        Nz3at least one between style and prefix must be givenr   z/page_index_from must be equal or greater then 0z;page_index_to must be equal or greater then page_index_fromz%page_index_to exceeds number of pagesr   z1if given, start must be equal or greater than one)r   r   rq   _set_page_label)rp   r/  r0  r1  r2  r3  rs   rs   rt   set_page_label  s    !zPdfWriter.set_page_labelc                 C   s\  t  }td|td< t  }|dk	r4t||td< |dk	rLt||td< |dkrdt||td< ttj| jkrt }ttd|| t	 }	||	td< |	| jttj< t
t	| jttj }	t
t|	td }tt||| tt||| tt||^}
}|
|d kr<|d t| jk r<tt|d || ||	td< |	| jttj< dS )	a*  
        Set a page label to a range of pages.

        Page indexes must be given
        starting from 0. Labels must have a style, a prefix or both. If to a
        range is not assigned any page label a decimal label starting from 1 is
        applied.

        Args:
            page_index_from: page index of the beginning of the range starting from 0
            page_index_to: page index of the beginning of the range starting from 0
            style:  The numbering style to be used for the numeric portion of each page label:
                        /D Decimal arabic numerals
                        /R Uppercase roman numerals
                        /r Lowercase roman numerals
                        /A Uppercase letters (A to Z for the first 26 pages,
                           AA to ZZ for the next 26, and so on)
                        /a Lowercase letters (a to z for the first 26 pages,
                           aa to zz for the next 26, and so on)
            prefix: The label prefix for page labels in this range.
            start:  The value of the numeric portion for the first page label
                    in the range.
                    Subsequent pages are numbered sequentially from this value,
                    which must be greater than or equal to 1. Default value: 1.
        r  r   Nr  r   z/Stz/Numsr   )rA   rE   rK   rG   r*   ZPAGE_LABELSrl   r;   r   rL   r   r   r   r   rq   )rp   r/  r0  r1  r2  r3  Zdefault_page_labelZnew_page_labelnumsZpage_labelsZnext_label_pos_rs   rs   rt   r4    s6    ! "zPdfWriter._set_page_label)rY   )NN)rs   )rs   )rs   )r   rs   )r   rs   )NN)NN)NN)NNr   )NNr   )N)N)NNN)N)N)NNNN)N)N)NN)N)N)NNFFr  )NNFFr  )NN)NN)F)F)F)F)NN)N)Nr  )Nr  )NNTN)NNTrs   )N)N)N)N)NNr   )NNr   )r   
__module____qualname____doc__r    ru   rw   r   r   BaseExceptionr   r|   propertyr   r~   setterrH   rD   rf   r   r   r   r   r   r   r
   r	   r   r   r   r   r   r   r   r   r   r   r   r   r   rq   r  r   r   decimalDecimalr   r   r@   rK   r=   r   r   r   r   r   r   r   r   OPTIONAL_READ_WRITE_FIELDr   r.   r   r   r   r   rA   r   r  r  ALL_DOCUMENT_PERMISSIONSr  r8   r%  r!   r0  r   r   r   r{   r+  r,  r-  rB  rC  r;   r<   rC   rE   rG   rF   r*  rK  rR  rS  rL   rV  rX  rW  rY  r[  r\  rb  rc  rf  r%   rT   rm  rn  rq  r9   rB   rz  rR   rW   r  r  r  r  r  r  r  r  r  r  r  r  r  r  rI   r  r  r  r  r  rS   r  r  r  r  r  r  r  r  rV   r  r  r  r  r  r  r  r  r   r   r   rO   r   rP   r  r  r   r  r  r  r  r(  r  r2  rU   r+  r-  r.  r3   r5  r4  rs   rs   rs   rt   rX      s  (


	 
"     		        #  #	T#
F
  -"` 	R,	
	#   )
    T         
   + 		P	, S $ 
	"						)   $">    
B



5
.




  4  rX   r   c                 C   s   t | tr| S t | trLt }|  D ] \}}t|}t|}|||< q&|S t | trxt }| D ]}|	t| q`|S t | t
r| drt| S t| S n*t | ttfrt| S tdt|  dd S )Nrx  z
type(obj)=z! could not be casted to PdfObject)r   rH   r  rA   r   rE   r  r   r;   r   r   
startswithrK   r   r  rC   r  type)r   r  r$  r  Zname_keyZcasted_valuer  elrs   rs   rt   r    s.    






r  )rl  rr  rs  ru  rt  r[   c                 C   s   t  }| d k	r| |td< |tdt|i |rft|trFt|}|tdtdd |D i |sn|rd}|r~|d7 }|r|d7 }|td	t|i |S )
Nri  r  r'  c                 S   s   g | ]}t |qS rs   )rC   )rF  crs   rs   rt   rG  *  s     z(_create_outline_item.<locals>.<listcomp>r   r   r   r   )	rL   rE   ra   rM   r   r   rN   r;   rG   )rl  rr  rs  ru  rt  rg  Zformat_flagrs   rs   rt   r~    s,     
r~  c                       s&   e Zd Zeedd fddZ  ZS )PdfFileWriterN)rA  kwargsr[   c                    s   t ddd t j|| d S )NrF  rX   r   )r&   superru   )rp   rA  rG  rO  rs   rt   ru   7  s    zPdfFileWriter.__init__)r   r8  r9  r	   ru   __classcell__rs   rs   rI  rt   rF  6  s   rF  )rh   rH  r>  loggingr  r  r8  r  r   r   hashlibr   ior   r   r   pathlibr   typesr   typingr   r	   r
   r   r   r   r   r   r   r   r   r   r   r  r   Z_pager   r   Z_page_labelsr   r   r   Z_readerr   Z	_securityr   r   r   _utilsr    r!   r"   r#   r$   r%   r&   r'   	constantsr(   r)   r   r*   r+   rm   r,   r  r-   r.   r/   r0   r1   r2   r   r3   r4   rb   r5   r  r6   r   r7   r8   Zgenericr9   r:   r;   r<   r=   r>   r?   r@   rA   rB   rC   rD   rE   rF   rG   rH   rI   rJ   rK   rL   rM   rN   Z	pagerangerO   rP   rQ   rR   rS   rT   rU   rV   rW   	getLoggerr   r   r@  rA  rX   r   r   r  r  r  r~  rF  rs   rs   rs   rt   <module>   s   <(
`$

                       (
