CHANGELOG.md

Changelog

All notable changes in pdfminer.six will be documented in this file.

The format is based on Keep a Changelog.

[Unreleased]

Changed

• Using absolute instead of relative imports ([#995])

Deprecated

• The third argument (generation number) to PDFObjRef (#972)

Fixed

• TypeError when corrupt PDF object reference cannot be parsed as int (#972)])
• TypeError when corrupt PDF literal cannot be converted to str (#978)
• ValueError when corrupt PDF specifies a negative xref location (#980)
• ValueError when corrupt PDF specifies an invalid mediabox (#987)
• RecursionError when corrupt PDF specifies a recursive /Pages object (#998)
• TypeError when corrupt PDF specifies text-positioning operators with invalid values (#1000)
• inline image parsing fails when stream data contains "EI\n" (#1008)

Removed

• Deprecated tools, functions and classes (#974)

[20240706]

Added

• Support for zipped jpeg's (#938)
• Fuzzing harnesses for integration into Google's OSS-Fuzz (949)
• Support for setuptools-git-versioning version 2.0.0 (#957)

Fixed

• Resolving mediabox and pdffont (#834)
• Keywords that aren't terminated by the pattern END_KEYWORD before end-of-stream are parsed (#885)
• ValueError wrong error message when specifying codec for text output (#902)
• Resolve stream filter parameters (#906)
• Reading cmap's with whitespace in the name (#935)
• Optimize apply_png_predictor by using lists (#912)

Changed

• Updated Python 3.7 syntax to 3.8 (#956)
• Updated all Python version specifications to a minimum of 3.8 (#969)

[20231228]

Removed

• Support for Python 3.6 and 3.7 (#921)

Added

• Output converter for the hOCR format (#651)
• Font name aliases for Arial, Courier New and Times New Roman (#790)
• Documentation on why special characters can sometimes not be extracted (#829)
• Storing Bezier path and dashing style of line in LTCurve (#801)

Fixed

• Broken CI/CD pipeline by setting upper version limit for black, mypy, pip and setuptools (#921)
• flake8 failures (#921)
• ValueError when bmp images with 1 bit channel are decoded (#773)
• ValueError when trying to decrypt empty metadata values (#766)
• Sphinx errors during building of documentation (#760)
• TypeError when getting default width of font (#720)
• Installing typing-extensions on Python 3.6 and 3.7 (#775)
• TypeError in cmapdb.py when parsing null characters (#768)
• Color "convenience operators" now (per spec) also set color space (#794)
• ValueError when extracting images, due to breaking changes in Pillow (#827)
• Small typo's and issues in the documentation (#828)
• Ignore non-Unicode cmaps in TrueType fonts (#806)

Changed

• Using non-hardcoded version string and setuptools-git-versioning to enable installation from source and building on Python 3.12 (#922)

Deprecated

• Usage of if __name__ == "__main__" where it was only intended for testing purposes (#756)

Removed

• Support for Python 3.6 and 3.7 because they are end-of-life (#923)

[20220524]

Fixed

• Ignoring (invalid) path constructors that do not begin with m (#749)

Changed

• Removed upper version bounds (#755)

[20220506]

Fixed

• IndexError when handling invalid bfrange code map in CMap (#731)
• TypeError in lzw.py when self.table is not set (#732)
• TypeError in encodingdb.py when name of unicode is not str (#733)
• TypeError in HTMLConverter when using a bytes fontname (#734)

Added

• Exporting images without any specific encoding (#737)

Changed

• Using charset-normalizer instead of chardet for less restrictive license (#744)

[20220319]

Added

• Export type annotations from pypi package per PEP561 (#679)
• Support for identity cmap's (#626)
• Add support for PDF page labels (#680)
• Installation of Pillow as an optional extra dependency (#714)

Fixed

• Hande decompression error due to CRC checksum error (#637)
• Regression (since 20191107) in LTLayoutContainer.group_textboxes that returned some text lines out of order (#659)
• Add handling of JPXDecode filter to enable extraction of images for some pdfs (#645)
• Fix extraction of jbig2 files, which was producing invalid files (#652)
• Crash in pdf2txt.py --boxes-flow=disabled (#682)
• Only use xref fallback if PDFNoValidXRef is raised and fallback is True (#684)
• Ignore empty characters when analyzing layout (#499)

Changed

• Replace warnings.warn with logging.Logger.warning in line with recommended use (#673)
• Switched from nose to pytest, from tox to nox and from Travis CI to GitHub Actions (#704)

Removed

• Unnecessary return statements without argument at the end of functions (#707)

[20211012]

Added

• Add support for PDF 2.0 (ISO 32000-2) AES-256 encryption (#614)
• Support for Paeth PNG filter compression (predictor value = 4) (#537)
• Type annotations (#661)

Fixed

• KeyError when 'Encrypt' but not 'ID' present in trailer (#594)
• Fix issue of ValueError and KeyError rasied in PDFdocument and PDFparser (#573)
• Fix issue of TypeError: cannot unpack non-iterable PDFObjRef object, when unpacking the value of 'DW2' (#529)
• Fix PermissionError when creating temporary filepaths on windows when running tests (#484)
• Fix AttributeError when dumping a TOC with bytes destinations (#600)
• Fix issue of some Chinese characters can not be extracted correctly (#593)
• Detecting trailer correctly when surrounded with needless whitespace (#535)
• Fix .paint_path logic for handling single line segments and extracting point-on-curve positions of Beziér path commands (#530)
• Raising UnboundLocalError when a bad --output-type is used (#610)
• TypeError when using TagExtractor with non-string or non-bytes tag values (#610)
• Using io.TextIOBase as the file to write to (#616)
• Parsing \r\n after the escape character in a literal string (#616)

Removed

• Support for Python 3.4 and 3.5 (#522)
• Unused dependency on sortedcontainers package (#525)
• Support for non-standard output streams that are not binary (#523)
• Dependency on typing-extensions introduced by #661 (#677)

[20201018]

Deprecated

• Support for Python 3.4 and 3.5 (#507)

Added

• Option to disable boxes flow layout analysis when using pdf2txt (#479)
• Support for pathlib.PurePath in open_filename (#492)

Fixed

• Pass caching parameter to PDFResourceManager in high_level functions (#475)
• Fix .paint_path logic for handling non-rect quadrilaterals and decomposing complex paths (#512)
• Fix out-of-bound access on some PDFs (#483)

Removed

• Remove unused rijndael encryption implementation (#465)

[20200726]

Fixed

• Rename PDFTextExtractionNotAllowedError to PDFTextExtractionNotAllowed to revert breaking change (#461)
• Always try to get CMap, not only for identity encodings (#438)

[20200720]

Added

• Support for painting multiple rectangles at once (#371)

Fixed

• Validate image object in do_EI is a PDFStream (#451)

Changed

• Hiding fallback xref by default from dumppdf.py output (#431)
• Raise a warning instead of an error when extracting text from a non-extractable PDF (#453)
• Switched from pycryptodome to cryptography package for AES decryption (#456)

[20200517]

Added

• Python3 shebang line to script in tools (#408)

Fixed

• Fix ordering of textlines within a textbox when boxes_flow=None (#412)

[20200402]

Added

• Allow boxes_flow LAParam to be passed as None, validate the input, and update documentation (#396)
• Also accept file-like objects in high level functions extract_text and extract_pages (#393)

Fixed

• Text no longer comes in reverse order when advanced layout analysis is disabled (#399)
• Updated misleading documentation for word_margin and char_margin (#407)
• Ignore ValueError when converting font encoding differences (#389)
• Grouping of text lines outside of parent container bounding box (#386)

Changed

• Group text lines if they are centered (#384)

[20200124]

Security

• Removed samples/issue-00152-embedded-pdf.pdf because it contains a possible security thread; a javascript enabled object (#364)

[20200121]

Fixed

• Interpret two's complement integer as unsigned integer (#352)
• Fix font name in html output such that it is recognized by browser (#357)
• Compute correct font height by removing scaling with font bounding box height (#348)
• KeyError when extracting embedded files and a Unicode file specification is missing (#338)

Removed

• The command-line utility latin2ascii.py (#360)

[20200104]

Removed

• Support for Python 2 (#346)

Changed

• Enforce pep8 coding style by adding flake8 to CI (#345)

[20191110]

Fixed

• Wrong order of text box grouping introduced by PR #315 (#335)

[20191107]

Deprecated

• The argument _py2_no_more_posargs because Python2 is removed on January , 2020 (#328 and #307)

Added

• Simple wrapper to easily extract text from a PDF file #330
• Support for extracting JBIG2 encoded images (#311 and #46)
• Sphinx documentation that is published on Read the Docs (#329)

Fixed

• Unhandled AssertionError when dumping pdf containing reference to object id 0 (#318)
• Debug flag actually changes logging level to debug for pdf2txt.py and dumppdf.py (#325)

Changed

• Using argparse instead of getopt for command line interface of dumppdf.py (#321)
• Refactor LTLayoutContainer.group_textboxes for a significant speed up in layout analysis (#315)

Removed

• Files for external applications such as django, cgi and pyinstaller (#320)

[20191020]

Deprecated

• Support for Python 2 is dropped at January 1st, 2020 (#307)

Added

• Contribution guidelines in CONTRIBUTING.md (#259)
• Support new encodings OneByteEncoding and DLIdent for CMaps (#283)

Fixed

• Use six.iteritems() instead of dict().iteritems() to ensure Python2 and Python3 compatibility (#274)
• Properly convert Adobe Glyph names to unicode characters (#263)
• Allow CMap to be a content stream (#283)
• Resolve indirect objects for width and bounding boxes for fonts (#273)
• Actually updating stroke color in graphic state (#298)
• Interpret (invalid) negative font descent as a positive descent (#203)
• Correct colorspace comparision for images (#132)
• Allow for bounding boxes with zero height or width by removing assertion (#246)

Changed

• All dependencies are managed in setup.py (#306 and #219)

[20181108]

Changed

• Speedup layout analysis (#141)
• Use argparse instead of replace deprecated getopt (#173)
• Allow pdfminer.six to be compiled with cython (#142)