clean up

Author: Matt Sokoloff

labelbox/orm/db_object.py

@@ -1,8 +1,6 @@
-from dataclasses import field
 from datetime import datetime, timezone
 from functools import partial
 import logging
-from os import EX_CANTCREAT
 
 from labelbox import utils
 from labelbox.exceptions import InvalidQueryError, InvalidAttributeError
@@ -48,7 +46,7 @@ def __init__(self, client, field_values):
 
         for relationship in self.relationships():
             value = field_values.get(relationship.name)
-            if relationship.precompute and value is None:
+            if relationship.cache and value is None:
                 raise KeyError(
                     f"Expected field  values for {relationship.name}")
 

labelbox/orm/model.py

@@ -184,7 +184,7 @@ class Relationship:
         name (str): Name of the relationship in the snake_case format.
         graphql_name (str): Name of the relationships server-side. Most often
             (not always) just a camelCase version of `name`.
-        precompute (bool) : Whether or not to precompute the relationship.
+        cache (bool) : Whether or not to cache the relationship values.
             Useful for objects that aren't directly queryable from the api (relationship query builder won't work)
             Also useful for expensive ToOne relationships 
 
@@ -195,10 +195,8 @@ class Type(Enum):
         ToMany = auto()
 
     @staticmethod
-    def ToOne(*args, precompute=False):
-        return Relationship(Relationship.Type.ToOne,
-                            *args,
-                            precompute=precompute)
+    def ToOne(*args, cache=False):
+        return Relationship(Relationship.Type.ToOne, *args, cache=cache)
 
     @staticmethod
     def ToMany(*args):
@@ -210,11 +208,11 @@ def __init__(self,
                  filter_deleted=True,
                  name=None,
                  graphql_name=None,
-                 precompute=False):
+                 cache=False):
         self.relationship_type = relationship_type
         self.destination_type_name = destination_type_name
         self.filter_deleted = filter_deleted
