fixup! Add type hints and mypy

linting

Author: mxmeinhold

packet/log_utils.py

@@ -10,9 +10,9 @@
 from packet.context_processors import get_rit_name
 from packet.utils import is_freshman_on_floor
 
-F = TypeVar('F', bound=Callable)
+WrappedFunc = TypeVar('WrappedFunc', bound=Callable)
 
-def log_time(func: F) -> F:
+def log_time(func: WrappedFunc) -> WrappedFunc:
     """
     Decorator for logging the execution time of a function
     """
@@ -27,7 +27,7 @@ def wrapped_function(*args: list, **kwargs: dict) -> Any:
 
         return result
 
-    return cast(F, wrapped_function)
+    return cast(WrappedFunc, wrapped_function)
 
 
 def _format_cache(func: Any) -> str:
@@ -43,7 +43,7 @@ def _format_cache(func: Any) -> str:
 _caches = (get_rit_name, ldap.get_member, is_freshman_on_floor)
 
 
-def log_cache(func: F) -> F:
+def log_cache(func: WrappedFunc) -> WrappedFunc:
     """
     Decorator for logging cache info
     """
@@ -56,4 +56,4 @@ def wrapped_function(*args: list, **kwargs: dict) -> Any:
 
         return result
 
-    return cast(F, wrapped_function)
+    return cast(WrappedFunc, wrapped_function)

packet/models.py

@@ -38,13 +38,13 @@ class Freshman(db.Model):
     rit_username = cast(str, Column(String(10), primary_key=True))
     name = cast(str, Column(String(64), nullable=False))
     onfloor = cast(bool, Column(Boolean, nullable=False))
-    fresh_signatures = cast(FreshSignature, relationship('FreshSignature'))
+    fresh_signatures = cast('FreshSignature', relationship('FreshSignature'))
 
     # One freshman can have multiple packets if they repeat the intro process
-    packets = cast(Packet, relationship('Packet', order_by='desc(Packet.id)'))
+    packets = cast('Packet', relationship('Packet', order_by='desc(Packet.id)'))
 
     @classmethod
-    def by_username(cls, username: str) -> Packet:
+    def by_username(cls, username: str) -> 'Packet':
         """
         Helper method to retrieve a freshman by their RIT username
         """
@@ -69,11 +69,12 @@ class Packet(db.Model):
 
     # The `lazy='subquery'` kwarg enables eager loading for signatures which makes signature calculations much faster
     # See the docs here for details: https://docs.sqlalchemy.org/en/latest/orm/loading_relationships.html
