modal 1.0.6.dev58__py3-none-any.whl → 1.2.3.dev7__py3-none-any.whl

modal/cls.pyi

@@ -6,6 +6,7 @@ import modal._object
 import modal._partial_function
 import modal.app
 import modal.client
+import modal.cloud_bucket_mount
 import modal.functions
 import modal.gpu
 import modal.object
@@ -14,7 +15,7 @@ import modal.retries
 import modal.secret
 import modal.volume
 import modal_proto.api_pb2
-import os
+import pathlib
 import typing
 import typing_extensions
 
@@ -24,9 +25,9 @@ def _use_annotation_parameters(user_cls: type) -> bool: ...
 def _get_class_constructor_signature(user_cls: type) -> inspect.Signature: ...
 
 class _ServiceOptions:
-    """_ServiceOptions(secrets: Collection[modal.secret._Secret] = (), validated_volumes: Sequence[tuple[str, modal.volume._Volume]] = (), resources: Optional[modal_proto.api_pb2.Resources] = None, retry_policy: Optional[modal_proto.api_pb2.FunctionRetryPolicy] = None, max_containers: Optional[int] = None, buffer_containers: Optional[int] = None, scaledown_window: Optional[int] = None, timeout_secs: Optional[int] = None, max_concurrent_inputs: Optional[int] = None, target_concurrent_inputs: Optional[int] = None, batch_max_size: Optional[int] = None, batch_wait_ms: Optional[int] = None)"""
+    """_ServiceOptions(secrets: collections.abc.Collection[modal.secret._Secret] = (), validated_volumes: Sequence[tuple[str, modal.volume._Volume]] = (), resources: Optional[modal_proto.api_pb2.Resources] = None, retry_policy: Optional[modal_proto.api_pb2.FunctionRetryPolicy] = None, max_containers: Optional[int] = None, buffer_containers: Optional[int] = None, scaledown_window: Optional[int] = None, timeout_secs: Optional[int] = None, max_concurrent_inputs: Optional[int] = None, target_concurrent_inputs: Optional[int] = None, batch_max_size: Optional[int] = None, batch_wait_ms: Optional[int] = None, scheduler_placement: Optional[modal_proto.api_pb2.SchedulerPlacement] = None, cloud: Optional[str] = None, cloud_bucket_mounts: Sequence[tuple[str, modal.cloud_bucket_mount._CloudBucketMount]] = ())"""
 
-    secrets: typing.Collection[modal.secret._Secret]
+    secrets: collections.abc.Collection[modal.secret._Secret]
     validated_volumes: typing.Sequence[tuple[str, modal.volume._Volume]]
     resources: typing.Optional[modal_proto.api_pb2.Resources]
     retry_policy: typing.Optional[modal_proto.api_pb2.FunctionRetryPolicy]
@@ -38,6 +39,9 @@ class _ServiceOptions:
     target_concurrent_inputs: typing.Optional[int]
     batch_max_size: typing.Optional[int]
     batch_wait_ms: typing.Optional[int]
