Skip to content

routes

The internal route constants used to build requests. Most users never touch these directly - services compile them for you - but they are documented here for completeness.

Route/endpoint related items.

CompiledRoute

A route that has been compiled to include uri variables.

Parameters:

Name Type Description Default
route Route

The route to compile.

 required
Source code in wom/routes.py 
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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
class CompiledRoute:
    """A route that has been compiled to include uri variables.

    Parameters
    ----------
    route : Route
        The route to compile.
    """

    __slots__ = ("_route", "_uri", "_params")

    def __init__(self, route: Route, uri: str) -> None:
        self._uri = uri
        self._route = route
        self._params: t.Dict[str, t.Union[str, int]] = {}

    @property
    def route(self) -> Route:
        """The route itself."""
        return self._route

    @property
    def uri(self) -> str:
        """The routes uri endpoint."""
        return self._uri

    @uri.setter
    def uri(self, uri: str) -> None:
        self._uri = uri

    @property
    def method(self) -> str:
        """The routes method, i.e. GET, POST..."""
        return self.route.method

    @property
    def params(self) -> t.Dict[str, t.Union[str, int]]:
        """The query params for the route."""
        return self._params

    def with_params(self, params: t.Dict[str, t.Any]) -> CompiledRoute:
        """Adds additional query params to this compiled route.

        Parameters
        ----------
        params : dict[str, Any]
            The query params to compile.

        Returns
        -------
        CompiledRoute
            The compiled route for chained calls.
        """
        if params:
            self.params.update(params)

        return self

method property 

method: str

The routes method, i.e. GET, POST...

params property 

params: Dict[str, Union[str, int]]

The query params for the route.

route property 

route: Route

The route itself.

uri property writable 

uri: str

The routes uri endpoint.

with_params 

with_params(params: t.Dict[str, t.Any]) -> CompiledRoute

Adds additional query params to this compiled route.

Parameters:

Name Type Description Default
params dict[str, Any]

The query params to compile.

 required

Returns:

Type Description
CompiledRoute

The compiled route for chained calls.
Source code in wom/routes.py 
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
def with_params(self, params: t.Dict[str, t.Any]) -> CompiledRoute:
    """Adds additional query params to this compiled route.

    Parameters
    ----------
    params : dict[str, Any]
        The query params to compile.

    Returns
    -------
    CompiledRoute
        The compiled route for chained calls.
    """
    if params:
        self.params.update(params)

    return self

Route

A route that has not been compiled yet.

Source code in wom/routes.py 
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
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
class Route:
    """A route that has not been compiled yet."""

    __slots__ = ("method", "uri")

    method: str
    """The request method to use."""
    uri: str
    """The request uri."""

    def __init__(self, method: str, uri: str) -> None:
        self.method = method
        self.uri = uri

    def __repr__(self) -> str:
        return f"Route(method={self.method!r}, uri={self.uri!r})"

    def compile(self, *args: t.Union[str, int]) -> CompiledRoute:
        """Turn this route into a compiled route.

        Parameters
        ----------
        *args : str or int
            The arguments to insert into the uri.

        Returns
        -------
        CompiledRoute
            The compiled route.

        Raises
        ------
        ValueError
            If the number of args does not match the number of `{}`
            placeholders in the uri.
        """
        expected = self.uri.count(r"{}")
        if len(args) != expected:
            raise ValueError(
                f"Route {self.uri!r} expected {expected} uri argument(s), got {len(args)}."
            )

        compiled = CompiledRoute(self, self.uri)

        for arg in args:
            compiled.uri = compiled.uri.replace(r"{}", str(arg), 1)

        return compiled

method instance-attribute 

method: str = method

The request method to use.

uri instance-attribute 

uri: str = uri

The request uri.

compile 

compile(*args: t.Union[str, int]) -> CompiledRoute

Turn this route into a compiled route.

Parameters:

Name Type Description Default
*args str or int

The arguments to insert into the uri.

 ()

Returns:

Type Description
CompiledRoute

The compiled route.

Raises:

Type Description
ValueError

If the number of args does not match the number of {} placeholders in the uri.
Source code in wom/routes.py 
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
def compile(self, *args: t.Union[str, int]) -> CompiledRoute:
    """Turn this route into a compiled route.

    Parameters
    ----------
    *args : str or int
        The arguments to insert into the uri.

    Returns
    -------
    CompiledRoute
        The compiled route.

    Raises
    ------
    ValueError
        If the number of args does not match the number of `{}`
        placeholders in the uri.
    """
    expected = self.uri.count(r"{}")
    if len(args) != expected:
        raise ValueError(
            f"Route {self.uri!r} expected {expected} uri argument(s), got {len(args)}."
        )

    compiled = CompiledRoute(self, self.uri)

    for arg in args:
        compiled.uri = compiled.uri.replace(r"{}", str(arg), 1)

    return compiled