Source code for hyper2web.abstract

"""
This module defines all Abstract Types in the framework.
Mainly for Better Organization of Code and For Better IDE Type Inferences
"""


class AbstractApp:
    """
    This class is the base class of any App classes. The framework provides an `App` class which implements all methods of this class.
    
    A user can also implement this class if the user find that the `App` class is insufficient. But, the creator recommends user to extend `App` class instead of `AbstractApp` class.
    """
    def up(self):
        raise NotImplementedError

    def get(self, route: str, handler):
        raise NotImplementedError

    def post(self, route: str, handler):
        raise NotImplementedError

    async def handle_route(self, http, stream):
        """
        This function has to be async.
        """
        raise NotImplementedError


class AbstractRouter:
    def register(self, method: str, route: str, handler):
        raise NotImplementedError

    async def handle_route(self, http, stream):
        raise NotImplementedError


class AbstractHTTP:
    """
    The `HTTP` class implements this class.
    
    All methods declared here are async.
    """
    async def handle_event(self, event):
        raise NotImplementedError

    async def send(self, stream_id, headers, data):
        raise NotImplementedError


class AbstractResponse:
    """
    A Response should be constructed by the router.
    The router passes Stream information such as stream id to the Response object
    and Response object is passed to the end point function for top level users' use.
    
    The flow control is handled by the HTTP class. Therefore, a send method always ends the response.
    
    All send methods should call HTTP's send method
    """
    async def send(self, data: bytes):
        """
        send this response.
        :param headers: HTTP headers
        :param data: Body of the response. Has to be bytes
        That means, if you want to send some string, you have to convert the string to bytes.
        The framework does not do type conversion for you. It just fails if incorrect type is passed.
        """
        raise NotImplementedError

    async def send_file(self, file_path):
        raise NotImplementedError

    async def send_status_code(self, status_code):
        raise NotImplementedError


class AbstractRequest:
    pass