ft2font: Convert flag properties to enums

Author: QuLogic

doc/api/next_api_changes/deprecations/28842-ES.rst

@@ -34,3 +34,22 @@ prefix):
 - ``LOAD_TARGET_MONO``
 - ``LOAD_TARGET_LCD``
 - ``LOAD_TARGET_LCD_V``
+
+The following constants are now part of `.ft2font.FaceFlags`:
+
+- ``EXTERNAL_STREAM``
+- ``FAST_GLYPHS``
+- ``FIXED_SIZES``
+- ``FIXED_WIDTH``
+- ``GLYPH_NAMES``
+- ``HORIZONTAL``
+- ``KERNING``
+- ``MULTIPLE_MASTERS``
+- ``SCALABLE``
+- ``SFNT``
+- ``VERTICAL``
+
+The following constants are now part of `.ft2font.StyleFlags`:
+
+- ``ITALIC``
+- ``BOLD``

galleries/examples/misc/ftface_props.py

@@ -46,18 +46,10 @@
     # vertical thickness of the underline
     print('Underline thickness:', font.underline_thickness)
 
-for style in ('Italic',
-              'Bold',
-              'Scalable',
-              'Fixed sizes',
-              'Fixed width',
-              'SFNT',
-              'Horizontal',
-              'Vertical',
-              'Kerning',
-              'Fast glyphs',
-              'Multiple masters',
-              'Glyph names',
-              'External stream'):
-    bitpos = getattr(ft, style.replace(' ', '_').upper()) - 1
-    print(f"{style+':':17}", bool(font.style_flags & (1 << bitpos)))
+for flag in ft.StyleFlags:
+    name = flag.name.replace('_', ' ').title() + ':'
+    print(f"{name:17}", flag in font.style_flags)
+
+for flag in ft.FaceFlags:
+    name = flag.name.replace('_', ' ').title() + ':'
+    print(f"{name:17}", flag in font.face_flags)

lib/matplotlib/backends/backend_pdf.py

@@ -35,7 +35,7 @@
 from matplotlib.figure import Figure
 from matplotlib.font_manager import get_font, fontManager as _fontManager
 from matplotlib._afm import AFM
-from matplotlib.ft2font import FIXED_WIDTH, ITALIC, FT2Font, Kerning, LoadFlags
+from matplotlib.ft2font import FT2Font, FaceFlags, Kerning, LoadFlags, StyleFlags
 from matplotlib.transforms import Affine2D, BboxBase
 from matplotlib.path import Path
 from matplotlib.dates import UTC
@@ -1416,15 +1416,15 @@ def embedTTFType42(font, characters, descriptor):
 
         flags = 0
         symbolic = False  # ps_name.name in ('Cmsy10', 'Cmmi10', 'Cmex10')
-        if ff & FIXED_WIDTH:
+        if FaceFlags.FIXED_WIDTH in ff:
             flags |= 1 << 0
         if 0:  # TODO: serif
             flags |= 1 << 1
         if symbolic:
             flags |= 1 << 2
         else:
             flags |= 1 << 5
-        if sf & ITALIC:
+        if StyleFlags.ITALIC in sf:
             flags |= 1 << 6
         if 0:  # TODO: all caps
             flags |= 1 << 16

lib/matplotlib/font_manager.py

@@ -381,7 +381,7 @@ def ttfFontProperty(font):
         style = 'italic'
     elif sfnt2.find('regular') >= 0:
         style = 'normal'
-    elif font.style_flags & ft2font.ITALIC:
+    elif ft2font.StyleFlags.ITALIC in font.style_flags:
         style = 'italic'
     else:
         style = 'normal'
@@ -430,7 +430,7 @@ def get_weight():  # From fontconfig's FcFreeTypeQueryFaceInternal.
             for regex, weight in _weight_regexes:
                 if re.search(regex, style, re.I):
                     return weight
-        if font.style_flags & ft2font.BOLD:
+        if ft2font.StyleFlags.BOLD in font.style_flags:
             return 700  # "bold"
         return 500  # "medium", not "regular"!
 

lib/matplotlib/ft2font.pyi

@@ -8,19 +8,27 @@ from numpy.typing import NDArray
 
 __freetype_build_type__: str
 __freetype_version__: str
