dycw-utilities 0.126.10__py3-none-any.whl → 0.126.11__py3-none-any.whl

{dycw_utilities-0.126.10.dist-info → dycw_utilities-0.126.11.dist-info}/METADATA

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

{dycw_utilities-0.126.10.dist-info → dycw_utilities-0.126.11.dist-info}/RECORD

@@ -1,4 +1,4 @@
-utilities/__init__.py,sha256=_LTfJC5B-XkbCDy-opJNk2Pu2qwhA3B84Baq2rX5bbA,61
+utilities/__init__.py,sha256=zZdDjXYw0iXgNb3iikpaOv2GNjXKtYX9dLFyhvGm1Bs,61
 utilities/altair.py,sha256=Gpja-flOo-Db0PIPJLJsgzAlXWoKUjPU1qY-DQ829ek,9156
 utilities/asyncio.py,sha256=phbGti22VSe9cu-SwM1vP8kyUg8AUDHvvciMvE6JnCg,51842
 utilities/atomicwrites.py,sha256=geFjn9Pwn-tTrtoGjDDxWli9NqbYfy3gGL6ZBctiqSo,5393
@@ -61,7 +61,7 @@ utilities/pytest_regressions.py,sha256=-SVT9647Dg6-JcdsiaDKXe3NdOmmrvGevLKWwGjxq
 utilities/python_dotenv.py,sha256=iWcnpXbH7S6RoXHiLlGgyuH6udCupAcPd_gQ0eAenQ0,3190
 utilities/random.py,sha256=lYdjgxB7GCfU_fwFVl5U-BIM_HV3q6_urL9byjrwDM8,4157
 utilities/re.py,sha256=5J4d8VwIPFVrX2Eb8zfoxImDv7IwiN_U7mJ07wR2Wvs,3958
-utilities/redis.py,sha256=XywncvQak9AYgdeN2M3vDJM9MEJsIFSfOiWVCKZVGjY,32697
+utilities/redis.py,sha256=pMKJjNI5e0lG-FZh2_idMBBmfgNr53KIGjBquZQOLZc,37556
 utilities/reprlib.py,sha256=Re9bk3n-kC__9DxQmRlevqFA86pE6TtVfWjUgpbVOv0,1849
 utilities/rich.py,sha256=t50MwwVBsoOLxzmeVFSVpjno4OW6Ufum32skXbV8-Bs,1911
 utilities/scipy.py,sha256=X6ROnHwiUhAmPhM0jkfEh0-Fd9iRvwiqtCQMOLmOQF8,945
@@ -69,7 +69,7 @@ utilities/sentinel.py,sha256=3jIwgpMekWgDAxPDA_hXMP2St43cPhciKN3LWiZ7kv0,1248
 utilities/shelve.py,sha256=HZsMwK4tcIfg3sh0gApx4-yjQnrY4o3V3ZRimvRhoW0,738
 utilities/slack_sdk.py,sha256=h2DiVkcFyYcT5zzZOAo6CSith5BBlHUbXeOJSL1neK8,5948
 utilities/socket.py,sha256=K77vfREvzoVTrpYKo6MZakol0EYu2q1sWJnnZqL0So0,118
-utilities/sqlalchemy.py,sha256=KraI3PGrIs8ZpTQi0rZzBMjlcPbgWNipXlLySeu4aiY,36765
+utilities/sqlalchemy.py,sha256=rHixzaYl_QHTR1dAhLj15ntiE5kwZWY4MKIr97crDts,39602
 utilities/sqlalchemy_polars.py,sha256=s7hQNep2O5DTgIRXyN_JRQma7a4DAtNd25tshaZW8iw,15490
 utilities/statsmodels.py,sha256=koyiBHvpMcSiBfh99wFUfSggLNx7cuAw3rwyfAhoKpQ,3410
 utilities/streamlit.py,sha256=U9PJBaKP1IdSykKhPZhIzSPTZsmLsnwbEPZWzNhJPKk,2955
