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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-fontbro
-Version: 0.30.0
+Version: 0.32.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>
@@ -43,7 +43,6 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
@@ -52,6 +51,7 @@ Classifier: Programming Language :: Python :: Implementation :: PyPy
 Classifier: Topic :: Text Processing :: Fonts
 Classifier: Topic :: Multimedia :: Graphics
 Classifier: Topic :: Multimedia :: Graphics :: Graphics Conversion
+Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
 Requires-Dist: fonttools[lxml,pathops,unicode,woff]<5.0,>=4.43.0
@@ -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)
@@ -183,7 +184,7 @@ font_clone = font.clone()
 ```python
 """
 Close the wrapped TTFont instance.
-After closing, any operation on the font raises OperationError,
+After closing, any operation on the font raises ClosedFontError,
 closing an already closed font does nothing.
 """
 
@@ -630,7 +631,7 @@ Gets the wrapped TTFont instance.
 :returns: The TTFont instance.
 :rtype: TTFont
 
-:raises OperationError: If the font has been closed.
+:raises ClosedFontError: If the font has been closed.
 """
 
 ttfont = font.get_ttfont()
@@ -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 VariableFontRequiredError: 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
 """
@@ -1095,7 +1131,7 @@ Save all instances of a variable font to specified directory in one or more form
     includes 'instance' (containing instance metadata) and 'files' (a dictionary
     with file formats as keys and file-paths as values).
 
-:raises TypeError: If the font is not a variable font.
+:raises VariableFontRequiredError: If the font is not a variable font.
 """
 
 saved_fonts = font.save_variable_instances(
@@ -1131,7 +1167,7 @@ The fsType field is left untouched if any argument is invalid.
 :raises ArgumentError: If a value is not a bool or None, if more than one
     of the mutually exclusive usage permissions is set to True, or if
     installable is set to False while no other usage permission is in effect.
-:raises OperationError: If the OS/2 table is not available in the font.
+:raises MissingTableError: If the OS/2 table is not available in the font.
 """
 
 font.set_embedding_permissions(
@@ -1151,7 +1187,7 @@ based on provided class_id and subclass_id.
 
 :param class_id: Numeric identifier of the font family class.
 :param subclass_id: Optional numeric identifier of the font family subclass (default is 0).
-:raises OperationError: If the OS/2 table is not available in the font.
+:raises MissingTableError: If the OS/2 table is not available in the font.
 :raises ArgumentError: If class_id is invalid or subclass_id is specified but invalid.
 """
 
@@ -1360,15 +1396,26 @@ 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
 
-:raises TypeError: If the font is not a variable font
+:raises VariableFontRequiredError: If the font is not a variable font
 :raises ValueError: If the coordinates are not defined (empty)
 :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`
@@ -1391,7 +1438,7 @@ If coordinates are not specified each axis will be pinned at its default value.
 :param options: The options for the fontTools.varLib.instancer
 :type options: dictionary
 
-:raises TypeError: If the font is not a variable font
+:raises VariableFontRequiredError: If the font is not a variable font
 :raises ValueError: If the coordinates axes are not all pinned
 """
 

{python_fontbro-0.30.0 → python_fontbro-0.32.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)
@@ -119,7 +120,7 @@ font_clone = font.clone()
 ```python
 """
 Close the wrapped TTFont instance.
-After closing, any operation on the font raises OperationError,
+After closing, any operation on the font raises ClosedFontError,
 closing an already closed font does nothing.
 """
 
@@ -566,7 +567,7 @@ Gets the wrapped TTFont instance.
 :returns: The TTFont instance.
 :rtype: TTFont
 
-:raises OperationError: If the font has been closed.
+:raises ClosedFontError: If the font has been closed.
 """
 
 ttfont = font.get_ttfont()
