fal 1.3.0__tar.gz → 1.3.2__tar.gz

{fal-1.3.0 → fal-1.3.2}/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.1
 Name: fal
-Version: 1.3.0
+Version: 1.3.2
 Summary: fal is an easy-to-use Serverless Python Framework
 Author: Features & Labels <support@fal.ai>
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 Requires-Dist: isolate[build]<1.14.0,>=0.13.0
-Requires-Dist: isolate-proto==0.5.1
+Requires-Dist: isolate-proto==0.5.3
 Requires-Dist: grpcio==1.64.0
 Requires-Dist: dill==0.3.7
 Requires-Dist: cloudpickle==3.0.0
@@ -36,6 +36,7 @@ Requires-Dist: pillow<11,>=10.2.0
 Requires-Dist: pyjwt[crypto]<3,>=2.8.0
 Requires-Dist: uvicorn<1,>=0.29.0
 Requires-Dist: cookiecutter
+Requires-Dist: tomli
 Provides-Extra: test
 Requires-Dist: pytest<8; extra == "test"
 Requires-Dist: pytest-asyncio; extra == "test"

{fal-1.3.0 → fal-1.3.2}/fal.egg-info/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.1
 Name: fal
-Version: 1.3.0
+Version: 1.3.2
 Summary: fal is an easy-to-use Serverless Python Framework
 Author: Features & Labels <support@fal.ai>
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 Requires-Dist: isolate[build]<1.14.0,>=0.13.0
-Requires-Dist: isolate-proto==0.5.1
+Requires-Dist: isolate-proto==0.5.3
 Requires-Dist: grpcio==1.64.0
 Requires-Dist: dill==0.3.7
 Requires-Dist: cloudpickle==3.0.0
@@ -36,6 +36,7 @@ Requires-Dist: pillow<11,>=10.2.0
 Requires-Dist: pyjwt[crypto]<3,>=2.8.0
 Requires-Dist: uvicorn<1,>=0.29.0
 Requires-Dist: cookiecutter
+Requires-Dist: tomli
 Provides-Extra: test
 Requires-Dist: pytest<8; extra == "test"
 Requires-Dist: pytest-asyncio; extra == "test"

{fal-1.3.0 → fal-1.3.2}/fal.egg-info/SOURCES.txt

@@ -82,6 +82,7 @@ src/fal/api.py
 src/fal/app.py
 src/fal/apps.py
 src/fal/container.py
+src/fal/files.py
 src/fal/flags.py
 src/fal/py.typed
 src/fal/rest_client.py
@@ -93,6 +94,7 @@ src/fal/auth/__init__.py
 src/fal/auth/auth0.py
 src/fal/auth/local.py
 src/fal/cli/__init__.py
+src/fal/cli/_utils.py
 src/fal/cli/apps.py
 src/fal/cli/auth.py
 src/fal/cli/create.py

{fal-1.3.0 → fal-1.3.2}/fal.egg-info/requires.txt

@@ -1,5 +1,5 @@
 isolate[build]<1.14.0,>=0.13.0
-isolate-proto==0.5.1
+isolate-proto==0.5.3
 grpcio==1.64.0
 dill==0.3.7
 cloudpickle==3.0.0
@@ -28,6 +28,7 @@ pillow<11,>=10.2.0
 pyjwt[crypto]<3,>=2.8.0
 uvicorn<1,>=0.29.0
 cookiecutter
+tomli
 
 [:python_version < "3.10"]
 importlib-metadata>=4.4

{fal-1.3.0 → fal-1.3.2}/pyproject.toml

