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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-fontbro
-Version: 0.28.0
+Version: 0.28.1
 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.28.0 → python_fontbro-0.28.1}/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.0"
+__version__ = "0.28.1"

{python_fontbro-0.28.0 → python_fontbro-0.28.1}/fontbro/names.py

@@ -116,11 +116,20 @@ def get_name(
     Gets the name by its identifier from the name table of the given font.
     """
     name_id = _get_name_id(key)
-    name_table = ttfont["name"]
-    name = name_table.getName(name_id, **_NAMES_WIN_IDS)
-    if not name:
-        name = name_table.getName(name_id, **_NAMES_MAC_IDS)
-    return str(name.toUnicode()) if name else None
+    name_table = ttfont.get("name")
+    if not name_table:
+        return None
+    # the windows english record is preferred: mac records are legacy
+    # and they can follow different naming conventions (eg. name id 1)
+    name_record = name_table.getName(name_id, **_NAMES_WIN_IDS)
+    if name_record:
+        try:
+            return str(name_record.toUnicode())
+        except UnicodeDecodeError:
+            pass
+    # fallback to the english (mac) record or to any other decodable record
+    name: str | None = name_table.getDebugName(name_id)
+    return name
 
 
 def get_names(
@@ -129,12 +138,12 @@ def get_names(
     """
     Gets the names records of the given font mapped by their property name.
     """
-    names_by_id = {record.nameID: f"{record}" for record in ttfont["name"].names}
-    names = {
-        _NAMES_BY_ID[name_id]["key"]: value
-        for name_id, value in names_by_id.items()
-        if name_id in _NAMES_BY_ID
-    }
+    # read each name as get_name does, to get consistent values
+    names = {}
+    for name_id, name_item in _NAMES_BY_ID.items():
+        name = get_name(ttfont, name_id)
+        if name is not None:
+            names[name_item["key"]] = name
     return names
 
 
@@ -149,10 +158,17 @@ def set_name(
     name_id = _get_name_id(key)
     name_table = ttfont["name"]
     # https://github.com/fonttools/fonttools/blob/main/Lib/fontTools/ttLib/tables/_n_a_m_e.py#L568
+    # the windows record is always written, it's the one read first by get_name
     name_table.setName(value, name_id, **_NAMES_WIN_IDS)
+    # mac records are legacy (modern tools don't produce them anymore),
+    # so they are updated only if the font already has some of them
+    mac_platform_id = _NAMES_MAC_IDS["platformID"]
+    if not any(record.platformID == mac_platform_id for record in name_table.names):
+        return
     # the mac roman encoding can't encode many characters (eg. greek, cyrillic, cjk),
     # in that case the mac name record is removed (as fontTools addMultilingualName
-    # does), otherwise the font would raise UnicodeEncodeError when saved
+    # does), otherwise the font would raise UnicodeEncodeError when saved;
+    # removing it is safe because the windows record has just been written
     if _is_encodable(value, _NAMES_MAC_IDS):
         name_table.setName(value, name_id, **_NAMES_MAC_IDS)
     else:

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-fontbro
-Version: 0.28.0
+Version: 0.28.1
 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.28.0 → python_fontbro-0.28.1}/tests/test_names.py

@@ -85,9 +85,25 @@ class NamesTestCase(AbstractTestCase):
                 font_saved = Font(font.save_to_fileobject())
                 self.assertEqual(font_saved.get_name(Font.NAME_FAMILY_NAME), value)
 
+    def _add_mac_name_record(self, font):
+        # the fixtures fonts have only windows name records
+        name_table = font.get_ttfont()["name"]
+        name_table.setName("Roboto Mono", 1, 1, 0, 0)
+
+    def test_set_name_without_mac_records(self):
+        # mac records are legacy (modern tools don't produce them anymore),
+        # so they are not added to fonts having only windows records
+        font = self._get_font("/Roboto_Mono/static/RobotoMono-Regular.ttf")
+        font.set_name(Font.NAME_FAMILY_NAME, "Café Sans")
+        self.assertEqual(self._get_name_records_by_platform(font, 1), {3: "Café Sans"})
+        platforms = {record.platformID for record in font.get_ttfont()["name"].names}
+        self.assertEqual(platforms, {3})
+
     def test_set_name_encodable_in_mac_roman(self):
         # values encodable in mac roman are written in both windows and mac records
+        # if the font already has mac records
         font = self._get_font("/Roboto_Mono/static/RobotoMono-Regular.ttf")
+        self._add_mac_name_record(font)
         font.set_name(Font.NAME_FAMILY_NAME, "Café Sans")
         self.assertEqual(
             self._get_name_records_by_platform(font, 1),
@@ -95,11 +111,17 @@ class NamesTestCase(AbstractTestCase):
         )
 
     def test_set_name_not_encodable_in_mac_roman_removes_mac_record(self):
-        # an existing mac name record is removed to not keep an outdated value
+        # an existing mac name record is removed to not keep an outdated value,
+        # the name is still readable from the windows record
         font = self._get_font("/Roboto_Mono/static/RobotoMono-Regular.ttf")
-        font.set_name(Font.NAME_FAMILY_NAME, "Café Sans")
+        self._add_mac_name_record(font)
+        self.assertEqual(
+            self._get_name_records_by_platform(font, 1),
+            {1: "Roboto Mono", 3: "Roboto Mono"},
+        )
         font.set_name(Font.NAME_FAMILY_NAME, "Шрифт")
         self.assertEqual(self._get_name_records_by_platform(font, 1), {3: "Шрифт"})
+        self.assertEqual(font.get_name(Font.NAME_FAMILY_NAME), "Шрифт")
 
     def test_rename_not_encodable_in_mac_roman(self):
         # regression: renaming with non-latin names must not prevent saving
@@ -126,3 +148,59 @@ class NamesTestCase(AbstractTestCase):
         self.assertEqual(family_name, "Roboto Mono Renamed")
         subfamily_name = font.get_name(Font.NAME_SUBFAMILY_NAME)
         self.assertEqual(subfamily_name, "Regular Renamed")
+
+    def test_get_names_consistent_with_get_name(self):
+        # regression: get_names returned the last name record found for each name id,
+        # (eg. the japanese family name), instead of the same value of get_name
+        font = self._get_font("/DotGothic16/DotGothic16-Regular.ttf")
+        font_names = font.get_names()
+        self.assertEqual(font_names["family_name"], "DotGothic16")
+        for key, value in font_names.items():
+            with self.subTest(key=key):
+                self.assertEqual(font.get_name(key), value)
+
+    def _replace_name_records(self, font, platform_id, plat_enc_id, lang_id):
+        # replace all the name records with records of the given platform/language
+        name_table = font.get_ttfont()["name"]
+        for record in list(name_table.names):
+            name_table.setName(
+                record.toUnicode(), record.nameID, platform_id, plat_enc_id, lang_id
+            )
+        for record in list(name_table.names):
+            if (record.platformID, record.platEncID, record.langID) != (
+                platform_id,
+                plat_enc_id,
+                lang_id,
+            ):
+                name_table.names.remove(record)
+
+    def test_get_name_without_windows_english_records(self):
+        # regression: names were not found without windows english name records
+        platforms_ids = {
+            "unicode": (0, 3, 0),
+            "windows japanese": (3, 1, 0x411),
+            "mac english": (1, 0, 0),
+        }
+        for label, (platform_id, plat_enc_id, lang_id) in platforms_ids.items():
+            with self.subTest(records=label):
+                font = self._get_font("/Roboto_Mono/static/RobotoMono-Regular.ttf")
+                self._replace_name_records(font, platform_id, plat_enc_id, lang_id)
+                self.assertEqual(font.get_name(Font.NAME_FAMILY_NAME), "Roboto Mono")
+                self.assertEqual(font.get_family_name(), "Roboto Mono")
+                self.assertEqual(font.get_names()["family_name"], "Roboto Mono")
+
+    def test_get_name_with_undecodable_windows_record(self):
+        # an undecodable windows record is skipped, the other records are read
+        font = self._get_font("/Roboto_Mono/static/RobotoMono-Regular.ttf")
+        self._add_mac_name_record(font)
+        name_table = font.get_ttfont()["name"]
+        # lone utf-16 surrogate
+        name_table.getName(1, 3, 1, 0x409).string = b"\xd8\x00"
+        self.assertEqual(font.get_name(Font.NAME_FAMILY_NAME), "Roboto Mono")
+
+    def test_get_name_without_name_table(self):
+        font = self._get_font("/Roboto_Mono/static/RobotoMono-Regular.ttf")
+        del font.get_ttfont()["name"]
+        self.assertIsNone(font.get_name(Font.NAME_FAMILY_NAME))
+        self.assertEqual(font.get_names(), {})
+        self.assertEqual(font.get_family_name(), "")