Skip to content

Commit

Permalink
Missing deprecations
Browse files Browse the repository at this point in the history
  • Loading branch information
MartinThoma committed May 22, 2022
1 parent 9024f0b commit b353fe8
Show file tree
Hide file tree
Showing 4 changed files with 81 additions and 10 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,9 @@ PdfWriter class:
PdfMerger class
- `__init__` parameter: strict=True ➔ strict=False (the PdfFileMerger still has the old default)
- addMetadata ➔ add_metadata
- addNamedDestination ➔ add_named_destination
- setPageLayout ➔ set_page_layout
- setPageMode ➔ set_page_mode

Page class:
- artBox / bleedBox/ cropBox/ mediaBox / trimBox ➔ artbox / bleedbox/ cropbox/ mediabox / trimbox
Expand Down
68 changes: 68 additions & 0 deletions PyPDF2/merger.py
Original file line number Diff line number Diff line change
Expand Up @@ -299,6 +299,18 @@ def addMetadata(self, infos):
self.add_metadata(infos)

def setPageLayout(self, layout):
"""
.. deprecated:: 1.28.0
Use :meth:`set_page_layout` instead.
"""
warnings.warn(
DEPR_MSG.format("setPageLayout", "set_page_layout"),
PendingDeprecationWarning,
)
self.set_page_layout(layout)

def set_page_layout(self, layout):
"""
Set the page layout
Expand All @@ -325,6 +337,17 @@ def setPageLayout(self, layout):
self.output._set_page_layout(layout)

def setPageMode(self, mode):
"""
.. deprecated:: 1.28.0
Use :meth:`set_page_mode` instead.
"""
warnings.warn(
DEPR_MSG.format("setPageMode", "set_page_mode"), PendingDeprecationWarning
)
self.set_page_mode(mode)

def set_page_mode(self, mode):
"""
Set the page mode.
Expand Down Expand Up @@ -522,6 +545,17 @@ def _associate_bookmarks_to_pages(self, pages, bookmarks=None):
raise ValueError("Unresolved bookmark '%s'" % (b["/Title"],))

def findBookmark(self, bookmark, root=None):
"""
.. deprecated:: 1.28.0
Use :meth:`find_bookmark` instead.
"""
warnings.warn(
"findBookmark is deprecated. Use find_bookmark instead.",
DeprecationWarning,
)
return self.find_bookmark(bookmark, root=root)

def find_bookmark(self, bookmark, root=None):
if root is None:
root = self.bookmarks

Expand All @@ -545,6 +579,29 @@ def addBookmark(
italic=False,
fit="/Fit",
*args
):
"""
.. deprecated:: 1.28.0
Use :meth:`add_bookmark` instead.
"""
warnings.warn(
"addBookmark is deprecated. Use add_bookmark instead.",
DeprecationWarning,
)
return self.add_bookmark(
title, pagenum, parent, color, bold, italic, fit, *args
)

def add_bookmark(
self,
title,
pagenum,
parent=None,
color=None,
bold=False,
italic=False,
fit="/Fit",
*args
):
"""
Add a bookmark to this PDF file.
Expand Down Expand Up @@ -615,6 +672,17 @@ def addBookmark(
return bookmark_ref

def addNamedDestination(self, title, pagenum):
"""
.. deprecated:: 1.28.0
Use :meth:`add_named_destionation` instead.
"""
warnings.warn(
"addNamedDestination is deprecated. " "Use add_named_destionation instead.",
DeprecationWarning,
)
return self.add_named_destionation(title, pagenum)

def add_named_destionation(self, title, pagenum):
"""
Add a destination to the output.
Expand Down
10 changes: 5 additions & 5 deletions Tests/bench.py
Original file line number Diff line number Diff line change
Expand Up @@ -64,12 +64,12 @@ def merge():
with open(pdf_path, "rb") as fh:
file_merger.append(fh)

bookmark = file_merger.addBookmark("A bookmark", 0)
file_merger.addBookmark("deeper", 0, parent=bookmark)
bookmark = file_merger.add_bookmark("A bookmark", 0)
file_merger.add_bookmark("deeper", 0, parent=bookmark)
file_merger.add_metadata({"author": "Martin Thoma"})
file_merger.addNamedDestination("title", 0)
file_merger.setPageLayout("/SinglePage")
file_merger.setPageMode("/UseThumbs")
file_merger.add_named_destionation("title", 0)
file_merger.set_page_layout("/SinglePage")
file_merger.set_page_mode("/UseThumbs")

tmp_path = "dont_commit_merged.pdf"
file_merger.write(tmp_path)
Expand Down
10 changes: 5 additions & 5 deletions Tests/test_merger.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,12 @@ def test_merge():
with open(pdf_path, "rb") as fh:
file_merger.append(fh)

bookmark = file_merger.addBookmark("A bookmark", 0)
file_merger.addBookmark("deeper", 0, parent=bookmark)
bookmark = file_merger.add_bookmark("A bookmark", 0)
file_merger.add_bookmark("deeper", 0, parent=bookmark)
file_merger.add_metadata({"author": "Martin Thoma"})
file_merger.addNamedDestination("title", 0)
file_merger.setPageLayout("/SinglePage")
file_merger.setPageMode("/UseThumbs")
file_merger.add_named_destionation("title", 0)
file_merger.set_page_layout("/SinglePage")
file_merger.set_page_mode("/UseThumbs")

tmp_path = "dont_commit_merged.pdf"
file_merger.write(tmp_path)
Expand Down

0 comments on commit b353fe8

Please sign in to comment.