modal 0.62.16__py3-none-any.whl → 0.72.11__py3-none-any.whl

modal/partial_function.pyi

@@ -1,141 +1,234 @@
+import collections.abc
 import enum
 import modal.functions
 import modal_proto.api_pb2
 import typing
+import typing_extensions
 
 class _PartialFunctionFlags(enum.IntFlag):
-    FUNCTION: int
-    BUILD: int
-    ENTER_PRE_CHECKPOINT: int
-    ENTER_POST_CHECKPOINT: int
-    EXIT: int
+    FUNCTION: int = 1
+    BUILD: int = 2
+    ENTER_PRE_SNAPSHOT: int = 4
+    ENTER_POST_SNAPSHOT: int = 8
+    EXIT: int = 16
+    BATCHED: int = 32
+    CLUSTERED: int = 64  # Experimental: Clustered functions
 
-    def _generate_next_value_(name, start, count, last_values):
-        ...
+    @staticmethod
+    def all() -> int:
+        return ~_PartialFunctionFlags(0)
 
-    def __new__(cls, value):
-        ...
+P = typing_extensions.ParamSpec("P")
 
+ReturnType = typing.TypeVar("ReturnType", covariant=True)
 
-class _PartialFunction:
-    raw_f: typing.Callable[..., typing.Any]
-    flags: _PartialFunctionFlags
-    webhook_config: typing.Union[modal_proto.api_pb2.WebhookConfig, None]
-    is_generator: typing.Union[bool, None]
-    keep_warm: typing.Union[int, None]
-
-    def __init__(self, raw_f: typing.Callable[..., typing.Any], flags: _PartialFunctionFlags, webhook_config: typing.Union[modal_proto.api_pb2.WebhookConfig, None] = None, is_generator: typing.Union[bool, None] = None, keep_warm: typing.Union[int, None] = None):
-        ...
-
-    def __get__(self, obj, objtype=None) -> modal.functions._Function:
-        ...
-
-    def __del__(self):
-        ...
+OriginalReturnType = typing.TypeVar("OriginalReturnType", covariant=True)
 
-    def add_flags(self, flags) -> _PartialFunction:
-        ...
-
-
-class PartialFunction:
-    raw_f: typing.Callable[..., typing.Any]
+class _PartialFunction(typing.Generic[P, ReturnType, OriginalReturnType]):
+    raw_f: typing.Callable[P, ReturnType]
     flags: _PartialFunctionFlags
