Use datetime instead of zone

Author: Val Brodsky

libs/labelbox/src/labelbox/schema/search_filters.py

@@ -2,7 +2,8 @@
 from enum import Enum
 from typing import List, Literal, Union
 
-from labelbox.pydantic_compat import BaseModel, Field
+from labelbox.pydantic_compat import BaseModel
+from labelbox.utils import format_iso_datetime
 
 
 class BaseSearchFilter(BaseModel):
@@ -17,8 +18,8 @@ def dict(self, *args, **kwargs):
 
         # go through all the keys and convert date to string
         for key in res:
-            if isinstance(res[key], datetime.date):
-                res[key] = res[key].isoformat()
+            if isinstance(res[key], datetime.datetime):
+                res[key] = format_iso_datetime(res[key])
         return res
 
 
@@ -71,8 +72,7 @@ class ProjectStageFilter(BaseSearchFilter):
 
 class DateValue(BaseSearchFilter):
     operator: DateOperator
-    value: datetime.date
-    # timezone: TimeZoneName = Field(default=TimeZoneName.UTC)  # type: ignore
+    value: datetime.datetime
 
 
 class WorkforceStageUpdatedFilter(BaseSearchFilter):
@@ -86,8 +86,8 @@ class WorkforceRequestedDateFilter(BaseSearchFilter):
 
 
 class DateRange(BaseSearchFilter):
-    min: datetime.date
-    max: datetime.date
+    min: datetime.datetime
+    max: datetime.datetime
 
 
 class DateRangeValue(BaseSearchFilter):
@@ -97,13 +97,11 @@ class DateRangeValue(BaseSearchFilter):
 
 class WorkforceRequestedDateRangeFilter(BaseSearchFilter):
     operation: Literal[OperationType.WorforceRequestedDate]
-    # timezone: TimeZoneName = Field(default=TimeZoneName.UTC)  # type: ignore
     value: DateRangeValue
 
 
 class WorkforceStageUpdatedRangeFilter(BaseSearchFilter):
     operation: Literal[OperationType.WorkforceStageUpdatedDate]
-    # timezone: TimeZoneName = Field(default=TimeZoneName.UTC)  # type: ignore
     value: DateRangeValue
 
 

libs/labelbox/tests/unit/test_unit_search_filters.py

@@ -1,3 +1,4 @@
+from datetime import date, datetime
 from labelbox.schema.search_filters import DateOperator, DateRange, DateRangeOperator, DateRangeValue, DateValue, IdOperator, OperationType, OrganizationFilter, ProjectStageFilter, TagFilter, WorkforceRequestedDateFilter, WorkforceRequestedDateRangeFilter, WorkforceStageUpdatedFilter, WorkforceStageUpdatedRangeFilter, WorkspaceFilter, build_search_filter
 
 
@@ -17,80 +18,42 @@ def test_id_filters():
                            values=["requested"]),
     ]
 
-    assert build_search_filter(filters) == [{
-        "operator": "is",
-        "values": ["clphb4vd7000cd2wv1ktu5cwa"],
-        "type": "organization"
-    }, {
-        "operator": "is",
-        "values": ["clphb4vd7000cd2wv1ktu5cwa"],
-        "type": "workspace"
-    }, {
-        "operator": "is",
-        "values": ["tag"],
-        "type": "tag"
-    }, {
-        "operator": "is",
-        "values": ["requested"],
-        "type": "stage"
-    }]
+    assert build_search_filter(
+        filters
+    ) == '[{operator: "is", values: ["clphb4vd7000cd2wv1ktu5cwa"], type: "organization"}, {operator: "is", values: ["clphb4vd7000cd2wv1ktu5cwa"], type: "workspace"}, {operator: "is", values: ["tag"], type: "tag"}, {operator: "is", values: ["requested"], type: "stage"}]'
 
 
 def test_date_filters():
     filters = [
         WorkforceRequestedDateFilter(
             operation=OperationType.WorforceRequestedDate,
             value=DateValue(operator=DateOperator.GreaterThanOrEqual,
-                            value="2024-01-01")),
+                            value=datetime.strptime("2024-01-01", "%Y-%m-%d"))),
         WorkforceStageUpdatedFilter(
             operation=OperationType.WorkforceStageUpdatedDate,
             value=DateValue(operator=DateOperator.LessThanOrEqual,
-                            value="2025-01-01")),
+                            value=datetime.strptime("2025-01-01", "%Y-%m-%d"))),
     ]
-    assert build_search_filter(filters) == [{
-        "type": "workforce_requested_at",
-        "value": {
-            "operator": "GREATER_THAN_OR_EQUAL",
-            "value": "2024-01-01",
-        }
-    }, {
-        "type": "workforce_stage_updated_at",
-        "value": {
-            "operator": "LESS_THAN_OR_EQUAL",
-            "value": "2025-01-01",
-        }
-    }]
+    assert build_search_filter(
+        filters
+    ) == '[{value: {operator: "GREATER_THAN_OR_EQUAL", value: "2024-01-01T08:00:00Z"}, type: "workforce_requested_at"}, {value: {operator: "LESS_THAN_OR_EQUAL", value: "2025-01-01T08:00:00Z"}, type: "workforce_stage_updated_at"}]'
 
 
 def test_date_range_filters():
     filters = [
         WorkforceRequestedDateRangeFilter(
             operation=OperationType.WorforceRequestedDate,
-            value=DateRangeValue(operator=DateRangeOperator.Between,
-                                 value=DateRange(min="2024-01-01",
-                                                 max="2025-01-01"))),
+            value=DateRangeValue(
+                operator=DateRangeOperator.Between,
+                value=DateRange(min=datetime.strptime("2024-01-01", "%Y-%m-%d"),
+                                max=datetime.strptime("2025-01-01",
+                                                      "%Y-%m-%d")))),
         WorkforceStageUpdatedRangeFilter(
             operation=OperationType.WorkforceStageUpdatedDate,
             value=DateRangeValue(operator=DateRangeOperator.Between,
-                                 value=DateRange(min="2024-01-01",
-                                                 max="2025-01-01")))
+                                 value=DateRange(min="2024-01-01T08:00:00Z",
+                                                 max="2025-01-01T08:00:00Z")))
     ]
-    assert build_search_filter(filters) == [{
-        "value": {
-            "operator": "BETWEEN",
-            "value": {
-                "min": "2024-01-01",
-                "max": "2025-01-01"
-            }
-        },
-        "type": "workforce_requested_at"
-    }, {
-        "value": {
-            "operator": "BETWEEN",
-            "value": {
-                "min": "2024-01-01",
-                "max": "2025-01-01"
-            }
-        },
-        "type": "workforce_stage_updated_at"
-    }]
+    assert build_search_filter(
+        filters
+    ) == '[{value: {operator: "BETWEEN", value: {min: "2024-01-01T08:00:00Z", max: "2025-01-01T08:00:00Z"}}, type: "workforce_requested_at"}, {value: {operator: "BETWEEN", value: {min: "2024-01-01T08:00:00Z", max: "2025-01-01T08:00:00Z"}}, type: "workforce_stage_updated_at"}]'