Address 3-5 feedback

Author: Adrian Chang

libs/labelbox/src/labelbox/schema/user_group.py

@@ -89,24 +89,23 @@ class UserGroup(BaseModel):
     Represents a user group in Labelbox.
 
     Attributes:
-        id (Optional[str]): The ID of the user group.
-        name (Optional[str]): The name of the user group.
+        id (str): The ID of the user group.
+        name (str): The name of the user group.
         color (UserGroupColor): The color of the user group.
         users (Set[UserGroupUser]): The set of users in the user group.
         projects (Set[UserGroupProject]): The set of projects associated with the user group.
         client (Client): The Labelbox client object.
 
     Methods:
-        __init__(self, client: Client, id: str = "", name: str = "", color: UserGroupColor = UserGroupColor.BLUE,
-                 users: Set[UserGroupUser] = set(), projects: Set[UserGroupProject] = set(), reload=True)
-        _reload(self)
+        __init__(self, client: Client)
+        get(self) -> "UserGroup"
         update(self) -> "UserGroup"
         create(self) -> "UserGroup"
         delete(self) -> bool
         get_user_groups(client: Client) -> Iterator["UserGroup"]
     """
-    id: Optional[str]
-    name: Optional[str]
+    id: str
+    name: str
     color: UserGroupColor
     users: Set[UserGroupUser]
     projects: Set[UserGroupProject]
@@ -119,51 +118,38 @@ class Config:
     def __init__(
         self,
         client: Client,
-        id: str = "",
-        name: str = "",
-        color: UserGroupColor = UserGroupColor.BLUE,
-        users: Set[UserGroupUser] = set(),
-        projects: Set[UserGroupProject] = set(),
-        reload=True,
     ):
         """
         Initializes a UserGroup object.
 
         Args:
             client (Client): The Labelbox client object.
-            id (str, optional): The ID of the user group. Defaults to an empty string.
-            name (str, optional): The name of the user group. Defaults to an empty string.
-            color (UserGroupColor, optional): The color of the user group. Defaults to UserGroupColor.BLUE.
-            users (Set[UserGroupUser], optional): The set of users in the user group. Defaults to an empty set.
-            projects (Set[UserGroupProject], optional): The set of projects associated with the user group. Defaults to an empty set.
-            reload (bool, optional): Whether to reload the partial representation of the group. Defaults to True.
 
         Raises:
             RuntimeError: If the experimental feature is not enabled in the client.
 
         """
-        super().__init__(client=client, id=id, name=name, color=color, users=users, projects=projects)
+        super().__init__(client=client, id="", name="", color=UserGroupColor.BLUE, users=set(), projects=set())
         if not self.client.enable_experimental:
             raise RuntimeError(
                 "Please enable experimental in client to use UserGroups")
 
-        # partial representation of the group, reload
-        if self.id and reload:
-            self._reload()
-
-    def _reload(self):
+    def get(self) -> "UserGroup":
         """
         Reloads the user group information from the server.
 
         This method sends a GraphQL query to the server to fetch the latest information
         about the user group, including its name, color, projects, and members. The fetched
         information is then used to update the corresponding attributes of the `Group` object.
 
-        Raises:
-            InvalidQueryError: If the query fails to fetch the group information.
+        Args:
+            id (str): The ID of the user group to fetch.
 
         Returns:
-            None
+            UserGroup of passed in ID (self)
+
+        Raises:
+            InvalidQueryError: If the query fails to fetch the group information.
         """
         query = """
             query GetUserGroupPyApi($id: ID!) {
@@ -204,6 +190,7 @@ def _reload(self):
             UserGroupUser(id=member["id"], email=member["email"])
             for member in result["userGroup"]["members"]["nodes"]
         }
