modal 1.1.2.dev44__tar.gz → 1.1.3.dev0__tar.gz

{modal-1.1.2.dev44 → modal-1.1.3.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: modal
-Version: 1.1.2.dev44
+Version: 1.1.3.dev0
 Summary: Python client library for Modal
 Author-email: Modal Labs <support@modal.com>
 License: Apache-2.0

{modal-1.1.2.dev44 → modal-1.1.3.dev0}/modal/_functions.py

@@ -9,7 +9,7 @@ import warnings
 from collections.abc import AsyncGenerator, Sequence, Sized
 from dataclasses import dataclass
 from pathlib import PurePosixPath
-from typing import TYPE_CHECKING, Any, Callable, Optional, Union
+from typing import TYPE_CHECKING, Any, AsyncIterator, Callable, Optional, Union
 
 import typing_extensions
 from google.protobuf.message import Message
@@ -360,6 +360,43 @@ class _Invocation:
                 if items_total is not None and items_received >= items_total:
                     break
 
+    async def enumerate(self, start_index: int, end_index: int):
+        """Iterate over the results of the function call in the range [start_index, end_index)."""
+        limit = 49
+        current_index = start_index
+        while current_index < end_index:
+            # batch_end_indx is inclusive, so we subtract 1 to get the last index in the batch.
+            batch_end_index = min(current_index + limit, end_index) - 1
+            request = api_pb2.FunctionGetOutputsRequest(
+                function_call_id=self.function_call_id,
+                timeout=0,
+                last_entry_id="0-0",
+                clear_on_success=False,
+                requested_at=time.time(),
+                start_idx=current_index,
+                end_idx=batch_end_index,
+            )
+            response: api_pb2.FunctionGetOutputsResponse = await retry_transient_errors(
+                self.stub.FunctionGetOutputs,
+                request,
+                attempt_timeout=ATTEMPT_TIMEOUT_GRACE_PERIOD,
+            )
+
+            outputs = list(response.outputs)
+            outputs.sort(key=lambda x: x.idx)
+            for output in outputs:
+                if output.idx != current_index:
+                    break
+                result = await _process_result(output.result, output.data_format, self.stub, self.client)
+                yield output.idx, result
+                current_index += 1
+
+            # We're missing current_index, so we need to poll the function for the next result
+            if len(outputs) < (batch_end_index - current_index + 1):
+                result = await self.poll_function(index=current_index)
+                yield current_index, result
+                current_index += 1
+
 
 class _InputPlaneInvocation:
     """Internal client representation of a single-input call to a Modal Function using the input
@@ -1865,6 +1902,36 @@ class _FunctionCall(typing.Generic[ReturnType], _Object, type_prefix="fc"):
         """
         return await self._invocation().poll_function(timeout=timeout, index=index)
 
+    @live_method_gen
+    async def iter(self, *, start: int = 0, end: Optional[int] = None) -> AsyncIterator[ReturnType]:
+        """Iterate in-order over the results of the function call.
+
+        Optionally, specify a range [start, end) to iterate over.
+
+        Example:
+        ```python
+        @app.function()
+        def my_func(a):
+            return a ** 2
+
+
+        @app.local_entrypoint()
+        def main():
+            fc = my_func.spawn_map([1, 2, 3, 4])
+            assert list(fc.iter()) == [1, 4, 9, 16]
+            assert list(fc.iter(start=1, end=3)) == [4, 9]
+        ```
+
+        If `end` is not provided, it will iterate over all results.
+        """
+        num_inputs = await self.num_inputs()
+        if end is None:
+            end = num_inputs
+        if start < 0 or end > num_inputs:
+            raise ValueError(f"Invalid index range: {start} to {end} for {num_inputs} inputs")
+        async for _, item in self._invocation().enumerate(start_index=start, end_index=end):
+            yield item
+
     async def get_call_graph(self) -> list[InputInfo]:
         """Returns a structure representing the call graph from a given root
         call ID, along with the status of execution for each node.

{modal-1.1.2.dev44 → modal-1.1.3.dev0}/modal/app.py

@@ -641,7 +641,7 @@ class _App:
         scaledown_window: Optional[int] = None,  # Max time (in seconds) a container can remain idle while scaling down.
         proxy: Optional[_Proxy] = None,  # Reference to a Modal Proxy to use in front of this function.
         retries: Optional[Union[int, Retries]] = None,  # Number of times to retry each input in case of failure.
-        timeout: int = 300,  # Maximum execution time of the function in seconds.
+        timeout: int = 300,  # Maximum execution time in seconds.
         name: Optional[str] = None,  # Sets the Modal name of the function within the app
         is_generator: Optional[
             bool
@@ -869,7 +869,7 @@ class _App:
         scaledown_window: Optional[int] = None,  # Max time (in seconds) a container can remain idle while scaling down.
         proxy: Optional[_Proxy] = None,  # Reference to a Modal Proxy to use in front of this function.
         retries: Optional[Union[int, Retries]] = None,  # Number of times to retry each input in case of failure.
-        timeout: int = 300,  # Maximum execution time of the function in seconds.
+        timeout: int = 300,  # Maximum execution time in seconds; applies independently to startup and each input.
         cloud: Optional[str] = None,  # Cloud provider to run the function on. Possible values are aws, gcp, oci, auto.
         region: Optional[Union[str, Sequence[str]]] = None,  # Region or regions to run the function on.
         enable_memory_snapshot: bool = False,  # Enable memory checkpointing for faster cold starts.

{modal-1.1.2.dev44 → modal-1.1.3.dev0}/modal/client.pyi

@@ -33,7 +33,7 @@ class _Client:
         server_url: str,
         client_type: int,
         credentials: typing.Optional[tuple[str, str]],
-        version: str = "1.1.2.dev44",
+        version: str = "1.1.3.dev0",
     ):
         """mdmd:hidden
         The Modal client object is not intended to be instantiated directly by users.
@@ -164,7 +164,7 @@ class Client:
         server_url: str,
         client_type: int,
         credentials: typing.Optional[tuple[str, str]],
-        version: str = "1.1.2.dev44",
+        version: str = "1.1.3.dev0",
     ):
         """mdmd:hidden
         The Modal client object is not intended to be instantiated directly by users.

{modal-1.1.2.dev44 → modal-1.1.3.dev0}/modal/dict.py

@@ -81,6 +81,8 @@ class _DictManager:
         Note that this method does not return a local instance of the Dict. You can use
         `modal.Dict.from_name` to perform a lookup after creation.
 
+        Added in v1.1.2.
+
         """
         check_object_name(name, "Dict")
         client = await _Client.from_env() if client is None else client