@@ -23,7 +23,7 @@ readme = "README.md"
 requires-python = ">=3.8"
 dependencies = [
     "isolate[build]>=0.13.0,<1.14.0",
-    "isolate-proto==0.5.1",
+    "isolate-proto==0.5.3",
     "grpcio==1.64.0",
     "dill==0.3.7",
     "cloudpickle==3.0.0",
@@ -56,6 +56,7 @@ dependencies = [
     "pyjwt[crypto]>=2.8.0,<3",
     "uvicorn>=0.29.0,<1",
     "cookiecutter",
+    "tomli"
 ]
 
 [project.optional-dependencies]

{fal-1.3.0 → fal-1.3.2}/src/fal/__main__.py

@@ -1,4 +1,6 @@
+import sys
+
 from .cli import main
 
 if __name__ == "__main__":
-    main()
+    sys.exit(main())

{fal-1.3.0 → fal-1.3.2}/src/fal/_fal_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '1.3.0'
-__version_tuple__ = version_tuple = (1, 3, 0)
+__version__ = version = '1.3.2'
+__version_tuple__ = version_tuple = (1, 3, 2)

{fal-1.3.0 → fal-1.3.2}/src/fal/api.py

@@ -425,6 +425,7 @@ class FalServerlessHost(Host):
         application_name: str | None = None,
         application_auth_mode: Literal["public", "shared", "private"] | None = None,
         metadata: dict[str, Any] | None = None,
+        deployment_strategy: Literal["recreate", "rolling"] = "recreate",
     ) -> str | None:
         environment_options = options.environment.copy()
         environment_options.setdefault("python_version", active_python())
@@ -477,6 +478,7 @@ class FalServerlessHost(Host):
             application_auth_mode=application_auth_mode,
             machine_requirements=machine_requirements,
             metadata=metadata,
+            deployment_strategy=deployment_strategy,
         ):
             for log in partial_result.logs:
                 self._log_printer.print(log)

{fal-1.3.0 → fal-1.3.2}/src/fal/app.py

@@ -17,6 +17,7 @@ from fastapi import FastAPI
 import fal.api
 from fal._serialization import include_modules_from
 from fal.api import RouteSignature
+from fal.exceptions import RequestCancelledException
 from fal.logging import get_logger
 from fal.toolkit.file.providers import fal as fal_provider_module
 
@@ -143,7 +144,7 @@ class AppClient:
             with httpx.Client() as client:
                 retries = 100
                 for _ in range(retries):
-                    resp = client.get(info.url + "/health")
+                    resp = client.get(info.url + "/health", timeout=60)
 
                     if resp.is_success:
                         break
@@ -205,6 +206,14 @@ class App(fal.api.BaseServable):
                 "Running apps through SDK is not implemented yet."
             )
 
+    @classmethod
+    def get_endpoints(cls) -> list[str]:
+        return [
+            signature.path
+            for _, endpoint in inspect.getmembers(cls, inspect.isfunction)
+            if (signature := getattr(endpoint, "route_signature", None))
+        ]
+
     def collect_routes(self) -> dict[RouteSignature, Callable[..., Any]]:
         return {
             signature: endpoint
@@ -264,6 +273,17 @@ class App(fal.api.BaseServable):
                 )
             return response
 
+        @app.exception_handler(RequestCancelledException)
+        async def value_error_exception_handler(
+            request, exc: RequestCancelledException
+        ):
+            from fastapi.responses import JSONResponse
+
+            # A 499 status code is not an officially recognized HTTP status code,
+            # but it is sometimes used by servers to indicate that a client has closed
+            # the connection without receiving a response
+            return JSONResponse({"detail": str(exc)}, 499)
+
     def _add_extra_routes(self, app: FastAPI):
         @app.get("/health")
         def health():

{fal-1.3.0 → fal-1.3.2}/src/fal/apps.py

@@ -97,6 +97,15 @@ class RequestHandle:
         else:
             raise ValueError(f"Unknown status: {data['status']}")
 
+    def cancel(self) -> None:
+        """Cancel an async inference request."""
+        url = (
+            _QUEUE_URL_FORMAT.format(app_id=self.app_id)
+            + f"/requests/{self.request_id}/cancel"
+        )
+        response = _HTTP_CLIENT.put(url, headers=self._creds.to_headers())
+        response.raise_for_status()
+
     def iter_events(
         self,
         *,

fal-1.3.2/src/fal/cli/_utils.py

@@ -0,0 +1,34 @@
+from __future__ import annotations
+
+from fal.files import find_pyproject_toml, parse_pyproject_toml
+
+
+def is_app_name(app_ref: tuple[str, str | None]) -> bool:
+    is_single_file = app_ref[1] is None
+    is_python_file = app_ref[0].endswith(".py")
+
+    return is_single_file and not is_python_file
+
+
+def get_app_data_from_toml(app_name):
+    toml_path = find_pyproject_toml()
+
+    if toml_path is None:
+        raise ValueError("No pyproject.toml file found.")
+
+    fal_data = parse_pyproject_toml(toml_path)
+    apps = fal_data.get("apps", {})
+
+    try:
+        app_data = apps[app_name]
+    except KeyError:
+        raise ValueError(f"App {app_name} not found in pyproject.toml")
+
+    try:
+        app_ref = app_data["ref"]
+    except KeyError:
+        raise ValueError(f"App {app_name} does not have a ref key in pyproject.toml")
+
+    app_auth = app_data.get("auth", "private")
+
+    return app_ref, app_auth

{fal-1.3.0 → fal-1.3.2}/src/fal/cli/deploy.py

@@ -1,7 +1,9 @@
 import argparse
 from collections import namedtuple
 from pathlib import Path
+from typing import Optional, Union
 
+from ._utils import get_app_data_from_toml, is_app_name
 from .parser import FalClientParser, RefAction
 
 User = namedtuple("User", ["user_id", "username"])
@@ -60,11 +62,13 @@ def _get_user() -> User:
         raise FalServerlessError(f"Could not parse the user data: {e}")
 
 
-def _deploy(args):
+def _deploy_from_reference(
+    app_ref: tuple[Optional[Union[Path, str]], ...], app_name: str, auth: str, args
+):
     from fal.api import FalServerlessError, FalServerlessHost
     from fal.utils import load_function_from
 
-    file_path, func_name = args.app_ref
+    file_path, func_name = app_ref
     if file_path is None:
         # Try to find a python file in the current directory
         options = list(Path(".").glob("*.py"))
@@ -77,23 +81,27 @@ def _deploy(args):
             )
 
         [file_path] = options
-        file_path = str(file_path)
+        file_path = str(file_path)  # type: ignore
 
     user = _get_user()
     host = FalServerlessHost(args.host)
-    isolated_function, app_name, app_auth = load_function_from(
+    loaded = load_function_from(
         host,
-        file_path,
-        func_name,
+        file_path,  # type: ignore
+        func_name,  # type: ignore
     )
-    app_name = args.app_name or app_name
-    app_auth = args.auth or app_auth or "private"
+    isolated_function = loaded.function
+    app_name = app_name or loaded.app_name  # type: ignore
+    app_auth = auth or loaded.app_auth or "private"
+    deployment_strategy = args.strategy or "default"
+
     app_id = host.register(
         func=isolated_function.func,
         options=isolated_function.options,
         application_name=app_name,
         application_auth_mode=app_auth,
         metadata=isolated_function.options.host.get("metadata", {}),
+        deployment_strategy=deployment_strategy,
     )
 
     if app_id:
@@ -106,12 +114,36 @@ def _deploy(args):
             "Registered a new revision for function "
             f"'{app_name}' (revision='{app_id}')."
         )
-        args.console.print(
-            f"Playground: https://fal.ai/models/{user.username}/{app_name}"
-        )
-        args.console.print(
-            f"Endpoint: https://{gateway_host}/{user.username}/{app_name}"
-        )
+        args.console.print("Playground:")
+        for endpoint in loaded.endpoints:
+            args.console.print(
+                f"\thttps://fal.ai/models/{user.username}/{app_name}{endpoint}"
+            )
+        args.console.print("Endpoints:")
+        for endpoint in loaded.endpoints:
+            args.console.print(
+                f"\thttps://{gateway_host}/{user.username}/{app_name}{endpoint}"
+            )
+
+
+def _deploy(args):
+    # my-app
+    if is_app_name(args.app_ref):
+        # we do not allow --app-name and --auth to be used with app name
+        if args.app_name or args.auth:
+            raise ValueError("Cannot use --app-name or --auth with app name reference.")
+
+        app_name = args.app_ref[0]
+        app_ref, app_auth = get_app_data_from_toml(app_name)
+        file_path, func_name = RefAction.split_ref(app_ref)
+
+    # path/to/myfile.py::MyApp
+    else:
+        file_path, func_name = args.app_ref
+        app_name = args.app_name
+        app_auth = args.auth
+
+    _deploy_from_reference((file_path, func_name), app_name, app_auth, args)
 
 
 def add_parser(main_subparsers, parents):
