Skip to content

Update to score_family in font_manager.py #4689

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 21, 2015
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Update to score_family in font_manager.py
This PR fixes the score calculation for the case of matching a generic font name given in the `families` list.

The returned score is now constrained by the position `i` of the match in the list. If the font being scored (`family2`) is the first choice for that generic name in rcParams, it will receive the same score as if it were an exact match for that position in the `families` list, namely `i / len(families)`. If the font being scored is in the alias list but not the first choice, the returned score will be greater than `i / len(families)` but less than `(i + 1) / len(families)`, ensuring that the preferred order of fonts listed in both `families` and rcParams font alias list are respected.
  • Loading branch information
chadawagner committed Jul 14, 2015
commit 78073d3c5bcccf3755aafde3149e37ca7e559bff
10 changes: 5 additions & 5 deletions lib/matplotlib/font_manager.py
Original file line number Diff line number Diff line change
Expand Up @@ -1099,15 +1099,16 @@ def score_family(self, families, family2):
Returns a match score between the list of font families in
*families* and the font family name *family2*.

An exact match anywhere in the list returns 0.0.
An exact match at the head of the list returns 0.0.

A match by generic font name will return 0.1.
A match further down the list will return between 0 and 1.

No match will return 1.0.
"""
if not isinstance(families, (list, tuple)):
families = [families]
family2 = family2.lower()
step = 1 / len(families)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we need a special case here for len(families) == 0. Unlikely, but technically possible.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In which case, it should just return 1 immediately.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed, although it never checked before. Not a bad idea tho to be safe.

for i, family1 in enumerate(families):
family1 = family1.lower()
if family1 in font_family_aliases:
Expand All @@ -1117,12 +1118,11 @@ def score_family(self, families, family2):
options = [x.lower() for x in options]
if family2 in options:
idx = options.index(family2)
return ((0.1 * (idx / len(options))) *
((i + 1) / len(families)))
return (i + idx / len(options)) * step
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add some () here to be explicit about the grouping intended?

elif family1 == family2:
# The score should be weighted by where in the
# list the font was found.
return i / len(families)
return i * step
return 1.0

def score_style(self, style1, style2):
Expand Down