sparkenforce 0.1.0__py3-none-any.whl

sparkenforce/__init__.py

@@ -0,0 +1,450 @@
+"""
+sparkenforce: Type validation for PySpark DataFrames.
+
+This module provides a Dataset type annotation system that allows you to specify
+and validate the schema of PySpark DataFrames using Python type hints for both
+function arguments and return values.
+
+Example:
+    @validate
+    def process_data(df: Dataset["id": int, "name": str, "age": int]) -> Dataset["result": str]:
+        # Function will validate that df has the required columns and types
+        # Return value will also be validated against the specified schema
+        return spark.createDataFrame([("processed",)], ["result"])
+
+Apache Software License 2.0
+
+Copyright (c) 2025, Agustín Recoba
+
+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 datetime
+import decimal
+import inspect
+from functools import wraps
+from typing import Any, Dict, Set, Tuple, Type, TypeVar, get_type_hints
+
+from pyspark.sql import DataFrame
+from pyspark.sql import types as spark_types
+
+__all__ = ["Dataset", "DatasetValidationError", "validate"]
+
+
+class DatasetValidationError(TypeError):
+    """Raised when DataFrame validation fails."""
+
+
+T = TypeVar("T", bound=callable)
+
+
+def validate(func: T) -> T:
+    """
+    Decorator that validates function arguments and return values annotated with Dataset types.
+
+    Args:
+        func: Function to decorate with validation
+
+    Returns:
+        Wrapped function with validation logic
+
+    Raises:
+        DatasetValidationError: When validation fails
+
+    Example:
+        @validate
+        def process(data: Dataset["id", "name"]) -> Dataset["result": str]:
+            return spark.createDataFrame([("success",)], ["result"])
+    """
+    signature = inspect.signature(func)
+    hints = get_type_hints(func)
+
+    @wraps(func)
+    def wrapper(*args, **kwargs):
+        bound = signature.bind(*args, **kwargs)
+
+        # Validate input arguments
+        for argument_name, value in bound.arguments.items():
+            if argument_name in hints and isinstance(
+                hints[argument_name],
+                _DatasetMeta,
+            ):
+                hint = hints[argument_name]
+                _validate_dataframe(value, hint, argument_name)
+
+        # Execute the function
+        result = func(*args, **kwargs)
+
+        # Validate return value if annotated with Dataset type
+        return_annotation = hints.get("return")
+        if return_annotation is not None and isinstance(
+            return_annotation,
+            _DatasetMeta,
+        ):
+            _validate_dataframe(result, return_annotation, "return value")
+
+        return result
+
+    return wrapper
+
+
+def _validate_dataframe(
+    value: object, hint: "_DatasetMeta", argument_name: str
+) -> None:
+    """
+    Validate a single DataFrame against a Dataset hint.
+
+    Args:
+        value: Value to validate
+        hint: Dataset metadata with validation rules
+        argument_name: Name of the argument being validated
+
+    Raises:
+        DatasetValidationError: When validation fails
+    """
+    if not isinstance(value, DataFrame):
+        raise DatasetValidationError(
+            f"{argument_name} must be a PySpark DataFrame, got {type(value)}"
+        )
+
+    columns = set(value.columns)
+
+    # Check column presence
+    if hint.only_specified and columns != hint.columns:
+        missing = hint.columns - columns
+        extra = columns - hint.columns
+        msg_parts = []
+        if missing:
+            msg_parts.append(f"missing columns: {missing}")
+        if extra:
+            msg_parts.append(f"unexpected columns: {extra}")
+        raise DatasetValidationError(
+            f"{argument_name} columns mismatch. Expected exactly {hint.columns}, "
+            f"got {columns}. {', '.join(msg_parts)}"
+        )
+
+    if not hint.only_specified and not hint.columns.issubset(columns):
+        missing = hint.columns - columns
+        raise DatasetValidationError(
+            f"{argument_name} is missing required columns: {missing}"
+        )
+
+    # Check data types
+    if hint.dtypes:
+        _validate_dtypes(value, hint.dtypes, argument_name)
+
+
+def _validate_dtypes(
+    df: DataFrame,
+    expected_dtypes: Dict[str, Any],
+    argument_name: str,
+) -> None:
+    """
+    Validate DataFrame column types.
+
+    Args:
+        df: DataFrame to validate
+        expected_dtypes: Expected column types
+        argument_name: Name of the argument being validated
+
+    Raises:
+        DatasetValidationError: When type validation fails
+    """
+    actual_dtypes = dict(df.dtypes)
+
+    for col_name, expected_type in expected_dtypes.items():
+        if col_name not in actual_dtypes:
+            continue  # Column presence already validated
+
+        actual_type_str = actual_dtypes[col_name]
+        actual_spark_type = spark_types.DataType.fromDDL(actual_type_str)
+
+        # Convert expected type to Spark type
+        expected_spark_type = _convert_to_spark_type(expected_type)
+
+        if not _types_compatible(actual_spark_type, expected_spark_type):
+            raise DatasetValidationError(
+                f"{argument_name} column '{col_name}' has incorrect type. "
+                f"Expected {expected_type}, got {type(actual_spark_type).__name__}"
+            )
+
+
+def _convert_to_spark_type(python_type: Any) -> Type[spark_types.DataType]:
+    """
+    Convert Python type to Spark DataType.
+
+    Args:
+        python_type: Python type to convert
+
+    Returns:
+        Corresponding Spark DataType class
+
+    Raises:
+        TypeError: When python_type is not a supported type
+    """
+    if isinstance(python_type, type) and issubclass(python_type, spark_types.DataType):
+        return python_type
+
+    if python_type in spark_types._type_mappings:
+        return spark_types._type_mappings[python_type]
+
+    # Explicit mapping for common types
+    type_mapping = {
+        type(None): spark_types.NullType,
+        bool: spark_types.BooleanType,
+        int: spark_types.LongType,
+        float: spark_types.DoubleType,
+        str: spark_types.StringType,
+        bytearray: spark_types.BinaryType,
+        decimal.Decimal: spark_types.DecimalType,
+        datetime.date: spark_types.DateType,
+        datetime.datetime: spark_types.TimestampType,
+        datetime.time: spark_types.TimestampType,
+    }
+
+    if python_type in type_mapping:
+        return type_mapping[python_type]
+
+    # Raise error for unsupported types instead of silent fallback
+    supported_types = list(type_mapping.keys())
+    raise TypeError(
+        f"Unsupported type for Dataset column validation: {python_type}. "
+        f"Supported types are: {', '.join(str(t) for t in supported_types)} "
+        f"or any subclass of pyspark.sql.types.DataType"
+    )
+
+
+def _types_compatible(
+    actual: spark_types.DataType, expected: Type[spark_types.DataType]
+) -> bool:
+    """
+    Check if actual Spark type is compatible with expected type.
+
+    Args:
+        actual: Actual Spark DataType instance
+        expected: Expected Spark DataType class
+
+    Returns:
+        True if types are compatible
+    """
+    # Direct type match
+    if isinstance(actual, expected):
+        return True
+
+    # Define compatible type groups for more flexible validation
+    integer_types = (
+        spark_types.IntegerType,
+        spark_types.LongType,
+        spark_types.ShortType,
+        spark_types.ByteType,
+    )
+    float_types = (spark_types.FloatType, spark_types.DoubleType)
+    string_types = (spark_types.StringType,)
+    timestamp_types = (spark_types.TimestampType, spark_types.DateType)
+
+    # Check if actual and expected types are in the same compatibility group
+    compatibility_groups = [integer_types, float_types, string_types, timestamp_types]
+
+    return any(
+        isinstance(actual, group) and expected in group
+        for group in compatibility_groups
+    )
+
+
+def _get_columns_dtypes(parameters: Any) -> Tuple[Set[str], Dict[str, Any]]:
+    """
+    Extract column names and types from Dataset parameters.
+
+    Args:
+        parameters: Dataset parameters to parse
+
+    Returns:
+        Tuple of (column_names, column_types)
+
+    Raises:
+        TypeError: When parameters are invalid or types are unsupported
+    """
+    columns: Set[str] = set()
+    dtypes: Dict[str, Any] = {}
+
+    if isinstance(parameters, str):
+        columns.add(parameters)
+    elif isinstance(parameters, slice):
+        if not isinstance(parameters.start, str):
+            raise TypeError("Column name must be a string")
+        columns.add(parameters.start)
+        if parameters.stop is not None:
+            # Validate the type early to catch unsupported types
+            try:
+                _convert_to_spark_type(parameters.stop)
+            except TypeError as e:
+                # Re-raise with more context about where the error occurred
+                raise TypeError(
+                    f"Invalid type for column '{parameters.start}': {str(e)}"
+                ) from e
+            dtypes[parameters.start] = parameters.stop
+    elif isinstance(parameters, (list, tuple, set)):
+        for element in parameters:
+            sub_columns, sub_dtypes = _get_columns_dtypes(element)
+            columns.update(sub_columns)
+            dtypes.update(sub_dtypes)
+    elif isinstance(parameters, _DatasetMeta):
+        columns.update(parameters.columns)
+        dtypes.update(parameters.dtypes)
+    else:
+        raise TypeError(
+            f"Dataset parameters must be strings, slices, lists, or DatasetMeta instances. "
+            f"Got {type(parameters)}"
+        )
+
+    return columns, dtypes
+
+
+class _DatasetMeta(type):
+    """
+    Metaclass for Dataset type annotations.
+
+    This metaclass handles the creation of Dataset types with column and type specifications.
+    """
+
+    only_specified: bool
+    columns: Set[str]
+    dtypes: Dict[str, Any]
+
+    def __getitem__(cls, parameters: object) -> "_DatasetMeta":
+        """
+        Create a Dataset type with specified columns and types.
+
+        Args:
+            parameters: Column specifications (strings, slices, lists, etc.)
+
+        Returns:
+            New DatasetMeta instance with validation rules
+
+        Example:
+            Dataset["id", "name"]  # Exact columns
+            Dataset["id": int, "name": str]  # With types
+            Dataset["id", "name", ...]  # Minimum columns
+        """
+        if not isinstance(parameters, tuple):
+            parameters = (parameters,)
+
+        parameters = list(parameters)
+
+        # Check for ellipsis (indicates minimum columns, not exact match)
+        only_specified = True
+        if parameters and parameters[-1] is Ellipsis:
+            only_specified = False
+            parameters.pop()
+
+        columns, dtypes = _get_columns_dtypes(parameters)
+
+        # Create new metaclass instance
+        meta = _DatasetMeta(
+            cls.__name__,
+            cls.__bases__ if hasattr(cls, "__bases__") else (),
+            {},
+        )
+        meta.only_specified = only_specified
+        meta.columns = columns
+        meta.dtypes = dtypes
+
+        return meta
+
+    def __repr__(cls) -> str:
+        """String representation of Dataset type."""
+        if hasattr(cls, "dtypes") and cls.dtypes:
+            type_strs = [
+                f"{col}: {dt.__name__ if hasattr(dt, '__name__') else str(dt)}"
+                for col, dt in cls.dtypes.items()
+            ]
+            return f"Dataset[{', '.join(type_strs)}]"
+
+        if hasattr(cls, "columns") and cls.columns:
+            return f"Dataset[{', '.join(sorted(cls.columns))}]"
+
+        return "Dataset"
+
+
+class Dataset(DataFrame, metaclass=_DatasetMeta):
+    """
+    Type annotation for PySpark DataFrames with schema validation.
+
+    Dataset cannot be instantiated directly. It serves as a type annotation
+    to specify the expected schema of DataFrames passed to functions and
+    returned from functions.
+
+    Examples:
+        Dataset["id", "name"]  # Exact columns required
+        Dataset["id": int, "name": str]  # With type checking
+        Dataset["id", "name", ...]  # Minimum columns (can have more)
+        Dataset[...]  # Any DataFrame
+
+    Usage:
+        @validate
+        def process_users(users: Dataset["id": int, "name": str]) -> Dataset["result": str]:
+            # users is guaranteed to have 'id' (int) and 'name' (str) columns
+            # return value will be validated to have 'result' (str) column
+            return spark.createDataFrame([("success",)], ["result"])
+    """
+
+    __slots__ = ()
+
+    def __new__(cls, *args, **kwargs):
+        """Prevent direct instantiation."""
+        raise TypeError(
+            "Dataset cannot be instantiated directly. "
+            "Use spark.createDataFrame() to create DataFrames, "
+            "and use Dataset[...] for type annotations only."
+        )
+
+
+def infer_dataset_type(df: DataFrame) -> str:
+    """
+    Infer a Dataset[...] annotation string from a PySpark DataFrame's schema.
+
+    Args:
+        df: The PySpark DataFrame to inspect.
+
+    Returns:
+        A string representing the Dataset annotation, e.g.:
+        'Dataset["id": int, "name": str]'
+    """
+    spark_to_py = {
+        spark_types.StringType: str,
+        spark_types.BooleanType: bool,
+        spark_types.ByteType: int,
+        spark_types.ShortType: int,
+        spark_types.IntegerType: int,
+        spark_types.LongType: int,
+        spark_types.FloatType: float,
+        spark_types.DoubleType: float,
+        spark_types.DecimalType: decimal.Decimal,
+        spark_types.DateType: datetime.date,
+        spark_types.TimestampType: datetime.datetime,
+        spark_types.BinaryType: bytearray,
+        spark_types.NullType: type(None),
+    }
+    fields = []
+    for field in df.schema.fields:
+        py_type = None
+        for spark_type, candidate_py in spark_to_py.items():
+            if isinstance(field.dataType, spark_type):
+                py_type = candidate_py
+                break
+        if py_type is None:
+            py_type = type(field.dataType)  # fallback to Spark type class
+        fields.append(
+            f'"{field.name}": {py_type.__name__ if hasattr(py_type, "__name__") else str(py_type)}',
+        )
+    return f'Dataset[{", ".join(fields)}]'

sparkenforce-0.1.0.dist-info/METADATA

@@ -0,0 +1,382 @@
+Metadata-Version: 2.4
+Name: sparkenforce
+Version: 0.1.0
+Summary: Type annotation system that allows you to specify and validate the schema of PySpark DataFrames using Python type hints for both function arguments and return values.
+Project-URL: homepage, https://github.com/agustin-recoba/sparkenforce
+Project-URL: repository, https://github.com/agustin-recoba/sparkenforce.git
+Project-URL: documentation, https://github.com/agustin-recoba/sparkenforce
+Project-URL: issues, https://github.com/agustin-recoba/sparkenforce/issues
+Author-email: Agustín Recoba <agustin.recoba@outlook.com>
+License: Apache Software License 2.0
+        
+        Copyright (c) 2025, Agustín Recoba
+        
+        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.
+        
+        
+        Original License, part of the original proyect "dataenforce" (`https://github.com/CedricFR/dataenforce`)
+        
+        Apache License
+        Version 2.0, January 2004
+        http://www.apache.org/licenses/
+        
+        TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+        
+        1. Definitions.
+        
+        "License" shall mean the terms and conditions for use, reproduction,
+        and distribution as defined by Sections 1 through 9 of this document.
+        
+        "Licensor" shall mean the copyright owner or entity authorized by
+        the copyright owner that is granting the License.
+        
+        "Legal Entity" shall mean the union of the acting entity and all
+        other entities that control, are controlled by, or are under common
+        control with that entity. For the purposes of this definition,
+        "control" means (i) the power, direct or indirect, to cause the
+        direction or management of such entity, whether by contract or
+        otherwise, or (ii) ownership of fifty percent (50%) or more of the
+        outstanding shares, or (iii) beneficial ownership of such entity.
+        
+        "You" (or "Your") shall mean an individual or Legal Entity
+        exercising permissions granted by this License.
+        
+        "Source" form shall mean the preferred form for making modifications,
+        including but not limited to software source code, documentation
+        source, and configuration files.
+        
+        "Object" form shall mean any form resulting from mechanical
+        transformation or translation of a Source form, including but
+        not limited to compiled object code, generated documentation,
+        and conversions to other media types.
+        
+        "Work" shall mean the work of authorship, whether in Source or
+        Object form, made available under the License, as indicated by a
+        copyright notice that is included in or attached to the work
+        (an example is provided in the Appendix below).
+        
+        "Derivative Works" shall mean any work, whether in Source or Object
+        form, that is based on (or derived from) the Work and for which the
+        editorial revisions, annotations, elaborations, or other modifications
+        represent, as a whole, an original work of authorship. For the purposes
+        of this License, Derivative Works shall not include works that remain
+        separable from, or merely link (or bind by name) to the interfaces of,
+        the Work and Derivative Works thereof.
+        
+        "Contribution" shall mean any work of authorship, including
+        the original version of the Work and any modifications or additions
+        to that Work or Derivative Works thereof, that is intentionally
+        submitted to Licensor for inclusion in the Work by the copyright owner
+        or by an individual or Legal Entity authorized to submit on behalf of
+        the copyright owner. For the purposes of this definition, "submitted"
+        means any form of electronic, verbal, or written communication sent
+        to the Licensor or its representatives, including but not limited to
+        communication on electronic mailing lists, source code control systems,
+        and issue tracking systems that are managed by, or on behalf of, the
+        Licensor for the purpose of discussing and improving the Work, but
+        excluding communication that is conspicuously marked or otherwise
+        designated in writing by the copyright owner as "Not a Contribution."
+        
+        "Contributor" shall mean Licensor and any individual or Legal Entity
+        on behalf of whom a Contribution has been received by Licensor and
+        subsequently incorporated within the Work.
+        
+        2. Grant of Copyright License. Subject to the terms and conditions of
+        this License, each Contributor hereby grants to You a perpetual,
+        worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+        copyright license to reproduce, prepare Derivative Works of,
+        publicly display, publicly perform, sublicense, and distribute the
+        Work and such Derivative Works in Source or Object form.
+        
+        3. Grant of Patent License. Subject to the terms and conditions of
+        this License, each Contributor hereby grants to You a perpetual,
+        worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+        (except as stated in this section) patent license to make, have made,
+        use, offer to sell, sell, import, and otherwise transfer the Work,
+        where such license applies only to those patent claims licensable
+        by such Contributor that are necessarily infringed by their
+        Contribution(s) alone or by combination of their Contribution(s)
+        with the Work to which such Contribution(s) was submitted. If You
+        institute patent litigation against any entity (including a
+        cross-claim or counterclaim in a lawsuit) alleging that the Work
+        or a Contribution incorporated within the Work constitutes direct
+        or contributory patent infringement, then any patent licenses
+        granted to You under this License for that Work shall terminate
+        as of the date such litigation is filed.
+        
+        4. Redistribution. You may reproduce and distribute copies of the
+        Work or Derivative Works thereof in any medium, with or without
+        modifications, and in Source or Object form, provided that You
+        meet the following conditions:
+        
+        (a) You must give any other recipients of the Work or
+        Derivative Works a copy of this License; and
+        
+        (b) You must cause any modified files to carry prominent notices
+        stating that You changed the files; and
+        
+        (c) You must retain, in the Source form of any Derivative Works
+        that You distribute, all copyright, patent, trademark, and
+        attribution notices from the Source form of the Work,
+        excluding those notices that do not pertain to any part of
+        the Derivative Works; and
+        
+        (d) If the Work includes a "NOTICE" text file as part of its
+        distribution, then any Derivative Works that You distribute must
+        include a readable copy of the attribution notices contained
+        within such NOTICE file, excluding those notices that do not
+        pertain to any part of the Derivative Works, in at least one
+        of the following places: within a NOTICE text file distributed
+        as part of the Derivative Works; within the Source form or
+        documentation, if provided along with the Derivative Works; or,
+        within a display generated by the Derivative Works, if and
+        wherever such third-party notices normally appear. The contents
+        of the NOTICE file are for informational purposes only and
+        do not modify the License. You may add Your own attribution
+        notices within Derivative Works that You distribute, alongside
+        or as an addendum to the NOTICE text from the Work, provided
+        that such additional attribution notices cannot be construed
+        as modifying the License.
+        
+        You may add Your own copyright statement to Your modifications and
+        may provide additional or different license terms and conditions
+        for use, reproduction, or distribution of Your modifications, or
+        for any such Derivative Works as a whole, provided Your use,
+        reproduction, and distribution of the Work otherwise complies with
+        the conditions stated in this License.
+        
+        5. Submission of Contributions. Unless You explicitly state otherwise,
+        any Contribution intentionally submitted for inclusion in the Work
+        by You to the Licensor shall be under the terms and conditions of
+        this License, without any additional terms or conditions.
+        Notwithstanding the above, nothing herein shall supersede or modify
+        the terms of any separate license agreement you may have executed
+        with Licensor regarding such Contributions.
+        
+        6. Trademarks. This License does not grant permission to use the trade
+        names, trademarks, service marks, or product names of the Licensor,
+        except as required for reasonable and customary use in describing the
+        origin of the Work and reproducing the content of the NOTICE file.
+        
+        7. Disclaimer of Warranty. Unless required by applicable law or
+        agreed to in writing, Licensor provides the Work (and each
+        Contributor provides its Contributions) on an "AS IS" BASIS,
+        WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+        implied, including, without limitation, any warranties or conditions
+        of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+        PARTICULAR PURPOSE. You are solely responsible for determining the
+        appropriateness of using or redistributing the Work and assume any
+        risks associated with Your exercise of permissions under this License.
+        
+        8. Limitation of Liability. In no event and under no legal theory,
+        whether in tort (including negligence), contract, or otherwise,
+        unless required by applicable law (such as deliberate and grossly
+        negligent acts) or agreed to in writing, shall any Contributor be
+        liable to You for damages, including any direct, indirect, special,
+        incidental, or consequential damages of any character arising as a
+        result of this License or out of the use or inability to use the
+        Work (including but not limited to damages for loss of goodwill,
+        work stoppage, computer failure or malfunction, or any and all
+        other commercial damages or losses), even if such Contributor
+        has been advised of the possibility of such damages.
+        
+        9. Accepting Warranty or Additional Liability. While redistributing
+        the Work or Derivative Works thereof, You may choose to offer,
+        and charge a fee for, acceptance of support, warranty, indemnity,
+        or other liability obligations and/or rights consistent with this
+        License. However, in accepting such obligations, You may act only
+        on Your own behalf and on Your sole responsibility, not on behalf
+        of any other Contributor, and only if You agree to indemnify,
+        defend, and hold each Contributor harmless for any liability
+        incurred by, or claims asserted against, such Contributor by reason
+        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 [yyyy] [name of copyright owner]
+        
+        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.
+License-File: LICENSE
+Keywords: python
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: <4,>=3.10
+Requires-Dist: pyspark>=3.0.0
+Description-Content-Type: text/markdown
+
+# :rocket: sparkenforce
+
+**sparkenforce** is a type annotation system that lets you specify and validate PySpark DataFrame schemas using Python type hints. It validates both function arguments and return values, catching schema mismatches before they cause runtime errors.
+
+## Why sparkenforce?
+
+Working with PySpark DataFrames can be error-prone when schemas don't match expectations. sparkenforce helps by:
+
+- **Preventing runtime errors**: Catch schema mismatches early with type validation
+- **Improving code clarity**: Function signatures show exactly what DataFrame structure is expected
+- **Enforcing contracts**: Ensure functions return DataFrames with the promised schema
+- **Better debugging**: Clear error messages when validations fail
+
+## Installation
+
+Install sparkenforce using pip:
+
+```bash
+pip install sparkenforce
+```
+
+Or if you're using uv:
+
+```bash
+uv add sparkenforce
+```
+
+## Quick Start
+
+### Validating Input DataFrames
+
+```python
+import sparkenforce
+from pyspark.sql import functions as F
+
+@sparkenforce.validate
+def transform_data(df: sparkenforce.Dataset['firstname':str, ...]) -> sparkenforce.Dataset['name':str, 'length':int]:
+    """Transform DataFrame with validated input and output schemas."""
+    return df.select(
+        df.firstname.alias('name'),
+        F.length(df.firstname).alias('length')
+    )
+
+# If input DataFrame doesn't have 'firstname' column, validation fails
+# If return DataFrame doesn't match expected schema, validation fails
+```
+
+### Flexible Schemas with Ellipsis
+
+Use `...` to allow additional columns beyond the specified ones:
+
+```python
+@sparkenforce.validate
+def process_names(df: sparkenforce.Dataset['firstname':str, 'lastname':str, ...]):
+    """Requires firstname and lastname, but allows other columns too."""
+    return df.filter(df.firstname != "")
+```
+
+### Return Value Validation
+
+sparkenforce validates that your function returns exactly what you promise:
+
+```python
+@sparkenforce.validate
+def get_summary(df: sparkenforce.Dataset['firstname':str, ...]) -> sparkenforce.Dataset['firstname':str, 'summary':str, ...]:
+    return df.select(
+        'firstname',
+        F.lit('processed').alias('summary'),
+        'lastname'  # Additional columns allowed with ...
+    )
+```
+
+## Error Handling
+
+When validation fails, sparkenforce provides clear error messages:
+
+```python
+# This will raise DatasetValidationError with detailed message:
+# "return value columns mismatch. Expected exactly {'name', 'length'}, 
+#  got {'lastname', 'firstname'}. missing columns: {'name', 'length'}, 
+#  unexpected columns: {'lastname', 'firstname'}"
+
+@sparkenforce.validate  
+def bad_function(df: sparkenforce.Dataset['firstname':str, ...]) -> sparkenforce.Dataset['name':str, 'length':int]:
+    return df.select('firstname', 'lastname')  # Wrong columns!
+```
+
+
+## Development Setup
+
+**Step 1**: Create virtual environment
+```bash
+uv venv
+```
+
+**Step 2**: Activate environment
+```bash
+# Linux/Mac
+source .venv/bin/activate
+
+# Windows  
+.venv\Scripts\activate
+```
+
+**Step 3**: Install dependencies
+```bash
+uv sync
+```
+
+## CLI Commands
+
+```bash
+# Run tests
+task tests
+
+# Type checking
+task type
+
+# Linting
+task lint
+
+# Format code
+task format
+
+# Coverage report
+task coverage
+```
+
+## Inspiration
+
+This project builds on [dataenforce](https://github.com/CedricFR/dataenforce), extending it with additional validation capabilities for PySpark DataFrame workflows.
+
+## License
+
+Apache Software License v2.0
+
+## Contact
+
+Created by [Agustín Recoba](https://github.com/agustin-recoba)

sparkenforce-0.1.0.dist-info/RECORD

@@ -0,0 +1,5 @@
+sparkenforce/__init__.py,sha256=nV36EXw-zQ4U3W9TEWqvf8lYxrw5gBceuMcnDoQGntw,15008
+sparkenforce-0.1.0.dist-info/METADATA,sha256=G8UQFZlvmJuaLbt2pQin6jG1wpVIP18qabRJHkuPMyc,17326
+sparkenforce-0.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+sparkenforce-0.1.0.dist-info/licenses/LICENSE,sha256=vLd3j3I_iOtcGExnlBC84DFUAOkkD9p-hDhPZQps6b4,10949
+sparkenforce-0.1.0.dist-info/RECORD,,

sparkenforce-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

sparkenforce-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,220 @@
+Apache Software License 2.0
+
+Copyright (c) 2025, Agustín Recoba
+
+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.
+
+
+Original License, part of the original proyect "dataenforce" (`https://github.com/CedricFR/dataenforce`)
+
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction,
+and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by
+the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all
+other entities that control, are controlled by, or are under common
+control with that entity. For the purposes of this definition,
+"control" means (i) the power, direct or indirect, to cause the
+direction or management of such entity, whether by contract or
+otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity
+exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation
+source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical
+transformation or translation of a Source form, including but
+not limited to compiled object code, generated documentation,
+and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or
+Object form, made available under the License, as indicated by a
+copyright notice that is included in or attached to the work
+(an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object
+form, that is based on (or derived from) the Work and for which the
+editorial revisions, annotations, elaborations, or other modifications
+represent, as a whole, an original work of authorship. For the purposes
+of this License, Derivative Works shall not include works that remain
+separable from, or merely link (or bind by name) to the interfaces of,
+the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including
+the original version of the Work and any modifications or additions
+to that Work or Derivative Works thereof, that is intentionally
+submitted to Licensor for inclusion in the Work by the copyright owner
+or by an individual or Legal Entity authorized to submit on behalf of
+the copyright owner. For the purposes of this definition, "submitted"
+means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems,
+and issue tracking systems that are managed by, or on behalf of, the
+Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity
+on behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the
+Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+(except as stated in this section) patent license to make, have made,
+use, offer to sell, sell, import, and otherwise transfer the Work,
+where such license applies only to those patent claims licensable
+by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You
+institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work
+or a Contribution incorporated within the Work constitutes direct
+or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate
+as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+Work or Derivative Works thereof in any medium, with or without
+modifications, and in Source or Object form, provided that You
+meet the following conditions:
+
+(a) You must give any other recipients of the Work or
+Derivative Works a copy of this License; and
+
+(b) You must cause any modified files to carry prominent notices
+stating that You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works
+that You distribute, all copyright, patent, trademark, and
+attribution notices from the Source form of the Work,
+excluding those notices that do not pertain to any part of
+the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its
+distribution, then any Derivative Works that You distribute must
+include a readable copy of the attribution notices contained
+within such NOTICE file, excluding those notices that do not
+pertain to any part of the Derivative Works, in at least one
+of the following places: within a NOTICE text file distributed
+as part of the Derivative Works; within the Source form or
+documentation, if provided along with the Derivative Works; or,
+within a display generated by the Derivative Works, if and
+wherever such third-party notices normally appear. The contents
+of the NOTICE file are for informational purposes only and
+do not modify the License. You may add Your own attribution
+notices within Derivative Works that You distribute, alongside
+or as an addendum to the NOTICE text from the Work, provided
+that such additional attribution notices cannot be construed
+as modifying the License.
+
+You may add Your own copyright statement to Your modifications and
+may provide additional or different license terms and conditions
+for use, reproduction, or distribution of Your modifications, or
+for any such Derivative Works as a whole, provided Your use,
+reproduction, and distribution of the Work otherwise complies with
+the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+any Contribution intentionally submitted for inclusion in the Work
+by You to the Licensor shall be under the terms and conditions of
+this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify
+the terms of any separate license agreement you may have executed
+with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+names, trademarks, service marks, or product names of the Licensor,
+except as required for reasonable and customary use in describing the
+origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+agreed to in writing, Licensor provides the Work (and each
+Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied, including, without limitation, any warranties or conditions
+of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any
+risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+whether in tort (including negligence), contract, or otherwise,
+unless required by applicable law (such as deliberate and grossly
+negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special,
+incidental, or consequential damages of any character arising as a
+result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all
+other commercial damages or losses), even if such Contributor
+has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+the Work or Derivative Works thereof, You may choose to offer,
+and charge a fee for, acceptance of support, warranty, indemnity,
+or other liability obligations and/or rights consistent with this
+License. However, in accepting such obligations, You may act only
+on Your own behalf and on Your sole responsibility, not on behalf
+of any other Contributor, and only if You agree to indemnify,
+defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason
+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 [yyyy] [name of copyright owner]
+
+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.