The changes made in this commit include:

- Added `src/base/serializers.py`
- Modified `src/signal_documentation/settings.py` to remove a line
- Modified `src/signals/filters.py` to add a class docstring and a method docstring
- Modified `src/signals/resources.py` to add class docstrings and method docstrings
- Added `src/signals/serializers.py`
- Modified `src/signals/urls.py` to add a new API endpoint
- Modified `src/signals/views.py` to add class docstrings and a new API view

Author: BrainIsDead

src/base/serializers.py

@@ -0,0 +1,12 @@
+from rest_framework.serializers import ModelSerializer
+
+from base.models import Link
+
+
+class LinkSerializer(ModelSerializer):
+    """
+    Serializer for the Link model.
+    """
+    class Meta:
+        model = Link
+        fields = ['link_type', 'url']

src/signal_documentation/settings.py

@@ -177,7 +177,6 @@
     'DEFAULT_FILTER_BACKENDS': (
         'django_filters.rest_framework.DjangoFilterBackend',
     ),
-
 }
 
 

src/signals/filters.py

@@ -8,6 +8,10 @@
 
 
 class SignalFilter(django_filters.FilterSet):
+    """
+    FilterSet for the Signal model.
+    """
+
     search = CharFilter(method='filter_search')
 
     class Meta:
@@ -24,6 +28,18 @@ class Meta:
         ]
 
     def filter_search(self, queryset, name, value) -> Any:
+        """
+        Custom filter method to perform a search on the Signal model.
+
+        Args:
+            queryset (QuerySet): The initial queryset.
+            name (str): The name of the filter field.
+            value (Any): The value to search for.
+
+        Returns:
+            QuerySet: The filtered queryset based on the search value.
+        """
+
         if not value:
             return queryset
 

src/signals/resources.py

@@ -17,6 +17,10 @@
 
 
 class SignalBaseResource(resources.ModelResource):
