modal 1.2.1.dev7__tar.gz → 1.2.1.dev9__tar.gz

{modal-1.2.1.dev7 → modal-1.2.1.dev9}/PKG-INFO

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

{modal-1.2.1.dev7 → modal-1.2.1.dev9}/modal/app.py

@@ -2,6 +2,7 @@
 import inspect
 import typing
 from collections.abc import AsyncGenerator, Collection, Coroutine, Mapping, Sequence
+from dataclasses import dataclass
 from pathlib import PurePosixPath
 from textwrap import dedent
 from typing import (
@@ -114,6 +115,22 @@ class _FunctionDecoratorType:
     def __call__(self, func): ...
 
 
+@dataclass()
+class _LocalAppState:
+    """All state for apps that's part of the local/definition state"""
+
+    functions: dict[str, _Function]
+    classes: dict[str, _Cls]
+    image_default: Optional[_Image]
+    web_endpoints: list[str]  # Used by the CLI
+    local_entrypoints: dict[str, _LocalEntrypoint]
+    tags: dict[str, str]
+
+    include_source_default: bool
+    secrets_default: Sequence[_Secret]
+    volumes_default: dict[Union[str, PurePosixPath], _Volume]
+
+
 class _App:
     """A Modal App is a group of functions and classes that are deployed together.
 
@@ -151,23 +168,21 @@ class _App:
 
     _name: Optional[str]
     _description: Optional[str]
-    _tags: dict[str, str]
-
-    _functions: dict[str, _Function]
-    _classes: dict[str, _Cls]
 
-    _image: Optional[_Image]
-    _secrets: Sequence[_Secret]
-    _volumes: dict[Union[str, PurePosixPath], _Volume]
-    _web_endpoints: list[str]  # Used by the CLI
-    _local_entrypoints: dict[str, _LocalEntrypoint]
+    _local_state_attr: Optional[_LocalAppState] = None
 
     # Running apps only (container apps or running local)
     _app_id: Optional[str]  # Kept after app finishes
     _running_app: Optional[RunningApp]  # Various app info
     _client: Optional[_Client]
 
-    _include_source_default: Optional[bool] = None
+    @property
+    def _local_state(self) -> _LocalAppState:
+        """For internal use only. Do not use this property directly."""
+
+        if self._local_state_attr is None:
+            raise AttributeError("Local state is not initialized - app is not locally available")
+        return self._local_state_attr
 
     def __init__(
         self,
@@ -196,8 +211,6 @@ class _App:
 
         self._name = name
         self._description = name
-        self._tags = tags or {}
-        self._include_source_default = include_source
 
         check_sequence(secrets, _Secret, "`secrets=` has to be a list or tuple of `modal.Secret` objects")
         validate_volumes(volumes)
@@ -205,16 +218,24 @@ class _App:
         if image is not None and not isinstance(image, _Image):
             raise InvalidError("`image=` has to be a `modal.Image` object")
 
-        self._functions = {}
-        self._classes = {}
-        self._image = image
-        self._secrets = secrets
-        self._volumes = volumes
-        self._local_entrypoints = {}
-        self._web_endpoints = []
+        self._local_state_attr = _LocalAppState(
+            functions={},
+            classes={},
+            image_default=image,
+            secrets_default=secrets,
+            volumes_default=volumes,
+            include_source_default=include_source,
+            web_endpoints=[],
+            local_entrypoints={},
+            tags=tags or {},
+        )
 
+        # Running apps only
         self._app_id = None
         self._running_app = None  # Set inside container, OR during the time an app is running locally
+
+        # Client is special - needed to be set just before the app is "hydrated" or running at the latest
+        # Guaranteed to be set for running apps, but also needed to actually *hydrate* the app and make it running
         self._client = None
 
         # Register this app. This is used to look up the app in the container, when we can't get it from the function
@@ -283,7 +304,8 @@ class _App:
 
         response = await retry_transient_errors(client.stub.AppGetOrCreate, request)
 
-        app = _App(name)
+        app = _App(name)  # TODO: this should probably be a distinct constructor, possibly even a distinct type
+        app._local_state_attr = None  # this is not a locally defined App, so no local state
         app._app_id = response.app_id
         app._client = client
         app._running_app = RunningApp(response.app_id, interactive=False)
@@ -310,18 +332,19 @@ class _App:
         App that is retrieved via `modal.App.lookup`. It is likely to be deprecated in the future.
 
         """
-        return self._image
+        return self._local_state.image_default
 
     @image.setter
     def image(self, value):
         """mdmd:hidden"""
-        self._image = value
+        self._local_state.image_default = value
 
     def _uncreate_all_objects(self):
         # TODO(erikbern): this doesn't unhydrate objects that aren't tagged
-        for obj in self._functions.values():
+        local_state = self._local_state
+        for obj in local_state.functions.values():
             obj._unhydrate()
-        for obj in self._classes.values():
+        for obj in local_state.classes.values():
             obj._unhydrate()
 
     @asynccontextmanager
@@ -457,8 +480,9 @@ class _App:
         return self
 
     def _get_default_image(self):
-        if self._image:
-            return self._image
+        local_state = self._local_state
+        if local_state.image_default:
+            return local_state.image_default
         else:
             return _default_image
 
@@ -473,7 +497,8 @@ class _App:
         return [m for m in all_mounts if m.is_local()]
 
     def _add_function(self, function: _Function, is_web_endpoint: bool):
-        if old_function := self._functions.get(function.tag, None):
+        local_state = self._local_state
+        if old_function := local_state.functions.get(function.tag, None):
             if old_function is function:
                 return  # already added the same exact instance, ignore
 
@@ -484,7 +509,7 @@ class _App:
                     f"[{old_function._info.module_name}].{old_function._info.function_name}"
                     f" with new function [{function._info.module_name}].{function._info.function_name}"
                 )
