Switch to new pypdfium2 API

[mara004]

Modifications to use the new pypdfium2 API (see #844).
I did not dare to try render_pdf_tobytes(), as I think that might change the colour format from RGB to BGR.

[fg-mindee]

Thanks a lot for the PR!

It's much appreciated that upstream projects help with the transition from one version of their project to the next 🙏 I added a few comments, let me know what you think!

[mara004]

I have now released pypdfium2 1.0.0 and applied the review suggestions. Could you please re-run CI?

[fg-mindee]

I have now released pypdfium2 1.0.0 and applied the review suggestions. Could you please re-run CI?

Thanks for the ping 🙏

I'm all for loose version specifiers as long as they don't put too much constraints to avoid pushing to many env constraints on the user. So here are a few questions:

• are there dependency changes with this new release?
• apart from the import/call of the function to render the page, does the behaviour change in any noticeable way in release 1.0.0?

If it's only a change of import location, perhaps we could have a dynamic import depending on the version of pypfdium2. But if there are no modifications on version specifiers with this new release, then it's not worth going through this trouble and we can move forward with the PR as is :)

[codecov]

Codecov Report

Merging #845 (d3f6d9b) into main (bc03a0f) will decrease coverage by 0.01%.
The diff coverage is 83.33%.

@@            Coverage Diff             @@
##             main     #845      +/-   ##
==========================================
- Coverage   94.84%   94.82%   -0.02%     
==========================================
  Files         133      133              
  Lines        5197     5200       +3     
==========================================
+ Hits         4929     4931       +2     
- Misses        268      269       +1     

Flag	Coverage Δ
unittests	94.82% <83.33%> (-0.02%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
doctr/io/pdf.py	93.33% <83.33%> (-6.67%)	⬇️
doctr/transforms/modules/base.py	94.59% <0.00%> (ø)
doctr/transforms/functional/base.py	95.65% <0.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update bc03a0f...d3f6d9b. Read the comment docs.

[mara004]

are there dependency changes with this new release?

The dependency on PIL/Pillow has been made optional. This means the core library now does not have external runtime dependencies anymore. Otherwise, there are no dependency changes.

If it's only a change of import location, perhaps we could have a dynamic import depending on the version of pypfdium2.

It essentially is a renaming from render_pdf() to render_pdf_topil(). Theoretically, I believe it would be possible to use hasattr() or check the version specifier to make the code work with older versions of pypdfium2. Probably somewhat like this:

import pypdfium2 as pdfium

if pdfium._version.V_MAJOR == 0:
    render_pdf_func = pdfium.render_pdf
else:
    render_pdf_func = pdfium.render_pdf_topil

# ...
return [np.asarray(img) for img, _ in render_pdf_func(file, scale=scale, **kwargs)]

However, I don't believe it's worth the additional code, considering that pypdfium2 < 1 has not been widely used.

apart from the import/call of the function to render the page, does the behaviour change in any noticeable way in release 1.0.0?

Other parts of the public API have not changed much; it's mainly improvements under the hood. You can refer to the Changelog for more details.

[fg-mindee]

Thanks a lot for the PR 🙏 Indeed with the small dependency specifier modifications, it's not worth going through the trouble of a dynamic import!

[mara004]

Thanks!