flwr-nightly 1.11.0.dev20240805__py3-none-any.whl → 1.11.0.dev20240811__py3-none-any.whl

flwr/cli/build.py

@@ -30,32 +30,34 @@ from .utils import get_sha256_hash, is_valid_project_name
 
 # pylint: disable=too-many-locals
 def build(
-    directory: Annotated[
+    app: Annotated[
         Optional[Path],
-        typer.Option(help="Path of the Flower project to bundle into a FAB"),
+        typer.Option(help="Path of the Flower App to bundle into a FAB"),
     ] = None,
 ) -> str:
-    """Build a Flower project into a Flower App Bundle (FAB).
+    """Build a Flower App into a Flower App Bundle (FAB).
 
-    You can run ``flwr build`` without any arguments to bundle the current directory,
-    or you can use ``--directory`` to build a specific directory:
-    ``flwr build --directory ./projects/flower-hello-world``.
+    You can run ``flwr build`` without any arguments to bundle the app located in the
+    current directory. Alternatively, you can you can specify a path using the ``--app``
+    option to bundle an app located at the provided path. For example:
+
+    ``flwr build --app ./apps/flower-hello-world``.
     """
-    if directory is None:
-        directory = Path.cwd()
+    if app is None:
+        app = Path.cwd()
 
-    directory = directory.resolve()
-    if not directory.is_dir():
+    app = app.resolve()
+    if not app.is_dir():
         typer.secho(
-            f"❌ The path {directory} is not a valid directory.",
+            f"❌ The path {app} is not a valid path to a Flower app.",
             fg=typer.colors.RED,
             bold=True,
         )
         raise typer.Exit(code=1)
 
-    if not is_valid_project_name(directory.name):
+    if not is_valid_project_name(app.name):
         typer.secho(
-            f"❌ The project name {directory.name} is invalid, "
+            f"❌ The project name {app.name} is invalid, "
             "a valid project name must start with a letter or an underscore, "
             "and can only contain letters, digits, and underscores.",
             fg=typer.colors.RED,
@@ -63,7 +65,7 @@ def build(
         )
         raise typer.Exit(code=1)
 
-    conf, errors, warnings = load_and_validate(directory / "pyproject.toml")
+    conf, errors, warnings = load_and_validate(app / "pyproject.toml")
     if conf is None:
         typer.secho(
             "Project configuration could not be loaded.\npyproject.toml is invalid:\n"
@@ -82,12 +84,12 @@ def build(
         )
 
     # Load .gitignore rules if present
-    ignore_spec = _load_gitignore(directory)
+    ignore_spec = _load_gitignore(app)
 
     # Set the name of the zip file
     fab_filename = (
         f"{conf['tool']['flwr']['app']['publisher']}"
-        f".{directory.name}"
+        f".{app.name}"
         f".{conf['project']['version'].replace('.', '-')}.fab"
     )
     list_file_content = ""
@@ -108,7 +110,7 @@ def build(
         fab_file.writestr("pyproject.toml", toml_contents)
 
         # Continue with adding other files
-        for root, _, files in os.walk(directory, topdown=True):
+        for root, _, files in os.walk(app, topdown=True):
             files = [
                 f
                 for f in files
@@ -120,7 +122,7 @@ def build(
 
             for file in files:
                 file_path = Path(root) / file
-                archive_path = file_path.relative_to(directory)
+                archive_path = file_path.relative_to(app)
                 fab_file.write(file_path, archive_path)
 
                 # Calculate file info
@@ -138,9 +140,9 @@ def build(
     return fab_filename
 
 
-def _load_gitignore(directory: Path) -> pathspec.PathSpec:
+def _load_gitignore(app: Path) -> pathspec.PathSpec:
     """Load and parse .gitignore file, returning a pathspec."""
-    gitignore_path = directory / ".gitignore"
+    gitignore_path = app / ".gitignore"
     patterns = ["__pycache__/"]  # Default pattern
     if gitignore_path.exists():
         with open(gitignore_path, encoding="UTF-8") as file:

flwr/cli/new/new.py

@@ -34,13 +34,13 @@ from ..utils import (
 class MlFramework(str, Enum):
     """Available frameworks."""
 
-    NUMPY = "NumPy"
     PYTORCH = "PyTorch"
     TENSORFLOW = "TensorFlow"
-    JAX = "JAX"
+    SKLEARN = "sklearn"
     HUGGINGFACE = "HuggingFace"
+    JAX = "JAX"
     MLX = "MLX"
-    SKLEARN = "sklearn"
+    NUMPY = "NumPy"
     FLOWERTUNE = "FlowerTune"
 
 
@@ -92,9 +92,9 @@ def render_and_create(file_path: Path, template: str, context: Dict[str, str]) -
 
 # pylint: disable=too-many-locals,too-many-branches,too-many-statements
 def new(
-    project_name: Annotated[
+    app_name: Annotated[
         Optional[str],
-        typer.Argument(metavar="project_name", help="The name of the project"),
+        typer.Argument(help="The name of the Flower App"),
     ] = None,
     framework: Annotated[
         Optional[MlFramework],
@@ -105,26 +105,26 @@ def new(
         typer.Option(case_sensitive=False, help="The Flower username of the author"),
     ] = None,
 ) -> None:
-    """Create new Flower project."""
-    if project_name is None:
-        project_name = prompt_text("Please provide the project name")
-    if not is_valid_project_name(project_name):
-        project_name = prompt_text(
+    """Create new Flower App."""
+    if app_name is None:
+        app_name = prompt_text("Please provide the app name")
+    if not is_valid_project_name(app_name):
+        app_name = prompt_text(
             "Please provide a name that only contains "
             "characters in {'-', a-zA-Z', '0-9'}",
             predicate=is_valid_project_name,
-            default=sanitize_project_name(project_name),
+            default=sanitize_project_name(app_name),
         )
 
     # Set project directory path
-    package_name = re.sub(r"[-_.]+", "-", project_name).lower()
+    package_name = re.sub(r"[-_.]+", "-", app_name).lower()
     import_name = package_name.replace("-", "_")
     project_dir = Path.cwd() / package_name
 
     if project_dir.exists():
         if not typer.confirm(
             typer.style(
-                f"\n💬 {project_name} already exists, do you want to override it?",
+                f"\n💬 {app_name} already exists, do you want to override it?",
                 fg=typer.colors.MAGENTA,
                 bold=True,
             )
@@ -139,7 +139,7 @@ def new(
     else:
         framework_value = prompt_options(
             "Please select ML framework by typing in the number",
-            sorted([mlf.value for mlf in MlFramework]),
+            [mlf.value for mlf in MlFramework],
         )
         selected_value = [
             name
@@ -166,7 +166,7 @@ def new(
 
     print(
         typer.style(
-            f"\n🔨 Creating Flower project {project_name}...",
+            f"\n🔨 Creating Flower App {app_name}...",
             fg=typer.colors.GREEN,
             bold=True,
         )
@@ -176,7 +176,7 @@ def new(
         "framework_str": framework_str_upper,
         "import_name": import_name.replace("-", "_"),
         "package_name": package_name,
-        "project_name": project_name,
+        "project_name": app_name,
         "username": username,
     }
 
@@ -268,8 +268,8 @@ def new(
 
     print(
         typer.style(
-            "🎊 Project creation successful.\n\n"
-            "Use the following command to run your project:\n",
+            "🎊 Flower App creation successful.\n\n"
+            "Use the following command to run your Flower App:\n",
             fg=typer.colors.GREEN,
             bold=True,
         )

flwr/cli/run/run.py

@@ -35,9 +35,9 @@ from flwr.proto.exec_pb2_grpc import ExecStub
 
 # pylint: disable-next=too-many-locals
 def run(
-    app_dir: Annotated[
+    app: Annotated[
         Path,
-        typer.Argument(help="Path of the Flower project to run."),
+        typer.Argument(help="Path of the Flower App to run."),
     ] = Path("."),
     federation: Annotated[
         Optional[str],
@@ -55,10 +55,10 @@ def run(
         ),
     ] = None,
 ) -> None:
-    """Run Flower project."""
+    """Run Flower App."""
     typer.secho("Loading project configuration... ", fg=typer.colors.BLUE)
 
-    pyproject_path = app_dir / "pyproject.toml" if app_dir else None
+    pyproject_path = app / "pyproject.toml" if app else None
     config, errors, warnings = load_and_validate(path=pyproject_path)
 
     if config is None:
@@ -109,14 +109,14 @@ def run(
         raise typer.Exit(code=1)
 
     if "address" in federation_config:
-        _run_with_superexec(federation_config, app_dir, config_overrides)
+        _run_with_superexec(app, federation_config, config_overrides)
     else:
-        _run_without_superexec(app_dir, federation_config, federation, config_overrides)
+        _run_without_superexec(app, federation_config, config_overrides, federation)
 
 
 def _run_with_superexec(
+    app: Optional[Path],
     federation_config: Dict[str, Any],
-    app_dir: Optional[Path],
     config_overrides: Optional[List[str]],
 ) -> None:
 
@@ -162,10 +162,10 @@ def _run_with_superexec(
     channel.subscribe(on_channel_state_change)
     stub = ExecStub(channel)
 
-    fab_path = build(app_dir)
+    fab_path = Path(build(app))
 
     req = StartRunRequest(
-        fab_file=Path(fab_path).read_bytes(),
+        fab_file=fab_path.read_bytes(),
         override_config=user_config_to_proto(
             parse_config_args(config_overrides, separator=",")
         ),
@@ -174,14 +174,17 @@ def _run_with_superexec(
         ),
     )
     res = stub.StartRun(req)
+
+    # Delete FAB file once it has been sent to the SuperExec
+    fab_path.unlink()
     typer.secho(f"🎊 Successfully started run {res.run_id}", fg=typer.colors.GREEN)
 
 
 def _run_without_superexec(
-    app_path: Optional[Path],
+    app: Optional[Path],
     federation_config: Dict[str, Any],
-    federation: str,
     config_overrides: Optional[List[str]],
+    federation: str,
 ) -> None:
     try:
         num_supernodes = federation_config["options"]["num-supernodes"]
@@ -200,7 +203,7 @@ def _run_without_superexec(
     command = [
         "flower-simulation",
         "--app",
-        f"{app_path}",
+        f"{app}",
         "--num-supernodes",
         f"{num_supernodes}",
     ]

flwr/client/supernode/app.py

@@ -31,6 +31,7 @@ from flwr.client.client_app import ClientApp, LoadClientAppError
 from flwr.common import EventType, event
 from flwr.common.config import (
     get_flwr_dir,
+    get_metadata_from_config,
     get_project_config,
     get_project_dir,
     parse_config_args,
@@ -61,8 +62,8 @@ def run_supernode() -> None:
 
     root_certificates = _get_certificates(args)
     load_fn = _get_load_client_app_fn(
-        default_app_ref=getattr(args, "client-app"),
-        project_dir=args.dir,
+        default_app_ref="",
+        app_path=args.app,
         flwr_dir=args.flwr_dir,
         multi_app=True,
     )
@@ -100,7 +101,7 @@ def run_client_app() -> None:
     root_certificates = _get_certificates(args)
     load_fn = _get_load_client_app_fn(
         default_app_ref=getattr(args, "client-app"),
-        project_dir=args.dir,
+        app_path=args.dir,
         multi_app=False,
     )
     authentication_keys = _try_setup_client_authentication(args)
@@ -176,7 +177,7 @@ def _get_certificates(args: argparse.Namespace) -> Optional[bytes]:
 
 def _get_load_client_app_fn(
     default_app_ref: str,
-    project_dir: str,
+    app_path: Optional[str],
     multi_app: bool,
     flwr_dir: Optional[str] = None,
 ) -> Callable[[str, str], ClientApp]:
@@ -196,34 +197,39 @@ def _get_load_client_app_fn(
             default_app_ref,
         )
 
-        valid, error_msg = validate(default_app_ref, project_dir=project_dir)
+        valid, error_msg = validate(default_app_ref, project_dir=app_path)
         if not valid and error_msg:
             raise LoadClientAppError(error_msg) from None
 
     def _load(fab_id: str, fab_version: str) -> ClientApp:
-        runtime_project_dir = Path(project_dir).absolute()
+        runtime_app_dir = Path(app_path if app_path else "").absolute()
         # If multi-app feature is disabled
         if not multi_app:
             # Set app reference
             client_app_ref = default_app_ref
-        # If multi-app feature is enabled but the fab id is not specified
-        elif fab_id == "":
-            if default_app_ref == "":
+        # If multi-app feature is enabled but app directory is provided
+        elif app_path is not None:
+            config = get_project_config(runtime_app_dir)
+            this_fab_version, this_fab_id = get_metadata_from_config(config)
+
+            if this_fab_version != fab_version or this_fab_id != fab_id:
                 raise LoadClientAppError(
-                    "Invalid FAB ID: The FAB ID is empty.",
+                    f"FAB ID or version mismatch: Expected FAB ID '{this_fab_id}' and "
+                    f"FAB version '{this_fab_version}', but received FAB ID '{fab_id}' "
+                    f"and FAB version '{fab_version}'.",
                 ) from None
 
-            log(WARN, "FAB ID is not provided; the default ClientApp will be loaded.")
+            # log(WARN, "FAB ID is not provided; the default ClientApp will be loaded.")
 
             # Set app reference
-            client_app_ref = default_app_ref
+            client_app_ref = config["tool"]["flwr"]["app"]["components"]["clientapp"]
         # If multi-app feature is enabled
         else:
             try:
-                runtime_project_dir = get_project_dir(
+                runtime_app_dir = get_project_dir(
                     fab_id, fab_version, get_flwr_dir(flwr_dir)
                 )
-                config = get_project_config(runtime_project_dir)
+                config = get_project_config(runtime_app_dir)
             except Exception as e:
                 raise LoadClientAppError("Failed to load ClientApp") from e
 
@@ -236,7 +242,7 @@ def _get_load_client_app_fn(
             "Loading ClientApp `%s`",
             client_app_ref,
         )
-        client_app = load_app(client_app_ref, LoadClientAppError, runtime_project_dir)
+        client_app = load_app(client_app_ref, LoadClientAppError, runtime_app_dir)
 
         if not isinstance(client_app, ClientApp):
             raise LoadClientAppError(
@@ -255,13 +261,15 @@ def _parse_args_run_supernode() -> argparse.ArgumentParser:
     )
 
     parser.add_argument(
-        "client-app",
+        "app",
         nargs="?",
-        default="",
-        help="For example: `client:app` or `project.package.module:wrapper.app`. "
-        "This is optional and serves as the default ClientApp to be loaded when "
-        "the ServerApp does not specify `fab_id` and `fab_version`. "
-        "If not provided, defaults to an empty string.",
+        default=None,
+        help="Specify the path of the Flower App to load and run the `ClientApp`. "
+        "The `pyproject.toml` file must be located in the root of this path. "
+        "When this argument is provided, the SuperNode will exclusively respond to "
+        "messages from the corresponding `ServerApp` by matching the FAB ID and FAB "
+        "version. An error will be raised if a message is received from any other "
+        "`ServerApp`.",
     )
     _parse_args_common(parser)
     parser.add_argument(
@@ -290,6 +298,13 @@ def _parse_args_run_client_app() -> argparse.ArgumentParser:
         help="For example: `client:app` or `project.package.module:wrapper.app`",
     )
     _parse_args_common(parser=parser)
+    parser.add_argument(
+        "--dir",
+        default="",
+        help="Add specified directory to the PYTHONPATH and load Flower "
+        "app from there."
+        " Default: current working directory.",
+    )
 
     return parser
 
@@ -357,13 +372,6 @@ def _parse_args_common(parser: argparse.ArgumentParser) -> None:
         "connect to the SuperLink in case of connection error. By default, it"
         "is set to None, meaning there is no limit to the total time.",
     )
-    parser.add_argument(
-        "--dir",
-        default="",
-        help="Add specified directory to the PYTHONPATH and load Flower "
-        "app from there."
-        " Default: current working directory.",
-    )
     parser.add_argument(
         "--auth-supernode-private-key",
         type=str,

flwr/common/config.py

@@ -105,11 +105,16 @@ def get_fused_config(run: Run, flwr_dir: Optional[Path]) -> UserConfig:
     Get the config using the fab_id and the fab_version, remove the nesting by adding
     the nested keys as prefixes separated by dots, and fuse it with the override dict.
     """
+    # Return empty dict if fab_id or fab_version is empty
     if not run.fab_id or not run.fab_version:
         return {}
 
     project_dir = get_project_dir(run.fab_id, run.fab_version, flwr_dir)
 
+    # Return empty dict if project directory does not exist
+    if not project_dir.is_dir():
+        return {}
+
     return get_fused_config_from_dir(project_dir, run.override_config)
 
 
@@ -136,6 +141,23 @@ def flatten_dict(
     return dict(items)
 
 
+def unflatten_dict(flat_dict: Dict[str, Any]) -> Dict[str, Any]:
+    """Unflatten a dict with keys containing separators into a nested dict."""
+    unflattened_dict: Dict[str, Any] = {}
+    separator: str = "."
+
+    for key, value in flat_dict.items():
+        parts = key.split(separator)
+        d = unflattened_dict
+        for part in parts[:-1]:
+            if part not in d:
+                d[part] = {}
+            d = d[part]
+        d[parts[-1]] = value
+
+    return unflattened_dict
+
+
 def parse_config_args(
     config: Optional[List[str]],
     separator: str = ",",
@@ -161,3 +183,11 @@ def parse_config_args(
                 overrides.update(tomli.loads(toml_str))
 
     return overrides
+
+
+def get_metadata_from_config(config: Dict[str, Any]) -> Tuple[str, str]:
+    """Extract `fab_version` and `fab_id` from a project config."""
+    return (
+        config["project"]["version"],
+        f"{config['tool']['flwr']['app']['publisher']}/{config['project']['name']}",
+    )

flwr/common/typing.py

@@ -199,3 +199,11 @@ class Run:
     fab_id: str
     fab_version: str
     override_config: UserConfig
+
+
+@dataclass
+class Fab:
+    """Fab file representation."""
+
+    hash_str: str
+    content: bytes

flwr/proto/fab_pb2.py

@@ -14,7 +14,7 @@ _sym_db = _symbol_database.Default()
 
 
 
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x14\x66lwr/proto/fab.proto\x12\nflwr.proto\"$\n\x03\x46\x61\x62\x12\x0c\n\x04hash\x18\x01 \x01(\t\x12\x0f\n\x07\x63ontent\x18\x02 \x01(\x0c\"\x1d\n\rGetFabRequest\x12\x0c\n\x04hash\x18\x01 \x01(\t\".\n\x0eGetFabResponse\x12\x1c\n\x03\x66\x61\x62\x18\x01 \x01(\x0b\x32\x0f.flwr.proto.Fabb\x06proto3')
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x14\x66lwr/proto/fab.proto\x12\nflwr.proto\"(\n\x03\x46\x61\x62\x12\x10\n\x08hash_str\x18\x01 \x01(\t\x12\x0f\n\x07\x63ontent\x18\x02 \x01(\x0c\"!\n\rGetFabRequest\x12\x10\n\x08hash_str\x18\x01 \x01(\t\".\n\x0eGetFabResponse\x12\x1c\n\x03\x66\x61\x62\x18\x01 \x01(\x0b\x32\x0f.flwr.proto.Fabb\x06proto3')
 
 _globals = globals()
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
@@ -22,9 +22,9 @@ _builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'flwr.proto.fab_pb2', _globa
 if _descriptor._USE_C_DESCRIPTORS == False:
   DESCRIPTOR._options = None
   _globals['_FAB']._serialized_start=36
-  _globals['_FAB']._serialized_end=72
-  _globals['_GETFABREQUEST']._serialized_start=74
-  _globals['_GETFABREQUEST']._serialized_end=103
-  _globals['_GETFABRESPONSE']._serialized_start=105
-  _globals['_GETFABRESPONSE']._serialized_end=151
+  _globals['_FAB']._serialized_end=76
+  _globals['_GETFABREQUEST']._serialized_start=78
+  _globals['_GETFABREQUEST']._serialized_end=111
+  _globals['_GETFABRESPONSE']._serialized_start=113
+  _globals['_GETFABRESPONSE']._serialized_end=159
 # @@protoc_insertion_point(module_scope)

flwr/proto/fab_pb2.pyi

@@ -12,9 +12,9 @@ DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
 
 class Fab(google.protobuf.message.Message):
     DESCRIPTOR: google.protobuf.descriptor.Descriptor
-    HASH_FIELD_NUMBER: builtins.int
+    HASH_STR_FIELD_NUMBER: builtins.int
     CONTENT_FIELD_NUMBER: builtins.int
-    hash: typing.Text
+    hash_str: typing.Text
     """This field is the hash of the data field. It is used to identify the data.
     The hash is calculated using the SHA-256 algorithm and is represented as a
     hex string (sha256hex).
@@ -25,21 +25,21 @@ class Fab(google.protobuf.message.Message):
 
     def __init__(self,
         *,
-        hash: typing.Text = ...,
+        hash_str: typing.Text = ...,
         content: builtins.bytes = ...,
         ) -> None: ...
-    def ClearField(self, field_name: typing_extensions.Literal["content",b"content","hash",b"hash"]) -> None: ...
+    def ClearField(self, field_name: typing_extensions.Literal["content",b"content","hash_str",b"hash_str"]) -> None: ...
 global___Fab = Fab
 
 class GetFabRequest(google.protobuf.message.Message):
     DESCRIPTOR: google.protobuf.descriptor.Descriptor
-    HASH_FIELD_NUMBER: builtins.int
-    hash: typing.Text
+    HASH_STR_FIELD_NUMBER: builtins.int
+    hash_str: typing.Text
     def __init__(self,
         *,
-        hash: typing.Text = ...,
+        hash_str: typing.Text = ...,
         ) -> None: ...
-    def ClearField(self, field_name: typing_extensions.Literal["hash",b"hash"]) -> None: ...
+    def ClearField(self, field_name: typing_extensions.Literal["hash_str",b"hash_str"]) -> None: ...
 global___GetFabRequest = GetFabRequest
 
 class GetFabResponse(google.protobuf.message.Message):

flwr/server/run_serverapp.py

@@ -24,7 +24,8 @@ from typing import Optional
 from flwr.common import Context, EventType, RecordSet, event
 from flwr.common.config import (
     get_flwr_dir,
-    get_fused_config,
+    get_fused_config_from_dir,
+    get_metadata_from_config,
     get_project_config,
     get_project_dir,
 )
@@ -146,51 +147,50 @@ def run_server_app() -> None:  # pylint: disable=too-many-branches
             cert_path,
         )
 
-    server_app_attr: Optional[str] = getattr(args, "server-app")
-    if not (server_app_attr is None) ^ (args.run_id is None):
+    app_path: Optional[str] = args.app
+    if not (app_path is None) ^ (args.run_id is None):
         raise sys.exit(
-            "Please provide either a ServerApp reference or a Run ID, but not both. "
+            "Please provide either a Flower App path or a Run ID, but not both. "
             "For more details, use: ``flower-server-app -h``"
         )
 
     # Initialize GrpcDriver
-    if args.run_id is not None:
-        # User provided `--run-id`, but not `server-app`
+    if app_path is None:
+        # User provided `--run-id`, but not `app_dir`
         driver = GrpcDriver(
             run_id=args.run_id,
             driver_service_address=args.superlink,
             root_certificates=root_certificates,
         )
+        flwr_dir = get_flwr_dir(args.flwr_dir)
+        run_ = driver.run
+        app_path = str(get_project_dir(run_.fab_id, run_.fab_version, flwr_dir))
+        config = get_project_config(app_path)
     else:
-        # User provided `server-app`, but not `--run-id`
+        # User provided `app_dir`, but not `--run-id`
         # Create run if run_id is not provided
         driver = GrpcDriver(
             run_id=0,  # Will be overwritten
             driver_service_address=args.superlink,
             root_certificates=root_certificates,
         )
+        # Load config from the project directory
+        config = get_project_config(app_path)
+        fab_version, fab_id = get_metadata_from_config(config)
+
         # Create run
-        req = CreateRunRequest(fab_id=args.fab_id, fab_version=args.fab_version)
+        req = CreateRunRequest(fab_id=fab_id, fab_version=fab_version)
         res: CreateRunResponse = driver._stub.CreateRun(req)  # pylint: disable=W0212
         # Overwrite driver._run_id
         driver._run_id = res.run_id  # pylint: disable=W0212
 
-    server_app_run_config = {}
-
-    # Dynamically obtain ServerApp path based on run_id
-    if args.run_id is not None:
-        # User provided `--run-id`, but not `server-app`
-        flwr_dir = get_flwr_dir(args.flwr_dir)
-        run_ = driver.run
-        server_app_dir = str(get_project_dir(run_.fab_id, run_.fab_version, flwr_dir))
-        config = get_project_config(server_app_dir)
-        server_app_attr = config["tool"]["flwr"]["app"]["components"]["serverapp"]
-        server_app_run_config = get_fused_config(run_, flwr_dir)
-    else:
-        # User provided `server-app`, but not `--run-id`
-        server_app_dir = str(Path(args.dir).absolute())
+    # Obtain server app reference and the run config
+    server_app_attr = config["tool"]["flwr"]["app"]["components"]["serverapp"]
+    server_app_run_config = get_fused_config_from_dir(
+        Path(app_path), driver.run.override_config
+    )
 
-    log(DEBUG, "Flower will load ServerApp `%s` in %s", server_app_attr, server_app_dir)
+    log(DEBUG, "Flower will load ServerApp `%s` in %s", server_app_attr, app_path)
 
     log(
         DEBUG,
@@ -201,7 +201,7 @@ def run_server_app() -> None:  # pylint: disable=too-many-branches
     # Run the ServerApp with the Driver
     run(
         driver=driver,
-        server_app_dir=server_app_dir,
+        server_app_dir=app_path,
         server_app_run_config=server_app_run_config,
         server_app_attr=server_app_attr,
     )
@@ -219,15 +219,16 @@ def _parse_args_run_server_app() -> argparse.ArgumentParser:
     )
 
     parser.add_argument(
-        "server-app",
+        "app",
         nargs="?",
         default=None,
-        help="For example: `server:app` or `project.package.module:wrapper.app`",
+        help="Load and run the `ServerApp` from the specified Flower App path. "
+        "The `pyproject.toml` file must be located in the root of this path.",
     )
     parser.add_argument(
         "--insecure",
         action="store_true",
-        help="Run the server app without HTTPS. By default, the app runs with "
+        help="Run the `ServerApp` without HTTPS. By default, the app runs with "
         "HTTPS enabled. Use this flag only if you understand the risks.",
     )
     parser.add_argument(
@@ -252,25 +253,6 @@ def _parse_args_run_server_app() -> argparse.ArgumentParser:
         default=ADDRESS_DRIVER_API,
         help="SuperLink Driver API (gRPC-rere) address (IPv4, IPv6, or a domain name)",
     )
-    parser.add_argument(
-        "--dir",
-        default="",
-        help="Add specified directory to the PYTHONPATH and load Flower "
-        "app from there."
-        " Default: current working directory.",
-    )
-    parser.add_argument(
-        "--fab-id",
-        default=None,
-        type=str,
-        help="The identifier of the FAB used in the run.",
-    )
-    parser.add_argument(
-        "--fab-version",
-        default=None,
-        type=str,
-        help="The version of the FAB used in the run.",
-    )
     parser.add_argument(
         "--run-id",
         default=None,

flwr/server/superlink/fleet/vce/backend/backend.py

@@ -29,7 +29,7 @@ BackendConfig = Dict[str, Dict[str, ConfigsRecordValues]]
 class Backend(ABC):
     """Abstract base class for a Simulation Engine Backend."""
 
-    def __init__(self, backend_config: BackendConfig, work_dir: str) -> None:
+    def __init__(self, backend_config: BackendConfig) -> None:
         """Construct a backend."""
 
     @abstractmethod

flwr/server/superlink/fleet/vce/backend/raybackend.py

@@ -14,9 +14,8 @@
 # ==============================================================================
 """Ray backend for the Fleet API using the Simulation Engine."""
 
-import pathlib
 from logging import DEBUG, ERROR
-from typing import Callable, Dict, List, Tuple, Union
+from typing import Callable, Dict, Tuple, Union
 
 import ray
 
@@ -33,7 +32,6 @@ from .backend import Backend, BackendConfig
 
 ClientResourcesDict = Dict[str, Union[int, float]]
 ActorArgsDict = Dict[str, Union[int, float, Callable[[], None]]]
-RunTimeEnvDict = Dict[str, Union[str, List[str]]]
 
 
 class RayBackend(Backend):
@@ -42,18 +40,14 @@ class RayBackend(Backend):
     def __init__(
         self,
         backend_config: BackendConfig,
-        work_dir: str,
     ) -> None:
         """Prepare RayBackend by initialising Ray and creating the ActorPool."""
         log(DEBUG, "Initialising: %s", self.__class__.__name__)
         log(DEBUG, "Backend config: %s", backend_config)
 
-        if not pathlib.Path(work_dir).exists():
-            raise ValueError(f"Specified work_dir {work_dir} does not exist.")
-
         # Initialise ray
         self.init_args_key = "init_args"
-        self.init_ray(backend_config, work_dir)
+        self.init_ray(backend_config)
 
         # Validate client resources
         self.client_resources_key = "client_resources"
@@ -68,23 +62,6 @@ class RayBackend(Backend):
             actor_kwargs=actor_kwargs,
         )
 
-    def _configure_runtime_env(self, work_dir: str) -> RunTimeEnvDict:
-        """Return list of files/subdirectories to exclude relative to work_dir.
-
-        Without this, Ray will push everything to the Ray Cluster.
-        """
-        runtime_env: RunTimeEnvDict = {"working_dir": work_dir}
-
-        excludes = []
-        path = pathlib.Path(work_dir)
-        for p in path.rglob("*"):
-            # Exclude files need to be relative to the working_dir
-            if p.is_file() and not str(p).endswith(".py"):
-                excludes.append(str(p.relative_to(path)))
-        runtime_env["excludes"] = excludes
-
-        return runtime_env
-
     def _validate_client_resources(self, config: BackendConfig) -> ClientResourcesDict:
         client_resources_config = config.get(self.client_resources_key)
         client_resources: ClientResourcesDict = {}
@@ -123,26 +100,18 @@ class RayBackend(Backend):
                 actor_args["on_actor_init_fn"] = enable_tf_gpu_growth
         return actor_args
 
-    def init_ray(self, backend_config: BackendConfig, work_dir: str) -> None:
+    def init_ray(self, backend_config: BackendConfig) -> None:
         """Intialises Ray if not already initialised."""
         if not ray.is_initialized():
-            # Init ray and append working dir if needed
-            runtime_env = (
-                self._configure_runtime_env(work_dir=work_dir) if work_dir else None
-            )
-
             ray_init_args: Dict[
                 str,
-                Union[ConfigsRecordValues, RunTimeEnvDict],
+                ConfigsRecordValues,
             ] = {}
 
             if backend_config.get(self.init_args_key):
                 for k, v in backend_config[self.init_args_key].items():
                     ray_init_args[k] = v
 
-            if runtime_env is not None:
-                ray_init_args["runtime_env"] = runtime_env
-
             ray.init(**ray_init_args)
 
     @property

flwr/server/superlink/fleet/vce/vce_api.py

@@ -339,7 +339,7 @@ def start_vce(
 
     def backend_fn() -> Backend:
         """Instantiate a Backend."""
-        return backend_type(backend_config, work_dir=app_dir)
+        return backend_type(backend_config)
 
     # Load ClientApp if needed
     def _load() -> ClientApp:
@@ -347,9 +347,9 @@ def start_vce(
         if client_app_attr:
             app = _get_load_client_app_fn(
                 default_app_ref=client_app_attr,
-                project_dir=app_dir,
+                app_path=app_dir,
                 flwr_dir=flwr_dir,
-                multi_app=True,
+                multi_app=False,
             )(run.fab_id, run.fab_version)
 
         if client_app:

{flwr_nightly-1.11.0.dev20240805.dist-info → flwr_nightly-1.11.0.dev20240811.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: flwr-nightly
-Version: 1.11.0.dev20240805
+Version: 1.11.0.dev20240811
 Summary: Flower: A Friendly Federated Learning Framework
 Home-page: https://flower.ai
 License: Apache-2.0
@@ -33,7 +33,7 @@ Classifier: Typing :: Typed
 Provides-Extra: rest
 Provides-Extra: simulation
 Requires-Dist: cryptography (>=42.0.4,<43.0.0)
-Requires-Dist: grpcio (>=1.60.0,<2.0.0,!=1.64.2,!=1.65.1)
+Requires-Dist: grpcio (>=1.60.0,<2.0.0,!=1.64.2,!=1.65.1,!=1.65.2,!=1.65.4)
 Requires-Dist: iterators (>=0.0.2,<0.0.3)
 Requires-Dist: numpy (>=1.21.0,<2.0.0)
 Requires-Dist: pathspec (>=0.12.1,<0.13.0)

{flwr_nightly-1.11.0.dev20240805.dist-info → flwr_nightly-1.11.0.dev20240811.dist-info}/RECORD

@@ -1,12 +1,12 @@
 flwr/__init__.py,sha256=VmBWedrCxqmt4QvUHBLqyVEH6p7zaFMD_oCHerXHSVw,937
 flwr/cli/__init__.py,sha256=cZJVgozlkC6Ni2Hd_FAIrqefrkCGOV18fikToq-6iLw,720
 flwr/cli/app.py,sha256=FBcSrE35ll88VE11ib67qgsJe2GYDN25UswV9-cYcX8,1267
-flwr/cli/build.py,sha256=5igi2013fLH-TlR6MNpbxNEMaVqdBbts-E-WdY3JPsE,5167
+flwr/cli/build.py,sha256=gIR-nTgmLJY5ZtJFLN5ebFBCN3_hoqaioFT77AHojNU,5159
 flwr/cli/config_utils.py,sha256=WK6ywT-mHt2iMG90bspkSGMewv8jXh7yQPVdcPuT2JE,7540
 flwr/cli/example.py,sha256=1bGDYll3BXQY2kRqSN-oICqS5n1b9m0g0RvXTopXHl4,2215
 flwr/cli/install.py,sha256=AI6Zv2dQVDHpLDX1Z_vX5XHVxmZo1OU3ndCSrD2stzQ,7059
 flwr/cli/new/__init__.py,sha256=cQzK1WH4JP2awef1t2UQ2xjl1agVEz9rwutV18SWV1k,789
-flwr/cli/new/new.py,sha256=w7Zh9RIrwuasiyZoaj8eM1jTZJ8tzRiwLDXNT4TEAyg,9687
+flwr/cli/new/new.py,sha256=VNb31-NLedm-_OK_D0aed0QxHO-tVlXjnf9UWVhC_Jk,9612
 flwr/cli/new/templates/__init__.py,sha256=4luU8RL-CK8JJCstQ_ON809W9bNTkY1l9zSaPKBkgwY,725
 flwr/cli/new/templates/app/.gitignore.tpl,sha256=XixnHdyeMB2vwkGtGnwHqoWpH-9WChdyG0GXe57duhc,3078
 flwr/cli/new/templates/app/README.flowertune.md.tpl,sha256=PqzkGm0g6Zy-vZK9_0EO3f_U6g1r69lGc4UL8kds5Q8,2696
@@ -50,7 +50,7 @@ flwr/cli/new/templates/app/pyproject.pytorch.toml.tpl,sha256=vIO1ArukTC76ogYLNmJ
 flwr/cli/new/templates/app/pyproject.sklearn.toml.tpl,sha256=jk_5teoyOVM9QdBea8J-nk10S6TKw81QZiiKB54ATF0,654
 flwr/cli/new/templates/app/pyproject.tensorflow.toml.tpl,sha256=bRIvPCPvTTI4Eo5b61Rmw8WdDw3sjcohciTXgULN5l8,702
 flwr/cli/run/__init__.py,sha256=oCd6HmQDx-sqver1gecgx-uMA38BLTSiiKpl7RGNceg,789
-flwr/cli/run/run.py,sha256=s6I2EU6dmjJHPJ_LNdjIBe9UZlCwvf5RA5O61nAgO3g,7483
+flwr/cli/run/run.py,sha256=te6J1HxOOzyC47HMIrvbh-_4xVEGM1x_yXLIhlCBkb8,7521
 flwr/cli/utils.py,sha256=l65Ul0YsSBPuypk0uorAtEDmLEYiUrzpCXi6zCg9mJ4,4506
 flwr/client/__init__.py,sha256=wzJZsYJIHf_8-PMzvfbinyzzjgh1UP1vLrAw2_yEbKI,1345
 flwr/client/app.py,sha256=VJ_vPMVfur5_SqUjHa18VWLB6I9kOav78f5myC_iWuk,26110
@@ -83,11 +83,11 @@ flwr/client/numpy_client.py,sha256=u76GWAdHmJM88Agm2EgLQSvO8Jnk225mJTk-_TmPjFE,1
 flwr/client/rest_client/__init__.py,sha256=5KGlp7pjc1dhNRkKlaNtUfQmg8wrRFh9lS3P3uRS-7Q,735
 flwr/client/rest_client/connection.py,sha256=8LPk7zPvX3l3-5QQXNym8DkIe6V14uEHmTzQ8jCcsnQ,12198
 flwr/client/supernode/__init__.py,sha256=SUhWOzcgXRNXk1V9UgB5-FaWukqqrOEajVUHEcPkwyQ,865
-flwr/client/supernode/app.py,sha256=GI2jnttoUt31v39Q-F2dS-WZuesG7IhGXfhP0oylaUU,14694
+flwr/client/supernode/app.py,sha256=A_0VKCoNREjLPdzngJYPl2Pt5ZKWxbmdGgsJqWqzzy4,15236
 flwr/client/typing.py,sha256=dxoTBnTMfqXr5J7G3y-uNjqxYCddvxhu89spfj4Lm2U,1048
 flwr/common/__init__.py,sha256=4cBLNNnNTwHDnL_HCxhU5ILCSZ6fYh3A_aMBtlvHTVw,3721
 flwr/common/address.py,sha256=wRu1Luezx1PWadwV9OA_KNko01oVvbRnPqfzaDn8QOk,1882
-flwr/common/config.py,sha256=IN3UVfC4h-ItpbAOhJXNsVA63ZOJ05twsmIv3AbSU04,5599
+flwr/common/config.py,sha256=soJEX0bo3gcKpYlZBzu4NGiNVmwF0tEvqSnwWQsu3pw,6548
 flwr/common/constant.py,sha256=1XxuRezsr9fl3xvQNPR2kyFkwNeG_f5vZayv0PFh0kY,3012
 flwr/common/context.py,sha256=5Bd9RCrhLkYZOVR7vr97OVhzVBHQkS1fUsYiIKTwpxU,2239
 flwr/common/date.py,sha256=OcQuwpb2HxcblTqYm6H223ufop5UZw5N_fzalbpOVzY,891
@@ -120,7 +120,7 @@ flwr/common/secure_aggregation/secaggplus_constants.py,sha256=9MF-oQh62uD7rt9VeN
 flwr/common/secure_aggregation/secaggplus_utils.py,sha256=3VssKgYF7HQIkSpROnEUoYWVt47p12PE_Rj4nYqqg04,3221
 flwr/common/serde.py,sha256=0lXwbnILK16r1uFeV62pKJGxN78pArfOxo1AxAtGs6Q,23679
 flwr/common/telemetry.py,sha256=nSjJHDitPhzB2qUl6LeSMT9Zld5lIk9uW98RpxQwiZw,8366
-flwr/common/typing.py,sha256=tnpUbcAVFA-ic3yjoxwlQ-jjLPVUYN0B4ftUQzBVUY0,4633
+flwr/common/typing.py,sha256=ISp8UF94dtqml7ElaR6NeGCqcZX3xeab7KWMdjQEqcU,4730
 flwr/common/version.py,sha256=W1ntylR04xkCP6zeSet6sRtBn7P1cje2lOqBJgYBjJY,1349
 flwr/proto/__init__.py,sha256=hbY7JYakwZwCkYgCNlmHdc8rtvfoJbAZLalMdc--CGc,683
 flwr/proto/common_pb2.py,sha256=uzSmq0FJdC-MriN9UGPFs7QVIFTKJmX5lyLnzcyZ5WE,2405
@@ -139,8 +139,8 @@ flwr/proto/exec_pb2.py,sha256=7b1JUZgt04lBxdXpnd3WOOwmY2egUausm4G1wbmXFPs,3120
 flwr/proto/exec_pb2.pyi,sha256=R9xCAUxkLvuXcvQfhNGZ5Qy8qiUCdjN-gp3Iy5BmkNo,4110
 flwr/proto/exec_pb2_grpc.py,sha256=faAN19XEMP8GTKrcIU6jvlWkN44n2KiUsZh_OG0sYcg,4072
 flwr/proto/exec_pb2_grpc.pyi,sha256=VrFhT1Um3Nb8UC2YqnR9GIiM-Yyx0FqaxVOWljh-G_w,1208
-flwr/proto/fab_pb2.py,sha256=k1L3z4L3pJGRIUmgt609xUe-UAtSKFwT0C7wXnb12IY,1427
-flwr/proto/fab_pb2.pyi,sha256=G2eHjgIAeVAf4TchXg3XPdeUk-h5-OMJnAv7CLyxdGs,1930
+flwr/proto/fab_pb2.py,sha256=ztC3HnD5e-bYpp7lxrlxkdc30haAlBHswTnt4X5G1eg,1432
+flwr/proto/fab_pb2.pyi,sha256=wQXdQkcij6CrkmclIT5tU9SkOSZHTqm3PxWJWu4-CPI,1970
 flwr/proto/fab_pb2_grpc.py,sha256=1oboBPFxaTEXt9Aw7EAj8gXHDCNMhZD2VXqocC9l_gk,159
 flwr/proto/fab_pb2_grpc.pyi,sha256=ff2TSiLVnG6IVQcTGzb2DIH3XRSoAvAo_RMcvbMFyc0,76
 flwr/proto/fleet_pb2.py,sha256=euBC2M_LfQSwiSK9kFi18OvoV1gnQT4cC9lAMCCiOGY,4729
@@ -187,7 +187,7 @@ flwr/server/driver/driver.py,sha256=NT_yaeit7_kZEIsCEqOWPID1GrVD3ywH4xZ2wtIh5lM,
 flwr/server/driver/grpc_driver.py,sha256=4LMLDXjMU1VdHsj9nyqFIF71GWVsUR85fsO6biWMHRU,9710
 flwr/server/driver/inmemory_driver.py,sha256=RcK94_NtjGZ4aZDIscnU7A3Uv1u8jGx29-xcbjQvZTM,6444
 flwr/server/history.py,sha256=bBOHKyX1eQONIsUx4EUU-UnAk1i0EbEl8ioyMq_UWQ8,5063
-flwr/server/run_serverapp.py,sha256=khrB9bQ42p8DMRJLGoY_pQJ5bkpXyBPL0eyPdZJo29Y,9430
+flwr/server/run_serverapp.py,sha256=8HCGSVaNYd2cnd_j-JpVTRH7Cg8_U7ATZUejiMmJe0o,8894
 flwr/server/server.py,sha256=wsXsxMZ9SQ0B42nBnUlcV83NJPycgrgg5bFwcQ4BYBE,17821
 flwr/server/server_app.py,sha256=1hul76ospG8L_KooK_ewn1sWPNTNYLTtZMeGNOBNruA,6267
 flwr/server/server_config.py,sha256=CZaHVAsMvGLjpWVcLPkiYxgJN4xfIyAiUrCI3fETKY4,1349
@@ -237,9 +237,9 @@ flwr/server/superlink/fleet/rest_rere/__init__.py,sha256=5jbYbAn75sGv-gBwOPDySE0
 flwr/server/superlink/fleet/rest_rere/rest_api.py,sha256=yoSU-6nCJF9ASHGNpSY69nZbUhPGXkMIKYDgybKQX3c,7672
 flwr/server/superlink/fleet/vce/__init__.py,sha256=36MHKiefnJeyjwMQzVUK4m06Ojon3WDcwZGQsAcyVhQ,783
 flwr/server/superlink/fleet/vce/backend/__init__.py,sha256=psQjI1DQHOM5uWVXM27l_wPHjfEkMUTP-_8-lEFH1JA,1466
-flwr/server/superlink/fleet/vce/backend/backend.py,sha256=iG3KSIY7DzNfcxmuLfTs7VdQJnqPCvvn5DFkTWKG5lI,2227
-flwr/server/superlink/fleet/vce/backend/raybackend.py,sha256=SnjZ1WOcrfMZNgiDdTHcFeXJqrY7UHx8kvO62mqU9S4,7489
-flwr/server/superlink/fleet/vce/vce_api.py,sha256=jTAUX472qRIZefSL64rwLkhRe01PX_YwhFpWoLwk6Tc,12770
+flwr/server/superlink/fleet/vce/backend/backend.py,sha256=KL0eHScWr_YfP2eY3VP8_OOMgZwnRNW7qpu5J-ISpXI,2212
+flwr/server/superlink/fleet/vce/backend/raybackend.py,sha256=6-CjUTv1cFnAb53cZzEYCuVLrVu60tPczTo8meqeqbk,6289
+flwr/server/superlink/fleet/vce/vce_api.py,sha256=AeJBEZIC3V54Wg4bzBJa0aO4IXUNiRzRDRv-EKhqtpQ,12750
 flwr/server/superlink/state/__init__.py,sha256=Gj2OTFLXvA-mAjBvwuKDM3rDrVaQPcIoybSa2uskMTE,1003
 flwr/server/superlink/state/in_memory_state.py,sha256=LnKlnXe9JjVHb5_XOo6eD1RQhlCvJVKgz_CkXrMz8DY,13069
 flwr/server/superlink/state/sqlite_state.py,sha256=LdLnHtF8C-1L1IAglfZPqIuKa782Qo7qAYzTXMdMYGM,29052
@@ -270,8 +270,8 @@ flwr/superexec/exec_grpc.py,sha256=PhqGoZEpTMxSQmUSV8Wgtzb1Za_pHJ-adZqo5RYnDyE,1
 flwr/superexec/exec_servicer.py,sha256=fxQAKfgmQRSnYq5anjryfGeRbsZrNFEkuiNcTZhRwiE,2320
 flwr/superexec/executor.py,sha256=k_adivto6R2U82DADOHNvdtobehBYreRek1gOEBIQnQ,2318
 flwr/superexec/simulation.py,sha256=lfdClQYSAIMHe43aJ0Pk-kBw_xoV09LsIMfHo2eo-Ck,6775
-flwr_nightly-1.11.0.dev20240805.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
-flwr_nightly-1.11.0.dev20240805.dist-info/METADATA,sha256=GbnPZD32eyE4EtjGhNPvXtx0eATKrt8oTW0Y7Qa6k9c,15672
-flwr_nightly-1.11.0.dev20240805.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
-flwr_nightly-1.11.0.dev20240805.dist-info/entry_points.txt,sha256=7qBQcA-bDGDxnJmLd9FYqglFQubjCNqyg9M8a-lukps,336
-flwr_nightly-1.11.0.dev20240805.dist-info/RECORD,,
+flwr_nightly-1.11.0.dev20240811.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+flwr_nightly-1.11.0.dev20240811.dist-info/METADATA,sha256=_auggocO__wMNHqoNJK1_XN8doddMwaMl6rvFt6xd0I,15690
+flwr_nightly-1.11.0.dev20240811.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
+flwr_nightly-1.11.0.dev20240811.dist-info/entry_points.txt,sha256=7qBQcA-bDGDxnJmLd9FYqglFQubjCNqyg9M8a-lukps,336
+flwr_nightly-1.11.0.dev20240811.dist-info/RECORD,,