Change: add typehint for api/auth, app, scripts{apply_ramdom, draw}

Author: Cj-bc

api/auth.py

@@ -6,6 +6,10 @@
 import json
 from api.time_management import get_current_datetime
 from api.error import error_response
+# typehints imports {{{
+from typehint import Optional, Tuple, Callable, Dict
+from flask import Response
+# }}}
 
 
 class UserNotFoundError(Exception):
@@ -55,18 +59,17 @@ def decrypt_token(token: str) -> dict:
     return json.loads(decrypted.decode())
 
 
-# TODO: is this returns anything?
-def login_required(*required_authority: str):
+def login_required(*required_authority: str) -> Callable:
     """
         a decorder to require login
         Args:
             *required_authority (str): required authorities
                 if this is blank, no requirement of authority
     """
-    def login_required_impl(f):
+    def login_required_impl(f: Callable) -> Callable:
         @wraps(f)
-        def decorated_function(*args, **kwargs):
-            def auth_error(code, headm=None):
+        def decorated_function(*args: Tuple, **kwargs: Dict) -> Callable:
+            def auth_error(code: int, headm: Optional[str]=None) -> Tuple[Response , int]:
                 resp, http_code = error_response(code)
                 if headm:
                     resp.headers['WWW-Authenticate'] = 'Bearer ' + headm

app.py

@@ -3,11 +3,13 @@
 app = create_app()
 
 
+# TODO: I don't know whether this function returns anything
 @app.cli.command("initdb")
 def initdb_():
     initdb()
 
 
+# TODO: I don't know whether this function returns anything
 @app.cli.command("generate")
 def generate_():
     generate()

scripts/apply_ramdom.py

@@ -8,9 +8,13 @@
 from pathlib import Path
 import json
 
+# typehints imports {{{
+from typehint import Dict, Optional
+# }}}
+
 
 class client():
-    def get(self, _url, _json=None, follow_redirects=False, headers=None):
+    def get(self, _url: str, _json: Optional[Dict]=None, follow_redirects: bool=False, headers: Optional[Dict]=None) -> Optional[Dict]:
         default_headers = {"Content-Type": "application/json"}
         if headers:
             default_headers.update(headers)
@@ -29,7 +33,7 @@ def get(self, _url, _json=None, follow_redirects=False, headers=None):
             response.close()
             return json.loads(response_body)
 
-    def post(self, _url, _json=None, follow_redirects=False, headers=None):
+    def post(self, _url: str, _json: Optional[Dict]=None, follow_redirects: bool=False, headers: Optional[Dict]=None) -> Optional[Dict]:
         default_headers = {"Content-Type": "application/json"}
         if headers:
             default_headers.update(headers)
@@ -49,7 +53,7 @@ def post(self, _url, _json=None, follow_redirects=False, headers=None):
             return json.loads(response_body)
 
 
-def login(client, secret_id, rresp):
+def login(client: client, secret_id: int, rresp: str) -> Optional[Dict]:
     return client.post('/auth', _json={
         "id": secret_id,
         "g-recaptcha-response": rresp

scripts/draw.py

@@ -12,6 +12,9 @@
 from urllib.request import Request, urlopen
 from urllib.error import HTTPError
 import hashlib
+# typehints imports {{{
+from typehint import Dict, Optional
+# }}}
 
 parser = argparse.ArgumentParser(
     description='Draw currently available lotteries')
@@ -32,7 +35,7 @@
 admin_ids = next(cred for cred in id_list if cred['authority'] == 'admin')
 
 
-def post_json(path, data=None, token=None):
+def post_json(path: str, data: Optional[Dict]=None, token: Optional[str]=None) -> Optional[Dict]:
     headers = {"Content-Type": "application/json"}
     if token:
         headers['Authorization'] = 'Bearer ' + token