Skip to content

views#

SystemCreatorViewSet#

Bases: AccessViewSetMixin, ModelViewSet

Source code in src/apps/common/views.py 
16
17
18
19
20
21
22
class SystemCreatorViewSet(AccessViewSetMixin, viewsets.ModelViewSet):
    access_policy = BaseAccessPolicy

    def perform_create(self, serializer):
        if self.request.user.is_anonymous:
            raise NotAuthenticated("You must be authenticated to perform this action.")
        serializer.save(system_creator=self.request.user)

StandardResultsSetPagination#

Bases: PageNumberPagination

Source code in src/apps/common/views.py 
25
26
27
28
class StandardResultsSetPagination(PageNumberPagination):
    page_size = 100
    page_size_query_param = "page_size"
    max_page_size = 1000

PatchModelMixin#

ViewSet mixin for patch support in partial update.

The ViewSet needs to use a serializer based on PatchModelSerializer. Otherwise the serializer raises an error about unexpected 'patch' argument.

Source code in src/apps/common/views.py 
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
class PatchModelMixin:
    """ViewSet mixin for patch support in partial update.

    The ViewSet needs to use a serializer based on PatchModelSerializer.
    Otherwise the serializer raises an error about unexpected 'patch' argument.
    """

    def update(self, request, *args, **kwargs):
        """Like UpdateModelMixin.update but with support for 'patch' kwarg."""
        patch = kwargs.pop("patch", False)
        partial = kwargs.pop("partial", False)
        instance = self.get_object()
        serializer = self.get_serializer(instance, data=request.data, partial=partial, patch=patch)
        serializer.is_valid(raise_exception=True)
        self.perform_update(serializer)

        if getattr(instance, "_prefetched_objects_cache", None):
            # If 'prefetch_related' has been applied to a queryset, we need to
            # forcibly invalidate the prefetch cache on the instance.
            instance._prefetched_objects_cache.clear()

        return Response(serializer.data)

    def partial_update(self, request, *args, **kwargs):
        kwargs["patch"] = True
        return self.update(request, *args, **kwargs)

update(request, *args, **kwargs) #

Like UpdateModelMixin.update but with support for 'patch' kwarg.

Source code in src/apps/common/views.py 
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
def update(self, request, *args, **kwargs):
    """Like UpdateModelMixin.update but with support for 'patch' kwarg."""
    patch = kwargs.pop("patch", False)
    partial = kwargs.pop("partial", False)
    instance = self.get_object()
    serializer = self.get_serializer(instance, data=request.data, partial=partial, patch=patch)
    serializer.is_valid(raise_exception=True)
    self.perform_update(serializer)

    if getattr(instance, "_prefetched_objects_cache", None):
        # If 'prefetch_related' has been applied to a queryset, we need to
        # forcibly invalidate the prefetch cache on the instance.
        instance._prefetched_objects_cache.clear()

    return Response(serializer.data)

CommonQueryParamsSerializer#

Bases: Serializer

Serializer for 'strict' query parameter.

Source code in src/apps/common/views.py 
59
60
61
62
63
64
65
class CommonQueryParamsSerializer(serializers.Serializer):
    """Serializer for 'strict' query parameter."""

    strict = serializers.BooleanField(default=True)
    include_nulls = serializers.BooleanField(
        default=False, help_text="Keep null values in the response."
    )

QueryParamsMixin#

Bases: ViewSet

ViewSet mixin for parsing query params with serializers.

Provides query_params attribute that validates query parameters using serializers assigned to the view action.

The serializers are configured with the added query_serializers ViewSet class attribute. The query_serializers attribute should be a list of dicts with - class: Serializer class used for parsing query parameters. - actions: Optional list to limit the ViewSet actions the serializer applies to.

Example: 

class SomeView(ViewSet):
    query_serializers = [
        {"class": SomeQueryParamsSerializer, "actions": ["list"]}
    ]

    def list(self, request, *args, **kwargs):
        params = self.query_params
        ...

