python-fontbro 0.29.0__tar.gz → 0.30.0__tar.gz

{python_fontbro-0.29.0/python_fontbro.egg-info → python_fontbro-0.30.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-fontbro
-Version: 0.29.0
+Version: 0.30.0
 Summary: friendly font operations on top of fontTools.
 Author-email: Fabio Caccamo <fabio.caccamo@gmail.com>
 Maintainer-email: Fabio Caccamo <fabio.caccamo@gmail.com>

{python_fontbro-0.29.0 → python_fontbro-0.30.0}/fontbro/data/features.json

@@ -88,7 +88,7 @@
         "tag": "clig",
         "name": "Contextual Ligatures",
         "exposed": true,
-        "exposed_active": false
+        "exposed_active": true
     },
     {
         "tag": "cpct",

{python_fontbro-0.29.0 → python_fontbro-0.30.0}/fontbro/data/unicode-blocks.json

@@ -1015,6 +1015,10 @@
         "characters_total": 64,
         "name": "Tolong Siki"
     },
+    {
+        "characters_total": 16,
+        "name": "Bengali Supplement"
+    },
     {
         "characters_total": 32,
         "name": "Makasar"
@@ -1043,6 +1047,10 @@
         "characters_total": 208,
         "name": "Early Dynastic Cuneiform"
     },
+    {
+        "characters_total": 320,
+        "name": "Archaic Cuneiform Numerals"
+    },
     {
         "characters_total": 112,
         "name": "Cypro-Minoan"
@@ -1127,6 +1135,14 @@
         "characters_total": 128,
         "name": "Tangut Components Supplement"
     },
+    {
+        "characters_total": 928,
+        "name": "Jurchen"
+    },
+    {
+        "characters_total": 64,
+        "name": "Jurchen Radicals"
+    },
     {
         "characters_total": 16,
         "name": "Kana Extended-B"
@@ -1179,6 +1195,10 @@
         "characters_total": 80,
         "name": "Ancient Greek Musical Notation"
     },
+    {
+        "characters_total": 64,
+        "name": "Musical Symbols Supplement"
+    },
     {
         "characters_total": 32,
         "name": "Kaktovik Numerals"
@@ -1203,6 +1223,10 @@
         "characters_total": 688,
         "name": "Sutton SignWriting"
     },
+    {
+        "characters_total": 256,
+        "name": "Miscellaneous Symbols and Arrows Extended"
+    },
     {
         "characters_total": 256,
         "name": "Latin Extended-G"
@@ -1367,6 +1391,10 @@
         "characters_total": 4304,
         "name": "CJK Unified Ideographs Extension J"
     },
+    {
+        "characters_total": 11328,
+        "name": "Seal"
+    },
     {
         "characters_total": 128,
         "name": "Tags"

{python_fontbro-0.29.0 → python_fontbro-0.30.0}/fontbro/data/unicode-scripts.json

@@ -1,11 +1,11 @@
 [
     {
-        "characters_total": 9123,
+        "characters_total": 9276,
         "name": "Common",
         "tag": "Zyyy"
     },
     {
-        "characters_total": 1492,
+        "characters_total": 1653,
         "name": "Latin",
         "tag": "Latn"
     },
@@ -15,17 +15,17 @@
         "tag": "Bopo"
     },
     {
-        "characters_total": 684,
+        "characters_total": 695,
         "name": "Inherited",
         "tag": "Zinh"
     },
     {
-        "characters_total": 518,
+        "characters_total": 520,
         "name": "Greek",
         "tag": "Grek"
     },
     {
-        "characters_total": 143942,
+        "characters_total": 143911,
         "name": "Unknown",
         "tag": "Zzzz"
     },
@@ -40,17 +40,17 @@
         "tag": "Cyrl"
     },
     {
-        "characters_total": 96,
+        "characters_total": 99,
         "name": "Armenian",
         "tag": "Armn"
     },
     {
-        "characters_total": 134,
+        "characters_total": 136,
         "name": "Hebrew",
         "tag": "Hebr"
     },
     {
-        "characters_total": 1413,
+        "characters_total": 1452,
         "name": "Arabic",
         "tag": "Arab"
     },
