PyPDF2 PdfWriter類

2023-03-30 15:22 更新

?classPyPDF2.PdfWriter(fileobj: Union[str, IO] = '')?

基類: ?object?

此類支持寫出 PDF 文件，給定由另一個類生成的頁面（通常為?PdfReader?）。

addAttachment(fname: str, fdata: Union[str, bytes])→ None

1.28.0 版后已棄用：改為使用?add_attachment()?。

 addBlankPage(width: Optional[float] = None, height: Optional[float] = None)→ PageObject

1.28.0 版后已棄用：改為使用?add_blank_page()?。

addBookmark(title: str, pagenum: int, parent: ~typing.Union[None, ~PyPDF2.generic._data_structures.TreeObject, ~PyPDF2.generic._base.IndirectObject] = None, color: ~typing.Optional[~typing.Tuple[float, float, float]] = None, bold: bool = False, italic: bool = False, fit: typing_extensions.Literal[/Fit, /XYZ, /FitH, /FitV, /FitR, /FitB, /FitBH, /FitBV] = '/Fit', *args: ~typing.Union[~PyPDF2.generic._base.NumberObject, ~PyPDF2.generic._base.NullObject, float])→ IndirectObject

1.28.0 版后已棄用：改為使用?add_outline_item()?。

addBookmarkDestination(dest: PageObject, parent: Optional[TreeObject] = None)→ IndirectObject

1.28.0 版后已棄用：改為使用?add_outline_item_destination()?。

addBookmarkDict(outline_item: Union[OutlineItem, Destination], parent: Optional[TreeObject] = None)→ IndirectObject

1.28.0 版后已棄用：改為使用?add_outline_item_dict()?。

addJS(javascript: str)→ None

1.28.0 版后已棄用：改為使用?add_js()?。

addLink(pagenum: int, page_destination: int, rect: ~PyPDF2.generic._rectangle.RectangleObject, border: ~typing.Optional[~PyPDF2.generic._data_structures.ArrayObject] = None, fit: typing_extensions.Literal[/Fit, /XYZ, /FitH, /FitV, /FitR, /FitB, /FitBH, /FitBV] = '/Fit', *args: ~typing.Union[~PyPDF2.generic._base.NumberObject, ~PyPDF2.generic._base.NullObject, float])→ None

1.28.0 版后已棄用：改為使用?add_link()?。

addMetadata(infos: Dict[str, Any])→ None

1.28.0 版后已棄用：改為使用?add_metadata()?。

addNamedDestination(title: str, pagenum: int)→ IndirectObject

1.28.0 版后已棄用：改為使用?add_named_destination()?。

addNamedDestinationObject(dest: Destination)→ IndirectObject

1.28.0 版后已棄用：改為使用?add_named_destination_object()?。

addPage(page: PageObject, excluded_keys: Iterable[str] = ())→ PageObject

1.28.0 版后已棄用：改為使用?add_page()?。

addURI(pagenum: int, uri: str, rect: RectangleObject, border: Optional[ArrayObject] = None)→ None

1.28.0 版后已棄用：改為使用?add_uri()?。

add_annotation(page_number: int, annotation: Dict[str, Any])→ None

add_attachment(filename: str, data: Union[str, bytes])→ None

在 PDF 中嵌入文件。

參數(shù)

  • filename ( str ) – 要顯示的文件名。

  • data ( str ) – 文件中的數(shù)據(jù)。

參考： https://www.adobe.com/content/dam/Adobe/en/devnet/acrobat/pdfs/PDF32000_2008.pdf 第 7.11.3 節(jié)

add_blank_page(width: Optional[float] = None, height: Optional[float] = None)→ PageObject

將空白頁附加到此 PDF 文件并將其返回。如果未指定頁面大小，則使用最后一頁的大小。

參數(shù)

  • width ( float ) – 以默認用戶空間單位表示的新頁面的寬度。

  • height ( float ) – 以默認用戶空間單位表示的新頁面的高度。

