24750: Raise HowsoError when Trainee fails to write to file (#543)

Co-authored-by: howso-automation <[email protected]>

Author: fulpm

LICENSE-3RD-PARTY.txt

@@ -1,10 +1,10 @@
 Faker
-37.12.0
+38.2.0
 MIT License
 joke2k
 https://github.com/joke2k/faker
 Faker is a Python package that generates fake data for you.
-/home/runner/.pyenv/versions/3.13.9/lib/python3.13/site-packages/faker-37.12.0.dist-info/licenses/LICENSE.txt
+/home/runner/.pyenv/versions/3.13.9/lib/python3.13/site-packages/faker-38.2.0.dist-info/licenses/LICENSE.txt
 Copyright (c) 2012 Daniele Faraglia
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -149,12 +149,12 @@ DEALINGS IN THE SOFTWARE.
 
 
 certifi
-2025.10.5
+2025.11.12
 Mozilla Public License 2.0 (MPL 2.0)
 Kenneth Reitz
 https://github.com/certifi/python-certifi
 Python package for providing Mozilla's CA Bundle.
-/home/runner/.pyenv/versions/3.13.9/lib/python3.13/site-packages/certifi-2025.10.5.dist-info/licenses/LICENSE
+/home/runner/.pyenv/versions/3.13.9/lib/python3.13/site-packages/certifi-2025.11.12.dist-info/licenses/LICENSE
 This package contains a modified version of ca-bundle.crt:
 
 ca-bundle.crt -- Bundle of CA Root Certificates
@@ -240,12 +240,12 @@ SOFTWARE.
 
 
 click
-8.3.0
+8.3.1
 BSD-3-Clause
 UNKNOWN
 https://github.com/pallets/click/
 Composable command line interface toolkit
-/home/runner/.pyenv/versions/3.13.9/lib/python3.13/site-packages/click-8.3.0.dist-info/licenses/LICENSE.txt
+/home/runner/.pyenv/versions/3.13.9/lib/python3.13/site-packages/click-8.3.1.dist-info/licenses/LICENSE.txt
 Copyright 2014 Pallets
 
 Redistribution and use in source and binary forms, with or without

howso/direct/client.py

@@ -457,12 +457,15 @@ def _auto_persist_trainee(self, trainee_id: str):
         if new_file_size <= trainee.file_size * 2 and new_file_size <= trainee.file_size + 10485760:
             return
 
-        self.amlg.store_entity(
+        resolved_path = self.resolve_trainee_filepath(trainee_id)
+        is_persisted = self.amlg.store_entity(
             handle=trainee_id,
-            file_path=self.resolve_trainee_filepath(trainee_id),
+            file_path=resolved_path,
             persist=True,
             json_file_params='{"transactional":true,"flatten":true}'
         )
+        if not is_persisted:
+            warnings.warn(f'Failed to auto persist Trainee "{trainee_id}" to file path: {resolved_path}', UserWarning)
         trainee.file_size = self._trainee_size(trainee_id)
 
     def _store_session(self, trainee_id: str, session: Session):
@@ -1084,18 +1087,29 @@ def update_trainee(self, trainee: Mapping | Trainee) -> Trainee:
 
         if old_trainee.persistence == 'always' and instance.persistence != 'always':
             # Manually persist the trainee now, turning off transactional mode.
-            self.amlg.store_entity(
-                handle=instance.id,
-                file_path=self.resolve_trainee_filepath(instance.id)
-            )
+            resolved_path = self.resolve_trainee_filepath(instance.id)
+            is_persisted = self.amlg.store_entity(handle=instance.id, file_path=resolved_path)
+            if not is_persisted:
+                raise HowsoError(
+                    f'Failed to update persistence of Trainee "{instance.id}", '
+                    f"could not write Trainee to file path: {resolved_path}",
+                    code="persist_failed",
+                )
         elif instance.persistence == 'always' and old_trainee.persistence != 'always':
             # Manually persist the trainee, turning on transactional mode.
-            self.amlg.store_entity(
+            resolved_path = self.resolve_trainee_filepath(instance.id)
+            is_persisted = self.amlg.store_entity(
                 handle=instance.id,
-                file_path=self.resolve_trainee_filepath(instance.id),
+                file_path=resolved_path,
                 persist=True,
-                json_file_params='{"transactional":true,"flatten":true}'
+                json_file_params='{"transactional":true,"flatten":true}',
             )
+            if not is_persisted:
+                raise HowsoError(
+                    f'Failed to update persistence of Trainee "{instance.id}", '
+                    f"could not write Trainee to file path: {resolved_path}",
+                    code="persist_failed",
+                )
             instance.file_size = self._trainee_size(instance.id)
 
         metadata = {
@@ -1577,10 +1591,18 @@ def release_trainee_resources(self, trainee_id: str):
 
             if trainee.persistence in ['allow', 'always']:
                 # Persist on unload
-                self.amlg.store_entity(
+                resolved_path = self.resolve_trainee_filepath(trainee_id)
+                is_persisted = self.amlg.store_entity(
                     handle=trainee_id,
-                    file_path=self.resolve_trainee_filepath(trainee_id)
+                    file_path=resolved_path,
                 )
+                if not is_persisted:
+                    # If persist fails, do not proceed to delete the trainee from memory
+                    raise HowsoError(
+                        f'Failed to release resources for Trainee "{trainee_id}", '
+                        f'could not write Trainee to file path: {resolved_path}',
+                        code="persist_failed",
+                    )
             elif trainee.persistence == "never":
                 raise HowsoError(
                     "Trainees set to never persist may not have their "
@@ -1618,12 +1640,17 @@ def persist_trainee(self, trainee_id: str):
                 "persistence option to enable persistence.")
         transactional = (trainee is not None and trainee.persistence == 'always')
 
-        self.amlg.store_entity(
+        resolved_path = self.resolve_trainee_filepath(trainee_id)
+        is_persisted = self.amlg.store_entity(
             handle=trainee_id,
-            file_path=self.resolve_trainee_filepath(trainee_id),
+            file_path=resolved_path,
             persist=transactional,
             json_file_params='{"transactional":true,"flatten":true}' if transactional else ""
         )
+        if not is_persisted:
+            raise HowsoError(
+                f'Failed to write Trainee "{trainee_id}" to file path: {resolved_path}', code="persist_failed"
+            )
 
         if transactional:
             assert trainee is not None

howso/direct/tests/test_standalone.py

@@ -1,6 +1,7 @@
 from pathlib import Path
 
 import pytest
+from pytest_mock import MockFixture
 
 from amalgam.api import Amalgam
 from howso.client.exceptions import HowsoError
@@ -118,3 +119,36 @@ def test_load_subtrainee_from_memory(client: HowsoDirectClient, tmp_path: Path)
         assert df["cases"] == [[1], [2]]
     finally:
         client.delete_trainee("test")
+
+
+def test_persistence_fails(mocker: MockFixture, client: HowsoDirectClient) -> None:
+    """Test persist raises when unable to write file."""
+    features = {"x": {"type": "continuous"}}
+    t1 = client.create_trainee(features=features)
+    client.train(t1.id, cases=[[1]], features=["x"])
+
+    def mock_store_entity(*args, **kwargs):
+        return False
+
+    mocker.patch.object(client.amlg, "store_entity", side_effect=mock_store_entity)
+
+    resolved_path = client.resolve_trainee_filepath(t1.id)
+
+    with pytest.raises(HowsoError) as error_info:
+        client.persist_trainee(t1.id)
+    assert error_info.value.code == "persist_failed"
+    assert error_info.value.message == f'Failed to write Trainee "{t1.id}" to file path: {resolved_path}'
+
+    with pytest.raises(HowsoError) as error_info:
+        client.release_trainee_resources(t1.id)
+    assert error_info.value.code == "persist_failed"
+    assert error_info.value.message == (
+        f'Failed to release resources for Trainee "{t1.id}", could not write Trainee to file path: {resolved_path}'
+    )
+
+    assert t1.persistence == "allow"
+    t1_new = t1.to_dict()
+    t1_new["persistence"] = "always"
+    with pytest.raises(HowsoError) as error_info:
+        client.update_trainee(t1_new)
+    assert error_info.value.code == "persist_failed"

howso/engine/tests/conftest.py

@@ -1,12 +1,14 @@
-import pmlb
+import pandas as pd
+from pathlib import Path
 import pytest
 
 from howso.utilities import infer_feature_attributes
 
 
 @pytest.fixture(scope="module", name="data")
 def load_data():
-    return pmlb.fetch_data("iris")
+    filename = Path(Path(__file__).parent, "data/iris.csv")
+    return pd.read_csv(filename)
 
 
 @pytest.fixture(scope="module", name="features")

howso/engine/tests/data/iris.csv

@@ -0,0 +1,151 @@
+sepal-length,sepal-width,petal-length,petal-width,target
+6.7,3.0,5.2,2.3,2
+6.0,2.2,5.0,1.5,2
+6.2,2.8,4.8,1.8,2
+7.7,3.8,6.7,2.2,2
+7.2,3.0,5.8,1.6,2
+5.5,2.4,3.8,1.1,1
+6.0,2.7,5.1,1.6,1
+5.5,2.5,4.0,1.3,1
+5.6,2.9,3.6,1.3,1
+5.7,2.9,4.2,1.3,1
+5.0,3.2,1.2,0.2,0
+4.9,3.1,1.5,0.1,0
+5.3,3.7,1.5,0.2,0
+4.8,3.1,1.6,0.2,0
+5.0,3.3,1.4,0.2,0
+6.3,3.4,5.6,2.4,2
+7.1,3.0,5.9,2.1,2
+6.3,2.8,5.1,1.5,2
+6.3,2.9,5.6,1.8,2
+5.8,2.7,5.1,1.9,2
+5.2,2.7,3.9,1.4,1
+5.6,3.0,4.1,1.3,1
+6.9,3.1,4.9,1.5,1
+6.2,2.9,4.3,1.3,1
+6.5,2.8,4.6,1.5,1
+5.0,3.0,1.6,0.2,0
+5.5,3.5,1.3,0.2,0
+5.1,3.5,1.4,0.3,0
+5.7,3.8,1.7,0.3,0
+5.5,4.2,1.4,0.2,0
+6.7,3.1,5.6,2.4,2
+5.8,2.8,5.1,2.4,2
+6.4,3.1,5.5,1.8,2
+7.9,3.8,6.4,2.0,2
+6.8,3.0,5.5,2.1,2
+6.0,3.4,4.5,1.6,1
+6.7,3.1,4.7,1.5,1
+5.7,2.8,4.1,1.3,1
+6.7,3.1,4.4,1.4,1
+5.9,3.0,4.2,1.5,1
+5.1,3.8,1.9,0.4,0
+4.9,3.1,1.5,0.1,0
+5.4,3.9,1.3,0.4,0
+5.1,3.5,1.4,0.2,0
+4.8,3.4,1.9,0.2,0
+6.3,3.3,6.0,2.5,2
+6.7,3.3,5.7,2.5,2
+6.3,2.7,4.9,1.8,2
+6.9,3.2,5.7,2.3,2
+4.9,2.5,4.5,1.7,2
+7.0,3.2,4.7,1.4,1
+6.6,2.9,4.6,1.3,1
+6.4,2.9,4.3,1.3,1
+6.3,2.5,4.9,1.5,1
+5.7,2.6,3.5,1.0,1
+5.4,3.4,1.5,0.4,0
+5.0,3.5,1.3,0.3,0
+4.5,2.3,1.3,0.3,0
+5.1,3.8,1.5,0.3,0
+4.4,3.0,1.3,0.2,0
+6.9,3.1,5.1,2.3,2
+7.3,2.9,6.3,1.8,2
+6.1,2.6,5.6,1.4,2
+7.4,2.8,6.1,1.9,2
+7.2,3.6,6.1,2.5,2
+5.9,3.2,4.8,1.8,1
+6.1,2.8,4.7,1.2,1
+6.3,3.3,4.7,1.6,1
+5.8,2.6,4.0,1.2,1
+6.0,2.2,4.0,1.0,1
+4.6,3.6,1.0,0.2,0
+4.7,3.2,1.6,0.2,0
+5.1,3.8,1.6,0.2,0
+4.4,3.2,1.3,0.2,0
+4.8,3.0,1.4,0.3,0
+5.6,2.8,4.9,2.0,2
+7.6,3.0,6.6,2.1,2
+6.5,3.0,5.5,1.8,2
+5.9,3.0,5.1,1.8,2
+6.3,2.5,5.0,1.9,2
+6.1,2.8,4.0,1.3,1
+6.6,3.0,4.4,1.4,1
+5.8,2.7,4.1,1.0,1
+5.0,2.0,3.5,1.0,1
+5.5,2.6,4.4,1.2,1
+4.6,3.4,1.4,0.3,0
+5.4,3.4,1.7,0.2,0
+4.7,3.2,1.3,0.2,0
+5.2,4.1,1.5,0.1,0
+5.0,3.4,1.5,0.2,0
+6.5,3.2,5.1,2.0,2
+6.8,3.2,5.9,2.3,2
+5.7,2.5,5.0,2.0,2
+6.4,2.8,5.6,2.2,2
+7.7,2.6,6.9,2.3,2
+6.3,2.3,4.4,1.3,1
+6.1,3.0,4.6,1.4,1
+5.8,2.7,3.9,1.2,1
+6.2,2.2,4.5,1.5,1
+5.0,2.3,3.3,1.0,1
+5.2,3.4,1.4,0.2,0
+5.2,3.5,1.5,0.2,0
+4.9,3.1,1.5,0.1,0
+5.4,3.7,1.5,0.2,0
+4.4,2.9,1.4,0.2,0
+6.4,3.2,5.3,2.3,2
+6.4,2.8,5.6,2.1,2
+6.5,3.0,5.8,2.2,2
+6.1,3.0,4.9,1.8,2
+6.7,2.5,5.8,1.8,2
+5.7,2.8,4.5,1.3,1
+5.6,2.7,4.2,1.3,1
+6.0,2.9,4.5,1.5,1
+5.5,2.3,4.0,1.3,1
+5.6,3.0,4.5,1.5,1
+5.1,3.3,1.7,0.5,0
+5.8,4.0,1.2,0.2,0
+4.6,3.1,1.5,0.2,0
+5.7,4.4,1.5,0.4,0
+4.9,3.0,1.4,0.2,0
+6.7,3.3,5.7,2.1,2
+6.4,2.7,5.3,1.9,2
+5.8,2.7,5.1,1.9,2
+6.2,3.4,5.4,2.3,2
+6.0,3.0,4.8,1.8,2
+5.6,2.5,3.9,1.1,1
+4.9,2.4,3.3,1.0,1
+5.1,2.5,3.0,1.1,1
+6.4,3.2,4.5,1.5,1
+5.7,3.0,4.2,1.2,1
+4.3,3.0,1.1,0.1,0
+5.1,3.7,1.5,0.4,0
+4.8,3.4,1.6,0.2,0
+4.6,3.2,1.4,0.2,0
+4.8,3.0,1.4,0.1,0
+6.9,3.1,5.4,2.1,2
+7.2,3.2,6.0,1.8,2
+7.7,3.0,6.1,2.3,2
+7.7,2.8,6.7,2.0,2
+6.5,3.0,5.2,2.0,2
+5.5,2.4,3.7,1.0,1
+5.4,3.0,4.5,1.5,1
+6.8,2.8,4.8,1.4,1
+6.1,2.9,4.7,1.4,1
+6.7,3.0,5.0,1.7,1
+5.0,3.5,1.6,0.6,0
+5.4,3.9,1.7,0.4,0
+5.1,3.4,1.5,0.2,0
+5.0,3.6,1.4,0.2,0
+5.0,3.4,1.6,0.4,0

howso/engine/tests/test_engine.py

@@ -209,6 +209,21 @@ def test_save_load_warning(self, trainee):
 
         assert load_training_cases == 150
 
+    def test_save_raises(self, mocker, trainee):
+        """Test save raises when unable to write file."""
+
+        def mock_store_entity(*args, **kwargs):
+            return False
+
+        mocker.patch.object(trainee.client.amlg, "store_entity", side_effect=mock_store_entity)
+
+        resolved_path = trainee.client.resolve_trainee_filepath("foobar.caml")
+
+        with pytest.raises(HowsoError) as error_info:
+            trainee.save("foobar.caml")
+        assert error_info.value.code == "persist_failed"
+        assert error_info.value.message == f'Failed to write Trainee "{trainee.id}" to file path: {resolved_path}'
+
     def test_save_load_bad_load(self):
         """Test bad disk load methods."""
         cwd = Path.cwd()

howso/engine/trainee.py

@@ -403,10 +403,12 @@ def save(self, file_path: t.Optional[PathLike] = None):
             file_name = self.id
 
         if self.id:
-            self.client.amlg.store_entity(
-                handle=self.id,
-                file_path=self.client.resolve_trainee_filepath(file_name, filepath=file_path)
-            )
+            resolved_path = self.client.resolve_trainee_filepath(file_name, filepath=file_path)
+            is_persisted = self.client.amlg.store_entity(handle=self.id, file_path=resolved_path)
+            if not is_persisted:
+                raise HowsoError(
+                    f'Failed to write Trainee "{self.id}" to file path: {resolved_path}', code="persist_failed"
+                )
         else:
             raise ValueError("Trainee ID is needed for saving.")