ENH: Add AnnotationBuilder.popup by pubpub-zz · Pull Request #1665 · py-pdf/pypdf

pubpub-zz · 2023-02-26T13:26:38Z

fixes #1195
refactored bas on previous proposal and get open workink

codecov · 2023-02-26T14:08:24Z

Codecov Report

Patch coverage: 77.27% and project coverage change: -0.06 ⚠️

Comparison is base (20ebcfd) 92.44% compared to head (bd16e55) 92.38%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1665      +/-   ##
==========================================
- Coverage   92.44%   92.38%   -0.06%     
==========================================
  Files          34       34              
  Lines        6538     6553      +15     
  Branches     1296     1300       +4     
==========================================
+ Hits         6044     6054      +10     
- Misses        323      326       +3     
- Partials      171      173       +2

Impacted Files	Coverage Δ
pypdf/generic/_annotations.py	`93.69% <70.00%> (-2.39%)`	⬇️
pypdf/_writer.py	`86.12% <83.33%> (-0.11%)`	⬇️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

docs/user/adding-pdf-annotations.md

MartinThoma · 2023-02-26T17:59:18Z

Looks good to me - should I merge it? (I want to release in the next ~30 minutes) :-)

pypdf/_writer.py

MartinThoma · 2023-02-26T18:03:28Z

Ok, I think this one might need more discussion as there were a few changes besides the pure addition of the popup.

I'll make todays release without it so that we have time to discuss this :-)

pypdf/_writer.py

Co-authored-by: Martin Thoma <info@martin-thoma.de>

docs/user/adding-pdf-annotations.md

Co-authored-by: Martin Thoma <info@martin-thoma.de>

pypdf/generic/_annotations.py

MartinThoma · 2023-03-23T05:59:58Z

pypdf/generic/_annotations.py

+    @staticmethod
+    def popup(
+        rect: Union[RectangleObject, Tuple[float, float, float, float]],
+        flags: int = 0,


It would be nice if we had an enum.IntFlag in constants.py for that. See the ObjectDeletionFlag in _writer.py and several examples in constants.py

pypdf/_writer.py

oups... too old PR Co-authored-by: Martin Thoma <info@martin-thoma.de>

Co-authored-by: Martin Thoma <info@martin-thoma.de>

pypdf/_writer.py

MartinThoma · 2023-03-24T05:08:34Z

Very nice work 👍 Two cleanups would be nice (removing the outdated check related to pagenum + using an enum.IntFlag), but I could do myself both if you want.

I want to include this in the coming release :-)

Co-authored-by: Martin Thoma <info@martin-thoma.de>

pubpub-zz · 2023-03-24T20:15:39Z

@MartinThoma
I think the flag which is global should be a candidate to a set_flag() in the same idea I've proposed in the PR about rectangle. Your opinion

pypdf/_writer.py

MartinThoma · 2023-03-25T06:18:45Z

@pubpub-zz I think the PR is good to be merged :-) Two small comments that I could change myself + the IntEnum flag (which I could also add myself).

Let me know if I should wait for you :-)

Co-authored-by: Martin Thoma <info@martin-thoma.de>

pubpub-zz · 2023-03-25T13:06:44Z

@MartinThoma
All yours.

pypdf/_writer.py

MartinThoma · 2023-03-26T09:46:09Z

Thank you @pubpub-zz 🤗 The popup annotation will be part of pypdf==3.7.0 which I will release today 🎉

Security (SEC): - Use Python's secrets module instead of random module (#1748) New Features (ENH): - 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) Bug Fixes (BUG): - 'DictionaryObject' object has no attribute 'indirect_reference' (#1729) Robustness (ROB): - Handle params NullObject in decode_stream_data (#1738) Documentation (DOC): - Project scope (#1743) Maintenance (MAINT): - Add AnnotationFlag (#1746) - Add LazyDict.__str__ (#1727) [Full Changelog](3.6.0...3.7.0)

pubpub-zz added 2 commits February 26, 2023 14:21

add popup

de984d5

mypy

fe51779

test coverage

6680062

MartinThoma reviewed Feb 26, 2023

View reviewed changes

docs/user/adding-pdf-annotations.md Outdated Show resolved Hide resolved

MartinThoma reviewed Feb 26, 2023

View reviewed changes

docs/user/adding-pdf-annotations.md Show resolved Hide resolved

missing file

775e61e

MartinThoma reviewed Feb 26, 2023

View reviewed changes

pypdf/_writer.py Show resolved Hide resolved

MartinThoma reviewed Feb 26, 2023