@@ -132,6 +134,8 @@ class _DictManager:
         dicts = modal.Dict.objects.list(max_objects=10, created_before="2025-01-01")
         ```
 
+        Added in v1.1.2.
+
         """
         client = await _Client.from_env() if client is None else client
         if max_objects is not None and max_objects < 0:
@@ -192,6 +196,9 @@ class _DictManager:
         ```python notest
         await modal.Dict.objects.delete("my-dict", environment_name="dev")
         ```
+
+        Added in v1.1.2.
+
         """
         try:
             obj = await _Dict.from_name(name, environment_name=environment_name).hydrate(client)

{modal-1.1.2.dev44 → modal-1.1.3.dev0}/modal/dict.pyi

@@ -66,6 +66,8 @@ class _DictManager:
 
         Note that this method does not return a local instance of the Dict. You can use
         `modal.Dict.from_name` to perform a lookup after creation.
+
+        Added in v1.1.2.
         """
         ...
 
@@ -98,6 +100,8 @@ class _DictManager:
         ```python
         dicts = modal.Dict.objects.list(max_objects=10, created_before="2025-01-01")
         ```
+
+        Added in v1.1.2.
         """
         ...
 
@@ -125,6 +129,8 @@ class _DictManager:
         ```python notest
         await modal.Dict.objects.delete("my-dict", environment_name="dev")
         ```
+
+        Added in v1.1.2.
         """
         ...
 
@@ -167,6 +173,8 @@ class DictManager:
 
             Note that this method does not return a local instance of the Dict. You can use
             `modal.Dict.from_name` to perform a lookup after creation.
+
+            Added in v1.1.2.
             """
             ...
 
@@ -202,6 +210,8 @@ class DictManager:
 
             Note that this method does not return a local instance of the Dict. You can use
             `modal.Dict.from_name` to perform a lookup after creation.
+
+            Added in v1.1.2.
             """
             ...
 
@@ -238,6 +248,8 @@ class DictManager:
             ```python
             dicts = modal.Dict.objects.list(max_objects=10, created_before="2025-01-01")
             ```
+
+            Added in v1.1.2.
             """
             ...
 
@@ -271,6 +283,8 @@ class DictManager:
             ```python
             dicts = modal.Dict.objects.list(max_objects=10, created_before="2025-01-01")
             ```
+
+            Added in v1.1.2.
             """
             ...
 
@@ -302,6 +316,8 @@ class DictManager:
             ```python notest
             await modal.Dict.objects.delete("my-dict", environment_name="dev")
             ```
+
+            Added in v1.1.2.
             """
             ...
 
@@ -330,6 +346,8 @@ class DictManager:
             ```python notest
             await modal.Dict.objects.delete("my-dict", environment_name="dev")
             ```
+
+            Added in v1.1.2.
             """
             ...
 

{modal-1.1.2.dev44 → modal-1.1.3.dev0}/modal/functions.pyi

@@ -433,7 +433,7 @@ class Function(
 
     _call_generator: ___call_generator_spec[typing_extensions.Self]
 
-    class __remote_spec(typing_extensions.Protocol[ReturnType_INNER, P_INNER, SUPERSELF]):
+    class __remote_spec(typing_extensions.Protocol[P_INNER, ReturnType_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."""
             ...
@@ -442,7 +442,7 @@ class Function(
             """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]
+    remote: __remote_spec[modal._functions.P, modal._functions.ReturnType, typing_extensions.Self]
 
     class __remote_gen_spec(typing_extensions.Protocol[SUPERSELF]):
         def __call__(self, /, *args, **kwargs) -> typing.Generator[typing.Any, None, None]:
@@ -469,7 +469,7 @@ class Function(
         """
         ...
 
-    class ___experimental_spawn_spec(typing_extensions.Protocol[ReturnType_INNER, P_INNER, SUPERSELF]):
+    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]:
             """[Experimental] Calls the function with the given arguments, without waiting for the results.
 
@@ -493,7 +493,7 @@ class Function(
             ...
 
     _experimental_spawn: ___experimental_spawn_spec[
-        modal._functions.ReturnType, modal._functions.P, typing_extensions.Self
+        modal._functions.P, modal._functions.ReturnType, typing_extensions.Self
     ]
 
     class ___spawn_map_inner_spec(typing_extensions.Protocol[P_INNER, SUPERSELF]):
@@ -502,7 +502,7 @@ class Function(
 
     _spawn_map_inner: ___spawn_map_inner_spec[modal._functions.P, typing_extensions.Self]
 
-    class __spawn_spec(typing_extensions.Protocol[ReturnType_INNER, P_INNER, SUPERSELF]):
+    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]:
             """Calls the function with the given arguments, without waiting for the results.
 
@@ -523,7 +523,7 @@ class Function(
             """
             ...
 
-    spawn: __spawn_spec[modal._functions.ReturnType, modal._functions.P, typing_extensions.Self]
+    spawn: __spawn_spec[modal._functions.P, modal._functions.ReturnType, typing_extensions.Self]
 
     def get_raw_f(self) -> collections.abc.Callable[..., typing.Any]:
         """Return the inner Python object wrapped by this Modal Function."""
@@ -788,6 +788,55 @@ class FunctionCall(typing.Generic[modal._functions.ReturnType], modal.object.Obj
 
     get: __get_spec[modal._functions.ReturnType, typing_extensions.Self]
 
+    class __iter_spec(typing_extensions.Protocol[ReturnType_INNER, SUPERSELF]):
+        def __call__(self, /, *, start: int = 0, end: typing.Optional[int] = None) -> typing.Iterator[ReturnType_INNER]:
+            """Iterate in-order over the results of the function call.
+
+            Optionally, specify a range [start, end) to iterate over.
+
+            Example:
+            ```python
+            @app.function()
+            def my_func(a):
+                return a ** 2
+
+
+            @app.local_entrypoint()
+            def main():
+                fc = my_func.spawn_map([1, 2, 3, 4])
+                assert list(fc.iter()) == [1, 4, 9, 16]
+                assert list(fc.iter(start=1, end=3)) == [4, 9]
+            ```
+
+            If `end` is not provided, it will iterate over all results.
+            """
+            ...
+
+        def aio(self, /, *, start: int = 0, end: typing.Optional[int] = None) -> typing.AsyncIterator[ReturnType_INNER]:
+            """Iterate in-order over the results of the function call.
+
+            Optionally, specify a range [start, end) to iterate over.
+
+            Example:
+            ```python
+            @app.function()
+            def my_func(a):
+                return a ** 2
+
+
+            @app.local_entrypoint()
+            def main():
+                fc = my_func.spawn_map([1, 2, 3, 4])
+                assert list(fc.iter()) == [1, 4, 9, 16]
+                assert list(fc.iter(start=1, end=3)) == [4, 9]
+            ```
+
+            If `end` is not provided, it will iterate over all results.
+            """
+            ...
+
+    iter: __iter_spec[modal._functions.ReturnType, typing_extensions.Self]
+
     class __get_call_graph_spec(typing_extensions.Protocol[SUPERSELF]):
         def __call__(self, /) -> list[modal.call_graph.InputInfo]:
             """Returns a structure representing the call graph from a given root

{modal-1.1.2.dev44 → modal-1.1.3.dev0}/modal/queue.py

@@ -79,6 +79,8 @@ class _QueueManager:
         Note that this method does not return a local instance of the Queue. You can use
         `modal.Queue.from_name` to perform a lookup after creation.
 
+        Added in v1.1.2.
+
         """
         check_object_name(name, "Queue")
         client = await _Client.from_env() if client is None else client
@@ -130,6 +132,8 @@ class _QueueManager:
         queues = modal.Queue.objects.list(max_objects=10, created_before="2025-01-01")
         ```
 
