modal 1.0.6.dev34__tar.gz → 1.0.6.dev36__tar.gz

{modal-1.0.6.dev34 → modal-1.0.6.dev36}/PKG-INFO

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

{modal-1.0.6.dev34 → modal-1.0.6.dev36}/modal/app.py

@@ -508,22 +508,38 @@ class _App:
 
     @property
     def registered_functions(self) -> dict[str, _Function]:
-        """All modal.Function objects registered on the app."""
+        """All modal.Function objects registered on the app.
+
+        Note: this property is populated only during the build phase, and it is not
+        expected to work when a deplyoed App has been retrieved via `modal.App.lookup`.
+        """
         return self._functions
 
     @property
     def registered_classes(self) -> dict[str, _Cls]:
-        """All modal.Cls objects registered on the app."""
+        """All modal.Cls objects registered on the app.
+
+        Note: this property is populated only during the build phase, and it is not
+        expected to work when a deplyoed App has been retrieved via `modal.App.lookup`.
+        """
         return self._classes
 
     @property
     def registered_entrypoints(self) -> dict[str, _LocalEntrypoint]:
-        """All local CLI entrypoints registered on the app."""
+        """All local CLI entrypoints registered on the app.
+
+        Note: this property is populated only during the build phase, and it is not
+        expected to work when a deplyoed App has been retrieved via `modal.App.lookup`.
+        """
         return self._local_entrypoints
 
     @property
     def registered_web_endpoints(self) -> list[str]:
