Move to PrivateAttr.

Deltares · Jan 19, 2024 · bdd638e · bdd638e
1 parent c24238c
commit bdd638e
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 4 deletions.
diff --git a/python/ribasim/ribasim/input_base.py b/python/ribasim/ribasim/input_base.py
@@ -20,6 +20,7 @@
     ConfigDict,
     DirectoryPath,
     Field,
+    PrivateAttr,
     ValidationInfo,
     field_validator,
     model_serializer,
@@ -159,7 +160,7 @@ def _load(cls, filepath: Path | None) -> dict[str, Any]:
 
 class TableModel(FileModel, Generic[TableT]):
     df: DataFrame[TableT] | None = Field(default=None, exclude=True, repr=False)
-    sort_keys: list[str] = Field(default=[], exclude=True, repr=False)
+    _sort_keys: list[str] = PrivateAttr(default=[])
 
     @field_validator("df")
     @classmethod
@@ -296,7 +297,7 @@ def sort(self):
         Sorting is done automatically before writing the table.
         """
         if self.df is not None:
-            self.df.sort_values(self.sort_keys, ignore_index=True, inplace=True)
+            self.df.sort_values(self._sort_keys, ignore_index=True, inplace=True)
 
     @classmethod
     def tableschema(cls) -> TableT:
@@ -408,7 +409,7 @@ def set_sort_keys(cls, v: Any, info: ValidationInfo) -> Any:
             field = cls.model_fields[getattr(info, "field_name")]
             extra = field.json_schema_extra
             if extra is not None and isinstance(extra, dict):
-                v.sort_keys = extra.get("sort_keys", [])  # type: ignore
+                v._sort_keys = extra.get("sort_keys", [])  # type: ignore
         return v
 
     @classmethod

diff --git a/python/ribasim/tests/test_io.py b/python/ribasim/tests/test_io.py
@@ -111,7 +111,7 @@ def test_sort(level_setpoint_with_minmax, tmp_path):
     # apply a wrong sort, then call the sort method to restore order
     table.df.sort_values("greater_than", ascending=False, inplace=True)
     assert table.df.iloc[0]["greater_than"] == 15.0
-    assert table.sort_keys == [
+    assert table._sort_keys == [
         "node_id",
         "listen_feature_id",
         "variable",