feat: replace ConflictError with IntegrityError (#129)

advanced_alchemy/__init__.py

@@ -17,11 +17,11 @@
 from advanced_alchemy.service._async import SQLAlchemyAsyncRepositoryReadService, SQLAlchemyAsyncRepositoryService
 from advanced_alchemy.service._sync import SQLAlchemySyncRepositoryReadService, SQLAlchemySyncRepositoryService
 
-from .exceptions import ConflictError, NotFoundError, RepositoryError
+from .exceptions import IntegrityError, NotFoundError, RepositoryError
 from .filters import FilterTypes
 
 __all__ = (
-    "ConflictError",
+    "IntegrityError",
     "FilterTypes",
     "NotFoundError",
     "RepositoryError",

advanced_alchemy/exceptions.py

@@ -2,6 +2,8 @@
 
 from typing import Any
 
+from advanced_alchemy.utils.deprecation import deprecated
+
 
 class AdvancedAlchemyError(Exception):
     """Base exception class from which all Advanced Alchemy exceptions inherit."""
@@ -65,6 +67,20 @@ class RepositoryError(AdvancedAlchemyError):
 class ConflictError(RepositoryError):
     """Data integrity error."""
 
+    @deprecated(
+        version="0.7.1",
+        alternative="advanced_alchemy.exceptions.IntegrityError",
+        kind="method",
+        removal_in="1.0.0",
+        info="`ConflictError` has been renamed to `IntegrityError`",
+    )
+    def __init__(self, *args: Any, detail: str = "") -> None:
+        super().__init__(*args, detail=detail)
+
+
+class IntegrityError(RepositoryError):
+    """Data integrity error."""
+
 
 class NotFoundError(RepositoryError):
     """An identity does not exist."""

advanced_alchemy/repository/_util.py

@@ -3,9 +3,10 @@
 from contextlib import contextmanager
 from typing import TYPE_CHECKING, Any, cast
 
-from sqlalchemy.exc import IntegrityError, SQLAlchemyError
+from sqlalchemy.exc import IntegrityError as SQLAlchemyIntegrityError
+from sqlalchemy.exc import SQLAlchemyError
 
-from advanced_alchemy.exceptions import ConflictError, RepositoryError
+from advanced_alchemy.exceptions import IntegrityError, RepositoryError
 
 if TYPE_CHECKING:
     from sqlalchemy.orm import InstrumentedAttribute
@@ -29,8 +30,8 @@ def wrap_sqlalchemy_exception() -> Any:
     """
     try:
         yield
-    except IntegrityError as exc:
-        raise ConflictError from exc
+    except SQLAlchemyIntegrityError as exc:
+        raise IntegrityError from exc
     except SQLAlchemyError as exc:
         msg = f"An exception occurred: {exc}"
         raise RepositoryError(msg) from exc

advanced_alchemy/repository/memory/_async.py

@@ -8,7 +8,7 @@
 from sqlalchemy.ext.asyncio import AsyncEngine, AsyncSession
 from sqlalchemy.orm import InstrumentedAttribute
 
-from advanced_alchemy.exceptions import ConflictError, NotFoundError, RepositoryError
+from advanced_alchemy.exceptions import IntegrityError, NotFoundError, RepositoryError
 from advanced_alchemy.filters import (
     BeforeAfter,
     CollectionFilter,
@@ -294,13 +294,13 @@ async def _list_and_count_window(
     def _find_or_raise_not_found(self, id_: Any) -> ModelT:
         return self.check_not_found(self.__collection__().get_or_none(id_))
 
-    def _find_one_or_raise_conflict(self, result: list[ModelT]) -> ModelT:
+    def _find_one_or_raise_error(self, result: list[ModelT]) -> ModelT:
         if not result:
             msg = "No item found when one was expected"
-            raise ConflictError(msg)
+            raise IntegrityError(msg)
         if len(result) > 1:
             msg = "Multiple objects when one was expected"
-            raise ConflictError(msg)
+            raise IntegrityError(msg)
         return result[0]
 
     @classmethod
@@ -317,7 +317,7 @@ async def get_one_or_none(self, **kwargs: Any) -> ModelT | None:
         result = self._filter_result_by_kwargs(self.__collection__().list(), kwargs)
         if len(result) > 1:
             msg = "Multiple objects when one was expected"
-            raise ConflictError(msg)
+            raise IntegrityError(msg)
         return result[0] if result else None
 
     @deprecated(version="0.3.5", alternative="SQLAlchemyAsyncRepository.get_or_upsert", kind="method")
@@ -390,7 +390,7 @@ async def add(self, data: ModelT, **_: Any) -> ModelT:
             self.__database__.add(self.model_type, data)
         except KeyError as exc:
             msg = "Item already exist in collection"
-            raise ConflictError(msg) from exc
+            raise IntegrityError(msg) from exc
         return data
 
     async def add_many(self, data: list[ModelT], **_: Any) -> list[ModelT]:

advanced_alchemy/repository/memory/_sync.py

@@ -10,7 +10,7 @@
 from sqlalchemy.ext.asyncio import AsyncEngine
 from sqlalchemy.orm import InstrumentedAttribute, Session
 
-from advanced_alchemy.exceptions import ConflictError, NotFoundError, RepositoryError
+from advanced_alchemy.exceptions import IntegrityError, NotFoundError, RepositoryError
 from advanced_alchemy.filters import (
     BeforeAfter,
     CollectionFilter,
@@ -296,13 +296,13 @@ def _list_and_count_window(
     def _find_or_raise_not_found(self, id_: Any) -> ModelT:
         return self.check_not_found(self.__collection__().get_or_none(id_))
 
-    def _find_one_or_raise_conflict(self, result: list[ModelT]) -> ModelT:
+    def _find_one_or_raise_error(self, result: list[ModelT]) -> ModelT:
         if not result:
             msg = "No item found when one was expected"
-            raise ConflictError(msg)
+            raise IntegrityError(msg)
         if len(result) > 1:
             msg = "Multiple objects when one was expected"
-            raise ConflictError(msg)
+            raise IntegrityError(msg)
         return result[0]
 
     @classmethod
@@ -319,7 +319,7 @@ def get_one_or_none(self, **kwargs: Any) -> ModelT | None:
         result = self._filter_result_by_kwargs(self.__collection__().list(), kwargs)
         if len(result) > 1:
             msg = "Multiple objects when one was expected"
-            raise ConflictError(msg)
+            raise IntegrityError(msg)
         return result[0] if result else None
 
     @deprecated(version="0.3.5", alternative="SQLAlchemyAsyncRepository.get_or_upsert", kind="method")
@@ -392,7 +392,7 @@ def add(self, data: ModelT, **_: Any) -> ModelT:
             self.__database__.add(self.model_type, data)
         except KeyError as exc:
             msg = "Item already exist in collection"
-            raise ConflictError(msg) from exc
+            raise IntegrityError(msg) from exc
         return data
 
     def add_many(self, data: list[ModelT], **_: Any) -> list[ModelT]:

tests/unit/test_exceptions.py

@@ -0,0 +1,11 @@
+import contextlib
+
+import pytest
+
+
+async def test_repo_get_or_create_deprecation() -> None:
+    with pytest.warns(DeprecationWarning):
+        from advanced_alchemy.exceptions import ConflictError
+
+        with contextlib.suppress(Exception):
+            raise ConflictError

tests/unit/test_repository.py

@@ -10,7 +10,7 @@
 import pytest
 from pytest_lazyfixture import lazy_fixture
 from sqlalchemy import String
-from sqlalchemy.exc import IntegrityError, InvalidRequestError, SQLAlchemyError
+from sqlalchemy.exc import InvalidRequestError, SQLAlchemyError
 from sqlalchemy.ext.asyncio import AsyncSession
 from sqlalchemy.orm import InstrumentedAttribute, Mapped, Session, mapped_column
 
@@ -20,7 +20,7 @@
     base,
     wrap_sqlalchemy_exception,
 )
-from advanced_alchemy.exceptions import ConflictError, RepositoryError
+from advanced_alchemy.exceptions import IntegrityError, RepositoryError
 from advanced_alchemy.filters import (
     BeforeAfter,
     CollectionFilter,
@@ -178,7 +178,7 @@ class TheBigIntModel(base.BigIntBase):
 
 def test_wrap_sqlalchemy_integrity_error() -> None:
     """Test to ensure we wrap IntegrityError."""
-    with pytest.raises(ConflictError), wrap_sqlalchemy_exception():
+    with pytest.raises(IntegrityError), wrap_sqlalchemy_exception():
         raise IntegrityError(None, None, Exception())