ENH: add capability to remove /Info from pypdf #2820

pubpub-zz · 2024-08-28T10:02:43Z

to be merged after #2811

closes py-pdf#2780

to be merged after py-pdf#2811

codecov · 2024-08-28T10:11:32Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.99%. Comparing base (c4e95bd) to head (be48872).
Report is 95 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2820      +/-   ##
==========================================
+ Coverage   95.94%   95.99%   +0.04%     
==========================================
  Files          51       51              
  Lines        8758     8780      +22     
  Branches     1748     1753       +5     
==========================================
+ Hits         8403     8428      +25     
  Misses        209      209              
+ Partials      146      143       -3

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

pubpub-zz · 2024-08-28T11:55:08Z

This PR is ready for review (after #2811)
The uncoverd line will be addressed in another PR

this prevents "repairation" within acrobat

## Version 5.0.0, 2024-09-15 This version drops support for Python 3.7 (not maintained since July 2023), PdfMerger (use PdfWriter instead) and AnnotationBuilder (use annotations instead). ### Deprecations (DEP) - Remove the deprecated PfdMerger and AnnotationBuilder classes and other deprecations cleanup (#2813) - Drop Python 3.7 support (#2793) ### New Features (ENH) - 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) ### Bug Fixes (BUG) - Fix sheared image (#2801) ### Robustness (ROB) - 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) ### Developer Experience (DEV) - Fix coverage uploads (#2832) - Test against Python 3.13 (#2776) [Full Changelog](4.3.1...5.0.0)

Even if 5.1 is not technically supported, debuntu might switch to it any moment and we don't know if / when upstream will fix it, so it's not worth the time bomb. While technically it was always typed such, since py-pdf/pypdf#2820 it looks like `_info` is a lot more likely to be `None` as e.g. `clone_reader_document_root` now starts with unsetting `_info_obj` and never re-sets it. Except `add_metadata` was not updated to handle this case, likely because mypy interprets `assert isinstance(self._info, DictionaryObject)` as a type narrowing and trusts the developer, thus does not report the type mismatch... and the assertion ends up blowing in the user's face at runtime with a simple >>> r = pypdf.PdfReader(some_pdf_document) >>> w = pypdf.PdfWriter() >>> w.clone_reader_document_root(r) >>> w.add_metadata({"/foo": "bar"}) Traceback (most recent call last): File "<stdin>", line 1, in <module> File "lib/python3.12/site-packages/pypdf/_writer.py", line 1622, in add_metadata assert isinstance(self._info, DictionaryObject) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ AssertionError This is rather inconsiderate, so monkeypatch `add_metadata` to handle the case where `_info` exists and is `None`. Most of the credit goes to juwu for uncovering the issue. opw-4372052 opw-4426881 Fixes odoo#185673 Co-Authored-By: Junqi <juwu@odoo.com>

Even if 5.1 is not technically supported, debuntu might switch to it any moment and we don't know if / when upstream will fix it, so it's not worth the time bomb. While technically it was always typed such, since py-pdf/pypdf#2820 it looks like `_info` is a lot more likely to be `None` as e.g. `clone_reader_document_root` now starts with unsetting `_info_obj` and never re-sets it. Except `add_metadata` was not updated to handle this case, likely because mypy interprets `assert isinstance(self._info, DictionaryObject)` as a type narrowing and trusts the developer, thus does not report the type mismatch... and the assertion ends up blowing in the user's face at runtime with a simple >>> r = pypdf.PdfReader(some_pdf_document) >>> w = pypdf.PdfWriter() >>> w.clone_reader_document_root(r) >>> w.add_metadata({"/foo": "bar"}) Traceback (most recent call last): File "<stdin>", line 1, in <module> File "lib/python3.12/site-packages/pypdf/_writer.py", line 1622, in add_metadata assert isinstance(self._info, DictionaryObject) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ AssertionError This is rather inconsiderate, so monkeypatch `add_metadata` to handle the case where `_info` exists and is `None`. Most of the credit goes to juwu for uncovering the issue. opw-4372052 opw-4426881 Fixes #185673 closes #193086 Signed-off-by: Xavier Morel (xmo) <xmo@odoo.com> Co-authored-by: Junqi <juwu@odoo.com>

Even if 5.1 is not technically supported, debuntu might switch to it any moment and we don't know if / when upstream will fix it, so it's not worth the time bomb. While technically it was always typed such, since py-pdf/pypdf#2820 it looks like `_info` is a lot more likely to be `None` as e.g. `clone_reader_document_root` now starts with unsetting `_info_obj` and never re-sets it. Except `add_metadata` was not updated to handle this case, likely because mypy interprets `assert isinstance(self._info, DictionaryObject)` as a type narrowing and trusts the developer, thus does not report the type mismatch... and the assertion ends up blowing in the user's face at runtime with a simple >>> r = pypdf.PdfReader(some_pdf_document) >>> w = pypdf.PdfWriter() >>> w.clone_reader_document_root(r) >>> w.add_metadata({"/foo": "bar"}) Traceback (most recent call last): File "<stdin>", line 1, in <module> File "lib/python3.12/site-packages/pypdf/_writer.py", line 1622, in add_metadata assert isinstance(self._info, DictionaryObject) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ AssertionError This is rather inconsiderate, so monkeypatch `add_metadata` to handle the case where `_info` exists and is `None`. Most of the credit goes to juwu for uncovering the issue. opw-4372052 opw-4426881 Fixes odoo#185673 X-original-commit: 1fb35ad Co-authored-by: Junqi <juwu@odoo.com>

Even if 5.1 is not technically supported, debuntu might switch to it any moment and we don't know if / when upstream will fix it, so it's not worth the time bomb. While technically it was always typed such, since py-pdf/pypdf#2820 it looks like `_info` is a lot more likely to be `None` as e.g. `clone_reader_document_root` now starts with unsetting `_info_obj` and never re-sets it. Except `add_metadata` was not updated to handle this case, likely because mypy interprets `assert isinstance(self._info, DictionaryObject)` as a type narrowing and trusts the developer, thus does not report the type mismatch... and the assertion ends up blowing in the user's face at runtime with a simple >>> r = pypdf.PdfReader(some_pdf_document) >>> w = pypdf.PdfWriter() >>> w.clone_reader_document_root(r) >>> w.add_metadata({"/foo": "bar"}) Traceback (most recent call last): File "<stdin>", line 1, in <module> File "lib/python3.12/site-packages/pypdf/_writer.py", line 1622, in add_metadata assert isinstance(self._info, DictionaryObject) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ AssertionError This is rather inconsiderate, so monkeypatch `add_metadata` to handle the case where `_info` exists and is `None`. Most of the credit goes to juwu for uncovering the issue. opw-4372052 opw-4426881 Fixes #185673 closes #193129 X-original-commit: 1fb35ad Signed-off-by: Xavier Morel (xmo) <xmo@odoo.com> Co-authored-by: Junqi <juwu@odoo.com>

Even if 5.1 is not technically supported, debuntu might switch to it any moment and we don't know if / when upstream will fix it, so it's not worth the time bomb. While technically it was always typed such, since py-pdf/pypdf#2820 it looks like `_info` is a lot more likely to be `None` as e.g. `clone_reader_document_root` now starts with unsetting `_info_obj` and never re-sets it. Except `add_metadata` was not updated to handle this case, likely because mypy interprets `assert isinstance(self._info, DictionaryObject)` as a type narrowing and trusts the developer, thus does not report the type mismatch... and the assertion ends up blowing in the user's face at runtime with a simple >>> r = pypdf.PdfReader(some_pdf_document) >>> w = pypdf.PdfWriter() >>> w.clone_reader_document_root(r) >>> w.add_metadata({"/foo": "bar"}) Traceback (most recent call last): File "<stdin>", line 1, in <module> File "lib/python3.12/site-packages/pypdf/_writer.py", line 1622, in add_metadata assert isinstance(self._info, DictionaryObject) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ AssertionError This is rather inconsiderate, so monkeypatch `add_metadata` to handle the case where `_info` exists and is `None`. Most of the credit goes to juwu for uncovering the issue. opw-4372052 opw-4426881 Fixes #185673 closes #193155 X-original-commit: 1fb35ad Signed-off-by: Xavier Morel (xmo) <xmo@odoo.com> Co-authored-by: Junqi <juwu@odoo.com>

Even if 5.1 is not technically supported, debuntu might switch to it any moment and we don't know if / when upstream will fix it, so it's not worth the time bomb. While technically it was always typed such, since py-pdf/pypdf#2820 it looks like `_info` is a lot more likely to be `None` as e.g. `clone_reader_document_root` now starts with unsetting `_info_obj` and never re-sets it. Except `add_metadata` was not updated to handle this case, likely because mypy interprets `assert isinstance(self._info, DictionaryObject)` as a type narrowing and trusts the developer, thus does not report the type mismatch... and the assertion ends up blowing in the user's face at runtime with a simple >>> r = pypdf.PdfReader(some_pdf_document) >>> w = pypdf.PdfWriter() >>> w.clone_reader_document_root(r) >>> w.add_metadata({"/foo": "bar"}) Traceback (most recent call last): File "<stdin>", line 1, in <module> File "lib/python3.12/site-packages/pypdf/_writer.py", line 1622, in add_metadata assert isinstance(self._info, DictionaryObject) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ AssertionError This is rather inconsiderate, so monkeypatch `add_metadata` to handle the case where `_info` exists and is `None`. Most of the credit goes to juwu for uncovering the issue. opw-4372052 opw-4426881 Fixes #185673 closes #193158 X-original-commit: 1fb35ad Signed-off-by: Xavier Morel (xmo) <xmo@odoo.com> Co-authored-by: Junqi <juwu@odoo.com>

Even if 5.1 is not technically supported, debuntu might switch to it any moment and we don't know if / when upstream will fix it, so it's not worth the time bomb. While technically it was always typed such, since py-pdf/pypdf#2820 it looks like `_info` is a lot more likely to be `None` as e.g. `clone_reader_document_root` now starts with unsetting `_info_obj` and never re-sets it. Except `add_metadata` was not updated to handle this case, likely because mypy interprets `assert isinstance(self._info, DictionaryObject)` as a type narrowing and trusts the developer, thus does not report the type mismatch... and the assertion ends up blowing in the user's face at runtime with a simple >>> r = pypdf.PdfReader(some_pdf_document) >>> w = pypdf.PdfWriter() >>> w.clone_reader_document_root(r) >>> w.add_metadata({"/foo": "bar"}) Traceback (most recent call last): File "<stdin>", line 1, in <module> File "lib/python3.12/site-packages/pypdf/_writer.py", line 1622, in add_metadata assert isinstance(self._info, DictionaryObject) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ AssertionError This is rather inconsiderate, so monkeypatch `add_metadata` to handle the case where `_info` exists and is `None`. Most of the credit goes to juwu for uncovering the issue. opw-4372052 opw-4426881 Fixes #185673 closes #193159 X-original-commit: 1fb35ad Signed-off-by: Xavier Morel (xmo) <xmo@odoo.com> Co-authored-by: Junqi <juwu@odoo.com>

Even if 5.1 is not technically supported, debuntu might switch to it any moment and we don't know if / when upstream will fix it, so it's not worth the time bomb. While technically it was always typed such, since py-pdf/pypdf#2820 it looks like `_info` is a lot more likely to be `None` as e.g. `clone_reader_document_root` now starts with unsetting `_info_obj` and never re-sets it. Except `add_metadata` was not updated to handle this case, likely because mypy interprets `assert isinstance(self._info, DictionaryObject)` as a type narrowing and trusts the developer, thus does not report the type mismatch... and the assertion ends up blowing in the user's face at runtime with a simple >>> r = pypdf.PdfReader(some_pdf_document) >>> w = pypdf.PdfWriter() >>> w.clone_reader_document_root(r) >>> w.add_metadata({"/foo": "bar"}) Traceback (most recent call last): File "<stdin>", line 1, in <module> File "lib/python3.12/site-packages/pypdf/_writer.py", line 1622, in add_metadata assert isinstance(self._info, DictionaryObject) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ AssertionError This is rather inconsiderate, so monkeypatch `add_metadata` to handle the case where `_info` exists and is `None`. Most of the credit goes to juwu for uncovering the issue. opw-4372052 opw-4426881 Fixes #185673 closes #193143 X-original-commit: 1fb35ad Signed-off-by: Xavier Morel (xmo) <xmo@odoo.com> Co-authored-by: Junqi <juwu@odoo.com>

Even if 5.1 is not technically supported, debuntu might switch to it any moment and we don't know if / when upstream will fix it, so it's not worth the time bomb. While technically it was always typed such, since py-pdf/pypdf#2820 it looks like `_info` is a lot more likely to be `None` as e.g. `clone_reader_document_root` now starts with unsetting `_info_obj` and never re-sets it. Except `add_metadata` was not updated to handle this case, likely because mypy interprets `assert isinstance(self._info, DictionaryObject)` as a type narrowing and trusts the developer, thus does not report the type mismatch... and the assertion ends up blowing in the user's face at runtime with a simple >>> r = pypdf.PdfReader(some_pdf_document) >>> w = pypdf.PdfWriter() >>> w.clone_reader_document_root(r) >>> w.add_metadata({"/foo": "bar"}) Traceback (most recent call last): File "<stdin>", line 1, in <module> File "lib/python3.12/site-packages/pypdf/_writer.py", line 1622, in add_metadata assert isinstance(self._info, DictionaryObject) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ AssertionError This is rather inconsiderate, so monkeypatch `add_metadata` to handle the case where `_info` exists and is `None`. Most of the credit goes to juwu for uncovering the issue. opw-4372052 opw-4426881 Fixes #185673 closes #193155 X-original-commit: 1fb35ad Signed-off-by: Xavier Morel (xmo) <xmo@odoo.com> Co-authored-by: Junqi <juwu@odoo.com>

Even if 5.1 is not technically supported, debuntu might switch to it any moment and we don't know if / when upstream will fix it, so it's not worth the time bomb. While technically it was always typed such, since py-pdf/pypdf#2820 it looks like `_info` is a lot more likely to be `None` as e.g. `clone_reader_document_root` now starts with unsetting `_info_obj` and never re-sets it. Except `add_metadata` was not updated to handle this case, likely because mypy interprets `assert isinstance(self._info, DictionaryObject)` as a type narrowing and trusts the developer, thus does not report the type mismatch... and the assertion ends up blowing in the user's face at runtime with a simple >>> r = pypdf.PdfReader(some_pdf_document) >>> w = pypdf.PdfWriter() >>> w.clone_reader_document_root(r) >>> w.add_metadata({"/foo": "bar"}) Traceback (most recent call last): File "<stdin>", line 1, in <module> File "lib/python3.12/site-packages/pypdf/_writer.py", line 1622, in add_metadata assert isinstance(self._info, DictionaryObject) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ AssertionError This is rather inconsiderate, so monkeypatch `add_metadata` to handle the case where `_info` exists and is `None`. Most of the credit goes to juwu for uncovering the issue. opw-4372052 opw-4426881 Fixes #185673 closes odoo/odoo#193155 X-original-commit: 1fb35add8090b5fc9e706aad67f6bb38432273e0 Signed-off-by: Xavier Morel (xmo) <xmo@odoo.com> Co-authored-by: Junqi <juwu@odoo.com>

Even if 5.1 is not technically supported, debuntu might switch to it any moment and we don't know if / when upstream will fix it, so it's not worth the time bomb. While technically it was always typed such, since py-pdf/pypdf#2820 it looks like `_info` is a lot more likely to be `None` as e.g. `clone_reader_document_root` now starts with unsetting `_info_obj` and never re-sets it. Except `add_metadata` was not updated to handle this case, likely because mypy interprets `assert isinstance(self._info, DictionaryObject)` as a type narrowing and trusts the developer, thus does not report the type mismatch... and the assertion ends up blowing in the user's face at runtime with a simple >>> r = pypdf.PdfReader(some_pdf_document) >>> w = pypdf.PdfWriter() >>> w.clone_reader_document_root(r) >>> w.add_metadata({"/foo": "bar"}) Traceback (most recent call last): File "<stdin>", line 1, in <module> File "lib/python3.12/site-packages/pypdf/_writer.py", line 1622, in add_metadata assert isinstance(self._info, DictionaryObject) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ AssertionError This is rather inconsiderate, so monkeypatch `add_metadata` to handle the case where `_info` exists and is `None`. Most of the credit goes to juwu for uncovering the issue. opw-4372052 opw-4426881 Fixes odoo#185673 closes odoo#193086 Signed-off-by: Xavier Morel (xmo) <xmo@odoo.com> Co-authored-by: Junqi <juwu@odoo.com>

Even if 5.1 is not technically supported, debuntu might switch to it any moment and we don't know if / when upstream will fix it, so it's not worth the time bomb. While technically it was always typed such, since py-pdf/pypdf#2820 it looks like `_info` is a lot more likely to be `None` as e.g. `clone_reader_document_root` now starts with unsetting `_info_obj` and never re-sets it. Except `add_metadata` was not updated to handle this case, likely because mypy interprets `assert isinstance(self._info, DictionaryObject)` as a type narrowing and trusts the developer, thus does not report the type mismatch... and the assertion ends up blowing in the user's face at runtime with a simple >>> r = pypdf.PdfReader(some_pdf_document) >>> w = pypdf.PdfWriter() >>> w.clone_reader_document_root(r) >>> w.add_metadata({"/foo": "bar"}) Traceback (most recent call last): File "<stdin>", line 1, in <module> File "lib/python3.12/site-packages/pypdf/_writer.py", line 1622, in add_metadata assert isinstance(self._info, DictionaryObject) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ AssertionError This is rather inconsiderate, so monkeypatch `add_metadata` to handle the case where `_info` exists and is `None`. Most of the credit goes to juwu for uncovering the issue. opw-4372052 opw-4426881 Fixes odoo#185673 closes odoo#193155 X-original-commit: 1fb35ad Signed-off-by: Xavier Morel (xmo) <xmo@odoo.com> Co-authored-by: Junqi <juwu@odoo.com>

pubpub-zz added 18 commits August 23, 2024 23:05

ENH: add incremental capability to PdfWriter

fba73a4

closes py-pdf#2780

fix test

0543709

fixes + first test

29030d4

coverage

1067b74

coverage

f1d3fbe

cope with multiple level pages

ae97bc7

test + doc

d9a99d9

coverage

3c4cfdc

coverage

38d4b35

coverage

79eca73

coverage

290c5a6

coverage

173578d

Merge branch 'main' into incremental

b2b0c9e

simplification

1a6eda5

coverage

d43d25b

Merge branch 'main' into incremental

7e2e74d

Merge branch 'main' into incremental

708e449

ENH: add capability to remove /Info from pypdf

c9a6c95

to be merged after py-pdf#2811

pubpub-zz added 2 commits August 28, 2024 12:19

coverage

5147266

oups

ec9aafe

pubpub-zz added 8 commits September 1, 2024 13:33

Merge remote-tracking branch 'py-pdf/main' into incremental

ff76e02

move to X-reference stream for increment

14a93f1

this prevents "repairation" within acrobat

coverage

53e141f

coverage

b4b7c1b

coverage

7bc3abd

fix

ffa2f0c

mypy

b072952

Merge branch 'incremental' into info_clean

ca724f9

stefan6419846 approved these changes Sep 14, 2024

View reviewed changes

stefan6419846 merged commit a790532 into py-pdf:main Sep 14, 2024
13 checks passed

stefan6419846 mentioned this pull request Sep 14, 2024

MAINT: simplify test with None and NullObject #2829

Merged

pubpub-zz mentioned this pull request Sep 15, 2024

REL: 5.0.0 #2851

Merged

xmo-odoo mentioned this pull request Jan 9, 2025

[FIX] core: inconsistent pypdf metadata in 5.1 odoo/odoo#193086

Closed

fw-bot mentioned this pull request Jan 9, 2025

[FW][FIX] core: inconsistent pypdf metadata in 5.1 odoo/odoo#193129

Closed

fw-bot mentioned this pull request Jan 9, 2025

[FW][FIX] core: inconsistent pypdf metadata in 5.1 odoo/odoo#193143

Closed

fw-bot mentioned this pull request Jan 9, 2025

[FW][FIX] core: inconsistent pypdf metadata in 5.1 odoo/odoo#193155

Closed

fw-bot mentioned this pull request Jan 9, 2025

[FW][FIX] core: inconsistent pypdf metadata in 5.1 odoo/odoo#193158

Closed

fw-bot mentioned this pull request Jan 9, 2025

[FW][FIX] core: inconsistent pypdf metadata in 5.1 odoo/odoo#193159

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ENH: add capability to remove /Info from pypdf #2820

ENH: add capability to remove /Info from pypdf #2820

pubpub-zz commented Aug 28, 2024

codecov bot commented Aug 28, 2024 •

edited

Loading

pubpub-zz commented Aug 28, 2024

ENH: add capability to remove /Info from pypdf #2820

ENH: add capability to remove /Info from pypdf #2820

Conversation

pubpub-zz commented Aug 28, 2024

codecov bot commented Aug 28, 2024 • edited Loading

Codecov Report

pubpub-zz commented Aug 28, 2024

codecov bot commented Aug 28, 2024 •

edited

Loading