返回

新添加的頁面

拋出

PageSizeNotDefinedError – 如果未定義寬度和高度并且上一頁不存在。

add_bookmark(title: str, pagenum: int, parent: ~typing.Union[None, ~PyPDF2.generic._data_structures.TreeObject, ~PyPDF2.generic._base.IndirectObject] = None, color: ~typing.Optional[~typing.Tuple[float, float, float]] = None, bold: bool = False, italic: bool = False, fit: typing_extensions.Literal[/Fit, /XYZ, /FitH, /FitV, /FitR, /FitB, /FitBH, /FitBV] = '/Fit', *args: ~typing.Union[~PyPDF2.generic._base.NumberObject, ~PyPDF2.generic._base.NullObject, float])→ IndirectObject

2.9.0 版后已棄用：改為使用?add_outline_item()?。

add_bookmark_destination(dest: Union[PageObject, TreeObject], parent: Union[None, TreeObject, IndirectObject] = None)→ IndirectObject

2.9.0 版后已棄用：改為使用?add_outline_item_destination()?。

add_bookmark_dict(outline_item: Union[OutlineItem, Destination], parent: Optional[TreeObject] = None)→ IndirectObject

2.9.0 版后已棄用：改為使用?add_outline_item_dict()?。

add_filtered_articles(fltr: Union[Pattern, str], pages: Dict[int, PageObject], reader: PdfReader)→ None

添加符合定義條件的文章。

add_js(javascript: str)→ None

添加將在打開此 PDF 時啟動的 Javascript。

參數(shù)

javascript ( str ) – 你的 Javascript。

>>> output.add_js("this.print({bUI:true,bSilent:false,bShrinkToFit:true});")
# Example: This will launch the print window when the PDF is opened.
add_link(pagenum: int, page_destination: int, rect: ~PyPDF2.generic._rectangle.RectangleObject, border: ~typing.Optional[~PyPDF2.generic._data_structures.ArrayObject] = None, fit: typing_extensions.Literal[/Fit, /XYZ, /FitH, /FitV, /FitR, /FitB, /FitBH, /FitBV] = '/Fit', *args: ~typing.Union[~PyPDF2.generic._base.NumberObject, ~PyPDF2.generic._base.NullObject, float])→ None
add_metadata(infos: Dict[str, Any])→ None

將自定義元數(shù)據(jù)添加到輸出。

參數(shù)

infos ( dict ) – 一個 Python 字典，其中每個鍵都是一個字段，每個值都是您的新元數(shù)據(jù)。

add_named_destination(title: str, page_number: Optional[int] = None, pagenum: Optional[int] = None)→ IndirectObject

add_named_destination_array(title: TextStringObject, destination: Union[IndirectObject, ArrayObject])→ None

add_named_destination_object(page_destination: Optional[PdfObject] = None, dest: Optional[PdfObject] = None)→ IndirectObject

add_outline()→ None

add_outline_item(title: str, page_number: ~typing.Union[None, ~PyPDF2._page.PageObject, ~PyPDF2.generic._base.IndirectObject, int], parent: ~typing.Union[None, ~PyPDF2.generic._data_structures.TreeObject, ~PyPDF2.generic._base.IndirectObject] = None, before: ~typing.Union[None, ~PyPDF2.generic._data_structures.TreeObject, ~PyPDF2.generic._base.IndirectObject] = None, color: ~typing.Optional[~typing.Union[~typing.Tuple[float, float, float], str]] = None, bold: bool = False, italic: bool = False, fit: ~PyPDF2.generic._fit.Fit = <PyPDF2.generic._fit.Fit object>, pagenum: ~typing.Optional[int] = None)→ IndirectObject

向此 PDF 文件添加大綱項目（通常稱為“書簽”）。

