mediator_group_classes.py

Go to the documentation of this file.

 
 
 
class Group:
 
    
 
    
    @property
    def Name(self) -> str:
        return self._groupName
 
 
    
    @property
    def Users(self) -> list[str]:
        return self._users.copy()
 
    
 
    
    def __init__(self, name = "") -> None:
        self._groupName = name
        self._users = []  # type list[str]
 
    
 
    
    def ContainsUser(self, name : str) -> bool:
        return name in self._users
 
 
    
    def AddUser(self, name : str) -> None:
        if not name:
            raise ValueError("Must specify a user name to add it to the group.")
 
        if not self.ContainsUser(name):
            self._users.append(name)
 
 
    
    def RemoveUser(self, name : str) -> None:
        if self.ContainsUser(name):
            self._users.remove(name)
 
    
    def __eq__(self, o) -> bool:
        if isinstance(o, Group):
            return self._groupName == o._groupName
        elif isinstance(o, str):
            return self._groupName == o
        else:
            raise TypeError("Expecting a Group type or string to compare to.")
 
 
 
 
 
 
class GroupList:
 
    
 
    
    @property
    def GroupNames(self) -> list[str]:
        groupNames = []
 
        for group in self._groups:
            groupNames.append(group.Name)
 
        # Case-insensitive sort
        groupNames.sort(key=str.lower)
        return groupNames
 
    
 
    
    def __init__(self) -> None:
        self._groups = [] # type list[Group]
 
    
 
 
    
    def _SearchForGroup(self, name : str) -> int:
        foundIndex = -1
        try:
            foundIndex = self._groups.index(Group(name))
        except ValueError:
            # name was not found in the list
            pass
        return foundIndex
 
    
    def FindGroup(self, name : str) -> Group:
        foundIndex = self._SearchForGroup(name)
        if foundIndex != -1:
            return self._groups[foundIndex]
        return None
 
 
    
    def AddGroup(self, name : str) -> None:
        if not name:
            raise ValueError("Must specify a group name to add it to the group list.")
 
        if not self.FindGroup(name):
            self._groups.append(Group(name))
 
 
    
    def RemoveGroup(self, name : str) -> None:
        foundIndex = self._SearchForGroup(name)
        if foundIndex != -1:
            self._groups.remove(Group(name))