modal 1.0.4.dev10__py3-none-any.whl → 1.0.5__py3-none-any.whl

modal/functions.pyi

@@ -35,6 +35,12 @@ class Function(
     typing.Generic[modal._functions.P, modal._functions.ReturnType, modal._functions.OriginalReturnType],
     modal.object.Object,
 ):
+    """Functions are the basic units of serverless execution on Modal.
+
+    Generally, you will not construct a `Function` directly. Instead, use the
+    `App.function()` decorator to register your Python functions with your App.
+    """
+
     _info: typing.Optional[modal._utils.function_utils.FunctionInfo]
     _serve_mounts: frozenset[modal.mount.Mount]
     _app: typing.Optional[modal.app.App]
@@ -53,7 +59,10 @@ class Function(
     _method_handle_metadata: typing.Optional[dict[str, modal_proto.api_pb2.FunctionHandleMetadata]]
     _metadata: typing.Optional[modal_proto.api_pb2.FunctionHandleMetadata]
 
-    def __init__(self, *args, **kwargs): ...
+    def __init__(self, *args, **kwargs):
+        """mdmd:hidden"""
+        ...
+
     @staticmethod
     def from_local(
         info: modal._utils.function_utils.FunctionInfo,
@@ -101,14 +110,22 @@ class Function(
         _experimental_proxy_ip: typing.Optional[str] = None,
         _experimental_custom_scaling_factor: typing.Optional[float] = None,
         _experimental_enable_gpu_snapshot: bool = False,
-    ) -> Function: ...
+    ) -> Function:
+        """mdmd:hidden"""
+        ...
+
     def _bind_parameters(
         self,
         obj: modal.cls.Obj,
         options: typing.Optional[modal.cls._ServiceOptions],
         args: collections.abc.Sized,
         kwargs: dict[str, typing.Any],
-    ) -> Function: ...
+    ) -> Function:
+        """mdmd:hidden
+
+        Binds a class-function to a specific instance of (init params, options) or a new workspace
+        """
+        ...
 
     class __update_autoscaler_spec(typing_extensions.Protocol[SUPERSELF]):
         def __call__(
@@ -119,7 +136,33 @@ class Function(
             max_containers: typing.Optional[int] = None,
             buffer_containers: typing.Optional[int] = None,
             scaledown_window: typing.Optional[int] = None,
-        ) -> None: ...
+        ) -> None:
+            """Override the current autoscaler behavior for this Function.
+
+            Unspecified parameters will retain their current value, i.e. either the static value
+            from the function decorator, or an override value from a previous call to this method.
+
+            Subsequent deployments of the App containing this Function will reset the autoscaler back to
+            its static configuration.
+
+            Examples:
+
+            ```python notest
+            f = modal.Function.from_name("my-app", "function")
+
+            # Always have at least 2 containers running, with an extra buffer when the Function is active
+            f.update_autoscaler(min_containers=2, buffer_containers=1)
+
+            # Limit this Function to avoid spinning up more than 5 containers
+            f.update_autoscaler(max_containers=5)
+
+            # Extend the scaledown window to increase the amount of time that idle containers stay alive
+            f.update_autoscaler(scaledown_window=300)
+
+            ```
+            """
+            ...
+
         async def aio(
             self,
             /,
@@ -128,13 +171,71 @@ class Function(
             max_containers: typing.Optional[int] = None,
             buffer_containers: typing.Optional[int] = None,
             scaledown_window: typing.Optional[int] = None,
-        ) -> None: ...
+        ) -> None:
+            """Override the current autoscaler behavior for this Function.
+
+            Unspecified parameters will retain their current value, i.e. either the static value
+            from the function decorator, or an override value from a previous call to this method.
+
+            Subsequent deployments of the App containing this Function will reset the autoscaler back to
+            its static configuration.
+
+            Examples:
+
+            ```python notest
+            f = modal.Function.from_name("my-app", "function")
+
+            # Always have at least 2 containers running, with an extra buffer when the Function is active
+            f.update_autoscaler(min_containers=2, buffer_containers=1)
+
+            # Limit this Function to avoid spinning up more than 5 containers
+            f.update_autoscaler(max_containers=5)
+
+            # Extend the scaledown window to increase the amount of time that idle containers stay alive
+            f.update_autoscaler(scaledown_window=300)
+
+            ```
+            """
+            ...
 
     update_autoscaler: __update_autoscaler_spec[typing_extensions.Self]
 
     class __keep_warm_spec(typing_extensions.Protocol[SUPERSELF]):
