Implement read-only mode

Author: edan-bainglass

aiida_restapi/__init__.py

@@ -1,5 +1,3 @@
-"""AiiDA REST API for data queries and workflow managment."""
+"""AiiDA REST API for data queries and workflow management."""
 
 __version__ = '0.1.0a1'
-
-from .main import app  # noqa: F401

aiida_restapi/cli/__init__.py

@@ -0,0 +1,21 @@
+import click
+import uvicorn
+
+from aiida_restapi.main import create_app
+
+
+@click.group()
+def cli() -> None:
+    """AiiDA REST API management CLI."""
+    pass
+
+
+@cli.command()
+@click.option('--host', default='127.0.0.1', show_default=True, help='Host to bind.')
+@click.option('--port', default=8000, show_default=True, type=int, help='Port to bind.')
+@click.option('--read-only', is_flag=True, help='Run the REST API in read-only mode.')
+def start(read_only: bool, host: str, port: int) -> None:
+    """Start the AiiDA REST API service."""
+    click.echo(f'Starting REST API (read_only={read_only}) on {host}:{port}')
+    app = create_app(read_only=read_only)
+    uvicorn.run(app, host=host, port=port)

aiida_restapi/cli/main.py

@@ -7,26 +7,34 @@
 from aiida_restapi.routers import auth, computers, daemon, groups, nodes, submit, users
 from aiida_restapi.utils import generate_endpoints_table
 
-app = FastAPI()
 
+def generate_endpoints_table_endpoint(app: FastAPI):
+    """Generate an endpoint that lists all registered API routes."""
 
-@app.get('/', response_class=HTMLResponse)
-def list_endpoints(request: Request) -> HTMLResponse:
-    """Return an HTML table of all registered API routes."""
-    return HTMLResponse(
-        content=generate_endpoints_table(
-            str(request.base_url).rstrip('/'),
-            app.routes,
-        ),
-    )
+    def list_endpoints(request: Request) -> HTMLResponse:
+        """Return an HTML table of all registered API routes."""
+        return HTMLResponse(
+            content=generate_endpoints_table(
+                str(request.base_url).rstrip('/'),
+                app.routes,
+            ),
+        )
 
+    return list_endpoints
 
-app.include_router(auth.router)
-app.include_router(computers.router)
-app.include_router(daemon.router)
-app.include_router(nodes.router)
-app.include_router(groups.router)
-app.include_router(users.router)
-app.include_router(submit.router)
 
-app.add_route('/graphql', main.app, name='graphql', methods=['POST'])
+def create_app(read_only: bool = False) -> FastAPI:
+    """Create the FastAPI application and include the routers."""
+    app = FastAPI()
+    app.include_router(auth.router)
+
+    for module in (computers, daemon, groups, nodes, submit, users):
+        if read_router := getattr(module, 'read_router', None):
+            app.include_router(read_router)
+        if not read_only and (write_router := getattr(module, 'write_router', None)):
+            app.include_router(write_router)
+
+    app.add_route('/graphql', main.app)
+    app.add_route('/', lambda request: generate_endpoints_table_endpoint(app)(request))
+
+    return app

aiida_restapi/main.py

@@ -12,13 +12,14 @@
 
 from .auth import UserInDB, get_current_active_user
 
-router = APIRouter()
+read_router = APIRouter()
+write_router = APIRouter()
 
 
 repository = EntityRepository[orm.Computer, orm.Computer.Model](orm.Computer)
 
 
-@router.get('/computers/schema')
+@read_router.get('/computers/schema')
 async def get_computers_schema(
     which: t.Literal['get', 'post'] | None = Query(
         None,
@@ -43,7 +44,7 @@ async def get_computers_schema(
     raise HTTPException(status_code=400, detail='Parameter "which" must be either "get" or "post"')
 
 
-@router.get('/computers/projectable_properties', response_model=list[str])
+@read_router.get('/computers/projectable_properties', response_model=list[str])
 async def get_computer_projectable_properties() -> list[str]:
     """Get projectable properties for AiiDA computers.
 
@@ -52,7 +53,7 @@ async def get_computer_projectable_properties() -> list[str]:
     return repository.get_projectable_properties()
 
 
-@router.get(
+@read_router.get(
     '/computers',
     response_model=PaginatedResults[orm.Computer.Model],
     response_model_exclude_none=True,
@@ -69,7 +70,7 @@ async def get_computers(
     return repository.get_entities(queries)
 
 
-@router.get(
+@read_router.get(
     '/computers/{comp_id}',
     response_model=orm.Computer.Model,
     response_model_exclude_none=True,
@@ -88,7 +89,7 @@ async def get_computer(comp_id: int) -> orm.Computer.Model:
         raise HTTPException(status_code=404, detail=f'Could not find any Computer with id {comp_id}')
 
 
-@router.post(
+@write_router.post(
     '/computers',
     response_model=orm.Computer.Model,
     response_model_exclude_none=True,

aiida_restapi/routers/computers.py

@@ -11,7 +11,8 @@
 
 from .auth import UserInDB, get_current_active_user
 
-router = APIRouter()
+read_router = APIRouter()
+write_router = APIRouter()
 
 
 class DaemonStatusModel(BaseModel):
@@ -21,7 +22,7 @@ class DaemonStatusModel(BaseModel):
     num_workers: t.Optional[int] = Field(description='The number of workers if the daemon is running.')
 
 
-@router.get(
+@read_router.get(
     '/daemon/status',
     response_model=DaemonStatusModel,
 )
@@ -44,7 +45,7 @@ async def get_daemon_status() -> DaemonStatusModel:
     return DaemonStatusModel(running=True, num_workers=response['numprocesses'])
 
 
-@router.post(
+@write_router.post(
     '/daemon/start',
     response_model=DaemonStatusModel,
 )
@@ -71,7 +72,7 @@ async def get_daemon_start(
     return DaemonStatusModel(running=True, num_workers=response['numprocesses'])
 
 
-@router.post(
+@write_router.post(
     '/daemon/stop',
     response_model=DaemonStatusModel,
 )

aiida_restapi/routers/daemon.py

@@ -12,12 +12,13 @@
 
 from .auth import UserInDB, get_current_active_user
 
-router = APIRouter()
+read_router = APIRouter()
+write_router = APIRouter()
 
 repository = EntityRepository[orm.Group, orm.Group.Model](orm.Group)
 
 
-@router.get('/groups/schema')
+@read_router.get('/groups/schema')
 async def get_groups_schema(
     which: t.Literal['get', 'post'] | None = Query(
         None,
@@ -42,7 +43,7 @@ async def get_groups_schema(
     raise HTTPException(status_code=400, detail='Parameter "which" must be either "get" or "post"')
 
 
-@router.get('/groups/projectable_properties', response_model=list[str])
+@read_router.get('/groups/projectable_properties', response_model=list[str])
 async def get_group_projectable_properties() -> list[str]:
     """Get projectable properties for AiiDA groups.
 
@@ -51,7 +52,7 @@ async def get_group_projectable_properties() -> list[str]:
     return repository.get_projectable_properties()
 
 
-@router.get(
+@read_router.get(
     '/groups',
     response_model=PaginatedResults[orm.Group.Model],
     response_model_exclude_none=True,
@@ -68,7 +69,7 @@ async def get_groups(
     return repository.get_entities(queries)
 
 
-@router.get(
+@read_router.get(
     '/groups/{group_id}',
     response_model=orm.Group.Model,
     response_model_exclude_none=True,
@@ -87,7 +88,7 @@ async def get_group(group_id: int) -> orm.Group.Model:
         raise HTTPException(status_code=404, detail=f'Could not find any Group with id {group_id}')
 
 
-@router.post(
+@write_router.post(
     '/groups',
     response_model=orm.Group.Model,
     response_model_exclude_none=True,

aiida_restapi/routers/groups.py

@@ -18,14 +18,15 @@
 
 from .auth import UserInDB, get_current_active_user
 
-router = APIRouter()
+read_router = APIRouter()
+write_router = APIRouter()
 
 
 repository = NodeRepository[orm.Node, orm.Node.Model](orm.Node)
 model_registry = NodeModelRegistry()
 
 
-@router.get('/nodes/schema')
+@read_router.get('/nodes/schema')
 async def get_nodes_schema(
     which: t.Literal['get', 'post'] | None = Query(
         None,
@@ -57,7 +58,7 @@ def generate_create_models() -> dict[str, dict[str, t.Any]]:
     )
 
 
-@router.get('/nodes/projectable_properties')
+@read_router.get('/nodes/projectable_properties')
 @with_dbenv()
 async def get_node_projectable_properties() -> list[str]:
     """Get projectable properties for AiiDA nodes.
@@ -67,7 +68,7 @@ async def get_node_projectable_properties() -> list[str]:
     return repository.get_projectable_properties()
 
 
-@router.get('/nodes/download_formats')
+@read_router.get('/nodes/download_formats')
 async def get_nodes_download_formats() -> dict[str, t.Any]:
     """Get download formats for AiiDA nodes.
 
@@ -76,7 +77,7 @@ async def get_nodes_download_formats() -> dict[str, t.Any]:
     return resources.get_all_download_formats()
 
 
-@router.get(
+@read_router.get(
     '/nodes',
     response_model=PaginatedResults[orm.Node.Model],
     response_model_exclude_none=True,
@@ -93,7 +94,7 @@ async def get_nodes(
     return repository.get_entities(queries)
 
 
-@router.get('/nodes/types')
+@read_router.get('/nodes/types')
 async def get_nodes_types() -> list:
     """
     Return all node types in a machine-actionable format:
@@ -123,7 +124,7 @@ async def get_nodes_types() -> list:
     ]
 
 
-@router.get(
+@read_router.get(
     '/nodes/types/{node_type}',
     response_model=PaginatedResults[orm.Node.Model],
     response_model_exclude_none=True,
@@ -149,7 +150,7 @@ async def get_nodes_by_type(
         raise HTTPException(status_code=400, detail=str(exception)) from exception
 
 
-@router.get('/nodes/types/{node_type}/projectable_properties')
+@read_router.get('/nodes/types/{node_type}/projectable_properties')
 @with_dbenv()
 async def get_node_class_projectable_properties(node_type: str) -> list[str]:
     """Get projectable properties of a given AiiDA node class.
@@ -166,7 +167,7 @@ async def get_node_class_projectable_properties(node_type: str) -> list[str]:
         raise HTTPException(status_code=400, detail=str(exception)) from exception
 
 
-@router.get('/nodes/types/{node_type}/schema')
+@read_router.get('/nodes/types/{node_type}/schema')
 async def get_node_class_schema(
     node_type: str,
     which: t.Literal['get', 'post'] | None = Query(
@@ -199,7 +200,7 @@ async def get_node_class_schema(
     raise HTTPException(status_code=404, detail='Parameter "which" must be either "get" or "post"')
 
 
-@router.get(
+@read_router.get(
     '/nodes/{node_id}',
     response_model=orm.Node.Model,
     response_model_exclude_none=True,
@@ -218,7 +219,7 @@ async def get_node(node_id: int) -> orm.Node.Model:
         raise HTTPException(status_code=404, detail=f'Could not find any Node with id {node_id}')
 
 
-@router.get('/nodes/{node_id}/download')
+@read_router.get('/nodes/{node_id}/download')
 @with_dbenv()
 async def download_node(
     node_id: int,
@@ -269,7 +270,7 @@ def stream() -> t.Generator[bytes, None, None]:
         )
 
 
-@router.get('/nodes/{node_id}/repo/contents')
+@write_router.get('/nodes/{node_id}/repo/contents')
 @with_dbenv()
 async def get_node_repo_file_contents(
     node_id: int,
@@ -315,7 +316,7 @@ def zip_stream() -> t.Generator[bytes, None, None]:
         return StreamingResponse(zip_stream(), media_type='application/zip')
 
 
-@router.post(
+@write_router.post(
     '/nodes',
     response_model=orm.Node.Model,
     response_model_exclude_none=True,
@@ -342,7 +343,7 @@ async def create_node(
 
 
 # TODO what about folderdata?
-@router.post(
+@write_router.post(
     '/nodes/file-upload',
     response_model=orm.Node.Model,
     response_model_exclude_none=True,

aiida_restapi/routers/nodes.py

@@ -13,7 +13,7 @@
 
 from .auth import UserInDB, get_current_active_user
 
-router = APIRouter()
+write_router = APIRouter()
 
 
 def process_inputs(inputs: dict[str, t.Any]) -> dict[str, t.Any]:
@@ -61,7 +61,7 @@ def validate_inputs(cls, inputs: dict[str, t.Any]) -> dict[str, t.Any]:
         return process_inputs(inputs)
 
 
-@router.post(
+@write_router.post(
     '/submit',
     response_model=orm.Node.Model,
     response_model_exclude_none=True,