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.

Sign up for GitHub

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

Jump to bottom

Bugfix/605 IndexError if check raises Exception without args #613

Merged
merged 1 commit into from
Sep 10, 2021
Merged

Bugfix/605 IndexError if check raises Exception without args #613

merged 1 commit into from
Sep 10, 2021

Conversation

jeffzi
Copy link
Collaborator

@jeffzi jeffzi commented Sep 9, 2021 •
edited
Loading

Pandera raises an IndexError during validation if a check raises an Exception that does not have arguments (typically a message). fixes #605

The cause was the following snippet which assumes an exception always has arguments:
https://github.com/pandera-dev/pandera/blob/84ea3c227e638fe36b9e90cbfc5b5632638d4a57/pandera/schemas.py#L1789-L1792

I also appended a traceback in the SchemaError to help users debugging their check (if lazy=False). Let me know if you think that's overkill :)

Example:

import pandas as pd
import pandera as pa


def fail_without_msg(s):
    raise ValueError()


schema = pa.DataFrameSchema(
    {
        "fail": pa.Column(int, pa.Check(fail_without_msg)),
    }
)

schema.validate(pd.DataFrame({"fail": [0]}))
#> Traceback (most recent call last):
#> /tmp/ipykernel_322026/2037979856.py in <module>
#> ----> 1 schema.validate(pd.DataFrame({"fail": [0]}))
#> ...
#> SchemaError: Error while executing check function: ValueError()
#> Traceback (most recent call last):
#>   File "/home/jeffzi/Projects/dev/pandera/pandera/schemas.py", line 1860, in validate
#>     _handle_check_results(
#>   File "/home/jeffzi/Projects/dev/pandera/pandera/schemas.py", line 2179, in _handle_check_results
#>     check_result = check(check_obj, *check_args)
#>   File "/home/jeffzi/Projects/dev/pandera/pandera/checks.py", line 397, in __call__
#>     check_output = check_fn(check_obj)
#>   File "/tmp/ipykernel_322026/35140900.py", line 2, in fail_without_msg
#>     raise ValueError()
#> ValueError

@jeffzi jeffzi changed the base branch from master to dev September 9, 2021 22:47
@jeffzi jeffzi changed the title Bugfix/check error wo arg Bugfix/605 IndexError if check raises Exception without args Sep 9, 2021
@codecov
Copy link

codecov bot commented Sep 9, 2021 •
edited
Loading

Codecov Report

Merging #613 (4ff3b30) into dev (bd0d295) will increase coverage by 0.00%.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##              dev     #613   +/-   ##
=======================================
  Coverage   98.84%   98.84%           
=======================================
  Files          29       29           
  Lines        3380     3382    +2     
=======================================
+ Hits         3341     3343    +2     
  Misses         39       39
Impacted Files Coverage Δ
pandera/schemas.py 99.47% <100.00%> (+<0.01%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update bd0d295...4ff3b30. Read the comment docs.

@jeffzi jeffzi mentioned this pull request Sep 9, 2021
Closed
cosmicBboy
cosmicBboy approved these changes Sep 10, 2021
View reviewed changes
Copy link
Collaborator

@cosmicBboy cosmicBboy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks!

@cosmicBboy cosmicBboy merged commit afa6d30 into unionai-oss:dev Sep 10, 2021
cosmicBboy added a commit that referenced this pull request Sep 10, 2021
@cosmicBboy @tfwillems
@abyz0123 @kvnkho
bugfix release 0.7.1 (#615)
f0ddcbf 
* Unique keyword arg (#580)

* add copy button to docs (#448)

* Add missing inplace arg to SchemaModel's validate (#450)

* link documentation to github (#449)

Co-authored-by: Niels Bantilan <niels.bantilan@gmail.com>

* intermediate commit for review by @cosmicBboy

* link documentation to github (#449)

Co-authored-by: Niels Bantilan <niels.bantilan@gmail.com>

* intermediate commit for review by @cosmicBboy

* WIP

* fix test errors, re-factor allow_duplicates handling

* fix io tests

* fix docs, remove _allow_duplicates private var

* update unique type signature in strategies

* completing tests for setters and lazy evaluation of unique kw

* small fix for the linting errors

* support dataframe-level uniqueness in strategies

* add docs, fix error formatting, add multiindex support

Co-authored-by: Jean-Francois Zinque <jzinque@gmail.com>
Co-authored-by: tfwillems <tfwillems@users.noreply.github.com>
Co-authored-by: fkroll8 <13244820+fkrull8@users.noreply.github.com>
Co-authored-by: fkroll8 <kent.troutman@tuta.io>

* Add support for timezone-aware datetime strategies (#595)

* add support for Any annotation in schema model (#594)

* add support for Any annotation in schema model

the motivation behind this feature is to support column annotations
that can have any type, to support use cases like the one described
in #592, where
custom checks can be applied to any column except for ones that
are explicitly defined in the schema model class attributes

* update pylint, fix lint

* Docs/scaling - Bring Pandera to Spark and Dask (#588)

* scaling.rst

* edited conf

* finished first pass

* removing FugueWorkflow

* Update index.rst

* Update docs/source/scaling.rst

Co-authored-by: Niels Bantilan <niels.bantilan@gmail.com>

* add support for timezone-aware datetime strategies

* fix le/ge strategies with datetime

* fix mypy errors

Co-authored-by: Niels Bantilan <niels.bantilan@gmail.com>
Co-authored-by: Kevin Kho <kdykho@gmail.com>

* schemas with multi-index columns correctly report errors (#600)

fixes #589

* strategies module supports undefined checks in regex columns (#599)

* Add support for empty data type annotation in SchemaModel (#602)

* remove artifacts of py3.6 support

* add support for empty data type annotation in SchemaModel

* fix frictionless version in dev dependencies

* fix setuptools version instead of frictionless

* fix setuptools pinning

* remove frictionless from core pandera deps (#609)

* support frictionless primary keys with multiple fields (#608)

* fix validation of check raising error without message (#613)

* docs/requirements.txt pin setuptools (#611)

* bump version 0.7.1

Co-authored-by: Jean-Francois Zinque <jzinque@gmail.com>
Co-authored-by: tfwillems <tfwillems@users.noreply.github.com>
Co-authored-by: fkroll8 <13244820+fkrull8@users.noreply.github.com>
Co-authored-by: fkroll8 <kent.troutman@tuta.io>
Co-authored-by: Kevin Kho <kdykho@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cosmicBboy cosmicBboy cosmicBboy approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jeffzi @cosmicBboy