Links in PDF's created using Story do not work if they use "text=" attribute

[wfsaxton]

Description of the bug

When creating a link without a text attribute:

with body.add_paragraph() as paragraph:
        paragraph.add_link(myurl)

Links are created and clickable. When using a text attribute however:

with body.add_paragraph() as paragraph:
        paragraph.add_link(myurl, text=mytext)

It looks like a link is created (blue and underlined) but you can't actually interact with it.

How to reproduce the bug

# PDF settings
WIDTH: Final[int] = 360
HEIGHT: Final[int] = 576
MARGIN: Final[int] = 18

# size and position the PDF pages
MEDIABOX: Final[Rect] = fitz.Rect(0, 0, WIDTH, HEIGHT)

# set the margins
WHERE: Final[Rect] = MEDIABOX + (  # noqa: RUF005 - ignoring this rule because its incorrect!
    MARGIN,
    MARGIN,
    -MARGIN,
    -MARGIN,
)

story = fitz.Story()

body = story.body

with body.add_paragraph() as paragraph:
        paragraph.add_link("https://github.com/", text="Github Home Page")

temp_pdf = BytesIO()

    with fitz.DocumentWriter(temp_pdf) as writer:
        more = 1
        pno = 1
        while more:
            device = writer.begin_page(MEDIABOX)
            more, _ = story.place(WHERE)
            story.draw(device)

            writer.end_page()
            pno += 1

    temp_pdf.seek(0)

PyMuPDF version

1.23.25

Operating system

Linux

Python version

3.11

[JorjMcKie]

Please consult the documentation: there is a special Story method available if links should automatically be generated: write_with_links().

[wfsaxton]

Ah, thank you. Didn't see that.

[wfsaxton]

If anyone is interested on how I got this working:

# PDF settings
WIDTH: Final[int] = 360
HEIGHT: Final[int] = 576
MARGIN: Final[int] = 18

# size and position the PDF pages
MEDIABOX: Final[Rect] = fitz.Rect(0, 0, WIDTH, HEIGHT)

# set the margins
WHERE: Final[Rect] = MEDIABOX + (  # noqa: RUF005 - ignoring this rule because its incorrect!
    MARGIN,
    MARGIN,
    -MARGIN,
    -MARGIN,
)

# size and position the footer
FTR_WHERE: Final[Rect] = fitz.Rect(
    MARGIN / 2,
    MEDIABOX.height - MARGIN * 2,
    MEDIABOX.width - MARGIN / 2,
    MEDIABOX.height,
)

...

def rectfn(
    rect_num: int,  # noqa: ARG001, required
    filled: fitz.Rect,  # noqa: ARG001, required
) -> tuple[fitz.Rect | None, fitz.Rect, fitz.Matrix | None]:
    """Create pages for the PDF."""
    mediabox = MEDIABOX  # Start a new page
    content_rect = WHERE  # Set where content goes
    ctm = None  # Use default transformation
    return mediabox, content_rect, ctm

def pagefn(
    page_num: int,
    mediabox: fitz.Rect,  # noqa: ARG001, required
    dev: fitz.Device,
    after: int,
) -> None:
    """Add the page footer to the PDF."""
    # For some reason, we have to print the page numbers first
    # because the first time after=1 is called, the page number is 2
    # and the last time after=1 is called, the page number never gets incremented
    if after == 0:  # Before page content is drawn
        footer = _footer_story(str(page_num))
        ftr_ok, _ = footer.place(FTR_WHERE)
        if ftr_ok != 0:
            raise ValueError("footer does not fit")
        footer.draw(dev, None)

pdf = story.write_with_links(rectfn=rectfn, pagefn=pagefn)

[JorjMcKie]

I'm going to move this post to "Discussions" in case you have more questions.