beta wip

Author: Matt Sokoloff

labelbox/client.py

@@ -37,7 +37,8 @@ class Client:
 
     def __init__(self,
                  api_key=None,
-                 endpoint='https://api.labelbox.com/graphql'):
+                 endpoint='https://api.labelbox.com/graphql',
+                 enable_beta = False):
         """ Creates and initializes a Labelbox Client.
 
         Logging is defaulted to level WARNING. To receive more verbose
@@ -50,6 +51,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_beta (bool): Indicated whether or not to use beta features
         Raises:
             labelbox.exceptions.AuthenticationError: If no `api_key`
                 is provided as an argument or via the environment
@@ -61,6 +63,10 @@ def __init__(self,
                     "Labelbox API key not provided")
             api_key = os.environ[_LABELBOX_API_KEY]
         self.api_key = api_key
+        self.enable_beta = enable_beta
+
+        if enable_beta:
+            logger.info("Beta features have been enabled")
 
         logger.info("Initializing Labelbox client at '%s'", endpoint)
 
@@ -74,7 +80,7 @@ def __init__(self,
 
     @retry.Retry(predicate=retry.if_exception_type(
         labelbox.exceptions.InternalServerError))
-    def execute(self, query, params=None, timeout=30.0, experimental=False):
+    def execute(self, query, params=None, timeout=30.0):
         """ Sends a request to the server for the execution of the
         given query.
 
@@ -86,8 +92,6 @@ def execute(self, query, params=None, timeout=30.0, experimental=False):
             params (dict): Query parameters referenced within the query.
             timeout (float): Max allowed time for query execution,
                 in seconds.
-            experimental (bool): Enables users to query experimental features.
-                Users should be aware that these features could change slightly over time.
         Returns:
             dict, parsed JSON response.
         Raises:
@@ -122,15 +126,7 @@ def convert_value(value):
         data = json.dumps({'query': query, 'variables': params}).encode('utf-8')
 
         try:
-            endpoint = self.endpoint
-
-            if experimental:
-                endpoint = self.endpoint.replace('graphql', '_gql')
-                logger.info(
-                    "Experimental queries/mutations aren't guarenteed to maintain their interface."
-                )
-
-            response = requests.post(endpoint,
+            response = requests.post(self.endpoint,
                                      data=data,
                                      headers=self.headers,
                                      timeout=timeout)

labelbox/orm/db_object.py

@@ -252,3 +252,20 @@ def delete(self):
         a call to this you should not use this DB object anymore.
         """
         type(self).bulk_delete([self])
+
+
+
+def beta(fn):
+    def wrapper(self, *args, **kwargs):
+        if not isinstance(self, DbObject):
+            raise TypeError("Cannot decorate functions that are not functions of `DbOjects` with `beta` decorator")
+        if not self.client.enable_beta:
+            logger.warning(
+                f"This function {fn.__name__} relies on a beta feature in the api. This means that the interface could change."
+                " Set `enable_beta=True` in the client to silence this warning.")
+            self.client.endpoint = self.client.endpoint.replace("/graphql", "/_gql")
+            result = fn(self, *args, **kwargs)
+            self.client.endpoint = self.client.endpoint.replace("/_gql", "/graphql")
+            return result
+    return wrapper
+    

labelbox/pagination.py

@@ -18,7 +18,7 @@ def __init__(self,
                  dereferencing,
                  obj_class,
                  cursor_path=None,
-                 experimental=False):
+                 beta=False):
         """ Creates a PaginatedCollection.
 
         Args:
@@ -40,7 +40,7 @@ def __init__(self,
         self.params = params
         self.dereferencing = dereferencing
         self.obj_class = obj_class
-        self.experimental = experimental
+        self.beta = beta
 
         self._fetched_all = False
         self._data = []
@@ -66,7 +66,7 @@ def __next__(self):
                 raise StopIteration()
 
             results = self.paginator.fetch_results(self.query, self.params,
-                                                   self.experimental)
+                                                   self.beta)
             page_data = self.get_page_data(results)
             self._data.extend(page_data)
             n_items = len(page_data)

labelbox/schema/invite.py

@@ -2,7 +2,7 @@
 from typing import Optional
 from datetime import datetime
 
-from labelbox.orm.db_object import DbObject
+from labelbox.orm.db_object import DbObject, beta
 from labelbox.orm.model import Field
 from labelbox.schema.role import ProjectRole
 
@@ -50,6 +50,7 @@ def __init__(self, client, invite_response):
             for r in project_roles
         ]
 
