Renamed some fields

Author: dmytrotsko

src/signal_sets/admin.py

@@ -7,6 +7,6 @@
 
 @admin.register(SignalSet)
 class SignalSetAdmin(ImportExportModelAdmin):
-    list_display = ('name', 'data_description', 'maintainer_name', 'maintainer_email', 'organization')
+    list_display = ('name', 'description', 'maintainer_name', 'maintainer_email', 'organization')
     search_fields = ('name', 'maintainer_name', 'maintainer_email', 'organization')
     resource_class = SignalSetResource

src/signal_sets/migrations/0013_remove_signalset_data_description_and_more.py

@@ -0,0 +1,36 @@
+# Generated by Django 5.0.7 on 2024-11-04 18:17
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('signal_sets', '0012_alter_signalset_data_source'),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name='signalset',
+            name='data_description',
+        ),
+        migrations.RemoveField(
+            model_name='signalset',
+            name='link_to_dictionary',
+        ),
+        migrations.AddField(
+            model_name='signalset',
+            name='description',
+            field=models.TextField(blank=True, verbose_name='Signal Set description'),
+        ),
+        migrations.AddField(
+            model_name='signalset',
+            name='link_to_documentation',
+            field=models.CharField(blank=True, help_text='Link to documentation.', max_length=255, null=True, verbose_name='Link to documentation'),
+        ),
+        migrations.AlterField(
+            model_name='signalset',
+            name='name',
+            field=models.CharField(max_length=255, unique=True, verbose_name='Signal Set name'),
+        ),
+    ]

src/signal_sets/models.py

@@ -35,13 +35,13 @@ def display_name(self) -> str:
 
 class SignalSet(models.Model):
     name: models.CharField = models.CharField(
-        verbose_name="name",
+        verbose_name="Signal Set name",
         max_length=255,
         unique=True,
     )
 
-    data_description: models.TextField = models.TextField(
-        verbose_name="Data Description",
+    description: models.TextField = models.TextField(
+        verbose_name="Signal Set description",
         blank=True,
     )
 
@@ -220,10 +220,12 @@ class SignalSet(models.Model):
         help_text=_("Location of the dataset."),
     )
 
