'''
Base AlchemyViewSet which provides
the necessary plumbing to interface with
AlchemyModelSerializer and AlchemyModelManager
'''
from rest_framework import viewsets
from rest_framework.response import Response
from rest_framework import status
from djangorest_alchemy.serializers import AlchemyModelSerializer
from djangorest_alchemy.serializers import AlchemyListSerializer
from djangorest_alchemy.mixins import MultipleObjectMixin
from djangorest_alchemy.mixins import ManagerMixin
from django.core.paginator import InvalidPage
[docs]class AlchemyModelViewSet(MultipleObjectMixin, ManagerMixin, viewsets.ViewSet):
"""
Generic SQLAlchemy viewset which calls
methods over the specified manager_class and
uses specified serializer_class
"""
[docs] def serializer_factory(self, multiple, queryset, model_class, context):
'''
Factory method to instantiate appropriate serializer class
Override to return back your instance
'''
if multiple:
return AlchemyListSerializer(queryset,
model_class=model_class,
context=context)
else:
return AlchemyModelSerializer(queryset,
model_class=model_class,
context=context)
[docs] def get_other_pks(self, request):
'''
Return default empty {}
Override to return back your primary keys
from other source (possibly from headers)
:param request: REST request object
:return: dict
'''
return {}
[docs] def get_pks(self, request, **kwargs):
'''
Return list of pks
from the keyword args
e.g. /models/pk1/childmodel/pk2 return back [pk1, pk2]
:param request: REST request object
:kwargs kwargs: URI keyword args
:return: List e.g. [pk1, pk2]
'''
return kwargs.values()
[docs] def list(self, request, **kwargs):
'''
Returns back serialized list of objects URIs
in the `results` key
:return: json
{
"results":
[
{
"href": "http://server/api/models/pk/"
}
]
}
Note::
* URI contains the same pk field
* Complete URI with server/port is returned back
'''
mgr = self.manager_factory(context={'request': request})
queryset = mgr.list(other_pks=self.get_other_pks(request),
filters=request.QUERY_PARAMS)
if self.paginate_by:
try:
queryset = self.get_page(queryset)
except InvalidPage:
return Response({}, status.HTTP_400_BAD_REQUEST)
serializer = self.serializer_factory(True, queryset,
mgr.model_class(),
{'request': request})
return Response({"results": serializer.data})
[docs] def retrieve(self, request, **kwargs):
'''
Retrieve returns back serialized object.
:return: json
{
"href": "http://server/api/models/pk/",
"field": "value"
"childmodel": "http://serv/api/parentmodels/pk/childmodels/pk"
}
Note::
As of now, only SQLAlchemy mapper properties are returned
No other fields or properties are serialized. You will need
to override retrieve and provide your own implementation to
query those additional properties for now.
'''
mgr = self.manager_factory(context={'request': request})
queryset = mgr.retrieve(self.get_pks(request, **kwargs),
other_pks=self.get_other_pks(request))
serializer = self.serializer_factory(False, queryset,
mgr.model_class(),
{'request': request})
return Response(serializer.data)
[docs] def create(self, request):
pass
[docs] def update(self, request, pk=None):
pass
[docs] def destroy(self, request, pk=None):
pass