Class _ActorMethodMetadata

python/ray/actor.py:745–819

A container for the metadata required to invoke an actor method. This class intentionally does *not* hold a reference to the `ActorHandle`, as that causes a circular reference that delays `ActorHandle` destruction until the Python GC runs. Instead, it can be used as a factory to lazily

class _ActorMethodMetadata:
    """A container for the metadata required to invoke an actor method.

    This class intentionally does *not* hold a reference to the `ActorHandle`, as that causes
    a circular reference that delays `ActorHandle` destruction until the Python GC runs.

    Instead, it can be used as a factory to lazily generate `ActorMethod` instances that can
    be used to submit actor tasks for this method.
    """

    def __init__(
        self,
        method_name: str,
        num_returns: Optional[Union[int, Literal["streaming"]]],
        max_task_retries: int,
        retry_exceptions: Union[bool, list, tuple],
        is_generator: bool,
        generator_backpressure_num_objects: int,
        enable_task_events: bool,
        decorator: Optional[Any] = None,
        signature: Optional[List[inspect.Parameter]] = None,
        tensor_transport: Optional[str] = None,
    ):
        """Initialize an _ActorMethodMetadata.

        Args:
            method_name: The name of the actor method.
            num_returns: The default number of return values that the method
                invocation should return. If None is given, it uses
                DEFAULT_ACTOR_METHOD_NUM_RETURN_VALS for a normal actor task
                and "streaming" for a generator task (when `is_generator` is True).
            max_task_retries: Number of retries on method failure.
            retry_exceptions: Boolean or list/tuple of exceptions to retry.
            is_generator: True if the method is a generator.
            generator_backpressure_num_objects: Generator-only config for backpressure.
            enable_task_events: True if task events are enabled for this method.
            decorator: Optional decorator for the method invocation.
            signature: The signature of the actor method.
            tensor_transport: The tensor transport protocol to use for the actor method.
        """
        self._method_name = method_name

        # Default case.
        if num_returns is None:
            if is_generator:
                num_returns = "streaming"
            else:
                num_returns = ray_constants.DEFAULT_ACTOR_METHOD_NUM_RETURN_VALS
        self._num_returns = num_returns
        self._max_task_retries = max_task_retries
        self._retry_exceptions = retry_exceptions
        self._is_generator = is_generator
        self._generator_backpressure_num_objects = generator_backpressure_num_objects
        self._enable_task_events = enable_task_events
        self._decorator = decorator
        self._signature = signature
        self._tensor_transport = tensor_transport