+    scheduler_placement: typing.Optional[modal_proto.api_pb2.SchedulerPlacement]
+    cloud: typing.Optional[str]
+    cloud_bucket_mounts: typing.Sequence[tuple[str, modal.cloud_bucket_mount._CloudBucketMount]]
 
     def merge_options(self, new_options: _ServiceOptions) -> _ServiceOptions:
         """Implement protobuf-like MergeFrom semantics for this dataclass.
@@ -48,7 +52,7 @@ class _ServiceOptions:
 
     def __init__(
         self,
-        secrets: typing.Collection[modal.secret._Secret] = (),
+        secrets: collections.abc.Collection[modal.secret._Secret] = (),
         validated_volumes: typing.Sequence[tuple[str, modal.volume._Volume]] = (),
         resources: typing.Optional[modal_proto.api_pb2.Resources] = None,
         retry_policy: typing.Optional[modal_proto.api_pb2.FunctionRetryPolicy] = None,
@@ -60,6 +64,9 @@ class _ServiceOptions:
         target_concurrent_inputs: typing.Optional[int] = None,
         batch_max_size: typing.Optional[int] = None,
         batch_wait_ms: typing.Optional[int] = None,
+        scheduler_placement: typing.Optional[modal_proto.api_pb2.SchedulerPlacement] = None,
+        cloud: typing.Optional[str] = None,
+        cloud_bucket_mounts: typing.Sequence[tuple[str, modal.cloud_bucket_mount._CloudBucketMount]] = (),
     ) -> None:
         """Initialize self.  See help(type(self)) for accurate signature."""
         ...
@@ -350,6 +357,10 @@ class _Cls(modal._object._Object):
     def _get_name(self) -> str: ...
     def _get_class_service_function(self) -> modal._functions._Function: ...
     def _get_method_names(self) -> collections.abc.Collection[str]: ...
+    async def _experimental_get_flash_urls(self) -> typing.Optional[list[str]]:
+        """URL of the flash service for the class."""
+        ...
+
     def _hydrate_metadata(self, metadata: google.protobuf.message.Message): ...
     @staticmethod
     def validate_construction_mechanism(user_cls):
@@ -369,6 +380,7 @@ class _Cls(modal._object._Object):
         *,
         namespace: typing.Any = None,
         environment_name: typing.Optional[str] = None,
+        client: typing.Optional[modal.client._Client] = None,
     ) -> _Cls:
         """Reference a Cls from a deployed App by its name.
 
@@ -388,13 +400,19 @@ class _Cls(modal._object._Object):
         cpu: typing.Union[float, tuple[float, float], None] = None,
         memory: typing.Union[int, tuple[int, int], None] = None,
         gpu: typing.Union[None, str, modal.gpu._GPUConfig] = None,
-        secrets: collections.abc.Collection[modal.secret._Secret] = (),
-        volumes: dict[typing.Union[str, os.PathLike], modal.volume._Volume] = {},
+        env: typing.Optional[dict[str, typing.Optional[str]]] = None,
+        secrets: typing.Optional[collections.abc.Collection[modal.secret._Secret]] = None,
+        volumes: dict[
+            typing.Union[str, pathlib.PurePosixPath],
+            typing.Union[modal.volume._Volume, modal.cloud_bucket_mount._CloudBucketMount],
+        ] = {},
         retries: typing.Union[int, modal.retries.Retries, None] = None,
         max_containers: typing.Optional[int] = None,
         buffer_containers: typing.Optional[int] = None,
         scaledown_window: typing.Optional[int] = None,
         timeout: typing.Optional[int] = None,
+        region: typing.Union[str, typing.Sequence[str], None] = None,
+        cloud: typing.Optional[str] = None,
         concurrency_limit: typing.Optional[int] = None,
         container_idle_timeout: typing.Optional[int] = None,
         allow_concurrent_inputs: typing.Optional[int] = None,
@@ -454,30 +472,6 @@ class _Cls(modal._object._Object):
         """
         ...
 
-    @staticmethod
-    async def lookup(
-        app_name: str,
-        name: str,
-        namespace=None,
-        client: typing.Optional[modal.client._Client] = None,
-        environment_name: typing.Optional[str] = None,
-    ) -> _Cls:
-        """mdmd:hidden
-        Lookup a Cls from a deployed App by its name.
-
-        DEPRECATED: This method is deprecated in favor of `modal.Cls.from_name`.
-
-        In contrast to `modal.Cls.from_name`, this is an eager method
-        that will hydrate the local object with metadata from Modal servers.
-
-        ```python notest
-        Model = modal.Cls.from_name("other-app", "Model")
-        model = Model()
-        model.inference(...)
-        ```
-        """
-        ...
-
     def __call__(self, *args, **kwargs) -> _Obj:
         """This acts as the class constructor."""
         ...
@@ -514,6 +508,18 @@ class Cls(modal.object.Object):
     def _get_name(self) -> str: ...
     def _get_class_service_function(self) -> modal.functions.Function: ...
     def _get_method_names(self) -> collections.abc.Collection[str]: ...
+
+    class ___experimental_get_flash_urls_spec(typing_extensions.Protocol[SUPERSELF]):
+        def __call__(self, /) -> typing.Optional[list[str]]:
+            """URL of the flash service for the class."""
+            ...
+
+        async def aio(self, /) -> typing.Optional[list[str]]:
+            """URL of the flash service for the class."""
+            ...
+
+    _experimental_get_flash_urls: ___experimental_get_flash_urls_spec[typing_extensions.Self]
+
     def _hydrate_metadata(self, metadata: google.protobuf.message.Message): ...
     @staticmethod
     def validate_construction_mechanism(user_cls):
@@ -533,6 +539,7 @@ class Cls(modal.object.Object):
         *,
         namespace: typing.Any = None,
         environment_name: typing.Optional[str] = None,
+        client: typing.Optional[modal.client.Client] = None,
     ) -> Cls:
         """Reference a Cls from a deployed App by its name.
 
@@ -552,13 +559,19 @@ class Cls(modal.object.Object):
         cpu: typing.Union[float, tuple[float, float], None] = None,
         memory: typing.Union[int, tuple[int, int], None] = None,
         gpu: typing.Union[None, str, modal.gpu._GPUConfig] = None,
-        secrets: collections.abc.Collection[modal.secret.Secret] = (),
-        volumes: dict[typing.Union[str, os.PathLike], modal.volume.Volume] = {},
+        env: typing.Optional[dict[str, typing.Optional[str]]] = None,
+        secrets: typing.Optional[collections.abc.Collection[modal.secret.Secret]] = None,
+        volumes: dict[
+            typing.Union[str, pathlib.PurePosixPath],
+            typing.Union[modal.volume.Volume, modal.cloud_bucket_mount.CloudBucketMount],
+        ] = {},
         retries: typing.Union[int, modal.retries.Retries, None] = None,
         max_containers: typing.Optional[int] = None,
         buffer_containers: typing.Optional[int] = None,
         scaledown_window: typing.Optional[int] = None,
         timeout: typing.Optional[int] = None,
+        region: typing.Union[str, typing.Sequence[str], None] = None,
+        cloud: typing.Optional[str] = None,
         concurrency_limit: typing.Optional[int] = None,
         container_idle_timeout: typing.Optional[int] = None,
         allow_concurrent_inputs: typing.Optional[int] = None,
