TASK: Add static type definitions

devcarron · devcarron · commit 1c1f5b8ffbd2 · 2017-11-02T19:30:49.000+01:00
diff --git a/database/db_wrapper.py b/database/db_wrapper.py
@@ -23,7 +23,7 @@ def __init__(self):
             self.connection.text_factory = lambda x: str(x, 'utf-8', "ignore")
             self.cursor = self.connection.cursor()
 
-        def create_database(self, database_path):
+        def create_database(self, database_path: str) -> None:
             # Create database file and add admin and users table to the database
             open(database_path, 'a').close()
 
@@ -51,57 +51,57 @@ def create_database(self, database_path):
             connection.commit()
             connection.close()
 
-        def get_user(self, user_id):
+        def get_user(self, user_id: int) -> tuple:
             self.cursor.execute("SELECT * FROM users WHERE userID=?;", [str(user_id)])
 
             result = self.cursor.fetchone()
             if len(result) > 0:
                 return result
             else:
-                return []
+                return ()
 
-        def get_played_games(self, user_id):
+        def get_played_games(self, user_id: int) -> int:
             self.cursor.execute("SELECT gamesPlayed FROM users WHERE userID=?;", [str(user_id)])
 
             result = self.cursor.fetchone()
             if len(result) > 0:
-                return result[0]
+                return int(result[0])
             else:
                 return 0
 
-        def get_all_users(self):
+        def get_all_users(self) -> list:
             self.cursor.execute("SELECT rowid, * FROM users;")
             return self.cursor.fetchall()
 
-        def get_admins(self):
+        def get_admins(self) -> list:
             self.cursor.execute("SELECT userID from admins;")
             admins = self.cursor.fetchall()
             admin_list = []
             for admin in admins:
                 admin_list.append(admin[0])
             return admin_list
 
-        def get_lang_id(self, user_id):
+        def get_lang_id(self, user_id: int) -> str:
             self.cursor.execute("SELECT languageID FROM users WHERE userID=?;", [str(user_id)])
             result = self.cursor.fetchone()
             if result:
                 return result[0]
             else:
                 return "en"
 
-        def add_user(self, user_id, lang_id, first_name, last_name, username):
+        def add_user(self, user_id: int, lang_id: str, first_name: str, last_name: str, username: str) -> None:
             try:
-                self.cursor.execute("INSERT INTO users VALUES (?, ?, ?, ?, ?, 0, 0, 0, 0);", (str(user_id), str(lang_id), str(first_name), str(last_name), str(username)))
+                self.cursor.execute("INSERT INTO users VALUES (?, ?, ?, ?, ?, 0, 0, 0, 0);", (str(user_id), lang_id, first_name, last_name, username))
                 self.connection.commit()
             except sqlite3.IntegrityError:
                 pass
 
-        def insert(self, column_name, value, user_id):
-            self.cursor.execute("UPDATE users SET " + str(column_name) + "= ? WHERE userID = ?;",
-                                [str(value), str(user_id)])
+        def insert(self, column_name: str, value: str, user_id: int) -> None:
+            self.cursor.execute("UPDATE users SET " + column_name + "= ? WHERE userID = ?;",
+                                [value, str(user_id)])
             self.connection.commit()
 
-        def is_user_saved(self, user_id):
+        def is_user_saved(self, user_id: int) -> bool:
             self.cursor.execute("SELECT rowid, * FROM users WHERE userID=?;", [str(user_id)])
 
             result = self.cursor.fetchall()
@@ -110,7 +110,7 @@ def is_user_saved(self, user_id):
             else:
                 return False
 
-        def user_data_changed(self, user_id, first_name, last_name, username):
+        def user_data_changed(self, user_id: int, first_name: str, last_name: str, username: str) -> bool:
             self.cursor.execute("SELECT * FROM users WHERE userID=?;", [str(user_id)])
 
             result = self.cursor.fetchone()
