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

Uploaded Source

Built Distribution

drfexts-3.10.2-py3-none-any.whl (48.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: drfexts-3.10.2.tar.gz
  • Upload date:
  • Size: 37.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.3 Darwin/23.5.0

File hashes

Hashes for drfexts-3.10.2.tar.gz
Algorithm Hash digest
SHA256 bbe757734b7d935deaca585d888d41504f5256d99b51113af75def241ba516f9
MD5 16937328b46c2bfb184bb824ac72473e
BLAKE2b-256 2cd6ec9d2f2747775b0bf6ec6e3b411892b6830e1963925295ff446a8dfebc2d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: drfexts-3.10.2-py3-none-any.whl
  • Upload date:
  • Size: 48.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.3 Darwin/23.5.0

File hashes

Hashes for drfexts-3.10.2-py3-none-any.whl
Algorithm Hash digest
SHA256 596a1896acf9a6e0f19d19941997b236288a7e0ffdeaa733637276f29e33b46b
MD5 68ae115ff086305b039cb9d8ca226d08
BLAKE2b-256 b2abd40f0b83d77339fd6b982e53872e3b757d1f1cfce14cad9d12f86f22dd93

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