Fix `Text` class bug when `font` argument is provided without `math_fontfamily` #20101

ain-soph · 2021-04-28T20:27:53Z

PR Summary

Fix bug of #20099

Issue Analysis

import matplotlib.pyplot as plt
import matplotlib

plt.figure(figsize=(6, 5))
plt.plot(range(11), color="0.9")
msg = (r"Normal Text. $Text\ in\ math\ mode:\ "
       r"\int_{0}^{\infty } x^2 dx$")
plt.text(1, 7, msg, size=12, font='Arial')  # math_fontfamily='cm'
plt.show()

When you pass font='Arial' to plt.text() without math_fontfamily='cm' (Arial and cm just for example), it will raise Exception.
It is expected that the math_fontfamily will use the global default value rcParams['mathtext.fontset']. However, it is None actually.
The reason is that in

matplotlib/lib/matplotlib/text.py

Line 171 in 54a4b6f

self.update(kwargs)

font='Arial' is passed in kwargs, passing to

matplotlib/lib/matplotlib/artist.py

Lines 1059 to 1064 in 54a4b6f

    
           else: 
        
               func = getattr(self, f"set_{k}", None) 
        
               if not callable(func): 
        
                   raise AttributeError(f"{type(self).__name__!r} object " 
        
                                        f"has no property {k!r}") 
        
               ret.append(func(v))

go to Text.set_font_properties and then

matplotlib/lib/matplotlib/font_manager.py

Line 689 in 54a4b6f

return cls(arg)

Finally it calls Text(font), goes into the if condition

matplotlib/lib/matplotlib/font_manager.py

Lines 653 to 659 in 54a4b6f

    
           if isinstance(family, str): 
        
               # Treat family as a fontconfig pattern if it is the only 
        
               # parameter provided. 
        
               if (style is None and variant is None and weight is None and 
        
                       stretch is None and size is None and fname is None): 
        
                   self.set_fontconfig_pattern(family) 
        
                   return

It returns without self.set_math_fontfamily(math_fontfamily) (since it only occurs when if condition is False), leading to math_fontfamily=None rather than the global default.

ain-soph · 2021-04-28T20:29:41Z

@diegopetrola may take a glance of it.

github-actions

Thank you for opening your first PR into Matplotlib!

If you have not heard from us in a while, please feel free to ping @matplotlib/developers or anyone who has commented on the PR. Most of our reviewers are volunteers and sometimes things fall through the cracks.

You can also join us on gitter for real-time discussion.

For details on testing, writing docs, and our review process, please see the developer guide

We strive to be a welcoming and open project. Please follow our Code of Conduct.

ain-soph · 2021-04-28T20:38:00Z

I notice that another issue still exists after the initial fix, since the argument order matters.

import matplotlib.pyplot as plt
import matplotlib

matplotlib.rcParams['mathtext.fontset'] = 'cm'

plt.figure(figsize=(6, 5))
plt.plot(range(11), color="0.9")
msg = (r"Normal Text. $Text\ in\ math\ mode:\ "
       r"\int_{0}^{\infty } x^2 dx$")
plt.text(1, 7, msg, size=12, math_fontfamily='dejavusans', font='Arial')
plt.show()

If we put math_fontfamily='dejavusans' before font='Arial', then the plotted mathfont will still be cm (global default value in rcParams['mathtext.fontset']).
It is caused by

matplotlib/lib/matplotlib/artist.py

Lines 1059 to 1064 in 4e10777

    
           else: 
        
               func = getattr(self, f"set_{k}", None) 
        
               if not callable(func): 
        
                   raise AttributeError(f"{type(self).__name__!r} object " 
        
                                        f"has no property {k!r}") 
        
               ret.append(func(v))

where in L1048 for k, v in props.items(): the traverse order follows the passing argument orders.

Text.set_fontproperties will construct the self._fontproperties instance with self._math_fontfamily = rcParams['mathtext.fontset'] as default (None without my initial fix).

Text.set_math_fontfamily will set self._fontproperties._math_fontfamily = <desired passing value>

Therefore, we must ensure Text.set_fontproperties is called before Text.set_math_fontfamily.

ain-soph · 2021-04-28T21:06:16Z

This won't happen if you pass fontproperties='Arial' rather than font='Arial', because fontproperties is treated specially before any other arguments.