@@ -123,15 +123,15 @@ def user_data_changed(self, user_id, first_name, last_name, username):
             else:
                 return True
 
-        def update_user_data(self, user_id, first_name, last_name, username):
-            self.cursor.execute("UPDATE users SET first_name=?, last_name=?, username=? WHERE userID=?;", (str(first_name), str(last_name), str(username), str(user_id)))
+        def update_user_data(self, user_id: int, first_name: str, last_name: str, username: str) -> None:
+            self.cursor.execute("UPDATE users SET first_name=?, last_name=?, username=? WHERE userID=?;", (first_name, last_name, username, str(user_id)))
             self.connection.commit()
 
-        def reset_stats(self, user_id):
+        def reset_stats(self, user_id: int) -> None:
             self.cursor.execute("UPDATE users SET gamesPlayed='0', gamesWon='0', gamesTie='0', lastPlayed='0' WHERE userID=?;", [str(user_id)])
             self.connection.commit()
 
-        def close_conn(self):
+        def close_conn(self) -> None:
             self.connection.close()
 
     instance = None
@@ -141,7 +141,7 @@ def __init__(self):
             DBwrapper.instance = DBwrapper.__DBwrapper()
 
     @staticmethod
-    def get_instance():
+    def get_instance() -> __DBwrapper:
         if not DBwrapper.instance:
             DBwrapper.instance = DBwrapper.__DBwrapper()
 
diff --git a/database/statistics.py b/database/statistics.py
@@ -19,11 +19,11 @@ def set_game_won(user_id):
 
 def add_game_played(user_id):
     db = DBwrapper.get_instance()
-    games_played = int(db.get_played_games(user_id))
+    games_played = db.get_played_games(user_id)
     games_played = games_played + 1
     logger.debug("Add game played for userID: " + str(user_id))
     db.insert("gamesPlayed", str(games_played), user_id)
-    db.insert("lastPlayed", int(time()), user_id)
+    db.insert("lastPlayed", str(int(time())), user_id)
 
 
 def get_stats(percentage):
diff --git a/game/blackJack.py b/game/blackJack.py
@@ -155,7 +155,7 @@ def dealers_turn(self):
             self.send_message(self.chat_id, output_text, parse_mode="Markdown", reply_markup=self.keyboard_running)
             self.evaluation()
 
-    def start_game(self, message_id=None):
+    def start_game(self, message_id: int = None) -> None:
         if not self.game_running:
             if ((self.game_type == self.GROUP_CHAT or self.game_type == self.MULTIPLAYER_GAME) and len(self.players) > 1) or self.game_type == self.PRIVATE_CHAT:
                 self.game_running = True
@@ -174,7 +174,7 @@ def start_game(self, message_id=None):
             # TODO Game already running
             pass
 
-    def evaluation(self):
+    def evaluation(self) -> None:
         list_21 = []
         list_busted = []
         list_lower_21 = []
@@ -243,7 +243,7 @@ def evaluation(self):
         self.send_message(self.chat_id, final_message, game_id=self.__game_id)
         self.game_handler.gl_remove(self.chat_id)
 
-    def get_player_overview(self, show_points=False, text="", i=0, dealer=False):
+    def get_player_overview(self, show_points: bool = False, text: str = "", i=0, dealer: bool = False) -> str:
         if self.game_running:
             for user in self.players:
                 if i == self.current_player:
@@ -297,7 +297,7 @@ def analyze_message(self, update):
                 if user_id == self.players[0].user_id:
                     self.game_handler.gl_remove(self.chat_id)
 
-    def get_game_id(self):
+    def get_game_id(self) -> int:
         return self.__game_id
 
     # When game is being initialized
diff --git a/lang/language.py b/lang/language.py
@@ -13,7 +13,7 @@
 
 
 # translate returns the translation for a specific string
-def translate(string, language):
+def translate(string: str, language: str) -> str:
     if language in translations and string in translations[language]:
         return translations[language][string]
     elif language == "br":