The query serializers are also used for generating swagger docs. See the inspectors.ExtendedSwaggerAutoSchema.get_query_parameters method for details.

Source code in src/apps/common/views.py 
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
class QueryParamsMixin(viewsets.ViewSet):
    """ViewSet mixin for parsing query params with serializers.

    Provides `query_params` attribute that validates query parameters
    using serializers assigned to the view action.

    The serializers are configured with the
    added query_serializers ViewSet class attribute.
    The query_serializers attribute should be a list of dicts with
    - `class`: Serializer class used for parsing query parameters.
    - `actions`: Optional list to limit the ViewSet actions the serializer applies to.

    Example:
    ```
    class SomeView(ViewSet):
        query_serializers = [
            {"class": SomeQueryParamsSerializer, "actions": ["list"]}
        ]

        def list(self, request, *args, **kwargs):
            params = self.query_params
            ...
    ```

    The query serializers are also used for generating swagger docs.
    See the inspectors.ExtendedSwaggerAutoSchema.get_query_parameters method for details.
    """

    query_serializers = []

    query_params = {}

    def initial(self, request, *args, **kwargs):
        """Initialization before method handler is called."""
        self.validate_query_params()
        super().initial(request, *args, **kwargs)

    def get_query_serializer_classes(self):
        """Get query serializer classes for current action."""
        classes = []
        for serializer_info in getattr(self, "query_serializers", []):
            actions = serializer_info.get("actions")
            if actions and self.action not in actions:
                continue
            classes.append(serializer_info["class"])
        return classes

    @cached_property
    def common_query_params(self) -> dict:
        serializer = CommonQueryParamsSerializer(data=self.request.query_params)
        serializer.is_valid(raise_exception=True)
        return serializer.validated_data

    @property
    def strict(self) -> bool:
        """Return True if strict parameter parsing is enabled."""
        return self.common_query_params["strict"]

    @property
    def include_nulls(self) -> bool:
        """Return True if returning nulls is enabled."""
        return self.common_query_params["include_nulls"]

    def validate_query_params(self):
        """Validate query parameters for current action, assign to self.query_params."""
        params = {}
        supported_params = set(settings.COMMON_QUERY_PARAMS)
        for serializer_class in self.get_query_serializer_classes():
            serializer = serializer_class(data=self.request.query_params)
            serializer.is_valid(raise_exception=True)
            params.update(serializer.validated_data)
            supported_params.update(serializer.fields)

        # Add query parameters from filterset to supported_params.
        # NOTE: This currently assumes that there are no new filters
        # added dynamically during filterset instantiation.
        if filterset_class := getattr(self, "filterset_class", None):
            supported_params.update(filterset_class.base_filters)

        # List views use pagination, add pagination params to supported_params
        if not self.detail:
            # Requires paginator to declare its params in 'params' attribute
            if paginator := getattr(self, "paginator", None):
                supported_params.update(paginator.params)

        # Disallow unknown query params in strict mode
        if self.strict:
            if unknown_params := set(self.request.query_params) - supported_params:
                raise serializers.ValidationError(
                    {field: _("Unknown query parameter") for field in unknown_params}
                )

        self.query_params = params

include_nulls: bool property #

Return True if returning nulls is enabled.

strict: bool property #

Return True if strict parameter parsing is enabled.

get_query_serializer_classes() #

Get query serializer classes for current action.

Source code in src/apps/common/views.py 
105
106
107
108
109
110
111
112
113
def get_query_serializer_classes(self):
    """Get query serializer classes for current action."""
    classes = []
    for serializer_info in getattr(self, "query_serializers", []):
        actions = serializer_info.get("actions")
        if actions and self.action not in actions:
            continue
        classes.append(serializer_info["class"])
    return classes

initial(request, *args, **kwargs) #

Initialization before method handler is called.