@@ -80,12 +80,12 @@
         "tag": "Mand"
     },
     {
-        "characters_total": 164,
+        "characters_total": 165,
         "name": "Devanagari",
         "tag": "Deva"
     },
     {
-        "characters_total": 96,
+        "characters_total": 98,
         "name": "Bengali",
         "tag": "Beng"
     },
@@ -100,7 +100,7 @@
         "tag": "Gujr"
     },
     {
-        "characters_total": 91,
+        "characters_total": 93,
         "name": "Oriya",
         "tag": "Orya"
     },
@@ -280,17 +280,17 @@
         "tag": "Tfng"
     },
     {
-        "characters_total": 103351,
+        "characters_total": 103352,
         "name": "Han",
         "tag": "Hani"
     },
     {
-        "characters_total": 381,
+        "characters_total": 382,
         "name": "Hiragana",
         "tag": "Hira"
     },
     {
-        "characters_total": 321,
+        "characters_total": 327,
         "name": "Katakana",
         "tag": "Kana"
     },
@@ -745,10 +745,15 @@
         "tag": "Kawi"
     },
     {
-        "characters_total": 1234,
+        "characters_total": 1393,
         "name": "Cuneiform",
         "tag": "Xsux"
     },
+    {
+        "characters_total": 164,
+        "name": "Proto Cuneiform",
+        "tag": "Pcun"
+    },
     {
         "characters_total": 99,
         "name": "Cypro Minoan",
@@ -810,7 +815,7 @@
         "tag": "Plrd"
     },
     {
-        "characters_total": 7059,
+        "characters_total": 7061,
         "name": "Tangut",
         "tag": "Tang"
     },
@@ -820,10 +825,15 @@
         "tag": "Nshu"
     },
     {
-        "characters_total": 472,
+        "characters_total": 477,
         "name": "Khitan Small Script",
         "tag": "Kits"
     },
+    {
+        "characters_total": 965,
+        "name": "Jurchen",
+        "tag": "Jurc"
+    },
     {
         "characters_total": 143,
         "name": "Duployan",
@@ -873,5 +883,10 @@
         "characters_total": 88,
         "name": "Adlam",
         "tag": "Adlm"
+    },
+    {
+        "characters_total": 11328,
+        "name": "Seal",
+        "tag": "Seal"
     }
 ]

python_fontbro-0.30.0/fontbro/features.py

