Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support pyspark sql dataframe validation #1243

Merged
merged 9 commits into from
Jul 6, 2023
Merged

Support pyspark sql dataframe validation #1243

merged 9 commits into from
Jul 6, 2023

Conversation

cosmicBboy
Copy link
Collaborator

This PR fixes #1138

  • Introduces native pyspark sql dataframe validation support via the pandera.pyspark subpackage
  • Adds support for adding arbitrary metadata to schemas and schema components
  • Adds support for disabling/enabling validation globally via environment variable (pyspark sql only for now)
  • Adds support for toggling schema vs. data-level validation (pyspark sql only for now)

NeerajMalhotra-QB and others added 5 commits May 12, 2023 23:20
* init

* init

* init structure

* disable imports'

* adding structure for pyspark

* setting dependency

* update class import

* fixing datatype cls

* adding dtypes for pyspark

* keep only bool type

* remove pydantic schema

* register pyspark data types

* add check method

* updating equivalents to native types

* update column schema

* refactor array to column

* rename array to column_schema

* remove pandas imports

* remove index and multiindex functionality

* adding pydantic schema class

* adding model components

* add model config

* define pyspark BaseConfig class

* removing index and multi-indexes

* remove modify schema

* Pyspark backend components, base, container, accessor, test file for accessor

* Pyspark backend components, base, container, accessor, test file for accessor

* Pyspark backend components, base, container, accessor, test file for accessor

* Pyspark backend components, base, container, accessor, test file for accessor

* add pyspark model components and types

* remove hypothesis

* remove synthesis and hypothesis

* Pyspark backend components, base, container, accessor, test file for accessor

* test for pyspark dataframeschema class

* test schema with alias types

* ensuring treat dataframes as tables types

* update container for pyspark dataframe

* adding negative test flow

* removing series and index on pysparrk dataframes

* remove series

* revert series from pyspark.pandas

* adding checks for pyspark

* registering pysparkCheckBackend

* cleaning base

* Fixing the broken type cast check, validation of schema fix.

* define spark level schema

* fixing check flow

* setting apply fn

* add sub sample functionality

* adjusting test case against common attributes

* need apply for column level check

* adding builtin checks for pyspark

* adding checks for pyspark df

* getting check registered

* fixing a bug a in error handling for schema check

* check_name validation fixed

* implementing dtype checks for pyspark

* updating error msg

* fixing dtype reason_code

* updating builtin checks for pyspark

* registeration

* Implementation of checks import and spark columns information check

* enhancing __call__, checks classes and builtin_checks

* delete junk files

* Changes to fix the implemtation of checks. Changed Apply function to send list with dataframe and column name, builtin function registers functions with lists which inculdes the dataframe

* extending pyspark checks

* Fixed builtin check bug and added test for supported builtin checks for pyspark

* add todos

* bydefault validate all checks

* fixing issue with sqlctx

* add dtypes pytests

* setting up schema

* add negative and positive tests

* add fixtures and refactor tests

* generalize spark_df func

* refactor to use conftest

* use conftest

* add support for decimal dtype and fixing other types

* Added new Datatypes support for pyspark, test cases for dtypes pyspark, created test file for error

* refactor ArraySchema

* rename array to column.py

* 1) Changes in test cases to look for summarised error raise instead of fast fail, since default behaviour is changed to summarised.
2) Added functionality to accept and check the precision and scale in Decimal Datatypes.

* add neg test

* add custom ErrorHandler

* Added functionality to DayTimeIntervalType datatype to accept parameters

* Added functionality to DayTimeIntervalType datatype to accept parameters

* return summarized error report

* replace dataframe to dict for return obj

* Changed checks input datatype to custom named tuple from the existing list. Also started changing the pyspark checks to include more datatypes

* refactor

* introduce error categories

* rename error categories

* fixing bug in schema.dtype.check

* fixing error category to by dynamic

* Added checks for each datatype in test cases. Reduced the code redundancy of the code in test file. Refactored the name of custom datatype object for checks.

* error_handler pass through

* add ErrorHandler to column api

* removed SchemaErrors since we now aggregate in errorHandler

* fixing dict keys

* Added Decorator to raise TypeError in case of unexpected input type for the check function.

* replace validator with report_errors

* cleaning debugs

* Support DataModels and Field

* Added Decorator to raise TypeError in case of unexpected input type for the check function. Merged with Develop

