Skip to content

Refactor entity type handling with Literal type #1499

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mhmohona wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Refactor entity type handling with Literal type #1499

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions openml/testing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,17 @@
import unittest
from pathlib import Path
from typing import ClassVar
from typing_extensions import Literal

import requests

import openml
from openml.exceptions import OpenMLServerException
from openml.tasks import TaskType

# Type alias for entity types that can be tracked
EntityType = Literal["run", "data", "flow", "task", "study", "user"]


def _check_dataset(dataset: dict) -> None:
assert isinstance(dataset, dict)
Expand All @@ -37,8 +41,7 @@ class TestBase(unittest.TestCase):
Hopefully soon allows using a test server, not the production server.
"""

# TODO: This could be made more explcit with a TypedDict instead of list[str | int]
publish_tracker: ClassVar[dict[str, list[str | int]]] = {
publish_tracker: ClassVar[dict[EntityType, list[int]]] = {
"run": [],
"data": [],
"flow": [],
Expand Down Expand Up @@ -133,7 +136,7 @@ def tearDown(self) -> None:
@classmethod
def _mark_entity_for_removal(
cls,
entity_type: str,
entity_type: EntityType,
entity_id: int,
entity_name: str | None = None,
) -> None:
Expand All @@ -153,7 +156,7 @@ def _mark_entity_for_removal(
cls.flow_name_tracker.append(entity_name)

@classmethod
def _delete_entity_from_tracker(cls, entity_type: str, entity: int) -> None:
def _delete_entity_from_tracker(cls, entity_type: EntityType, entity: int) -> None:
"""Deletes entity records from the static file_tracker

Given an entity type and corresponding ID, deletes all entries, including
Expand Down