-        self.precompute = precompute
+        self.cache = cache
 
         if name is None:
             name = utils.snake_case(destination_type_name) + (

labelbox/schema/invite.py

@@ -1,6 +1,4 @@
 from dataclasses import dataclass
-from typing import Optional
-from datetime import datetime
 
 from labelbox.orm.db_object import DbObject, beta
 from labelbox.orm.model import Field

labelbox/schema/organization.py

@@ -1,8 +1,7 @@
-from typing import Any, Dict, List, Optional
+from typing import List, Optional
 
 from labelbox.exceptions import LabelboxError
 from labelbox import utils
-from labelbox.pagination import PaginatedCollection
 from labelbox.orm.db_object import DbObject, beta
 from labelbox.orm.model import Field, Relationship
 from labelbox.schema.invite import Invite, InviteLimit, ProjectRole

labelbox/schema/project.py

@@ -9,11 +9,10 @@
 
 from labelbox import utils
 from labelbox.schema.data_row import DataRow
-from labelbox.schema.invite import Invite
 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, beta
+from labelbox.orm.db_object import DbObject, Updateable, Deletable
 from labelbox.orm.model import Entity, Field, Relationship
 from labelbox.pagination import PaginatedCollection
 
@@ -630,8 +629,8 @@ def _is_url_valid(url: Union[str, Path]) -> bool:
 
 
 class ProjectMember(DbObject):
-    user = Relationship.ToOne("User", precompute=True)
-    role = Relationship.ToOne("Role", precompute=True)
+    user = Relationship.ToOne("User", cache=True)
+    role = Relationship.ToOne("Role", cache=True)
 
 
 class LabelingParameterOverride(DbObject):

labelbox/schema/role.py

@@ -68,5 +68,5 @@ class UserRole(Role):
 
 @dataclass
 class ProjectRole:
-    project: "Project"
+    project: Project
     role: Role

tests/integration/conftest.py

@@ -1,17 +1,16 @@
 from collections import namedtuple
 from enum import Enum
 from datetime import datetime
-from labelbox.orm.model import Entity
-from labelbox.orm.query import Query, results_query_part
-from labelbox.schema.invite import Invite
-from labelbox.pagination import PaginatedCollection
-import os
 from random import randint
-import re
 from string import ascii_letters
+import os
+import re
 
 import pytest
 
+from labelbox.orm.query import results_query_part
+from labelbox.schema.invite import Invite
+from labelbox.pagination import PaginatedCollection
 from labelbox.schema.user import User
 from labelbox import Client
 
@@ -49,15 +48,19 @@ def testing_api_key(environ: str) -> str:
         return os.environ["LABELBOX_TEST_API_KEY_PROD"]
     return os.environ["LABELBOX_TEST_API_KEY_STAGING"]
 
+
 def beta_endpoint(fn):
-    def beta(client,*args, **kwargs):
+
+    def beta(client, *args, **kwargs):
         try:
             client.endpoint = client.endpoint.replace("/graphql", "/_gql")
-            return fn(client, *args, **kwargs) 
+            return fn(client, *args, **kwargs)
         finally:
             client.endpoint = client.endpoint.replace("/_gql", "/graphql")
+
     return beta
 
+
 @beta_endpoint
 def cancel_invite(client, invite_id):
     """
@@ -67,6 +70,7 @@ def cancel_invite(client, invite_id):
             cancelInvite(where: $where) {id}}"""
     client.execute(query_str, {'where': {'id': invite_id}})
 
+
 @beta_endpoint
 def get_project_invites(client, project_id):
     """
@@ -78,11 +82,13 @@ def get_project_invites(client, project_id):
         invites(from: $from, first: $first) { nodes { %s
         projectInvites { projectId projectRoleName } } nextCursor}}}
     """ % (id_param, id_param, results_query_part(Invite))
-    return list(PaginatedCollection(
-        client,
-            query_str, {id_param: project_id}, ['project', 'invites', 'nodes'],
-            Invite,
-            cursor_path=['project', 'invites', 'nextCursor']))
+    return list(
+        PaginatedCollection(client,
+                            query_str, {id_param: project_id},
+                            ['project', 'invites', 'nodes'],
+                            Invite,
+                            cursor_path=['project', 'invites', 'nextCursor']))
+
 
 @beta_endpoint
 def get_invites(client):
@@ -93,11 +99,13 @@ def get_invites(client):
             organization { id invites(from: $from, first: $first) { 
                 nodes { id createdAt organizationRoleName inviteeEmail } nextCursor }}}"""
     invites = PaginatedCollection(
-            client,
-            query_str, {}, ['organization', 'invites', 'nodes'],
-            Invite,
-            cursor_path=['organization', 'invites', 'nextCursor'])
-    return list(invites) # list() so that it makes the request to the right endpoint.
+        client,
+        query_str, {}, ['organization', 'invites', 'nodes'],
+        Invite,
+        cursor_path=['organization', 'invites', 'nextCursor'])
+    return list(
+        invites)  # list() so that it makes the request to the right endpoint.
+
 
 class IntegrationClient(Client):
 
@@ -188,6 +196,7 @@ def organization(client):
         if "@labelbox.com" in invite.email:
             cancel_invite(client, invite.uid)
 
+
 @pytest.fixture
 def project_based_user(client, rand_gen):
     email = rand_gen(str)
@@ -211,6 +220,7 @@ def project_based_user(client, rand_gen):
     yield user
     client.get_organization().remove_user(user)
 
+
 @pytest.fixture
 def project_pack(client):
     projects = [

tests/integration/test_user_management.py

@@ -4,7 +4,6 @@
 from labelbox import ProjectRole
 
 
-
 def test_org_invite(client, organization, environ):
     role = client.get_roles()['LABELER']
     dummy_email = "none@labelbox.com"
@@ -23,7 +22,7 @@ def test_org_invite(client, organization, environ):
         # One user added
         assert invite_limit.remaining - invite_limit_after.remaining == 1
         # An invite shouldn't effect the user count until after it is accepted
-    
+
     outstanding_invites = get_invites(client)
     in_list = False
     for invite in outstanding_invites: