snowpark-checkpoints-validators 0.2.0rc1__tar.gz → 0.3.0__tar.gz

{snowpark_checkpoints_validators-0.2.0rc1 → snowpark_checkpoints_validators-0.3.0}/.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_validators-0.3.0/PKG-INFO

@@ -0,0 +1,325 @@
+Metadata-Version: 2.4
+Name: snowpark-checkpoints-validators
+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/
+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: pydantic>=2.0
+Requires-Dist: snowflake-connector-python[pandas]
+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: deepdiff==8.1.1; 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-validators
+
+---
+##### This package is on Public Preview.
+---
+
+**snowpark-checkpoints-validators** is a package designed to validate Snowpark DataFrames against predefined schemas and checkpoints. This package ensures data integrity and consistency by performing schema and data validation checks at various stages of a Snowpark pipeline.
+
+---
+## Install the library
+```bash
+pip install snowpark-checkpoints-validators
+```
+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-validators[pyspark]"
+```
+---
+
+## Features
+
+- Validate Snowpark DataFrames against predefined Pandera schemas.
+- Perform custom checks and skip specific checks as needed.
+- Generate validation results and log them for further analysis.
+- Support for sampling strategies to validate large datasets efficiently.
+- Integration with PySpark for cross-validation between Snowpark and PySpark DataFrames.
+
+## Functionalities
+
+### Validate DataFrame Schema from File
+
+The `validate_dataframe_checkpoint` function validates a Snowpark DataFrame against a checkpoint schema file or dataframe.
+
+```python
+from snowflake.snowpark import DataFrame as SnowparkDataFrame
+from snowflake.snowpark_checkpoints.job_context import SnowparkJobContext
+from snowflake.snowpark_checkpoints.utils.constant import (
+    CheckpointMode,
+)
+from snowflake.snowpark_checkpoints.spark_migration import SamplingStrategy
+from typing import Any, Optional
+
+# Signature of the function
+def validate_dataframe_checkpoint(
+    df: SnowparkDataFrame,
+    checkpoint_name: str,
+    job_context: Optional[SnowparkJobContext] = None,
+    mode: Optional[CheckpointMode] = CheckpointMode.SCHEMA,
+    custom_checks: Optional[dict[Any, Any]] = None,
+    skip_checks: Optional[dict[Any, Any]] = None,
+    sample_frac: Optional[float] = 1.0,
+    sample_number: Optional[int] = None,
+    sampling_strategy: Optional[SamplingStrategy] = SamplingStrategy.RANDOM_SAMPLE,
+    output_path: Optional[str] = None,
+):
+...
+```
+
+- `df`: Snowpark dataframe to validate.
+- `checkpoint_name`: Name of the checkpoint schema file or dataframe.
+- `job_context`: Snowpark job context.
+- `mode`: Checkpoint mode (schema or data).
+- `custom_checks`: Custom checks to perform.
+- `skip_checks`: Checks to skip.
+- `sample_frac`: Fraction of the dataframe to sample.
+- `sample_number`: Number of rows to sample.
+- `sampling_strategy`: Sampling strategy to use.
+- `output_path`: Output path for the checkpoint report.
+
+### Usage Example
+
+```python
+from snowflake.snowpark import Session
+from snowflake.snowpark_checkpoints.utils.constant import (
+    CheckpointMode,
+)
+from snowflake.snowpark_checkpoints.checkpoint import validate_dataframe_checkpoint
+from snowflake.snowpark_checkpoints.spark_migration import SamplingStrategy
+from snowflake.snowpark_checkpoints.job_context import SnowparkJobContext
+from pyspark.sql import SparkSession
+
+session = Session.builder.getOrCreate()
+job_context = SnowparkJobContext(
+    session, SparkSession.builder.getOrCreate(), "job_context", True
+)
+df = session.read.format("csv").load("data.csv")
+
+validate_dataframe_checkpoint(
+    df,
+    "schema_checkpoint",
+    job_context=job_context,
+    mode=CheckpointMode.SCHEMA,
+    sample_frac=0.1,
+    sampling_strategy=SamplingStrategy.RANDOM_SAMPLE
+)
+```
+
+### Check with Spark Decorator
+
+The `check_with_spark` decorator converts any Snowpark dataframe arguments to a function, samples them, and converts them to PySpark dataframe. It then executes a provided Spark function and compares the outputs between the two implementations.
+
+```python
+from snowflake.snowpark_checkpoints.job_context import SnowparkJobContext
+from snowflake.snowpark_checkpoints.spark_migration import SamplingStrategy
+from typing import Callable, Optional, TypeVar
+
+fn = TypeVar("F", bound=Callable)
+
+# Signature of the decorator
+def check_with_spark(
+    job_context: Optional[SnowparkJobContext],
+    spark_function: fn,
+    checkpoint_name: str,
+    sample_number: Optional[int] = 100,
+    sampling_strategy: Optional[SamplingStrategy] = SamplingStrategy.RANDOM_SAMPLE,
+    output_path: Optional[str] = None,
+) -> Callable[[fn], fn]:
+    ...
+```
+
+- `job_context`: Snowpark job context.
+- `spark_function`: PySpark function to execute.
+- `checkpoint_name`: Name of the check.
+- `sample_number`: Number of rows to sample.
+- `sampling_strategy`: Sampling strategy to use.
+- `output_path`: Output path for the checkpoint report.
+
+### Usage Example
+
+```python
+from snowflake.snowpark import Session
+from snowflake.snowpark import DataFrame as SnowparkDataFrame
+from snowflake.snowpark_checkpoints.spark_migration import check_with_spark
+from snowflake.snowpark_checkpoints.job_context import SnowparkJobContext
+from pyspark.sql import DataFrame as SparkDataFrame, SparkSession
+
+session = Session.builder.getOrCreate()
+job_context = SnowparkJobContext(
+    session, SparkSession.builder.getOrCreate(), "job_context", True
+)
+
+def my_spark_scalar_fn(df: SparkDataFrame):
+    return df.count()
+
+@check_with_spark(
+    job_context=job_context,
+    spark_function=my_spark_scalar_fn,
+    checkpoint_name="count_checkpoint",
+)
+def my_snowpark_scalar_fn(df: SnowparkDataFrame):
+    return df.count()
+
+df = job_context.snowpark_session.create_dataframe(
+    [[1, 2], [3, 4]], schema=["a", "b"]
+)
+count = my_snowpark_scalar_fn(df)
+```
+
+### Pandera Snowpark Decorators
+
+The decorators `@check_input_schema` and `@check_output_schema` allow for sampled schema validation of Snowpark dataframes in the input arguments or in the return value.
+
+```python
+from snowflake.snowpark_checkpoints.spark_migration import SamplingStrategy
+from snowflake.snowpark_checkpoints.job_context import SnowparkJobContext
+from pandera import DataFrameSchema
+from typing import Optional
+
+# Signature of the decorator
+def check_input_schema(
+    pandera_schema: DataFrameSchema,
+    checkpoint_name: str,
+    sample_frac: Optional[float] = 1.0,
+    sample_number: Optional[int] = None,
+    sampling_strategy: Optional[SamplingStrategy] = SamplingStrategy.RANDOM_SAMPLE,
+    job_context: Optional[SnowparkJobContext] = None,
+    output_path: Optional[str] = None,
+):
+    ...
+
+# Signature of the decorator
+def check_output_schema(
+    pandera_schema: DataFrameSchema,
+    checkpoint_name: str,
+    sample_frac: Optional[float] = 1.0,
+    sample_number: Optional[int] = None,
+    sampling_strategy: Optional[SamplingStrategy] = SamplingStrategy.RANDOM_SAMPLE,
+    job_context: Optional[SnowparkJobContext] = None,
+    output_path: Optional[str] = None,
+):
+    ...
+```
+
+- `pandera_schema`: Pandera schema to validate.
+- `checkpoint_name`: Name of the checkpoint schema file or DataFrame.
+- `sample_frac`: Fraction of the DataFrame to sample.
+- `sample_number`: Number of rows to sample.
+- `sampling_strategy`: Sampling strategy to use.
+- `job_context`: Snowpark job context.
+- `output_path`: Output path for the checkpoint report.
+
+### Usage Example
+
+#### Check Input Schema Example
+```python
+from pandas import DataFrame as PandasDataFrame
+from pandera import DataFrameSchema, Column, Check
+from snowflake.snowpark import Session
+from snowflake.snowpark import DataFrame as SnowparkDataFrame
+from snowflake.snowpark_checkpoints.checkpoint import check_input_schema
+from numpy import int8
+
+df = PandasDataFrame(
+    {
+        "COLUMN1": [1, 4, 0, 10, 9],
+        "COLUMN2": [-1.3, -1.4, -2.9, -10.1, -20.4],
+    }
+)
+
+in_schema = DataFrameSchema(
+    {
+        "COLUMN1": Column(int8, Check(lambda x: 0 <= x <= 10, element_wise=True)),
+        "COLUMN2": Column(float, Check(lambda x: x < -1.2, element_wise=True)),
+    }
+)
+
+@check_input_schema(in_schema, "input_schema_checkpoint")
+def preprocessor(dataframe: SnowparkDataFrame):
+    dataframe = dataframe.withColumn(
+        "COLUMN3", dataframe["COLUMN1"] + dataframe["COLUMN2"]
+    )
+    return dataframe
+
+session = Session.builder.getOrCreate()
+sp_dataframe = session.create_dataframe(df)
+
+preprocessed_dataframe = preprocessor(sp_dataframe)
+```
+
+#### Check Input Schema Example
+```python
+from pandas import DataFrame as PandasDataFrame
+from pandera import DataFrameSchema, Column, Check
+from snowflake.snowpark import Session
+from snowflake.snowpark import DataFrame as SnowparkDataFrame
+from snowflake.snowpark_checkpoints.checkpoint import check_output_schema
+from numpy import int8
+
+df = PandasDataFrame(
+    {
+        "COLUMN1": [1, 4, 0, 10, 9],
+        "COLUMN2": [-1.3, -1.4, -2.9, -10.1, -20.4],
+    }
+)
+
+out_schema = DataFrameSchema(
+    {
+        "COLUMN1": Column(int8, Check.between(0, 10, include_max=True, include_min=True)),
+        "COLUMN2": Column(float, Check.less_than_or_equal_to(-1.2)),
+        "COLUMN3": Column(float, Check.less_than(10)),
+    }
+)
+
+@check_output_schema(out_schema, "output_schema_checkpoint")
+def preprocessor(dataframe: SnowparkDataFrame):
+    return dataframe.with_column(
+        "COLUMN3", dataframe["COLUMN1"] + dataframe["COLUMN2"]
+    )
+
+session = Session.builder.getOrCreate()
+sp_dataframe = session.create_dataframe(df)
+
+preprocessed_dataframe = preprocessor(sp_dataframe)
+```
+
+------

{snowpark_checkpoints_validators-0.2.0rc1 → snowpark_checkpoints_validators-0.3.0}/README.md

@@ -1,14 +1,22 @@
 # snowpark-checkpoints-validators
 
 ---
-**NOTE**
-
-This package is on Private Preview.
-
+##### This package is on Public Preview.
 ---
 
 **snowpark-checkpoints-validators** is a package designed to validate Snowpark DataFrames against predefined schemas and checkpoints. This package ensures data integrity and consistency by performing schema and data validation checks at various stages of a Snowpark pipeline.
 
+---
+## Install the library
+```bash
+pip install snowpark-checkpoints-validators
+```
+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-validators[pyspark]"
+```
+---
+
 ## Features
 
 - Validate Snowpark DataFrames against predefined Pandera schemas.