-        def __call__(self, /, warm_pool_size: int) -> None: ...
-        async def aio(self, /, warm_pool_size: int) -> None: ...
+        def __call__(self, /, warm_pool_size: int) -> None:
+            """mdmd:hidden
+            Set the warm pool size for the Function.
+
+            DEPRECATED: Please adapt your code to use the more general `update_autoscaler` method instead:
+
+            ```python notest
+            f = modal.Function.from_name("my-app", "function")
+
+            # Old pattern (deprecated)
+            f.keep_warm(2)
+
+            # New pattern
+            f.update_autoscaler(min_containers=2)
+            ```
+            """
+            ...
+
+        async def aio(self, /, warm_pool_size: int) -> None:
+            """mdmd:hidden
+            Set the warm pool size for the Function.
+
+            DEPRECATED: Please adapt your code to use the more general `update_autoscaler` method instead:
+
+            ```python notest
+            f = modal.Function.from_name("my-app", "function")
+
+            # Old pattern (deprecated)
+            f.keep_warm(2)
+
+            # New pattern
+            f.update_autoscaler(min_containers=2)
+            ```
+            """
+            ...
 
     keep_warm: __keep_warm_spec[typing_extensions.Self]
 
@@ -143,7 +244,18 @@ class Function(
     @classmethod
     def from_name(
         cls: type[Function], app_name: str, name: str, *, namespace=1, environment_name: typing.Optional[str] = None
-    ) -> Function: ...
+    ) -> Function:
+        """Reference a Function from a deployed App by its name.
+
+        This is a lazy method that defers hydrating the local
+        object with metadata from Modal servers until the first
+        time it is actually used.
+
+        ```python
+        f = modal.Function.from_name("other-app", "function")
+        ```
+        """
+        ...
 
     class __lookup_spec(typing_extensions.Protocol):
         def __call__(
@@ -154,7 +266,21 @@ class Function(
             namespace=1,
             client: typing.Optional[modal.client.Client] = None,
             environment_name: typing.Optional[str] = None,
-        ) -> Function: ...
+        ) -> Function:
+            """mdmd:hidden
+            Lookup a Function from a deployed App by its name.
+
+            DEPRECATED: This method is deprecated in favor of `modal.Function.from_name`.
+
+            In contrast to `modal.Function.from_name`, this is an eager method
+            that will hydrate the local object with metadata from Modal servers.
+
+            ```python notest
+            f = modal.Function.lookup("other-app", "function")
+            ```
+            """
+            ...
+
         async def aio(
             self,
             /,
@@ -163,45 +289,120 @@ class Function(
             namespace=1,
             client: typing.Optional[modal.client.Client] = None,
             environment_name: typing.Optional[str] = None,
-        ) -> Function: ...
+        ) -> Function:
+            """mdmd:hidden
+            Lookup a Function from a deployed App by its name.
+
+            DEPRECATED: This method is deprecated in favor of `modal.Function.from_name`.
+
+            In contrast to `modal.Function.from_name`, this is an eager method
+            that will hydrate the local object with metadata from Modal servers.
+
+            ```python notest
+            f = modal.Function.lookup("other-app", "function")
+            ```
+            """
+            ...
 
     lookup: __lookup_spec
 
     @property
-    def tag(self) -> str: ...
+    def tag(self) -> str:
+        """mdmd:hidden"""
+        ...
+
     @property
-    def app(self) -> modal.app.App: ...
+    def app(self) -> modal.app.App:
+        """mdmd:hidden"""
+        ...
+
     @property
-    def stub(self) -> modal.app.App: ...
+    def stub(self) -> modal.app.App:
+        """mdmd:hidden"""
+        ...
+
     @property
-    def info(self) -> modal._utils.function_utils.FunctionInfo: ...
+    def info(self) -> modal._utils.function_utils.FunctionInfo:
+        """mdmd:hidden"""
+        ...
+
     @property
