"""
import logging
+from Queue import Queue, Empty
+
+from .command import NullQueue
class QueueMessage (object):
class CommandMessage (QueueMessage):
- """A message storing a command to run, `command` should be a
- :class:`hooke.command.Command` instance, and `arguments` should be
- a :class:`dict` with `argname` keys and `value` values to be
- passed to the command.
+ """A message storing a command to run, `command` should be the
+ name of a :class:`hooke.command.Command` instance, and `arguments`
+ should be a :class:`dict` with `argname` keys and `value` values
+ to be passed to the command.
"""
def __init__(self, command, arguments=None):
self.command = command
arguments = {}
self.arguments = arguments
+ def __str__(self):
+ return str(self.__unicode__())
+
+ def __unicode__(self):
+ """Return a unicode representation of the `CommandMessage`.
+
+ Examples
+ --------
+ >>> from .compat.odict import odict
+ >>> cm = CommandMessage('command A')
+ >>> print unicode(cm)
+ <CommandMessage command A>
+ >>> cm.arguments = odict([('param a','value a'), ('param b', 'value b')])
+ >>> print unicode(cm)
+ <CommandMessage command A {param a: value a, param b: value b}>
+
+ The parameters are sorted by name, so you won't be surprised
+ in any doctests, etc.
+
+ >>> cm.arguments = odict([('param b','value b'), ('param a', 'value a')])
+ >>> print unicode(cm)
+ <CommandMessage command A {param a: value a, param b: value b}>
+ """
+ if len(self.arguments) > 0:
+ return u'<%s %s {%s}>' % (
+ self.__class__.__name__, self.command,
+ ', '.join(['%s: %s' % (key, value)
+ for key,value in sorted(self.arguments.items())]))
+ return u'<%s %s>' % (self.__class__.__name__, self.command)
+
+ def __repr__(self):
+ return self.__str__()
+
class CommandEngine (object):
def run(self, hooke, ui_to_command_queue, command_to_ui_queue):
'engine closing, placed hooke instance in return queue')
break
assert isinstance(msg, CommandMessage), type(msg)
- log.debug('engine running %s' % msg.command.name)
- msg.command.run(hooke, ui_to_command_queue, command_to_ui_queue,
- **msg.arguments)
+ log.debug('engine running %s' % msg)
+ cmd = hooke.command_by_name[msg.command]
+ cmd.run(hooke, ui_to_command_queue, command_to_ui_queue,
+ **msg.arguments)
+
+ def run_command(self, hooke, command, arguments):
+ """Run the command named `command` with `arguments` using
+ :meth:`~hooke.engine.CommandEngine.run_command`.
+
+ This allows commands to execute sub commands and enables
+ :class:`~hooke.command_stack.CommandStack` execution.
+
+ Note that these commands *do not* have access to the usual UI
+ communication queues, so make sure they will not need user
+ interaction.
+ """
+ log = logging.getLogger('hooke')
+ log.debug('engine running internal %s'
+ % CommandMessage(command, arguments))
+ outqueue = Queue()
+ cmd = hooke.command_by_name[command]
+ cmd.run(hooke, NullQueue(), outqueue, **arguments)
+ while True:
+ try:
+ msg = outqueue.get(block=False)
+ except Empty:
+ break
+ log.debug('engine message from %s (%s): %s' % (command, type(msg), msg))