drfexts
Extensions for Django REST Framework
Author: Aiden Lu.
Installation
$ pip install drfexts
Usage
views.py
from rest_framework.views import APIView
from rest_framework.settings import api_settings
from drfexts.viewsets import ExportMixin
class MyView (ExportMixin, APIView):
...
Ordered Fields
By default, a CSVRenderer will output fields in sorted order. To specify an alternative field ordering you can override the header attribute. There are two ways to do this:
-
Create a new renderer class and override the
headerattribute directly:class MyUserRenderer (CSVRenderer): header = ['first', 'last', 'email'] @api_view(['GET']) @renderer_classes((MyUserRenderer,)) def my_view(request): users = User.objects.filter(active=True) content = [{'first': user.first_name, 'last': user.last_name, 'email': user.email} for user in users] return Response(content) -
Use the
renderer_contextto override the field ordering on the fly:class MyView (APIView): renderer_classes = [CSVRenderer] def get_renderer_context(self): context = super().get_renderer_context() context['header'] = ( self.request.GET['fields'].split(',') if 'fields' in self.request.GET else None) return context ...
Labeled Fields
Custom labels can be applied to the CSVRenderer using the labels dict attribute where each key corresponds to the header and the value corresponds to the custom label for that header.
1) Create a new renderer class and override the header and labels attribute directly:
class MyBazRenderer (CSVRenderer): header = ['foo.bar'] labels = { 'foo.bar': 'baz' }
Pagination
Using the renderer with paginated data is also possible with the new [PaginatedCSVRenderer]{.title-ref} class and should be used with views that paginate data
For more information about using renderers with Django REST Framework, see the API Guide or the Tutorial.
Running the tests
To run the tests against the current environment:
$ ./manage.py test
Changelog
1.0.0
- Initial release
Thanks
336 Dec 28, 2022
4 Dec 6, 2022
1 Mar 31, 2022
1 May 3, 2022
1 Oct 24, 2021
1 Oct 31, 2021
1.8k Jan 4, 2023
35 Dec 23, 2022
3.8k Jan 4, 2023
575 Jan 05, 2023
24.7k Jan 04, 2023
106 Oct 14, 2022
223 Dec 07, 2022
6 Jan 28, 2022
3k Jan 06, 2023
53 Dec 12, 2022
9k Jan 03, 2023
20 Jul 14, 2022
525 Jan 01, 2023
142 Jan 06, 2023
1.3k Dec 28, 2022
8 Sep 12, 2022
4 Feb 19, 2022
1 Nov 16, 2021