data_designer.config.utils.misc

Module Contents

Functions

Name	Description
`kebab_to_snake`	None
`template_error_handler`	None
`assert_valid_jinja2_template`	Raises an error if the template cannot be parsed.
`is_notebook_environment`	Returns True if running inside a Jupyter/IPython notebook.
`can_run_data_designer_locally`	Returns True if Data Designer can be run locally, False otherwise.
`extract_keywords_from_jinja2_template`	Extract all keywords from a valid Jinja2 template.
`json_indent_list_of_strings`	Convert a list of column names to a JSON string if the list is long.

Data

REPR_LIST_LENGTH_USE_JSON

API

1 REPR_LIST_LENGTH_USE_JSON = 4

1 data_designer.config.utils.misc.kebab_to_snake(s: str) -> str

1 data_designer.config.utils.misc.template_error_handler()

1 data_designer.config.utils.misc.assert_valid_jinja2_template(template: str) -> None

Raises an error if the template cannot be parsed.

1 data_designer.config.utils.misc.is_notebook_environment() -> bool

Returns True if running inside a Jupyter/IPython notebook.

1 data_designer.config.utils.misc.can_run_data_designer_locally() -> bool

Returns True if Data Designer can be run locally, False otherwise.

1 data_designer.config.utils.misc.extract_keywords_from_jinja2_template(template: str) -> set[str]

Extract all keywords from a valid Jinja2 template.

1 data_designer.config.utils.misc.json_indent_list_of_strings(
2     column_names: list[str],
3     *,
4     indent: int | str | None = None
5 ) -> list[str] | str | None

Convert a list of column names to a JSON string if the list is long.

This function helps keep Data Designer’s repr output clean and readable.

Parameters:

column_names

list[str]

List of column names.

indent

int | str | NoneDefaults to None

Indentation for the JSON string.

Returns:

list[str] | str | None

A list of column names or a JSON string if the list is long.

1	data_designer.config.utils.misc.json_indent_list_of_strings(
2	column_names: list[str],
3	*,
4	indent: int \| str \| None = None
5	) -> list[str] \| str \| None