-    webhook_config: typing.Union[modal_proto.api_pb2.WebhookConfig, None]
-    is_generator: typing.Union[bool, None]
-    keep_warm: typing.Union[int, None]
-
-    def __init__(self, raw_f: typing.Callable[..., typing.Any], flags: _PartialFunctionFlags, webhook_config: typing.Union[modal_proto.api_pb2.WebhookConfig, None] = None, is_generator: typing.Union[bool, None] = None, keep_warm: typing.Union[int, None] = None):
-        ...
-
-    def __get__(self, obj, objtype=None) -> modal.functions.Function:
-        ...
-
-    def __del__(self):
-        ...
-
-    def add_flags(self, flags) -> PartialFunction:
-        ...
-
-
-def _find_partial_methods_for_cls(user_cls: typing.Type, flags: _PartialFunctionFlags) -> typing.Dict[str, _PartialFunction]:
-    ...
-
-
-def _find_callables_for_cls(user_cls: typing.Type, flags: _PartialFunctionFlags) -> typing.Dict[str, typing.Callable]:
-    ...
-
-
-def _find_callables_for_obj(user_obj: typing.Any, flags: _PartialFunctionFlags) -> typing.Dict[str, typing.Callable]:
-    ...
-
-
-def _method(_warn_parentheses_missing=None, *, is_generator: typing.Union[bool, None] = None, keep_warm: typing.Union[int, None] = None) -> typing.Callable[[typing.Callable[..., typing.Any]], _PartialFunction]:
-    ...
-
-
-def _parse_custom_domains(custom_domains: typing.Union[typing.Iterable[str], None] = None) -> typing.List[modal_proto.api_pb2.CustomDomainConfig]:
-    ...
-
-
-def _web_endpoint(_warn_parentheses_missing=None, *, method: str = 'GET', label: typing.Union[str, None] = None, wait_for_response: bool = True, custom_domains: typing.Union[typing.Iterable[str], None] = None) -> typing.Callable[[typing.Callable[..., typing.Any]], _PartialFunction]:
-    ...
-
-
-def _asgi_app(_warn_parentheses_missing=None, *, label: typing.Union[str, None] = None, wait_for_response: bool = True, custom_domains: typing.Union[typing.Iterable[str], None] = None) -> typing.Callable[[typing.Callable[..., typing.Any]], _PartialFunction]:
-    ...
-
-
-def _wsgi_app(_warn_parentheses_missing=None, *, label: typing.Union[str, None] = None, wait_for_response: bool = True, custom_domains: typing.Union[typing.Iterable[str], None] = None) -> typing.Callable[[typing.Callable[..., typing.Any]], _PartialFunction]:
-    ...
-
-
-def _web_server(port: int, *, startup_timeout: float = 5.0, label: typing.Union[str, None] = None, custom_domains: typing.Union[typing.Iterable[str], None] = None) -> typing.Callable[[typing.Callable[..., typing.Any]], _PartialFunction]:
-    ...
-
-
-def _disallow_wrapping_method(f: _PartialFunction, wrapper: str) -> None:
-    ...
-
-
-def _build(_warn_parentheses_missing=None) -> typing.Callable[[typing.Union[typing.Callable[[typing.Any], typing.Any], _PartialFunction]], _PartialFunction]:
-    ...
-
-
-def _enter(_warn_parentheses_missing=None, *, snap: bool = False) -> typing.Callable[[typing.Union[typing.Callable[[typing.Any], typing.Any], _PartialFunction]], _PartialFunction]:
-    ...
-
-
-def _exit(_warn_parentheses_missing=None) -> typing.Callable[[typing.Union[typing.Callable[[typing.Any, typing.Union[typing.Type[BaseException], None], typing.Union[BaseException, None], typing.Any], None], typing.Callable[[typing.Any], None]]], _PartialFunction]:
-    ...
-
-
-def method(_warn_parentheses_missing=None, *, is_generator: typing.Union[bool, None] = None, keep_warm: typing.Union[int, None] = None) -> typing.Callable[[typing.Callable[..., typing.Any]], PartialFunction]:
-    ...
-
-
-def web_endpoint(_warn_parentheses_missing=None, *, method: str = 'GET', label: typing.Union[str, None] = None, wait_for_response: bool = True, custom_domains: typing.Union[typing.Iterable[str], None] = None) -> typing.Callable[[typing.Callable[..., typing.Any]], PartialFunction]:
-    ...
-
-
-def asgi_app(_warn_parentheses_missing=None, *, label: typing.Union[str, None] = None, wait_for_response: bool = True, custom_domains: typing.Union[typing.Iterable[str], None] = None) -> typing.Callable[[typing.Callable[..., typing.Any]], PartialFunction]:
-    ...
-
-
-def wsgi_app(_warn_parentheses_missing=None, *, label: typing.Union[str, None] = None, wait_for_response: bool = True, custom_domains: typing.Union[typing.Iterable[str], None] = None) -> typing.Callable[[typing.Callable[..., typing.Any]], PartialFunction]:
-    ...
-
-
-def web_server(port: int, *, startup_timeout: float = 5.0, label: typing.Union[str, None] = None, custom_domains: typing.Union[typing.Iterable[str], None] = None) -> typing.Callable[[typing.Callable[..., typing.Any]], PartialFunction]:
-    ...
-
-
-def build(_warn_parentheses_missing=None) -> typing.Callable[[typing.Union[typing.Callable[[typing.Any], typing.Any], PartialFunction]], PartialFunction]:
-    ...
-
-
-def enter(_warn_parentheses_missing=None, *, snap: bool = False) -> typing.Callable[[typing.Union[typing.Callable[[typing.Any], typing.Any], PartialFunction]], PartialFunction]:
-    ...
-
-
-def exit(_warn_parentheses_missing=None) -> typing.Callable[[typing.Union[typing.Callable[[typing.Any, typing.Union[typing.Type[BaseException], None], typing.Union[BaseException, None], typing.Any], None], typing.Callable[[typing.Any], None]]], PartialFunction]:
-    ...
+    webhook_config: typing.Optional[modal_proto.api_pb2.WebhookConfig]
+    is_generator: bool
+    keep_warm: typing.Optional[int]
+    batch_max_size: typing.Optional[int]
+    batch_wait_ms: typing.Optional[int]
+    force_build: bool
+    cluster_size: typing.Optional[int]
+    build_timeout: typing.Optional[int]
+
+    def __init__(
+        self,
+        raw_f: typing.Callable[P, ReturnType],
+        flags: _PartialFunctionFlags,
+        webhook_config: typing.Optional[modal_proto.api_pb2.WebhookConfig] = None,
+        is_generator: typing.Optional[bool] = None,
+        keep_warm: typing.Optional[int] = None,
+        batch_max_size: typing.Optional[int] = None,
+        batch_wait_ms: typing.Optional[int] = None,
+        cluster_size: typing.Optional[int] = None,
+        force_build: bool = False,
+        build_timeout: typing.Optional[int] = None,
+    ): ...
+    def __get__(self, obj, objtype=None) -> modal.functions._Function[P, ReturnType, OriginalReturnType]: ...
+    def __del__(self): ...
+    def add_flags(self, flags) -> _PartialFunction: ...
+
+class PartialFunction(typing.Generic[P, ReturnType, OriginalReturnType]):
+    raw_f: typing.Callable[P, ReturnType]
+    flags: _PartialFunctionFlags
+    webhook_config: typing.Optional[modal_proto.api_pb2.WebhookConfig]
+    is_generator: bool
+    keep_warm: typing.Optional[int]
+    batch_max_size: typing.Optional[int]
+    batch_wait_ms: typing.Optional[int]
+    force_build: bool
+    cluster_size: typing.Optional[int]
+    build_timeout: typing.Optional[int]
+
+    def __init__(
+        self,
+        raw_f: typing.Callable[P, ReturnType],
+        flags: _PartialFunctionFlags,
+        webhook_config: typing.Optional[modal_proto.api_pb2.WebhookConfig] = None,
+        is_generator: typing.Optional[bool] = None,
+        keep_warm: typing.Optional[int] = None,
+        batch_max_size: typing.Optional[int] = None,
+        batch_wait_ms: typing.Optional[int] = None,
+        cluster_size: typing.Optional[int] = None,
+        force_build: bool = False,
+        build_timeout: typing.Optional[int] = None,
+    ): ...
+    def __get__(self, obj, objtype=None) -> modal.functions.Function[P, ReturnType, OriginalReturnType]: ...
+    def __del__(self): ...
+    def add_flags(self, flags) -> PartialFunction: ...
+
+def _find_partial_methods_for_user_cls(user_cls: type[typing.Any], flags: int) -> dict[str, _PartialFunction]: ...
+def _find_callables_for_obj(user_obj: typing.Any, flags: int) -> dict[str, typing.Callable[..., typing.Any]]: ...
+
+class _MethodDecoratorType:
+    @typing.overload
+    def __call__(
+        self, func: PartialFunction[typing_extensions.Concatenate[typing.Any, P], ReturnType, OriginalReturnType]
+    ) -> PartialFunction[P, ReturnType, OriginalReturnType]: ...
+    @typing.overload
+    def __call__(
+        self,
+        func: typing.Callable[
+            typing_extensions.Concatenate[typing.Any, P], collections.abc.Coroutine[typing.Any, typing.Any, ReturnType]
+        ],
+    ) -> PartialFunction[P, ReturnType, collections.abc.Coroutine[typing.Any, typing.Any, ReturnType]]: ...
+    @typing.overload
+    def __call__(
+        self, func: typing.Callable[typing_extensions.Concatenate[typing.Any, P], ReturnType]
+    ) -> PartialFunction[P, ReturnType, ReturnType]: ...
+
+def _method(
+    _warn_parentheses_missing=None,
+    *,
+    is_generator: typing.Optional[bool] = None,
+    keep_warm: typing.Optional[int] = None,
+) -> _MethodDecoratorType: ...
+def _parse_custom_domains(
+    custom_domains: typing.Optional[collections.abc.Iterable[str]] = None,
+) -> list[modal_proto.api_pb2.CustomDomainConfig]: ...
+def _web_endpoint(
+    _warn_parentheses_missing=None,
+    *,
+    method: str = "GET",
+    label: typing.Optional[str] = None,
+    docs: bool = False,
+    custom_domains: typing.Optional[collections.abc.Iterable[str]] = None,
+    requires_proxy_auth: bool = False,
+    wait_for_response: bool = True,
+) -> typing.Callable[[typing.Callable[P, ReturnType]], _PartialFunction[P, ReturnType, ReturnType]]: ...
+def _asgi_app(
+    _warn_parentheses_missing=None,
+    *,
+    label: typing.Optional[str] = None,
+    custom_domains: typing.Optional[collections.abc.Iterable[str]] = None,
+    requires_proxy_auth: bool = False,
+    wait_for_response: bool = True,
+) -> typing.Callable[[typing.Callable[..., typing.Any]], _PartialFunction]: ...
+def _wsgi_app(
+    _warn_parentheses_missing=None,
+    *,
+    label: typing.Optional[str] = None,
+    custom_domains: typing.Optional[collections.abc.Iterable[str]] = None,
+    requires_proxy_auth: bool = False,
+    wait_for_response: bool = True,
+) -> typing.Callable[[typing.Callable[..., typing.Any]], _PartialFunction]: ...
+def _web_server(
+    port: int,
+    *,
+    startup_timeout: float = 5.0,
+    label: typing.Optional[str] = None,
+    custom_domains: typing.Optional[collections.abc.Iterable[str]] = None,
+    requires_proxy_auth: bool = False,
+) -> typing.Callable[[typing.Callable[..., typing.Any]], _PartialFunction]: ...
+def _disallow_wrapping_method(f: _PartialFunction, wrapper: str) -> None: ...
+def _build(
+    _warn_parentheses_missing=None, *, force: bool = False, timeout: int = 86400
+) -> typing.Callable[[typing.Union[typing.Callable[[typing.Any], typing.Any], _PartialFunction]], _PartialFunction]: ...
+def _enter(
+    _warn_parentheses_missing=None, *, snap: bool = False
+) -> typing.Callable[[typing.Union[typing.Callable[[typing.Any], typing.Any], _PartialFunction]], _PartialFunction]: ...
+def _exit(
+    _warn_parentheses_missing=None,
+) -> typing.Callable[
+    [
+        typing.Union[
+            typing.Callable[
+                [typing.Any, typing.Optional[type[BaseException]], typing.Optional[BaseException], typing.Any],
+                typing.Any,
+            ],
+            typing.Callable[[typing.Any], typing.Any],
+        ]
+    ],
+    _PartialFunction,
+]: ...
+def _batched(
+    _warn_parentheses_missing=None, *, max_batch_size: int, wait_ms: int
+) -> typing.Callable[[typing.Callable[..., typing.Any]], _PartialFunction]: ...
+def method(
+    _warn_parentheses_missing=None,
+    *,
+    is_generator: typing.Optional[bool] = None,
+    keep_warm: typing.Optional[int] = None,
+) -> _MethodDecoratorType: ...
+def web_endpoint(
+    _warn_parentheses_missing=None,
+    *,
+    method: str = "GET",
+    label: typing.Optional[str] = None,
+    docs: bool = False,
+    custom_domains: typing.Optional[collections.abc.Iterable[str]] = None,
+    requires_proxy_auth: bool = False,
+    wait_for_response: bool = True,
+) -> typing.Callable[[typing.Callable[P, ReturnType]], PartialFunction[P, ReturnType, ReturnType]]: ...
+def asgi_app(
+    _warn_parentheses_missing=None,
+    *,
+    label: typing.Optional[str] = None,
+    custom_domains: typing.Optional[collections.abc.Iterable[str]] = None,
+    requires_proxy_auth: bool = False,
+    wait_for_response: bool = True,
+) -> typing.Callable[[typing.Callable[..., typing.Any]], PartialFunction]: ...
+def wsgi_app(
+    _warn_parentheses_missing=None,
+    *,
+    label: typing.Optional[str] = None,
+    custom_domains: typing.Optional[collections.abc.Iterable[str]] = None,
+    requires_proxy_auth: bool = False,
+    wait_for_response: bool = True,
+) -> typing.Callable[[typing.Callable[..., typing.Any]], PartialFunction]: ...
+def web_server(
+    port: int,
+    *,
+    startup_timeout: float = 5.0,
+    label: typing.Optional[str] = None,
+    custom_domains: typing.Optional[collections.abc.Iterable[str]] = None,
+    requires_proxy_auth: bool = False,
+) -> typing.Callable[[typing.Callable[..., typing.Any]], PartialFunction]: ...
+def build(
+    _warn_parentheses_missing=None, *, force: bool = False, timeout: int = 86400
+) -> typing.Callable[[typing.Union[typing.Callable[[typing.Any], typing.Any], PartialFunction]], PartialFunction]: ...
+def enter(
+    _warn_parentheses_missing=None, *, snap: bool = False
+) -> typing.Callable[[typing.Union[typing.Callable[[typing.Any], typing.Any], PartialFunction]], PartialFunction]: ...
+def exit(
+    _warn_parentheses_missing=None,
+) -> typing.Callable[
+    [
+        typing.Union[
+            typing.Callable[
+                [typing.Any, typing.Optional[type[BaseException]], typing.Optional[BaseException], typing.Any],
+                typing.Any,
+            ],
+            typing.Callable[[typing.Any], typing.Any],
+        ]
+    ],
+    PartialFunction,
+]: ...
+def batched(
+    _warn_parentheses_missing=None, *, max_batch_size: int, wait_ms: int
+) -> typing.Callable[[typing.Callable[..., typing.Any]], PartialFunction]: ...

