Merge pull request #297 from mihalikv/develop

Added ability to pickle FilePreference in Django 4.2

Author: agateblue

dynamic_preferences/serializers.py

@@ -275,6 +275,28 @@ def to_python(self, value, **kwargs):
             raise self.exception("Array {0} cannot be converted to int".format(value))
 
 
+# FieldFile also needs a model instance to save changes.
+class FakeInstance(object):
+    """
+    FieldFile needs a model instance to update when file is persisted
+    or deleted
+    """
+
+    def save(self):
+        return
+
+
+class FakeField(object):
+    """
+    FieldFile needs a field object to generate a filename, persist
+    and delete files, so we are effectively mocking that.
+    """
+
+    name = "noop"
+    attname = "noop"
+    max_length = 10000
+
+
 class PreferenceFieldFile(FieldFile):
     """
     In order to have the same API that we have with models.FileField,
@@ -285,33 +307,9 @@ class PreferenceFieldFile(FieldFile):
 
     def __init__(self, preference, storage, name):
         super(FieldFile, self).__init__(None, name)
-
-        # FieldFile also needs a model instance to save changes.
-        class FakeInstance(object):
-            """
-            FieldFile needs a model instance to update when file is persisted
-            or deleted
-            """
-
-            def save(self):
-                return
-
         self.instance = FakeInstance()
-
-        class FakeField(object):
-            """
-            FieldFile needs a field object to generate a filename, persist
-            and delete files, so we are effectively mocking that.
-            """
-
-            name = "noop"
-            attname = "noop"
-            max_length = 10000
-
-            def generate_filename(field, instance, name):
-                return os.path.join(self.preference.get_upload_path(), f.name)
-
         self.field = FakeField()
+        self.field.storage = storage
         self.storage = storage
         self._committed = True
         self.preference = preference
@@ -483,5 +481,5 @@ def to_python(cls, value, **kwargs):
         while "" in ret:
             pos = ret.index("")
             val = ret[pos - 1] + cls.separator + ret[pos + 1]
-            ret = ret[0 : pos - 1] + [val] + ret[pos + 2 :]
+            ret = ret[0: pos - 1] + [val] + ret[pos + 2:]
         return ret

tests/test_types.py

@@ -1,5 +1,7 @@
 import os
 import decimal
+import pickle
+
 import pytest
 
 from datetime import date, timedelta, datetime, time
@@ -239,6 +241,19 @@ def test_file_preference_api_repr_returns_path(db):
     assert p.api_repr(f) == f.url
 
 
+def test_file_preference_if_pickleable(db):
+    manager = global_preferences_registry.manager()
+    f = SimpleUploadedFile(
+        "test_file_24485a80-8db9-4191-ae49-da7fe2013794.txt",
+        "hello world".encode("utf-8"),
+    )
+    try:
+        manager["blog__logo"] = f
+        pickle.dumps(manager["blog__logo"])
+    except Exception:
+        pytest.fail("FilePreference not pickleable")
+
+
 def test_choice_preference(fake_user):
     fake_user.preferences["user__favorite_vegetable"] = "C"
     assert fake_user.preferences["user__favorite_vegetable"] == "C"