feat(debug): add async support for debug operations

- add AsyncDebug class for async debug information retrieval
- add async tests for debug functionality
- add async fixtures for testing async debug operations
- remove future annotations imports from test files

Author: tharropoulos

src/typesense/async_debug.py

@@ -0,0 +1,71 @@
+"""
+This module provides async functionality for accessing debug information in Typesense.
+
+It contains the AsyncDebug class, which allows for retrieving debug information
+asynchronously.
+
+Classes:
+    AsyncDebug: Manages async operations for accessing debug information in the Typesense API.
+
+Dependencies:
+    - typesense.async_api_call: Provides the AsyncApiCall class for making async API requests.
+    - typesense.types.debug: Provides DebugResponseSchema type.
+
+Note: This module uses conditional imports to support both Python 3.11+ and earlier versions.
+"""
+
+import sys
+
+if sys.version_info >= (3, 11):
+    import typing
+else:
+    import typing_extensions as typing
+
+from typesense.async_api_call import AsyncApiCall
+from typesense.types.debug import DebugResponseSchema
+
+
+class AsyncDebug:
+    """
+    Manages async operations for accessing debug information in the Typesense API.
+
+    This class provides async methods to retrieve debug information from the Typesense server,
+    which can be useful for system diagnostics and troubleshooting.
+
+    Attributes:
+        resource_path (str): The API resource path for debug operations.
+        api_call (AsyncApiCall): The AsyncApiCall instance for making async API requests.
+    """
+
+    resource_path: typing.Final[str] = "/debug"
+
+    def __init__(self, api_call: AsyncApiCall) -> None:
+        """
+        Initialize the AsyncDebug instance.
+
+        Args:
+            api_call (AsyncApiCall): The AsyncApiCall instance for making async API requests.
+        """
+        self.api_call = api_call
+
+    async def retrieve(self) -> DebugResponseSchema:
+        """
+        Retrieve debug information from the Typesense server.
+
+        This method sends an async GET request to the debug endpoint and returns
+        the server's debug information.
+
+        Returns:
+            DebugResponseSchema: A schema containing the debug information.
+
+        Example:
+            >>> debug = AsyncDebug(async_api_call)
+            >>> info = await debug.retrieve()
+            >>> print(info["version"])
+        """
+        response: DebugResponseSchema = await self.api_call.get(
+            AsyncDebug.resource_path,
+            as_json=True,
+            entity_type=DebugResponseSchema,
+        )
+        return response

tests/debug_test.py

@@ -1,8 +1,9 @@
 """Tests for the Debug class."""
 
-from __future__ import annotations
 from tests.utils.object_assertions import assert_match_object, assert_object_lists_match
 from typesense.api_call import ApiCall
+from typesense.async_api_call import AsyncApiCall
+from typesense.async_debug import AsyncDebug
 from typesense.debug import Debug
 
 
@@ -24,6 +25,22 @@ def test_init(fake_api_call: ApiCall) -> None:
     assert debug.resource_path == "/debug"  # noqa: WPS437
 
 
+def test_init_async(fake_async_api_call: AsyncApiCall) -> None:
+    """Test that the AsyncDebug object is initialized correctly."""
+    debug = AsyncDebug(fake_async_api_call)
+
+    assert_match_object(debug.api_call, fake_async_api_call)
+    assert_object_lists_match(
+        debug.api_call.node_manager.nodes,
+        fake_async_api_call.node_manager.nodes,
+    )
+    assert_match_object(
+        debug.api_call.config.nearest_node,
+        fake_async_api_call.config.nearest_node,
+    )
+    assert debug.resource_path == "/debug"  # noqa: WPS437
+
+
 def test_actual_retrieve(actual_debug: Debug) -> None:
     """Test that the Debug object can retrieve a debug on Typesense server and verify response structure."""
     response = actual_debug.retrieve()
@@ -33,3 +50,14 @@ def test_actual_retrieve(actual_debug: Debug) -> None:
 
     assert isinstance(response["state"], int)
     assert isinstance(response["version"], str)
+
+
+async def test_actual_retrieve_async(actual_async_debug: AsyncDebug) -> None:
+    """Test that the AsyncDebug object can retrieve a debug on Typesense server and verify response structure."""
+    response = await actual_async_debug.retrieve()
+
+    assert "state" in response
+    assert "version" in response
+
+    assert isinstance(response["state"], int)
+    assert isinstance(response["version"], str)

tests/fixtures/debug_fixtures.py

@@ -3,6 +3,8 @@
 import pytest
 
 from typesense.api_call import ApiCall
+from typesense.async_api_call import AsyncApiCall
+from typesense.async_debug import AsyncDebug
 from typesense.debug import Debug
 
 
@@ -16,3 +18,15 @@ def actual_debug_fixture(actual_api_call: ApiCall) -> Debug:
 def fake_debug_fixture(fake_api_call: ApiCall) -> Debug:
     """Return a debug object with test values."""
     return Debug(fake_api_call)
+
+
+@pytest.fixture(scope="function", name="actual_async_debug")
+def actual_async_debug_fixture(actual_async_api_call: AsyncApiCall) -> AsyncDebug:
+    """Return a AsyncDebug object using a real API."""
+    return AsyncDebug(actual_async_api_call)
+
+
+@pytest.fixture(scope="function", name="fake_async_debug")
+def fake_async_debug_fixture(fake_async_api_call: AsyncApiCall) -> AsyncDebug:
+    """Return a AsyncDebug object with test values."""
+    return AsyncDebug(fake_async_api_call)