modal/proxy.py

@@ -9,28 +9,31 @@ from .object import _get_environment_name, _Object
 
 
 class _Proxy(_Object, type_prefix="pr"):
-    """
-    Proxy objects are used to setup secure tunnel connections to a private remote address, for example
-    a database.
+    """Proxy objects give your Modal containers a static outbound IP address.
 
-    Currently `modal.Proxy` objects must be setup with the assistance of Modal staff. If you require a proxy
-    please contact us.
+    This can be used for connecting to a remote address with network whitelist, for example
+    a database. See [the guide](/docs/guide/proxy-ips) for more information.
     """
 
     @staticmethod
     def from_name(
-        label: str,
-        namespace=api_pb2.DEPLOYMENT_NAMESPACE_WORKSPACE,
+        name: str,
         environment_name: Optional[str] = None,
     ) -> "_Proxy":
+        """Reference a Proxy by its name.
+
+        In contrast to most other Modal objects, new Proxy objects must be
+        provisioned via the Dashboard and cannot be created on the fly from code.
+
+        """
+
         async def _load(self: _Proxy, resolver: Resolver, existing_object_id: Optional[str]):
-            req = api_pb2.ProxyGetOrCreateRequest(
-                deployment_name=label,
-                namespace=namespace,
+            req = api_pb2.ProxyGetRequest(
+                name=name,
                 environment_name=_get_environment_name(environment_name, resolver),
             )
-            response = await resolver.client.stub.ProxyGetOrCreate(req)
-            self._hydrate(response.proxy_id, resolver.client, None)
+            response: api_pb2.ProxyGetResponse = await resolver.client.stub.ProxyGet(req)
+            self._hydrate(response.proxy.proxy_id, resolver.client, None)
 
         return _Proxy._from_loader(_load, "Proxy()", is_another_app=True)
 

modal/proxy.pyi

@@ -3,14 +3,9 @@ import typing
 
 class _Proxy(modal.object._Object):
     @staticmethod
-    def from_name(label: str, namespace=1, environment_name: typing.Union[str, None] = None) -> _Proxy:
-        ...
-
+    def from_name(name: str, environment_name: typing.Optional[str] = None) -> _Proxy: ...
 
 class Proxy(modal.object.Object):
-    def __init__(self, *args, **kwargs):
-        ...
-
+    def __init__(self, *args, **kwargs): ...
     @staticmethod
-    def from_name(label: str, namespace=1, environment_name: typing.Union[str, None] = None) -> Proxy:
-        ...
+    def from_name(name: str, environment_name: typing.Optional[str] = None) -> Proxy: ...