snowpark-checkpoints-validators 0.2.0rc1__py3-none-any.whl → 0.3.0__py3-none-any.whl

snowpark_checkpoints_validators-0.3.0.dist-info/METADATA

@@ -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.3.0.dist-info/RECORD

@@ -0,0 +1,26 @@
+snowflake/snowpark_checkpoints/__init__.py,sha256=p7fzH3f8foD5nhNJHZ00JT3ODTXJGGkWTd3xRKx-8aQ,1435
+snowflake/snowpark_checkpoints/__version__.py,sha256=kbbDnlkY7JOLNHvfWYkCO_mOBOV9GniMGdxYoQpLhyg,632
+snowflake/snowpark_checkpoints/checkpoint.py,sha256=i-iDRYbGvQHy9ipW7UxHVhJhQ9BXNSO-bsCcHyg3oLA,22056
+snowflake/snowpark_checkpoints/errors.py,sha256=9KjzRf8bjDZTTNL4LeySJAwuucDOyz0Ka7EFBKWFpyg,1821
+snowflake/snowpark_checkpoints/job_context.py,sha256=RMK0g0HrbDVrOAvai4PgsGvsAn_GIo9aFmh-tWlyieY,4183
+snowflake/snowpark_checkpoints/singleton.py,sha256=7AgIHQBXVRvPBBCkmBplzkdrrm-xVWf_N8svzA2vF8E,836
+snowflake/snowpark_checkpoints/snowpark_sampler.py,sha256=Qxv-8nRGuf-ab3GoSUt8_MNL0ppjoBIMOFIMkqmwN5I,4668
+snowflake/snowpark_checkpoints/spark_migration.py,sha256=s2HqomYx76Hqn71g9TleBeHI3t1nirgfPvkggqQQdts,10253
+snowflake/snowpark_checkpoints/validation_result_metadata.py,sha256=5C8f1g-Grs2ydpXiZBLGt5n9cvEHBaw2-CDeb2vnhpg,5847
+snowflake/snowpark_checkpoints/validation_results.py,sha256=J8OcpNty6hQD8RbAy8xmA0UMbPWfXSmQnHYspWWSisk,1502
+snowflake/snowpark_checkpoints/io_utils/__init__.py,sha256=fmSEYcBGNASBanNvMVW-uv6hcoYre6kEH35K-RliuiA,954
+snowflake/snowpark_checkpoints/io_utils/io_default_strategy.py,sha256=VMfdqj4uDgTEinmpC3D0zXncIB9FxWJod1rI-Yt3YVA,1869
+snowflake/snowpark_checkpoints/io_utils/io_env_strategy.py,sha256=ltG_rxm0CkJFXpskOf__ByZw-C6B9LtycqlyB9EmaJI,3569
+snowflake/snowpark_checkpoints/io_utils/io_file_manager.py,sha256=YHrxRBzTlhIUrSFrsoWkRY_Qa-TXgDWglr00T98Tc5g,2485
+snowflake/snowpark_checkpoints/utils/__init__.py,sha256=I4srmZ8G1q9DU6Suo1S91aVfNvETyisKH95uvLAvEJ0,609
+snowflake/snowpark_checkpoints/utils/constants.py,sha256=pgFttLDQ6fTa6obSdvivWBYClS21ap41YVDNGAS4sxY,4146
+snowflake/snowpark_checkpoints/utils/extra_config.py,sha256=xOYaG6MfsUCAHI0C_7qWF_m96xcLIZWwrgxY4UlpaZI,4325
+snowflake/snowpark_checkpoints/utils/logging_utils.py,sha256=yyi6X5DqKeTg0HRhvsH6ymYp2P0wbnyKIzI2RzrQS7k,2278
+snowflake/snowpark_checkpoints/utils/pandera_check_manager.py,sha256=tQIozLO-2kM8WZ-gGKfRwmXBx1cDPaIZB0qIcArp8xA,16100
+snowflake/snowpark_checkpoints/utils/supported_types.py,sha256=GrMX2tHdSFnK7LlPbZx20UufD6Br6TNVRkkBwIxdPy0,1433
+snowflake/snowpark_checkpoints/utils/telemetry.py,sha256=GfuyIaI3QG4a4_qWwyJHvWRM0GENunNexuEJ6IgscF4,32684
+snowflake/snowpark_checkpoints/utils/utils_checks.py,sha256=oQ1c4n-uAA2kFIpWIRPWhbCW8e-wwOIL8qDqLvr5Fok,14398
+snowpark_checkpoints_validators-0.3.0.dist-info/METADATA,sha256=RbOlEHK5kumiBPP2S7-7k7zxzzLYag7Yb6TtQeOYbV0,11557
+snowpark_checkpoints_validators-0.3.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+snowpark_checkpoints_validators-0.3.0.dist-info/licenses/LICENSE,sha256=pmjhbh6uVhV5MBXOlou_UZgFP7CYVQITkCCdvfcS5lY,11340
+snowpark_checkpoints_validators-0.3.0.dist-info/RECORD,,