feat(backend): add typechecking with ty

.github/scripts/version_check.py

@@ -16,6 +16,7 @@
 import re
 import sys
 from pathlib import Path
+from typing import Optional
 
 import requests
 
@@ -48,7 +49,7 @@ def get_existing_release_tags(include_prerelease=True):
         tag = release['tag_name'].strip()
         match = re.match(r'^.*(\d+)\.(\d+)\.(\d+).*$', tag)
 
-        if len(match.groups()) != 3:
+        if not match or len(match.groups()) != 3:
             print(f"Version '{tag}' did not match expected pattern")
             continue
 
@@ -94,11 +95,12 @@ def check_version_number(version_string, allow_duplicate=False):
     return highest_release
 
 
-if __name__ == '__main__':
+def main() -> bool:
+    """Main function to check the version number."""
     # Ensure that we are running in GH Actions
     if os.environ.get('GITHUB_ACTIONS', '') != 'true':
         print('This script is intended to be run within a GitHub Action!')
-        sys.exit(1)
+        return False
 
     if 'only_version' in sys.argv:
         here = Path(__file__).parent.absolute()
@@ -111,7 +113,7 @@ def check_version_number(version_string, allow_duplicate=False):
         if len(sys.argv) > 2 and sys.argv[2] == 'true':
             results[0] = str(int(results[0]) - 1)
         print(results[0])
-        exit(0)
+        return True
 
     # GITHUB_REF_TYPE may be either 'branch' or 'tag'
     GITHUB_REF_TYPE = os.environ['GITHUB_REF_TYPE']
@@ -142,7 +144,7 @@ def check_version_number(version_string, allow_duplicate=False):
 
         if len(results) != 1:
             print(f'Could not find INVENTREE_SW_VERSION in {version_file}')
-            sys.exit(1)
+            return False
 
         version = results[0]
 
@@ -164,16 +166,16 @@ def check_version_number(version_string, allow_duplicate=False):
     highest_release = check_version_number(version, allow_duplicate=allow_duplicate)
 
     # Determine which docker tag we are going to use
-    docker_tags = None
+    docker_tags: Optional[list[str]] = None
 
     if GITHUB_REF_TYPE == 'tag':
         # GITHUB_REF should be of the form /refs/heads/<tag>
-        version_tag = GITHUB_REF.split('/')[-1]
+        version_tag: str = GITHUB_REF.split('/')[-1]
         print(f"Checking requirements for tagged release - '{version_tag}':")
 
         if version_tag != version:
             print(f"Version number '{version}' does not match tag '{version_tag}'")
-            sys.exit
+            return True
 
         docker_tags = [version_tag, 'stable'] if highest_release else [version_tag]
 
@@ -187,11 +189,11 @@ def check_version_number(version_string, allow_duplicate=False):
         print('GITHUB_REF_TYPE:', GITHUB_REF_TYPE)
         print('GITHUB_BASE_REF:', GITHUB_BASE_REF)
         print('GITHUB_REF:', GITHUB_REF)
-        sys.exit(1)
+        return False
 
     if docker_tags is None:
         print('Docker tags could not be determined')
-        sys.exit(1)
+        return False
 
     print(f"Version check passed for '{version}'!")
     print(f"Docker tags: '{docker_tags}'")
@@ -208,3 +210,11 @@ def check_version_number(version_string, allow_duplicate=False):
 
         if GITHUB_REF_TYPE == 'tag' and highest_release:
             env_file.write('stable_release=true\n')
+    return True
+
+
+if __name__ == '__main__':
+    rslt = main()
+    if rslt is not True:
+        print('Version check failed!')
+        sys.exit(1)

.github/workflows/qc_checks.yaml

@@ -97,6 +97,27 @@ jobs:
           pip install --require-hashes -r contrib/dev_reqs/requirements.txt
           python3 .github/scripts/version_check.py
 
+  typecheck:
+    name: Style [Typecheck]
+    runs-on: ubuntu-24.04
+    needs: [paths-filter, pre-commit]
+    if: needs.paths-filter.outputs.server == 'true' || needs.paths-filter.outputs.requirements == 'true' || needs.paths-filter.outputs.force == 'true'
+
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # pin@v4.2.2
+        with:
+          persist-credentials: false
+      - name: Environment Setup
+        id: setup
+        uses: ./.github/actions/setup
+        with:
+          apt-dependency: gettext poppler-utils
+          dev-install: true
+          update: true
+      - name: Check types
+        run: |
+          ty check --python ${Python_ROOT_DIR}/bin/python3
+
   mkdocs:
     name: Style [Documentation]
     runs-on: ubuntu-24.04

docs/docs/hooks.py

@@ -4,7 +4,7 @@
 import os
 import re
 from datetime import datetime
-from distutils.version import StrictVersion
+from distutils.version import StrictVersion  # type: ignore[import]
 from pathlib import Path
 
 import requests

docs/main.py

@@ -110,7 +110,7 @@ def check_link(url) -> bool:
     return False
 
 
