recommended changes

Author: Matt Sokoloff

labelbox/client.py

@@ -50,7 +50,7 @@ def __init__(self,
         Args:
             api_key (str): API key. If None, the key is obtained from the "LABELBOX_API_KEY" environment variable.
             endpoint (str): URL of the Labelbox server to connect to.
-            enable_experimental (bool): Indicated whether or not to use experimental features
+            enable_experimental (bool): Indicates whether or not to use experimental features
         Raises:
             labelbox.exceptions.AuthenticationError: If no `api_key`
                 is provided as an argument or via the environment

labelbox/schema/invite.py

@@ -27,7 +27,6 @@ class Invite(DbObject):
     email = Field.String("email", "inviteeEmail")
 
     def __init__(self, client, invite_response):
-        #invite_response.get('inviter')
         project_roles = invite_response.pop("projectInvites", [])
         super().__init__(client, invite_response)
 

labelbox/schema/organization.py

@@ -7,9 +7,6 @@
 from labelbox.schema.invite import Invite, InviteLimit, ProjectRole
 from labelbox.schema.user import User
 from labelbox.schema.role import Role
-import logging
-
-logger = logging.getLogger(__name__)
 
 
 class Organization(DbObject):
@@ -64,8 +61,8 @@ def invite_user(
 
         Notes:
             This function is currently experimental and has a few limitations that will be resolved in future releases
-            1. There is a really unclear foreign key error if you use an unsupported role.
-                - This means that the `Roles` object is not getting the right ids
+            1. If you try to add an unsupported you will get an error referring to invalid foreign keys
+                - In this case `role.get_roles` is likely not getting the right ids
             2. Multiple invites can be sent for the same email. This can only be resolved in the UI for now.
                 - Future releases of the SDK will support the ability to query and revoke invites to solve this problem (and/or checking on the backend)
             3. Some server side response are unclear (e.g. if the user invites themself `None` is returned which the SDK raises as a `LabelboxError` )

labelbox/schema/role.py

@@ -1,13 +1,17 @@
 from dataclasses import dataclass
+from typing import Dict, Optional, TYPE_CHECKING
 
 from labelbox.orm.model import Field
 from labelbox.orm.db_object import DbObject
 from labelbox.schema.project import Project
 
-_ROLES = None
+if TYPE_CHECKING:
+    from labelbox import Client
 
+_ROLES: Optional[Dict[str, "Role"]] = None
 
-def get_roles(client):
+
+def get_roles(client: "Client") -> Dict[str, "Role"]:
     global _ROLES
     if _ROLES is None:
         query_str = """query GetAvailableUserRolesPyApi { roles { id name } }"""