Change from pkg_resources to importlib (#281)

Author: anders-kiaer

CHANGELOG.md

@@ -11,6 +11,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 [CSP rules](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy)
 enforced by `webviz-config` (inline script hashes are added automatically).
 
+### Changed
+- [#281](https://github.com/equinor/webviz-config/pull/281) - Now uses `importlib` instead of `pkg_resources` for
+detecting plugin entry points and package versions.
+
 ## [0.1.2] - 2020-09-09
 ### Added
 - [#279](https://github.com/equinor/webviz-config/pull/279) - Added scrollbar to menu (when larger than screen size).

setup.py

@@ -46,6 +46,7 @@
         "pyarrow>=0.16",
         "pyyaml>=5.1",
         "tqdm>=4.8",
+        "importlib_metadata>=1.7; python_version<'3.8'",
         "typing-extensions>=3.7",  # Needed on Python < 3.8
         "webviz-core-components>=0.0.19",
     ],

webviz_config/__init__.py

@@ -1,4 +1,9 @@
-from pkg_resources import get_distribution, DistributionNotFound
+try:
+    # Python 3.8+
+    from importlib.metadata import version, PackageNotFoundError  # type: ignore
+except ModuleNotFoundError:
+    # Python < 3.8
+    from importlib_metadata import version, PackageNotFoundError  # type: ignore
 
 from ._theme_class import WebvizConfigTheme
 from ._localhost_token import LocalhostToken
@@ -7,7 +12,7 @@
 from ._shared_settings_subscriptions import SHARED_SETTINGS_SUBSCRIPTIONS
 
 try:
-    __version__ = get_distribution(__name__).version
-except DistributionNotFound:
+    __version__ = version("webviz-config")
+except PackageNotFoundError:
     # package is not installed
     pass

webviz_config/_docs/_build_docs.py

@@ -18,7 +18,14 @@
 from collections import defaultdict
 from typing import Any, Dict, Optional, Tuple, List
 
-import pkg_resources
+try:
+    # Python 3.8+
+    # pylint: disable=ungrouped-imports
+    from importlib.metadata import version  # type: ignore
+except ModuleNotFoundError:
+    # Python < 3.8
+    from importlib_metadata import version  # type: ignore
+
 import jinja2
 from typing_extensions import TypedDict
 
@@ -69,7 +76,7 @@ def _document_plugin(plugin: Tuple[str, Any]) -> PluginInfo:
         "module": module.__name__,  # type: ignore
         "package": top_package_name,
         "package_doc": import_module(subpackage).__doc__,  # type: ignore
-        "package_version": pkg_resources.get_distribution(top_package_name).version,
+        "package_version": version(top_package_name),
     }
 
     if argspec.defaults is not None:

webviz_config/plugins/__init__.py

@@ -2,7 +2,12 @@
 the utility itself.
 """
 
-import pkg_resources
+try:
+    # Python 3.8+
+    from importlib.metadata import entry_points  # type: ignore
+except ModuleNotFoundError:
+    # Python < 3.8
+    from importlib_metadata import entry_points  # type: ignore
 
 from ._example_plugin import ExamplePlugin
 from ._example_data_download import ExampleDataDownload
@@ -29,6 +34,6 @@
     "Markdown",
 ]
 
-for entry_point in pkg_resources.iter_entry_points("webviz_config_plugins"):
+for entry_point in entry_points().get("webviz_config_plugins", []):
     globals()[entry_point.name] = entry_point.load()
     __all__.append(entry_point.name)

webviz_config/themes/__init__.py

@@ -1,4 +1,9 @@
-import pkg_resources
+try:
+    # Python 3.8+
+    from importlib.metadata import entry_points  # type: ignore
+except ModuleNotFoundError:
+    # Python < 3.8
+    from importlib_metadata import entry_points  # type: ignore
 
 from .. import WebvizConfigTheme
 from ._default_theme import default_theme
@@ -9,7 +14,7 @@
 
 __all__ = ["installed_themes"]
 
-for entry_point in pkg_resources.iter_entry_points("webviz_config_themes"):
+for entry_point in entry_points().get("webviz_config_themes", []):
     theme = entry_point.load()
 
     globals()[entry_point.name] = theme