snowpark-checkpoints-configuration 0.1.3__py3-none-any.whl → 0.2.0__py3-none-any.whl

snowflake/snowpark_checkpoints_configuration/__init__.py

@@ -13,10 +13,20 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import logging
+
+
+# Add a NullHandler to prevent logging messages from being output to
+# sys.stderr if no logging configuration is provided.
+logging.getLogger(__name__).addHandler(logging.NullHandler())
+
+# ruff: noqa: E402
+
 from snowflake.snowpark_checkpoints_configuration.checkpoint_metadata import (
     CheckpointMetadata,
 )
 
+
 __all__ = [
     "CheckpointMetadata",
 ]

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.1.3"
+__version__ = "0.2.0"

snowflake/snowpark_checkpoints_configuration/checkpoint_metadata.py

@@ -12,8 +12,12 @@
 # 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 logging
 import os
 
+from typing import Optional
+
 from snowflake.snowpark_checkpoints_configuration.model.checkpoints import (
     Checkpoint,
     Checkpoints,
@@ -21,6 +25,9 @@ from snowflake.snowpark_checkpoints_configuration.model.checkpoints import (
 from snowflake.snowpark_checkpoints_configuration.singleton import Singleton
 
 
+LOGGER = logging.getLogger(__name__)
+
+
 class CheckpointMetadata(metaclass=Singleton):
 
     """CheckpointMetadata class.
@@ -33,21 +40,28 @@ class CheckpointMetadata(metaclass=Singleton):
 
     """
 
-    def __init__(self, path: str = None):
-        directory = path if path is not None else os.getcwd()
+    def __init__(self, path: Optional[str] = None):
         self.checkpoint_model: Checkpoints = Checkpoints(type="", pipelines=[])
+        directory = path if path is not None else os.getcwd()
         checkpoints_file = os.path.join(directory, "checkpoints.json")
         if os.path.exists(checkpoints_file):
-            with open(checkpoints_file) as f:
-                try:
+            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
                     )
-                except Exception as e:
-                    raise Exception(
-                        f"Error reading checkpoints file: {checkpoints_file} \n {e}"
-                    ) from None
+                LOGGER.info(
+                    "Successfully read and validated checkpoints file: '%s'",
+                    checkpoints_file,
+                )
+            except Exception as e:
+                error_msg = f"An error occurred while reading the checkpoints file: '{checkpoints_file}'"
+                LOGGER.exception(error_msg)
+                raise Exception(f"{error_msg} \n {e}") from None
+        else:
+            LOGGER.warning("Checkpoints file not found: '%s'", checkpoints_file)
 
     def get_checkpoint(self, checkpoint_name: str) -> Checkpoint:
         """Get a checkpoint by its name.

snowflake/snowpark_checkpoints_configuration/model/checkpoints.py

@@ -13,6 +13,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import logging
+
 from typing import Optional
 
 from pydantic import BaseModel, ConfigDict, field_validator
@@ -21,6 +23,9 @@ from pydantic.alias_generators import to_camel
 from snowflake.snowpark_checkpoints_configuration import checkpoint_name_utils
 
 
+LOGGER = logging.getLogger(__name__)
+
+
 class Checkpoint(BaseModel):
 
     """Checkpoint model.
@@ -42,15 +47,19 @@ class Checkpoint(BaseModel):
     @field_validator("name", mode="before")
     @classmethod
     def normalize(cls, name: str) -> str:
+        LOGGER.debug("Normalizing checkpoint name: '%s'", name)
         normalized_name = checkpoint_name_utils.normalize_checkpoint_name(name)
+        LOGGER.debug("Checkpoint name was normalized to: '%s'", normalized_name)
         is_valid_checkpoint_name = checkpoint_name_utils.is_valid_checkpoint_name(
             normalized_name
         )
         if not is_valid_checkpoint_name:
-            raise Exception(
-                f"Invalid checkpoint name: {name} in checkpoints.json file. Checkpoint names must only contain "
-                f"alphanumeric characters and underscores."
+            error_msg = (
+                f"Invalid checkpoint name: {name} in checkpoints.json file. "
+                f"Checkpoint names must only contain alphanumeric characters and underscores."
             )
+            LOGGER.error(error_msg)
+            raise Exception(error_msg)
 
         return normalized_name
 
@@ -93,8 +102,11 @@ class Checkpoints(BaseModel):
     _checkpoints = {}
 
     def _build_checkpoints_dict(self):
+        LOGGER.debug("Building checkpoints dictionary from pipelines.")
         for pipeline in self.pipelines:
+            LOGGER.debug("Processing pipeline: '%s'", pipeline.entry_point)
             for checkpoint in pipeline.checkpoints:
+                LOGGER.debug("Adding checkpoint: %s", checkpoint)
                 self._checkpoints[checkpoint.name] = checkpoint
 
     def get_check_point(self, checkpoint_name: str) -> Checkpoint:
@@ -108,21 +120,35 @@ class Checkpoints(BaseModel):
             with the name set to the checkpoint_id.
 
         """
+        LOGGER.info("Fetching checkpoint: '%s'", checkpoint_name)
         if not self._checkpoints:
+            LOGGER.debug("Checkpoints dictionary is empty, building it...")
             self._build_checkpoints_dict()
 
         checkpoint = self._checkpoints.get(checkpoint_name)
         if len(self._checkpoints) == 0:
+            LOGGER.info(
+                "No checkpoints found, creating a new enabled checkpoint with name: '%s'",
+                checkpoint_name,
+            )
             checkpoint = Checkpoint(name=checkpoint_name, enabled=True)
         elif checkpoint is None:
+            LOGGER.info(
+                "Checkpoint not found, creating a new disabled checkpoint with name: '%s'",
+                checkpoint_name,
+            )
             checkpoint = Checkpoint(name=checkpoint_name, enabled=False)
+
+        LOGGER.debug("Returning checkpoint: %s", checkpoint)
         return checkpoint
 
     def add_checkpoint(self, checkpoint: Checkpoint) -> None:
         """Add a checkpoint to the checkpoints' dictionary.
 
-        Args:.
+        Args:
             checkpoint (Checkpoint): The checkpoint object to add
 
         """
+        LOGGER.debug("Adding checkpoint: %s", checkpoint)
         self._checkpoints[checkpoint.name] = checkpoint
+        LOGGER.info("Checkpoint '%s' added successfully.", checkpoint.name)

{snowpark_checkpoints_configuration-0.1.3.dist-info → snowpark_checkpoints_configuration-0.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: snowpark-checkpoints-configuration
-Version: 0.1.3
+Version: 0.2.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/
@@ -27,7 +27,7 @@ Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: <3.12,>=3.9
 Requires-Dist: pydantic>=1.8.2
-Requires-Dist: snowflake-snowpark-python==1.26.0
+Requires-Dist: snowflake-snowpark-python>=1.23.0
 Provides-Extra: development
 Requires-Dist: coverage>=7.6.7; extra == 'development'
 Requires-Dist: hatchling==1.25.0; extra == 'development'

{snowpark_checkpoints_configuration-0.1.3.dist-info → snowpark_checkpoints_configuration-0.2.0.dist-info}/RECORD

@@ -1,10 +1,10 @@
-snowflake/snowpark_checkpoints_configuration/__init__.py,sha256=ILSUJf0losOC1vPMWITsK0zv5NjccBy8wlgQd5-YJlU,756
-snowflake/snowpark_checkpoints_configuration/__version__.py,sha256=OfdAqrd8gnFI-pK7o_olRVrRKIWfQhQOoo_wR3u1s5s,632
-snowflake/snowpark_checkpoints_configuration/checkpoint_metadata.py,sha256=6V968CUQcYu0CnSHnJmP3Ccgmekfyfanh9JinH7UGOA,2207
+snowflake/snowpark_checkpoints_configuration/__init__.py,sha256=xZ2oBwJeEso0laWYDaXQidGt_MdjgNsOZ1_0BcZcXvE,980
+snowflake/snowpark_checkpoints_configuration/__version__.py,sha256=ajnGza8ucK69-PA8wEbHmWZxDwd3bsTm74yMKiIWNHY,632
+snowflake/snowpark_checkpoints_configuration/checkpoint_metadata.py,sha256=vr60OMFW5PUR5BSBSi1PqiTRoKi4D64qxSUP5z1Lz4o,2692
 snowflake/snowpark_checkpoints_configuration/checkpoint_name_utils.py,sha256=WExQaZ4oL4otDCtM8kyGbf0Gn_v1a-tzM5j1p0wVDVg,1767
 snowflake/snowpark_checkpoints_configuration/singleton.py,sha256=7AgIHQBXVRvPBBCkmBplzkdrrm-xVWf_N8svzA2vF8E,836
-snowflake/snowpark_checkpoints_configuration/model/checkpoints.py,sha256=5OJfAU3oyQZoffOD01Pr1aNlghSKqZ6L-JAhggC0T5Y,3688
-snowpark_checkpoints_configuration-0.1.3.dist-info/METADATA,sha256=cAy9aOOcdmIRwCrYJCneqPerVel-T16dzQjr3TnqRWs,2724
-snowpark_checkpoints_configuration-0.1.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-snowpark_checkpoints_configuration-0.1.3.dist-info/licenses/LICENSE,sha256=DVQuDIgE45qn836wDaWnYhSdxoLXgpRRKH4RuTjpRZQ,10174
-snowpark_checkpoints_configuration-0.1.3.dist-info/RECORD,,
+snowflake/snowpark_checkpoints_configuration/model/checkpoints.py,sha256=O2x_iRQiw-UojjS770p9JX0JAy1mmBAA8WkzOaUaZ8U,4838
+snowpark_checkpoints_configuration-0.2.0.dist-info/METADATA,sha256=qswqNR19zQcrSLRh_uAOiBQ-X4cvjtMEYuvVSOFjCT4,2724
+snowpark_checkpoints_configuration-0.2.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+snowpark_checkpoints_configuration-0.2.0.dist-info/licenses/LICENSE,sha256=DVQuDIgE45qn836wDaWnYhSdxoLXgpRRKH4RuTjpRZQ,10174
+snowpark_checkpoints_configuration-0.2.0.dist-info/RECORD,,