-    upper_signatures = cast(UpperSignature, relationship('UpperSignature', lazy='subquery',
+    upper_signatures = cast('UpperSignature', relationship('UpperSignature', lazy='subquery',
                                     order_by='UpperSignature.signed.desc(), UpperSignature.updated'))
-    fresh_signatures = cast(FreshSignature, relationship('FreshSignature', lazy='subquery',
+    fresh_signatures = cast('FreshSignature', relationship('FreshSignature', lazy='subquery',
                                     order_by='FreshSignature.signed.desc(), FreshSignature.updated'))
-    misc_signatures = cast(MiscSignature, relationship('MiscSignature', lazy='subquery', order_by='MiscSignature.updated'))
+    misc_signatures = cast('MiscSignature',
+            relationship('MiscSignature', lazy='subquery', order_by='MiscSignature.updated'))
 
     def is_open(self) -> bool:
         return self.start < datetime.now() < self.end

packet/notifications.py

@@ -1,7 +1,7 @@
 from datetime import datetime
 from typing import Any, Callable, TypeVar, cast
 
-import onesignal
+import onesignal_sdk as onesignal
 
 from packet import app, intro_onesignal_client, csh_onesignal_client
 from packet.models import NotificationSubscription, Packet
@@ -14,21 +14,21 @@
     'url': app.config['PROTOCOL'] + app.config['SERVER_NAME']
 }
 
-F = TypeVar('F', bound=Callable)
+WrappedFunc = TypeVar('WrappedFunc', bound=Callable)
 
-def require_onesignal_intro(func: F) -> F:
+def require_onesignal_intro(func: WrappedFunc) -> WrappedFunc:
     def require_onesignal_intro_wrapper(*args: list, **kwargs: dict) -> Any:
         if intro_onesignal_client:
             return func(*args, **kwargs)
         return None
-    return cast(F, require_onesignal_intro_wrapper)
+    return cast(WrappedFunc, require_onesignal_intro_wrapper)
 
-def require_onesignal_csh(func: F) -> F:
+def require_onesignal_csh(func: WrappedFunc) -> WrappedFunc:
     def require_onesignal_csh_wrapper(*args: list, **kwargs: dict) -> Any:
         if csh_onesignal_client:
             return func(*args, **kwargs)
         return None
-    return cast(F, require_onesignal_csh_wrapper)
+    return cast(WrappedFunc, require_onesignal_csh_wrapper)
 
 
 def send_notification(notification_body: dict, subscriptions: list, client: onesignal.Client) -> None:
@@ -60,7 +60,8 @@ def packet_signed_notification(packet: Packet, signer: str) -> None:
 @require_onesignal_intro
 def packet_100_percent_notification(packet: Packet) -> None:
     member_subscriptions = NotificationSubscription.query.filter(cast(Any, NotificationSubscription.member).isnot(None))
-    intro_subscriptions = NotificationSubscription.query.filter(cast(Any, NotificationSubscription.freshman_username).isnot(None))
+    intro_subscriptions = NotificationSubscription.query.filter(
+            cast(Any, NotificationSubscription.freshman_username).isnot(None))
     if member_subscriptions or intro_subscriptions:
         notification_body = post_body
         notification_body['contents']['en'] = packet.freshman.name + ' got 💯 on packet!'

packet/stats.py

@@ -1,4 +1,4 @@
-from datetime import date, timedelta
+from datetime import date as dateType, timedelta
 from typing import TypedDict, Union, cast, Callable
 
 from packet.models import Packet, MiscSignature, UpperSignature
@@ -23,10 +23,10 @@ class SimplePacket(TypedDict):
     freshman_username: str
 
 class SigDict(TypedDict):
-    date: date
+    date: dateType
     packet: SimplePacket
 
-Stats = dict[date, list[str]]
+Stats = dict[dateType, list[str]]
 
 
 def packet_stats(packet_id: int) -> PacketStats:

packet/utils.py

@@ -3,7 +3,7 @@
 """
 from datetime import datetime, time, timedelta, date
 from functools import wraps, lru_cache
-from typing import Any, Callable, TypeVar, cast, Union, Literal, TypedDict
+from typing import Any, Callable, TypeVar, cast
 
 import requests
 from flask import session, redirect
@@ -15,9 +15,9 @@
 
 INTRO_REALM = 'https://sso.csh.rit.edu/auth/realms/intro'
 
-F = TypeVar('F', bound=Callable)
+WrappedFunc = TypeVar('WrappedFunc', bound=Callable)
 
-def before_request(func: F) -> F:
+def before_request(func: WrappedFunc) -> WrappedFunc:
     """
     Credit to Liam Middlebrook and Ram Zallan
     https://github.com/liam-middlebrook/gallery
@@ -45,7 +45,7 @@ def wrapped_function(*args: list, **kwargs: dict) -> Any:
         kwargs['info'] = info
         return func(*args, **kwargs)
 
-    return cast(F, wrapped_function)
+    return cast(WrappedFunc, wrapped_function)
 
 
 @lru_cache(maxsize=128)
@@ -60,7 +60,7 @@ def is_freshman_on_floor(rit_username: str) -> bool:
         return False
 
 
-def packet_auth(func: F) -> F:
+def packet_auth(func: WrappedFunc) -> WrappedFunc:
     """
     Decorator for easily configuring oidc
     """
@@ -76,10 +76,10 @@ def wrapped_function(*args: list, **kwargs: dict) -> Any:
 
         return func(*args, **kwargs)
 
-    return cast(F, wrapped_function)
+    return cast(WrappedFunc, wrapped_function)
 
 
-def admin_auth(func: F) -> F:
+def admin_auth(func: WrappedFunc) -> WrappedFunc:
     """
     Decorator for easily configuring oidc
     """
@@ -98,7 +98,7 @@ def wrapped_function(*args: list, **kwargs: dict) -> Any:
 
         return func(*args, **kwargs)
 
-    return cast(F, wrapped_function)
+    return cast(WrappedFunc, wrapped_function)
 
 
 def notify_slack(name: str) -> None: