support for wildcards in dispatch patterns

Author: jsheedy

pythonosc/dispatcher.py

@@ -35,8 +35,8 @@ def handlers_for_address(self, address_pattern):
     # '?' in the OSC Address Pattern matches any single character.
     # Let's consider numbers and _ "characters" too here, it's not said
     # explicitly in the specification but it sounds good.
-    address_pattern = re.escape(address_pattern)
-    pattern = address_pattern.replace('\\?', '\\w?')
+    escaped_address_pattern = re.escape(address_pattern)
+    pattern = escaped_address_pattern.replace('\\?', '\\w?')
     # '*' in the OSC Address Pattern matches any sequence of zero or more
     # characters.
     pattern = pattern.replace('\\*', '[\w|\+]*')
@@ -45,7 +45,12 @@ def handlers_for_address(self, address_pattern):
     pattern = pattern + '$'
     pattern = re.compile(pattern)
     matched = [
-        handler for addr, handler in self._map.items() if pattern.match(addr)]
+        handler for addr, handler in self._map.items()
+        if ( pattern.match(addr) # wildcards could be in the incoming pattern
+             # .. or the mapped pattern
+             or (('*' in addr) and re.match(addr.replace('*','[^/]*?/*'), address_pattern))
+           )
+        ]
     if not matched and self._default_handler:
       matched.append(Handler(self._default_handler, []))
       logging.debug('No handler matched but default handler present, added it.')

pythonosc/test/test_dispatcher.py

@@ -18,7 +18,7 @@ def test_empty_by_default(self):
   def test_use_default_handler_when_set_and_no_match(self):
     handler = object()
     self.dispatcher.set_default_handler(handler)
-    self.assertEqual([(handler, [])], self.dispatcher.handlers_for_address('/test'))
+    self.assertEqual([dispatcher.Handler(handler, [])], self.dispatcher.handlers_for_address('/test'))
 
   def test_simple_map_and_match(self):
     handler = object()
@@ -27,7 +27,7 @@ def test_simple_map_and_match(self):
     self.assertEqual(
         [(handler, [1, 2, 3])], self.dispatcher.handlers_for_address('/test'))
     self.assertEqual(
-        [(handler, [])], self.dispatcher.handlers_for_address('/test2'))
+        [dispatcher.Handler(handler, [])], self.dispatcher.handlers_for_address('/test2'))
 
   def test_example_from_spec(self):
     addresses = [
@@ -89,5 +89,22 @@ def test_call_correct_dispatcher_on_star(self):
     self.sortAndAssertSequenceEqual(
         [(1, [])], self.dispatcher.handlers_for_address('/a+b'))
 
+  def test_map_star(self):
+    self.dispatcher.map('/starbase/*', 1)
+    self.sortAndAssertSequenceEqual(
+        [(1, [])], self.dispatcher.handlers_for_address("/starbase/bar"))
+
+  def test_map_root_star(self):
+    self.dispatcher.map('/*', 1)
+    self.sortAndAssertSequenceEqual(
+        [(1, [])], self.dispatcher.handlers_for_address("/anything/matches"))
+
+  def test_map_double_stars(self):
+    self.dispatcher.map('/foo/*/bar/*', 1)
+    self.sortAndAssertSequenceEqual(
+        [(1, [])], self.dispatcher.handlers_for_address("/foo/wild/bar/wild"))
+    self.sortAndAssertSequenceEqual(
+        [], self.dispatcher.handlers_for_address("/foo/wild/nomatch/wild"))
+
 if __name__ == "__main__":
   unittest.main()