snowpark-checkpoints-configuration 0.1.0rc3__py3-none-any.whl → 0.1.2__py3-none-any.whl

snowflake/snowpark_checkpoints_configuration/__init__.py

@@ -0,0 +1,22 @@
+# 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 snowflake.snowpark_checkpoints_configuration.checkpoint_metadata import (
+    CheckpointMetadata,
+)
+
+__all__ = [
+    "CheckpointMetadata",
+]

snowflake/snowpark_checkpoints_configuration/__version__.py

@@ -0,0 +1,16 @@
+# 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.
+
+__version__ = "0.1.2"

snowflake/snowpark_checkpoints_configuration/checkpoint_metadata.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.
+import os
+
+from snowflake.snowpark_checkpoints_configuration.model.checkpoints import (
+    Checkpoint,
+    Checkpoints,
+)
+from snowflake.snowpark_checkpoints_configuration.singleton import Singleton
+
+
+class CheckpointMetadata(metaclass=Singleton):
+
+    """CheckpointMetadata class.
+
+    This is a singleton class that reads the checkpoints.json file
+    and provides an interface to get the checkpoint configuration.
+
+    Args:
+        metaclass (Singleton, optional): Defaults to Singleton.
+
+    """
+
+    def __init__(self, path: str = None):
+        directory = path if path is not None else os.getcwd()
+        self.checkpoint_model: Checkpoints = Checkpoints(type="", pipelines=[])
+        checkpoints_file = os.path.join(directory, "checkpoints.json")
+        if os.path.exists(checkpoints_file):
+            with open(checkpoints_file) as f:
+                try:
+                    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
+
+    def get_checkpoint(self, checkpoint_name: str) -> Checkpoint:
+        """Get a checkpoint by its name.
+
+        Args:
+            checkpoint_name (str): checkpoint name
+
+        Returns:
+            Checkpoint: Checkpoint configuration instance
+
+        """
+        return self.checkpoint_model.get_check_point(checkpoint_name=checkpoint_name)

snowflake/snowpark_checkpoints_configuration/checkpoint_name_utils.py

@@ -0,0 +1,53 @@
+# 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 re as regx
+
+
+CHECKPOINT_NAME_REGEX_PATTERN = r"[a-zA-Z_][a-zA-Z0-9_]+"
+TRANSLATION_TABLE = str.maketrans({" ": "_", "-": "_"})
+
+
+def normalize_checkpoint_name(checkpoint_name: str) -> str:
+    """Normalize the provided checkpoint name by replacing: the whitespace and hyphen tokens by underscore token.
+
+    Args:
+        checkpoint_name (str): The checkpoint name to normalize.
+
+    Returns:
+        str: the checkpoint name normalized.
+
+    """
+    normalized_checkpoint_name = checkpoint_name.translate(TRANSLATION_TABLE)
+    return normalized_checkpoint_name
+
+
+def is_valid_checkpoint_name(checkpoint_name: str) -> bool:
+    """Check if the provided checkpoint name is valid.
+
+    A valid checkpoint name must:
+    - Start with a letter (a-z, A-Z) or an underscore (_)
+    - Be followed by any combination of letters, digits (0-9) and underscores (_).
+
+    Args:
+        checkpoint_name (str): The checkpoint name to validate.
+
+    Returns:
+        bool: True if the checkpoint name is valid; otherwise, False.
+
+    """
+    matched = regx.fullmatch(CHECKPOINT_NAME_REGEX_PATTERN, checkpoint_name)
+    is_valid = bool(matched)
+    return is_valid

snowflake/snowpark_checkpoints_configuration/model/checkpoints.py

