feat: dataclass implemented in openmlparameter and openmlsetup class

[rohansen856]

Metadata

• Reference Issue: [ENH] Refactor OpenMLParameter to Use Dataclass #1541
• New Tests Added: No
• Documentation Updated: No
• Change Log Entry:

Details

Edited the OpenMLParameter in openml/setups/setup.py to use @dataclass decorator. This significantly reduces the boilerplate code in the following places:

• OpenMLSetup

Before:

class OpenMLSetup:
    """Setup object (a.k.a. Configuration)...."""

    def __init__(self, setup_id: int, flow_id: int, parameters: dict[int, Any] | None):
        if not isinstance(setup_id, int):
            raise ValueError("setup id should be int")

        if not isinstance(flow_id, int):
            raise ValueError("flow id should be int")

        if parameters is not None and not isinstance(parameters, dict):
            raise ValueError("parameters should be dict")

        self.setup_id = setup_id
        self.flow_id = flow_id
        self.parameters = parameters

After:

@dataclass
class OpenMLSetup:
    """Setup object (a.k.a. Configuration)...."""

    setup_id: int
    flow_id: int
    parameters: dict[int, Any] | None

    def __post_init__(self) -> None:
        if not isinstance(self.setup_id, int):
            raise ValueError("setup id should be int")

        if not isinstance(self.flow_id, int):
            raise ValueError("flow id should be int")

        if self.parameters is not None and not isinstance(self.parameters, dict):
            raise ValueError("parameters should be dict")

• OpenMLParameter

Before:

class OpenMLParameter:
    """Parameter object (used in setup)...."""

    def __init__(  # noqa: PLR0913
        self,
        input_id: int,
        flow_id: int,
        flow_name: str,
        full_name: str,
        parameter_name: str,
        data_type: str,
        default_value: str,
        value: str,
    ):
        self.id = input_id
        self.flow_id = flow_id
        self.flow_name = flow_name
        self.full_name = full_name
        self.parameter_name = parameter_name
        self.data_type = data_type
        self.default_value = default_value
        self.value = value

After:

@dataclass
class OpenMLParameter:
    """Parameter object (used in setup)...."""

    input_id: int
    flow_id: int
    flow_name: str
    full_name: str
    parameter_name: str
    data_type: str
    default_value: str
    value: str

    def __post_init__(self) -> None:
        # Map input_id to id for backward compatibility
        self.id = self.input_id

Tests

For tests, I have used xfail temporarily to bypass the preexisting test failures in tests\test_setups\test_setup_functions.py.

[codecov-commenter]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 52.82%. Comparing base (d421b9e) to head (155bbaa).

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1582      +/-   ##
==========================================
+ Coverage   52.04%   52.82%   +0.78%     
==========================================
  Files          36       36              
  Lines        4333     4339       +6     
==========================================
+ Hits         2255     2292      +37     
+ Misses       2078     2047      -31     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[geetu040]

Changes in openml/setups/setup.py look good. Please revert the changes in tests/test_setups/test_setup_functions.py; they won't be needed once this branch is synced with main. Merging main into this branch should skip those tests and make the CI pass.

[rohansen856]

@geetu040 removed the test file changes. Ready for review.

[geetu040]

LGTM! Should be ready for merge. The failing tests are unrelated.

CC: @fkiraly for review/merge.

[geetu040]

please mention in pr description
Fixes #1541