xoscar 0.1.4__cp38-cp38-macosx_10_9_universal2.whl → 0.2.1__cp38-cp38-macosx_10_9_universal2.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,7 +1,7 @@
-xoscar-0.1.4.dist-info/RECORD,,
-xoscar-0.1.4.dist-info/WHEEL,sha256=DcQ_CBc5lcCpOkpgTKxtf6JlU0Ew_fM0Yq6SmO-UB_M,113
-xoscar-0.1.4.dist-info/top_level.txt,sha256=vYlqqY4Nys8Thm1hePIuUv8eQePdULVWMmt7lXtX_ZA,21
-xoscar-0.1.4.dist-info/METADATA,sha256=9VJ57HI5Evln870g8i4Ex41M4GGXVI8-n2Sj6XzSekI,9214
+xoscar-0.2.1.dist-info/RECORD,,
+xoscar-0.2.1.dist-info/WHEEL,sha256=DcQ_CBc5lcCpOkpgTKxtf6JlU0Ew_fM0Yq6SmO-UB_M,113
+xoscar-0.2.1.dist-info/top_level.txt,sha256=vYlqqY4Nys8Thm1hePIuUv8eQePdULVWMmt7lXtX_ZA,21
+xoscar-0.2.1.dist-info/METADATA,sha256=rG9DA6iIoOVLoyKK0z5tid9xhSVnWccijS9blRQyfSc,9214
 xoscar/_utils.pyx,sha256=UR1FtYXAYKIdEWR9HulEpMbSOrkQWi6xGz63d4IQmG0,7059
 xoscar/backend.py,sha256=is436OPkZfSpQXaoqTRVta5eoye_pp45RFgCstAk2hU,1850
 xoscar/core.pxd,sha256=4lBq8J0kjcXcsGuvN7Kv4xcL5liHwTTFWlqyK7XAEnw,1280
@@ -10,18 +10,18 @@ xoscar/context.pxd,sha256=qKa0OyDPZtVymftSh447m-RzFZgmz8rGqQBa7qlauvc,725
 xoscar/batch.py,sha256=DpArS0L3WYJ_HVPG-6hSYEwoAFY1mY2-mlC4Jp5M_Dw,7872
 xoscar/nvutils.py,sha256=qmW4mKLU0WB2yCs198ccQOgLL02zB7Fsa-AotO3NOmg,20412
 xoscar/constants.py,sha256=Yn59lRIOvE1VFwyuZB5G2-gxYIyhIZ1rVovbdFAR2NM,759
-xoscar/__init__.py,sha256=QbTOmq0iycuyylnarLBGorCd639XYQpU0MoTeBOyL-w,1706
-xoscar/api.py,sha256=Vu_AdyJf0GZqDaiAa1T8ZE09qo_xUKBfT4XjBs4QzR8,8324
-xoscar/_utils.cpython-38-darwin.so,sha256=jkCVfRqBVkTGDphcAXG1PCT3NcdzY2ZpRkh6va7KeOA,386424
+xoscar/__init__.py,sha256=9BapEEmHU9OlpDOIc_4LwXNHfauP1XDW0YRnAUKZp_8,1721
+xoscar/api.py,sha256=3hztPoOxg8A_mlhWyWgVP7FMXG0PATA1TP4Rbaj7A-g,13327
+xoscar/_utils.cpython-38-darwin.so,sha256=yJta9Rv60X-9oVBy1bijnMpEmv0O_jpAU_IOb8lKG-I,386424
 xoscar/utils.py,sha256=TH81N2EWUDfAMdlkPYSh0juZS2EbdvvdhWx_6euQygk,14672
 xoscar/debug.py,sha256=9Z8SgE2WaKYQcyDo-5-DxEJQ533v7kWjrvCd28pSx3E,5069
 xoscar/libcpp.pxd,sha256=DJqBxLFOKL4iRr9Kale5UH3rbvPRD1x5bTSOPHFpz9I,1147
 xoscar/entrypoints.py,sha256=t-PfnqYDyjzXbV-Z-hjaQxpf_m95eSx2saAsb-V2ODY,1642
 xoscar/context.pyx,sha256=8CdgPnWcE9eOp3N600WgDQ03MCi8P73eUOGcfV7Zksg,10942
