python-osc/pythonosc/dispatcher.py at master · FrancescElies/python-osc · GitHub

History

207 lines (170 loc) · 8.38 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

"""Maps OSC addresses to handler functions

"""

import collections

import logging

import re

import time

from pythonosc import osc_packet

from typing import overload, List, Union, Any, Generator, Tuple

from types import FunctionType

from pythonosc.osc_message import OscMessage

class Handler(object):

"""Wrapper for a callback function that will be called when an OSC message is sent to the right address.

Represents a handler callback function that will be called whenever an OSC message is sent to the address this

handler is mapped to. It passes the address, the fixed arguments (if any) as well as all osc arguments from the

message if any were passed.

"""

def __init__(self, _callback: FunctionType, _args: Union[Any, List[Any]],

_needs_reply_address: bool = False) -> None:

"""

Args:

_callback Function that is called when handler is invoked

_args: Message causing invocation

_needs_reply_address Whether the client's ip address shall be passed as an argument or not

"""

self.callback = _callback

self.args = _args

self.needs_reply_address = _needs_reply_address

# needed for test module

def __eq__(self, other) -> bool:

return (type(self) == type(other) and

self.callback == other.callback and

self.args == other.args and

self.needs_reply_address == other.needs_reply_address)

def invoke(self, client_address: str, message: OscMessage) -> None:

"""Invokes the associated callback function

Args:

client_address: Address match that causes the invocation

message: Message causing invocation

"""

if self.needs_reply_address:

if self.args:

self.callback(client_address, message.address, self.args, *message)

else:

self.callback(client_address, message.address, *message)

else:

if self.args:

self.callback(message.address, self.args, *message)

else:

self.callback(message.address, *message)

class Dispatcher(object):

"""Maps Handlers to OSC addresses and dispatches messages to the handler on matched addresses

Maps OSC addresses to handler functions and invokes the correct handler when a message comes in.

"""

def __init__(self) -> None:

self._map = collections.defaultdict(list)

self._default_handler = None

def map(self, address: str, handler: FunctionType, *args: Union[Any, List[Any]],

needs_reply_address: bool = False) -> Handler:

"""Map an address to a handler

The callback function must have one of the following signatures:

``def some_cb(address: str, *osc_args: List[Any]) -> None:``

``def some_cb(address: str, fixed_args: List[Any], *osc_args: List[Any]) -> None:``

``def some_cb(client_address: Tuple[str, int], address: str, *osc_args: List[Any]) -> None:``

``def some_cb(client_address: Tuple[str, int], address: str, fixed_args: List[Any], *osc_args: List[Any]) -> None:``

Args:

address: Address to be mapped

handler: Callback function that will be called as the handler for the given address

*args: Fixed arguements that will be passed to the callback function

needs_reply_address: Whether the IP address from which the message originated from shall be passed as

an argument to the handler callback

Returns:

The handler object that will be invoked should the given address match

"""

# TODO: Check the spec:

# http://opensoundcontrol.org/spec-1_0

# regarding multiple mappings

handlerobj = Handler(handler, list(args), needs_reply_address)

self._map[address].append(handlerobj)

return handlerobj

@overload

def unmap(self, address: str, handler: Handler) -> None:

"""Remove an already mapped handler from an address

Args:

address (str): Address to be unmapped

handler (Handler): A Handler object as returned from map().

"""

pass

@overload

def unmap(self, address: str, handler: FunctionType, *args: Union[Any, List[Any]],

needs_reply_address: bool = False) -> None:

"""Remove an already mapped handler from an address

Args:

address: Address to be unmapped

handler: A function that will be run when the address matches with

the OscMessage passed as parameter.

args: Any additional arguments that will be always passed to the

handlers after the osc messages arguments if any.

needs_reply_address: True if the handler function needs the

originating client address passed (as the first argument).

"""

pass

def unmap(self, address, handler, *args, needs_reply_address=False):

try:

if isinstance(handler, Handler):

self._map[address].remove(handler)

else:

self._map[address].remove(Handler(handler, list(args), needs_reply_address))

except ValueError as e:

if str(e) == "list.remove(x): x not in list":

raise ValueError("Address '%s' doesn't have handler '%s' mapped to it" % (address, handler)) from e

def handlers_for_address(self, address_pattern: str) -> Generator[None, Handler, None]:

"""Yields handlers matching an address

Args:

address_pattern: Address to match

Returns:

Generator yielding Handlers matching address_pattern

"""

# First convert the address_pattern into a matchable regexp.

# '?' 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.

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|\+]*')

# The rest of the syntax in the specification is like the re module so

# we're fine.

pattern = pattern + '$'

patterncompiled = re.compile(pattern)

matched = False

for addr, handlers in self._map.items():

if (patterncompiled.match(addr)

or (('*' in addr) and re.match(addr.replace('*', '[^/]*?/*'), address_pattern))):

yield from handlers

matched = True

if not matched and self._default_handler:

logging.debug('No handler matched but default handler present, added it.')

yield self._default_handler

def call_handlers_for_packet(self, data: bytes, client_address: Tuple[str, int]) -> None:

"""Invoke handlers for all messages in OSC packet

The incoming OSC Packet is decoded and the handlers for each included message is found and invoked.

Args:

data: Data of packet

client_address: Address of client this packet originated from

"""

# Get OSC messages from all bundles or standalone message.

try:

packet = osc_packet.OscPacket(data)

for timed_msg in packet.messages:

now = time.time()

handlers = self.handlers_for_address(

timed_msg.message.address)

if not handlers:

continue

# If the message is to be handled later, then so be it.

if timed_msg.time > now:

time.sleep(timed_msg.time - now)

for handler in handlers:

handler.invoke(client_address, timed_msg.message)

except osc_packet.ParseError:

pass

def set_default_handler(self, handler: FunctionType, needs_reply_address: bool = False) -> None:

"""Sets the default handler

The default handler is invoked every time no other handler is mapped to an address.

Args:

handler: Callback function to handle unmapped requests

needs_reply_address: Whether the callback shall be passed the client address

"""

self._default_handler = None if (handler is None) else Handler(handler, [], needs_reply_address)

python-osc/pythonosc/dispatcher.py at master · FrancescElies/python-osc · GitHub

Expand file tree

Breadcrumbs

dispatcher.py

Latest commit

History

Breadcrumbs

dispatcher.py

File metadata and controls