Make renaming of commands persistant. Closes GH-789.

This commit is contained in:
Valentin Lorentz 2014-07-18 20:43:24 +02:00
parent 3973244d82
commit 39dad55b6f
2 changed files with 31 additions and 30 deletions

View File

@ -66,28 +66,6 @@ def registerDefaultPlugin(command, plugin):
# This must be set, or the quotes won't be removed. # This must be set, or the quotes won't be removed.
conf.supybot.commands.defaultPlugins.get(command).set(plugin) conf.supybot.commands.defaultPlugins.get(command).set(plugin)
def registerRename(plugin, command=None, newName=None):
g = conf.registerGlobalValue(conf.supybot.commands.renames, plugin,
registry.SpaceSeparatedSetOfStrings([], """Determines what commands
in this plugin are to be renamed."""))
if command is not None:
g().add(command)
v = conf.registerGlobalValue(g, command, registry.String('', ''))
if newName is not None:
v.setValue(newName) # In case it was already registered.
return v
else:
return g
def renameCommand(cb, name, newName):
assert not hasattr(cb, newName), 'Cannot rename over existing attributes.'
assert newName == callbacks.canonicalName(newName), \
'newName must already be normalized.'
if name != newName:
method = getattr(cb.__class__, name)
setattr(cb.__class__, newName, method)
delattr(cb.__class__, name)
registerDefaultPlugin('list', 'Misc') registerDefaultPlugin('list', 'Misc')
registerDefaultPlugin('help', 'Misc') registerDefaultPlugin('help', 'Misc')
@ -574,20 +552,20 @@ class Owner(callbacks.Plugin):
irc.error('That command wasn\'t disabled.') irc.error('That command wasn\'t disabled.')
enable = wrap(enable, [optional('plugin'), 'commandName']) enable = wrap(enable, [optional('plugin'), 'commandName'])
def rename(self, irc, msg, args, plugin, command, newName): def rename(self, irc, msg, args, command_plugin, command, newName):
"""<plugin> <command> <new name> """<plugin> <command> <new name>
Renames <command> in <plugin> to the <new name>. Renames <command> in <plugin> to the <new name>.
""" """
if not plugin.isCommand(command): if not command_plugin.isCommand(command):
what = 'command in the %s plugin' % plugin.name() what = 'command in the %s plugin' % command_plugin.name()
irc.errorInvalid(what, command) irc.errorInvalid(what, command)
if hasattr(plugin, newName): if hasattr(command_plugin, newName):
irc.error('The %s plugin already has an attribute named %s.' % irc.error('The %s plugin already has an attribute named %s.' %
(plugin, newName)) (command_plugin, newName))
return return
registerRename(plugin.name(), command, newName) plugin.registerRename(command_plugin.name(), command, newName)
renameCommand(plugin, command, newName) plugin.renameCommand(command_plugin, command, newName)
irc.replySuccess() irc.replySuccess()
rename = wrap(rename, ['plugin', 'commandName', 'commandName']) rename = wrap(rename, ['plugin', 'commandName', 'commandName'])

View File

@ -81,6 +81,28 @@ def loadPluginModule(name, ignoreDeprecation=False):
linecache.checkcache() linecache.checkcache()
return module return module
def renameCommand(cb, name, newName):
assert not hasattr(cb, newName), 'Cannot rename over existing attributes.'
assert newName == callbacks.canonicalName(newName), \
'newName must already be normalized.'
if name != newName:
method = getattr(cb.__class__, name)
setattr(cb.__class__, newName, method)
delattr(cb.__class__, name)
def registerRename(plugin, command=None, newName=None):
g = conf.registerGlobalValue(conf.supybot.commands.renames, plugin,
registry.SpaceSeparatedSetOfStrings([], """Determines what commands
in this plugin are to be renamed."""))
if command is not None:
g().add(command)
v = conf.registerGlobalValue(g, command, registry.String('', ''))
if newName is not None:
v.setValue(newName) # In case it was already registered.
return v
else:
return g
def loadPluginClass(irc, module, register=None): def loadPluginClass(irc, module, register=None):
"""Loads the plugin Class from the given module into the given Irc.""" """Loads the plugin Class from the given module into the given Irc."""
try: try:
@ -118,7 +140,8 @@ def loadPluginClass(irc, module, register=None):
assert not irc.getCallback(plugin), \ assert not irc.getCallback(plugin), \
'There is already a %r plugin registered.' % plugin 'There is already a %r plugin registered.' % plugin
try: try:
renames = []#XXX registerRename(plugin)() v = registerRename(plugin)
renames = conf.supybot.commands.renames.get(plugin)()
if renames: if renames:
for command in renames: for command in renames:
v = registerRename(plugin, command) v = registerRename(plugin, command)