-BOLD: int
-EXTERNAL_STREAM: int
-FAST_GLYPHS: int
-FIXED_SIZES: int
-FIXED_WIDTH: int
-GLYPH_NAMES: int
-HORIZONTAL: int
-ITALIC: int
-KERNING: int
-MULTIPLE_MASTERS: int
-SCALABLE: int
-SFNT: int
-VERTICAL: int
+
+class FaceFlags(Flag):
+    SCALABLE: int
+    FIXED_SIZES: int
+    FIXED_WIDTH: int
+    SFNT: int
+    HORIZONTAL: int
+    VERTICAL: int
+    KERNING: int
+    FAST_GLYPHS: int
+    MULTIPLE_MASTERS: int
+    GLYPH_NAMES: int
+    EXTERNAL_STREAM: int
+    HINTER: int
+    CID_KEYED: int
+    TRICKY: int
+    COLOR: int
+    # VARIATION: int  # FT 2.9
+    # SVG: int  # FT 2.12
+    # SBIX: int  # FT 2.12
+    # SBIX_OVERLAY: int  # FT 2.12
 
 class Kerning(Enum):
     DEFAULT: int
@@ -54,6 +62,10 @@ class LoadFlags(Flag):
     TARGET_LCD: int
     TARGET_LCD_V: int
 
+class StyleFlags(Flag):
+    ITALIC: int
+    BOLD: int
+
 class _SfntHeadDict(TypedDict):
     version: tuple[int, int]
     fontRevision: tuple[int, int]
@@ -232,7 +244,7 @@ class FT2Font(Buffer):
     @property
     def descender(self) -> int: ...
     @property
-    def face_flags(self) -> int: ...
+    def face_flags(self) -> FaceFlags: ...
     @property
     def family_name(self) -> str: ...
     @property
@@ -256,7 +268,7 @@ class FT2Font(Buffer):
     @property
     def scalable(self) -> bool: ...
     @property
-    def style_flags(self) -> int: ...
+    def style_flags(self) -> StyleFlags: ...
     @property
     def style_name(self) -> str: ...
     @property

lib/matplotlib/tests/test_ft2font.py

@@ -44,10 +44,11 @@ def test_ft2font_dejavu_attrs():
     assert font.num_fixed_sizes == 0  # All glyphs are scalable.
     assert font.num_charmaps == 5
     # Other internal flags are set, so only check the ones we're allowed to test.
-    expected_flags = (ft2font.SCALABLE | ft2font.SFNT | ft2font.HORIZONTAL |
-                      ft2font.KERNING | ft2font.GLYPH_NAMES)
-    assert (font.face_flags & expected_flags) == expected_flags
-    assert font.style_flags == 0  # Not italic or bold.
+    expected_flags = (ft2font.FaceFlags.SCALABLE | ft2font.FaceFlags.SFNT |
+                      ft2font.FaceFlags.HORIZONTAL | ft2font.FaceFlags.KERNING |
+                      ft2font.FaceFlags.GLYPH_NAMES)
+    assert expected_flags in font.face_flags
+    assert font.style_flags == ft2font.StyleFlags.NORMAL
     assert font.scalable
     # From FontForge: Font Information → General tab → entry name below.
     assert font.units_per_EM == 2048  # Em Size.
@@ -76,10 +77,10 @@ def test_ft2font_cm_attrs():
     assert font.num_fixed_sizes == 0  # All glyphs are scalable.
     assert font.num_charmaps == 2
     # Other internal flags are set, so only check the ones we're allowed to test.
-    expected_flags = (ft2font.SCALABLE | ft2font.SFNT | ft2font.HORIZONTAL |
-                      ft2font.GLYPH_NAMES)
-    assert (font.face_flags & expected_flags) == expected_flags, font.face_flags
-    assert font.style_flags == 0  # Not italic or bold.
+    expected_flags = (ft2font.FaceFlags.SCALABLE | ft2font.FaceFlags.SFNT |
+                      ft2font.FaceFlags.HORIZONTAL | ft2font.FaceFlags.GLYPH_NAMES)
+    assert expected_flags in font.face_flags
+    assert font.style_flags == ft2font.StyleFlags.NORMAL
     assert font.scalable
     # From FontForge: Font Information → General tab → entry name below.
     assert font.units_per_EM == 2048  # Em Size.
@@ -108,10 +109,10 @@ def test_ft2font_stix_bold_attrs():
     assert font.num_fixed_sizes == 0  # All glyphs are scalable.
     assert font.num_charmaps == 3
     # Other internal flags are set, so only check the ones we're allowed to test.
-    expected_flags = (ft2font.SCALABLE | ft2font.SFNT | ft2font.HORIZONTAL |
-                      ft2font.GLYPH_NAMES)
-    assert (font.face_flags & expected_flags) == expected_flags, font.face_flags
-    assert font.style_flags == ft2font.BOLD
+    expected_flags = (ft2font.FaceFlags.SCALABLE | ft2font.FaceFlags.SFNT |
+                      ft2font.FaceFlags.HORIZONTAL | ft2font.FaceFlags.GLYPH_NAMES)
+    assert expected_flags in font.face_flags
+    assert font.style_flags == ft2font.StyleFlags.BOLD
     assert font.scalable
     # From FontForge: Font Information → General tab → entry name below.
     assert font.units_per_EM == 1000  # Em Size.