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

Uploaded Source

Built Distribution

drfexts-0.19.6-py3-none-any.whl (39.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for drfexts-0.19.6.tar.gz
Algorithm Hash digest
SHA256 6b5399f7a0970b454d63e7fa97d6c3c3b2bc54c7954064553c2614feab9ba347
MD5 6b30954488281f565963044d365100ce
BLAKE2b-256 ca7f162e9f143deca4ff498f636f94ae2e0e7774d06022e2940a6801d813a795

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for drfexts-0.19.6-py3-none-any.whl
Algorithm Hash digest
SHA256 0671f7bee78c54db35d0e488000fffa68839f271dcabdcc24a7abe30bf7b204e
MD5 b73c78f8818048f29dd55af4bcd382c6
BLAKE2b-256 f56ae75676099c4037acb00d8e93be1ca4d17a15d9840e9f5726de40f3f6373d

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