feat(types): add datetime.date and datetime.datetime support for Tag values (ITL-45) (#188)

Author: kurodo3[bot]

pyproject.toml

@@ -20,7 +20,7 @@ dependencies = [
     "graphviz>=0.21",
     "gitpython>=3.1.45",
     "universal-pathlib>=0.3.8",
-    "starfix~=0.3.0",
+    "starfix~=0.4.0",
     "pygraphviz>=1.14",
     "tzdata>=2024.1",
     "uuid-utils>=0.11.1",

src/orcapod/semantic_types/universal_converter.py

@@ -17,7 +17,7 @@
 import types
 import typing
 from collections.abc import Callable, Iterable, Mapping
-from datetime import datetime, timezone
+from datetime import date, datetime, timezone
 
 # Handle generic types
 from typing import TYPE_CHECKING, Any, TypedDict, get_args, get_origin
@@ -89,6 +89,7 @@ def _get_python_to_arrow_map() -> dict:
         "date": pa.date32(),
         "datetime": pa.timestamp("us", tz="UTC"),
         datetime: pa.timestamp("us", tz="UTC"),
+        date: pa.date32(),
     }
 
     # Add numpy types if available
@@ -1201,6 +1202,8 @@ def _convert_arrow_to_python(self, arrow_type: pa.DataType) -> type | Any:
             else:
                 return typing.Union[tuple(child_types)]
 
+        elif pa.types.is_date(arrow_type):
+            return date
         elif pa.types.is_timestamp(arrow_type):
             return datetime
 

src/orcapod/types.py

@@ -16,7 +16,7 @@
 import uuid
 from collections.abc import Collection, Iterator, Mapping
 from dataclasses import dataclass
-from datetime import datetime
+from datetime import date, datetime
 from enum import Enum
 from types import UnionType
 from typing import TYPE_CHECKING, Any, Generic, Self, TypeAlias, TypeVar
@@ -42,20 +42,19 @@
 """Convenience alias for any filesystem-path-like object (``str`` or
 ``os.PathLike``)."""
 
-# TODO: accomodate other common data types such as datetime
-TagValue: TypeAlias = int | str | None | Collection["TagValue"]
-"""A tag metadata value: an int, string, ``None``, or an arbitrarily nested
-collection thereof. Tags are used to label and organise data and
-datagrams."""
+TagValue: TypeAlias = int | str | date | datetime | None | Collection["TagValue"]
+"""A tag metadata value: an int, string, date, datetime, ``None``, or an
+arbitrarily nested collection thereof. Tags are used to label and organise
+data and datagrams."""
 
 PathSet: TypeAlias = PathLike | Collection[PathLike | None]
 """A single path or an arbitrarily nested collection of paths (with optional
 ``None`` entries). Used when operations need to address multiple files at
 once, e.g. batch hashing."""
 
-SupportedNativePythonData: TypeAlias = str | int | float | bool | bytes
+SupportedNativePythonData: TypeAlias = str | int | float | bool | bytes | date | datetime
 """The simple Python scalar types that have a direct Arrow / Polars
-correspondence."""
+correspondence, including temporal types (date and datetime)."""
 
 ExtendedSupportedPythonData: TypeAlias = SupportedNativePythonData | PathSet
 """Native scalar types extended with filesystem paths."""