Allow add_link() to be called before add_page(). #1337
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This patch sets the default page to 1 for add_link() if no pages have yet been added to the PDF, otherwise the default target is the current page. Page 1 is mandatory, so the target will definitely be valid even if it is not later pointed elsewhere with set_link(). Since this is no longer an error, the test/test_links.py test_inserting_link_with_no_page_number() has been changed to ensure that it produces the same document as the later test_later_call_to_set_link().
osresearch
force-pushed
the
add_link_20250104
branch
from
392bd6e to
35efe39
Compare
Lucas-C
reviewed
Jan 6, 2025
| pdf.set_link(link_to_section1, page=pdf.page) | ||
| pdf.cell(text="Section 1: Bla bla bla") | ||
|
|
||
| assert_pdf_equal(pdf, HERE / "later_call_to_set_link.pdf", tmp_path) |
There was a problem hiding this comment.
Could you please provide the reference file later_call_to_set_link.pdf as part of this PR, please?
You just need to pass generate=True to this function call in order to generate it:
https://py-pdf.github.io/fpdf2/Development.html#generating-pdf-files-for-testing
You will also need to run black test/test_links.py in order to pretty-format this file.
Lucas-C
approved these changes
Jan 6, 2025
|
@allcontributors please add @osresearch for code |
|
I've put up a pull request to add @osresearch! 🎉 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This patch sets the default page to 1 for add_link() if no pages have yet been added to the PDF, otherwise the default target is the current page. Page 1 is mandatory, so the target will definitely be valid even if it is not later pointed elsewhere with set_link().
Since this is no longer an error, the test/test_links.py test_inserting_link_with_no_page_number() has been changed to ensure that it produces the same document as the later test_later_call_to_set_link().
Checklist:
A unit test is covering the code added / modified by this PR
This PR is ready to be merged
In case of a new feature, docstrings have been added, with also some documentation in the
docs/folderA mention of the change is present in
CHANGELOG.mdBy submitting this pull request, I confirm that my contribution is made under the terms of the GNU LGPL 3.0 license.