dycw-utilities 0.150.15__tar.gz → 0.151.0__tar.gz

{dycw_utilities-0.150.15 → dycw_utilities-0.151.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dycw-utilities
-Version: 0.150.15
+Version: 0.151.0
 Author-email: Derek Wan <d.wan@icloud.com>
 License-File: LICENSE
 Requires-Python: >=3.12

{dycw_utilities-0.150.15 → dycw_utilities-0.151.0}/pyproject.toml

@@ -232,7 +232,7 @@ dependencies = [
 name = "dycw-utilities"
 readme = "README.md"
 requires-python = ">= 3.12"
-version = "0.150.15"
+version = "0.151.0"
 
 [project.entry-points.pytest11]
 pytest-randomly = "utilities.pytest_plugins.pytest_randomly"
@@ -265,7 +265,7 @@ test = [
 # bump-my-version
 [tool.bumpversion]
 allow_dirty = true
-current_version = "0.150.15"
+current_version = "0.151.0"
 
 [[tool.bumpversion.files]]
 filename = "src/utilities/__init__.py"

{dycw_utilities-0.150.15 → dycw_utilities-0.151.0}/src/tests/test_altair.py

@@ -28,7 +28,7 @@ from utilities.altair import (
 )
 from utilities.functions import ensure_class
 from utilities.hypothesis import dates, text_ascii, zoned_datetimes
-from utilities.polars import DatetimeUTC, zoned_datetime
+from utilities.polars import DatetimeUTC, zoned_datetime_dtype
 from utilities.tzdata import HongKong, Tokyo
 from utilities.whenever import get_now
 from utilities.zoneinfo import UTC
@@ -97,7 +97,10 @@ class TestPlotDataFrames:
     def test_auto_localization(self, *, time_zone: ZoneInfo) -> None:
         df = DataFrame(
             data=[(dt.datetime(2000, 1, 1, 12, tzinfo=time_zone), 0.0)],
-            schema={"datetime": zoned_datetime(time_zone=time_zone), "value": Float64},
+            schema={
+                "datetime": zoned_datetime_dtype(time_zone=time_zone),
+                "value": Float64,
+            },
             orient="row",
         )
         chart = plot_dataframes(df, x="datetime", y="value")

{dycw_utilities-0.150.15 → dycw_utilities-0.151.0}/src/tests/test_orjson.py

@@ -79,7 +79,7 @@ from utilities.orjson import (
     serialize,
     write_object,
 )
-from utilities.polars import check_polars_dataframe, zoned_datetime
+from utilities.polars import check_polars_dataframe, zoned_datetime_dtype
 from utilities.sentinel import Sentinel, sentinel
 from utilities.types import LogLevel, MaybeIterable, PathLike
 from utilities.typing import get_args
@@ -174,7 +174,7 @@ class TestGetLogRecords:
                 "level": UInt64,
                 "path_name": String,
                 "line_num": UInt64,
-                "datetime": zoned_datetime(time_zone=LOCAL_TIME_ZONE),
+                "datetime": zoned_datetime_dtype(time_zone=LOCAL_TIME_ZONE),
                 "func_name": String,
                 "stack_info": String,
                 "extra": Object,

{dycw_utilities-0.150.15 → dycw_utilities-0.151.0}/src/tests/test_polars.py

@@ -187,7 +187,8 @@ from utilities.polars import (
     week_num,
     write_dataframe,
     write_series,
-    zoned_datetime,
+    zoned_datetime_dtype,
+    zoned_datetime_period_dtype,
 )
 from utilities.random import get_state
 from utilities.sentinel import Sentinel, sentinel
@@ -1023,7 +1024,9 @@ class TestDataClassToDataFrame:
         ):
             df = dataclass_to_dataframe(objs, localns=locals())
         check_polars_dataframe(
-            df, height=len(objs), schema_list={"x": zoned_datetime(time_zone=time_zone)}
+            df,
+            height=len(objs),
+            schema_list={"x": zoned_datetime_dtype(time_zone=time_zone)},
         )
 
     def test_error_empty(self) -> None:
@@ -1117,7 +1120,7 @@ class TestDataClassToSchema:
 
         obj = Example()
         result = dataclass_to_schema(obj)
-        expected = {"x": zoned_datetime(time_zone=time_zone)}
+        expected = {"x": zoned_datetime_dtype(time_zone=time_zone)}
         assert result == expected
 
     def test_enum(self) -> None:
@@ -1249,7 +1252,7 @@ class TestDataClassToSchema:
 
         obj = Example()
         result = dataclass_to_schema(obj)
-        expected = {"x": zoned_datetime(time_zone=time_zone)}
+        expected = {"x": zoned_datetime_dtype(time_zone=time_zone)}
         assert result == expected
 
     @given(start=timezones(), end=timezones())
@@ -1269,12 +1272,7 @@ class TestDataClassToSchema:
 
         obj = Outer()
         result = dataclass_to_schema(obj, localns=locals())
-        expected = {
-            "inner": Struct({
-                "start": zoned_datetime(time_zone=start),
-                "end": zoned_datetime(time_zone=end),
-            })
-        }
+        expected = {"inner": zoned_datetime_period_dtype(time_zone=(start, end))}
         assert result == expected
 
     def test_containers(self) -> None:
@@ -1490,7 +1488,7 @@ class TestGetDataTypeOrSeriesTimeZone:
     def test_main(
         self, *, time_zone: ZoneInfo, case: Literal["dtype", "series"]
     ) -> None:
-        dtype = zoned_datetime(time_zone=time_zone)
+        dtype = zoned_datetime_dtype(time_zone=time_zone)
         match case:
             case "dtype":
                 dtype_or_series = dtype
@@ -2823,9 +2821,15 @@ class TestWeekNum:
         assert_series_equal(result, expected)
 
 
-class TestZonedDateTime:
-    @given(time_zone=sampled_from([HongKong, UTC]))
-    def test_main(self, *, time_zone: ZoneInfo) -> None:
-        dtype = zoned_datetime(time_zone=time_zone)
+class TestZonedDateTimeDType:
+    def test_main(self) -> None:
+        dtype = zoned_datetime_dtype(time_zone=UTC)
         assert isinstance(dtype, Datetime)
         assert dtype.time_zone is not None
+
+
+class TestZonedDateTimePeriodDType:
+    @given(time_zone=sampled_from([UTC, (UTC, UTC)]))
+    def test_main(self, *, time_zone: ZoneInfo | tuple[ZoneInfo, ZoneInfo]) -> None:
+        dtype = zoned_datetime_period_dtype(time_zone=time_zone)
+        assert isinstance(dtype, Struct)

{dycw_utilities-0.150.15 → dycw_utilities-0.151.0}/src/utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.150.15"
+__version__ = "0.151.0"

{dycw_utilities-0.150.15 → dycw_utilities-0.151.0}/src/utilities/polars.py

@@ -1097,7 +1097,7 @@ def _dataclass_to_schema_datetime(
 ) -> PolarsDataType:
     if field.value.tzinfo is None:
         return Datetime
-    return zoned_datetime(time_zone=ensure_time_zone(field.value.tzinfo))
+    return zoned_datetime_dtype(time_zone=ensure_time_zone(field.value.tzinfo))
 
 
 def _dataclass_to_schema_one(
@@ -2259,7 +2259,7 @@ def _struct_from_dataclass_one(
     if ann is dt.datetime:
         if time_zone is None:
             raise _StructFromDataClassTimeZoneMissingError
-        return zoned_datetime(time_zone=time_zone)
+        return zoned_datetime_dtype(time_zone=time_zone)
     if is_dataclass_class(ann):
         return struct_from_dataclass(ann, time_zone=time_zone)
     if (isinstance(ann, type) and issubclass(ann, enum.Enum)) or (
@@ -2388,13 +2388,30 @@ def week_num(column: IntoExprColumn, /, *, start: WeekDay = "mon") -> Expr | Ser
 ##
 
 
-def zoned_datetime(
+def zoned_datetime_dtype(
     *, time_unit: TimeUnit = "us", time_zone: TimeZoneLike = UTC
 ) -> Datetime:
     """Create a zoned datetime data type."""
     return Datetime(time_unit=time_unit, time_zone=get_time_zone_name(time_zone))
 
 
+def zoned_datetime_period_dtype(
+    *,
+    time_unit: TimeUnit = "us",
+    time_zone: TimeZoneLike | tuple[TimeZoneLike, TimeZoneLike] = UTC,
+) -> Struct:
+    """Create a zoned datetime period data type."""
+    match time_zone:
+        case start, end:
+            return struct_dtype(
+                start=zoned_datetime_dtype(time_unit=time_unit, time_zone=start),
+                end=zoned_datetime_dtype(time_unit=time_unit, time_zone=end),
+            )
+        case _:
+            dtype = zoned_datetime_dtype(time_unit=time_unit, time_zone=time_zone)
+            return struct_dtype(start=dtype, end=dtype)
+
+
 __all__ = [
     "BooleanValueCountsError",
     "CheckPolarsDataFrameError",
@@ -2470,5 +2487,6 @@ __all__ = [
     "unique_element",
     "write_dataframe",
     "write_series",
-    "zoned_datetime",
+    "zoned_datetime_dtype",
+    "zoned_datetime_period_dtype",
 ]

{dycw_utilities-0.150.15 → dycw_utilities-0.151.0}/src/utilities/sqlalchemy_polars.py

@@ -35,7 +35,7 @@ from utilities.iterables import (
     chunked,
     one,
 )
-from utilities.polars import zoned_datetime
+from utilities.polars import zoned_datetime_dtype
 from utilities.reprlib import get_repr
 from utilities.sqlalchemy import (
     CHUNK_SIZE_FRAC,
@@ -390,7 +390,7 @@ def _select_to_dataframe_map_table_column_type_to_dtype(
         return pl.Date
     if is_subclass_gen(py_type, dt.datetime):
         has_tz: bool = type_use.timezone
-        return zoned_datetime(time_zone=time_zone) if has_tz else Datetime()
+        return zoned_datetime_dtype(time_zone=time_zone) if has_tz else Datetime()
     if issubclass(py_type, dt.time):
         return Time
     if issubclass(py_type, dt.timedelta):