Source code for bacommon.docui._docui

# Released under the MIT License. See LICENSE for details.
#
"""Version 1 of our doc-ui system."""

from __future__ import annotations

from enum import Enum
from dataclasses import dataclass
from typing import override, assert_never, TYPE_CHECKING, Annotated

from efro.dataclassio import ioprepped, IOAttrs, IOMultiType
from bacommon.locale import Locale

if TYPE_CHECKING:
    pass




class DocUIRequestTypeID(Enum):
    """Type ID for each of our subclasses."""

    UNKNOWN = 'u'
    V1 = 'v1'





class DocUIRequest(IOMultiType[DocUIRequestTypeID]):
    """A request for some UI."""



    @override
    @classmethod
    def get_type_id(cls) -> DocUIRequestTypeID:
        # Require child classes to supply this themselves. If we did a
        # full type registry/lookup here it would require us to import
        # everything and would prevent lazy loading.
        raise NotImplementedError()




    @override
    @classmethod
    def get_type(cls, type_id: DocUIRequestTypeID) -> type[DocUIRequest]:
        """Return the subclass for each of our type-ids."""
        # pylint: disable=cyclic-import

        t = DocUIRequestTypeID
        if type_id is t.UNKNOWN:
            return UnknownDocUIRequest
        if type_id is t.V1:
            from bacommon.docui.v1 import Request

            return Request

        # Make sure we cover all types.
        assert_never(type_id)




    @override
    @classmethod
    def get_unknown_type_fallback(cls) -> DocUIRequest:
        # If we encounter some future type we don't know anything about,
        # drop in a placeholder.
        return UnknownDocUIRequest()




    @override
    @classmethod
    def get_type_id_storage_name(cls) -> str:
        return '_t'






@ioprepped
@dataclass
class UnknownDocUIRequest(DocUIRequest):
    """Fallback type for unrecognized UI types.

    Will show the client a 'cannot display this UI' placeholder request.
    """



    @override
    @classmethod
    def get_type_id(cls) -> DocUIRequestTypeID:
        return DocUIRequestTypeID.UNKNOWN






class DocUIResponseTypeID(Enum):
    """Type ID for each of our subclasses."""

    UNKNOWN = 'u'
    V1 = 'v1'





class DocUIResponse(IOMultiType[DocUIResponseTypeID]):
    """A UI provied in response to a :class:`DocUIRequest`."""



    @override
    @classmethod
    def get_type_id(cls) -> DocUIResponseTypeID:
        # Require child classes to supply this themselves. If we did a
        # full type registry/lookup here it would require us to import
        # everything and would prevent lazy loading.
        raise NotImplementedError()




    @override
    @classmethod
    def get_type(cls, type_id: DocUIResponseTypeID) -> type[DocUIResponse]:
        """Return the subclass for each of our type-ids."""
        # pylint: disable=cyclic-import

        t = DocUIResponseTypeID
        if type_id is t.UNKNOWN:
            return UnknownDocUIResponse
        if type_id is t.V1:
            from bacommon.docui.v1 import Response

            return Response

        # Make sure we cover all types.
        assert_never(type_id)




    @override
    @classmethod
    def get_unknown_type_fallback(cls) -> DocUIResponse:
        # If we encounter some future type we don't know anything about,
        # drop in a placeholder.
        return UnknownDocUIResponse()




    @override
    @classmethod
    def get_type_id_storage_name(cls) -> str:
        return '_t'






@ioprepped
@dataclass
class UnknownDocUIResponse(DocUIResponse):
    """Fallback type for unrecognized UI types.

    Will show the client a 'cannot display this UI' placeholder response.
    """



    @override
    @classmethod
    def get_type_id(cls) -> DocUIResponseTypeID:
        return DocUIResponseTypeID.UNKNOWN






@ioprepped
@dataclass
class DocUIWebRequest:
    """Complete data sent for doc-ui http requests."""

    #: The wrapped doc-ui request.
    doc_ui_request: DocUIRequest

    #: The current locale of the client. doc-ui generally deals in raw
    #: strings and expects localization to happen on the server.
    locale: Locale

    #: Engine build number. In some cases it may make sense to adjust
    #: responses depending on available engine features.
    engine_build_number: int





@ioprepped
@dataclass
class DocUIWebResponse:
    """Complete data returned for doc-ui http requests."""

    #: Human readable error string (if an error occurs). Either this or
    #: doc_ui_response should be set; not both.
    error: str | None = None

    #: doc-ui response. Either this or error should be set; not both.
    doc_ui_response: DocUIResponse | None = None



# Docs-generation hack; import some stuff that we likely only forward-declared
# in our actual source code so that docs tools can find it.
from typing import (Coroutine, Any, Literal, Callable,
  Generator, Awaitable, Sequence, Self)
import asyncio
from concurrent.futures import Future
from pathlib import Path
from enum import Enum