dycw-utilities 0.109.13__tar.gz → 0.109.14__tar.gz

{dycw_utilities-0.109.13 → dycw_utilities-0.109.14}/PKG-INFO

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

{dycw_utilities-0.109.13 → dycw_utilities-0.109.14}/pyproject.toml

@@ -29,6 +29,7 @@ dev = [
   "httpx >= 0.28.1, < 0.29",  # for fastapi
   "hypothesis >= 6.131.7, < 6.132",
   "img2pdf >= 0.6.0, < 0.7",
+  "lightweight-charts >= 2.1, < 2.2",
   "loguru >= 0.7.3, < 0.8",
   "luigi >= 3.6.0, < 3.7",
   "memory-profiler >= 0.61.0, < 0.62",
@@ -91,7 +92,7 @@ dependencies = [
 name = "dycw-utilities"
 readme = "README.md"
 requires-python = ">= 3.12"
-version = "0.109.13"
+version = "0.109.14"
 
 [project.optional-dependencies]
 test = [
@@ -334,7 +335,7 @@ zzz-test-zoneinfo = [
 # bump-my-version
 [tool.bumpversion]
 allow_dirty = true
-current_version = "0.109.13"
+current_version = "0.109.14"
 
 [[tool.bumpversion.files]]
 filename = "src/utilities/__init__.py"

{dycw_utilities-0.109.13 → dycw_utilities-0.109.14}/src/tests/test_iterables.py

@@ -1058,7 +1058,7 @@ class TestOne:
 
     @given(args=sampled_from([([],), ([], []), ([], [], [])]))
     def test_error_empty(self, *, args: tuple[Iterable[Any], ...]) -> None:
-        with raises(OneEmptyError, match=r"Iterable\(s\) must not be empty"):
+        with raises(OneEmptyError, match=r"Iterable\(s\) .* must not be empty"):
             _ = one(*args)
 
     @given(iterable=sets(integers(), min_size=2))

dycw_utilities-0.109.14/src/tests/test_lightweight_charts.py

@@ -0,0 +1,64 @@
+from __future__ import annotations
+
+import datetime as dt
+from typing import cast
+
+from lightweight_charts import Chart
+from polars import DataFrame, Date, Float64, Int64, col
+from pytest import fixture, raises
+
+from utilities.lightweight_charts import (
+    _SetDataFrameEmptyError,
+    _SetDataFrameNonUniqueError,
+    set_dataframe,
+)
+
+
+@fixture
+def df() -> DataFrame:
+    data = [
+        (dt.date(2000, 1, 1), 5824.0, 5824.75, 5823.75, 5824.25, 124),
+        (dt.date(2000, 1, 2), 5821.0, 5821.5, 5820.75, 5820.75, 146),
+        (dt.date(2000, 1, 3), 5820.0, 5821.0, 5819.75, 5820.5, 128),
+        (dt.date(2000, 1, 4), 5822.5, 5822.5, 5822.25, 5822.25, 78),
+        (dt.date(2000, 1, 5), 5822.5, 5822.5, 5821.5, 5821.75, 73),
+        (dt.date(2000, 1, 6), 5817.0, 5817.0, 5816.0, 5816.5, 301),
+        (dt.date(2000, 1, 7), 5817.75, 5818.75, 5817.5, 5818.75, 150),
+        (dt.date(2000, 1, 8), 5821.0, 5821.25, 5821.0, 5821.25, 75),
+        (dt.date(2000, 1, 9), 5818.0, 5819.0, 5818.0, 5818.75, 69),
+        (dt.date(2000, 1, 10), 5818.75, 5819.25, 5818.5, 5819.0, 67),
+    ]
+    return DataFrame(
+        data=data,
+        schema={
+            "date": Date,
+            "open": Float64,
+            "high": Float64,
+            "low": Float64,
+            "close": Float64,
+            "volume": Int64,
+        },
+        orient="row",
+    )
+
+
+class TestSetDataFrame:
+    def test_main(self, *, df: DataFrame) -> None:
+        chart = Chart()
+        set_dataframe(df, chart)
+
+    def test_error_empty(self, *, df: DataFrame) -> None:
+        df = df.drop("date")
+        with raises(
+            _SetDataFrameEmptyError,
+            match="At least 1 column must be of date/datetime type; got 0",
+        ):
+            set_dataframe(df, cast("Chart", None))
+
+    def test_error_non_unique(self, *, df: DataFrame) -> None:
+        df = df.with_columns(col("date").alias("date2"))
+        with raises(
+            _SetDataFrameNonUniqueError,
+            match=r"Schema\(.*\) must contain exactly 1 date/datetime column; got 'date', 'date2' and perhaps more",
+        ):
+            set_dataframe(df, cast("Chart", None))

{dycw_utilities-0.109.13 → dycw_utilities-0.109.14}/src/tests/test_polars.py

@@ -755,7 +755,7 @@ class TestDataClassToDataFrame:
 
         with raises(
             _DataClassToDataFrameNonUniqueError,
-            match="Iterable .* must contain exactly one class; got .*, .* and perhaps more",
+            match="Iterable .* must contain exactly 1 class; got .*, .* and perhaps more",
         ):
             _ = dataclass_to_dataframe([Example1(), Example2()])
 

{dycw_utilities-0.109.13 → dycw_utilities-0.109.14}/src/utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.109.13"
+__version__ = "0.109.14"

{dycw_utilities-0.109.13 → dycw_utilities-0.109.14}/src/utilities/altair.py

@@ -22,7 +22,6 @@ from altair import (
     vconcat,
 )
 from altair.utils.schemapi import Undefined
-from polars import Date, Datetime
 
 from utilities.functions import ensure_bytes, ensure_number
 from utilities.iterables import always_iterable
@@ -66,7 +65,7 @@ def plot_dataframes(
 ) -> VConcatChart:
     """Plot a DataFrame as a set of time series, with a multi-line tooltip."""
     import polars as pl
-    from polars import int_range
+    from polars import Date, Datetime, int_range
 
     from utilities.polars import replace_time_zone
 

{dycw_utilities-0.109.13 → dycw_utilities-0.109.14}/src/utilities/iterables.py

@@ -1009,7 +1009,7 @@ def one(*iterables: Iterable[_T]) -> _T:
     try:
         first = next(it)
     except StopIteration:
-        raise OneEmptyError from None
+        raise OneEmptyError(iterables=iterables) from None
     try:
         second = next(it)
     except StopIteration:
@@ -1018,19 +1018,19 @@ def one(*iterables: Iterable[_T]) -> _T:
 
 
 @dataclass(kw_only=True, slots=True)
-class OneError(Exception): ...
+class OneError(Exception, Generic[_T]):
+    iterables: tuple[Iterable[_T], ...]
 
 
 @dataclass(kw_only=True, slots=True)
-class OneEmptyError(OneError):
+class OneEmptyError(OneError[_T]):
     @override
     def __str__(self) -> str:
-        return "Iterable(s) must not be empty"
+        return f"Iterable(s) {get_repr(self.iterables)} must not be empty"
 
 
 @dataclass(kw_only=True, slots=True)
 class OneNonUniqueError(OneError, Generic[_T]):
-    iterables: tuple[Iterable[_T], ...]
     first: _T
     second: _T
 

dycw_utilities-0.109.14/src/utilities/lightweight_charts.py

@@ -0,0 +1,96 @@
+from __future__ import annotations
+
+from contextlib import asynccontextmanager
+from dataclasses import dataclass
+from typing import TYPE_CHECKING, override
+
+from utilities.iterables import OneEmptyError, OneNonUniqueError, one
+from utilities.reprlib import get_repr
+
+if TYPE_CHECKING:
+    from collections.abc import AsyncIterator
+
+    from lightweight_charts import AbstractChart, Chart
+    from lightweight_charts.abstract import SeriesCommon
+    from polars import DataFrame
+    from polars._typing import SchemaDict
+
+    from utilities.types import PathLike
+
+
+##
+
+
+def save_chart(chart: Chart, path: PathLike, /, *, overwrite: bool = False) -> None:
+    """Atomically save a chart to disk."""
+    from utilities.atomicwrites import writer  # pragma: no cover
+
+    chart.show(block=False)  # pragma: no cover
+    with (  # pragma: no cover
+        writer(path, overwrite=overwrite) as temp,
+        temp.open(mode="wb") as fh,
+    ):
+        _ = fh.write(chart.screenshot())
+    chart.exit()  # pragma: no cover
+
+
+##
+
+
+def set_dataframe(df: DataFrame, obj: AbstractChart | SeriesCommon, /) -> None:
+    """Set a `polars` DataFrame onto a Chart."""
+    from polars import Date, Datetime, col  # pragma: no cover
+
+    try:
+        name = one(k for k, v in df.schema.items() if isinstance(v, Date | Datetime))
+    except OneEmptyError:
+        raise _SetDataFrameEmptyError(schema=df.schema) from None
+    except OneNonUniqueError as error:
+        raise _SetDataFrameNonUniqueError(
+            schema=df.schema, first=error.first, second=error.second
+        ) from None
+    return obj.set(
+        df.select(
+            col(name).alias("date").dt.strftime("iso"),
+            *[c for c in df.columns if c != name],
+        ).to_pandas()
+    )
+
+
+@dataclass(kw_only=True, slots=True)
+class SetDataFrameError(Exception):
+    schema: SchemaDict
+
+
+@dataclass(kw_only=True, slots=True)
+class _SetDataFrameEmptyError(SetDataFrameError):
+    @override
+    def __str__(self) -> str:
+        return "At least 1 column must be of date/datetime type; got 0"
+
+
+@dataclass(kw_only=True, slots=True)
+class _SetDataFrameNonUniqueError(SetDataFrameError):
+    first: str
+    second: str
+
+    @override
+    def __str__(self) -> str:
+        return f"{get_repr(self.schema)} must contain exactly 1 date/datetime column; got {self.first!r}, {self.second!r} and perhaps more"
+
+
+##
+
+
+@asynccontextmanager
+async def yield_chart(chart: Chart, /) -> AsyncIterator[None]:
+    """Yield a chart for visualization in a notebook."""
+    try:  # pragma: no cover
+        yield await chart.show_async()
+    except BaseException:  # pragma: no cover  # noqa: BLE001, S110
+        pass
+    finally:  # pragma: no cover
+        chart.exit()
+
+
+__all__ = ["save_chart", "set_dataframe", "yield_chart"]

{dycw_utilities-0.109.13 → dycw_utilities-0.109.14}/src/utilities/polars.py

@@ -714,7 +714,7 @@ class _DataClassToDataFrameNonUniqueError(DataClassToDataFrameError):
 
     @override
     def __str__(self) -> str:
-        return f"Iterable {get_repr(self.objs)} must contain exactly one class; got {self.first}, {self.second} and perhaps more"
+        return f"Iterable {get_repr(self.objs)} must contain exactly 1 class; got {self.first}, {self.second} and perhaps more"
 
 
 ##