Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add rest_framework.filters.OrderingFilters to TemplateViewSet filter_… #352

Merged
merged 1 commit into from
Sep 27, 2022
Merged

Add rest_framework.filters.OrderingFilters to TemplateViewSet filter_… #352

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
128 changes: 47 additions & 81 deletions apis_core/api_routers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,10 @@
from rest_framework import pagination, serializers, viewsets
from rest_framework import renderers
from rest_framework.response import Response
#from drf_spectacular.contrib.django_filters import (

# from drf_spectacular.contrib.django_filters import (
# DjangoFilterBackend as DjangoFilterbackendSpectacular,
#)
# )
from drf_spectacular.utils import (
extend_schema,
extend_schema_field,
Expand All @@ -23,6 +24,7 @@
from drf_spectacular.types import OpenApiTypes
from django import forms
from django_filters import rest_framework as filters
from rest_framework.filters import OrderingFilter
from .apis_metainfo.models import TempEntityClass
from .api_renderers import NetJsonRenderer
from .apis_relations.models import AbstractRelation
Expand Down Expand Up @@ -94,11 +96,7 @@ def add_uri(self, obj):
@extend_schema_field(OpenApiTypes.OBJECT)
def add_type(self, obj):
lst_type = ["kind", "type", "collection_type", "relation_type"]
lst_kind = [
x
for x in obj._meta.fields
if x.name in lst_type and "apis_vocabularies" in str(x.related_model)
]
lst_kind = [x for x in obj._meta.fields if x.name in lst_type and "apis_vocabularies" in str(x.related_model)]
if len(lst_kind):
pk_obj = getattr(obj, f"{lst_kind[0].name}_id")
if pk_obj is not None:
Expand Down Expand Up @@ -140,9 +138,7 @@ class Meta(ApisBaseSerializer.Meta):


class LabelSerializer(ApisBaseSerializer):
parent_id = serializers.PrimaryKeyRelatedField(
many=False, source="parent_class_id", read_only=True
)
parent_id = serializers.PrimaryKeyRelatedField(many=False, source="parent_class_id", read_only=True)

@extend_schema_field(OpenApiTypes.INT)
def add_parent_id(self, obj):
Expand All @@ -165,14 +161,8 @@ class RelationObjectSerializer2(ApisBaseSerializer):
@extend_schema_field(EntitySerializer)
def add_related_entity(self, instance):
for at in dir(instance):
if (
at.startswith("related_")
and at.endswith("_id")
and getattr(instance, at) != self._pk_instance
):
return EntitySerializer(
getattr(instance, at[:-3]), context=self.context
).data
if at.startswith("related_") and at.endswith("_id") and getattr(instance, at) != self._pk_instance:
return EntitySerializer(getattr(instance, at[:-3]), context=self.context).data

class Meta(ApisBaseSerializer.Meta):
fields = ApisBaseSerializer.Meta.fields + ["relation_type", "related_entity"]
Expand All @@ -185,14 +175,13 @@ def __init__(self, *args, **kwargs):
if "apis_highlighter" in getattr(settings, "INSTALLED_APPS"):

class AnnotationSerializer(serializers.ModelSerializer):
related_object = VocabsBaseSerializer(
source="get_related_entity", read_only=True, many=False
)
related_object = VocabsBaseSerializer(source="get_related_entity", read_only=True, many=False)

class Meta:
model = Annotation
fields = ["id", "start", "end", "related_object"]


def generic_serializer_creation_factory():
lst_cont = GetContentTypes().get_model_classes()
not_allowed_filter_fields = [
Expand Down Expand Up @@ -238,7 +227,7 @@ class TemplateSerializer(serializers.HyperlinkedModelSerializer):

id = serializers.ReadOnlyField()
url = serializers.HyperlinkedIdentityField(view_name=f"apis:apis_api:{entity_str.lower()}-detail")
#sameAs = UriSerializer(source="uri_set", many=True)
# sameAs = UriSerializer(source="uri_set", many=True)
_entity = entity
_exclude_lst = exclude_lst_fin
_app_label = app_label
Expand All @@ -250,13 +239,13 @@ class Meta:

def add_labels(self, obj):
return {"id": obj.pk, "label": str(obj)}

def add_sameas(self, instance):
res = []
for uri in instance.uri_set.all():
res.append(uri.uri)
return res

if entity_str.lower() == "text":

def __init__(self, *args, **kwargs):
Expand All @@ -277,30 +266,24 @@ def __init__(self, *args, **kwargs):
)
self.fields["sameAs"] = serializers.SerializerMethodField("add_sameas")
for f in self._entity._meta.get_fields():
if getattr(settings, "APIS_API_EXCLUDE_SETS", False) and str(
f.name
).endswith("_set"):
if getattr(settings, "APIS_API_EXCLUDE_SETS", False) and str(f.name).endswith("_set"):
if f.name in self.fields.keys():
self.fields.pop(f.name)
continue
ck_many = f.__class__.__name__ == "ManyToManyField"
if f.name in self._exclude_lst:
continue
elif (
f.__class__.__name__
in [
"ManyToManyField",
"ForeignKey",
]
and "apis_vocabularies" not in str(f.related_model)
):
self.fields[f.name] = ApisBaseSerializer(
many=ck_many, read_only=True
)
elif f.__class__.__name__ in [
"ManyToManyField",
"ForeignKey",
] and "apis_vocabularies" not in str(f.related_model):
self.fields[f.name] = ApisBaseSerializer(many=ck_many, read_only=True)
elif f.__class__.__name__ in ["ManyToManyField", "ForeignKey"]:
self.fields[f.name] = LabelSerializer(many=ck_many, read_only=True)

TemplateSerializer.__name__ = TemplateSerializer.__qualname__ = f"{entity_str.title().replace(' ', '')}Serializer"
TemplateSerializer.__name__ = (
TemplateSerializer.__qualname__
) = f"{entity_str.title().replace(' ', '')}Serializer"

class TemplateSerializerRetrieve(TemplateSerializer):

Expand All @@ -312,19 +295,15 @@ class TemplateSerializerRetrieve(TemplateSerializer):
@extend_schema_field(AnnotationSerializer(many=True))
def txt_serializer_add_annotations(self, instance):
if self._highlight:
return AnnotationSerializer(
self._annotations, context=self.context, many=True
).data
return AnnotationSerializer(self._annotations, context=self.context, many=True).data
else:
return None

def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
highlight = self.context.get("highlight", True)
self._inline_annotations = False
if highlight is not None and "apis_highlighter" in getattr(
settings, "INSTALLED_APPS"
):
if highlight is not None and "apis_highlighter" in getattr(settings, "INSTALLED_APPS"):
self._highlight = highlight
if self._highlight == "":
self._highlight = True
Expand Down Expand Up @@ -353,9 +332,9 @@ def __init__(self, *args, **kwargs):
qs_an["users_added__in"] = self._users_show
if self._ann_proj_pk is not None:
qs_an["annotation_project_id"] = self._ann_proj_pk
#self._annotations = Annotation.objects.filter(
# self._annotations = Annotation.objects.filter(
# **qs_an
#) # FIXME: Currently this QS is called twice (highlight_text_new)
# ) # FIXME: Currently this QS is called twice (highlight_text_new)
except Exception as e:
self._txt_html = ""
self._annotations = []
Expand Down Expand Up @@ -384,26 +363,18 @@ def __init__(self, *args, **kwargs):
[],
)
for f in self._entity._meta.get_fields():
if getattr(settings, "APIS_API_EXCLUDE_SETS", False) and str(
f.name
).endswith("_set"):
if getattr(settings, "APIS_API_EXCLUDE_SETS", False) and str(f.name).endswith("_set"):
if f.name in self.fields.keys():
self.fields.pop(f.name)
continue
ck_many = f.__class__.__name__ == "ManyToManyField"
if f.name in self._exclude_lst:
continue
elif (
f.__class__.__name__
in [
"ManyToManyField",
"ForeignKey",
]
and "apis_vocabularies" not in str(f.related_model)
):
self.fields[f.name] = ApisBaseSerializer(
many=ck_many, read_only=True
)
elif f.__class__.__name__ in [
"ManyToManyField",
"ForeignKey",
] and "apis_vocabularies" not in str(f.related_model):
self.fields[f.name] = ApisBaseSerializer(many=ck_many, read_only=True)
elif f.__class__.__name__ in ["ManyToManyField", "ForeignKey"]:
self.fields[f.name] = LabelSerializer(many=ck_many, read_only=True)
# include = list(ContentType.objects.filter(app_label="apis_relations", model__icontains=entity_str).values_list('model', flat=True))
Expand All @@ -422,7 +393,9 @@ def __init__(self, *args, **kwargs):
pk_instance=inst_pk2,
)

