Skip to content

puepy.router

The puepy.router module contains code relevant to optional client-side routing in PuePy.

See Also

PuePy's router functionality can be optionally installed by calling the install_router method of the Application class.

Example 
from puepy import Application, Router

app = Application()
app.install_router(Router, link_mode=Router.LINK_MODE_HASH)

Once installed, the Router instance is available on app.Router and can be used throughout the application to manage client-side routing. Routes are defined by either using the @app.page decorator or by calling methods manually on the Router instance.

Classes:

Name Description
puepy.router.Route

Represents a route in the router.
puepy.router.Router

Represents a router for managing client-side routing in a web application.

Route

Represents a route in the router. A route is defined by a path match pattern, a page class, and a name.

Note

This is usually not instanciated directly. Instead, use the Router.add_route method to create a new route or use the @app.page decorator to define a route at the time you define your Pages.

Source code in puepy/router.py 
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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
class Route:
    """
    Represents a route in the router. A route is defined by a path match pattern, a page class, and a name.

    Note:
        This is usually not instanciated directly. Instead, use the `Router.add_route` method to create a new route or
        use the @app.page decorator to define a route at the time you define your Pages.
    """

    def __init__(self, path_match: str, page: Page, name: str, base_path: str, router=None):
        """
        Args:
            path_match (str): The path match pattern used for routing.
            page (Page): An instance of the Page class representing the page.
            name (str): The name of the page.
            base_path (str): The base path used for routing.
            router (Router, optional): An optional parameter representing the router used for routing.
        """
        self.path_match = path_match
        self.page = page
        self.name = name
        self.base_path = base_path
        self.router = router

    def match(self, path):
        """
        Evaluates a path against the route's pattern to determine if there is a match.

        Args:
            path: The path to be matched against the pattern.

        Returns:
            Match found (tuple): A tuple containing a True boolean value and a dictionary. The dictionary contains the
            matched variables extracted from the path.

            Match not found (tuple): If no match is found, returns `(False, None)`.
        """
        if self.base_path and path.startswith(self.base_path):
            path = path[len(self.base_path) :]

        # Simple pattern matching without regex
        parts = path.strip("/").split("/")
        pattern_parts = self.path_match.strip("/").split("/")
        if len(parts) != len(pattern_parts):
            return False, None

        kwargs = {}
        for part, pattern_part in zip(parts, pattern_parts):
            if pattern_part.startswith("<") and pattern_part.endswith(">"):
                group_name = pattern_part[1:-1]
                kwargs[group_name] = part
            elif part != pattern_part:
                return False, None

        return True, kwargs

    def reverse(self, **kwargs):
        """
        Reverse method is used to generate a URL path using the given parameters. It replaces the placeholders in the
        path template with the corresponding values.

        Args:
            **kwargs: A variable number of keyword arguments representing the values to be inserted into the path
            template.

        Returns:
            (str): The generated URL path.

        Example:
            Let's say we have a path template `/users/<username>/posts/<post_id>`. We can use the reverse method to
            generate the URL path by providing the values for "username" and "post_id" as keyword arguments:
            `route.reverse(username="john", post_id=123)` => `"/users/john/posts/123"`
        """
        kwargs = kwargs.copy()
        result = self.path_match
        for key in list(kwargs.keys()):
            if f"<{key}>" in result:
                value = kwargs.pop(key)
                result = result.replace(f"<{key}>", str(value))

        if self.router and self.router.link_mode == Router.LINK_MODE_HASH:
            result = "#" + result

        if self.base_path:
            path = f"{self.base_path}{result}"
        else:
            path = result

        if kwargs:
            path += "?" + "&".join(f"{url_quote(k)}={url_quote(v)}" for k, v in kwargs.items())
        return path

    def __str__(self):
        return self.name

    def __repr__(self):
        return f"<Route: {self.name}>"

__init__(path_match, page, name, base_path, router=None)

Parameters:

Name Type Description Default
path_match str

The path match pattern used for routing.

 required
page Page

An instance of the Page class representing the page.

 required
name str