-    def spec(self) -> modal._functions._FunctionSpec: ...
+    def spec(self) -> modal._functions._FunctionSpec:
+        """mdmd:hidden"""
+        ...
+
     def _is_web_endpoint(self) -> bool: ...
-    def get_build_def(self) -> str: ...
+    def get_build_def(self) -> str:
+        """mdmd:hidden"""
+        ...
+
     def _initialize_from_empty(self): ...
     def _hydrate_metadata(self, metadata: typing.Optional[google.protobuf.message.Message]): ...
     def _get_metadata(self): ...
     def _check_no_web_url(self, fn_name: str): ...
     @property
-    def web_url(self) -> typing.Optional[str]: ...
+    def web_url(self) -> typing.Optional[str]:
+        """mdmd:hidden
+        Deprecated. Use the `Function.get_web_url()` method instead.
+
+        URL of a Function running as a web endpoint.
+        """
+        ...
 
     class __get_web_url_spec(typing_extensions.Protocol[SUPERSELF]):
-        def __call__(self, /) -> typing.Optional[str]: ...
-        async def aio(self, /) -> typing.Optional[str]: ...
+        def __call__(self, /) -> typing.Optional[str]:
+            """URL of a Function running as a web endpoint."""
+            ...
+
+        async def aio(self, /) -> typing.Optional[str]:
+            """URL of a Function running as a web endpoint."""
+            ...
 
     get_web_url: __get_web_url_spec[typing_extensions.Self]
 
     @property
-    def is_generator(self) -> bool: ...
+    def is_generator(self) -> bool:
+        """mdmd:hidden"""
+        ...
 
     class ___map_spec(typing_extensions.Protocol[SUPERSELF]):
         def __call__(
-            self, /, input_queue: modal.parallel_map.SynchronizedQueue, order_outputs: bool, return_exceptions: bool
-        ) -> typing.Generator[typing.Any, None, None]: ...
+            self,
+            /,
+            input_queue: modal.parallel_map.SynchronizedQueue,
+            order_outputs: bool,
+            return_exceptions: bool,
+            wrap_returned_exceptions: bool,
+        ) -> typing.Generator[typing.Any, None, None]:
+            """mdmd:hidden
+
+            Synchronicity-wrapped map implementation. To be safe against invocations of user code in
+            the synchronicity thread it doesn't accept an [async]iterator, and instead takes a
+              _SynchronizedQueue instance that is fed by higher level functions like .map()
+
+            _SynchronizedQueue is used instead of asyncio.Queue so that the main thread can put
+            items in the queue safely.
+            """
+            ...
+
         def aio(
-            self, /, input_queue: modal.parallel_map.SynchronizedQueue, order_outputs: bool, return_exceptions: bool
-        ) -> collections.abc.AsyncGenerator[typing.Any, None]: ...
+            self,
+            /,
+            input_queue: modal.parallel_map.SynchronizedQueue,
+            order_outputs: bool,
+            return_exceptions: bool,
+            wrap_returned_exceptions: bool,
+        ) -> collections.abc.AsyncGenerator[typing.Any, None]:
+            """mdmd:hidden
+
+            Synchronicity-wrapped map implementation. To be safe against invocations of user code in
+            the synchronicity thread it doesn't accept an [async]iterator, and instead takes a
+              _SynchronizedQueue instance that is fed by higher level functions like .map()
+
+            _SynchronizedQueue is used instead of asyncio.Queue so that the main thread can put
+            items in the queue safely.
+            """
+            ...
 
     _map: ___map_spec[typing_extensions.Self]
 
