xoscar 0.1.4__cp39-cp39-win_amd64.whl → 0.2.1__cp39-cp39-win_amd64.whl

xoscar/__init__.py

@@ -32,6 +32,7 @@ from .api import (
     setup_cluster,
     wait_actor_pool_recovered,
     get_pool_config,
+    generator,
 )
 from .backends import allocate_strategy
 from .backends.pool import MainActorPoolType

xoscar/api.py

@@ -15,9 +15,26 @@
 
 from __future__ import annotations
 
+import asyncio
+import functools
+import inspect
+import logging
+import threading
+import uuid
 from collections import defaultdict
 from numbers import Number
-from typing import TYPE_CHECKING, Any, Dict, List, Optional, Tuple, Type, Union
+from typing import (
+    TYPE_CHECKING,
+    Any,
+    Dict,
+    Generic,
+    List,
+    Optional,
+    Tuple,
+    Type,
+    TypeVar,
+    Union,
+)
 from urllib.parse import urlparse
 
 from .aio import AioFileObject
@@ -29,6 +46,8 @@ if TYPE_CHECKING:
     from .backends.config import ActorPoolConfig
     from .backends.pool import MainActorPoolType
 
+logger = logging.getLogger(__name__)
+
 
 async def create_actor(
     actor_cls: Type, *args, uid=None, address=None, **kwargs
@@ -271,6 +290,61 @@ def setup_cluster(address_to_resources: Dict[str, Dict[str, Number]]):
         get_backend(scheme).get_driver_cls().setup_cluster(address_resources)
 
 
+T = TypeVar("T")
+
+
+class IteratorWrapper(Generic[T]):
+    def __init__(self, uid: str, actor_addr: str, actor_uid: str):
+        self._uid = uid
+        self._actor_addr = actor_addr
+        self._actor_uid = actor_uid
+        self._actor_ref = None
+        self._gc_destroy = True
+
+    async def destroy(self):
+        if self._actor_ref is None:
+            self._actor_ref = await actor_ref(
+                address=self._actor_addr, uid=self._actor_uid
+            )
+        assert self._actor_ref is not None
+        return await self._actor_ref.__xoscar_destroy_generator__(self._uid)
+
+    def __del__(self):
+        # It's not a good idea to spawn a new thread and join in __del__,
+        # but currently it's the only way to GC the generator.
+        # TODO(codingl2k1): This __del__ may hangs if the program is exiting.
+        if self._gc_destroy:
+            thread = threading.Thread(
+                target=asyncio.run, args=(self.destroy(),), daemon=True
+            )
+            thread.start()
+            thread.join()
+
+    def __aiter__(self):
+        return self
+
+    def __getstate__(self):
+        # Transfer gc destroy during serialization.
+        state = self.__dict__.copy()
+        state["_gc_destroy"] = True
+        self._gc_destroy = False
+        return state
+
+    async def __anext__(self) -> T:
+        if self._actor_ref is None:
+            self._actor_ref = await actor_ref(
+                address=self._actor_addr, uid=self._actor_uid
+            )
+        try:
+            assert self._actor_ref is not None
+            return await self._actor_ref.__xoscar_next__(self._uid)
+        except Exception as e:
+            if "StopIteration" in str(e):
+                raise StopAsyncIteration
+            else:
+                raise
+
+
 class AsyncActorMixin:
     @classmethod
     def default_uid(cls):
@@ -282,6 +356,10 @@ class AsyncActorMixin:
         except KeyError:
             return super().__new__(cls, *args, **kwargs)
 
+    def __init__(self, *args, **kwargs) -> None:
+        super().__init__()
+        self._generators: Dict[str, IteratorWrapper] = {}
+
     async def __post_create__(self):
         """
         Method called after actor creation
@@ -305,6 +383,93 @@ class AsyncActorMixin:
         """
         return await super().__on_receive__(message)  # type: ignore
 
+    async def __xoscar_next__(self, generator_uid: str) -> Any:
+        """
+        Iter the next of generator.
+
+        Parameters
+        ----------
+        generator_uid: str
+            The uid of generator
+
+        Returns
+        -------
+            The next value of generator
+        """
+
+        def _wrapper(_gen):
+            try:
+                return next(_gen)
+            except StopIteration:
+                return stop
+
+        async def _async_wrapper(_gen):
+            try:
+                # anext is only available for Python >= 3.10
+                return await _gen.__anext__()  # noqa: F821
+            except StopAsyncIteration:
+                return stop
+
+        if gen := self._generators.get(generator_uid):
+            stop = object()
+            try:
+                if inspect.isgenerator(gen):
+                    r = await asyncio.to_thread(_wrapper, gen)
+                elif inspect.isasyncgen(gen):
+                    r = await asyncio.create_task(_async_wrapper(gen))
+                else:
+                    raise Exception(
+                        f"The generator {generator_uid} should be a generator or an async generator, "
+                        f"but a {type(gen)} is got."
+                    )
+            except Exception as e:
+                logger.exception(
+                    f"Destroy generator {generator_uid} due to an error encountered."
+                )
+                await self.__xoscar_destroy_generator__(generator_uid)
+                del gen  # Avoid exception hold generator reference.
+                raise e
+            if r is stop:
+                await self.__xoscar_destroy_generator__(generator_uid)
+                del gen  # Avoid exception hold generator reference.
+                raise Exception("StopIteration")
+            else:
+                return r
+        else:
+            raise RuntimeError(f"No iterator with id: {generator_uid}")
+
+    async def __xoscar_destroy_generator__(self, generator_uid: str):
+        """
+        Destroy the generator.
+
+        Parameters
+        ----------
+        generator_uid: str
+            The uid of generator
+        """
+        logger.debug("Destroy generator: %s", generator_uid)
+        self._generators.pop(generator_uid, None)
+
+
+def generator(func):
+    need_to_thread = not asyncio.iscoroutinefunction(func)
+
+    @functools.wraps(func)
+    async def _wrapper(self, *args, **kwargs):
+        if need_to_thread:
+            r = await asyncio.to_thread(func, self, *args, **kwargs)
+        else:
+            r = await func(self, *args, **kwargs)
+        if inspect.isgenerator(r) or inspect.isasyncgen(r):
+            gen_uid = uuid.uuid1().hex
+            logger.debug("Create generator: %s", gen_uid)
+            self._generators[gen_uid] = r
+            return IteratorWrapper(gen_uid, self.address, self.uid)
+        else:
+            return r
+
+    return _wrapper
+
 
 class Actor(AsyncActorMixin, _Actor):
     pass

xoscar/core.pyx

@@ -127,7 +127,7 @@ cdef class ActorRef:
         return create_actor_ref, (self.address, self.uid)
 
     def __getattr__(self, item):
-        if item.startswith('_'):
+        if item.startswith('_') and item not in ["__xoscar_next__", "__xoscar_destroy_generator__"]:
             return object.__getattribute__(self, item)
 
         try:

{xoscar-0.1.4.dist-info → xoscar-0.2.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: xoscar
-Version: 0.1.4
+Version: 0.2.1
 Summary: Python actor framework for heterogeneous computing.
 Home-page: http://github.com/xorbitsai/xoscar
 Author: Qin Xuye

{xoscar-0.1.4.dist-info → xoscar-0.2.1.dist-info}/RECORD

@@ -1,18 +1,18 @@
-xoscar/__init__.py,sha256=rrre56CmXi2ItpdBru0sMQRvSxuLa-Mj18a1E481Bmk,1769
-xoscar/_utils.cp39-win_amd64.pyd,sha256=gbnV8ZFf9Hyk-DbqW6sVk4KZkp3Vd_-y1nU3tsMFiKM,117248
+xoscar/__init__.py,sha256=MfWK519G_Rs8z-zkT5HdrEfJcPa6p6vqU5uvdTJTH5Y,1785
+xoscar/_utils.cp39-win_amd64.pyd,sha256=y_lakm1_XS9rbBHxSVQUnELVHYIQPWbCR-VsIdXoHow,117248
 xoscar/_utils.pxd,sha256=rlNbTg5lhXA-jCOLksqF4jhUlNn0xw2jx1HxdLa34pc,1193
 xoscar/_utils.pyx,sha256=5Wvind3AQ3JaMK7Zv9SjhiPO6LEol2hW7_fMncn69go,7300
 xoscar/_version.py,sha256=bsfCVAo_o9LkiP3AjPsP4SRRqhjuS0t4D1WGJPzbdls,24412
-xoscar/api.py,sha256=j0LVDNighYZc2xds69qKvhPavWb7QTBDyrk4sbp3Hmw,8652
+xoscar/api.py,sha256=B5oXv4vgMxMteh1YNaBmNFDrUFmYa_dCdzfaWwwZnCo,13820
 xoscar/backend.py,sha256=8G5JwjoOT6Q2slb11eXNApxgcmvNQUCdQzkoIMDwLcQ,1917
 xoscar/batch.py,sha256=Jk5BSpvMFAV9DrRy0a9tgPvIo_dt8cbJReZBL0cnOPc,8128
 xoscar/constants.py,sha256=H9ntCahBz5nKO-A6rkrGKy4WB2kNaLZAytkDajKIXqM,780
-xoscar/context.cp39-win_amd64.pyd,sha256=qf0H5vkKXCjzhnychCuqIhJJFTtf7J9hX5ml9Zz_5Aw,158208
+xoscar/context.cp39-win_amd64.pyd,sha256=g7Y7boTpX5k3oRnHai3wF7pFjNYEBpTnITUpIFEZ4po,158208
 xoscar/context.pxd,sha256=6n6IAbmArSRq8EjcsbS6npW8xP1jI0qOoS1fF0oyj-o,746
 xoscar/context.pyx,sha256=FOJVerGOvxe2USryXEQA0rpaFX_ScxISH6QWKUcahY8,11310
-xoscar/core.cp39-win_amd64.pyd,sha256=gfG3xtD61Va_YoD5vCivaCrNQfWp22mVMvrnpNiFmb0,333312
+xoscar/core.cp39-win_amd64.pyd,sha256=1VzFHAHfnNwhB0GtcxIXxFofh9gunvUWlU84fKnpZPU,333824
 xoscar/core.pxd,sha256=dGv62H92PFG98SVILuF641kY-NWFEt1FYqqOX3WY5RQ,1330
-xoscar/core.pyx,sha256=AeXcz4_d7lgfmEoVL7QguH8vSKVOK3pZ5RO76KSHktY,22320
+xoscar/core.pyx,sha256=0YvJW2AHgymyfsAlPGvIFw65J5gTKO3PK2p1wl4VlJ0,22388
 xoscar/debug.py,sha256=hrmxIH6zvTKasQo6PUUgXu5mgEsR0g87Fvpw7CoHipg,5257
 xoscar/driver.py,sha256=EjZ7HkdSgwtE9pXGiJXXwgWfxaIn10eZyqKpBhelaoc,1414
 xoscar/entrypoints.py,sha256=BOFOyMIeH3LwRCqonP6-HJGXp1gUdOrHX64KnpAFxjI,1684
@@ -32,7 +32,7 @@ xoscar/backends/allocate_strategy.py,sha256=DzvTlixwzTANURI2mDLHm3vcaugSPDxU6UQZ
 xoscar/backends/config.py,sha256=7nmvU_19zYR7n-bT8BNasbjntwmobmMiM7wN7O6Lujc,5129
 xoscar/backends/context.py,sha256=zhOFZk_RPLaJ9a8ZDQBHcV54E6r3-VnLVO-D3pIr1qA,15685
 xoscar/backends/core.py,sha256=4eMQ5a0-_wYs4OhOWuRIZoBojhMhj7wr6qzo2dqXFSg,7582
-xoscar/backends/message.cp39-win_amd64.pyd,sha256=zNA73QFclcS-sFZsm0b2OVfVpTDySlvMDlO5vDfxVC0,263168
+xoscar/backends/message.cp39-win_amd64.pyd,sha256=Xzfg1P9z-ka22DqgXq6tWGKWWXlMycIvsh5cTE9inpU,263168
 xoscar/backends/message.pyx,sha256=kD_bqaApizHtMzqH0Baw5GH3N7r26NwOGoVfm7KCXWg,18203
 xoscar/backends/pool.py,sha256=9FBNhiIOu3LJCP6hIkvPKfjvHqgRDQ4Sf1mwrcb9fmk,59720
 xoscar/backends/router.py,sha256=GJpSV_LhzINHdTp5jtsMHfPNMkNb1KI-WlqGqhwApGU,7953
@@ -56,8 +56,8 @@ xoscar/collective/common.py,sha256=CBikMogIBIqe0U_bhomEPM2fNywthumFea3KuA9hB2U,3
 xoscar/collective/core.py,sha256=Rx1niJ_6rznLG9varP53oqTH_bZabRzgbuP2V6JPu54,24235
 xoscar/collective/process_group.py,sha256=kTPbrLMJSGhqbiWvTIiz-X3W0rZWd_CFn_zUIlXbOlM,23286
 xoscar/collective/utils.py,sha256=p3WEVtXvnVhkuO5mRgQBhBRFr1dKHcDKMjrbMyuiyfg,1219
-xoscar/collective/uv.dll,sha256=NcMlxPDCPBrd1dCcsznWBVLK49OluZ_8xJBlAEFPXAI,618496
-xoscar/collective/xoscar_pygloo.cp39-win_amd64.pyd,sha256=OyTbonlvzAHs8t67XE9Pm926W4yLCBMH5etOfTG-0VQ,798720
+xoscar/collective/uv.dll,sha256=9yXEQnXa4jR1f_SBXM0QPdvLA2zqRwJ9XRd2IMkqDRg,618496
+xoscar/collective/xoscar_pygloo.cp39-win_amd64.pyd,sha256=mmsZByqe8fdfI1nW6LuymTRS7NOlocb3j3FxJqKNJZ0,798720
 xoscar/metrics/__init__.py,sha256=RjXuuYw4I2YYgD8UY2Z5yCZk0Z56xMJ1n40O80Dtxf8,726
 xoscar/metrics/api.py,sha256=dtJ4QrIqQNXhJedeqOPs4TXKgrRGZFFN50xAd9SCfec,9144
 xoscar/metrics/backends/__init__.py,sha256=ZHepfhCDRuK9yz4pAM7bjpWDvS3Ijp1YgyynoUFLeuU,594
@@ -68,7 +68,7 @@ xoscar/metrics/backends/prometheus/__init__.py,sha256=ZHepfhCDRuK9yz4pAM7bjpWDvS
 xoscar/metrics/backends/prometheus/prometheus_metric.py,sha256=65hb8O3tmsEJ7jgOrIwl_suj9SE5Tmqcfjuk0urkLvE,2120
 xoscar/serialization/__init__.py,sha256=NOAn046vnHEkx--82BKNinV8EpyOfT5hqfRBGnKl56s,866
 xoscar/serialization/aio.py,sha256=bL31B2lwrEKA5nztRSeSgDyqsbBN6dCMr6rHwNDGAIk,4715
-xoscar/serialization/core.cp39-win_amd64.pyd,sha256=kbBOIsxOj54bMrD34QeB3zwdNzMRxThgDaf3HoEf7H0,299520
+xoscar/serialization/core.cp39-win_amd64.pyd,sha256=vxj_VALt2onNfuVmp5CjiGkSLrFR_cBvxPK39yfs8xE,299520
 xoscar/serialization/core.pxd,sha256=X-47bqBM2Kzw5SkLqICdKD0gU6CpmLsBxC3kfW--wVk,1013
 xoscar/serialization/core.pyx,sha256=H6YZos-OHDxqFvu1vKvoH3Fhw3HzGn8dI3YPACFL5C0,31085
 xoscar/serialization/cuda.py,sha256=Fj4Cpr_YmkGceUCo0mQn8fRvmHP_5WcLdRx6epZ3RC0,3869
@@ -76,7 +76,7 @@ xoscar/serialization/exception.py,sha256=t6yZn_Ate04UE1RbabNh7mu739sdtwarjuPXWhA
 xoscar/serialization/numpy.py,sha256=C6WVx-Sdl2OHBAvVY34DFjAKXlekMbpc2ni6bR8wxYo,3001
 xoscar/serialization/pyfury.py,sha256=3ucal29Hr7PX9_1SfB2x43FE2xw_C0rLkVv3foL7qwM,1200
 xoscar/serialization/scipy.py,sha256=9ph-yoRoNiwUZTwQrn35U60VPirWlncXNAg6EXvqMR4,2554
-xoscar-0.1.4.dist-info/METADATA,sha256=KCnDiyV5z4m16FpS5Bt_RuyGxboAbE8P_DIQ-tY5xJ4,9438
-xoscar-0.1.4.dist-info/WHEEL,sha256=GZFS91_ufm4WrNPBaFVPB9MvOXR6bMZQhPcZRRTN5YM,100
-xoscar-0.1.4.dist-info/top_level.txt,sha256=vYlqqY4Nys8Thm1hePIuUv8eQePdULVWMmt7lXtX_ZA,21
-xoscar-0.1.4.dist-info/RECORD,,
+xoscar-0.2.1.dist-info/METADATA,sha256=EqRTotGIj5L-Ek7P69Ebga1WXy0adVlkaIvhzQ_dzGI,9438
+xoscar-0.2.1.dist-info/WHEEL,sha256=GZFS91_ufm4WrNPBaFVPB9MvOXR6bMZQhPcZRRTN5YM,100
+xoscar-0.2.1.dist-info/top_level.txt,sha256=vYlqqY4Nys8Thm1hePIuUv8eQePdULVWMmt7lXtX_ZA,21
+xoscar-0.2.1.dist-info/RECORD,,