Font fallback #669

andersonhc · 2023-01-26T04:45:11Z

This is a draft PR for handling #637
Sending it now so you can take a look and validate that's the path you want to take.

Checklist:

The GitHub pipeline is OK (green),
meaning that both pylint (static code analyzer) and black (code formatter) are happy with the changes of this PR.
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/ folder
A mention of the change is present in CHANGELOG.md

By submitting this pull request, I confirm that my contribution is made under the terms of the GNU LGPL 3.0 license.

Co-authored-by: Lucas Cimon <925560+Lucas-C@users.noreply.github.com>

Lucas-C

The overall approach seems good to me!

Ping @gmischler if he wants to get a look at this 😊

fpdf/fpdf.py

test/fonts/test_font_fallback.py

fpdf/fpdf.py

gmischler · 2023-01-31T13:05:53Z

fpdf/fpdf.py

@@ -1981,6 +1982,12 @@ def set_stretching(self, stretching):
        if self.page > 0:
            self._out(f"BT {stretching:.2f} Tz ET")

+    def set_fallback_fonts(self, fallback_fonts):


maybe add_fallback_fonts() ?
That would give the users more flexibility, in case they discover they need to add another font later on.

add_fallback_fonts(), as I understand it, could be a bit limiting, as it would not allow to remove fallback fonts, for example in some sections of a document.
In that sense set_fallback_fonts() would provide a bit more control to the users: they could call it with more or less fonts, and even with [] to remove all fallback fonts.

fpdf/fpdf.py

Lucas-C · 2023-02-16T11:17:57Z

Hi @andersonhc!

I hope our feedbacks on this PR did not discourage you 😊
Can we help you to finish this work?
This would be a nice new feature for fpdf2!

andersonhc · 2023-02-16T16:32:33Z

Hi @andersonhc!

I hope our feedbacks on this PR did not discourage you 😊 Can we help you to finish this work? This would be a nice new feature for fpdf2!

I got sidetracked working on #696.
I'll get back to this soon.

Co-authored-by: Lucas Cimon <925560+Lucas-C@users.noreply.github.com>

Lucas-C

Great work!
I gave you some final feedbacks / suggestions.
I'll be happy to merge this PR as soon as those points are addressed 😊

test/fonts/test_font_fallback.py

fpdf/output.py

Lucas-C · 2023-02-27T10:00:14Z

test/fonts/test_font_fallback.py

+        txt="hello world 😄 😁 😆 😅 ✌ 🤞 🌭 🍔 🍟 🍕", w=50, new_x=XPos.LMARGIN, new_y=YPos.NEXT
+    )
+    pdf.write(txt="hello world 😄 😁 😆 😅 ✌ 🤞 🌭 🍔 🍟 🍕")
+    assert_pdf_equal(pdf, HERE / "font_fallback.pdf", tmp_path)


Finally, could you please add a check that the warning you added in #661 is not raised in that scenario?

I think something along those lines should do the trick:

assert len(caplog.text) == 0

Lucas-C · 2023-02-27T14:38:40Z

You may want to get rid of PYTHONMALLOCSTATS as part of this PR to avoid the GitHub Actions logs being bloated, cf. #657 (comment)

test/fonts/test_font_fallback.py

docs/Fallback_fonts.md

codecov · 2023-02-28T17:40:01Z

Codecov Report

Patch coverage: 97.93% and project coverage change: +0.08 🎉

Comparison is base (2f062b2) 93.66% compared to head (1115aeb) 93.75%.

❗ Current head 1115aeb differs from pull request most recent head 3f6c8aa. Consider uploading reports for the commit 3f6c8aa to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #669      +/-   ##
==========================================
+ Coverage   93.66%   93.75%   +0.08%     
==========================================
  Files          26       26              
  Lines        6868     7008     +140     
  Branches     1226     1258      +32     
==========================================
+ Hits         6433     6570     +137     
- Misses        259      260       +1     
- Partials      176      178       +2

Impacted Files	Coverage Δ
fpdf/output.py	`96.65% <92.30%> (-0.20%)`	⬇️
fpdf/fpdf.py	`91.92% <98.66%> (+0.26%)`	⬆️
fpdf/enums.py	`100.00% <100.00%> (ø)`
fpdf/image_parsing.py	`83.25% <100.00%> (+1.48%)`	⬆️
fpdf/line_break.py	`99.60% <100.00%> (+0.03%)`	⬆️

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 at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

Lucas-C · 2023-03-01T06:33:17Z

Merged! Thank you @andersonhc !

Lucas-C · 2023-03-01T07:40:30Z

There was a minor bug remaining in this PR when markdown=True;
I opened #712 to fix it.
Could you please give it a look @andersonhc when you'll have some time?
I basically got rid of the style parameter of _get_fallback_font(),
and I'l like to know if you think that's fine 😊

andersonhc · 2023-03-02T14:13:02Z

There was a minor bug remaining in this PR when markdown=True; I opened #712 to fix it. Could you please give it a look @andersonhc when you'll have some time? I basically got rid of the style parameter of _get_fallback_font(), and I'l like to know if you think that's fine 😊

The 2 missing glyphs were by design... it was "bold" on markdown and I didn't set any bold emoji font, so they were missing just like it does when you don't have a fallback font.

The solution in #712 disregard style, so bold text can be replaced by a non-bold fallback font.

Lucas-C · 2023-03-03T09:38:37Z

The 2 missing glyphs were by design... it was "bold" on markdown and I didn't set any bold emoji font, so they were missing just like it does when you don't have a fallback font.