-xoscar/context.cpython-38-darwin.so,sha256=q3Im3Vy09aBSl03PuarZcpnq0vP1GUV4ucabpfhuSpY,480553
+xoscar/context.cpython-38-darwin.so,sha256=zbXL2AFs2sQG_Ncj6e1qeQtSz-LeorNkWY77wAsylzQ,480585
 xoscar/errors.py,sha256=wBlQOKsXf0Fc4skN39tDie0YZT-VIAuLNRgoDl2pZcA,1241
-xoscar/core.cpython-38-darwin.so,sha256=a_Kh-HPtrfnJ_fAzc0kcOvXlEbfFFXz8XNkPbIHb3Fs,999798
-xoscar/core.pyx,sha256=hVnv6jM9_kqdnYnRWlsBju1Xh0_qAEEY1T2Hui05zFM,21662
+xoscar/core.cpython-38-darwin.so,sha256=fSEncPwszq6Eo2JNV2SzXOqn2qcg4WkwZMfh-44Qmi4,999958
+xoscar/core.pyx,sha256=Aqc2i8Fetsd5wRAPF4kL0ddnBZn3E2HRNCvup79BbQc,21730
 xoscar/driver.py,sha256=498fowtJr6b3FE8FIOA_Tc1Vwx88nfZw7p0FxrML0h4,1372
 xoscar/profiling.py,sha256=BC5OF0HzSaXv8V7w-y-B8r5gV5DgxHFoTEIF6jCMioQ,8015
 xoscar/_utils.pxd,sha256=5KYAL3jfPdejsHnrGGT2s--ZUX5SXznQWpHVSno429k,1157
@@ -47,11 +47,11 @@ xoscar/serialization/numpy.py,sha256=5Kem87CvpJmzUMp3QHk4WeHU30FoQWTJJP2SwIcaQG0
 xoscar/serialization/cuda.py,sha256=iFUEnN4SiquBIhyieyOrfw3TnKnW-tU_vYgqOxO_DrA,3758
 xoscar/serialization/scipy.py,sha256=yOEi0NB8cqQ6e2UnCZ1w006RsB7T725tIL-DM_hNcsU,2482
 xoscar/serialization/aio.py,sha256=S9e3rHMBwqqKmJtDz7KzYAqWc8w9bttA0Dj83IBfEU0,4577
-xoscar/serialization/core.cpython-38-darwin.so,sha256=LauwlGgUFyb1XNpy-_i4QMgx2aWhjNlsBljm5sRDrQ4,943254
+xoscar/serialization/core.cpython-38-darwin.so,sha256=mYFXyJ_eCEkbRFIlMbSSvx9jDTzftwsdlFASGzsgV9g,943254
 xoscar/serialization/core.pyx,sha256=E3xIKmdI2gn99JduR3yuU_YTm-lOyG0Tkc7fZVBWCho,30131
 xoscar/backends/config.py,sha256=EG26f0GwX_f4dAhwTW77RBjiK9h8R_3JrD-rBF1bAq8,4984
 xoscar/backends/allocate_strategy.py,sha256=tC1Nbq2tJohahUwd-zoRYHEDX65wyuX8tmeY45uWj_w,4845
-xoscar/backends/message.cpython-38-darwin.so,sha256=gy4DoEb9HlwkherJr0LnQ-oG5j2gVDFaYrC12dmReuU,822985
+xoscar/backends/message.cpython-38-darwin.so,sha256=OpmZ4lRiQvvxgGgrcU9E1F7YGs_l9mZwN7FSO8YHfi0,822985
 xoscar/backends/__init__.py,sha256=VHEBQcUWM5bj027W8EUf9PiJUAP7JoMrRw3Tsvy5ySw,643
 xoscar/backends/core.py,sha256=o6g3ZOW7PkGmiu-nNtp6I3Sd_2KkQDwOsKz-FdgRFs0,7390
 xoscar/backends/context.py,sha256=b4mDqcrA7uBsy9Rb5laxlbujCyj8GpBglpjkNcg-Mg0,15285