mediator_user_classes.py

Go to the documentation of this file.

 
 
 
class User:
 
    
 
    
    @property
    def Name(self) -> str:
        return self._name
 
    
 
    
    def __init__(self, name = "") -> None:
        self._name = name
 
    
 
 
    
    def __eq__(self, o) -> bool:
        if isinstance(o, User):
            return self._name == o._name
        elif isinstance(o, str):
            return self._name == o
        else:
            raise TypeError("Expecting a User type or string to compare to.")
 
 
 
 
 
 
class UserList:
 
    
 
    
    @property
    def UserNames(self) -> list[str]:
        userNames = []
 
        for user in self._users:
            userNames.append(user.Name)
 
        # Case-insensitive sort
        userNames.sort(key=str.lower)
        return userNames
 
    
 
    
    def __init__(self) -> None:
        self._users = [] # type: list[User]
 
    
 
 
    
    def _SearchForUser(self, name : str) -> int:
        foundIndex = -1
        try:
            foundIndex = self._users.index(User(name))
        except ValueError:
            # name was not found in the list
            pass
        return foundIndex
 
    
    def  FindUser(self, name : str) -> User:
        foundIndex = self._SearchForUser(name)
        if foundIndex != -1:
            return self._users[foundIndex]
        return None
 
 
    
    def AddUser(self, name : str) -> None:
        if not name:
            raise ValueError("Must specify a user name to add it to the user list.")
 
        if not self.FindUser(name):
            self._users.append(User(name))
 
 
    
    def RemoveUser(self, name : str) -> None:
        foundIndex = self._SearchForUser(name)
        if foundIndex != -1:
            self._users.remove(User(name))