feat: add _file suffix to methods interacting with files (#103)

### Summary of Changes

In `Table`:
* Rename `to_csv` to `to_csv_file`
* Rename `to_json` to `to_json_file`
* Rename `from_csv` to `from_csv_file`
* Rename `from_json` to `from_json_file`
* Rename `path_to_file` parameters to `path`

---------

Co-authored-by: lars-reimann <[email protected]>

docs/tutorials/data_processing.ipynb

@@ -29,7 +29,7 @@
    "source": [
     "from safeds.data.tabular.containers import Table\n",
     "\n",
-    "titanic = Table.from_csv(\"data/titanic.csv\")"
+    "titanic = Table.from_csv_file(\"data/titanic.csv\")"
    ],
    "metadata": {
     "collapsed": false

docs/tutorials/data_visualization.ipynb

@@ -22,7 +22,7 @@
    "source": [
     "from safeds.data.tabular.containers import Table\n",
     "\n",
-    "titanic = Table.from_csv(\"data/titanic.csv\")"
+    "titanic = Table.from_csv_file(\"data/titanic.csv\")"
    ],
    "metadata": {
     "collapsed": false,

src/safeds/data/tabular/containers/_table.py

@@ -52,7 +52,7 @@ class Table:
     # ------------------------------------------------------------------------------------------------------------------
 
     @staticmethod
-    def from_csv(path: str) -> Table:
+    def from_csv_file(path: str) -> Table:
         """
         Read data from a CSV file into a table.
 
@@ -82,7 +82,7 @@ def from_csv(path: str) -> Table:
             raise ValueError(f'Could not read file from "{path}" as CSV') from exception
 
     @staticmethod
-    def from_json(path: str) -> Table:
+    def from_json_file(path: str) -> Table:
         """
         Read data from a JSON file into a table.
 
@@ -1023,37 +1023,37 @@ def scatterplot(self, x_column_name: str, y_column_name: str) -> None:
     # Conversion
     # ------------------------------------------------------------------------------------------------------------------
 
-    def to_csv(self, path_to_file: str) -> None:
+    def to_csv_file(self, path: str) -> None:
         """
         Write the data from the table into a CSV file.
         If the file and/or the directories do not exist they will be created.
         If the file already exists it will be overwritten.
 
         Parameters
         ----------
-        path_to_file : str
+        path : str
             The path to the output file.
         """
-        Path(os.path.dirname(path_to_file)).mkdir(parents=True, exist_ok=True)
+        Path(os.path.dirname(path)).mkdir(parents=True, exist_ok=True)
         data_to_csv = self._data.copy()
         data_to_csv.columns = self._schema.get_column_names()
-        data_to_csv.to_csv(path_to_file, index=False)
+        data_to_csv.to_csv(path, index=False)
 
-    def to_json(self, path_to_file: str) -> None:
+    def to_json_file(self, path: str) -> None:
         """
         Write the data from the table into a JSON file.
         If the file and/or the directories do not exist, they will be created.
         If the file already exists it will be overwritten.
 
         Parameters
         ----------
-        path_to_file : str
+        path : str
             The path to the output file.
         """
-        Path(os.path.dirname(path_to_file)).mkdir(parents=True, exist_ok=True)
+        Path(os.path.dirname(path)).mkdir(parents=True, exist_ok=True)
         data_to_json = self._data.copy()
         data_to_json.columns = self._schema.get_column_names()
-        data_to_json.to_json(path_to_file)
+        data_to_json.to_json(path)
 
     def to_columns(self) -> list[Column]:
         """

tests/safeds/data/tabular/containers/_row/test_has_column.py

@@ -3,12 +3,12 @@
 
 
 def test_has_column_positive() -> None:
-    table = Table.from_csv(resolve_resource_path("test_table_has_column.csv"))
+    table = Table.from_csv_file(resolve_resource_path("test_table_has_column.csv"))
     row = table.to_rows()[0]
     assert row.has_column("A")
 
 
 def test_has_column_negative() -> None:
-    table = Table.from_csv(resolve_resource_path("test_table_has_column.csv"))
+    table = Table.from_csv_file(resolve_resource_path("test_table_has_column.csv"))
     row = table.to_rows()[0]
     assert not row.has_column("C")

tests/safeds/data/tabular/containers/_table/test_column_drop.py

@@ -5,14 +5,14 @@
 
 
 def test_table_column_drop() -> None:
-    table = Table.from_csv(resolve_resource_path("test_table_read_csv.csv"))
+    table = Table.from_csv_file(resolve_resource_path("test_table_from_csv_file.csv"))
     transformed_table = table.drop_columns(["A"])
     assert transformed_table.schema.has_column(
         "B"
     ) and not transformed_table.schema.has_column("A")
 
 
 def test_table_column_drop_warning() -> None:
-    table = Table.from_csv(resolve_resource_path("test_table_read_csv.csv"))
+    table = Table.from_csv_file(resolve_resource_path("test_table_from_csv_file.csv"))
     with pytest.raises(UnknownColumnNameError):
         table.drop_columns(["C"])

tests/safeds/data/tabular/containers/_table/test_drop_duplicate_rows.py

@@ -13,6 +13,6 @@
 )
 def test_drop_duplicate_rows(path: str) -> None:
     expected_table = Table(pd.DataFrame(data={"A": [1, 4], "B": [2, 5]}))
-    table = Table.from_csv(resolve_resource_path(path))
+    table = Table.from_csv_file(resolve_resource_path(path))
     result_table = table.drop_duplicate_rows()
     assert expected_table == result_table

tests/safeds/data/tabular/containers/_table/test_from_columns.py

@@ -6,7 +6,7 @@
 
 
 def test_from_columns() -> None:
-    table_expected = Table.from_csv(resolve_resource_path("test_column_table.csv"))
+    table_expected = Table.from_csv_file(resolve_resource_path("test_column_table.csv"))
     columns_table: list[Column] = [
         Column(pd.Series([1, 4]), "A"),
         Column(pd.Series([2, 5]), "B"),

tests/safeds/data/tabular/containers/_table/test_from_csv_file.py

@@ -0,0 +1,18 @@
+import pytest
+from safeds.data.tabular.containers import Table
+from tests.fixtures import resolve_resource_path
+
+
+def test_from_csv_file_valid() -> None:
+    table = Table.from_csv_file(resolve_resource_path("test_table_from_csv_file.csv"))
+    assert (
+        table.get_column("A").get_value(0) == 1
+        and table.get_column("B").get_value(0) == 2
+    )
+
+
+def test_from_csv_file_invalid() -> None:
+    with pytest.raises(FileNotFoundError):
+        Table.from_csv_file(
+            resolve_resource_path("test_table_from_csv_file_invalid.csv")
+        )

tests/safeds/data/tabular/containers/_table/test_from_json_file.py

@@ -0,0 +1,20 @@
+import pytest
+from safeds.data.tabular.containers import Table
+from tests.fixtures import resolve_resource_path
+
+
+def test_from_json_file_valid() -> None:
+    table = Table.from_json_file(
+        resolve_resource_path("test_table_from_json_file.json")
+    )
+    assert (
+        table.get_column("A").get_value(0) == 1
+        and table.get_column("B").get_value(0) == 2
+    )
+
+
+def test_from_json_file_invalid() -> None:
+    with pytest.raises(FileNotFoundError):
+        Table.from_json_file(
+            resolve_resource_path("test_table_from_json_file_invalid.json")
+        )

tests/safeds/data/tabular/containers/_table/test_from_rows.py

@@ -5,7 +5,7 @@
 
 
 def test_from_rows() -> None:
-    table_expected = Table.from_csv(resolve_resource_path("test_row_table.csv"))
+    table_expected = Table.from_csv_file(resolve_resource_path("test_row_table.csv"))
     rows_is: list[Row] = table_expected.to_rows()
     table_is: Table = Table.from_rows(rows_is)
 

tests/safeds/data/tabular/containers/_table/test_get_row.py

@@ -5,18 +5,18 @@
 
 
 def test_get_row() -> None:
-    table = Table.from_csv(resolve_resource_path("test_table_read_csv.csv"))
+    table = Table.from_csv_file(resolve_resource_path("test_table_from_csv_file.csv"))
     val = table.get_row(0)
     assert val.get_value("A") == 1 and val.get_value("B") == 2
 
 
 def test_get_row_negative_index() -> None:
-    table = Table.from_csv(resolve_resource_path("test_table_read_csv.csv"))
+    table = Table.from_csv_file(resolve_resource_path("test_table_from_csv_file.csv"))
     with pytest.raises(IndexOutOfBoundsError):
         table.get_row(-1)
 
 
 def test_get_row_out_of_bounds_index() -> None:
-    table = Table.from_csv(resolve_resource_path("test_table_read_csv.csv"))
+    table = Table.from_csv_file(resolve_resource_path("test_table_from_csv_file.csv"))
     with pytest.raises(IndexOutOfBoundsError):
         table.get_row(5)

tests/safeds/data/tabular/containers/_table/test_has_column.py

@@ -3,10 +3,10 @@
 
 
 def test_has_column_positive() -> None:
-    table = Table.from_csv(resolve_resource_path("test_table_has_column.csv"))
+    table = Table.from_csv_file(resolve_resource_path("test_table_has_column.csv"))
     assert table.has_column("A")
 
 
 def test_has_column_negative() -> None:
-    table = Table.from_csv(resolve_resource_path("test_table_has_column.csv"))
+    table = Table.from_csv_file(resolve_resource_path("test_table_has_column.csv"))
     assert not table.has_column("C")

tests/safeds/data/tabular/containers/_table/test_keep_only_columns.py

@@ -5,14 +5,14 @@
 
 
 def test_keep_columns() -> None:
-    table = Table.from_csv(resolve_resource_path("test_table_read_csv.csv"))
+    table = Table.from_csv_file(resolve_resource_path("test_table_from_csv_file.csv"))
     transformed_table = table.keep_only_columns(["A"])
     assert transformed_table.schema.has_column(
         "A"
     ) and not transformed_table.schema.has_column("B")
 
 
 def test_keep_columns_warning() -> None:
-    table = Table.from_csv(resolve_resource_path("test_table_read_csv.csv"))
+    table = Table.from_csv_file(resolve_resource_path("test_table_from_csv_file.csv"))
     with pytest.raises(UnknownColumnNameError):
         table.keep_only_columns(["C"])

tests/safeds/data/tabular/containers/_table/test_rename.py

@@ -11,7 +11,9 @@
 def test_rename_valid(
     name_from: str, name_to: str, column_one: str, column_two: str
 ) -> None:
-    table: Table = Table.from_csv(resolve_resource_path("test_table_read_csv.csv"))
+    table: Table = Table.from_csv_file(
+        resolve_resource_path("test_table_from_csv_file.csv")
+    )
     renamed_table = table.rename_column(name_from, name_to)
     assert renamed_table.schema.has_column(column_one)
     assert renamed_table.schema.has_column(column_two)
@@ -27,6 +29,8 @@ def test_rename_valid(
     ],
 )
 def test_rename_invalid(name_from: str, name_to: str, error: Exception) -> None:
-    table: Table = Table.from_csv(resolve_resource_path("test_table_read_csv.csv"))
+    table: Table = Table.from_csv_file(
+        resolve_resource_path("test_table_from_csv_file.csv")
+    )
     with pytest.raises(error):
         table.rename_column(name_from, name_to)

tests/safeds/data/tabular/containers/_table/test_replace_column.py

@@ -17,10 +17,10 @@
     ],
 )
 def test_replace_valid(column_name: str, path: str) -> None:
-    input_table: Table = Table.from_csv(
+    input_table: Table = Table.from_csv_file(
         resolve_resource_path("test_table_replace_column_input.csv")
     )
-    expected: Table = Table.from_csv(resolve_resource_path(path))
+    expected: Table = Table.from_csv_file(resolve_resource_path(path))
 
     column = Column(pd.Series(["d", "e", "f"]), column_name)
 
@@ -43,7 +43,7 @@ def test_replace_invalid(
     column_name: str,
     error: type[Exception],
 ) -> None:
-    input_table: Table = Table.from_csv(
+    input_table: Table = Table.from_csv_file(
         resolve_resource_path("test_table_replace_column_input.csv")
     )
     column = Column(pd.Series(column_values), column_name)

tests/safeds/data/tabular/containers/_table/test_table_add_column.py

@@ -6,10 +6,10 @@
 
 
 def test_table_add_column_valid() -> None:
-    input_table = Table.from_csv(
+    input_table = Table.from_csv_file(
         resolve_resource_path("test_table_add_column_valid_input.csv")
     )
-    expected = Table.from_csv(
+    expected = Table.from_csv_file(
         resolve_resource_path("test_table_add_column_valid_output.csv")
     )
     column = Column(pd.Series(["a", "b", "c"]), "C")
@@ -28,7 +28,7 @@ def test_table_add_column_valid() -> None:
 def test_table_add_column_(
     column_values: list[str], column_name: str, error: type[Exception]
 ) -> None:
-    input_table = Table.from_csv(
+    input_table = Table.from_csv_file(
         resolve_resource_path("test_table_add_column_valid_input.csv")
     )
     column = Column(pd.Series(column_values), column_name)

tests/safeds/data/tabular/containers/_table/test_to_columns.py

@@ -9,7 +9,7 @@
     [([1, 4], "A", 0), ([2, 5], "B", 1)],
 )
 def test_to_columns(values: list[int], name: str, index: int) -> None:
-    table = Table.from_csv(resolve_resource_path("test_column_table.csv"))
+    table = Table.from_csv_file(resolve_resource_path("test_column_table.csv"))
     columns_list: list[Column] = table.to_columns()
 
     column_expected: Column = Column(pd.Series(values, name=name), name)

tests/safeds/data/tabular/containers/_table/test_to_csv_file.py

@@ -0,0 +1,15 @@
+from tempfile import NamedTemporaryFile
+
+import pandas as pd
+from safeds.data.tabular.containers import Table
+
+
+def test_to_csv_file() -> None:
+    table = Table(pd.DataFrame(data={"col1": ["col1_1"], "col2": ["col2_1"]}))
+    with NamedTemporaryFile() as tmp_table_file:
+        tmp_table_file.close()
+        with open(tmp_table_file.name, "w", encoding="utf-8") as tmp_file:
+            table.to_csv_file(tmp_file.name)
+        with open(tmp_table_file.name, "r", encoding="utf-8") as tmp_file:
+            table_r = Table.from_csv_file(tmp_file.name)
+    assert table == table_r

tests/safeds/data/tabular/containers/_table/test_to_json_file.py

@@ -0,0 +1,15 @@
+from tempfile import NamedTemporaryFile
+
+import pandas as pd
+from safeds.data.tabular.containers import Table
+
+
+def test_to_json_file() -> None:
+    table = Table(pd.DataFrame(data={"col1": ["col1_1"], "col2": ["col2_1"]}))
+    with NamedTemporaryFile() as tmp_table_file:
+        tmp_table_file.close()
+        with open(tmp_table_file.name, "w", encoding="utf-8") as tmp_file:
+            table.to_json_file(tmp_file.name)
+        with open(tmp_table_file.name, "r", encoding="utf-8") as tmp_file:
+            table_r = Table.from_json_file(tmp_file.name)
+    assert table == table_r

tests/safeds/data/tabular/containers/_table/test_to_rows.py

@@ -5,7 +5,7 @@
 
 
 def test_to_rows() -> None:
-    table = Table.from_csv(resolve_resource_path("test_row_table.csv"))
+    table = Table.from_csv_file(resolve_resource_path("test_row_table.csv"))
     expected_schema: TableSchema = TableSchema(
         {
             "A": IntColumnType(),