ENH: Add support for BrotliDecode filter (PDF 2.0) #3223 #3254

ash01ish · 2025-04-13T18:51:01Z

Implements the BrotliDecode filter as specified in ISO 32000-2:2020, Section 7.4.11. Adds necessary constants, integrates the filter into the decoding logic, includes brotli as an optional dependency, adds unit tests, and updates documentation.

Closes #3223

codecov · 2025-04-13T18:58:46Z

Codecov Report

Attention: Patch coverage is 89.47368% with 2 lines in your changes missing coverage. Please review.

Project coverage is 96.69%. Comparing base (1c9eacd) to head (1016c29).

Files with missing lines	Patch %	Lines
pypdf/filters.py	88.23%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3254      +/-   ##
==========================================
- Coverage   96.71%   96.69%   -0.02%     
==========================================
  Files          53       53              
  Lines        9029     9048      +19     
  Branches     1674     1677       +3     
==========================================
+ Hits         8732     8749      +17     
- Misses        177      179       +2     
  Partials      120      120

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

stefan6419846

Thanks for the PR. Is the official specification available in the meantime?

Apart from this, I have left some comments I stumbled upon during the review.

CHANGELOG.md

docs/modules/constants.rst

pypdf/constants.py

pypdf/filters.py

requirements/ci.txt

requirements/dev.txt

tests/test_filters.py

ash01ish · 2025-04-14T09:24:20Z

Reverting the requirements.txt files to main will show an error that the package is not installed. Is there any other way to get them installed? - I have added them in dev.in and ci.in - expecting that the req will be generated while running the pipeline.

ash01ish · 2025-04-14T09:26:11Z

Is the official specification available in the meantime?

The official specification for Brotli compression in PDF is not yet released. However, the PDF Association has announced its upcoming inclusion in PDF 2.0. Sample PDF files are available for developers to begin testing. https://pdfa.org/brotli-compression-coming-to-pdf/

stefan6419846 · 2025-04-14T09:31:21Z

Reverting the requirements.txt files to main will show an error that the package is not installed. Is there any other way to get them installed? - I have added them in dev.in and ci.in - expecting that the req will be generated while running the pipeline.

You can change the .txt variants, but ONLY for the actual dependency.

pypdf/filters.py

tests/test_filters.py

…y-pdf#3255) Variabke NumberSigns is unused. Also tweak some comments.

Also change kw to kwargs for familiarity.

Closes py-pdf#3247.

tests/test_filters.py

stefan6419846 · 2025-05-11T14:04:47Z

tests/test_filters.py

+@pytest.mark.skipif(importlib.util.find_spec("brotli") is None, reason="brotli library not installed")
+def test_brotli_import_handling_available():
+    """Verify brotli module is properly imported in pypdf.filters when available."""
+    # This test only runs when brotli is actually installed


This comment is superfluous.

stefan6419846 · 2025-05-11T14:06:14Z

tests/test_filters.py

+
+    assert extracted_text.strip() == "Hello, Brotli!"
+
+def test_brotli_import_error_with_patch():


I still do not really understand why we need this complexity. Could you please elaborate?

tests/test_filters.py

ash01ish changed the title ~~feat: Add support for BrotliDecode filter (PDF 2.0) #3223~~ ENH: Add support for BrotliDecode filter (PDF 2.0) #3223 Apr 13, 2025

ash01ish force-pushed the feat/add-brotli-decode branch 7 times, most recently from 1573164 to d339bc8 Compare April 14, 2025 02:15

stefan6419846 requested changes Apr 14, 2025

View reviewed changes

ash01ish force-pushed the feat/add-brotli-decode branch 2 times, most recently from 274ed94 to 4dd3fa0 Compare April 14, 2025 09:21

ash01ish force-pushed the feat/add-brotli-decode branch from 8b4514f to b7a5245 Compare April 14, 2025 12:05

stefan6419846 reviewed Apr 14, 2025

View reviewed changes

pypdf/filters.py Outdated Show resolved Hide resolved

stefan6419846 reviewed Apr 14, 2025

View reviewed changes

pypdf/filters.py Show resolved Hide resolved

stefan6419846 reviewed Apr 14, 2025

View reviewed changes

tests/test_filters.py Outdated Show resolved Hide resolved

stefan6419846 reviewed Apr 14, 2025

View reviewed changes

tests/test_filters.py Outdated Show resolved Hide resolved

stefan6419846 reviewed Apr 14, 2025

View reviewed changes

