Merge branch 'SD-27' of https://github.com/cmu-delphi/signal_documentation into ci-tests

Author: BrainIsDead

.flake8

@@ -25,6 +25,8 @@ django-import-export = "*"
 coverage = "*"
 django-coverage-plugin = "*"
 django-extensions-models = "*"
+mypy = "*"
+django-stubs = "*"
 
 [dev-packages]
 flake8 = "*"

.isort.cfg

@@ -0,0 +1,32 @@
+[isort]
+multi_line_output=3
+force_grid_wrap = 3
+include_trailing_comma=True
+line_length=158
+
+[flake8]
+max-line-length = 158
+max-complexity = 10
+exclude =
+    .git,
+    __pycache__,
+    .env,
+    venv,
+    */migrations
+
+[mypy]
+mypy_path = src/
+files = src
+warn_return_any = True
+warn_unused_configs = True
+warn_redundant_casts = True
+warn_unused_ignores = True
+check_untyped_defs = True
+show_error_codes = True
+strict_optional = True
+ignore_missing_imports = True
+plugins =
+    mypy_django_plugin.main
+
+[mypy.plugins.django-stubs]
+django_settings_module = signal_documentation.settings

Pipfile

@@ -1,3 +1,5 @@
+from typing import Literal
+
 from django.contrib import admin
 
 from base.models import Link
@@ -8,4 +10,4 @@ class LinkAdmin(admin.ModelAdmin):
     """
     Admin interface for managing link objects.
     """
-    list_display = ('url', 'link_type')
+    list_display: tuple[Literal['url'], Literal['link_type']] = ('url', 'link_type')

Pipfile.lock

@@ -1,3 +1,5 @@
+from typing import Literal
+
 from django.contrib import admin
 from import_export.admin import ImportExportModelAdmin
 
@@ -10,15 +12,19 @@ class SourceSubdivisionAdmin(ImportExportModelAdmin):
     """
     Admin interface for managing source subdivision objects.
     """
-    list_display = ('name', 'db_source')
-    search_fields = ('name', 'db_source')
-    resource_classes = [SourceSubdivisionResource]
+    list_display: tuple[Literal['name'], Literal['db_source']] = ('name', 'db_source')
+    search_fields: tuple[Literal['name'], Literal['db_source']] = ('name', 'db_source')
+    resource_classes: list[type[SourceSubdivisionResource]] = [SourceSubdivisionResource]
+
+
+data_source_search_fields_type = tuple[Literal['name'], Literal['source_subdivision__db_source'], Literal['source_subdivision__name'], Literal['description']]
 
 
 @admin.register(DataSource)
 class DataSourceAdmin(ImportExportModelAdmin):
     """
     Admin interface for managing data source objects.
     """
-    list_display = ('name',)
+    list_display: tuple[Literal['name']] = ('name',)
+    search_fields: tuple[Literal['name'], Literal['source_subdivision__db_source'], Literal['source_subdivision__name'], Literal['description']]
     search_fields = ('name', 'source_subdivision__db_source', 'source_subdivision__name', 'description')

setup.cfg

@@ -1,5 +1,7 @@
 import re
+from typing import Literal
 
+from django.db.models import QuerySet
 from import_export import resources
 from import_export.fields import Field, widgets
 
@@ -25,8 +27,10 @@ class SourceSubdivisionResource(resources.ModelResource):
 
     class Meta:
         model = SourceSubdivision
+        fields: tuple[Literal['name'], Literal['display_name'], Literal['description'],
+                      Literal['data_source'], Literal['reference_signal'], Literal['links']]
         fields = ('name', 'display_name', 'description', 'data_source', 'reference_signal', 'links')
-        import_id_fields = ['name']
+        import_id_fields: list[str] = ['name']
         skip_unchanged = True
 
     def before_import_row(self, row, **kwargs) -> None:
@@ -37,22 +41,26 @@ def before_import_row(self, row, **kwargs) -> None:
         self.process_links(row)
         self.process_datasource(row)
 
-    def process_links(self, row):
+    def process_links(self, row) -> None:
         row['Links'] = ''
         if row['DUA']:
+            link: Link
+            created: bool
             link, created = Link.objects.get_or_create(url=row['DUA'], link_type=LinkTypeChoices.DUA)
             row['Links'] += row['Links'] + f'|{link.url}'
         if row['Link']:
             pattern = r'\[(.*?)\]\((.*?)\)'
             pattern_match = re.search(pattern, row['Link'])
             link_type_mapping = {choice.label: choice.value for choice in LinkTypeChoices}
-            link_type = link_type_mapping[pattern_match.group(1)]
-            link_url = pattern_match.group(2)
+            link_type: str = link_type_mapping[pattern_match.group(1)]  # type: ignore
+            link_url: str = pattern_match.group(2)  # type: ignore
             link, created = Link.objects.get_or_create(url=link_url, link_type=link_type)
             row['Links'] += row['Links'] + f'|{link.url}'
 
-    def process_datasource(self, row):
+    def process_datasource(self, row) -> None:
         if row['Name']:
+            data_source: DataSource
+            created: bool
             data_source, created = DataSource.objects.get_or_create(
                 name=row['Name'],
                 defaults={
@@ -61,5 +69,5 @@ def process_datasource(self, row):
                     'source_license': row['License'],
                 }
             )
-            links = Link.objects.filter(url__in=row['Links'].split('|')).values_list('id', flat=True)
+            links: QuerySet[Link] = Link.objects.filter(url__in=row['Links'].split('|')).values_list('id', flat=True)
             data_source.links.add(*links)