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

Uploaded Source

Built Distribution

drfexts-1.4.6-py3-none-any.whl (42.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: drfexts-1.4.6.tar.gz
  • Upload date:
  • Size: 32.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.11.5 Darwin/22.6.0

File hashes

Hashes for drfexts-1.4.6.tar.gz
Algorithm Hash digest
SHA256 7a879b9d0c3594edca6a0555f15e9ae2f28a7b6e7cf79d1cf4a5de143b9632f6
MD5 6fada445c8f162c879099c3ac4ba4a96
BLAKE2b-256 45d62adb226159911993e9c16d4d8e1aea6d734b5936cd87beb66655bfa9e2fb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: drfexts-1.4.6-py3-none-any.whl
  • Upload date:
  • Size: 42.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.11.5 Darwin/22.6.0

File hashes

Hashes for drfexts-1.4.6-py3-none-any.whl
Algorithm Hash digest
SHA256 8287948efe3f93668d721f9e44adcb1bf1763846705c1a863d8da7b2c15605b5
MD5 8c8a8af1c4bfa2056ff01474abc306cf
BLAKE2b-256 8190e25ba31137e5ac7685aed477f87fa6cdeb20380b114a22d22a2f9188d094

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