overview of checks attached to a schema

[fbuters]

Hey everyone,

Does Pandera already have functionality to quickly generate an overview of which checks are already attached to a schema?
Background of my question:
When calling schema.validate(df), only failures are reported, while I would also be interested in reporting back which checks are actually passed.

Any help or pointers to known solutions are appreciated!
Frank

[cosmicBboy]

Hi @fbuters pandera currently doesn't have any way of generating a report of all checks that passed/failed... I'm curious to learn how exactly you want to use this sort of feature... are you generating reports for human-readability?

The validate method returns the data if it's valid and raises a SchemaError(s) exception if it fails... what kind of UX would make sense to you for reporting both succeeded checks and failures?

[fbuters]

Hey @cosmicBboy, I would like show to end-users also the set of checks which the data is validated against. Consumers of data gain more confidence when there is feedback showing which checks are implemented and showing the outcome, also when the checks pass. In this scenario, the consumers of the data are not the developers of the data pipelines.

[cosmicBboy]

yep, makes sense! A few questions though:

• do you imagine this to be stdout output, some sort of html report, or something else?
• do you imagine this as a separate method, or as an optional side-effect in the schema.validate call?

[stdiff]

Hi, I am also interested in the information about successful test cases.

What I want is an extension of the "Schema Error Summary" in Lazy validation. In the case of the example of the linked documentation, we have (at least) 7 test criteria: the presence of all columns, 4 data types and 2 constraints of values. So the summary is a DataFrame with 7 rows, and each row corresponds to a single test criterion.

It would be good that the summary is just a DataFrame rather than stdout output or an HTML report. This is because we can store the summary in a database and show it on a Dashboard (e.g. Streamlit).

[crnudal]

Very interested in this topic!
Have there been any updates on this?
I totally see how something like this might be redundant from a pure data validation point of view, but in a corporate context, being able to show something like this to customers adds huge value!

On a side note, just discovered Pandera and I honestly wish I would have earlier in my career.