Added distinction between Geographic Values that are used in Signal or Signal Set objects

Author: dmytrotsko

src/fixtures/available_geography.json

@@ -6,6 +6,7 @@
         "name": "county",
         "display_name": "ADM2 (e.g. U.S. counties)",
         "display_order_number": 3,
+        "used_in": "signals",
         "created": "2023-08-09T19:23:22.597131",
         "modified": "2023-08-09T19:23:22.597131"
       }
@@ -17,6 +18,7 @@
         "name": "hhs",
         "display_name": "HHS Regions",
         "display_order_number": 4,
+        "used_in": "signals",
         "created": "2023-08-09T19:23:22.597131",
         "modified": "2023-08-09T19:23:22.597131"
       }
@@ -28,6 +30,7 @@
         "name": "hrr",
         "display_name": "Hospital Referral Regions (HRRs)",
         "display_order_number": 6,
+        "used_in": "signals",
         "created": "2023-08-09T19:23:22.597131",
         "modified": "2023-08-09T19:23:22.597131"
       }
@@ -39,6 +42,7 @@
         "name": "msa",
         "display_name": "Metropolitan Statistical Areas (MSAs)",
         "display_order_number": 5,
+        "used_in": "signals",
         "created": "2023-08-09T19:23:22.597131",
         "modified": "2023-08-09T19:23:22.597131"
       }
@@ -50,6 +54,7 @@
         "name": "nation",
         "display_name": "National",
         "display_order_number": 1,
+        "used_in": "signals",
         "created": "2023-08-09T19:23:22.597131",
         "modified": "2023-08-09T19:23:22.597131"
       }
@@ -61,6 +66,7 @@
         "name": "state",
         "display_name": "ADM1 (e.g. U.S. states)",
         "display_order_number": 2,
+        "used_in": "signals",
         "created": "2023-08-09T19:23:22.597131",
         "modified": "2023-08-09T19:23:22.597131"
       }
@@ -72,8 +78,165 @@
         "name": "dma",
         "display_name": "Designated Market Areas (DMAs)",
         "display_order_number": 7,
+        "used_in": "signals",
         "created": "2023-08-09T19:23:22.597131",
         "modified": "2023-08-09T19:23:22.597131"
       }
