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


?

基類: object

初始化一個(gè)?PdfMerger?對(duì)象。

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

請(qǐng)參閱功能?merge()?（或?append()?）和?write()?使用信息。

參數(shù)

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

• fileobj——輸出文件?？梢允俏募蛉魏晤愋偷念愃莆募膶?duì)象。

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 ) – 一個(gè) Python 字典，其中每個(gè)鍵都是一個(gè)字段，每個(gè)值都是您的新元數(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)指向的頁(yè)碼。

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 文件添加大綱項(xiàng)目（通常稱為“書(shū)簽”）。

參數(shù)

• title ( str ) – 用于此大綱項(xiàng)目的標(biāo)題。

• page_number ( int ) – 此大綱項(xiàng)將指向的頁(yè)碼。

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

• color ( tuple ) – 大綱項(xiàng)字體的顏色，作為從 0.0 到 1.0 的紅色、綠色、藍(lán)色元組

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

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

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

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

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

參數(shù)

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

• outline_item ( str ) – 或者，您可以通過(guò)提供大綱項(xiàng)的文本來(lái)指定要在包含文件的開(kāi)頭應(yīng)用的大綱項(xiàng)（以前稱為“書(shū)簽”）。

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

• import_outline ( bool ) – 您可以通過(guò)將其指定為?False? 來(lái)阻止導(dǎo)入源文檔的大綱（大綱項(xiàng)目的集合，以前稱為“書(shū)簽”）。

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

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

參數(shù)

• page_number ( int ) –插入此文件的頁(yè)碼。文件將被插入到給定的編號(hào)之后。

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

• outline_item ( str ) – 或者，您可以通過(guò)提供大綱項(xiàng)的文本來(lái)指定要在包含文件的開(kāi)頭應(yīng)用的大綱項(xiàng)（以前稱為“書(shū)簽”）。

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

• import_outline ( bool ) – 您可以通過(guò)將其指定為?False?來(lái)阻止導(dǎo)入源文檔的大綱（大綱項(xiàng)目的集合，以前稱為“書(shū)簽”）。

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è)置頁(yè)面布局。

參數(shù)  layout (str) – 要使用的頁(yè)面布局

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

設(shè)置頁(yè)面模式。

參數(shù) mode (str) – 要使用的頁(yè)面模式

有效的 mode 值

/UseNone	不顯示大綱或縮略圖面板
/UseOutlines	顯示大綱（又名書(shū)簽）面板
/UseThumbs	顯示頁(yè)面縮略圖面板
/FullScreen	全屏視圖
/UseOC	顯示可選內(nèi)容組（OCG）面板
/UseAttachments	顯示附件面板

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

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

參數(shù)

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