V5.0.1

core/Model.py

@@ -3,7 +3,6 @@ from datetime import datetime
 from typing import Union
 from core.base import Base
 
-
 class User:
 
     @dataclass
@@ -18,7 +17,7 @@ class User:
         remote_ip: str
         score_connexion: int
         connexion_datetime: datetime = field(default=datetime.now())
-    
+
     UID_DB: list[UserModel] = []
 
     def __init__(self, Base: Base) -> None:
@@ -26,7 +25,14 @@ class User:
         pass
 
     def insert(self, newUser: UserModel) -> bool:
+        """Insert a new User object
 
+        Args:
+            newUser (UserModel): New userModel object
+
+        Returns:
+            bool: True if inserted
+        """
         result = False
         exist = False
 
@@ -44,9 +50,17 @@ class User:
             self.log.critical(f'The User Object was not inserted {newUser}')
 
         return result
-    
-    def update(self, uid: str, newNickname: str) -> bool:
 
+    def update(self, uid: str, newNickname: str) -> bool:
+        """Update the nickname starting from the UID
+
+        Args:
+            uid (str): UID of the user
+            newNickname (str): New nickname
+
+        Returns:
+            bool: True if updated
+        """
         result = False
 
         for record in self.UID_DB:
@@ -59,9 +73,16 @@ class User:
             self.log.critical(f'The new nickname {newNickname} was not updated, uid = {uid}')
 
         return result
-    
-    def delete(self, uid: str) -> bool:
 
+    def delete(self, uid: str) -> bool:
+        """Delete the User starting from the UID
+
+        Args:
+            uid (str): UID of the user
+
+        Returns:
+            bool: True if deleted
+        """
         result = False
 
         for record in self.UID_DB:
@@ -74,9 +95,16 @@ class User:
             self.log.critical(f'The UID {uid} was not deleted')
 
         return result
-    
-    def get_User(self, uidornickname: str) -> Union[UserModel, None]:
 
+    def get_User(self, uidornickname: str) -> Union[UserModel, None]:
+        """Get The User Object model
+
+        Args:
+            uidornickname (str): UID or Nickname
+
+        Returns:
+            UserModel|None: The UserModel Object | None
+        """
         User = None
         for record in self.UID_DB:
             if record.uid == uidornickname:
@@ -89,7 +117,14 @@ class User:
         return User
 
     def get_uid(self, uidornickname:str) -> Union[str, None]:
+        """Get the UID of the user starting from the UID or the Nickname
 
+        Args:
+            uidornickname (str): UID or Nickname
+
+        Returns:
+            str|None: Return the UID
+        """
         uid = None
         for record in self.UID_DB:
             if record.uid == uidornickname:
@@ -101,14 +136,21 @@ class User:
         return uid
 
     def get_nickname(self, uidornickname:str) -> Union[str, None]:
+        """Get the Nickname starting from UID or the nickname
 
+        Args:
+            uidornickname (str): UID or Nickname of the user
+
+        Returns:
+            str|None: the nickname
+        """
         nickname = None
         for record in self.UID_DB:
             if record.nickname == uidornickname:
                 nickname = record.nickname
             if record.uid == uidornickname:
                 nickname = record.nickname
-        self.log.debug(f'The value {uidornickname} -- {nickname}')
+        self.log.debug(f'The value to check {uidornickname} -> {nickname}')
         return nickname
 
 class Admin:
@@ -217,6 +259,7 @@ class Admin:
         return nickname
 
 class Channel:
+
     @dataclass
     class ChannelModel:
         name: str
@@ -227,6 +270,7 @@ class Channel:
 
     def __init__(self, Base: Base) -> None:
         self.log = Base.logs
+        self.Base = Base
         pass
 
     def insert(self, newChan: ChannelModel) -> bool:
@@ -257,7 +301,7 @@ class Channel:
             self.log.critical(f'The Channel Object was not inserted {newChan}')
 
         return result
-    
+
     def update(self, name: str, newMode: str) -> bool:
 
         result = False
@@ -272,7 +316,7 @@ class Channel:
             self.log.critical(f'The channel mode {newMode} was not updated, name = {name}')
 
         return result
-    
+
     def delete(self, name: str) -> bool:
 
         result = False
@@ -287,18 +331,28 @@ class Channel:
             self.log.critical(f'The Channel {name} was not deleted')
 
         return result
-    
-    def delete_user_from_channel(self,chan_name: str, uid:str) -> bool:
-        result = False
 
-        for record in self.UID_CHANNEL_DB:
-            if record.name == chan_name:
-                record.uids.remove(uid)
-                self.log.debug(f'uid {uid} has been removed, here is the new object: {record}')
-                result = True
+    def delete_user_from_channel(self, chan_name: str, uid:str) -> bool:
+        try:
+            result = False
+
+            for record in self.UID_CHANNEL_DB:
+                if record.name == chan_name:
+                    for user_id in record.uids:
+                        if self.Base.clean_uid(user_id) == uid:
+                            record.uids.remove(user_id)
+                            self.log.debug(f'uid {uid} has been removed, here is the new object: {record}')
+                            result = True
+
+            for record in self.UID_CHANNEL_DB:
+                if not record.uids:
+                    self.UID_CHANNEL_DB.remove(record)
+                    self.log.debug(f'Channel {record.name} has been removed, here is the new object: {record}')
+
+            return result
+        except ValueError as ve:
+            self.log.error(f'{ve}')
 
-        return result
-    
     def get_Channel(self, name: str) -> Union[ChannelModel, None]:
 
         Channel = None
@@ -319,4 +373,3 @@ class Channel:
 
         self.log.debug(f'The mode of the channel {name} has been found: {mode}')
         return mode
-