* Fix to run using the class schema type

* use alias types

* clean up

* add new typing for pyspark.sql

* Added Decorator to raise TypeError in case of unexpected input type for the check function. Merged with Develop

* Added changes to support raising error for use of datatype not supported by the check and support for map and array type.

* support bare dtypes for DataFrameModel

* remove resolved TODOs and breakpoints

* change to bare types

* use spark types instead of bare types

* using SchemaErrorReason instead of hardcode in container

* fixing an issue with error reason codes

* minor fix

* fixing checks and errors in pyspark

* Changes include the following:
1) Updated dtypes test functionality to make it more readable
2) Changes in accessor tests to support the new functionality
3) Changes in engine class to conform to check class everywhere else

* enhancing dataframeschema and model classes

* Changes to remove the pandas dependency

* Refactoring of the checks test functions

* Fixing the test case breaking

* Isort and Black formatting

* Container Test function failure

* Isort and black linting

* Changes to remove the pandas dependency

* Refactoring of the checks test functions

* Isort and black linting

* Added Changes to refactor the checks class. Fixes to some test cases failures.

* Removing breakpoint

* fixing raise error

* adding metadata dict

* Removing the reference of pandas from docstrings

* Removing redundant code block in utils

* Changes to return dataframe with errors property

* add accessor for errorHandler

* support errors access on pyspark.sql

* updating pyspark error tcs

* fixing model test cases

* adjusting errors to use pandera.errors

* use accessor instead of dict

* revert to  develop

* Removal of imports which are not needed and improved test case.

* setting independent pyspark import

* pyspark imports

* revert comments

* store and retrieve metadata at schema levels

* adding metadata support

* Added changes to support parameter based run.
1) Added parameters.yaml file to hold the configurations
2) Added code in utility to read the config
3) Updated the test cases to support the parameter based run
4) Moved pyspark decorators to a new file decorators.py in backend
5) Type fix in get_matadata property in container.py file

* Changing the default value in config

* change to consistent interface

* cleaning api/pyspark

* backend and tests

* adding setter on errors accessors for pyspark

* reformatting error dict

* doc

* run black linter

Signed-off-by: Niels Bantilan <niels.bantilan@gmail.com>

* fix lint

Signed-off-by: Niels Bantilan <niels.bantilan@gmail.com>

* update pylintrc

Signed-off-by: Niels Bantilan <niels.bantilan@gmail.com>

---------

Signed-off-by: Niels Bantilan <niels.bantilan@gmail.com>
Co-authored-by: jaskaransinghsidana <jaskaran_singh_sidana@mckinsey.com>
Co-authored-by: jaskaransinghsidana <112083212+jaskaransinghsidana@users.noreply.github.com>
Co-authored-by: Niels Bantilan <niels.bantilan@gmail.com>
* fixing check flow

* setting apply fn

* add sub sample functionality

* adjusting test case against common attributes

* need apply for column level check

* adding builtin checks for pyspark

* adding checks for pyspark df

* getting check registered

* fixing a bug a in error handling for schema check

* check_name validation fixed

* implementing dtype checks for pyspark

* updating error msg

* fixing dtype reason_code

* updating builtin checks for pyspark

* registeration

* Implementation of checks import and spark columns information check

* enhancing __call__, checks classes and builtin_checks

* delete junk files

* Changes to fix the implemtation of checks. Changed Apply function to send list with dataframe and column name, builtin function registers functions with lists which inculdes the dataframe

* extending pyspark checks

* Fixed builtin check bug and added test for supported builtin checks for pyspark

* add todos

* bydefault validate all checks

* fixing issue with sqlctx

* add dtypes pytests

* setting up schema

* add negative and positive tests

* add fixtures and refactor tests

* generalize spark_df func

* refactor to use conftest

* use conftest

* add support for decimal dtype and fixing other types

* Added new Datatypes support for pyspark, test cases for dtypes pyspark, created test file for error

* refactor ArraySchema

* rename array to column.py

* 1) Changes in test cases to look for summarised error raise instead of fast fail, since default behaviour is changed to summarised.
2) Added functionality to accept and check the precision and scale in Decimal Datatypes.

* add neg test

* add custom ErrorHandler

* Added functionality to DayTimeIntervalType datatype to accept parameters

* Added functionality to DayTimeIntervalType datatype to accept parameters

* return summarized error report

* replace dataframe to dict for return obj

