Skip to content

Conversation

@rich-iannone
Copy link
Member

@rich-iannone rich-iannone commented Mar 27, 2025

This PR makes it so the text of the brief= parameter is displayed in the validation report table. We also make the brief= arg more flexible: True yields the automatically-generated brief (the 'autobrief') and we could use a few more templating params (e.g., "{auto}") when adding the brief= as a string.

Here's an example of how this works (and how it looks):

import pointblank as pb

validation = (
    pb.Validate(
        data=pb.load_dataset(dataset="small_table", tbl_type="polars"),
        tbl_name="small_table"
    )
    .col_vals_gt(columns="d", value=1000)
    .col_vals_le(columns="c", value=5, brief=True)
    .col_exists(columns=["date", "date_time"], brief="**A Brief**: {auto}")
    .interrogate()
)

validation
image

Fixes: #125

@rich-iannone rich-iannone changed the title feat: add text of brief to validation report table; enable more templating of brief feat: add text of brief to validation report table; enable more templating features for brief= Mar 27, 2025
@codecov-commenter
Copy link

codecov-commenter commented Mar 27, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.04%. Comparing base (2a69672) to head (ae4827a).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #127   +/-   ##
=======================================
  Coverage   99.03%   99.04%           
=======================================
  Files          17       17           
  Lines        3619     3648   +29     
=======================================
+ Hits         3584     3613   +29     
  Misses         35       35           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@rich-iannone rich-iannone marked this pull request as ready for review March 27, 2025 22:03
@rich-iannone rich-iannone merged commit 1f0fb23 into main Mar 27, 2025
5 checks passed
@rich-iannone rich-iannone deleted the feat-add-brief-to-report branch March 27, 2025 22:05
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.

Add custom messages for steps

3 participants