SNOW-893112 updated platformdirs usage (#1737)

Author: sfc-gh-mkeller

DESCRIPTION.md

@@ -12,6 +12,7 @@ Source code is also available at: https://github.com/snowflakedb/snowflake-conne
 
   - Fixed a bug where url port and path were ignore in private link oscp retry.
   - Added thread safety in telemetry when instantiating multiple connections concurrently.
+  - Bumped platformdirs dependency from >=2.6.0,<3.9.0 to >=2.6.0,<4.0.0.0 and made necessary changes to allow this.
 
 - v3.2.0(September 06,2023)
 

setup.cfg

@@ -60,7 +60,7 @@ install_requires =
     typing_extensions>=4.3,<5
     filelock>=3.5,<4
     sortedcontainers>=2.4.0
-    platformdirs>=2.6.0,<3.9.0
+    platformdirs>=2.6.0,<4.0.0
     tomlkit
 include_package_data = True
 package_dir =

src/snowflake/connector/sf_dirs.py

@@ -5,12 +5,20 @@
 from __future__ import annotations
 
 import os
-from typing import Literal
+import pathlib
+from functools import cached_property
+from typing import Protocol
 
-from platformdirs import PlatformDirs, PlatformDirsABC
+from platformdirs import PlatformDirs
 
 
-def _resolve_platform_dirs() -> PlatformDirsABC:
+class PlatformDirsProto(Protocol):
+    @property
+    def user_config_path(self) -> pathlib.Path:
+        ...
+
+
+def _resolve_platform_dirs() -> PlatformDirsProto:
     """Decide on what PlatformDirs class to use.
 
     In case a folder exists (which can be customized with the environmental
@@ -40,7 +48,7 @@ def _resolve_platform_dirs() -> PlatformDirsABC:
         return PlatformDirs(**platformdir_kwargs)
 
 
-class SFPlatformDirs(PlatformDirsABC):
+class SFPlatformDirs:
     """Single folder platformdirs.
 
     This class introduces a PlatformDir class where everything is placed into a
@@ -51,91 +59,11 @@ class SFPlatformDirs(PlatformDirsABC):
     def __init__(
         self,
         single_dir: str,
-        appname: str | None = None,
-        appauthor: str | None | Literal[False] = None,
-        version: str | None = None,
-        roaming: bool = False,
-        multipath: bool = False,
-        opinion: bool = True,
-        ensure_exists: bool = False,
+        **kwargs,
     ) -> None:
-        super().__init__(
-            appname=appname,
-            appauthor=appauthor,
-            version=version,
-            roaming=roaming,
-            multipath=multipath,
-            opinion=opinion,
-            ensure_exists=ensure_exists,
-        )
-        self.single_dir = single_dir
+        self.single_dir = pathlib.Path(single_dir)
 
-    @property
-    def user_data_dir(self) -> str:
+    @cached_property
+    def user_config_path(self) -> str:
         """data directory tied to to the user"""
         return self.single_dir
-
-    @property
-    def site_data_dir(self) -> str:
-        """data directory shared by users"""
-        return self.user_data_dir
-
-    @property
-    def user_config_dir(self) -> str:
-        """config directory tied to the user"""
-        return self.user_data_dir
-
-    @property
-    def site_config_dir(self) -> str:
-        """config directory shared by the users"""
-        return self.user_data_dir
-
-    @property
-    def user_cache_dir(self) -> str:
-        """cache directory tied to the user"""
-        return self.user_data_dir
-
-    @property
-    def site_cache_dir(self) -> str:
-        """cache directory shared by users"""
-        return self.user_data_dir
-
-    @property
-    def user_state_dir(self) -> str:
-        """state directory tied to the user"""
-        return self.user_data_dir
-
-    @property
-    def user_log_dir(self) -> str:
-        """log directory tied to the user"""
-        return self.user_data_dir
-
-    @property
-    def user_documents_dir(self) -> str:
-        """documents directory tied to the user"""
-        return self.user_data_dir
-
-    @property
-    def user_runtime_dir(self) -> str:
-        """runtime directory tied to the user"""
-        return self.user_data_dir
-
-    @property
-    def user_music_dir(self) -> str:
-        """music directory tied to the user"""
-        return self.user_data_dir
-
-    @property
-    def user_pictures_dir(self) -> str:
-        """pictures directory tied to the user"""
-        return self.user_data_dir
-
-    @property
-    def user_videos_dir(self) -> str:
-        """videos directory tied to the user"""
-        return self.user_data_dir
-
-    @property
-    def user_downloads_dir(self) -> str:
-        """downloads directory tied to the user"""
-        return self.user_data_dir

test/unit/test_configmanager.py

@@ -499,35 +499,18 @@ def test_error_missing_fp_retrieve():
 
 
 @pytest.mark.parametrize("version", (None, "1"))
-@pytest.mark.parametrize(
-    "method",
-    (
-        "user_data_dir",
-        "site_data_dir",
-        "user_config_dir",
-        "site_config_dir",
-        "user_cache_dir",
-        "user_state_dir",
-        "user_log_dir",
-        "user_documents_dir",
-        "user_runtime_dir",
-        "user_music_dir",
-        "user_pictures_dir",
-        "user_videos_dir",
-    ),
-)
-def test_sf_dirs(tmp_path, method, version):
+def test_sf_dirs(tmp_path, version):
     appname = random_string(5)
-    assert getattr(
+    assert (
         SFPlatformDirs(
             str(tmp_path),
             appname=appname,
             appauthor=False,
             version=version,
             ensure_exists=True,
-        ),
-        method,
-    ) == str(tmp_path)
+        ).user_config_path
+        == tmp_path
+    )
 
 
 def test_config_file_resolution_sfdirs_default():