-def get_build_environment() -> str:
+def get_build_environment() -> Optional[str]:
     """Returns the branch we are currently building on, based on the environment variables of the various CI platforms."""
     # Check if we are in ReadTheDocs
     if os.environ.get('READTHEDOCS') == 'True':

pyproject.toml

@@ -101,6 +101,21 @@ python-version = "3.9.2"
 no-strip-extras=true
 generate-hashes=true
 
+[tool.ty]
+src = [
+    "src/backend/InvenTree",
+    "./",
+]
+[tool.ty.rules]
+unresolved-reference="ignore"  # 24 # see https://github.com/astral-sh/ty/issues/220
+unresolved-attribute="ignore"  # 33 # need Plugin Mixin typing
+call-non-callable="ignore"  # 3 ##
+invalid-return-type="ignore"  # 12 ##
+invalid-argument-type="ignore"  # 15
+possibly-unbound-attribute="ignore"  # 7
+unknown-argument="ignore"  # 9  # need to wait for betterdjango field stubs
+
+
 [tool.coverage.run]
 source = ["src/backend/InvenTree", "InvenTree"]
 dynamic_context = "test_function"

src/backend/InvenTree/InvenTree/api.py

@@ -17,6 +17,7 @@
 from rest_framework.serializers import ValidationError
 from rest_framework.views import APIView
 
+import InvenTree.permissions
 import InvenTree.version
 from common.settings import get_global_setting
 from InvenTree import helpers

src/backend/InvenTree/InvenTree/apps.py

@@ -134,6 +134,9 @@ def start_background_tasks(self):
         tasks = InvenTree.tasks.tasks.task_list
 
         for task in tasks:
+            if not task:
+                continue  # pragma: no cover
+
             ref_name = f'{task.func.__module__}.{task.func.__name__}'
 
             if ref_name in existing_tasks:

src/backend/InvenTree/InvenTree/cache.py

@@ -2,6 +2,7 @@
 
 import socket
 import threading
+from typing import Any
 
 import structlog
 
@@ -127,7 +128,7 @@ def delete_session_cache() -> None:
         del thread_data.request_cache
 
 
-def get_session_cache(key: str) -> any:
+def get_session_cache(key: str) -> Any:
     """Return a cached value from the session cache."""
     # Only return a cached value if the request object is available too
     if not hasattr(thread_data, 'request'):
@@ -139,7 +140,7 @@ def get_session_cache(key: str) -> any:
         return val
 
 
-def set_session_cache(key: str, value: any) -> None:
+def set_session_cache(key: str, value: Any) -> None:
     """Set a cached value in the session cache."""
     # Only set a cached value if the request object is available too
     if not hasattr(thread_data, 'request'):

src/backend/InvenTree/InvenTree/config.py

@@ -8,6 +8,7 @@
 import shutil
 import string
 from pathlib import Path
+from typing import Union
 
 logger = logging.getLogger('inventree')
 CONFIG_DATA = None
@@ -113,7 +114,7 @@ def get_config_file(create=True) -> Path:
     return cfg_filename
 
 
-def load_config_data(set_cache: bool = False) -> map:
+def load_config_data(set_cache: bool = False) -> Union[map, None]:
     """Load configuration data from the config file.
 
     Arguments:

src/backend/InvenTree/InvenTree/conversion.py

@@ -191,7 +191,7 @@ def convert_physical_value(value: str, unit: Optional[str] = None, strip_units=T
         attempts.append(f'{value}{unit}')
         attempts.append(f'{eng}{unit}')
 
-    value = None
+    value: Optional[str] = None
 
     # Run through the available "attempts", take the first successful result
     for attempt in attempts:

src/backend/InvenTree/InvenTree/exceptions.py

@@ -50,7 +50,8 @@ def log_error(path, error_name=None, error_info=None, error_data=None):
         data = error_data
     else:
         try:
-            data = '\n'.join(traceback.format_exception(kind, info, data))
+            formatted_exception = traceback.format_exception(kind, info, data)  # type: ignore[no-matching-overload]
+            data = '\n'.join(formatted_exception)
         except AttributeError:
             data = 'No traceback information available'
 

src/backend/InvenTree/InvenTree/filters.py

@@ -6,7 +6,8 @@
 from django.utils import timezone
 from django.utils.timezone import make_aware
 
-from django_filters import rest_framework as rest_filters
+import django_filters.rest_framework.backends as drf_backend
+import django_filters.rest_framework.filters as rest_filters
 from rest_framework import filters
 
 import InvenTree.helpers
@@ -20,7 +21,7 @@ def filter(self, qs, value):
         if settings.USE_TZ and value is not None:
             tz = timezone.get_current_timezone()
             value = datetime(value.year, value.month, value.day)
-            value = make_aware(value, tz, True)
+            value = make_aware(value, timezone=tz, is_dst=True)
 
         return super().filter(qs, value)
 
@@ -160,17 +161,17 @@ def get_ordering(self, request, queryset, view):
 
 
 SEARCH_ORDER_FILTER = [
-    rest_filters.DjangoFilterBackend,
+    drf_backend.DjangoFilterBackend,
     InvenTreeSearchFilter,
     filters.OrderingFilter,
 ]
 
 SEARCH_ORDER_FILTER_ALIAS = [
-    rest_filters.DjangoFilterBackend,
+    drf_backend.DjangoFilterBackend,
     InvenTreeSearchFilter,
     InvenTreeOrderingFilter,
 ]
 
-ORDER_FILTER = [rest_filters.DjangoFilterBackend, filters.OrderingFilter]
+ORDER_FILTER = [drf_backend.DjangoFilterBackend, filters.OrderingFilter]
 
-ORDER_FILTER_ALIAS = [rest_filters.DjangoFilterBackend, InvenTreeOrderingFilter]
+ORDER_FILTER_ALIAS = [drf_backend.DjangoFilterBackend, InvenTreeOrderingFilter]

src/backend/InvenTree/InvenTree/format.py

@@ -107,7 +107,7 @@ def construct_format_regex(fmt_string: str) -> str:
         # Add a named capture group for the format entry
         if name:
             # Check if integer values are required
-            c = '\\d' if _fmt.endswith('d') else '.'
+            c = '\\d' if _fmt and _fmt.endswith('d') else '.'
 
             # Specify width
             # TODO: Introspect required width
@@ -124,7 +124,7 @@ def construct_format_regex(fmt_string: str) -> str:
     return pattern
 
 
-def validate_string(value: str, fmt_string: str) -> str:
+def validate_string(value: str, fmt_string: str) -> bool:
     """Validate that the provided string matches the specified format.
 
     Args:

src/backend/InvenTree/InvenTree/helpers.py

@@ -8,7 +8,7 @@
 import os.path
 import re
 from decimal import Decimal, InvalidOperation
-from typing import Optional, TypeVar
+from typing import Optional, TypeVar, Union
 from wsgiref.util import FileWrapper
 from zoneinfo import ZoneInfo, ZoneInfoNotFoundError
 
@@ -21,6 +21,8 @@
 from django.utils.translation import gettext_lazy as _
 
 import bleach
+import bleach.css_sanitizer
+import bleach.sanitizer
 import structlog
 from bleach import clean
 from djmoney.money import Money
@@ -123,7 +125,7 @@ def do_clip(value: int, clip: int, allow_negative: bool) -> int:
     return ref_int
 
 
-def generateTestKey(test_name: str) -> str:
+def generateTestKey(test_name: Union[str, None]) -> str:
     """Generate a test 'key' for a given test name. This must not have illegal chars as it will be used for dict lookup in a template.
 
     Tests must be named such that they will have unique keys.
@@ -362,9 +364,7 @@ def increment(value):
     except ValueError:
         pass
 
-    number = number.zfill(width)
-
-    return prefix + number
+    return prefix + str(number).zfill(width)
 
 
 def decimal2string(d):
@@ -949,7 +949,7 @@ def current_time(local=True):
     """
     if settings.USE_TZ:
         now = timezone.now()
-        now = to_local_time(now, target_tz=server_timezone() if local else 'UTC')
+        now = to_local_time(now, target_tz_str=server_timezone() if local else 'UTC')
         return now
     else:
         return datetime.datetime.now()
@@ -968,12 +968,12 @@ def server_timezone() -> str:
     return settings.TIME_ZONE
 
 
-def to_local_time(time, target_tz: Optional[str] = None):
+def to_local_time(time, target_tz_str: Optional[str] = None):
     """Convert the provided time object to the local timezone.
 
     Arguments:
         time: The time / date to convert
-        target_tz: The desired timezone (string) - defaults to server time
+        target_tz_str: The desired timezone (string) - defaults to server time
 
     Returns:
         A timezone aware datetime object, with the desired timezone
@@ -997,11 +997,11 @@ def to_local_time(time, target_tz: Optional[str] = None):
         # Default to UTC if not provided
         source_tz = ZoneInfo('UTC')
 
-    if not target_tz:
-        target_tz = server_timezone()
+    if not target_tz_str:
+        target_tz_str = server_timezone()
 
     try:
-        target_tz = ZoneInfo(str(target_tz))
+        target_tz = ZoneInfo(str(target_tz_str))
     except ZoneInfoNotFoundError:
         target_tz = ZoneInfo('UTC')
 

src/backend/InvenTree/InvenTree/helpers_email.py

@@ -1,5 +1,7 @@
 """Code for managing email functionality in InvenTree."""
 
+from typing import Optional
+
 from django.conf import settings
 from django.core import mail as django_mail
 
@@ -91,7 +93,7 @@ def send_email(subject, body, recipients, from_email=None, html_message=None):
     )
 
 
-def get_email_for_user(user) -> str:
+def get_email_for_user(user) -> Optional[str]:
     """Find an email address for the specified user."""
     # First check if the user has an associated email address
     if user.email: