modal 1.4.4.dev18__tar.gz → 1.4.4.dev20__tar.gz

{modal-1.4.4.dev18 → modal-1.4.4.dev20}/PKG-INFO

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

{modal-1.4.4.dev18 → modal-1.4.4.dev20}/modal/_image.py

@@ -40,6 +40,7 @@ from ._utils.docker_utils import (
 )
 from ._utils.function_utils import FunctionInfo, parse_gpu_config
 from ._utils.mount_utils import validate_only_modal_volumes, validate_volumes_by_object_id
+from ._utils.name_utils import check_object_name
 from .client import _Client
 from .cloud_bucket_mount import _CloudBucketMount
 from .config import config, logger, user_config_path
@@ -103,6 +104,27 @@ See https://modal.com/docs/guide/modal-1-0-migration for more details.
 P = typing_extensions.ParamSpec("P")
 
 
+def _validate_image_name(name: str) -> None:
+    check_object_name(name, "Image")
+    # Reserve the "im-" prefix for image IDs so CLI args can be parsed
+    # unambiguously as either an image ID or an image name.
+    if name.startswith("im-"):
+        raise InvalidError("Image name cannot start with 'im-' (reserved for image IDs).")
+
+
+def _validate_image_tag(tag: str) -> None:
+    check_object_name(tag, "Image tag")
+
+
+def _parse_named_image_ref(name: str) -> str:
+    image_name, sep, tag = name.partition(":")
+    if not sep:
+        tag = "latest"
+    _validate_image_name(image_name)
+    _validate_image_tag(tag)
+    return f"{image_name}:{tag}"
+
+
 def _validate_python_version(
     python_version: str | None,
     builder_version: ImageBuilderVersion,
@@ -2844,6 +2866,86 @@ class _Image(_Object, type_prefix="im"):
                 if task_log.data:
                     yield task_log.data
 
+    @staticmethod
+    def from_name(
+        name: str,
+        *,
+        environment_name: str | None = None,
+        client: _Client | None = None,
+    ) -> "_Image":
+        """Reference a named Image that was previously published with `.publish()`.
+
+        Names can contain an optional `:tag` part - if no tag part is included `":latest"` is used,
+        matching Docker conventions.
+
+        ```python notest
+        image = modal.Image.from_name("my-image")     # references my-image:latest
+        image_v1 = modal.Image.from_name("my-image:v1")
+
+        @app.function(image=image)
+        def run():
+            ...
+        ```
+        """
+        tag = _parse_named_image_ref(name)
+
+        async def _load(self: _Image, resolver: Resolver, load_context: LoadContext, existing_object_id: str | None):
+            req = api_pb2.ImageGetByTagRequest(
+                tag=tag,
+                environment_name=load_context.environment_name,
+            )
+            response = await load_context.client.stub.ImageGetByTag(req)
+            self._hydrate(response.image_id, load_context.client, None)
+
+        rep = _Image._repr(tag, environment_name)
+        return _Image._from_loader(
+            _load,
+            rep,
+            hydrate_lazily=True,
+            skip_reload=True,
+            load_context_overrides=LoadContext(environment_name=environment_name, client=client),
+        )
+
+    async def publish(
+        self,
+        name: str,
+        *,
+        environment_name: str | None = None,
+        client: _Client | None = None,
+    ) -> None:
+        """Publish this image under the given name
+
+        The Image must already be created (typically by calling `image.build()` or `sandbox.snapshot_filesystem()`).
+
+        Image names can contain an explicit tag designation (using the `name:tag`). If no tag is included in the name,
+        `":latest"` is used, matching Docker conventions. To publish multiple tags, call `.publish()` once per tag.
+
+        ```python notest
+        image = modal.Image.debian_slim().pip_install("numpy")
+        image.build(app)
+        image.publish("my-image-with-numpy")     # my-image-with-numpy:latest
+        image.publish("my-image-with-numpy:v1")
+        ```
+        """
+        tag = _parse_named_image_ref(name)
+
+        if not self.is_hydrated:
+            raise InvalidError("Cannot publish an image that has not been created yet. Call `.build()` first.")
+
+        _client = client or self._client
+        assert _client is not None
+
+        resolved_env = environment_name or config.get("environment") or ""
+
+        await _client.stub.ImagePublish(
+            api_pb2.ImagePublishRequest(
+                image_id=self.object_id,
+                environment_name=resolved_env,
+                is_public=False,
+                tag=tag,
+            )
+        )
+
     async def hydrate(self, client: _Client | None = None) -> Self:
         """mdmd:hidden"""
         # Image inherits hydrate() from Object but can't be hydrated on demand

{modal-1.4.4.dev18 → modal-1.4.4.dev20}/modal/client.pyi

@@ -35,7 +35,7 @@ class _Client:
         server_url: str,
         client_type: int,
         credentials: typing.Optional[tuple[str, str]],
-        version: str = "1.4.4.dev18",
+        version: str = "1.4.4.dev20",
     ):
         """mdmd:hidden
         The Modal client object is not intended to be instantiated directly by users.
@@ -205,7 +205,7 @@ class Client:
         server_url: str,
         client_type: int,
         credentials: typing.Optional[tuple[str, str]],
-        version: str = "1.4.4.dev18",
+        version: str = "1.4.4.dev20",
     ):
         """mdmd:hidden
         The Modal client object is not intended to be instantiated directly by users.