+    """
+    Resource class for importing Signals base.
+    """
+
     name = Field(attribute='name', column_name='Signal')
     display_name = Field(attribute='display_name', column_name='Name')
     base = Field(
@@ -49,7 +53,9 @@ def process_base(self, row) -> None:
 
 
 class SignalResource(resources.ModelResource):
-    """Resource class for importing and exporting Signal models."""
+    """
+    Resource class for importing and exporting Signal models
+    """
 
     name = Field(attribute='name', column_name='Signal')
     display_name = Field(attribute='display_name', column_name='Name')
@@ -122,19 +128,26 @@ class Meta:
         import_id_fields: list[str] = ['name', 'source', 'display_name']
 
     def before_import_row(self, row, **kwargs) -> None:
-        """Pre-processes each row before importing."""
+        """
+        Pre-processes each row before importing.
+        """
+
         self.fix_boolean_fields(row, ['Active', 'Is Smoothed', 'Is Weighted', 'Is Cumulative', 'Has StdErr', 'Has Sample Size'])
         self.process_links(row)
         self.process_pathogen(row)
 
     def is_url_in_domain(self, url, domain) -> Any:
-        """Checks if a URL belongs to a specific domain."""
+        """
+        Checks if a URL belongs to a specific domain.
+        """
 
         parsed_url: Any = urlparse(url)
         return parsed_url.netloc == domain
 
     def fix_boolean_fields(self, row, fields: list) -> Any:
-        """Fixes boolean fields."""
+        """
+        Fixes boolean fields.
+        """
 
         for k in fields:
             if row[k] == 'TRUE':
@@ -144,7 +157,9 @@ def fix_boolean_fields(self, row, fields: list) -> Any:
         return row
 
     def process_links(self, row) -> Any:
-        """Processes links."""
+        """
+        Processes links.
+        """
 
         row['Links'] = ''
         if row['Link']:
@@ -170,7 +185,9 @@ def process_links(self, row) -> Any:
         return row
 
     def process_pathogen(self, row) -> None:
-        """Processes pathogen."""
+        """
+        Processes pathogen.
+        """
 
         if row['Pathogen/ Disease Area']:
             pathogens: str = row['Pathogen/ Disease Area'].split(',')

src/signals/serializers.py

@@ -0,0 +1,32 @@
+from rest_framework.serializers import ModelSerializer, SlugRelatedField
+
+from base.serializers import LinkSerializer
+from signals.models import Signal
+
+
+class SignalBaseSerializer(ModelSerializer):
+    """
+    Serializer for the base Signal model.
+    """
+
+    class Meta:
+        model = Signal
+        fields = ['id', 'name', 'display_name']
+
+
+class SignalSerializer(ModelSerializer):
+    """
+    Serializer for the Signal model.
+    """
+
+    links = LinkSerializer(many=True)
+    pathogen = SlugRelatedField(many=True, read_only=True, slug_field='name')
+    signal_type = SlugRelatedField(many=True, read_only=True, slug_field='name')
+    available_geography = SlugRelatedField(many=True, read_only=True, slug_field='name')
+    category = SlugRelatedField(read_only=True, slug_field='name')
+    source = SlugRelatedField(read_only=True, slug_field='name')
+    base = SignalBaseSerializer()
+
+    class Meta:
+        model = Signal
+        fields = '__all__'

src/signals/urls.py

@@ -1,9 +1,17 @@
 from django.urls import path
 from django.urls.resolvers import URLPattern
 
-from signals.views import SignalsDetailView, SignalsListView
+from signals.views import (
+    SignalsDetailView,
+    SignalsListApiView,
+    SignalsListView,
+)
 
 urlpatterns: list[URLPattern] = [
     path('', SignalsListView.as_view(), name='signals'),
     path('signals/<pk>/', SignalsDetailView.as_view(), name='signal'),
+
+    # REST API
+    path('api/v1/signals/', SignalsListApiView.as_view(), name='signals_api'),
+
 ]

src/signals/views.py

@@ -1,26 +1,48 @@
 from typing import Any, Dict
 
+from django.conf import settings
 from django.core.paginator import Page, Paginator
 from django.utils.decorators import method_decorator
 from django.views.decorators.cache import cache_page
 from django.views.generic import DetailView, ListView
+from django_filters.rest_framework import DjangoFilterBackend
+from rest_framework.filters import SearchFilter
+from rest_framework.generics import ListAPIView
 
 from signals.filters import SignalFilter
 from signals.models import Signal
+from signals.serializers import SignalSerializer
 
 
 class SignalsListView(ListView):
+    """
+    ListView for displaying a list of Signal objects.
+    """
 
     model = Signal
     template_name = 'signals/signal_list.html'
-    paginate_by = 10
+    paginate_by = settings.PAGE_SIZE
 
     def get_queryset(self) -> Any:
+        """
+        Get the queryset for the view.
+
+        Returns:
+            QuerySet: The queryset for the view.
+        """
+
         queryset = super().get_queryset()
         f = SignalFilter(self.request.GET, queryset=queryset)
         return f.qs
 
     def get_context_data(self, **kwargs) -> Dict[str, Any]:
+        """
+        Get the context data for the view.
+
+        Returns:
+            Dict[str, Any]: The context data for the view.
+        """
+
         context: Dict[str, Any] = super().get_context_data(**kwargs)
         context['filter'] = SignalFilter(self.request.GET, queryset=self.get_queryset())
         paginator = Paginator(self.get_queryset(), self.paginate_by)
@@ -32,5 +54,31 @@ def get_context_data(self, **kwargs) -> Dict[str, Any]:
 
 @method_decorator(cache_page(60 * 5), name='dispatch')
 class SignalsDetailView(DetailView):
+    """
+    DetailView for displaying a single Signal object.
+    """
 
     model = Signal
+
+
+class SignalsListApiView(ListAPIView):
+    """
+    ListAPIView for retrieving a list of Signal objects via API.
+    """
+
+    queryset = Signal.objects.all()
+    serializer_class = SignalSerializer
+    search_fields = ('name', 'display_name', 'description', 'short_description')
+    filter_backends = [SearchFilter, DjangoFilterBackend]
+    filterset_fields = (
+        'name',
+        'display_name',
+        'pathogen__name',
+        'available_geography__name',
+        'signal_type__name',
+        'category__name',
+        'format',
+        'base',
+        'source__name',
+        'time_label',
+    )