Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

MAINT: Deprecate features with PyPDF2==3.0.0 #1489

Merged
merged 11 commits into from Dec 17, 2022
Merged

MAINT: Deprecate features with PyPDF2==3.0.0 #1489

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
c5dfb50
MAINT: Deprecate features with PyPDF2==3.0.0
MartinThoma Dec 10, 2022
54c848a
Merge branch 'main' into deprecate-3
MartinThoma Dec 11, 2022
70fe5ce
Adjust tests
MartinThoma Dec 11, 2022
0c26da1
More
MartinThoma Dec 11, 2022
6eb2b93
Remaining ones
MartinThoma Dec 11, 2022
379eea9
Balck
MartinThoma Dec 11, 2022
e64770b
Bookmarks decorator adjustment
MartinThoma Dec 11, 2022
bcac8e2
More deprecations / old code removal
MartinThoma Dec 11, 2022
bf20fca
Fix
MartinThoma Dec 11, 2022
09193e5
Last one
MartinThoma Dec 11, 2022
b8d8cb5
Mark as deprecated
MartinThoma Dec 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
60 changes: 34 additions & 26 deletions PyPDF2/_merger.py
View file
Open in desktop
Expand Up @@ -46,8 +46,8 @@
from ._reader import PdfReader
from ._utils import (
StrByteType,
deprecate_bookmark,
deprecate_with_replacement,
deprecation_bookmark,
deprecation_with_replacement,
str_,
)
from ._writer import PdfWriter
Expand Down Expand Up @@ -102,7 +102,7 @@ class PdfMerger:
file-like object.
"""

@deprecate_bookmark(bookmarks="outline")
@deprecation_bookmark(bookmarks="outline")
def __init__(
self, strict: bool = False, fileobj: Union[Path, StrByteType] = ""
) -> None:
Expand Down Expand Up @@ -130,7 +130,7 @@ def __exit__(
self.write(self.fileobj)
self.close()

@deprecate_bookmark(bookmark="outline_item", import_bookmarks="import_outline")
@deprecation_bookmark(bookmark="outline_item", import_bookmarks="import_outline")
def merge(
self,
page_number: Optional[int] = None,
Expand Down Expand Up @@ -171,9 +171,11 @@ def merge(
old_term = "position"
new_term = "page_number"
warnings.warn(
message=(
f"{old_term} is deprecated as an argument. Use {new_term} instead"
)
(
f"{old_term} is deprecated as an argument and will be "
f"removed in PyPDF2=4.0.0. Use {new_term} instead"
),
DeprecationWarning,
)
else:
raise ValueError(
Expand Down Expand Up @@ -281,7 +283,7 @@ def _create_stream(
)
return stream, encryption_obj

@deprecate_bookmark(bookmark="outline_item", import_bookmarks="import_outline")
@deprecation_bookmark(bookmark="outline_item", import_bookmarks="import_outline")
def append(
self,
fileobj: Union[StrByteType, PdfReader, Path],
Expand Down Expand Up @@ -375,7 +377,7 @@ def addMetadata(self, infos: Dict[str, Any]) -> None: # pragma: no cover

Use :meth:`add_metadata` instead.
"""
deprecate_with_replacement("addMetadata", "add_metadata")
deprecation_with_replacement("addMetadata", "add_metadata")
self.add_metadata(infos)

def setPageLayout(self, layout: LayoutType) -> None: # pragma: no cover
Expand All @@ -384,7 +386,7 @@ def setPageLayout(self, layout: LayoutType) -> None: # pragma: no cover

Use :meth:`set_page_layout` instead.
"""
deprecate_with_replacement("setPageLayout", "set_page_layout")
deprecation_with_replacement("setPageLayout", "set_page_layout")
self.set_page_layout(layout)

def set_page_layout(self, layout: LayoutType) -> None:
Expand Down Expand Up @@ -421,7 +423,7 @@ def setPageMode(self, mode: PagemodeType) -> None: # pragma: no cover

Use :meth:`set_page_mode` instead.
"""
deprecate_with_replacement("setPageMode", "set_page_mode")
deprecation_with_replacement("setPageMode", "set_page_mode", "3.0.0")
self.set_page_mode(mode)

def set_page_mode(self, mode: PagemodeType) -> None:
Expand Down Expand Up @@ -513,7 +515,7 @@ def _write_dests(self) -> None:
if pageno is not None:
self.output.add_named_destination_object(named_dest)

