snowpark-checkpoints-configuration 0.2.0rc1__tar.gz → 0.2.1__tar.gz

{snowpark_checkpoints_configuration-0.2.0rc1 → snowpark_checkpoints_configuration-0.2.1}/.gitignore

@@ -4,12 +4,16 @@
 
 # demos
 snowpark-checkpoints-output/
+Demos/Demos/
+Demos/snowpark-checkpoints-output/
 
 # env
 wheelvenv/
 
+
 # version
 !__version__.py
+!**/__version__.py
 
 #ruff
 .ruff_cache

{snowpark_checkpoints_configuration-0.2.0rc1 → snowpark_checkpoints_configuration-0.2.1}/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.2.1/PKG-INFO

@@ -0,0 +1,62 @@
+Metadata-Version: 2.4
+Name: snowpark-checkpoints-configuration
+Version: 0.2.1
+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/
+Author-email: "Snowflake, Inc." <snowflake-python-libraries-dl@snowflake.com>
+License: Apache License, Version 2.0
+License-File: LICENSE
+Keywords: Snowflake,Snowpark,analytics,cloud,database,db
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Environment :: Other Environment
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: SQL
+Classifier: Topic :: Database
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: Topic :: Software Development
+Classifier: Topic :: Software Development :: Libraries
+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.23.0
+Provides-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'
+Requires-Dist: pyarrow>=18.0.0; extra == 'development'
+Requires-Dist: pytest-cov>=6.0.0; extra == 'development'
+Requires-Dist: pytest>=8.3.3; extra == 'development'
+Requires-Dist: setuptools>=70.0.0; extra == 'development'
+Requires-Dist: twine==5.1.1; extra == 'development'
+Description-Content-Type: text/markdown
+
+# snowpark-checkpoints-configuration
+
+---
+##### 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.
+
+## Usage
+
+To explicit load a file, you can import  `CheckpointMetadata` and create an instance as shown below:
+
+```python
+from snowflake.snowpark_checkpoints_configuration import CheckpointMetadata
+
+my_checkpoint_metadata = CheckpointMetadata("path/to/checkpoint.json")
+
+checkpoint_model = my_checkpoint_metadata.get_checkpoint("my_checkpoint_name")
+...
+```
+------

{snowpark_checkpoints_configuration-0.2.0rc1 → snowpark_checkpoints_configuration-0.2.1}/README.md

@@ -1,12 +1,8 @@
 # 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.
 
@@ -19,7 +15,7 @@ from snowflake.snowpark_checkpoints_configuration import CheckpointMetadata
 
 my_checkpoint_metadata = CheckpointMetadata("path/to/checkpoint.json")
 