參數(shù)

  • title ( str ) – 用于此大綱項目的標題。

  • page_number ( int ) – 此大綱項將指向的頁碼。

  • parent – 對父大綱項的引用以創(chuàng)建嵌套大綱項。

  • parent – 對父大綱項的引用以創(chuàng)建嵌套大綱項。

  • color ( tuple ) – 大綱項字體的顏色，作為從 0.0 到 1.0 的紅色、綠色、藍色元組或作為十六進制字符串 (#RRGGBB)

  • bold ( bool ) – 大綱項字體為粗體

  • italic ( bool ) – 大綱項目字體為斜體

  • fit ( Fit ) – 目標頁面的適合度。

add_outline_item_destination(page_destination: Union[None, PageObject, TreeObject] = None, parent: Union[None, TreeObject, IndirectObject] = None, before: Union[None, TreeObject, IndirectObject] = None, dest: Union[None, PageObject, TreeObject] = None)→ IndirectObject

add_outline_item_dict(outline_item: Union[OutlineItem, Destination], parent: Union[None, TreeObject, IndirectObject] = None, before: Union[None, TreeObject, IndirectObject] = None)→ IndirectObject

add_page(page: PageObject, excluded_keys: Iterable[str] = ())→ 

PageObject

向此 PDF 文件添加頁面。推薦用于高級用法，包括足夠的 excluded_keys

該頁面通常是從?PdfReader ?實例中獲取的。

參數(shù)

page ( PageObject) – 要添加到文檔中的頁面。應(yīng)該是一個?PageObject?實例

add_uri(page_number: int, uri: str, rect: RectangleObject, border: Optional[ArrayObject] = None, pagenum: Optional[int] = None)→ None

從一個矩形區(qū)域添加一個 URI 到指定的頁面。這使用?add_link()?的基本結(jié)構(gòu)

參數(shù)

  • page_number ( int ) – 放置 URI 操作的頁面的索引。

  • uri ( str ) – 要鏈接到的資源的 URI。

  • rect ( Tuple [ int , int , int , int ] ) –?RectangleObject?或指定可點擊矩形區(qū)域的四個整數(shù)數(shù)組?[xLL, yLL, xUR, yUR]? ，或?"[ xLL yLL xUR yUR ]"?形式中的字符串。

  • border ( ArrayObject ) – 如果提供，則為描述邊框繪制屬性的數(shù)組。有關(guān)詳細信息，請參閱 PDF 規(guī)范。如果省略此參數(shù)，則不會繪制邊框。

append(fileobj: Union[str, IO, PdfReader, Path], outline_item: Union[str, None, PageRange, Tuple[int, int], Tuple[int, int, int], List[int]] = None, pages: Union[None, PageRange, Tuple[int, int], Tuple[int, int, int], List[int]] = None, import_outline: bool = True, excluded_fields: Optional[Union[List[str], Tuple[str, ...]]] = None)→ None

與?merge()?方法相同，但假設(shè)您要將所有頁面連接到文件末尾而不是指定位置。

參數(shù)

  • fileobj – 文件對象或支持類似于文件對象的標準讀取和查找方法的對象。也可以是表示 PDF 文件路徑的字符串。

  • outline_item ( str ) – 或者，您可以指定一個字符串來構(gòu)建大綱（也稱為“書簽”）以標識所包含文件的開頭。

  • pages – 可以是要處理的頁面?PageRange ?或?(start, stop[, step])?元組或頁面列表，以僅將指定范圍的頁面從源文檔合并到輸出文檔中。

  • import_outline ( bool ) – 您可以通過將其指定為?False? 來阻止導入源文檔的大綱（大綱項目的集合，以前稱為“書簽”）。

  • excluded_fields ( List ) – 如果“/Annots”是列表的一部分，提供要忽略的字段/鍵列表，如果“/B”是列表的一部分，注釋將被忽略，文章將被忽略

appendPagesFromReader(reader: PdfReader, after_page_append: Optional[Callable[[PageObject], None]] = None)→ None

1.28.0 版后已棄用：改為使用?append_pages_from_reader()?。

append_pages_from_reader(reader: PdfReader, after_page_append: Optional[Callable[[PageObject], None]] = None)→ None

將頁面從讀者復制到作者。包括一個可選的回調(diào)參數(shù)，該參數(shù)在頁面附加到編寫器后調(diào)用。

參數(shù)

  • reader ( PdfReader) – 一個 PdfReader 對象，從中復制頁面注釋到這個 writer 對象。作者的注釋將被更新

  • after_page_append ( Callable [ [ PageObject] , None ] ) – 在每個頁面附加到作者之后調(diào)用的回調(diào)函數(shù)。簽名包括對附加頁面的引用（委托給 append_pages_from_reader）。回調(diào)的單個參數(shù)是對剛剛附加到文檔的頁面的引用。

clean_page(page: Union[PageObject, IndirectObject])→ PageObject

在頁面中執(zhí)行一些清理。當前：將 NameObject nameddestination 轉(zhuǎn)換為 TextStringObject（名稱/目標列表需要）

cloneDocumentFromReader(reader: PdfReader, after_page_append: Optional[Callable[[PageObject], None]] = None)→ None

1.28.0 版后已棄用：改為使用?clone_document_from_reader()?。

cloneReaderDocumentRoot(reader: PdfReader)→ None

1.28.0 版后已棄用：改為使用?clone_reader_document_root()?。

clone_document_from_reader(reader: PdfReader, after_page_append: Optional[Callable[[PageObject], None]] = None)→ None

從 PDF 文件閱讀器創(chuàng)建文檔的副本（克?。?/p>

參數(shù)

  • reader – 應(yīng)該從中創(chuàng)建克隆的 PDF 文件閱讀器實例。

  • after_page_append ( Callable [ [ PageObject] , None ] ) – 在每個頁面附加到作者之后調(diào)用的回調(diào)函數(shù)。簽名包括對附加頁面的引用（委托給 append_pages_from_reader）?；卣{(diào)的單個參數(shù)是對剛剛附加到文檔的頁面的引用。

clone_reader_document_root(reader: PdfReader)→ None

將讀取器文檔根目錄復制到寫入器。

參數(shù)

reader – 應(yīng)復制文檔根目錄中的 PdfReader。

close()→ None

匹配Merger的功能

encrypt(user_password: ~typing.Optional[str] = None, owner_password: ~typing.Optional[str] = None, use_128bit: bool = True, permissions_flag: ~PyPDF2.constants.UserAccessPermissions = UserAccessPermissions.None, user_pwd: ~typing.Optional[str] = None, owner_pwd: ~typing.Optional[str] = None)→ None

使用 PDF 標準加密處理程序加密此 PDF 文件。

參數(shù)

  • user_password ( str ) – “用戶密碼”，允許在提供的限制條件下打開和閱讀 PDF 文件。

  • owner_password ( str ) – “所有者密碼”，允許不受任何限制地打開 PDF 文件。默認情況下，所有者密碼與用戶密碼相同。

  • use_128bit ( bool ) – 是否使用 128 位加密的標志。如果為 false，將使用 40 位加密。默認情況下，此標志處于打開狀態(tài)。

  • permissions_flag ( unsigned int ) – PDF 1.7 規(guī)范的表 3.20 中描述的權(quán)限。位值為 1 表示許可已授予。因此，整數(shù)值 -1 將設(shè)置所有標志。位位3用于打印，4位用于修改內(nèi)容，5位和6位控制注釋，9位用于表單域，10位用于提取文本和圖形。

find_bookmark(outline_item: Dict[str, Any], root: Optional[List[Union[Destination, List[Union[Destination, List[Destination]]]]]] = None)→ Optional[List[int]]

2.9.0 版后已棄用：改為使用?find_outline_item()?。

find_outline_item(outline_item: Dict[str, Any], root: Optional[List[Union[Destination, List[Union[Destination, List[Destination]]]]]] = None)→ Optional[List[int]]

getNamedDestRoot()→ ArrayObject

1.28.0 版后已棄用：改為使用?get_named_dest_root()?。

getNumPages()→ int

1.28.0 版后已棄用：改為使用?len(writer.pages)?。

getObject(ido: Union[int, IndirectObject])→ PdfObject

1.28.0 版后已棄用：改為使用?get_object()?。

getOutlineRoot()→ TreeObject

1.28.0 版后已棄用：改為使用?get_outline_root()?。

getPage(pageNumber: int)→ PageObject

1.28.0 版后已棄用：改為使用?writer.pages[page_number]?。

getPageLayout()→ Literal[/NoLayout, /SinglePage, /OneColumn, /TwoColumnLeft, /TwoColumnRight, /TwoPageLeft, /TwoPageRight]]

1.28.0 版后已棄用：改為使用?page_layout?。

getPageMode()→ Literal[/UseNone, /UseOutlines, /UseThumbs, /FullScreen, /UseOC, /UseAttachments]]