+        Added in v1.1.2.
+
         """
         client = await _Client.from_env() if client is None else client
         if max_objects is not None and max_objects < 0:
@@ -190,6 +194,9 @@ class _QueueManager:
         ```python notest
         await modal.Queue.objects.delete("my-queue", environment_name="dev")
         ```
+
+        Added in v1.1.2.
+
         """
         try:
             obj = await _Queue.from_name(name, environment_name=environment_name).hydrate(client)

{modal-1.1.2.dev44 → modal-1.1.3.dev0}/modal/queue.pyi

@@ -64,6 +64,8 @@ class _QueueManager:
 
         Note that this method does not return a local instance of the Queue. You can use
         `modal.Queue.from_name` to perform a lookup after creation.
+
+        Added in v1.1.2.
         """
         ...
 
@@ -96,6 +98,8 @@ class _QueueManager:
         ```python
         queues = modal.Queue.objects.list(max_objects=10, created_before="2025-01-01")
         ```
+
+        Added in v1.1.2.
         """
         ...
 
@@ -123,6 +127,8 @@ class _QueueManager:
         ```python notest
         await modal.Queue.objects.delete("my-queue", environment_name="dev")
         ```
+
+        Added in v1.1.2.
         """
         ...
 
@@ -165,6 +171,8 @@ class QueueManager:
 
             Note that this method does not return a local instance of the Queue. You can use
             `modal.Queue.from_name` to perform a lookup after creation.
+
+            Added in v1.1.2.
             """
             ...
 
