HTTPClient

Bases: Protocol

Interface for HTTP clients like requests, httpx or a custom implementation.

This interface is compatible with the popular synchronous HTTP client libraries, for example, the requests library, httpx library or any custom implementation that follows the same method signatures.

This interface defines the methods that an HTTP client should implement to be compatible with the REST API repository. It includes methods for making HTTP requests (POST, GET, DELETE, PUT, PATCH) and allows for additional parameters to be passed as needed.

Source code in src/alpha/interfaces/http_client.py 
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
@runtime_checkable
class HTTPClient(Protocol):
    """Interface for HTTP clients like requests, httpx or a custom
    implementation.

    This interface is compatible with the popular synchronous HTTP client
    libraries, for example, the `requests` library, `httpx` library or any
    custom implementation that follows the same method signatures.

    This interface defines the methods that an HTTP client should implement to
    be compatible with the REST API repository. It includes methods for making
    HTTP requests (POST, GET, DELETE, PUT, PATCH) and allows for additional
    parameters to be passed as needed.
    """

    cookies: Any
    headers: Any

    def post(self, url: str, json: Any = None, **kwargs: Any) -> Any: ...
    def get(self, url: str, **kwargs: Any) -> Any: ...
    def delete(self, url: str, **kwargs: Any) -> Any: ...
    def put(self, url: str, json: Any = None, **kwargs: Any) -> Any: ...
    def patch(self, url: str, json: Any = None, **kwargs: Any) -> Any: ...