@@ -227,15 +428,25 @@ class Function(
 
     _call_generator: ___call_generator_spec[typing_extensions.Self]
 
-    class __remote_spec(typing_extensions.Protocol[P_INNER, ReturnType_INNER, SUPERSELF]):
-        def __call__(self, /, *args: P_INNER.args, **kwargs: P_INNER.kwargs) -> ReturnType_INNER: ...
-        async def aio(self, /, *args: P_INNER.args, **kwargs: P_INNER.kwargs) -> ReturnType_INNER: ...
+    class __remote_spec(typing_extensions.Protocol[ReturnType_INNER, P_INNER, SUPERSELF]):
+        def __call__(self, /, *args: P_INNER.args, **kwargs: P_INNER.kwargs) -> ReturnType_INNER:
+            """Calls the function remotely, executing it with the given arguments and returning the execution's result."""
+            ...
 
-    remote: __remote_spec[modal._functions.P, modal._functions.ReturnType, typing_extensions.Self]
+        async def aio(self, /, *args: P_INNER.args, **kwargs: P_INNER.kwargs) -> ReturnType_INNER:
+            """Calls the function remotely, executing it with the given arguments and returning the execution's result."""
+            ...
+
+    remote: __remote_spec[modal._functions.ReturnType, modal._functions.P, typing_extensions.Self]
 
     class __remote_gen_spec(typing_extensions.Protocol[SUPERSELF]):
-        def __call__(self, /, *args, **kwargs) -> typing.Generator[typing.Any, None, None]: ...
-        def aio(self, /, *args, **kwargs) -> collections.abc.AsyncGenerator[typing.Any, None]: ...
+        def __call__(self, /, *args, **kwargs) -> typing.Generator[typing.Any, None, None]:
+            """Calls the generator remotely, executing it with the given arguments and returning the execution's result."""
+            ...
+
+        def aio(self, /, *args, **kwargs) -> collections.abc.AsyncGenerator[typing.Any, None]:
+            """Calls the generator remotely, executing it with the given arguments and returning the execution's result."""
+            ...
 
     remote_gen: __remote_gen_spec[typing_extensions.Self]
 
@@ -244,14 +455,40 @@ class Function(
     def _get_obj(self) -> typing.Optional[modal.cls.Obj]: ...
     def local(
         self, *args: modal._functions.P.args, **kwargs: modal._functions.P.kwargs
-    ) -> modal._functions.OriginalReturnType: ...
+    ) -> modal._functions.OriginalReturnType:
+        """Calls the function locally, executing it with the given arguments and returning the execution's result.
+
+        The function will execute in the same environment as the caller, just like calling the underlying function
+        directly in Python. In particular, only secrets available in the caller environment will be available
+        through environment variables.
+        """
+        ...
+
+    class ___experimental_spawn_spec(typing_extensions.Protocol[ReturnType_INNER, P_INNER, SUPERSELF]):
+        def __call__(self, /, *args: P_INNER.args, **kwargs: P_INNER.kwargs) -> FunctionCall[ReturnType_INNER]:
+            """[Experimental] Calls the function with the given arguments, without waiting for the results.
+
+            This experimental version of the spawn method allows up to 1 million inputs to be spawned.
+
+            Returns a `modal.FunctionCall` object, that can later be polled or
+            waited for using `.get(timeout=...)`.
+            Conceptually similar to `multiprocessing.pool.apply_async`, or a Future/Promise in other contexts.
+            """
+            ...
 
-    class ___experimental_spawn_spec(typing_extensions.Protocol[P_INNER, ReturnType_INNER, SUPERSELF]):
-        def __call__(self, /, *args: P_INNER.args, **kwargs: P_INNER.kwargs) -> FunctionCall[ReturnType_INNER]: ...
-        async def aio(self, /, *args: P_INNER.args, **kwargs: P_INNER.kwargs) -> FunctionCall[ReturnType_INNER]: ...
+        async def aio(self, /, *args: P_INNER.args, **kwargs: P_INNER.kwargs) -> FunctionCall[ReturnType_INNER]:
+            """[Experimental] Calls the function with the given arguments, without waiting for the results.
+
+            This experimental version of the spawn method allows up to 1 million inputs to be spawned.
+
+            Returns a `modal.FunctionCall` object, that can later be polled or
+            waited for using `.get(timeout=...)`.
+            Conceptually similar to `multiprocessing.pool.apply_async`, or a Future/Promise in other contexts.
+            """
+            ...
 
     _experimental_spawn: ___experimental_spawn_spec[
-        modal._functions.P, modal._functions.ReturnType, typing_extensions.Self
+        modal._functions.ReturnType, modal._functions.P, typing_extensions.Self
     ]
 
     class ___spawn_map_inner_spec(typing_extensions.Protocol[P_INNER, SUPERSELF]):
@@ -260,30 +497,103 @@ class Function(
 
     _spawn_map_inner: ___spawn_map_inner_spec[modal._functions.P, typing_extensions.Self]
 
-    class __spawn_spec(typing_extensions.Protocol[P_INNER, ReturnType_INNER, SUPERSELF]):
-        def __call__(self, /, *args: P_INNER.args, **kwargs: P_INNER.kwargs) -> FunctionCall[ReturnType_INNER]: ...
-        async def aio(self, /, *args: P_INNER.args, **kwargs: P_INNER.kwargs) -> FunctionCall[ReturnType_INNER]: ...
+    class __spawn_spec(typing_extensions.Protocol[ReturnType_INNER, P_INNER, SUPERSELF]):
+        def __call__(self, /, *args: P_INNER.args, **kwargs: P_INNER.kwargs) -> FunctionCall[ReturnType_INNER]:
+            """Calls the function with the given arguments, without waiting for the results.
+
+            Returns a [`modal.FunctionCall`](https://modal.com/docs/reference/modal.FunctionCall) object
+            that can later be polled or waited for using
+            [`.get(timeout=...)`](https://modal.com/docs/reference/modal.FunctionCall#get).
+            Conceptually similar to `multiprocessing.pool.apply_async`, or a Future/Promise in other contexts.
+            """
+            ...
+
+        async def aio(self, /, *args: P_INNER.args, **kwargs: P_INNER.kwargs) -> FunctionCall[ReturnType_INNER]:
+            """Calls the function with the given arguments, without waiting for the results.
 
-    spawn: __spawn_spec[modal._functions.P, modal._functions.ReturnType, typing_extensions.Self]
+            Returns a [`modal.FunctionCall`](https://modal.com/docs/reference/modal.FunctionCall) object
+            that can later be polled or waited for using
+            [`.get(timeout=...)`](https://modal.com/docs/reference/modal.FunctionCall#get).
+            Conceptually similar to `multiprocessing.pool.apply_async`, or a Future/Promise in other contexts.
+            """
+            ...
 
-    def get_raw_f(self) -> collections.abc.Callable[..., typing.Any]: ...
+    spawn: __spawn_spec[modal._functions.ReturnType, modal._functions.P, typing_extensions.Self]
+
+    def get_raw_f(self) -> collections.abc.Callable[..., typing.Any]:
+        """Return the inner Python object wrapped by this Modal Function."""
+        ...
 
     class __get_current_stats_spec(typing_extensions.Protocol[SUPERSELF]):
-        def __call__(self, /) -> modal._functions.FunctionStats: ...
-        async def aio(self, /) -> modal._functions.FunctionStats: ...
+        def __call__(self, /) -> modal._functions.FunctionStats:
+            """Return a `FunctionStats` object describing the current function's queue and runner counts."""
+            ...
+
+        async def aio(self, /) -> modal._functions.FunctionStats:
+            """Return a `FunctionStats` object describing the current function's queue and runner counts."""
+            ...
 
     get_current_stats: __get_current_stats_spec[typing_extensions.Self]
 
     class ___get_schema_spec(typing_extensions.Protocol[SUPERSELF]):
-        def __call__(self, /) -> modal_proto.api_pb2.FunctionSchema: ...
-        async def aio(self, /) -> modal_proto.api_pb2.FunctionSchema: ...
+        def __call__(self, /) -> modal_proto.api_pb2.FunctionSchema:
+            """Returns recorded schema for function, internal use only for now"""
+            ...
+
+        async def aio(self, /) -> modal_proto.api_pb2.FunctionSchema:
+            """Returns recorded schema for function, internal use only for now"""
+            ...
 
     _get_schema: ___get_schema_spec[typing_extensions.Self]
 
     class __map_spec(typing_extensions.Protocol[SUPERSELF]):
         def __call__(
-            self, /, *input_iterators, kwargs={}, order_outputs: bool = True, return_exceptions: bool = False
-        ) -> modal._utils.async_utils.AsyncOrSyncIterable: ...
+            self,
+            /,
+            *input_iterators,
+            kwargs={},
+            order_outputs: bool = True,
+            return_exceptions: bool = False,
+            wrap_returned_exceptions: bool = True,
+        ) -> modal._utils.async_utils.AsyncOrSyncIterable:
+            """Parallel map over a set of inputs.
+
+            Takes one iterator argument per argument in the function being mapped over.
+
+            Example:
+            ```python
+            @app.function()
+            def my_func(a):
+                return a ** 2
+
+
+            @app.local_entrypoint()
+            def main():
+                assert list(my_func.map([1, 2, 3, 4])) == [1, 4, 9, 16]
+            ```
+
+            If applied to a `app.function`, `map()` returns one result per input and the output order
+            is guaranteed to be the same as the input order. Set `order_outputs=False` to return results
+            in the order that they are completed instead.
+
+            `return_exceptions` can be used to treat exceptions as successful results:
+
+            ```python
+            @app.function()
+            def my_func(a):
+                if a == 2:
+                    raise Exception("ohno")
+                return a ** 2
+
+
+            @app.local_entrypoint()
+            def main():
+                # [0, 1, UserCodeException(Exception('ohno'))]
+                print(list(my_func.map(range(3), return_exceptions=True)))
+            ```
+            """
+            ...
+
         def aio(
             self,
             /,
@@ -291,6 +601,7 @@ class Function(
             kwargs={},
             order_outputs: bool = True,
             return_exceptions: bool = False,
+            wrap_returned_exceptions: bool = True,
         ) -> typing.AsyncGenerator[typing.Any, None]: ...
 
     map: __map_spec[typing_extensions.Self]
@@ -304,7 +615,26 @@ class Function(
             kwargs={},
             order_outputs: bool = True,
             return_exceptions: bool = False,
-        ) -> modal._utils.async_utils.AsyncOrSyncIterable: ...
+            wrap_returned_exceptions: bool = True,
+        ) -> modal._utils.async_utils.AsyncOrSyncIterable:
+            """Like `map`, but spreads arguments over multiple function arguments.
+
+            Assumes every input is a sequence (e.g. a tuple).
+
+            Example:
+            ```python
+            @app.function()
+            def my_func(a, b):
+                return a + b
+
+
+            @app.local_entrypoint()
+            def main():
+                assert list(my_func.starmap([(1, 2), (3, 4)])) == [3, 7]
+            ```
+            """
+            ...
+
         def aio(
             self,
             /,
@@ -315,68 +645,246 @@ class Function(
             kwargs={},
             order_outputs: bool = True,
             return_exceptions: bool = False,
+            wrap_returned_exceptions: bool = True,
         ) -> typing.AsyncIterable[typing.Any]: ...
 
     starmap: __starmap_spec[typing_extensions.Self]
 
     class __for_each_spec(typing_extensions.Protocol[SUPERSELF]):
-        def __call__(self, /, *input_iterators, kwargs={}, ignore_exceptions: bool = False): ...
+        def __call__(self, /, *input_iterators, kwargs={}, ignore_exceptions: bool = False):
+            """Execute function for all inputs, ignoring outputs. Waits for completion of the inputs.
+
+            Convenient alias for `.map()` in cases where the function just needs to be called.
+            as the caller doesn't have to consume the generator to process the inputs.
+            """
+            ...
+
         async def aio(self, /, *input_iterators, kwargs={}, ignore_exceptions: bool = False) -> None: ...
 
     for_each: __for_each_spec[typing_extensions.Self]
 
     class __spawn_map_spec(typing_extensions.Protocol[SUPERSELF]):
-        def __call__(self, /, *input_iterators, kwargs={}) -> None: ...
-        async def aio(self, /, *input_iterators, kwargs={}) -> None: ...
+        def __call__(self, /, *input_iterators, kwargs={}) -> None:
+            """Spawn parallel execution over a set of inputs, exiting as soon as the inputs are created (without waiting
+            for the map to complete).
+
+            Takes one iterator argument per argument in the function being mapped over.
+
+            Example:
+            ```python
+            @app.function()
+            def my_func(a):
+                return a ** 2
+
+
+            @app.local_entrypoint()
+            def main():
+                my_func.spawn_map([1, 2, 3, 4])
+            ```
+
+            Programmatic retrieval of results will be supported in a future update.
+            """
+            ...
+
+        async def aio(self, /, *input_iterators, kwargs={}) -> None:
+            """This runs in an event loop on the main thread. It consumes inputs from the input iterators and creates async
+            function calls for each.
+            """
+            ...
 
     spawn_map: __spawn_map_spec[typing_extensions.Self]
 
 class FunctionCall(typing.Generic[modal._functions.ReturnType], modal.object.Object):
+    """A reference to an executed function call.
+
+    Constructed using `.spawn(...)` on a Modal function with the same
+    arguments that a function normally takes. Acts as a reference to
+    an ongoing function call that can be passed around and used to
+    poll or fetch function results at some later time.
+
+    Conceptually similar to a Future/Promise/AsyncResult in other contexts and languages.
+    """
+
     _is_generator: bool
 
-    def __init__(self, *args, **kwargs): ...
+    def __init__(self, *args, **kwargs):
+        """mdmd:hidden"""
+        ...
+
     def _invocation(self): ...
 
     class __get_spec(typing_extensions.Protocol[ReturnType_INNER, SUPERSELF]):
-        def __call__(self, /, timeout: typing.Optional[float] = None) -> ReturnType_INNER: ...
-        async def aio(self, /, timeout: typing.Optional[float] = None) -> ReturnType_INNER: ...
+        def __call__(self, /, timeout: typing.Optional[float] = None) -> ReturnType_INNER:
+            """Get the result of the function call.
+
+            This function waits indefinitely by default. It takes an optional
+            `timeout` argument that specifies the maximum number of seconds to wait,
+            which can be set to `0` to poll for an output immediately.
+
+            The returned coroutine is not cancellation-safe.
+            """
+            ...
+
+        async def aio(self, /, timeout: typing.Optional[float] = None) -> ReturnType_INNER:
+            """Get the result of the function call.
+
+            This function waits indefinitely by default. It takes an optional
+            `timeout` argument that specifies the maximum number of seconds to wait,
+            which can be set to `0` to poll for an output immediately.
+
+            The returned coroutine is not cancellation-safe.
+            """
+            ...
 
     get: __get_spec[modal._functions.ReturnType, typing_extensions.Self]
 
     class __get_call_graph_spec(typing_extensions.Protocol[SUPERSELF]):
-        def __call__(self, /) -> list[modal.call_graph.InputInfo]: ...
-        async def aio(self, /) -> list[modal.call_graph.InputInfo]: ...
+        def __call__(self, /) -> list[modal.call_graph.InputInfo]:
+            """Returns a structure representing the call graph from a given root
+            call ID, along with the status of execution for each node.
+
+            See [`modal.call_graph`](https://modal.com/docs/reference/modal.call_graph) reference page
+            for documentation on the structure of the returned `InputInfo` items.
+            """
+            ...
+
+        async def aio(self, /) -> list[modal.call_graph.InputInfo]:
+            """Returns a structure representing the call graph from a given root
+            call ID, along with the status of execution for each node.
+
+            See [`modal.call_graph`](https://modal.com/docs/reference/modal.call_graph) reference page
+            for documentation on the structure of the returned `InputInfo` items.
+            """
+            ...
 
     get_call_graph: __get_call_graph_spec[typing_extensions.Self]
 
     class __cancel_spec(typing_extensions.Protocol[SUPERSELF]):
-        def __call__(self, /, terminate_containers: bool = False): ...
-        async def aio(self, /, terminate_containers: bool = False): ...
+        def __call__(self, /, terminate_containers: bool = False):
+            """Cancels the function call, which will stop its execution and mark its inputs as
+            [`TERMINATED`](https://modal.com/docs/reference/modal.call_graph#modalcall_graphinputstatus).
+
+            If `terminate_containers=True` - the containers running the cancelled inputs are all terminated
+            causing any non-cancelled inputs on those containers to be rescheduled in new containers.
+            """
+            ...
+
+        async def aio(self, /, terminate_containers: bool = False):
+            """Cancels the function call, which will stop its execution and mark its inputs as
+            [`TERMINATED`](https://modal.com/docs/reference/modal.call_graph#modalcall_graphinputstatus).
+
+            If `terminate_containers=True` - the containers running the cancelled inputs are all terminated
+            causing any non-cancelled inputs on those containers to be rescheduled in new containers.
+            """
+            ...
 
     cancel: __cancel_spec[typing_extensions.Self]
 
     class __from_id_spec(typing_extensions.Protocol):
         def __call__(
             self, /, function_call_id: str, client: typing.Optional[modal.client.Client] = None
-        ) -> FunctionCall[typing.Any]: ...
+        ) -> FunctionCall[typing.Any]:
+            """Instantiate a FunctionCall object from an existing ID.
+
+            Examples:
+
+            ```python notest
+            # Spawn a FunctionCall and keep track of its object ID
+            fc = my_func.spawn()
+            fc_id = fc.object_id
+
+            # Later, use the ID to re-instantiate the FunctionCall object
+            fc = _FunctionCall.from_id(fc_id)
+            result = fc.get()
+            ```
+
+            Note that it's only necessary to re-instantiate the `FunctionCall` with this method
+            if you no longer have access to the original object returned from `Function.spawn`.
+            """
+            ...
+
         async def aio(
             self, /, function_call_id: str, client: typing.Optional[modal.client.Client] = None
-        ) -> FunctionCall[typing.Any]: ...
+        ) -> FunctionCall[typing.Any]:
+            """Instantiate a FunctionCall object from an existing ID.
+
+            Examples:
+
+            ```python notest
+            # Spawn a FunctionCall and keep track of its object ID
+            fc = my_func.spawn()
+            fc_id = fc.object_id
+
+            # Later, use the ID to re-instantiate the FunctionCall object
+            fc = _FunctionCall.from_id(fc_id)
+            result = fc.get()
+            ```
+
+            Note that it's only necessary to re-instantiate the `FunctionCall` with this method
+            if you no longer have access to the original object returned from `Function.spawn`.
+            """
+            ...
 
     from_id: __from_id_spec
 
     class __gather_spec(typing_extensions.Protocol):
