Version 4.0.0, 2024-01-19

What's new

pypdf==4.0.0 is a big milestone forward:

• We finally have a layout-mode text extraction. This enables users who want to detect / extract tables with heuristics to give it a try.
• We deprecated a lot of the old PyPDF2 API that was either not following PEP8 naming styles or was not using a property. Users coming from PyPDF2 might want to switch to pypdf<4.0.0 first to get helpful error messages that show the new API in their specific cases.

A big 'Thank you!' the the whole pypdf community for your work. Thanks to you, pypdf is better than ever.

Kudos to @shartzog who added the layout-mode with his first contribution!

Deprecations (DEP)

• Drop Python 3.6 support (#2369) by @MartinThoma
• Remove deprecated code (#2367) by @MartinThoma
• Remove deprecated XMP properties (#2386) by @stefan6419846

New Features (ENH)

• Add "layout" mode for text extraction (#2388) by @shartzog
• Add Jupyter Notebook integration for PdfReader (#2375) by @MartinThoma
• Improve/rewrite PDF permission retrieval (#2400) by @stefan6419846

Bug Fixes (BUG)

• PdfWriter.add_uri was setting the wrong type (#2406) by @pmiller66
• Add support for GBK2K cmaps (#2385) by @stefan6419846

Documentation (DOC)

• Add pmiller66 for #2406 as a contributor by @MartinThoma
• Add missing expand parameter (#2393) by @Atomnp
• Resolve build warnings (#2380) by @stefan6419846
• Fix testing prerequisites (#2381) by @stefan6419846
• Improve formatting of contributors page (#2383) by @stefan6419846
• Add Tobeabellwether as a contributor for #2341 by @MartinThoma

Developer Experience (DEV)

• Make dependabot aware of our PR prefixes (#2415) by @stefan6419846
• Fail on Sphinx issues (#2405) by @stefan6419846
• Move title check to own workflow (#2384) by @MasterOdin
• Write to temporary files instead of the working directory (#2379) by @stefan6419846
• Ensure that the PR titles have the correct format (#2378) by @stefan6419846

Maintenance (MAINT)

• Return None instead of -1 when page is not attached (#2376) by @MartinThoma
• Complete FileSpecificationDictionaryEntries constants (#2416) by @MartinThoma
• Replace warning with logging.error (#2377) by @MartinThoma

Testing (TST)

• Add missing pytest.mark.samples annotations (#2412) by @kitterma
• Correctly close temporary files (#2396) by @stefan6419846
• Fix side effect #2379 (#2395) by @pubpub-zz
• Add test for layout extraction mode (#2390) by @MartinThoma

Code Style (STY)

• Use the UserAccessPermissions enum (#2398) by @MartinThoma
• Run black (#2370) by @MartinThoma

Full Changelog

Version 3.17.4, 2023-12-24

What's new

Bug Fixes (BUG)

• Handle IndirectObject as image filter (#2355) by @stefan6419846

Documentation (DOC)

• Quote specs in generate_file_identifiers (#2363) by @exiledkingcc
• Notes about form fields and annotations (#1945) by @dmjohnsson23
• Notes about update_page_form_field_values(auto_regenerate) (#2359) by @dmjohnsson23
• Fix stamping example (#2358) by @dmjohnsson23
• Stamp images directly on a PDF (#2357) by @dmjohnsson23
• Correct the example of adding highlight annotation (#2341) by @Tobeabellwether

Maintenance (MAINT)

• Update upload-artifact and download-artifact actions from v3 to v4 (#2352) by @stefan6419846

Testing (TST)

• Add xfail test for #2336 (#2365) by @MartinThoma
• Increase test coverage for flate handling of image mode 1 (#2339) by @stefan6419846

Code Style (STY)

• File identifier generation restructuring (#2362) by @exiledkingcc
• Add PdfWriter._ID attribute (#2361) by @exiledkingcc
• Variable naming convention (#2360) by @MartinThoma

Full Changelog

Version 3.17.3, 2023-12-17

What's new

Robustness (ROB)

• Out-of-bounds issue in handle_tj (text extraction) (#2342) by @rgwood-rely

Developer Experience (DEV)

• Make make_release.py easier to configure (#2348) by @MartinThoma

Maintenance (MAINT)

• Bump actions/download-artifact from 3 to 4 (#2344) by @dependabot[bot]

Full Changelog

Version 3.17.2, 2023-12-10

What's new

Bug Fixes (BUG)

• Cope with deflated images with CMYK Black Only (#2322) by @pubpub-zz
• Handle indirect objects as parameters for CCITTFaxDecode (#2307) by @stefan6419846
• check words length in _cmap type1_alternative function (#2310) by @Takher

Robustness (ROB)

• Relax flate decoding for too many lookup values (#2331) by @stefan6419846
• Let _build_destination skip in case of missing /D key (#2018) by @nickryand

Documentation (DOC)

• Note in reading form data (#2338) by @MartinThoma
• Pull Request prefixes and size by @MartinThoma
• Add https://github.com/zuypt for #2325 as a contributor by @MartinThoma
• Fix docstring for RunLengthDecode.decode (#2302) by @stefan6419846

Maintenance (MAINT)

• Enable disallow_any_generics and add missing generics (#2278) by @nilehmann

Testing (TST)

• Centralize file downloads (#2324) by @MartinThoma

Code Style (STY)

• Fix typo "steam" \xe2\x86\x92 "stream" (#2327) by @stefan6419846
• Run black by @MartinThoma
• Make Traceback in bug report template uppercase (#2304) by @stefan6419846

Full Changelog

Version 3.17.1, 2023-11-14

What's new

Bug Fixes (BUG)

• Mediabox expansion size when applying non-right angle rotation (#2282) by @MrinalJain17

Robustness (ROB)

• MissingWidth is IndirectObject (#2288) by @MartinThoma
• Initialize states array with an empty value (#2280) by @alexey-v-paramonov

Documentation (DOC)

• Typo in example in extract-attachments.md (#2285) by @ageitgey
• Add Alexey Paramonov as a contributor for #2280 by @MartinThoma

Maintenance (MAINT)

• Update sample-files by @MartinThoma

Full Changelog

Version 3.17.0, 2023-10-29

What's new

Security (SEC)

• Infinite recursion when using PdfWriter(clone_from=reader) (#2264) by @Alexhuszagh

New Features (ENH)

• Add parameter to select images to be removed (#2214) by @pubpub-zz

Bug Fixes (BUG)

• Correctly handle image mode 1 with FlateDecode (#2249) by @stefan6419846
• Error when filling a value with parentheses #2268 (#2269) by @KanorUbu
• Handle empty root outline (#2239) by @pubpub-zz

Documentation (DOC)

• Improve merging docs (#2247) by @stefan6419846

Developer Experience (DEV)

• Test Python 3.7 with cryptopgraphy provider as well (#2276) by @stefan6419846
• Run CI with windows-latest (#2258) by @MartinThoma
• Use pytest-xdist (#2254) by @MartinThoma
• Attribute correct authors in the release notes (#2246) by @stefan6419846

Maintenance (MAINT)

• Apply pre-commit hooks (#2277) by @MartinThoma
• Update requirements + mypy fixes (#2275) by @MartinThoma
• Explicitly provide Any for IO generic argument (#2272) by @nilehmann

Testing (TST)

• Fix test_image_without_pillow in windows environment (#2257) by @pubpub-zz

Code Style (STY)

• Remove unused import by @MartinThoma

Full Changelog

Version 3.16.4, 2023-10-10

What's new

Bug Fixes (BUG)

• Avoid exceeding recursion depth when retrieving image mode (#2251) by @stefan6419846

Maintenance (MAINT)

• Bump sample-files by @MartinThoma

Full Changelog

Version 3.16.3, 2023-10-08

What's new

Bug Fixes (BUG)

• invalid cm/tm in visitor functions (#2206) by @pubpub-zz
• Encrypt / decrypt Stream object dictionaries (#2228) by @pilotandy
• Support nested color spaces for the /DeviceN color space (#2241) by @stefan6419846
• images property fails if NullObject in list (#2215) by @pubpub-zz

Robustness (ROB)

• XYZ destination to cope with missing left and top param (#2237) by @pubpub-zz

Documentation (DOC)

• Add pilotandy for #2228 as a contributor by @MartinThoma
• Link to CONTRIBUTING.md in README.md (#2232) by @markpfeifle
• Changelog by @MartinThoma

Developer Experience (DEV)

• Exclude tests from mypy checks by @MartinThoma
• Unify mypy options and warn redundant workarounds (#2223) by @exiledkingcc
• Stabilize Pillow test with Pillow missing (#2229) by @stefan6419846

Maintenance (MAINT)

• Update pinned packages (#2243) by @MartinThoma

Testing (TST)

• Regression test against non-deterministic accidental object reuse (#2244) by @sjoerdjob

Full Changelog

Version 3.16.2, 2023-09-24

What's new

Bug Fixes (BUG)

• PDF size increases because of too high float writing precision (#2213) by @pubpub-zz
• Fix test_watermarking_reportlab_rendering() (#2203) by @Lucas-C

Documentation (DOC)

• Fix typos and add a paragraph to ViewerPreferences docs (#2199) by @marcstober
• How to install pypi from any branch (#2209) by @pubpub-zz
• Update copyright footer in docs (#2207) by @marcstober

Developer Experience (DEV)

• Let dependabot update Github Actions by @MartinThoma

Maintenance (MAINT)

• Update .pre-commit-config.yaml by @MartinThoma

Full Changelog

Version 3.16.1, 2023-09-17

What's new

Bug Fixes (BUG)

• Missing new line in extract_text with cm operations (#2142) by @pubpub-zz
• _get_fonts not processing properly CIDFonts and annotations (#2194) by @pubpub-zz

Documentation (DOC)

• Sort list of contributors by @MartinThoma

Developer Experience (DEV)

• Give attribution in release notes (#2196) by @MartinThoma

Maintenance (MAINT)

• Update packages (#2195) by @MartinThoma
• Rename PdfWriter.create_viewer_preferences to PdfWriter.create_viewer_preferences (#2190) by @marcstober
• Mark cryptography as default (#2186) by @exiledkingcc

Testing (TST)

• Issue with merging pdfkit (#2191) by @MartinThoma

Code Style (STY)

• clean-up overriden variable (#2189) by @pubpub-zz

Full Changelog