Added ... and .... wildcards

Author: michalpokusa

adafruit_httpserver/route.py

@@ -31,7 +31,9 @@ def __init__(
         self.parameters_names = [
             name[1:-1] for name in re.compile(r"/[^<>]*/?").split(path) if name != ""
         ]
-        self.path = re.sub(r"<\w*>", r"([^/]*)", path) + ("/?" if append_slash else "")
+        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}
 
     @staticmethod
@@ -54,10 +56,12 @@ def match(self, other: "_Route") -> Tuple[bool, List[str]]:
 
         Examples::
 
-            route = _Route("/example", GET)
+            route = _Route("/example", GET, True)
 
-            other1 = _Route("/example", GET)
-            route.matches(other1) # True, []
+            other1a = _Route("/example", GET)
+            other1b = _Route("/example/", GET)
+            route.matches(other1a) # True, []
+            route.matches(other1b) # True, []
 
             other2 = _Route("/other-example", GET)
             route.matches(other2) # False, []
@@ -71,6 +75,16 @@ def match(self, other: "_Route") -> Tuple[bool, List[str]]:
 
             other2 = _Route("/other-example", GET)
             route.matches(other2) # False, []
+
+            ...
+
+            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.matches(other2) # True, []
         """
 
         if not other.methods.issubset(self.methods):

adafruit_httpserver/server.py

@@ -102,9 +102,15 @@ def route_func(request):
                 ...
 
             # URL parameters can be specified
-            @server.route("/example/<my_parameter>", GET)
+            @server.route("/example/<my_parameter>", GET) e.g. /example/123
             def route_func(request, my_parameter):
                 ...
+
+            # It is possible to use wildcard that can match any number of path segments
+            @server.route("/example/.../something", GET) # e.g. /example/123/something
+            @server.route("/example/..../something", GET) # e.g. /example/123/456/something
+            def route_func(request):
+                ...
         """
         if path.endswith("/") and append_slash:
             raise ValueError("Cannot use append_slash=True when path ends with /")

docs/examples.rst

@@ -154,8 +154,8 @@ To use it, you need to set the ``chunked=True`` when creating a ``Response`` obj
     :emphasize-lines: 21-26
     :linenos:
 
-URL parameters
---------------
+URL parameters and wildcards
+----------------------------
 
 Alternatively to using query parameters, you can use URL parameters.
 They are a better choice when you want to perform different actions based on the URL.
@@ -176,9 +176,16 @@ In the example below the second route has only one URL parameter, so the ``actio
 Keep in mind that URL parameters are always passed as strings, so you need to convert them to the desired type.
 Also note that the names of the function parameters **have to match** with the ones used in route, but they **do not have to** be in the same order.
 
+It is also possible to specify a wildcard route:
+
+- ``...`` - matches one path segment, e.g ``/api/...`` will match ``/api/123``, but **not** ``/api/123/456``
+- ``....`` - matches multiple path segments, e.g ``/api/....`` will match ``/api/123`` and ``/api/123/456``
+
+In both cases, wildcards will not match empty path segment, so ``/api/.../users`` will match ``/api/v1/users``, but not ``/api//users`` or ``/api/users``.
+
 .. literalinclude:: ../examples/httpserver_url_parameters.py
     :caption: examples/httpserver_url_parameters.py
-    :emphasize-lines: 30-34
+    :emphasize-lines: 30-34,54-55
     :linenos:
 
 Authentication

examples/httpserver_url_parameters.py

@@ -51,4 +51,16 @@ def perform_action(
         response.send(f"Action ({action}) performed on device with ID: {device_id}")
 
 
+@server.route("/device/.../status", append_slash=True)
+@server.route("/device/....", append_slash=True)
+def device_status(request: Request):
+    """
+    Returns the status of all devices no matter what their ID is.
+    Unknown commands also return the status of all devices.
+    """
+
+    with Response(request, content_type="text/plain") as response:
+        response.send("Status of all devices: ...")
+
+
 server.serve_forever(str(wifi.radio.ipv4_address))