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

{snowpark_checkpoints_collectors-0.2.0rc1 → snowpark_checkpoints_collectors-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_collectors-0.2.0rc1 → snowpark_checkpoints_collectors-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_collectors-0.2.1/PKG-INFO

@@ -0,0 +1,158 @@
+Metadata-Version: 2.4
+Name: snowpark-checkpoints-collectors
+Version: 0.2.1
+Summary: Snowpark column and table statistics collection
+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: pandera[io]==0.20.4
+Requires-Dist: snowflake-connector-python
+Requires-Dist: snowflake-snowpark-python>=1.23.0
+Provides-Extra: development
+Requires-Dist: coverage>=7.6.7; extra == 'development'
+Requires-Dist: deepdiff>=8.0.0; 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: pyspark>=3.5.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'
+Provides-Extra: pyspark
+Requires-Dist: pyspark>=3.5.0; extra == 'pyspark'
+Description-Content-Type: text/markdown
+
+# snowpark-checkpoints-collectors
+
+
+---
+##### This package is on Public Preview.
+---
+
+**snowpark-checkpoints-collector** package offers a function for extracting information from PySpark dataframes. We can then use that data to validate against the converted Snowpark dataframes to ensure that behavioral equivalence has been achieved.
+
+---
+## Install the library
+```bash
+pip install snowpark-checkpoints-collectors
+```
+This package requires PySpark to be installed in the same environment. If you do not have it, you can install PySpark alongside Snowpark Checkpoints by running the following command:
+```bash
+pip install "snowpark-checkpoints-collectors[pyspark]"
+```
+---
+
+## Features
+
+- Schema inference collected data mode (Schema): This is the default mode, which leverages Pandera schema inference to obtain the metadata and checks that will be evaluated for the specified dataframe. This mode also collects custom data from columns of the DataFrame based on the PySpark type.
+- DataFrame collected data mode (DataFrame): This mode collects the data of the PySpark dataframe. In this case, the mechanism saves all data of the given dataframe in parquet format. Using the default user Snowflake connection, it tries to upload the parquet files into the Snowflake temporal stage and create a table based on the information in the stage. The name of the file and the table is the same as the checkpoint.
+
+
+
+## Functionalities
+
+### Collect DataFrame Checkpoint
+
+
+
+```python
+from pyspark.sql import DataFrame as SparkDataFrame
+from snowflake.snowpark_checkpoints_collector.collection_common import CheckpointMode
+from typing import Optional
+
+# Signature of the function
+def collect_dataframe_checkpoint(
+    df: SparkDataFrame,
+    checkpoint_name: str,
+    sample: Optional[float] = None,
+    mode: Optional[CheckpointMode] = None,
+    output_path: Optional[str] = None,
+) -> None:
+    ...
+```
+
+- `df`: The input Spark dataframe to collect.
+- `checkpoint_name`: Name of the checkpoint schema file or dataframe.
+- `sample`: Fraction of DataFrame to sample for schema inference, defaults to 1.0.
+- `mode`: The mode to execution the collection (Schema or Dataframe), defaults to CheckpointMode.Schema.
+- `output_path`: The output path to save the checkpoint, defaults to current working directory.
+
+
+## Usage Example
+
+### Schema mode
+
+```python
+from pyspark.sql import SparkSession
+from snowflake.snowpark_checkpoints_collector import collect_dataframe_checkpoint
+from snowflake.snowpark_checkpoints_collector.collection_common import CheckpointMode
+
+spark_session = SparkSession.builder.getOrCreate()
+sample_size = 1.0
+
+pyspark_df = spark_session.createDataFrame(
+    [("apple", 21), ("lemon", 34), ("banana", 50)], schema="fruit string, age integer"
+)
+
+collect_dataframe_checkpoint(
+    pyspark_df,
+    checkpoint_name="collect_checkpoint_mode_1",
+    sample=sample_size,
+    mode=CheckpointMode.SCHEMA,
+)
+```
+
+
+### Dataframe mode
+
+```python
+from pyspark.sql import SparkSession
+from snowflake.snowpark_checkpoints_collector import collect_dataframe_checkpoint
+from snowflake.snowpark_checkpoints_collector.collection_common import CheckpointMode
+from pyspark.sql.types import StructType, StructField, ByteType, StringType, IntegerType 
+
+spark_schema = StructType(
+    [
+        StructField("BYTE", ByteType(), True),
+        StructField("STRING", StringType(), True),
+        StructField("INTEGER", IntegerType(), True)
+    ]
+)
+
+data = [(1, "apple", 21), (2, "lemon", 34), (3, "banana", 50)]
+
+spark_session = SparkSession.builder.getOrCreate()
+pyspark_df = spark_session.createDataFrame(data, schema=spark_schema).orderBy(
+    "INTEGER"
+)
+
+collect_dataframe_checkpoint(
+    pyspark_df,
+    checkpoint_name="collect_checkpoint_mode_2",
+    mode=CheckpointMode.DATAFRAME,
+)
+```
+
+------

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

@@ -1,13 +1,23 @@
 # snowpark-checkpoints-collectors
 
+
+---
+##### This package is on Public Preview.
 ---
-**NOTE**
 
-This package is on Private Preview.
+**snowpark-checkpoints-collector** package offers a function for extracting information from PySpark dataframes. We can then use that data to validate against the converted Snowpark dataframes to ensure that behavioral equivalence has been achieved.
 
+---
+## Install the library
+```bash
+pip install snowpark-checkpoints-collectors
+```
+This package requires PySpark to be installed in the same environment. If you do not have it, you can install PySpark alongside Snowpark Checkpoints by running the following command:
+```bash
+pip install "snowpark-checkpoints-collectors[pyspark]"
+```
 ---
 
-**snowpark-checkpoints-collector** package offers a function for extracting information from PySpark dataframes. We can then use that data to validate against the converted Snowpark dataframes to ensure that behavioral equivalence has been achieved.
 ## Features
 
 - Schema inference collected data mode (Schema): This is the default mode, which leverages Pandera schema inference to obtain the metadata and checks that will be evaluated for the specified dataframe. This mode also collects custom data from columns of the DataFrame based on the PySpark type.

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

@@ -3,7 +3,9 @@ build-backend = "hatchling.build"
 requires = ["hatchling"]
 
 [project]
-authors = [{name = "Snowflake Inc."}]
+authors = [
+  {name = "Snowflake, Inc.", email = "snowflake-python-libraries-dl@snowflake.com"},
+]
 classifiers = [
   "Development Status :: 4 - Beta",
   "Environment :: Console",
@@ -24,12 +26,12 @@ classifiers = [
   "Topic :: Scientific/Engineering :: Information Analysis",
 ]
 dependencies = [
-  "snowflake-snowpark-python",
+  "snowflake-snowpark-python>=1.23.0",
   "snowflake-connector-python",
-  "pyspark",
   "pandera[io]==0.20.4",
 ]
 description = "Snowpark column and table statistics collection"
+dynamic = ['version']
 keywords = [
   'Snowflake',
   'analytics',
@@ -38,13 +40,15 @@ keywords = [
   'db',
   'Snowpark',
 ]
-license = {file = "LICENSE"}
+license = {text = "Apache License, Version 2.0"}
 name = "snowpark-checkpoints-collectors"
 readme = "README.md"
 requires-python = '>=3.9,<3.12'
-dynamic = ['version']
 
 [project.optional-dependencies]
+pyspark = [
+  "pyspark>=3.5.0",
+]
 development = [
   "pytest>=8.3.3",
   "pytest-cov>=6.0.0",
@@ -55,14 +59,16 @@ development = [
   "setuptools>=70.0.0",
   "pyarrow>=18.0.0",
   "deepdiff>=8.0.0",
+  "pyspark>=3.5.0",
 ]
 
 [project.urls]
 "Bug Tracker" = "https://github.com/snowflakedb/snowpark-checkpoints/issues"
 "Source code" = "https://github.com/snowflakedb/snowpark-checkpoints/"
 
+
 [tool.hatch.version]
-path = "__version__.py"
+path = "src/snowflake/snowpark_checkpoints_collector/__version__.py"
 pattern = '^__version__ = "(?P<version>.*)"'
 source = "regex"
 
@@ -74,15 +80,22 @@ where = ["src/"]
 dev-mode-dirs = ['src']
 directory = 'snowpark-checkpoints-collectors'
 
+[[tool.hatch.sources]]
+dir = "src/snowflake/snowpark_checkpoints_collector"
+name = "snowpark-checkpoints-collectors"
+type = "package"
+
 [tool.hatch.build.targets.wheel]
 directory = "dist"
-packages = ["snowpark-checkpoints-collectors/src/snowflake/snowpark_checkpoints_collector"]
+packages = [
+  "src/snowflake",
+]
 
 [tool.hatch.build.targets.sdist]
 directory = "dist"
 exclude = ["/.github", "/.idea"]
 include = [
-  'src/',
+  'src/**',
   'README.md',
   'LICENSE',
   'test/',
@@ -113,7 +126,6 @@ exclude_lines = [
   "if __name__ == .__main__.:",
 ]
 
-
 [tool.hatch.envs.linter.scripts]
 check = [
   'ruff check --fix .',
@@ -121,8 +133,10 @@ check = [
 
 [tool.hatch.envs.test.scripts]
 check = [
-  "pip install -e ../snowpark-checkpoints-configuration" ,
-  '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',
+  'python -m pip install --upgrade pip -q',
+  'pip install -q -e ../snowpark-checkpoints-configuration',
+  'pip list',
+  '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_collectors-0.2.1/src/snowflake/snowpark_checkpoints_collector/__init__.py

@@ -0,0 +1,30 @@
+# 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
+
+__all__ = ["collect_dataframe_checkpoint", "CheckpointMode"]
+
+from snowflake.snowpark_checkpoints_collector.collection_common import CheckpointMode
+from snowflake.snowpark_checkpoints_collector.summary_stats_collector import (
+    collect_dataframe_checkpoint,
+)

snowpark_checkpoints_collectors-0.2.1/src/snowflake/snowpark_checkpoints_collector/__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_collectors-0.2.0rc1 → snowpark_checkpoints_collectors-0.2.1}/src/snowflake/snowpark_checkpoints_collector/collection_common.py

@@ -1,6 +1,17 @@
-#
-# Copyright (c) 2012-2024 Snowflake Computing Inc. All rights reserved.
-#
+# 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 locale
 
@@ -81,11 +92,13 @@ COLUMN_IS_UNIQUE_SIZE_KEY = "is_unique_size"
 COLUMN_KEY_TYPE_KEY = "key_type"
 COLUMN_MARGIN_ERROR_KEY = "margin_error"
 COLUMN_MAX_KEY = "max"
+COLUMN_MAX_LENGTH_KEY = "max_length"
 COLUMN_MAX_SIZE_KEY = "max_size"
 COLUMN_MEAN_KEY = "mean"
 COLUMN_MEAN_SIZE_KEY = "mean_size"
 COLUMN_METADATA_KEY = "metadata"
 COLUMN_MIN_KEY = "min"
+COLUMN_MIN_LENGTH_KEY = "min_length"
 COLUMN_MIN_SIZE_KEY = "min_size"
 COLUMN_NAME_KEY = "name"
 COLUMN_NULL_COUNT_KEY = "null_count"
@@ -95,6 +108,7 @@ COLUMN_ROWS_NULL_COUNT_KEY = "rows_null_count"
 COLUMN_SIZE_KEY = "size"
 COLUMN_TRUE_COUNT_KEY = "true_count"
 COLUMN_TYPE_KEY = "type"
+COLUMN_VALUE_KEY = "value"
 COLUMN_VALUE_TYPE_KEY = "value_type"
 COLUMNS_KEY = "columns"
 
@@ -126,6 +140,8 @@ UNKNOWN_SOURCE_FILE = "unknown"
 UNKNOWN_LINE_OF_CODE = -1
 BACKSLASH_TOKEN = "\\"
 SLASH_TOKEN = "/"
+PYSPARK_NONE_SIZE_VALUE = -1
+PANDAS_LONG_TYPE = "Int64"
 
 # ENVIRONMENT VARIABLES
 SNOWFLAKE_CHECKPOINT_CONTRACT_FILE_PATH_ENV_VAR = (

snowpark_checkpoints_collectors-0.2.1/src/snowflake/snowpark_checkpoints_collector/collection_result/model/__init__.py

@@ -0,0 +1,24 @@
+# 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__ = ["CollectionPointResult", "CollectionResult", "CollectionPointResultManager"]
+
+from snowflake.snowpark_checkpoints_collector.collection_result.model.collection_point_result import (
+    CollectionPointResult,
+    CollectionResult,
+)
+from snowflake.snowpark_checkpoints_collector.collection_result.model.collection_point_result_manager import (
+    CollectionPointResultManager,
+)

{snowpark_checkpoints_collectors-0.2.0rc1 → snowpark_checkpoints_collectors-0.2.1}/src/snowflake/snowpark_checkpoints_collector/collection_result/model/collection_point_result.py

@@ -1,6 +1,17 @@
-#
-# Copyright (c) 2012-2024 Snowflake Computing Inc. All rights reserved.
-#
+# 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 datetime import datetime
 from enum import Enum
 

{snowpark_checkpoints_collectors-0.2.0rc1 → snowpark_checkpoints_collectors-0.2.1}/src/snowflake/snowpark_checkpoints_collector/collection_result/model/collection_point_result_manager.py

@@ -1,7 +1,20 @@
-#
-# Copyright (c) 2012-2024 Snowflake Computing Inc. All rights reserved.
-#
+# 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 json
+import logging
 
 from typing import Optional
 
@@ -13,6 +26,7 @@ from snowflake.snowpark_checkpoints_collector.utils import file_utils
 
 
 RESULTS_KEY = "results"
+LOGGER = logging.getLogger(__name__)
 
 
 class CollectionPointResultManager(metaclass=Singleton):
@@ -38,6 +52,7 @@ class CollectionPointResultManager(metaclass=Singleton):
 
         """
         result_json = result.get_collection_result_data()
+        LOGGER.debug("Adding a new collection result: %s", result_json)
         self.result_collection.append(result_json)
         self._save_result()
 
@@ -54,5 +69,6 @@ class CollectionPointResultManager(metaclass=Singleton):
 
     def _save_result(self) -> None:
         result_collection_json = self.to_json()
+        LOGGER.info("Saving collection results to '%s'", self.output_file_path)
         with open(self.output_file_path, "w") as f:
             f.write(result_collection_json)

snowpark_checkpoints_collectors-0.2.1/src/snowflake/snowpark_checkpoints_collector/column_collection/__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.
+
+__all__ = [
+    "ColumnCollectorManager",
+]
+
+from snowflake.snowpark_checkpoints_collector.column_collection.column_collector_manager import (
+    ColumnCollectorManager,
+)