Merge pull request #1267 from TOMToolkit/1125-add-target-and-dataproduct-filters-to-the-reduceddatums-drf-api

add ReducedDatum filters

Author: jchate6

docs/api/tom_dataproducts/api_views.rst

@@ -1,5 +1,5 @@
-API Views
-=========
+Data API Views
+==============
 
 .. warning:: Check your groups!
 
@@ -10,8 +10,13 @@ API Views
 
 .. tip:: Better API documentation
 
-    The available parameters for RESTful API calls are not available here. However, if you navigate to ``/api/targets/``
-    and click the ``OPTIONS`` button, you can easily view all of the available parameters.
+    The available parameters for RESTful API calls are not available here. However, if you navigate to
+    ``/api/reduceddatums/`` and click the ``OPTIONS`` button, you can easily view all of the available parameters.
+
+    From the ``GET`` view, you can experiment with the available filters and see an example of the request.
 
 .. automodule:: tom_dataproducts.api_views
-    :members:
+    :members:
+
+.. automodule:: tom_dataproducts.filters
+    :members:

docs/api/tom_targets/api_views.rst

@@ -1,5 +1,5 @@
-API Views
-=========
+Target API Views
+================
 
 .. warning:: Check your groups!
 
@@ -12,5 +12,10 @@ API Views
     The available parameters for RESTful API calls are not available here. However, if you navigate to ``/api/targets/``
     and click the ``OPTIONS`` button, you can easily view all of the available parameters.
 
+    From the ``GET`` view, you can experiment with the available filters and see an example of the request.
+
 .. automodule:: tom_targets.api_views
-    :members:
+    :members:
+
+.. automodule:: tom_targets.filters.TargetFilter
+    :members:

docs/introduction/credits.rst

@@ -13,6 +13,7 @@ Austin Riba, David Collom and William Lindstrom.
 
 Our team very much welcome input from the community, and we are grateful to
 the following people for their many contributions:
+
  - Dan Avner, NOIRLab
  - Doug Arnold, Liverpool Telescope
  - Etienne Bachelet, IPAC/Caltech

docs/managing_data/single_target_data_service.rst

@@ -72,6 +72,7 @@ as an asynchronous task manager. To use django-tasks you can enable it by adding
 
 
 .. code:: python
