route_table.py

Provides routing table class.

RouteTable

Stores and manages registered routes.

Provides lookup for handlers based on URL and HTTP method.

Source code in jetweb/routing/route_table.py

class RouteTable:
    """
    Stores and manages registered routes.

    Provides lookup for handlers based on URL and HTTP method.
    """

    def __init__(self):
        self.routes = []

    def include(self, prefix: str, route_table: RouteTable) -> None:
        """
        Include routes from another table under a prefix.

        :param prefix: Endpoint prefix.
        :param route_table: Route table with routes for including.
        """
        for route in route_table.routes:
            self.routes.append(
                Route(endpoint=prefix + route.endpoint, handler=route.handler, methods=route.methods)
            )

    def add_route(
        self, prefix: str, endpoint: str, handler: Callable, methods: Union[Iterable[str], None] = None
    ) -> None:
        """
        Register a new route.

        :param prefix: Endpoint prefix.
        :param endpoint: Route endpoint.
        :param handler: Request handler.
        :param methods: Allowed request methods (default: ["GET"]). Adds "OPTIONS" if GET is allowed.
        """
        methods = [method.upper() for method in (methods or ["GET"])]
        if "GET" in methods:
            methods.append("OPTIONS")

        self.routes.append(
            Route(endpoint=prefix + endpoint, handler=handler, methods=methods)
        )

    def find_handler(self, endpoint: str, method: str) -> tuple[Callable, dict]:
        """
        Find a request handler for the given endpoint and method.

        :param endpoint: Request endpoint.
        :param method: Request method.
        :returns: Request handler and parsed path parameters.
        :raises HTTPException(404): If no route matches for endpoint.
        :raises HTTPException(405): If no method matches for matched route.
        """
        for route in self.routes:
            matched, path_params = route.match_endpoint(endpoint)
            if matched:
                if route.match_method(method):
                    return route.handler, path_params
                raise HTTPException(status=405)
        raise HTTPException(status=404)

add_route(prefix, endpoint, handler, methods=None)

Register a new route.

Parameters:

Name	Type	Description	Default
prefix	str	Endpoint prefix.	required
endpoint	str	Route endpoint.	required
handler	Callable	Request handler.	required
methods	Union[Iterable[str], None]	Allowed request methods (default: ["GET"]). Adds "OPTIONS" if GET is allowed.	None

Source code in jetweb/routing/route_table.py

def add_route(
    self, prefix: str, endpoint: str, handler: Callable, methods: Union[Iterable[str], None] = None
) -> None:
    """
    Register a new route.

    :param prefix: Endpoint prefix.
    :param endpoint: Route endpoint.
    :param handler: Request handler.
    :param methods: Allowed request methods (default: ["GET"]). Adds "OPTIONS" if GET is allowed.
    """
    methods = [method.upper() for method in (methods or ["GET"])]
    if "GET" in methods:
        methods.append("OPTIONS")

    self.routes.append(
        Route(endpoint=prefix + endpoint, handler=handler, methods=methods)
    )

find_handler(endpoint, method)

Find a request handler for the given endpoint and method.

Parameters:

Name	Type	Description	Default
endpoint	str	Request endpoint.	required
method	str	Request method.	required

Returns:

Type	Description
tuple[Callable, dict]	Request handler and parsed path parameters.

Raises:

Type	Description
HTTPException(404)	If no route matches for endpoint.
HTTPException(405)	If no method matches for matched route.

Source code in jetweb/routing/route_table.py

def find_handler(self, endpoint: str, method: str) -> tuple[Callable, dict]:
    """
    Find a request handler for the given endpoint and method.

    :param endpoint: Request endpoint.
    :param method: Request method.
    :returns: Request handler and parsed path parameters.
    :raises HTTPException(404): If no route matches for endpoint.
    :raises HTTPException(405): If no method matches for matched route.
    """
    for route in self.routes:
        matched, path_params = route.match_endpoint(endpoint)
        if matched:
            if route.match_method(method):
                return route.handler, path_params
            raise HTTPException(status=405)
    raise HTTPException(status=404)

include(prefix, route_table)

Include routes from another table under a prefix.

Parameters:

Name	Type	Description	Default
prefix	str	Endpoint prefix.	required
route_table	RouteTable	Route table with routes for including.	required

Source code in jetweb/routing/route_table.py

def include(self, prefix: str, route_table: RouteTable) -> None:
    """
    Include routes from another table under a prefix.

    :param prefix: Endpoint prefix.
    :param route_table: Route table with routes for including.
    """
    for route in route_table.routes:
        self.routes.append(
            Route(endpoint=prefix + route.endpoint, handler=route.handler, methods=route.methods)
        )