modal 1.1.5.dev81__tar.gz → 1.1.5.dev82__tar.gz

{modal-1.1.5.dev81 → modal-1.1.5.dev82}/PKG-INFO

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

{modal-1.1.5.dev81 → modal-1.1.5.dev82}/modal/app.py

@@ -227,7 +227,12 @@ class _App:
 
     @property
     def is_interactive(self) -> bool:
-        """Whether the current app for the app is running in interactive mode."""
+        """mdmd:hidden
+        Whether the current app for the app is running in interactive mode.
+
+        Note: this method will likely be deprecated in the future.
+
+        """
         # return self._name
         if self._running_app:
             return self._running_app.interactive
@@ -285,6 +290,11 @@ class _App:
         return app
 
     def set_description(self, description: str):
+        """mdmd:hidden
+        Set the description of the App before it starts running.
+
+        Note: we don't recommend using the method and may deprecate it in the future.
+        """
         self._description = description
 
     def _validate_blueprint_value(self, key: str, value: Any):
@@ -293,10 +303,18 @@ class _App:
 
     @property
     def image(self) -> _Image:
+        """mdmd:hidden
+        Retrieve the Image that will be used as the default for any Functions registered to the App.
+
+        Note: This property is only relevant in the build phase and won't be populated on a deployed
+        App that is retrieved via `modal.App.lookup`. It is likely to be deprecated in the future.
+
+        """
         return self._image
 
     @image.setter
     def image(self, value):
+        """mdmd:hidden"""
         self._image = value
 
     def _uncreate_all_objects(self):
@@ -515,37 +533,48 @@ class _App:
 
     @property
     def registered_functions(self) -> dict[str, _Function]:
-        """All modal.Function objects registered on the app.
+        """mdmd:hidden
+        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`.
+        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
 
     @property
     def registered_classes(self) -> dict[str, _Cls]:
-        """All modal.Cls objects registered on the app.
+        """mdmd:hidden
+        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`.
+        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
 
     @property
     def registered_entrypoints(self) -> dict[str, _LocalEntrypoint]:
-        """All local CLI entrypoints registered on the app.
+        """mdmd:hidden
+        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`.
+        This method is likely to be deprecated in the future.
         """
         return self._local_entrypoints
 
     @property
     def registered_web_endpoints(self) -> list[str]:
-        """Names of web endpoint (ie. webhook) functions registered on the app.
+        """mdmd:hidden
+        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`.
+        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
 

{modal-1.1.5.dev81 → modal-1.1.5.dev82}/modal/app.pyi

@@ -151,7 +151,11 @@ class _App:
 
     @property
     def is_interactive(self) -> bool:
-        """Whether the current app for the app is running in interactive mode."""
+        """mdmd:hidden
+        Whether the current app for the app is running in interactive mode.
+
+        Note: this method will likely be deprecated in the future.
+        """
         ...
 
     @property
@@ -185,12 +189,30 @@ class _App:
         """
         ...
 
-    def set_description(self, description: str): ...
+    def set_description(self, description: str):
+        """mdmd:hidden
+        Set the description of the App before it starts running.
+
+        Note: we don't recommend using the method and may deprecate it in the future.
+        """
+        ...
+
     def _validate_blueprint_value(self, key: str, value: typing.Any): ...
     @property
-    def image(self) -> modal.image._Image: ...
+    def image(self) -> modal.image._Image:
+        """mdmd:hidden
+        Retrieve the Image that will be used as the default for any Functions registered to the App.
+
+        Note: This property is only relevant in the build phase and won't be populated on a deployed
+        App that is retrieved via `modal.App.lookup`. It is likely to be deprecated in the future.
+        """
+        ...
+
     @image.setter
-    def image(self, value): ...
+    def image(self, value):
+        """mdmd:hidden"""
+        ...
+
     def _uncreate_all_objects(self): ...
     def _set_local_app(
         self, client: modal.client._Client, running_app: modal.running_app.RunningApp
@@ -301,37 +323,48 @@ 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.
+        """mdmd:hidden
+        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`.
+        This method is likely to be deprecated in the future in favor of a different
+        approach for retrieving the layout of a deployed App.
         """
         ...
 
     @property
     def registered_classes(self) -> dict[str, modal.cls._Cls]:
-        """All modal.Cls objects registered on the app.
+        """mdmd:hidden
+        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`.
+        This method is likely to be deprecated in the future in favor of a different
+        approach for retrieving the layout of a deployed App.
         """
         ...
 
     @property
     def registered_entrypoints(self) -> dict[str, _LocalEntrypoint]:
-        """All local CLI entrypoints registered on the app.
+        """mdmd:hidden
+        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`.
+        This method is likely to be deprecated in the future.
         """
         ...
 
     @property
     def registered_web_endpoints(self) -> list[str]:
-        """Names of web endpoint (ie. webhook) functions registered on the app.
+        """mdmd:hidden
+        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`.
+        This method is likely to be deprecated in the future in favor of a different
+        approach for retrieving the layout of a deployed App.
         """
         ...
 
@@ -638,7 +671,11 @@ class App:
 
     @property
     def is_interactive(self) -> bool:
-        """Whether the current app for the app is running in interactive mode."""
+        """mdmd:hidden
+        Whether the current app for the app is running in interactive mode.
+
+        Note: this method will likely be deprecated in the future.
+        """
         ...
 
     @property
@@ -698,12 +735,30 @@ class App:
 
     lookup: __lookup_spec
 
-    def set_description(self, description: str): ...
+    def set_description(self, description: str):
+        """mdmd:hidden
+        Set the description of the App before it starts running.
+
+        Note: we don't recommend using the method and may deprecate it in the future.
+        """
+        ...
+
     def _validate_blueprint_value(self, key: str, value: typing.Any): ...
     @property
-    def image(self) -> modal.image.Image: ...
+    def image(self) -> modal.image.Image:
+        """mdmd:hidden
+        Retrieve the Image that will be used as the default for any Functions registered to the App.
+
+        Note: This property is only relevant in the build phase and won't be populated on a deployed
+        App that is retrieved via `modal.App.lookup`. It is likely to be deprecated in the future.
+        """
+        ...
+
     @image.setter
-    def image(self, value): ...
+    def image(self, value):
+        """mdmd:hidden"""
+        ...
+
     def _uncreate_all_objects(self): ...
 
     class ___set_local_app_spec(typing_extensions.Protocol[SUPERSELF]):
@@ -931,37 +986,48 @@ 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.
+        """mdmd:hidden
+        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`.
+        This method is likely to be deprecated in the future in favor of a different
+        approach for retrieving the layout of a deployed App.
         """
         ...
 
     @property
     def registered_classes(self) -> dict[str, modal.cls.Cls]:
-        """All modal.Cls objects registered on the app.
+        """mdmd:hidden
+        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`.
+        This method is likely to be deprecated in the future in favor of a different
+        approach for retrieving the layout of a deployed App.
         """
         ...
 
     @property
     def registered_entrypoints(self) -> dict[str, LocalEntrypoint]:
-        """All local CLI entrypoints registered on the app.
+        """mdmd:hidden
+        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`.
+        This method is likely to be deprecated in the future.
         """
         ...
 
     @property
     def registered_web_endpoints(self) -> list[str]:
-        """Names of web endpoint (ie. webhook) functions registered on the app.
+        """mdmd:hidden
+        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`.
+        This method is likely to be deprecated in the future in favor of a different
+        approach for retrieving the layout of a deployed App.
         """
         ...
 

{modal-1.1.5.dev81 → modal-1.1.5.dev82}/modal/client.pyi

@@ -33,7 +33,7 @@ class _Client:
         server_url: str,
         client_type: int,
         credentials: typing.Optional[tuple[str, str]],
-        version: str = "1.1.5.dev81",
+        version: str = "1.1.5.dev82",
     ):
         """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.1.5.dev81",
+        version: str = "1.1.5.dev82",
     ):
         """mdmd:hidden
         The Modal client object is not intended to be instantiated directly by users.

{modal-1.1.5.dev81 → modal-1.1.5.dev82}/modal.egg-info/PKG-INFO

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

{modal-1.1.5.dev81 → modal-1.1.5.dev82}/modal_version/__init__.py

@@ -1,4 +1,4 @@
 # Copyright Modal Labs 2025
 """Supplies the current version of the modal client library."""
 
-__version__ = "1.1.5.dev81"
+__version__ = "1.1.5.dev82"