Skip to content

Commit ea176fc

Browse files
fix: mark various API elements as internal (#587)
Closes #582 Closes #585 ### Summary of Changes Mark the following API elements as internal: * Static method `Schema.merge_multiple_schemas` * Instance method `SupportVectorMachineKernel.get_sklearn_kernel` * Module `config` --------- Co-authored-by: megalinter-bot <129584137+megalinter-bot@users.noreply.github.com>
1 parent ce53153 commit ea176fc

File tree

12 files changed

+32
-28
lines changed

12 files changed

+32
-28
lines changed
File renamed without changes.
File renamed without changes.

src/safeds/data/image/containers/_image.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
from __future__ import annotations
22

3-
import sys
43
import io
4+
import sys
55
import warnings
66
from pathlib import Path
77
from typing import TYPE_CHECKING
@@ -12,7 +12,7 @@
1212
from PIL.Image import open as pil_image_open
1313
from torch import Tensor
1414

15-
from safeds.config import _get_device
15+
from safeds._config import _get_device
1616

1717
if TYPE_CHECKING:
1818
from torch.types import Device

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -337,7 +337,7 @@ def from_rows(rows: list[Row]) -> Table:
337337
dataframe: DataFrame = pd.concat(row_array, ignore_index=True)
338338
dataframe.columns = column_names_compare
339339

340-
schema = Schema.merge_multiple_schemas([row.schema for row in rows])
340+
schema = Schema._merge_multiple_schemas([row.schema for row in rows])
341341

342342
return Table._from_pandas_dataframe(dataframe, schema)
343343

@@ -1012,7 +1012,7 @@ def add_row(self, row: Row) -> Table:
10121012

10131013
new_df = pd.concat([self._data, row._data]).infer_objects()
10141014
new_df.columns = self.column_names
1015-
schema = Schema.merge_multiple_schemas([self.schema, row.schema])
1015+
schema = Schema._merge_multiple_schemas([self.schema, row.schema])
10161016
result = Table._from_pandas_dataframe(new_df, schema)
10171017

10181018
for column in int_columns:

src/safeds/data/tabular/typing/_schema.py

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,11 @@ def __sizeof__(self) -> int:
111111
-------
112112
Size of this object in bytes.
113113
"""
114-
return sum(map(sys.getsizeof, self._schema.keys())) + sum(map(sys.getsizeof, self._schema.values())) + sys.getsizeof(self._schema)
114+
return (
115+
sum(map(sys.getsizeof, self._schema.keys()))
116+
+ sum(map(sys.getsizeof, self._schema.values()))
117+
+ sys.getsizeof(self._schema)
118+
)
115119

116120
def __str__(self) -> str:
117121
"""
@@ -237,7 +241,7 @@ def to_dict(self) -> dict[str, ColumnType]:
237241
return dict(self._schema) # defensive copy
238242

239243
@staticmethod
240-
def merge_multiple_schemas(schemas: list[Schema]) -> Schema:
244+
def _merge_multiple_schemas(schemas: list[Schema]) -> Schema:
241245
"""
242246
Merge multiple schemas into one.
243247

src/safeds/ml/classical/classification/_support_vector_machine.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ class SupportVectorMachineKernel(ABC):
1919
"""The abstract base class of the different subclasses supported by the `Kernel`."""
2020

2121
@abstractmethod
22-
def get_sklearn_kernel(self) -> object:
22+
def _get_sklearn_kernel(self) -> object:
2323
"""
2424
Get the kernel of the given SupportVectorMachine.
2525
@@ -85,7 +85,7 @@ def kernel(self) -> SupportVectorMachineKernel | None:
8585

8686
class Kernel:
8787
class Linear(SupportVectorMachineKernel):
88-
def get_sklearn_kernel(self) -> str:
88+
def _get_sklearn_kernel(self) -> str:
8989
"""
9090
Get the name of the linear kernel.
9191
@@ -102,7 +102,7 @@ def __init__(self, degree: int):
102102
raise OutOfBoundsError(degree, name="degree", lower_bound=ClosedBound(1))
103103
self._degree = degree
104104

105-
def get_sklearn_kernel(self) -> str:
105+
def _get_sklearn_kernel(self) -> str:
106106
"""
107107
Get the name of the polynomial kernel.
108108
@@ -114,7 +114,7 @@ def get_sklearn_kernel(self) -> str:
114114
return "poly"
115115

116116
class Sigmoid(SupportVectorMachineKernel):
117-
def get_sklearn_kernel(self) -> str:
117+
def _get_sklearn_kernel(self) -> str:
118118
"""
119119
Get the name of the sigmoid kernel.
120120
@@ -126,7 +126,7 @@ def get_sklearn_kernel(self) -> str:
126126
return "sigmoid"
127127

128128
class RadialBasisFunction(SupportVectorMachineKernel):
129-
def get_sklearn_kernel(self) -> str:
129+
def _get_sklearn_kernel(self) -> str:
130130
"""
131131
Get the name of the radial basis function (RBF) kernel.
132132

src/safeds/ml/classical/regression/_support_vector_machine.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ class SupportVectorMachineKernel(ABC):
1919
"""The abstract base class of the different subclasses supported by the `Kernel`."""
2020

2121
@abstractmethod
22-
def get_sklearn_kernel(self) -> object:
22+
def _get_sklearn_kernel(self) -> object:
2323
"""
2424
Get the kernel of the given SupportVectorMachine.
2525
@@ -85,7 +85,7 @@ def kernel(self) -> SupportVectorMachineKernel | None:
8585

8686
class Kernel:
8787
class Linear(SupportVectorMachineKernel):
88-
def get_sklearn_kernel(self) -> str:
88+
def _get_sklearn_kernel(self) -> str:
8989
"""
9090
Get the name of the linear kernel.
9191
@@ -102,7 +102,7 @@ def __init__(self, degree: int):
102102
raise OutOfBoundsError(degree, name="degree", lower_bound=ClosedBound(1))
103103
self._degree = degree
104104

105-
def get_sklearn_kernel(self) -> str:
105+
def _get_sklearn_kernel(self) -> str:
106106
"""
107107
Get the name of the polynomial kernel.
108108
@@ -114,7 +114,7 @@ def get_sklearn_kernel(self) -> str:
114114
return "poly"
115115

116116
class Sigmoid(SupportVectorMachineKernel):
117-
def get_sklearn_kernel(self) -> str:
117+
def _get_sklearn_kernel(self) -> str:
118118
"""
119119
Get the name of the sigmoid kernel.
120120
@@ -126,7 +126,7 @@ def get_sklearn_kernel(self) -> str:
126126
return "sigmoid"
127127

128128
class RadialBasisFunction(SupportVectorMachineKernel):
129-
def get_sklearn_kernel(self) -> str:
129+
def _get_sklearn_kernel(self) -> str:
130130
"""
131131
Get the name of the radial basis function (RBF) kernel.
132132
File renamed without changes.

tests/safeds/config/test_device.py renamed to tests/safeds/_config/test_device.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import torch
2-
from safeds.config import _get_device
2+
from safeds._config import _get_device
33

44

55
def test_device() -> None:

tests/safeds/data/tabular/typing/test_schema.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -280,7 +280,7 @@ class TestMergeMultipleSchemas:
280280
)
281281
def test_should_raise_if_column_names_are_different(self, schemas: list[Schema], error_msg_regex: str) -> None:
282282
with pytest.raises(UnknownColumnNameError, match=error_msg_regex):
283-
Schema.merge_multiple_schemas(schemas)
283+
Schema._merge_multiple_schemas(schemas)
284284

285285
@pytest.mark.parametrize(
286286
("schemas", "expected"),
@@ -470,10 +470,10 @@ def test_should_raise_if_column_names_are_different(self, schemas: list[Schema],
470470
],
471471
)
472472
def test_should_return_merged_schema(self, schemas: list[Schema], expected: Schema) -> None:
473-
assert Schema.merge_multiple_schemas(schemas) == expected
473+
assert Schema._merge_multiple_schemas(schemas) == expected
474474
schemas.reverse()
475475
assert (
476-
Schema.merge_multiple_schemas(schemas) == expected
476+
Schema._merge_multiple_schemas(schemas) == expected
477477
) # test the reversed list because the first parameter is handled differently
478478

479479

tests/safeds/ml/classical/classification/test_support_vector_machine.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ def test_should_be_passed_to_sklearn(self, training_set: TaggedTable) -> None:
4141
def test_should_get_sklearn_kernel_linear(self) -> None:
4242
svm = SupportVectorMachine(c=2, kernel=SupportVectorMachine.Kernel.Linear())
4343
assert isinstance(svm.kernel, SupportVectorMachine.Kernel.Linear)
44-
linear_kernel = svm.kernel.get_sklearn_kernel()
44+
linear_kernel = svm.kernel._get_sklearn_kernel()
4545
assert linear_kernel == "linear"
4646

4747
@pytest.mark.parametrize("degree", [-1, 0], ids=["minus_one", "zero"])
@@ -52,19 +52,19 @@ def test_should_raise_if_degree_less_than_1(self, degree: int) -> None:
5252
def test_should_get_sklearn_kernel_polynomial(self) -> None:
5353
svm = SupportVectorMachine(c=2, kernel=SupportVectorMachine.Kernel.Polynomial(degree=2))
5454
assert isinstance(svm.kernel, SupportVectorMachine.Kernel.Polynomial)
55-
poly_kernel = svm.kernel.get_sklearn_kernel()
55+
poly_kernel = svm.kernel._get_sklearn_kernel()
5656
assert poly_kernel == "poly"
5757

5858
def test_should_get_sklearn_kernel_sigmoid(self) -> None:
5959
svm = SupportVectorMachine(c=2, kernel=SupportVectorMachine.Kernel.Sigmoid())
6060
assert isinstance(svm.kernel, SupportVectorMachine.Kernel.Sigmoid)
61-
sigmoid_kernel = svm.kernel.get_sklearn_kernel()
61+
sigmoid_kernel = svm.kernel._get_sklearn_kernel()
6262
assert sigmoid_kernel == "sigmoid"
6363

6464
def test_should_get_sklearn_kernel_rbf(self) -> None:
6565
svm = SupportVectorMachine(c=2, kernel=SupportVectorMachine.Kernel.RadialBasisFunction())
6666
assert isinstance(svm.kernel, SupportVectorMachine.Kernel.RadialBasisFunction)
67-
rbf_kernel = svm.kernel.get_sklearn_kernel()
67+
rbf_kernel = svm.kernel._get_sklearn_kernel()
6868
assert rbf_kernel == "rbf"
6969

7070
def test_should_get_kernel_name(self) -> None:

tests/safeds/ml/classical/regression/test_support_vector_machine.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ def test_should_be_passed_to_sklearn(self, training_set: TaggedTable) -> None:
4141
def test_should_get_sklearn_kernel_linear(self) -> None:
4242
svm = SupportVectorMachine(c=2, kernel=SupportVectorMachine.Kernel.Linear())
4343
assert isinstance(svm.kernel, SupportVectorMachine.Kernel.Linear)
44-
linear_kernel = svm.kernel.get_sklearn_kernel()
44+
linear_kernel = svm.kernel._get_sklearn_kernel()
4545
assert linear_kernel == "linear"
4646

4747
@pytest.mark.parametrize("degree", [-1, 0], ids=["minus_one", "zero"])
@@ -52,19 +52,19 @@ def test_should_raise_if_degree_less_than_1(self, degree: int) -> None:
5252
def test_should_get_sklearn_kernel_polynomial(self) -> None:
5353
svm = SupportVectorMachine(c=2, kernel=SupportVectorMachine.Kernel.Polynomial(degree=2))
5454
assert isinstance(svm.kernel, SupportVectorMachine.Kernel.Polynomial)
55-
poly_kernel = svm.kernel.get_sklearn_kernel()
55+
poly_kernel = svm.kernel._get_sklearn_kernel()
5656
assert poly_kernel == "poly"
5757

5858
def test_should_get_sklearn_kernel_sigmoid(self) -> None:
5959
svm = SupportVectorMachine(c=2, kernel=SupportVectorMachine.Kernel.Sigmoid())
6060
assert isinstance(svm.kernel, SupportVectorMachine.Kernel.Sigmoid)
61-
sigmoid_kernel = svm.kernel.get_sklearn_kernel()
61+
sigmoid_kernel = svm.kernel._get_sklearn_kernel()
6262
assert sigmoid_kernel == "sigmoid"
6363

6464
def test_should_get_sklearn_kernel_rbf(self) -> None:
6565
svm = SupportVectorMachine(c=2, kernel=SupportVectorMachine.Kernel.RadialBasisFunction())
6666
assert isinstance(svm.kernel, SupportVectorMachine.Kernel.RadialBasisFunction)
67-
rbf_kernel = svm.kernel.get_sklearn_kernel()
67+
rbf_kernel = svm.kernel._get_sklearn_kernel()
6868
assert rbf_kernel == "rbf"
6969

7070
def test_should_get_kernel_name(self) -> None:

0 commit comments

Comments
 (0)