Olá! Muito obrigado por esta biblioteca! Foi um prazer testá-lo com minha API atual!
Tenho dois modelos, um School
e um SchoolCourse
. SchoolCourse
tem um relacionamento reverso de muitos para um para School
.
Eu quero ser capaz de filtrar o objeto School
com base no name
do SchoolCourse
Além disso, como uma meta estendida, eu adoraria poder filtrar por SchoolLesson
eventualmente também.
class SchoolModel(Model):
name = CharField(max_length=24, unique=True)
REQUIRED_FIELDS = ["name"]
class Meta:
ordering = ("id",)
def get_courses(self):
school_courses = SchoolCourseModel.objects.filter(school=self)
return school_courses
class SchoolCourseModel(Model):
description = CharField(default="", max_length=200)
name = CharField(max_length=50)
school = ForeignKey(SchoolModel,
related_name="school_course",
on_delete=CASCADE)
REQUIRED_FIELDS = ["school", "name"]
class Meta:
ordering = ("id",)
unique_together = ("school", "name",)
def get_lessons(self):
school_lessons = SchoolLessonModel.objects.filter(course=self)
return school_lessons
Qual - se você brincar com esses modelos na visualização de depuração, verá isso
all_school_models[50].school_course
(Pdb++) <django.db.models.fields.related_descriptors.create_reverse_many_to_one_manager.<locals>.RelatedManager object at 0x10a8177d0>
all_school_models[50].school_course.all()
(Pdb++) <QuerySet [<SchoolCourseModel: SchoolCourseModel object (151)>, <SchoolCourseModel: SchoolCourseModel object (152)>, <SchoolCourseModel: SchoolCourseModel object (153)>]>
all_school_models[50].school_course.all()[0]
(Pdb++) <SchoolCourseModel: SchoolCourseModel object (151)>
all_school_models[50].school_course.all()[0].name
(Pdb++) 'Nihongo Course One'
O filtro que fiz parece bastante simples.
class SchoolFilter(FilterSet):
school_name = CharFilter(field_name="name",
lookup_expr="icontains")
# ---
course_name = CharFilter(field_name="school_course__name",
lookup_expr="icontains")
course_description = CharFilter(field_name="school_course__description",
lookup_expr="icontains")
class Meta:
model = SchoolModel
fields = [
"school_name",
# ---
"course_name",
"course_description"
]
Entretanto, isso não funciona. Se eu fizer este pedido:
{{API_URL}}/api/v1/schools/?course_name=Nihongo
eu recebo isso de volta como uma resposta
{
"schools": []
}
O que estou fazendo de errado aqui?
Estou interpretando mal os django-filters? Estou interpretando mal como conectar os modelos de dados?
Qualquer orientação é apreciada!
Olá @loganknecht. Apenas como uma verificação de sanidade, você pode verificar se seu URL está correto? Em seu URL de exemplo, a string de consulta começa com /
em vez de ?
.
Ah @rpkilby - desculpas, foi um descuido da minha parte ao copiar e colar de Postman
. A url é na verdade {{API_URL}}/api/v1/schools/?offset=49&course_name=Nihongo
mas eu estava removendo o offset
para ficar menos confuso e consegui fazer o contrário 😂
Seu exemplo não levanta nenhuma questão óbvia para mim. Meu melhor palpite é que há algum problema com a visualização da API. Você adicionou o DjangoFilterBackend
às suas configurações/visualização filter_backends
? E você definiu filterset_class = SchoolFilter
(observe que isso costumava ser filter_class
)?
Oi @rpkilby
Aqui está o código de visualização que tenho
class SchoolViewSet(ViewSet):
http_method_names = ["get", "post"]
def list(self, request):
all_school_models = SchoolModel.objects.all()
filtered_school_models = SchoolFilter(request.GET, queryset=all_school_models)
# import pdb
# pdb.set_trace()
paginator = HeaderLinkPagination()
current_page_results = paginator.paginate_queryset(filtered_school_models.qs,
request)
all_schools_serializer = SchoolSerializer(current_page_results,
many=True)
response_data = {
"schools": all_schools_serializer.data
}
response_to_return = paginator.get_paginated_response(response_data)
return response_to_return
O pdb.set_trace()
é onde eu postei o interrogatório acima.
Eu não configurei o DjangoFilterBackend
, pois assumi que era uma configuração global e estou testando isso apenas em um único endpoint.
Além disso, também não configurei isso para a classe pelo mesmo motivo.
É importante saber que EU POSSO usar esse filtro no nome do SchoolModel
mas quando eu filtro na chave estrangeira reversa school_course
ele não funciona.
Gotcha - então você está criando o conjunto de filtros diretamente na visualização. Nesse caso, sim, você não precisaria definir a classe de backend/filterset do filtro.
Você pode verificar se os dados parecem corretos, se houve algum erro ou se a consulta SQL está formada corretamente. Experimentar:
filtered_school_models = SchoolFilter(request.GET, queryset=all_school_models)
print(filtered_school_models.data)
print(filtered_school_models.errors)
print(filtered_school_models.qs)
print(str(filtered_school_models.qs.query))
@rpkilby Aqui está o que eu vejo
<QueryDict: {'offset': ['49'], 'course_name': ['Nihongo']}>
<QuerySet [<SchoolModel: SchoolModel object (51)>]>
SELECT "piano_gym_api_schoolmodel"."id", "piano_gym_api_schoolmodel"."name", "piano_gym_api_schoolmodel"."school_board_id" FROM "piano_gym_api_schoolmodel" INNER JOIN "piano_gym_api_schoolcoursemodel" ON ("piano_gym_api_schoolmodel"."id" = "piano_gym_api_schoolcoursemodel"."school_id") WHERE UPPER("piano_gym_api_schoolcoursemodel"."name"::text) LIKE UPPER(%Nihongo%) ORDER BY "piano_gym_api_schoolmodel"."id" ASC
@rpkilby Parece que pode ser um problema com a implementação do meu paginador que se parece com isso
class HeaderLinkPagination(LimitOffsetPagination):
default_limit = settings.DEFAULT_LIMIT
max_limit = settings.DEFAULT_MAX_LIMIT
min_limit = settings.DEFAULT_MIN_LIMIT
min_offset = settings.DEFAULT_MIN_OFFSET
max_offset = settings.DEFAULT_MAX_OFFSET
def get_paginated_response(self, data):
next_url = self.get_next_link()
previous_url = self.get_previous_link()
links = []
header_data = (
(previous_url, "prev"),
(next_url, "next"),
)
for url, label in header_data:
if url is not None:
links.append("<{}>; rel=\"{}\"".format(url, label))
headers = {"Link": ", ".join(links)} if links else {}
return Response(data, headers=headers)
def paginate_queryset(self, queryset, request, view=None):
limit = request.query_params.get("limit")
offset = request.query_params.get("offset")
if limit is None:
limit = settings.DEFAULT_LIMIT
if offset is None:
offset = settings.DEFAULT_OFFSET
limit = int(limit)
if limit > self.max_limit:
error_message = ("Limit should be less than or equal to {0}"
).format(self.max_limit)
errors = {"limit": [error_message]}
raise ValidationError(errors)
elif limit < self.min_limit:
error_message = ("Limit should be greater than or equal to {0}"
).format(self.min_limit)
errors = {"limit": [error_message]}
raise ValidationError(errors)
offset = int(offset)
if offset > self.max_offset:
error_message = ("Offset should be less than or equal to {0}"
).format(self.max_offset)
errors = {"offset": [error_message]}
raise ValidationError(errors)
elif offset < self.min_offset:
error_message = ("Offset should be greater than or equal to {0}"
).format(self.min_offset)
errors = {"offset": [error_message]}
raise ValidationError(errors)
import pdb
pdb.set_trace()
return super(self.__class__, self).paginate_queryset(queryset, request, view)
Se você ver uma solução, por favor me avise. Fique atento enquanto eu tento sacudir isso.
Meu palpite é que isso está relacionado ao deslocamento fornecido. Há apenas 1 objeto no conjunto de consultas filtrado, mas a solicitação está dizendo ao paginador para ignorar os primeiros 49 itens. se você fosse verificar
print(filtered_school_models[49:])
Eu suponho que você receberia <QuerySet []>
.
Fechando, pois parece que este é um problema de paginação.
Oi @rpkilby
Eu só quero dizer muito obrigado por me falar sobre isso. Isso nem era um problema de django-filter
. Eu estava apenas sendo um dingo. Você me abaixando de borracha é super super apreciado.
Você é incrível, e mais uma vez, obrigado por esta biblioteca incrível!
Sem problemas. Feliz por ajudar!
Comentários muito úteis
Meu palpite é que isso está relacionado ao deslocamento fornecido. Há apenas 1 objeto no conjunto de consultas filtrado, mas a solicitação está dizendo ao paginador para ignorar os primeiros 49 itens. se você fosse verificar
Eu suponho que você receberia
<QuerySet []>
.Fechando, pois parece que este é um problema de paginação.