Switch from wrapt library to decorator so that components which utilize the db_model decorator can be stored in backend cache.

Author: adamghill

django_unicorn/decorators.py

@@ -3,11 +3,11 @@
 
 from django.conf import settings
 
-import wrapt
+from decorator import decorator
 
 
-@wrapt.decorator()
-def db_model(wrapped, instance, args, kwargs):
+@decorator
+def db_model(func, *args, **kwargs):
     """
     Converts a JSON representation of a Django model into an actual model.
 
@@ -20,50 +20,48 @@ def delete(self, model):
         `component.delete({ 'name': 'modelName', pk: 1})` -> `component.delete(modelInstance)`
     """
 
+    instance = args[0]
+    model_dictionary = args[1]
+
     if hasattr(instance, "Meta") and hasattr(instance.Meta, "db_models"):
-        db_model_name = args[0].get("name")
+        db_model_name = model_dictionary.get("name")
         assert db_model_name, "Missing db model name"
-        db_model_pk = args[0].get("pk")
+        db_model_pk = model_dictionary.get("pk")
         assert db_model_pk, "Missing db model pk"
         db_model_found = False
 
         for db_model in instance.Meta.db_models:
             if db_model.name == db_model_name:
                 model = db_model.model_class.objects.get(pk=db_model_pk)
-                args = (model,) + args[1:]
+                args = (instance, model,) + args[2:]
                 db_model_found = True
                 break
 
         assert db_model_found, f"No db_model found that matches '{db_model_name}'"
     else:
         raise AssertionError("No db_models defined")
 
-    result = wrapped(*args, **kwargs)
+    result = func(*args, **kwargs)
 
     return result
 
 
-def _timed_enabled():
-    return settings.DEBUG
-
-
-@wrapt.decorator(enabled=_timed_enabled)
-def timed(wrapped, instance, args, kwargs):
+@decorator
+def timed(func, *args, **kwargs):
     """
     Decorator that prints out the timing of a function.
 
     Slightly altered version of https://gist.github.com/bradmontgomery/bd6288f09a24c06746bbe54afe4b8a82.
     """
+    if not settings.DEBUG:
+        return func(*args, **kwargs)
+
     logger = logging.getLogger("profile")
     start = time.time()
-    result = wrapped(*args, **kwargs)
+    result = func(*args, **kwargs)
     end = time.time()
 
-    function_name = wrapped.__name__
-
-    if instance:
-        function_name = f"{instance}.{function_name}"
-
+    function_name = func.__name__
     arguments = ""
 
     if args:

poetry.lock

@@ -15,9 +15,9 @@ django = ">=2.2"
 beautifulsoup4 = ">=4.8.0"
 orjson = "^3.2.1"
 shortuuid = "^1.0.1"
-wrapt = "^1.12.1"
 cachetools = "^4.1.1"
 dataclasses = {version = "^0.8.0", python = "<3.7"}
+decorator = "^4.4.2"
 
 [tool.poetry.dev-dependencies]
 pytest = "^6.2"

pyproject.toml

@@ -38,19 +38,19 @@ def test_happy_path(component):
 @pytest.mark.django_db
 def test_missing_name(component):
     with pytest.raises(AssertionError):
-        component.get_pk({"pk": 1})
+        component.get_pk({"pk": 1}, 1)
 
 
 @pytest.mark.django_db
 def test_missing_pk(component):
     with pytest.raises(AssertionError):
-        component.get_pk({"name": "flavor"})
+        component.get_pk({"name": "flavor"}, 1)
 
 
 @pytest.mark.django_db
 def test_model_not_found(component):
     with pytest.raises(Flavor.DoesNotExist):
-        component.get_pk({"name": "flavor", "pk": -99})
+        component.get_pk({"name": "flavor", "pk": -99}, 1)
 
 
 @pytest.mark.django_db
@@ -83,9 +83,9 @@ class Meta:
 
 
 @pytest.mark.django_db
-def test_component_db_model_not_pickleable(component):
+def test_component_db_model_is_pickleable(component):
     """
-    This is not ideal and should hopefully be fixable by providing a `__reduce_ex__` method.
+    Using the `wrapt` library would raise an exception, but the `decorator` library
+    is pickleable, so this should be a-ok
     """
-    with pytest.raises(UnicornCacheError):
-        get_cacheable_component(component)
+    get_cacheable_component(component)