* Changed checks input datatype to custom named tuple from the existing list. Also started changing the pyspark checks to include more datatypes

* refactor

* introduce error categories

* rename error categories

* fixing bug in schema.dtype.check

* fixing error category to by dynamic

* Added checks for each datatype in test cases. Reduced the code redundancy of the code in test file. Refactored the name of custom datatype object for checks.

* error_handler pass through

* add ErrorHandler to column api

* removed SchemaErrors since we now aggregate in errorHandler

* fixing dict keys

* Added Decorator to raise TypeError in case of unexpected input type for the check function.

* replace validator with report_errors

* cleaning debugs

* Support DataModels and Field

* Added Decorator to raise TypeError in case of unexpected input type for the check function. Merged with Develop

* Fix to run using the class schema type

* use alias types

* clean up

* add new typing for pyspark.sql

* Added Decorator to raise TypeError in case of unexpected input type for the check function. Merged with Develop

* Added changes to support raising error for use of datatype not supported by the check and support for map and array type.

* support bare dtypes for DataFrameModel

* remove resolved TODOs and breakpoints

* change to bare types

* use spark types instead of bare types

* using SchemaErrorReason instead of hardcode in container

* fixing an issue with error reason codes

* minor fix

* fixing checks and errors in pyspark

* Changes include the following:
1) Updated dtypes test functionality to make it more readable
2) Changes in accessor tests to support the new functionality
3) Changes in engine class to conform to check class everywhere else

* enhancing dataframeschema and model classes

* Changes to remove the pandas dependency

* Refactoring of the checks test functions

* Fixing the test case breaking

* Isort and Black formatting

* Container Test function failure

* Isort and black linting

* Changes to remove the pandas dependency

* Refactoring of the checks test functions

* Isort and black linting

* Added Changes to refactor the checks class. Fixes to some test cases failures.

* Removing breakpoint

* fixing raise error

* adding metadata dict

* Removing the reference of pandas from docstrings

* Removing redundant code block in utils

* Changes to return dataframe with errors property

* add accessor for errorHandler

* support errors access on pyspark.sql

* updating pyspark error tcs

* fixing model test cases

* adjusting errors to use pandera.errors

* use accessor instead of dict

* revert to  develop

* Removal of imports which are not needed and improved test case.

* setting independent pyspark import

* pyspark imports

* revert comments

* store and retrieve metadata at schema levels

* adding metadata support

* Added changes to support parameter based run.
1) Added parameters.yaml file to hold the configurations
2) Added code in utility to read the config
3) Updated the test cases to support the parameter based run
4) Moved pyspark decorators to a new file decorators.py in backend
5) Type fix in get_matadata property in container.py file

* Changing the default value in config

* change to consistent interface

* Changes to remove config yaml and introduce environment variables for parameterized runs

* cleaning api/pyspark

* backend and tests

* adding setter on errors accessors for pyspark

* reformatting error dict

* Changes to remove config yaml and introduce environment variables for parameterized runs

* Changes to rename the config object and call only in utils.py

* Fixing merge conflict issue

* Updating the test cases to support new checks types

* Added individualized test for each configuration type.

* Removing unnecessary prints

* The changes include the following:
1) Fixed test case for validating the environment variable
2) Improved docstrings for test cases and few test cases asserts

* Fix reference to with wrong key in test_pyspark_schema_data_checks

* minor change

* Added Support for docstring substitution method.

* Removing an extra indent

* Removing commented docstring substitution from __new__ method

* remove union

* cleaning

* Feature to add metadata dictionary for pandas schema

* Added test to check the docstring substitution decorator

* Added test to check the docstring substitution decorator

* Feature to add metadata dictionary for pandas schema

* Changes to ensure only pandas run does not import pyspark dependencies

* Fix of imports for pandas and pyspark for separation

* Rename the function from pyspark to pandas

* black lint and isort

* black lint and isort

* Fixes of pyliny issue and suppression wherever necessary

* Fixes of mypy failures and redone black linting post changes.

* Added new test cases, removed redundant codes and black lint.

* Fixed the doc strings, added functionality and test for custom checks

* add rst for pyspark.sql

* removing rst

* Renamed check name and Fixed pylint and mypy issues

* add rst for pyspark.sql

* Fixed the doc strings, added functionality and test for custom checks

* removing rst

* Renamed check name and Fixed pylint and mypy issues

* add rst for pyspark.sql

