data_designer.config.exportable_config

Module Contents

Name	Description
`ExportableConfigBase`	!!! abstract “Usage Documentation” Models

1 class data_designer.config.exportable_config.ExportableConfigBase(
2     /,
3     **data: typing.Any
4 )

Bases: data_designer.config.base.ConfigBase

1 to_dict() -> dict[str, typing.Any]

Convert the configuration to a dictionary.

Returns:

dict[str, typing.Any]

A dictionary representation of the configuration using JSON-compatible serialization.

1 to_yaml(
2     path: str | pathlib.Path | None = None,
3     *,
4     indent: int | None = 2,
5     **kwargs
6 ) -> str | None

Convert the configuration to a YAML string or file.

Parameters:

path

str | pathlib.Path | NoneDefaults to None

Optional file path to write the YAML to. If None, returns the YAML string instead of writing to file.

indent

int | NoneDefaults to 2

Number of spaces for YAML indentation. Defaults to 2.

**kwargs

Additional keyword arguments passed to yaml.dump().

Returns:

str | None

The YAML string if path is None, otherwise None (file is written).

1 to_json(
2     path: str | pathlib.Path | None = None,
3     *,
4     indent: int | None = 2,
5     **kwargs
6 ) -> str | None

Convert the configuration to a JSON string or file.

Parameters:

path

str | pathlib.Path | NoneDefaults to None

Optional file path to write the JSON to. If None, returns the JSON string instead of writing to file.

indent

int | NoneDefaults to 2

Number of spaces for JSON indentation. Defaults to 2.

**kwargs

Additional keyword arguments passed to json.dumps().

Returns:

str | None

The JSON string if path is None, otherwise None (file is written).

1	class data_designer.config.exportable_config.ExportableConfigBase(
2	/,
3	**data: typing.Any
4	)

1	to_yaml(
2	path: str \| pathlib.Path \| None = None,
3	*,
4	indent: int \| None = 2,
5	**kwargs
6	) -> str \| None

1	to_json(
2	path: str \| pathlib.Path \| None = None,
3	*,
4	indent: int \| None = 2,
5	**kwargs
6	) -> str \| None