Cleanup LabelingDashboard

Author: Val Brodsky

libs/labelbox/src/labelbox/__init__.py

@@ -43,4 +43,6 @@
 from labelbox.schema.identifiable import UniqueId, GlobalKey
 from labelbox.schema.ontology_kind import OntologyKind
 from labelbox.schema.project_overview import ProjectOverview, ProjectOverviewDetailed
-from labelbox.schema.labeling_service import LabelingService, LabelingServiceStatus
+from labelbox.schema.labeling_service import LabelingService
+from labelbox.schema.labeling_service_dashboard import LabelingServiceDashboard
+from labelbox.schema.labeling_service_status import LabelingServiceStatus

libs/labelbox/src/labelbox/client.py

@@ -20,7 +20,6 @@
 from labelbox import utils
 from labelbox.adv_client import AdvClient
 from labelbox.orm import query
-from labelbox.orm.comparison import Comparison
 from labelbox.orm.db_object import DbObject
 from labelbox.orm.model import Entity, Field
 from labelbox.pagination import PaginatedCollection
@@ -2395,6 +2394,17 @@ def upsert_label_feedback(self, label_id: str, feedback: str,
     def get_labeling_service_dashboards(
         self,
         after: Optional[str] = None,
-        where: Optional[Comparison] = None,
+        search_query: Optional[List[Dict]] = None,
     ) -> PaginatedCollection:
-        return LabelingServiceDashboard.get_all(self, after, where)
+        """
+        Get all labeling service dashboards for a given org.
+
+        Optional parameters:
+            after: The cursor to use for pagination.
+            where: A filter to apply to the query.
+
+        NOTE: support for after and search_query are not yet implemented.
+        """
+        return LabelingServiceDashboard.get_all(self,
+                                                after,
+                                                search_query=search_query)

libs/labelbox/src/labelbox/schema/labeling_service_dashboard.py

@@ -1,14 +1,10 @@
-from datetime import datetime
 from string import Template
+from datetime import datetime
 from typing import Any, Dict, List, Optional
 
 from labelbox.exceptions import ResourceNotFoundError
-from labelbox.orm.comparison import Comparison
-from labelbox.orm import query
-from ..orm.model import Field
 from labelbox.pagination import PaginatedCollection
-from labelbox.pydantic_compat import BaseModel, root_validator
-from .organization import Organization
+from labelbox.pydantic_compat import BaseModel, root_validator, Field
 from labelbox.utils import _CamelCaseMixin
 from labelbox.schema.labeling_service_status import LabelingServiceStatus
 
@@ -28,15 +24,29 @@
 
 
 class LabelingServiceDashboard(BaseModel):
-    id: str
-    name: str
-    # service_type: str
-    # created_at: datetime
-    # updated_at: datetime
-    # created_by_id: str
-    status: LabelingServiceStatus
-    tasks_completed: int
-    tasks_remaining: int
+    """
+    Represent labeling service data for a project
+
+    Attributes:
+        id (str): project id
+        name (str): project name
+        status (LabelingServiceStatus): status of the labeling service
+        tasks_completed (int): number of data rows completed
+        tasks_remaining (int): number of data rows that have not started
+        client (Any): labelbox client
+    """
+    id: str = Field(frozen=True)
+    name: str = Field(frozen=True)
+    service_type: Optional[str] = Field(frozen=True, default=None)
+    created_at: Optional[datetime] = Field(frozen=True, default=None)
+    updated_at: Optional[datetime] = Field(frozen=True, default=None)
+    created_by_id: Optional[str] = Field(frozen=True, default=None)
+    status: LabelingServiceStatus = Field(frozen=True,
+                                          default=LabelingServiceStatus.Missing)
+    data_rows_count: int = Field(frozen=True)
+    data_rows_in_review_count: int = Field(frozen=True)
+    data_rows_in_rework_count: int = Field(frozen=True)
+    data_rows_done_count: int = Field(frozen=True)
 
     client: Any  # type Any to avoid circular import from client
 
@@ -46,6 +56,14 @@ def __init__(self, **kwargs):
             raise RuntimeError(
                 "Please enable experimental in client to use LabelingService")
 
+    @property
+    def tasks_completed(self):
+        return self.data_rows_done_count
+
+    @property
+    def tasks_remaining(self):
+        return self.data_rows_count - self.data_rows_done_count
+
     class Config(_CamelCaseMixin.Config):
         ...
 
@@ -57,24 +75,14 @@ def get(cls, client, project_id: str) -> 'LabelingServiceDashboard':
         Raises:
             ResourceNotFoundError: If the project does not have a labeling service.
         """
-        query = """
-            query GetProjectByIdPyApi($id: ID!) {
-            getProjectById(input: {id: $id}) {
-                    id
-                    name
-                    # serviceType
-                    # createdAt
-                    # updatedAt
-                    # createdById
-                    boostStatus
-                    dataRowsCount
-                    dataRowsInReviewCount
-                    dataRowsInReworkCount
-                    dataRowsDoneCount
-                }
-            }
-        """
-        result = client.execute(query, {"id": project_id})
+        query = f"""
+                    query GetProjectByIdPyApi($id: ID!) {{
+                    getProjectById(input: {{id: $id}}) {{
+                        {GRAPHQL_QUERY_SELECTIONS}
+                        }}
+                    }}
+                """
+        result = client.execute(query, {"id": project_id}, experimental=True)
         if result["getProjectById"] is None:
             raise ResourceNotFoundError(
                 message="The project does not have a labeling service.")
@@ -87,7 +95,6 @@ def get_all(
         cls,
         client,
         after: Optional[str] = None,
-        # where: Optional[Comparison] = None,
         search_query: Optional[List[Dict]] = None,
     ) -> PaginatedCollection:
         template = Template(
@@ -121,16 +128,12 @@ def convert_to_labeling_service_dashboard(client, data):
             dereferencing=['searchProjects', 'nodes'],
             obj_class=convert_to_labeling_service_dashboard,
             cursor_path=['searchProjects', 'pageInfo', 'endCursor'],
+            experimental=True,
         )
 
     @root_validator(pre=True)
-    def convert_graphql_to_attrs(cls, data):
+    def convert_boost_status_to_enum(cls, data):
         if 'boostStatus' in data:
             data['status'] = LabelingServiceStatus(data.pop('boostStatus'))
-        if 'dataRowsDoneCount' in data:
-            data['tasksCompleted'] = data.pop('dataRowsDoneCount')
-        if 'dataRowsCount' in data and 'dataRowsInReviewCount' in data and 'dataRowsInReworkCount' in data:
-            data['tasksRemaining'] = data['dataRowsCount'] - (
-                data['dataRowsInReviewCount'] + data['dataRowsInReworkCount'])
 
         return data