refactor: split the base model class in two

canaille/backends/ldap/ldapobject.py

@@ -5,7 +5,7 @@ from collections.abc import Iterable
 import ldap.dn
 import ldap.filter
 
-from canaille.backends.models import Model
+from canaille.backends.models import BackendModel
 
 from .backend import Backend
 from .utils import cardinalize_attribute
@@ -104,7 +104,7 @@ class LDAPObjectQuery:
         return klass
 
 
-class LDAPObject(Model, metaclass=LDAPObjectMetaclass):
+class LDAPObject(BackendModel, metaclass=LDAPObjectMetaclass):
     _object_class_by_name = None
     _attribute_type_by_name = None
     _may = None
@@ -166,8 +166,8 @@ class LDAPObject(Model, metaclass=LDAPObjectMetaclass):
     def __hash__(self):
         return hash(self.id)
 
-    def __getattr__(self, name):
+    def __getattribute__(self, name):
-        if name not in self.attributes:
+        if name == "attributes" or name not in self.attributes:
             return super().__getattribute__(name)
 
         ldap_name = self.python_attribute_to_ldap(name)

canaille/backends/memory/models.py

@@ -8,17 +8,17 @@ from flask import current_app
 import canaille.core.models
 import canaille.oidc.models
 from canaille.app import models
-from canaille.backends.models import Model
+from canaille.backends.models import BackendModel
 
 
-class MemoryModel(Model):
+class MemoryModel(BackendModel):
     indexes = {}
     """Associates ids and states."""
 
     attribute_indexes = {}
     """Associates attribute values and ids."""
 
-    def __init__(self, **kwargs):
+    def __init__(self, *args, **kwargs):
         kwargs.setdefault("id", str(uuid.uuid4()))
         self._state = {}
         self._cache = {}

canaille/backends/models.py

@@ -8,8 +8,7 @@ from canaille.app import classproperty
 class Model:
     """The model abstract class.
 
-    It details all the methods and attributes that are expected to be
+    It details all the common attributes shared by every models.
-    implemented for every model and for every backend.
     """
 
     created: Optional[datetime.datetime]
@@ -24,6 +23,14 @@ class Model:
     the value MUST be the same as the value of :attr:`~canaille.backends.models.Model.created`.
     """
 
+
+class BackendModel:
+    """The backend model abstract class.
+
+    It details all the methods and attributes that are expected to be
+    implemented for every model and for every backend.
+    """
+
     @classproperty
     def attributes(cls):
         return ChainMap(

canaille/backends/sql/models.py

@@ -24,7 +24,7 @@ from sqlalchemy_utils import force_auto_coercion
 import canaille.core.models
 import canaille.oidc.models
 from canaille.app import models
-from canaille.backends.models import Model
+from canaille.backends.models import BackendModel
 
 from .backend import Backend
 from .backend import Base
@@ -33,7 +33,7 @@ from .utils import TZDateTime
 force_auto_coercion()
 
 
-class SqlAlchemyModel(Model):
+class SqlAlchemyModel(BackendModel):
     def __html__(self):
         return self.id
 

tests/backends/test_models.py

@@ -4,32 +4,6 @@ import freezegun
 import pytest
 
 from canaille.app import models
-from canaille.backends.models import Model
-
-
-def test_required_methods(testclient):
-    with pytest.raises(NotImplementedError):
-        Model.query()
-
-    with pytest.raises(NotImplementedError):
-        Model.fuzzy("foobar")
-
-    with pytest.raises(NotImplementedError):
-        Model.get()
-
-    obj = Model()
-
-    with pytest.raises(NotImplementedError):
-        obj.identifier
-
-    with pytest.raises(NotImplementedError):
-        obj.save()
-
-    with pytest.raises(NotImplementedError):
-        obj.delete()
-
-    with pytest.raises(NotImplementedError):
-        obj.reload()
 
 
 def test_model_comparison(testclient, backend):