Skip to content

ENH: Filter by font when removing text #3216

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 16 commits into from
Mar 24, 2025
Merged

Conversation

samuelbradshaw
Copy link
Contributor

This is related to a discussion from a couple of months ago: #3049.

The change adds an optional font_names attribute to PdfWriter.removeText(), allowing users to remove all text with a certain font from the PDF. Example:

from pypdf import PdfWriter

pdf_path = '/path/to/file.pdf'

writer = PdfWriter(clone_from = pdf_path)
writer.remove_text(font_names = ['Helvetica-Bold'])
writer.write(pdf_path)  

Copy link

codecov bot commented Mar 22, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.56%. Comparing base (4716589) to head (639bdb3).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3216   +/-   ##
=======================================
  Coverage   96.56%   96.56%           
=======================================
  Files          53       53           
  Lines        8930     8947   +17     
  Branches     1642     1648    +6     
=======================================
+ Hits         8623     8640   +17     
  Misses        185      185           
  Partials      122      122           

☔ 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
Copy link
Collaborator

Thanks for the PR. Please add corresponding tests as well to show that everything is working as expected.

@stefan6419846 stefan6419846 added the needs-test A test should be added before this PR is merged. label Mar 23, 2025
@stefan6419846 stefan6419846 removed the needs-test A test should be added before this PR is merged. label Mar 24, 2025
Copy link
Collaborator

@stefan6419846 stefan6419846 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your patience. Looks good to me.

@stefan6419846 stefan6419846 merged commit 24b81eb into py-pdf:main Mar 24, 2025
16 checks passed
stefan6419846 added a commit that referenced this pull request May 11, 2025
## What's new

### New Features (ENH)
- Add support for IndirectObject.__iter__ (#3228) by @bryan-brancotte
- Allow filtering by font when removing text (#3216) by @samuelbradshaw

### Bug Fixes (BUG)
- Add missing named destinations being ByteStringObjects (#3282) by @stefan6419846
- Get font information more reliably when removing text (#3252) by @samuelbradshaw
- T* 2D Translation consistent with PDF 1.7 Spec (#3250) by @hackowitz-af
- Add font stack to q/Q operations in layout mode (#3225) by @hackowitz-af
- Avoid completely hiding image loading issues like exceeding image size limits (#3221) by @stefan6419846
- Using compress_identical_objects on transformed content duplicates differing content (#3197) by @danio
- Consider BlackIs1 parameter for CCITTFaxDecode filter (#3196) by @stefan6419846

### Robustness (ROB)
- Deal with insufficient cm matrix during text extraction (#3283) by @stefan6419846
- Allow merging when annotations miss D entry (#3281) by @stefan6419846
- Fix merging documents if there are no Dests (#3280) by @stefan6419846
- Fix crash on malformed action in outline (#3278) by @larsga
- Fix compression issues for removed images which might be None (#3246) by @stefan6419846
- Attempt to deal with non-rectangular FlateDecode streams (#3245) by @stefan6419846
- Handle some None values for broken PDF files (#3230) by @stefan6419846

### Developer Experience (DEV)
- Multiple style improvements by @j-t-1
- Update ruff to 0.11.0 by @stefan6419846

### Maintenance (MAINT)
- Conform ASCIIHexDecode implementation to specification (#3274) by @j-t-1
- Modify comments of filters that do not use decode_parms (#3260) by @j-t-1

### Code Style (STY)
- Simplify warnings & debugging in layout mode text extraction (#3271) by @hackowitz-af
- Standardize mypy assert statements (#3276) by @j-t-1

[Full Changelog](5.4.0...5.5.0)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants