Replace pkg_resources with importlib_resources (#1131)

* Replace pkg_resources with importlib_resources

* black

* implement Cosimo feedback

* work on py3.9

* black

* fix py3.9 again. Thanks Cosimo

* implement naughty boy feedback.

* implement Cosimo feedback again

* simplify version import

Author: m4rc1e

Lib/gftools/scripts/add_font.py

@@ -58,7 +58,6 @@
 from axisregistry import AxisRegistry
 from gfsubsets import SubsetsInFont
 from google.protobuf import text_format
-from pkg_resources import resource_filename
 from gftools.utils import remove_url_prefix, primary_script
 
 

Lib/gftools/scripts/lang_support.py

@@ -20,10 +20,8 @@
 from gftools import fonts_public_pb2
 from gftools.util import google_fonts as fonts
 from google.protobuf import text_format
-from pkg_resources import resource_filename
 import csv
 import os
-from pkg_resources import resource_filename
 
 parser = argparse.ArgumentParser(
     description="Add language support metadata to METADATA.pb files"

Lib/gftools/scripts/push_stats.py

@@ -11,7 +11,7 @@
 """
 from gftools.push.trafficjam import PushItems
 from jinja2 import Environment, FileSystemLoader, select_autoescape
-from pkg_resources import resource_filename
+from importlib.resources import files, as_file
 from datetime import datetime
 import pygit2
 from github import Github
@@ -76,12 +76,6 @@ def main(args=None):
     parser.add_argument("out")
     args = parser.parse_args(args)
 
-    push_template_dir = resource_filename("gftools", "push-templates")
-    env = Environment(
-        loader=FileSystemLoader(push_template_dir),
-        autoescape=select_autoescape(),
-    )
-
     data_out = os.path.join(os.path.dirname(args.out), "gf_repo_data.json")
     if os.path.exists(data_out):
         commit_data = json.load(open(data_out, encoding="utf8"))
@@ -100,22 +94,27 @@ def main(args=None):
     prod_path = os.path.join(args.repo_path, "to_production.txt")
     prod_families = PushItems.from_server_file(prod_path)
 
-    template = env.get_template("index.html")
-
-    print("Writing json data")
-    commit_data = {
-        "last_run": datetime.now().strftime("%Y-%m-%d"),
-        "commits": commits,
-        "pushes": {
-            "sandbox": [i.to_json() for i in sb_families],
-            "production": [i.to_json() for i in prod_families],
-        },
-    }
-    json.dump(commit_data, open(data_out, "w", encoding="utf8"), indent=4)
-
-    print("Writing report")
-    with open(args.out, "w") as doc:
-        doc.write(template.render(commit_data=json.dumps(commit_data)))
+    with as_file(files("gftools") / "push-templates") as push_template_dir:
+        env = Environment(
+            loader=FileSystemLoader(str(push_template_dir)),
+            autoescape=select_autoescape(),
+        )
+        template = env.get_template("index.html")
+
+        print("Writing json data")
+        commit_data = {
+            "last_run": datetime.now().strftime("%Y-%m-%d"),
+            "commits": commits,
+            "pushes": {
+                "sandbox": [i.to_json() for i in sb_families],
+                "production": [i.to_json() for i in prod_families],
+            },
+        }
+        json.dump(commit_data, open(data_out, "w", encoding="utf8"), indent=4)
+
+        print("Writing report")
+        with open(args.out, "w") as doc:
+            doc.write(template.render(commit_data=json.dumps(commit_data)))
 
 
 if __name__ == "__main__":

Lib/gftools/utils.py

@@ -28,7 +28,7 @@
 from collections import namedtuple
 from gflanguages import LoadLanguages
 from github import Github
-from pkg_resources import resource_filename
+import importlib.resources
 from google.protobuf import text_format
 import json
 from PIL import Image
@@ -540,7 +540,8 @@ def font_sample_text(ttFont):
     that can be formed using the ttFont instance.
 
     UDHR has been chosen due to the many languages it covers"""
-    with open(resource_filename("gftools", "udhr_all.txt"), encoding="utf-8") as doc:
+    ref = importlib.resources.files("gftools") / "udhr_all.txt"
+    with importlib.resources.as_file(ref) as doc:
         uhdr = doc.read()
 
     cmap = set(ttFont.getBestCmap())

bin/gftools

@@ -16,7 +16,7 @@
 #
 from __future__ import print_function
 from argparse import RawTextHelpFormatter
-from pkg_resources import get_distribution
+from gftools import __version__
 from warnings import warn
 import sys
 import os
@@ -47,7 +47,6 @@ def _get_subcommands():
 
 
 def print_menu():
-    __version__ = get_distribution('gftools').version
     print(" o-o              o     o--o")
     print("o                 |     |            o")
     print("| o-o o-o o-o o-o o o-o o-o o-o o-o -o- o-o")
@@ -64,7 +63,6 @@ def print_menu():
 
 subcommands = _get_subcommands()
 
-__version__ = get_distribution('gftools').version
 
 description = "Run gftools subcommands:{0}".format(''.join(
               ['\n    {0}'.format(sc) for sc in sorted(subcommands.keys())]))

tests/push/test_items.py

@@ -3,16 +3,23 @@
 from pathlib import Path
 
 from gftools.push.items import Family, FamilyMeta, Designer, Axis, AxisFallback
-from pkg_resources import resource_filename
+from importlib.resources import files, as_file
 import json
+import atexit
+from contextlib import ExitStack
+
+file_manager = ExitStack()
+atexit.register(file_manager.close)
 
 
 CWD = os.path.dirname(__file__)
 TEST_DIR = os.path.join(CWD, "..", "..", "data", "test", "gf_fonts")
 SERVER_DIR = os.path.join(CWD, "..", "..", "data", "test", "servers")
 TEST_FAMILY_DIR = Path(TEST_DIR) / "ofl" / "mavenpro"
 DESIGNER_DIR = Path(TEST_DIR) / "joeprince"
-AXES_DIR = Path(resource_filename("axisregistry", "data"))
+WEIGHT_AXIS = file_manager.enter_context(
+    as_file(files("axisregistry") / "data" / "weight.textproto")
+)
 FAMILY_JSON = json.load(open(os.path.join(SERVER_DIR, "family.json"), encoding="utf8"))
 FONTS_JSON = json.load(open(os.path.join(SERVER_DIR, "fonts.json"), encoding="utf8"))
 
@@ -68,7 +75,7 @@
         ),
         (
             Axis,
-            AXES_DIR / "weight.textproto",
+            WEIGHT_AXIS,
             next(a for a in FONTS_JSON["axisRegistry"] if a["tag"] == "wght"),
             Axis(
                 tag="wght",