Add update_model_by_attribute

update_model_by_attribute allows users to update models that do not have an "id" field.

sqlalchemy_crud/crud.py

@@ -1,5 +1,6 @@
-from typing import List
+from typing import List, Type
 
+import sqlalchemy
 from sqlalchemy.ext.declarative import declarative_base
 from sqlalchemy.orm import Session
 
@@ -70,6 +71,30 @@ def update_model(db: Session, model: Base, model_id: int, schema: dict) -> Base:
     return db_model
 
 
+def update_model_by_attribute(
+    db: Session,
+    model: Type[sqlalchemy.orm.decl_api.DeclarativeMeta],
+    lookup_attribute: str,
+    lookup_attribute_value,
+    schema: dict,
+):
+    db_model = get_model_by_attribute(
+        db=db,
+        model=model,
+        attribute=lookup_attribute,
+        attribute_value=lookup_attribute_value,
+    )
+    for key, value in schema.items():
+        if hasattr(db_model, key):
+            setattr(db_model, key, value)
+        else:
+            raise AttributeError
+
+    db.commit()
+    db.refresh(db_model)
+    return db_model
+
+
 def delete_model(db: Session, model: Base, model_id: int) -> None:
     db_model = get_model(db=db, model=model, model_id=model_id)
     db.delete(db_model)

tests/test_crud.py

@@ -14,6 +14,7 @@
     delete_model,
     link_models,
     unlink_models,
+    update_model_by_attribute,
 )
 from tests.models_for_test import Base, Parent, Child
 
@@ -277,6 +278,35 @@ def test_update_model_raise_exception_on_invalid_attribute(self):
                 schema=dict(name="parent_test_name_1_updated", invalid=1),
             )
 
+    def test_update_model_by_attribute(self):
+        self.create_test_data()
+        self.link_children_to_parents()
+
+        model = get_model(db=self.db, model=Parent, model_id=1)
+        self.assertEqual(model.name, "parent_test_name_1")
+
+        model = update_model_by_attribute(
+            db=self.db,
+            model=Parent,
+            lookup_attribute="name",
+            lookup_attribute_value="parent_test_name_1",
+            schema=dict(name="parent_test_name_1_updated"),
+        )
+        self.assertEqual(model.name, "parent_test_name_1_updated")
+
+        model = get_model(db=self.db, model=Parent, model_id=1)
+        self.assertEqual(model.name, "parent_test_name_1_updated")
+
+    def test_update_model_by_attribute_raise_exception_on_invalid_attribute(self):
+        with self.assertRaises(AttributeError):
+            update_model_by_attribute(
+                db=self.db,
+                model=Parent,
+                lookup_attribute="name",
+                lookup_attribute_value="parent_test_name_1",
+                schema=dict(name="parent_test_name_1_updated", invalid=1),
+            )
+
     def test_delete_model(self):
         self.create_test_data()
         self.link_children_to_parents()