* Rename for environment variable key name

* removing rst

* Black lint

* Removed daytime interval type

* refactor

* override pyspark patching of __class_getitem__

Signed-off-by: Niels Bantilan <niels.bantilan@gmail.com>

* fixiing mypy error

* lint fixes

* lint fixes

* fixing more lint and type issues

* fixing mypy issues

* fixing doctest

* doctest

Signed-off-by: Neeraj Malhotra <neeraj_malhotra@mckinsey.com>

* fixing doctest

Signed-off-by: Neeraj Malhotra <neeraj_malhotra@mckinsey.com>

* adding doctest:metadata for pandas container classes

Signed-off-by: Neeraj Malhotra <neeraj_malhotra@mckinsey.com>

* doctest

* fixing doctest

Signed-off-by: Neeraj Malhotra <neeraj_malhotra@mckinsey.com>

* fixing rst

Signed-off-by: Neeraj Malhotra <neeraj_malhotra@mckinsey.com>

* black formatting

Signed-off-by: Neeraj Malhotra <neeraj_malhotra@mckinsey.com>

* fixing str repr for DataFrameSchema across rst

* add ps.DataFrame

* fixing tests

* fix lint

Signed-off-by: Niels Bantilan <niels.bantilan@gmail.com>

* use full class name in pandas accessor

Signed-off-by: Niels Bantilan <niels.bantilan@gmail.com>

* use os.environ instead of parameters.yaml

Signed-off-by: Neeraj Malhotra <neeraj_malhotra@mckinsey.com>

* simplify config

Signed-off-by: Niels Bantilan <niels.bantilan@gmail.com>

---------

Signed-off-by: Niels Bantilan <niels.bantilan@gmail.com>
Signed-off-by: Neeraj Malhotra <neeraj_malhotra@mckinsey.com>
Co-authored-by: jaskaransinghsidana <jaskaran_singh_sidana@mckinsey.com>
Co-authored-by: jaskaransinghsidana <112083212+jaskaransinghsidana@users.noreply.github.com>
Co-authored-by: Niels Bantilan <niels.bantilan@gmail.com>
support pyspark 3.2 and 3.3 for string representation of dtypes.

---------

Signed-off-by: Niels Bantilan <niels.bantilan@gmail.com>
Signed-off-by: Neeraj Malhotra <neeraj_malhotra@mckinsey.com>
Co-authored-by: jaskaransinghsidana <jaskaran_singh_sidana@mckinsey.com>
Co-authored-by: jaskaransinghsidana <112083212+jaskaransinghsidana@users.noreply.github.com>
Co-authored-by: Niels Bantilan <niels.bantilan@gmail.com>
* updating builtin checks for pyspark

* registeration

* Implementation of checks import and spark columns information check

* enhancing __call__, checks classes and builtin_checks

* delete junk files

* Changes to fix the implemtation of checks. Changed Apply function to send list with dataframe and column name, builtin function registers functions with lists which inculdes the dataframe

* extending pyspark checks

* Fixed builtin check bug and added test for supported builtin checks for pyspark

* add todos

* bydefault validate all checks

* fixing issue with sqlctx

* add dtypes pytests

* setting up schema

* add negative and positive tests

* add fixtures and refactor tests

* generalize spark_df func

* refactor to use conftest

* use conftest

* add support for decimal dtype and fixing other types

* Added new Datatypes support for pyspark, test cases for dtypes pyspark, created test file for error

* refactor ArraySchema

* rename array to column.py

* 1) Changes in test cases to look for summarised error raise instead of fast fail, since default behaviour is changed to summarised.
2) Added functionality to accept and check the precision and scale in Decimal Datatypes.

* add neg test

* add custom ErrorHandler

* Added functionality to DayTimeIntervalType datatype to accept parameters

* Added functionality to DayTimeIntervalType datatype to accept parameters

* return summarized error report

* replace dataframe to dict for return obj

* Changed checks input datatype to custom named tuple from the existing list. Also started changing the pyspark checks to include more datatypes

* refactor

* introduce error categories

* rename error categories

* fixing bug in schema.dtype.check

* fixing error category to by dynamic

* Added checks for each datatype in test cases. Reduced the code redundancy of the code in test file. Refactored the name of custom datatype object for checks.

* error_handler pass through

* add ErrorHandler to column api

* removed SchemaErrors since we now aggregate in errorHandler

