REL: 5.0.0

[pubpub-zz]

Version 5.0.0, 2024-09-15

This release drops support to Python 3.7 and introduces the capability to build incremental PDF files.

Security (SEC)

• Fix GitHub workflow vulnerable to script injection (SEC: fix github workflow vulnerable to script injection #2787)

New Features (ENH)

• Add capability to remove /Info from PDF (ENH: add capability to remove /Info from pypdf #2820)
• Robustify parsing for Object streams in XRef rebuilding (ENH: Robustify parsing for Object streams in XRef rebuilding #2818)
• Add incremental capability to PdfWriter (ENH: add incremental capability to PdfWriter #2811)
• Add UniGB-UTF16 encodings (ENH: add UniGB-UTF16 encodings #2819)
• Robustify on missing font for Tf operator in text_extract() (ENH: Robustify on missing font for Tf operator in text_extract() #2816)
• Accept utf strings for metadata (ENH: accept utf strings for metadata #2802)
• Report PdfReadError instead of RecursionError (ENH: report PdfReadError instead of RecursionError #2800)
• Compress PDF files merging identical objects (ENH: compress pdf files merging identical objects #2795)

Bug Fixes (BUG)

• Warn when visitor* arguments are ignored (BUG: Warn when visitor* arguments are ignored #2845)
• Fix sheared image (BUG: fix sheared image #2801)
• Handle Sequence as an IndirectObject when extracting text with layout mode (BUG: Handle Sequence as an IndirectObject when extracting text with layout mode #2788)

Robustness (ROB)

• Robustify .set_data() (ROB: robustify .set_data() #2821)
• Raise PdfReadError when missing /Root in trailer (ROB: Raise PdfReadError when missing /Root in trailer. #2808)
• Fix extract_text() issues on damaged PDFs (ROB: fix extract_text() issues on damaged PDFs #2760)
• Handle images with empty data when processing an image from bytes (ROB: Handle images with empty data when processing an image from bytes #2786)

Documentation (DOC)

• Small changes to PaperSize notes (DOC: Small changes to PaperSize notes #2834)

Developer Experience (DEV)

• Fix coverage uploads (DEV: Fix coverage uploads #2832)
• Test against Python 3.13 (DEV: Test against Python 3.13 #2776)

Maintenance (MAINT)

• Deprecate PdfMerger, AnnotationBuilder and other deprecations cleanup (MAINT: deprecate PdfMerger,AnnotationBuilder and other depreciations cleanup #2813)
• simplify test with None and NullObject
• Improve wording of set_data error message (MAINT: Improve wording of set_data error message #2810)
• Remove unused code (MAINT: remove unused code #2805)
• Fix mypy type output (MAINT: fix mypy type output #2799)
• Improve test coverage (MAINT: test coverage #2796)
• Remove b_ and str_ (MAINT: Remove b_ and str_ #2792)
• Drop Python 3.7 support (MAINT: drop Python 3.7 support #2793)
• Remove unused AnnotationFlag
• Remove unused paeth_predictor (DEP: Remove paeth_predictor #2773)

Code Style (STY)

• Use f-string = functionality (STY: Use f-string = functionality #2835)
• Refactor b_ (STY: Refactor b_ #2772)
• Remove boolean value comparison (STY: Remove boolean value comparison #2779)
• Increase readability (STY: Increase readability #2775)
• Reorder exported symbols (STY: Reorder exported symbols #2774)
• Amend B_CACHE key types (STY: Amend B_CACHE key types #2766)

Other

Full Changelog

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.98%. Comparing base (8eefba8) to head (159fd25).
Report is 90 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2851   +/-   ##
=======================================
  Coverage   95.98%   95.98%           
=======================================
  Files          51       51           
  Lines        8501     8501           
  Branches     1696     1696           
=======================================
  Hits         8160     8160           
  Misses        200      200           
  Partials      141      141           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[stefan6419846]

Please reduce the changelog to omit unimportant changes and fix line 15 to match the other lines. (Please note that this has to be done for the merge commit data as well.) Additionally, I slightly adjusted the wording of the introductory text which should be transferred as well.

If you need help, feel free to come back to me and I will have a look at condensing the changelog myself tomorrow.

[MartinThoma]

@pubpub-zz @stefan6419846 Thank you for keeping pypdf alive 🙏

[pubpub-zz]

@stefan6419846
Is it ok now ?

[MartinThoma]

Looks good to me 🎉 Thank you 🙏

As I'm out of touch of recent developments it would be good to wait for the approval of @stefan6419846

change applied

[stefan6419846]

I have just reverted all the unrelated changes to the files. They need further dedicated discussions.

[stefan6419846]

Should be okay now. Please ensure that the merge commit uses the correct (cleaned up) message. Creating the tag will probably need manual tasks as well.