matplotlib/lib/matplotlib/text.py

Lines 177 to 181 in 54a4b6f

    
           sentinel = object()  # bbox can be None, so use another sentinel. 
        
           # Update fontproperties first, as it has lowest priority. 
        
           fontproperties = kwargs.pop("fontproperties", sentinel) 
        
           if fontproperties is not sentinel: 
        
               self.set_fontproperties(fontproperties)

But I think these 2 different names just equivalent aliases. So A possible solution is to treat font together with fontproperties as well.

ain-soph · 2021-04-28T21:18:12Z

A better fix might be using Text.alias_map defined in cbook.

matplotlib/lib/matplotlib/text.py

Lines 106 to 119 in 54a4b6f

    
           @cbook._define_aliases({ 
        
               "color": ["c"], 
        
               "fontfamily": ["family"], 
        
               "fontproperties": ["font", "font_properties"], 
        
               "horizontalalignment": ["ha"], 
        
               "multialignment": ["ma"], 
        
               "fontname": ["name"], 
        
               "fontsize": ["size"], 
        
               "fontstretch": ["stretch"], 
        
               "fontstyle": ["style"], 
        
               "fontvariant": ["variant"], 
        
               "verticalalignment": ["va"], 
        
               "fontweight": ["weight"], 
        
           })

QuLogic

Please give your PRs more descriptive titles.

This could also do with a test.

lib/matplotlib/text.py

indent fix Co-authored-by: Elliott Sales de Andrade <[email protected]>

ain-soph · 2021-04-29T00:33:18Z

The test functions have been commited. @QuLogic

lib/matplotlib/font_manager.py

lib/matplotlib/text.py

ain-soph · 2021-04-30T17:16:36Z

Please remove the “need tests” tag, since now it need review.
@matplotlib Hope anyone could take a review, I’d appreciate.

lib/matplotlib/tests/test_mathtext.py

ain-soph · 2021-05-13T21:17:19Z

@QuLogic Have fixed. Sorry for my carelessness.

QuLogic · 2021-05-15T00:05:59Z

This will need a rebase for the conflicts, and the tests need to pass.

QuLogic · 2021-05-18T00:27:13Z

Downstream CI seems to think this is not mergeable, though GitHub doesn't seem to be showing any conflicts. I guess this would need a rebase to work properly.

ain-soph · 2021-05-18T02:05:21Z

Sorry for first time dealing with co-operation workflow on GitHub. I create a pull request to merge master commits to my PR and solve the merge conflict by myself, guess it is equivalent to rebase all master commits onto my branch. Ping me if anything is wrong.

QuLogic · 2021-05-19T05:55:05Z

Oops, I only meant to Approve the workflows (that is very annoying to have to re-do so much), not mark the PR as ready. Is it ready?

ain-soph · 2021-05-19T18:48:36Z

@QuLogic I think it's ready. I'm fine if it requires more reviewer.

lib/matplotlib/text.py

QuLogic · 2021-05-26T05:33:42Z

Thanks @ain-soph! Congratulations on your first PR to Matplotlib 🎉 We hope to hear from you again.

