lms.model.groupsets

  1import typing
  2
  3import lms.model.base
  4import lms.model.groups
  5import lms.model.query
  6import lms.model.users
  7
  8class GroupSetQuery(lms.model.query.BaseQuery):
  9    """
 10    A class for the different ways one can attempt to reference an LMS group set.
 11    In general, a group set can be queried by:
 12     - LMS Group Set ID (`id`)
 13     - Full Name (`name`)
 14     - f"{name} ({id})"
 15    """
 16
 17    _include_email = False
 18
 19class ResolvedGroupSetQuery(lms.model.query.ResolvedBaseQuery, GroupSetQuery):
 20    """
 21    A GroupSetQuery that has been resolved (verified) from a real group set instance.
 22    """
 23
 24    _include_email = False
 25
 26    def __init__(self,
 27            group_set: 'GroupSet',
 28            **kwargs: typing.Any) -> None:
 29        super().__init__(id = group_set.id, name = group_set.name, **kwargs)
 30
 31class GroupSet(lms.model.base.BaseType):
 32    """
 33    A collection of groups with a common purpose
 34    (e.g., a set of student groups for an assignment).
 35    """
 36
 37    CORE_FIELDS = [
 38        'id', 'name',
 39    ]
 40
 41    def __init__(self,
 42            id: typing.Union[str, int, None] = None,
 43            name: typing.Union[str, None] = None,
 44            **kwargs: typing.Any) -> None:
 45        super().__init__(**kwargs)
 46
 47        if (id is None):
 48            raise ValueError("Group sets must have an id.")
 49
 50        self.id: str = str(id)
 51        """ The LMS's identifier for this group set. """
 52
 53        self.name: typing.Union[str, None] = name
 54        """ The display name of this group set. """
 55
 56    def to_query(self) -> ResolvedGroupSetQuery:
 57        """ Get a query representation of this group set. """
 58
 59        return ResolvedGroupSetQuery(self)
 60
 61class GroupSetMembership(lms.model.base.BaseType):
 62    """
 63    An instance of a user being in a group set.
 64    """
 65
 66    CORE_FIELDS = [
 67        'groupset', 'group', 'user',
 68    ]
 69
 70    def __init__(self,
 71            user: lms.model.users.UserQuery,
 72            groupset: GroupSetQuery,
 73            group: lms.model.groups.GroupQuery,
 74            **kwargs: typing.Any) -> None:
 75        super().__init__(**kwargs)
 76
 77        self.groupset: GroupSetQuery = groupset
 78        """ The group set the group belongs to. """
 79
 80        self.group: lms.model.groups.GroupQuery = group
 81        """ The group the user belongs to. """
 82
 83        self.user: lms.model.users.UserQuery = user
 84        """ The user in a group. """
 85
 86    def update_queries(self,
 87            groupset: typing.Union[ResolvedGroupSetQuery, None] = None,
 88            users: typing.Union[typing.Dict[str, lms.model.users.ResolvedUserQuery], None] = None,
 89            groups: typing.Union[typing.Dict[str, lms.model.groups.ResolvedGroupQuery], None] = None,
 90            ) -> None:
 91        """
 92        Update the queries with resolved variants.
 93        The maps should be keyed by respective ids.
 94        """
 95
 96        if (groupset is not None):
 97            self.groupset = groupset
 98
 99        if ((users is not None) and (self.user.id in users)):
100            self.user = users[self.user.id]
101
102        if ((groups is not None) and (self.group.id in groups)):
103            self.group = groups[self.group.id]