Improved Field.file/Field.image, added Field.dropfile/Field.dropimage (iommirocks#704)

Author: berycz

docs/test_doc_cookbook_edit_tables.py

@@ -34,7 +34,9 @@ def test_how_do_you_edit_one_to_one_in_a_table(black_sabbath):
     Include them in `auto__include`. Say you have a profile model for an artist:
     """
 
+    # @test
     profile = Profile.objects.create(artist=black_sabbath)
+    # @end
 
     # language=rst
     """
@@ -68,7 +70,7 @@ def test_how_do_you_edit_one_to_one_in_a_table(black_sabbath):
     # @end
 
 
-def test_how_do_I_change_delete_to_checkboxes():
+def test_how_do_i_change_delete_to_checkboxes(ozzy):
     # language=rst
     """
     .. _edit-table-delete-as-checkbox:
@@ -79,6 +81,10 @@ def test_how_do_I_change_delete_to_checkboxes():
     Just add `data-iommi-edit-table-delete-with="checkbox"`:
     """
 
+    # @test
+    Profile.objects.create(artist=ozzy)
+    # @end
+
     edit_table = EditTable(
         auto__model=Profile,
         auto__include=['artist__name'],
@@ -92,3 +98,32 @@ def test_how_do_I_change_delete_to_checkboxes():
     # @test
     show_output(edit_table)
     # @end
+
+
+def test_how_do_i_include_labels_for_fields(ozzy):
+    # language=rst
+    """
+    .. _edit-table-include-field-labels:
+
+    How do I include labels for fields?
+    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+    If you're using `EditTable` and not `EditTable.div`, then by default you get fields rendered without labels,
+    because the label text is in the table header. But in case you still want to render labels (e.g. as floating labels),
+    you can just set `extra_evaluated__input_labels_include = True`:
+    """
+
+    # @test
+    Profile.objects.create(artist=ozzy)
+    # @end
+
+    edit_table = EditTable(
+        auto__model=Profile,
+        auto__include=['artist__name'],
+        columns__artist_name__field__include=True,
+        extra_evaluated__input_labels_include=True,
+    )
+
+    # @test
+    show_output(edit_table)
+    # @end

docs/test_doc_cookbook_forms.py

@@ -1,3 +1,7 @@
+from pathlib import Path
+
+from django.core.files import File
+from django.db.models import FileField, ImageField
 from django.contrib.auth.models import User
 from django.core.exceptions import ValidationError
 from django.utils.translation import gettext_lazy
@@ -1442,3 +1446,46 @@ class Meta:
 
     The same way you can also use layouts for filter forms via `Table.query__form__layout`
     """
+
+
+def test_dropfile_dropimage_field():
+    # language=rst
+    """
+    .. _dropfile-dropimage:
+
+    How to make cool drag&drop file or image fields?
+    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+    If you don't want a regular file-inputs, you can use `Field.dropfile` and `Field.dropimage`:
+    """
+
+    # @test
+    existing_files = []
+    for fn in ("Black Sabbath Vol 4.jpg", "Heaven And Hell.jpg"):
+        with open(Path(__file__).resolve().parent.parent / "examples" / "examples" / "static" / "album_art" / "Black Sabbath" / fn, "rb") as f:
+            _file = File(f)
+            _file.url = f'https://github.com/iommirocks/iommi/blob/master/examples/examples/static/album_art/Black%20Sabbath/{fn}?raw=true'
+            existing_files.append(_file)
+    # @end
+
+    form = Form.create(
+        fields__my_document=Field.dropfile(display_name="My document"),
+        fields__my_image=Field.dropimage(display_name="My image"),
+        fields__existing_files=Field.dropfile(
+            display_name="Existing multiple files",
+            is_list=True,
+            initial=existing_files,
+        ),
+    )
+
+    # @test
+    show_output(form)
+    # @end
+
+    # language=rst
+    """
+    And of course you can also use `registrations </registrations.html#django-custom-fields>`__ to enable drag&drop for all file/image fields:
+    """
+
+    register_field_factory(FileField, shortcut_name='dropfile')
+    register_field_factory(ImageField, shortcut_name='dropimage')

iommi/edit_table.py

@@ -9,8 +9,8 @@
 )
 
 from django.db.models import QuerySet
+from django.db.models.fields.files import FieldFile
 from django.http import HttpResponseRedirect
-from django.template import Context
 from django.utils.safestring import mark_safe
 from django.utils.translation import gettext_lazy
 
@@ -23,6 +23,7 @@
     Actions,
     group_actions,
 )
+from iommi.error import Errors
 from iommi.sort_after import LAST
 from iommi.base import (
     MISSING,
@@ -115,24 +116,26 @@ def render_cell_contents(self):
 
             bind_field_from_instance(field, self.row)
 
-            if self.table.extra_evaluated.render_inputs_only or 'hidden' in getattr(field, 'iommi_shortcut_stack', []):
-                input_html = field.input.__html__()
-            else:
-                input_html = field.__html__()
-
-            field.attr = orig_attr
-
             # Check both edit_errors and create_errors
             errors = None
             if self.table.edit_errors:
                 errors = self.table.edit_errors.get(path)
             if not errors and self.table.create_errors:
                 errors = self.table.create_errors.get(path)
 
-            if errors:
-                return Template(
-                    '{{ input_html }}<br><span class="text-danger"><ul class="errors">{% for error in errors %}<li>{{ error }}</li>{% endfor %}</ul></span>'
-                ).render(context=Context(dict(input_html=input_html, errors=errors)))
+            if self.table.extra_evaluated.render_inputs_only or 'hidden' in getattr(field, 'iommi_shortcut_stack', []):
+                input_html = field.input.__html__()
+            else:
+                if self.table.extra_evaluated.input_labels_include is False:
+                    field.label.include = False
+                if errors:
+                    field._errors = errors
+
+                input_html = field.__html__()
+
+                field.errors = Errors(parent=field)
+
+            field.attr = orig_attr
 
             return input_html
         else:
@@ -143,6 +146,7 @@ def on_refine_done(self):
             self.value = None
         super(EditCell, self).on_refine_done()
 
+
 def bind_field_from_instance(field, instance):
     field.input = field.iommi_namespace.input(_name='input')
     field.non_editable_input = field.iommi_namespace.non_editable_input(_name='non_editable_input')
@@ -337,6 +341,7 @@ def save(cells_iterator, form):
             instance = cells.row
             form.instance = instance
             attrs_to_save = []
+            to_save_in_second_phase = []
             for cell in cells.iter_editable_cells():
                 path = cell.get_path()
                 if path not in parsed_data:
@@ -345,20 +350,25 @@ def save(cells_iterator, form):
                 field = form.fields[cell.column.iommi_name()]
                 field._iommi_path_override = path
                 if cells.is_create_template or (
-                    field.invoke_callback(field.read_from_instance, instance=instance) != value
+                        (instance_value := field.invoke_callback(field.read_from_instance, instance=instance)) != value
                 ):
-                    field.invoke_callback(field.write_to_instance, instance=instance, value=value)
-                    if not field.extra.get('django_related_field', False):
+                    if field.extra.get('django_related_field', False):
+                        if not cells.is_create_template and isinstance(instance_value, FieldFile) and not instance_value and value is None:
+                            # instance value of FileField/ImageField is an empty FieldFile/ImageFieldFile, not None
+                            pass
+                        else:
+                            to_save_in_second_phase.append((field, value))
+                    else:
+                        field.invoke_callback(field.write_to_instance, instance=instance, value=value)
                         attrs_to_save.append(field.attr)
 
-            to_save.append((instance, attrs_to_save))
+            to_save.append((instance, attrs_to_save, to_save_in_second_phase))
 
         to_save.sort(key=lambda x: abs(x[0].pk))
-        for instance, attrs_to_save in to_save:
-            if not to_save:
-                pass
+        for instance, attrs_to_save, to_save_in_second_phase in to_save:
             if instance.pk is not None and instance.pk < 0:
                 instance.pk = None
+
             if instance.pk is None:
                 attrs_to_save = None
 
@@ -371,6 +381,11 @@ def save(cells_iterator, form):
                         model_object = getattr_path(model_object, prefix)
                     model_object.save(update_fields=[strip_prefix(x, prefix=f'{prefix}__') for x in attrs_to_save if x.startswith(prefix)])
 
+            if to_save_in_second_phase:
+                for field, value in to_save_in_second_phase:
+                    field.invoke_callback(field.write_to_instance, instance=instance, value=value)
+                instance.save()
+
     save(table.cells_for_rows(), table.edit_form)
     save(table.cells_for_rows_for_create(save=True), table.create_form)
 
@@ -459,7 +474,8 @@ class Meta:
 
         reorderable = False
 
-        extra_evaluated__render_inputs_only = lambda table, **_: table.row.layout is None
+        extra_evaluated__render_inputs_only = False
+        extra_evaluated__input_labels_include = lambda table, **_: table.row.layout is not None
 
         bulk__include = True
 
@@ -651,8 +667,9 @@ def parse_virtual_pk(k):
             except ValueError:
                 return None
 
-        post_data = self.get_request().POST
-        pks = {parse_virtual_pk(k) for k in keys(post_data)}
+        request = self.get_request()
+        post_data = request.POST
+        pks = {parse_virtual_pk(k) for k in {*keys(post_data), *keys(request.FILES)}}
         virtual_pks = [
             k for k in pks
             if k is not None and k < 0 and f'{delete_prefix}{k}' not in post_data