dece/Edm0nd
1
0
Fork 0
Code Issues 2 Pull requests Releases Activity

plugin: allow excluding some handling conditions

Browse source
This commit is contained in:
dece 2020-11-02 13:23:19 +01:00
parent f055ef76c4
commit 127ad5c895
1 changed files with 23 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
edmond/plugin.py
View file

@ -105,10 +105,27 @@ class Plugin:
return True return True
return False return False
def should_handle_command(self, message, no_content=False): def should_handle_command(
"""Store Command in object and return True if it should handle it.""" self,
message,
no_content=False,
exclude_conditions=None,
):
"""Store Command in object and return True if it should handle it.
If no_content is True, the command does not parse command contents and
put all the command message (without suffix) to the command identifier.
This is useful for commands that have multiple words in their identifier
and do not have any content, or when the content parsing should be done
by the plugin itself.
If exclude_conditions is a collection of plugin namespaces, the
conditions of these plugins are not tested. A basic scenario is the
wakeup command from sleep plugin that requires excluding its own
condition (i.e. do not handle commands when sleeping).
"""
# Are the config conditions to handle a command valid? # Are the config conditions to handle a command valid?
if not self.__respects_handling_conditions(): if not self.__respects_handling_conditions(exclude_conditions):
return False return False
# Is it a valid command? # Is it a valid command?
@ -140,10 +157,12 @@ class Plugin:
content = " ".join(words[2:-1]) content = " ".join(words[2:-1])
return Command(ident, content) return Command(ident, content)
def __respects_handling_conditions(self): def __respects_handling_conditions(self, exclude_conditions=None):
"""Check if question conditions are valid.""" """Check if question conditions are valid."""
conditions = self.config.get("handling_conditions", {}) conditions = self.config.get("handling_conditions", {})
for plugin_ns, plugin_conditions in conditions.items(): for plugin_ns, plugin_conditions in conditions.items():
if exclude_conditions and plugin_ns in exclude_conditions:
continue
for condition_key, condition_value in plugin_conditions.items(): for condition_key, condition_value in plugin_conditions.items():
value = self.get_runtime_value(condition_key, ns=plugin_ns) value = self.get_runtime_value(condition_key, ns=plugin_ns)
if condition_value != value: if condition_value != value: