modal 1.1.5.dev25__tar.gz → 1.1.5.dev27__tar.gz

{modal-1.1.5.dev25 → modal-1.1.5.dev27}/PKG-INFO

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

{modal-1.1.5.dev25 → modal-1.1.5.dev27}/modal/_functions.py

@@ -831,17 +831,23 @@ class _Function(typing.Generic[P, ReturnType, OriginalReturnType], _Object, type
             for method_name, partial_function in interface_methods.items():
                 function_type = get_function_type(partial_function.params.is_generator)
                 function_name = f"{info.user_cls.__name__}.{method_name}"
+                is_web_endpoint = partial_function._is_web_endpoint()
                 method_schema = get_callable_schema(
                     partial_function._get_raw_f(),
-                    is_web_endpoint=partial_function._is_web_endpoint(),
+                    is_web_endpoint=is_web_endpoint,
                     ignore_first_argument=True,
                 )
-
                 method_definition = api_pb2.MethodDefinition(
                     webhook_config=partial_function.params.webhook_config,
                     function_type=function_type,
                     function_name=function_name,
                     function_schema=method_schema,
+                    supported_input_formats=[api_pb2.DATA_FORMAT_ASGI]
+                    if is_web_endpoint
+                    else [api_pb2.DATA_FORMAT_PICKLE],
+                    supported_output_formats=[api_pb2.DATA_FORMAT_ASGI]
+                    if is_web_endpoint
+                    else [api_pb2.DATA_FORMAT_PICKLE],
                 )
                 method_definitions[method_name] = method_definition
 
@@ -865,6 +871,18 @@ class _Function(typing.Generic[P, ReturnType, OriginalReturnType], _Object, type
 
             return deps
 
+        if info.is_service_class():
+            # classes don't have data formats themselves - methods do
+            supported_input_formats = []
+            supported_output_formats = []
+        elif webhook_config is not None:
+            supported_input_formats = [api_pb2.DATA_FORMAT_ASGI]
+            supported_output_formats = [api_pb2.DATA_FORMAT_ASGI]
+        else:
+            # TODO: add CBOR support
+            supported_input_formats = [api_pb2.DATA_FORMAT_PICKLE]
+            supported_output_formats = [api_pb2.DATA_FORMAT_PICKLE]
+
         async def _preload(self: _Function, resolver: Resolver, existing_object_id: Optional[str]):
             assert resolver.client and resolver.client.stub
 
@@ -877,6 +895,8 @@ class _Function(typing.Generic[P, ReturnType, OriginalReturnType], _Object, type
                 function_schema=get_callable_schema(info.raw_f, is_web_endpoint=bool(webhook_config))
                 if info.raw_f
                 else None,
+                supported_input_formats=supported_input_formats,
+                supported_output_formats=supported_output_formats,
             )
             if method_definitions:
                 for method_name, method_definition in method_definitions.items():
@@ -955,6 +975,7 @@ class _Function(typing.Generic[P, ReturnType, OriginalReturnType], _Object, type
                 function_schema = (
                     get_callable_schema(info.raw_f, is_web_endpoint=bool(webhook_config)) if info.raw_f else None
                 )
+
                 # Create function remotely
                 function_definition = api_pb2.Function(
                     module_name=info.module_name or "",
@@ -1016,6 +1037,8 @@ class _Function(typing.Generic[P, ReturnType, OriginalReturnType], _Object, type
                     task_idle_timeout_secs=scaledown_window or 0,
                     # ---
                     function_schema=function_schema,
+                    supported_input_formats=supported_input_formats,
+                    supported_output_formats=supported_output_formats,
                 )
 
                 if isinstance(gpu, list):
@@ -1051,6 +1074,8 @@ class _Function(typing.Generic[P, ReturnType, OriginalReturnType], _Object, type
                         runtime_perf_record=function_definition.runtime_perf_record,
                         function_schema=function_schema,
                         untrusted=function_definition.untrusted,
+                        supported_input_formats=supported_input_formats,
+                        supported_output_formats=supported_output_formats,
                     )
 
                     ranked_functions = []
@@ -1529,6 +1554,8 @@ class _Function(typing.Generic[P, ReturnType, OriginalReturnType], _Object, type
             input_plane_region=self._input_plane_region,
             max_object_size_bytes=self._max_object_size_bytes,
             _experimental_flash_urls=self._experimental_flash_urls,
+            supported_input_formats=self._metadata.supported_input_formats if self._metadata else [],
+            supported_output_formats=self._metadata.supported_output_formats if self._metadata else [],
         )
 
     def _check_no_web_url(self, fn_name: str):

{modal-1.1.5.dev25 → modal-1.1.5.dev27}/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.5.dev25",
+        version: str = "1.1.5.dev27",
     ):
         """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.5.dev25",
+        version: str = "1.1.5.dev27",
     ):
         """mdmd:hidden
         The Modal client object is not intended to be instantiated directly by users.

{modal-1.1.5.dev25 → modal-1.1.5.dev27}/modal/image.py

@@ -868,6 +868,68 @@ class _Image(_Object, type_prefix="im"):
 
         return obj
 
+    async def build(self, app: "modal.app._App") -> "_Image":
+        """Eagerly build an image.
+
+        If your image was previously built, then this method will not rebuild your image
+        and your cached image is returned.
+
+        **Examples**
+
+        ```python
+        image = modal.Image.debian_slim().uv_pip_install("scipy", "numpy")
+
+        app = modal.App("build-image")
+        with modal.enable_output(), app.run():
+            image.build(app)
+
+        # Save the image id
+        my_image_id = image.object_id
+
+        # Reference the image with the id or uses it another context.
+        built_image = modal.Image.from_id(my_image_id)
+        ```
+
+        Alternatively, you can pre-build a image and use it in a sandbox.
+
+        ```python notest
+        app = modal.App.lookup("sandbox-example")
+
+        with modal.enable_output():
+            image = modal.Image.debian_slim().uv_pip_install("scipy")
+            image.build(app)
+
+        sb = modal.Sandbox.create("python", "-c", "import scipy; print(scipy)", app=app, image=image)
+        print(sb.stdout.read())
+        sb.terminate()
+        ```
+
+        **Note**
+
+        For defining Modal functions, images are built automatically when deploying or running an App.
+        You do not need to built the image explicitly:
+
+        ```python notest
+        app = modal.App()
+        image = modal.Image.debian_slim()
+
+        # No need to explicitly build the image for defining a function.
+        @app.function(image=image)
+        def f():
+            ...
+        ```
+
+        """
+        if app.app_id is None:
+            raise InvalidError("App has not been initialized yet. Use the content manager `app.run()` or `App.lookup`")
+
+        app_id = app.app_id
+        app_client = app._client or await _Client.from_env()
+
+        resolver = Resolver(app_client, app_id=app_id)
+        await resolver.load(self)
+        return self
+
     def pip_install(
         self,
         *packages: Union[str, list[str]],  # A list of Python packages, eg. ["numpy", "matplotlib>=3.5.0"]

{modal-1.1.5.dev25 → modal-1.1.5.dev27}/modal/image.pyi

@@ -2,6 +2,7 @@ import collections.abc
 import google.protobuf.message
 import modal._functions
 import modal._object
+import modal.app
 import modal.client
 import modal.cloud_bucket_mount
 import modal.functions
@@ -318,6 +319,59 @@ class _Image(modal._object._Object):
         """
         ...
 
+    async def build(self, app: modal.app._App) -> _Image:
+        """Eagerly build an image.
+
+        If your image was previously built, then this method will not rebuild your image
+        and your cached image is returned.
+
+        **Examples**
+
+        ```python
+        image = modal.Image.debian_slim().uv_pip_install("scipy", "numpy")
+
+        app = modal.App("build-image")
+        with modal.enable_output(), app.run():
+            image.build(app)
+
+        # Save the image id
+        my_image_id = image.object_id
+
+        # Reference the image with the id or uses it another context.
+        built_image = modal.Image.from_id(my_image_id)
+        ```
+
+        Alternatively, you can pre-build a image and use it in a sandbox.
+
+        ```python notest
+        app = modal.App.lookup("sandbox-example")
+
+        with modal.enable_output():
+            image = modal.Image.debian_slim().uv_pip_install("scipy")
+            image.build(app)
+
+        sb = modal.Sandbox.create("python", "-c", "import scipy; print(scipy)", app=app, image=image)
+        print(sb.stdout.read())
+        sb.terminate()
+        ```
+
+        **Note**
+
+        For defining Modal functions, images are built automatically when deploying or running an App.
+        You do not need to built the image explicitly:
+
+        ```python notest
+        app = modal.App()
+        image = modal.Image.debian_slim()
+
+        # No need to explicitly build the image for defining a function.
+        @app.function(image=image)
+        def f():
+            ...
+        ```
+        """
+        ...
+
     def pip_install(
         self,
         *packages: typing.Union[str, list[str]],
@@ -1182,6 +1236,115 @@ class Image(modal.object.Object):
 
     from_id: __from_id_spec
 
+    class __build_spec(typing_extensions.Protocol[SUPERSELF]):
+        def __call__(self, /, app: modal.app.App) -> Image:
+            """Eagerly build an image.
+
+            If your image was previously built, then this method will not rebuild your image
+            and your cached image is returned.
+
+            **Examples**
+
+            ```python
+            image = modal.Image.debian_slim().uv_pip_install("scipy", "numpy")
+
+            app = modal.App("build-image")
+            with modal.enable_output(), app.run():
+                image.build(app)
+
+            # Save the image id
+            my_image_id = image.object_id
+
+            # Reference the image with the id or uses it another context.
+            built_image = modal.Image.from_id(my_image_id)
+            ```
+
+            Alternatively, you can pre-build a image and use it in a sandbox.
+
+            ```python notest
+            app = modal.App.lookup("sandbox-example")
+
+            with modal.enable_output():
+                image = modal.Image.debian_slim().uv_pip_install("scipy")
+                image.build(app)
+
+            sb = modal.Sandbox.create("python", "-c", "import scipy; print(scipy)", app=app, image=image)
+            print(sb.stdout.read())
+            sb.terminate()
+            ```
+
+            **Note**
+
+            For defining Modal functions, images are built automatically when deploying or running an App.
+            You do not need to built the image explicitly:
+
+            ```python notest
+            app = modal.App()
+            image = modal.Image.debian_slim()
+
+            # No need to explicitly build the image for defining a function.
+            @app.function(image=image)
+            def f():
+                ...
+            ```
+            """
+            ...
+
+        async def aio(self, /, app: modal.app.App) -> Image:
+            """Eagerly build an image.
+
+            If your image was previously built, then this method will not rebuild your image
+            and your cached image is returned.
+
+            **Examples**
+
+            ```python
+            image = modal.Image.debian_slim().uv_pip_install("scipy", "numpy")
+
+            app = modal.App("build-image")
+            with modal.enable_output(), app.run():
+                image.build(app)
+
+            # Save the image id
+            my_image_id = image.object_id
+
+            # Reference the image with the id or uses it another context.
+            built_image = modal.Image.from_id(my_image_id)
+            ```
+
+            Alternatively, you can pre-build a image and use it in a sandbox.
+
+            ```python notest
+            app = modal.App.lookup("sandbox-example")
+
+            with modal.enable_output():
+                image = modal.Image.debian_slim().uv_pip_install("scipy")
+                image.build(app)
+
+            sb = modal.Sandbox.create("python", "-c", "import scipy; print(scipy)", app=app, image=image)
+            print(sb.stdout.read())
+            sb.terminate()
+            ```
+
+            **Note**
+
+            For defining Modal functions, images are built automatically when deploying or running an App.
+            You do not need to built the image explicitly:
+
+            ```python notest
+            app = modal.App()
+            image = modal.Image.debian_slim()
+
+            # No need to explicitly build the image for defining a function.
+            @app.function(image=image)
+            def f():
+                ...
+            ```
+            """
+            ...
+
+    build: __build_spec[typing_extensions.Self]
+
     def pip_install(
         self,
         *packages: typing.Union[str, list[str]],

{modal-1.1.5.dev25 → modal-1.1.5.dev27}/modal.egg-info/PKG-INFO

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

{modal-1.1.5.dev25 → modal-1.1.5.dev27}/modal_proto/api.proto

@@ -111,6 +111,7 @@ enum DataFormat {
   DATA_FORMAT_PICKLE = 1; // Cloudpickle
   DATA_FORMAT_ASGI = 2; // "Asgi" protobuf message
   DATA_FORMAT_GENERATOR_DONE = 3; // "GeneratorDone" protobuf message
+  DATA_FORMAT_CBOR = 4;
 }
 
 enum DeploymentNamespace {
@@ -1504,6 +1505,8 @@ message Function {
   bool enable_gpu_snapshot = 85; // GPU memory snapshotting (alpha)
 
   uint32 startup_timeout_secs = 86;
+  repeated DataFormat supported_input_formats = 87; // can be used as inputs
+  repeated DataFormat supported_output_formats = 88;
 }
 
 message FunctionAsyncInvokeRequest {
@@ -1679,6 +1682,8 @@ message FunctionData {
   string flash_service_label = 35;
 
   uint32 startup_timeout_secs = 36;
+  repeated DataFormat supported_input_formats = 37;
+  repeated DataFormat supported_output_formats = 38;
 }
 
 message FunctionExtended {
@@ -1828,6 +1833,8 @@ message FunctionHandleMetadata {
   // Use optional to ensure unset values default to None instead of 0
   optional uint64 max_object_size_bytes = 48;
   repeated string _experimental_flash_urls = 49; // (Optional) urls for flash services
+  repeated DataFormat supported_input_formats = 50;
+  repeated DataFormat supported_output_formats = 51;
 }
 
 message FunctionInput {
@@ -1892,6 +1899,8 @@ message FunctionPrecreateRequest {
   // Mapping of method names to method definitions, only non-empty for class service functions
   map<string, MethodDefinition> method_definitions = 8;
   FunctionSchema function_schema = 9;
+  repeated DataFormat supported_input_formats = 10;
+  repeated DataFormat supported_output_formats = 11;
 }
 
 message FunctionPrecreateResponse {
@@ -2230,6 +2239,8 @@ message MethodDefinition {
   WebUrlInfo web_url_info = 5;
   repeated CustomDomainInfo custom_domain_info = 6;
   FunctionSchema function_schema = 7;
+  repeated DataFormat supported_input_formats = 8;
+  repeated DataFormat supported_output_formats = 9;
 }
 
 message MountFile {