modal 1.5.4.dev0__tar.gz → 1.5.4.dev2__tar.gz

{modal-1.5.4.dev0 → modal-1.5.4.dev2}/PKG-INFO

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

{modal-1.5.4.dev0 → modal-1.5.4.dev2}/modal/_environments.py

@@ -4,7 +4,7 @@ import builtins
 from collections.abc import Iterable, Mapping
 from dataclasses import dataclass
 from datetime import datetime, timezone
-from typing import Literal
+from typing import Any, Literal
 
 from google.protobuf.empty_pb2 import Empty
 from google.protobuf.message import Message
@@ -39,6 +39,7 @@ class _EnvironmentManager:
         name: str,  # Name to use for the new Environment
         *,
         restricted: bool = False,  # If True, enable RBAC restrictions on the Environment
+        experimental_options: dict[str, Any] | None = None,  # Experimental options for Environment creation
         client: _Client | None = None,  # Optional client with Modal credentials
     ) -> None:
         """Create a new Environment.
@@ -51,7 +52,10 @@ class _EnvironmentManager:
         """
         check_environment_name(name)
         client = await _Client.from_env() if client is None else client
-        await client.stub.EnvironmentCreate(api_pb2.EnvironmentCreateRequest(name=name, is_managed=restricted))
+        request = api_pb2.EnvironmentCreateRequest(name=name, is_managed=restricted)
+        if (experimental_options or {}).get("is_public", False):
+            request.environment_type = api_pb2.ENVIRONMENT_TYPE_PUBLIC
+        await client.stub.EnvironmentCreate(request)
 
     async def list(
         self,

{modal-1.5.4.dev0 → modal-1.5.4.dev2}/modal/_functions.py

@@ -93,7 +93,7 @@ from .proxy import _Proxy
 from .retries import Retries, RetryManager
 from .schedule import Schedule
 from .secret import _Secret
-from .types import FunctionStats
+from .types import FunctionAutoscalerSettings, FunctionStats, ServerAutoscalerSettings
 from .volume import _Volume, _volume_to_mount_proto
 
 if TYPE_CHECKING:
@@ -1172,6 +1172,25 @@ class _Function(typing.Generic[P, ReturnType, OriginalReturnType], _Object, type
         return obj
 
     async def _update_autoscaler(
+        self,
+        *,
+        min_containers: int | None = None,
+        max_containers: int | None = None,
+        buffer_containers: int | None = None,
+        scaledown_window: int | None = None,
+    ) -> FunctionAutoscalerSettings:
+        settings = api_pb2.AutoscalerSettings(
+            min_containers=min_containers,
+            max_containers=max_containers,
+            buffer_containers=buffer_containers,
+            scaledown_window=scaledown_window,
+        )
+        request = api_pb2.FunctionUpdateSchedulingParamsRequest(function_id=self.object_id, settings=settings)
+        response = await self.client.stub.FunctionUpdateSchedulingParams(request)
+
+        return FunctionAutoscalerSettings._from_proto(response.current_settings)
+
+    async def _update_autoscaler_server(
         self,
         *,
         min_containers: int | None = None,
@@ -1180,7 +1199,7 @@ class _Function(typing.Generic[P, ReturnType, OriginalReturnType], _Object, type
         scaleup_window: int | None = None,
         scaledown_window: int | None = None,
         target_concurrency: int | None = None,
-    ) -> None:
+    ) -> ServerAutoscalerSettings:
         settings = api_pb2.AutoscalerSettings(
             min_containers=min_containers,
             max_containers=max_containers,
@@ -1190,10 +1209,9 @@ class _Function(typing.Generic[P, ReturnType, OriginalReturnType], _Object, type
             target_concurrency=target_concurrency,
         )
         request = api_pb2.FunctionUpdateSchedulingParamsRequest(function_id=self.object_id, settings=settings)
-        await self.client.stub.FunctionUpdateSchedulingParams(request)
+        response = await self.client.stub.FunctionUpdateSchedulingParams(request)
 
-        # One idea would be for FunctionUpdateScheduleParams to return the current (coalesced) settings
-        # and then we could return them here (would need some ad hoc dataclass, which I don't love)
+        return ServerAutoscalerSettings._from_proto(response.current_settings)
 
     @live_method
     async def update_autoscaler(
@@ -1203,7 +1221,7 @@ class _Function(typing.Generic[P, ReturnType, OriginalReturnType], _Object, type
         max_containers: int | None = None,
         buffer_containers: int | None = None,
         scaledown_window: int | None = None,
-    ) -> None:
+    ) -> FunctionAutoscalerSettings:
         """Override the current autoscaler behavior for this Function.
 
         Unspecified parameters will retain their current value, i.e. either the static value
@@ -1218,6 +1236,10 @@ class _Function(typing.Generic[P, ReturnType, OriginalReturnType], _Object, type
             buffer_containers: Extra containers to keep warm beyond current demand.
             scaledown_window: Maximum duration (in seconds) idle containers wait before scaling down.
 
+        Returns:
+            A `FunctionAutoscalerSettings` dataclass which contains the current autoscaler settings
+            of this Function after the call.
+
         Examples:
             ```python notest
             f = modal.Function.from_name("my-app", "function")
@@ -1237,7 +1259,7 @@ class _Function(typing.Generic[P, ReturnType, OriginalReturnType], _Object, type
         if self._is_method:
             raise InvalidError("Cannot call .update_autoscaler() on a method. Call it on the class instance instead.")
 
-        await self._update_autoscaler(
+        return await self._update_autoscaler(
             min_containers=min_containers,
             max_containers=max_containers,
             buffer_containers=buffer_containers,

{modal-1.5.4.dev0 → modal-1.5.4.dev2}/modal/_image.py

@@ -117,34 +117,51 @@ def _validate_image_tag(tag: str) -> None:
     check_object_name(tag, "Image tag")
 
 
-def _parse_named_image_ref(name: str) -> tuple[str, str]:
-    """Parse an image reference, returning (namespace_prefix, name_tag).
-
-    If the name contains a '/', the part before the last '/' is extracted as
-    a namespace prefix (intended for environment/name or workspace/env/name
-    syntax). The actual image name (after the last '/') is validated as a
-    standard object name.
-
-    Returns a tuple of (prefix, "full_name:tag") where prefix is empty string
-    if no '/' is present.
-    """
-    image_name, sep, tag = name.partition(":")
+def _parse_image_name(partial_name: str) -> tuple[str | None, str]:
+    partial_name_no_env, sep, tag = partial_name.partition(":")
     if not sep:
         tag = "latest"
 
-    prefix = ""
-    if "/" in image_name:
-        prefix, image_name = image_name.rsplit("/", 1)
-        if not prefix:
-            raise InvalidError("Invalid Image name: '/' prefix must be non-empty.")
+    if "/" in partial_name_no_env:
+        environment, image_name = partial_name_no_env.rsplit("/", 1)
+        if not environment:
+            raise InvalidError("Invalid Image name: environment prefix before '/' must be non-empty.")
         if not image_name:
-            raise InvalidError("Invalid Image name: name after '/' must be non-empty.")
+            raise InvalidError("Invalid Image name: name after last '/' must be non-empty.")
+    else:
+        environment = None
+        image_name = partial_name_no_env
 
     _validate_image_name(image_name)
     _validate_image_tag(tag)
 
-    full_name = f"{prefix}/{image_name}" if prefix else image_name
-    return prefix, f"{full_name}:{tag}"
+    return environment, f"{image_name}:{tag}"
+
+
+def _upgrade_image_name(
+    partial_name: str,
+    *,
+    explicit_environment_name: str | None = None,
+    fallback_environment_name: str | None = None,
+) -> str:
+    """Ensures an Image name has a tag and an environment name when possible
+
+    * If no tag is present, add :latest
+    * If an explicit environment name is passed, add it as a prefix and error
+      if there is already a prefix
+    * If a fallback environment name is passed, add it only when there is no prefix
+
+    """
+    prefix_environment, name_tag = _parse_image_name(partial_name)
+    if prefix_environment:
+        if explicit_environment_name is not None:
+            raise InvalidError("environment_name cannot be used when an Image name includes an environment prefix.")
+        return f"{prefix_environment}/{name_tag}"
+
+    environment_name = explicit_environment_name if explicit_environment_name is not None else fallback_environment_name
+    if environment_name:
+        return f"{environment_name}/{name_tag}"
+    return name_tag  # no explicit environment - use just the unprefixed name:tag
 
 
 def _validate_python_version(
@@ -2932,8 +2949,8 @@ class _Image(_Object, type_prefix="im"):
     ) -> "_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.
+        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
@@ -2944,20 +2961,16 @@ class _Image(_Object, type_prefix="im"):
             ...
         ```
         """
-        namespace_prefix, tag = _parse_named_image_ref(name)
-
-        if namespace_prefix and environment_name:
-            raise InvalidError("Cannot specify 'environment_name' when the image name contains a '/'.")
+        _upgrade_image_name(name, explicit_environment_name=environment_name)  # validate
 
         async def _load(self: _Image, resolver: Resolver, load_context: LoadContext, existing_object_id: str | None):
             req = api_pb2.ImageGetByTagRequest(
-                tag=tag,
-                environment_name="" if namespace_prefix else load_context.environment_name,
+                tag=_upgrade_image_name(name, fallback_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)
+        rep = _Image._repr(name, environment_name)
         return _Image._from_loader(
             _load,
             rep,
@@ -2971,13 +2984,14 @@ class _Image(_Object, type_prefix="im"):
         name: str,
         *,
         environment_name: str | None = None,
+        experimental_options: dict[str, Any] | 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,
+        Image names can contain an explicit tag designation using `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
@@ -2987,25 +3001,20 @@ class _Image(_Object, type_prefix="im"):
         image.publish("my-image-with-numpy:v1")
         ```
         """
-        namespace_prefix, tag = _parse_named_image_ref(name)
-
-        if namespace_prefix:
-            if environment_name:
-                raise InvalidError("Cannot specify 'environment_name' when the image name contains a '/'.")
-            resolved_env = ""
-        else:
-            resolved_env = environment_name or config.get("environment") or ""
-
         if self._object_id is None:
             raise InvalidError("Cannot publish an image that has not been created yet. Call `.build()` first.")
 
         _client = client or await _Client.from_env()
+        tag = _upgrade_image_name(
+            name,
+            explicit_environment_name=environment_name,
+            fallback_environment_name=config.get("environment"),
+        )
 
         await _client.stub.ImagePublish(
             api_pb2.ImagePublishRequest(
                 image_id=self._object_id,
-                environment_name=resolved_env,
-                allow_public=False,
+                allow_public=bool((experimental_options or {}).get("is_public", False)),
                 tag=tag,
             )
         )

{modal-1.5.4.dev0 → modal-1.5.4.dev2}/modal/_server.py

@@ -15,6 +15,7 @@ from ._supports_logs import _LogQueryData
 from .client import _Client
 from .cls import is_parameter
 from .exception import InvalidError
+from .types import ServerAutoscalerSettings
 
 if typing.TYPE_CHECKING:
     import modal.app
@@ -129,7 +130,7 @@ class _Server:
         buffer_containers: int | None = None,
         scaleup_window: int | None = None,
         scaledown_window: int | None = None,
-    ) -> None:
+    ) -> ServerAutoscalerSettings:
         """Override the current autoscaler behavior for this Server.
 
         Unspecified parameters will retain their current value, i.e. either the static value
@@ -146,6 +147,10 @@ class _Server:
             scaleup_window: Seconds of sustained demand required before scaling up new containers.
             scaledown_window: Maximum duration (in seconds) idle containers wait before scaling down.
 
+        Returns:
+            A `ServerAutoscalerSettings` dataclass which contains the current autoscaler settings of
+            this Server after the call.
+
         Examples:
             ```python notest
             server = modal.Server.from_name("my-app", "Server")
@@ -167,7 +172,7 @@ class _Server:
             ```
 
         """
-        return await self._get_service_function()._update_autoscaler(
+        return await self._get_service_function()._update_autoscaler_server(
             min_containers=min_containers,
             max_containers=max_containers,
             scaleup_window=scaleup_window,

{modal-1.5.4.dev0 → modal-1.5.4.dev2}/modal/cli/environment.py

@@ -72,10 +72,11 @@ def list_(json: bool = False):
 @environment_cli.command("create", help="Create a new environment in the current workspace.", no_args_is_help=True)
 @click.argument("name")
 @click.option("--restricted", is_flag=True, default=False, help="Enable RBAC restrictions on the new environment")
-def create(name: str, restricted: bool = False):
+@click.option("--public", is_flag=True, default=False, hidden=True)
+def create(name: str, restricted: bool = False, public: bool = False):
     check_environment_name(name)
-    Environment.objects.create(name, restricted=restricted)
-    prefix = "Restricted " if restricted else ""
+    Environment.objects.create(name, restricted=restricted, experimental_options={"is_public": public})
+    prefix = "Public " if public else "Restricted " if restricted else ""
     rich.print(f"[green]✓[/green] {prefix}Environment created: {name}")
 
 

{modal-1.5.4.dev0 → modal-1.5.4.dev2}/modal/cli/image.py

@@ -10,12 +10,12 @@ from typing import Optional
 import click
 
 from modal._environments import ensure_env
-from modal._image import _parse_named_image_ref
+from modal._image import _upgrade_image_name
 from modal._utils.async_utils import synchronizer
 from modal._utils.time_utils import timestamp_to_localized_str
 from modal.cli.utils import display_table, env_option
 from modal.client import _Client
-from modal.exception import InvalidError
+from modal.config import config
 from modal.output import OutputManager
 from modal_proto import api_pb2
 
@@ -91,14 +91,12 @@ async def _iter_tag_pages(
 
 async def _fetch_history_page(
     client: _Client,
-    env: str,
-    tag: str,
+    name_tag: str,
     page_token: str,
 ) -> api_pb2.ImageTagRevisionsResponse:
     return await client.stub.ImageTagRevisions(
         api_pb2.ImageTagRevisionsRequest(
-            tag=tag,
-            environment_name=env,
+            tag=name_tag,
             max_objects=IMAGE_NAMES_HISTORY_PAGE_SIZE,
             page_token=page_token,
         )
@@ -106,7 +104,7 @@ async def _fetch_history_page(
 
 
 async def _iter_history_pages(
-    client: _Client, env: str, tag: str, first_page: api_pb2.ImageTagRevisionsResponse
+    client: _Client, name_tag: str, first_page: api_pb2.ImageTagRevisionsResponse
 ) -> AsyncIterator[api_pb2.ImageTagRevisionsResponse]:
     response = first_page
 
@@ -116,7 +114,7 @@ async def _iter_history_pages(
         if not response.next_page_token:
             return
         await asyncio.sleep(IMAGE_NAMES_HISTORY_PAGE_DELAY_SECONDS)
-        response = await _fetch_history_page(client, env, tag, response.next_page_token)
+        response = await _fetch_history_page(client, name_tag, response.next_page_token)
 
 
 @image_names_cli.command("list", help="List named Images.")
@@ -160,36 +158,26 @@ async def list_(
     "history", help="Show publishing history for a named Image.", hidden=True, no_args_is_help=True
 )
 @click.argument("name")
-@env_option
 @click.option("--json", is_flag=True, default=False)
 @synchronizer.create_blocking
 async def history(
     name: str,
-    env: Optional[str] = None,
     json: bool = False,
 ):
-    explicit_env = env  # None when --env is not passed by the user
-    env = ensure_env(env)
-    try:
-        namespace_prefix, name_tag = _parse_named_image_ref(name)
-    except InvalidError as exc:
-        raise click.UsageError(str(exc)) from exc
-
-    if namespace_prefix:
-        if explicit_env is not None:
-            raise click.UsageError("Cannot specify '--env' when the image name contains a '/'.")
-        env = ""
-
+    upgraded_image_name = _upgrade_image_name(
+        name,
+        fallback_environment_name=config.get("environment"),
+    )
     client = await _Client.from_env()
 
-    first_page = await _fetch_history_page(client, env, name_tag, "")
+    first_page = await _fetch_history_page(client, upgraded_image_name, "")
     if not first_page.items:
         raise click.ClickException(f"No publishing history found for named image {first_page.tag!r}.")
 
     if json:
         click.echo("[", nl=False)
         count = 0
-        async for response in _iter_history_pages(client, env, name_tag, first_page):
+        async for response in _iter_history_pages(client, upgraded_image_name, first_page):
             for item in response.items:
                 if count:
                     click.echo(",", nl=False)
@@ -200,7 +188,7 @@ async def history(
 
     count = 0
     show_title = True
-    async for response in _iter_history_pages(client, env, name_tag, first_page):
+    async for response in _iter_history_pages(client, upgraded_image_name, first_page):
         if response.items:
             title = f"History for {response.tag}" if show_title else ""
             display_table(

{modal-1.5.4.dev0 → modal-1.5.4.dev2}/modal/client.pyi

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

{modal-1.5.4.dev0 → modal-1.5.4.dev2}/modal/cls.py

@@ -33,6 +33,7 @@ from .cloud_bucket_mount import _CloudBucketMount
 from .exception import ExecutionError, InvalidError, NotFoundError
 from .retries import Retries
 from .secret import _Secret
+from .types import FunctionAutoscalerSettings
 from .volume import _Volume
 
 T = TypeVar("T")
@@ -288,7 +289,7 @@ class _Obj:
         max_containers: int | None = None,
         scaledown_window: int | None = None,
         buffer_containers: int | None = None,
-    ) -> None:
+    ) -> FunctionAutoscalerSettings:
         """Override the current autoscaler behavior for this Cls instance.
 
         Unspecified parameters will retain their current value, i.e. either the static value
@@ -306,6 +307,10 @@ class _Obj:
             scaledown_window: Idle seconds before scaling down a container; omit to leave unchanged.
             buffer_containers: Extra idle containers under load; omit to leave unchanged.
 
+        Returns:
+            An `FunctionAutoscalerSettings` dataclass which contains the current autoscaler settings
+            of this Cls instance after the call.
+
         Examples:
             ```python notest
             Model = modal.Cls.from_name("my-app", "Model")
@@ -321,6 +326,7 @@ class _Obj:
         """
         if not self._cls.is_hydrated and not self._cls._is_local():
             await self._cls.hydrate()
+
         return await self._cached_service_function().update_autoscaler(
             min_containers=min_containers,
             max_containers=max_containers,

{modal-1.5.4.dev0 → modal-1.5.4.dev2}/modal/cls.pyi

@@ -13,6 +13,7 @@ import modal.object
 import modal.partial_function
 import modal.retries
 import modal.secret
+import modal.types
 import modal.volume
 import modal_proto.api_pb2
 import pathlib
@@ -67,7 +68,7 @@ class _Obj:
         max_containers: typing.Optional[int] = None,
         scaledown_window: typing.Optional[int] = None,
         buffer_containers: typing.Optional[int] = None,
-    ) -> None:
+    ) -> modal.types.FunctionAutoscalerSettings:
         """Override the current autoscaler behavior for this Cls instance.
 
         Unspecified parameters will retain their current value, i.e. either the static value
@@ -85,6 +86,10 @@ class _Obj:
             scaledown_window: Idle seconds before scaling down a container; omit to leave unchanged.
             buffer_containers: Extra idle containers under load; omit to leave unchanged.
 
+        Returns:
+            An `FunctionAutoscalerSettings` dataclass which contains the current autoscaler settings
+            of this Cls instance after the call.
+
         Examples:
             ```python notest
             Model = modal.Cls.from_name("my-app", "Model")
@@ -150,7 +155,7 @@ class Obj:
             max_containers: typing.Optional[int] = None,
             scaledown_window: typing.Optional[int] = None,
             buffer_containers: typing.Optional[int] = None,
-        ) -> None:
+        ) -> modal.types.FunctionAutoscalerSettings:
             """Override the current autoscaler behavior for this Cls instance.
 
             Unspecified parameters will retain their current value, i.e. either the static value
@@ -168,6 +173,10 @@ class Obj:
                 scaledown_window: Idle seconds before scaling down a container; omit to leave unchanged.
                 buffer_containers: Extra idle containers under load; omit to leave unchanged.
 
+            Returns:
+                An `FunctionAutoscalerSettings` dataclass which contains the current autoscaler settings
+                of this Cls instance after the call.
+
             Examples:
                 ```python notest
                 Model = modal.Cls.from_name("my-app", "Model")
@@ -190,7 +199,7 @@ class Obj:
             max_containers: typing.Optional[int] = None,
             scaledown_window: typing.Optional[int] = None,
             buffer_containers: typing.Optional[int] = None,
-        ) -> None:
+        ) -> modal.types.FunctionAutoscalerSettings:
             """Override the current autoscaler behavior for this Cls instance.
 
             Unspecified parameters will retain their current value, i.e. either the static value
@@ -208,6 +217,10 @@ class Obj:
                 scaledown_window: Idle seconds before scaling down a container; omit to leave unchanged.
                 buffer_containers: Extra idle containers under load; omit to leave unchanged.
 
+            Returns:
+                An `FunctionAutoscalerSettings` dataclass which contains the current autoscaler settings
+                of this Cls instance after the call.
+
             Examples:
                 ```python notest
                 Model = modal.Cls.from_name("my-app", "Model")

{modal-1.5.4.dev0 → modal-1.5.4.dev2}/modal/environments.pyi

@@ -18,7 +18,13 @@ class EnvironmentManager:
 
     class __create_spec(typing_extensions.Protocol):
         def __call__(
-            self, /, name: str, *, restricted: bool = False, client: typing.Optional[modal.client.Client] = None
+            self,
+            /,
+            name: str,
+            *,
+            restricted: bool = False,
+            experimental_options: typing.Optional[dict[str, typing.Any]] = None,
+            client: typing.Optional[modal.client.Client] = None,
         ) -> None:
             """Create a new Environment.
 
@@ -31,7 +37,13 @@ class EnvironmentManager:
             ...
 
         async def aio(
-            self, /, name: str, *, restricted: bool = False, client: typing.Optional[modal.client.Client] = None
+            self,
+            /,
+            name: str,
+            *,
+            restricted: bool = False,
+            experimental_options: typing.Optional[dict[str, typing.Any]] = None,
+            client: typing.Optional[modal.client.Client] = None,
         ) -> None:
             """Create a new Environment.