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

Uploaded Source

Built Distribution

drfexts-0.5.26-py3-none-any.whl (36.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: drfexts-0.5.26.tar.gz
  • Upload date:
  • Size: 30.4 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.5.26.tar.gz
Algorithm Hash digest
SHA256 4443a01899ab80b3e967c417ce9aa25cbeec0b4e88146c3a64e07b84043c3379
MD5 a276a4448ce6b3ec0e13cd166237f975
BLAKE2b-256 43eb65bd65af7995341e5bcb49b9140bf4ee976fe8445f923546a930e9be0584

See more details on using hashes here.

File details

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

File metadata

  • Download URL: drfexts-0.5.26-py3-none-any.whl
  • Upload date:
  • Size: 36.6 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.5.26-py3-none-any.whl
Algorithm Hash digest
SHA256 4fb9e281f6cfa9676583466a9ec1cb3b3ff080f37995fa1a4fd31c2e53862ec2
MD5 cc79aafeb87dacd74873e9e857978da1
BLAKE2b-256 d082fd71c013e418b683652a9cc1461c03efc1fbc5857b9c5d823525b7b39c9e

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