The name of the page.

 required
base_path str

The base path used for routing.

 required
router Router

An optional parameter representing the router used for routing.

 None
Source code in puepy/router.py 
112
113
114
115
116
117
118
119
120
121
122
123
124
125
def __init__(self, path_match: str, page: Page, name: str, base_path: str, router=None):
    """
    Args:
        path_match (str): The path match pattern used for routing.
        page (Page): An instance of the Page class representing the page.
        name (str): The name of the page.
        base_path (str): The base path used for routing.
        router (Router, optional): An optional parameter representing the router used for routing.
    """
    self.path_match = path_match
    self.page = page
    self.name = name
    self.base_path = base_path
    self.router = router

match(path)

Evaluates a path against the route's pattern to determine if there is a match.

Parameters:

Name Type Description Default
path

The path to be matched against the pattern.

 required

Returns:

Type Description

Match found (tuple): A tuple containing a True boolean value and a dictionary. The dictionary contains the

matched variables extracted from the path.

Match not found (tuple): If no match is found, returns (False, None).
Source code in puepy/router.py 
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
def match(self, path):
    """
    Evaluates a path against the route's pattern to determine if there is a match.

    Args:
        path: The path to be matched against the pattern.

    Returns:
        Match found (tuple): A tuple containing a True boolean value and a dictionary. The dictionary contains the
        matched variables extracted from the path.

        Match not found (tuple): If no match is found, returns `(False, None)`.
    """
    if self.base_path and path.startswith(self.base_path):
        path = path[len(self.base_path) :]

    # Simple pattern matching without regex
    parts = path.strip("/").split("/")
    pattern_parts = self.path_match.strip("/").split("/")
    if len(parts) != len(pattern_parts):
        return False, None

    kwargs = {}
    for part, pattern_part in zip(parts, pattern_parts):
        if pattern_part.startswith("<") and pattern_part.endswith(">"):
            group_name = pattern_part[1:-1]
            kwargs[group_name] = part
        elif part != pattern_part:
            return False, None

    return True, kwargs

reverse(**kwargs)

Reverse method is used to generate a URL path using the given parameters. It replaces the placeholders in the path template with the corresponding values.

Parameters:

Name Type Description Default
**kwargs

A variable number of keyword arguments representing the values to be inserted into the path

 {}

Returns:

Type Description
str

The generated URL path.
Example

Let's say we have a path template /users/<username>/posts/<post_id>. We can use the reverse method to generate the URL path by providing the values for "username" and "post_id" as keyword arguments: route.reverse(username="john", post_id=123) => "/users/john/posts/123"

Source code in puepy/router.py 
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
def reverse(self, **kwargs):
    """
    Reverse method is used to generate a URL path using the given parameters. It replaces the placeholders in the
    path template with the corresponding values.

    Args:
        **kwargs: A variable number of keyword arguments representing the values to be inserted into the path
        template.

    Returns:
        (str): The generated URL path.

    Example:
        Let's say we have a path template `/users/<username>/posts/<post_id>`. We can use the reverse method to
        generate the URL path by providing the values for "username" and "post_id" as keyword arguments:
        `route.reverse(username="john", post_id=123)` => `"/users/john/posts/123"`
    """
    kwargs = kwargs.copy()
    result = self.path_match
    for key in list(kwargs.keys()):
        if f"<{key}>" in result:
            value = kwargs.pop(key)
            result = result.replace(f"<{key}>", str(value))

    if self.router and self.router.link_mode == Router.LINK_MODE_HASH:
        result = "#" + result

    if self.base_path:
        path = f"{self.base_path}{result}"
    else:
        path = result

    if kwargs:
        path += "?" + "&".join(f"{url_quote(k)}={url_quote(v)}" for k, v in kwargs.items())
    return path

Router

Class representing a router for managing client-side routing in a web application.

Parameters:

Name Type Description Default
application object

The web application object. Defaults to None.

 None
base_path str

The base path URL. Defaults to None.

 None
link_mode str

The link mode for navigating. Defaults to "hash".

 LINK_MODE_HASH