-    }
+    },
+    {
+        "model": "signals.Geography",
+        "pk": 8,
+        "fields": {
+          "name": "nation",
+          "display_name": "National",
+          "display_order_number": 1,
+          "used_in": "signal_sets",
+          "created": "2023-08-09T19:23:22.597131",
+          "modified": "2023-08-09T19:23:22.597131"
+        }
+      },
+      {
+        "model": "signals.Geography",
+        "pk": 9,
+        "fields": {
+          "name": "hhs-region",
+          "display_name": "U.S. HHS Region",
+          "display_order_number": 2,
+          "used_in": "signal_sets",
+          "created": "2023-08-09T19:23:22.597131",
+          "modified": "2023-08-09T19:23:22.597131"
+        }
+      },
+      {
+        "model": "signals.Geography",
+        "pk": 10,
+        "fields": {
+          "name": "census-region",
+          "display_name": "U.S. Census Region",
+          "display_order_number": 3,
+          "used_in": "signal_sets",
+          "created": "2023-08-09T19:23:22.597131",
+          "modified": "2023-08-09T19:23:22.597131"
+        }
+      },
+      {
+        "model": "signals.Geography",
+        "pk": 11,
+        "fields": {
+          "name": "region",
+          "display_name": "Other Subnational Region",
+          "display_order_number": 4,
+          "used_in": "signal_sets",
+          "created": "2023-08-09T19:23:22.597131",
+          "modified": "2023-08-09T19:23:22.597131"
+        }
+      },
+      {
+        "model": "signals.Geography",
+        "pk": 12,
+        "fields": {
+          "name": "state",
+          "display_name": "State/ADM 1",
+          "display_order_number": 5,
+          "used_in": "signal_sets",
+          "created": "2023-08-09T19:23:22.597131",
+          "modified": "2023-08-09T19:23:22.597131"
+        }
+      },
+      {
+        "model": "signals.Geography",
+        "pk": 13,
+        "fields": {
+          "name": "county",
+          "display_name": "County/ADM 2",
+          "display_order_number": 6,
+          "used_in": "signal_sets",
+          "created": "2023-08-09T19:23:22.597131",
+          "modified": "2023-08-09T19:23:22.597131"
+        }
+      },
+      {
+        "model": "signals.Geography",
+        "pk": 14,
+        "fields": {
+          "name": "city",
+          "display_name": "Municipality/ADM 3",
+          "display_order_number": 7,
+          "used_in": "signal_sets",
+          "created": "2023-08-09T19:23:22.597131",
+          "modified": "2023-08-09T19:23:22.597131"
+        }
+      },
+      {
+        "model": "signals.Geography",
+        "pk": 15,
+        "fields": {
+          "name": "hrr",
+          "display_name": "Hospital Referral Region (HRR)",
+          "display_order_number": 8,
+          "used_in": "signal_sets",
+          "created": "2023-08-09T19:23:22.597131",
+          "modified": "2023-08-09T19:23:22.597131"
+        }
+      },
+      {
+        "model": "signals.Geography",
+        "pk": 16,
+        "fields": {
+          "name": "msa",
+          "display_name": "Metropolitan Statistical Area (MSA)",
+          "display_order_number": 9,
+          "used_in": "signal_sets",
+          "created": "2023-08-09T19:23:22.597131",
+          "modified": "2023-08-09T19:23:22.597131"
+        }
+      },
+      {
+        "model": "signals.Geography",
+        "pk": 17,
+        "fields": {
+          "name": "dma",
+          "display_name": "Designated Market Area (DMA)",
+          "display_order_number": 10,
+          "used_in": "signal_sets",
+          "created": "2023-08-09T19:23:22.597131",
+          "modified": "2023-08-09T19:23:22.597131"
+        }
+      },
+      {
+        "model": "signals.Geography",
+        "pk": 18,
+        "fields": {
+          "name": "facility",
+          "display_name": "Hospital ('Facility')",
+          "display_order_number": 11,
+          "used_in": "signal_sets",
+          "created": "2023-08-09T19:23:22.597131",
+          "modified": "2023-08-09T19:23:22.597131"
+        }
+      },
+      {
+        "model": "signals.Geography",
+        "pk": 19,
+        "fields": {
+          "name": "FluSurv-Net site",
+          "display_name": "FluSurv-Net site (see documentation)",
+          "display_order_number": 12,
+          "used_in": "signal_sets",
+          "created": "2023-08-09T19:23:22.597131",
+          "modified": "2023-08-09T19:23:22.597131"
+        }
+      },
+      {
+        "model": "signals.Geography",
+        "pk": 20,
+        "fields": {
+          "name": "n/a",
+          "display_name": "N/A",
+          "display_order_number": 13,
+          "used_in": "signal_sets",
+          "created": "2023-08-09T19:23:22.597131",
+          "modified": "2023-08-09T19:23:22.597131"
+        }
+      }
   ]

src/signal_sets/filters.py

@@ -32,7 +32,10 @@ class SignalSetFilter(django_filters.FilterSet):
 
     available_geographies = django_filters.ModelMultipleChoiceFilter(
         field_name="available_geographies",
-        queryset=Geography.objects.filter(id__in=SignalSet.objects.values_list("available_geographies", flat="True")).order_by("display_order_number"),
+        queryset=Geography.objects.filter(
+            # id__in=SignalSet.objects.values_list("available_geographies", flat="True")
+            used_in="signal_sets"
+        ).order_by("display_order_number"),
         widget=QueryArrayWidget,
     )
 

src/signal_sets/forms.py

@@ -25,7 +25,8 @@ class SignalSetFilterForm(forms.ModelForm):
 
     available_geographies = forms.ModelChoiceField(
         queryset=Geography.objects.filter(
-            id__in=SignalSet.objects.values_list("available_geographies", flat="True")
+            # id__in=SignalSet.objects.values_list("available_geographies", flat="True")
+            used_in="signal_sets"
         ).order_by("display_order_number"),
         widget=forms.CheckboxSelectMultiple(),
     )

src/signal_sets/models.py

@@ -203,7 +203,7 @@ class SignalSet(models.Model):
     missingness: models.TextField = models.TextField(
         verbose_name=_("missingness"),
         help_text=_("Missingness of the signal set."),
-        blank=True
+        blank=True,
     )
 
     dua_required: models.CharField = models.CharField(
@@ -245,3 +245,7 @@ class SignalSet(models.Model):
     class Meta:
         unique_together = ("name", "data_source")
         ordering = ["name"]
+
+    @property
+    def get_available_geographies(self):
+        return ", ".join([geo.display_name for geo in self.available_geographies.all()])

src/signal_sets/resources.py

@@ -1,5 +1,6 @@
 from typing import Any
 from django.db import IntegrityError, transaction
+from django.db.models import Max
 
 
 from import_export import resources
@@ -50,9 +51,11 @@ def process_avaliable_geographies(row) -> None:
     if row["Geographic Granularity - Delphi"]:
         available_geographies = row["Geographic Granularity - Delphi"].split(",")
         for available_geography in available_geographies:
+            max_display_order_number = Geography.objects.filter(used_in="signals").aggregate(Max("display_order_number"))["display_order_number__max"]
             available_geography_obj, _ = Geography.objects.get_or_create(
                 name=available_geography,
-                defaults={"display_order_number": 1},  # TODO: fix display_order_number
+                used_in="signal_sets",
+                defaults={"used_in": "signal_sets", "display_order_number": max_display_order_number + 1}
             )
 
 
@@ -191,6 +194,7 @@ class Meta:
             "dataset_location",
             "link_to_documentation",
             "endpoint",
+            "available_geographies",
         ]
         import_id_fields = ["name", "data_source"]
         store_instance = True
