Merge pull request #889 from Labelbox/ms/last-activity

last activity filter

Author: msokoloff1

CHANGELOG.md

@@ -1,6 +1,9 @@
 # Changelog
 
 # Version 3.37.0 (2023-xx-xx)
+## Added
+* New `last_activity_start` param to `project.export_labels()` for filtering which labels are exported. See docstring for more on how this works. 
+
 ## Changed
 * Rename `Classification.instructions` to `Classification.name`
 

labelbox/schema/project.py

@@ -301,6 +301,10 @@ def export_labels(self,
             timeout_seconds (float): Max waiting time, in seconds.
             start (str): Earliest date for labels, formatted "YYYY-MM-DD" or "YYYY-MM-DD hh:mm:ss"
             end (str): Latest date for labels, formatted "YYYY-MM-DD" or "YYYY-MM-DD hh:mm:ss"
+            last_activity_start (str): Will include all labels that have had any updates to
+              data rows, issues, comments, metadata, or reviews since this timestamp.
+              formatted "YYYY-MM-DD" or "YYYY-MM-DD hh:mm:ss"
+
         Returns:
             URL of the data file with this Project's labels. If the server didn't
             generate during the `timeout_seconds` period, None is returned.
@@ -346,6 +350,12 @@ def _validate_datetime(string_date: str) -> bool:
             filter_param_dict["labelCreatedAt"] = "{%s}" % _string_from_dict(
                 created_at_dict, value_with_quotes=True)
 
+        if "last_activity_start" in kwargs:
+            last_activity_start = kwargs['last_activity_start']
+            _validate_datetime(last_activity_start)
+            filter_param_dict["lastActivityAt"] = "{%s}" % _string_from_dict(
+                {"start": last_activity_start}, value_with_quotes=True)
+
         if filter_param_dict:
             filter_param = """, filters: {%s }""" % (_string_from_dict(
                 filter_param_dict, value_with_quotes=False))
@@ -355,6 +365,7 @@ def _validate_datetime(string_date: str) -> bool:
         """ % (id_param, id_param, filter_param)
 
         start_time = time.time()
+
         while True:
             res = self.client.execute(query_str, {id_param: self.uid})
             res = res["exportLabels"]

tests/integration/test_export.py

@@ -1,4 +1,5 @@
 import uuid
+import datetime
 
 from labelbox.data.annotation_types.annotation import ObjectAnnotation
 from labelbox.schema.annotation_import import LabelImport
@@ -98,3 +99,47 @@ def test_export_filtered_dates(client,
                                          start="2020-01-01",
                                          end="2020-01-02")
     assert len(empty_export) == 0
+
+
+def test_export_filtered_activity(client,
+                                  configured_project_with_complex_ontology):
+    project, data_row = configured_project_with_complex_ontology
+    ontology = project.ontology().normalized
+
+    tool = ontology["tools"][0]
+
+    data = [{
+        "uuid": str(uuid.uuid4()),
+        "schemaId": tool['featureSchemaId'],
+        "dataRow": {
+            "id": data_row.uid
+        },
+        "bbox": {
+            "top": 20,
+            "left": 20,
+            "height": 50,
+            "width": 50
+        }
+    }]
+
+    task = LabelImport.create_from_objects(client, project.uid,
+                                           f'label-import-{uuid.uuid4()}', data)
+    task.wait_until_done()
+
+    regular_export = project.export_labels(download=True)
+    assert len(regular_export) == 1
+
+    filtered_export = project.export_labels(download=True,
+                                            last_activity_start="2020-01-01")
+    assert len(filtered_export) == 1
+
+    filtered_export_with_time = project.export_labels(
+        download=True, last_activity_start="2020-01-01 00:00:01")
+    assert len(filtered_export_with_time) == 1
+
+    empty_export = project.export_labels(
+        download=True,
+        last_activity_start=(datetime.datetime.now() +
+                             datetime.timedelta(days=1)).strftime("%Y-%m-%d"),
+    )
+    assert len(empty_export) == 0