django_sorcery.viewsets.base module

Django REST Framework like model viewsets.

class django_sorcery.viewsets.base.GenericViewSet(**kwargs)[source]

Bases: django.views.generic.base.TemplateResponseMixin, django.views.generic.base.View

Base class for all sqlalchemy model generic viewsets.

classmethod as_view(actions=None, **initkwargs)[source]

Main entry point for a request-response process.

classmethod get_extra_actions()[source]

Get the methods that are marked as an extra ViewSet @action.

get_template_names()[source]

Return a list of template names to be used for the request. Must return a list. May not be called if render_to_response() is overridden.

class django_sorcery.viewsets.base.ModelViewSet(**kwargs)[source]

Bases: django_sorcery.viewsets.mixins.CreateModelMixin, django_sorcery.viewsets.mixins.UpdateModelMixin, django_sorcery.viewsets.mixins.DeleteModelMixin, django_sorcery.viewsets.base.ReadOnlyModelViewSet

A viewset that provides default new(), create(), retrieve(), edit(), update()`, confirm_destroy()), destroy() and list() actions.

When used with router, it will map the following operations to actions on the viewset

Method Path Action Route Name
GET / list <resource name>-list
POST / create <resource name>-list
GET /new/ new <resource name>-new
GET /<pk>/ retrieve <resource name>-detail
POST /<pk>/ update <resource name>-detail
PUT /<pk>/ update <resource name>-detail
PATCH /<pk>/ update <resource name>-detail
DELETE /<pk>/ destroy <resource name>-detail
GET /<pk>/edit/ edit <resource name>-edit
GET /<pk>/delete/ confirm_destoy <resource name>-delete
POST /<pk>/delete/ destroy <resource name>-delete
class django_sorcery.viewsets.base.ReadOnlyModelViewSet(**kwargs)[source]

Bases: django_sorcery.viewsets.mixins.ListModelMixin, django_sorcery.viewsets.mixins.RetrieveModelMixin, django_sorcery.viewsets.base.GenericViewSet

A viewset that provides default list() and retrieve() actions.

When used with router, it will map the following operations to actions on the viewset

Method Path Action Route Name
GET / list <resource name>-list
GET /<pk>/ retrieve <resource name>-detail