[Documentation] Example

[phigjm]

It would be cool to have a complet example code.
E.g. i tried this so far:

from moonraker_api import MoonrakerClient, MoonrakerListener


class APIConnector(MoonrakerListener):
    def __init__(self):
        self.running = False
        self.client = MoonrakerClient(
            self,
            "yourURL.local",
            "7125",
            "",
        )

    async def start(self) -> None:
        """Start the websocket connection."""
        self.running = True
        return await self.client.connect()

    async def stop(self) -> None:
        """Stop the websocket connection."""
        self.running = False
        await self.client.disconnect()


async def get_printer_info():
    api_connector = APIConnector()
    await api_connector.start()
    response = await api_connector.client.request("printer.info")
    return response


printer_info = asyncio.run(get_printer_info())

print(printer_info)

but I always get the error:

response = await api_connector.client.request("printer.info")
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
TypeError: object AwaitableTaskContext can't be used in 'await' expression
Unclosed client session
client_session: <aiohttp.client.ClientSession object at 0x0000024C10544290>```

[axlCastill0]

Hey @phigjm

I see that this issue was made almost a year ago, but I got into the same problem and I managed to find the solution.

I went into the code and found this piece of code using the request() method

async def call_method(self, method: str, **kwargs: Any) -> Any:
        """Call a json-rpc method and wait for the response.

        Args:
            **kwargs (optional): Used to pass RPC ``params`` to the call.

        Returns:
            A ``json`` object containing the ``response`` of the RPC method.
        """
        async with self.request(method, **kwargs) as req:
            return await req.get_result()

The last part of the snippet uses request() with async with

This is what I tried on your piece of code that I used to test connecting to my Klipper instance.

async def get_printer_info():
    """Get printer information."""
    conn = APIConnector()
    await conn.start()
    async with conn.client.request("printer.info") as req:
        response = await req.get_result()
    await conn.stop()
    return response

And this actually gives me my printer information by printing it

if __name__ == "__main__":
    printer_info = asyncio.run(get_printer_info())
    print("Printer Info:", printer_info)

Print example:

Printer Info: {'state': 'ready', 'state_message': 'Printer is ready', 'hostname': 'raspberrypi', 'klipper_path': '/home/acastillo/klipper', 'python_path': '/home/acastillo/klippy-env/bin/python', 'process_id': 4011, 'user_id': 1000, 'group_id': 1000, 'log_file': '/home/acastillo/printer_data/logs/klippy.log', 'config_file': '/home/acastillo/printer_data/config/printer.cfg', 'software_version': 'v0.12.0-CNC20240801-347-gc9804b63', 'cpu_info': '4 core ?'}

You could also just use call_method() and it will give the same result, plus it seems more straightforward:

async def get_printer_info():
    """Get printer information."""
    conn = APIConnector()
    await conn.start()
    response = await conn.client.call_method("printer.info")
    # async with conn.client.request("printer.info") as req:
    #     response = await req.get_result()
    await conn.stop()
    return response