Django-filter: UserWarning: X não é compatível com a geração de esquema: devido a AnonymousUser

Criado em 13 ago. 2018 · 4Comentários · Fonte: carltongibson/django-filter

Estou olhando as advertências do usuário que tentei melhorar em https://github.com/carltongibson/django-filter/pull/903 novamente:

…/django-filter/django_filters/rest_framework/backends.py:131: UserWarning: <class 'project.app.views.TermsOfServiceViewSet'> is not compatible with schema generation
  "{} is not compatible with schema generation".format(view.__class__)

Isso acontece principalmente porque um AnonymousUser é usado, o que não é compatível com a maioria dos métodos get_queryset() de nossa visão, que presumem que o usuário está autenticado (e tem certos métodos em particular).

Estou usando drf_yasg aqui.

Gostaria de saber se há uma maneira de melhorar isso, por exemplo, usando um usuário autenticado para isso (seria um problema drf-yasg, então, provavelmente).

Traceback:

../../../Vcs/django-rest-framework/rest_framework/views.py:480: in dispatch
    response = handler(request, *args, **kwargs)
.venv/lib/python3.6/site-packages/drf_yasg/views.py:85: in get
    schema = generator.get_schema(request, self.public)
.venv/lib/python3.6/site-packages/drf_yasg/generators.py:215: in get_schema
    paths, prefix = self.get_paths(endpoints, components, request, public)
.venv/lib/python3.6/site-packages/drf_yasg/generators.py:337: in get_paths
    operation = self.get_operation(view, path, prefix, method, components, request)
.venv/lib/python3.6/site-packages/drf_yasg/generators.py:379: in get_operation
    operation = view_inspector.get_operation(operation_keys)
.venv/lib/python3.6/site-packages/drf_yasg/inspectors/view.py:30: in get_operation
    query = self.get_query_parameters()
.venv/lib/python3.6/site-packages/drf_yasg/inspectors/view.py:293: in get_query_parameters
    natural_parameters = self.get_filter_parameters() + self.get_pagination_parameters()
.venv/lib/python3.6/site-packages/drf_yasg/inspectors/base.py:336: in get_filter_parameters
    fields += self.probe_inspectors(self.filter_inspectors, 'get_filter_parameters', filter_backend()) or []
.venv/lib/python3.6/site-packages/drf_yasg/inspectors/base.py:71: in probe_inspectors
    result = method(obj, **kwargs)
.venv/lib/python3.6/site-packages/drf_yasg/inspectors/query.py:27: in get_filter_parameters
    fields = filter_backend.get_schema_fields(self.view)
../../../Vcs/django-filter/django_filters/rest_framework/backends.py:131: in get_schema_fields
    "{} is not compatible with schema generation".format(view.__class__)
E   UserWarning: <class 'project.app.views.AffiliationViewSet'> is not compatible with schema generation

Fonte

blueyed

👍13

Comentários muito úteis

Uma possível solução alternativa pode ser definir algo assim no método get_queryset do seu conjunto de visualizações. Tratar o caso em que self.request é None parece funcionar.

def get_queryset(self):
    if self.request is None:
        return SomeModel.objects.none()

    return SomeModel.objects.filter(...)

gunthercox em 5 jun. 2020

👍5

Todos 4 comentários

Não podemos fazer muito aqui . Qualquer método que precise chamar get_queryset() vai dar de cara com isso. Basicamente, você precisa permitir isso para lidar com o caso anônimo.

De qualquer forma, o problema é melhor abordado como parte da lógica de introspecção do DRF. (Mas também não há uma resposta simples aí.)

carltongibson em 17 dez. 2018

👎1 👍1

Uma possível solução alternativa pode ser definir algo assim no método get_queryset do seu conjunto de visualizações. Tratar o caso em que self.request é None parece funcionar.

def get_queryset(self):
    if self.request is None:
        return SomeModel.objects.none()

    return SomeModel.objects.filter(...)

gunthercox em 5 jun. 2020

👍5

Obrigado @gunthercox, seu comentário realmente me ajudou. Isso me colocou no caminho para a solução, mas no final das contas o que funcionou para mim foi:

queryset = MyModel.objects.all()

def get_queryset(self):
    if not self.request:
        return MyModel.objects.none()

    if self.request.query_params:
        queryset = self.filter_queryset(self.queryset)
    else:
        queryset = self.queryset

    # ... the rest of the method code ...

    return queryset

Espero que isso ajude alguém em uma situação semelhante.

aaronstephenson em 23 jun. 2020

👍1

Acho que a abordagem sugerida é esta:

def get_queryset(self):
    if getattr(self, "swagger_fake_view", False):
        return MyModel.objects.none()

    # ... the rest of the method code ...

Eu vi isso neste tópico: https://github.com/axnsan12/drf-yasg/issues/333