vws-python/src/vws/_async_vws_request.py at 1d7eabbd374adca59e4f9b4874bc2689a3da7433 · VWS-Python/vws-python · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
"""Internal helper for making authenticated async requests to the
Vuforia Target API.
"""

from beartype import BeartypeConf, beartype

from vws._vws_request import build_vws_request_args
from vws.response import Response
from vws.transports import AsyncTransport


@beartype(conf=BeartypeConf(is_pep484_tower=True))
async def async_target_api_request(
    *,
    content_type: str,
    server_access_key: str,
    server_secret_key: str,
    method: str,
    data: bytes,
    request_path: str,
    base_vws_url: str,
    request_timeout_seconds: float | tuple[float, float],
    extra_headers: dict[str, str],
    transport: AsyncTransport,
) -> Response:
    """Make an async request to the Vuforia Target API.

    Args:
        content_type: The content type of the request.
        server_access_key: A VWS server access key.
        server_secret_key: A VWS server secret key.
        method: The HTTP method which will be used in the
            request.
        data: The request body which will be used in the
            request.
        request_path: The path to the endpoint which will be
            used in the request.
        base_vws_url: The base URL for the VWS API.
        request_timeout_seconds: The timeout for the request.
            This can be a float to set both the connect and
            read timeouts, or a (connect, read) tuple.
        extra_headers: Additional headers to include in the
            request.
        transport: The async HTTP transport to use for the
            request.

    Returns:
        The response to the request.
    """
    url, headers = build_vws_request_args(
        content_type=content_type,
        server_access_key=server_access_key,
        server_secret_key=server_secret_key,
        method=method,
        data=data,
        request_path=request_path,
        base_vws_url=base_vws_url,
        extra_headers=extra_headers,
    )

    return await transport(
        method=method,
        url=url,
        headers=headers,
        data=data,
        request_timeout=request_timeout_seconds,
    )