Fix PyPDF2 3.0+ compatibility issues

Add compatibility wrapper classes for PdfFileWriter/PdfFileReader
to support both PyPDF2 2.x and 3.x versions.

Changes:
- Add PdfWriter/PdfReader compatibility wrappers in odoo/tools/pdf.py
- Add compatibility classes in odoo/addons/base/models/ir_actions_report.py
- Create comprehensive documentation in doc/PATCH_PDFWRITER.md

Resolves PyPDF2.errors.DeprecationError: PdfFileWriter is deprecated
and was removed in PyPDF2 3.0.0.

🤖 assisted by claude
This commit is contained in:
Ernad Husremovic 2025-09-02 18:47:52 +02:00
parent 2483097b1b
commit e8119c9226
3 changed files with 182 additions and 7 deletions

View file

@ -16,7 +16,7 @@ from reportlab.pdfgen import canvas
try:
# class were renamed in PyPDF2 > 2.0
# https://pypdf2.readthedocs.io/en/latest/user/migration-1-to-2.html#classes
from PyPDF2 import PdfReader
from PyPDF2 import PdfReader, PdfWriter
import PyPDF2
# monkey patch to discard unused arguments as the old arguments were not discarded in the transitional class
# https://pypdf2.readthedocs.io/en/2.0.0/_modules/PyPDF2/_reader.html#PdfReader
@ -26,12 +26,34 @@ try:
kwargs["strict"] = True # maintain the default
kwargs = {k:v for k, v in kwargs.items() if k in ('strict', 'stream')}
super().__init__(*args, **kwargs)
def getNumPages(self):
"""Compatibility method for old API"""
return len(self.pages)
def getPage(self, page_num):
"""Compatibility method for old API"""
return self.pages[page_num]
class PdfFileWriter(PdfWriter):
def _addObject(self, obj):
return self._add_object(obj)
def addPage(self, page):
"""Compatibility method for old API"""
return self.add_page(page)
def addMetadata(self, metadata):
"""Compatibility method for old API"""
return self.add_metadata(metadata)
PyPDF2.PdfFileReader = PdfFileReader
from PyPDF2 import PdfFileWriter, PdfFileReader
PdfFileWriter._addObject = PdfFileWriter._add_object
PyPDF2.PdfFileWriter = PdfFileWriter
except ImportError:
from PyPDF2 import PdfFileWriter, PdfFileReader
try:
from PyPDF2 import PdfFileWriter, PdfFileReader
except ImportError:
from PyPDF2 import PdfWriter as PdfFileWriter, PdfReader as PdfFileReader
from PyPDF2.generic import DictionaryObject, NameObject, ArrayObject, DecodedStreamObject, NumberObject, createStringObject, ByteStringObject
@ -65,10 +87,15 @@ DictionaryObject.get = _unwrapping_get
class BrandedFileWriter(PdfFileWriter):
def __init__(self):
super().__init__()
self.addMetadata({
# Use new API method if available, fall back to old API
metadata = {
'/Creator': "Odoo",
'/Producer': "Odoo",
})
}
if hasattr(self, 'add_metadata'):
self.add_metadata(metadata)
else:
self.addMetadata(metadata)
PdfFileWriter = BrandedFileWriter