modal 1.5.3.dev6__tar.gz → 1.5.3.dev7__tar.gz

{modal-1.5.3.dev6 → modal-1.5.3.dev7}/PKG-INFO

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

{modal-1.5.3.dev6 → modal-1.5.3.dev7}/modal/_environments.py

@@ -104,11 +104,7 @@ class _EnvironmentManager:
 
 
 class _EnvironmentMembersManager:
-    """mdmd:namespace
-    Namespace with methods for managing the membership of a restricted Environment.
-
-    See https://modal.com/docs/guide/rbac for more information on restricted Environments.
-    """
+    """mdmd:namespace"""
 
     def __init__(self, environment: "_Environment"):
         """mdmd:hidden"""
@@ -288,6 +284,10 @@ class _Environment(_Object, type_prefix="en"):
 
     @property
     def members(self) -> "_EnvironmentMembersManager":
+        """Namespace with methods for managing the membership of a restricted Environment.
+
+        See https://modal.com/docs/guide/rbac for more information on restricted Environments.
+        """
         return _EnvironmentMembersManager(self)
 
     # TODO(michael) Keeping this private for now until we decide what else should be in it
@@ -372,13 +372,12 @@ class _Environment(_Object, type_prefix="en"):
 
     @property
     def billing(self) -> "_EnvironmentBillingManager":
+        """Namespace for Environment billing APIs."""
         return _EnvironmentBillingManager(self)
 
 
 class _EnvironmentBillingManager:
-    """mdmd:namespace
-    Namespace for Environment billing APIs
-    """
+    """mdmd:namespace"""
 
     def __init__(self, environment: _Environment):
         """mdmd:ignore"""

{modal-1.5.3.dev6 → modal-1.5.3.dev7}/modal/_workspace.py

@@ -35,9 +35,7 @@ def _member_role_from_proto(proto_value: int) -> str:
 
 
 class _WorkspaceMembersManager:
-    """mdmd:namespace
-    Namespace with methods for managing the membership of a Workspace.
-    """
+    """mdmd:namespace"""
 
     def __init__(self, workspace: "_Workspace"):
         """mdmd:hidden"""
@@ -81,6 +79,7 @@ class _Workspace(_Object, type_prefix="ac"):
 
     @property
     def members(self) -> "_WorkspaceMembersManager":
+        """Namespace with methods for managing the membership of a Workspace."""
         return _WorkspaceMembersManager(self)
 
     @staticmethod
@@ -110,23 +109,25 @@ class _Workspace(_Object, type_prefix="ac"):
 
     @property
     def billing(self) -> "_WorkspaceBillingManager":
+        """Namespace for Workspace billing APIs."""
         return _WorkspaceBillingManager(self)
 
     @property
     def proxy_tokens(self) -> "_WorkspaceProxyTokenManager":
+        """Namespace with methods for managing the proxy tokens in a Workspace.
+
+        See [the guide](https://modal.com/docs/guide/webhook-proxy-auth) for more information on proxy tokens.
+        """
         return _WorkspaceProxyTokenManager(self)
 
     @property
     def settings(self) -> "_WorkspaceSettingsManager":
+        """Namespace for Workspace settings APIs."""
         return _WorkspaceSettingsManager(self)
 
 
 class _WorkspaceProxyTokenManager:
-    """mdmd:namespace
-    Namespace with methods for managing the proxy tokens in a Workspace.
-
-    See [the guide](https://modal.com/docs/guide/webhook-proxy-auth) for more information on proxy tokens.
-    """
+    """mdmd:namespace"""
 
     def __init__(self, workspace: "_Workspace"):
         """mdmd:hidden"""
@@ -245,9 +246,7 @@ class _WorkspaceProxyTokenManager:
 
 
 class _WorkspaceBillingManager:
-    """mdmd:namespace
-    Namespace for Workspace billing APIs.
-    """
+    """mdmd:namespace"""
 
     def __init__(self, workspace: _Workspace):
         """mdmd:hidden"""
@@ -321,9 +320,7 @@ class _WorkspaceBillingManager:
 
 
 class _WorkspaceSettingsManager:
-    """mdmd:namespace
-    Namespace for Workspace settings APIs.
-    """
+    """mdmd:namespace"""
 
     @classmethod
     def valid_settings(cls):