Attributes:

Name Type Description
LINK_MODE_DIRECT str

Direct link mode.
LINK_MODE_HTML5 str

HTML5 link mode.
LINK_MODE_HASH str

Hash link mode.
routes list

List of Route instances.
routes_by_name dict

Dictionary mapping route names to Route instances.
routes_by_page dict

Dictionary mapping page classes to Route instances.
application object

The web application object.
base_path str

The base path URL.
link_mode str

The link mode for navigating.
Source code in puepy/router.py 
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
class Router:
    """Class representing a router for managing client-side routing in a web application.



    Args:
        application (object, optional): The web application object. Defaults to None.
        base_path (str, optional): The base path URL. Defaults to None.
        link_mode (str, optional): The link mode for navigating. Defaults to "hash".

    Attributes:
        LINK_MODE_DIRECT (str): Direct link mode.
        LINK_MODE_HTML5 (str): HTML5 link mode.
        LINK_MODE_HASH (str): Hash link mode.
        routes (list): List of Route instances.
        routes_by_name (dict): Dictionary mapping route names to Route instances.
        routes_by_page (dict): Dictionary mapping page classes to Route instances.
        application (object): The web application object.
        base_path (str): The base path URL.
        link_mode (str): The link mode for navigating.
    """

    LINK_MODE_DIRECT = "direct"
    LINK_MODE_HTML5 = "html5"
    LINK_MODE_HASH = "hash"

    def __init__(self, application=None, base_path=None, link_mode=LINK_MODE_HASH):
        """
        Initializes an instance of the class.

        Parameters:
            application (Application): The application used for routing.
            base_path (str): The base path for the routes.
            link_mode (str): The mode for generating links.
        """
        self.routes = []
        self.routes_by_name = {}
        self.routes_by_page = {}
        self.application = application
        self.base_path = base_path
        self.link_mode = link_mode

    def add_route_instance(self, route: Route):
        """
        Add a route instance to the current router.

        Parameters:
            route (Route): The route instance to be added.

        Raises:
            ValueError: If the route instance or route name already exists in the router.
        """
        if route in self.routes:
            raise ValueError(f"Route already added: {route}")
        if route.name in self.routes_by_name:
            raise ValueError(f"Route name already exists for another route: {route.name}")
        self.routes.append(route)
        self.routes_by_name[route.name] = route
        self.routes_by_page[route.page] = route
        route.router = self

    def add_route(self, path_match, page_class, name=None):
        """
        Adds a route to the router. This method creates a new Route instance.

        Args:
            path_match (str): The URL path pattern to match for the route.
            page_class (Page class): The class or function to be associated with the route.
            name (str, optional): The name of the route. If not provided, the name will be derived from the page class name.
        """
        # Convert path to a simple pattern without regex
        if not name:
            name = mixed_to_underscores(page_class.__name__)
        self.add_route_instance(Route(path_match=path_match, page=page_class, name=name, base_path=self.base_path))

    def reverse(self, destination, **kwargs):
        """
        Reverses a

        Args:
            destination: The destination to reverse. It can be the name of a route, the mapped page of a route, or the default page of the application.
            **kwargs: Additional keyword arguments to be passed to the reverse method of the destination route.

        Returns:
            (str): The reversed URL for the given destination.

        Raises:
            KeyError: If the destination is not found in the routes.
        """
        route: Route
        if isinstance(destination, Route):
            return destination.reverse(**kwargs)
        elif destination in self.routes_by_name:
            route = self.routes_by_name[destination]
        elif destination in self.routes_by_page:
            route = self.routes_by_page[destination]
        elif self.application and destination is self.application.default_page:
            if self.link_mode == Router.LINK_MODE_HASH:
                path = "#/"
            else:
                path = "/"
            return self.base_path or "" + path
        else:
            raise KeyError(f"{destination} not found in routes")
        return route.reverse(**kwargs)

    def match(self, path):
        """
        Args:
            path (str): The path to be matched.

        Returns:
            (tuple): A tuple containing the matching route and the matched route arguments (if any). If no route is
                found, returns (None, None).
        """
        path = path.split("#")[0]
        if "?" not in path:
            path += "?"
        path, query_string = path.split("?", 1)
        arguments = parse_query_string(query_string)

        for route in self.routes:
            matches, path_arguments = route.match(path)
            if path_arguments:
                arguments.update(path_arguments)
            if matches:
                return route, arguments
        return None, None

    def navigate_to_path(self, path, **kwargs):
        """
        Navigates to the specified path.

        Args:
            path (str or Page): The path to navigate to. If path is a subclass of Page, it will be reversed using the reverse method
            provided by the self object. If path is a string and **kwargs is not empty, it will append the query string
            to the path.

            **kwargs: Additional key-value pairs to be included in the query string. Each key-value pair will be
            URL-encoded.

        Raises:
            Exception: If the link mode is invalid.
        """
        if isinstance(path, type) and issubclass(path, Page):
            path = self.reverse(path, **kwargs)
        elif kwargs:
            path += "?" + "&".join(f"{url_quote(k)}={url_quote(v)}" for k, v in kwargs.items())

        if self.link_mode == self.LINK_MODE_DIRECT:
            window.location = path
        elif self.link_mode == self.LINK_MODE_HTML5:
            history.pushState(jsobj(), "", path)
            self.application.mount(self.application._selector_or_element, path)
        elif self.link_mode == self.LINK_MODE_HASH:
            path = path[1:] if path.startswith("#") else path
            if not is_server_side:
                history.pushState(jsobj(), "", "#" + path)
            self.application.mount(self.application._selector_or_element, path)
        else:
            raise Exception(f"Invalid link mode: {self.link_mode}")

