types.py

from __future__ import annotations

from threading import Thread
from typing import Optional, TypeVar

from typing_extensions import Protocol

from idom.core.types import ComponentConstructor


_App = TypeVar("_App")
_Config = TypeVar("_Config", contravariant=True)


class ServerFactory(Protocol[_App, _Config]):
    """Setup a :class:`Server`"""

    def __call__(
        self,
        constructor: ComponentConstructor,
        config: Optional[_Config] = None,
        app: Optional[_App] = None,
    ) -> ServerType[_App]:
        ...


class ServerType(Protocol[_App]):
    """A thin wrapper around a web server that provides a common operational interface"""

    app: _App
    """The server's underlying application"""

    def run(self, host: str, port: int) -> None:
        """Start running the server"""

    def run_in_thread(self, host: str, port: int) -> Thread:
        """Run the server in a thread"""

    def wait_until_started(self, timeout: Optional[float] = None) -> None:
        """Block until the server is able to receive requests"""

    def stop(self, timeout: Optional[float] = None) -> None:
        """Stop the running server"""