drfexts

PyPI - Python Version

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:

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)

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

Metadata

Release files for drfexts 3.13.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for drfexts 3.13.5
File	Size	Uploaded	Provenance
drfexts-3.13.5.tar.gz	38.7 kB	Apr 22, 2025	Without provenance	Details

Built distribution (wheel)

Table of built distributions (wheels) for drfexts 3.13.5
File	Interpreter	ABI	Platform	Reset
drfexts-3.13.5-py3-none-any.whl 49.8 kB Apr 22, 2025 Without provenance	Python 3	none	any	Details

Total release size: 88.5 kB

Release files / drfexts-3.13.5.tar.gz

Download URL	drfexts-3.13.5.tar.gz
Size	38.7 kB
Tags	Source
SHA-256 checksum How to use checksums	`67e1fb95e998c35e42ac260cdb9dd3953804beda1001b5822497c8dd25daa14c`
BLAKE2b-256 checksum How to use checksums	`fa01192ccd8966eef604ffd0ee36c4cae8ffe35501bc20822b09a952665edcd0`
Upload date	Apr 22, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.8.5 CPython/3.12.8 Darwin/24.3.0`

Release files / drfexts-3.13.5-py3-none-any.whl

Download URL	drfexts-3.13.5-py3-none-any.whl
Size	49.8 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`7fcbe103f42a9d322b1a870b3abe066a6d7db2ef46763995c4641e92bd5e6a3e`
BLAKE2b-256 checksum How to use checksums	`7cf4265c5de83463791a019471439b9b5786e03f1fa340c8659fdbf983776411`
Upload date	Apr 22, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.8.5 CPython/3.12.8 Darwin/24.3.0`

Security for drfexts 3.13.5

Report project as malware

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.