Merge pull request #107 from ethancedwards8/remove-pkg_resources

migrate from pkg_resources to importlib

Author: rongxin-liu

compare50/__init__.py

@@ -1,21 +1,11 @@
 def _set_version():
-    """Set check50 __version__"""
+    """Set compare50 __version__"""
     global __version__
-    from pkg_resources import get_distribution, DistributionNotFound
-    import os
-    # https://stackoverflow.com/questions/17583443/what-is-the-correct-way-to-share-package-version-with-setup-py-and-the-package
+    from importlib.metadata import version
     try:
-        dist = get_distribution("compare50")
-        # Normalize path for cross-OS compatibility.
-        dist_loc = os.path.normcase(dist.location)
-        here = os.path.normcase(__file__)
-        if not here.startswith(os.path.join(dist_loc, "compare50")):
-            # This version is not installed, but another version is.
-            raise DistributionNotFound
-    except DistributionNotFound:
-        __version__ = "locally installed, no version information available"
-    else:
-        __version__ = dist.version
+        __version__ = version('compare50')
+    except:
+        __version__ = "version information not available"
 
 
 # Encapsulated inside a function so their local variables/imports aren't seen by autocompleters

compare50/_renderer/_renderer.py

@@ -2,8 +2,10 @@
 import glob
 import os
 import pathlib
-import pkg_resources
 import shutil
+import importlib
+import atexit
+from contextlib import ExitStack
 
 import attr
 import jinja2
@@ -13,8 +15,19 @@
 from .. import _api
 from .._data import IdStore
 
-STATIC = pathlib.Path(pkg_resources.resource_filename("compare50._renderer", "static"))
-TEMPLATES = pathlib.Path(pkg_resources.resource_filename("compare50._renderer", "templates"))
+file_manager = ExitStack()
+atexit.register(file_manager.close)
+
+_static = importlib.resources.files('compare50._renderer') / 'static'
+_templates = importlib.resources.files('compare50._renderer') / 'templates'
+
+path_static = file_manager.enter_context(
+        importlib.resources.as_file(_static))
+path_templates = file_manager.enter_context(
+        importlib.resources.as_file(_templates))
+
+STATIC = pathlib.Path(path_static)
+TEMPLATES = pathlib.Path(path_templates)
 
 @attr.s(slots=True)
 class Fragment:

compare50/passes.py

@@ -1,4 +1,6 @@
-from pkg_resources import resource_filename
+import importlib
+import atexit
+from contextlib import ExitStack
 
 from . import comparators, preprocessors
 from ._data import Pass
@@ -44,5 +46,11 @@ class misspellings(Pass):
     preprocessors = [preprocessors.comments,
                      preprocessors.normalize_case,
                      preprocessors.words]
-    comparator = comparators.Misspellings(resource_filename("compare50.comparators",
-                                                            "english_dictionary.txt"))
+
+    file_manager = ExitStack()
+    atexit.register(file_manager.close)
+    ref = importlib.resources.files('compare50.comparators') / 'english_dictionary.txt'
+    path = file_manager.enter_context(
+        importlib.resources.as_file(ref))
+
+    comparator = comparators.Misspellings(path)

setup.py

@@ -12,16 +12,16 @@
     license="GPLv3",
     description="This is compare50, with which you can compare files for similarities.",
     long_description="This is compare50, with which you can compare files for similarities.",
-    install_requires=["attrs>=18,<21", "intervaltree>=3,<4", "lib50>=2,<4", "numpy>=1.15,<2", "pygments>=2.2,<3", "jinja2>=3,<4", "termcolor>=1.1.0,<2", "tqdm>=4.32,<5"],
+    install_requires=["attrs>=18,<21", "intervaltree>=3,<4", "lib50>=2,<4", "numpy>=1.15,<2", "pygments>=2.2,<3", "jinja2>=3,<4", "termcolor>=1.1.0,<2", "tqdm>=4.32,<5", "importlib"],
     extras_require = {
         "develop": ["sphinx", "sphinx_rtd_theme", "sphinx-autobuild", "line_profiler"]
     },
     keywords=["compare", "compare50"],
     name="compare50",
-    python_requires=">=3.5",
+    python_requires=">=3.8",
     packages=find_packages(exclude=["tests"]),
     scripts=["bin/compare50"],
     url="https://github.com/cs50/compare50",
-    version="1.2.6",
+    version="1.2.7",
     include_package_data=True,
 )