Changed Route class to public

Author: michalpokusa

adafruit_httpserver/__init__.py

@@ -59,6 +59,7 @@
     JSONResponse,
     Redirect,
 )
+from .route import Route
 from .server import Server
 from .status import (
     Status,

adafruit_httpserver/route.py

@@ -20,34 +20,41 @@
 from .methods import GET
 
 
-class _Route:
+class Route:
     """Route definition for different paths, see `adafruit_httpserver.server.Server.route`."""
 
     def __init__(
         self,
         path: str = "",
         methods: Union[str, Set[str]] = GET,
+        handler: Callable = None,
+        *,
         append_slash: bool = False,
     ) -> None:
-        self._validate_path(path)
+        self._validate_path(path, append_slash)
 
         self.parameters_names = [
             name[1:-1] for name in re.compile(r"/[^<>]*/?").split(path) if name != ""
         ]
         self.path = re.sub(r"<\w+>", r"([^/]+)", path).replace("....", r".+").replace(
             "...", r"[^/]+"
         ) + ("/?" if append_slash else "")
-        self.methods = methods if isinstance(methods, set) else {methods}
+        self.methods = set(methods) if isinstance(methods, (set, list)) else set([methods])
+
+        self.handler = handler
 
     @staticmethod
-    def _validate_path(path: str) -> None:
+    def _validate_path(path: str, append_slash: bool) -> None:
         if not path.startswith("/"):
             raise ValueError("Path must start with a slash.")
 
         if "<>" in path:
             raise ValueError("All URL parameters must be named.")
 
-    def match(self, other: "_Route") -> Tuple[bool, List[str]]:
+        if path.endswith("/") and append_slash:
+            raise ValueError("Cannot use append_slash=True when path ends with /")
+
+    def match(self, other: "Route") -> Tuple[bool, List[str]]:
         """
         Checks if the route matches the other route.
 
@@ -59,34 +66,34 @@ def match(self, other: "_Route") -> Tuple[bool, List[str]]:
 
         Examples::
 
-            route = _Route("/example", GET, True)
+            route = Route("/example", GET, True)
 
-            other1a = _Route("/example", GET)
-            other1b = _Route("/example/", GET)
+            other1a = Route("/example", GET)
+            other1b = Route("/example/", GET)
             route.matches(other1a) # True, []
             route.matches(other1b) # True, []
 
-            other2 = _Route("/other-example", GET)
+            other2 = Route("/other-example", GET)
             route.matches(other2) # False, []
 
             ...
 
-            route = _Route("/example/<parameter>", GET)
+            route = Route("/example/<parameter>", GET)
 
-            other1 = _Route("/example/123", GET)
+            other1 = Route("/example/123", GET)
             route.matches(other1) # True, ["123"]
 
-            other2 = _Route("/other-example", GET)
+            other2 = Route("/other-example", GET)
             route.matches(other2) # False, []
 
             ...
 
-            route1 = _Route("/example/.../something", GET)
-            other1 = _Route("/example/123/something", GET)
+            route1 = Route("/example/.../something", GET)
+            other1 = Route("/example/123/something", GET)
             route1.matches(other1) # True, []
 
-            route2 = _Route("/example/..../something", GET)
-            other2 = _Route("/example/123/456/something", GET)
+            route2 = Route("/example/..../something", GET)
+            other2 = Route("/example/123/456/something", GET)
             route2.matches(other2) # True, []
         """
 
@@ -103,23 +110,20 @@ def __repr__(self) -> str:
         path = repr(self.path)
         methods = repr(self.methods)
 
-        return f"_Route(path={path}, methods={methods})"
+        return f"Route(path={path}, methods={methods})"
 
 
 class _Routes:
     """A collection of routes and their corresponding handlers."""
 
     def __init__(self) -> None:
-        self._routes: List[_Route] = []
-        self._handlers: List[Callable] = []
+        self._routes: List[Route] = []
 
-    def add(self, route: _Route, handler: Callable):
+    def add(self, route: Route):
         """Adds a route and its handler to the collection."""
-
         self._routes.append(route)
-        self._handlers.append(handler)
 
-    def find_handler(self, route: _Route) -> Union[Callable["...", "Response"], None]:
+    def find_handler(self, route: Route) -> Union[Callable["...", "Response"], None]:
         """
         Finds a handler for a given route.
 
@@ -146,7 +150,7 @@ def route_func(request, my_parameter):
         if not found_route:
             return None
 
-        handler = self._handlers[self._routes.index(_route)]
+        handler = _route.handler
 
         keyword_parameters = dict(zip(_route.parameters_names, parameters_values))
 

adafruit_httpserver/server.py

@@ -28,7 +28,7 @@
 from .methods import GET, HEAD
 from .request import Request
 from .response import Response, FileResponse
-from .route import _Routes, _Route
+from .route import _Routes, Route
 from .status import BAD_REQUEST_400, UNAUTHORIZED_401, FORBIDDEN_403, NOT_FOUND_404
 
 
@@ -117,13 +117,8 @@ def route_func(request, my_parameter):
             def route_func(request):
                 ...
         """
-        if path.endswith("/") and append_slash:
-            raise ValueError("Cannot use append_slash=True when path ends with /")
-
-        methods = set(methods) if isinstance(methods, (set, list)) else set([methods])
-
         def route_decorator(func: Callable) -> Callable:
-            self._routes.add(_Route(path, methods, append_slash), func)
+            self._routes.add(Route(path, methods, func, append_slash=append_slash))
             return func
 
         return route_decorator