+    @beta
     def revoke(self):
         """ Makes the invitation invalid.
         """

labelbox/schema/organization.py

@@ -3,12 +3,14 @@
 from labelbox.exceptions import LabelboxError
 from labelbox import utils
 from labelbox.pagination import PaginatedCollection
-from labelbox.orm.db_object import DbObject
+from labelbox.orm.db_object import DbObject, beta
 from labelbox.orm.model import Field, Relationship
 from labelbox.schema.invite import Invite, InviteLimit, UserLimit, ProjectRole
 from labelbox.schema.user import User
 from labelbox.schema.role import Role
+import logging
 
+logger = logging.getLogger(__name__)
 
 class Organization(DbObject):
     """ An Organization is a group of Users.
@@ -43,6 +45,7 @@ def __init__(self, *args, **kwargs):
     projects = Relationship.ToMany("Project", True)
     webhooks = Relationship.ToMany("Webhook", False)
 
+    @beta
     def invites(self) -> PaginatedCollection:
         """ List all current invitees
         
@@ -97,6 +100,7 @@ def _assign_user_role(self, email: str, role: Role,
         invite_info = res['createInvites'][0]['invite']
         return invite_info
 
+    @beta
     def invite_user(
             self,
             email: str,
@@ -144,6 +148,7 @@ def invite_user(
         invite_response = self._assign_user_role(email, role, _project_roles)
         return Invite(self.client, invite_response)
 
+    @beta
     def user_limit(self) -> UserLimit:
         """ Retrieve user limits for the org
 
@@ -161,6 +166,7 @@ def user_limit(self) -> UserLimit:
                 ['account']['usersLimit'].items()
             })
 
+    @beta
     def invite_limit(self) -> InviteLimit:
         """ Retrieve invite limits for the org
         This already accounts for users currently in the org
@@ -178,6 +184,7 @@ def invite_limit(self) -> InviteLimit:
         return InviteLimit(
             **{utils.snake_case(k): v for k, v in res['invitesLimit'].items()})
 
+
     def remove_user(self, user: User):
         """
         Deletes a user from the organization. This cannot be undone without sending another invite.

labelbox/schema/project.py

@@ -13,7 +13,7 @@
 from labelbox.orm import query
 from labelbox.schema.bulk_import_request import BulkImportRequest
 from labelbox.exceptions import InvalidQueryError
-from labelbox.orm.db_object import DbObject, Updateable, Deletable
+from labelbox.orm.db_object import DbObject, Updateable, Deletable, beta
 from labelbox.orm.model import Entity, Field, Relationship
 from labelbox.pagination import PaginatedCollection
 
@@ -79,6 +79,7 @@ class Project(DbObject, Updateable, Deletable):
     predictions = Relationship.ToMany("Prediction", False)
     ontology = Relationship.ToOne("Ontology", True)
 
+    @beta
     def invites(self):
         """ Fetch all current invites for this project
         
@@ -97,8 +98,7 @@ def invites(self):
             self.client,
             query_str, {id_param: self.uid}, ['project', 'invites', 'nodes'],
             Invite,
-            cursor_path=['project', 'invites', 'nextCursor'],
-            experimental=True)
+            cursor_path=['project', 'invites', 'nextCursor'])
 
     def members(self):
         """ Fetch all current members for this project

labelbox/utils.py

@@ -1,3 +1,4 @@
+#from labelbox.orm.db_object import DbObject
 import re
 
 
@@ -23,3 +24,7 @@ def title_case(s):
 def snake_case(s):
     """ Converts a string in [snake|camel|title]case to snake_case. """
     return _convert(s, "_", lambda i: False)
+
+
+
+