@@ -122,14 +154,22 @@ def add_parser(main_subparsers, parents):
             raise argparse.ArgumentTypeError(f"{option} is not a auth option")
         return option
 
-    deploy_help = "Deploy a fal application."
+    deploy_help = (
+        "Deploy a fal application. "
+        "If no app reference is provided, the command will look for a "
+        "pyproject.toml file with a [tool.fal.apps] section and deploy the "
+        "application specified with the provided app name."
+    )
+
     epilog = (
         "Examples:\n"
         "  fal deploy\n"
         "  fal deploy path/to/myfile.py\n"
         "  fal deploy path/to/myfile.py::MyApp\n"
         "  fal deploy path/to/myfile.py::MyApp --app-name myapp --auth public\n"
+        "  fal deploy my-app\n"
     )
+
     parser = main_subparsers.add_parser(
         "deploy",
         parents=[*parents, FalClientParser(add_help=False)],
@@ -137,21 +177,36 @@ def add_parser(main_subparsers, parents):
         help=deploy_help,
         epilog=epilog,
     )
+
     parser.add_argument(
         "app_ref",
         nargs="?",
         action=RefAction,
         help=(
-            "Application reference. " "For example: `myfile.py::MyApp`, `myfile.py`."
+            "Application reference. Either a file path or a file path and a "
+            "function name separated by '::'. If no reference is provided, the "
+            "command will look for a pyproject.toml file with a [tool.fal.apps] "
+            "section and deploy the application specified with the provided app name.\n"
+            "File path example: path/to/myfile.py::MyApp\n"
+            "App name example: my-app\n"
         ),
     )
+
     parser.add_argument(
         "--app-name",
         help="Application name to deploy with.",
     )
+
     parser.add_argument(
         "--auth",
         type=valid_auth_option,
         help="Application authentication mode (private, public).",
     )
+    parser.add_argument(
+        "--strategy",
+        choices=["default", "rolling"],
+        help="Deployment strategy.",
+        default="default",
+    )
+
     parser.set_defaults(func=_deploy)

{fal-1.3.0 → fal-1.3.2}/src/fal/cli/parser.py

@@ -14,14 +14,18 @@ class RefAction(argparse.Action):
         kwargs.setdefault("default", (None, None))
         super().__init__(*args, **kwargs)
 
-    def __call__(self, parser, args, values, option_string=None):  # noqa: ARG002
-        if isinstance(values, tuple):
-            file_path, obj_path = values
-        elif values.find("::") > 1:
-            file_path, obj_path = values.split("::", 1)
-        else:
-            file_path, obj_path = values, None
+    @classmethod
+    def split_ref(cls, value):
+        if isinstance(value, tuple):
+            return value
+
+        if value.find("::") > 1:
+            return value.split("::", 1)
 
+        return value, None
+
+    def __call__(self, parser, args, values, option_string=None):  # noqa: ARG002
+        file_path, obj_path = self.split_ref(values)
         setattr(args, self.dest, (file_path, obj_path))
 
 

{fal-1.3.0 → fal-1.3.2}/src/fal/cli/run.py

@@ -1,3 +1,4 @@
+from ._utils import get_app_data_from_toml, is_app_name
 from .parser import FalClientParser, RefAction
 
 
@@ -6,7 +7,17 @@ def _run(args):
     from fal.utils import load_function_from
 
     host = FalServerlessHost(args.host)
-    isolated_function, _, _ = load_function_from(host, *args.func_ref)
+
+    if is_app_name(args.func_ref):
+        app_name = args.func_ref[0]
+        app_ref, _ = get_app_data_from_toml(app_name)
+        file_path, func_name = RefAction.split_ref(app_ref)
+    else:
+        file_path, func_name = args.func_ref
+
+    loaded = load_function_from(host, file_path, func_name)
+
+    isolated_function = loaded.function
     # let our exc handlers handle UserFunctionException
     isolated_function.reraise = False
     isolated_function()

