ref: migrate from pkg_resources to importlib.resources

Author: paulmueller

CHANGELOG

@@ -1,5 +1,6 @@
 0.17.7
  - fix: invalid properties used in .ui files
+ - ref: migrate from pkg_resources to importlib.resources
  - setup: bump dclab from 0.62.11 to 0.67.0
 0.17.6
  - docs: properly employ license GPL-3.0-or-later

dckit/__main__.py

@@ -1,20 +1,21 @@
 def main(splash=True):
-    import os
-    import pkg_resources
+    import importlib.resources
     import sys
     import time
 
     from PyQt5.QtWidgets import QApplication
     from PyQt5.QtCore import QEventLoop
 
     app = QApplication(sys.argv)
-    imdir = pkg_resources.resource_filename("dckit", "img")
 
     if splash:
         from PyQt5.QtWidgets import QSplashScreen
         from PyQt5.QtGui import QPixmap
-        splash_path = os.path.join(imdir, "splash.png")
-        splash_pix = QPixmap(splash_path)
+
+        ref = importlib.resources.files("dckit.img") / "splash.png"
+        with importlib.resources.as_file(ref) as splash_path:
+            splash_pix = QPixmap(str(splash_path))
+
         splash = QSplashScreen(splash_pix)
         splash.setMask(splash_pix.mask())
         splash.show()
@@ -26,8 +27,9 @@ def main(splash=True):
     from .main import DCKit
 
     # Set Application Icon
-    icon_path = os.path.join(imdir, "icon.png")
-    app.setWindowIcon(QtGui.QIcon(icon_path))
+    ref = importlib.resources.files("dckit.img") / "icon.png"
+    with importlib.resources.as_file(ref) as icon_path:
+        app.setWindowIcon(QtGui.QIcon(str(icon_path)))
 
     # Use dots as decimal separators
     QtCore.QLocale.setDefault(QtCore.QLocale(QtCore.QLocale.C))

dckit/dlg_icheck.py

@@ -4,7 +4,7 @@
 import functools
 import numbers
 
-import pkg_resources
+import importlib.resources
 import warnings
 
 import dclab
@@ -28,8 +28,10 @@ class IntegrityCheckDialog(QtWidgets.QDialog):
 
     def __init__(self, parent, path, *args, **kwargs):
         QtWidgets.QDialog.__init__(self, parent, *args, **kwargs)
-        path_ui = pkg_resources.resource_filename("dckit", "dlg_icheck.ui")
-        uic.loadUi(path_ui, self)
+        ref = importlib.resources.files(
+            "dckit") / "dlg_icheck.ui"
+        with importlib.resources.as_file(ref) as path_ui:
+            uic.loadUi(path_ui, self)
 
         self.path = path
         #: metadata (remember across instances)
@@ -253,8 +255,11 @@ def on_logs(self):
             return
         dlg = QtWidgets.QDialog()
         dlg.setWindowTitle("{}: {}".format(self.path.name, log))
-        path_ui = pkg_resources.resource_filename("dckit", "dlg_log.ui")
-        uic.loadUi(path_ui, dlg)
+        ref = importlib.resources.files(
+            "dckit") / "dlg_log.ui"
+        with importlib.resources.as_file(ref) as path_ui:
+            uic.loadUi(path_ui, dlg)
+
         dlg.label.setText(log)
         logs = meta_tool.get_rtdc_logs(self.path)
         text = "\n".join(logs[log])

dckit/main.py

@@ -1,6 +1,6 @@
 import hashlib
 import pathlib
-import pkg_resources
+import importlib.resources
 import signal
 import sys
 import traceback
@@ -32,8 +32,11 @@
 class DCKit(QtWidgets.QMainWindow):
     def __init__(self):
         super(DCKit, self).__init__()
-        path_ui = pkg_resources.resource_filename("dckit", "main.ui")
-        uic.loadUi(path_ui, self)
+        ref = importlib.resources.files(
+            "dckit") / "main.ui"
+        with importlib.resources.as_file(ref) as path_ui:
+            uic.loadUi(path_ui, self)
+
         self.setWindowTitle(f"DCKit {version}")
         # update check
         self._update_thread = None
@@ -345,8 +348,11 @@ def on_repack(self):
         if self.checkBox_repack.isChecked():
             # ask the user whether he knows what he is doing
             dlg = QtWidgets.QDialog()
-            path_ui = pkg_resources.resource_filename("dckit", "dlg_repack.ui")
-            uic.loadUi(path_ui, dlg)
+            ref = importlib.resources.files(
+                "dckit") / "dlg_repack.ui"
+            with importlib.resources.as_file(ref) as path_ui:
+                uic.loadUi(path_ui, dlg)
+
             ret = dlg.exec_()
             if ret == QtWidgets.QDialog.Rejected:
                 self.checkBox_repack.setChecked(False)
@@ -434,8 +440,11 @@ def on_task_join(self):
         """Join multiple RT-DC measurements"""
         # show a dialog with sample name
         dlg = QtWidgets.QDialog()
-        path_ui = pkg_resources.resource_filename("dckit", "dlg_join.ui")
-        uic.loadUi(path_ui, dlg)
+        ref = importlib.resources.files(
+            "dckit") / "dlg_join.ui"
+        with importlib.resources.as_file(ref) as path_ui:
+            uic.loadUi(path_ui, dlg)
+
         dlg.lineEdit.setText(self.get_metadata(0)["experiment"]["sample"])
         ret = dlg.exec_()
         if ret == QtWidgets.QDialog.Accepted:

dckit/preferences.py

@@ -1,4 +1,4 @@
-import pkg_resources
+import importlib.resources
 
 import dclab
 from dclab.rtdc_dataset import feat_temp
@@ -14,8 +14,11 @@ class Preferences(QtWidgets.QDialog):
 
     def __init__(self, parent, *args, **kwargs):
         QtWidgets.QWidget.__init__(self, parent=parent, *args, **kwargs)
-        path_ui = pkg_resources.resource_filename("dckit", "preferences.ui")
-        uic.loadUi(path_ui, self)
+        ref = importlib.resources.files(
+            "dckit") / "preferences.ui"
+        with importlib.resources.as_file(ref) as path_ui:
+            uic.loadUi(path_ui, self)
+
         self.settings = QtCore.QSettings()
         self.parent = parent