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

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:

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

Uploaded Source

Built Distribution

drfexts-0.7.4-py3-none-any.whl (43.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: drfexts-0.7.4.tar.gz
  • Upload date:
  • Size: 34.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.10.2 Darwin/21.3.0

File hashes

Hashes for drfexts-0.7.4.tar.gz
Algorithm Hash digest
SHA256 20cc40886a342eb740982f0f146b835a01239b840f91a3dd907a7a00bab4fbf7
MD5 2a0a14100f04dc1eb881ee51fffc1f9a
BLAKE2b-256 d2fd12b22c1341149087c6ac8901b0ba0b375b95f03bf34f68c307359df84e25

See more details on using hashes here.

File details

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

File metadata

  • Download URL: drfexts-0.7.4-py3-none-any.whl
  • Upload date:
  • Size: 43.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.10.2 Darwin/21.3.0

File hashes

Hashes for drfexts-0.7.4-py3-none-any.whl
Algorithm Hash digest
SHA256 1b4f400c3936649e8aa50f7a23e4dd356eefecdb40dfa80d232cb767097d4c6a
MD5 7343d138a323e986593c901882ee532a
BLAKE2b-256 2a130552926140212d528714c1e26734b67533bbc165026467c9a882bfd7975c

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