Skip to content

endpoints

This module contains functions for generating API endpoints urls.

GENERIC_API_ENDPOINT_SUBPATH

Bases: StrEnum

The placeholder class, meant to extended by APIs to define the endpoint paths.

Source code in horde_sdk/generic_api/endpoints.py 
 9
10
class GENERIC_API_ENDPOINT_SUBPATH(StrEnum):
    """The placeholder class, meant to extended by APIs to define the endpoint paths."""

url_with_path 

url_with_path(*, base_url: str, path: str) -> str

Return the combined baseURL and endpoint path. Cached for a marginal performance boost.

Parameters:

  • path (Rating_API_URL_Literals) –

    The API action path.

  • base_url (str) –

    The internet location of the API. Defaults to RATING_API_BASE_URL.

Raises:

  • ValueError –

    Raised if URL seems to be invalid.

Returns:

  • str ( str ) –

    The combined baseURL and endpoint path.

Source code in horde_sdk/generic_api/endpoints.py 
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
def url_with_path(
    *,
    base_url: str,
    path: str,
) -> str:
    """Return the combined baseURL and endpoint path. Cached for a marginal performance boost.

    Args:
        path (Rating_API_URL_Literals): The API action path.
        base_url (str, optional): The internet location of the API. Defaults to RATING_API_BASE_URL.

    Raises:
        ValueError: Raised if URL seems to be invalid.

    Returns:
        str: The combined baseURL and endpoint path.
    """

    @functools.cache
    def _shadowed_cached_func(*, base_url: str, path: str) -> str:
        # This sub def is here to support intellisense for the cached function
        # VSCode doesn't seem to understand the types/parameters of cached functions
        # (perhaps for a good reason, I don't know)
        parsedURL = urllib.parse.urlparse(base_url)
        if path.startswith("/"):
            path = path[1:]
        if not parsedURL.scheme:
            raise ValueError(f"Missing URL scheme (e.g., http, https)!\n  Is baseURL valid? baseURL: {base_url}")
        return urllib.parse.urljoin(base_url, path)

    return _shadowed_cached_func(base_url=base_url, path=path)