serve.py

import typer
from pathlib import Path
from typing import Optional
import logging

from src.enums import IndexType

logging.basicConfig(
    level=logging.INFO,
    format="%(asctime)s (%(threadName)s): %(name)s - %(levelname)s - %(message)s",
)

app = typer.Typer()
@app.command(
    help="Serve the REST API and frontend UI for WISE.",
    epilog="For more details about WISE, visit https://www.robots.ox.ac.uk/~vgg/software/wise/",
    no_args_is_help=True,
)
def main(
    project_dir: Path = typer.Option(
        help="Project directory path"
    ),
    theme_asset_dir: Path = typer.Option(
        "frontend/dist",
        exists=True,
        dir_okay=True,
        file_okay=False,
        help=(
            "Static HTML assets related to the user interface are served "
            "from this folder."
        ),
    ),
    index_type: Optional[IndexType] = typer.Option(
        None,
        help="The faiss index to use for serving"
    ),
    query_blocklist: Path = typer.Option(
        None,
        '--query-blocklist',
        '--query-blacklist',
        exists=True,
        dir_okay=False,
        file_okay=True,
        readable=True,
        help=(
            "A text file containing a list of words/phrases (each separated by a line break) "
            "that users should be blocked from searching. When the user enters a query that matches "
            "one of the terms in the blocklist, an error message will be returned"
        ),
    )
):
    # ensure that the frontend assets are built
    if not Path(theme_asset_dir / 'index.html').exists():
        raise FileNotFoundError(
            f"Frontend assets not found at {theme_asset_dir}. "
            "Please build the frontend assets using `npm install && npm run build`."
        )
    from api import serve

    serve(
        project_dir,
        theme_asset_dir,
        index_type.value if index_type else None,
        query_blocklist
    )


if __name__ == "__main__":
    app()