Replace pkg_resources with importlib and packaging

https://setuptools.pypa.io/en/latest/pkg_resources.html:
> Use of pkg_resources is deprecated in favor of importlib.resources, importlib.metadata and their backports (importlib_resources, importlib_metadata). Some useful APIs are also provided by packaging (e.g. requirements and version parsing). Users should refrain from new usage of pkg_resources and should work to port to importlib-based solutions.

Author: hanwen-cluster

cli/requirements.txt

@@ -25,3 +25,4 @@ marshmallow~=3.10
 PyYAML>=5.3.1,!=5.4
 tabulate>=0.8.8,<=0.8.10
 werkzeug~=2.0
+packaging~=25.0

cli/setup.py

@@ -29,6 +29,7 @@ def readme():
     "PyYAML>=5.3.1,!=5.4",
     "jinja2~=3.0",
     "marshmallow~=3.10",
+    "packaging~=25.0",
     "aws-cdk.core~=" + CDK_VERSION,
     "aws-cdk.aws-batch~=" + CDK_VERSION,
     "aws_cdk.aws-cloudwatch~=" + CDK_VERSION,

cli/src/pcluster/api/controllers/common.py

@@ -17,7 +17,7 @@
 from typing import List, Optional, Set, Union
 
 import boto3
-from pkg_resources import packaging
+from packaging import version as packaging_version
 
 from pcluster.api.errors import (
     BadRequestException,
@@ -110,12 +110,12 @@ def check_cluster_version(cluster: Cluster, exact_match: bool = False) -> bool:
         return False
 
     if exact_match:
-        return packaging.version.parse(cluster.stack.version) == packaging.version.parse(get_installed_version())
+        return packaging_version.parse(cluster.stack.version) == packaging_version.parse(get_installed_version())
     else:
         return (
-            packaging.version.parse(packaging.version.parse(get_installed_version()).base_version)
-            >= packaging.version.parse(cluster.stack.version)
-            >= packaging.version.parse("3.0.0a0")
+            packaging_version.parse(packaging_version.parse(get_installed_version()).base_version)
+            >= packaging_version.parse(cluster.stack.version)
+            >= packaging_version.parse("3.0.0a0")
         )
 
 

cli/src/pcluster/api/util.py

@@ -17,7 +17,7 @@
 import subprocess  # nosec B404
 
 import six
-from pkg_resources import packaging
+from packaging import version as packaging_version
 
 from pcluster.api import typing_utils
 from pcluster.constants import NODEJS_INCOMPATIBLE_VERSION_RANGE, NODEJS_MIN_VERSION
@@ -221,19 +221,19 @@ def _assert_node_version():
         LOGGER.critical(message)
         raise Exception(message)
 
-    node_version = packaging.version.parse(node_version_string)
+    node_version = packaging_version.parse(node_version_string)
 
-    if node_version < packaging.version.parse(NODEJS_MIN_VERSION):
+    if node_version < packaging_version.parse(NODEJS_MIN_VERSION):
         message = (
             f"AWS CDK library used by ParallelCluster requires Node.js version >= {NODEJS_MIN_VERSION},"
             " see installation instructions here: https://docs.aws.amazon.com/parallelcluster/latest/ug/install-v3.html"
         )
         LOGGER.critical(message)
         raise Exception(message)
     if (
-        packaging.version.parse(NODEJS_INCOMPATIBLE_VERSION_RANGE[0])
+        packaging_version.parse(NODEJS_INCOMPATIBLE_VERSION_RANGE[0])
         <= node_version
-        <= packaging.version.parse(NODEJS_INCOMPATIBLE_VERSION_RANGE[1])
+        <= packaging_version.parse(NODEJS_INCOMPATIBLE_VERSION_RANGE[1])
     ):
         message = (
             f"AWS CDK library used by ParallelCluster requires Node.js to not be in the range"

cli/src/pcluster/config/cluster_config.py

@@ -16,10 +16,9 @@
 from abc import abstractmethod
 from collections import defaultdict
 from enum import Enum
+from importlib.resources import files  # nosemgrep: python.lang.compatibility.python37.python37-compatibility-importlib2
 from typing import Dict, List, Union
 
-import pkg_resources
-
 from pcluster.aws.aws_api import AWSApi
 from pcluster.aws.aws_resources import InstanceTypeInfo
 from pcluster.aws.common import AWSClientError, get_region
@@ -2192,7 +2191,7 @@ def _register_validators(self, context: ValidatorContext = None):
     @property
     def scheduler_resources(self):
         """Return scheduler specific resources."""
-        return pkg_resources.resource_filename(__name__, "../resources/batch")
+        return str(files(__package__).parent / "resources" / "batch")
 
 
 class _BaseSlurmComputeResource(BaseComputeResource):

cli/src/pcluster/models/cluster.py

@@ -20,9 +20,9 @@
 from copy import deepcopy
 from datetime import datetime
 from enum import Enum
+from importlib.resources import files  # nosemgrep: python.lang.compatibility.python37.python37-compatibility-importlib2
 from typing import List, Optional, Set, Tuple
 
-import pkg_resources
 from marshmallow import ValidationError
 
 from pcluster.aws.aws_api import AWSApi
@@ -586,7 +586,7 @@ def _upload_artifacts(self):
         LOGGER.info("Uploading cluster artifacts to S3...")
         self._check_bucket_existence()
         try:
-            resources = pkg_resources.resource_filename(__name__, "../resources/custom_resources")
+            resources = str(files(__package__).parent / "resources" / "custom_resources")
             self.bucket.upload_resources(
                 resource_dir=resources, custom_artifacts_name=PCLUSTER_S3_ARTIFACTS_DICT.get("custom_artifacts_name")
             )

cli/src/pcluster/models/compute_fleet_status_manager.py

@@ -15,7 +15,7 @@
 from enum import Enum
 
 from boto3.dynamodb.conditions import Attr
-from pkg_resources import packaging
+from packaging import version as packaging_version
 
 from pcluster.aws.aws_api import AWSApi
 from pcluster.aws.common import AWSClientError
@@ -146,7 +146,7 @@ def get_status_with_last_updated_time(
     @staticmethod
     def get_manager(cluster_name, version):
         """Return compute fleet status manager based on version and plugin."""
-        if packaging.version.parse(version) < packaging.version.parse("3.2.0a0"):
+        if packaging_version.parse(version) < packaging_version.parse("3.2.0a0"):
             return PlainTextComputeFleetStatusManager(cluster_name)
         else:
             return JsonComputeFleetStatusManager(cluster_name)

cli/src/pcluster/models/imagebuilder.py

@@ -19,9 +19,9 @@
 import re
 import tempfile
 from datetime import datetime
+from importlib.resources import files  # nosemgrep: python.lang.compatibility.python37.python37-compatibility-importlib2
 from typing import Set
 
-import pkg_resources
 from marshmallow.exceptions import ValidationError
 
 from pcluster.aws.aws_api import AWSApi
@@ -532,7 +532,7 @@ def _upload_artifacts(self):
                 # upload cfn template
                 self.bucket.upload_cfn_template(self.template_body, self._s3_artifacts_dict.get("template_name"))
 
-            resources = pkg_resources.resource_filename(__name__, "../resources/custom_resources")
+            resources = str(files(__package__).parent / "resources" / "custom_resources")
             self.bucket.upload_resources(
                 resource_dir=resources, custom_artifacts_name=self._s3_artifacts_dict.get("custom_artifacts_name")
             )

cli/src/pcluster/templates/cdk_builder_utils.py

@@ -12,9 +12,9 @@
 # pylint: disable=too-many-lines
 import abc
 from hashlib import sha1, sha256
+from importlib.resources import files  # nosemgrep: python.lang.compatibility.python37.python37-compatibility-importlib2
 from typing import List, Union
 
-import pkg_resources
 from aws_cdk import aws_ec2 as ec2
 from aws_cdk import aws_iam as iam
 from aws_cdk import aws_lambda as awslambda
@@ -77,7 +77,7 @@ def create_hash_suffix(string_to_hash: str):
 
 def get_user_data_content(user_data_path: str):
     """Retrieve user data content."""
-    user_data_file_path = pkg_resources.resource_filename(__name__, user_data_path)
+    user_data_file_path = str(files(__package__) / user_data_path)
     with open(user_data_file_path, "r", encoding="utf-8") as user_data_file:
         user_data_content = user_data_file.read()
     return user_data_content

cli/src/pcluster/utils.py

@@ -23,6 +23,8 @@
 import urllib
 import zipfile
 from concurrent.futures import ThreadPoolExecutor
+from importlib.metadata import version
+from importlib.resources import files  # nosemgrep: python.lang.compatibility.python37.python37-compatibility-importlib2
 from io import BytesIO
 from shlex import quote
 from typing import Callable, NoReturn
@@ -31,8 +33,8 @@
 
 import boto3
 import dateutil.parser
-import pkg_resources
 import yaml
+from packaging.version import parse
 from yaml import SafeLoader
 from yaml.constructor import ConstructorError
 from yaml.resolver import BaseResolver
@@ -149,8 +151,8 @@ def zip_dir(path):
     """
     file_out = BytesIO()
     with zipfile.ZipFile(file_out, "w", zipfile.ZIP_DEFLATED) as ziph:
-        for root, _, files in os.walk(path):
-            for file in files:
+        for root, _, files_list in os.walk(path):
+            for file in files_list:
                 _add_file_to_zip(
                     ziph,
                     os.path.join(root, file),
@@ -305,8 +307,8 @@ def get_templates_bucket_path():
 
 def get_installed_version(base_version_only: bool = False):
     """Get the version of the installed aws-parallelcluster package."""
-    pkg_distribution = pkg_resources.get_distribution("aws-parallelcluster")
-    return pkg_distribution.version if not base_version_only else pkg_distribution.parsed_version.base_version
+    pkg_version = version("aws-parallelcluster")
+    return pkg_version if not base_version_only else parse(pkg_version).base_version
 
 
 def warn(message):
@@ -576,7 +578,7 @@ def retrieve_supported_regions():
                 retrieve_supported_regions.cache = f.read().decode("utf-8").split("\n")
         except URLError:
             # When the file is not found on the URL, use local file. This is useful when developing new versions.
-            with open(pkg_resources.resource_filename(__name__, "/resources/supported-regions"), encoding="utf-8") as f:
+            with open(str(files(__package__) / "resources" / "supported-regions"), encoding="utf-8") as f:
                 retrieve_supported_regions.cache = f.read().split("\n")
     return retrieve_supported_regions.cache