modal 1.5.6.dev17__tar.gz → 1.5.6.dev18__tar.gz

{modal-1.5.6.dev17 → modal-1.5.6.dev18}/PKG-INFO

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

{modal-1.5.6.dev17 → modal-1.5.6.dev18}/modal/_workspace.py

@@ -137,17 +137,20 @@ class _WorkspaceProxyTokenManager:
         """mdmd:hidden"""
         self._workspace = workspace
 
-    async def create(self) -> TokenData:
+    async def create(self, name: str = "") -> TokenData:
         """Create a new proxy token for the Workspace.
 
+        Args:
+            name: An optional name to help identify the token.
+
         Examples:
             ```python notest
-            token = modal.Workspace.from_context().proxy_tokens.create()
+            token = modal.Workspace.from_context().proxy_tokens.create(name="production-webhooks")
             print(token.token_id, token.token_secret)
             ```
         """
         await self._workspace.hydrate()
-        resp = await self._workspace.client.stub.WebhookTokenCreate(api_pb2.WebhookTokenCreateRequest())
+        resp = await self._workspace.client.stub.WebhookTokenCreate(api_pb2.WebhookTokenCreateRequest(name=name))
         return TokenData(token_id=resp.token_id, token_secret=resp.token_secret)
 
     async def list(self, environment_name: Optional[str] = None) -> builtins.list[ProxyTokenInfo]:
@@ -180,6 +183,8 @@ class _WorkspaceProxyTokenManager:
                 token_id=token.token_id,
                 created_at=timestamp_to_localized_dt(token.created_at),
                 scoped=token.scoped,
+                name=token.name,
+                created_by=token.created_by.username,
             )
             for token in resp.tokens
         ]

{modal-1.5.6.dev17 → modal-1.5.6.dev18}/modal/cli/workspace.py

@@ -76,15 +76,23 @@ proxy_tokens_cli = ModalGroup(name="proxy-tokens", help=PROXY_TOKENS_HELP_TEXT)
 workspace_cli.add_command(proxy_tokens_cli)
 
 
-@proxy_tokens_cli.command("create", help="Create a proxy token in the current Workspace.")
+@proxy_tokens_cli.command("create")
+@click.option("--name", default="", help="Name to help identify the token.")
 @click.option("--json", is_flag=True, default=False)
-def proxy_tokens_create(*, json: bool = False):
+def proxy_tokens_create(*, name: str = "", json: bool = False):
     """Create a proxy token in the current Workspace.
 
     The new token's ID and secret will be printed to stdout. The secret is only
     shown at creation time and cannot be retrieved later.
+
+    Examples:
+
+    ```
+    modal workspace proxy-tokens create --name production-webhooks
+    modal workspace proxy-tokens create --json
+    ```
     """
-    token = Workspace.from_context().proxy_tokens.create()
+    token = Workspace.from_context().proxy_tokens.create(name=name)
     output_manager = OutputManager.get()
     bearer = f"Bearer {token.token_id}.{token.token_secret}"
     if json:
@@ -104,7 +112,7 @@ def proxy_tokens_create(*, json: bool = False):
         output_manager.print(table)
 
 
-@proxy_tokens_cli.command("list", help="List the proxy tokens of the current Workspace.")
+@proxy_tokens_cli.command("list")
 @click.option(
     "-e",
     "--environment",
@@ -113,39 +121,75 @@ def proxy_tokens_create(*, json: bool = False):
 )
 @click.option("--json", is_flag=True, default=False)
 def proxy_tokens_list(environment: str | None = None, json: bool = False):
+    """List the proxy tokens of the current Workspace.
+
+    Examples:
+
+    ```
+    modal workspace proxy-tokens list
+    modal workspace proxy-tokens list --environment prod
+    modal workspace proxy-tokens list --json
+    ```
+    """
     tokens = Workspace.from_context().proxy_tokens.list(environment_name=environment)
     # Emit a real boolean for JSON output, but a string for the rich table (which can't render a bare bool).
     rows = [
         [
+            token.name,
             token.token_id,
             timestamp_to_localized_str(token.created_at.timestamp(), json),
+            token.created_by,
             token.scoped if json else str(token.scoped),
         ]
         for token in tokens
     ]