-checkpoint_model = my_checkpoint_metadata.get("my_checkpoint_name")
+checkpoint_model = my_checkpoint_metadata.get_checkpoint("my_checkpoint_name")
 ...
 ```
 ------

{snowpark_checkpoints_configuration-0.2.0rc1 → snowpark_checkpoints_configuration-0.2.1}/pyproject.toml

@@ -3,7 +3,6 @@ build-backend = "hatchling.build"
 requires = ["hatchling"]
 
 [project]
-authors = [{name = "Snowflake Inc."}]
 classifiers = [
   "Development Status :: 4 - Beta",
   "Environment :: Console",
@@ -26,10 +25,14 @@ classifiers = [
 
 dependencies = [
   "pydantic>=1.8.2",
-  "snowflake-snowpark-python",
+  "snowflake-snowpark-python>=1.23.0",
 ]
 
+authors = [
+  {name = "Snowflake, Inc.", email = "snowflake-python-libraries-dl@snowflake.com"},
+]
 description = "Migration tools for Snowpark"
+dynamic = ['version']
 keywords = [
   'Snowflake',
   'analytics',
@@ -38,12 +41,10 @@ keywords = [
   'db',
   'Snowpark',
 ]
-license = {file = "LICENSE"}
+license = {text = "Apache License, Version 2.0"}
 name = "snowpark-checkpoints-configuration"
 readme = "README.md"
-requires-python = ">=3.9"
-dynamic = ['version']
-
+requires-python = '>=3.9,<3.12'
 
 [project.optional-dependencies]
 development = [
@@ -62,7 +63,7 @@ development = [
 "Source code" = "https://github.com/snowflakedb/snowpark-checkpoints/"
 
 [tool.hatch.version]
-path = "__version__.py"
+path = "src/snowflake/snowpark_checkpoints_configuration/__version__.py"
 pattern = '^__version__ = "(?P<version>.*)"'
 source = "regex"
 
@@ -74,15 +75,22 @@ where = ["src/"]
 dev-mode-dirs = ['src']
 directory = 'snowpark-checkpoints-configuration'
 
+[[tool.hatch.sources]]
+dir = "src/snowflake/snowpark_checkpoints_configuration"
+name = "snowpark-checkpoints-configuration"
+type = "package"
+
 [tool.hatch.build.targets.wheel]
 directory = "dist"
-packages = ["snowpark-checkpoints-configuration/src/snowflake/snowpark_checkpoints_configuration"]
+packages = [
+  "src/snowflake",
+]
 
 [tool.hatch.build.targets.sdist]
 directory = "dist"
 exclude = ["/.github", "/.idea"]
 include = [
-  'snowpark-checkpoints-configuration/src',
+  'src/**',
   'README.md',
   'LICENSE',
   'test/',
@@ -116,7 +124,7 @@ check = [
 
 [tool.hatch.envs.test.scripts]
 check = [
-  'pytest -v --junitxml=test/outcome/test-results.xml --cov=. --cov-config=test/.coveragerc --cov-report=xml:test/outcome/coverage-{matrix:python:{env:PYTHON_VERSION:unset}}.xml {args:test} --cov-report=term --cov-report=json:test/outcome/coverage-{matrix:python:{env:PYTHON_VERSION:unset}}.json',
+  'pytest -vvv --junitxml=test/outcome/test-results.xml --cov=. --cov-branch --cov-config=test/.coveragerc --cov-report=xml:test/outcome/coverage-{matrix:python:{env:PYTHON_VERSION:unset}}.xml {args:test} --cov-report=term --cov-report=html:test/outcome/coverage-{matrix:python:{env:PYTHON_VERSION:unset}}.html --cov-report=json:test/outcome/coverage-{matrix:python:{env:PYTHON_VERSION:unset}}.json',
 ]
 
 coverage = [

snowpark_checkpoints_configuration-0.2.1/src/snowflake/snowpark_checkpoints_configuration/__init__.py

@@ -0,0 +1,32 @@
+# 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 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",
+]

snowpark_checkpoints_configuration-0.2.1/src/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.2.1"

snowpark_checkpoints_configuration-0.2.1/src/snowflake/snowpark_checkpoints_configuration/checkpoint_metadata.py

@@ -0,0 +1,76 @@
+# 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 logging
+import os
+
+from typing import Optional
+
+from snowflake.snowpark_checkpoints_configuration.model.checkpoints import (
+    Checkpoint,
+    Checkpoints,
+)
+from snowflake.snowpark_checkpoints_configuration.singleton import Singleton
+
+
+LOGGER = logging.getLogger(__name__)
+
+
+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: 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):
+            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
+                    )
+                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.
+
+        Args:
+            checkpoint_name (str): checkpoint name
+
+        Returns:
+            Checkpoint: Checkpoint configuration instance
+
+        """
+        return self.checkpoint_model.get_check_point(checkpoint_name=checkpoint_name)

snowpark_checkpoints_configuration-0.2.1/src/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), underscores (_), and dollar signs ($).
+
+    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

snowpark_checkpoints_configuration-0.2.1/src/snowflake/snowpark_checkpoints_configuration/model/checkpoints.py

@@ -0,0 +1,154 @@
+# 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 logging
+
+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
+
+
+LOGGER = logging.getLogger(__name__)
+
+
+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:
+        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:
+            error_msg = (
+                f"Invalid checkpoint name: {name} in checkpoints.json file. "
+                f"Checkpoint names must only contain alphanumeric characters, underscores and dollar signs."
+            )
+            LOGGER.error(error_msg)
+            raise Exception(error_msg)
+
+        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):
+        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:
+        """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.
+
+        """
+        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:
+            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.2.1/src/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.2.0rc1 → snowpark_checkpoints_configuration-0.2.1}/test/.coveragerc

@@ -8,6 +8,7 @@ omit =
     */test/*
     */.venv/*
     */.env/*
+    **/telemetry.py
 
 [report]
 show_missing = False