@@ -618,59 +631,6 @@ class Cls(modal.object.Object):
         """
         ...
 
-    class __lookup_spec(typing_extensions.Protocol):
-        def __call__(
-            self,
-            /,
-            app_name: str,
-            name: str,
-            namespace=None,
-            client: typing.Optional[modal.client.Client] = None,
-            environment_name: typing.Optional[str] = None,
-        ) -> Cls:
-            """mdmd:hidden
-            Lookup a Cls from a deployed App by its name.
-
-            DEPRECATED: This method is deprecated in favor of `modal.Cls.from_name`.
-
-            In contrast to `modal.Cls.from_name`, this is an eager method
-            that will hydrate the local object with metadata from Modal servers.
-
-            ```python notest
-            Model = modal.Cls.from_name("other-app", "Model")
-            model = Model()
-            model.inference(...)
-            ```
-            """
-            ...
-
-        async def aio(
-            self,
-            /,
-            app_name: str,
-            name: str,
-            namespace=None,
-            client: typing.Optional[modal.client.Client] = None,
-            environment_name: typing.Optional[str] = None,
-        ) -> Cls:
-            """mdmd:hidden
-            Lookup a Cls from a deployed App by its name.
-
-            DEPRECATED: This method is deprecated in favor of `modal.Cls.from_name`.
-
-            In contrast to `modal.Cls.from_name`, this is an eager method
-            that will hydrate the local object with metadata from Modal servers.
-
-            ```python notest
-            Model = modal.Cls.from_name("other-app", "Model")
-            model = Model()
-            model.inference(...)
-            ```
-            """
-            ...
-
-    lookup: __lookup_spec
-
     def __call__(self, *args, **kwargs) -> Obj:
         """This acts as the class constructor."""
         ...

modal/config.py

@@ -66,11 +66,15 @@ Other possible configuration options are:
 * `traceback` (in the .toml file) / `MODAL_TRACEBACK` (as an env var).
   Defaults to False. Enables printing full tracebacks on unexpected CLI
   errors, which can be useful for debugging client issues.
-* `log_pattern` (in the .toml file) / MODAL_LOG_PATTERN` (as an env var).
-  Defaults to "[modal-client] %(asctime)s %(message)s"
+* `log_pattern` (in the .toml file) / `MODAL_LOG_PATTERN` (as an env var).
+  Defaults to `"[modal-client] %(asctime)s %(message)s"`
   The log formatting pattern that will be used by the modal client itself.
   See https://docs.python.org/3/library/logging.html#logrecord-attributes for available
   log attributes.
+* `dev_suffix` (in the .toml file) / `MODAL_DEV_SUFFIX` (as an env var).
+  Overrides the default `-dev` suffix added to URLs generated for web endpoints
+  when the App is ephemeral (i.e., created via `modal serve`). Must be a short
+  alphanumeric string.
 
 Meta-configuration
 ------------------
@@ -85,6 +89,7 @@ Some "meta-options" are set using environment variables only:
 
 import logging
 import os
+import re
 import typing
 import warnings
 from typing import Any, Callable, Optional
@@ -94,7 +99,7 @@ from google.protobuf.empty_pb2 import Empty
 from modal_proto import api_pb2
 
 from ._utils.logger import configure_logger
-from .exception import InvalidError
+from .exception import InvalidError, NotFoundError
 
 DEFAULT_SERVER_URL = "https://api.modal.com"
 
@@ -142,7 +147,7 @@ async def _lookup_workspace(server_url: str, token_id: str, token_secret: str) -
 
     credentials = (token_id, token_secret)
     async with _Client(server_url, api_pb2.CLIENT_TYPE_CLIENT, credentials) as client:
-        return await client.stub.WorkspaceNameLookup(Empty(), timeout=3)
+        return await client.stub.WorkspaceNameLookup(Empty(), retry=None, timeout=3)
 
 
 def config_profiles():
@@ -158,15 +163,15 @@ def _config_active_profile() -> str:
         return "default"
 
 
-def config_set_active_profile(env: str) -> None:
+def config_set_active_profile(profile: str) -> None:
     """Set the user's active modal profile by writing it to the `.modal.toml` file."""
-    if env not in _user_config:
-        raise KeyError(env)
+    if profile not in _user_config:
+        raise NotFoundError(f"No profile named '{profile}' found in {user_config_path}")
 
-    for key, values in _user_config.items():
-        values.pop("active", None)
+    for profile_data in _user_config.values():
+        profile_data.pop("active", None)
 
-    _user_config[env]["active"] = True
+    _user_config[profile]["active"] = True  # type: ignore
     _write_user_config(_user_config)
 
 
@@ -206,6 +211,12 @@ def _check_value(options: list[str]) -> Callable[[str], str]:
     return checker
 
 
+def _enforce_suffix_rules(x: str) -> str:
+    if x and not re.match(r"^[a-zA-Z0-9]{1,8}$", x):
+        raise ValueError("Suffix must be an alphanumeric string of no more than 8 characters.")
+    return x
+
+
 class _Setting(typing.NamedTuple):
     default: typing.Any = None
     transform: typing.Callable[[str], typing.Any] = lambda x: x  # noqa: E731
@@ -236,9 +247,17 @@ _SETTINGS = {
     "traceback": _Setting(False, transform=_to_boolean),
     "image_builder_version": _Setting(),
     "strict_parameters": _Setting(False, transform=_to_boolean),  # For internal/experimental use
+    # Allow insecure TLS for the task command router when running locally (testing/dev only)
+    "task_command_router_insecure": _Setting(False, transform=_to_boolean),
     "snapshot_debug": _Setting(False, transform=_to_boolean),
     "cuda_checkpoint_path": _Setting("/__modal/.bin/cuda-checkpoint"),  # Used for snapshotting GPU memory.
     "build_validation": _Setting("error", transform=_check_value(["error", "warn", "ignore"])),
+    # Payload format for function inputs/outputs: 'pickle' (default) or 'cbor'
+    "payload_format": _Setting(
+        "pickle",
+        transform=lambda s: _check_value(["pickle", "cbor"])(s.lower()),
+    ),
+    "dev_suffix": _Setting("", transform=_enforce_suffix_rules),
 }