@deprecate_bookmark(bookmarks="outline")
@deprecation_bookmark(bookmarks="outline")
def _write_outline(
self,
outline: Optional[Iterable[OutlineItem]] = None,
Expand Down Expand Up @@ -541,7 +543,7 @@ def _write_outline(
del outline_item["/Page"], outline_item["/Type"]
last_added = self.output.add_outline_item_dict(outline_item, parent)

@deprecate_bookmark(bookmark="outline_item")
@deprecation_bookmark(bookmark="outline_item")
def _write_outline_item_on_page(
self, outline_item: Union[OutlineItem, Destination], page: _MergedPage
) -> None:
Expand Down Expand Up @@ -594,7 +596,7 @@ def _associate_dests_to_pages(self, pages: List[_MergedPage]) -> None:
)
named_dest[NameObject("/Page")] = NumberObject(pageno)

@deprecate_bookmark(bookmarks="outline")
@deprecation_bookmark(bookmarks="outline")
def _associate_outline_items_to_pages(
self, pages: List[_MergedPage], outline: Optional[Iterable[OutlineItem]] = None
) -> None:
Expand All @@ -619,7 +621,7 @@ def _associate_outline_items_to_pages(
if pageno is not None:
outline_item[NameObject("/Page")] = NumberObject(pageno)

@deprecate_bookmark(bookmark="outline_item")
@deprecation_bookmark(bookmark="outline_item")
def find_outline_item(
self,
outline_item: Dict[str, Any],
Expand All @@ -644,7 +646,7 @@ def find_outline_item(

return None

@deprecate_bookmark(bookmark="outline_item")
@deprecation_bookmark(bookmark="outline_item")
def find_bookmark(
self,
outline_item: Dict[str, Any],
Expand Down Expand Up @@ -688,9 +690,11 @@ def add_outline_item(
old_term = "pagenum"
new_term = "page_number"
warnings.warn(
message=(
f"{old_term} is deprecated as an argument. Use {new_term} instead"
)
(
f"{old_term} is deprecated as an argument and will be "
f"removed in PyPDF2==4.0.0. Use {new_term} instead"
),
DeprecationWarning,
)
page_number = pagenum
if page_number is None:
Expand Down Expand Up @@ -724,7 +728,7 @@ def addBookmark(
.. deprecated:: 1.28.0
Use :meth:`add_outline_item` instead.
"""
deprecate_with_replacement("addBookmark", "add_outline_item")
deprecation_with_replacement("addBookmark", "add_outline_item", "3.0.0")
return self.add_outline_item(
title,
pagenum,
Expand All @@ -750,7 +754,7 @@ def add_bookmark(
.. deprecated:: 2.9.0
Use :meth:`add_outline_item` instead.
"""
deprecate_with_replacement("addBookmark", "add_outline_item")
deprecation_with_replacement("addBookmark", "add_outline_item", "3.0.0")
return self.add_outline_item(
title,
pagenum,
Expand All @@ -766,7 +770,9 @@ def addNamedDestination(self, title: str, pagenum: int) -> None: # pragma: no c
.. deprecated:: 1.28.0
Use :meth:`add_named_destination` instead.
"""
deprecate_with_replacement("addNamedDestination", "add_named_destination")
deprecation_with_replacement(
"addNamedDestination", "add_named_destination", "3.0.0"
)
return self.add_named_destination(title, pagenum)

def add_named_destination(
Expand All @@ -789,9 +795,11 @@ def add_named_destination(
old_term = "pagenum"
new_term = "page_number"
warnings.warn(
message=(
f"{old_term} is deprecated as an argument. Use {new_term} instead"
)
(
f"{old_term} is deprecated as an argument and will be "
f"removed in PyPDF2==4.0.0. Use {new_term} instead"
),
DeprecationWarning,
)
page_number = pagenum
if page_number is None:
Expand All @@ -806,7 +814,7 @@ def add_named_destination(

class PdfFileMerger(PdfMerger): # pragma: no cover
def __init__(self, *args: Any, **kwargs: Any) -> None:
deprecate_with_replacement("PdfFileMerger", "PdfMerger")
deprecation_with_replacement("PdfFileMerger", "PdfMerger", "3.0.0")

if "strict" not in kwargs and len(args) < 1:
kwargs["strict"] = True # maintain the default
Expand Down