Replace runtime dependency on setuptools with modern libraries (#1448)

Co-authored-by: Mark Keller <[email protected]>

Author: ofek

DESCRIPTION.md

@@ -13,6 +13,7 @@ Source code is also available at: https://github.com/snowflakedb/snowflake-conne
   - Improved the robustness of OCSP response caching to handle errors in cases of serialization and deserialization.
   - Fixed a bug where `AuthByKeyPair.handle_timeout` should pass keyword arguments instead of positional arguments when calling `AuthByKeyPair.prepare`. PR #1440 (@emilhe)
   - Fixed a bug where MFA token caching would refuse to work until restarted instead of reauthenticating
+  - Replaced dependency on setuptools in favor of packaging
 
 - v3.0.0(January 26, 2023)
 

setup.cfg

@@ -52,7 +52,8 @@ install_requires =
     pyjwt<3.0.0
     pytz
     requests<3.0.0
-    setuptools>34.0.0
+    importlib-metadata; python_version < '3.8'
+    packaging
     charset_normalizer>=2,<3
     idna>=2.5,<4
     urllib3>=1.21.1,<1.27

src/snowflake/connector/options.py

@@ -5,15 +5,21 @@
 from __future__ import annotations
 
 import importlib
+import sys
 import warnings
 from logging import getLogger
 from types import ModuleType
 from typing import Union
 
-import pkg_resources
+from packaging.requirements import Requirement
 
 from . import errors
 
+if sys.version_info >= (3, 8):
+    from importlib.metadata import distributions
+else:
+    from importlib_metadata import distributions
+
 logger = getLogger(__name__)
 
 """This module helps to manage optional dependencies.
@@ -54,7 +60,7 @@ class MissingKeyring(MissingOptionalDependency):
 
 
 def warn_incompatible_dep(
-    dep_name: str, installed_ver: str, expected_ver: pkg_resources.Requirement
+    dep_name: str, installed_ver: str, expected_ver: Requirement
 ) -> None:
     warnings.warn(
         "You have an incompatible version of '{}' installed ({}), please install a version that "
@@ -78,31 +84,34 @@ def _import_or_missing_pandas_option() -> tuple[
 
         pyarrow = importlib.import_module("pyarrow")
         # Check whether we have the currently supported pyarrow installed
-        installed_packages = pkg_resources.working_set.by_key
-        if all(
-            k in installed_packages for k in ("snowflake-connector-python", "pyarrow")
-        ):
-            _pandas_extras = installed_packages["snowflake-connector-python"]._dep_map[
-                "pandas"
-            ]
-            _expected_pyarrow_version = [
-                dep for dep in _pandas_extras if dep.name == "pyarrow"
-            ][0]
-            _installed_pyarrow_version = installed_packages["pyarrow"]
-            if (
-                _installed_pyarrow_version
-                and _installed_pyarrow_version.version not in _expected_pyarrow_version
-            ):
+        installed_packages = {
+            package.metadata["Name"]: package for package in distributions()
+        }
+        if {"pyarrow", "snowflake-connector-python"} <= installed_packages.keys():
+            dependencies = installed_packages[
+                "snowflake-connector-python"
+            ].metadata.get_all("Requires-Dist", [])
+            pandas_pyarrow_extra = None
+            for dependency in dependencies:
+                dep = Requirement(dependency)
+                if (
+                    dep.marker is not None
+                    and dep.marker.evaluate({"extra": "pandas"})
+                    and dep.name == "pyarrow"
+                ):
+                    pandas_pyarrow_extra = dep
+                    break
+
+            installed_pyarrow_version = installed_packages["pyarrow"].version
+            if not pandas_pyarrow_extra.specifier.contains(installed_pyarrow_version):
                 warn_incompatible_dep(
-                    "pyarrow",
-                    _installed_pyarrow_version.version,
-                    _expected_pyarrow_version,
+                    "pyarrow", installed_pyarrow_version, pandas_pyarrow_extra
                 )
 
         else:
             logger.info(
                 "Cannot determine if compatible pyarrow is installed because of missing package(s) from "
-                "{}".format(installed_packages.keys())
+                "{}".format(list(installed_packages.keys()))
             )
         return pandas, pyarrow, True
     except ImportError:

test/integ/pandas/test_unit_options.py

@@ -4,11 +4,10 @@
 from __future__ import annotations
 
 import logging
-from copy import deepcopy
+import sys
 from unittest import mock
 
 import pytest
-from pkg_resources import working_set
 
 try:
     from snowflake.connector.options import (
@@ -19,6 +18,11 @@
     MissingPandas = None
     _import_or_missing_pandas_option = None
 
+if sys.version_info >= (3, 8):
+    from importlib.metadata import distributions
+else:
+    from importlib_metadata import distributions
+
 
 @pytest.mark.skipif(
     MissingPandas is None or _import_or_missing_pandas_option is None,
@@ -29,16 +33,25 @@ def test_pandas_option_reporting(caplog):
 
     This issue was brought to attention in: https://github.com/snowflakedb/snowflake-connector-python/issues/412
     """
-    modified_by_key = deepcopy(working_set.by_key)
-    modified_by_key.pop("snowflake-connector-python")
-    modified_by_key.pop("pyarrow")
-    with mock.patch.object(working_set, "by_key", modified_by_key):
+    modified_distributions = list(
+        d
+        for d in distributions()
+        if d.metadata["Name"]
+        not in (
+            "pyarrow",
+            "snowflake-connecctor-python",
+        )
+    )
+    with mock.patch(
+        "snowflake.connector.options.distributions",
+        return_value=modified_distributions,
+    ):
         caplog.set_level(logging.DEBUG, "snowflake.connector")
         pandas, pyarrow, installed_pandas = _import_or_missing_pandas_option()
         assert installed_pandas
         assert not isinstance(pandas, MissingPandas)
         assert not isinstance(pyarrow, MissingPandas)
         assert (
             "Cannot determine if compatible pyarrow is installed because of missing package(s) "
-            "from dict_keys(["
+            "from "
         ) in caplog.text