Add get project_overview to retrieve the values of the Overview tab (#1615)

Author: paulnoirel

docs/labelbox/project-overview.rst

@@ -0,0 +1,6 @@
+ProjectOverview
+===============================================================================================
+
+.. automodule:: labelbox.schema.project-overview
+   :members:
+   :show-inheritance:

libs/labelbox/src/labelbox/schema/project.py

@@ -39,6 +39,7 @@
 from labelbox.schema.task import Task
 from labelbox.schema.task_queue import TaskQueue
 from labelbox.schema.ontology_kind import (EditorTaskType, OntologyKind)
+from labelbox.schema.project_overview import ProjectOverview
 
 if TYPE_CHECKING:
     from labelbox import BulkImportRequest
@@ -1746,6 +1747,63 @@ def __check_data_rows_have_been_processed(
         return response["queryAllDataRowsHaveBeenProcessed"][
             "allDataRowsHaveBeenProcessed"]
 
+    def get_overview(self) -> ProjectOverview:
+        """ Return the number of data rows per task queue, and issues of a project
+            Equivalent of the Overview tab of a project
+
+                Args:
+                    with_issues: (optional) boolean to include issues in the overview
+                Returns:
+                    Object Project_Overview
+                """
+
+        query = """query ProjectGetOverviewPyApi($projectId: ID!) {
+            project(where: { id: $projectId }) {      
+            workstreamStateCounts {
+                state
+                count
+            }
+            taskQueues {
+                queueType
+                name
+                dataRowCount
+            }
+            issues {
+                totalCount
+            }
+            completedDataRowCount
+            }
+        }
+        """
+
+        # Must use experimental to access "issues"
+        result = self.client.execute(query, {"projectId": self.uid},
+                                     experimental=True)["project"]
+
+        overview = {
+            utils.snake_case(st["state"]): st["count"]
+            for st in result.get("workstreamStateCounts")
+            if st["state"] != "NotInTaskQueue"
+        }
+
+        review_queues = {
+            tq["name"]: tq.get("dataRowCount")
+            for tq in result.get("taskQueues")
+            if tq.get("queueType") == "MANUAL_REVIEW_QUEUE"
+        }
+
+        # Store the total number of data rows in review
+        review_queues["all"] = overview.get("in_review")
+        overview["in_review"] = review_queues
+
+        overview["issues"] = result.get("issues", {}).get("totalCount")
+
+        # Rename keys
+        overview["to_label"] = overview.pop("unlabeled")
+        overview["all_in_data_rows"] = overview.pop("all")
+
+        return ProjectOverview(**overview)
+
 
 class ProjectMember(DbObject):
     user = Relationship.ToOne("User", cache=True)

libs/labelbox/src/labelbox/schema/project_overview.py

@@ -0,0 +1,38 @@
+from typing import Dict
+from labelbox.pydantic_compat import BaseModel
+
+from typing import Dict
+
+class ProjectOverview(BaseModel):
+    """
+    Class that represents a project summary as displayed in the UI, in Annotate, 
+    under the "Overview" tab of a particular project.
+
+    All attributes represent the number of data rows in the corresponding state.
+    The `in_review` attribute is a dictionary where the keys are the queue names
+    and the values are the number of data rows in that queue.
+
+    Attributes:
+        Representing existing fields from the Overview tag (UI names in parentheses):
+
+        to_label (int): The number of data rows that are yet to be labeled (To Label).
+        in_review (Dict[str, int]): A dictionary where the keys are the queue names .
+            and the values are the number of data rows in that queue. (In Review)
+        in_rework (int): The number of data rows that are in the Rework queue (In Rework).
+        skipped (int): The number of data rows that have been skipped (Skipped).
+        done (int): The number of data rows that have been marked as Done (Done).
+        issues (int): The number of data rows with associated issues (Issues).
+        
+        Additional values:
+
+        labeled (int): The number of data rows that have been labeled.
+        all_in_data_rows (int): The total number of data rows in the project.
+    """
+    to_label: int   
+    in_review: Dict[str, int]
+    in_rework: int
+    skipped: int
+    done: int
+    issues: int
+    labeled: int
+    all_in_data_rows: int

libs/labelbox/tests/integration/test_task_queue.py

@@ -1,5 +1,4 @@
 import time
-
 from labelbox import Project
 from labelbox.schema.identifiables import GlobalKeys, UniqueIds
 
@@ -12,6 +11,19 @@ def test_get_task_queue(project: Project):
     assert review_queue
 
 
+def test_get_overview(project: Project):
+    po = project.get_overview()
+
+    assert isinstance(po.to_label, int)
+    assert isinstance(po.in_review, dict)
+    assert isinstance(po.in_rework, int)
+    assert isinstance(po.skipped, int)
+    assert isinstance(po.done, int)
+    assert isinstance(po.issues, int)
+    assert isinstance(po.labeled, int)
+    assert isinstance(po.all_in_data_rows, int)
+
+
 def _validate_moved(project, queue_name, data_row_count):
     timeout_seconds = 30
     sleep_time = 2