Skip to content

HTTP Client

httpclient

HTTP client protocol definitions and implementations for sync and async requests.

HttpClient

Bases: Protocol

Protocol defining the sync HTTP client interface used by the SDK.

send 

send(
    request,
    *,
    stream=False,
    auth=USE_CLIENT_DEFAULT,
    follow_redirects=USE_CLIENT_DEFAULT,
)

Send a request and return a response.

Source code in src/griddy/core/httpclient.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
def send(
    self,
    request: httpx.Request,
    *,
    stream: bool = False,
    auth: Union[
        httpx._types.AuthTypes, httpx._client.UseClientDefault, None
    ] = httpx.USE_CLIENT_DEFAULT,
    follow_redirects: Union[
        bool, httpx._client.UseClientDefault
    ] = httpx.USE_CLIENT_DEFAULT,
) -> httpx.Response:
    """Send a request and return a response."""
    pass

build_request 

build_request(
    method,
    url,
    *,
    content=None,
    data=None,
    files=None,
    json=None,
    params=None,
    headers=None,
    cookies=None,
    timeout=USE_CLIENT_DEFAULT,
    extensions=None,
)

Build an HTTP request object from the given parameters.

Source code in src/griddy/core/httpclient.py 
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
def build_request(
    self,
    method: str,
    url: httpx._types.URLTypes,
    *,
    content: Optional[httpx._types.RequestContent] = None,
    data: Optional[httpx._types.RequestData] = None,
    files: Optional[httpx._types.RequestFiles] = None,
    json: Optional[Any] = None,
    params: Optional[httpx._types.QueryParamTypes] = None,
    headers: Optional[httpx._types.HeaderTypes] = None,
    cookies: Optional[httpx._types.CookieTypes] = None,
    timeout: Union[
        httpx._types.TimeoutTypes, httpx._client.UseClientDefault
    ] = httpx.USE_CLIENT_DEFAULT,
    extensions: Optional[httpx._types.RequestExtensions] = None,
) -> httpx.Request:
    """Build an HTTP request object from the given parameters."""
    pass

close 

close()

Close the HTTP client and release resources.

Source code in src/griddy/core/httpclient.py 
50
51
52
def close(self) -> None:
    """Close the HTTP client and release resources."""
    pass

AsyncHttpClient

Bases: Protocol

Protocol defining the async HTTP client interface used by the SDK.

send async 

send(
    request,
    *,
    stream=False,
    auth=USE_CLIENT_DEFAULT,
    follow_redirects=USE_CLIENT_DEFAULT,
)

Send a request asynchronously and return a response.

Source code in src/griddy/core/httpclient.py 
59
60
61
62
63
64
65
66
67
68
69
70
71
72
async def send(
    self,
    request: httpx.Request,
    *,
    stream: bool = False,
    auth: Union[
        httpx._types.AuthTypes, httpx._client.UseClientDefault, None
    ] = httpx.USE_CLIENT_DEFAULT,
    follow_redirects: Union[
        bool, httpx._client.UseClientDefault
    ] = httpx.USE_CLIENT_DEFAULT,
) -> httpx.Response:
    """Send a request asynchronously and return a response."""
    pass

build_request 

build_request(
    method,
    url,
    *,
    content=None,
    data=None,
    files=None,
    json=None,
    params=None,
    headers=None,
    cookies=None,
    timeout=USE_CLIENT_DEFAULT,
    extensions=None,
)

Build an HTTP request object from the given parameters.

Source code in src/griddy/core/httpclient.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
def build_request(
    self,
    method: str,
    url: httpx._types.URLTypes,
    *,
    content: Optional[httpx._types.RequestContent] = None,
    data: Optional[httpx._types.RequestData] = None,
    files: Optional[httpx._types.RequestFiles] = None,
    json: Optional[Any] = None,
    params: Optional[httpx._types.QueryParamTypes] = None,
    headers: Optional[httpx._types.HeaderTypes] = None,
    cookies: Optional[httpx._types.CookieTypes] = None,
    timeout: Union[
        httpx._types.TimeoutTypes, httpx._client.UseClientDefault
    ] = httpx.USE_CLIENT_DEFAULT,
    extensions: Optional[httpx._types.RequestExtensions] = None,
) -> httpx.Request:
    """Build an HTTP request object from the given parameters."""
    pass

aclose async 

aclose()

Close the async HTTP client and release resources.

Source code in src/griddy/core/httpclient.py 
94
95
96
async def aclose(self) -> None:
    """Close the async HTTP client and release resources."""
    pass

ClientOwner

Bases: Protocol

Protocol for objects that own sync and async HTTP clients.

close_clients 

close_clients(
    owner,
    sync_client,
    sync_client_supplied,
    async_client,
    async_client_supplied,
)

A finalizer function that is meant to be used with weakref.finalize to close httpx clients used by an SDK so that underlying resources can be garbage collected.

Source code in src/griddy/core/httpclient.py 
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
def close_clients(
    owner: ClientOwner,
    sync_client: Union[HttpClient, None],
    sync_client_supplied: bool,
    async_client: Union[AsyncHttpClient, None],
    async_client_supplied: bool,
) -> None:
    """
    A finalizer function that is meant to be used with weakref.finalize to close
    httpx clients used by an SDK so that underlying resources can be garbage
    collected.
    """

    # Unset the client/async_client properties so there are no more references
    # to them from the owning SDK instance and they can be reaped.
    owner.client = None
    owner.async_client = None
    if sync_client is not None and not sync_client_supplied:
        try:
            sync_client.close()
        except Exception:
            pass

    if async_client is not None and not async_client_supplied:
        try:
            loop = asyncio.get_running_loop()
            asyncio.run_coroutine_threadsafe(async_client.aclose(), loop)
        except RuntimeError:
            try:
                asyncio.run(async_client.aclose())
            except RuntimeError:
                # best effort
                pass