__init__(application=None, base_path=None, link_mode=LINK_MODE_HASH)

Initializes an instance of the class.

Parameters:

Name Type Description Default
application Application

The application used for routing.

 None
base_path str

The base path for the routes.

 None
link_mode str

The mode for generating links.

 LINK_MODE_HASH
Source code in puepy/router.py 
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
def __init__(self, application=None, base_path=None, link_mode=LINK_MODE_HASH):
    """
    Initializes an instance of the class.

    Parameters:
        application (Application): The application used for routing.
        base_path (str): The base path for the routes.
        link_mode (str): The mode for generating links.
    """
    self.routes = []
    self.routes_by_name = {}
    self.routes_by_page = {}
    self.application = application
    self.base_path = base_path
    self.link_mode = link_mode

add_route(path_match, page_class, name=None)

Adds a route to the router. This method creates a new Route instance.

Parameters:

Name Type Description Default
path_match str

The URL path pattern to match for the route.

 required
page_class Page class

The class or function to be associated with the route.

 required
name str

The name of the route. If not provided, the name will be derived from the page class name.

 None
Source code in puepy/router.py 
263
264
265
266
267
268
269
270
271
272
273
274
275
def add_route(self, path_match, page_class, name=None):
    """
    Adds a route to the router. This method creates a new Route instance.

    Args:
        path_match (str): The URL path pattern to match for the route.
        page_class (Page class): The class or function to be associated with the route.
        name (str, optional): The name of the route. If not provided, the name will be derived from the page class name.
    """
    # Convert path to a simple pattern without regex
    if not name:
        name = mixed_to_underscores(page_class.__name__)
    self.add_route_instance(Route(path_match=path_match, page=page_class, name=name, base_path=self.base_path))

add_route_instance(route)

Add a route instance to the current router.

Parameters:

Name Type Description Default
route Route

The route instance to be added.

 required

Raises:

Type Description
ValueError

If the route instance or route name already exists in the router.
Source code in puepy/router.py 
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
def add_route_instance(self, route: Route):
    """
    Add a route instance to the current router.

    Parameters:
        route (Route): The route instance to be added.

    Raises:
        ValueError: If the route instance or route name already exists in the router.
    """
    if route in self.routes:
        raise ValueError(f"Route already added: {route}")
    if route.name in self.routes_by_name:
        raise ValueError(f"Route name already exists for another route: {route.name}")
    self.routes.append(route)
    self.routes_by_name[route.name] = route
    self.routes_by_page[route.page] = route
    route.router = self