* fixing dict keys

* Added Decorator to raise TypeError in case of unexpected input type for the check function.

* replace validator with report_errors

* cleaning debugs

* Support DataModels and Field

* Added Decorator to raise TypeError in case of unexpected input type for the check function. Merged with Develop

* Fix to run using the class schema type

* use alias types

* clean up

* add new typing for pyspark.sql

* Added Decorator to raise TypeError in case of unexpected input type for the check function. Merged with Develop

* Added changes to support raising error for use of datatype not supported by the check and support for map and array type.

* support bare dtypes for DataFrameModel

* remove resolved TODOs and breakpoints

* change to bare types

* use spark types instead of bare types

* using SchemaErrorReason instead of hardcode in container

* fixing an issue with error reason codes

* minor fix

* fixing checks and errors in pyspark

* Changes include the following:
1) Updated dtypes test functionality to make it more readable
2) Changes in accessor tests to support the new functionality
3) Changes in engine class to conform to check class everywhere else

* enhancing dataframeschema and model classes

* Changes to remove the pandas dependency

* Refactoring of the checks test functions

* Fixing the test case breaking

* Isort and Black formatting

* Container Test function failure

* Isort and black linting

* Changes to remove the pandas dependency

* Refactoring of the checks test functions

* Isort and black linting

* Added Changes to refactor the checks class. Fixes to some test cases failures.

* Removing breakpoint

* fixing raise error

* adding metadata dict

* Removing the reference of pandas from docstrings

* Removing redundant code block in utils

* Changes to return dataframe with errors property

* add accessor for errorHandler

* support errors access on pyspark.sql

* updating pyspark error tcs

* fixing model test cases

* adjusting errors to use pandera.errors

* use accessor instead of dict

* revert to  develop

* Removal of imports which are not needed and improved test case.

* setting independent pyspark import

* pyspark imports

* revert comments

* store and retrieve metadata at schema levels

* adding metadata support

* Added changes to support parameter based run.
1) Added parameters.yaml file to hold the configurations
2) Added code in utility to read the config
3) Updated the test cases to support the parameter based run
4) Moved pyspark decorators to a new file decorators.py in backend
5) Type fix in get_matadata property in container.py file

* Changing the default value in config

* change to consistent interface

* Changes to remove config yaml and introduce environment variables for parameterized runs

* cleaning api/pyspark

* backend and tests

* adding setter on errors accessors for pyspark

* reformatting error dict

* Changes to remove config yaml and introduce environment variables for parameterized runs

* Changes to rename the config object and call only in utils.py

* Fixing merge conflict issue

* Updating the test cases to support new checks types

* Added individualized test for each configuration type.

* Removing unnecessary prints

* The changes include the following:
1) Fixed test case for validating the environment variable
2) Improved docstrings for test cases and few test cases asserts

* Fix reference to with wrong key in test_pyspark_schema_data_checks

* minor change

* Added Support for docstring substitution method.

* Removing an extra indent

* Removing commented docstring substitution from __new__ method

* remove union

* cleaning

* Feature to add metadata dictionary for pandas schema

* Added test to check the docstring substitution decorator

* Added test to check the docstring substitution decorator

* Feature to add metadata dictionary for pandas schema

* Changes to ensure only pandas run does not import pyspark dependencies

* Fix of imports for pandas and pyspark for separation

* Rename the function from pyspark to pandas

* black lint and isort

* black lint and isort

* Fixes of pyliny issue and suppression wherever necessary

* Fixes of mypy failures and redone black linting post changes.

* Added new test cases, removed redundant codes and black lint.

* Fixed the doc strings, added functionality and test for custom checks

* add rst for pyspark.sql

* removing rst

* Renamed check name and Fixed pylint and mypy issues

* add rst for pyspark.sql

* Fixed the doc strings, added functionality and test for custom checks

* removing rst

* Renamed check name and Fixed pylint and mypy issues

* add rst for pyspark.sql

* Rename for environment variable key name

* removing rst

* Black lint

* Removed daytime interval type

* refactor

* override pyspark patching of __class_getitem__

Signed-off-by: Niels Bantilan <niels.bantilan@gmail.com>

* fixiing mypy error

* lint fixes

* lint fixes

* fixing more lint and type issues

* fixing mypy issues

* fixing doctest

* doctest

Signed-off-by: Neeraj Malhotra <neeraj_malhotra@mckinsey.com>

