Close the websocket connection

Author: btschwertfeger

kraken/futures/ws_client.py

@@ -153,8 +153,8 @@ async def start(self: FuturesWSClient) -> None:
         else:
             raise TimeoutError("Could not connect to the Kraken API!")
 
-    async def stop(self: FuturesWSClient) -> None:
-        """Method to stop the websocket connection."""
+    async def close(self: FuturesWSClient) -> None:
+        """Method to close the websocket connection."""
         if self._conn:
             await self._conn.stop()
         await super().close()
@@ -444,7 +444,7 @@ async def __aexit__(
     ) -> None:
         """Exit if used as context manager"""
         await super().__aexit__()
-        await self.stop()
+        await self.close()
 
 
 __all__ = ["FuturesWSClient"]

kraken/spot/websocket/__init__.py

@@ -137,8 +137,8 @@ async def start(self: SpotWSClientBase) -> None:
         else:
             raise TimeoutError("Could not connect to the Kraken API!")
 
-    async def stop(self: SpotWSClientBase) -> None:
-        """Method to stop the websocket connection."""
+    async def close(self: SpotWSClientBase) -> None:
+        """Method to close the websocket connection."""
         if self._pub_conn:
             await self._pub_conn.stop()
         if self._priv_conn:
@@ -185,7 +185,7 @@ async def __aexit__(
     ) -> None:
         """Exit if used as context manager"""
         await super().__aexit__()
-        await self.stop()
+        await self.close()
 
     async def get_ws_token(self: SpotWSClientBase) -> dict:
         """

tests/futures/test_futures_websocket.py

@@ -34,7 +34,7 @@ async def instantiate_client() -> None:
         await client.start()
         await async_sleep(4)
         assert not client.is_auth
-        await client.stop()
+        await client.close()
         await async_sleep(2)
 
     asyncio.run(instantiate_client())

tests/spot/test_spot_websocket.py

@@ -46,7 +46,7 @@ async def create_client() -> None:
         client = SpotWebsocketClientTestWrapper()
         await client.start()
         await async_sleep(5)
-        await client.stop()
+        await client.close()
 
     asyncio_run(create_client())