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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-fontbro
-Version: 0.29.0
+Version: 0.31.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>
@@ -149,6 +149,7 @@ with open("fonts/MyFont.ttf") as fh:
 -   [`is_static`](#is_static)
 -   [`is_variable`](#is_variable)
 -   [`rename`](#rename)
+-   [`rename_variable_instances`](#rename_variable_instances)
 -   [`sanitize`](#sanitize)
 -   [`save`](#save)
 -   [`save_as_woff`](#save_as_woff)
@@ -966,6 +967,8 @@ variable = font.is_variable()
 """
 Renames the font names records (1, 2, 4, 6, 16, 17) according to
 the given family_name and style_name (subfamily_name).
+The names records (18, 25), the fvar named instances PostScript names
+and the CFF table names are updated too, only if already defined.
 
 If family_name is not defined it will be auto-detected.
 If style_name is not defined it will be auto-detected.
@@ -985,6 +988,39 @@ font.rename(
 )
 ```
 
+#### `rename_variable_instances`
+```python
+"""
+Renames the named instances of the variable font.
+
+The family_name replaces the family part of the instances PostScript names
+(and of the variations PostScript name prefix, if defined).
+The style_names replace the instances style names and the style part
+of their PostScript names. The axes names are unchanged.
+The default instance style name must match the font style name,
+so renaming it renames the font style too.
+
+If family_name is not defined it will be auto-detected.
+
+:param family_name: The family name
+:type family_name: str
+:param style_names: The new style names mapped by the old ones (case-insensitive),
+    eg. {"Thin": "Hairline"}
+:type style_names: dict or None
+:param update_style_flags: if True the style flags will be updated by subfamily name
+    (only if the default instance style name is renamed)
+:type update_style_flags: bool
+
+:raises OperationError: if the font is not a variable font.
+"""
+
+font.rename_variable_instances(
+    family_name="My Font New",
+    style_names={"Thin": "Hairline"},
+    update_style_flags=True,
+)
+```
+
 #### `sanitize`
 ```python
 """
@@ -1360,6 +1396,12 @@ If an axis min and max values are equal, the axis will be pinned.
     {'wdth':100, 'wght':[100,600], 'ital':[30,65,70]} or
     {'wdth':100, 'wght':{'min':100,'max':600}, 'ital':{'min':30,'default':65,'max':70}}
 :type coordinates: dict
+:param update_names: if True the name records will be updated based on
+    the closest instance to the new default coordinates (only if changed)
+:type update_names: bool
+:param update_style_flags: if True the style flags will be updated based on
+    the closest instance to the new default coordinates (only if changed)
+:type update_style_flags: bool
 :param options: The options for the fontTools.varLib.instancer
 :type options: dictionary
 
@@ -1368,7 +1410,12 @@ If an axis min and max values are equal, the axis will be pinned.
 :raises ValueError: If the coordinates axes are all pinned
 """
 
-font.to_sliced_variable(coordinates, **options)
+font.to_sliced_variable(
+    coordinates,
+    update_names=True,
+    update_style_flags=True,
+    **options,
+)
 ```
 
 #### `to_static`

{python_fontbro-0.29.0 → python_fontbro-0.31.0}/README.md

@@ -85,6 +85,7 @@ with open("fonts/MyFont.ttf") as fh:
 -   [`is_static`](#is_static)
 -   [`is_variable`](#is_variable)
 -   [`rename`](#rename)
+-   [`rename_variable_instances`](#rename_variable_instances)
 -   [`sanitize`](#sanitize)
 -   [`save`](#save)
 -   [`save_as_woff`](#save_as_woff)
@@ -902,6 +903,8 @@ variable = font.is_variable()
 """
 Renames the font names records (1, 2, 4, 6, 16, 17) according to
 the given family_name and style_name (subfamily_name).
+The names records (18, 25), the fvar named instances PostScript names
+and the CFF table names are updated too, only if already defined.
 
 If family_name is not defined it will be auto-detected.
 If style_name is not defined it will be auto-detected.
@@ -921,6 +924,39 @@ font.rename(
 )
 ```
 
+#### `rename_variable_instances`
+```python
+"""
+Renames the named instances of the variable font.
+
+The family_name replaces the family part of the instances PostScript names
+(and of the variations PostScript name prefix, if defined).
+The style_names replace the instances style names and the style part
+of their PostScript names. The axes names are unchanged.
+The default instance style name must match the font style name,
+so renaming it renames the font style too.
+
+If family_name is not defined it will be auto-detected.
+
+:param family_name: The family name
+:type family_name: str
+:param style_names: The new style names mapped by the old ones (case-insensitive),
+    eg. {"Thin": "Hairline"}
+:type style_names: dict or None
+:param update_style_flags: if True the style flags will be updated by subfamily name
+    (only if the default instance style name is renamed)
+:type update_style_flags: bool
+
+:raises OperationError: if the font is not a variable font.
+"""
+
+font.rename_variable_instances(
+    family_name="My Font New",
+    style_names={"Thin": "Hairline"},
+    update_style_flags=True,
+)
+```
+
 #### `sanitize`
 ```python
 """
@@ -1296,6 +1332,12 @@ If an axis min and max values are equal, the axis will be pinned.
     {'wdth':100, 'wght':[100,600], 'ital':[30,65,70]} or
     {'wdth':100, 'wght':{'min':100,'max':600}, 'ital':{'min':30,'default':65,'max':70}}
 :type coordinates: dict
+:param update_names: if True the name records will be updated based on
+    the closest instance to the new default coordinates (only if changed)
+:type update_names: bool
+:param update_style_flags: if True the style flags will be updated based on
+    the closest instance to the new default coordinates (only if changed)
+:type update_style_flags: bool
 :param options: The options for the fontTools.varLib.instancer
 :type options: dictionary
 
@@ -1304,7 +1346,12 @@ If an axis min and max values are equal, the axis will be pinned.
 :raises ValueError: If the coordinates axes are all pinned
 """
 
-font.to_sliced_variable(coordinates, **options)
+font.to_sliced_variable(
+    coordinates,
+    update_names=True,
+    update_style_flags=True,
+    **options,
+)
 ```
 
 #### `to_static`

{python_fontbro-0.29.0 → python_fontbro-0.31.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.31.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.31.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.31.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.31.0}/fontbro/font.py

@@ -1227,6 +1227,8 @@ class Font:
         """
         Renames the font names records (1, 2, 4, 6, 16, 17) according to
         the given family_name and style_name (subfamily_name).
+        The names records (18, 25), the fvar named instances PostScript names
+        and the CFF table names are updated too, only if already defined.
 
         If family_name is not defined it will be auto-detected.
         If style_name is not defined it will be auto-detected.
@@ -1247,6 +1249,48 @@ class Font:
         if update_style_flags:
             self.set_style_flags_by_subfamily_name()
 
+    def rename_variable_instances(
+        self,
+        *,
+        family_name: str = "",
+        style_names: dict[str, str] | None = None,
+        update_style_flags: bool = True,
+    ) -> None:
+        """
+        Renames the named instances of the variable font.
+
+        The family_name replaces the family part of the instances PostScript names
+        (and of the variations PostScript name prefix, if defined).
+        The style_names replace the instances style names and the style part
+        of their PostScript names. The axes names are unchanged.
+        The default instance style name must match the font style name,
+        so renaming it renames the font style too.
+
+        If family_name is not defined it will be auto-detected.
+
+        :param family_name: The family name
+        :type family_name: str
+        :param style_names: The new style names mapped by the old ones (case-insensitive),
+            eg. {"Thin": "Hairline"}
+        :type style_names: dict or None
+        :param update_style_flags: if True the style flags will be updated by subfamily name
+            (only if the default instance style name is renamed)
+        :type update_style_flags: bool
+
+        :raises OperationError: if the font is not a variable font.
+        :return: None
+        """
+        ttfont = self.get_ttfont()
+        style_name = self.get_style_name()
+        _names.rename_variable_instances(
+            ttfont,
+            family_name=family_name,
+            style_names=style_names,
+        )
+
+        if update_style_flags and self.get_style_name() != style_name:
+            self.set_style_flags_by_subfamily_name()
+
     def sanitize(
         self,
         *,
@@ -1791,6 +1835,8 @@ class Font:
         self,
         *,
         coordinates: dict[str, Any],
+        update_names: bool = True,
+        update_style_flags: bool = True,
         **options: Any,
     ) -> None:
         """
@@ -1805,6 +1851,12 @@ class Font:
             {'wdth':100, 'wght':[100,600], 'ital':[30,65,70]} or
             {'wdth':100, 'wght':{'min':100,'max':600}, 'ital':{'min':30,'default':65,'max':70}}
         :type coordinates: dict
+        :param update_names: if True the name records will be updated based on
+            the closest instance to the new default coordinates (only if changed)
+        :type update_names: bool
+        :param update_style_flags: if True the style flags will be updated based on
+            the closest instance to the new default coordinates (only if changed)
+        :type update_style_flags: bool
         :param options: The options for the fontTools.varLib.instancer
         :type options: dictionary
 
@@ -1813,7 +1865,13 @@ class Font:
         :raises ValueError: If the coordinates axes are all pinned
         """
         ttfont = self.get_ttfont()
-        _variable.to_sliced_variable(ttfont, coordinates=coordinates, **options)
+        _variable.to_sliced_variable(
+            ttfont,
+            coordinates=coordinates,
+            update_names=update_names,
+            update_style_flags=update_style_flags,
+            **options,
+        )
 
     def to_static(
         self,

{python_fontbro-0.29.0 → python_fontbro-0.31.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.31.0"