Skip to content

Commit e23d0a9

Browse files
committed
Allow for use of header=None to remove header
1 parent 666cddb commit e23d0a9

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

pointblank/validate.py

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8890,7 +8890,8 @@ def get_step_report(
88908890
from this default, free text can be provided for the header. This will be interpreted as
88918891
Markdown text and transformed internally to HTML. You can provide one of two templating
88928892
elements: `{title}` and `{details}`. The default header has the template
8893-
`"{title}{details}"` so you can easily start from that and modify as you see fit.
8893+
`"{title}{details}"` so you can easily start from that and modify as you see fit. If you
8894+
don't want a header at all, you can set `header=None` to remove it entirely.
88948895
limit
88958896
The number of rows to display for those validation steps that check values in rows (the
88968897
`col_vals_*()` validation steps). The default is `10` rows and the limit can be removed
@@ -10366,7 +10367,10 @@ def _step_report_row_based(
1036610367

1036710368
# TODO: localize all text fragments according to `lang=` parameter
1036810369

10369-
if header == ":default:":
10370+
if header is None:
10371+
pass
10372+
10373+
elif header == ":default:":
1037010374
step_report = step_report.tab_header(
1037110375
title=html(f"Report for Validation Step {i} {CHECK_MARK_SPAN}"),
1037210376
subtitle=html(
@@ -10458,6 +10462,10 @@ def _step_report_row_based(
1045810462
"</div>"
1045910463
)
1046010464

10465+
# If `header` is None then don't add a header and just return the step report
10466+
if header is None:
10467+
return step_report
10468+
1046110469
# Generate the default template text for the header when `":default:"` is used
1046210470
if header == ":default:":
1046310471
header = "{title}{details}"
@@ -10762,6 +10770,10 @@ def _step_report_schema_in_order(
1076210770
if version("great_tables") >= "0.17.0":
1076310771
step_report = step_report.tab_options(quarto_disable_processing=True)
1076410772

10773+
# If `header` is None then don't add a header and just return the step report
10774+
if header is None:
10775+
return step_report
10776+
1076510777
# Get the other parameters for the `col_schema_match()` function
1076610778
case_sensitive_colnames = schema_info["params"]["case_sensitive_colnames"]
1076710779
case_sensitive_dtypes = schema_info["params"]["case_sensitive_dtypes"]
@@ -11167,6 +11179,10 @@ def _step_report_schema_any_order(
1116711179
if version("great_tables") >= "0.17.0":
1116811180
step_report = step_report.tab_options(quarto_disable_processing=True)
1116911181

11182+
# If `header` is None then don't add a header and just return the step report
11183+
if header is None:
11184+
return step_report
11185+
1117011186
# Get the other parameters for the `col_schema_match()` function
1117111187
case_sensitive_colnames = schema_info["params"]["case_sensitive_colnames"]
1117211188
case_sensitive_dtypes = schema_info["params"]["case_sensitive_dtypes"]

0 commit comments

Comments
 (0)