{snowpark_checkpoints_validators-0.2.0rc1 → snowpark_checkpoints_validators-0.3.0}/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,13 +26,13 @@ classifiers = [
   "Topic :: Scientific/Engineering :: Information Analysis",
 ]
 dependencies = [
-  "snowflake-snowpark-python",
-  "snowflake-connector-python",
-  "pyspark",
+  "snowflake-snowpark-python>=1.23.0",
+  "snowflake-connector-python[pandas]",
   "pandera[io]==0.20.4",
-  "pandera-report==0.1.2",
+  "pydantic>=2.0"
 ]
 description = "Migration tools for Snowpark"
+dynamic = ['version']
 keywords = [
   'Snowflake',
   'analytics',
@@ -39,14 +41,17 @@ keywords = [
   'db',
   'Snowpark',
 ]
-license = {file = "LICENSE"}
+license = {text = "Apache License, Version 2.0"}
 name = "snowpark-checkpoints-validators"
 readme = "README.md"
 requires-python = '>=3.9,<3.12'
-dynamic = ['version']
 
 [project.optional-dependencies]
+pyspark = [
+  "pyspark>=3.5.0",
+]
 development = [
+  "deepdiff==8.1.1",
   "pytest>=8.3.3",
   "pytest-cov>=6.0.0",
   "coverage>=7.6.7",
@@ -56,6 +61,8 @@ development = [
   "setuptools>=70.0.0",
   "pyarrow>=18.0.0",
   "deepdiff>=8.0.0",
+  "pyspark>=3.5.0",
+  "certifi==2025.1.31",
 ]
 
 [project.urls]
@@ -63,7 +70,7 @@ development = [
 "Source code" = "https://github.com/snowflakedb/snowpark-checkpoints/"
 
 [tool.hatch.version]
-path = "__version__.py"
+path = "src/snowflake/snowpark_checkpoints/__version__.py"
 pattern = '^__version__ = "(?P<version>.*)"'
 source = "regex"
 
@@ -75,15 +82,22 @@ where = ["src/"]
 dev-mode-dirs = ['src']
 directory = 'snowpark-checkpoints-validators'
 
+[[tool.hatch.sources]]
+dir = "src/snowflake/snowpark_checkpoints"
+name = "snowpark-checkpoints-validators"
+type = "package"
+
 [tool.hatch.build.targets.wheel]
 directory = "dist"
-packages = ["snowpark-checkpoints-validators/src/snowflake/snowpark_checkpoints"]
+packages = [
+  "src/snowflake",
+]
 
 [tool.hatch.build.targets.sdist]
 directory = "dist"
 exclude = ["/.github", "/.idea"]
 include = [
-  'src/',
+  'src/**',
   'README.md',
   'LICENSE',
   'test/',
@@ -118,8 +132,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_validators-0.3.0/src/snowflake/snowpark_checkpoints/__init__.py

@@ -0,0 +1,44 @@
+# 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.checkpoint import (
+    check_dataframe_schema,
+    check_input_schema,
+    check_output_schema,
+    validate_dataframe_checkpoint,
+)
+from snowflake.snowpark_checkpoints.job_context import SnowparkJobContext
+from snowflake.snowpark_checkpoints.spark_migration import check_with_spark
+from snowflake.snowpark_checkpoints.utils.constants import CheckpointMode
+
+
+__all__ = [
+    "check_with_spark",
+    "SnowparkJobContext",
+    "check_dataframe_schema",
+    "check_output_schema",
+    "check_input_schema",
+    "validate_dataframe_checkpoint",
+    "CheckpointMode",
+]

snowpark_checkpoints_validators-0.3.0/src/snowflake/snowpark_checkpoints/__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.3.0"