Skip to content

DownloadActionMixin

DownloadActionMixin

djadmin.actions.base.DownloadActionMixin

Mixin for actions that return file downloads.

No view is displayed, returns HttpResponse with file attachment.

Examples

  • ExportCSVAction
  • ExportPDFAction
  • GenerateReportAction

Method Resolution Order

  1. djadmin.actions.base.DownloadActionMixin

Methods

get_download_response(self, request: django.http.request.HttpRequest, obj=None, queryset=None, **kwargs) -> django.http.response.HttpResponse

Defined in: <class 'djadmin.actions.base.DownloadActionMixin'>

Generate file download response.

Override this method to generate the file.

Args: request: The HTTP request obj: Single object (for record actions) queryset: Multiple objects (for bulk/list actions) **kwargs: Additional context

Returns: HttpResponse with Content-Disposition header

Source code in base.py line 625
    def get_download_response(
        self,
        request: HttpRequest,
        obj=None,
        queryset=None,
        **kwargs,
    ) -> HttpResponse:
        """
        Generate file download response.

        Override this method to generate the file.

        Args:
            request: The HTTP request
            obj: Single object (for record actions)
            queryset: Multiple objects (for bulk/list actions)
            **kwargs: Additional context

        Returns:
            HttpResponse with Content-Disposition header
        """
        raise NotImplementedError(f'{self.__class__.__name__} must implement get_download_response()')

Fields

Field Type Related To
__dict__ getset_descriptor -
__weakref__ getset_descriptor -