BUG: PdfWriter.add_uri was setting the wrong type

[pmiller66]

BUG: /TYPE for a link should be "/Annot" not "/Annots" This change makes add_uri work; previously, it did not.

writer = pypdf.PdfWriter()
writer.add_blank_page(width=500, height=500)
writer.add_uri(0, 'https://cnn.com', [0, 0, 499, 499])
print ('writing demo.pdf')
writer.write('demo.pdf')

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (fc893d5) 94.42% compared to head (8e461c0) 94.42%.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2406   +/-   ##
=======================================
  Coverage   94.42%   94.42%           
=======================================
  Files          49       49           
  Lines        7961     7961           
  Branches     1608     1608           
=======================================
  Hits         7517     7517           
  Misses        274      274           
  Partials      170      170           

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

[stefan6419846]

Thanks. Do we have a chance to add a corresponding test as well?

[pmiller66]

add_uri is already tested in test_writer.py. That test requires a manual step to check that the generated PDF has links that work; that step would be sufficient my patch. I don't know how to formalize that manual step. My casual test is to generate a blank page with a full-page link to cnn.com: writer = pypdf.PdfWriter() writer.add_blank_page(width=500, height=500) writer.add_uri(0, 'https://cnn.com', [0, 0, 499, 499]) writer.write('demo.pdf')

[MartinThoma]

Table 30 – Entries in a page object clearly says /Annots, so at least the PG constant is not wrong.

However, Table 164 – Entries common to all annotation dictionaries is the relevant part. There it is /Annot

Good catch! 👍

[MartinThoma]

@pmiller66 Thank you for your PR 🙏 It will be part of pypdf==4.0.0. As this is a major release, it might take a bit longer than usual for the release on PyPI. I want to get some breaking changes into it. My guess is that we will publish pypdf==4.0.0 end of January/early February

[MartinThoma]

If you want, I can add you to https://pypdf.readthedocs.io/en/latest/meta/CONTRIBUTORS.html :-)

[MartinThoma]

Regarding the testing: I don't see an easy way to meaningfully test this. Essentially, we would either (1) need to rely on another library and make a comparison between the generated PDFs or (2) have some RPA-like process and thus relying on a PDF viewer + the RPA software.

Nothing you need to do in this PR as it's quite obvious that this change is correct and the PR improves pypdf :-)

[pmiller66]

Sure, honored. --P Phil Miller 11 Coventry Close Avondale, GA 30002 ***@***.*** 404.296.1221

…

------ Original Message ------ From "Martin Thoma" ***@***.***> To "py-pdf/pypdf" ***@***.***> Cc "pmiller66" ***@***.***>; "Mention" ***@***.***> Date 1/17/2024 4:48:48 PM Subject Re: [py-pdf/pypdf] BUG: PdfWriter.add_uri was setting the wrong type (PR #2406)

If you want, I can add you to https://pypdf.readthedocs.io/en/latest/meta/CONTRIBUTORS.html :-) — Reply to this email directly, view it on GitHub <#2406 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AA72UFCOH4JOXNDFLZAQN7LYPBBMBAVCNFSM6AAAAABBYMPZH2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQOJWHEZTOOBQGI>. You are receiving this because you were mentioned.Message ID: ***@***.***>