modal 1.1.5.dev25__tar.gz → 1.1.5.dev26__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: modal
-Version: 1.1.5.dev25
+Version: 1.1.5.dev26
 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.dev26}/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.dev26",
     ):
         """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.dev26",
     ):
         """mdmd:hidden
         The Modal client object is not intended to be instantiated directly by users.

{modal-1.1.5.dev25 → modal-1.1.5.dev26}/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.dev26}/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.dev26}/modal.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: modal
-Version: 1.1.5.dev25
+Version: 1.1.5.dev26
 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.dev26}/modal_version/__init__.py

@@ -1,4 +1,4 @@
 # Copyright Modal Labs 2025
 """Supplies the current version of the modal client library."""
 
-__version__ = "1.1.5.dev25"
+__version__ = "1.1.5.dev26"