Skip to main content

Django Restframework Utils

Project description

drfexts

GitHub license pypi-version PyPI - Python Version PyPI - Django Version PyPI - DRF Version Build Status Black code style

Extensions for Django REST Framework

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:

  1. Create a new renderer class and override the header attribute 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)
    
  2. Use the renderer_context to 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

PyCharm

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

drfexts-3.9.6.tar.gz (37.4 kB view details)

Uploaded Source

Built Distribution

drfexts-3.9.6-py3-none-any.whl (48.1 kB view details)

Uploaded Python 3

File details

Details for the file drfexts-3.9.6.tar.gz.

File metadata

  • Download URL: drfexts-3.9.6.tar.gz
  • Upload date:
  • Size: 37.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.3 Darwin/23.4.0

File hashes

Hashes for drfexts-3.9.6.tar.gz
Algorithm Hash digest
SHA256 63306396f46dd50b5c1d7b68bdd9a5ddd964cf2f4c500b34b9e1e8d1e4287492
MD5 abf8d00049f5480186c97e7a72478ef7
BLAKE2b-256 ff031077a5b41a13837f2d56179cacb8afea9ef55e1295a3d659a0d3036197b2

See more details on using hashes here.

File details

Details for the file drfexts-3.9.6-py3-none-any.whl.

File metadata

  • Download URL: drfexts-3.9.6-py3-none-any.whl
  • Upload date:
  • Size: 48.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.3 Darwin/23.4.0

File hashes

Hashes for drfexts-3.9.6-py3-none-any.whl
Algorithm Hash digest
SHA256 dd32195f7ebbc0d6c2806bcf49a12d5d0e5e8ef28cb3b39cfcb989181af01f98
MD5 5c4545deb59567925c6ee2eaf53d7b40
BLAKE2b-256 20d540ef5d257a8cb0e0fd77df2a06cd43c5288aee0490491e364f1f9d74a029

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page