AssertionError: `HyperlinkedIdentityField` требует запроса в контексте сериализатора
Я хочу создать связь many-to-many
, где один человек может быть во многих клубах, а в одном клубе может быть много людей. Я добавил models.py
и serializers.py
для следующей логики, но когда я попытаюсь выполнить сериализацию в командной строке, я получаю следующую ошибку: что я делаю неправильно здесь? У меня даже нет HyperlinkedIdentityField
Traceback (most recent call last):
File "<console>", line 1, in <module>
File "C:\Users\user\corr\lib\site-packages\rest_framework\serializers.py", line 503, in data
ret = super(Serializer, self).data
File "C:\Users\user\corr\lib\site-packages\rest_framework\serializers.py", line 239, in data
self._data = self.to_representation(self.instance)
File "C:\Users\user\corr\lib\site-packages\rest_framework\serializers.py", line 472, in to_representation
ret[field.field_name] = field.to_representation(attribute)
File "C:\Users\user\corr\lib\site-packages\rest_framework\relations.py", line 320, in to_representation"the serializer." % self.__class__.__name__
AssertionError: `HyperlinkedIdentityField` requires the request in the serializer context. Add `context={'request': request}` when instantiating the serializer.
models.py
class Club(models.Model):
club_name = models.CharField(default='',blank=False,max_length=100)
class Person(models.Model):
person_name = models.CharField(default='',blank=False,max_length=200)
clubs = models.ManyToManyField(Club)
serializers.py
class ClubSerializer(serializers.ModelSerializer):
class Meta:
model = Club
fields = ('url','id','club_name','person')
class PersonSerializer(serializers.ModelSerializer):
clubs = ClubSerializer()
class Meta:
model = Person
fields = ('url','id','person_name','clubs')
views.py
class ClubDetail(generics.ListCreateAPIView):
serializer_class = ClubSerializer
def get_queryset(self):
club = Clubs.objects.get(pk=self.kwargs.get('pk',None))
persons = Person.objects.filter(club=club)
return persons
class ClubList(generics.ListCreateAPIView):
queryset = Club.objects.all()
serializer_class = ClubSerializer
class PersonDetail(generics.RetrieveUpdateDestroyAPIView):
serializer_class = PersonSerializer
def get_object(self):
person_id = self.kwargs.get('pk',None)
return Person.objects.get(pk=person_id)
Проверка созданного сериализатора дает мне это -
PersonSerializer(<Person: fd>):
url = HyperlinkedIdentityField(view_name='person-detail')
id = IntegerField(label='ID', read_only=True)
person_name = CharField(max_length=200, required=False)
clubs = ClubSerializer():
url = HyperlinkedIdentityField(view_name='club-detail')
id = IntegerField(label='ID', read_only=True)
club_name = CharField(max_length=100, required=False)
но serializer.data
дает мне ошибку
****************** редактировать *********************
Я понял, что ошибка может быть вызвана шаблонами url
, поэтому я добавил следующие шаблоны url, но до сих пор получаю ошибку -
urlpatterns = format_suffix_patterns([
url(r'^$', views.api_root),
url(r'^clubs/$',
views.ClubList.as_view(),
name='club-list'),
url(r'^clubs/(?P<pk>[0-9]+)/persons/$',
views.ClubDetail.as_view(),
name='club-detail'),
url(r'^person/(?P<pk>[0-9]+)/$',
views.PersonDetail.as_view(),
name='person-detail'),
])
Ответы
Ответ 1
Вы получаете эту ошибку, поскольку HyperlinkedIdentityField
ожидает получить request
в context
сериализатора, чтобы он мог создавать абсолютные URL-адреса. Когда вы инициализируете свой сериализатор в командной строке, у вас нет доступа к запросу и поэтому получите сообщение об ошибке.
Если вам нужно проверить свой сериализатор в командной строке, вам нужно сделать что-то вроде этого:
from rest_framework.request import Request
from rest_framework.test import APIRequestFactory
from .models import Person
from .serializers import PersonSerializer
factory = APIRequestFactory()
request = factory.get('/')
serializer_context = {
'request': Request(request),
}
p = Person.objects.first()
s = PersonSerializer(instance=p, context=serializer_context)
print s.data
Ваше поле url будет выглядеть примерно как http://testserver/person/1/
.
Ответ 2
Я столкнулся с той же проблемой. Мой подход заключается в удалении 'url' из Meta.fields в serializer.py.
Ответ 3
У меня есть два решения...
urls.py
1)
Если вы используете router.register, вы можете добавить base_name:
router.register(r'users', views.UserViewSet, base_name='users')
urlpatterns = [
url(r'', include(router.urls)),
]
2)
Если у вас есть что-то вроде этого:
urlpatterns = [
url(r'^user/$', views.UserRequestViewSet.as_view()),
]
Вы должны передать контекст сериализатору:
views.py
class UserRequestViewSet(APIView):
def get(self, request, pk=None, format=None):
user = ...
serializer_context = {
'request': request,
}
serializer = api_serializers.UserSerializer(user, context=serializer_context)
return Response(serializer.data)
Таким образом, вы можете продолжать использовать URL-адрес вашего сериализатора:
serializers.py
...
url = serializers.HyperlinkedIdentityField(view_name="user")
...
Ответ 4
Следуя ответу Slipstream, я редактировал мой views.py
, представляя контекст, и теперь он работает.
class UserViewSet(viewsets.ModelViewSet):
"""
API endpoint that allows users to be viewed or edited.
"""
queryset = User.objects.all().select_related('profile').order_by('-date_joined')
serializer_class = UserSerializer
@list_route(methods=['get'], url_path='username/(?P<username>\w+)')
def getByUsername(self, request, username):
serializer_context = {
'request': request,
}
user = get_object_or_404(User, username=username)
return Response(UserSerializer(user, context=serializer_context).data, status=status.HTTP_200_OK)