-    display_table(["Token ID", "Created at", "Scoped"], rows, json=json)
+    display_table(["Name", "Token ID", "Created at", "Created by", "Scoped"], rows, json=json)
 
 
-@proxy_tokens_cli.command("allow", help="Allow a proxy token to authenticate to an environment.", no_args_is_help=True)
+@proxy_tokens_cli.command("allow", no_args_is_help=True)
 @click.argument("token_id")
 @click.argument("environment_name")
 def proxy_tokens_allow(token_id: str, environment_name: str):
+    """Allow a proxy token to authenticate to an environment.
+
+    Example:
+
+    ```
+    modal workspace proxy-tokens allow wk-123 prod
+    ```
+    """
     Workspace.from_context().proxy_tokens.allow(token_id, environment_name)
     rich.print(f"[green]✓[/green] Allowed proxy token {token_id!r} to authenticate to environment {environment_name!r}")
 
 
-@proxy_tokens_cli.command("revoke", help="Revoke a proxy token's access to an environment.", no_args_is_help=True)
+@proxy_tokens_cli.command("revoke", no_args_is_help=True)
 @click.argument("token_id")
 @click.argument("environment_name")
 def proxy_tokens_revoke(token_id: str, environment_name: str):
+    """Revoke a proxy token's access to an environment.
+
+    Example:
+
+    ```
+    modal workspace proxy-tokens revoke wk-123 prod
+    ```
+    """
     Workspace.from_context().proxy_tokens.revoke(token_id, environment_name)
     rich.print(f"[green]✓[/green] Revoked proxy token {token_id!r} access to environment {environment_name!r}")
 
 
-@proxy_tokens_cli.command("delete", help="Delete a proxy token from the current Workspace.", no_args_is_help=True)
+@proxy_tokens_cli.command("delete", no_args_is_help=True)
 @click.argument("token_id")
 @yes_option
 def proxy_tokens_delete(token_id: str, yes: bool = False):
+    """Delete a proxy token from the current Workspace.
+
+    Example:
+
+    ```
+    modal workspace proxy-tokens delete wk-123
+    ```
+    """
     if not yes:
         message = (
             f"Are you sure you want to delete proxy token {token_id!r}? Requests using this token will be rejected."

{modal-1.5.6.dev17 → modal-1.5.6.dev18}/modal/client.pyi

@@ -77,7 +77,7 @@ class _Client:
         server_url: str,
         client_type: int,
         credentials: typing.Optional[tuple[str, str]],
-        version: str = "1.5.6.dev17",
+        version: str = "1.5.6.dev18",
         *,
         oauth_credentials: typing.Optional[_OAuthCredentials] = None,
     ):
@@ -277,7 +277,7 @@ class Client:
         server_url: str,
         client_type: int,
         credentials: typing.Optional[tuple[str, str]],
-        version: str = "1.5.6.dev17",
+        version: str = "1.5.6.dev18",
         *,
         oauth_credentials: typing.Optional[_OAuthCredentials] = None,
     ):

{modal-1.5.6.dev17 → modal-1.5.6.dev18}/modal/functions.pyi