TemplateSerializerRetrieve.__name__ = TemplateSerializerRetrieve.__qualname__ = f"{entity_str.title().replace(' ', '')}DetailSerializer"
TemplateSerializerRetrieve.__name__ = (
TemplateSerializerRetrieve.__qualname__
) = f"{entity_str.title().replace(' ', '')}DetailSerializer"

allowed_fields_filter = {
"IntegerField": ["in", "range", "exact"],
Expand All @@ -435,14 +408,9 @@ def __init__(self, *args, **kwargs):
filter_fields = {}

for field in entity._meta.fields + entity._meta.many_to_many:
if getattr(settings, "APIS_API_EXCLUDE_SETS", False) and "_set" in str(
field.name.lower()
):
if getattr(settings, "APIS_API_EXCLUDE_SETS", False) and "_set" in str(field.name.lower()):
continue
if (
field.name.lower() in not_allowed_filter_fields
or field.name == "tempentityclass_ptr"
):
if field.name.lower() in not_allowed_filter_fields or field.name == "tempentityclass_ptr":
continue
elif field.__class__.__name__ in ["ForeignKey", "ManyToManyField"]:
filter_fields[field.name] = ["exact"]
Expand All @@ -455,14 +423,10 @@ def __init__(self, *args, **kwargs):
"IntegerField",
"AutoField",
]:
filter_fields[
f"{field.name}__{f2.name}"
] = allowed_fields_filter[f2.__class__.__name__]
filter_fields[f"{field.name}__{f2.name}"] = allowed_fields_filter[f2.__class__.__name__]
continue
if field.__class__.__name__ in allowed_fields_filter.keys():
filter_fields[field.name] = allowed_fields_filter[
field.__class__.__name__
]
filter_fields[field.name] = allowed_fields_filter[field.__class__.__name__]
else:
filter_fields[field.name] = ["exact"]
additional_filters = getattr(settings, "APIS_API_ADDITIONAL_FILTERS", False)
Expand All @@ -485,8 +449,8 @@ class TemplateViewSet(viewsets.ModelViewSet):
_prefetch_rel = prefetch_rel
pagination_class = CustomPagination
model = entity
#filter_backends = (DjangoFilterbackendSpectacular,)
filter_backends = (filters.DjangoFilterBackend, )
# filter_backends = (DjangoFilterbackendSpectacular,)
filter_backends = (filters.DjangoFilterBackend, OrderingFilter)
filterset_fields = filter_fields
depth = 2
renderer_classes = (
Expand All @@ -511,9 +475,7 @@ def get_serializer_context(self):
cont["ann_proj_pk"] = self.request.query_params.get("ann_proj_pk", None)
cont["types"] = self.request.query_params.get("types", None)
cont["users_show"] = self.request.query_params.get("users_show", None)
cont["inline_annotations"] = self.request.query_params.get(
"inline_annotations", True
)
cont["inline_annotations"] = self.request.query_params.get("inline_annotations", True)
context.update(cont)
return context

Expand All @@ -537,6 +499,7 @@ def dispatch(self, request, *args, **kwargs):
return super(self.__class__, self).dispatch(request, *args, **kwargs)

if entity_str.lower() == "text":

@extend_schema(
parameters=[
OpenApiParameter(
Expand Down Expand Up @@ -570,13 +533,15 @@ def dispatch(self, request, *args, **kwargs):
def retrieve(self, request, pk=None):
res = super(self.__class__, self).retrieve(request, pk=pk)
return res

else:

@extend_schema(
parameters=[
OpenApiParameter(
name="include_relations",
description="Whether to include serialization of relations or not. Usefull to avoid timeouts on big objects. Defaults to true",
type=OpenApiTypes.BOOL
type=OpenApiTypes.BOOL,
)
]
)
Expand All @@ -589,6 +554,7 @@ def retrieve(self, request, pk=None):
serializers_dict[TemplateSerializer.__name__] = TemplateSerializer
views[f"{entity_str.lower().replace(' ', '')}"] = TemplateViewSet


serializers_dict = dict()
views = dict()
# filter_classes = dict()
Expand Down