* fixing doctest

Signed-off-by: Neeraj Malhotra <neeraj_malhotra@mckinsey.com>

* adding doctest:metadata for pandas container classes

Signed-off-by: Neeraj Malhotra <neeraj_malhotra@mckinsey.com>

* doctest

* Fix to support pyspark 3.2 and 3.3 both. The string representation of datatype changed in 3.2 and 3.3. Fix ensure both versions are supported.

* Black Lint

* fixing doctest

Signed-off-by: Neeraj Malhotra <neeraj_malhotra@mckinsey.com>

* fixing rst

Signed-off-by: Neeraj Malhotra <neeraj_malhotra@mckinsey.com>

* black formatting

Signed-off-by: Neeraj Malhotra <neeraj_malhotra@mckinsey.com>

* fixing str repr for DataFrameSchema across rst

* add ps.DataFrame

* fixing tests

* fix lint

Signed-off-by: Niels Bantilan <niels.bantilan@gmail.com>

* use full class name in pandas accessor

Signed-off-by: Niels Bantilan <niels.bantilan@gmail.com>

* use os.environ instead of parameters.yaml

Signed-off-by: Neeraj Malhotra <neeraj_malhotra@mckinsey.com>

* simplify config

Signed-off-by: Niels Bantilan <niels.bantilan@gmail.com>

* merge with develop

* Black Lint

* refactor

Signed-off-by: Neeraj Malhotra <neeraj_malhotra@mckinsey.com>

* lint fix

Signed-off-by: Neeraj Malhotra <neeraj_malhotra@mckinsey.com>

* refactor

* remove Column class due to redundancy

Signed-off-by: Neeraj Malhotra <neeraj_malhotra@mckinsey.com>

* linting

Signed-off-by: Neeraj Malhotra <neeraj_malhotra@mckinsey.com>

---------

Signed-off-by: Niels Bantilan <niels.bantilan@gmail.com>
Signed-off-by: Neeraj Malhotra <neeraj_malhotra@mckinsey.com>
Co-authored-by: jaskaransinghsidana <jaskaran_singh_sidana@mckinsey.com>
Co-authored-by: jaskaransinghsidana <112083212+jaskaransinghsidana@users.noreply.github.com>
Co-authored-by: Niels Bantilan <niels.bantilan@gmail.com>
* add dtypes pytests

* setting up schema

* add negative and positive tests

* add fixtures and refactor tests

* generalize spark_df func

* refactor to use conftest

* use conftest

* add support for decimal dtype and fixing other types

* Added new Datatypes support for pyspark, test cases for dtypes pyspark, created test file for error

* refactor ArraySchema

* rename array to column.py

* 1) Changes in test cases to look for summarised error raise instead of fast fail, since default behaviour is changed to summarised.
2) Added functionality to accept and check the precision and scale in Decimal Datatypes.

* add neg test

* add custom ErrorHandler

* Added functionality to DayTimeIntervalType datatype to accept parameters

* Added functionality to DayTimeIntervalType datatype to accept parameters

* return summarized error report

* replace dataframe to dict for return obj

* Changed checks input datatype to custom named tuple from the existing list. Also started changing the pyspark checks to include more datatypes

* refactor

* introduce error categories

* rename error categories

* fixing bug in schema.dtype.check

* fixing error category to by dynamic

* Added checks for each datatype in test cases. Reduced the code redundancy of the code in test file. Refactored the name of custom datatype object for checks.

* error_handler pass through

* add ErrorHandler to column api

* removed SchemaErrors since we now aggregate in errorHandler

* fixing dict keys

* Added Decorator to raise TypeError in case of unexpected input type for the check function.

* replace validator with report_errors

* cleaning debugs

* Support DataModels and Field

* Added Decorator to raise TypeError in case of unexpected input type for the check function. Merged with Develop

* Fix to run using the class schema type

* use alias types

* clean up

* add new typing for pyspark.sql

* Added Decorator to raise TypeError in case of unexpected input type for the check function. Merged with Develop

* Added changes to support raising error for use of datatype not supported by the check and support for map and array type.

* support bare dtypes for DataFrameModel

* remove resolved TODOs and breakpoints

* change to bare types

* use spark types instead of bare types

* using SchemaErrorReason instead of hardcode in container

* fixing an issue with error reason codes

* minor fix

* fixing checks and errors in pyspark

