Refactor of _Route and _Routes, added append_slash

Author: michalpokusa

adafruit_httpserver/route.py

@@ -8,7 +8,7 @@
 """
 
 try:
-    from typing import Callable, List, Union, Tuple
+    from typing import Callable, List, Set, Union, Tuple
 except ImportError:
     pass
 
@@ -20,18 +20,19 @@
 class _Route:
     """Route definition for different paths, see `adafruit_httpserver.server.Server.route`."""
 
-    def __init__(self, path: str = "", method: str = GET) -> None:
+    def __init__(
+        self,
+        path: str = "",
+        methods: Union[str, Set[str]] = GET,
+        append_slash: bool = False,
+    ) -> None:
         self._validate_path(path)
 
         self.parameters_names = [
             name[1:-1] for name in re.compile(r"/[^<>]*/?").split(path) if name != ""
         ]
-        self.path = (
-            path
-            if not self._contains_parameters
-            else re.sub(r"<\w*>", r"([^/]*)", path)
-        )
-        self.method = method
+        self.path = re.sub(r"<\w*>", r"([^/]*)", path) + ("/?" if append_slash else "")
+        self.methods = methods if isinstance(methods, set) else {methods}
 
     @staticmethod
     def _validate_path(path: str) -> None:
@@ -41,10 +42,6 @@ def _validate_path(path: str) -> None:
         if "<>" in path:
             raise ValueError("All URL parameters must be named.")
 
-    @property
-    def _contains_parameters(self) -> bool:
-        return 0 < len(self.parameters_names)
-
     def match(self, other: "_Route") -> Tuple[bool, List[str]]:
         """
         Checks if the route matches the other route.
@@ -76,20 +73,20 @@ def match(self, other: "_Route") -> Tuple[bool, List[str]]:
             route.matches(other2) # False, []
         """
 
-        if self.method != other.method:
+        if not other.methods.issubset(self.methods):
             return False, []
 
-        if not self._contains_parameters:
-            return self.path == other.path, []
-
         regex_match = re.match(f"^{self.path}$", other.path)
         if regex_match is None:
             return False, []
 
         return True, regex_match.groups()
 
     def __repr__(self) -> str:
-        return f"_Route(path={repr(self.path)}, method={repr(self.method)})"
+        path = repr(self.path)
+        methods = repr(self.methods)
+
+        return f"_Route(path={path}, methods={methods})"
 
 
 class _Routes:

adafruit_httpserver/server.py

@@ -8,7 +8,7 @@
 """
 
 try:
-    from typing import Callable, Protocol, Union, List, Tuple
+    from typing import Callable, Protocol, Union, List, Set, Tuple
     from socket import socket
     from socketpool import SocketPool
 except ImportError:
@@ -51,20 +51,30 @@ def __init__(
         self._auths = []
         self._buffer = bytearray(1024)
         self._timeout = 1
-        self.routes = _Routes()
+        self._routes = _Routes()
         self._socket_source = socket_source
         self._sock = None
         self.root_path = root_path
         self.stopped = False
 
         self.debug = debug
 
-    def route(self, path: str, methods: Union[str, List[str]] = GET) -> Callable:
+    def route(
+        self,
+        path: str,
+        methods: Union[str, Set[str]] = GET,
+        *,
+        append_slash: bool = False,
+    ) -> Callable:
         """
         Decorator used to add a route.
 
+        If request matches multiple routes, the first matched one added will be used.
+
         :param str path: URL path
         :param str methods: HTTP method(s): ``"GET"``, ``"POST"``, ``["GET", "POST"]`` etc.
+        :param bool append_slash: If True, the route will be accessible with and without a
+          trailing slash
 
         Example::
 
@@ -78,6 +88,14 @@ def route_func(request):
             def route_func(request):
                 ...
 
+            # If you want to access URL with and without trailing slash, use append_slash=True
+            @server.route("/example-with-slash", append_slash=True)
+            # which is equivalent to
+            @server.route("/example-with-slash")
+            @server.route("/example-with-slash/")
+            def route_func(request):
+                ...
+
             # Multiple methods can be specified
             @server.route("/example", [GET, POST])
             def route_func(request):
@@ -88,12 +106,13 @@ def route_func(request):
             def route_func(request, my_parameter):
                 ...
         """
-        if isinstance(methods, str):
-            methods = [methods]
+        if path.endswith("/") and append_slash:
+            raise ValueError("Cannot use append_slash=True when path ends with /")
+
+        methods = methods if isinstance(methods, set) else {methods}
 
         def route_decorator(func: Callable) -> Callable:
-            for method in methods:
-                self.routes.add(_Route(path, method), func)
+            self._routes.add(_Route(path, methods, append_slash), func)
             return func
 
         return route_decorator
@@ -294,7 +313,9 @@ def poll(self):
                     _debug_incoming_request(request)
 
                 # Find a handler for the route
-                handler = self.routes.find_handler(_Route(request.path, request.method))
+                handler = self._routes.find_handler(
+                    _Route(request.path, request.method)
+                )
 
                 # Handle the request
                 self._handle_request(request, handler)

docs/examples.rst

@@ -101,7 +101,9 @@ You can pass a list of methods or a single method as a string.
 
 It is recommended to use the the values in ``adafruit_httpserver.methods`` module to avoid typos and for future proofness.
 
-In example below, handler for ``/api`` route will be called when any of ``GET``, ``POST``, ``PUT``, ``DELETE`` methods is used.
+If you want to route a given path with and without trailing slash, use ``append_slash=True`` parameter.
+
+In example below, handler for ``/api`` and ``/api/`` route will be called when any of ``GET``, ``POST``, ``PUT``, ``DELETE`` methods is used.
 
 .. literalinclude:: ../examples/httpserver_methods.py
     :caption: examples/httpserver_methods.py

examples/httpserver_cpu_information.py

@@ -13,7 +13,7 @@
 server = Server(pool, debug=True)
 
 
-@server.route("/cpu-information")
+@server.route("/cpu-information", append_slash=True)
 def cpu_information_handler(request: Request):
     """
     Return the current CPU temperature, frequency, and voltage as JSON.

examples/httpserver_methods.py

@@ -12,7 +12,7 @@
 server = Server(pool, debug=True)
 
 
-@server.route("/api", [GET, POST, PUT, DELETE])
+@server.route("/api", [GET, POST, PUT, DELETE], append_slash=True)
 def api(request: Request):
     """
     Performs different operations depending on the HTTP method.