Python 3 style type hinting

src/tixlbase/cache.py

@@ -3,6 +3,8 @@ import hashlib
 
 from django.core.cache import caches
 
+from tixlbase.models import Event
+
 
 class EventRelatedCache:
     """
@@ -17,12 +19,12 @@ class EventRelatedCache:
     instantiate it as many times as you want.
     """
 
-    def __init__(self, event, cache='default'):
+    def __init__(self, event: Event, cache: str='default'):
         self.cache = caches[cache]
         self.event = event
         self.prefixkey = 'event:%d' % self.event.pk
 
-    def _prefix_key(self, original_key):
+    def _prefix_key(self, original_key: str) -> str:
         # Race conditions can happen here, but should be very very rare.
         # We could only handle this by going _really_ lowlevel using
         # memcached's `add` keyword instead of `set`.
@@ -39,7 +41,7 @@ class EventRelatedCache:
         return key
 
     @staticmethod
-    def _strip_prefix(key):
+    def _strip_prefix(key: str) -> str:
         return key.split(":", 3)[-1] if 'event:' in key else key
 
     def clear(self):
@@ -49,35 +51,35 @@ class EventRelatedCache:
             prefix = int(time.time())
             self.cache.set(self.prefixkey, prefix)
 
-    def set(self, key, value, timeout=3600):
+    def set(self, key: str, value: str, timeout: int=3600):
         return self.cache.set(self._prefix_key(key), value, timeout)
 
-    def get(self, key):
+    def get(self, key: str) -> str:
         return self.cache.get(self._prefix_key(key))
 
-    def get_many(self, keys):
+    def get_many(self, keys: "list[str]") -> "dict[str, str]":
         values = self.cache.get_many([self._prefix_key(key) for key in keys])
         newvalues = {}
         for k, v in values.items():
             newvalues[self._strip_prefix(k)] = v
         return newvalues
 
-    def set_many(self, values, timeout=3600):
+    def set_many(self, values: "dict[str, str]", timeout=3600):
         newvalues = {}
         for k, v in values.items():
             newvalues[self._prefix_key(k)] = v
         return self.cache.set_many(newvalues, timeout)
 
-    def delete(self, key):  # NOQA
+    def delete(self, key: str):  # NOQA
         return self.cache.delete(self._prefix_key(key))
 
-    def delete_many(self, keys):  # NOQA
+    def delete_many(self, keys: "list[str]"):  # NOQA
         return self.cache.delete_many([self._prefix_key(key) for key in keys])
 
-    def incr(self, key, by=1):  # NOQA
+    def incr(self, key: str, by: int=1):  # NOQA
         return self.cache.incr(self._prefix_key(key), by)
 
-    def decr(self, key, by=1):  # NOQA
+    def decr(self, key: str, by: int=1):  # NOQA
         return self.cache.decr(self._prefix_key(key), by)
 
     def close(self):  # NOQA

src/tixlbase/middleware.py

@@ -62,7 +62,7 @@ class LocaleMiddleware(BaseLocaleMiddleware):
         return response
 
 
-def get_language_from_request(request):
+def get_language_from_request(request) -> str:
     """
     Analyzes the request to find what language the user wants the system to
     show. Only languages listed in settings.LANGUAGES are taken into account.

src/tixlbase/models.py

@@ -119,7 +119,7 @@ class User(AbstractBaseUser, PermissionsMixin):
             self.identifier = self.identifier.lower()
         super().save(*args, **kwargs)
 
-    def get_short_name(self):
+    def get_short_name(self) -> str:
         if self.givenname:
             return self.givenname
         elif self.familyname:
@@ -127,7 +127,7 @@ class User(AbstractBaseUser, PermissionsMixin):
         else:
             return self.username
 
-    def get_full_name(self):
+    def get_full_name(self) -> str:
         if self.givenname and not self.familyname:
             return self.givenname
         elif not self.givenname and self.familyname:
@@ -295,18 +295,18 @@ class Event(models.Model):
         self.get_cache().clear()
         return obj
 
-    def get_plugins(self):
+    def get_plugins(self) -> "list[str]":
         if self.plugins is None:
             return []
         return self.plugins.split(",")
 
-    def get_date_from_display(self):
+    def get_date_from_display(self) -> str:
         return _date(
             self.date_from,
             "DATETIME_FORMAT" if self.show_times else "DATE_FORMAT"
         )
 
-    def get_date_to_display(self):
+    def get_date_to_display(self) -> str:
         if not self.show_date_to:
             return ""
         return _date(
@@ -314,7 +314,7 @@ class Event(models.Model):
             "DATETIME_FORMAT" if self.show_times else "DATE_FORMAT"
         )
 
-    def get_cache(self):
+    def get_cache(self) -> "tixlbase.cache.EventRelatedCache":
         from tixlbase.cache import EventRelatedCache
         return EventRelatedCache(self)
 
@@ -579,7 +579,7 @@ class Item(models.Model):
         self.active = False
         return super().save()
 
-    def get_all_variations(self, use_cache=False):
+    def get_all_variations(self, use_cache: bool=False) -> "list[VariationDict]":
         """
         This method returns a list containing all variations of this
         item. The list contains one VariationDict per variation, where

src/tixlbase/plugins.py

@@ -10,7 +10,7 @@ class PluginType(Enum):
     RESTRICTION = 1
 
 
-def get_all_plugins():
+def get_all_plugins() -> "class":
     plugins = []
     for app in apps.get_app_configs():
         if hasattr(app, 'TixlPluginMeta'):

src/tixlbase/tests/__init__.py

@@ -8,7 +8,7 @@ RUN_LOCAL = ('SAUCE_USERNAME' not in os.environ)
 
 if RUN_LOCAL:
     # could add Chrome, PhantomJS etc... here
-    BROWSERS = ['Chrome']
+    BROWSERS = ['Chrome', 'Firefox']
 else:
     from sauceclient import SauceClient
     USERNAME = os.environ.get('SAUCE_USERNAME')

src/tixlbase/types.py

@@ -6,7 +6,7 @@ class VariationDict(dict):
     code calling this method.
     """
 
-    def relevant_items(self):
+    def relevant_items(self) -> "list[(int, PropertyValue)]":
         """
         Iterate over all items with numeric keys.
 
@@ -17,7 +17,7 @@ class VariationDict(dict):
             if type(i[0]) is int:
                 yield i
 
-    def relevant_values(self):
+    def relevant_values(self) -> "list[PropertyValue]":
         """
         Iterate over all values with numeric keys.
 
@@ -28,7 +28,7 @@ class VariationDict(dict):
             if type(i[0]) is int:
                 yield i[1]
 
-    def identify(self):
+    def identify(self) -> str:
         """
         Build a simple and unique identifier for this dict. This can be any string
         used to compare one VariationDict to others.
@@ -42,7 +42,7 @@ class VariationDict(dict):
             str(v[1].pk) for v in sorted(self.relevant_items(), key=order_key)
         ))
 
-    def key(self):
+    def key(self) -> str:
         """
         Build an identifier for this dict which exactly specifies the combination
         for this variation without any doubt. This can be used to "talk" about a
@@ -62,7 +62,7 @@ class VariationDict(dict):
         else:
             return super().__eq__(other)
 
-    def ordered_values(self):
+    def ordered_values(self) -> "list[ItemVariation]":
         """
         Returns a list of values ordered by their keys
         """
@@ -74,7 +74,7 @@ class VariationDict(dict):
             )
         ]
 
-    def copy(self):
+    def copy(self) -> "VariationDict":
         """
         Return a one-level deep copy of this object (create a new
         VariationDict but make a shallow copy of the dict inside it).