BUG- Missing documentation for Polars

[FlorianJacta]

Bug description
Release notes mentionned that we now support Polars but I have no idea how to use it. I tried putting different strings in exposed type without success.

Either this feature does not exist at all and this is an error inside the doc or if it exists, there are no ways to know how to use it.

This is also what I get when I try to run a code using polars.

[2024-12-04 11:14:00.518][Taipy][ERROR] The `exposed_type` of DataNodeConfig `output_data` must be either "pandas", "numpy", or a custom type. Current value of property `exposed_type` is "polars.LazyFrame".
Configuration errors found. Please check the error log for more information.

Polars is not mentionned.

Test Code:

from taipy import Config, Gui
import taipy.gui.builder as tgb
import taipy as tp


def handle_preprocessing(data):
    # some polars code to preprocess data

    return data


input_data_cfg = Config.configure_data_node(
    id="input_data",
    storage_type="csv",
    default_data={"a": [1, 2, 3], "b": [4, 5, 6]},
    exposed_type="polars.LazyFrame",
)

output_data_cfg = Config.configure_data_node(
    id="output_data",
    storage_type="csv",
    exposed_type="polars.LazyFrame",
)

scenario_cfg = Config.configure_scenario(
    id="scenario",
    task_configs=[
        Config.configure_task(
            id="task",
            input=input_data_cfg,
            output=output_data_cfg,
            function=handle_preprocessing,
        )
    ],
)

if __name__ == "__main__":
    tp.Orchestrator().run()
    scenario = tp.create_scenario(scenario_cfg)
    with tgb.Page() as page:
        tgb.scenario_selector("{scenario}")
        tgb.scenario("{scenario}")

        tgb.data_node(
            lambda scenario: scenario.output_data if scenario is not None else None
        )

        tgb.chart(
            lambda scenario: (
                scenario.output_data.read() if scenario is not None else None
            )
        )

    Gui(page).run()

[jrobinAV]

Must be documented on both develop and 4.0.X versions.

[FlorianJacta]

Should you be assigned to this and have this issue in review/Q&A? @toan-quach

[github-actions]

This issue has been labelled as "🥶Waiting for contributor" because it has been inactive for more than 14 days. If you would like to continue working on this issue, please add another comment or create a PR that links to this issue. If a PR has already been created which refers to this issue, then you should explicitly mention this issue in the relevant PR. Otherwise, you will be unassigned in 14 days. For more information please refer to the contributing guidelines.

[jrobinAV]

@toan-quach @FlorianJacta Is this issue solved?

[FlorianJacta]

Is there a PR on it?

[toan-quach]

@jrobinAV nope not yet, have added to all of the messages raise but not the docstring since this will require changes to the ones in taipy, or a way to inject polars into it. Is it necessary? as I noticed we don't specify all the exposed types in the docstring.

[jrobinAV]

No. The docstring is not mandatory, but we must update the user manual. Pages data node config and data node usage.