Update dependency PyPDF2 to v3 (!44) · Merge requests · Documento / documento-client

Remove 'mine' as PdfMerger always creates the stream (#1261)
Let PdfMerger._create_stream raise NotImplemented (#1251)
password param of _security._alg32(...) is only a string, not bytes (#1259)
Remove unreachable code in read_block_backwards (#1250) and sign function in _extract_text (#1262)

Testing (TST)

Delete annotations (#1263)
Close PdfMerger in tests (#1260)
PdfReader.xmp_metadata workflow (#1257)
Various PdfWriter (Layout, Bookmark deprecation) (#1249)

Full Changelog

`v2.10.2`

Compare Source

BUG: Add PyPDF2.generic to PyPI distribution

`v2.10.1`

Compare Source

Bug Fixes (BUG)

TreeObject.remove_child had a non-PdfObject assignment for Count (#1233, #1234)
Fix stream truncated prematurely (#1223)

Documentation (DOC)

Fix docstring formatting (#1228)

Maintenance (MAINT)

Split generic.py (#1229)

Testing (TST)

Decrypt AlgV4 with owner password (#1239)
AlgV5.generate_values (#1238)
TreeObject.remove_child / empty_tree (#1235, #1236)
create_string_object (#1232)
Free-Text annotations (#1231)
generic._base (#1230)
Strict get fonts (#1226)
Increase PdfReader coverage (#1219, #1225)
Increase PdfWriter coverage (#1237)
100% coverage for utils.py (#1217)
PdfWriter exception non-binary stream (#1218)
Don't check coverage for deprecated code (#1216)

Full Changelog

`v2.10.0`

Compare Source

New Features (ENH)

"with" support for PdfMerger and PdfWriter (#1193)
Add AnnotationBuilder.text(...) to build text annotations (#1202)

Bug Fixes (BUG)

Allow IndirectObjects as stream filters (#1211)

Documentation (DOC)

Font scrambling
Page vs Content scaling (#1208)
Example for orientation parameter of extract_text (#1206)
Fix AnnotationBuilder parameter formatting (#1204)

Developer Experience (DEV)

Add flake8-print (#1203)

Maintenance (MAINT)

Introduce WrongPasswordError / FileNotDecryptedError / EmptyFileError (#1201)

Full Changelog

`v2.9.0`

Compare Source

New Features (ENH)

Add ability to add hex encoded colors to outline items (#1186)
Add support for pathlib.Path in PdfMerger.merge (#1190)
Add link annotation (#1189)
Add capability to filter text extraction by orientation (#1175)

Bug Fixes (BUG)

Named Dest in PDF1.1 (#1174)
Incomplete Graphic State save/restore (#1172)

Documentation (DOC)

Update changelog url in package metadata (#1180)
Mention camelot for table extraction (#1179)
Mention pyHanko for signing PDF documents (#1178)
Weow have CMAP support since a while (#1177)

Maintenance (MAINT)

Consistent usage of warnings / log messages (#1164)
Consistent terminology for outline items (#1156)

Full Changelog

`v2.8.1`

Compare Source

Bug Fixes (BUG)

u_hash in AlgV4.compute_key (#1170)

Robustness (ROB)

Fix loading of file from #134 (#1167)
Cope with empty DecodeParams (#1165)

Documentation (DOC)

Typo in merger deprecation warning message (#1166)

Maintenance (MAINT)

Package updates; solve mypy strict remarks (#1163)

Testing (TST)

Add test from #325 (#1169)

Full Changelog

`v2.8.0`

Compare Source

New Features (ENH)

Add writer.add_annotation, page.annotations, and generic.AnnotationBuilder (#1120)

Bug Fixes (BUG)

Set /AS for /Btn form fields in writer (#1161)
Ignore if /Perms verify failed (#1157)

Robustness (ROB)

Cope with utf16 character for space calculation (#1155)
Cope with null params for FitH / FitV destination (#1152)
Handle outlines without valid destination (#1076)

Developer Experience (DEV)

Introduce _utils.logger_warning (#1148)

Maintenance (MAINT)

Break up parse_to_unicode (#1162)
Add diagnostic output to exception in read_from_stream (#1159)
Reduce PdfReader.read complexity (#1151)

Testing (TST)

Add workflow tests found by arc testing (#1154)
Decrypt file which is not encrypted (#1149)
Test CryptRC4 encryption class; test image extraction filters (#1147)

Full Changelog

`v2.7.0`

Compare Source

New Features (ENH)

Add outline_count property (#1129)

Bug Fixes (BUG)

Make reader.get_fields also return dropdowns with options (#1114)
Add deprecated EncodedStreamObject functions back until PyPDF2==3.0.0 (#1139)

Robustness (ROB)

Cope with missing /W entry (#1136)
Cope with invalid parent xref (#1133)

Documentation (DOC)

Contributors file (#1132)
Fix type in signature of PdfWriter.add_uri (#1131)

Developer Experience (DEV)

Add .git-blame-ignore-revs (#1141)

Code Style (STY)

Fixing typos (#1137)
Reuse code via get_outlines_property in tests (#1130)

Full Changelog

`v2.6.0`

Compare Source

New Features (ENH)

Add color and font_format to PdfReader.outlines[i] (#1104)
Extract Text Enhancement (whitespaces) (#1084)

Bug Fixes (BUG)

Use build_destination for named destination outlines (#1128)
Avoid a crash when a ToUnicode CMap has an empty dstString in beginbfchar (#1118)
Prevent deduplication of PageObject (#1105)
None-check in DictionaryObject.read_from_stream (#1113)
Avoid IndexError in _cmap.parse_to_unicode (#1110)

Documentation (DOC)

Explanation for git submodule
Watermark and stamp (#1095)

Maintenance (MAINT)

Text extraction improvements (#1126)
Destination.color returns ArrayObject instead of tuple as fallback (#1119)
Use add_bookmark_destination in add_bookmark (#1100)
Use add_bookmark_destination in add_bookmark_dict (#1099)

Testing (TST)

Add test for arab text (#1127)
Add xfail for decryption fail (#1125)
Add xfail test for IndexError when extracting text (#1124)
Add MCVE showing outline title issue (#1123)

Code Style (STY)

Use IntFlag for permissions_flag / update_page_form_field_values (#1094)
Simplify code (#1101)

Full Changelog

`v2.5.0`

Compare Source

New Features (ENH)

Add support for indexed color spaces / BitsPerComponent for decoding PNGs (#1067)
Add PageObject._get_fonts (#1083)

Performance Improvements (PI)

Use iterative DFS in PdfWriter._sweep_indirect_references (#1072)

Bug Fixes (BUG)

Let Page.scale also scale the crop-/trim-/bleed-/artbox (#1066)
Column default for CCITTFaxDecode (#1079)

Robustness (ROB)

Guard against None-value in _get_outlines (#1060)

Documentation (DOC)

Stamps and watermarks (#1082)
OCR vs PDF text extraction (#1081)
Python Version support
Formatting of CHANGELOG

Developer Experience (DEV)

Cache downloaded files (#1070)
Speed-up for CI (#1069)

Maintenance (MAINT)

Set page.rotate(angle: int) (#1092)
Issue #416 was fixed by #1015 (#1078)

Testing (TST)

Image extraction (#1080)
Image extraction (#1077)

Code Style (STY)

Apply black
Typo in Changelog

Full Changelog

`v2.4.2`

Compare Source

New Features (ENH)

Add PdfReader.xfa attribute (#1026)

Bug Fixes (BUG)

Wrong page inserted when PdfMerger.merge is done (#1063)
Resolve IndirectObject when it refers to a free entry (#1054)

Developer Experience (DEV)

Added {posargs} to tox.ini (#1055)

Maintenance (MAINT)

Remove PyPDF2._utils.bytes_type (#1053)

Testing (TST)

Scale page (indirect rect object) (#1057)
Simplify pathlib PdfReader test (#1056)
IndexError of VirtualList (#1052)
Invalid XML in xmp information (#1051)
No pycryptodome (#1050)
Increase test coverage (#1045)

Code Style (STY)

DOC of compress_content_streams (#1061)
Minimize diff for #879 (#1049)

Full Changelog

`v2.4.1`

Compare Source

New Features (ENH)

Add writer.pdf_header property (getter and setter) (#1038)

Performance Improvements (PI)

Remove b_ call in FloatObject.write_to_stream (#1044)
Check duplicate objects in writer._sweep_indirect_references (#207)

Documentation (DOC)

How to surppress exceptions/warnings/log messages (#1037)
Remove hyphen from lossless (#1041)
Compression of content streams (#1040)
Fix inconsistent variable names in add-watermark.md (#1039)
File size reduction
Add CHANGELOG to the rendered docs (#1023)

Maintenance (MAINT)

Handle XML error when reading XmpInformation (#1030)
Deduplicate Code / add mutmut config (#1022)

Code Style (STY)

Use unnecessary one-line function / class attribute (#1043)
Docstring formatting (#1033)

Full Changelog

`v2.4.0`

Compare Source

New Features (ENH):

Support R6 decrypting (#1015)
Add PdfReader.pdf_header (#1013)

Performance Improvements (PI):

Remove ord_ calls (#1014)

Bug Fixes (BUG):

Fix missing page for bookmark (#1016)

Robustness (ROB):

Deal with invalid Destinations (#1028)

Documentation (DOC):

get_form_text_fields does not extract dropdown data (#1029)
Adjust PdfWriter.add_uri docstring
Mention crypto extra_requires for installation (#1017)

Developer Experience (DEV):

Use /n line endings everywhere (#1027)
Adjust string formatting to be able to use mutmut (#1020)
Update Bug report template

Full Changelog

`v2.3.1`

Compare Source

BUG: Forgot to add the internal _codecs subpackage.

Full Changelog

`v2.3.0`

Compare Source

The highlight of this release is improved support for file encryption (AES-128 and AES-256, R5 only). See #749 for the amazing work of @exiledkingcc 🎊 Thank you 🤗

Deprecations (DEP)

Rename names to be PEP8-compliant (#967)
PdfWriter.get_page: the pageNumber parameter is renamed to page_number
PyPDF2.filters:
- For all classes, a parameter rename: decodeParms ➔ decode_parms
- decodeStreamData ➔ decode_stream_data
PyPDF2.xmp:
- XmpInformation.rdfRoot ➔ XmpInformation.rdf_root
- XmpInformation.xmp_createDate ➔ XmpInformation.xmp_create_date
- XmpInformation.xmp_creatorTool ➔ XmpInformation.xmp_creator_tool
- XmpInformation.xmp_metadataDate ➔ XmpInformation.xmp_metadata_date
- XmpInformation.xmp_modifyDate ➔ XmpInformation.xmp_modify_date
- XmpInformation.xmpMetadata ➔ XmpInformation.xmp_metadata
- XmpInformation.xmpmm_documentId ➔ XmpInformation.xmpmm_document_id
- XmpInformation.xmpmm_instanceId ➔ XmpInformation.xmpmm_instance_id
PyPDF2.generic:
- readHexStringFromStream ➔ read_hex_string_from_stream
- initializeFromDictionary ➔ initialize_from_dictionary
- createStringObject ➔ create_string_object
- TreeObject.hasChildren ➔ TreeObject.has_children
- TreeObject.emptyTree ➔ TreeObject.empty_tree

New Features (ENH)

Add decrypt support for V5 and AES-128, AES-256 (R5 only) (#749)

Robustness (ROB)

Fix corrupted (wrongly) linear PDF (#1008)

Maintenance (MAINT)

Move PDF_Samples folder into resources
Fix typos (#1007)

Testing (TST)

Improve encryption/decryption test (#1009)
Add merger test cases with real PDFs (#1006)
Add mutmut config

Code Style (STY)

Put pure data mappings in separate files (#1005)
Make encryption module private, apply pre-commit (#1010)

Full Changelog

`v2.2.1`

Compare Source

Performance Improvements (PI)

Remove b_ calls (#992, #986)
Apply improvements to _utils suggested by perflint (#993)

Robustness (ROB)

utf-16-be codec can't decode (...) (#995)

Documentation (DOC)

Remove reference to Scripts (#987)

Developer Experience (DEV)

Fix type annotations for add_bookmarks (#1000)

Testing (TST)

Add test for PdfMerger (#1001)
Add tests for XMP information (#996)
reader.get_fields / zlib issue / LZW decode issue (#1004)
reader.get_fields with report generation (#1002)
Improve test coverage by extracting texts (#998)

Code Style (STY)

Apply fixes suggested by pylint (#999)

Full Changelog

`v2.2.0`

Compare Source

The 2.2.0 release improves text extraction again via (#969):

Improvements around /Encoding / /ToUnicode
Extraction of CMaps improved
Fallback for font def missing
Support for /Identity-H and /Identity-V: utf-16-be
Support for /GB-EUC-H / /GB-EUC-V / GBp/c-EUC-H / /GBpc-EUC-V (beta release for evaluation)
Arabic (for evaluation)
Whitespace extraction improvements

Those changes should mainly improve the text extraction for non-ASCII alphabets, e.g. Russian / Chinese / Japanese / Korean / Arabic.

Full Changelog

`v2.1.1`

Compare Source

New Features (ENH)

Add support for pathlib as input for PdfReader (#979)

Performance Improvements (PI)

Optimize read_next_end_line (#646)

Bug Fixes (BUG)

Adobe Acrobat 'Would you like to save this file?' (#970)

Documentation (DOC)

Notes on annotations (#982)
Who uses PyPDF2
intendet \xe2\x9e\x94 in robustness page (#958)

Maintenance (MAINT)

pre-commit / requirements.txt updates (#977)
Mark read_next_end_line as deprecated (#965)
Export PageObject in PyPDF2 root (#960)

Testing (TST)

Add MCVE of issue #416 (#980)
FlateDecode.decode decodeParms (#964)
Xmp module (#962)
utils.paeth_predictor (#959)

Code Style (STY)

Use more tuples and list/dict comprehensions (#976)

Full Changelog

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)
  - Unable to read bullets (#230)
- 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

`v2.0.0`

Compare Source

The 2.0.0 release of PyPDF2 includes three core changes:

Dropping support for Python 3.5 and older.
Introducing type annotations.
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 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)

Create flake8 config file (#916)
Use relative imports (#875)

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

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 Aug 14, 2024 by Tine Wittler