fal 0.12.4__tar.gz → 0.12.6__tar.gz

{fal-0.12.4 → fal-0.12.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fal
-Version: 0.12.4
+Version: 0.12.6
 Summary: fal is an easy-to-use Serverless Python Framework
 Author: Features & Labels
 Author-email: hello@fal.ai
@@ -29,15 +29,19 @@ Requires-Dist: pathspec (>=0.11.1,<0.12.0)
 Requires-Dist: pillow (>=10.2.0,<11.0.0)
 Requires-Dist: portalocker (>=2.7.0,<3.0.0)
 Requires-Dist: pydantic (<2.0)
-Requires-Dist: pyjwt (>=2.8.0,<3.0.0)
+Requires-Dist: pyjwt[crypto] (>=2.8.0,<3.0.0)
 Requires-Dist: python-dateutil (>=2.8.0,<3.0.0)
 Requires-Dist: rich (>=13.3.2,<14.0.0)
+Requires-Dist: rich_click
 Requires-Dist: structlog (>=22.3.0,<23.0.0)
 Requires-Dist: types-python-dateutil (>=2.8.0,<3.0.0)
 Requires-Dist: typing-extensions (>=4.7.1,<5.0.0)
 Requires-Dist: websockets (>=12.0,<13.0)
 Description-Content-Type: text/markdown
 
+[![PyPI](https://img.shields.io/pypi/v/fal.svg?logo=PyPI)](https://pypi.org/project/fal)
+[![Tests](https://img.shields.io/github/actions/workflow/status/fal-ai/fal/integration_tests.yaml?label=Tests)](https://github.com/fal-ai/fal/actions)
+
 # fal
 
 fal is a serverless Python runtime that lets you run and scale code in the cloud with no infra management.

{fal-0.12.4 → fal-0.12.6}/README.md

@@ -1,3 +1,6 @@
+[![PyPI](https://img.shields.io/pypi/v/fal.svg?logo=PyPI)](https://pypi.org/project/fal)
+[![Tests](https://img.shields.io/github/actions/workflow/status/fal-ai/fal/integration_tests.yaml?label=Tests)](https://github.com/fal-ai/fal/actions)
+
 # fal
 
 fal is a serverless Python runtime that lets you run and scale code in the cloud with no infra management.

{fal-0.12.4 → fal-0.12.6}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "fal"
-version = "0.12.4"
+version = "0.12.6"
 description = "fal is an easy-to-use Serverless Python Framework"
 authors = ["Features & Labels <hello@fal.ai>"]
 readme = "README.md"
@@ -24,6 +24,7 @@ grpc-interceptor = "^0.15.0"
 colorama = "^0.4.6"
 portalocker = "^2.7.0"
 rich = "^13.3.2"
+rich_click = "*"
 packaging = ">=21.3"
 pathspec = "^0.11.1"
 pydantic = "<2.0"
@@ -42,7 +43,7 @@ importlib-metadata = { version = ">=4.4", python = "<3.10" }
 msgpack = "^1.0.7"
 websockets = "^12.0"
 pillow = "^10.2.0"
-pyjwt = "^2.8.0"
+pyjwt = { version = "^2.8.0", extras = ["crypto"] }
 
 [tool.poetry.group.dev.dependencies]
 openapi-python-client = "^0.14.1"

{fal-0.12.4 → fal-0.12.6}/setup.py

@@ -52,9 +52,10 @@ install_requires = \
  'pillow>=10.2.0,<11.0.0',
  'portalocker>=2.7.0,<3.0.0',
  'pydantic<2.0',
- 'pyjwt>=2.8.0,<3.0.0',
+ 'pyjwt[crypto]>=2.8.0,<3.0.0',
  'python-dateutil>=2.8.0,<3.0.0',
  'rich>=13.3.2,<14.0.0',
+ 'rich_click',
  'structlog>=22.3.0,<23.0.0',
  'types-python-dateutil>=2.8.0,<3.0.0',
  'typing-extensions>=4.7.1,<5.0.0',
@@ -68,9 +69,9 @@ entry_points = \
 
 setup_kwargs = {
     'name': 'fal',
-    'version': '0.12.4',
+    'version': '0.12.6',
     'description': 'fal is an easy-to-use Serverless Python Framework',
-    'long_description': '# fal\n\nfal is a serverless Python runtime that lets you run and scale code in the cloud with no infra management.\n\nWith fal, you can build pipelines, serve ML models and scale them up to many users. You scale down to 0 when you don\'t use any resources.\n\n## Quickstart\n\nFirst, you need to install the `fal` package. You can do so using pip:\n```shell\npip install fal\n```\n\nThen you need to authenticate:\n```shell\nfal auth login\n```\n\nYou can also use fal keys that you can get from [our dashboard](https://fal.ai/dashboard/keys).\n\nNow can use the fal package in your Python scripts as follows:\n\n```py\nimport fal\n\n@fal.function(\n    "virtualenv",\n    requirements=["pyjokes"],\n)\ndef tell_joke() -> str:\n    import pyjokes\n\n    joke = pyjokes.get_joke()\n    return joke\n\nprint("Joke from the clouds: ", tell_joke())\n```\n\nA new virtual environment will be created by fal in the cloud and the set of requirements that we passed will be installed as soon as this function is called. From that point on, our code will be executed as if it were running locally, and the joke prepared by the pyjokes library will be returned.\n\n## Next steps\n\nIf you would like to find out more about the capabilities of fal, check out to the [docs](https://fal.ai/docs). You can learn more about persistent storage, function caches and deploying your functions as API endpoints.\n',
+    'long_description': '[![PyPI](https://img.shields.io/pypi/v/fal.svg?logo=PyPI)](https://pypi.org/project/fal)\n[![Tests](https://img.shields.io/github/actions/workflow/status/fal-ai/fal/integration_tests.yaml?label=Tests)](https://github.com/fal-ai/fal/actions)\n\n# fal\n\nfal is a serverless Python runtime that lets you run and scale code in the cloud with no infra management.\n\nWith fal, you can build pipelines, serve ML models and scale them up to many users. You scale down to 0 when you don\'t use any resources.\n\n## Quickstart\n\nFirst, you need to install the `fal` package. You can do so using pip:\n```shell\npip install fal\n```\n\nThen you need to authenticate:\n```shell\nfal auth login\n```\n\nYou can also use fal keys that you can get from [our dashboard](https://fal.ai/dashboard/keys).\n\nNow can use the fal package in your Python scripts as follows:\n\n```py\nimport fal\n\n@fal.function(\n    "virtualenv",\n    requirements=["pyjokes"],\n)\ndef tell_joke() -> str:\n    import pyjokes\n\n    joke = pyjokes.get_joke()\n    return joke\n\nprint("Joke from the clouds: ", tell_joke())\n```\n\nA new virtual environment will be created by fal in the cloud and the set of requirements that we passed will be installed as soon as this function is called. From that point on, our code will be executed as if it were running locally, and the joke prepared by the pyjokes library will be returned.\n\n## Next steps\n\nIf you would like to find out more about the capabilities of fal, check out to the [docs](https://fal.ai/docs). You can learn more about persistent storage, function caches and deploying your functions as API endpoints.\n',
     'author': 'Features & Labels',
     'author_email': 'hello@fal.ai',
     'maintainer': 'None',

fal-0.12.6/src/fal/__main__.py

@@ -0,0 +1,4 @@
+from .cli import cli
+
+if __name__ == "__main__":
+    cli()

{fal-0.12.4 → fal-0.12.6}/src/fal/apps.py

@@ -65,8 +65,12 @@ class RequestHandle:
     def __post_init__(self):
         app_id = _backwards_compatible_app_id(self.app_id)
         # drop any extra path components
-        user_id, app_name = app_id.split("/")[:2]
-        self.app_id = f"{user_id}/{app_name}"
+        parts = app_id.split("/")[:3]
+        if parts[0] != "workflows":
+            # if the app_id is not a workflow, only keep the first two parts
+            parts = parts[:2]
+
+        self.app_id = "/".join(parts)
 
     def status(self, *, logs: bool = False) -> _Status:
         """Check the status of an async inference request."""

{fal-0.12.4 → fal-0.12.6}/src/fal/auth/auth0.py

@@ -9,7 +9,7 @@ import httpx
 
 from fal.console import console
 from fal.console.icons import CHECK_ICON
-from fal.console.ux import get_browser
+from fal.console.ux import maybe_open_browser_tab
 
 WEBSITE_URL = "https://fal.ai"
 
@@ -27,19 +27,17 @@ def logout_url(return_url: str):
 
 
 def _open_browser(url: str, code: str | None) -> None:
-    browser = get_browser()
-    console.print()
+    maybe_open_browser_tab(url)
 
-    if browser is not None and click.confirm(
-        "Open browser automatically ('no' to show URL)?", default=True, err=True
-    ):
-        browser.open_new_tab(url)
-    else:
-        console.print(f"On your computer or mobile device navigate to: {url}")
-        if code:
-            console.print(
-                f"Confirm it shows the following code: [markdown.code]{code}[/]"
-            )
+    console.print(
+        "If browser didn't open automatically, on your computer or mobile device navigate to"
+    )
+    console.print(url)
+
+    if code:
+        console.print(
+            f"\nConfirm it shows the following code: [markdown.code]{code}[/]\n"
+        )
 
 
 def login() -> dict:
@@ -183,7 +181,7 @@ def validate_id_token(token: str):
 def verify_access_token_expiration(token: str):
     from jwt import decode
 
-    leeway = 60 * 30 * 60  # 30 minutes
+    leeway = 30 * 60  # 30 minutes
     decode(
         token,
         leeway=-leeway,  # negative to consider expired before actual expiration

{fal-0.12.4 → fal-0.12.6}/src/fal/cli.py

@@ -1,14 +1,16 @@
 from __future__ import annotations
 
 import json
+from dataclasses import dataclass, field
 from http import HTTPStatus
 from sys import argv
-from typing import Literal
+from typing import Any, Callable, Literal
 from uuid import uuid4
 
 import click
 import openapi_fal_rest.api.billing.get_user_details as get_user_details
 from rich.table import Table
+from rich_click import RichCommand, RichGroup
 
 import fal
 import fal.auth as auth
@@ -32,16 +34,29 @@ DEBUG_ENABLED = False
 logger = get_logger(__name__)
 
 
-class ExecutionInfo:
-    debug: bool
-    invocation_id: str
+@dataclass
+class State:
+    debug: bool = False
+    invocation_id: str = field(default_factory=lambda: str(uuid4()))
 
-    def __init__(self, debug=False):
-        self.debug = debug
-        self.invocation_id = str(uuid4())
 
+def debug_option(*param_decls: str, **kwargs: Any) -> Callable[[click.FC], click.FC]:
+    def callback(ctx: click.Context, param: click.Parameter, value: bool) -> None:
+        state = ctx.ensure_object(State)
+        state.debug = value
+        set_debug_logging(value)
 
-class MainGroup(click.Group):
+    if not param_decls:
+        param_decls = ("--debug",)
+
+    kwargs.setdefault("is_flag", True)
+    kwargs.setdefault("expose_value", False)
+    kwargs.setdefault("callback", callback)
+    kwargs.setdefault("help", "Enable detailed errors and verbose logging.")
+    return click.option(*param_decls, **kwargs)
+
+
+class MainGroup(RichGroup):
     """A custom implementation of the top-level group
     (i.e. called on all commands and subcommands).
 
@@ -54,13 +69,13 @@ class MainGroup(click.Group):
     _tracer = get_tracer(__name__)
 
     def invoke(self, ctx):
-        execution_info = ExecutionInfo(debug=ctx.params["debug"])
+        from click.exceptions import Abort, ClickException, Exit
+
+        state = ctx.ensure_object(State)
         qualified_name = " ".join([ctx.info_name] + argv[1:])
-        invocation_id = execution_info.invocation_id
-        set_debug_logging(execution_info.debug)
 
         with self._tracer.start_as_current_span(
-            qualified_name, attributes={"invocation_id": invocation_id}
+            qualified_name, attributes={"invocation_id": state.invocation_id}
         ):
             try:
                 logger.debug(
@@ -68,22 +83,25 @@ class MainGroup(click.Group):
                     command=qualified_name,
                 )
                 return super().invoke(ctx)
+            except (EOFError, KeyboardInterrupt, ClickException, Exit, Abort):
+                # let click's main handle these
+                raise
             except Exception as exception:
                 logger.error(exception)
-                if execution_info.debug:
+                if state.debug:
                     # Here we supress detailed errors on click lines because
                     # they're mostly decorator calls, irrelevant to the dev's error tracing
                     console.print_exception(suppress=[click])
                     console.print()
                     console.print(
-                        f"The [markdown.code]invocation_id[/] for this operation is: [white]{invocation_id}[/]"
+                        f"The [markdown.code]invocation_id[/] for this operation is: [white]{state.invocation_id}[/]"
                     )
                 else:
                     self._exception_handler.handle(exception)
 
     def add_command(
         self,
-        cmd: click.Command,
+        cmd: RichCommand,
         name: str | None = None,
         aliases: list[str] | None = None,
     ) -> None:
@@ -108,7 +126,7 @@ class MainGroup(click.Group):
             self.add_command(alias_cmd, alias)
 
 
-class AliasCommand(click.Command):
+class AliasCommand(RichCommand):
     def __init__(self, wrapped):
         self._wrapped = wrapped
 
@@ -123,35 +141,34 @@ class AliasCommand(click.Command):
         return self._wrapped.__getattribute__(__name)
 
 
-@click.group(
-    cls=MainGroup,
-    context_settings={"allow_interspersed_args": True},
-)
-@click.option(
-    "--debug", is_flag=True, help="Enable detailed errors and verbose logging."
-)
+@click.group(cls=MainGroup)
 @click.version_option()
-def cli(debug):
+@debug_option()
+def cli():
     pass
 
 
 ###### Auth group ######
-@click.group
+@click.group(cls=RichGroup)
+@debug_option()
 def auth_cli():
     pass
 
 
 @auth_cli.command(name="login")
+@debug_option()
 def auth_login():
     auth.login()
 
 
 @auth_cli.command(name="logout")
+@debug_option()
 def auth_logout():
     auth.logout()
 
 
 @auth_cli.command(name="hello", hidden=True)
+@debug_option()
 def auth_test():
     """
     To test auth.
@@ -160,9 +177,10 @@ def auth_test():
 
 
 ###### Key group ######
-@click.group
+@click.group(cls=RichGroup)
 @click.option("--host", default=DEFAULT_HOST, envvar=HOST_ENVVAR)
 @click.option("--port", default=DEFAULT_PORT, envvar=PORT_ENVVAR, hidden=True)
+@debug_option()
 @click.pass_context
 def key_cli(ctx, host: str, port: str):
     ctx.obj = sdk.FalServerlessClient(f"{host}:{port}")
@@ -181,6 +199,7 @@ def key_cli(ctx, host: str, port: str):
     default=None,
     help="An alias for the key.",
 )
+@debug_option()
 @click.pass_obj
 def key_generate(client: sdk.FalServerlessClient, scope: str, alias: str | None):
     with client.connect() as connection:
@@ -195,6 +214,7 @@ def key_generate(client: sdk.FalServerlessClient, scope: str, alias: str | None)
 
 
 @key_cli.command(name="list")
+@debug_option()
 @click.pass_obj
 def key_list(client: sdk.FalServerlessClient):
     table = Table(title="Keys")
@@ -215,6 +235,7 @@ def key_list(client: sdk.FalServerlessClient):
 
 @key_cli.command(name="revoke")
 @click.argument("key_id", required=True)
+@debug_option()
 @click.pass_obj
 def key_revoke(client: sdk.FalServerlessClient, key_id: str):
     with client.connect() as connection:
@@ -226,9 +247,10 @@ ALIAS_AUTH_OPTIONS = ["public", "private", "shared"]
 ALIAS_AUTH_TYPE = Literal["public", "private", "shared"]
 
 
-@click.group
+@click.group(cls=RichGroup)
 @click.option("--host", default=DEFAULT_HOST, envvar=HOST_ENVVAR)
 @click.option("--port", default=DEFAULT_PORT, envvar=PORT_ENVVAR, hidden=True)
+@debug_option()
 @click.pass_context
 def function_cli(ctx, host: str, port: str):
     ctx.obj = api.FalServerlessHost(f"{host}:{port}")
@@ -270,6 +292,7 @@ def load_function_from(
 )
 @click.argument("file_path", required=True)
 @click.argument("function_name", required=True)
+@debug_option()
 @click.pass_obj
 def register_application(
     host: api.FalServerlessHost,
@@ -321,6 +344,7 @@ def register_application(
 @function_cli.command("run")
 @click.argument("file_path", required=True)
 @click.argument("function_name", required=True)
+@debug_option()
 @click.pass_obj
 def run(host: api.FalServerlessHost, file_path: str, function_name: str):
     isolated_function = load_function_from(host, file_path, function_name)
@@ -330,6 +354,7 @@ def run(host: api.FalServerlessHost, file_path: str, function_name: str):
 @function_cli.command("logs")
 @click.option("--lines", default=100)
 @click.option("--url", default=None)
+@debug_option()
 @click.pass_obj
 def get_logs(
     host: api.FalServerlessHost, lines: int | None = 100, url: str | None = None
@@ -340,9 +365,10 @@ def get_logs(
 
 
 ##### Alias group #####
-@click.group
+@click.group(cls=RichGroup)
 @click.option("--host", default=DEFAULT_HOST, envvar=HOST_ENVVAR)
 @click.option("--port", default=DEFAULT_PORT, envvar=PORT_ENVVAR, hidden=True)
+@debug_option()
 @click.pass_context
 def alias_cli(ctx, host: str, port: str):
     ctx.obj = api.FalServerlessClient(f"{host}:{port}")
@@ -383,6 +409,7 @@ def _alias_table(aliases: list[AliasInfo]):
     type=click.Choice(ALIAS_AUTH_OPTIONS),
     default="private",
 )
+@debug_option()
 @click.pass_obj
 def alias_set(
     client: api.FalServerlessClient,
@@ -396,6 +423,7 @@ def alias_set(
 
 @alias_cli.command("delete")
 @click.argument("alias", required=True)
+@debug_option()
 @click.pass_obj
 def alias_delete(client: api.FalServerlessClient, alias: str):
     with client.connect() as connection:
@@ -405,6 +433,7 @@ def alias_delete(client: api.FalServerlessClient, alias: str):
 
 
 @alias_cli.command("list")
+@debug_option()
 @click.pass_obj
 def alias_list(client: api.FalServerlessClient):
     with client.connect() as connection:
@@ -426,6 +455,7 @@ def alias_list(client: api.FalServerlessClient):
 #     "auth_mode",
 #     type=click.Choice(ALIAS_AUTH_OPTIONS),
 # )
+@debug_option()
 @click.pass_obj
 def alias_update(
     client: api.FalServerlessClient,
@@ -459,6 +489,7 @@ def alias_update(
 
 @alias_cli.command("runners")
 @click.argument("alias", required=True)
+@debug_option()
 @click.pass_obj
 def alias_list_runners(
     client: api.FalServerlessClient,
@@ -489,15 +520,17 @@ def alias_list_runners(
 
 
 ##### Secrets group #####
-@click.group
+@click.group(cls=RichGroup)
 @click.option("--host", default=DEFAULT_HOST, envvar=HOST_ENVVAR)
 @click.option("--port", default=DEFAULT_PORT, envvar=PORT_ENVVAR, hidden=True)
+@debug_option()
 @click.pass_context
 def secrets_cli(ctx, host: str, port: str):
     ctx.obj = sdk.FalServerlessClient(f"{host}:{port}")
 
 
 @secrets_cli.command("list")
+@debug_option()
 @click.pass_obj
 def list_secrets(client: api.FalServerlessClient):
     table = Table(title="Secrets")
@@ -514,6 +547,7 @@ def list_secrets(client: api.FalServerlessClient):
 @secrets_cli.command("set")
 @click.argument("secret_name", required=True)
 @click.argument("secret_value", required=True)
+@debug_option()
 @click.pass_obj
 def set_secret(client: api.FalServerlessClient, secret_name: str, secret_value: str):
     with client.connect() as connection:
@@ -523,6 +557,7 @@ def set_secret(client: api.FalServerlessClient, secret_name: str, secret_value:
 
 @secrets_cli.command("delete")
 @click.argument("secret_name", required=True)
+@debug_option()
 @click.pass_obj
 def delete_secret(client: api.FalServerlessClient, secret_name: str):
     with client.connect() as connection:
@@ -574,11 +609,10 @@ def _get_user_id() -> str:
             raise api.FalServerlessError(content["detail"])
     try:
         full_user_id = user_details_response.parsed.user_id
-        user_id = full_user_id.split("|")[1]
+        _provider, _, user_id = full_user_id.partition("|")
+        if not user_id:
+            user_id = full_user_id
+
         return user_id
     except Exception as e:
         raise api.FalServerlessError(f"Could not parse the user data: {e}")
-
-
-if __name__ == "__main__":
-    cli()

fal-0.12.6/src/fal/console/ux.py

@@ -0,0 +1,14 @@
+from __future__ import annotations
+
+import webbrowser
+
+
+def maybe_open_browser_tab(url) -> None:
+    try:
+        # Avoids unwanted output in the console from the standard `webbrowser.open()`.
+        # See https://stackoverflow.com/a/19199794
+        browser = webbrowser.get()
+
+        browser.open_new_tab(url)
+    except webbrowser.Error:
+        pass

{fal-0.12.4 → fal-0.12.6}/src/fal/workflows.py

@@ -12,6 +12,7 @@ import rich
 from openapi_fal_rest.api.workflows import (
     create_or_update_workflow_workflows_post as publish_workflow,
 )
+from openapi_fal_rest.models.http_validation_error import HTTPValidationError
 from pydantic import BaseModel
 from rich.syntax import Syntax
 
@@ -363,7 +364,7 @@ class Workflow:
 
     to_dict = to_json
 
-    def publish(self, title: str, *, is_public: bool = True) -> None:
+    def publish(self, title: str, *, is_public: bool = True):
         workflow_contents = publish_workflow.TypedWorkflow(
             name=self.name,
             title=title,
@@ -376,14 +377,14 @@ class Workflow:
         )
         if isinstance(published_workflow, Exception):
             raise published_workflow
-
-        return (
-            REST_CLIENT.base_url
-            + "/workflows/"
-            + published_workflow.user_id
-            + "/"
-            + published_workflow.name
-        )
+        if isinstance(published_workflow, HTTPValidationError):
+            raise RuntimeError(published_workflow.detail)
+        if not published_workflow:
+            raise RuntimeError("Failed to publish the workflow")
+
+        # NOTE: dropping the provider prefix from the user_id
+        user_id_part = published_workflow.user_id.split("|")[-1]
+        return f"{user_id_part}/{published_workflow.name}"
 
 
 def create_workflow(

fal-0.12.4/src/fal/console/ux.py

@@ -1,17 +0,0 @@
-from __future__ import annotations
-
-import webbrowser
-
-
-def get_browser() -> webbrowser.BaseBrowser | None:
-    """Gets a reference to the default browser, if available.
-
-    This allows us to decide on a flow before showing the actual browser window.
-    It also avoids unwanted output in the console from the standard `webbrowser.open()`.
-
-    See https://stackoverflow.com/a/19199794
-    """
-    try:
-        return webbrowser.get()
-    except webbrowser.Error:
-        return None