-        if function.tag in self._classes:
+        if function.tag in local_state.classes:
             logger.warning(f"Warning: tag {function.tag} exists but is overridden by function")
 
         if self._running_app:
@@ -495,9 +520,9 @@ class _App:
                 metadata: Message = self._running_app.object_handle_metadata[object_id]
                 function._hydrate(object_id, self._client, metadata)
 
-        self._functions[function.tag] = function
+        local_state.functions[function.tag] = function
         if is_web_endpoint:
-            self._web_endpoints.append(function.tag)
+            local_state.web_endpoints.append(function.tag)
 
     def _add_class(self, tag: str, cls: _Cls):
         if self._running_app:
@@ -508,7 +533,7 @@ class _App:
                 metadata: Message = self._running_app.object_handle_metadata[object_id]
                 cls._hydrate(object_id, self._client, metadata)
 
-        self._classes[tag] = cls
+        self._local_state.classes[tag] = cls
 
     def _init_container(self, client: _Client, running_app: RunningApp):
         self._app_id = running_app.app_id
@@ -516,18 +541,18 @@ class _App:
         self._client = client
 
         _App._container_app = self
-
+        local_state = self._local_state
         # Hydrate function objects
         for tag, object_id in running_app.function_ids.items():
-            if tag in self._functions:
-                obj = self._functions[tag]
+            if tag in local_state.functions:
+                obj = local_state.functions[tag]
                 handle_metadata = running_app.object_handle_metadata[object_id]
                 obj._hydrate(object_id, client, handle_metadata)
 
         # Hydrate class objects
         for tag, object_id in running_app.class_ids.items():
-            if tag in self._classes:
-                obj = self._classes[tag]
+            if tag in local_state.classes:
+                obj = local_state.classes[tag]
                 handle_metadata = running_app.object_handle_metadata[object_id]
                 obj._hydrate(object_id, client, handle_metadata)
 
@@ -541,7 +566,7 @@ class _App:
         This method is likely to be deprecated in the future in favor of a different
         approach for retrieving the layout of a deployed App.
         """
-        return self._functions
+        return self._local_state.functions
 
     @property
     def registered_classes(self) -> dict[str, _Cls]:
@@ -553,7 +578,7 @@ class _App:
         This method is likely to be deprecated in the future in favor of a different
         approach for retrieving the layout of a deployed App.
         """