@@ -200,6 +208,8 @@ class QueueManager:
 
             Note that this method does not return a local instance of the Queue. You can use
             `modal.Queue.from_name` to perform a lookup after creation.
+
+            Added in v1.1.2.
             """
             ...
 
@@ -236,6 +246,8 @@ class QueueManager:
             ```python
             queues = modal.Queue.objects.list(max_objects=10, created_before="2025-01-01")
             ```
+
+            Added in v1.1.2.
             """
             ...
 
@@ -269,6 +281,8 @@ class QueueManager:
             ```python
             queues = modal.Queue.objects.list(max_objects=10, created_before="2025-01-01")
             ```
+
+            Added in v1.1.2.
             """
             ...
 
@@ -300,6 +314,8 @@ class QueueManager:
             ```python notest
             await modal.Queue.objects.delete("my-queue", environment_name="dev")
             ```
+
+            Added in v1.1.2.
             """
             ...
 
@@ -328,6 +344,8 @@ class QueueManager:
             ```python notest
             await modal.Queue.objects.delete("my-queue", environment_name="dev")
             ```
+
+            Added in v1.1.2.
             """
             ...
 

{modal-1.1.2.dev44 → modal-1.1.3.dev0}/modal/secret.py

@@ -74,6 +74,8 @@ class _SecretManager:
         Note that this method does not return a local instance of the Secret. You can use
         `modal.Secret.from_name` to perform a lookup after creation.
 
+        Added in v1.1.2.
+
         """
         check_object_name(name, "Secret")
         client = await _Client.from_env() if client is None else client