* Changes include the following:
1) Updated dtypes test functionality to make it more readable
2) Changes in accessor tests to support the new functionality
3) Changes in engine class to conform to check class everywhere else

* enhancing dataframeschema and model classes

* Changes to remove the pandas dependency

* Refactoring of the checks test functions

* Fixing the test case breaking

* Isort and Black formatting

* Container Test function failure

* Isort and black linting

* Changes to remove the pandas dependency

* Refactoring of the checks test functions

* Isort and black linting

* Added Changes to refactor the checks class. Fixes to some test cases failures.

* Removing breakpoint

* fixing raise error

* adding metadata dict

* Removing the reference of pandas from docstrings

* Removing redundant code block in utils

* Changes to return dataframe with errors property

* add accessor for errorHandler

* support errors access on pyspark.sql

* updating pyspark error tcs

* fixing model test cases

* adjusting errors to use pandera.errors

* use accessor instead of dict

* revert to  develop

* Removal of imports which are not needed and improved test case.

* setting independent pyspark import

* pyspark imports

* revert comments

* store and retrieve metadata at schema levels

* adding metadata support

* Added changes to support parameter based run.
1) Added parameters.yaml file to hold the configurations
2) Added code in utility to read the config
3) Updated the test cases to support the parameter based run
4) Moved pyspark decorators to a new file decorators.py in backend
5) Type fix in get_matadata property in container.py file

* Changing the default value in config

* change to consistent interface

* Changes to remove config yaml and introduce environment variables for parameterized runs

* cleaning api/pyspark

* backend and tests

* adding setter on errors accessors for pyspark

* reformatting error dict

* Changes to remove config yaml and introduce environment variables for parameterized runs

* Changes to rename the config object and call only in utils.py

* Fixing merge conflict issue

* Updating the test cases to support new checks types

* Added individualized test for each configuration type.

* Removing unnecessary prints

* The changes include the following:
1) Fixed test case for validating the environment variable
2) Improved docstrings for test cases and few test cases asserts

* Fix reference to with wrong key in test_pyspark_schema_data_checks

* minor change

* Added Support for docstring substitution method.

* Removing an extra indent

* Removing commented docstring substitution from __new__ method

* remove union

* cleaning

* Feature to add metadata dictionary for pandas schema

* Added test to check the docstring substitution decorator

* Added test to check the docstring substitution decorator

* Feature to add metadata dictionary for pandas schema

* Changes to ensure only pandas run does not import pyspark dependencies

* Fix of imports for pandas and pyspark for separation

* Rename the function from pyspark to pandas

* black lint and isort

* black lint and isort

* Fixes of pyliny issue and suppression wherever necessary

* Fixes of mypy failures and redone black linting post changes.

* Added new test cases, removed redundant codes and black lint.

* Fixed the doc strings, added functionality and test for custom checks

* add rst for pyspark.sql

* removing rst

* Renamed check name and Fixed pylint and mypy issues

* add rst for pyspark.sql

* Fixed the doc strings, added functionality and test for custom checks

* removing rst

* Renamed check name and Fixed pylint and mypy issues

* add rst for pyspark.sql

* Rename for environment variable key name

* removing rst

* Black lint

* Removed daytime interval type

* refactor

* override pyspark patching of __class_getitem__

Signed-off-by: Niels Bantilan <niels.bantilan@gmail.com>

* fixiing mypy error

* lint fixes

* lint fixes

* fixing more lint and type issues

* fixing mypy issues

* fixing doctest

* doctest

Signed-off-by: Neeraj Malhotra <neeraj_malhotra@mckinsey.com>

* fixing doctest

Signed-off-by: Neeraj Malhotra <neeraj_malhotra@mckinsey.com>

* adding doctest:metadata for pandas container classes

Signed-off-by: Neeraj Malhotra <neeraj_malhotra@mckinsey.com>

* doctest

* Fix to support pyspark 3.2 and 3.3 both. The string representation of datatype changed in 3.2 and 3.3. Fix ensure both versions are supported.

* Black Lint

* fixing doctest

Signed-off-by: Neeraj Malhotra <neeraj_malhotra@mckinsey.com>

* fixing rst

Signed-off-by: Neeraj Malhotra <neeraj_malhotra@mckinsey.com>

* black formatting

Signed-off-by: Neeraj Malhotra <neeraj_malhotra@mckinsey.com>

* fixing str repr for DataFrameSchema across rst