…ontfamily` (matplotlib#20101) * fix mathtext.fontset issue * fix argument order issue * better fix using alias_map * indent fix * Update lib/matplotlib/text.py indent fix Co-authored-by: Elliott Sales de Andrade <[email protected]> * add test * split into 2 test methods * fix test * add a whitespace * use cbook.normalize_kwargs * no need to copy (normalize_kwargs already copy it) Co-authored-by: Elliott Sales de Andrade <[email protected]>

fix mathtext.fontset issue

add6ac2

github-actions bot reviewed Apr 28, 2021

View reviewed changes

fix argument order issue

af1ce2f

ain-soph added 2 commits April 28, 2021 17:27

better fix using alias_map

ca4b5af

indent fix

ca241dd

QuLogic reviewed Apr 28, 2021

View reviewed changes

lib/matplotlib/text.py Outdated Show resolved Hide resolved

QuLogic added status: needs tests topic: text/mathtext labels Apr 28, 2021

Update lib/matplotlib/text.py

87c80b6

indent fix Co-authored-by: Elliott Sales de Andrade <[email protected]>

ain-soph changed the title ~~Fix #20099~~ Fix Text class when font argument is provided without math_fontfamily Apr 28, 2021

ain-soph changed the title ~~Fix Text class when font argument is provided without math_fontfamily~~ Fix Text class bug when font argument is provided without math_fontfamily Apr 28, 2021

ain-soph added 3 commits April 28, 2021 20:28

add test

0e9954c

split into 2 test methods

842fc88

fix test

912a7cf

diegopetrola reviewed Apr 29, 2021

View reviewed changes

lib/matplotlib/font_manager.py Outdated Show resolved Hide resolved

diegopetrola reviewed Apr 29, 2021

View reviewed changes

lib/matplotlib/text.py Outdated Show resolved Hide resolved

Update font_manager.py

8a47e03

story645 added status: needs review and removed status: needs tests labels Apr 30, 2021

QuLogic reviewed May 6, 2021

View reviewed changes

ain-soph added 2 commits May 12, 2021 14:34

Update test_mathtext.py

5b00dfb

Update test_mathtext.py

4580007

jklymak approved these changes May 13, 2021

View reviewed changes

jklymak requested a review from timhoffm May 13, 2021 14:14

QuLogic reviewed May 13, 2021

View reviewed changes

lib/matplotlib/tests/test_mathtext.py Outdated Show resolved Hide resolved

lib/matplotlib/tests/test_mathtext.py Outdated Show resolved Hide resolved

lib/matplotlib/tests/test_mathtext.py Outdated Show resolved Hide resolved

Update test_mathtext.py

8f67ef5

jklymak marked this pull request as draft May 15, 2021 00:32

Update test_mathtext.py

0d1a388

ain-soph added 2 commits May 17, 2021 22:01

Merge branch

fddf4d1

add a whitespace

356c8db

QuLogic marked this pull request as ready for review May 19, 2021 05:54

QuLogic requested changes May 20, 2021

View reviewed changes

lib/matplotlib/text.py Outdated Show resolved Hide resolved

ain-soph added 2 commits May 20, 2021 02:04

use cbook.normalize_kwargs

38560bc

no need to copy (normalize_kwargs already copy it)

f6f0686

jklymak requested a review from QuLogic May 22, 2021 15:51

QuLogic approved these changes May 26, 2021

View reviewed changes

QuLogic merged commit c4dcf5e into matplotlib:master May 26, 2021

QuLogic removed the status: needs review label May 26, 2021

QuLogic added this to the v3.5.0 milestone May 26, 2021

	else:
	func = getattr(self, f"set_{k}", None)
	if not callable(func):
	raise AttributeError(f"{type(self).__name__!r} object "
	f"has no property {k!r}")
	ret.append(func(v))

	if isinstance(family, str):
	# Treat family as a fontconfig pattern if it is the only
	# parameter provided.
	if (style is None and variant is None and weight is None and
	stretch is None and size is None and fname is None):
	self.set_fontconfig_pattern(family)
	return

Uh oh!

Fix Text class bug when font argument is provided without math_fontfamily #20101

Fix Text class bug when font argument is provided without math_fontfamily #20101

Uh oh!

Conversation

ain-soph commented Apr 28, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Summary

Issue Analysis

Uh oh!

ain-soph commented Apr 28, 2021

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

ain-soph commented Apr 28, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ain-soph commented Apr 28, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ain-soph commented Apr 28, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

QuLogic left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ain-soph commented Apr 29, 2021

Uh oh!

Uh oh!

Uh oh!

ain-soph commented Apr 30, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ain-soph commented May 13, 2021

Uh oh!

QuLogic commented May 15, 2021

Uh oh!

QuLogic commented May 18, 2021

Uh oh!

ain-soph commented May 18, 2021

Uh oh!

QuLogic commented May 19, 2021

Uh oh!

ain-soph commented May 19, 2021

Uh oh!

Uh oh!

QuLogic commented May 26, 2021

Uh oh!

Uh oh!

Fix `Text` class bug when `font` argument is provided without `math_fontfamily` #20101

Fix `Text` class bug when `font` argument is provided without `math_fontfamily` #20101

ain-soph commented Apr 28, 2021 •

edited

Loading

ain-soph commented Apr 28, 2021 •

edited

Loading

ain-soph commented Apr 28, 2021 •

edited

Loading

ain-soph commented Apr 28, 2021 •

edited

Loading

ain-soph commented Apr 30, 2021 •

edited

Loading