1.28.0 版后已棄用：改為使用?page_mode?。

getReference(obj: PdfObject)→ IndirectObject

1.28.0 版后已棄用：改為使用?get_reference()?。

get_named_dest_root()→ ArrayObject

get_object(indirect_reference: Union[None, int, IndirectObject] = None, ido: Optional[IndirectObject] = None)→ PdfObject

get_outline_root()→ TreeObject

get_page(page_number: Optional[int] = None, pageNumber: Optional[int] = None)→ PageObject

從此 PDF 文件中按編號檢索頁面。

參數(shù)

page_number ( int ) – 要檢索的頁碼（頁面從零開始）

返回

page_number給出的索引處的頁面

get_reference(obj: PdfObject)→ IndirectObject

get_threads_root()→ ArrayObject

線程列表請參閱 PDF 1.7 規(guī)范中的§8.3.2

返回具有“/F”和“/I”屬性的字典數(shù)組（可能為空）
insertBlankPage(width: Optional[Decimal] = None, height: Optional[Decimal] = None, index: int = 0)→ PageObject

1.28.0 版后已棄用：改為使用?insertBlankPage()?。

insertPage(page: PageObject, index: int = 0, excluded_keys: Iterable[str] = ())→ ??PageObject??

1.28.0 版后已棄用：改為使用?insert_page()?。

