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-0.19.1.tar.gz (30.9 kB view details)

Uploaded Source

Built Distribution

drfexts-0.19.1-py3-none-any.whl (39.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: drfexts-0.19.1.tar.gz
  • Upload date:
  • Size: 30.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.2 CPython/3.9.13 Darwin/21.6.0

File hashes

Hashes for drfexts-0.19.1.tar.gz
Algorithm Hash digest
SHA256 8f6081d57a0c18389bb69106813911b65f517e5a9acddc7b35ecd2147bbea5ac
MD5 ad7d9e712f008346c02eaa96f0d8a45e
BLAKE2b-256 734a407e881c1f38a0c1f190959c9b9d30a174d6c8bb21085979f74d6a9e2b28

See more details on using hashes here.

File details

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

File metadata

  • Download URL: drfexts-0.19.1-py3-none-any.whl
  • Upload date:
  • Size: 39.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.2 CPython/3.9.13 Darwin/21.6.0

File hashes

Hashes for drfexts-0.19.1-py3-none-any.whl
Algorithm Hash digest
SHA256 efb6100928227d042dbd132de646d9b80ff4dd2b6f701a560f66f8518a41d5eb
MD5 c140671764901bbd72938302bc6277a0
BLAKE2b-256 b718b69898bacea318c764e25d9caf56a9e9ff85f9fba8a1f2f3728c751870a8

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