@@ -0,0 +1,128 @@
+# 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 pydantic import BaseModel, ConfigDict, field_validator
+from pydantic.alias_generators import to_camel
+
+from snowflake.snowpark_checkpoints_configuration import checkpoint_name_utils
+
+
+class Checkpoint(BaseModel):
+
+    """Checkpoint model.
+
+    Args:
+        pydantic.BaseModel (pydantic.BaseModel): pydantic BaseModel
+
+    """
+
+    name: str
+    mode: int = 1
+    function: Optional[str] = None
+    df: Optional[str] = None
+    sample: Optional[float] = None
+    file: Optional[str] = None
+    location: int = -1
+    enabled: bool = True
+
+    @field_validator("name", mode="before")
+    @classmethod
+    def normalize(cls, name: str) -> str:
+        normalized_name = checkpoint_name_utils.normalize_checkpoint_name(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."
+            )
+
+        return normalized_name
+
+
+class Pipeline(BaseModel):
+
+    """Pipeline model.
+
+    Args:
+        pydantic.BaseModel (pydantic.BaseModel): pydantic BaseModel
+
+    """
+
+    model_config = ConfigDict(
+        alias_generator=to_camel,
+        populate_by_name=True,
+        from_attributes=True,
+    )
+
+    entry_point: str
+    checkpoints: list[Checkpoint]
+
+
+class Checkpoints(BaseModel):
+
+    """Checkpoints model.
+
+    Args:
+        pydantic.BaseModel (pydantic.BaseModel): pydantic BaseModel
+
+    Returns:
+        Checkpoints: An instance of the Checkpoints class
+
+    """
+
+    type: str
+    pipelines: list[Pipeline]
+
+    # this dictionary holds the unpacked checkpoints from the different pipelines.
+    _checkpoints = {}
+
+    def _build_checkpoints_dict(self):
+        for pipeline in self.pipelines:
+            for checkpoint in pipeline.checkpoints:
+                self._checkpoints[checkpoint.name] = checkpoint
+
+    def get_check_point(self, checkpoint_name: str) -> Checkpoint:
+        """Get a checkpoint by its name.
+
+        Args:
+            checkpoint_name (str): The name of the checkpoint.
+
+        Returns:
+            Checkpoint: The checkpoint object if found, otherwise a new Checkpoint object
+            with the name set to the checkpoint_id.
+
+        """
+        if not self._checkpoints:
+            self._build_checkpoints_dict()
+
+        checkpoint = self._checkpoints.get(checkpoint_name)
+        if len(self._checkpoints) == 0:
+            checkpoint = Checkpoint(name=checkpoint_name, enabled=True)
+        elif checkpoint is None:
+            checkpoint = Checkpoint(name=checkpoint_name, enabled=False)
+        return checkpoint
+
+    def add_checkpoint(self, checkpoint: Checkpoint) -> None:
+        """Add a checkpoint to the checkpoints' dictionary.
+
+        Args:.
+            checkpoint (Checkpoint): The checkpoint object to add
+
+        """
+        self._checkpoints[checkpoint.name] = checkpoint

snowflake/snowpark_checkpoints_configuration/singleton.py

@@ -0,0 +1,23 @@
+# 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.
+
+
+class Singleton(type):
+    _instances = {}
+
+    def __call__(cls, *args, **kwargs):
+        if cls not in cls._instances:
+            cls._instances[cls] = super().__call__(*args, **kwargs)
+        return cls._instances[cls]

{snowpark_checkpoints_configuration-0.1.0rc3.dist-info → snowpark_checkpoints_configuration-0.1.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: snowpark-checkpoints-configuration
-Version: 0.1.0rc3
+Version: 0.1.2
 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
+Requires-Dist: snowflake-snowpark-python==1.26.0
 Provides-Extra: development
 Requires-Dist: coverage>=7.6.7; extra == 'development'
 Requires-Dist: hatchling==1.25.0; extra == 'development'
@@ -42,12 +42,8 @@ Description-Content-Type: text/markdown
 # snowpark-checkpoints-configuration
 
 ---
-**NOTE**
-
-This package is on Private Preview.
-
+##### This package is on Public Preview.
 ---
-
 **snowpark-checkpoints-configuration** is a module for loading `checkpoint.json` and provides a model. 
 This module will work automatically with *snowpark-checkpoints-collector*  and *snowpark-checkpoints-validators*. This will try to read the configuration file from the current working directory.
 

snowpark_checkpoints_configuration-0.1.2.dist-info/RECORD

@@ -0,0 +1,10 @@
+snowflake/snowpark_checkpoints_configuration/__init__.py,sha256=ILSUJf0losOC1vPMWITsK0zv5NjccBy8wlgQd5-YJlU,756
+snowflake/snowpark_checkpoints_configuration/__version__.py,sha256=qNTBwMUtsLu0okWXwrUvl9AohG1pXd4kalMC8v10gHM,632
+snowflake/snowpark_checkpoints_configuration/checkpoint_metadata.py,sha256=6V968CUQcYu0CnSHnJmP3Ccgmekfyfanh9JinH7UGOA,2207
+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.2.dist-info/METADATA,sha256=B0Mi9vZ_0cQQSkqIPO_RM-NVQ2bgsFZEgZh38UBBMOY,2724
+snowpark_checkpoints_configuration-0.1.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+snowpark_checkpoints_configuration-0.1.2.dist-info/licenses/LICENSE,sha256=DVQuDIgE45qn836wDaWnYhSdxoLXgpRRKH4RuTjpRZQ,10174
+snowpark_checkpoints_configuration-0.1.2.dist-info/RECORD,,

{snowpark_checkpoints_configuration-0.1.0rc3.dist-info → snowpark_checkpoints_configuration-0.1.2.dist-info}/licenses/LICENSE

@@ -175,28 +175,3 @@
       of your accepting any such warranty or additional liability.
 
    END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright 2025 Snowflake
-
-   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.

snowpark_checkpoints_configuration-0.1.0rc3.dist-info/RECORD

@@ -1,4 +0,0 @@
-snowpark_checkpoints_configuration-0.1.0rc3.dist-info/METADATA,sha256=vV9CjHZ7EHjV7Kjuee0EhR8ndOXRo-KtlzJraH_LVNw,2726
-snowpark_checkpoints_configuration-0.1.0rc3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-snowpark_checkpoints_configuration-0.1.0rc3.dist-info/licenses/LICENSE,sha256=pmjhbh6uVhV5MBXOlou_UZgFP7CYVQITkCCdvfcS5lY,11340
-snowpark_checkpoints_configuration-0.1.0rc3.dist-info/RECORD,,