Merge pull request #4129 from plone/drop-pkg-resources-usage

Replace pkg_resources usage

Author: gforcada

Products/CMFPlone/MigrationTool.py

@@ -2,6 +2,8 @@
 from AccessControl.class_init import InitializeClass
 from AccessControl.requestmethod import postonly
 from App.config import getConfiguration
+from importlib.metadata import distribution
+from importlib.metadata import PackageNotFoundError
 from io import StringIO
 from OFS.SimpleItem import SimpleItem
 from plone.base.interfaces import IMigrationTool
@@ -15,7 +17,6 @@
 from zope.interface import implementer
 
 import logging
-import pkg_resources
 import sys
 import transaction
 
@@ -149,7 +150,7 @@ def getInstanceVersion(self):
 
         if version == "unknown":
             if _version:
-                # Instance version was not pkg_resources compatible...
+                # Instance version was not standard...
                 _version = _version.replace("devel (svn/unreleased)", "dev")
                 _version = _version.rstrip("-final")
                 _version = _version.rstrip("final")
@@ -185,7 +186,7 @@ def getFileSystemVersion(self):
 
     def getSoftwareVersion(self):
         # The software version.
-        dist = pkg_resources.get_distribution("Products.CMFPlone")
+        dist = distribution("Products.CMFPlone")
         return dist.version
 
     security.declareProtected(ManagePortal, "needUpgrading")
@@ -199,24 +200,23 @@ def needUpgrading(self):
     def coreVersions(self):
         # Useful core information.
         vars = {}
-        get_dist = pkg_resources.get_distribution
-        vars["Zope"] = get_dist("Zope").version
+        vars["Zope"] = distribution("Zope").version
         vars["Python"] = sys.version
         vars["Platform"] = sys.platform
-        vars["Plone"] = get_dist("Products.CMFPlone").version
+        vars["Plone"] = distribution("Products.CMFPlone").version
         vars["Plone Instance"] = self.getInstanceVersion()
         vars["Plone File System"] = self.getFileSystemVersion()
-        vars["CMF"] = get_dist("Products.CMFCore").version
+        vars["CMF"] = distribution("Products.CMFCore").version
         vars["Debug mode"] = getConfiguration().debug_mode and "Yes" or "No"
         try:
-            vars["PIL"] = get_dist("PIL").version
-        except pkg_resources.DistributionNotFound:
+            vars["PIL"] = distribution("PIL").version
+        except PackageNotFoundError:
             try:
-                vars["PIL"] = get_dist("PILwoTK").version
-            except pkg_resources.DistributionNotFound:
+                vars["PIL"] = distribution("PILwoTK").version
+            except PackageNotFoundError:
                 try:
-                    vars["PIL"] = "%s (Pillow)" % get_dist("Pillow").version
-                except pkg_resources.DistributionNotFound:
+                    vars["PIL"] = "%s (Pillow)" % distribution("Pillow").version
+                except PackageNotFoundError:
                     try:
                         import _imaging
 

Products/CMFPlone/WorkflowTool.py

@@ -2,6 +2,8 @@
 from AccessControl import getSecurityManager
 from AccessControl.class_init import InitializeClass
 from Acquisition import aq_base
+from importlib.metadata import distribution
+from importlib.metadata import PackageNotFoundError
 from plone.base.interfaces import IWorkflowChain
 from Products.CMFCore.permissions import ManagePortal
 from Products.CMFCore.utils import getToolByName
@@ -11,22 +13,13 @@
 from ZODB.POSException import ConflictError
 from zope.component import getMultiAdapter
 
-import pkg_resources
-
 
 try:
-    pkg_resources.get_distribution("plone.app.multilingual")
-except pkg_resources.DistributionNotFound:
+    multilingual_version = distribution("plone.app.multilingual").version
+except PackageNotFoundError:
     has_new_lang_bypass = False
 else:
-    has_new_lang_bypass = (
-        int(
-            pkg_resources.get_distribution("plone.app.multilingual").version.split(".")[
-                0
-            ]
-        )
-        > 1
-    )
+    has_new_lang_bypass = int(multilingual_version.split(".")[0]) > 1
 
 
 class WorkflowTool(PloneBaseTool, BaseTool):

Products/CMFPlone/bbb.py

@@ -1,10 +1,11 @@
-import pkg_resources
+from importlib.metadata import distribution
+from importlib.metadata import PackageNotFoundError
 
 
 HAS_ZSERVER = True
 try:
-    dist = pkg_resources.get_distribution("ZServer")
-except pkg_resources.DistributionNotFound:
+    dist = distribution("ZServer")
+except PackageNotFoundError:
     HAS_ZSERVER = False
 
 NullResource = None

Products/CMFPlone/controlpanel/browser/overview.py

@@ -1,6 +1,7 @@
 from AccessControl import getSecurityManager
 from Acquisition import aq_inner
 from App.config import getConfiguration
+from importlib.metadata import distribution
 from plone.app.registry.browser import controlpanel
 from plone.base.interfaces.controlpanel import IMailSchema
 from plone.memoize.instance import memoize
@@ -11,7 +12,6 @@
 from zope.component import getUtility
 from ZPublisher.HTTPRequest import WSGIRequest
 
-import pkg_resources
 import warnings
 
 
@@ -61,7 +61,7 @@ def server_info(self):
             elif "/" in server_name:
                 server_name = server_name.split("/")[0]
             try:
-                server = pkg_resources.get_distribution(server_name)
+                server = distribution(server_name)
                 server_version = server.version
             except Exception:
                 warnings.warn(

Products/CMFPlone/controlpanel/browser/quickinstaller.py

@@ -1,3 +1,6 @@
+from importlib.metadata import distribution
+from importlib.metadata import PackageNotFoundError
+from packaging import version
 from plone.base import PloneMessageFactory as _
 from plone.base.interfaces import INonInstallable
 from plone.memoize import view
@@ -10,7 +13,6 @@
 from zope.i18n import translate
 
 import logging
-import pkg_resources
 import transaction
 
 
@@ -207,9 +209,9 @@ def is_product_installable(self, product_id, allow_hidden=False):
     def get_product_version(self, product_id):
         """Return the version of the product (package)."""
         try:
-            dist = pkg_resources.get_distribution(product_id)
+            dist = distribution(product_id)
             return dist.version
-        except pkg_resources.DistributionNotFound:
+        except PackageNotFoundError:
             if "." in product_id:
                 return ""
         # For CMFPlacefulWorkflow we need to try Products.CMFPlacefulWorkflow.
@@ -226,7 +228,7 @@ def get_latest_upgrade_step(self, profile_id):
             available = self.ps.listUpgrades(profile_id, True)
             if available:  # could return empty sequence
                 latest = available[-1]
-                profile_version = max(latest["dest"], key=pkg_resources.parse_version)
+                profile_version = max(latest["dest"], key=version.parse)
         except Exception:
             pass
         return profile_version

Products/CMFPlone/relationhelper.py

@@ -2,6 +2,8 @@
 from collections import defaultdict
 from collections import OrderedDict
 from five.intid.intid import addIntIdSubscriber
+from importlib.metadata import distribution
+from importlib.metadata import PackageNotFoundError
 from plone.app.linkintegrity.handlers import modifiedContent
 from plone.app.linkintegrity.utils import referencedRelationship
 from plone.app.relationfield.event import update_behavior_relations
@@ -24,13 +26,12 @@
 from zope.intid.interfaces import ObjectMissingError
 
 import logging
-import pkg_resources
 
 
 try:
     # "iterate" is not a dependency of CMFPlone, but a consumer of it
-    pkg_resources.get_distribution("plone.app.iterate")
-except pkg_resources.DistributionNotFound:
+    distribution("plone.app.iterate")
+except PackageNotFoundError:
     HAS_ITERATE = False
 else:
     HAS_ITERATE = True

Products/CMFPlone/utils.py

@@ -11,6 +11,7 @@
 from App.ImageFile import ImageFile
 from DateTime import DateTime
 from html import escape
+from importlib.metadata import distribution
 from OFS.CopySupport import CopyError
 from os.path import abspath
 from os.path import join
@@ -40,7 +41,6 @@
 from zope.interface import implementedBy
 
 import OFS
-import pkg_resources
 import re
 import sys
 import transaction
@@ -312,7 +312,7 @@ def versionTupleFromString(v_str):
 
 def getFSVersionTuple():
     """Returns Products.CMFPlone version tuple"""
-    version = pkg_resources.get_distribution("Products.CMFPlone").version
+    version = distribution("Products.CMFPlone").version
     return versionTupleFromString(version)
 
 

news/4126.bugfix

@@ -0,0 +1 @@
+Replace `pkg_resources` with `importlib.metadata` and `packaging`. @gforcada

setup.py

@@ -53,6 +53,7 @@
         "five.customerize",
         "five.intid",
         "lxml",
+        "packaging",
         "plone.app.content",
         "plone.app.contentlisting",
         "plone.app.contentmenu >= 2.0.1",