@@ -126,6 +128,8 @@ class _SecretManager:
         secrets = modal.Secret.objects.list(max_objects=10, created_before="2025-01-01")
         ```
 
+        Added in v1.1.2.
+
         """
         client = await _Client.from_env() if client is None else client
         if max_objects is not None and max_objects < 0:
@@ -185,6 +189,9 @@ class _SecretManager:
         ```python notest
         await modal.Secret.objects.delete("my-secret", environment_name="dev")
         ```
+
+        Added in v1.1.2.
+
         """
         try:
             obj = await _Secret.from_name(name, environment_name=environment_name).hydrate(client)

{modal-1.1.2.dev44 → modal-1.1.3.dev0}/modal/secret.pyi

@@ -65,6 +65,8 @@ class _SecretManager:
 
         Note that this method does not return a local instance of the Secret. You can use
         `modal.Secret.from_name` to perform a lookup after creation.
+
+        Added in v1.1.2.
         """
         ...
 
@@ -97,6 +99,8 @@ class _SecretManager:
         ```python
         secrets = modal.Secret.objects.list(max_objects=10, created_before="2025-01-01")
         ```
+
+        Added in v1.1.2.
         """
         ...
 
@@ -123,6 +127,8 @@ class _SecretManager:
         ```python notest
         await modal.Secret.objects.delete("my-secret", environment_name="dev")
         ```
+
+        Added in v1.1.2.
         """
         ...
 
@@ -168,6 +174,8 @@ class SecretManager:
 
             Note that this method does not return a local instance of the Secret. You can use
             `modal.Secret.from_name` to perform a lookup after creation.
+
+            Added in v1.1.2.
             """
             ...
 
@@ -206,6 +214,8 @@ class SecretManager:
 
             Note that this method does not return a local instance of the Secret. You can use
             `modal.Secret.from_name` to perform a lookup after creation.
+
+            Added in v1.1.2.
             """
             ...
 
@@ -242,6 +252,8 @@ class SecretManager:
             ```python
             secrets = modal.Secret.objects.list(max_objects=10, created_before="2025-01-01")
             ```
+
+            Added in v1.1.2.
             """
             ...
 
@@ -275,6 +287,8 @@ class SecretManager:
             ```python
             secrets = modal.Secret.objects.list(max_objects=10, created_before="2025-01-01")
             ```
+
+            Added in v1.1.2.
             """
             ...
 
@@ -305,6 +319,8 @@ class SecretManager:
             ```python notest
             await modal.Secret.objects.delete("my-secret", environment_name="dev")
             ```
+
+            Added in v1.1.2.
             """
             ...
 
@@ -332,6 +348,8 @@ class SecretManager:
             ```python notest
             await modal.Secret.objects.delete("my-secret", environment_name="dev")
             ```
+
+            Added in v1.1.2.
             """
             ...
 

{modal-1.1.2.dev44 → modal-1.1.3.dev0}/modal/volume.py

@@ -139,6 +139,7 @@ class _VolumeManager:
         modal.Volume.objects.create("my-volume", environment_name="dev")
         ```
 
+        By default, an error will be raised if the Volume already exists, but passing
         `allow_existing=True` will make the creation attempt a no-op in this case.
 
         ```python notest
@@ -148,6 +149,8 @@ class _VolumeManager:
         Note that this method does not return a local instance of the Volume. You can use
         `modal.Volume.from_name` to perform a lookup after creation.
 
+        Added in v1.1.2.
+
         """
         check_object_name(name, "Volume")
         client = await _Client.from_env() if client is None else client
@@ -204,6 +207,8 @@ class _VolumeManager:
         volumes = modal.Volume.objects.list(max_objects=10, created_before="2025-01-01")
         ```
 
+        Added in v1.1.2.
+
         """
         client = await _Client.from_env() if client is None else client
         if max_objects is not None and max_objects < 0:
@@ -264,6 +269,9 @@ class _VolumeManager:
         ```python notest
         await modal.Volume.objects.delete("my-volume", environment_name="dev")
         ```
+
+        Added in v1.1.2.
+
         """
         try:
             obj = await _Volume.from_name(name, environment_name=environment_name).hydrate(client)
@@ -685,6 +693,7 @@ class _Volume(_Object, type_prefix="vo"):
         except modal.exception.NotFoundError as exc:
             raise FileNotFoundError(exc.args[0])
 
+        @retry(n_attempts=5, base_delay=0.1, timeout=None)
         async def read_block(block_url: str) -> bytes:
             async with ClientSessionRegistry.get_session().get(block_url) as get_response:
                 return await get_response.content.read()
@@ -724,6 +733,7 @@ class _Volume(_Object, type_prefix="vo"):
         write_lock = asyncio.Lock()
         start_pos = fileobj.tell()
 
+        @retry(n_attempts=5, base_delay=0.1, timeout=None)
         async def download_block(idx, url) -> int:
             block_start_pos = start_pos + idx * BLOCK_SIZE
             num_bytes_written = 0