Add type hints to dummy instance creation methods
authorMitja Nikolaus <mitja@fairphone.com>
Thu, 6 Dec 2018 10:33:17 +0000 (11:33 +0100)
committerFranz-Xaver Geiger <franz@fairphone.com>
Fri, 7 Dec 2018 16:08:21 +0000 (16:08 +0000)
Issue: HIC-287
Change-Id: I1bd10c6aee50fc309d0d39d7b118a6dc76812aa9

crashreport_stats/tests/utils.py
crashreports/tests/utils.py

index 8e22acd..78ecf32 100644 (file)
@@ -1,6 +1,7 @@
 """Utility functions shared by all crashreport stats tests."""
 
 from datetime import datetime
+from typing import Any, Union, Type
 
 import pytz
 from django.contrib.auth.models import Group
@@ -47,7 +48,10 @@ class Dummy(CrashreportsDummy):
     }
 
     @staticmethod
-    def create_version(version_type=Version, **kwargs):
+    def create_version(
+        version_type: Type[Union[Version, RadioVersion]] = Version,
+        **kwargs: Any
+    ) -> Union[Version, RadioVersion]:
         """Create a dummy version instance.
 
         The dummy instance is created and saved to the database.
@@ -80,7 +84,7 @@ class Dummy(CrashreportsDummy):
         return entity
 
     @staticmethod
-    def create_daily_version(version, **kwargs):
+    def create_daily_version(version: Version, **kwargs: Any) -> VersionDaily:
         """Create a dummy daily version instance.
 
         The dummy instance is created and saved to the database.
@@ -99,7 +103,9 @@ class Dummy(CrashreportsDummy):
         return entity
 
     @staticmethod
-    def create_daily_radio_version(version, **kwargs):
+    def create_daily_radio_version(
+        version: RadioVersion, **kwargs: Any
+    ) -> RadioVersionDaily:
         """Create a dummy daily radio version instance.
 
         The dummy instance is created and saved to the database.
@@ -120,7 +126,7 @@ class Dummy(CrashreportsDummy):
         return entity
 
     @staticmethod
-    def create_stats_metadata(**kwargs):
+    def create_stats_metadata(**kwargs: Any) -> StatsMetadata:
         """Create a dummy stats metadata instance.
 
         The dummy instance is created and saved to the database.
index 8f71cad..66a3be0 100644 (file)
@@ -5,7 +5,7 @@ import shutil
 import threading
 import zipfile
 from datetime import date, datetime
-from typing import Optional
+from typing import Optional, Dict, Type, Union, Tuple, Any
 
 import pytz
 from django.conf import settings
@@ -157,14 +157,16 @@ class Dummy:
     ]
 
     @staticmethod
-    def _update_copy(original, update):
+    def _update_copy(
+        original: Dict[str, Any], update: Dict[str, Any]
+    ) -> Dict[str, Any]:
         """Merge fields of update into a copy of original."""
         data = original.copy()
         data.update(update)
         return data
 
     @staticmethod
-    def device_register_data(**kwargs):
+    def device_register_data(**kwargs: Any) -> Dict[str, Any]:
         """Return the data required to register a device.
 
         Use the values passed as keyword arguments or default to the ones
@@ -173,7 +175,7 @@ class Dummy:
         return Dummy._update_copy(Dummy.DEFAULT_DEVICE_REGISTER_VALUES, kwargs)
 
     @staticmethod
-    def heartbeat_data(**kwargs):
+    def heartbeat_data(**kwargs: Any) -> Dict[str, Any]:
         """Return the data required to create a heartbeat.
 
         Use the values passed as keyword arguments or default to the ones
@@ -182,7 +184,7 @@ class Dummy:
         return Dummy._update_copy(Dummy.DEFAULT_HEARTBEAT_VALUES, kwargs)
 
     @staticmethod
-    def alternative_heartbeat_data(**kwargs):
+    def alternative_heartbeat_data(**kwargs: Any) -> Dict[str, Any]:
         """Return the alternative data required to create a heartbeat.
 
         Use the values passed as keyword arguments or default to the ones
@@ -191,7 +193,9 @@ class Dummy:
         return Dummy._update_copy(Dummy.ALTERNATIVE_HEARTBEAT_VALUES, kwargs)
 
     @staticmethod
-    def crashreport_data(report_type: Optional[str] = None, **kwargs):
+    def crashreport_data(
+        report_type: Optional[str] = None, **kwargs: Any
+    ) -> Dict[str, Any]:
         """Return the data required to create a crashreport.
 
         Use the values passed as keyword arguments or default to the ones
@@ -213,7 +217,7 @@ class Dummy:
         return data
 
     @staticmethod
-    def alternative_crashreport_data(**kwargs):
+    def alternative_crashreport_data(**kwargs: Any) -> Dict[str, Any]:
         """Return the alternative data required to create a crashreport.
 
         Use the values passed as keyword arguments or default to the ones
@@ -222,7 +226,7 @@ class Dummy:
         return Dummy._update_copy(Dummy.ALTERNATIVE_CRASHREPORT_VALUES, kwargs)
 
     @staticmethod
-    def create_user(**kwargs):
+    def create_user(**kwargs: Any) -> User:
         """Create a dummy user instance.
 
         The dummy instance is created and saved to the database.
@@ -238,7 +242,7 @@ class Dummy:
         return entity
 
     @staticmethod
-    def create_device(user, **kwargs):
+    def create_device(user: User, **kwargs: Any) -> Device:
         """Create a dummy device instance.
 
         The dummy instance is created and saved to the database.
@@ -257,7 +261,11 @@ class Dummy:
         return entity
 
     @staticmethod
-    def create_report(report_type, device, **kwargs):
+    def create_report(
+        report_type: Type[Union[HeartBeat, Crashreport]],
+        device: Device,
+        **kwargs: Any
+    ) -> Union[HeartBeat, Crashreport]:
         """Create a dummy report instance of the given report class type.
 
         The dummy instance is created and saved to the database.
@@ -293,7 +301,7 @@ class Dummy:
         return entity
 
     @staticmethod
-    def create_log_file(crashreport, **kwargs):
+    def create_log_file(crashreport: Crashreport, **kwargs: Any) -> LogFile:
         """Create a dummy log file instance.
 
         The dummy instance is created and saved to the database.
@@ -314,7 +322,9 @@ class Dummy:
         return entity
 
     @staticmethod
-    def create_log_file_with_actual_file(crashreport, **kwargs):
+    def create_log_file_with_actual_file(
+        crashreport: Crashreport, **kwargs: Any
+    ) -> Tuple[LogFile, str]:
         """Create a dummy log file instance along with a file.
 
         The dummy instance is created and saved to the database. The log file