Adding Type annotations

.pre-commit-config.yaml

@@ -37,6 +37,17 @@ repos:
           - --sequence=4
         exclude: (.github|pnpm-lock.yaml)
 
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.15.0
+    hooks:
+      - id: mypy
+        args:
+          - --exclude
+          - backend/tests
+          - --explicit-package-bases
+          - --config-file
+          - backend/pyproject.toml
+
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v5.0.0
     hooks:

backend/apps/common/geocoding.py

@@ -3,11 +3,12 @@
 import time
 
 from geopy.geocoders import Nominatim
+from geopy.location import Location
 
 from apps.common.utils import get_nest_user_agent
 
 
-def get_location_coordinates(query, delay=2):
+def get_location_coordinates(query: str, delay: int = 2) -> Location:
     """Get location geo coordinates.
 
     Args:

backend/apps/common/index.py

@@ -1,5 +1,7 @@
 """Algolia index common classes and helpers."""
 
+from __future__ import annotations
+
 import logging
 from functools import lru_cache
 from pathlib import Path
@@ -13,7 +15,7 @@
 
 from apps.common.constants import NL
 
-logger = logging.getLogger(__name__)
+logger: logging.Logger = logging.getLogger(__name__)
 
 EXCLUDED_LOCAL_INDEX_NAMES = (
     "projects_contributors_count_asc",
@@ -36,19 +38,19 @@ class IndexRegistry:
 
     _instance = None
 
-    def __init__(self):
+    def __init__(self) -> None:
         """Initialize index registry."""
         self.excluded_local_index_names = set()
         self.load_excluded_local_index_names()
 
     @classmethod
-    def get_instance(cls):
+    def get_instance(cls) -> IndexRegistry:
         """Get or create a singleton instance of IndexRegistry."""
         if cls._instance is None:
             cls._instance = IndexRegistry()
         return cls._instance
 
-    def is_indexable(self, name: str):
+    def is_indexable(self, name: str) -> bool:
         """Check if an index is enabled for indexing.
 
         Args:
@@ -60,7 +62,7 @@ def is_indexable(self, name: str):
         """
         return name.lower() not in self.excluded_local_index_names if IS_LOCAL_BUILD else True
 
-    def load_excluded_local_index_names(self):
+    def load_excluded_local_index_names(self) -> IndexRegistry:
         """Load excluded local index names from settings.
 
         Returns
@@ -81,7 +83,7 @@ def load_excluded_local_index_names(self):
         return self
 
 
-def is_indexable(index_name: str):
+def is_indexable(index_name: str) -> bool:
     """Determine if an index should be created based on configuration.
 
     Args:
@@ -120,7 +122,7 @@ class IndexBase(AlgoliaIndex):
     """Base index class."""
 
     @staticmethod
-    def get_client(ip_address=None):
+    def get_client(ip_address=None) -> SearchClientSync:
         """Return an instance of the search client.
 
         Args:
@@ -140,7 +142,7 @@ def get_client(ip_address=None):
         return SearchClientSync(config=config)
 
     @staticmethod
-    def configure_replicas(index_name: str, replicas: dict):
+    def configure_replicas(index_name: str, replicas: dict) -> None:
         """Configure replicas for an index.
 
         Args:
@@ -168,7 +170,7 @@ def configure_replicas(index_name: str, replicas: dict):
                 client.set_settings(replica_name, {"ranking": replica_ranking})
 
     @staticmethod
-    def _parse_synonyms_file(file_path):
+    def _parse_synonyms_file(file_path) -> list | None:
         """Parse a synonyms file and return its content.
 
         Args:
@@ -214,7 +216,7 @@ def _parse_synonyms_file(file_path):
         return synonyms
 
     @staticmethod
-    def reindex_synonyms(app_name, index_name):
+    def reindex_synonyms(app_name: str, index_name: str) -> int | None:
         """Reindex synonyms for a specific index.
 
         Args:
@@ -246,7 +248,7 @@ def reindex_synonyms(app_name, index_name):
 
     @staticmethod
     @lru_cache(maxsize=1024)
-    def get_total_count(index_name, search_filters=None):
+    def get_total_count(index_name: str, search_filters=None) -> int | None:
         """Get the total count of records in an index.
 
         Args:

backend/apps/common/management/commands/algolia_update_replicas.py

@@ -8,7 +8,7 @@
 class Command(BaseCommand):
     help = "Update OWASP Nest index replicas."
 
-    def handle(self, *_args, **_options):
+    def handle(self, *_args, **_options) -> None:
         """Update replicas for Algolia indices.
 
         Args:

backend/apps/common/management/commands/algolia_update_synonyms.py

@@ -9,7 +9,7 @@
 class Command(BaseCommand):
     help = "Update OWASP Nest index synonyms."
 
-    def handle(self, *_args, **_options):
+    def handle(self, *_args, **_options) -> None:
         """Update synonyms for Algolia indices.
 
         Args:

backend/apps/common/management/commands/generate_sitemap.py

@@ -28,7 +28,7 @@ class Command(BaseCommand):
         ],
     }
 
-    def add_arguments(self, parser):
+    def add_arguments(self, parser) -> None:
         """Add command-line arguments to the parser.
 
         Args:
@@ -41,7 +41,7 @@ def add_arguments(self, parser):
             help="Directory where sitemap files will be saved",
         )
 
-    def handle(self, *args, **options):
+    def handle(self, *args, **options) -> None:
         """Generate sitemaps for the OWASP Nest application.
 
         Args:
@@ -70,7 +70,7 @@ def handle(self, *args, **options):
 
         self.stdout.write(self.style.SUCCESS(f"Successfully generated sitemaps in {output_dir}"))
 
-    def generate_project_sitemap(self, output_dir):
+    def generate_project_sitemap(self, output_dir: Path) -> None:
         """Generate a sitemap for projects.
 
         Args:
@@ -91,7 +91,7 @@ def generate_project_sitemap(self, output_dir):
         content = self.generate_sitemap_content(routes)
         self.save_sitemap(content, output_dir / "sitemap-project.xml")
 
-    def generate_chapter_sitemap(self, output_dir):
+    def generate_chapter_sitemap(self, output_dir: Path) -> None:
         """Generate a sitemap for chapters.
 
         Args:
@@ -112,7 +112,7 @@ def generate_chapter_sitemap(self, output_dir):
         content = self.generate_sitemap_content(routes)
         self.save_sitemap(content, output_dir / "sitemap-chapters.xml")
 
-    def generate_committee_sitemap(self, output_dir):
+    def generate_committee_sitemap(self, output_dir: Path) -> None:
         """Generate a sitemap for committees.
 
         Args:
@@ -136,7 +136,7 @@ def generate_committee_sitemap(self, output_dir):
         content = self.generate_sitemap_content(routes)
         self.save_sitemap(content, output_dir / "sitemap-committees.xml")
 
-    def generate_user_sitemap(self, output_dir):
+    def generate_user_sitemap(self, output_dir: Path) -> None:
         """Generate a sitemap for users.
 
         Args:
@@ -185,7 +185,7 @@ def generate_sitemap_content(self, routes):
 
         return self.create_sitemap(urls)
 
-    def generate_index_sitemap(self, sitemap_files):
+    def generate_index_sitemap(self, sitemap_files: list) -> str:
         """Generate the sitemap index file.
 
         Args:
@@ -204,7 +204,7 @@ def generate_index_sitemap(self, sitemap_files):
 
         return self.create_sitemap_index(sitemaps)
 
-    def create_url_entry(self, url_data):
+    def create_url_entry(self, url_data: dict) -> str:
         """Create a URL entry for the sitemap.
 
         Args:
@@ -223,7 +223,7 @@ def create_url_entry(self, url_data):
             "  </url>"
         ).format(**url_data)
 
-    def create_sitemap_index_entry(self, sitemap_data):
+    def create_sitemap_index_entry(self, sitemap_data: dict) -> str:
         """Create a sitemap index entry.
 
         Args:
@@ -237,7 +237,7 @@ def create_sitemap_index_entry(self, sitemap_data):
             "  <sitemap>\n    <loc>{loc}</loc>\n    <lastmod>{lastmod}</lastmod>\n  </sitemap>"
         ).format(**sitemap_data)
 
-    def create_sitemap(self, urls):
+    def create_sitemap(self, urls: list) -> str:
         """Create the complete sitemap XML.
 
         Args:
@@ -254,7 +254,7 @@ def create_sitemap(self, urls):
             "</urlset>"
         )
 
-    def create_sitemap_index(self, sitemaps):
+    def create_sitemap_index(self, sitemaps: list) -> str:
         """Create the complete sitemap index XML.
 
         Args:
@@ -272,7 +272,7 @@ def create_sitemap_index(self, sitemaps):
         )
 
     @staticmethod
-    def save_sitemap(content, filepath):
+    def save_sitemap(content: str, filepath: Path) -> None:
         """Save the sitemap content to a file.
 
         Args:

backend/apps/common/management/commands/load_data.py

@@ -10,7 +10,7 @@
 class Command(BaseCommand):
     help = "Load OWASP Nest data."
 
-    def handle(self, *_args, **_options):
+    def handle(self, *_args, **_options) -> None:
         """Load data into the OWASP Nest application.
 
         Args:

backend/apps/common/management/commands/purge_data.py

@@ -8,7 +8,7 @@
 class Command(BaseCommand):
     help = "Purge OWASP Nest data."
 
-    def handle(self, *_args, **options):
+    def handle(self, *_args, **options) -> None:
         """Purge data from specified OWASP Nest applications.
 
         Args:

backend/apps/common/models.py

@@ -12,7 +12,7 @@ class Meta:
         abstract = True
 
     @staticmethod
-    def bulk_save(model, objects, fields=None):
+    def bulk_save(model, objects, fields=None) -> None:
         """Bulk save objects.
 
         Args:

backend/apps/common/open_ai.py

@@ -1,17 +1,21 @@
 """Open AI API module."""
 
+from __future__ import annotations
+
 import logging
 
 import openai
 from django.conf import settings
 
-logger = logging.getLogger(__name__)
+logger: logging.Logger = logging.getLogger(__name__)
 
 
 class OpenAi:
     """Open AI communication class."""
 
-    def __init__(self, model="gpt-4o-mini", max_tokens=1000, temperature=0.7):
+    def __init__(
+        self, model: str = "gpt-4o-mini", max_tokens: int = 1000, temperature: float = 0.7
+    ) -> None:
         """OpenAi constructor.
 
         Args:
@@ -29,7 +33,7 @@ def __init__(self, model="gpt-4o-mini", max_tokens=1000, temperature=0.7):
         self.model = model
         self.temperature = temperature
 
-    def set_input(self, content):
+    def set_input(self, content: str) -> OpenAi:
         """Set system role content.
 
         Args:
@@ -43,7 +47,7 @@ def set_input(self, content):
 
         return self
 
-    def set_max_tokens(self, max_tokens):
+    def set_max_tokens(self, max_tokens: int) -> OpenAi:
         """Set max tokens.
 
         Args:
@@ -57,7 +61,7 @@ def set_max_tokens(self, max_tokens):
 
         return self
 
-    def set_prompt(self, content):
+    def set_prompt(self, content: str) -> OpenAi:
         """Set system role content.
 
         Args:
@@ -71,7 +75,7 @@ def set_prompt(self, content):
 
         return self
 
-    def complete(self):
+    def complete(self) -> str | None:
         """Get API response.
 
         Returns
@@ -98,3 +102,4 @@ def complete(self):
             logger.exception("A connection error occurred during OpenAI API request.")
         except Exception:
             logger.exception("An error occurred during OpenAI API request.")
+        return None