- Add
layout_mode_font_height_weightargument toPageObject.extract_text()(#2920)
- Fix font specificier for FreeText annotation (#2893)
- Line breaks are not generated due to incorrect calculation of text leading (#2890)
- Improve handling of spaces in text extraction (#2882)
- Soft failure for flate encode image mode 1 with wrong LUT size (#2900)
- Use latest package versions (#2907)
- Correct example of reading FileAttachment annotation (#2906)
- Update pinned requirements (#2918)
- Make make_release.py compatible with Windows environment (#2894)
- Remove references to outdated Python versions (#2919)
- Generalize the method of obtaining space_code (#2891)
- Unnecessary character mapping process (#2888)
- New LZW decoding implementation (#2887)
- Add LzwCodec for encoding (#2883)
- Capitalize error messages (#2903)
- Modify error messages in PdfWriter (#2902)
- Add
fullparameter to PdfWriter constructor (#2865)
- Update pyproject.toml with minimum Python version of 3.8 (#2859)
- Cope with unbalanced delimiters in dictionary object (#2878)
- Cope with encoding with too many differences (#2873)
- Missing spaces in extract_text() method (#1328) (#2868)
- Tolerate truncated files and no warning when jumping startxref (#2855)
- Repair PDF with invalid Root object (#2880)
- Continue parsing dictionary object when error is detected (#2872)
- Merge documents with invalid pages in named destinations (#2857)
- Tolerate comments in arrays (#2856)
- Use latest Python version for benchmarking (#2879)
- Add tests to source distributions (#2874)
- Refactor _update_field_annotation (#2862)
This version drops support for Python 3.7 (not maintained since July 2023), PdfMerger (use PdfWriter instead) and AnnotationBuilder (use annotations instead).
- Remove the deprecated PfdMerger and AnnotationBuilder classes and other deprecations cleanup (#2813)
- Drop Python 3.7 support (#2793)
- Add capability to remove /Info from PDF (#2820)
- Add incremental capability to PdfWriter (#2811)
- Add UniGB-UTF16 encodings (#2819)
- Accept utf strings for metadata (#2802)
- Report PdfReadError instead of RecursionError (#2800)
- Compress PDF files merging identical objects (#2795)
- Fix sheared image (#2801)
- Robustify .set_data() (#2821)
- Raise PdfReadError when missing /Root in trailer (#2808)
- Fix extract_text() issues on damaged PDFs (#2760)
- Handle images with empty data when processing an image from bytes (#2786)
- Fix coverage uploads (#2832)
- Test against Python 3.13 (#2776)
- Cope with Matrix entry in field annotations (#2736)
- Cope with fields with upside down box/rectangle (#2729)
- Add deprecate_with_replacement to StreamObject.initializeFromD… (#2728)
- Deal with cryptography>=43 moving ARC4 (#2765)
- Accept ETen-B5 and UniCNS-UTF16 encodings (#2721)
- Add decode_as_image() to ContentStreams (#2615)
- context manager for PdfReader (#2666)
- Add capability to set font and size in fields (#2636)
- Allow to pass input file without named argument (#2576)
- Fix deprecation for Ressources when using old constants (#2705)
- Fix images issue 4 bits encoding and LUT starting with UTF16_BOM (#2675)
- Reading large compressed images takes huge time to process (#2644)
- Highlighted Text Cannot Be Printed (#2604)
- Fix UnboundLocalError on malformed pdf (#2619)
- Cope with missing Standard 14 fonts in fields (#2677)
- Improve inline image extraction (#2622)
- Cope with loops in Fields tree (#2656)
- Discard /I in choice fields for compatibility with Acrobat (#2614)
- Cope with some issues in pillow (#2595)
- Cope with some image extraction issues (#2591)
- Various improvements on docstrings and examples
- Deprecate interiour_color with replacement interior_color (#2706)
- Add deprecate_with_replacement to PdfWriter.find_bookmark (#2674)
- Change Link to be a non-markup annotation (#2714)
- Allow multiple charsets for NameObject.read_from_stream (#2585)
- Add support for /Kids in page labels (#2562)
- Allow to update fields on many pages (#2571)
- Tolerate PDF with invalid xref pointed objects (#2335)
- Add Enforce from PDF2.0 in viewer_preferences (#2511)
- Add += and -= operators to ArrayObject (#2510)
- Fix merge_page sometimes generating unknown operator 'QQ' (#2588)
- Fix fields update where annotations are kids of field (#2570)
- Process CMYK images without a filter correctly (#2557)
- Extract text in layout mode without finding resources (#2555)
- Prevent recursive loop in some PDF files (#2505)
- Tolerate "truncated" xref (#2580)
- Replace error by warning for EOD in RunLengthDecode/ASCIIHexDecode (#2334)
- Rebuild xref table if one entry is invalid (#2528)
- Robustify stream extraction (#2526)
- Update release process for latest changes (#2564)
- Encryption/decryption: Clone document instead of copying all pages (#2546)
- Minor improvements (#2542)
- Update annotation list (#2534)
- Update references and formatting (#2529)
- Correct threads reference, plus minor changes (#2521)
- Minor readability increases (#2515)
- Simplify PaperSize examples (#2504)
- Minor improvements (#2501)
- Remove unused dependencies (#2572)
- Remove page labels PR link from message (#2561)
- Fix changelog generator regarding whitespace and handling of "Other" group (#2492)
- Add REL to known PR prefixes (#2554)
- Release using the REL commit instead of git tag (#2500)
- Unify code between PdfReader and PdfWriter (#2497)
- Bump softprops/action-gh-release from 1 to 2 (#2514)
- Ressources → Resources (and internal name childs) (#2550)
- Fix typos found by codespell (#2549)
- Update Read the Docs configuration (#2538)
- Add root_object, _info and _ID to PdfReader (#2495)
- Allow loading truncated images if required (#2586)
- Fix download issues from #2562 (#2578)
- Improve test_get_contents_from_nullobject to show real use-case (#2524)
- Add missing test annotations (#2507)
Generating name objects (NameObject) without a leading slash
is considered deprecated now. Previously, just a plain warning
would be logged, leading to possibly invalid PDF files. According
to our deprecation policy, this will log a DeprecationWarning
for now.
- Add get_pages_from_field (#2494)
- Add reattach_fields function (#2480)
- Automatic access to pointed object for IndirectObject (#2464)
- Missing error on name without leading / (#2387)
- encode_pdfdocencoding() always returns bytes (#2440)
- BI in text content identified as image tag (#2459)
- Missing basefont entry in type 3 font (#2469)
- Improve lossless compression example (#2488)
- Amend robustness documentation (#2479)
- Fix changelog for UTF-8 characters (#2462)
- Add _get_page_number_from_indirect in writer (#2493)
- Remove user assignment for feature requests (#2483)
- Remove reference to old 2.0.0 branch (#2482)
- Fix benchmark failures (#2481)
- Broken test due to expired test file URL (#2468)
- Resolve file naming conflict in test_iss1767 (#2445)
- Use NumberObject for /Border elements of annotations (#2451)
- layout mode text extraction ZeroDivisionError (#2417)
- Skip tests using fpdf2 if it's not installed (#2419)
- Drop Python 3.6 support (#2369)
- Remove deprecated code (#2367)
- Remove deprecated XMP properties (#2386)
- Add "layout" mode for text extraction (#2388)
- Add Jupyter Notebook integration for PdfReader (#2375)
- Improve/rewrite PDF permission retrieval (#2400)
- PdfWriter.add_uri was setting the wrong type (#2406)
- Add support for GBK2K cmaps (#2385)
- Return None instead of -1 when page is not attached (#2376)
- Complete FileSpecificationDictionaryEntries constants (#2416)
- Replace warning with logging.error (#2377)
- Handle IndirectObject as image filter (#2355)
- Out-of-bounds issue in handle_tj (text extraction) (#2342)
- Make make_release.py easier to configure (#2348)
- Bump actions/download-artifact from 3 to 4 (#2344)
- Cope with deflated images with CMYK Black Only (#2322)
- Handle indirect objects as parameters for CCITTFaxDecode (#2307)
- check words length in _cmap type1_alternative function (#2310)
- Relax flate decoding for too many lookup values (#2331)
- Let _build_destination skip in case of missing /D key (#2018)
- Mediabox expansion size when applying non-right angle rotation (#2282)
- MissingWidth is IndirectObject (#2288)
- Initialize states array with an empty value (#2280)
- Infinite recursion when using PdfWriter(clone_from=reader) (#2264)
- Add parameter to select images to be removed (#2214)
- Correctly handle image mode 1 with FlateDecode (#2249)
- Error when filling a value with parentheses #2268 (#2269)
- Handle empty root outline (#2239)
- Avoid exceeding recursion depth when retrieving image mode (#2251)
- Invalid cm/tm in visitor functions (#2206)
- Encrypt / decrypt Stream object dictionaries (#2228)
- Support nested color spaces for the /DeviceN color space (#2241)
- Images property fails if NullObject in list (#2215)
- Unify mypy options and warn redundant workarounds (#2223)
- PDF size increases because of too high float writing precision (#2213)
- Fix test_watermarking_reportlab_rendering() (#2203)
- Missing new line in extract_text with cm operations (#2142)
- _get_fonts not processing properly CIDFonts and annotations (#2194)
- Rename PdfWriter.create_viewer_preference to PdfWriter.create_viewer_preferences (#2190)
- Infinite recursion caused by IndirectObject clone (#2156)
- Ease access to ViewerPreferences (#2144)
- Catch the case where w[0] is an IndirectObject instead of an int (#2154)
- Cope with indirect objects in filters and remove deprecated code (#2177)
- Accept tabs in cmaps (#2174) / cope with extra space (#2151)
- Merge pages without resources (#2150)
- getcontents() shall return None if contents is NullObject (#2161)
- Fix conversion from 1 to LA (#2175)
- Accept XYZ with no arguments (#2178)
- Cope with missing /I in articles (#2134)
- Fix image look-up table in EncodedStreamObject (#2128)
- remove_images not operating in sub level forms (#2133)
- Cope with damaged PDF (#2129)
- Making pypdf as fast as pdfrw (#2086)
- Relax typing_extensions version (#2104)
- Check version of crypt provider (#2115)
- TypeError: can't concat str to bytes (#2114)
- Require flit_core >= 3.9 (#2091)
- Avoid endless recursion of reading damaged PDF file (#2093)
- Reuse content stream (#2101)
- Make ParseError inherit from PyPdfError (#2097)
- optimize _decode_png_prediction (#2068)
- Fix incorrect tm_matrix in call to visitor_text (#2060)
- Writing German characters into form fields (#2047)
- Prevent stall when accessing image in corrupted pdf (#2081)
- append() fails when articles do not have /T (#2080)
- Cope with xref not followed by separator (#2083)
- Add
levelparameter to compress_content_streams (#2044) - Process /uniHHHH for text_extract (#2043)
- Fix AnnotationBuilder.link (#2066)
- JPX image without ColorSpace (#2062)
- Added check for field /Info when cloning reader document (#2055)
- Fix indexed/CMYK images (#2039)
- Cryptography as primary dependency (#2053)
- Accelerate image list keys generation (#2014)
- Use
cryptographyfor encryption/decryption as a fallback for PyCryptodome (#2000) - Extract LaTeX characters (#2016)
- ASCIIHexDecode.decode now returns bytes instead of str (#1994)
- Add RunLengthDecode filter (#2012)
- Process /Separation ColorSpace (#2007)
- Handle single element ColorSpace list (#2026)
- Process lookup decoded as TextStringObjects (#2008)
- Cope with garbage collector during cloning (#1841)
- Cleanup of annotations (#1745)
- Add is_open in outlines in PdfReader and PdfWriter (#1960)
- Search /DA in hierarchy fields (#2002)
- Cope with different ISO date length (#1999)
- Decode Black only/CMYK deviceN images (#1984)
- Process CMYK in deflate images (#1977)
- Add mypy to pre-commit (#2001)
- Release automation (#1991, #1985)
- Accept calRGB and calGray color_spaces (#1968)
- Process 2bits and 4bits images (#1967)
- Check for AcroForm and ensure it is not None (#1965)
- Automate the release process (#1970)
- Prevent updating page contents after merging page (stamping/watermarking) (#1952)
- % to be hex encoded in names (#1958)
- Inverse color in CMYK images (#1947)
- Dates conversion not working with Z00'00' (#1946)
- Support UTF-16-LE Strings (#1884)
- Add AES support for encrypting PDF files (#1918, #1935, #1936, #1938)
- Add page deletion feature to PdfWriter (#1843)
- PdfReader.get_fields() attempts to delete non-existing index "/Off" (#1933)
- Remove unused objects when cloning_from (#1926)
- Add the TK.SIZE into the trailer (#1911)
- add_named_destination() maintains named destination list sort order (#1930)
- Cascaded filters in image objects (#1913)
- Append pdf with named destination using numbers for pages (#1858)
- Ignore "/B" fields only on pages in PdfWriter.append() (#1875)
- Add page_number property (#1856)
- File expansion when updating with Page Contents (#1906)
- Missing Alternate in indexed/ICCbased colorspaces (#1896)
- Extraction of inline images (#1850)
- Add capability to replace image (#1849)
- Extend images interface by returning an ImageFile(File) class (#1848)
- Add set_data to EncodedStreamObject (#1854)
- Fix RGB FlateEncode Images(PNG) and transparency (#1834)
- Generate static appearance for fields (#1864)
- Deprecate PdfMerger (#1866)
- Ignore UTF-8 decode errors (#1865)
- Handle missing /Type entry in Page tree (#1859)
- Simplify metadata input (Document Information Dictionary) (#1851)
- Extend cmap compatibility to GBK_EUC_H/V (#1812)
- Prevent infinite loop when no character follows after a comment (#1828)
- get_contents does not return ContentStream (#1847)
- Accept XYZ destination with zoom missing (default to zoom=0.0) (#1844)
- Cope with 1 Bit images (#1815)
- Handle missing /Type entry in Page tree (#1845)
- Expand file size explanations (#1835)
- Add comparison with pdfplumber (#1837)
- Clarify that PyPDF2 is dead (#1827)
- Add Hunter King as Contributor for #1806
- Refactor internal Encryption class (#1821)
- Add R parameter to generate_values (#1820)
- Make encryption_key parameter of write_to_stream optional (#1819)
- Prepare for adding AES encryption support (#1818)
- Convert color space before saving (#1802)
- PDF/A (#1807)
- Use append instead of add_page
- Document core mechanics of pypdf (#1783)
- Add transform method to Transformation class (#1765)
- Cope with UC2 fonts in text_extraction (#1785)
- Invalid startxref pointing 1 char before (#1784)
- Mark code handling old parameters as deprecated (#1798)
- Warn about PDF encryption security (#1755)
- Prevent loop in Cloning (#1770)
- Capture UnicodeDecodeError at PdfReader.pdf_header (#1768)
- Add .readthedocs.yaml and bump docs dependencies using
tox -e deps(#1750, #1752)
- Make make_changelog.py idempotent
- Move generation of file identifiers to a method (#1760)
- Add xmp test (#1775)
- Use Python's secrets module instead of random module (#1748)
- Add AnnotationBuilder.highlight text markup annotation (#1740)
- Add AnnotationBuilder.popup (#1665)
- Add AnnotationBuilder.polyline annotation support (#1726)
- Add clone_from parameter in PdfWriter constructor (#1703)
- 'DictionaryObject' object has no attribute 'indirect_reference' (#1729)
- Handle params NullObject in decode_stream_data (#1738)
- Project scope (#1743)
- Add AnnotationFlag (#1746)
- Add LazyDict.str (#1727)
- Extend PdfWriter.append() to PageObjects (#1704)
- Support qualified names in update_page_form_field_values (#1695)
- Tolerate streams without length field (#1717)
- Accept DictionaryObject in /D of NamedDestination (#1720)
- Widths def in cmap calls IndirectObject (#1719)
- compress_content_stream not readable in Adobe Acrobat (#1698)
- Pass logging parameters correctly in set_need_appearances_writer (#1697)
- Write /Root/AcroForm in set_need_appearances_writer (#1639)
- Allow more whitespaces within linearized file (#1701)
- Some attributes not copied in DictionaryObject._clone (#1635)
- Allow merging multiple time pages with annots (#1624)
- Replace pytest.mark.external by enable_socket (#1657)
- Add reader.attachments public interface (#1611, #1661)
- Add PdfWriter.remove_objects_from_page(page: PageObject, to_delete: ObjectDeletionFlag) (#1648)
- Allow free-text annotation to have transparent border/background (#1664)
- Allow decryption with empty password for AlgV5 (#1663)
- Let PdfWriter.pages return PageObject after calling
clone_document_from_reader()(#1613) - Invalid font pointed during merge_resources (#1641)
- Cope with invalid objects in IndirectObject.clone (#1637)
- Improve tolerance to invalid Names/Dests (#1658)
- Decode encoded values in get_fields (#1636)
- Let PdfWriter.merge cope with missing "/Fields" (#1628)
- Switch from trimbox to cropbox when merging pages (#1622)
- Text extraction not working with one glyph to char sequence (#1620)
- Fix 2 cases of "object has no attribute 'indirect_reference'" (#1616)
- Add multiple retry on get_url for external PDF downloads (#1626)
NOTICE: pypdf changed the way it represents numbers parsed from PDF files. pypdf<3.4.0 represented numbers as Decimal, pypdf>=3.4.0 represents them as floats. Several other PDF libraries to this, as well as many PDF viewers. We hope to fix issues with too high precision like this and get a speed boost. In case your PDF documents rely on more than 18 decimals of precision you should check if it still works as expected. To clarify: This does not affect the text shown in PDF documents. It affects numbers, e.g. when graphics are drawn on the PDF or very exact positions are used. Typically, 5 decimals should be enough.
- Enable merging forms with overlapping names (#1553)
- Add 'over' parameter to merge_transformend_page & co (#1567)
- Fix getter of the PageObject.rotation property with an indirect object (#1602)
- Restore merge_transformed_page & co (#1567)
- Replace decimal by float (#1563)
- PdfWriter.remove_images: /Contents might not be in page_ref (#1598)
- Introduce ruff (#1586, #1609)
- Remove decimal (#1608)
- Add page label support to PdfWriter (#1558)
- Accept inline images with space before EI (#1552)
- Add circle annotation support (#1556)
- Add polygon annotation support (#1557)
- Make merging pages produce a deterministic PDF (#1542, #1543)
- Fix error in cmap extraction (#1544)
- Remove erroneous assertion check (#1564)
- Fix dictionary access of optional page label keys (#1562)
- Set ignore_eof=True for read_until_regex (#1521)
- Paper size (#1550)
- Fix broken combination of dependencies of docs.txt
- Annotate tests appropriately (#1551)
- Accept hierarchical fields (#1529)
- Use google style docstrings (#1534)
- Fix linked markdown documents (#1537)
- Update docs config (#1535)
- Help the specializing adaptive interpreter (#1522)
- Add support for page labels (#1519)
- upgrade clone_document_root (#1520)
Move PyPDF2 to pypdf (#1513). This now it's all lowercase, no number in the name. For installation and for import. PyPDF2 will no longer receive updates. The community should move back to its roots.
If you were still using pyPdf or PyPDF2 < 2.0.0, I recommend reading the migration guide: https://pypdf.readthedocs.io/en/latest/user/migration-1-to-2.html
pypdf==3.1.0 is only different from PyPDF2==3.0.0 in the package name.
Replacing "PyPDF2" by "pypdf" should be enough if you migrate from
PyPDF2==3.0.0 to pypdf==3.1.0.
- Deprecate features with PyPDF2==3.0.0 (#1489)
- Refactor Fit / Zoom parameters (#1437)
- Add Cloning (#1371)
- Allow int for indirect_reference in PdfWriter.get_object (#1490)
- How to read PDFs from S3 (#1509)
- Make MyST parse all links as simple hyperlinks (#1506)
- Changed 'latest' for 'stable' generated docs (#1495)
- Adjust deprecation procedure (#1487)
- Use typing.IO for file streams (#1498)
- Deduplicate extract_text docstring (#1485)
- How to cite PyPDF2 (#1476)
Consistency changes:
- indirect_ref/ido ➔ indirect_reference, dest➔ page_destination (#1467)
- owner_pwd/user_pwd ➔ owner_password/user_password (#1483)
- position ➜ page_number in Merger.merge (#1482)
- indirect_ref ➜ indirect_reference (#1484)
- Add support to extract gray scale images (#1460)
- Add 'threads' property to PdfWriter (#1458)
- Add 'open_destination' property to PdfWriter (#1431)
- Make PdfReader.get_object accept integer arguments (#1459)
- Scale PDF annotations (#1479)
- Padding issue with AES encryption (#1469)
- Accept empty object as null objects (#1477)
- Add module documentation the PaperSize class (#1447)
- Use 'page_number' instead of 'pagenum' (#1365)
- Add List of pages to PageRangeSpec (#1456)
- Cleanup temporary files (#1454)
- Mark test_tounicode_is_identity as external (#1449)
- Use Ubuntu 20.04 for running CI test suite (#1452)
- Add remove_from_tree (#1432)
- Add AnnotationBuilder.rectangle (#1388)
- JavaScript executed twice (#1439)
- ToUnicode stores /Identity-H instead of stream (#1433)
- Declare Pillow as optional dependency (#1392)
- Link 'Full Changelog' automatically
- Modify read_string_from_stream to a benchmark (#1415)
- Improve error reporting of read_object (#1412)
- Test Python 3.11 (#1404)
- Extend Flake8 ignore list (#1410)
- Use correct pytest markers (#1407)
- Move project configuration to pyproject.toml (#1382)
- td matrix (#1373)
- Cope with cmap from #1322 (#1372)
- Cope with str returned from get_data in cmap (#1380)
- Addition of optional visitor-functions in extract_text() (#1252)
- Add metadata.creation_date and modification_date (#1364)
- Add PageObject.images attribute (#1330)
- Lookup index in _xobj_to_image can be ByteStringObject (#1366)
- 'IndexError: index out of range' when using extract_text (#1361)
- Errors in transfer_rotation_to_content() (#1356)
- Ensure update_page_form_field_values does not fail if no fields (#1346)
- Add rotation property and transfer_rotate_to_content (#1348)
- Avoid string concatenation with large embedded base64-encoded images (#1350)
- Format floats using their intrinsic decimal precision (#1267)
- Fix merge_page for pages without resources (#1349)
- Add PageObject.user_unit property (#1336)
- Improve NameObject reading/writing (#1345)
- Fix Error in transformations (#1341)
- Decode #23 in NameObject (#1342)
- Use pytest.warns() for warnings, and .raises() for exceptions (#1325)
- Fix infinite loop due to Invalid object (#1331)
- Fix image extraction issue with superfluous whitespaces (#1327)
- Process XRefStm (#1297)
- Auto-detect RTL for text extraction (#1309)
- Avoid scaling cropbox twice (#1314)
- Fix offset correction in revised PDF (#1318)
- Crop data of /U and /O in encryption dictionary to 48 bytes (#1317)
- MultiLine bfrange in cmap (#1299)
- Cope with 2 digit codes in bfchar (#1310)
- Accept '/annn' charset as ASCII code (#1316)
- Log errors during Float / NumberObject initialization (#1315)
- Cope with corrupted entries in xref table (#1300)
- Migration guide (PyPDF2 1.x ➔ 2.x) (#1324)
- Creating a coverage report (#1319)
- Fix AnnotationBuilder.free_text example (#1311)
- Fix usage of page.scale by replacing it with page.scale_by (#1313)
- PdfReaderProtocol (#1303)
- Throw PdfReadError if Trailer can't be read (#1298)
- Remove catching OverflowException (#1302)
- Fix errors/warnings on no /Resources within extract_text (#1276)
- Add required line separators in ContentStream ArrayObjects (#1281)
- Use NameObject idempotency (#1290)
- Rectangle deletion (#1289)
- Add workflow tests (#1287)
- Remove files after tests ran (#1286)
- Add minimum version for typing_extensions requirement (#1277)
- Decrypt returns empty bytestring (#1258)
- Modify CI to better verify built package contents (#1244)
- 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)
- Delete annotations (#1263)
- Close PdfMerger in tests (#1260)
- PdfReader.xmp_metadata workflow (#1257)
- Various PdfWriter (Layout, Bookmark deprecation) (#1249)
BUG: Add PyPDF2.generic to PyPI distribution
- TreeObject.remove_child had a non-PdfObject assignment for Count (#1233, #1234)
- Fix stream truncated prematurely (#1223)
- Fix docstring formatting (#1228)
- Split generic.py (#1229)
- 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)
- "with" support for PdfMerger and PdfWriter (#1193)
- Add AnnotationBuilder.text(...) to build text annotations (#1202)
- Allow IndirectObjects as stream filters (#1211)
- Font scrambling
- Page vs Content scaling (#1208)
- Example for orientation parameter of extract_text (#1206)
- Fix AnnotationBuilder parameter formatting (#1204)
- Add flake8-print (#1203)
- Introduce WrongPasswordError / FileNotDecryptedError / EmptyFileError (#1201)
- 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)
- Named Dest in PDF1.1 (#1174)
- Incomplete Graphic State save/restore (#1172)
- 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)
- Consistent usage of warnings / log messages (#1164)
- Consistent terminology for outline items (#1156)
- u_hash in AlgV4.compute_key (#1170)
- Fix loading of file from #134 (#1167)
- Cope with empty DecodeParams (#1165)
- Typo in merger deprecation warning message (#1166)
- Package updates; solve mypy strict remarks (#1163)
- Add test from #325 (#1169)
- Add writer.add_annotation, page.annotations, and generic.AnnotationBuilder (#1120)
- Set /AS for /Btn form fields in writer (#1161)
- Ignore if /Perms verify failed (#1157)
- Cope with utf16 character for space calculation (#1155)
- Cope with null params for FitH / FitV destination (#1152)
- Handle outlines without valid destination (#1076)
- Introduce _utils.logger_warning (#1148)
- Break up parse_to_unicode (#1162)
- Add diagnostic output to exception in read_from_stream (#1159)
- Reduce PdfReader.read complexity (#1151)
- Add workflow tests found by arc testing (#1154)
- Decrypt file which is not encrypted (#1149)
- Test CryptRC4 encryption class; test image extraction filters (#1147)
- Add
outline_countproperty (#1129)
- Make reader.get_fields also return dropdowns with options (#1114)
- Add deprecated EncodedStreamObject functions back until PyPDF2==3.0.0 (#1139)
- Cope with missing /W entry (#1136)
- Cope with invalid parent xref (#1133)
- Contributors file (#1132)
- Fix type in signature of PdfWriter.add_uri (#1131)
- Add .git-blame-ignore-revs (#1141)
- Fixing typos (#1137)
- Reuse code via get_outlines_property in tests (#1130)
- Add color and font_format to PdfReader.outlines[i] (#1104)
- Extract Text Enhancement (whitespaces) (#1084)
- Use
build_destinationfor 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)
- Explanation for git submodule
- Watermark and stamp (#1095)
- 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)
- 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)
- Use IntFlag for permissions_flag / update_page_form_field_values (#1094)
- Simplify code (#1101)
- Add support for indexed color spaces / BitsPerComponent for decoding PNGs (#1067)
- Add PageObject._get_fonts (#1083)
- Use iterative DFS in PdfWriter._sweep_indirect_references (#1072)
- Let Page.scale also scale the crop-/trim-/bleed-/artbox (#1066)
- Column default for CCITTFaxDecode (#1079)
- Guard against None-value in _get_outlines (#1060)
- Stamps and watermarks (#1082)
- OCR vs PDF text extraction (#1081)
- Python Version support
- Formatting of CHANGELOG
- Cache downloaded files (#1070)
- Speed-up for CI (#1069)
- Set page.rotate(angle: int) (#1092)
- Issue #416 was fixed by #1015 (#1078)
- Image extraction (#1080)
- Image extraction (#1077)
- Apply black
- Typo in Changelog
- Add PdfReader.xfa attribute (#1026)
- Wrong page inserted when PdfMerger.merge is done (#1063)
- Resolve IndirectObject when it refers to a free entry (#1054)
- Added {posargs} to tox.ini (#1055)
- Remove PyPDF2._utils.bytes_type (#1053)
- 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)
- DOC of compress_content_streams (#1061)
- Minimize diff for #879 (#1049)
- Add writer.pdf_header property (getter and setter) (#1038)
- Remove b_ call in FloatObject.write_to_stream (#1044)
- Check duplicate objects in writer._sweep_indirect_references (#207)
- 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)
- Handle XML error when reading XmpInformation (#1030)
- Deduplicate Code / add mutmut config (#1022)
- Use unnecessary one-line function / class attribute (#1043)
- Docstring formatting (#1033)
- Support R6 decrypting (#1015)
- Add PdfReader.pdf_header (#1013)
- Remove ord_ calls (#1014)
- Fix missing page for bookmark (#1016)
- Deal with invalid Destinations (#1028)
- get_form_text_fields does not extract dropdown data (#1029)
- Adjust PdfWriter.add_uri docstring
- Mention crypto extra_requires for installation (#1017)
- Use /n line endings everywhere (#1027)
- Adjust string formatting to be able to use mutmut (#1020)
- Update Bug report template
BUG: Forgot to add the internal _codecs subpackage.
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 🤗
- Rename names to be PEP8-compliant (#967)
PdfWriter.get_page: the pageNumber parameter is renamed to page_numberPyPDF2.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
- Add decrypt support for V5 and AES-128, AES-256 (R5 only) (#749)
- Fix corrupted (wrongly) linear PDF (#1008)
- Move PDF_Samples folder into resources
- Fix typos (#1007)
- Improve encryption/decryption test (#1009)
- Add merger test cases with real PDFs (#1006)
- Add mutmut config
- Put pure data mappings in separate files (#1005)
- Make encryption module private, apply pre-commit (#1010)
- Remove b_ calls (#992, #986)
- Apply improvements to _utils suggested by perflint (#993)
- utf-16-be codec can't decode (...) (#995)
- Remove reference to Scripts (#987)
- Fix type annotations for add_bookmarks (#1000)
- 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)
- Apply fixes suggested by pylint (#999)
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.
- Add support for pathlib as input for PdfReader (#979)
- Optimize read_next_end_line (#646)
- Adobe Acrobat 'Would you like to save this file?' (#970)
- Notes on annotations (#982)
- Who uses PyPDF2
- intendet \xe2\x9e\x94 in robustness page (#958)
- pre-commit / requirements.txt updates (#977)
- Mark read_next_end_line as deprecated (#965)
- Export
PageObjectin PyPDF2 root (#960)
- Add MCVE of issue #416 (#980)
- FlateDecode.decode decodeParms (#964)
- Xmp module (#962)
- utils.paeth_predictor (#959)
- Use more tuples and list/dict comprehensions (#976)
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 PRs / issues. pubpub-zz was the most comprehensive PR which also incorporated the latest changes of PyPDF2 2.0.0.
Thank you to VictorCarlquist for #858 and asabramo for #464 🤗
- 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)
- Exceptions / missing spaces in extract_text() method (#17) 🕺
- Update glyphlist (#947) - inspired by #464
- Allow adding PageRange objects (#948)
- Delete .python-version file (#944)
- Compare StreamObject.decoded_self with None (#931)
- Fix some conversion errors on non conform PDF (#932)
- 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)
- Ignore .python-version file
- Mark deprecated code with no-cover (#943)
- Automatically create Github releases from tags (#870)
- Text extraction for non-latin alphabets (#954)
- Ignore PdfReadWarning in benchmark (#949)
- writer.remove_text (#946)
- Add test for Tree and _security (#945)
- black, isort, Flake8, splitting buildCharMap (#950)
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.
- 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
overwriteWarningsparameter. The new behavior isoverwriteWarnings=False. - merger: OutlinesObject was removed without replacement.
- merger.py ➔ _merger.py: You must import PdfFileMerger from PyPDF2 directly.
- utils:
ConvertFunctionsToVirtualListwas removedformatWarningwas removedisInt(obj): Useinstance(obj, int)insteadu_(s): Usesdirectlychr_(c): Usechr(c)insteadbarray(b): Usebytearray(b)insteadisBytes(b): Useinstance(b, type(bytes()))insteadxrange_fn: Userangeinsteadstring_type: UsestrinsteadisString(s): Useinstance(s, str)instead_basestring: Usestrinstead- All Exceptions are now in
PyPDF2.errors:- PageSizeNotDefinedError
- PdfReadError
- PdfReadWarning
- PyPdfError
PyPDF2.pdf(thepdfmodule) no longer exists. The contents were moved with the library. You should most likely import directly fromPyPDF2instead. TheRectangleObjectis inPyPDF2.generic.- The
Resources,Scripts, andTestswill no longer be part of the distribution files on PyPI. This should have little to no impact on most people. TheTestsare renamed totests, theResourcesare renamed toresources. Both are still in the git repository. TheScriptsare now in cpdf.Sample_Codewas moved to thedocs.
For a full list of deprecated functions, please see the changelog of version 1.28.0.
- Improve space setting for text extraction (#922)
- Allow setting the decryption password in
PdfReader.__init__(#920) - Add Page.add_transformation (#883)
- Fix error adding transformation to page without /Contents (#908)
- Cope with invalid length in streams (#861)
- Fix style of 1.25 and 1.27 patch notes (#927)
- Transformation (#907)
- Create flake8 config file (#916)
- Use relative imports (#875)
- 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)
- 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)