extented-ws 0.1.4

This is a web socket wrapper for handling JSON messages in the 'handler' way

Extented Websockets

The library is based on Websockets
The observer-handlers approach is used, like in FastAPI and Aiogram it's allows you to quickly integrate web sockets into the project, and expand the list of requests-responses

Installation

pip install extented-ws

Usage

By default, the server accepts a JSON message of the following format:

{
  "Type": "CalculateRequest",
  "Data": {
    "numbers": [2, 2]
  }
}

After that, the server calls trigger from the observer, and that in turn calls all handlers whose first argument type name equals Type in JSON The returned object, in turn, will be the answer for the client When the observer finds the desired handlers, it calls it by passing arguments:

• Unpacked object from Data in JSON
• The user received from the authorization protocol

For known how create_protocol work see: Authentication, Factory

from extented_ws import WebsocketServer, telegram_protocol_factory

server = WebsocketServer()

class CalculateRequest(BaseModel):
    numbers: List[int]

class CalculateResponse(BaseModel):
    result: int

@server.message()
async def calculate_handler(request: CalculateRequest, user: WebAppUser): # user is optional argument
    result = 0

    for i in request.numbers:
        result += i

    return CalculateResponse(result=result)

async def main() -> None:
    """
        telegram_protocol_factory used for create TelegramAuthProtocol instance with bot token
    """
    await server.listen(create_protocol=telegram_protocol_factory(
        token=TOKEN
    ))


if __name__ == "__main__":
    logging.basicConfig(level=logging.INFO, stream=sys.stdout)
    asyncio.run(main())

Also see EXAMPLE