def clean_callable(func, config):
"""Compiles the regexes, moves commands into func.rule, fixes up docs and
puts them in func._docs, and sets defaults"""
nick = config.core.nick
alias_nicks = config.core.alias_nicks
prefix = config.core.prefix
help_prefix = config.core.help_prefix
func._docs = {}
doc = trim_docstring(func.__doc__)
example = None
func.unblockable = getattr(func, 'unblockable', False)
func.priority = getattr(func, 'priority', 'medium')
func.thread = getattr(func, 'thread', True)
func.rate = getattr(func, 'rate', 0)
func.channel_rate = getattr(func, 'channel_rate', 0)
func.global_rate = getattr(func, 'global_rate', 0)
if not hasattr(func, 'event'):
func.event = ['PRIVMSG']
else:
if isinstance(func.event, basestring):
func.event = [func.event.upper()]
else:
func.event = [event.upper() for event in func.event]
if hasattr(func, 'rule'):
if isinstance(func.rule, basestring):
func.rule = [func.rule]
func.rule = [
compile_rule(nick, rule, alias_nicks) for rule in func.rule
]
if hasattr(func, 'commands') or hasattr(func, 'nickname_commands'):
func.rule = getattr(func, 'rule', [])
for command in getattr(func, 'commands', []):
regexp = get_command_regexp(prefix, command)
func.rule.append(regexp)
for command in getattr(func, 'nickname_commands', []):
regexp = get_nickname_command_regexp(nick, command, alias_nicks)
func.rule.append(regexp)
if hasattr(func, 'example'):
example = func.example[0]["example"]
example = example.replace('$nickname', nick)
if example[0] != help_prefix and not example.startswith(nick):
example = help_prefix + example[len(help_prefix):]
if doc or example:
cmds = []
cmds.extend(getattr(func, 'commands', []))
cmds.extend(getattr(func, 'nickname_commands', []))
for command in cmds:
func._docs[command] = (doc, example)
if hasattr(func, 'intents'):
func.intents = [
re.compile(intent, re.IGNORECASE) for intent in func.intents
]
def clean_callable(func, config):
"""Compiles the regexes, moves commands into func.rule, fixes up docs and
puts them in func._docs, and sets defaults"""
nick = config.core.nick
alias_nicks = config.core.alias_nicks
prefix = config.core.prefix
help_prefix = config.core.help_prefix
func._docs = {}
doc = trim_docstring(func.__doc__)
example = None
func.unblockable = getattr(func, 'unblockable', False)
func.priority = getattr(func, 'priority', 'medium')
func.thread = getattr(func, 'thread', True)
func.rate = getattr(func, 'rate', 0)
func.channel_rate = getattr(func, 'channel_rate', 0)
func.global_rate = getattr(func, 'global_rate', 0)
if not hasattr(func, 'event'):
func.event = ['PRIVMSG']
else:
if isinstance(func.event, basestring):
func.event = [func.event.upper()]
else:
func.event = [event.upper() for event in func.event]
if hasattr(func, 'rule'):
if isinstance(func.rule, basestring):
func.rule = [func.rule]
func.rule = [compile_rule(nick, rule, alias_nicks) for rule in func.rule]
if hasattr(func, 'commands') or hasattr(func, 'nickname_commands'):
func.rule = getattr(func, 'rule', [])
for command in getattr(func, 'commands', []):
regexp = get_command_regexp(prefix, command)
func.rule.append(regexp)
for command in getattr(func, 'nickname_commands', []):
regexp = get_nickname_command_regexp(nick, command, alias_nicks)
func.rule.append(regexp)
if hasattr(func, 'example'):
example = func.example[0]["example"]
example = example.replace('$nickname', nick)
if example[0] != help_prefix and not example.startswith(nick):
example = example.replace(default_prefix, help_prefix, 1)
if doc or example:
cmds = []
cmds.extend(getattr(func, 'commands', []))
cmds.extend(getattr(func, 'nickname_commands', []))
for command in cmds:
func._docs[command] = (doc, example)
if hasattr(func, 'intents'):
func.intents = [re.compile(intent, re.IGNORECASE) for intent in func.intents]
def clean_callable(func, config):
"""Compiles the regexes, moves commands into func.rule, fixes up docs and
puts them in func._docs, and sets defaults"""
nick = config.core.nick
alias_nicks = config.core.alias_nicks
prefix = config.core.prefix
help_prefix = config.core.help_prefix
func._docs = {}
doc = trim_docstring(func.__doc__)
examples = []
func.unblockable = getattr(func, 'unblockable', False)
func.echo = getattr(func, 'echo', False)
func.priority = getattr(func, 'priority', 'medium')
func.thread = getattr(func, 'thread', True)
func.rate = getattr(func, 'rate', 0)
func.channel_rate = getattr(func, 'channel_rate', 0)
func.global_rate = getattr(func, 'global_rate', 0)
if not hasattr(func, 'event'):
func.event = ['PRIVMSG']
else:
if isinstance(func.event, basestring):
func.event = [func.event.upper()]
else:
func.event = [event.upper() for event in func.event]
if hasattr(func, 'rule'):
if isinstance(func.rule, basestring):
func.rule = [func.rule]
func.rule = [
compile_rule(nick, rule, alias_nicks) for rule in func.rule
]
if hasattr(func, 'commands') or hasattr(func, 'nickname_commands'):
func.rule = getattr(func, 'rule', [])
for command in getattr(func, 'commands', []):
regexp = get_command_regexp(prefix, command)
func.rule.append(regexp)
for command in getattr(func, 'nickname_commands', []):
regexp = get_nickname_command_regexp(nick, command, alias_nicks)
func.rule.append(regexp)
if hasattr(func, 'example'):
# If no examples are flagged as user-facing, just show the first one like Sopel<7 did
examples = [rec["example"] for rec in func.example if rec["help"]
] or [func.example[0]["example"]]
for i, example in enumerate(examples):
example = example.replace('$nickname', nick)
if example[0] != help_prefix and not example.startswith(nick):
example = example.replace(default_prefix, help_prefix, 1)
examples[i] = example
if doc or examples:
cmds = []
cmds.extend(getattr(func, 'commands', []))
cmds.extend(getattr(func, 'nickname_commands', []))
for command in cmds:
func._docs[command] = (doc, examples)
if hasattr(func, 'intents'):
func.intents = [
re.compile(intent, re.IGNORECASE) for intent in func.intents
]
def clean_callable(func, config):
"""Clean the callable. (compile regexes, fix docs, set defaults)
:param func: the callable to clean
:type func: callable
:param config: Sopel's settings
:type config: :class:`sopel.config.Config`
This function will set all the default attributes expected for a Sopel
callable, i.e. properties related to threading, docs, examples, rate
limiting, commands, rules, and other features.
"""
nick = config.core.nick
alias_nicks = config.core.alias_nicks
help_prefix = config.core.help_prefix
func._docs = {}
doc = trim_docstring(func.__doc__)
examples = []
func.thread = getattr(func, 'thread', True)
if is_limitable(func):
# These attributes are a waste of memory on callables that don't pass
# through Sopel's rate-limiting machinery
func.rate = getattr(func, 'rate', 0)
func.channel_rate = getattr(func, 'channel_rate', 0)
func.global_rate = getattr(func, 'global_rate', 0)
func.unblockable = getattr(func, 'unblockable', False)
if not is_triggerable(func) and not is_url_callback(func):
# Adding the remaining default attributes below is potentially
# confusing to other code (and a waste of memory) for jobs.
return
func.echo = getattr(func, 'echo', False)
func.priority = getattr(func, 'priority', 'medium')
func.output_prefix = getattr(func, 'output_prefix', '')
if not hasattr(func, 'event'):
func.event = ['PRIVMSG']
else:
if isinstance(func.event, basestring):
func.event = [func.event.upper()]
else:
func.event = [event.upper() for event in func.event]
if hasattr(func, 'rule'):
if isinstance(func.rule, basestring):
func.rule = [func.rule]
func.rule = [
compile_rule(nick, rule, alias_nicks) for rule in func.rule
]
if hasattr(func, 'find_rules'):
func.find_rules = [
compile_rule(nick, rule, alias_nicks) for rule in func.find_rules
]
if hasattr(func, 'search_rules'):
func.search_rules = [
compile_rule(nick, rule, alias_nicks) for rule in func.search_rules
]
if any(
hasattr(func, attr)
for attr in ['commands', 'nickname_commands', 'action_commands']):
if hasattr(func, 'example'):
# If no examples are flagged as user-facing, just show the first one like Sopel<7.0 did
examples = [rec["example"] for rec in func.example if rec["help"]
] or [func.example[0]["example"]]
for i, example in enumerate(examples):
example = example.replace('$nickname', nick)
if example[0] != help_prefix and not example.startswith(nick):
example = example.replace(COMMAND_DEFAULT_HELP_PREFIX,
help_prefix, 1)
examples[i] = example
if doc or examples:
cmds = []
cmds.extend(getattr(func, 'commands', []))
cmds.extend(getattr(func, 'nickname_commands', []))
for command in cmds:
func._docs[command] = (doc, examples)
if hasattr(func, 'intents'):
# Can be implementation-dependent
_regex_type = type(re.compile(''))
func.intents = [(intent if isinstance(intent, _regex_type) else
re.compile(intent, re.IGNORECASE))
for intent in func.intents]
def clean_callable(func, config):
"""Compiles the regexes, moves commands into func.rule, fixes up docs and
puts them in func._docs, and sets defaults"""
nick = config.core.nick
alias_nicks = config.core.alias_nicks
prefix = config.core.prefix
help_prefix = config.core.help_prefix
func._docs = {}
doc = trim_docstring(func.__doc__)
examples = []
func.unblockable = getattr(func, 'unblockable', False)
func.echo = getattr(func, 'echo', False)
func.priority = getattr(func, 'priority', 'medium')
func.thread = getattr(func, 'thread', True)
func.rate = getattr(func, 'rate', 0)
func.channel_rate = getattr(func, 'channel_rate', 0)
func.global_rate = getattr(func, 'global_rate', 0)
if not hasattr(func, 'event'):
func.event = ['PRIVMSG']
else:
if isinstance(func.event, basestring):
func.event = [func.event.upper()]
else:
func.event = [event.upper() for event in func.event]
if hasattr(func, 'rule'):
if isinstance(func.rule, basestring):
func.rule = [func.rule]
func.rule = [compile_rule(nick, rule, alias_nicks) for rule in func.rule]
if hasattr(func, 'commands') or hasattr(func, 'nickname_commands'):
func.rule = getattr(func, 'rule', [])
for command in getattr(func, 'commands', []):
regexp = get_command_regexp(prefix, command)
if regexp not in func.rule:
func.rule.append(regexp)
for command in getattr(func, 'nickname_commands', []):
regexp = get_nickname_command_regexp(nick, command, alias_nicks)
if regexp not in func.rule:
func.rule.append(regexp)
if hasattr(func, 'example'):
# If no examples are flagged as user-facing, just show the first one like Sopel<7 did
examples = [rec["example"] for rec in func.example if rec["help"]] or [func.example[0]["example"]]
for i, example in enumerate(examples):
example = example.replace('$nickname', nick)
if example[0] != help_prefix and not example.startswith(nick):
example = example.replace(default_prefix, help_prefix, 1)
examples[i] = example
if doc or examples:
cmds = []
cmds.extend(getattr(func, 'commands', []))
cmds.extend(getattr(func, 'nickname_commands', []))
for command in cmds:
func._docs[command] = (doc, examples)
if hasattr(func, 'intents'):
# Can be implementation-dependent
_regex_type = type(re.compile(''))
func.intents = [
(intent
if isinstance(intent, _regex_type)
else re.compile(intent, re.IGNORECASE))
for intent in func.intents
]
def clean_callable(func, config):
"""Compiles the regexes, moves commands into func.rule, fixes up docs and
puts them in func._docs, and sets defaults"""
nick = config.core.nick
alias_nicks = config.core.alias_nicks
prefix = config.core.prefix
help_prefix = config.core.help_prefix
func._docs = {}
doc = trim_docstring(func.__doc__)
examples = []
func.thread = getattr(func, 'thread', True)
if not is_triggerable(func):
# Rate-limiting, priority, etc. doesn't apply to non-triggerable functions.
# Adding the default attributes below is a waste of memory, as well as
# potentially confusing to other code.
return
func.unblockable = getattr(func, 'unblockable', False)
func.echo = getattr(func, 'echo', False)
func.priority = getattr(func, 'priority', 'medium')
func.rate = getattr(func, 'rate', 0)
func.channel_rate = getattr(func, 'channel_rate', 0)
func.global_rate = getattr(func, 'global_rate', 0)
func.output_prefix = getattr(func, 'output_prefix', '')
if not hasattr(func, 'event'):
func.event = ['PRIVMSG']
else:
if isinstance(func.event, basestring):
func.event = [func.event.upper()]
else:
func.event = [event.upper() for event in func.event]
if hasattr(func, 'rule'):
if isinstance(func.rule, basestring):
func.rule = [func.rule]
func.rule = [compile_rule(nick, rule, alias_nicks) for rule in func.rule]
if any(hasattr(func, attr) for attr in ['commands', 'nickname_commands', 'action_commands']):
func.rule = getattr(func, 'rule', [])
for command in getattr(func, 'commands', []):
regexp = get_command_regexp(prefix, command)
if regexp not in func.rule:
func.rule.append(regexp)
for command in getattr(func, 'nickname_commands', []):
regexp = get_nickname_command_regexp(nick, command, alias_nicks)
if regexp not in func.rule:
func.rule.append(regexp)
for command in getattr(func, 'action_commands', []):
regexp = get_action_command_regexp(command)
if regexp not in func.rule:
func.rule.append(regexp)
if hasattr(func, 'example'):
# If no examples are flagged as user-facing, just show the first one like Sopel<7.0 did
examples = [rec["example"] for rec in func.example if rec["help"]] or [func.example[0]["example"]]
for i, example in enumerate(examples):
example = example.replace('$nickname', nick)
if example[0] != help_prefix and not example.startswith(nick):
example = example.replace(default_prefix, help_prefix, 1)
examples[i] = example
if doc or examples:
cmds = []
cmds.extend(getattr(func, 'commands', []))
cmds.extend(getattr(func, 'nickname_commands', []))
for command in cmds:
func._docs[command] = (doc, examples)
if hasattr(func, 'intents'):
# Can be implementation-dependent
_regex_type = type(re.compile(''))
func.intents = [
(intent
if isinstance(intent, _regex_type)
else re.compile(intent, re.IGNORECASE))
for intent in func.intents
]