@@ -0,0 +1,124 @@
+from __future__ import annotations
+
+from typing import Any
+
+from fontTools.ttLib import TTFont
+
+from fontbro.utils import read_json
+
+# Features:
+# https://docs.microsoft.com/en-gb/typography/opentype/spec/featurelist
+# https://developer.mozilla.org/en-US/docs/Web/CSS/font-feature-settings
+_FEATURES_LIST: list[dict[str, Any]] = read_json("data/features.json")
+_FEATURES_BY_TAG: dict[str, dict[str, Any]] = {
+    feature["tag"]: feature for feature in _FEATURES_LIST
+}
+
+
+def get_features(
+    ttfont: TTFont,
+) -> list[dict[str, Any]]:
+    """
+    Gets the opentype features of the given font.
+    """
+    features_tags = get_features_tags(ttfont)
+    features_params = _get_features_params(ttfont)
+    features = []
+    for features_tag in features_tags:
+        if features_tag not in _FEATURES_BY_TAG:
+            continue
+        feature = _FEATURES_BY_TAG[features_tag].copy()
+        feature["params"] = _get_feature_params_dict(
+            ttfont, features_params.get(features_tag)
+        )
+        features.append(feature)
+    return features
+
+
+def _get_features_params(
+    ttfont: TTFont,
+) -> dict[str, Any]:
+    """
+    Gets the opentype features params (if any) of the given font by tag.
+    """
+    features_params: dict[str, Any] = {}
+    for table_tag in ["GPOS", "GSUB"]:
+        if table_tag in ttfont:
+            table = ttfont[table_tag].table
+            try:
+                feature_record = table.FeatureList.FeatureRecord or []
+            except AttributeError:
+                feature_record = []
+            for feature in feature_record:
+                feature_params = feature.Feature.FeatureParams
+                if feature_params is not None:
+                    features_params.setdefault(feature.FeatureTag, feature_params)
+    return features_params
+
+
+def _get_feature_params_dict(
+    ttfont: TTFont,
+    feature_params: Any,
+) -> dict[str, Any]:
+    """
+    Gets the designer-defined params of a feature:
+    stylistic sets (ss01-ss20) and character variants (cv01-cv99).
+    """
+
+    def get_name(name_id: int | None) -> str | None:
+        if not name_id or "name" not in ttfont:
+            return None
+        name: str | None = ttfont["name"].getDebugName(name_id)
+        return name
+
+    params: dict[str, Any] = {
+        "name": None,
+        "tooltip": None,
+        "sample_text": None,
+        "labels": [],
+        "characters": [],
+    }
+    if feature_params is None:
+        return params
+    params["name"] = get_name(
+        getattr(feature_params, "UINameID", None)
+        or getattr(feature_params, "FeatUILabelNameID", None)
+    )
+    params["tooltip"] = get_name(
+        getattr(feature_params, "FeatUITooltipTextNameID", None)
+    )
+    params["sample_text"] = get_name(getattr(feature_params, "SampleTextNameID", None))
+    first_label_name_id = getattr(feature_params, "FirstParamUILabelNameID", 0)
+    labels_count = getattr(feature_params, "NumNamedParameters", 0)
+    if first_label_name_id:
+        # keep missing labels as None to preserve the label index / feature value match
+        params["labels"] = [
+            get_name(first_label_name_id + index) for index in range(labels_count)
+        ]
+    # characters are stored as uint24, skip values that are not unicode scalar values
+    characters = getattr(feature_params, "Character", None) or []
+    params["characters"] = [
+        chr(character)
+        for character in characters
+        if 0 <= character <= 0x10FFFF and not 0xD800 <= character <= 0xDFFF
+    ]
+    return params
+
+
+def get_features_tags(
+    ttfont: TTFont,
+) -> list[str]:
+    """
+    Gets the opentype features tags of the given font.
+    """
+    features_tags = set()
+    for table_tag in ["GPOS", "GSUB"]:
+        if table_tag in ttfont:
+            table = ttfont[table_tag].table
+            try:
+                feature_record = table.FeatureList.FeatureRecord or []
+            except AttributeError:
+                feature_record = []
+            for feature in feature_record:
+                features_tags.add(feature.FeatureTag)
+    return sorted(features_tags)

{python_fontbro-0.29.0 → python_fontbro-0.30.0}/fontbro/metadata.py

@@ -4,4 +4,4 @@ __description__ = "friendly font operations on top of fontTools."
 __email__ = "fabio.caccamo@gmail.com"
 __license__ = "MIT"
 __title__ = "python-fontbro"
-__version__ = "0.29.0"
+__version__ = "0.30.0"

