Skip to content

RunServer

Starts the Flask application using an appropriate server based on the operating system.

The module accepts optional command line arguments
  • First argument: Device type ('cuda' or 'cpu', defaults to 'cpu')
  • Second argument: Number of workers/threads (positive integer, defaults to 4)
Server selection
  • Linux: Uses Gunicorn with specified number of worker processes
  • Windows: Uses Waitress with specified number of threads
  • Other OS: Uses Flask's built-in development server

The server runs on port 21493 and binds to all network interfaces (0.0.0.0).

run_server 

run_server() -> None

Start the Flask application using an OS-appropriate server with configurable settings.

Command line arguments:

argv[1]: Device type ('cuda' or 'cpu', defaults to 'cpu')

argv[2]: Number of workers/threads (positive integer, defaults to 4)

Environment variables set:

DEVICE: Set to the specified device type ('cuda' or 'cpu')

Server configuration:

Gunicorn
  • Workers: Specified by argv[2]
  • Logs: ./logs/gunicorn_access.log and gunicorn_error.log
  • Binds to: 0.0.0.0:21493
Waitress
  • Threads: Specified by argv[2]
  • Port: 21493

Other OS: Flask development server

Source code in src/run_server.py 
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
def run_server() -> None:
    """
    Start the Flask application using an OS-appropriate server with configurable settings.

    Command line arguments:

        argv[1]: Device type ('cuda' or 'cpu', defaults to 'cpu')

        argv[2]: Number of workers/threads (positive integer, defaults to 4)

    Environment variables set:

        DEVICE: Set to the specified device type ('cuda' or 'cpu')

    Server configuration:

    Linux: Gunicorn
        - Workers: Specified by argv[2]
        - Logs: ./logs/gunicorn_access.log and gunicorn_error.log
        - Binds to: 0.0.0.0:21493

    Windows: Waitress
        - Threads: Specified by argv[2]
        - Port: 21493

        Other OS: Flask development server
    """
    os_type: str = platform.system()

    # Check for device argument
    if len(sys.argv) > 1:
        device = sys.argv[1].lower()
        if device not in ["cuda", "cpu"]:
            print("Invalid device argument. Use 'cuda' or 'cpu'.")
            sys.exit(1)
    else:
        device = "cpu"  # Default to CPU if no argument is provided

    # Check for threads argument
    if len(sys.argv) > 2:
        try:
            threads = int(sys.argv[2])
            if threads < 1:
                raise ValueError
        except ValueError:
            print("Invalid threads argument. Use a positive integer.")
            sys.exit(1)
    else:
        threads = 4  # Default to 4 threads if no argument is provided

    # Set the device as an environment variable
    os.environ["DEVICE"] = device

    if os_type == "Linux":
        # Use Gunicorn on Linux
        print(f"Running on Linux. Starting Gunicorn server with {threads} workers.")
        subprocess.run(
            [
                "gunicorn",
                "-w",
                str(threads),
                "-b",
                "0.0.0.0:21493",
                "--access-logfile",
                "./logs/gunicorn_access.log",
                "--error-logfile",
                "./logs/gunicorn_error.log",
                "src.api:app",
            ],
            check=True,
        )
    elif os_type == "Windows":
        # Use Waitress on Windows
        print(f"Running on Windows. Starting Waitress server with {threads} threads.")
        subprocess.run(
            ["waitress-serve", "--port=21493", f"--threads={threads}", "src.api:app"],
            check=True,
        )
    else:
        print(f"Running on {os_type}. Using Flask's built-in server.")
        subprocess.run(["python", "src.api:app"], check=True)