@@ -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 VariableFontRequiredError: 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
 """
@@ -1031,7 +1067,7 @@ Save all instances of a variable font to specified directory in one or more form
     includes 'instance' (containing instance metadata) and 'files' (a dictionary
     with file formats as keys and file-paths as values).
 
-:raises TypeError: If the font is not a variable font.
+:raises VariableFontRequiredError: If the font is not a variable font.
 """
 
 saved_fonts = font.save_variable_instances(
@@ -1067,7 +1103,7 @@ The fsType field is left untouched if any argument is invalid.
 :raises ArgumentError: If a value is not a bool or None, if more than one
     of the mutually exclusive usage permissions is set to True, or if
     installable is set to False while no other usage permission is in effect.
-:raises OperationError: If the OS/2 table is not available in the font.
+:raises MissingTableError: If the OS/2 table is not available in the font.
 """
 
 font.set_embedding_permissions(
@@ -1087,7 +1123,7 @@ based on provided class_id and subclass_id.
 
 :param class_id: Numeric identifier of the font family class.
 :param subclass_id: Optional numeric identifier of the font family subclass (default is 0).
-:raises OperationError: If the OS/2 table is not available in the font.
+:raises MissingTableError: If the OS/2 table is not available in the font.
 :raises ArgumentError: If class_id is invalid or subclass_id is specified but invalid.
 """
 
@@ -1296,15 +1332,26 @@ 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
 
-:raises TypeError: If the font is not a variable font
+:raises VariableFontRequiredError: If the font is not a variable font
 :raises ValueError: If the coordinates are not defined (empty)
 :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`
@@ -1327,7 +1374,7 @@ If coordinates are not specified each axis will be pinned at its default value.
 :param options: The options for the fontTools.varLib.instancer
 :type options: dictionary
 
-:raises TypeError: If the font is not a variable font
+:raises VariableFontRequiredError: If the font is not a variable font
 :raises ValueError: If the coordinates axes are not all pinned
 """
 

{python_fontbro-0.30.0 → python_fontbro-0.32.0}/fontbro/embedding_permissions.py

@@ -2,8 +2,9 @@ from __future__ import annotations
 
 from fontTools.ttLib import TTFont
 
-from fontbro.exceptions import ArgumentError, OperationError
+from fontbro.exceptions import ArgumentError
 from fontbro.flags import get_flag, set_flag
+from fontbro.tables import get_table_or_raise
 
 # Embedding Permissions:
 # https://learn.microsoft.com/en-us/typography/opentype/spec/os2#fstype
@@ -95,9 +96,7 @@ def set_embedding_permissions(
     Sets the embedding permissions in the OS/2 fsType field of the given font,
     the fsType field is left untouched if any argument is invalid.
     """
-    os2 = ttfont.get("OS/2")
-    if not os2:
-        raise OperationError("Invalid OS/2 table (doesn't exist).")
+    os2 = get_table_or_raise(ttfont, "OS/2")
 
     usage_permissions = {
         "installable": installable,

python_fontbro-0.32.0/fontbro/exceptions.py

@@ -0,0 +1,53 @@
+from __future__ import annotations
+
+
+class ArgumentError(ValueError):
+    pass
+
+
+class DataError(ValueError):
+    pass
+
+
+class OperationError(TypeError):
+    pass
+
+
+class ClosedFontError(OperationError):
+    """
+    The operation was called on a closed font.
+    """
+
+
+class MissingTableError(OperationError, KeyError):
+    """
+    The operation requires a table the font doesn't have.
+    It's also a KeyError, raised before when accessing the missing table.
+    """
+
+    def __init__(
+        self,
+        table_tag: str,
+        message: str | None = None,
+    ) -> None:
+        self.table_tag = table_tag
+        super().__init__(message or f"Invalid {table_tag} table (doesn't exist).")
+
+    def __reduce__(self) -> tuple[type[MissingTableError], tuple[str, str]]:
+        # pickle and copy recreate the exception passing its args (the message
+        # only) to __init__, the table tag must be passed too
+        return (self.__class__, (self.table_tag, str(self)))
+
+    def __str__(self) -> str:
+        # KeyError wraps the message in quotes
+        return str(self.args[0])
+
+
+class VariableFontRequiredError(OperationError):
+    """
+    The operation requires a variable font.
+    """
+
+
+class SanitizationError(Exception):
+    pass

{python_fontbro-0.30.0 → python_fontbro-0.32.0}/fontbro/family_classification.py

@@ -4,7 +4,8 @@ from typing import Any
 
 from fontTools.ttLib import TTFont
 
-from fontbro.exceptions import ArgumentError, OperationError
+from fontbro.exceptions import ArgumentError
+from fontbro.tables import get_table_or_raise
 from fontbro.utils import concat_names, find_item, read_json
 
 # Family Classification:
@@ -152,9 +153,7 @@ def set_family_classification(
     """
     Sets the family classification of the given font in the OS/2.sFamilyClass field.
     """
-    os2 = ttfont.get("OS/2")
-    if not os2:
-        raise OperationError("Invalid OS/2 table (doesn't exist).")
+    os2 = get_table_or_raise(ttfont, "OS/2")
 
     # validate class key and subclass key
     class_item, subclass_item = _get_family_classification_items(

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

@@ -32,7 +32,8 @@ from fontbro import variable as _variable
 from fontbro import version as _version
 from fontbro.exceptions import (
     ArgumentError,
-    OperationError,
+    ClosedFontError,
+    VariableFontRequiredError,
 )
 
 
@@ -325,7 +326,7 @@ class Font:
     ) -> None:
         """
         Close the wrapped TTFont instance.
-        After closing, any operation on the font raises OperationError,
+        After closing, any operation on the font raises ClosedFontError,
         closing an already closed font does nothing.
         """
         # TTFont.close() is idempotent (it closes the reader and sets it to None)
@@ -847,13 +848,13 @@ class Font:
         :returns: The TTFont instance.
         :rtype: TTFont
 
-        :raises OperationError: If the font has been closed.
+        :raises ClosedFontError: If the font has been closed.
         """
         # all the font operations get the TTFont instance through this method,
         # the TTFont can also be closed directly (bypassing this instance):
         # when closed, fontTools sets its reader to None
         if self._ttfont is None or self._ttfont.reader is None:
-            raise OperationError("Invalid operation, the font is closed.")
+            raise ClosedFontError("Invalid operation, the font is closed.")
         return self._ttfont
 
     def get_unicode_block_by_name(
@@ -1227,6 +1228,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 +1250,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 VariableFontRequiredError: 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,
         *,
@@ -1468,10 +1513,10 @@ class Font:
             includes 'instance' (containing instance metadata) and 'files' (a dictionary
             with file formats as keys and file-paths as values).
 
-        :raises TypeError: If the font is not a variable font.
+        :raises VariableFontRequiredError: If the font is not a variable font.
         """
         if not self.is_variable():
-            raise OperationError("Only a variable font can be instantiated.")
+            raise VariableFontRequiredError("Only a variable font can be instantiated.")
 
         fsutil.assert_not_file(dirpath)
         fsutil.make_dirs(dirpath)
@@ -1526,7 +1571,7 @@ class Font:
 
         :param class_id: Numeric identifier of the font family class.
         :param subclass_id: Optional numeric identifier of the font family subclass (default is 0).
-        :raises OperationError: If the OS/2 table is not available in the font.
+        :raises MissingTableError: If the OS/2 table is not available in the font.
         :raises ArgumentError: If class_id is invalid or subclass_id is specified but invalid.
         """
         ttfont = self.get_ttfont()
@@ -1679,7 +1724,7 @@ class Font:
         :raises ArgumentError: If a value is not a bool or None, if more than one
             of the mutually exclusive usage permissions is set to True, or if
             installable is set to False while no other usage permission is in effect.
-        :raises OperationError: If the OS/2 table is not available in the font.
+        :raises MissingTableError: If the OS/2 table is not available in the font.
         """
         ttfont = self.get_ttfont()
         _embedding_permissions.set_embedding_permissions(
@@ -1791,6 +1836,8 @@ class Font:
         self,
         *,
         coordinates: dict[str, Any],
+        update_names: bool = True,
+        update_style_flags: bool = True,
         **options: Any,
     ) -> None:
         """
@@ -1805,15 +1852,27 @@ 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
 
-        :raises TypeError: If the font is not a variable font
+        :raises VariableFontRequiredError: If the font is not a variable font
         :raises ValueError: If the coordinates are not defined (blank)
         :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,
@@ -1842,7 +1901,7 @@ class Font:
         :param options: The options for the fontTools.varLib.instancer
         :type options: dictionary
 
-        :raises TypeError: If the font is not a variable font
+        :raises VariableFontRequiredError: If the font is not a variable font
         :raises ValueError: If the coordinates axes are not all pinned
         """
         ttfont = self.get_ttfont()

{python_fontbro-0.30.0 → python_fontbro-0.32.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.30.0"
+__version__ = "0.32.0"

{python_fontbro-0.30.0 → python_fontbro-0.32.0}/fontbro/monospace.py

@@ -6,6 +6,7 @@ from collections import Counter
 from fontTools import unicodedata
 from fontTools.ttLib import TTFont
 
+from fontbro.tables import get_table_or_raise
 from fontbro.unicode import get_best_cmap
 
 # same criteria used by Fontbakery (glyph_metrics_stats condition):
@@ -36,9 +37,10 @@ def _get_widths(
     """
     Gets the advance widths of the given glyphs, zero widths are ignored.
     """
+    hmtx = get_table_or_raise(ttfont, "hmtx")
     return [
         advance
-        for glyph_name, (advance, _) in ttfont["hmtx"].metrics.items()
+        for glyph_name, (advance, _) in hmtx.metrics.items()
         if glyph_name in glyphs_names and advance != 0
     ]