Implement DoesNotExist exception under Model #23

docs/CHANGELOG.md

@@ -17,6 +17,7 @@ All notable changes to this project will be documented in this file.
   - model.objects.filter
   - model.save
   - model.update
+- Implement DoesNotExist exception under Model [#23](https://github.com/hakancelikdev/pydbm/issues/23)
 
 ### Fixed
 - Fix find object annotations from the model.

docs/tutorial/models.md

@@ -144,15 +144,13 @@ That's it, now we have saved our user to the database.
 Get method is used to get the data from the database and return it as a model instance.
 
 ```python
-from pydbm import DoesNotExist
-
 try:
     user = UserModel.objects.get(user.id)
-except DoesNotExist:
+except UserModel.DoesNotExist:
     print("User does not exist")
 ```
 
-If the user exists in the database, it will return the user, otherwise it raises `DoesNotExists` exception.
+If the user exists in the database, it will return the user, otherwise it raises `UserModel.DoesNotExists` exception.
 
 
 ### Update

src/pydbm/__init__.py

@@ -1,4 +1,4 @@
-from pydbm.exceptions import DoesNotExists, PydbmBaseException, PydbmTypeError, ValidationError
+from pydbm.exceptions import PydbmBaseException, PydbmTypeError, ValidationError
 from pydbm.models import (
     BaseModel,
     Field,
@@ -17,7 +17,6 @@
 from pydbm.typing_extra import NormalizationT, ValidatorT
 
 __all__ = (
-    "DoesNotExists",
     "PydbmBaseException",
     "PydbmTypeError",
     "ValidationError",

src/pydbm/database/manager.py

@@ -7,7 +7,6 @@
 from pathlib import Path
 
 from pydbm.database.data_types import BaseDataType
-from pydbm.exceptions import DoesNotExists
 from pydbm.inspect_extra import get_obj_annotations
 
 if typing.TYPE_CHECKING:
@@ -152,7 +151,7 @@ def get(self, *, pk: str) -> BaseModel:
 
             return self.model(**fields)
 
-        raise DoesNotExists(f"{self.model.__name__} with pk {pk} does not exists")
+        raise self.model.DoesNotExists(f"{self.model.__name__} with pk {pk} does not exists")
 
     def update(self, *, pk: str, **updated_fields) -> None:
         model = self.get(pk=pk)

src/pydbm/exceptions.py

@@ -2,7 +2,6 @@
 
 __all__ = (
     "PydbmBaseException",
-    "DoesNotExists",
     "PydbmTypeError",
     "ValidationError",
 )
@@ -14,12 +13,6 @@ class PydbmBaseException(Exception):
     pass
 
 
-class DoesNotExists(PydbmBaseException):
-    """Exception for not found id in the models."""
-
-    pass
-
-
 class PydbmTypeError(PydbmBaseException, TypeError):
     """Exception for not valid type of value."""
 

src/pydbm/models/meta.py

@@ -4,6 +4,7 @@
 
 from pydbm import typing_extra
 from pydbm.database import DatabaseManager
+from pydbm.exceptions import PydbmBaseException
 from pydbm.inspect_extra import get_obj_annotations
 from pydbm.models.fields import AutoField, Field, Undefined
 
@@ -48,6 +49,7 @@ def __init__(cls, cls_name: str, bases: tuple[Meta, ...], namespace: dict[str, t
 
             cls.required_fields, cls.not_required_fields = mcs.split_fields(list(fields.values()))
             cls.objects = DatabaseManager(model=cls, table_name=config.table_name)  # type: ignore
+            cls.DoesNotExists = type("DoesNotExists", (PydbmBaseException,), {"__doc__": "Exception for not found id in the models."})  # noqa: E501
 
             for key, value in fields.items():
                 setattr(cls, key, value)

tests/models/test_base.py

@@ -2,7 +2,7 @@
 
 import pytest
 
-from pydbm import BaseModel, DoesNotExists
+from pydbm import BaseModel
 
 
 class Model(BaseModel):
@@ -168,7 +168,7 @@ class Example(BaseModel):
     model = Example.objects.create(str="str")
 
     model.delete()
-    with pytest.raises(DoesNotExists) as cm:
+    with pytest.raises(model.DoesNotExists) as cm:
         Example.objects.get(pk=model.id)
     assert str(cm.value) == "Example with pk 341be97d9aff90c9978347f66f945b77 does not exists"