-        def __call__(
-            self, /, *function_calls: FunctionCall[modal._functions.T]
-        ) -> typing.Sequence[modal._functions.T]: ...
+        def __call__(self, /, *function_calls: FunctionCall[modal._functions.T]) -> typing.Sequence[modal._functions.T]:
+            """Wait until all Modal FunctionCall objects have results before returning.
+
+            Accepts a variable number of `FunctionCall` objects, as returned by `Function.spawn()`.
+
+            Returns a list of results from each FunctionCall, or raises an exception
+            from the first failing function call.
+
+            Examples:
+
+            ```python notest
+            fc1 = slow_func_1.spawn()
+            fc2 = slow_func_2.spawn()
+
+            result_1, result_2 = modal.FunctionCall.gather(fc1, fc2)
+            ```
+
+            *Added in v0.73.69*: This method replaces the deprecated `modal.functions.gather` function.
+            """
+            ...
+
         async def aio(
             self, /, *function_calls: FunctionCall[modal._functions.T]
-        ) -> typing.Sequence[modal._functions.T]: ...
+        ) -> typing.Sequence[modal._functions.T]:
+            """Wait until all Modal FunctionCall objects have results before returning.
+
+            Accepts a variable number of `FunctionCall` objects, as returned by `Function.spawn()`.
+
+            Returns a list of results from each FunctionCall, or raises an exception
+            from the first failing function call.
+
+            Examples:
+
+            ```python notest
+            fc1 = slow_func_1.spawn()
+            fc2 = slow_func_2.spawn()
+
+            result_1, result_2 = modal.FunctionCall.gather(fc1, fc2)
+            ```
+
+            *Added in v0.73.69*: This method replaces the deprecated `modal.functions.gather` function.
+            """
+            ...
 
     gather: __gather_spec
 
 class __gather_spec(typing_extensions.Protocol):
-    def __call__(self, /, *function_calls) -> typing.Sequence[modal._functions.T]: ...
-    async def aio(self, /, *function_calls) -> typing.Sequence[modal._functions.T]: ...
+    def __call__(self, /, *function_calls) -> typing.Sequence[modal._functions.T]:
+        """mdmd:hidden
+        Deprecated: Please use `modal.FunctionCall.gather()` instead.
+        """
+        ...
+
+    async def aio(self, /, *function_calls) -> typing.Sequence[modal._functions.T]:
+        """mdmd:hidden
+        Deprecated: Please use `modal.FunctionCall.gather()` instead.
+        """
+        ...
 
 gather: __gather_spec