python-osc/pythonosc/dispatcher.py at main · ZipFile/python-osc · GitHub

History

389 lines (344 loc) · 14.7 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

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

"""Maps OSC addresses to handler functions"""

import asyncio

import collections

import inspect

import logging

import re

import time

from pythonosc import osc_packet

from typing import (

overload,

List,

Union,

Any,

AnyStr,

Generator,

Tuple,

Callable,

Optional,

DefaultDict,

)

from pythonosc.osc_message import OscMessage

from pythonosc.osc_message_builder import ArgValue

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: Callable,

_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: Any) -> bool:

return (

isinstance(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: Tuple[str, int], message: OscMessage

) -> Union[None, AnyStr, Tuple[AnyStr, ArgValue]]:

"""Invokes the associated callback function

Args:

client_address: Address match that causes the invocation

message: Message causing invocation

Returns:

The result of the handler function can be None, a string OSC address, or a tuple of the OSC address

and arguments.

"""

if self.needs_reply_address:

if self.args:

return self.callback(

client_address, message.address, self.args, *message

)

else:

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

else:

if self.args:

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

else:

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

async def async_invoke(

self, client_address: Tuple[str, int], message: OscMessage

) -> Union[None, AnyStr, Tuple[AnyStr, ArgValue]]:

"""Invokes the associated callback function (asynchronously)

Args:

client_address: Address match that causes the invocation

message: Message causing invocation

Returns:

The result of the handler function can be None, a string OSC address, or a tuple of the OSC address

and arguments.

"""

cb = self.callback

is_async = inspect.iscoroutinefunction(cb)

if self.needs_reply_address:

if self.args:

if is_async:

return await cb(

client_address, message.address, self.args, *message

)

else:

return cb(client_address, message.address, self.args, *message)

else:

if is_async:

return await cb(client_address, message.address, *message)

else:

return cb(client_address, message.address, *message)

else:

if self.args:

if is_async:

return await cb(message.address, self.args, *message)

else:

return cb(message.address, self.args, *message)

else:

if is_async:

return await cb(message.address, *message)

else:

return cb(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, strict_timing: bool = True) -> None:

"""Initialize the dispatcher.

Args:

strict_timing: Whether to automatically schedule messages with future timetags.

If True (default), the dispatcher will wait (using sleep) until the specified

timetag before invoking handlers.

If False, messages are dispatched immediately regardless of their timetag.

Disabling this can prevent memory/thread accumulation issues when receiving

many future-dated messages.

"""

self._map: DefaultDict[str, List[Handler]] = collections.defaultdict(list)

self._default_handler: Optional[Handler] = None

self._strict_timing = strict_timing

def map(

self,

address: str,

handler: Callable,

*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]) -> Union[None, AnyStr, Tuple(str, ArgValue)]:``

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

Tuple(str, ArgValue)]:``

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

Tuple(str, ArgValue)]:``

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

The callback function can return None, or a string representing an OSC address to be returned to the client,

or a tuple that includes the address and ArgValue which will be converted to an OSC message and returned to

the client.

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: Callable,

*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(

f"Address '{address}' doesn't have handler '{handler}' mapped to it"

) from e

def handlers_for_address(

self, address_pattern: str

) -> Generator[Handler, None, None]:

"""Yields handlers matching an address

Args:

address_pattern: Address to match

Returns:

Generator yielding Handlers matching address_pattern

"""

# Convert OSC Address Pattern to a Python regular expression.

# Spec: https://opensoundcontrol.stanford.edu/spec-1_0.html#osc-address-patterns

pattern = "^"

i = 0

while i < len(address_pattern):

c = address_pattern[i]

if c == "*":

pattern += "[^/]*"

elif c == "?":

pattern += "[^/]"

elif c == "[":

pattern += "["

i += 1

if i < len(address_pattern) and address_pattern[i] == "!":

pattern += "^"

i += 1

while i < len(address_pattern) and address_pattern[i] != "]":

if address_pattern[i] in r"\^$.|()+*?":

pattern += "\\"

pattern += address_pattern[i]

i += 1

pattern += "]"

elif c == "{":

pattern += "("

i += 1

while i < len(address_pattern) and address_pattern[i] != "}":

char = address_pattern[i]

if char == ",":

pattern += "|"

elif char in r"\^$.|()[]+*?":

pattern += "\\" + char

else:

pattern += char

i += 1

pattern += ")"

elif c in r"\^$.|()[]+?":

pattern += "\\" + c

else:

pattern += c

i += 1

pattern += "$"

try:

patterncompiled = re.compile(pattern)

except re.error:

# If the pattern is invalid, it won't match anything.

return

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]

) -> List:

"""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

Returns: A list of strings or tuples to be converted to OSC messages and returned to the client

"""

results = list()

# 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 self._strict_timing and timed_msg.time > now:

time.sleep(timed_msg.time - now)

for handler in handlers:

result = handler.invoke(client_address, timed_msg.message)

if result is not None:

results.append(result)

except osc_packet.ParseError:

pass

return results

async def async_call_handlers_for_packet(

self, data: bytes, client_address: Tuple[str, int]

) -> List:

"""

This function calls the handlers registered to the dispatcher for

every message it found in the packet.

The process/thread granularity is thus the OSC packet, not the handler.

If parameters were registered with the dispatcher, then the handlers are

called this way:

handler('/address that triggered the message',

registered_param_list, osc_msg_arg1, osc_msg_arg2, ...)

if no parameters were registered, then it is just called like this:

handler('/address that triggered the message',

osc_msg_arg1, osc_msg_arg2, osc_msg_param3, ...)

"""

# Get OSC messages from all bundles or standalone message.

results = []

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 self._strict_timing and timed_msg.time > now:

await asyncio.sleep(timed_msg.time - now)

for handler in handlers:

result = await handler.async_invoke(

client_address, timed_msg.message

)

if result is not None:

results.append(result)

except osc_packet.ParseError:

pass

return results

def set_default_handler(

self, handler: Callable, 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 main · ZipFile/python-osc · GitHub

Expand file tree

Breadcrumbs

dispatcher.py

Latest commit

History

Breadcrumbs

dispatcher.py

File metadata and controls