@@ -91,7 +91,7 @@ utilities/warnings.py,sha256=un1LvHv70PU-LLv8RxPVmugTzDJkkGXRMZTE2-fTQHw,1771
 utilities/whenever.py,sha256=jS31ZAY5OMxFxLja_Yo5Fidi87Pd-GoVZ7Vi_teqVDA,16743
 utilities/zipfile.py,sha256=24lQc9ATcJxHXBPc_tBDiJk48pWyRrlxO2fIsFxU0A8,699
 utilities/zoneinfo.py,sha256=-5j7IQ9nb7gR43rdgA7ms05im-XuqhAk9EJnQBXxCoQ,1874
-dycw_utilities-0.126.10.dist-info/METADATA,sha256=3hajeWxg9om0FI0yM_fkaoFNZFG_j4slCdaV-NRNswU,12804
-dycw_utilities-0.126.10.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-dycw_utilities-0.126.10.dist-info/licenses/LICENSE,sha256=gppZp16M6nSVpBbUBrNL6JuYfvKwZiKgV7XoKKsHzqo,1066
-dycw_utilities-0.126.10.dist-info/RECORD,,
+dycw_utilities-0.126.11.dist-info/METADATA,sha256=BpSldlx63eNjZ98CKmHpEi6Ee2Zm5HqWnYZrKbBOICI,12804
+dycw_utilities-0.126.11.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+dycw_utilities-0.126.11.dist-info/licenses/LICENSE,sha256=gppZp16M6nSVpBbUBrNL6JuYfvKwZiKgV7XoKKsHzqo,1066
+dycw_utilities-0.126.11.dist-info/RECORD,,

utilities/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.126.10"
+__version__ = "0.126.11"

utilities/redis.py

