Skip to content

Update dependency PyPDF2 to v2 - autoclosed

Tine Wittler requested to merge renovate/pypdf2-2.x into master

This MR contains the following updates:

Package Type Update Change
PyPDF2 (source, changelog) dependencies major ^1.26.0 -> ^2.0.0

Release Notes

py-pdf/PyPDF2

v2.1.0

Compare Source

The highlight of the 2.1.0 release is the most massive improvement to the text extraction capabilities of PyPDF2 since 2016 🥳🎊 A very big thank you goes to pubpub-zz who took a lot of time and knowledge about the PDF format to finally get those improvements into PyPDF2. Thank you 🤗💚

In case the new function causes any issues, you can use _extract_text_old for the old functionality. Please also open a bug ticket in that case.

There were several people who have attempted to bring similar improvements to PyPDF2. All of those were valuable. The main reason why they didn't get merged is the big amount of open MRs / issues. pubpub-zz was the most comprehensive MR which also incorporated the latest changes of PyPDF2 2.0.0.

Thank you to VictorCarlquist for #​858 and asabramo for #​464 🤗

New Features (ENH):

  • Massive text extraction improvement (#​924). Closed many open issues:
    • Exceptions / missing spaces in extract_text() method (#​17) 🕺
      • Whitespace issues in extract_text() (#​42) 💃
      • pypdf2 reads the hifenated words in a new line (#​246)
    • PyPDF2 failing to read unicode character (#​37)
    • ExtractText yields nothing for apparently good PDF (#​168) 🎉
    • Encoding issue in extract_text() (#​235)
    • extractText() doesn't work on Chinese PDF (#​252)
    • encoding error (#​260)
    • Trouble with apostophes in names in text "O'Doul" (#​384)
    • extract_text works for some PDF files, but not the others (#​437)
    • Euro sign not being recognized by extractText (#​443)
    • Failed extracting text from French texts (#​524)
    • extract_text doesn't extract ligatures correctly (#​598)
    • reading spanish text - mark convert issue (#​635)
    • Read PDF changed from text to random symbols (#​654)
    • .extractText() reads / as 1. (#​789)
  • Update glyphlist (#​947) - inspired by #​464
  • Allow adding PageRange objects (#​948)

Bug Fixes (BUG):

  • Delete .python-version file (#​944)
  • Compare StreamObject.decoded_self with None (#​931)

Robustness (ROB):

  • Fix some conversion errors on non conform PDF (#​932)

Documentation (DOC):

  • Elaborate on PDF text extraction difficulties (#​939)
  • Add logo (#​942)
  • rotate vs Transformation().rotate (#​937)
  • Example how to use PyPDF2 with AWS S3 (#​938)
  • How to deprecate (#​930)
  • Fix typos on robustness page (#​935)
  • Remove scripts (pdfcat) from docs (#​934)

Developer Experience (DEV):

  • Ignore .python-version file
  • Mark deprecated code with no-cover (#​943)
  • Automatically create Github releases from tags (#​870)

Testing (TST):

  • Text extraction for non-latin alphabets (#​954)
  • Ignore PdfReadWarning in benchmark (#​949)
  • writer.remove_text (#​946)
  • Add test for Tree and _security (#​945)

Code Style (STY):

  • black, isort, Flake8, splitting buildCharMap (#​950)

Full Changelog: https://github.com/py-pdf/PyPDF2/compare/2.0.0...2.1.0

v2.0.0

Compare Source

The 2.0.0 release of PyPDF2 includes three core changes:

  1. Dropping support for Python 3.5 and older.
  2. Introducing type annotations.
  3. Interface changes, mostly to have PEP8-compliant names

We introduced a deprecation process that hopefully helps users to avoid unexpected breaking changes.

Breaking Changes(DEP):

  • PyPDF2 2.0 requires Python 3.6+. Python 2.7 and 3.5 support were dropped.
  • PdfFileReader: The "warndest" parameter was removed
  • PdfFileReader and PdfFileMerger no longer have the overwriteWarnings parameter. The new behavior is overwriteWarnings=False.
  • merger: OutlinesObject was removed without replacement.
  • merger.py ➔ _merger.py: You must import PdfFileMerger from PyPDF2 directly.
  • utils:
    • ConvertFunctionsToVirtualList was removed
    • formatWarning was removed
    • isInt(obj): Use instance(obj, int) instead
    • u_(s): Use s directly
    • chr_(c): Use chr(c) instead
    • barray(b): Use bytearray(b) instead
    • isBytes(b): Use instance(b, type(bytes())) instead
    • xrange_fn: Use range instead
    • string_type: Use str instead
    • isString(s): Use instance(s, str) instead
    • _basestring: Use str instead
    • All Exceptions are now in PyPDF2.errors:
      • PageSizeNotDefinedError
      • PdfReadError
      • PdfReadWarning
      • PyPdfError
  • PyPDF2.pdf (the pdf module) no longer exists. The contents were moved with the library. You should most likely import directly from PyPDF2 instead. The RectangleObject is in PyPDF2.generic.
  • The Resources, Scripts, and Tests will no longer be part of the distribution files on PyPI. This should have little to no impact on most people. The Tests are renamed to tests, the Resources are renamed to resources. Both are still in the git repository. The Scripts are now in https://github.com/py-pdf/cpdf. Sample_Code was moved to the docs.

For a full list of deprecated functions, please see the changelog of version 1.28.0.

New Features (ENH):

  • Improve space setting for text extraction (#​922)
  • Allow setting the decryption password in PdfReader.init (#​920)
  • Add Page.add_transformation (#​883)

Bug Fixes (BUG):

  • Fix error adding transformation to page without /Contents (#​908)

Robustness (ROB):

  • Cope with invalid length in streams (#​861)

Documentation (DOC):

  • Fix style of 1.25 and 1.27 patch notes (#​927)
  • Transformation (#​907)

Developer Experience (DEV):

Maintenance (MAINT):

  • Use Python 3.6 language features (#​849)
  • Add wrapper function for PendingDeprecationWarnings (#​928)
  • Use new PEP8 compliant names (#​884)
  • Explicitly represent transformation matrix (#​878)
  • Inline PAGE_RANGE_HELP string (#​874)
  • Remove unnecessary generics imports (#​873)
  • Remove star imports (#​865)
  • merger.py ➔ _merger.py (#​864)
  • Type annotations for all functions/methods (#​854)
  • Add initial type support with mypy (#​853)

Testing (TST):

  • Regression test for xmp_metadata converter (#​923)
  • Checkout submodule sample-files for benchmark
  • Add text extracting performance benchmark
  • Use new PyPDF2 API in benchmark (#​902)
  • Make test suite fail for uncaught warnings (#​892)
  • Remove -OO testrun from CI (#​901)
  • Improve tests for convert_to_int (#​899)

Full Changelog: https://github.com/py-pdf/PyPDF2/compare/1.28.4...2.0.0

Configuration

📅 Schedule: At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this MR and you won't be reminded about this update again.

  • If you want to rebase/retry this MR, click this checkbox.

This MR has been generated by Renovate Bot.

Edited by Tine Wittler

Merge request reports