tests/test_filters.py Outdated Show resolved Hide resolved

stefan6419846 reviewed Apr 14, 2025

View reviewed changes

tests/test_filters.py Outdated Show resolved Hide resolved

stefan6419846 reviewed Apr 14, 2025

View reviewed changes

tests/test_filters.py Outdated Show resolved Hide resolved

stefan6419846 reviewed Apr 14, 2025

View reviewed changes

tests/test_filters.py Outdated Show resolved Hide resolved

stefan6419846 reviewed Apr 14, 2025

View reviewed changes

tests/test_filters.py Outdated Show resolved Hide resolved

stefan6419846 reviewed Apr 14, 2025

View reviewed changes

tests/test_filters.py Outdated Show resolved Hide resolved

stefan6419846 reviewed Apr 14, 2025

View reviewed changes

tests/test_filters.py Outdated Show resolved Hide resolved

stefan6419846 reviewed Apr 14, 2025

View reviewed changes

tests/test_filters.py Show resolved Hide resolved

ash01ish force-pushed the feat/add-brotli-decode branch from 672f080 to a4fdd61 Compare April 14, 2025 15:18

stefan6419846 reviewed Apr 15, 2025

View reviewed changes

tests/test_filters.py Outdated Show resolved Hide resolved

samuelbradshaw and others added 8 commits May 9, 2025 16:18

BUG: Get font information more reliably when removing text (py-pdf#3252)

7da38f1

MAINT: Modify some comments (py-pdf#3256)

5b7ac7e

STY: Remove variable check_crlf_space (py-pdf#3096)

50c230d

MAINT: Remove an unused variable and zero from the start of slices (p…

42b9efe

…y-pdf#3255) Variabke NumberSigns is unused. Also tweak some comments.

MAINT: Tweak comments (py-pdf#3257)

2d03292

Also change kw to kwargs for familiarity.

BUG: T* 2D Translation consistent with PDF 1.7 Spec (py-pdf#3250)

9c064d3

Closes py-pdf#3247.

STY: Remove variable check_crlf_space (py-pdf#3096)

cbbea23

update changes as suggested

3ba2235

ash01ish force-pushed the feat/add-brotli-decode branch from aee4bf8 to 3ba2235 Compare May 9, 2025 11:24

ash01ish added 7 commits May 9, 2025 16:55

Merge branch 'main' into feat/add-brotli-decode

7dcd2e9

Update test_text_extraction.py

3935ea2

Update test_filters.py

b4ac3d9

Update test_filters.py

666b871

remove unused imports

48cee95

change import error test case

94b6485

fix code fmt

9b8b80a

ash01ish requested a review from stefan6419846 May 9, 2025 13:37

stefan6419846 reviewed May 11, 2025

View reviewed changes

tests/test_filters.py Outdated Show resolved Hide resolved

stefan6419846 reviewed May 11, 2025

View reviewed changes

tests/test_filters.py Outdated Show resolved Hide resolved

stefan6419846 reviewed May 11, 2025

View reviewed changes

tests/test_filters.py Show resolved Hide resolved

ash01ish added 3 commits May 17, 2025 10:06

improve as per suggestions.

e099ead

fix code fmt

ab1c492

remove whitespace

dc2b4db

stefan6419846 reviewed May 19, 2025

View reviewed changes

tests/test_filters.py Outdated Show resolved Hide resolved

stefan6419846 added the needs-change The PR/issue cannot be handled as issue and needs to be improved label Jun 5, 2025

ash01ish added 2 commits June 5, 2025 21:37

Merge branch 'main' into feat/add-brotli-decode

fd842b3

Update test_filters.py

1016c29

ash01ish requested a review from stefan6419846 June 5, 2025 16:56


		assert extracted_text.strip() == "Hello, Brotli!"

		def test_brotli_import_error_with_patch():

ENH: Add support for BrotliDecode filter (PDF 2.0) #3223 #3254

Are you sure you want to change the base?

ENH: Add support for BrotliDecode filter (PDF 2.0) #3223 #3254

Uh oh!

Conversation

ash01ish commented Apr 13, 2025

Uh oh!

codecov bot commented Apr 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

stefan6419846 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ash01ish commented Apr 14, 2025

Uh oh!

ash01ish commented Apr 14, 2025

Uh oh!

stefan6419846 commented Apr 14, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stefan6419846 May 11, 2025

Choose a reason for hiding this comment

Uh oh!

stefan6419846 May 11, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov bot commented Apr 13, 2025 •

edited

Loading