Merge pull request #150 from saritasa-nest/feature/add-field-selection-to-export-in-admin-page

Add field selection to admin export confirmation page

Author: Eg0ra

HISTORY.rst

@@ -8,6 +8,7 @@ unreleased
 * Improve filterset class initialization during fetching export queryset
 * Add ability to customize the order of operation for export queryset
 * Add ability to set dataset title
+* Add field selection to the export confirmation page in the admin panel
 
 1.8.0 (2025-06-30)
 ------------------

import_export_extensions/admin/mixins/export_mixin.py

@@ -12,8 +12,8 @@
 from django.utils.translation import gettext_lazy as _
 
 from import_export import admin as import_export_admin
+from import_export import forms as import_export_forms
 from import_export import mixins as import_export_mixins
-from import_export.forms import ExportForm
 
 from ... import models
 from . import base_mixin, types
@@ -43,7 +43,9 @@ class CeleryExportAdminMixin(
     # export data encoding
     to_encoding = "utf-8"
 
-    export_form_class: type[ExportForm] = ExportForm
+    export_form_class: type[import_export_forms.ExportForm] = (
+        import_export_forms.SelectableFieldsExportForm
+    )
 
     # template used to display ExportForm
     celery_export_template_name = "admin/import_export/export.html"
@@ -68,6 +70,7 @@ class CeleryExportAdminMixin(
         import_export_admin.ExportMixin.has_export_permission
     )
     get_export_form_class = import_export_admin.ExportMixin.get_export_form_class  # noqa
+    get_export_resource_fields_from_form = import_export_admin.ExportMixin.get_export_resource_fields_from_form  # noqa
 
     def get_export_context_data(self, **kwargs):
         """Get context data for export."""
@@ -136,6 +139,10 @@ def celery_export_action(self, request, *args, **kwargs):
         )
         if request.method == "POST" and form.is_valid():
             file_format = formats[int(form.cleaned_data["format"])]
+            # Get the selected export fields from the form
+            resource_kwargs["export_fields"] = (
+                self.get_export_resource_fields_from_form(form)
+            )
             # create ExportJob and redirect to page with it's status
             job = self.create_export_job(
                 request=request,

import_export_extensions/models/export_job.py

@@ -239,7 +239,7 @@ def cancel_export(self) -> None:
 
     def _export_data_inner(self) -> None:
         """Run export process with saving to file."""
-        self.result = self.resource.export()
+        self.result = self.resource.export(**self.resource_kwargs)
         self.save(update_fields=["result"])
 
         # `export_data` may be bytes (base formats such as xlsx, csv, etc.) or

test_project/tests/integration_tests/test_admin/test_export/test_export.py

@@ -45,6 +45,10 @@ def test_export_using_admin_model(client: Client, superuser: User):
         path=reverse("admin:fake_app_artist_export"),
         data={
             "format": 0,
+            "artistresourcewithm2m_id": "on",
+            "artistresourcewithm2m_name": "on",
+            "artistresourcewithm2m_bands": "on",
+            "artistresourcewithm2m_instrument": "on",
         },
     )
     assert start_export_response.status_code == status.HTTP_302_FOUND
@@ -63,6 +67,46 @@ def test_export_using_admin_model(client: Client, superuser: User):
     )
 
 
+@pytest.mark.usefixtures("existing_artist")
+@pytest.mark.django_db(transaction=True)
+def test_export_using_admin_with_select_fields(
+    client: Client,
+    superuser: User,
+):
+    """Test that only selected fields are exported."""
+    client.force_login(superuser)
+
+    # Make get request to admin export page
+    export_get_response = client.get(
+        path=reverse("admin:fake_app_artist_export"),
+    )
+    assert export_get_response.status_code == status.HTTP_200_OK
+
+    response = client.post(
+        path=reverse("admin:fake_app_artist_export"),
+        follow=True,
+        data={
+            "format": 0,
+            "artistresourcewithm2m_id": "on",
+            "artistresourcewithm2m_name": "on",
+            "artistresourcewithm2m_bands": "on",
+        },
+    )
+    assert response.status_code == status.HTTP_200_OK
+
+    with pathlib.Path(
+        response.context["export_job"].data_file.path,
+    ).open() as file:
+        content = list(csv.reader(file))
+
+    expected_fields_count = 3
+    content_headers = content[0]
+    exported_artist = content[1]
+    assert len(content_headers) == expected_fields_count
+    assert len(exported_artist) == expected_fields_count
+    assert "instrument" not in content_headers
+
+
 @pytest.mark.parametrize(
     argnames=["view_name", "path_kwargs"],
     argvalues=[
@@ -259,6 +303,10 @@ def test_export_using_get_params(
         reverse("admin:fake_app_artist_export"),
         data={
             "format": 0,
+            "artistresourcewithm2m_id": "on",
+            "artistresourcewithm2m_name": "on",
+            "artistresourcewithm2m_bands": "on",
+            "artistresourcewithm2m_instrument": "on",
         },
         follow=True,
         QUERY_STRING=f"q={search_value}&instrument__title={instrument_title}",