-        return self._classes
+        return self._local_state.classes
 
     @property
     def registered_entrypoints(self) -> dict[str, _LocalEntrypoint]:
@@ -564,7 +589,7 @@ class _App:
         expected to work when a deplyoed App has been retrieved via `modal.App.lookup`.
         This method is likely to be deprecated in the future.
         """
-        return self._local_entrypoints
+        return self._local_state.local_entrypoints
 
     @property
     def registered_web_endpoints(self) -> list[str]:
@@ -576,7 +601,7 @@ class _App:
         This method is likely to be deprecated in the future in favor of a different
         approach for retrieving the layout of a deployed App.
         """
-        return self._web_endpoints
+        return self._local_state.web_endpoints
 
     def local_entrypoint(
         self, _warn_parentheses_missing: Any = None, *, name: Optional[str] = None
@@ -637,10 +662,11 @@ class _App:
         def wrapped(raw_f: Callable[..., Any]) -> _LocalEntrypoint:
             info = FunctionInfo(raw_f)
             tag = name if name is not None else raw_f.__qualname__
-            if tag in self._local_entrypoints:
+            local_state = self._local_state
+            if tag in local_state.local_entrypoints:
                 # TODO: get rid of this limitation.
                 raise InvalidError(f"Duplicate local entrypoint name: {tag}. Local entrypoint names must be unique.")
-            entrypoint = self._local_entrypoints[tag] = _LocalEntrypoint(info, self)
+            entrypoint = local_state.local_entrypoints[tag] = _LocalEntrypoint(info, self)
             return entrypoint
 
         return wrapped
@@ -732,7 +758,8 @@ class _App:
         secrets = secrets or []
         if env:
             secrets = [*secrets, _Secret.from_dict(env)]
-        secrets = [*self._secrets, *secrets]
+        local_state = self._local_state
+        secrets = [*local_state.secrets_default, *secrets]
 
         def wrapped(
             f: Union[_PartialFunction, Callable[..., Any], None],
@@ -840,7 +867,7 @@ class _App:
                 is_generator=is_generator,
                 gpu=gpu,
                 network_file_systems=network_file_systems,
-                volumes={**self._volumes, **volumes},
+                volumes={**local_state.volumes_default, **volumes},
                 cpu=cpu,
                 memory=memory,
                 ephemeral_disk=ephemeral_disk,
@@ -866,7 +893,7 @@ class _App:
                 i6pn_enabled=i6pn_enabled,
                 cluster_size=cluster_size,  # Experimental: Clustered functions
                 rdma=rdma,
-                include_source=include_source if include_source is not None else self._include_source_default,
+                include_source=include_source if include_source is not None else local_state.include_source_default,
                 experimental_options={k: str(v) for k, v in (experimental_options or {}).items()},
                 _experimental_proxy_ip=_experimental_proxy_ip,
                 restrict_output=_experimental_restrict_output,
@@ -963,6 +990,7 @@ class _App:
             secrets = [*secrets, _Secret.from_dict(env)]
 
         def wrapper(wrapped_cls: Union[CLS_T, _PartialFunction]) -> CLS_T:
+            local_state = self._local_state
             # Check if the decorated object is a class
             if isinstance(wrapped_cls, _PartialFunction):
                 wrapped_cls.registered = True
@@ -1029,10 +1057,10 @@ class _App:
                 info,
                 app=self,
                 image=image or self._get_default_image(),
-                secrets=[*self._secrets, *secrets],
+                secrets=[*local_state.secrets_default, *secrets],
                 gpu=gpu,
                 network_file_systems=network_file_systems,
-                volumes={**self._volumes, **volumes},
+                volumes={**local_state.volumes_default, **volumes},
                 cpu=cpu,
                 memory=memory,
                 ephemeral_disk=ephemeral_disk,
@@ -1057,7 +1085,7 @@ class _App:
                 i6pn_enabled=i6pn_enabled,
                 cluster_size=cluster_size,
                 rdma=rdma,
-                include_source=include_source if include_source is not None else self._include_source_default,
+                include_source=include_source if include_source is not None else local_state.include_source_default,
                 experimental_options={k: str(v) for k, v in (experimental_options or {}).items()},
                 _experimental_proxy_ip=_experimental_proxy_ip,
                 _experimental_custom_scaling_factor=_experimental_custom_scaling_factor,
@@ -1067,6 +1095,11 @@ class _App:
             self._add_function(cls_func, is_web_endpoint=False)
 
             cls: _Cls = _Cls.from_local(user_cls, self, cls_func)
+            for method_name, partial_function in cls._method_partials.items():
+                if partial_function.params.webhook_config is not None:
+                    full_name = f"{user_cls.__name__}.{method_name}"
+                    local_state.web_endpoints.append(full_name)
+                partial_function.registered = True
 
             tag: str = user_cls.__name__
             self._add_class(tag, cls)
@@ -1102,11 +1135,14 @@ class _App:
         (with this App's tags taking precedence in the case of conflicts).
 
         """
-        for tag, function in other_app._functions.items():
+        other_app_local_state = other_app._local_state
+        this_local_state = self._local_state
+
+        for tag, function in other_app_local_state.functions.items():
             self._add_function(function, False)  # TODO(erikbern): webhook config?
 
-        for tag, cls in other_app._classes.items():
-            existing_cls = self._classes.get(tag)
+        for tag, cls in other_app_local_state.classes.items():
+            existing_cls = this_local_state.classes.get(tag)
             if existing_cls and existing_cls != cls:
                 logger.warning(
                     f"Named app class {tag} with existing value {existing_cls} is being "
@@ -1116,7 +1152,7 @@ class _App:
             self._add_class(tag, cls)
 
         if inherit_tags:
-            self._tags = {**other_app._tags, **self._tags}
+            this_local_state.tags = {**other_app_local_state.tags, **this_local_state.tags}
 
         return self
 
@@ -1132,7 +1168,7 @@ class _App:
 
         """
         # Note that we are requiring the App to be "running" before we set the tags.
-        # Alternatively, we could hold onto the tags (i.e. in `self._tags`) and then pass
+        # Alternatively, we could hold onto the tags (i.e. in `self._local_state.tags`) and then pass
         # then up when AppPublish gets called. I'm not certain we want to support it, though.
         # It might not be obvious to users that `.set_tags()` is eager and has immediate effect
         # when the App is running, but lazy (and potentially ignored) otherwise. There would be

{modal-1.2.1.dev7 → modal-1.2.1.dev9}/modal/app.pyi

@@ -74,6 +74,42 @@ class _FunctionDecoratorType:
         self, func: collections.abc.Callable[P, ReturnType]
     ) -> modal.functions.Function[P, ReturnType, ReturnType]: ...
 
+class _LocalAppState:
+    """All state for apps that's part of the local/definition state"""
+
+    functions: dict[str, modal._functions._Function]
+    classes: dict[str, modal.cls._Cls]
+    image_default: typing.Optional[modal.image._Image]
+    web_endpoints: list[str]
+    local_entrypoints: dict[str, _LocalEntrypoint]
+    tags: dict[str, str]
+    include_source_default: bool
+    secrets_default: collections.abc.Sequence[modal.secret._Secret]
+    volumes_default: dict[typing.Union[str, pathlib.PurePosixPath], modal.volume._Volume]
+
+    def __init__(
+        self,
+        functions: dict[str, modal._functions._Function],
+        classes: dict[str, modal.cls._Cls],
+        image_default: typing.Optional[modal.image._Image],
+        web_endpoints: list[str],
+        local_entrypoints: dict[str, _LocalEntrypoint],
+        tags: dict[str, str],
+        include_source_default: bool,
+        secrets_default: collections.abc.Sequence[modal.secret._Secret],
+        volumes_default: dict[typing.Union[str, pathlib.PurePosixPath], modal.volume._Volume],
+    ) -> None:
+        """Initialize self.  See help(type(self)) for accurate signature."""
+        ...
+
+    def __repr__(self):
+        """Return repr(self)."""
+        ...
+
+    def __eq__(self, other):
+        """Return self==value."""
+        ...
+
 class _App:
     """A Modal App is a group of functions and classes that are deployed together.
 
@@ -110,18 +146,15 @@ class _App:
     _container_app: typing.ClassVar[typing.Optional[_App]]
     _name: typing.Optional[str]
     _description: typing.Optional[str]
-    _tags: dict[str, str]
-    _functions: dict[str, modal._functions._Function]
-    _classes: dict[str, modal.cls._Cls]
-    _image: typing.Optional[modal.image._Image]
-    _secrets: collections.abc.Sequence[modal.secret._Secret]
-    _volumes: dict[typing.Union[str, pathlib.PurePosixPath], modal.volume._Volume]
-    _web_endpoints: list[str]
-    _local_entrypoints: dict[str, _LocalEntrypoint]
+    _local_state_attr: typing.Optional[_LocalAppState]
     _app_id: typing.Optional[str]
     _running_app: typing.Optional[modal.running_app.RunningApp]
     _client: typing.Optional[modal.client._Client]
-    _include_source_default: typing.Optional[bool]
+
+    @property
+    def _local_state(self) -> _LocalAppState:
+        """For internal use only. Do not use this property directly."""
+        ...
 
     def __init__(
         self,
@@ -630,18 +663,10 @@ class App:
     _container_app: typing.ClassVar[typing.Optional[App]]
     _name: typing.Optional[str]
     _description: typing.Optional[str]
-    _tags: dict[str, str]
-    _functions: dict[str, modal.functions.Function]
-    _classes: dict[str, modal.cls.Cls]
-    _image: typing.Optional[modal.image.Image]
-    _secrets: collections.abc.Sequence[modal.secret.Secret]
-    _volumes: dict[typing.Union[str, pathlib.PurePosixPath], modal.volume.Volume]
-    _web_endpoints: list[str]
-    _local_entrypoints: dict[str, LocalEntrypoint]
+    _local_state_attr: typing.Optional[_LocalAppState]
     _app_id: typing.Optional[str]
     _running_app: typing.Optional[modal.running_app.RunningApp]
     _client: typing.Optional[modal.client.Client]
-    _include_source_default: typing.Optional[bool]
 
     def __init__(
         self,
@@ -664,6 +689,11 @@ class App:
         """
         ...
 
+    @property
+    def _local_state(self) -> _LocalAppState:
+        """For internal use only. Do not use this property directly."""
+        ...
+
     @property
     def name(self) -> typing.Optional[str]:
         """The user-provided name of the App."""

{modal-1.2.1.dev7 → modal-1.2.1.dev9}/modal/client.pyi

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

{modal-1.2.1.dev7 → modal-1.2.1.dev9}/modal/cls.py

@@ -577,22 +577,15 @@ More information on class parameterization can be found here: https://modal.com/
         # validate signature
         _Cls.validate_construction_mechanism(user_cls)
 
-        method_partials: dict[str, _PartialFunction] = _find_partial_methods_for_user_cls(
-            user_cls, _PartialFunctionFlags.interface_flags()
-        )
-
-        for method_name, partial_function in method_partials.items():
-            if partial_function.params.webhook_config is not None:
-                full_name = f"{user_cls.__name__}.{method_name}"
-                app._web_endpoints.append(full_name)
-            partial_function.registered = True
-
         # Disable the warning that lifecycle methods are not wrapped
-        for partial_function in _find_partial_methods_for_user_cls(
+        lifecycle_method_partials = _find_partial_methods_for_user_cls(
             user_cls, ~_PartialFunctionFlags.interface_flags()
-        ).values():
+        )
+        for partial_function in lifecycle_method_partials.values():
             partial_function.registered = True
 
+        method_partials = _find_partial_methods_for_user_cls(user_cls, _PartialFunctionFlags.interface_flags())
+
         # Get all callables
         callables: dict[str, Callable] = {
             k: pf.raw_f