Сериализация контекста на Django CBV? - PullRequest
Новая
       94

Сериализация контекста на Django CBV?

1 голос
/ 29 апреля 2020

У меня проблемы с сериализацией стороннего пакета (django -организации), так как я хочу получить контекст в JSON.

Сам класс выглядит так: 

class OrganizationUserMixin(OrganizationMixin, JSONResponseMixin):
    """Mixin used like a SingleObjectMixin to fetch an organization user"""

    user_model = OrganizationUser
    org_user_context_name = 'organization_user'

    def get_user_model(self):
        return self.user_model

    def get_context_data(self, **kwargs):
        kwargs = super(OrganizationUserMixin, self).get_context_data(**kwargs)
        kwargs.update({self.org_user_context_name: self.object,
            self.org_context_name: self.object.organization})
        return kwargs

    def get_object(self):
        """ Returns the OrganizationUser object based on the primary keys for both
        the organization and the organization user.
        """
        if hasattr(self, 'organization_user'):
            return self.organization_user
        organization_pk = self.kwargs.get('organization_pk', None)
        user_pk = self.kwargs.get('user_pk', None)
        self.organization_user = get_object_or_404(
                self.get_user_model().objects.select_related(),
                user__pk=user_pk, organization__pk=organization_pk)
        return self.organization_user

И я пытаюсь передать этот пользовательский JSONResponseMixin моему OrganizationUserMixin классу: 

class JSONResponseMixin:
    """
    A mixin that can be used to render a JSON response.
    """
    def render_to_json_response(self, context, **response_kwargs):
        """
        Returns a JSON response, transforming 'context' to make the payload.
        """
        return JsonResponse(
            self.get_data(context),
            **response_kwargs
        )

    def get_data(self, context):
        print(context)
        return context

И затем переопределяя render_to_response в OrganizationUserMixin следующим образом: 

def render_to_response(self, context, **response_kwargs):
    return self.render_to_json_response(context, **response_kwargs)

Если я печатаю context

Это выглядит примерно так 

# {
# 'object': <OrganizationUser: Erik (MyOrgName)>, 
# 'organizationuser': <OrganizationUser: Erik (MyOrgName)>, 
# 'organization': <Organization: MyOrgName>, 
# 'view': <organizations.views.OrganizationUserDetail object at 0x1091a3ac0>, 
# 'organization_user': <OrganizationUser: Erik (MyOrgName)>
# }

Сообщение об ошибке Я получаю TypeError: Object of type OrganizationUser is not JSON serializable

Как я могу сериализовать context в моем JSONResponseMixin?

1 Ответ

1 голос
/ 29 апреля 2020

Здесь у вас есть две опции: либо Django rest framework (DRF), либо реализуйте функции, которые выполняют сериализацию для моделей.

Вариант 1

DRF - это более устойчивое решение, поскольку вы расширяете API-интерфейс вашего приложения, поскольку оно абстрагирует большую часть работы по десериализации и предоставляет вам с множеством других полезных функций, таких как Маршрутизаторы, ViewSets и др.

Пример кода 

# serializers.py
from rest_framework import serializers

class OrganizationUserSerializer(serializers.ModelSerializer):
    class Meta:
        model = OrganizationUser
        fields = '__all__'


# views.py
from rest_framework import generics

class OrganizationUser(generics.RetrieveModelMixin):
    queryset = OrganizationUser.objects.all()
    serializer_class = OrganizationUserSerializer

Опция 2

При этом, если вам JsonResponseMixin достаточно для большинства ваших потребностей, и ваше приложение в основном не зависит от API, вы можете просто добавить функции сериализации для ваших моделей и вызвать их в вашем JsonResponseMixin.get_data()

Пример кода: 

# Models.py
class OrganizationUser(models.Model):
    ...

    def to_json(self):
        # assuming you have a field name and organization
        return {"name": self.name, "organization": self.organization.to_json()}

# mixins.py
class JSONResponseMixin:
    """
    A mixin that can be used to render a JSON response.
    """
    def render_to_json_response(self, context, **response_kwargs):
        """
        Returns a JSON response, transforming 'context' to make the payload.
        """
        return JsonResponse(
            self.get_data(context),
            **response_kwargs
        )

    def get_data(self, context):
        data = {}
        for key, val in context:
            if hasattr(val, "to_json"):
                data[key] = val.to_json()
            else:
                data[key] = val
        return data
...