@@ -653,7 +653,7 @@ class Function(
 
     _call_generator: ___call_generator_spec
 
-    class __remote_spec(typing_extensions.Protocol[P_INNER, ReturnType_INNER]):
+    class __remote_spec(typing_extensions.Protocol[ReturnType_INNER, P_INNER]):
         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.
 
@@ -678,7 +678,7 @@ class Function(
             """
             ...
 
-    remote: __remote_spec[modal._functions.P, modal._functions.ReturnType]
+    remote: __remote_spec[modal._functions.ReturnType, modal._functions.P]
 
     class __remote_gen_spec(typing_extensions.Protocol):
         def __call__(self, /, *args, **kwargs) -> typing.Generator[typing.Any, None, None]:
@@ -728,7 +728,7 @@ class Function(
         """
         ...
 
-    class ___experimental_spawn_spec(typing_extensions.Protocol[P_INNER, ReturnType_INNER]):
+    class ___experimental_spawn_spec(typing_extensions.Protocol[ReturnType_INNER, P_INNER]):
         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.
 
@@ -761,7 +761,7 @@ class Function(
             """
             ...
 
-    _experimental_spawn: ___experimental_spawn_spec[modal._functions.P, modal._functions.ReturnType]
+    _experimental_spawn: ___experimental_spawn_spec[modal._functions.ReturnType, modal._functions.P]
 
     class ___spawn_map_inner_spec(typing_extensions.Protocol[P_INNER]):
         def __call__(self, /, *args: P_INNER.args, **kwargs: P_INNER.kwargs) -> None: ...
@@ -769,7 +769,7 @@ class Function(
 
     _spawn_map_inner: ___spawn_map_inner_spec[modal._functions.P]
 
-    class __spawn_spec(typing_extensions.Protocol[P_INNER, ReturnType_INNER]):
+    class __spawn_spec(typing_extensions.Protocol[ReturnType_INNER, P_INNER]):
         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.
 
@@ -802,7 +802,7 @@ class Function(
             """
             ...
 
-    spawn: __spawn_spec[modal._functions.P, modal._functions.ReturnType]
+    spawn: __spawn_spec[modal._functions.ReturnType, modal._functions.P]
 
     def get_raw_f(self) -> collections.abc.Callable[..., typing.Any]:
         """Return the inner Python object wrapped by this Modal Function.

{modal-1.5.6.dev17 → modal-1.5.6.dev18}/modal/types.py

@@ -310,6 +310,8 @@ class ProxyTokenInfo:
     token_id: str
     created_at: datetime
     scoped: bool
+    name: str = ""
+    created_by: str = ""
 
 
 @dataclass(frozen=True)

{modal-1.5.6.dev17 → modal-1.5.6.dev18}/modal/workspace.pyi

@@ -12,8 +12,12 @@ class ProxyTokenInfo:
     token_id: str
     created_at: datetime.datetime
     scoped: bool
+    name: str
+    created_by: str
 
-    def __init__(self, token_id: str, created_at: datetime.datetime, scoped: bool) -> None:
+    def __init__(
+        self, token_id: str, created_at: datetime.datetime, scoped: bool, name: str = "", created_by: str = ""
+    ) -> None:
         """Initialize self.  See help(type(self)) for accurate signature."""
         ...
 
@@ -395,23 +399,29 @@ class WorkspaceProxyTokenManager:
         ...
 
     class __create_spec(typing_extensions.Protocol):
-        def __call__(self, /) -> modal.types.TokenData:
+        def __call__(self, /, name: str = "") -> modal.types.TokenData:
             """Create a new proxy token for the Workspace.
 
+            Args:
+                name: An optional name to help identify the token.
+
             Examples:
                 ```python notest
-                token = modal.Workspace.from_context().proxy_tokens.create()
+                token = modal.Workspace.from_context().proxy_tokens.create(name="production-webhooks")
                 print(token.token_id, token.token_secret)
                 ```
             """
             ...
 
-        async def aio(self, /) -> modal.types.TokenData:
+        async def aio(self, /, name: str = "") -> modal.types.TokenData:
             """Create a new proxy token for the Workspace.
 
+            Args:
+                name: An optional name to help identify the token.
+
             Examples:
                 ```python notest
-                token = modal.Workspace.from_context().proxy_tokens.create()
+                token = modal.Workspace.from_context().proxy_tokens.create(name="production-webhooks")
                 print(token.token_id, token.token_secret)
                 ```
             """

{modal-1.5.6.dev17 → modal-1.5.6.dev18}/modal.egg-info/PKG-INFO

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