Replace pkg_resources by importlib.resources

CHANGELOG.md

@@ -2,6 +2,7 @@ Below are the noteworthy changes from each release.
 A more detailed list of changes is available in the corresponding milestones for each release in the Github issue tracker (https://github.com/googlefonts/fontbakery/milestones?state=closed).
 
 ## Upcoming release: 1.1.0 (2025-Jul-??)
+  - Replace deprecated `pkg_resources` by `importlib.resources` (issue #5028)
   - ...
 
 

Lib/fontbakery/checks/vendorspecific/googlefonts/conditions.py

@@ -307,10 +307,10 @@ def rfn_exception(font):
     been published previously with an RFN, or fonts which benefit from
     an agreement with Google Fonts.
     """
-    from pkg_resources import resource_filename
+    from fontbakery.utils import get_resource_file_path
 
     rfn_exceptions_txt = "data/googlefonts/reserved_font_name_exceptions.txt"
-    filename = resource_filename("fontbakery", rfn_exceptions_txt)
+    filename = get_resource_file_path(rfn_exceptions_txt)
     for exception in open(filename, "r", encoding="utf-8").readlines():
         exception = exception.split("#")[0].strip()
         exception = exception.replace(" ", "")

Lib/fontbakery/checks/vendorspecific/googlefonts/family_name_compliance.py

@@ -25,8 +25,8 @@
 def check_family_name_compliance(ttFont):
     """Check family name for GF Guide compliance."""
     import re
-    from pkg_resources import resource_filename
-    from fontbakery.utils import get_name_entries
+
+    from fontbakery.utils import get_name_entries, get_resource_file_path
 
     camelcase_exceptions_txt = "data/googlefonts/camelcased_familyname_exceptions.txt"
     abbreviations_exceptions_txt = (
@@ -45,7 +45,7 @@ def check_family_name_compliance(ttFont):
         known_exception = False
 
         # Process exceptions
-        filename = resource_filename("fontbakery", camelcase_exceptions_txt)
+        filename = get_resource_file_path(camelcase_exceptions_txt)
         for exception in open(filename, "r", encoding="utf-8").readlines():
             exception = exception.split("#")[0].strip()
             if exception == "":
@@ -71,7 +71,7 @@ def check_family_name_compliance(ttFont):
         known_exception = False
 
         # Process exceptions
-        filename = resource_filename("fontbakery", abbreviations_exceptions_txt)
+        filename = get_resource_file_path(abbreviations_exceptions_txt)
         for exception in open(filename, "r", encoding="utf-8").readlines():
             exception = exception.split("#")[0].strip()
             if exception == "":

Lib/fontbakery/checks/vendorspecific/googlefonts/utils.py

@@ -1,8 +1,7 @@
 import re
 from functools import lru_cache
-from pkg_resources import resource_filename
 
-from fontbakery.utils import exit_with_install_instructions
+from fontbakery.utils import exit_with_install_instructions, get_resource_file_path
 
 
 @lru_cache(maxsize=1)
@@ -22,9 +21,7 @@ def registered_vendor_ids():
         exit_with_install_instructions("googlefonts")
 
     registered_vendor_ids = {}
-    CACHED = resource_filename(
-        "fontbakery", "data/fontbakery-microsoft-vendorlist.cache"
-    )
+    CACHED = get_resource_file_path("data/fontbakery-microsoft-vendorlist.cache")
     content = open(CACHED, encoding="utf-8").read()
     # Strip all <A> HTML tags from the raw HTML. The current page contains a
     # closing </A> for which no opening <A> is present, which causes

Lib/fontbakery/utils.py

@@ -13,12 +13,14 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
+from __future__ import annotations
+
 import os
 import subprocess
 import sys
 import traceback
-from typing import Optional
 from copy import deepcopy
+from typing import TYPE_CHECKING, Optional
 
 from fontTools.pens.basePen import BasePen
 from fontTools.ttLib import TTFont
@@ -31,6 +33,27 @@
     PANOSE_Family_Type,
 )
 
+if TYPE_CHECKING:
+    from pathlib import Path
+
+
+def get_resource_file_path(sub_file_path: str) -> Path:
+    """Return the full file path of a resource file inside the fontbakery
+    directory.
+
+    Args:
+        sub_file_path (str): The file path relative to the `fontbakery`
+            directory.
+
+    Returns:
+        Path: The full file path
+    """
+    from importlib.resources import as_file, files
+
+    with as_file(files("fontbakery").joinpath(sub_file_path)) as path:
+        file_path = path
+    return file_path
+
 
 def exit_with_install_instructions(profile_name):
     sys.exit(

pyproject.toml

@@ -209,10 +209,6 @@ exclude = [
 minversion = "6.0"
 testpaths = ["tests"]
 addopts = "--color=yes  --verbose"
-filterwarnings = [
-    "ignore:pkg_resources is deprecated as an API:DeprecationWarning",
-    "ignore:Deprecated call to `pkg_resources.declare_namespace:DeprecationWarning",
-]
 
 # ============================================================================
 [tool.pylint.master]