PyPDF2 PDFMerger類

2023-03-30 11:50 更新

?classPyPDF2.PdfMerger(strict: bool = Falsefileobj: Union[Path, str, IO] = '')

?

基類: object

初始化一個?PdfMerger?對象。

?PdfMerger?將多個 PDF 合并為一個 PDF。它可以連接、切片、插入或以上的任意組合。

請參閱功能?merge()?(或?append()?)和?write()?使用信息。

參數(shù)
  • strict ( bool ) – 確定是否應(yīng)警告用戶所有問題,并導(dǎo)致一些可糾正的問題成為致命問題。默認為False.

  • fileobj——輸出文件。可以是文件名或任何類型的類似文件的對象。

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()?。

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

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

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

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

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_metadata(infos: Dict[str, Any])→ None

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

參數(shù)

infos ( dict ) – 一個 Python 字典,其中每個鍵都是一個字段,每個值都是您的新元數(shù)據(jù)。例子:{u'/Title': u'My title'}

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

向輸出添加目標(biāo)。

參數(shù)
  • title ( str ) – 要使用的標(biāo)題

  • page_number ( int ) – 此目標(biāo)指向的頁碼。

add_outline_item(title: str, page_number: ~typing.Optional[int] = None, 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: ~PyPDF2.generic._fit.Fit = <PyPDF2.generic._fit.Fit object>, pagenum: ~typing.Optional[int] = None)→ IndirectObject

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

參數(shù)
  • title ( str ) – 用于此大綱項目的標(biāo)題。

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

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

  • color ( tuple ) – 大綱項字體的顏色,作為從 0.0 到 1.0 的紅色、綠色、藍色元組

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

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

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

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

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

參數(shù)
  • fileobj – 文件對象或支持類似于文件對象的標(biāo)準(zhǔn)讀取和查找方法的對象。也可以是表示 PDF 文件路徑的字符串。

  • outline_item ( str ) – 或者,您可以通過提供大綱項的文本來指定要在包含文件的開頭應(yīng)用的大綱項(以前稱為“書簽”)。

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

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

close()→ None

關(guān)閉所有文件描述符(輸入和輸出)并清除所有內(nèi)存使用情況。

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]]

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

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

參數(shù)
  • page_number ( int ) –插入此文件的頁碼。文件將被插入到給定的編號之后。

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

  • outline_item ( str ) – 或者,您可以通過提供大綱項的文本來指定要在包含文件的開頭應(yīng)用的大綱項(以前稱為“書簽”)。

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

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

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

1.28.0 版后已棄用:改為使用?set_page_layout()?。

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

1.28.0 版后已棄用:改為使用?set_page_mode()?。

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

分兩列顯示頁面,奇數(shù)頁在右邊

/TwoPageLeft

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

/TwoPageRight

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

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

設(shè)置頁面模式。

參數(shù) mode (str) – 要使用的頁面模式
有效的 mode 值

/UseNone

不顯示大綱或縮略圖面板

/UseOutlines

顯示大綱(又名書簽)面板

/UseThumbs

顯示頁面縮略圖面板

/FullScreen

全屏視圖

/UseOC

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

/UseAttachments

顯示附件面板

write(fileobj: Union[Path, str, IO])→ None

將所有已合并的數(shù)據(jù)寫入給定的輸出文件。

參數(shù)

fileobj——輸出文件??梢允俏募蛉魏晤愋偷念愃莆募膶ο?。

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

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號