Improved type-hinting and overall sanity checks implemented.

classes/holo_user.py

@@ -1,55 +1,41 @@
 import logging
-from typing import Any, Union
+from typing import Any, Union, Dict
 
-import discord
-import discord.member
+from bson import ObjectId
+from discord import User, Member
 from libbot import config_get
 
+from errors import UserNotFoundError
 from modules.database import col_warnings, sync_col_users, sync_col_warnings, col_users
 
 logger = logging.getLogger(__name__)
 
 
-class UserNotFoundError(Exception):
-    """HoloUser could not find user with such an ID in database"""
-
-    def __init__(self, user, user_id):
-        self.user = user
-        self.user_id = user_id
-
-        super().__init__(
-            f"User of type {type(self.user)} with id {self.user_id} was not found"
-        )
-
-
 class HoloUser:
-    def __init__(
-        self, user: Union[discord.User, discord.Member, discord.member.Member, int]
-    ) -> None:
+    def __init__(self, user: Union[User, Member, int]) -> None:
         """Get an object that has a proper binding between Discord ID and database
 
         ### Args:
-            * `user` (Union[discord.User, discord.Member, discord.member.Member, int]): Object from which ID can be extracted
+            * `user` (Union[User, Member, int]): Object from which ID can be extracted
 
         ### Raises:
             * `UserNotFoundError`: User with such ID does not seem to exist in database
         """
 
-        if hasattr(user, "id"):
-            self.id = user.id  # type: ignore
-        else:
-            self.id = user
+        self.id: int = user if not hasattr(user, "id") else user.id
 
-        jav_user = sync_col_users.find_one({"user": self.id})
+        jav_user: Union[Dict[str, Any], None] = sync_col_users.find_one(
+            {"user": self.id}
+        )
 
         if jav_user is None:
             raise UserNotFoundError(user=user, user_id=self.id)
 
-        self.db_id = jav_user["_id"]
+        self.db_id: ObjectId = jav_user["_id"]
 
-        self.customrole = jav_user["customrole"]
-        self.customchannel = jav_user["customchannel"]
-        self.warnings = self.warns()
+        self.customrole: Union[int, None] = jav_user["customrole"]
+        self.customchannel: Union[int, None] = jav_user["customchannel"]
+        self.warnings: int = self.warns()
 
     def warns(self) -> int:
         """Get number of warnings user has
@@ -57,7 +43,9 @@ class HoloUser:
         ### Returns:
             * `int`: Number of warnings
         """
-        warns = sync_col_warnings.find_one({"user": self.id})
+        warns: Union[Dict[str, Any], None] = sync_col_warnings.find_one(
+            {"user": self.id}
+        )
 
         return 0 if warns is None else warns["warns"]
 
@@ -67,7 +55,9 @@ class HoloUser:
         ### Args:
             * `count` (int, optional): Count of warnings to be added. Defaults to 1.
         """
-        warns = await col_warnings.find_one({"user": self.id})
+        warns: Union[Dict[str, Any], None] = await col_warnings.find_one(
+            {"user": self.id}
+        )
 
         if warns is not None:
             await col_warnings.update_one(
@@ -77,7 +67,7 @@ class HoloUser:
         else:
             await col_warnings.insert_one(document={"user": self.id, "warns": count})
 
-        logger.info(f"User {self.id} was warned {count} times due to: {reason}")
+        logger.info("User %s was warned %s times due to: %s", self.id, count, reason)
 
     async def set(self, key: str, value: Any) -> None:
         """Set attribute data and save it into database
@@ -95,45 +85,41 @@ class HoloUser:
             {"_id": self.db_id}, {"$set": {key: value}}, upsert=True
         )
 
-        logger.info(f"Set attribute {key} of user {self.id} to {value}")
+        logger.info("Set attribute %s of user %s to %s", key, self.id, value)
 
     @staticmethod
-    async def is_moderator(
-        member: Union[discord.User, discord.Member, discord.member.Member]
-    ) -> bool:
+    async def is_moderator(member: Union[User, Member]) -> bool:
         """Check if user is moderator or council member
 
         ### Args:
-            * `member` (Union[discord.User, discord.Member, discord.member.Member]): Member object
+            * `member` (Union[User, Member]): Member object
 
         ### Returns:
             `bool`: `True` if member is a moderator or member of council and `False` if not
         """
-        if isinstance(member, discord.User):
+        if isinstance(member, User):
             return False
 
-        moderator_role = await config_get("moderators", "roles")
-        council_role = await config_get("council", "roles")
+        moderator_role: Union[int, None] = await config_get("moderators", "roles")
+        council_role: Union[int, None] = await config_get("council", "roles")
 
         for role in member.roles:
-            if role.id == moderator_role or role.id == council_role:
+            if role.id in (moderator_role, council_role):
                 return True
 
         return False
 
     @staticmethod
-    async def is_council(
-        member: Union[discord.User, discord.Member, discord.member.Member]
-    ) -> bool:
+    async def is_council(member: Union[User, Member]) -> bool:
         """Check if user is a member of council
 
         ### Args:
-            * `member` (Union[discord.User, discord.Member, discord.member.Member]): Member object
+            * `member` (Union[User, Member]): Member object
 
         ### Returns:
             `bool`: `True` if member is a member of council and `False` if not
         """
-        if isinstance(member, discord.User):
+        if isinstance(member, User):
             return False
 
         council_role = await config_get("council", "roles")