??insert_blank_page(width: Optional[Decimal] = None, height: Optional[Decimal] = None, index: int = 0)→ PageObject??

在此 PDF 文件中插入空白頁并將其返回。如果未指定頁面大小，則使用最后一頁的大小。

參數(shù)

  • width ( float ) – 以默認用戶空間單位表示的新頁面的寬度。

  • height ( float ) – 以默認用戶空間單位表示的新頁面的高度。

  • index ( int ) – 添加頁面的位置。

返回

新添加的頁面

拋出

PageSizeNotDefinedError – 如果未定義寬度和高度并且上一頁不存在。

insert_page(page: PageObject, index: int = 0, excluded_keys: Iterable[str] = ())→ PageObject

在此 PDF 文件中插入一頁。該頁面通常是從 PdfReader實例中獲取的。

參數(shù)

  • page ( PageObject) – 要添加到文檔中的頁面。

  • index ( int ) – 頁面將被插入的位置。

merge(position: Optional[int], fileobj: Union[Path, str, IO, PdfReader], outline_item: Optional[str] = None, pages: Optional[Union[str, PageRange, Tuple[int, int], Tuple[int, int, int], List[int]]] = None, import_outline: bool = True, excluded_fields: Optional[Union[List[str], Tuple[str, ...]]] = ())→ None

將給定文件中的頁面合并到指定頁碼處的輸出文件中。

參數(shù)

  • position ( int ) –要插入此文件的頁碼。文件將被插入到給定的編號之后。

  • fileobj – 文件對象或支持類似于文件對象的標準讀取和查找方法的對象。也可以是表示 PDF 文件路徑的字符串。

  • outline_item ( str ) – 或者，您可以指定一個字符串來構(gòu)建大綱（也稱為“書簽”）以標識所包含文件的開頭。

  • pages – 可以是要處理的頁面?PageRange ?或元組?(start, stop[, step])?或頁面列表，以僅將指定范圍的頁面從源文檔合并到輸出文檔中。

  • import_outline ( bool ) – 您可以通過將其指定為?False ?來阻止導入源文檔的大綱（大綱項目的集合，以前稱為“書簽”）。

  • excluded_fields ( List ) – 如果“/Annots”是列表的一部分，提供要忽略的字段/鍵列表，如果“/B”是列表的一部分，注釋將被忽略，文章將被忽略

propertyopen_destination: Union[None, Destination, TextStringObject, ByteStringObject]

用于訪問打開目標的屬性（PDF 目錄中的“/OpenAction”條目）。如果未設(shè)置條目不存在，則返回None 。

：參數(shù)目的地：。該屬性可以設(shè)置為 Destination、Page 或 string(NamedDest) 或

無（刪除“/OpenAction”）

（值存儲在 Pdf 目錄的“/OpenAction”條目中）

屬性 pageLayout: Literal[/NoLayout, /SinglePage, /OneColumn, /TwoColumnLeft, /TwoColumnRight, /TwoPageLeft, /TwoPageRight]]

自版本 1.28.0 后棄用。

改用?page_layout?。

?屬性 pageMode: Literal[/UseNone, /UseOutlines, /UseThumbs, /FullScreen, /UseOC, /UseAttachments]]?

自版本 1.28.0 后棄用。

改用?page_mode?。

屬性 page_layout: Literal[/NoLayout, /SinglePage, /OneColumn, /TwoColumnLeft, /TwoColumnRight, /TwoPageLeft, /TwoPageRight]]

頁面布局屬性

有效的 layout 值

/NoLayout

未明確指定布局

/SinglePage

一次顯示一頁

/OneColumn

一次顯示一列

/TwoColumnLeft

分兩列顯示頁面，左側(cè)為奇數(shù)頁

/TwoColumnRight

分兩列顯示頁面，右側(cè)為奇數(shù)頁

/TwoPageLeft

一次顯示兩頁，奇數(shù)頁在左邊

/TwoPageRight

一次顯示兩頁，奇數(shù)頁在右邊
屬性 page_mode: Literal[/UseNone, /UseOutlines, /UseThumbs, /FullScreen, /UseOC, /UseAttachments]]

頁面模式屬性

有效的 mode 值

/UseNone

不顯示大綱或縮略圖面板

/UseOutlines

顯示大綱（又名書簽）面板

/UseThumbs

顯示頁面縮略圖面板

/FullScreen

全屏視圖

/UseOC

顯示可選內(nèi)容組（OCG）面板

/UseAttachments

顯示附件面板

屬性 pages: List[PageObject]

模擬?PageObject?.

屬性 pdf_header: bytes

寫入的 PDF 文檔的頁眉。

這應(yīng)該類似于 b'%PDF-1.5'。建議設(shè)置支持 PDF 文件中使用的所有功能的最低版本。

removeImages(ignoreByteStringObject: bool = False)→ None

1.28.0 版后已棄用：改為使用?remove_images()?。

removeLinks()→ None

1.28.0 版后已棄用：改為使用?remove_links()?。

removeText(ignoreByteStringObject: bool = False)→ None

1.28.0 版后已棄用：改為使用?remove_text()?。

remove_images(ignore_byte_string_object: bool = False)→ None

從此輸出中刪除圖像。

參數(shù)

ignore_byte_string_object ( bool ) – 忽略 ByteString 對象的可選參數(shù)。

remove_links()→ None

從此輸出中刪除鏈接和注釋。

remove_text(ignore_byte_string_object: bool = False)→ None

從此輸出中刪除文本。

參數(shù)

