Move command line options to configuration file (#534)

Author: PGijsbers

docker-compose.dev.yaml

@@ -3,10 +3,7 @@ services:
     stdin_open: true
     volumes:
       - ./src:/app:ro
-    command: >
-      python main.py
-      --build-db if-absent
-      --reload
+    command: python main.py
 
   fill-db-with-examples:
     volumes:

docker-compose.yaml

@@ -14,9 +14,7 @@ services:
       - ES_PASSWORD=$ES_PASSWORD
     ports:
       - ${AIOD_REST_PORT}:8000
-    command: >
-      python main.py
-      --build-db if-absent
+    command: python main.py
     healthcheck:
       test: ["CMD", "python", "-c",  "import requests; requests.get('http://localhost:8000')"]
       start_interval: 1s

docs/hosting/index.md

@@ -112,7 +112,7 @@ Then run the startup commands again (either `up.sh` or `docker compose`).
 ### Creating the Database
 
 By default, the server will create a database on the provided MySQL server if it does not yet exist.
-You can change this behavior through the **build-db** command-line parameter,
+You can change this behavior through the **build-database** configuration parameter in `src/config.override.toml`,
 it takes the following options:
 
 * never: *never* creates the database, not even if there does not exist one yet.

pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "aiod_metadata_catalogue"
 description = "A Metadata Catalogue for AI on Demand "
-version = "1.4.20250529"
+version = "1.4.20250530"
 requires-python = ">=3.11"
 authors = [
     { name = "Adrián Alcolea" },

src/config.default.toml

@@ -9,11 +9,26 @@ database = "aiod"
 username = "root"
 password = "ok"
 
+# One of: 'never', 'if-absent', or 'drop-then-build'
+# Determines if the database is created:
+#    - never:
+#        *never* creates the database, not even if there does not exist one yet.
+#        Use this only if you expect the database to be created through other means, such
+#        as MySQL group replication.
+#    - if-absent:
+#        Creates a database only if none exists.
+#    - drop-then-build:
+#        Drops the database on startup to recreate it from scratch.
+#        THIS REMOVES ALL DATA PERMANENTLY. NO RECOVERY POSSIBLE.
+build_database = "if-absent"
+
 # Additional options for development
 [dev]
-reload = true
+reload = false
 request_timeout = 10  # seconds
 log_level = "INFO"  # Python log levels: https://docs.python.org/3/library/logging.html#logging-levels
+disable_reviews = false  # set to true to automatically publish submissions
+url_prefix = ""
 
 # Authentication and authorization
 [keycloak]

src/config.py

@@ -32,4 +32,5 @@ def _merge_configurations(
 CONFIG = _merge_configurations(DEFAULT_CONFIG, OVERRIDE_CONFIG)
 DB_CONFIG = CONFIG.get("database", {})
 KEYCLOAK_CONFIG = CONFIG.get("keycloak", {})
+DEV_CONFIG = CONFIG.get("dev", {})
 REQUEST_TIMEOUT = CONFIG.get("dev", {}).get("request_timeout", None)

src/main.py

@@ -17,7 +17,7 @@
 from starlette.requests import Request
 
 from authentication import get_user_or_raise, KeycloakUser, assert_required_settings_configured
-from config import KEYCLOAK_CONFIG
+from config import KEYCLOAK_CONFIG, DB_CONFIG, DEV_CONFIG
 from database.deletion.triggers import create_delete_triggers
 import database.authorization  # noqa  # Trigger registration of User, Permission -> likely obsolete when couple with aiod_entry is done
 from database.model.concept.concept import AIoDConcept
@@ -39,38 +39,6 @@
 from setup_logger import setup_logger
 
 
-def _parse_args() -> argparse.Namespace:
-    # TODO: refactor configuration (https://github.com/aiondemand/AIOD-rest-api/issues/82)
-    parser = argparse.ArgumentParser(description="Please refer to the README.")
-    parser.add_argument("--url-prefix", default="", help="Prefix for the api url.")
-    parser.add_argument(
-        "--build-db",
-        default="if-absent",
-        choices=["never", "if-absent", "drop-then-build"],
-        help="""
-        Determines if the database is created:\n
-            - never: *never* creates the database, not even if there does not exist one yet.
-                Use this only if you expect the database to be created through other means, such
-                as MySQL group replication.\n
-            - if-absent: Creates a database only if none exists.\n
-            - drop-then-build: Drops the database on startup to recreate it from scratch.
-                THIS REMOVES ALL DATA PERMANENTLY. NO RECOVERY POSSIBLE.
-        """,
-    )
-    parser.add_argument(
-        "--reload",
-        action=argparse.BooleanOptionalAction,
-        help="Use `--reload` for FastAPI.",
-    )
-    parser.add_argument(
-        "--disable-reviews",
-        action="store_true",
-        help="Use --disable-reviews to disable the review process for new assets."
-        "This does not affect the state of assets already created or under review.",
-    )
-    return parser.parse_args()
-
-
 def add_routes(app: FastAPI, url_prefix=""):
     """Add routes to the FastAPI application"""
 
@@ -121,9 +89,9 @@ def counts() -> dict:
 def create_app() -> FastAPI:
     """Create the FastAPI application, complete with routes."""
     setup_logger()
-    args = _parse_args()
     assert_required_settings_configured()
-    if args.build_db == "never":
+    build_database_setting = DB_CONFIG.get("build_database", "never")
+    if build_database_setting == "never":
         if not database_exists():
             logging.warning(
                 "AI-on-Demand database does not exist on the MySQL server, "
@@ -132,14 +100,15 @@ def create_app() -> FastAPI:
                 "this likely means that you will get errors or undefined behavior."
             )
     else:
-        build_database(args)
+        drop_database = build_database_setting == "drop-then-build"
+        build_database(drop_database=drop_database)
 
     pyproject_toml = pkg_resources.get_distribution("aiod_metadata_catalogue")
-    app = build_app(args.url_prefix, pyproject_toml.version)
+    app = build_app(url_prefix=DEV_CONFIG.get("url_prefix", ""), version=pyproject_toml.version)
     return app
 
 
-def build_app(url_prefix: str = "", version: str = "dev"):
+def build_app(*, url_prefix: str = "", version: str = "dev"):
     app = FastAPI(
         openapi_url=f"{url_prefix}/openapi.json",
         docs_url=f"{url_prefix}/docs",
@@ -197,16 +166,15 @@ async def add_sunset_header(request: Request, call_next):
     return app
 
 
-def build_database(args):
-    drop_database = args.build_db == "drop-then-build"
+def build_database(drop_database: bool = False):
     create_database(delete_first=drop_database)
     SQLModel.metadata.create_all(EngineSingleton().engine, checkfirst=True)
     with DbSession() as session:
         triggers = create_delete_triggers(AIoDConcept)
         for trigger in triggers:
             session.execute(trigger)
 
-        if args.disable_reviews:
+        if DEV_CONFIG.get("disable_reviews", False):
             disable_review_process(session)
         else:
             enable_review_process(session)
@@ -220,11 +188,19 @@ def build_database(args):
 
 def main():
     """Run the application. Placed in a separate function, to avoid having global variables"""
-    args = _parse_args()
+
+    # TODO: unify configuration and environment file?  GH#82
+    # This parsing allows users to see the message on `--help` or incorrect (old) invocations.
+    msg = (
+        "Configuration options can be set in the configuration file. "
+        "Please refer to the documentation pages."
+    )
+    argparse.ArgumentParser(description=msg).parse_args()
+
     uvicorn.run(
         "main:create_app",
         host="0.0.0.0",  # noqa: S104  # required to make the interface available outside of docker
-        reload=args.reload,
+        reload=DEV_CONFIG.get("reload", False),
         factory=True,
     )