+
     TASKS = {
         "default": {
              "BACKEND": "django_tasks.backends.database.DatabaseBackend"

tom_dataproducts/api_views.py

@@ -10,7 +10,7 @@
 
 from tom_common.hooks import run_hook
 from tom_dataproducts.data_processor import run_data_processor
-from tom_dataproducts.filters import DataProductFilter
+from tom_dataproducts.filters import DataProductFilter, ReducedDatumFilter
 from tom_dataproducts.models import DataProduct, ReducedDatum
 from tom_dataproducts.serializers import DataProductSerializer, ReducedDatumSerializer
 from tom_targets.models import Target
@@ -77,15 +77,11 @@ class ReducedDatumViewSet(CreateModelMixin, DestroyModelMixin, ListModelMixin, G
     Viewset for ReducedDatum objects. Supports list, create, and delete.
 
     To view supported query parameters, please use the OPTIONS endpoint, which can be accessed through the web UI.
-
-    **Please note that ``groups`` are an accepted query parameters for the ``CREATE`` endpoint. The groups parameter
-    will specify which ``groups`` can view the created ``DataProduct``. If no ``groups`` are specified, the
-    ``ReducedDatum`` will only be visible to the user that created the ``DataProduct``. Make sure to check your
-    ``groups``!!**
     """
     queryset = ReducedDatum.objects.all()
     serializer_class = ReducedDatumSerializer
     filter_backends = (drf_filters.DjangoFilterBackend,)
+    filterset_class = ReducedDatumFilter
     permission_required = 'tom_dataproducts.view_reduceddatum'
     parser_classes = [FormParser, JSONParser]
 

tom_dataproducts/filters.py

@@ -1,10 +1,18 @@
 import django_filters
 from django.db.models import Q
 
-from tom_dataproducts.models import DataProduct
+from tom_dataproducts.models import DataProduct, ReducedDatum
 
 
-class DataProductFilter(django_filters.FilterSet):
+class DataProductFilter(django_filters.rest_framework.FilterSet):
+    """
+    Filters are available for DataProduct objects:
+        - target_name: Filter by target name or alias.
+        - facility: Filter by the facility of the observation record associated with the data product.
+
+    Access these filters via the API endpoint:
+        `GET /api/dataproducts/?target_name=<name>&facility=<facility>`
+    """
     target_name = django_filters.CharFilter(label='Target Name', method='filter_name')
     facility = django_filters.CharFilter(field_name='observation_record__facility', label='Observation Record Facility')
 
@@ -14,3 +22,31 @@ class Meta:
 
     def filter_name(self, queryset, name, value):
         return queryset.filter(Q(target__name__icontains=value) | Q(target__aliases__name__icontains=value))
+
+
+class ReducedDatumFilter(django_filters.rest_framework.FilterSet):
+    """
+    Filters are available for ReducedDatum objects:
+        - target__id: Filter by target ID.
+        - target_name: Filter by target name or alias.
+        - data_product_pk: Filter by the primary key of the associated DataProduct.
+        - data_product_product_id: Filter by the "Product ID" or filename of the associated DataProduct.
+        - source_name: Filter by the name of the source.
+        - data_type: Filter by the type of data (e.g., 'photometry', 'spectrum').
+
+    Access these filters via the API endpoint:
+        `GET /api/reduceddatums/?target__id=<id>&data_type=<type>`
+    """
+    target_name = django_filters.CharFilter(label='Target Name', method='filter_name')
+    data_product_name = django_filters.CharFilter(method='filter_data_product_name', label='Data Product filename')
+
+    class Meta:
+        model = ReducedDatum
+        fields = ['target__id', 'target_name', 'data_product__id', 'source_name', 'data_type']
+
+    def filter_name(self, queryset, name, value):
+        return queryset.filter(Q(target__name__icontains=value) | Q(target__aliases__name__icontains=value))
+
+    def filter_data_product_name(self, queryset, name, value):
+        return queryset.filter(data_product__product_id__icontains=value) | \
+               queryset.filter(data_product__data__icontains=value)

tom_dataproducts/tests/test_api.py

@@ -157,3 +157,41 @@ def test_upload_reduced_datum_no_sharing_name(self):
         del self.rd_data['source_name']
         response = self.client.post(reverse('api:reduceddatums-list'), self.rd_data, format='json')
         self.assertEqual(response.status_code, status.HTTP_201_CREATED)
+
+    def test_reduced_datum_list(self):
+        rd = ReducedDatum.objects.create(
+            target=self.st,
+            data_type='photometry',
+            source_name='TOM Toolkit',
+            value={'magnitude': 15.582, 'filter': 'r', 'error': 0.005},
+        )
+
+        response = self.client.get(reverse('api:reduceddatums-list'))
+        self.assertContains(response, rd.data_type, status_code=status.HTTP_200_OK)
+
+    def test_reduced_datum_filter(self):
+        rd1 = ReducedDatum.objects.create(
+            target=self.st,
+            data_type='photometry',
+            source_name='TOM Toolkit',
+            value={'magnitude': 15.582, 'filter': 'r', 'error': 0.005},
+        )
+        rd2 = ReducedDatum.objects.create(
+            target=self.st,
+            data_type='spectroscopy',
+            source_name='TOM Toolkit',
+            value={'wavelength': 150, 'flux': 12, 'error': 0.005},
+        )
+
+        # test filter for one object
+        response = self.client.get(reverse('api:reduceddatums-list'), QUERY_STRING='data_type=photometry')
+        self.assertContains(response, rd1.data_type, status_code=status.HTTP_200_OK, count=1)
+
+        # test filter for both objects
+        response2 = self.client.get(reverse('api:reduceddatums-list'), QUERY_STRING=f'target_name={self.st.name}')
+        self.assertContains(response2, rd2.data_type, status_code=status.HTTP_200_OK, count=2)
+
+        # test filter for no objects
+        response3 = self.client.get(reverse('api:reduceddatums-list'), QUERY_STRING='source_name=thin_air')
+        self.assertEqual(response3.data['count'], 0)
+        self.assertEqual(response3.data['results'], [])

tom_observations/views.py

@@ -11,8 +11,8 @@
 from django.contrib import messages
 from django.contrib.auth.mixins import LoginRequiredMixin
 from django.core.management import call_command
-from django_filters import (CharFilter, ChoiceFilter, DateTimeFromToRangeFilter, FilterSet, ModelMultipleChoiceFilter,
-                            OrderingFilter, MultipleChoiceFilter)
+from django_filters import CharFilter, ChoiceFilter, DateTimeFromToRangeFilter, ModelMultipleChoiceFilter
+from django_filters import OrderingFilter, MultipleChoiceFilter, rest_framework
 from django_filters.views import FilterView
 from django.shortcuts import redirect
 from django.urls import reverse, reverse_lazy
@@ -38,7 +38,7 @@
 logger = logging.getLogger(__name__)
 
 
-class ObservationFilter(FilterSet):
+class ObservationFilter(rest_framework.FilterSet):
     """
     Defines the available fields for filtering the list of ``ObservationRecord`` objects.
     """
@@ -594,7 +594,7 @@ class ObservationGroupDeleteView(Raise403PermissionRequiredMixin, DeleteView):
     success_url = reverse_lazy('tom_observations:group-list')
 
 
-class ObservationTemplateFilter(FilterSet):
+class ObservationTemplateFilter(rest_framework.FilterSet):
     """
     Defines the available fields for filtering the list of ``ObservationTemplate`` objects.
     """

tom_targets/filters.py

@@ -41,7 +41,22 @@ def filter_text(queryset, name, value):
     return queryset.filter(targetextra__key=name, targetextra__value__icontains=value)
 
 
-class TargetFilter(django_filters.FilterSet):
+class TargetFilter(django_filters.rest_framework.FilterSet):
+    """
+    Filters are available for Target objects:
+        - type: Filter by target type (e.g., 'SIDEREAL', 'NON_SIDEREAL').
+        - name: Filter by target name or alias.
+        - key: Filter by a specific key in the target's extra fields.
+        - value: Filter by a specific value in the target's extra fields.
+        - cone_search: Perform a cone search around a given position (RA,Dec,Radius).
+        - targetlist__name: Filter by the name of the target list the target belongs to.
+        - name_fuzzy: Perform a fuzzy search on the target name or aliases.
+        - target_cone_search: Perform a cone search on the target's position (radius).
+        - order: Order the results by a specific field ('name', 'created', 'modified')
+
+    Access these filters via the API endpoint:
+        `GET /api/targets/?type=<type>&cone_search=<ra,dec,radius>`
+    """
     key = django_filters.CharFilter(field_name='targetextra__key', label='Key')
     value = django_filters.CharFilter(field_name='targetextra__value', label='Value')