ignore_byte_string_object ( bool ) – 忽略 ByteString 對象的可選參數(shù)。

reset_translation(reader: Union[None, PdfReader, IndirectObject] = None)→ None

重置讀者和作者對象之間的轉(zhuǎn)換表。后期克隆將創(chuàng)建新的獨立對象

參數(shù)

reader – PdfReader 或 IndirectObject 引用 PdfReader 對象。如果設(shè)置為 None 或省略，所有表都將被重置。

setPageLayout(layout: typing_extensions.Literal[/NoLayout, /SinglePage, /OneColumn, /TwoColumnLeft, /TwoColumnRight, /TwoPageLeft, /TwoPageRight])→ None

1.28.0 版后已棄用：改為使用?page_layout?。

setPageMode(mode: typing_extensions.Literal[/UseNone, /UseOutlines, /UseThumbs, /FullScreen, /UseOC, /UseAttachments])→ None

1.28.0 版后已棄用：改為使用?page_mode?。

set_need_appearances_writer()→ None
set_page_layout(layout: typing_extensions.Literal[/NoLayout, /SinglePage, /OneColumn, /TwoColumnLeft, /TwoColumnRight, /TwoPageLeft, /TwoPageRight])→ None

設(shè)置頁面布局

參數(shù)

layout (str) – 要使用的頁面布局

有效的layout 參數(shù)

/NoLayout

未明確指定布局

/SinglePage

一次顯示一頁

/OneColumn

一次顯示一列

/TwoColumnLeft

分兩列顯示頁面，左側(cè)為奇數(shù)頁

/TwoColumnRight

分兩列顯示頁面，右側(cè)為奇數(shù)頁

/TwoPageLeft

一次顯示兩頁，奇數(shù)頁在左邊

/TwoPageRight

一次顯示兩頁，奇數(shù)頁在右邊

set_page_mode(mode: typing_extensions.Literal[/UseNone, /UseOutlines, /UseThumbs, /FullScreen, /UseOC, /UseAttachments])→ None

1.28.0 版后已棄用：改為使用?page_mode?。

屬性 threads: ArrayObject

線程列表的只讀屬性請參閱 PDF 1.7 規(guī)范中的§8.3.2

返回

具有“/F”和“/I”屬性的字典數(shù)組（可能為空）

updatePageFormFieldValues(page: ~PyPDF2._page.PageObject, fields: ~typing.Dict[str, ~typing.Any], flags: ~PyPDF2.constants.FieldFlag = FieldFlag.None)→ None

1.28.0 版后已棄用：改為使用?update_page_form_field_values()?。

update_page_form_field_values(page: ~PyPDF2._page.PageObject, fields: ~typing.Dict[str, ~typing.Any], flags: ~PyPDF2.constants.FieldFlag = FieldFlag.None)→ None

從字段字典更新給定頁面的表單字段值。

將字段文本和值從字段復制到頁面。如果字段鏈接到父對象，則將信息添加到父對象。

參數(shù)

  • page ( PageObject ) – 來自 PDF writer 的頁面引用，其中注釋和字段數(shù)據(jù)將被更新。

  • fields ( dict ) – 字段名稱 (/T) 和文本值 (/V) 的 Python 字典

  • flags ( int ) – 一個整數(shù)（0 到 7）。第一位設(shè)置 ReadOnly，第二位設(shè)置 Required，第三位設(shè)置 NoExport。有關(guān)詳細信息，請參閱 PDF 參考表 8.70。

write(stream: Union[Path, str, IO])→ Tuple[bool, IO]

將添加到此對象的頁面集合寫出為 PDF 文件。

參數(shù)

stream – 將文件寫入的對象。該對象可以支持 write 方法和 tell 方法，類似于文件對象，也可以是文件路徑，就像 fileobj 一樣，只是將其命名為 stream 以保持現(xiàn)有的工作流程。

write_stream(stream: IO)→ None
以上內(nèi)容是否對您有幫助：
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號