match(path)

Parameters:

Name Type Description Default
path str

The path to be matched.

 required

Returns:

Type Description
tuple

A tuple containing the matching route and the matched route arguments (if any). If no route is found, returns (None, None).
Source code in puepy/router.py 
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
def match(self, path):
    """
    Args:
        path (str): The path to be matched.

    Returns:
        (tuple): A tuple containing the matching route and the matched route arguments (if any). If no route is
            found, returns (None, None).
    """
    path = path.split("#")[0]
    if "?" not in path:
        path += "?"
    path, query_string = path.split("?", 1)
    arguments = parse_query_string(query_string)

    for route in self.routes:
        matches, path_arguments = route.match(path)
        if path_arguments:
            arguments.update(path_arguments)
        if matches:
            return route, arguments
    return None, None

navigate_to_path(path, **kwargs)

Navigates to the specified path.

Parameters:

Name Type Description Default
path str or Page

The path to navigate to. If path is a subclass of Page, it will be reversed using the reverse method

 required
**kwargs

Additional key-value pairs to be included in the query string. Each key-value pair will be

 {}

Raises:

Type Description
Exception

If the link mode is invalid.
Source code in puepy/router.py 
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
def navigate_to_path(self, path, **kwargs):
    """
    Navigates to the specified path.

    Args:
        path (str or Page): The path to navigate to. If path is a subclass of Page, it will be reversed using the reverse method
        provided by the self object. If path is a string and **kwargs is not empty, it will append the query string
        to the path.

        **kwargs: Additional key-value pairs to be included in the query string. Each key-value pair will be
        URL-encoded.

    Raises:
        Exception: If the link mode is invalid.
    """
    if isinstance(path, type) and issubclass(path, Page):
        path = self.reverse(path, **kwargs)
    elif kwargs:
        path += "?" + "&".join(f"{url_quote(k)}={url_quote(v)}" for k, v in kwargs.items())

    if self.link_mode == self.LINK_MODE_DIRECT:
        window.location = path
    elif self.link_mode == self.LINK_MODE_HTML5:
        history.pushState(jsobj(), "", path)
        self.application.mount(self.application._selector_or_element, path)
    elif self.link_mode == self.LINK_MODE_HASH:
        path = path[1:] if path.startswith("#") else path
        if not is_server_side:
            history.pushState(jsobj(), "", "#" + path)
        self.application.mount(self.application._selector_or_element, path)
    else:
        raise Exception(f"Invalid link mode: {self.link_mode}")

reverse(destination, **kwargs)

Reverses a

Parameters:

Name Type Description Default
destination

The destination to reverse. It can be the name of a route, the mapped page of a route, or the default page of the application.

 required
**kwargs

Additional keyword arguments to be passed to the reverse method of the destination route.

 {}

Returns:

Type Description
str

The reversed URL for the given destination.

Raises:

Type Description
KeyError

If the destination is not found in the routes.
Source code in puepy/router.py 
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
def reverse(self, destination, **kwargs):
    """
    Reverses a

    Args:
        destination: The destination to reverse. It can be the name of a route, the mapped page of a route, or the default page of the application.
        **kwargs: Additional keyword arguments to be passed to the reverse method of the destination route.

    Returns:
        (str): The reversed URL for the given destination.

    Raises:
        KeyError: If the destination is not found in the routes.
    """
    route: Route
    if isinstance(destination, Route):
        return destination.reverse(**kwargs)
    elif destination in self.routes_by_name:
        route = self.routes_by_name[destination]
    elif destination in self.routes_by_page:
        route = self.routes_by_page[destination]
    elif self.application and destination is self.application.default_page:
        if self.link_mode == Router.LINK_MODE_HASH:
            path = "#/"
        else:
            path = "/"
        return self.base_path or "" + path
    else:
        raise KeyError(f"{destination} not found in routes")
    return route.reverse(**kwargs)