+        return self
 
     def update(self) -> "UserGroup":
         """
@@ -397,21 +384,19 @@ def get_user_groups(client: Client) -> Iterator["UserGroup"]:
                 yield
             groups = userGroups["nodes"]
             for group in groups:
-                yield UserGroup(client,
-                                reload=False,
-                                id=group["id"],
-                                name=group["name"],
-                                color=UserGroupColor(group["color"]),
-                                users={
-                                    UserGroupUser(id=member["id"],
-                                                  email=member["email"])
-                                    for member in group["members"]["nodes"]
-                                },
-                                projects={
-                                    UserGroupProject(id=project["id"],
-                                                     name=project["name"])
-                                    for project in group["projects"]["nodes"]
-                                })
+                userGroup = UserGroup(client)
+                userGroup.id = group["id"]
+                userGroup.name = group["name"]
+                userGroup.color = UserGroupColor(group["color"])
+                userGroup.users = {
+                    UserGroupUser(id=member["id"], email=member["email"])
+                    for member in group["members"]["nodes"]
+                }
+                userGroup.projects = {
+                    UserGroupProject(id=project["id"], name=project["name"])
+                    for project in group["projects"]["nodes"]
+                }
+                yield userGroup
             nextCursor = userGroups["nextCursor"]
             # this doesn't seem to be implemented right now to return a value other than null from the api
             if not nextCursor:

libs/labelbox/tests/unit/schema/test_user_group.py

@@ -59,71 +59,44 @@ class TestUserGroup:
     def setup_method(self):
         self.client = MagicMock(Client)
         self.client.enable_experimental = True
-        self.group = UserGroup(client=self.client, name="Test Group")
+        self.group = UserGroup(client=self.client)
 
     def test_constructor_experimental_needed(self):
         client = MagicMock(Client)
         client.enable_experimental = False
         with pytest.raises(RuntimeError):
             group = UserGroup(client)
 
-    def test_constructor_name(self):
-        group = self.group
-        assert group.name == "Test Group"
-        assert group.color == UserGroupColor.BLUE
-
-    def test_constructor_id_no_reload(self):
-        projects = [{
-            "id": "project_id_1",
-            "name": "project_1"
-        }, {
-            "id": "project_id_2",
-            "name": "project_2"
-        }]
-        group_members = [{
-            "id": "user_id_1",
-            "email": "email_1"
-        }, {
-            "id": "user_id_2",
-            "email": "email_2"
-        }]
-        self.client.execute.return_value = {
-            "userGroup": {
-                "id": "group_id",
-                "name": "Test Group",
-                "color": "4ED2F9",
-                "projects": {
-                    "nodes": projects
-                },
-                "members": {
-                    "nodes": group_members
-                }
-            }
-        }
-
-        group = UserGroup(self.client, id="group_id", reload=False)
+    def test_constructor(self):
+        group = UserGroup(self.client)
 
-        assert group.id == "group_id"
+        assert group.id == ""
         assert group.name == ""
         assert group.color is UserGroupColor.BLUE
         assert len(group.projects) == 0
         assert len(group.users) == 0
 
-    def test_constructor_id(self):
-        projects = [{
-            "id": "project_id_1",
-            "name": "project_1"
-        }, {
-            "id": "project_id_2",
-            "name": "project_2"
-        }]
-        group_members = [{
-            "id": "user_id_1",
-            "email": "email_1"
-        }, {
-            "id": "user_id_2",
-            "email": "email_2"
-        }]
+    def test_get(self):
+        projects = [
+            {
+                "id": "project_id_1",
+                "name": "project_1"
+            },
+            {
+                "id": "project_id_2",
+                "name": "project_2"
+            }
+        ]
+        group_members = [
+            {
+                "id": "user_id_1",
+                "email": "email_1"
+            },
+            {
+                "id": "user_id_2",
+                "email": "email_2"
+            }
+        ]
         self.client.execute.return_value = {
             "userGroup": {
                 "id": "group_id",
@@ -137,26 +110,29 @@ def test_constructor_id(self):
                 }
             }
         }
-        group = UserGroup(self.client, id="group_id")
+        group = UserGroup(self.client)
+        assert group.id == ""
+        assert group.name == ""
+        assert group.color is UserGroupColor.BLUE
+        assert len(group.projects) == 0
+        assert len(group.users) == 0
+
+        group.id = "group_id"
+        group.get()
+
         assert group.id == "group_id"
         assert group.name == "Test Group"
-        assert group.color == UserGroupColor.CYAN
+        assert group.color is UserGroupColor.CYAN
         assert len(group.projects) == 2
         assert len(group.users) == 2
 
     def test_id(self):
         group = self.group
         assert group.id == ""
 
-        group.id = "1"
-        assert group.id == "1"
-
-        group.id = "2"
-        assert group.id == "2"
-
     def test_name(self):
         group = self.group
-        assert group.name == "Test Group"
+        assert group.name == ""
 
         group.name = "New Group"
         assert group.name == "New Group"