@@ -25,7 +25,14 @@ from typing import (
 from redis.asyncio import Redis
 from redis.typing import EncodableT
 
-from utilities.asyncio import EnhancedQueue, InfiniteQueueLooper, Looper, timeout_dur
+from utilities.asyncio import (
+    EnhancedQueue,
+    InfiniteQueueLooper,
+    Looper,
+    LooperTimeoutError,
+    timeout_dur,
+)
+from utilities.contextlib import suppress_super_object_attribute_error
 from utilities.datetime import (
     MILLISECOND,
     SECOND,
@@ -72,6 +79,9 @@ _V2 = TypeVar("_V2")
 _V3 = TypeVar("_V3")
 
 
+_PUBLISH_TIMEOUT: Duration = SECOND
+
+
 ##
 
 
@@ -548,9 +558,6 @@ def redis_key(
 ##
 
 
-_PUBLISH_TIMEOUT: Duration = SECOND
-
-
 @overload
 async def publish(
     redis: Redis,
@@ -666,7 +673,7 @@ class PublishService(Looper[tuple[str, _T]]):
     # self
     redis: Redis
     serializer: Callable[[_T], EncodableT] = serialize
-    publish_timeout: Duration = SECOND
+    publish_timeout: Duration = _PUBLISH_TIMEOUT
 
     @override
     async def core(self) -> None:
@@ -685,6 +692,55 @@ class PublishService(Looper[tuple[str, _T]]):
 ##
 
 
+@dataclass(kw_only=True)
+class PublishServiceMixin(Generic[_T]):
+    """Mix-in for the publish service."""
+
+    # base - looper
+    publish_service_freq: Duration = field(default=MILLISECOND, repr=False)
+    publish_service_backoff: Duration = field(default=SECOND, repr=False)
+    publish_service_empty_upon_exit: bool = field(default=False, repr=False)
+    publish_service_logger: str | None = field(default=None, repr=False)
+    publish_service_timeout: Duration | None = field(default=None, repr=False)
+    publish_service_timeout_error: type[Exception] = field(
+        default=LooperTimeoutError, repr=False
+    )
+    publish_service_debug: bool = field(default=False, repr=False)
+    _is_pending_restart: Event = field(default_factory=Event, init=False, repr=False)
+    # base - publish service
+    publish_service_redis: Redis
+    publish_service_serializer: Callable[[_T], EncodableT] = serialize
+    publish_service_publish_timeout: Duration = _PUBLISH_TIMEOUT
+    # self
+    _publish_service: PublishService[_T] = field(init=False, repr=False)
+
+    def __post_init__(self) -> None:
+        with suppress_super_object_attribute_error():  # skipif-ci-and-not-linux
+            super().__post_init__()  # pyright: ignore[reportAttributeAccessIssue]
+        self._publish_service = PublishService(  # skipif-ci-and-not-linux
+            # looper
+            freq=self.publish_service_freq,
+            backoff=self.publish_service_backoff,
+            empty_upon_exit=self.publish_service_empty_upon_exit,
+            logger=self.publish_service_logger,
+            timeout=self.publish_service_timeout,
+            timeout_error=self.publish_service_timeout_error,
+            _debug=self.publish_service_debug,
+            # publish service
+            redis=self.publish_service_redis,
+            serializer=self.publish_service_serializer,
+            publish_timeout=self.publish_service_publish_timeout,
+        )
+
+    def _yield_sub_loopers(self) -> Iterator[Looper[Any]]:
+        with suppress_super_object_attribute_error():  # skipif-ci-and-not-linux
+            yield from super()._yield_sub_loopers()  # pyright: ignore[reportAttributeAccessIssue]
+        yield self._publish_service  # skipif-ci-and-not-linux
+
+
+##
+
+
 _SUBSCRIBE_TIMEOUT: Duration = SECOND
 _SUBSCRIBE_SLEEP: Duration = MILLISECOND
 
@@ -920,6 +976,58 @@ class SubscribeService(Looper[_T]):
 ##
 
 
+@dataclass(kw_only=True)
+class SubscribeServiceMixin(Generic[_T]):
+    """Mix-in for the subscribe service."""
+
+    # base - looper
+    subscribe_service_freq: Duration = field(default=MILLISECOND, repr=False)
+    subscribe_service_backoff: Duration = field(default=SECOND, repr=False)
+    subscribe_service_empty_upon_exit: bool = field(default=False, repr=False)
+    subscribe_service_logger: str | None = field(default=None, repr=False)
+    subscribe_service_timeout: Duration | None = field(default=None, repr=False)
+    subscribe_service_timeout_error: type[Exception] = field(
+        default=LooperTimeoutError, repr=False
+    )
+    subscribe_service_debug: bool = field(default=False, repr=False)
+    # base - looper
+    subscribe_service_redis: Redis
+    subscribe_service_channel: str
+    subscribe_service_deserializer: Callable[[bytes], _T] = deserialize
+    subscribe_service_subscribe_sleep: Duration = _SUBSCRIBE_SLEEP
+    subscribe_service_subscribe_timeout: Duration | None = _SUBSCRIBE_TIMEOUT
+    # self
+    _subscribe_service: SubscribeService[_T] = field(init=False, repr=False)
+
+    def __post_init__(self) -> None:
+        with suppress_super_object_attribute_error():  # skipif-ci-and-not-linux
+            super().__post_init__()  # pyright: ignore[reportAttributeAccessIssue]
+        self._subscribe_service = SubscribeService(  # skipif-ci-and-not-linux
+            # looper
+            freq=self.subscribe_service_freq,
+            backoff=self.subscribe_service_backoff,
+            empty_upon_exit=self.subscribe_service_empty_upon_exit,
+            logger=self.subscribe_service_logger,
+            timeout=self.subscribe_service_timeout,
+            timeout_error=self.subscribe_service_timeout_error,
+            _debug=self.subscribe_service_debug,
+            # subscribe service
+            redis=self.subscribe_service_redis,
+            channel=self.subscribe_service_channel,
+            deserializer=self.subscribe_service_deserializer,
+            subscribe_sleep=self.subscribe_service_subscribe_sleep,
+            subscribe_timeout=self.subscribe_service_subscribe_timeout,
+        )
+
+    def _yield_sub_loopers(self) -> Iterator[Looper[Any]]:
+        with suppress_super_object_attribute_error():  # skipif-ci-and-not-linux
+            yield from super()._yield_sub_loopers()  # pyright: ignore[reportAttributeAccessIssue]
+        yield self._subscribe_service  # skipif-ci-and-not-linux
+
+
+##
+
+
 @asynccontextmanager
 async def yield_pubsub(
     redis: Redis, channels: MaybeIterable[str], /
@@ -1000,11 +1108,13 @@ def _deserialize(
 
 __all__ = [
     "PublishService",
+    "PublishServiceMixin",
     "Publisher",
     "PublisherError",
     "RedisHashMapKey",
     "RedisKey",
     "SubscribeService",
+    "SubscribeServiceMixin",
     "publish",
     "redis_hash_map_key",
     "redis_key",

utilities/sqlalchemy.py

@@ -57,7 +57,13 @@ from sqlalchemy.orm import (
 from sqlalchemy.orm.exc import UnmappedClassError
 from sqlalchemy.pool import NullPool, Pool
 
-from utilities.asyncio import InfiniteQueueLooper, Looper, timeout_dur
+from utilities.asyncio import (
+    InfiniteQueueLooper,
+    Looper,
+    LooperTimeoutError,
+    timeout_dur,
+)
+from utilities.contextlib import suppress_super_object_attribute_error
 from utilities.datetime import SECOND
 from utilities.functions import (
     ensure_str,
@@ -691,6 +697,63 @@ class UpsertService(Looper[_InsertItem]):
         )
 
 
+@dataclass(kw_only=True)
+class UpsertServiceMixin:
+    """Mix-in for the upsert service."""
+
+    # base - looper
+    upsert_service_freq: Duration = field(default=SECOND, repr=False)
+    upsert_service_backoff: Duration = field(default=SECOND, repr=False)
+    upsert_service_empty_upon_exit: bool = field(default=False, repr=False)
+    upsert_service_logger: str | None = field(default=None, repr=False)
+    upsert_service_timeout: Duration | None = field(default=None, repr=False)
+    upsert_service_timeout_error: type[Exception] = field(
+        default=LooperTimeoutError, repr=False
+    )
+    upsert_service_debug: bool = field(default=False, repr=False)
+    # base - upsert service
+    upsert_service_database: AsyncEngine
+    upsert_service_snake: bool = False
+    upsert_service_selected_or_all: _SelectedOrAll = "selected"
+    upsert_service_chunk_size_frac: float = CHUNK_SIZE_FRAC
+    upsert_service_assume_tables_exist: bool = False
+    upsert_service_timeout_create: Duration | None = None
+    upsert_service_error_create: type[Exception] = TimeoutError
+    upsert_service_timeout_insert: Duration | None = None
+    upsert_service_error_insert: type[Exception] = TimeoutError
+    # self
+    _upsert_service: UpsertService = field(init=False, repr=False)
+
+    def __post_init__(self) -> None:
+        with suppress_super_object_attribute_error():
+            super().__post_init__()  # pyright: ignore[reportAttributeAccessIssue]
+        self._upsert_service = UpsertService(
+            # looper
+            freq=self.upsert_service_freq,
+            backoff=self.upsert_service_backoff,
+            empty_upon_exit=self.upsert_service_empty_upon_exit,
+            logger=self.upsert_service_logger,
+            timeout=self.upsert_service_timeout,
+            timeout_error=self.upsert_service_timeout_error,
+            _debug=self.upsert_service_debug,
+            # upsert service
+            engine=self.upsert_service_database,
+            snake=self.upsert_service_snake,
+            selected_or_all=self.upsert_service_selected_or_all,
+            chunk_size_frac=self.upsert_service_chunk_size_frac,
+            assume_tables_exist=self.upsert_service_assume_tables_exist,
+            timeout_create=self.upsert_service_timeout_create,
+            error_create=self.upsert_service_error_create,
+            timeout_insert=self.upsert_service_timeout_insert,
+            error_insert=self.upsert_service_error_insert,
+        )
+
+    def _yield_sub_loopers(self) -> Iterator[Looper[Any]]:
+        with suppress_super_object_attribute_error():
+            yield from super()._yield_sub_loopers()  # pyright: ignore[reportAttributeAccessIssue]
+        yield self._upsert_service
+
+
 ##
 
 
@@ -1147,6 +1210,7 @@ __all__ = [
     "TablenameMixin",
     "UpsertItemsError",
     "UpsertService",
+    "UpsertServiceMixin",
     "Upserter",
     "UpserterError",
     "check_engine",