Annikka/evennia
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Refactor get_and_merge_cmdsets to merge all cmdsets in one place rather than sub-merging them separately on each object first. See #1087. Also changes the names of the auto-added _exitset to ExitCmdSet and _channelset to ChannelCmdSet. Allow Channel cmdsets to also be identified on Objects.

Browse source
This commit is contained in:
Griatch 2016-10-09 14:25:38 +02:00
parent bac6c7f234
commit edacd58eab
5 changed files with 125 additions and 73 deletions
Download patch file Download diff file Expand all files Collapse all files

85
evennia/commands/cmdhandler.py
View file

@ -199,15 +199,13 @@ def get_and_merge_cmdsets(caller, session, player, obj, callertype):
local_obj_cmdsets = [None] local_obj_cmdsets = [None]
@inlineCallbacks @inlineCallbacks
def _get_channel_cmdset(player):#, player_cmdset): def _get_channel_cmdset(player_or_obj):
""" """
Helper-method; Get channel-cmdsets Helper-method; Get channel-cmdsets
""" """
# Create cmdset for all player's available channels # Create cmdset for all player's available channels
try: try:
channel_cmdset = None channel_cmdset = yield CHANNELHANDLER.get_cmdset(player_or_obj)
#if not player_cmdset.no_channels: #TODO
channel_cmdset = yield CHANNELHANDLER.get_cmdset(player)
returnValue([channel_cmdset]) returnValue([channel_cmdset])
except Exception: except Exception:
_msg_err(caller, _ERROR_CMDSETS) _msg_err(caller, _ERROR_CMDSETS)
@ -261,7 +259,7 @@ def get_and_merge_cmdsets(caller, session, player, obj, callertype):
def _get_cmdsets(obj): def _get_cmdsets(obj):
""" """
Helper method; Get cmdset while making sure to trigger all Helper method; Get cmdset while making sure to trigger all
hooks safely. hooks safely. Returns the stack and the valid options.
""" """
try: try:
yield obj.at_cmdset_get() yield obj.at_cmdset_get()
@ -269,43 +267,71 @@ def get_and_merge_cmdsets(caller, session, player, obj, callertype):
_msg_err(caller, _ERROR_CMDSETS) _msg_err(caller, _ERROR_CMDSETS)
raise ErrorReported raise ErrorReported
try: try:
#returnValue(obj.cmdset.current) # we don't return the 'duplicates' option since this happens per-merge
returnValue(obj.cmdset.cmdset_stack) returnValue((obj.cmdset.current, obj.cmdset.cmdset_stack))
except AttributeError: except AttributeError:
returnValue(None) returnValue(((None, None, None), []))
local_obj_cmdsets = []
if callertype == "session": if callertype == "session":
# we are calling the command from the session level # we are calling the command from the session level
report_to = session report_to = session
cmdsets = yield _get_cmdsets(session) current, cmdsets = yield _get_cmdsets(session)
if player: # this automatically implies logged-in if player: # this automatically implies logged-in
player_cmdsets = yield _get_cmdsets(player) pcurrent, player_cmdsets = yield _get_cmdsets(player)
channel_cmdset = yield _get_channel_cmdset(player) cmdsets += player_cmdsets
cmdsets += player_cmdsets + channel_cmdset current = current + pcurrent
if obj: if obj:
obj_cmdset = yield _get_cmdsets(obj) ocurrent, obj_cmdsets = yield _get_cmdsets(obj)
local_obj_cmdsets = yield _get_local_obj_cmdsets(obj) current = current + ocurrent
cmdsets.extend(obj_cmdset + local_obj_cmdsets) cmdsets += obj_cmdsets
if not current.no_objs:
local_obj_cmdsets = yield _get_local_obj_cmdsets(obj)
if current.no_exits:
# filter out all exits
local_obj_cmdsets = [cmdset for cmdset in local_obj_cmdsets if cmdset.key != "ExitCmdSet"]
cmdsets += local_obj_cmdsets
if not current.no_channels:
# also objs may have channels
cmdsets += yield _get_channel_cmdset(obj)
if not current.no_channels:
cmdsets += yield _get_channel_cmdset(player)
elif callertype == "player": elif callertype == "player":
# we are calling the command from the player level # we are calling the command from the player level
report_to = player report_to = player
player_cmdset = yield _get_cmdsets(player) current, cmdsets = yield _get_cmdsets(player)
channel_cmdset = yield _get_channel_cmdset(player)
cmdsets = player_cmdset + channel_cmdset
if obj: if obj:
obj_cmdset = yield _get_cmdsets(obj) ocurrent, obj_cmdsets = yield _get_cmdsets(obj)
local_obj_cmdsets = yield _get_local_obj_cmdsets(obj) current = current + ocurrent
cmdsets.extend(obj_cmdset + local_obj_cmdsets) cmdsets += obj_cmdsets
if not current.no_objs:
local_obj_cmdsets = yield _get_local_obj_cmdsets(obj)
if current.no_exits:
# filter out all exits
local_obj_cmdsets = [cmdset for cmdset in local_obj_cmdsets if cmdset.key != "ExitCmdSet"]
cmdsets += local_obj_cmdsets
if not current.no_channels:
# also objs may have channels
cmdsets += yield _get_channel_cmdset(obj)
if not current.no_channels:
cmdsets += yield _get_channel_cmdset(player)
elif callertype == "object": elif callertype == "object":
# we are calling the command from the object level # we are calling the command from the object level
report_to = obj report_to = obj
obj_cmdset = yield _get_cmdsets(obj) current, cmdsets = yield _get_cmdsets(obj)
local_obj_cmdsets = yield _get_local_obj_cmdsets(obj) if not current.no_objs:
cmdsets = obj_cmdset + local_obj_cmdsets local_obj_cmdsets = yield _get_local_obj_cmdsets(obj)
if current.no_exits:
# filter out all exits
local_obj_cmdsets = [cmdset for cmdset in local_obj_cmdsets if cmdset.key != "ExitCmdSet"]
cmdsets += yield local_obj_cmdsets
if not current.no_channels:
# also objs may have channels
cmdsets += yield _get_channel_cmdset(obj)
else: else:
raise Exception("get_and_merge_cmdsets: callertype %s is not valid." % callertype) raise Exception("get_and_merge_cmdsets: callertype %s is not valid." % callertype)
#cmdsets = yield [caller_cmdset] + [player_cmdset] +
# [channel_cmdset] + local_obj_cmdsets
# weed out all non-found sets # weed out all non-found sets
cmdsets = yield [cmdset for cmdset in cmdsets cmdsets = yield [cmdset for cmdset in cmdsets
@ -354,6 +380,7 @@ def get_and_merge_cmdsets(caller, session, player, obj, callertype):
raise raise
except Exception: except Exception:
_msg_err(caller, _ERROR_CMDSETS) _msg_err(caller, _ERROR_CMDSETS)
raise
raise ErrorReported raise ErrorReported
# Main command-handler function # Main command-handler function
@ -544,12 +571,6 @@ def cmdhandler(called_by, raw_string, _testing=False, callertype="session", sess
match = matches[0] match = matches[0]
cmdname, args, cmd = match[0], match[1], match[2] cmdname, args, cmd = match[0], match[1], match[2]
# check if we allow this type of command
if cmdset.no_channels and hasattr(cmd, "is_channel") and cmd.is_channel:
matches = []
if cmdset.no_exits and hasattr(cmd, "is_exit") and cmd.is_exit:
matches = []
if not matches: if not matches:
# No commands match our entered command # No commands match our entered command
syscmd = yield cmdset.get(CMD_NOMATCH) syscmd = yield cmdset.get(CMD_NOMATCH)

38
evennia/commands/cmdset.py
View file

@ -390,23 +390,12 @@ class CmdSet(with_metaclass(_CmdSetMeta, object)):
else: # Union else: # Union
cmdset_c = self._union(cmdset_a, self) cmdset_c = self._union(cmdset_a, self)
if self.priority == cmdset_a.priority: # pass through options whenever they are set, unless the merging or higher-prio
# same prio - pass through if changed # set changes the setting (i.e. has a non-None value).
cmdset_c.no_channels = self.no_channels if cmdset_a.no_channels is None else cmdset_a.no_channels cmdset_c.no_channels = self.no_channels if cmdset_a.no_channels is None else cmdset_a.no_channels
cmdset_c.no_exits = self.no_exits if cmdset_a.no_exits is None else cmdset_a.no_exits cmdset_c.no_exits = self.no_exits if cmdset_a.no_exits is None else cmdset_a.no_exits
cmdset_c.no_objs = self.no_objs if cmdset_a.no_objs is None else cmdset_a.no_objs cmdset_c.no_objs = self.no_objs if cmdset_a.no_objs is None else cmdset_a.no_objs
cmdset_c.duplicates = self.duplicates if cmdset_a.duplicates is None else cmdset_a.duplicates cmdset_c.duplicates = self.duplicates if cmdset_a.duplicates is None else cmdset_a.duplicates
else:
# pass through the options of the higher prio set
cmdset_c.no_channels = cmdset_a.no_channels
cmdset_c.no_exits = cmdset_a.no_exits
cmdset_c.no_objs = cmdset_a.no_objs
cmdset_c.duplicates = cmdset_a.duplicates
if cmdset_a.key.startswith("_"):
# don't rename new output if the merge set's name starts with _
# these are usually things like exitcmdsets and channelcmdsets)
cmdset_c.key = self.key
else: else:
# B higher priority than A # B higher priority than A
@ -425,15 +414,12 @@ class CmdSet(with_metaclass(_CmdSetMeta, object)):
else: # Union else: # Union
cmdset_c = self._union(self, cmdset_a) cmdset_c = self._union(self, cmdset_a)
cmdset_c.no_channels = self.no_channels # pass through options whenever they are set, unless the higher-prio
cmdset_c.no_exits = self.no_exits # set changes the setting (i.e. has a non-None value).
cmdset_c.no_objs = self.no_objs cmdset_c.no_channels = cmdset_a.no_channels if self.no_channels is None else self.no_channels
cmdset_c.duplicates = self.duplicates cmdset_c.no_exits = cmdset_a.no_exits if self.no_exits is None else self.no_exits
cmdset_c.no_objs = cmdset_a.no_objs if self.no_objs is None else self.no_objs
# update or pass-through cmdset_c.duplicates = cmdset_a.duplicates if self.duplicates is None else self.duplicates
if self.key.startswith("_"):
# don't rename new output if the merge set's name starts with _
cmdset_c.key = cmdset_a.self.key
# we store actual_mergetype since key_mergetypes # we store actual_mergetype since key_mergetypes
# might be different from the main mergetype. # might be different from the main mergetype.

66
evennia/commands/tests.py
View file

@ -170,6 +170,8 @@ class TestCmdSetMergers(TestCase):
def test_option_transfer(self): def test_option_transfer(self):
"Test transfer of cmdset options" "Test transfer of cmdset options"
a, b, c, d = self.cmdset_a, self.cmdset_b, self.cmdset_c, self.cmdset_d a, b, c, d = self.cmdset_a, self.cmdset_b, self.cmdset_c, self.cmdset_d
# the options should pass through since none of the other cmdsets care
# to change the setting from None.
a.no_exits = True a.no_exits = True
a.no_objs = True a.no_objs = True
a.no_channels = True a.no_channels = True
@ -207,15 +209,25 @@ class TestCmdSetMergers(TestCase):
c.priority = 1 c.priority = 1
d.priority = 2 d.priority = 2
cmdset_f = d + c + b + a # reverse, A low prio cmdset_f = d + c + b + a # reverse, A low prio
self.assertFalse(cmdset_f.no_exits) self.assertTrue(cmdset_f.no_exits)
self.assertFalse(cmdset_f.no_objs) self.assertTrue(cmdset_f.no_objs)
self.assertFalse(cmdset_f.no_channels) self.assertTrue(cmdset_f.no_channels)
self.assertFalse(cmdset_f.duplicates) self.assertTrue(cmdset_f.duplicates)
self.assertEqual(len(cmdset_f.commands), 4) self.assertEqual(len(cmdset_f.commands), 4)
cmdset_f = a + b + c + d # forward, A low prio cmdset_f = a + b + c + d # forward, A low prio
self.assertTrue(cmdset_f.no_exits)
self.assertTrue(cmdset_f.no_objs)
self.assertTrue(cmdset_f.no_channels)
self.assertTrue(cmdset_f.duplicates)
self.assertEqual(len(cmdset_f.commands), 4)
c.no_exits = False
b.no_objs = False
d.duplicates = False
# higher-prio sets will change the option up the chain
cmdset_f = a + b + c + d # forward, A low prio
self.assertFalse(cmdset_f.no_exits) self.assertFalse(cmdset_f.no_exits)
self.assertFalse(cmdset_f.no_objs) self.assertFalse(cmdset_f.no_objs)
self.assertFalse(cmdset_f.no_channels) self.assertTrue(cmdset_f.no_channels)
self.assertFalse(cmdset_f.duplicates) self.assertFalse(cmdset_f.duplicates)
self.assertEqual(len(cmdset_f.commands), 4) self.assertEqual(len(cmdset_f.commands), 4)
a.priority = 0 a.priority = 0
@ -245,17 +257,28 @@ class TestGetAndMergeCmdSets(TwistedTestCase, EvenniaTest):
obj.cmdset.add(cmdset) obj.cmdset.add(cmdset)
def test_from_session(self): def test_from_session(self):
self.set_cmdsets(self.session, self.cmdset_a) a = self.cmdset_a
a.no_channels = True
self.set_cmdsets(self.session, a)
deferred = cmdhandler.get_and_merge_cmdsets(self.session, self.session, None, None, "session") deferred = cmdhandler.get_and_merge_cmdsets(self.session, self.session, None, None, "session")
_callback = lambda cmdset: self.assertEqual(cmdset.key, "A") def _callback(cmdset):
self.assertEqual(cmdset.key, "A")
deferred.addCallback(_callback) deferred.addCallback(_callback)
return deferred return deferred
def test_from_player(self): def test_from_player(self):
self.set_cmdsets(self.player, self.cmdset_a) from evennia.commands.default.cmdset_player import PlayerCmdSet
a = self.cmdset_a
a.no_channels = True
self.set_cmdsets(self.player, a)
deferred = cmdhandler.get_and_merge_cmdsets(self.player, None, self.player, None, "player") deferred = cmdhandler.get_and_merge_cmdsets(self.player, None, self.player, None, "player")
# get_and_merge_cmdsets converts to lower-case internally. # get_and_merge_cmdsets converts to lower-case internally.
_callback = lambda cmdset: self.assertEqual(sum(1 for cmd in cmdset.commands if cmd.key in ("a", "b", "c", "d")), 4) def _callback(cmdset):
pcmdset = PlayerCmdSet()
pcmdset.at_cmdset_creation()
pcmds = [cmd.key for cmd in pcmdset.commands] + ["a", "b", "c", "d"]
self.assertTrue(all(cmd.key in pcmds for cmd in cmdset.commands))
#_callback = lambda cmdset: self.assertEqual(sum(1 for cmd in cmdset.commands if cmd.key in ("a", "b", "c", "d")), 4)
deferred.addCallback(_callback) deferred.addCallback(_callback)
return deferred return deferred
@ -269,12 +292,33 @@ class TestGetAndMergeCmdSets(TwistedTestCase, EvenniaTest):
def test_multimerge(self): def test_multimerge(self):
a, b, c, d = self.cmdset_a, self.cmdset_b, self.cmdset_c, self.cmdset_d a, b, c, d = self.cmdset_a, self.cmdset_b, self.cmdset_c, self.cmdset_d
d.no_exits = True a.no_exits = True
a.no_channels = True
self.set_cmdsets(self.obj1, a, b, c, d) self.set_cmdsets(self.obj1, a, b, c, d)
deferred = cmdhandler.get_and_merge_cmdsets(self.obj1, None, None, self.obj1, "object") deferred = cmdhandler.get_and_merge_cmdsets(self.obj1, None, None, self.obj1, "object")
def _callback(cmdset): def _callback(cmdset):
self.assertEqual(cmdset.key, "D")
self.assertTrue(cmdset.no_exits) self.assertTrue(cmdset.no_exits)
self.assertTrue(cmdset.no_channels)
self.assertEqual(cmdset.key, "D")
deferred.addCallback(_callback)
return deferred
def test_autocmdsets(self):
import evennia
from evennia.commands.default.cmdset_player import PlayerCmdSet
from evennia.comms.channelhandler import CHANNEL_HANDLER
testchannel = evennia.create_channel("testchannel", locks="listen:all();send:all()")
CHANNEL_HANDLER.add(testchannel)
self.assertTrue(testchannel.connect(self.player))
a, b, c, d = self.cmdset_a, self.cmdset_b, self.cmdset_c, self.cmdset_d
self.set_cmdsets(self.player, a, b, c, d)
deferred = cmdhandler.get_and_merge_cmdsets(self.session, self.session, self.player, self.char1, "session")
def _callback(cmdset):
pcmdset = PlayerCmdSet()
pcmdset.at_cmdset_creation()
pcmds = [cmd.key for cmd in pcmdset.commands] + ["a", "b", "c", "d"] + ["out"]
self.assertTrue(all(cmd.key or hasattr(cmd, "is_channel") in pcmds for cmd in cmdset.commands))
self.assertTrue(any(hasattr(cmd, "is_channel") for cmd in cmdset.commands))
deferred.addCallback(_callback) deferred.addCallback(_callback)
return deferred return deferred

7
evennia/comms/channelhandler.py
View file

@ -162,7 +162,7 @@ class ChannelHandler(object):
""" """
self.cached_channel_cmds = [] self.cached_channel_cmds = []
def add_channel(self, channel): def add(self, channel):
""" """
Add an individual channel to the handler. This should be Add an individual channel to the handler. This should be
called whenever a new channel is created. called whenever a new channel is created.
@ -197,6 +197,7 @@ class ChannelHandler(object):
channeldesc=channel.attributes.get("desc", default="").strip()) channeldesc=channel.attributes.get("desc", default="").strip())
self.cached_channel_cmds.append(cmd) self.cached_channel_cmds.append(cmd)
self.cached_cmdsets = {} self.cached_cmdsets = {}
add_channel = add # legacy alias
def update(self): def update(self):
""" """
@ -220,7 +221,7 @@ class ChannelHandler(object):
Args: Args:
source_object (Object): An object subscribing to one source_object (Object): An object subscribing to one
or more channels. or more channels.
hannelhandler import CHANNEL_HANDLER
Returns: Returns:
cmdsets (list): The Channel-Cmdsets `source_object` has cmdsets (list): The Channel-Cmdsets `source_object` has
access to. access to.
@ -231,7 +232,7 @@ class ChannelHandler(object):
else: else:
# create a new cmdset holding all channels # create a new cmdset holding all channels
chan_cmdset = cmdset.CmdSet() chan_cmdset = cmdset.CmdSet()
chan_cmdset.key = '_channelset' chan_cmdset.key = 'ChannelCmdSet'
chan_cmdset.priority = 101 chan_cmdset.priority = 101
chan_cmdset.duplicates = True chan_cmdset.duplicates = True
for cmd in [cmd for cmd in self.cached_channel_cmds for cmd in [cmd for cmd in self.cached_channel_cmds

2
evennia/objects/objects.py
View file

@ -1684,7 +1684,7 @@ class DefaultExit(DefaultObject):
obj=exidbobj) obj=exidbobj)
# create a cmdset # create a cmdset
exit_cmdset = cmdset.CmdSet(None) exit_cmdset = cmdset.CmdSet(None)
exit_cmdset.key = '_exitset' exit_cmdset.key = 'ExitCmdSet'
exit_cmdset.priority = self.priority exit_cmdset.priority = self.priority
exit_cmdset.duplicates = True exit_cmdset.duplicates = True
# add command to cmdset # add command to cmdset