fal-1.3.2/src/fal/exceptions/__init__.py

@@ -0,0 +1,9 @@
+from __future__ import annotations
+
+from ._base import (
+    AppException,  # noqa: F401
+    FalServerlessException,  # noqa: F401
+    FieldException,  # noqa: F401
+    RequestCancelledException,  # noqa: F401
+)
+from ._cuda import CUDAOutOfMemoryException  # noqa: F401

{fal-1.3.0 → fal-1.3.2}/src/fal/exceptions/_base.py

@@ -1,7 +1,6 @@
 from __future__ import annotations
 
 from dataclasses import dataclass
-from typing import Sequence
 
 
 class FalServerlessException(Exception):
@@ -40,11 +39,20 @@ class FieldException(FalServerlessException):
     status_code: int = 422
     type: str = "value_error"
 
-    def to_pydantic_format(self) -> Sequence[dict]:
-        return [
-            {
-                "loc": ["body", self.field],
-                "msg": self.message,
-                "type": self.type,
-            }
-        ]
+    def to_pydantic_format(self) -> dict[str, list[dict]]:
+        return dict(
+            detail=[
+                {
+                    "loc": ["body", self.field],
+                    "msg": self.message,
+                    "type": self.type,
+                }
+            ]
+        )
+
+
+@dataclass
+class RequestCancelledException(FalServerlessException):
+    """Exception raised when the request is cancelled by the client."""
+
+    message: str = "Request cancelled by the client."

fal-1.3.2/src/fal/files.py

@@ -0,0 +1,81 @@
+from functools import lru_cache
+from pathlib import Path
+from typing import Any, Dict, Optional, Sequence, Tuple, Union
+
+import tomli
+
+
+@lru_cache
+def _load_toml(path: Union[Path, str]) -> Dict[str, Any]:
+    with open(path, "rb") as f:
+        return tomli.load(f)
+
+
+@lru_cache
+def _cached_resolve(path: Path) -> Path:
+    return path.resolve()
+
+
+@lru_cache
+def find_project_root(srcs: Optional[Sequence[str]]) -> Tuple[Path, str]:
+    """Return a directory containing .git, or pyproject.toml.
+
+    That directory will be a common parent of all files and directories
+    passed in `srcs`.
+
+    If no directory in the tree contains a marker that would specify it's the
+    project root, the root of the file system is returned.
+
+    Returns a two-tuple with the first element as the project root path and
+    the second element as a string describing the method by which the
+    project root was discovered.
+    """
+    if not srcs:
+        srcs = [str(_cached_resolve(Path.cwd()))]
+
+    path_srcs = [_cached_resolve(Path(Path.cwd(), src)) for src in srcs]
+
+    # A list of lists of parents for each 'src'. 'src' is included as a
+    # "parent" of itself if it is a directory
+    src_parents = [
+        list(path.parents) + ([path] if path.is_dir() else []) for path in path_srcs
+    ]
+
+    common_base = max(
+        set.intersection(*(set(parents) for parents in src_parents)),
+        key=lambda path: path.parts,
+    )
+
+    for directory in (common_base, *common_base.parents):
+        if (directory / ".git").exists():
+            return directory, ".git directory"
+
+        if (directory / "pyproject.toml").is_file():
+            pyproject_toml = _load_toml(directory / "pyproject.toml")
+            if "fal" in pyproject_toml.get("tool", {}):
+                return directory, "pyproject.toml"
+
+    return directory, "file system root"
+
+
+def find_pyproject_toml(
+    path_search_start: Optional[Tuple[str, ...]] = None,
+) -> Optional[str]:
+    """Find the absolute filepath to a pyproject.toml if it exists"""
+    path_project_root, _ = find_project_root(path_search_start)
+    path_pyproject_toml = path_project_root / "pyproject.toml"
+
+    if path_pyproject_toml.is_file():
+        return str(path_pyproject_toml)
+
+
+def parse_pyproject_toml(path_config: str) -> Dict[str, Any]:
+    """Parse a pyproject toml file, pulling out relevant parts for fal.
+
+    If parsing fails, will raise a tomli.TOMLDecodeError.
+    """
+    pyproject_toml = _load_toml(path_config)
+    config: Dict[str, Any] = pyproject_toml.get("tool", {}).get("fal", {})
+    config = {k.replace("--", "").replace("-", "_"): v for k, v in config.items()}
+
+    return config

{fal-1.3.0 → fal-1.3.2}/src/fal/sdk.py

@@ -275,6 +275,33 @@ class KeyScope(enum.Enum):
             raise ValueError(f"Unknown KeyScope: {proto}")
 
 
+class DeploymentStrategy(enum.Enum):
+    RECREATE = "recreate"
+    ROLLING = "rolling"
+
+    @staticmethod
+    def from_proto(
+        proto: isolate_proto.DeploymentStrategy.ValueType | None,
+    ) -> DeploymentStrategy:
+        if proto is None:
+            return DeploymentStrategy.RECREATE
+
+        if proto is isolate_proto.DeploymentStrategy.RECREATE:
+            return DeploymentStrategy.RECREATE
+        elif proto is isolate_proto.DeploymentStrategy.ROLLING:
+            return DeploymentStrategy.ROLLING
+        else:
+            raise ValueError(f"Unknown DeploymentStrategy: {proto}")
+
+    def to_proto(self) -> isolate_proto.DeploymentStrategy.ValueType:
+        if self is DeploymentStrategy.RECREATE:
+            return isolate_proto.DeploymentStrategy.RECREATE
+        elif self is DeploymentStrategy.ROLLING:
+            return isolate_proto.DeploymentStrategy.ROLLING
+        else:
+            raise ValueError(f"Unknown DeploymentStrategy: {self}")
+
+
 @from_grpc.register(isolate_proto.ApplicationInfo)
 def _from_grpc_application_info(
     message: isolate_proto.ApplicationInfo,
@@ -457,6 +484,7 @@ class FalServerlessConnection:
         serialization_method: str = _DEFAULT_SERIALIZATION_METHOD,
         machine_requirements: MachineRequirements | None = None,
         metadata: dict[str, Any] | None = None,
+        deployment_strategy: Literal["recreate", "rolling"] = "recreate",
     ) -> Iterator[isolate_proto.RegisterApplicationResult]:
         wrapped_function = to_serialized_object(function, serialization_method)
         if machine_requirements:
@@ -488,6 +516,10 @@ class FalServerlessConnection:
             struct_metadata = isolate_proto.Struct()
             struct_metadata.update(metadata)
 
+        deployment_strategy_proto = DeploymentStrategy[
+            deployment_strategy.upper()
+        ].to_proto()
+
         request = isolate_proto.RegisterApplicationRequest(
             function=wrapped_function,
             environments=environments,
@@ -495,6 +527,7 @@ class FalServerlessConnection:
             application_name=application_name,
             auth_mode=auth_mode,
             metadata=struct_metadata,
+            deployment_strategy=deployment_strategy_proto,
         )
         for partial_result in self.stub.RegisterApplication(request):
             yield from_grpc(partial_result)

{fal-1.3.0 → fal-1.3.2}/src/fal/toolkit/file/file.py

@@ -149,14 +149,31 @@ class File(BaseModel):
         path: str | Path,
         content_type: Optional[str] = None,
         repository: FileRepository | RepositoryId = DEFAULT_REPOSITORY,
+        multipart: bool | None = None,
     ) -> File:
         file_path = Path(path)
         if not file_path.exists():
             raise FileNotFoundError(f"File {file_path} does not exist")
-        with open(file_path, "rb") as f:
-            data = f.read()
-        return File.from_bytes(
-            data, content_type, file_name=file_path.name, repository=repository
+
+        repo = (
+            repository
+            if isinstance(repository, FileRepository)
+            else get_builtin_repository(repository)
+        )
+
+        content_type = content_type or "application/octet-stream"
+
+        url, data = repo.save_file(
+            file_path,
+            content_type=content_type,
+            multipart=multipart,
+        )
+        return cls(
+            url=url,
+            file_data=data.data if data else None,
+            content_type=content_type,
+            file_name=file_path.name,
+            file_size=file_path.stat().st_size,
         )
 
     def as_bytes(self) -> bytes: