AioHTTPClient refined

Author: apetenchea

arangoasync/http.py

@@ -5,11 +5,14 @@
 ]
 
 from abc import ABC, abstractmethod
-from typing import Any, Optional
+from typing import Any, Generic, Optional, TypeVar
 
-from aiohttp import BaseConnector, BasicAuth, ClientSession, ClientTimeout, TcpConnector
-from request import Request
-from response import Response
+from aiohttp import BaseConnector, BasicAuth, ClientSession, ClientTimeout, TCPConnector
+
+from arangoasync.request import Request
+from arangoasync.response import Response
+
+T = TypeVar("T")
 
 
 class HTTPClient(ABC):  # pragma: no cover
@@ -50,7 +53,7 @@ async def send_request(
         raise NotImplementedError
 
 
-class AioHTTPClient(HTTPClient):
+class AioHTTPClient(HTTPClient, Generic[T]):
     """HTTP client implemented on top of [aiohttp](https://docs.aiohttp.org/en/stable/).
 
     :param connector: Supports connection pooling.
@@ -79,7 +82,7 @@ def __init__(
         auth: Optional[BasicAuth] = None,
         compression_threshold: int = 1024,
     ) -> None:
-        self._connector = connector or TcpConnector(
+        self._connector = connector or TCPConnector(
             keepalive_timeout=60,  # timeout for connection reusing after releasing
             limit=100,  # total number simultaneous connections
         )
@@ -94,13 +97,14 @@ def __init__(
     def create_session(self, host: str) -> ClientSession:
         """Return a new session given the base host URL.
 
-        :param host: ArangoDB host URL. Typically the address and port of a coordinator,
-            for example "http://127.0.0.1:8529".
+        :param host: ArangoDB host URL. Typically, the address and port of a coordinator
+            (e.g. "http://127.0.0.1:8529").
         :type host: str
         :returns: Session object.
         :rtype: aiohttp.ClientSession
         """
         return ClientSession(
+            base_url=host,
             connector=self._connector,
             timeout=self._timeout,
             auth=self._auth,
@@ -126,7 +130,7 @@ async def send_request(
         headers = request.headers
         params = request.params
         data = request.data
-        compress = len(data) >= self._compression_threshold
+        compress = data is not None and len(data) >= self._compression_threshold
 
         async with session.request(
             method.name,

arangoasync/request.py

@@ -4,12 +4,10 @@
 ]
 
 from enum import Enum, auto
-from typing import Generic, Optional, TypeVar
+from typing import Optional
 
-from typings import Headers, Params
-from version import __version__
-
-T = TypeVar("T")
+from arangoasync.typings import Headers, Params
+from arangoasync.version import __version__
 
 
 class Method(Enum):
@@ -24,7 +22,7 @@ class Method(Enum):
     OPTIONS = auto()
 
 
-class Request(Generic[T]):
+class Request:
     """HTTP request.
 
     :param method: HTTP method.
@@ -69,14 +67,14 @@ def __init__(
         endpoint: str,
         headers: Optional[Headers] = None,
         params: Optional[Params] = None,
-        data: Optional[T] = None,
+        data: Optional[str] = None,
         deserialize: bool = True,
     ) -> None:
         self.method: Method = method
         self.endpoint: str = endpoint
         self.headers: Headers = self._normalize_headers(headers)
         self.params: Params = self._normalize_params(params)
-        self.data: Optional[T] = data
+        self.data: Optional[str] = data
         self.deserialize: bool = deserialize
 
     @staticmethod

arangoasync/response.py

@@ -2,15 +2,13 @@
     "Response",
 ]
 
-from typing import Generic, Optional, TypeVar
+from typing import Optional
 
-from request import Method
-from typings import Headers
+from arangoasync.request import Method
+from arangoasync.typings import Headers
 
-T = TypeVar("T")
 
-
-class Response(Generic[T]):
+class Response:
     """HTTP response.
 
     :param method: HTTP method.
@@ -78,7 +76,7 @@ def __init__(
         self.raw_body: bytes = raw_body
 
         # Populated later
-        self.body: Optional[T] = None
+        self.body: Optional[str] = None
         self.error_code: Optional[int] = None
         self.error_message: Optional[str] = None
         self.is_success: Optional[bool] = None

docs/conf.py

@@ -1,3 +1,9 @@
+import os
+import sys
+
+# Required for autodoc
+sys.path.insert(0, os.path.abspath(".."))
+
 project = "python-arango-async"
 copyright_notice = "ArangoDB"
 author = "Alexandru Petenchea, Anthony Mahanna"
@@ -6,6 +12,14 @@
     "sphinx.ext.autodoc",
     "sphinx.ext.doctest",
     "sphinx.ext.viewcode",
+    "sphinx.ext.intersphinx",
 ]
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+html_theme = "sphinx_rtd_theme"
 master_doc = "index"
+
+autodoc_member_order = "bysource"
+
+intersphinx_mapping = {
+    "aiohttp": ("https://docs.aiohttp.org/en/stable/", None),
+}

docs/index.rst

@@ -5,4 +5,11 @@ Welcome to the documentation for **python-arango-async**, a Python driver for Ar
 
 **The driver is currently work in progress and not yet ready for use.**
 
+Development
+
+.. toctree::
+    :maxdepth: 1
+
+    specs
+
 .. _ArangoDB: https://www.arangodb.com

docs/specs.rst

@@ -0,0 +1,53 @@
+API Specification
+-----------------
+
+This page contains the specification for all classes and methods available in
+python-arango-async.
+
+.. _AioHTTPClient:
+
+AioHTTPClient
+=================
+
+.. autoclass:: arangoasync.http.AioHTTPClient
+    :members:
+
+.. _DefaultHTTPClient:
+
+DefaultHTTPClient
+=================
+
+.. autoclass:: arangoasync.http.DefaultHTTPClient
+    :members:
+
+.. _HTTPClient:
+
+HTTPClient
+==========
+
+.. autoclass:: arangoasync.http.HTTPClient
+    :members:
+
+.. _Method:
+
+Method
+=======
+
+.. autoclass:: arangoasync.request.Method
+    :members:
+
+.. _Request:
+
+Request
+=======
+
+.. autoclass:: arangoasync.request.Request
+    :members:
+
+.. _Response:
+
+Response
+========
+
+.. autoclass:: arangoasync.response.Response
+    :members:

pyproject.toml

@@ -54,6 +54,7 @@ dev = [
     "mypy>=1.10",
     "pre-commit>=3.7",
     "pytest>=8.2",
+    "pytest-asyncio>=0.23.8",
     "pytest-cov>=5.0",
     "sphinx>=7.3",
     "sphinx_rtd_theme",

tests/conftest.py

@@ -0,0 +1,53 @@
+from dataclasses import dataclass
+
+import pytest
+
+
+@dataclass
+class GlobalData:
+    url: str = None
+    root: str = None
+    password: str = None
+
+
+global_data = GlobalData()
+
+
+def pytest_addoption(parser):
+    parser.addoption(
+        "--host", action="store", default="127.0.0.1", help="ArangoDB host address"
+    )
+    parser.addoption(
+        "--port", action="append", default=["8529"], help="ArangoDB coordinator ports"
+    )
+    parser.addoption(
+        "--root", action="store", default="root", help="ArangoDB root user"
+    )
+    parser.addoption(
+        "--password", action="store", default="passwd", help="ArangoDB password"
+    )
+
+
+def pytest_configure(config):
+    ports = config.getoption("port")
+    hosts = [f"http://{config.getoption('host')}:{p}" for p in ports]
+    url = hosts[0]
+
+    global_data.url = url
+    global_data.root = config.getoption("root")
+    global_data.password = config.getoption("password")
+
+
+@pytest.fixture(autouse=False)
+def url():
+    return global_data.url
+
+
+@pytest.fixture(autouse=False)
+def root():
+    return global_data.root
+
+
+@pytest.fixture(autouse=False)
+def password():
+    return global_data.password

tests/test_http.py

@@ -0,0 +1,37 @@
+import pytest
+from aiohttp import BasicAuth
+
+from arangoasync.http import AioHTTPClient
+from arangoasync.request import Method, Request
+
+
+@pytest.mark.asyncio
+async def test_AioHTTPClient_simple_request(url):
+    client = AioHTTPClient()
+    session = client.create_session(url)
+    request = Request(
+        method=Method.GET,
+        endpoint="/_api/version",
+        deserialize=False,
+    )
+    response = await client.send_request(session, request)
+    assert response.method == Method.GET
+    assert response.url == f"{url}/_api/version"
+    assert response.status_code == 401
+    assert response.status_text == "Unauthorized"
+
+
+@pytest.mark.asyncio
+async def test_AioHTTPClient_auth_pass(url, root, password):
+    client = AioHTTPClient(auth=BasicAuth(root, password))
+    session = client.create_session(url)
+    request = Request(
+        method=Method.GET,
+        endpoint="/_api/version",
+        deserialize=False,
+    )
+    response = await client.send_request(session, request)
+    assert response.method == Method.GET
+    assert response.url == f"{url}/_api/version"
+    assert response.status_code == 200
+    assert response.status_text == "OK"