@@ -228,7 +232,7 @@ def after_import_row(self, row, row_result, **kwargs):
                 signal_set_obj.severity_pyramid_rungs.add(severity_pyramid_rung)
 
             for available_geography in row["Geographic Granularity - Delphi"].split(","):
-                available_geography = Geography.objects.get(name=available_geography)
+                available_geography = Geography.objects.get(name=available_geography, used_in="signal_sets")
                 signal_set_obj.available_geographies.add(available_geography)
             signal_set_obj.save()
         except SignalSet.DoesNotExist as e:

src/signal_sets/views.py

@@ -47,6 +47,11 @@ def get_url_params(self):
             "temporal_granularity": [
                 el for el in self.request.GET.getlist("temporal_granularity")
             ],
+            "available_geographies": (
+                [el for el in self.request.GET.getlist("available_geographies")]
+                if self.request.GET.get("available_geographies")
+                else None
+            ),
             "temporal_scope_end": self.request.GET.get("temporal_scope_end"),
         }
         url_params_str = ""

src/signals/forms.py

@@ -38,7 +38,10 @@ class SignalFilterForm(forms.ModelForm):
     )
 
     available_geography = forms.ModelChoiceField(
-        queryset=Geography.objects.filter(id__in=Signal.objects.values_list("available_geography", flat=True)).order_by("display_order_number"),
+        queryset=Geography.objects.filter(
+            # id__in=Signal.objects.values_list("available_geography", flat=True)
+            used_in="signals"
+        ),
         widget=forms.CheckboxSelectMultiple(),
     )
 

src/signals/migrations/0014_geography_used_in_alter_geography_name_and_more.py

@@ -0,0 +1,27 @@
+# Generated by Django 5.0.7 on 2025-01-17 13:10
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('signals', '0013_alter_geographicscope_options_and_more'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='geography',
+            name='used_in',
+            field=models.CharField(choices=[('signals', 'Signals'), ('signal_sets', 'Signal Sets')], default='signals', max_length=11),
+        ),
+        migrations.AlterField(
+            model_name='geography',
+            name='name',
+            field=models.CharField(help_text='Name of the geography.', max_length=255, verbose_name='name'),
+        ),
+        migrations.AlterUniqueTogether(
+            name='geography',
+            unique_together={('name', 'used_in')},
+        ),
+    ]

src/signals/models.py

@@ -156,7 +156,6 @@ class Geography(TimeStampedModel):
 
     name: models.CharField = models.CharField(
         max_length=255,
-        unique=True,
         verbose_name=_("name"),
         help_text=_("Name of the geography."),
     )
@@ -172,9 +171,16 @@ class Geography(TimeStampedModel):
         help_text=_("Display order number of the geography."),
     )
 
+    used_in: models.CharField = models.CharField(
+        max_length=11,
+        choices=USED_IN_CHOICES,
+        default="signals",
+    )
+
     class Meta:
         verbose_name_plural: str = "geographies"
         ordering: list[str] = ["display_order_number"]
+        unique_together: list[str] = ["name", "used_in"]
 
     def __str__(self) -> str:
         """

src/signals/resources.py

@@ -4,6 +4,8 @@
 from import_export.results import RowResult
 from import_export.fields import Field, widgets
 
+from django.db.models import Max
+
 from datasources.models import SourceSubdivision
 from datasources.resources import process_links
 from signal_sets.models import SignalSet
@@ -133,8 +135,11 @@ def process_available_geographies(row) -> None:
             ","
         )
         for geography in geographies:
+            max_display_order_number = Geography.objects.filter(used_in="signals").aggregate(Max("display_order_number"))["display_order_number__max"]
             geography_instance, _ = Geography.objects.get_or_create(
-                name=geography.strip()
+                name=geography.strip(),
+                used_in="signals",
+                defaults={"used_in": "signals", "display_order_number": max_display_order_number + 1},
             )
             signal = Signal.objects.get(
                 name=row["Signal"], source=row["Source Subdivision"]