DRF изменить поле lookup_field набора по умолчанию для пользовательских действий

Question

Как изменить параметр поиска по умолчанию для моего настраиваемого действия в DRF Viewset?Вот мой Viewset (упрощенно)

class InvitationViewSet(MultiSerializerViewSet):   
    queryset = Invitation.objects.all()  

    @action(
        detail=False,
        #url_path='accept-invitation/<str:key>/',
        #lookup_field='key'
    )
    def accept_invitation(self, request, key=None):
        invitation = self.get_object()
        with legal_invitation(invitation):
            serializer = self.get_serializer(invitation)
            invitation.accepted = True
            invitation.save()
        return Response(serializer.data)

Я хочу, когда пользователь вводит URL, например /invitations/accept-invitation/abccba, где abccba - случайная строка токена.key - уникальное поле в модели приглашений.Я знаю, что могу установить per-Viewset lookup_field='key', но я хочу, чтобы все другие действия все еще использовали значение по умолчанию lookup_field='pk'.Как мне добиться того, чего я хочу?

Answer 1

Вы можете переопределить метод get_object(), чтобы добиться этого. Это код GenericAPIView:

def get_object(self):
    """
    Returns the object the view is displaying.

    You may want to override this if you need to provide non-standard
    queryset lookups.  Eg if objects are referenced using multiple
    keyword arguments in the url conf.
    """
    queryset = self.filter_queryset(self.get_queryset())

    # Perform the lookup filtering.
    lookup_url_kwarg = self.lookup_url_kwarg or self.lookup_field

    assert lookup_url_kwarg in self.kwargs, (
        'Expected view %s to be called with a URL keyword argument '
        'named "%s". Fix your URL conf, or set the `.lookup_field` '
        'attribute on the view correctly.' %
        (self.__class__.__name__, lookup_url_kwarg)
    )

    filter_kwargs = {self.lookup_field: self.kwargs[lookup_url_kwarg]}
    obj = get_object_or_404(queryset, **filter_kwargs)

    # May raise a permission denied
    self.check_object_permissions(self.request, obj)

    return obj

Затем добавьте подтверждение, чтобы проверить, какое действие в данный момент инициируется, и соответственно измените значение lookup_field / lookup_url_kwarg. Ваш self.action внутри функции get_object должен быть равен accept_invitation (название функции, которую вы украшаете).

Проблема здесь в том, что вы используете декоратор действий с detail=False, поэтому поле поиска не имеет большого смысла. Мой подход работает для обычного подробного маршрута, как упомянуто в одном из комментариев: <your_api_url>/<invitation-viewset-path>/<key>/accept-invitation/.