Added CLI to generate FastAPI route manifest

Author: tieneupin

pyproject.toml

@@ -87,6 +87,7 @@ GitHub = "https://github.com/DiamondLightSource/python-murfey"
 "murfey.decrypt_password" = "murfey.cli.decrypt_db_password:run"
 "murfey.generate_key" = "murfey.cli.generate_crypto_key:run"
 "murfey.generate_password" = "murfey.cli.generate_db_password:run"
+"murfey.generate_route_manifest" = "murfey.cli.generate_route_manifest:run"
 "murfey.instrument_server" = "murfey.instrument_server:run"
 "murfey.repost_failed_calls" = "murfey.cli.repost_failed_calls:run"
 "murfey.server" = "murfey.server.run:run"

src/murfey/cli/generate_route_manifest.py

@@ -0,0 +1,138 @@
+"""
+CLI to generate a manifest of the FastAPI router paths present in both the instrument
+server and backend server to enable lookup of the URLs based on function name.
+"""
+
+import importlib
+import inspect
+import pkgutil
+from argparse import ArgumentParser
+from pathlib import Path
+from types import ModuleType
+from typing import Any
+
+import yaml
+from fastapi import APIRouter
+
+import murfey
+
+
+def find_routers(name: str) -> dict[str, APIRouter]:
+
+    def _extract_routers_from_module(module: ModuleType):
+        routers = {}
+        for name, obj in inspect.getmembers(module):
+            if isinstance(obj, APIRouter):
+                module_path = module.__name__
+                key = f"{module_path}.{name}"
+                routers[key] = obj
+        return routers
+
+    routers = {}
+
+    # Import the module or package
+    try:
+        root = importlib.import_module(name)
+    except ImportError:
+        raise ImportError(
+            f"Cannot import '{name}'. Please ensure that you've installed all the "
+            "dependencies for the client, instrument server, and backend server "
+            "before running this command."
+        )
+
+    # If it's a package, walk through submodules and extract routers from each
+    if hasattr(root, "__path__"):
+        module_list = pkgutil.walk_packages(root.__path__, prefix=name + ".")
+        for _, module_name, _ in module_list:
+            try:
+                module = importlib.import_module(module_name)
+            except ImportError:
+                raise ImportError(
+                    f"Cannot import '{module_name}'. Please ensure that you've "
+                    "installed all the dependencies for the client, instrument "
+                    "server, and backend server before running this command."
+                )
+
+            routers.update(_extract_routers_from_module(module))
+
+    # Extract directly from single module
+    else:
+        routers.update(_extract_routers_from_module(root))
+
+    return routers
+
+
+def get_route_manifest(routers: dict[str, APIRouter]):
+
+    manifest = {}
+
+    for router_name, router in routers.items():
+        routes = []
+        for route in router.routes:
+            path_params = []
+            for param in route.dependant.path_params:
+                param_type = param.type_ if param.type_ is not None else Any
+                param_info = {
+                    "name": param.name if hasattr(param, "name") else "",
+                    "type": (
+                        param_type.__name__
+                        if hasattr(param_type, "__name__")
+                        else str(param_type)
+                    ),
+                }
+                path_params.append(param_info)
+            route_info = {
+                "path": route.path if hasattr(route, "path") else "",
+                "function": route.name if hasattr(route, "name") else "",
+                "path_params": path_params,
+                "methods": list(route.methods) if hasattr(route, "methods") else [],
+            }
+            routes.append(route_info)
+        manifest[router_name] = routes
+    return manifest
+
+
+def run():
+    # Set up additional args
+    parser = ArgumentParser()
+    parser.add_argument(
+        "--debug",
+        action="store_true",
+        default=False,
+        help=("Outputs the modules being inspected when creating the route manifest"),
+    )
+    args = parser.parse_args()
+
+    # Find routers
+    print("Finding routers...")
+    routers = {
+        **find_routers("murfey.instrument_server.api"),
+        **find_routers("murfey.server.api"),
+    }
+    # Generate the manifest
+    print("Extracting route information")
+    manifest = get_route_manifest(routers)
+
+    # Verify
+    if args.debug:
+        for router_name, routes in manifest.items():
+            print(f"Routes found in {router_name!r}")
+            for route in routes:
+                for key, value in route.items():
+                    print(f"\t{key}: {value}")
+                print()
+
+    # Save the manifest
+    murfey_dir = Path(murfey.__path__[0])
+    manifest_file = murfey_dir / "util" / "route_manifest.yaml"
+    with open(manifest_file, "w") as file:
+        yaml.dump(manifest, file, default_flow_style=False, sort_keys=False)
+    print(
+        "Route manifest for instrument and backend servers saved to "
+        f"{str(manifest_file)!r}"
+    )
+    exit()
+
+
+if __name__ == "__main__":
+    run()