-        """Names of web endpoint (ie. webhook) functions registered on the app."""
+        """Names of web endpoint (ie. webhook) functions registered on the app.
+
+        Note: this property is populated only during the build phase, and it is not
+        expected to work when a deplyoed App has been retrieved via `modal.App.lookup`.
+        """
         return self._web_endpoints
 
     def local_entrypoint(

{modal-1.0.6.dev34 → modal-1.0.6.dev36}/modal/app.pyi

@@ -299,22 +299,38 @@ class _App:
     def _init_container(self, client: modal.client._Client, running_app: modal.running_app.RunningApp): ...
     @property
     def registered_functions(self) -> dict[str, modal._functions._Function]:
-        """All modal.Function objects registered on the app."""
+        """All modal.Function objects registered on the app.
+
+        Note: this property is populated only during the build phase, and it is not
+        expected to work when a deplyoed App has been retrieved via `modal.App.lookup`.
+        """
         ...
 
     @property
     def registered_classes(self) -> dict[str, modal.cls._Cls]:
-        """All modal.Cls objects registered on the app."""
+        """All modal.Cls objects registered on the app.
+
+        Note: this property is populated only during the build phase, and it is not
+        expected to work when a deplyoed App has been retrieved via `modal.App.lookup`.
+        """
         ...
 
     @property
     def registered_entrypoints(self) -> dict[str, _LocalEntrypoint]:
-        """All local CLI entrypoints registered on the app."""
+        """All local CLI entrypoints registered on the app.
+
+        Note: this property is populated only during the build phase, and it is not
+        expected to work when a deplyoed App has been retrieved via `modal.App.lookup`.
+        """
         ...
 
     @property
     def registered_web_endpoints(self) -> list[str]:
-        """Names of web endpoint (ie. webhook) functions registered on the app."""
+        """Names of web endpoint (ie. webhook) functions registered on the app.
+
+        Note: this property is populated only during the build phase, and it is not
+        expected to work when a deplyoed App has been retrieved via `modal.App.lookup`.
+        """
         ...
 
     def local_entrypoint(
@@ -888,22 +904,38 @@ class App:
     def _init_container(self, client: modal.client.Client, running_app: modal.running_app.RunningApp): ...
     @property
     def registered_functions(self) -> dict[str, modal.functions.Function]:
-        """All modal.Function objects registered on the app."""
+        """All modal.Function objects registered on the app.
+
+        Note: this property is populated only during the build phase, and it is not
+        expected to work when a deplyoed App has been retrieved via `modal.App.lookup`.
+        """
         ...
 
     @property
     def registered_classes(self) -> dict[str, modal.cls.Cls]:
-        """All modal.Cls objects registered on the app."""
+        """All modal.Cls objects registered on the app.
+
+        Note: this property is populated only during the build phase, and it is not
+        expected to work when a deplyoed App has been retrieved via `modal.App.lookup`.
+        """
         ...
 
     @property
     def registered_entrypoints(self) -> dict[str, LocalEntrypoint]:
-        """All local CLI entrypoints registered on the app."""
+        """All local CLI entrypoints registered on the app.
+
+        Note: this property is populated only during the build phase, and it is not
+        expected to work when a deplyoed App has been retrieved via `modal.App.lookup`.
+        """
         ...
 
     @property
     def registered_web_endpoints(self) -> list[str]:
-        """Names of web endpoint (ie. webhook) functions registered on the app."""
+        """Names of web endpoint (ie. webhook) functions registered on the app.
+
+        Note: this property is populated only during the build phase, and it is not
+        expected to work when a deplyoed App has been retrieved via `modal.App.lookup`.
+        """
         ...
 
     def local_entrypoint(

{modal-1.0.6.dev34 → modal-1.0.6.dev36}/modal/client.pyi

@@ -33,7 +33,7 @@ class _Client:
         server_url: str,
         client_type: int,
         credentials: typing.Optional[tuple[str, str]],
-        version: str = "1.0.6.dev34",
+        version: str = "1.0.6.dev36",
     ):
         """mdmd:hidden
         The Modal client object is not intended to be instantiated directly by users.
@@ -163,7 +163,7 @@ class Client:
         server_url: str,
         client_type: int,
         credentials: typing.Optional[tuple[str, str]],
-        version: str = "1.0.6.dev34",
+        version: str = "1.0.6.dev36",
     ):
         """mdmd:hidden
         The Modal client object is not intended to be instantiated directly by users.

{modal-1.0.6.dev34 → modal-1.0.6.dev36}/modal/experimental/__init__.py

@@ -17,8 +17,9 @@ from .._tunnel import _forward as _forward_tunnel
 from .._utils.async_utils import synchronize_api, synchronizer
 from .._utils.deprecation import deprecation_warning
 from .._utils.grpc_utils import retry_transient_errors
+from ..app import _App
 from ..client import _Client
-from ..cls import _Obj
+from ..cls import _Cls, _Obj
 from ..config import logger
 from ..exception import InvalidError
 from ..image import DockerfileSpec, ImageBuilderVersion, _Image, _ImageRegistryConfig
@@ -88,6 +89,51 @@ async def list_deployed_apps(environment_name: str = "", client: Optional[_Clien
     return app_infos
 
 
+@synchronizer.create_blocking
+async def get_app_objects(
+    app_name: str, *, environment_name: Optional[str] = None, client: Optional[_Client] = None
+) -> dict[str, Union[_Function, _Cls]]:
+    """Experimental interface for retrieving a dictionary of the Functions / Clses in an App.
+
+    The return value is a dictionary mapping names to unhydrated Function or Cls objects.
+
+    We plan to support this functionality through a stable API in the future. It's likely that
+    the stable API will look different (it will probably be a method on the App object itself).
+
+    """
+    # This is implemented through a somewhat odd mixture of internal RPCs and public APIs.
+    # While AppGetLayout provides the object ID and metadata for each object in the App, it's
+    # currently somewhere between very awkward and impossible to hydrate a modal.Cls with just
+    # that information, since the "class service function" needs to be loaded first
+    # (and it's not always possible to do that without knowledge of the parameterization).
+    # So instead we just use AppGetLayout to retrieve the names of the Functions / Clsices on
+    # the App and then use the public .from_name constructors to return unhydrated handles.
+
+    # Additionally, since we need to know the environment name to use `.from_name`, and the App's
+    # environment name isn't stored anywhere on the App (and cannot be retrieved via an RPC), the
+    # experimental function is parameterized by an App name while the stable API would instead
+    # be a method on the App itself.
+
+    if client is None:
+        client = await _Client.from_env()
+
+    app = await _App.lookup(app_name, environment_name=environment_name, client=client)
+    req = api_pb2.AppGetLayoutRequest(app_id=app.app_id)
+    app_layout_resp = await retry_transient_errors(client.stub.AppGetLayout, req)
+
+    app_objects: dict[str, Union[_Function, _Cls]] = {}
+
+    for cls_name in app_layout_resp.app_layout.class_ids:
+        app_objects[cls_name] = _Cls.from_name(app_name, cls_name, environment_name=environment_name)
+
+    for func_name in app_layout_resp.app_layout.function_ids:
+        if func_name.endswith(".*"):
+            continue  # TODO explain
+        app_objects[func_name] = _Function.from_name(app_name, func_name, environment_name=environment_name)
+
+    return app_objects
+
+
 @synchronizer.create_blocking
 async def raw_dockerfile_image(
     path: Union[str, Path],

{modal-1.0.6.dev34 → modal-1.0.6.dev36}/modal/functions.pyi

@@ -428,7 +428,7 @@ class Function(
 
     _call_generator: ___call_generator_spec[typing_extensions.Self]
 
-    class __remote_spec(typing_extensions.Protocol[ReturnType_INNER, P_INNER, SUPERSELF]):
+    class __remote_spec(typing_extensions.Protocol[P_INNER, ReturnType_INNER, SUPERSELF]):
         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."""
             ...
@@ -437,7 +437,7 @@ class Function(
             """Calls the function remotely, executing it with the given arguments and returning the execution's result."""
             ...
 
-    remote: __remote_spec[modal._functions.ReturnType, modal._functions.P, typing_extensions.Self]
+    remote: __remote_spec[modal._functions.P, modal._functions.ReturnType, typing_extensions.Self]
 
     class __remote_gen_spec(typing_extensions.Protocol[SUPERSELF]):
         def __call__(self, /, *args, **kwargs) -> typing.Generator[typing.Any, None, None]:
@@ -464,7 +464,7 @@ class Function(
         """
         ...
 
-    class ___experimental_spawn_spec(typing_extensions.Protocol[ReturnType_INNER, P_INNER, SUPERSELF]):
+    class ___experimental_spawn_spec(typing_extensions.Protocol[P_INNER, ReturnType_INNER, SUPERSELF]):
         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.
 
@@ -488,7 +488,7 @@ class Function(
             ...
 
     _experimental_spawn: ___experimental_spawn_spec[
-        modal._functions.ReturnType, modal._functions.P, typing_extensions.Self
+        modal._functions.P, modal._functions.ReturnType, typing_extensions.Self
     ]
 
     class ___spawn_map_inner_spec(typing_extensions.Protocol[P_INNER, SUPERSELF]):
@@ -497,7 +497,7 @@ class Function(
 
     _spawn_map_inner: ___spawn_map_inner_spec[modal._functions.P, typing_extensions.Self]
 
-    class __spawn_spec(typing_extensions.Protocol[ReturnType_INNER, P_INNER, SUPERSELF]):
+    class __spawn_spec(typing_extensions.Protocol[P_INNER, ReturnType_INNER, SUPERSELF]):
         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.
 
@@ -518,7 +518,7 @@ class Function(
             """
             ...
 
-    spawn: __spawn_spec[modal._functions.ReturnType, modal._functions.P, typing_extensions.Self]
+    spawn: __spawn_spec[modal._functions.P, modal._functions.ReturnType, typing_extensions.Self]
 
     def get_raw_f(self) -> collections.abc.Callable[..., typing.Any]:
         """Return the inner Python object wrapped by this Modal Function."""

{modal-1.0.6.dev34 → modal-1.0.6.dev36}/modal.egg-info/PKG-INFO

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

{modal-1.0.6.dev34 → modal-1.0.6.dev36}/modal_proto/api.proto

@@ -2514,6 +2514,9 @@ message Sandbox {
 
   // If set, the sandbox will be created with verbose logging enabled.
   bool verbose = 29;
+
+  // If set, the sandbox will be created with a name.
+  optional string name = 30;
 }
 
 message SandboxCreateRequest {
@@ -2526,6 +2529,15 @@ message SandboxCreateResponse {
   string sandbox_id = 1;
 }
 
+message SandboxGetFromNameRequest {
+  string sandbox_name = 1;
+  string environment_name = 2;
+}
+
+message SandboxGetFromNameResponse {
+  string sandbox_id = 1;
+}
+
 message SandboxGetLogsRequest {
   string sandbox_id = 1;
   FileDescriptor file_descriptor = 2;
@@ -2575,6 +2587,7 @@ message SandboxInfo {
   TaskInfo task_info = 4;
   string app_id = 5;
   repeated SandboxTag tags = 6; // TODO: Not yet exposed in client library.
+  string name = 7;
 
   reserved 2; // modal.client.Sandbox definition
 }
@@ -3397,6 +3410,7 @@ service ModalClient {
 
   // Sandboxes
   rpc SandboxCreate(SandboxCreateRequest) returns (SandboxCreateResponse);
+  rpc SandboxGetFromName(SandboxGetFromNameRequest) returns (SandboxGetFromNameResponse);
   rpc SandboxGetLogs(SandboxGetLogsRequest) returns (stream TaskLogsBatch);
   rpc SandboxGetResourceUsage(SandboxGetResourceUsageRequest) returns (SandboxGetResourceUsageResponse);
   rpc SandboxGetTaskId(SandboxGetTaskIdRequest) returns (SandboxGetTaskIdResponse); // needed for modal container exec

{modal-1.0.6.dev34 → modal-1.0.6.dev36}/modal_proto/api_grpc.py

@@ -442,6 +442,10 @@ class ModalClientBase(abc.ABC):
     async def SandboxCreate(self, stream: 'grpclib.server.Stream[modal_proto.api_pb2.SandboxCreateRequest, modal_proto.api_pb2.SandboxCreateResponse]') -> None:
         pass
 
+    @abc.abstractmethod
+    async def SandboxGetFromName(self, stream: 'grpclib.server.Stream[modal_proto.api_pb2.SandboxGetFromNameRequest, modal_proto.api_pb2.SandboxGetFromNameResponse]') -> None:
+        pass
+
     @abc.abstractmethod
     async def SandboxGetLogs(self, stream: 'grpclib.server.Stream[modal_proto.api_pb2.SandboxGetLogsRequest, modal_proto.api_pb2.TaskLogsBatch]') -> None:
         pass
@@ -1288,6 +1292,12 @@ class ModalClientBase(abc.ABC):
                 modal_proto.api_pb2.SandboxCreateRequest,
                 modal_proto.api_pb2.SandboxCreateResponse,
             ),
+            '/modal.client.ModalClient/SandboxGetFromName': grpclib.const.Handler(
+                self.SandboxGetFromName,
+                grpclib.const.Cardinality.UNARY_UNARY,
+                modal_proto.api_pb2.SandboxGetFromNameRequest,
+                modal_proto.api_pb2.SandboxGetFromNameResponse,
+            ),
             '/modal.client.ModalClient/SandboxGetLogs': grpclib.const.Handler(
                 self.SandboxGetLogs,
                 grpclib.const.Cardinality.UNARY_STREAM,
@@ -2242,6 +2252,12 @@ class ModalClientStub:
             modal_proto.api_pb2.SandboxCreateRequest,
             modal_proto.api_pb2.SandboxCreateResponse,
         )
+        self.SandboxGetFromName = grpclib.client.UnaryUnaryMethod(
+            channel,
+            '/modal.client.ModalClient/SandboxGetFromName',
+            modal_proto.api_pb2.SandboxGetFromNameRequest,
+            modal_proto.api_pb2.SandboxGetFromNameResponse,
+        )
         self.SandboxGetLogs = grpclib.client.UnaryStreamMethod(
             channel,
             '/modal.client.ModalClient/SandboxGetLogs',