modAL 1.4.4.dev18__py3-none-any.whl → 1.4.4.dev20__py3-none-any.whl

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/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/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/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.dist-info → modal-1.4.4.dev20.dist-info}/METADATA

@@ -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.dist-info → modal-1.4.4.dev20.dist-info}/RECORD

@@ -8,7 +8,7 @@ modal/_environments.py,sha256=mVDsN-hYyqjaz1-7JTD0X7D7HlQ-QUETssfEq7yHQ5g,17525
 modal/_function_variants.py,sha256=Oa1hwNGLmZrnKlp5u9jTbouOm9zlVaz5OmwxVe18d0o,12377
 modal/_functions.py,sha256=so9wDRbP0cBDq0IoNxxcaOVt8L2b0EpRo1kFnFtROro,93181
 modal/_grpc_client.py,sha256=7PPZIF68MaIKxOTqjCysSpPmjIGCJl5kzudrMK-Eqpg,6895
-modal/_image.py,sha256=ECtnm5enBzLwbzPEDHovAbXxTJHdLAB7ft5X_-cc1tg,122765
+modal/_image.py,sha256=LeE8d9KT2mSMafsASNgwFMxzRWMj15T5hpGKtfkqH3Q,126305
 modal/_ipython.py,sha256=Bu9fc3hm3xt2O47qLe_d-Mu2jS81LwMsmXNJ1sawBA0,575
 modal/_load_context.py,sha256=wrDqD3KehhFepp0vBhyz_PoLWoRVD0gZHP8dlLHCTiw,4818
 modal/_location.py,sha256=joiX-0ZeutEUDTrrqLF1GHXCdVLF-rHzstocbMcd_-k,366
@@ -30,7 +30,7 @@ modal/app.pyi,sha256=rjmh5TLrvgQ26hnNm0NqLgmMKoA8pzWIPJ1G1D1_AGg,84061
 modal/billing.py,sha256=V2WA_TAp8T3eEe5nE1nqXs9PL-CG-HhNpdr18IzsSMk,304
 modal/call_graph.py,sha256=k_wH3DuuUHCeuycHsOqlcOpIlIVbCYi9RPobg21hJdI,2550
 modal/client.py,sha256=KaAbJuglWWm_xR-WMGCPVTXDR56xdzenP9Q1b8Ynry0,16132
-modal/client.pyi,sha256=BsG4QvAbCYRkWhwB9VK6A3i7STqIlp8KAkXrj1sYvAg,17854
+modal/client.pyi,sha256=NsVL_-_zt6lSz4C9dCMgrhAXXzcBbe9XNwXJ1RyXGWg,17854
 modal/cloud_bucket_mount.py,sha256=03gECcV9l2Lnt9k23YrDOTGFW7ajfXMW5O8b1prhtwQ,6254
 modal/cloud_bucket_mount.pyi,sha256=lMOb44pbNE9kDVEqWfcmvpsnh1sdNNFzuKoVyZZ3d5M,8058
 modal/cls.py,sha256=wmtUfe0ewkIGK1AhyAnQ9IHTe6XJqcFvL8tCnfIjzZs,40928
@@ -47,9 +47,9 @@ modal/file_io.py,sha256=kfojtm0euzOMhfkVTAGyfuygDJ1XPPHQa5uUhkCsThg,21800
 modal/file_io.pyi,sha256=Tr0OtfbkTNa8v1dkGtl8l3RH58pMc9uGTYKxL1jNwho,15422
 modal/file_pattern_matcher.py,sha256=6g_awxudMy_ontBvkznybyeNnwGMj297YrmIHCbREI0,8132
 modal/functions.py,sha256=EZRcHFfnoYbvawUJnAHF5nIvoo9GX2Djy7mUmOCXmXc,258
-modal/functions.pyi,sha256=XgHw-z8RO-5RERK-ZR_DL22BA_qv6_lzpsFgdyoYG9E,46656
+modal/functions.pyi,sha256=SW12AMmvyolwO80aO57RM9YHlZwoqTSWGvEdlW9Kflg,46656
 modal/image.py,sha256=c0lUSAoU-Ip3g5DGZ0uhdCzoWSQWh1g0i-7Rxo-Sz-I,160
-modal/image.pyi,sha256=KEKOS1e79Yq98-3LBFkloRzhEA1q6qqpNbdzRzxPjLo,57031
+modal/image.pyi,sha256=Whbfmda2YLAyzctLEF9uF4FQ5b1canwLojSksRJ4gx8,59716
 modal/io_streams.py,sha256=3fhhb7SDJ69pVUu9J3PiMLBePD9bpiIxPN05SCzf8FE,29118
 modal/io_streams.pyi,sha256=5uQAgwxN3aouY8UJbRmDnRj9vOId5psRaMrU4IpyQgw,24471
 modal/mount.py,sha256=n1jfXvZVG1zKcVHDG8_0ECnzS7eaZCCRsk0XCx-GESo,34632
@@ -186,7 +186,7 @@ modal/experimental/flash.py,sha256=GAJ1c-EGL8M3_loAkqr5gdUfySMHY3U_oc6RywfZ8-0,3
 modal/experimental/flash.pyi,sha256=lpTqJFZRMGWscw0xpYZVdBMnAYjj16asXE4_64A6itQ,17774
 modal/experimental/ipython.py,sha256=kJ6o9wkAY_MiSb7paewI7f1MJAeqdi8TX5pBdhr_mUI,2925
 modal/skills/modal/SKILL.md,sha256=WzLjYJ1utjc_ZOf6qZTPwB6wxxwRYB5PibdvIf_FLy0,5316