* add ps.DataFrame

* fixing tests

* fix lint

Signed-off-by: Niels Bantilan <niels.bantilan@gmail.com>

* use full class name in pandas accessor

Signed-off-by: Niels Bantilan <niels.bantilan@gmail.com>

* use os.environ instead of parameters.yaml

Signed-off-by: Neeraj Malhotra <neeraj_malhotra@mckinsey.com>

* simplify config

Signed-off-by: Niels Bantilan <niels.bantilan@gmail.com>

* merge with develop

* Black Lint

* refactor

Signed-off-by: Neeraj Malhotra <neeraj_malhotra@mckinsey.com>

* lint fix

Signed-off-by: Neeraj Malhotra <neeraj_malhotra@mckinsey.com>

* readme

* refine example

* about granular controls

* native pyspark.sql documentation

Signed-off-by: Neeraj Malhotra <neeraj_malhotra@mckinsey.com>

* docs

Signed-off-by: Neeraj Malhotra <neeraj_malhotra@mckinsey.com>

* Add to index

* add to index

* Delete oryx-build-commands.txt

* fix index

* revert

* fix index

* Update pyspark_sql.rst

* Update pyspark_sql.rst

* update error print

* Update pyspark_sql.rst

* Update pyspark_sql.rst

* adding import in code block

Signed-off-by: Neeraj Malhotra <neeraj_malhotra@mckinsey.com>

* Update pyspark_sql.rst

* Update pyspark_sql.rst

* Update pyspark_sql.rst

* clean up docs

Signed-off-by: Niels Bantilan <niels.bantilan@gmail.com>

---------

Signed-off-by: Niels Bantilan <niels.bantilan@gmail.com>
Signed-off-by: Neeraj Malhotra <neeraj_malhotra@mckinsey.com>
Co-authored-by: jaskaransinghsidana <jaskaran_singh_sidana@mckinsey.com>
Co-authored-by: jaskaransinghsidana <112083212+jaskaransinghsidana@users.noreply.github.com>
Co-authored-by: Niels Bantilan <niels.bantilan@gmail.com>
@codecov
Copy link

codecov bot commented Jun 30, 2023

Codecov Report

Patch coverage: 82.37% and project coverage change: -3.58 ⚠️

Comparison is base (631089c) 97.31% compared to head (eab83ff) 93.73%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1243      +/-   ##
==========================================
- Coverage   97.31%   93.73%   -3.58%     
==========================================
  Files          65       90      +25     
  Lines        5140     6708    +1568     
==========================================
+ Hits         5002     6288    +1286     
- Misses        138      420     +282     
Impacted Files Coverage Δ
pandera/accessors/pandas_accessor.py 96.66% <ø> (ø)
pandera/api/base/checks.py 100.00% <ø> (ø)
pandera/api/base/model.py 97.22% <ø> (ø)
pandera/api/checks.py 98.54% <ø> (ø)
pandera/api/hypotheses.py 100.00% <ø> (ø)
pandera/backends/base/builtin_checks.py 100.00% <ø> (ø)
pandera/backends/pandas/__init__.py 100.00% <ø> (ø)
pandera/backends/pandas/base.py 100.00% <ø> (ø)
pandera/engines/engine.py 98.18% <ø> (ø)
pandera/extensions.py 100.00% <ø> (+100.00%) ⬆️
... and 61 more

... and 1 file with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

Signed-off-by: Niels Bantilan <niels.bantilan@gmail.com>
@cosmicBboy cosmicBboy mentioned this pull request Jul 5, 2023
@cosmicBboy
Copy link
Collaborator Author

@NeerajMalhotra-QB @jaskaransinghsidana FYI this PR is good to merge onto master!

However, this decreases the pandera code coverage pretty significantly (82.37% of the code changes are covered), bringing down the coverage of the overall codebase by 3.58% (see the coverage report for more details).

We'll definitely need to add more testing of the pyspark modules after the beta release to improve coverage.

@cosmicBboy cosmicBboy merged commit 4d16290 into main Jul 6, 2023
@cosmicBboy
Copy link
Collaborator Author

Somehow the coverage is back up to the original levels (97%)... it might have been a weird issue with codecoverage that I can't reproduce 🤷‍♂️ sorry for the false alarm @NeerajMalhotra-QB @jaskaransinghsidana

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Support pyspark.sql.DataFrame
2 participants