Oh OK! I did not realize that it was "by design" 😊

The solution in #712 disregard style, so bold text can be replaced by a non-bold fallback font.

Indeed.

What would you think about introducing a new ignore_style optional argument to set_font_fallback()?
It would be False by default, and you original behaviour would be implemented, but settng it to True
would allow bold/italics text to be replaced by a non-bold fallback font.

(I suggested that we continue this discusion in comments on #712)

andersonhc and others added 8 commits January 6, 2023 09:05

Show warning if font is missing glyphs

f5b3c73

Change LOGGER.warn to warning

b38248c

Co-authored-by: Lucas Cimon <925560+Lucas-C@users.noreply.github.com>

add a unit test and comment on changelog

508a85a

Merge branch 'font' of https://github.com/andersonhc/fpdf2 into font

b0f3b9e

increase memory cap

2db0667

increase memory cap

3f92160

Initial commit of font fallback

38fcaa5

Merge branch 'font' of https://github.com/andersonhc/fpdf2 into font

49a0845

andersonhc requested a review from Lucas-C as a code owner January 26, 2023 04:45

andersonhc added 2 commits January 26, 2023 22:16

fix pylint complaints

9db6834

.

3800d00

Lucas-C reviewed Jan 31, 2023

View reviewed changes

gmischler reviewed Jan 31, 2023

View reviewed changes

fpdf/fpdf.py Show resolved Hide resolved

andersonhc and others added 9 commits February 16, 2023 21:51

Update fpdf/fpdf.py

e5d2b85

Co-authored-by: Lucas Cimon <925560+Lucas-C@users.noreply.github.com>

Update fpdf/fpdf.py

d5b2fa1

Co-authored-by: Lucas Cimon <925560+Lucas-C@users.noreply.github.com>

Update test/fonts/test_font_fallback.py

02eee8d

Co-authored-by: Lucas Cimon <925560+Lucas-C@users.noreply.github.com>

Update fpdf/fpdf.py

a227d97

Co-authored-by: Lucas Cimon <925560+Lucas-C@users.noreply.github.com>

Update fpdf/fpdf.py

9d6bdf2

Co-authored-by: Lucas Cimon <925560+Lucas-C@users.noreply.github.com>

Merge branch 'PyFPDF:master' into font

b6b6326

fix set fallback font

493b3c5

fix for pylint

cfb1fe4

fix iteration on list

7a5b20b

Lucas-C approved these changes Feb 27, 2023

View reviewed changes

Merge branch 'PyFPDF:master' into font

ad3ef39

improve tests and add documentation

9c18156

Lucas-C reviewed Feb 27, 2023

View reviewed changes

test/fonts/test_font_fallback.py Show resolved Hide resolved

Lucas-C reviewed Feb 27, 2023

View reviewed changes

docs/Fallback_fonts.md Outdated Show resolved Hide resolved

andersonhc added 13 commits February 27, 2023 14:24

Delete Fallback_fonts.md

d34cb9a

fix documentation and tests

562db37

Add files via upload

75e1cdb

remove unused parameter

0dde51a

increase memory consumption limit

32ab133

Update test_load_image.py

25ed568

trying to store cmap keys for performance

40ff26a

Delete EmojiOneColor-SVGinOT.ttf

75697d9

change test to use smaller font

20e40dd

Update test_font_fallback.py

c0a2573

test increasing memory cap

a5e96d4

Add files via upload

a2a627d

increase memory cap

3f6c8aa

Lucas-C merged commit 89c528d into py-pdf:master Mar 1, 2023

Lucas-C mentioned this pull request Mar 1, 2023

Fix for set_fallback_fonts() when markdown=True #712

Merged

This was referenced Mar 3, 2023

Implement FPDF.table() - close #701 & #723 #703

Merged

Font fallback #637

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Font fallback #669

Font fallback #669

andersonhc commented Jan 26, 2023 •

edited

Loading

Lucas-C left a comment

gmischler Jan 31, 2023

Lucas-C Jan 31, 2023

Lucas-C commented Feb 16, 2023

andersonhc commented Feb 16, 2023

Lucas-C left a comment

Lucas-C Feb 27, 2023

Lucas-C Feb 27, 2023

Lucas-C commented Feb 27, 2023

codecov bot commented Feb 28, 2023

Lucas-C commented Mar 1, 2023

Lucas-C commented Mar 1, 2023

andersonhc commented Mar 2, 2023

Lucas-C commented Mar 3, 2023 •

edited

Loading

Font fallback #669

Font fallback #669

Conversation

andersonhc commented Jan 26, 2023 • edited Loading

Lucas-C left a comment

Choose a reason for hiding this comment

gmischler Jan 31, 2023

Choose a reason for hiding this comment

Lucas-C Jan 31, 2023

Choose a reason for hiding this comment

Lucas-C commented Feb 16, 2023

andersonhc commented Feb 16, 2023

Lucas-C left a comment

Choose a reason for hiding this comment

Lucas-C Feb 27, 2023

Choose a reason for hiding this comment

Lucas-C Feb 27, 2023

Choose a reason for hiding this comment

Lucas-C commented Feb 27, 2023

codecov bot commented Feb 28, 2023

Codecov Report

Lucas-C commented Mar 1, 2023

Lucas-C commented Mar 1, 2023

andersonhc commented Mar 2, 2023

Lucas-C commented Mar 3, 2023 • edited Loading

andersonhc commented Jan 26, 2023 •

edited

Loading

Lucas-C commented Mar 3, 2023 •

edited

Loading