feat: when using from table to time series feature must be given (#572)

Closes #571 ### Summary of Changes TimeSeries no longer is subclass of TaggedTable only of Table  --------- Co-authored-by: megalinter-bot <[email protected]>
Safe-DS · Mar 18, 2024 · ca23f0f · ca23f0f
1 parent f6a3ca7
commit ca23f0f
Show file tree

Hide file tree

Showing 50 changed files with 486 additions and 515 deletions.
diff --git a/src/safeds/data/tabular/containers/_table.py b/src/safeds/data/tabular/containers/_table.py
@@ -1,8 +1,8 @@
 from __future__ import annotations
 
-import sys
 import functools
 import io
+import sys
 import warnings
 from pathlib import Path
 from typing import TYPE_CHECKING, Any, TypeVar
@@ -1774,7 +1774,7 @@ def time_columns(self, target_name: str, time_name: str, feature_names: list[str
         """
         from ._time_series import TimeSeries
 
-        return TimeSeries._from_table_to_time_series(self, target_name, time_name, feature_names)
+        return TimeSeries._from_table(self, target_name, time_name, feature_names)
 
     def transform_column(self, name: str, transformer: Callable[[Row], Any]) -> Table:
         """

diff --git a/src/safeds/data/tabular/containers/_time_series.py b/src/safeds/data/tabular/containers/_time_series.py
diff --git a/tests/helpers/_assertions.py b/tests/helpers/_assertions.py
@@ -53,7 +53,8 @@ def assert_that_time_series_are_equal(table1: TimeSeries, table2: TimeSeries) ->
         The timeseries to compare the first timeseries to.
     """
     assert table1.schema == table2.schema
-    assert table1.features == table2.features
-    assert table1.target == table2.target
+    assert table1._feature_names == table2._feature_names
+    assert table1.features == table2._features
+    assert table1.target == table2._target
     assert table1.time == table2.time
     assert table1 == table2
diff --git a/tests/safeds/data/tabular/containers/_table/_tagged_table/_time_series/test_eq.py b/tests/safeds/data/tabular/containers/_table/_tagged_table/_time_series/test_eq.py
diff --git a/tests/safeds/data/tabular/containers/_table/_tagged_table/_time_series/test_hash.py b/tests/safeds/data/tabular/containers/_table/_tagged_table/_time_series/test_hash.py
diff --git a/tests/safeds/data/tabular/containers/_table/_tagged_table/_time_series/test_sizeof.py b/tests/safeds/data/tabular/containers/_table/_tagged_table/_time_series/test_sizeof.py
diff --git a/...le/_tagged_table/_time_series/__init__.py → ...bular/containers/_time_series/__init__.py b/...le/_tagged_table/_time_series/__init__.py → ...bular/containers/_time_series/__init__.py
diff --git a/...est_plot_lag/test_should_return_table.png → ...est_plot_lag/test_should_return_table.png b/...est_plot_lag/test_should_return_table.png → ...est_plot_lag/test_should_return_table.png
diff --git a/...lot_lineplot/test_should_plot_feature.png → ...lot_lineplot/test_should_plot_feature.png b/...lot_lineplot/test_should_plot_feature.png → ...lot_lineplot/test_should_plot_feature.png
diff --git a/...t_lineplot/test_should_plot_feature_x.png → ...t_lineplot/test_should_plot_feature_x.png b/...t_lineplot/test_should_plot_feature_x.png → ...t_lineplot/test_should_plot_feature_x.png
diff --git a/...t_lineplot/test_should_plot_feature_y.png → ...t_lineplot/test_should_plot_feature_y.png b/...t_lineplot/test_should_plot_feature_y.png → ...t_lineplot/test_should_plot_feature_y.png
diff --git a/...lot_lineplot/test_should_return_table.png → ...lot_lineplot/test_should_return_table.png b/...lot_lineplot/test_should_return_table.png → ...lot_lineplot/test_should_return_table.png
diff --git a/...ineplot/test_should_return_table_both.png → ...ineplot/test_should_return_table_both.png b/...ineplot/test_should_return_table_both.png → ...ineplot/test_should_return_table_both.png
diff --git a/..._scatterplot/test_should_plot_feature.png → ..._scatterplot/test_should_plot_feature.png b/..._scatterplot/test_should_plot_feature.png → ..._scatterplot/test_should_plot_feature.png
diff --git a/...lot/test_should_plot_feature_both_set.png → ...lot/test_should_plot_feature_both_set.png b/...lot/test_should_plot_feature_both_set.png → ...lot/test_should_plot_feature_both_set.png
diff --git a/...rplot/test_should_plot_feature_only_x.png → ...rplot/test_should_plot_feature_only_x.png b/...rplot/test_should_plot_feature_only_x.png → ...rplot/test_should_plot_feature_only_x.png
diff --git a/...t_should_plot_feature_only_y_optional.png → ...t_should_plot_feature_only_y_optional.png b/...t_should_plot_feature_only_y_optional.png → ...t_should_plot_feature_only_y_optional.png
diff --git a/..._scatterplot/test_should_return_table.png → ..._scatterplot/test_should_return_table.png b/..._scatterplot/test_should_return_table.png → ..._scatterplot/test_should_return_table.png
diff --git a/...ged_table/_time_series/test_add_column.py → ...ontainers/_time_series/test_add_column.py b/...ged_table/_time_series/test_add_column.py → ...ontainers/_time_series/test_add_column.py
@@ -28,7 +28,7 @@
                 },
                 target_name="target",
                 time_name="time",
-                feature_names=["feature_1"],
+                feature_names=None,
             ),
         ),
     ],

diff --git a/...time_series/test_add_column_as_feature.py → ...time_series/test_add_column_as_feature.py b/...time_series/test_add_column_as_feature.py → ...time_series/test_add_column_as_feature.py
diff --git a/...ed_table/_time_series/test_add_columns.py → ...ntainers/_time_series/test_add_columns.py b/...ed_table/_time_series/test_add_columns.py → ...ntainers/_time_series/test_add_columns.py
@@ -29,7 +29,7 @@
                 },
                 "target",
                 "time",
-                ["feature_1"],
+                None,
             ),
         ),
     ],

diff --git a/...me_series/test_add_columns_as_features.py → ...me_series/test_add_columns_as_features.py b/...me_series/test_add_columns_as_features.py → ...me_series/test_add_columns_as_features.py
diff --git a/...tagged_table/_time_series/test_add_row.py → ...r/containers/_time_series/test_add_row.py b/...tagged_table/_time_series/test_add_row.py → ...r/containers/_time_series/test_add_row.py
diff --git a/...agged_table/_time_series/test_add_rows.py → .../containers/_time_series/test_add_rows.py b/...agged_table/_time_series/test_add_rows.py → .../containers/_time_series/test_add_rows.py
diff --git a/...agged_table/_time_series/test_as_table.py → .../containers/_time_series/test_as_table.py b/...agged_table/_time_series/test_as_table.py → .../containers/_time_series/test_as_table.py
diff --git a/tests/safeds/data/tabular/containers/_time_series/test_eq.py b/tests/safeds/data/tabular/containers/_time_series/test_eq.py
@@ -0,0 +1,100 @@
+from typing import Any
+
+import pytest
+from safeds.data.tabular.containers import Row, Table, TaggedTable, TimeSeries
+
+
+@pytest.mark.parametrize(
+    ("table1", "table2", "expected"),
+    [
+        (
+            TimeSeries({"a": [], "b": [], "c": []}, "b", "c", ["a"]),
+            TimeSeries({"a": [], "b": [], "c": []}, "b", "c", ["a"]),
+            True,
+        ),
+        (
+            TimeSeries({"a": [1, 2, 3], "b": [4, 5, 6], "c": [7, 8, 9]}, "b", "c", ["a"]),
+            TimeSeries({"a": [1, 2, 3], "b": [4, 5, 6], "c": [7, 8, 9]}, "b", "c", ["a"]),
+            True,
+        ),
+        (
+            TimeSeries({"a": [1, 2, 3], "b": [4, 5, 6], "c": [7, 8, 9], "d": [10, 11, 12]}, "b", "d", ["a"]),
+            TimeSeries({"a": [1, 2, 3], "b": [4, 5, 6], "c": [7, 8, 9], "d": [10, 11, 12]}, "c", "d", ["a"]),
+            False,
+        ),
+        (
+            TimeSeries({"a": [1, 2, 3], "b": [4, 5, 6], "c": [7, 8, 9], "d": [10, 11, 12]}, "b", "c", ["a"]),
+            TimeSeries({"a": [1, 2, 3], "b": [4, 5, 6], "c": [7, 8, 9], "e": [10, 11, 12]}, "b", "c", ["a"]),
+            False,
+        ),
+        (
+            TimeSeries({"a": [1, 2, 3], "b": [4, 5, 6], "c": [7, 8, 9]}, "b", "c", ["a"]),
+            TimeSeries({"a": [1, 1, 3], "b": [4, 5, 6], "c": [7, 8, 9]}, "b", "c", ["a"]),
+            False,
+        ),
+        (
+            TimeSeries({"a": [1, 2, 3], "b": [4, 5, 6], "c": [7, 8, 9]}, "b", "c", ["a"]),
+            TimeSeries({"a": ["1", "2", "3"], "b": [4, 5, 6], "c": [7, 8, 9]}, "b", "c", ["a"]),
+            False,
+        ),
+        (
+            TimeSeries({"a": [1, 2, 3], "b": [4, 5, 6], "c": [7, 8, 9], "d": [10, 11, 12]}, "b", "d", ["a"]),
+            TimeSeries({"a": [1, 2, 3], "b": [4, 5, 6], "c": [7, 8, 9], "d": [10, 11, 12]}, "b", "d", ["c"]),
+            False,
+        ),
+        (
+            TimeSeries({"a": [1, 2, 3], "b": [4, 5, 6], "c": [7, 8, 9], "d": [10, 11, 12]}, "b", "d", ["a"]),
+            TimeSeries({"a": [1, 2, 3], "b": [4, 5, 6], "c": [7, 8, 9], "d": [10, 11, 12]}, "b", "c", ["a"]),
+            False,
+        ),
+    ],
+    ids=[
+        "rowless table",
+        "equal tables",
+        "different target",
+        "different column names",
+        "different values",
+        "different types",
+        "different features",
+        "different time",
+    ],
+)
+def test_should_return_whether_two_tagged_tables_are_equal(
+    table1: TimeSeries,
+    table2: TimeSeries,
+    expected: bool,
+) -> None:
+    assert (table1.__eq__(table2)) == expected
+
+
+@pytest.mark.parametrize(
+    "table1",
+    [TimeSeries({"a": [], "b": [], "c": []}, "b", "c", ["a"])],
+    ids=[
+        "any",
+    ],
+)
+def test_should_return_true_if_objects_are_identical(table1: TimeSeries) -> None:
+    assert (table1.__eq__(table1)) is True
+
+
+@pytest.mark.parametrize(
+    ("table", "other"),
+    [
+        (TimeSeries({"a": [1, 2, 3], "b": [4, 5, 6], "c": [7, 8, 9]}, "b", "c", ["a"]), None),
+        (TimeSeries({"a": [1, 2, 3], "b": [4, 5, 6], "c": [7, 8, 9]}, "b", "c", ["a"]), Row()),
+        (TimeSeries({"a": [1, 2, 3], "b": [4, 5, 6], "c": [7, 8, 9]}, "b", "c", ["a"]), Table()),
+        (
+            TimeSeries({"a": [1, 2, 3], "b": [4, 5, 6], "c": [7, 8, 9]}, "b", "c", ["a"]),
+            TaggedTable({"a": [1, 2, 3], "b": [4, 5, 6]}, "b", ["a"]),
+        ),
+    ],
+    ids=[
+        "TimeSeries vs. None",
+        "TimeSeries vs. Row",
+        "TimeSeries vs. Table",
+        "TimeSeries vs. TaggedTable",
+    ],
+)
+def test_should_return_not_implemented_if_other_is_not_tagged_table(table: TimeSeries, other: Any) -> None:
+    assert (table.__eq__(other)) is NotImplemented
diff --git a/...agged_table/_time_series/test_features.py → .../containers/_time_series/test_features.py b/...agged_table/_time_series/test_features.py → .../containers/_time_series/test_features.py
@@ -16,6 +16,7 @@
                 },
                 target_name="T",
                 time_name="time",
+                feature_names=["A", "B", "C"],
             ),
             Table({"A": [1, 4], "B": [2, 5], "C": [3, 6]}),
         ),

diff --git a/...ed_table/_time_series/test_filter_rows.py → ...ntainers/_time_series/test_filter_rows.py b/...ed_table/_time_series/test_filter_rows.py → ...ntainers/_time_series/test_filter_rows.py
diff --git a/..._series/test_from_table_to_time_series.py → ..._series/test_from_table_to_time_series.py b/..._series/test_from_table_to_time_series.py → ..._series/test_from_table_to_time_series.py
@@ -52,36 +52,7 @@
             "time",
             ["A", "B", "C"],
             ValueError,
-            r"Column 'A' cannot be both feature and target.",
-        ),
-        (
-            Table(
-                {
-                    "time": [0, 1],
-                    "A": [1, 4],
-                    "B": [2, 5],
-                    "C": [3, 6],
-                    "T": [0, 1],
-                },
-            ),
-            "A",
-            "time",
-            [],
-            ValueError,
-            r"At least one feature column must be specified.",
-        ),
-        (
-            Table(
-                {
-                    "time": [0, 1],
-                    "A": [1, 4],
-                },
-            ),
-            "A",
-            "time",
-            None,
-            ValueError,
-            r"At least one feature column must be specified.",
+            r"Column 'A' can not be target and feature column.",
         ),
         (
             Table(
@@ -120,8 +91,6 @@
         "feature_does_not_exist",
         "target_does_not_exist",
         "target_and_feature_overlap",
-        "features_are_empty-explicitly",
-        "features_are_empty_implicitly",
         "time_does_not_exist",
         "time_is_also_feature",
     ],
@@ -135,7 +104,7 @@ def test_should_raise_error(
     error_msg: str,
 ) -> None:
     with pytest.raises(error, match=error_msg):
-        TimeSeries._from_table_to_time_series(
+        TimeSeries._from_table(
             table,
             target_name=target_name,
             time_name=time_name,
@@ -186,7 +155,7 @@ def test_should_raise_error(
             ),
             "T",
             "time",
-            None,
+            ["B"],
         ),
     ],
     ids=["create_tagged_table", "tagged_table_not_all_columns_are_features", "tagged_table_with_feature_names_as_None"],
@@ -197,7 +166,7 @@ def test_should_create_a_tagged_table(
     time_name: str,
     feature_names: list[str] | None,
 ) -> None:
-    time_series = TimeSeries._from_table_to_time_series(
+    time_series = TimeSeries._from_table(
         table,
         target_name=target_name,
         time_name=time_name,

diff --git a/...le/_time_series/test_from_tagged_table.py → ...rs/_time_series/test_from_tagged_table.py b/...le/_time_series/test_from_tagged_table.py → ...rs/_time_series/test_from_tagged_table.py