snowpark-checkpoints-configuration 0.2.1__tar.gz → 0.3.0__tar.gz

{snowpark_checkpoints_configuration-0.2.1 → snowpark_checkpoints_configuration-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: snowpark-checkpoints-configuration
-Version: 0.2.1
+Version: 0.3.0
 Summary: Migration tools for Snowpark
 Project-URL: Bug Tracker, https://github.com/snowflakedb/snowpark-checkpoints/issues
 Project-URL: Source code, https://github.com/snowflakedb/snowpark-checkpoints/
@@ -29,6 +29,7 @@ Requires-Python: <3.12,>=3.9
 Requires-Dist: pydantic>=1.8.2
 Requires-Dist: snowflake-snowpark-python>=1.23.0
 Provides-Extra: development
+Requires-Dist: certifi==2025.1.31; extra == 'development'
 Requires-Dist: coverage>=7.6.7; extra == 'development'
 Requires-Dist: hatchling==1.25.0; extra == 'development'
 Requires-Dist: pre-commit>=4.0.1; extra == 'development'

{snowpark_checkpoints_configuration-0.2.1 → snowpark_checkpoints_configuration-0.3.0}/pyproject.toml

@@ -56,6 +56,7 @@ development = [
   "pre-commit>=4.0.1",
   "setuptools>=70.0.0",
   "pyarrow>=18.0.0",
+  "certifi==2025.1.31",
 ]
 
 [project.urls]

{snowpark_checkpoints_configuration-0.2.1 → snowpark_checkpoints_configuration-0.3.0}/src/snowflake/snowpark_checkpoints_configuration/__version__.py

@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-__version__ = "0.2.1"
+__version__ = "0.3.0"

{snowpark_checkpoints_configuration-0.2.1 → snowpark_checkpoints_configuration-0.3.0}/src/snowflake/snowpark_checkpoints_configuration/checkpoint_metadata.py

@@ -18,6 +18,9 @@ import os
 
 from typing import Optional
 
+from snowflake.snowpark_checkpoints_configuration.io_utils.io_file_manager import (
+    get_io_file_manager,
+)
 from snowflake.snowpark_checkpoints_configuration.model.checkpoints import (
     Checkpoint,
     Checkpoints,
@@ -42,16 +45,13 @@ class CheckpointMetadata(metaclass=Singleton):
 
     def __init__(self, path: Optional[str] = None):
         self.checkpoint_model: Checkpoints = Checkpoints(type="", pipelines=[])
-        directory = path if path is not None else os.getcwd()
+        directory = path if path is not None else get_io_file_manager().getcwd()
         checkpoints_file = os.path.join(directory, "checkpoints.json")
-        if os.path.exists(checkpoints_file):
+        if get_io_file_manager().file_exists(checkpoints_file):
             LOGGER.info("Reading checkpoints file: '%s'", checkpoints_file)
             try:
-                with open(checkpoints_file) as f:
-                    checkpoint_json = f.read()
-                    self.checkpoint_model = Checkpoints.model_validate_json(
-                        checkpoint_json
-                    )
+                checkpoint_json = get_io_file_manager().read(checkpoints_file)
+                self.checkpoint_model = Checkpoints.model_validate_json(checkpoint_json)
                 LOGGER.info(
                     "Successfully read and validated checkpoints file: '%s'",
                     checkpoints_file,

snowpark_checkpoints_configuration-0.3.0/src/snowflake/snowpark_checkpoints_configuration/io_utils/__init__.py

@@ -0,0 +1,26 @@
+# Copyright 2025 Snowflake Inc.
+# SPDX-License-Identifier: Apache-2.0
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+# http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+__all__ = ["EnvStrategy", "IOFileManager", "IODefaultStrategy"]
+
+from snowflake.snowpark_checkpoints_configuration.io_utils.io_env_strategy import (
+    EnvStrategy,
+)
+from snowflake.snowpark_checkpoints_configuration.io_utils.io_default_strategy import (
+    IODefaultStrategy,
+)
+from snowflake.snowpark_checkpoints_configuration.io_utils.io_file_manager import (
+    IOFileManager,
+)

snowpark_checkpoints_configuration-0.3.0/src/snowflake/snowpark_checkpoints_configuration/io_utils/io_default_strategy.py

@@ -0,0 +1,34 @@
+# Copyright 2025 Snowflake Inc.
+# SPDX-License-Identifier: Apache-2.0
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+# http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import os
+
+from typing import Optional
+
+from snowflake.snowpark_checkpoints_configuration.io_utils import EnvStrategy
+
+
+class IODefaultStrategy(EnvStrategy):
+    def file_exists(self, path: str) -> bool:
+        return os.path.isfile(path)
+
+    def read(
+        self, file_path: str, mode: str = "r", encoding: Optional[str] = None
+    ) -> str:
+        with open(file_path, mode=mode, encoding=encoding) as file:
+            return file.read()
+
+    def getcwd(self) -> str:
+        return os.getcwd()

snowpark_checkpoints_configuration-0.3.0/src/snowflake/snowpark_checkpoints_configuration/io_utils/io_env_strategy.py

@@ -0,0 +1,62 @@
+# Copyright 2025 Snowflake Inc.
+# SPDX-License-Identifier: Apache-2.0
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+# http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from abc import ABC, abstractmethod
+from typing import Optional
+
+
+class EnvStrategy(ABC):
+
+    """An abstract base class that defines methods for file and directory operations.
+
+    Subclasses should implement these methods to provide environment-specific behavior.
+    """
+
+    @abstractmethod
+    def file_exists(self, path: str) -> bool:
+        """Check if a file exists.
+
+        Args:
+            path: The path to the file.
+
+        Returns:
+            bool: True if the file exists, False otherwise.
+
+        """
+
+    @abstractmethod
+    def read(
+        self, file_path: str, mode: str = "r", encoding: Optional[str] = None
+    ) -> str:
+        """Read content from a file.
+
+        Args:
+            file_path: The path to the file to read from.
+            mode: The mode in which to open the file.
+            encoding: The encoding to use for reading the file.
+
+        Returns:
+            str: The content of the file.
+
+        """
+
+    @abstractmethod
+    def getcwd(self) -> str:
+        """Get the current working directory.
+
+        Returns:
+            str: The current working directory.
+
+        """

snowpark_checkpoints_configuration-0.3.0/src/snowflake/snowpark_checkpoints_configuration/io_utils/io_file_manager.py

@@ -0,0 +1,57 @@
+# Copyright 2025 Snowflake Inc.
+# SPDX-License-Identifier: Apache-2.0
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+# http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from typing import Optional
+
+from snowflake.snowpark_checkpoints_configuration.io_utils import (
+    EnvStrategy,
+    IODefaultStrategy,
+)
+from snowflake.snowpark_checkpoints_configuration.singleton import Singleton
+
+
+class IOFileManager(metaclass=Singleton):
+    def __init__(self, strategy: Optional[EnvStrategy] = None):
+        self.strategy = strategy or IODefaultStrategy()
+
+    def file_exists(self, path: str) -> bool:
+        return self.strategy.file_exists(path)
+
+    def read(
+        self, file_path: str, mode: str = "r", encoding: Optional[str] = None
+    ) -> str:
+        return self.strategy.read(file_path, mode, encoding)
+
+    def getcwd(self) -> str:
+        return self.strategy.getcwd()
+
+    def set_strategy(self, strategy: EnvStrategy):
+        """Set the strategy for file and directory operations.
+
+        Args:
+            strategy (EnvStrategy): The strategy to use for file and directory operations.
+
+        """
+        self.strategy = strategy
+
+
+def get_io_file_manager():
+    """Get the singleton instance of IOFileManager.
+
+    Returns:
+        IOFileManager: The singleton instance of IOFileManager.
+
+    """
+    return IOFileManager()

snowpark_checkpoints_configuration-0.3.0/test/unit/io_utils/test_default_strategy.py

@@ -0,0 +1,126 @@
+# Copyright 2025 Snowflake Inc.
+# SPDX-License-Identifier: Apache-2.0
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+# http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import os
+import tempfile
+from unittest.mock import patch
+import pytest
+
+from snowflake.snowpark_checkpoints_configuration.io_utils import IODefaultStrategy
+from snowflake.snowpark_checkpoints_configuration.io_utils.io_file_manager import (
+    get_io_file_manager,
+)
+from snowflake.snowpark_checkpoints_configuration.singleton import Singleton
+
+
+@pytest.fixture(scope="function")
+def io_file_manager():
+    Singleton._instances = {}
+    return get_io_file_manager()
+
+
+def test_default_file_exists(io_file_manager):
+    with tempfile.TemporaryDirectory(dir=os.getcwd()) as temp_dir:
+        # Arrange
+        path = os.path.join(temp_dir, "test_file.txt")
+        with open(path, "w") as f:
+            f.write("test")
+
+        # Act
+        result = io_file_manager.file_exists(path)
+
+        # Assert
+        assert result
+
+
+def test_default_file_exists_fail(io_file_manager):
+    # Act
+    result_not_exists = io_file_manager.file_exists("")
+
+    # Assert
+    assert result_not_exists is False
+
+
+def test_default_file_exists_fail_with_folder(io_file_manager):
+    with tempfile.TemporaryDirectory(dir=os.getcwd()) as temp_dir:
+        # Arrange
+        path = os.path.join(temp_dir, "temp_dir")
+        os.makedirs(path)
+
+        # Act
+        result_not_file = io_file_manager.file_exists(path)
+
+        # Assert
+        assert result_not_file is False
+
+
+def test_default_read(io_file_manager):
+    with tempfile.TemporaryDirectory(dir=os.getcwd()) as temp_dir:
+        # Arrange
+        path = os.path.join(temp_dir, "test_file.txt")
+        content = "test"
+        with open(path, "w") as f:
+            f.write(content)
+
+        # Act
+        result = io_file_manager.read(path)
+
+        # Assert
+        assert result == content
+
+
+def test_default_read_fail(io_file_manager):
+    with tempfile.TemporaryDirectory(dir=os.getcwd()) as temp_dir:
+        # Arrange
+        path = os.path.join(temp_dir, "test_file.txt")
+
+        # Act & Assert
+        with pytest.raises(FileNotFoundError):
+            io_file_manager.read(path)
+
+
+def test_default_getcwd(io_file_manager):
+    with tempfile.TemporaryDirectory(dir=os.getcwd()):
+        # Act
+        result = io_file_manager.getcwd()
+
+        # Assert
+        assert isinstance(result, str)
+
+
+def test_default_set_strategy(io_file_manager):
+    try:
+        # Arrange
+        with patch(
+            "snowflake.snowpark_checkpoints_configuration.io_utils.EnvStrategy"
+        ) as MockStrategy:
+            strategy = MockStrategy()
+
+            # Act
+            io_file_manager.set_strategy(strategy)
+
+            # Assert
+            assert io_file_manager.strategy == strategy
+    finally:
+        io_file_manager.set_strategy(IODefaultStrategy())
+
+
+def test_default_get_io_file_manager_singleton():
+    # Act
+    result = get_io_file_manager()
+    result2 = get_io_file_manager()
+
+    # Assert
+    assert result == result2