-modal-1.4.4.dev18.dist-info/licenses/LICENSE,sha256=psuoW8kuDP96RQsdhzwOqi6fyWv0ct8CR6Jr7He_P_k,10173
+modal-1.4.4.dev20.dist-info/licenses/LICENSE,sha256=psuoW8kuDP96RQsdhzwOqi6fyWv0ct8CR6Jr7He_P_k,10173
 modal_docs/__init__.py,sha256=svYKtV8HDwDCN86zbdWqyq5T8sMdGDj0PVlzc2tIxDM,28
 modal_docs/gen_cli_docs.py,sha256=R--gpKWbXopgLw7A1QcuLgvam9R8DtSR6Q_Oe1pLgkY,3729
 modal_docs/gen_cli_docs_main.py,sha256=UPGr7O1DYTIRLwfINe2rbdh89J3cPVTU1OWL-SjxnOQ,198
@@ -198,8 +198,8 @@ modal_docs/mdmd/signatures.py,sha256=Xx1FF6oND90MfbHJ24E9rej_GjmEGOAaOp6oJpkv1Os
 modal_docs/mdmd/types.py,sha256=UjPSjVmdiys9244vJ0DMDJcM9LrWWmI3alW98Ugy8tU,682
 modal_proto/__init__.py,sha256=tFdSv9eaHBvYcwhgq-XqIlYDNDw57clrvO91Fb-oUV4,130
 modal_proto/api_grpc.py,sha256=QPj19d4rnASiqYWzt4sJ-7pjGRdQhZHPGVWcX3m53E0,157648
-modal_proto/api_pb2.py,sha256=Mmn674jYYxyy9VcP_OqzSfrk1o-rLLVkkZOxMW9-9e4,441601
-modal_proto/api_pb2.pyi,sha256=cZ7qEl1OkceZo8IVKKhrh2i9NNtBs5ONL3-NZ19hvzk,620524
+modal_proto/api_pb2.py,sha256=6KiGxJGZIjq8_V_t8VbBGXjky9T6_-LayVMn3K93pTc,441645
+modal_proto/api_pb2.pyi,sha256=MbV4GAaNLNAo_h3jksY1zOY4chDV8lnDGPE50BpnWx4,620669
 modal_proto/api_pb2_grpc.py,sha256=T-aJ0Yet8uEHi-olGKmnLlaWY7KYDdzBcfBrUGxOI_s,339667
 modal_proto/api_pb2_grpc.pyi,sha256=0ExAtHDvSQ5ysWo-eB3Xlfrfr0XTkAYwZzI-W2uY3Gc,79270
 modal_proto/modal_api_grpc.py,sha256=-O55R7LC7XjC2sdfBydQN7uQpCzSYwSGag_G5aWTnZo,24857
@@ -209,10 +209,10 @@ modal_proto/task_command_router_pb2.py,sha256=5KEqPiP-8wfByo0YmwvHTYg1Zmd9d3kToj
 modal_proto/task_command_router_pb2.pyi,sha256=RwwMMv90wA1AT-_P0HDxfTaBa7bh-OSaXk9A71b-PzM,40167
 modal_proto/task_command_router_pb2_grpc.py,sha256=368j8b_h19L7bidFTRGSdSG4bK0zU9Y_Oq46_B2ACDg,34666
 modal_proto/task_command_router_pb2_grpc.pyi,sha256=PbzkCj-uSlN1inYSdhncPQ1-04vhBnj3Wzvb-D2pLHY,11226
-modal_version/__init__.py,sha256=Jo_Cl3179-gnOLvWbjXjrdK9cb00i2KmiX12P8oSmPo,121
+modal_version/__init__.py,sha256=rkRFGGh_bDjqt_D_DuEmQbj_z01w8nLNoyzJUpsTSPk,121
 modal_version/__main__.py,sha256=nLUbubxKx7GXNzJIkTB7M7_u8080LyLM0IS0rzFkC_c,119
-modal-1.4.4.dev18.dist-info/METADATA,sha256=tlso2-tDr6eo7KNWJQIZaTnQvai_84FkWQTG5b9nIKc,2339
-modal-1.4.4.dev18.dist-info/WHEEL,sha256=1tXe9gY0PYatrMPMDd6jXqjfpz_B-Wqm32CPfRC58XU,91
-modal-1.4.4.dev18.dist-info/entry_points.txt,sha256=An-wYgeEUnm6xzrAP9_NTSTSciYvvEWsMZILtYrvpAI,46
-modal-1.4.4.dev18.dist-info/top_level.txt,sha256=4BWzoKYREKUZ5iyPzZpjqx4G8uB5TWxXPDwibLcVa7k,43
-modal-1.4.4.dev18.dist-info/RECORD,,
+modal-1.4.4.dev20.dist-info/METADATA,sha256=3pZC-cokMWl1gR6cUbbBKPI4hsPZb-wspZydikN9Gdk,2339
+modal-1.4.4.dev20.dist-info/WHEEL,sha256=1tXe9gY0PYatrMPMDd6jXqjfpz_B-Wqm32CPfRC58XU,91
+modal-1.4.4.dev20.dist-info/entry_points.txt,sha256=An-wYgeEUnm6xzrAP9_NTSTSciYvvEWsMZILtYrvpAI,46
+modal-1.4.4.dev20.dist-info/top_level.txt,sha256=4BWzoKYREKUZ5iyPzZpjqx4G8uB5TWxXPDwibLcVa7k,43
+modal-1.4.4.dev20.dist-info/RECORD,,