Merge pull request #96 from cmu-delphi/OKRS24-138-Fix-mypy-issues

Okrs24 138 fix mypy issues

Author: BrainIsDead

Pipfile

@@ -40,6 +40,7 @@ celery = {version = "*", extras = ["redis"]}
 flower = "*"
 django-htmx = "*"
 gunicorn = "*"
+types-requests = "*"
 
 [dev-packages]
 flake8 = "*"

Pipfile.lock

@@ -30,3 +30,12 @@ plugins =
 
 [mypy.plugins.django-stubs]
 django_settings_module = signal_documentation.settings
+
+[mypy-*.migrations.*]
+ignore_errors = True
+
+[mypy-signal_documentation.settings.*]
+ignore_errors = True
+
+[mypy-*.tests.*]
+ignore_errors = True

setup.cfg

@@ -10,7 +10,7 @@ def filters_descriptions(request) -> dict[str, list[dict[str, Any]]]:
     """
     descripted_filters = DescriptedFilter.objects.all()
 
-    results: dict[str, dict[dict[str, dict[str, str]]]] = {
+    results: dict = {
         'filters_descriptions': {
                 split_class_name(str(df.filter_name))[-1]: df.descriptions
             } for df in descripted_filters

src/base/context_processors.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')
@@ -31,21 +31,21 @@ def __str__(self) -> str:
         Returns the name of the filter and the filter field
         that associated with description.
         """
-        return self.filter_field
+        return str(self.filter_field)
 
 
 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:
         """
         Returns the name of the filter and the filter field
         that associated with description.
         """
-        return self.filter_name
+        return str(self.filter_name)
 
     def save(self, *args, **kwargs) -> None:
         """
@@ -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/base/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/datasources/models.py

@@ -25,12 +25,12 @@
     'sphinx.ext.autodoc',
 ]
 
-templates_path = ['_templates']
-exclude_patterns = []
+templates_path: list[str] = ['_templates']
+exclude_patterns: list = []
 
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
 html_theme = "sphinx_rtd_theme"
-html_static_path = ['_static']
+html_static_path: list[str] = ['_static']

src/docs/source/conf.py

@@ -158,7 +158,7 @@
 }
 
 
-PAGE_SIZE = os.environ.get('PAGE_SIZE', 10)
+PAGE_SIZE: int = int(os.environ.get('PAGE_SIZE', 10))
 
 
 CRISPY_ALLOWED_TEMPLATE_PACKS = "bootstrap5"

src/signal_documentation/settings.py

@@ -100,7 +100,7 @@ def filter_search(self, queryset, name, value) -> Any:
                 query &= item
             queries.append(query)
 
-        query: Q = queries.pop()
+        query = queries.pop()
 
         for item in queries:
             query |= item

src/signals/filters.py

@@ -81,7 +81,7 @@ class Meta:
             }),
         }
 
-    def __init__(self, *args, **kwargs):
+    def __init__(self, *args, **kwargs) -> None:
         """
         Initialize the form.
         """
@@ -91,4 +91,4 @@ def __init__(self, *args, **kwargs):
         for field_name, field in self.fields.items():
             field.required = False
             field.help_text = ''
-            field.label = False
+            field.label = ''