🛠️ models.py -> Updated field types and help texts for models

🛠️ models.py -> Updated field types and help texts for models
🛠️ models.py -> Updated field types and help texts for models
🛠️ models.py -> Updated field types and help texts for models

Author: BrainIsDead

src/base/models.py

@@ -15,13 +15,13 @@ class DescriptedFilterField(models.Model):
     """
     A model representing a filter field that is descripted.
     """
-    filter = models.ForeignKey(
+    filter: models.ForeignKey = models.ForeignKey(
         'DescriptedFilter',
         on_delete=models.CASCADE,
         related_name='filter_fields'
     )
-    filter_field = models.CharField(help_text=_('Filter field'), max_length=256)
-    description = models.TextField(help_text=_('Filter field description'), blank=True, null=True)
+    filter_field: models.CharField = models.CharField(help_text=_('Filter field'), max_length=256)
+    description: models.TextField = models.TextField(help_text=_('Filter field description'), blank=True, null=True)
 
     class Meta:
         unique_together = ('filter', 'filter_field')
@@ -38,7 +38,7 @@ class DescriptedFilter(models.Model):
     """
     A model representing a filter wich fields are descripted.
     """
-    filter_name = models.CharField(max_length=256, unique=True, choices=FILTERS_LIST)
+    filter_name: models.CharField = models.CharField(max_length=256, unique=True, choices=FILTERS_LIST)
 
     def __str__(self) -> str:
         """
@@ -90,7 +90,7 @@ class Link(TimeStampedModel):
     """
     A model representing a Link.
     """
-    link_type = models.CharField(
+    link_type: models.CharField = models.CharField(
         help_text=_('Link type'),
         choices=LinkTypeChoices.choices,
         max_length=128

src/datasources/models.py

@@ -7,32 +7,32 @@ class SourceSubdivision(TimeStampedModel):
     """
     A model representing a source subdivision.
     """
-    name = models.CharField(
+    name: models.CharField = models.CharField(
         help_text=_('Name'),
         max_length=128,
         unique=True
     )
-    display_name = models.CharField(
+    display_name: models.CharField = models.CharField(
         help_text=_('Display Name'),
         max_length=128,
         unique=True
     )
-    description = models.TextField(
+    description: models.TextField = models.TextField(
         help_text=_('Source description'),
         max_length=1000,
         null=True,
         blank=True
     )
-    db_source = models.CharField(
+    db_source: models.CharField = models.CharField(
         help_text=_('DB Source'),
         max_length=128,
     )
-    links = models.ManyToManyField(
+    links: models.ManyToManyField = models.ManyToManyField(
         'base.Link',
         help_text=_('Source Subdivision links'),
         related_name="source_subdivisions"
     )
-    data_source = models.ForeignKey(
+    data_source: models.ForeignKey = models.ForeignKey(
         'datasources.DataSource',
         related_name='source_subdivisions',
         help_text=_('Source Subdivision'),
@@ -49,35 +49,35 @@ def __str__(self) -> str:
         :return: The name of the source subdivision as a string.
         :rtype: str
         """
-        return self.name
+        return str(self.name)
 
 
 class DataSource(TimeStampedModel):
     """
     A model representing a data source.
     """
 
-    name = models.CharField(
+    name: models.CharField = models.CharField(
         help_text=_('Name'),
         max_length=128,
         unique=True
     )
-    display_name = models.CharField(
+    display_name: models.CharField = models.CharField(
         help_text=_('Display Name'),
         max_length=128,
         unique=True
     )
-    description = models.TextField(
+    description: models.TextField = models.TextField(
         help_text=_('Source description'),
         max_length=1000,
         null=True,
         blank=True
     )
-    source_license = models.CharField(
+    source_license: models.CharField = models.CharField(
         help_text=_('License'),
         max_length=128
     )
-    links = models.ManyToManyField(
+    links: models.ManyToManyField = models.ManyToManyField(
         'base.Link',
         help_text=_('DataSource links'),
         related_name="data_sources"
@@ -93,4 +93,4 @@ def __str__(self) -> str:
         :return: The name of the data source as a string.
         :rtype: str
         """
-        return self.name
+        return str(self.name)

src/signals/models.py

@@ -53,7 +53,7 @@ class SignalCategory(TimeStampedModel):
     """
     A model representing a signal category.
     """
-    name = models.CharField(
+    name: models.CharField = models.CharField(
         help_text=_('Name'),
         max_length=128,
         unique=True
@@ -70,37 +70,34 @@ def __str__(self) -> str:
         :return: The name of the signal category as a string.
         :rtype: str
         """
-        return self.name
+        return str(self.name)
 
 
 class SignalType(TimeStampedModel):
     """
     A model representing a signal type.
     """
-    name = models.CharField(
+    name: models.CharField = models.CharField(
         help_text=_('Name'),
         max_length=128,
         unique=True
     )
 
-    class Meta:
-        ordering: list[str] = ["name"]
-
     def __str__(self) -> str:
         """
         Returns the name of the signal type as a string.
 
         :return: The name of the signal type as a string.
         :rtype: str
         """
-        return self.name
+        return str(self.name)
 
 
 class Pathogen(TimeStampedModel):
     """
     A model representing a pathogen.
     """
-    name = models.CharField(
+    name: models.CharField = models.CharField(
         help_text=_('Name'),
         max_length=128,
         unique=True
@@ -113,14 +110,14 @@ def __str__(self) -> str:
         :return: The name of the pathogen as a string.
         :rtype: str
         """
-        return self.name
+        return str(self.name)
 
 
 class Geography(TimeStampedModel):
     """
     A model representing a available geography.
     """
-    name = models.CharField(
+    name: models.CharField = models.CharField(
         help_text=_('Name'),
         max_length=128,
         unique=True
@@ -137,128 +134,128 @@ def __str__(self) -> str:
         :return: The name of the available geography as a string.
         :rtype: str
         """
-        return self.name
+        return str(self.name)
 
 
 class Signal(TimeStampedModel):
     """
     A model representing a signal.
     """
-    name = models.CharField(
+    name: models.CharField = models.CharField(
         help_text=_('Name'),
         max_length=128,
     )
-    display_name = models.CharField(
+    display_name: models.CharField = models.CharField(
         help_text=_('Display Name'),
         max_length=128,
     )
-    base = models.ForeignKey(
+    base: models.ForeignKey = models.ForeignKey(
         'signals.Signal',
         related_name='base_for',
         help_text=_('Signal base'),
         on_delete=models.SET_NULL,
         null=True,
         blank=True
     )
-    pathogen = models.ManyToManyField(
+    pathogen: models.ManyToManyField = models.ManyToManyField(
         'signals.Pathogen',
         related_name='signals',
         help_text=_('Pathogen/Disease Area'),
     )
-    signal_type = models.ManyToManyField(
+    signal_type: models.ManyToManyField = models.ManyToManyField(
         'signals.SignalType',
         related_name='signals',
         help_text=_('Signal Type')
     )
-    active = models.BooleanField(
+    active: models.BooleanField = models.BooleanField(
         help_text=_('Active'),
         default=False
     )
-    short_description = models.TextField(
+    short_description: models.TextField = models.TextField(
         help_text=_('Short Description'),
         max_length=500,
         null=True,
         blank=True
     )
-    description = models.TextField(
+    description: models.TextField = models.TextField(
         help_text=_('Description'),
         max_length=1000,
         null=True,
         blank=True
     )
-    format_type = models.CharField(
+    format_type: models.CharField = models.CharField(
         help_text=_('Format'),
         max_length=128,
         choices=FormatChoices.choices
     )
-    time_type = models.CharField(
+    time_type: models.CharField = models.CharField(
         help_text=_('Time type'),
         max_length=128,
         choices=TimeTypeChoices.choices
     )
-    time_label = models.CharField(
+    time_label: models.CharField = models.CharField(
         help_text=_('Time label'),
         max_length=128,
         choices=TimeLabelChoices.choices
     )
-    category = models.ForeignKey(
+    category: models.ForeignKey = models.ForeignKey(
         'signals.SignalCategory',
         related_name='signals',
         help_text=_('Signal Category'),
         on_delete=models.SET_NULL,
         null=True
     )
-    links = models.ManyToManyField(
+    links: models.ManyToManyField = models.ManyToManyField(
         'base.Link',
         help_text=_('Signal links'),
         related_name="signals"
     )
-    available_geography = models.ManyToManyField(
+    available_geography: models.ManyToManyField = models.ManyToManyField(
         'signals.Geography',
         help_text=_('Available geography')
     )
-    is_smoothed = models.BooleanField(
+    is_smoothed: models.BooleanField = models.BooleanField(
         help_text=_('Is Smoothed'),
         default=False
     )
-    is_weighted = models.BooleanField(
+    is_weighted: models.BooleanField = models.BooleanField(
         help_text=_('Is Weighted'),
         default=False
     )
-    is_cumulative = models.BooleanField(
+    is_cumulative: models.BooleanField = models.BooleanField(
         help_text=_('Is Cumulative'),
         default=False
     )
-    has_stderr = models.BooleanField(
+    has_stderr: models.BooleanField = models.BooleanField(
         help_text=_('Has StdErr'),
         default=False
     )
-    has_sample_size = models.BooleanField(
+    has_sample_size: models.BooleanField = models.BooleanField(
         help_text=_('Has Sample Size'),
         default=False
     )
-    high_values_are = models.CharField(
+    high_values_are: models.CharField = models.CharField(
         help_text=_('High values are'),
         max_length=128,
         choices=HighValuesAreChoices.choices
     )
-    source = models.ForeignKey(
+    source: models.ForeignKey = models.ForeignKey(
         'datasources.SourceSubdivision',
         related_name='signals',
         help_text=_('Source Subdivision'),
         on_delete=models.PROTECT,
     )
-    last_updated = models.DateField(
+    last_updated: models.DateField = models.DateField(
         help_text=_('Last Updated'),
         null=True,
         blank=True
     )
-    from_date = models.DateField(
+    from_date: models.DateField = models.DateField(
         help_text=_('From Date'),
         null=True,
         blank=True
     )
-    to_date = models.DateField(
+    to_date: models.DateField = models.DateField(
         help_text=_('To Date'),
         null=True,
         blank=True
@@ -280,7 +277,7 @@ def __str__(self) -> str:
         :return: The name of the signal as a string.
         :rtype: str
         """
-        return self.name
+        return str(self.name)
 
     def clean(self) -> None:
         """