{modal-1.5.3.dev6 → modal-1.5.3.dev7}/modal/cli/shell.py

@@ -236,6 +236,7 @@ def _start_shell_from_image(
     region: str | None,
     pty: bool,
     experimental_options: dict[str, str],
+    v2: bool,
 ) -> None:
     volumes = {f"/mnt/{vol}": Volume.from_name(vol) for vol in volume}
     secrets = [Secret.from_name(s) for s in secret]
@@ -267,6 +268,7 @@ def _start_shell_from_image(
         region=region.split(",") if region else [],
         pty=pty,
         experimental_options=experimental_options,
+        v2=v2,
     )
 
 
@@ -327,6 +329,14 @@ def _start_shell_from_image(
     hidden=True,
     metavar="KEY=VALUE",
 )
+@click.option(
+    "--experimental-v2",
+    "v2",
+    is_flag=True,
+    default=False,
+    hidden=True,
+    help="Create the shell using the V2 sandbox backend.",
+)
 def shell(
     ref: str | None = None,
     cmd: str = "/bin/bash",
@@ -344,6 +354,7 @@ def shell(
     pty: bool | None = None,
     use_module_mode: bool = False,
     experimental_options: tuple[str, ...] = (),
+    v2: bool = False,
 ):
     """Run a command or interactive shell inside a Modal container.
 
@@ -423,13 +434,20 @@ def shell(
             shell.params,
             ctx,
             locals(),
-            allowed=lambda p: p in {"cmd", "env", "pty", "ref", "use_module_mode", "experimental_options"},
+            allowed=lambda p: p in {"cmd", "env", "pty", "ref", "use_module_mode", "experimental_options", "v2"},
         ):
             raise ClickException(
                 f"Cannot specify container configuration arguments ({', '.join(passed_forbidden)}) "
                 f"when starting a new container from a function reference ('{ref}')."
             )
 
+        if v2:
+            # Function specs always carry mounts (e.g. the client mount), which the
+            # V2 backend does not support.
+            raise ClickException(
+                "--experimental-v2 is not supported when starting a shell from a function reference. "
+                "Use an image instead (e.g. `modal shell --experimental-v2 --image ...`)."
+            )
         function_spec = _function_spec_from_ref(ref, use_module_mode)
         _start_shell_from_function_spec(app, cmds, env, timeout, function_spec, pty, parsed_experimental_options)
         return
@@ -463,4 +481,5 @@ def shell(
         region,
         pty,
         parsed_experimental_options,
+        v2,
     )

{modal-1.5.3.dev6 → modal-1.5.3.dev7}/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.3.dev6",
+        version: str = "1.5.3.dev7",
     ):
         """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.3.dev6",
+        version: str = "1.5.3.dev7",
     ):
         """mdmd:hidden
         The Modal client object is not intended to be instantiated directly by users.

{modal-1.5.3.dev6 → modal-1.5.3.dev7}/modal/environments.pyi

@@ -102,11 +102,7 @@ class EnvironmentManager:
     delete: __delete_spec
 
 class EnvironmentMembersManager:
-    """mdmd:namespace
-    Namespace with methods for managing the membership of a restricted Environment.
-
-    See https://modal.com/docs/guide/rbac for more information on restricted Environments.
-    """
+    """mdmd:namespace"""
     def __init__(self, environment: Environment):
         """mdmd:hidden"""
         ...
@@ -254,9 +250,7 @@ class EnvironmentMembersManager:
     _dispatch_role_updates: ___dispatch_role_updates_spec
 
 class EnvironmentBillingManager:
-    """mdmd:namespace
-    Namespace for Environment billing APIs
-    """
+    """mdmd:namespace"""
     def __init__(self, environment: Environment):
         """mdmd:ignore"""
         ...
@@ -352,7 +346,13 @@ class Environment(modal.object.Object):
     @classmethod
     def objects(cls) -> EnvironmentManager: ...
     @property
-    def members(self) -> EnvironmentMembersManager: ...
+    def members(self) -> EnvironmentMembersManager:
+        """Namespace with methods for managing the membership of a restricted Environment.
+
+        See https://modal.com/docs/guide/rbac for more information on restricted Environments.
+        """
+        ...
+
     def _hydrate_metadata(self, metadata: typing.Optional[google.protobuf.message.Message]): ...
     @staticmethod
     def _get_or_create(
@@ -378,7 +378,9 @@ class Environment(modal.object.Object):
         ...
 
     @property
-    def billing(self) -> EnvironmentBillingManager: ...
+    def billing(self) -> EnvironmentBillingManager:
+        """Namespace for Environment billing APIs."""
+        ...
 
 class __create_environment_spec(typing_extensions.Protocol):
     def __call__(self, /, name: str, client: typing.Optional[modal.client.Client] = None): ...

{modal-1.5.3.dev6 → modal-1.5.3.dev7}/modal/runner.py

@@ -690,7 +690,12 @@ async def _deploy_app(
 
 
 async def _interactive_shell(
-    _app: "modal.app._App", cmds: list[str], environment_name: str = "", pty: bool = True, **kwargs: Any
+    _app: "modal.app._App",
+    cmds: list[str],
+    environment_name: str = "",
+    pty: bool = True,
+    v2: bool = False,
+    **kwargs: Any,
 ) -> None:
     """Run an interactive shell (like `bash`) within the image for this app.
 
@@ -732,13 +737,25 @@ async def _interactive_shell(
 
         # Temporarily enable output to show image build logs during sandbox creation
         output_mgr.set_quiet_mode(False)
-        sandbox = await _Sandbox._create(
-            "sleep",
-            "100000",
-            app=_app,
-            secrets=secrets,
-            **kwargs,
-        )
+        if v2:
+            for option in ("gpu", "mounts", "network_file_systems"):
+                if kwargs.pop(option, None):
+                    raise InvalidError(f"`{option}` is not supported for V2 sandboxes")
+            sandbox = await _Sandbox._experimental_create(
+                "sleep",
+                "100000",
+                app=_app,
+                secrets=secrets,
+                **kwargs,
+            )
+        else:
+            sandbox = await _Sandbox._create(
+                "sleep",
+                "100000",
+                app=_app,
+                secrets=secrets,
+                **kwargs,
+            )
 
         # Re-enable quiet mode before starting the interactive session
         output_mgr.set_quiet_mode(True)
@@ -757,7 +774,12 @@ async def _interactive_shell(
         except InteractiveTimeoutError:
             # Check on status of Sandbox. It may have crashed, causing connection failure.
             req = api_pb2.SandboxWaitRequest(sandbox_id=sandbox._object_id, timeout=0)
-            resp = await sandbox._client.stub.SandboxWait(req)
+            if v2:
+                assert sandbox._client._auth_token_manager
+                auth_token = await sandbox._client._auth_token_manager.get_token()
+                resp = await sandbox._client.stub.SandboxWaitV2(req, metadata=[("x-modal-auth-token", auth_token)])
+            else:
+                resp = await sandbox._client.stub.SandboxWait(req)
             if resp.result.exception:
                 raise RemoteError(resp.result.exception)
             else:

{modal-1.5.3.dev6 → modal-1.5.3.dev7}/modal/runner.pyi

@@ -139,7 +139,12 @@ async def _deploy_app(
     ...
 
 async def _interactive_shell(
-    _app: modal.app._App, cmds: list[str], environment_name: str = "", pty: bool = True, **kwargs: typing.Any
+    _app: modal.app._App,
+    cmds: list[str],
+    environment_name: str = "",
+    pty: bool = True,
+    v2: bool = False,
+    **kwargs: typing.Any,
 ) -> None:
     """Run an interactive shell (like `bash`) within the image for this app.
 
@@ -267,6 +272,7 @@ class __interactive_shell_spec(typing_extensions.Protocol):
         cmds: list[str],
         environment_name: str = "",
         pty: bool = True,
+        v2: bool = False,
         **kwargs: typing.Any,
     ) -> None:
         """Run an interactive shell (like `bash`) within the image for this app.
@@ -299,6 +305,7 @@ class __interactive_shell_spec(typing_extensions.Protocol):
         cmds: list[str],
         environment_name: str = "",
         pty: bool = True,
+        v2: bool = False,
         **kwargs: typing.Any,
     ) -> None:
         """Run an interactive shell (like `bash`) within the image for this app.

{modal-1.5.3.dev6 → modal-1.5.3.dev7}/modal/sandbox.py

@@ -2155,11 +2155,7 @@ class _Sandbox(_Object, type_prefix="sb"):
 
     @property
     def filesystem(self) -> _SandboxFilesystem:
-        """Namespace for filesystem APIs.
-
-        Returns:
-            A `SandboxFilesystem` helper bound to this sandbox.
-        """
+        """Namespace for Sandbox filesystem APIs."""
         self._ensure_attached()
         if self._filesystem is None:
             self._filesystem = _SandboxFilesystem(self)
@@ -2550,7 +2546,7 @@ class _SidecarContainer:
 
     @property
     def filesystem(self) -> _SandboxFilesystem:
-        """Namespace for filesystem APIs."""
+        """Namespace for Sandbox filesystem APIs."""
         if self._filesystem is None:
             self._filesystem = _SandboxFilesystem(self)
         return self._filesystem

{modal-1.5.3.dev6 → modal-1.5.3.dev7}/modal/sandbox.pyi

@@ -855,11 +855,7 @@ class _Sandbox(modal._object._Object):
     ): ...
     @property
     def filesystem(self) -> modal.sandbox_fs._SandboxFilesystem:
-        """Namespace for filesystem APIs.
-
-        Returns:
-            A `SandboxFilesystem` helper bound to this sandbox.
-        """
+        """Namespace for Sandbox filesystem APIs."""
         ...
 
     @typing.overload
@@ -1055,7 +1051,7 @@ class _SidecarContainer:
     ) -> modal.container_process._ContainerProcess[bytes]: ...
     @property
     def filesystem(self) -> modal.sandbox_fs._SandboxFilesystem:
-        """Namespace for filesystem APIs."""
+        """Namespace for Sandbox filesystem APIs."""
         ...
 
     async def wait(self, raise_on_termination: bool = True) -> None: ...
@@ -1207,7 +1203,7 @@ class SidecarContainer:
 
     @property
     def filesystem(self) -> modal.sandbox_fs.SandboxFilesystem:
-        """Namespace for filesystem APIs."""
+        """Namespace for Sandbox filesystem APIs."""
         ...
 
     class __wait_spec(typing_extensions.Protocol):
@@ -2820,11 +2816,7 @@ class Sandbox(modal.object.Object):
 
     @property
     def filesystem(self) -> modal.sandbox_fs.SandboxFilesystem:
-        """Namespace for filesystem APIs.
-
-        Returns:
-            A `SandboxFilesystem` helper bound to this sandbox.
-        """
+        """Namespace for Sandbox filesystem APIs."""
         ...
 
     class __open_spec(typing_extensions.Protocol):

{modal-1.5.3.dev6 → modal-1.5.3.dev7}/modal/sandbox_fs.py

@@ -66,8 +66,7 @@ def _expand_watch_filter(filter: list[FileWatchEventType]) -> list[str]:
 
 
 class _SandboxFilesystem:
-    """mdmd:namespace
-    Namespace for Sandbox filesystem APIs."""
+    """mdmd:namespace"""
 
     _container: Union["modal.sandbox._Sandbox", "modal.sandbox._SidecarContainer"]
 

{modal-1.5.3.dev6 → modal-1.5.3.dev7}/modal/sandbox_fs.pyi

@@ -14,9 +14,7 @@ def _expand_watch_filter(filter: list[modal.types.FileWatchEventType]) -> list[s
     ...
 
 class _SandboxFilesystem:
-    """mdmd:namespace
-    Namespace for Sandbox filesystem APIs.
-    """
+    """mdmd:namespace"""
 
     _container: typing.Union[modal.sandbox._Sandbox, modal.sandbox._SidecarContainer]
 
@@ -356,9 +354,7 @@ class _SandboxFilesystem:
         ...
 
 class SandboxFilesystem:
-    """mdmd:namespace
-    Namespace for Sandbox filesystem APIs.
-    """
+    """mdmd:namespace"""
 
     _container: typing.Union[modal.sandbox.Sandbox, modal.sandbox.SidecarContainer]
 

{modal-1.5.3.dev6 → modal-1.5.3.dev7}/modal/workspace.pyi

@@ -148,7 +148,10 @@ class Workspace(modal.object.Object):
     @property
     def name(self) -> typing.Optional[str]: ...
     @property
-    def members(self) -> WorkspaceMembersManager: ...
+    def members(self) -> WorkspaceMembersManager:
+        """Namespace with methods for managing the membership of a Workspace."""
+        ...
+
     @staticmethod
     def from_context(*, client: typing.Optional[modal.client.Client] = None) -> Workspace:
         """Look up the Workspace associated with the current context.
@@ -161,16 +164,25 @@ class Workspace(modal.object.Object):
         ...
 
     @property
-    def billing(self) -> WorkspaceBillingManager: ...
+    def billing(self) -> WorkspaceBillingManager:
+        """Namespace for Workspace billing APIs."""
+        ...
+
     @property
-    def proxy_tokens(self) -> WorkspaceProxyTokenManager: ...
+    def proxy_tokens(self) -> WorkspaceProxyTokenManager:
+        """Namespace with methods for managing the proxy tokens in a Workspace.
+
+        See [the guide](https://modal.com/docs/guide/webhook-proxy-auth) for more information on proxy tokens.
+        """
+        ...
+
     @property
-    def settings(self) -> WorkspaceSettingsManager: ...
+    def settings(self) -> WorkspaceSettingsManager:
+        """Namespace for Workspace settings APIs."""
+        ...
 
 class WorkspaceMembersManager:
-    """mdmd:namespace
-    Namespace with methods for managing the membership of a Workspace.
-    """
+    """mdmd:namespace"""
     def __init__(self, workspace: Workspace):
         """mdmd:hidden"""
         ...
@@ -203,9 +215,7 @@ class WorkspaceMembersManager:
     list: __list_spec
 
 class WorkspaceBillingManager:
-    """mdmd:namespace
-    Namespace for Workspace billing APIs.
-    """
+    """mdmd:namespace"""
     def __init__(self, workspace: Workspace):
         """mdmd:hidden"""
         ...
@@ -288,11 +298,7 @@ class WorkspaceBillingManager:
     report: __report_spec
 
 class WorkspaceProxyTokenManager:
-    """mdmd:namespace
-    Namespace with methods for managing the proxy tokens in a Workspace.
-
-    See [the guide](https://modal.com/docs/guide/webhook-proxy-auth) for more information on proxy tokens.
-    """
+    """mdmd:namespace"""
     def __init__(self, workspace: Workspace):
         """mdmd:hidden"""
         ...
@@ -481,9 +487,7 @@ class WorkspaceProxyTokenManager:
     _environment_id: ___environment_id_spec
 
 class WorkspaceSettingsManager:
-    """mdmd:namespace
-    Namespace for Workspace settings APIs.
-    """
+    """mdmd:namespace"""
     def __init__(self, workspace: Workspace):
         """mdmd:hidden"""
         ...

{modal-1.5.3.dev6 → modal-1.5.3.dev7}/modal.egg-info/PKG-INFO

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

{modal-1.5.3.dev6 → modal-1.5.3.dev7}/modal_docs/mdmd/mdmd.py

@@ -429,7 +429,14 @@ def _dataclass_attributes(name, obj, docstring: str) -> list[ParsedParam]:
     return attributes
 
 
-def class_str(name, obj, title_level="##", decl_override: str | None = None, member_prefix: str = ""):
+def class_str(
+    name,
+    obj,
+    title_level="##",
+    decl_override: str | None = None,
+    member_prefix: str = "",
+    docstring_source=None,
+):
     def qual_name(cls):
         if cls.__module__ == "builtins":
             return cls.__name__
@@ -453,7 +460,9 @@ def class_str(name, obj, title_level="##", decl_override: str | None = None, mem
 class {name}{bases_str}
 ```\n\n"""
     parts = ["\n", decl]
-    if is_dataclass and _has_autogenerated_dataclass_doc(obj):
+    if docstring_source is not None:
+        docstring = clean_docstring(docstring_source.__doc__)
+    elif is_dataclass and _has_autogenerated_dataclass_doc(obj):
         docstring = ""
     else:
         docstring = clean_docstring(obj.__doc__)
@@ -540,6 +549,7 @@ class {name}{bases_str}
                         title_level=title_level + "#",
                         decl_override=decl,
                         member_prefix=f"{member_name}.",
+                        docstring_source=fget,
                     )
                 )
                 continue