View reviewed changes

pypdf/_writer.py Outdated Show resolved Hide resolved

MartinThoma added soon PRs that are almost ready to be merged, issues that get solved pretty soon and removed soon PRs that are almost ready to be merged, issues that get solved pretty soon labels Feb 26, 2023

MartinThoma mentioned this pull request Mar 14, 2023

Tutorials or better demos to manipulate annotations #107

Closed

MartinThoma changed the title ~~ENH : add popup annots~~ ENH: Add AnnotationBuilder.popup Mar 14, 2023

MartinThoma added the is-feature A feature request label Mar 18, 2023

MartinThoma reviewed Mar 18, 2023

View reviewed changes

pypdf/_writer.py Outdated Show resolved Hide resolved

pubpub-zz and others added 3 commits March 18, 2023 18:25

Update pypdf/_writer.py

a499568

Co-authored-by: Martin Thoma <info@martin-thoma.de>

page_number

49c6261

Merge branch 'main' into popup2

98c906a

MartinThoma reviewed Mar 18, 2023

View reviewed changes

docs/user/adding-pdf-annotations.md Outdated Show resolved Hide resolved

Update docs/user/adding-pdf-annotations.md

c42ffe3

Co-authored-by: Martin Thoma <info@martin-thoma.de>

MartinThoma reviewed Mar 23, 2023

View reviewed changes

pypdf/generic/_annotations.py Outdated Show resolved Hide resolved

MartinThoma reviewed Mar 23, 2023

View reviewed changes

pypdf/_writer.py Outdated Show resolved Hide resolved

MartinThoma reviewed Mar 23, 2023

View reviewed changes

pypdf/_writer.py Outdated Show resolved Hide resolved

pubpub-zz and others added 4 commits March 23, 2023 12:43

Google Style

5f58b5f

oups... too old PR Co-authored-by: Martin Thoma <info@martin-thoma.de>

Update pypdf/_writer.py

f70b5ba

Co-authored-by: Martin Thoma <info@martin-thoma.de>

update from comments

cd9da8f

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

459ed73

MartinThoma reviewed Mar 24, 2023

View reviewed changes

pypdf/_writer.py Show resolved Hide resolved

MartinThoma added the soon PRs that are almost ready to be merged, issues that get solved pretty soon label Mar 24, 2023

Update pypdf/_writer.py

1128cdb

Co-authored-by: Martin Thoma <info@martin-thoma.de>

MartinThoma reviewed Mar 25, 2023

View reviewed changes

pypdf/_writer.py Outdated Show resolved Hide resolved

MartinThoma reviewed Mar 25, 2023

View reviewed changes

pypdf/_writer.py Show resolved Hide resolved

MartinThoma reviewed Mar 25, 2023

View reviewed changes

pypdf/_writer.py Outdated Show resolved Hide resolved

pubpub-zz and others added 3 commits March 25, 2023 09:25

Update pypdf/_writer.py

d6ef383

Co-authored-by: Martin Thoma <info@martin-thoma.de>

Update pypdf/_writer.py

f48bbdd

Co-authored-by: Martin Thoma <info@martin-thoma.de>

Merge branch 'main' into popup2

d731573

MartinThoma reviewed Mar 26, 2023

View reviewed changes

pypdf/_writer.py Outdated Show resolved Hide resolved

docstring imporvement

4603a4f

MartinThoma reviewed Mar 26, 2023

View reviewed changes

pypdf/_writer.py Outdated Show resolved Hide resolved

whitespace

bd16e55

MartinThoma merged commit 4fc0040 into py-pdf:main Mar 26, 2023

pubpub-zz deleted the popup2 branch June 24, 2023 08:42

Conversation

pubpub-zz commented Feb 26, 2023 • edited by MartinThoma Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Feb 26, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

MartinThoma commented Feb 26, 2023

Uh oh!

Uh oh!

Uh oh!

MartinThoma commented Feb 26, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MartinThoma Mar 23, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MartinThoma commented Mar 24, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pubpub-zz commented Mar 24, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MartinThoma commented Mar 25, 2023

Uh oh!

pubpub-zz commented Mar 25, 2023

Uh oh!

Uh oh!

Uh oh!

MartinThoma commented Mar 26, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

pubpub-zz commented Feb 26, 2023 •

edited by MartinThoma

Loading

codecov bot commented Feb 26, 2023 •

edited

Loading

MartinThoma Mar 23, 2023 •

edited

Loading

MartinThoma commented Mar 24, 2023 •

edited

Loading