➕ Add metaclass testing

Author: tarsil

saffier/__init__.py

@@ -3,6 +3,7 @@
 from saffier.core.registry import Registry
 from saffier.db.constants import CASCADE, RESTRICT, SET_NULL
 from saffier.db.manager import Manager
+from saffier.db.queryset import QuerySet
 from saffier.exceptions import DoesNotFound, MultipleObjectsReturned
 from saffier.fields import (
     BigIntegerField,
@@ -43,6 +44,7 @@
     "Model",
     "MultipleObjectsReturned",
     "OneToOneField",
+    "QuerySet",
     "RESTRICT",
     "Registry",
     "SET_NULL",

saffier/exceptions.py

@@ -21,11 +21,11 @@ def __str__(self) -> str:
         return "".join(self.args).strip()
 
 
-class DoesNotFound(Exception):
+class DoesNotFound(SaffierException):
     ...
 
 
-class MultipleObjectsReturned(Exception):
+class MultipleObjectsReturned(SaffierException):
     ...
 
 

saffier/metaclass.py

@@ -164,7 +164,7 @@ def __search_for_fields(base: typing.Type, attrs: DictAny) -> None:
 
                 if not isinstance(attrs["id"], Field) or not attrs["id"].primary_key:
                     raise ImproperlyConfigured(
-                        f"Cannot create model {name} without explicit primary key if field 'id' is already present"
+                        f"Cannot create model {name} without explicit primary key if field 'id' is already present."
                     )
 
         for key, value in attrs.items():
@@ -216,6 +216,14 @@ def __search_for_fields(base: typing.Type, attrs: DictAny) -> None:
         registry = meta.registry
         new_class.database = registry.database
 
+        # Abstract classes do not allow multiple managers. This make sure it is enforced.
+        if meta.abstract:
+            managers = [k for k, v in attrs.items() if isinstance(v, Manager)]
+            if len(managers) > 1:
+                raise ImproperlyConfigured(
+                    "Multiple managers are not allowed in abstract classes."
+                )
+
         # Making sure it does not generate tables if abstract it set
         if not meta.abstract:
             registry.models[name] = new_class

tests/managers/test_managers_abstract.py

@@ -63,14 +63,12 @@ async def rollback_connections():
             yield
 
 
-async def test_inherited_abstract_base_model_managers():
+@pytest.mark.parametrize("manager,total", [("query", 4), ("languages", 2)])
+async def test_inherited_abstract_base_model_managers(manager, total):
     await HubUser.query.create(name="test", language="EN")
     await HubUser.query.create(name="test2", language="EN")
     await HubUser.query.create(name="test3", language="PT")
     await HubUser.query.create(name="test4", language="PT")
 
-    # users = await HubUser.query.all()
-    # assert len(users) == 4
-
-    users = await HubUser.languages.all()
-    assert len(users) == 2
+    users = await getattr(HubUser, manager).all()
+    assert len(users) == total

tests/managers/test_managers_abstract_multiple.py

@@ -0,0 +1,39 @@
+import pytest
+from tests.settings import DATABASE_URL
+
+import saffier
+from saffier import Manager
+from saffier.db.connection import Database
+from saffier.db.queryset import QuerySet
+from saffier.exceptions import ImproperlyConfigured
+
+database = Database(url=DATABASE_URL)
+models = saffier.Registry(database=database)
+
+pytestmark = pytest.mark.anyio
+
+
+class ObjectsManager(Manager):
+    def get_queryset(self) -> QuerySet:
+        queryset = super().get_queryset().filter(is_active=True)
+        return queryset
+
+
+class LanguageManager(Manager):
+    def get_queryset(self) -> QuerySet:
+        queryset = super().get_queryset().filter(language="EN")
+        return queryset
+
+
+async def test_inherited_abstract_base_model_managers_raises_error_on_multiple():
+    with pytest.raises(ImproperlyConfigured) as raised:
+
+        class BaseModel(saffier.Model):
+            query = ObjectsManager()
+            languages = LanguageManager()
+
+            class Meta:
+                abstract = True
+                registry = models
+
+    assert raised.value.args[0] == "Multiple managers are not allowed in abstract classes."

tests/managers/test_managers_inherited.py

@@ -81,19 +81,17 @@ async def test_inherited_base_model_managers():
     assert len(users) == 2
 
 
-async def test_inherited_base_model_managers_product():
+@pytest.mark.parametrize("manager,total", [("query", 6), ("ratings", 3)])
+async def test_inherited_base_model_managers_product(manager, total):
     await Product.query.create(name="test", rating=5)
     await Product.query.create(name="test2", rating=4)
     await Product.query.create(name="test3", rating=3)
     await Product.query.create(name="test4", rating=2)
     await Product.query.create(name="test5", rating=2)
     await Product.query.create(name="test6", rating=1)
 
-    products = await Product.query.all()
-    assert len(products) == 6
-
-    products = await Product.ratings.all()
-    assert len(products) == 3
+    products = await getattr(Product, manager).all()
+    assert len(products) == total
 
 
 async def test_raises_key_error_on_non_existing_field_for_product():

tests/test_meta.py renamed to tests/metaclass/test_meta.py

@@ -0,0 +1,71 @@
+import pytest
+from tests.settings import DATABASE_URL
+
+import saffier
+from saffier import Manager, QuerySet
+from saffier.db.connection import Database
+from saffier.exceptions import ImproperlyConfigured
+
+pytestmark = pytest.mark.anyio
+
+database = Database(DATABASE_URL)
+models = saffier.Registry(database=database)
+
+
+class User(saffier.Model):
+    id = saffier.IntegerField(primary_key=True)
+    name = saffier.CharField(max_length=100)
+
+    class Meta:
+        registry = models
+
+
+class ObjectsManager(Manager):
+    def get_queryset(self) -> QuerySet:
+        queryset = super().get_queryset().filter(name__icontains="a")
+        return queryset
+
+
+async def test_improperly_configured_for_multiple_managers_on_abstract_class():
+    with pytest.raises(ImproperlyConfigured) as raised:
+
+        class BaseModel(saffier.Model):
+            query = ObjectsManager()
+            languages = ObjectsManager()
+
+            class Meta:
+                abstract = True
+                registry = models
+
+    assert raised.value.args[0] == "Multiple managers are not allowed in abstract classes."
+
+
+async def test_improperly_configured_for_primary_key():
+    with pytest.raises(ImproperlyConfigured) as raised:
+
+        class BaseModel(saffier.Model):
+            id = saffier.IntegerField(primary_key=False)
+            query = ObjectsManager()
+            languages = ObjectsManager()
+
+            class Meta:
+                registry = models
+
+    assert (
+        raised.value.args[0]
+        == "Cannot create model BaseModel without explicit primary key if field 'id' is already present."
+    )
+
+
+async def test_improperly_configured_for_multiple_primary_keys():
+    with pytest.raises(ImproperlyConfigured) as raised:
+
+        class BaseModel(saffier.Model):
+            name = saffier.IntegerField(primary_key=True)
+            query = ObjectsManager()
+            languages = ObjectsManager()
+
+            class Meta:
+                registry = models
+
+    assert raised.value.args[0] == "Cannot create model BaseModel with multiple primary keys."