-    link_to_dictionary: models.CharField = models.CharField(
+    link_to_documentation: models.CharField = models.CharField(
         max_length=255,
-        verbose_name=_("link to dictionary"),
-        help_text=_("Link to the dictionary."),
+        verbose_name=_("Link to documentation"),
+        help_text=_("Link to documentation."),
+        null=True,
+        blank=True,
     )
 
     class Meta:

src/signal_sets/resources.py

@@ -66,12 +66,12 @@ def process_datasources(row) -> None:
 
 class SignalSetResource(resources.ModelResource):
 
-    name = Field(attribute="name", column_name="Dataset Name* ")
-    data_description = Field(
-        attribute="data_description", column_name="Description of data*"
+    name = Field(attribute="name", column_name="Signal Set name* ")
+    description = Field(
+        attribute="description", column_name="Signal Set description*"
     )
     maintainer_name = Field(
-        attribute="maintainer_name", column_name="Name of maintainer/\nkey contact *"
+        attribute="maintainer_name", column_name="Maintainer/\nKey Contact *"
     )
     maintainer_email = Field(
         attribute="maintainer_email", column_name="Email of maintainer/\nkey contact *"
@@ -138,15 +138,15 @@ class SignalSetResource(resources.ModelResource):
     dataset_location = Field(
         attribute="dataset_location", column_name="Dataset Location"
     )
-    link_to_dictionary = Field(
-        attribute="link_to_dictionary", column_name="Link to data dictionary"
+    link_to_documentation = Field(
+        attribute="link_to_documentation", column_name="Link to documentation"
     )
 
     class Meta:
         model = SignalSet
         fields: list[str] = [
             "name",
-            "data_description",
+            "description",
             "maintainer_name",
             "maintainer_email",
             "organization",
@@ -171,7 +171,7 @@ class Meta:
             "dua_required",
             "license",
             "dataset_location",
-            "link_to_dictionary",
+            "link_to_documentation",
         ]
         import_id_fields = ["name", "data_source"]
         store_instance = True

src/signals/resources.py

@@ -6,9 +6,17 @@
 from datasources.models import SourceSubdivision
 from datasources.resources import process_links
 from signal_sets.models import SignalSet
-from signals.models import (Category, FormatType, GeographicScope, Geography,
-                            Pathogen, SeverityPyramidRung, Signal,
-                            SignalGeography, SignalType)
+from signals.models import (
+    Category,
+    FormatType,
+    GeographicScope,
+    Geography,
+    Pathogen,
+    SeverityPyramidRung,
+    Signal,
+    SignalGeography,
+    SignalType,
+)
 
 
 def fix_boolean_fields(row) -> Any:
@@ -324,6 +332,10 @@ def before_import_row(self, row, **kwargs) -> None:
         process_geographic_scope(row)
         process_source(row)
         process_links(row, dua_column_name="Link to DUA", link_column_name="Link")
+        if not row["Signal Set"]:
+            self.skip_row(row, None, row, None)
+        if not row["Source Subdivision"]:
+            row["Source Subdivision"] = None
 
     def after_import_row(self, row, row_result, **kwargs):
         signal_obj = Signal.objects.get(id=row_result.object_id)
@@ -333,3 +345,15 @@ def after_import_row(self, row, row_result, **kwargs):
         signal_obj.severity_pyramid_rung = row["Severity Pyramid Rungs"]
         signal_obj.format_type = row["Format"]
         signal_obj.save()
+
+    def import_data(self, *args, **kwargs):
+        self.signal = kwargs.get(
+            "signal"
+        )  # Here, we are assigning the requested signal to the `ModelResource` object.
+        return super().import_data(*args, **kwargs)
+
+    def skip_row(self, instance, original, row, import_validation_errors=None):
+        if row["Source Subdivision"] is None:
+            return True
+        if row["Signal Set"] is None:
+            return True

src/templates/signal_sets/signal_set_detail.html

@@ -19,12 +19,12 @@ <h5 class="card-title">
                     <div class="row">
                         <div class="col-9">
                             <p class="margin-top-1rem margin-bottom-0 overview" id="overview">
-                                {{ signalset.data_description|safe|truncatechars:300 }}
+                                {{ signalset.description|safe|truncatechars:300 }}
                             </p>
                             <p class="margin-top-1rem margin-bottom-0 full-text" id="full-text">
-                                {{ signalset.data_description|safe }}
+                                {{ signalset.description|safe }}
                             </p>
-                            {% if signalset.data_description|length > 300 %}
+                            {% if signalset.description|length > 300 %}
                             <a href="#" onclick="readMore(this);">Read more <i class="bi bi-arrow-bar-down"></i></a>
                             {% endif %}
                         </div>
@@ -158,7 +158,7 @@ <h5>{{ signalset.data_source }}</h5>
                                 </tr>
                                 <tr>
                                     <th scope="row">Link to data dictionary</th>
-                                    <td>{{ signalset.link_to_dictionary }}</td>
+                                    <td>{{ signalset.link_to_documentation }}</td>
                                 </tr>
                             </tbody>
                         </table>

src/templates/signal_sets/signal_sets.html

@@ -294,7 +294,7 @@ <h2 class="accordion-header" id="flush-heading_{{ form.temporal_granularity.auto
                                     </td>
                                     <td class="clickable-table-cell"
                                         onClick="location.href='{% url 'signal_set' pk=signal_set.id %}';">
-                                        {{ signal_set.data_description }}
+                                        {{ signal_set.description }}
                                     </td>
                                     <td class="clickable-table-cell"
                                         onClick="location.href='{% url 'signal_set' pk=signal_set.id %}';">
@@ -429,7 +429,7 @@ <h2 class="accordion-header" id="flush-heading_{{ form.temporal_granularity.auto
                                     </td>
                                     <td class="clickable-table-cell"
                                         onClick="location.href='{% url 'signal_set' pk=signal_set.id %}';">
-                                        {{ signal_set.link_to_dictionary }}
+                                        {{ signal_set.link_to_documentation }}
                                         <br>
                                     </td>
                                 </tr>