Source code in src/apps/common/views.py 
100
101
102
103
def initial(self, request, *args, **kwargs):
    """Initialization before method handler is called."""
    self.validate_query_params()
    super().initial(request, *args, **kwargs)

validate_query_params() #

Validate query parameters for current action, assign to self.query_params.

Source code in src/apps/common/views.py 
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
def validate_query_params(self):
    """Validate query parameters for current action, assign to self.query_params."""
    params = {}
    supported_params = set(settings.COMMON_QUERY_PARAMS)
    for serializer_class in self.get_query_serializer_classes():
        serializer = serializer_class(data=self.request.query_params)
        serializer.is_valid(raise_exception=True)
        params.update(serializer.validated_data)
        supported_params.update(serializer.fields)

    # Add query parameters from filterset to supported_params.
    # NOTE: This currently assumes that there are no new filters
    # added dynamically during filterset instantiation.
    if filterset_class := getattr(self, "filterset_class", None):
        supported_params.update(filterset_class.base_filters)

    # List views use pagination, add pagination params to supported_params
    if not self.detail:
        # Requires paginator to declare its params in 'params' attribute
        if paginator := getattr(self, "paginator", None):
            supported_params.update(paginator.params)

    # Disallow unknown query params in strict mode
    if self.strict:
        if unknown_params := set(self.request.query_params) - supported_params:
            raise serializers.ValidationError(
                {field: _("Unknown query parameter") for field in unknown_params}
            )

    self.query_params = params

NonFilteringGetObjectMixin#

ViewSet mixin that doesn't call filter_queryset in get_object.

Normally, e.g. /datasets/<id>?title=something will return 404 if the title does not contain 'something'. This is counterintuitive since it's not anywhere in the Swagger docs. Disabling the feature should be ok since we're not using django-filters for enforcing permissions.

Source code in src/apps/common/views.py 
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
class NonFilteringGetObjectMixin:
    """ViewSet mixin that doesn't call filter_queryset in get_object.

    Normally, e.g. `/datasets/<id>?title=something` will
    return 404 if the title does not contain 'something'.
    This is counterintuitive since it's not anywhere in
    the Swagger docs. Disabling the feature should be
    ok since we're not using django-filters for enforcing
    permissions.
    """

    def get_object(self):
        """Identical to GenericAPIView.get_object but doesn't use filter_queryset."""
        queryset = self.get_queryset()  # removed filter_queryset here

        # 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

get_object() #

Identical to GenericAPIView.get_object but doesn't use filter_queryset.

Source code in src/apps/common/views.py 
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
def get_object(self):
    """Identical to GenericAPIView.get_object but doesn't use filter_queryset."""
    queryset = self.get_queryset()  # removed filter_queryset here

    # 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

CommonModelViewSet#

Bases: QueryParamsMixin, NonFilteringGetObjectMixin, PatchModelMixin, SystemCreatorViewSet

ViewSet with common functionality.

Source code in src/apps/common/views.py 
196
197
198
199
200
201
202
203
204
205
class CommonModelViewSet(
    QueryParamsMixin, NonFilteringGetObjectMixin, PatchModelMixin, SystemCreatorViewSet
):
    """ViewSet with common functionality."""

    def get_serializer_context(self):
        context = super().get_serializer_context()
        context["strict"] = self.strict
        context["include_nulls"] = self.include_nulls
        return context

CommonReadOnlyModelViewSet#

Bases: QueryParamsMixin, NonFilteringGetObjectMixin, ReadOnlyModelViewSet

ViewSet with common functionality for read only models.

Source code in src/apps/common/views.py 
208
209
210
211
212
213
214
215
216
217
class CommonReadOnlyModelViewSet(
    QueryParamsMixin, NonFilteringGetObjectMixin, viewsets.ReadOnlyModelViewSet
):
    """ViewSet with common functionality for read only models."""

    def get_serializer_context(self):
        context = super().get_serializer_context()
        context["strict"] = self.strict
        context["include_nulls"] = self.include_nulls
        return context