{python_fontbro-0.29.0 → python_fontbro-0.30.0/python_fontbro.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-fontbro
-Version: 0.29.0
+Version: 0.30.0
 Summary: friendly font operations on top of fontTools.
 Author-email: Fabio Caccamo <fabio.caccamo@gmail.com>
 Maintainer-email: Fabio Caccamo <fabio.caccamo@gmail.com>

python_fontbro-0.30.0/tests/test_features.py

@@ -0,0 +1,149 @@
+from tests import AbstractTestCase
+
+
+class FeaturesTestCase(AbstractTestCase):
+    """
+    Test case for the methods related to the font features.
+    """
+
+    def test_get_features(self):
+        font = self._get_font("/Roboto_Mono/static/RobotoMono-Regular.ttf")
+        features = font.get_features()
+        self.assertEqual(
+            features,
+            [
+                {
+                    "tag": "smcp",
+                    "name": "Small Capitals",
+                    "exposed": True,
+                    "exposed_active": False,
+                    "params": {
+                        "name": None,
+                        "tooltip": None,
+                        "sample_text": None,
+                        "labels": [],
+                        "characters": [],
+                    },
+                }
+            ],
+        )
+
+    def test_get_features_with_params(self):
+        font = self._get_font("/Inter/static/Inter-Regular.ttf")
+        features = font.get_features()
+        features_by_tag = {feature["tag"]: feature for feature in features}
+        self.assertEqual(
+            features_by_tag["cv11"],
+            {
+                "tag": "cv11",
+                "name": "Character Variant 11",
+                "exposed": True,
+                "exposed_active": False,
+                "params": {
+                    "name": "Single-storey a",
+                    "tooltip": None,
+                    "sample_text": None,
+                    "labels": [],
+                    "characters": [],
+                },
+            },
+        )
+        self.assertEqual(
+            features_by_tag["ss01"],
+            {
+                "tag": "ss01",
+                "name": "Stylistic Set 1",
+                "exposed": True,
+                "exposed_active": False,
+                "params": {
+                    "name": "Open digits",
+                    "tooltip": None,
+                    "sample_text": None,
+                    "labels": [],
+                    "characters": [],
+                },
+            },
+        )
+        self.assertEqual(
+            features_by_tag["salt"]["params"],
+            {
+                "name": None,
+                "tooltip": None,
+                "sample_text": None,
+                "labels": [],
+                "characters": [],
+            },
+        )
+
+    def test_get_features_with_character_variants_params(self):
+        from fontTools.ttLib.tables import otTables
+
+        font = self._get_font("/Inter/static/Inter-Regular.ttf")
+        ttfont = font.get_ttfont()
+        name_table = ttfont["name"]
+        feature_params = otTables.FeatureParamsCharacterVariants()
+        feature_params.Format = 0
+        feature_params.FeatUILabelNameID = name_table.addName("Alternate a")
+        feature_params.FeatUITooltipTextNameID = name_table.addName(
+            "Alternate a tooltip"
+        )
+        feature_params.SampleTextNameID = name_table.addName("aaa")
+        feature_params.NumNamedParameters = 2
+        feature_params.FirstParamUILabelNameID = name_table.addName("Single-storey")
+        name_table.addName("Double-storey")
+        feature_params.CharCount = 2
+        feature_params.Character = [0x61, 0xE0]
+        for feature_record in ttfont["GSUB"].table.FeatureList.FeatureRecord:
+            if feature_record.FeatureTag == "cv11":
+                feature_record.Feature.FeatureParams = feature_params
+        features = font.get_features()
+        features_by_tag = {feature["tag"]: feature for feature in features}
+        self.assertEqual(
+            features_by_tag["cv11"]["params"],
+            {
+                "name": "Alternate a",
+                "tooltip": "Alternate a tooltip",
+                "sample_text": "aaa",
+                "labels": ["Single-storey", "Double-storey"],
+                "characters": ["a", "à"],
+            },
+        )
+
+    def test_get_features_with_character_variants_params_malformed(self):
+        from fontTools.ttLib.tables import otTables
+
+        font = self._get_font("/Inter/static/Inter-Regular.ttf")
+        ttfont = font.get_ttfont()
+        name_table = ttfont["name"]
+        feature_params = otTables.FeatureParamsCharacterVariants()
+        feature_params.Format = 0
+        feature_params.FeatUILabelNameID = name_table.addName("Alternate a")
+        feature_params.FeatUITooltipTextNameID = 0
+        feature_params.SampleTextNameID = 0
+        feature_params.NumNamedParameters = 3
+        feature_params.FirstParamUILabelNameID = name_table.addName("Single-storey")
+        missing_label_name_id = name_table.addName("Double-storey")
+        name_table.addName("Open")
+        name_table.removeNames(nameID=missing_label_name_id)
+        feature_params.CharCount = 4
+        feature_params.Character = [0x61, 0xD800, 0x110000, 0xE0]
+        for feature_record in ttfont["GSUB"].table.FeatureList.FeatureRecord:
+            if feature_record.FeatureTag == "cv11":
+                feature_record.Feature.FeatureParams = feature_params
+        features = font.get_features()
+        features_by_tag = {feature["tag"]: feature for feature in features}
+        self.assertEqual(
+            features_by_tag["cv11"]["params"],
+            {
+                "name": "Alternate a",
+                "tooltip": None,
+                "sample_text": None,
+                "labels": ["Single-storey", None, "Open"],
+                "characters": ["a", "à"],
+            },
+        )
+
+    def test_get_features_tags(self):
+        font = self._get_font("/Roboto_Mono/static/RobotoMono-Regular.ttf")
+        features = font.get_features_tags()
+        self.assertEqual(features, ["smcp"])

python_fontbro-0.29.0/fontbro/features.py

@@ -1,48 +0,0 @@
-from __future__ import annotations
-
-from typing import Any
-
-from fontTools.ttLib import TTFont
-
-from fontbro.utils import read_json
-
-# Features:
-# https://docs.microsoft.com/en-gb/typography/opentype/spec/featurelist
-# https://developer.mozilla.org/en-US/docs/Web/CSS/font-feature-settings
-_FEATURES_LIST: list[dict[str, Any]] = read_json("data/features.json")
-_FEATURES_BY_TAG: dict[str, dict[str, Any]] = {
-    feature["tag"]: feature for feature in _FEATURES_LIST
-}
-
-
-def get_features(
-    ttfont: TTFont,
-) -> list[dict[str, Any]]:
-    """
-    Gets the opentype features of the given font.
-    """
-    features_tags = get_features_tags(ttfont)
-    return [
-        _FEATURES_BY_TAG.get(features_tag, {}).copy()
-        for features_tag in features_tags
-        if features_tag in _FEATURES_BY_TAG
-    ]
-
-
-def get_features_tags(
-    ttfont: TTFont,
-) -> list[str]:
-    """
-    Gets the opentype features tags of the given font.
-    """
-    features_tags = set()
-    for table_tag in ["GPOS", "GSUB"]:
-        if table_tag in ttfont:
-            table = ttfont[table_tag].table
-            try:
-                feature_record = table.FeatureList.FeatureRecord or []
-            except AttributeError:
-                feature_record = []
-            for feature in feature_record:
-                features_tags.add(feature.FeatureTag)
-    return sorted(features_tags)

python_fontbro-0.29.0/tests/test_features.py

@@ -1,27 +0,0 @@
-from tests import AbstractTestCase
-
-
-class FeaturesTestCase(AbstractTestCase):
-    """
-    Test case for the methods related to the font features.
-    """
-
-    def test_get_features(self):
-        font = self._get_font("/Roboto_Mono/static/RobotoMono-Regular.ttf")
-        features = font.get_features()
-        self.assertEqual(
-            features,
-            [
-                {
-                    "tag": "smcp",
-                    "name": "Small Capitals",
-                    "exposed": True,
-                    "exposed_active": False,
-                }
-            ],
-        )
-
-    def test_get_features_tags(self):
-        font = self._get_font("/Roboto_Mono/static/RobotoMono-Regular.ttf")
-        features = font.get_features_tags()
-        self.assertEqual(features, ["smcp"])