{modal-1.4.4.dev18 → modal-1.4.4.dev20}/modal/functions.pyi

@@ -465,7 +465,7 @@ class Function(
 
     _call_generator: ___call_generator_spec
 
-    class __remote_spec(typing_extensions.Protocol[ReturnType_INNER, P_INNER]):
+    class __remote_spec(typing_extensions.Protocol[P_INNER, ReturnType_INNER]):
         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.
 
@@ -490,7 +490,7 @@ class Function(
             """
             ...
 
-    remote: __remote_spec[modal._functions.ReturnType, modal._functions.P]
+    remote: __remote_spec[modal._functions.P, modal._functions.ReturnType]
 
     class __remote_gen_spec(typing_extensions.Protocol):
         def __call__(self, /, *args, **kwargs) -> typing.Generator[typing.Any, None, None]:
@@ -540,7 +540,7 @@ class Function(
         """
         ...
 
-    class ___experimental_spawn_spec(typing_extensions.Protocol[ReturnType_INNER, P_INNER]):
+    class ___experimental_spawn_spec(typing_extensions.Protocol[P_INNER, ReturnType_INNER]):
         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.
 
@@ -573,7 +573,7 @@ class Function(
             """
             ...
 
-    _experimental_spawn: ___experimental_spawn_spec[modal._functions.ReturnType, modal._functions.P]
+    _experimental_spawn: ___experimental_spawn_spec[modal._functions.P, modal._functions.ReturnType]
 
     class ___spawn_map_inner_spec(typing_extensions.Protocol[P_INNER]):
         def __call__(self, /, *args: P_INNER.args, **kwargs: P_INNER.kwargs) -> None: ...
@@ -581,7 +581,7 @@ class Function(
 
     _spawn_map_inner: ___spawn_map_inner_spec[modal._functions.P]
 
-    class __spawn_spec(typing_extensions.Protocol[ReturnType_INNER, P_INNER]):
+    class __spawn_spec(typing_extensions.Protocol[P_INNER, ReturnType_INNER]):
         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.
 
@@ -614,7 +614,7 @@ class Function(
             """
             ...
 
-    spawn: __spawn_spec[modal._functions.ReturnType, modal._functions.P]
+    spawn: __spawn_spec[modal._functions.P, modal._functions.ReturnType]
 
     def get_raw_f(self) -> collections.abc.Callable[..., typing.Any]:
         """Return the inner Python object wrapped by this Modal Function.

{modal-1.4.4.dev18 → modal-1.4.4.dev20}/modal/image.pyi

@@ -1356,6 +1356,77 @@ class Image(modal.object.Object):
 
     _logs: ___logs_spec
 
+    @staticmethod
+    def from_name(
+        name: str, *, environment_name: typing.Optional[str] = None, client: typing.Optional[modal.client.Client] = None
+    ) -> Image:
+        """Reference a named Image that was previously published with `.publish()`.
+
+        Names can contain an optional `:tag` part - if no tag part is included `":latest"` is used,
+        matching Docker conventions.
+
+        ```python notest
+        image = modal.Image.from_name("my-image")     # references my-image:latest
+        image_v1 = modal.Image.from_name("my-image:v1")
+
+        @app.function(image=image)
+        def run():
+            ...
+        ```
+        """
+        ...
+
+    class __publish_spec(typing_extensions.Protocol):
+        def __call__(
+            self,
+            /,
+            name: str,
+            *,
+            environment_name: typing.Optional[str] = None,
+            client: typing.Optional[modal.client.Client] = None,
+        ) -> None:
+            """Publish this image under the given name
+
+            The Image must already be created (typically by calling `image.build()` or `sandbox.snapshot_filesystem()`).
+
+            Image names can contain an explicit tag designation (using the `name:tag`). If no tag is included in the name,
+            `":latest"` is used, matching Docker conventions. To publish multiple tags, call `.publish()` once per tag.
+
+            ```python notest
+            image = modal.Image.debian_slim().pip_install("numpy")
+            image.build(app)
+            image.publish("my-image-with-numpy")     # my-image-with-numpy:latest
+            image.publish("my-image-with-numpy:v1")
+            ```
+            """
+            ...
+
+        async def aio(
+            self,
+            /,
+            name: str,
+            *,
+            environment_name: typing.Optional[str] = None,
+            client: typing.Optional[modal.client.Client] = None,
+        ) -> None:
+            """Publish this image under the given name
+
+            The Image must already be created (typically by calling `image.build()` or `sandbox.snapshot_filesystem()`).
+
+            Image names can contain an explicit tag designation (using the `name:tag`). If no tag is included in the name,
+            `":latest"` is used, matching Docker conventions. To publish multiple tags, call `.publish()` once per tag.
+
+            ```python notest
+            image = modal.Image.debian_slim().pip_install("numpy")
+            image.build(app)
+            image.publish("my-image-with-numpy")     # my-image-with-numpy:latest
+            image.publish("my-image-with-numpy:v1")
+            ```
+            """
+            ...
+
+    publish: __publish_spec
+
     class __hydrate_spec(typing_extensions.Protocol[SUPERSELF]):
         def __call__(self, /, client: typing.Optional[modal.client.Client] = None) -> SUPERSELF:
             """mdmd:hidden"""

{modal-1.4.4.dev18 → modal-1.4.4.dev20}/modal.egg-info/PKG-INFO

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