oca/oca-ocb-accounting
2
0
Fork 0
mirror of https://github.com/bringout/oca-ocb-accounting.git synced 2026-04-18 04:02:01 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
oca-ocb-accounting/odoo-bringout-oca-ocb-account_edi/doc/PATCH_PDFWRITER.md
Ernad Husremovic fc6c53f22a Add mandatory PATCH_PDFWRITER.md documentation 
Complete mandatory documentation for PyPDF2 compatibility.
This package benefits from oca-ocb-base compatibility layer.

🤖 assisted by claude
2025-09-02 19:13:50 +02:00

2.9 KiB
Raw Blame History

PyPDF2 Compatibility Patch - Account EDI (OCB)

Overview

This package benefits from the PyPDF2 compatibility fixes implemented in the oca-ocb-base package. The account_edi module uses OdooPdfFileWriter classes that are automatically compatible with PyPDF2 3.0.0+ through the main compatibility layer.

Problem

In PyPDF2 3.0.0, several classes and methods were deprecated and removed:

  • PdfFileWriter → PdfWriter
  • PdfFileReader → PdfReader
  • cloneReaderDocumentRoot() → clone_reader_document_root()
  • Various other method names changed

Affected Functionality

The account_edi module uses PyPDF2 for:

  • Electronic invoice PDF generation with embedded XML
  • EDI document attachment to PDF reports
  • XML embedding in compliance documents
  • PDF/A conversion for electronic invoicing

Solution

This package requires NO direct patches because it uses:

  1. OdooPdfFileWriter from odoo.tools.pdf (oca-ocb-base)
  2. OdooPdfFileReader from odoo.tools.pdf (oca-ocb-base)

The main compatibility layer in oca-ocb-base handles all PyPDF2 version compatibility automatically.

Files Using PyPDF2

account_edi/models/ir_actions_report.py

  • Uses OdooPdfFileWriter for PDF generation (automatically compatible)
  • Calls writer.cloneReaderDocumentRoot(reader)
  • Embeds EDI XML attachments in PDFs

Implementation Details

No code changes needed in this package. Compatibility is achieved through:

  1. Dependency: Requires oca-ocb-base with pdfwrite branch
  2. Automatic compatibility: OdooPdfFileWriter handles all PyPDF2 version differences
  3. Method compatibility: Methods like cloneReaderDocumentRoot() are automatically wrapped

Testing

The compatibility has been verified with:

  • PyPDF2 3.0.0+ (new API)
  • PyPDF2 2.x (old API)
  • EDI invoice PDF generation
  • XML embedding workflows
  • Electronic invoicing compliance

Branch Information

  • Branch: pdfwrite
  • Based on: Current master branch
  • Type: Dependency compatibility (no direct patches)
  • Impact: Automatic compatibility through oca-ocb-base dependency

Dependencies

CRITICAL: This package requires:

  • oca-ocb-base package on pdfwrite branch
  • The main PyPDF2 compatibility layer must be active

Author

  • Developer: Ernad Husremović (hernad@bring.out.ba)
  • Company: bring.out.doo Sarajevo
  • Date: 2025-09-02

Related Issues

This documentation addresses PyPDF2 compatibility for:

  • Electronic invoicing (EDI)
  • PDF/A document generation
  • XML-embedded compliance documents
  • B2B electronic document exchange

Installation

  1. Ensure oca-ocb-base is using the pdfwrite branch
  2. Use this package's pdfwrite branch (for documentation compliance)
  3. No additional installation steps required

Future Considerations

  • Monitor oca-ocb-base compatibility updates
  • Test EDI workflows with future PyPDF2 versions
  • Consider EDI standard compliance with PDF changes