drf-viewset-scenarios 1.0.0

A Django REST Framework package that provides a flexible way to manage different serializers and paginators in your ViewSets based on defined scenarios.

ViewSet Scenarios

An elegant DRF library for managing and transforming serializers and paginators in your ViewSets based on defined scenarios

🚀 Description

A Django REST Framework package that provides a flexible way to manage different serializers and paginators in your ViewSets based on defined scenarios.

✨ Key Features

ViewSet Scenarios allows you to:

• Define multiple scenarios for a single ViewSet
• Dynamically assign serializers based on actions or conditions
• Configure pagination settings per scenario
• Handle custom endpoints with specific serialization needs

🛠️ Installation

pip install drf-viewset-scenarios

Quick Start

Here's a simple example of how to use ViewSet Scenarios:

from viewset_scenarios import ViewSetScenarios, DRFScenario, DRFActionType
from rest_framework import viewsets

class ProductViewSet(viewsets.ModelViewSet):
    queryset = Product.objects.all()
    scenarios = ViewSetScenarios([
        DRFScenario(
            action=DRFActionType.LIST, 
            serializer=ProductListSerializer,
            pagination=StandardPagination
        ),
        DRFScenario(
            action=DRFActionType.RETRIEVE,
            serializer=ProductDetailSerializer
        ),
        DRFScenario(
            action=DRFActionType.DEFAULT,
            serializer=ProductBaseSerializer
        ),
    ])

    def get_serializer_class(self):
        return self.scenarios.get_serializer_class(self)

    @property
    def paginator(self):
        return self.scenarios.get_paginator(self)

Features

Action Types

Built-in support for common ViewSet actions:

• LIST: List view
• RETRIEVE: Detail view
• CREATE: Creation view
• UPDATE: Update view
• DATATABLE: Special handling for datatable requests
• DEFAULT: Fallback scenario

Scenario Configuration

Each scenario can define:

• action: The ViewSet action or custom endpoint
• serializer: The serializer class to use
• pagination: Optional pagination class
• condition: Optional condition for more complex logic

Custom Endpoints

Support for custom actions with specific serialization needs:

class ProductViewSet(ViewSetScenarios, viewsets.ModelViewSet):
    scenarios = [
        DRFScenario(
            action="featured_products",
            serializer=FeaturedProductSerializer,
            pagination=None
        ),
    ]

    @action(detail=False, methods=["get"])
    def featured_products(self, request):
        products = self.get_queryset().filter(featured=True)
        serializer = self.get_serializer(products, many=True)
        return Response(serializer.data)

Advanced Usage

Conditional Scenarios

You can use conditions to determine which serializer to use:

class OrderViewSet(viewsets.ModelViewSet):
    scenarios = ViewSetScenarios([
        DRFScenario(
            action=DRFActionType.RETRIEVE,
            serializer=OrderDetailSerializer,
            condition=lambda request: request.user.is_staff
        ),
        DRFScenario(
            action=DRFActionType.RETRIEVE,
            serializer=OrderBasicSerializer
        ),
    ])

Custom Pagination

Configure different pagination per scenario:

class ProductViewSet(viewsets.ModelViewSet):
    scenarios = ViewSetScenarios([
        DRFScenario(
            action=DRFActionType.LIST,
            serializer=ProductListSerializer,
            pagination=LargeResultsPagination
        ),
        DRFScenario(
            action="featured",
            serializer=ProductListSerializer,
            pagination=None  # Disable pagination for this endpoint
        ),
    ])

📁 Project Structure

└── viewset_scenarios/
    ├── LICENSE
    ├── pyproject.toml
    ├── README.md
    └── src/
        └── viewset_scenarios/
            ├── __init__.py
            ├── action_type.py
            └── scenarios.py

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

📫 Contact

• GitHub: @jalvarezgom
• PyPI: drf-viewset-scenarios

---

Developed with ❤️ by Jancel