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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-fontbro
-Version: 0.28.1
+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>
@@ -138,6 +138,7 @@ with open("fonts/MyFont.ttf") as fh:
 -   [`get_variable_instance_by_style_name`](#get_variable_instance_by_style_name)
 -   [`get_variable_instance_closest_to_coordinates`](#get_variable_instance_closest_to_coordinates)
 -   [`get_version`](#get_version)
+-   [`get_version_formatted`](#get_version_formatted)
 -   [`get_vertical_metrics`](#get_vertical_metrics)
 -   [`get_weight`](#get_weight)
 -   [`get_width`](#get_width)
@@ -163,6 +164,7 @@ with open("fonts/MyFont.ttf") as fh:
 -   [`set_style_flags`](#set_style_flags)
 -   [`set_style_flags_by_subfamily_name`](#set_style_flags_by_subfamily_name)
 -   [`set_style_name`](#set_style_name)
+-   [`set_version`](#set_version)
 -   [`set_vertical_metrics`](#set_vertical_metrics)
 -   [`subset`](#subset)
 -   [`to_sliced_variable`](#to_sliced_variable)
@@ -784,13 +786,48 @@ instance = font.get_variable_instance_closest_to_coordinates(
 #### `get_version`
 ```python
 """
-Gets the font version.
+Gets the font version reading it from head.fontRevision,
+with fallback on the version name record (name id 5) parsed value,
+eg. "Version 1.015;git-0a5106e0b" -> 1.015.
 
-:returns: The font version value.
+:param use_head_revision: If True, the head.fontRevision value is used (if set).
+:type use_head_revision: bool
+:param use_name_record: If True, the version name record value is used as fallback.
+:type use_name_record: bool
+
+:returns: The font version value, 0.0 if the version cannot be read.
 :rtype: float
+
+:raises ArgumentError: If both options are False.
 """
 
-version = font.get_version()
+version = font.get_version(use_head_revision=True, use_name_record=True)
+```
+
+#### `get_version_formatted`
+```python
+"""
+Gets the font version formatted using the version name record convention,
+with the given prefix and a minimum of 3 decimal digits, eg. "v1.015".
+
+:param use_head_revision: If True, the head.fontRevision value is used (if set).
+:type use_head_revision: bool
+:param use_name_record: If True, the version name record value is used as fallback.
+:type use_name_record: bool
+:param prefix: The prefix to prepend to the version value.
+:type prefix: str
+
+:returns: The formatted font version value, eg. "v0.000" if the version cannot be read.
+:rtype: str
+
+:raises ArgumentError: If both source options are False.
+"""
+
+version = font.get_version_formatted(
+    use_head_revision=True,
+    use_name_record=True,
+    prefix="v",
+)
 ```
 
 #### `get_vertical_metrics`
@@ -1240,6 +1277,28 @@ Sets the style name updating the related font names records.
 font.set_style_name(name="Bold Italic")
 ```
 
+#### `set_version`
+```python
+"""
+Sets the font version, the version value can be a number (eg. 1.015)
+or a version string (eg. "Version 1.015"), parsed the same way the
+version name record value is parsed when read.
+The head.fontRevision and the version name record (name id 5) are
+updated, the latter is overwritten with the canonical "Version X.YYY"
+form (any extra info it contained is dropped).
+The unique identifier name record (name id 3) is updated only if its
+first ";" separated part holds the current version value, and only in
+that part. The CFF version is updated only if the font already has it.
+
+:param version: The version value, eg. 1.015 or "Version 1.015"
+:type version: float or str
+
+:raises ArgumentError: If the version value is not valid.
+"""
+
+font.set_version(1.015)
+```
+
 #### `set_vertical_metrics`
 ```python
 """

{python_fontbro-0.28.1 → python_fontbro-0.30.0}/README.md

@@ -74,6 +74,7 @@ with open("fonts/MyFont.ttf") as fh:
 -   [`get_variable_instance_by_style_name`](#get_variable_instance_by_style_name)
 -   [`get_variable_instance_closest_to_coordinates`](#get_variable_instance_closest_to_coordinates)
 -   [`get_version`](#get_version)
+-   [`get_version_formatted`](#get_version_formatted)
 -   [`get_vertical_metrics`](#get_vertical_metrics)
 -   [`get_weight`](#get_weight)
 -   [`get_width`](#get_width)
@@ -99,6 +100,7 @@ with open("fonts/MyFont.ttf") as fh:
 -   [`set_style_flags`](#set_style_flags)
 -   [`set_style_flags_by_subfamily_name`](#set_style_flags_by_subfamily_name)
 -   [`set_style_name`](#set_style_name)
+-   [`set_version`](#set_version)
 -   [`set_vertical_metrics`](#set_vertical_metrics)
 -   [`subset`](#subset)
 -   [`to_sliced_variable`](#to_sliced_variable)
@@ -720,13 +722,48 @@ instance = font.get_variable_instance_closest_to_coordinates(
 #### `get_version`
 ```python
 """
-Gets the font version.
+Gets the font version reading it from head.fontRevision,
+with fallback on the version name record (name id 5) parsed value,
+eg. "Version 1.015;git-0a5106e0b" -> 1.015.
 
-:returns: The font version value.
+:param use_head_revision: If True, the head.fontRevision value is used (if set).
+:type use_head_revision: bool
+:param use_name_record: If True, the version name record value is used as fallback.
+:type use_name_record: bool
+
+:returns: The font version value, 0.0 if the version cannot be read.
 :rtype: float
+
+:raises ArgumentError: If both options are False.
 """
 
-version = font.get_version()
+version = font.get_version(use_head_revision=True, use_name_record=True)
+```
+
+#### `get_version_formatted`
+```python
+"""
+Gets the font version formatted using the version name record convention,
+with the given prefix and a minimum of 3 decimal digits, eg. "v1.015".
+
+:param use_head_revision: If True, the head.fontRevision value is used (if set).
+:type use_head_revision: bool
+:param use_name_record: If True, the version name record value is used as fallback.
+:type use_name_record: bool
+:param prefix: The prefix to prepend to the version value.
+:type prefix: str
+
+:returns: The formatted font version value, eg. "v0.000" if the version cannot be read.
+:rtype: str
+
+:raises ArgumentError: If both source options are False.
+"""
+
+version = font.get_version_formatted(
+    use_head_revision=True,
+    use_name_record=True,
+    prefix="v",
+)
 ```
 
 #### `get_vertical_metrics`
@@ -1176,6 +1213,28 @@ Sets the style name updating the related font names records.
 font.set_style_name(name="Bold Italic")
 ```
 
+#### `set_version`
+```python
+"""
+Sets the font version, the version value can be a number (eg. 1.015)
+or a version string (eg. "Version 1.015"), parsed the same way the
+version name record value is parsed when read.
+The head.fontRevision and the version name record (name id 5) are
+updated, the latter is overwritten with the canonical "Version X.YYY"
+form (any extra info it contained is dropped).
+The unique identifier name record (name id 3) is updated only if its
+first ";" separated part holds the current version value, and only in
+that part. The CFF version is updated only if the font already has it.
+
+:param version: The version value, eg. 1.015 or "Version 1.015"
+:type version: float or str
+
+:raises ArgumentError: If the version value is not valid.
+"""
+
+font.set_version(1.015)
+```
+
 #### `set_vertical_metrics`
 ```python
 """

{python_fontbro-0.28.1 → 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.28.1 → 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.28.1 → 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.28.1 → python_fontbro-0.30.0}/fontbro/files.py

@@ -93,14 +93,3 @@ def get_filename(
     extension = get_format(ttfont)
     filename = f"{basename}.{extension}"
     return filename
-
-
-def get_version(
-    ttfont: TTFont,
-) -> float:
-    """
-    Gets the version of the given font (head.fontRevision).
-    """
-    head = ttfont.get("head")
-    version = float(head.fontRevision)
-    return version

{python_fontbro-0.28.1 → python_fontbro-0.30.0}/fontbro/font.py

@@ -29,6 +29,7 @@ from fontbro import support as _support
 from fontbro import tables as _tables
 from fontbro import unicode as _unicode
 from fontbro import variable as _variable
+from fontbro import version as _version
 from fontbro.exceptions import (
     ArgumentError,
     OperationError,
@@ -1027,15 +1028,62 @@ class Font:
 
     def get_version(
         self,
+        *,
+        use_head_revision: bool = True,
+        use_name_record: bool = True,
     ) -> float:
         """
-        Gets the font version.
+        Gets the font version reading it from head.fontRevision,
+        with fallback on the version name record (name id 5) parsed value,
+        eg. "Version 1.015;git-0a5106e0b" -> 1.015.
+
+        :param use_head_revision: If True, the head.fontRevision value is used (if set).
+        :type use_head_revision: bool
+        :param use_name_record: If True, the version name record value is used as fallback.
+        :type use_name_record: bool
 
-        :returns: The font version value.
+        :returns: The font version value, 0.0 if the version cannot be read.
         :rtype: float
+
+        :raises ArgumentError: If both options are False.
+        """
+        ttfont = self.get_ttfont()
+        return _version.get_version(
+            ttfont,
+            use_head_revision=use_head_revision,
+            use_name_record=use_name_record,
+        )
+
+    def get_version_formatted(
+        self,
+        *,
+        use_head_revision: bool = True,
+        use_name_record: bool = True,
+        prefix: str = "v",
+    ) -> str:
+        """
+        Gets the font version formatted using the version name record convention,
+        with the given prefix and a minimum of 3 decimal digits, eg. "v1.015".
+
+        :param use_head_revision: If True, the head.fontRevision value is used (if set).
+        :type use_head_revision: bool
+        :param use_name_record: If True, the version name record value is used as fallback.
+        :type use_name_record: bool
+        :param prefix: The prefix to prepend to the version value.
+        :type prefix: str
+
+        :returns: The formatted font version value, eg. "v0.000" if the version cannot be read.
+        :rtype: str
+
+        :raises ArgumentError: If both source options are False.
         """
         ttfont = self.get_ttfont()
-        return _files.get_version(ttfont)
+        return _version.get_version_formatted(
+            ttfont,
+            use_head_revision=use_head_revision,
+            use_name_record=use_name_record,
+            prefix=prefix,
+        )
 
     def get_vertical_metrics(
         self,
@@ -1670,6 +1718,29 @@ class Font:
             style_name=name,
         )
 
+    def set_version(
+        self,
+        version: float | str,
+    ) -> None:
+        """
+        Sets the font version, the version value can be a number (eg. 1.015)
+        or a version string (eg. "Version 1.015"), parsed the same way the
+        version name record value is parsed when read.
+        The head.fontRevision and the version name record (name id 5) are
+        updated, the latter is overwritten with the canonical "Version X.YYY"
+        form (any extra info it contained is dropped).
+        The unique identifier name record (name id 3) is updated only if its
+        first ";" separated part holds the current version value, and only in
+        that part. The CFF version is updated only if the font already has it.
+
+        :param version: The version value, eg. 1.015 or "Version 1.015"
+        :type version: float or str
+
+        :raises ArgumentError: If the version value is not valid.
+        """
+        ttfont = self.get_ttfont()
+        _version.set_version(ttfont, version)
+
     def set_vertical_metrics(
         self,
         **vertical_metrics: Any,

{python_fontbro-0.28.1 → 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.28.1"
+__version__ = "0.30.0"