8000 feat: add validation for parameters in configure_formatter · kosiew/datafusion-python@2314613 · GitHub
[go: up one dir, main page]

Skip to content

Commit 2314613

Browse files
committed
feat: add validation for parameters in configure_formatter
1 parent 001988e commit 2314613

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

python/datafusion/html_formatter.py

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -633,6 +633,9 @@ def configure_formatter(**kwargs: Any) -> None:
633633
**kwargs: Formatter configuration parameters like max_cell_length,
634634
max_width, max_height, enable_cell_expansion, etc.
635635
636+
Raises:
637+
ValueError: If any invalid parameters are provided
638+
636639
Example:
637640
>>> from datafusion.html_formatter import configure_formatter
638641
>>> configure_formatter(
@@ -642,6 +645,21 @@ def configure_formatter(**kwargs: Any) -> None:
642645
... use_shared_styles=True
643646
... )
644647
"""
648+
# Valid parameters accepted by DataFrameHtmlFormatter
649+
valid_params = {
650+
"max_cell_length", "max_width", "max_height", "max_memory_bytes",
651+
"min_rows_display", "repr_rows", "enable_cell_expansion", "custom_css",
652+
"show_truncation_message", "style_provider", "use_shared_styles"
653+
}
654+
655+
# Check for invalid parameters
656+
invalid_params = set(kwargs) - valid_params
657+
if invalid_params:
658+
msg = f"Invalid formatter parameters: {', '.join(invalid_params)}. " \
659+
f"Valid parameters are: {', '.join(valid_params)}"
660+
raise ValueError(msg)
661+
662+
# Create and set formatter with validated parameters
645663
set_formatter(DataFrameHtmlFormatter(**kwargs))
646664

647665

0 commit comments

Comments
 (0)
0