Plugin Internal Machinery

Important

This section contains modules and classes used by Sopel internally. They are subject to rapid changes between versions, without advance warning. This section exists primarily for the aid of Sopel’s core development.

• Plugin Loader
  • clean_callable()
  • clean_module()
  • is_limitable()
  • is_triggerable()
  • is_url_callback()
• sopel.plugins
  • enumerate_plugins()
  • find_directory_plugins()
  • find_entry_point_plugins()
  • find_internal_plugins()
  • find_sopel_modules_plugins()
  • get_usable_plugins()
• sopel.plugins.capabilities
  • Manager
    • Manager.acknowledge()
    • Manager.acknowledged
    • Manager.denied
    • Manager.deny()
    • Manager.get()
    • Manager.is_acknowledged()
    • Manager.is_complete
    • Manager.is_denied()
    • Manager.is_registered()
    • Manager.is_requested()
    • Manager.register()
    • Manager.registered
    • Manager.request_available()
    • Manager.requested
    • Manager.resume()
• sopel.plugins.exceptions
  • PluginError
  • PluginNotRegistered
  • PluginSettingsError
• sopel.plugins.handlers
  • AbstractPluginHandler
    • AbstractPluginHandler.configure()
    • AbstractPluginHandler.get_capability_requests()
    • AbstractPluginHandler.get_label()
    • AbstractPluginHandler.get_meta_description()
    • AbstractPluginHandler.get_version()
    • AbstractPluginHandler.has_configure()
    • AbstractPluginHandler.has_setup()
    • AbstractPluginHandler.has_shutdown()
    • AbstractPluginHandler.is_loaded()
    • AbstractPluginHandler.load()
    • AbstractPluginHandler.register()
    • AbstractPluginHandler.reload()
    • AbstractPluginHandler.setup()
    • AbstractPluginHandler.shutdown()
    • AbstractPluginHandler.unregister()
  • EntryPointPlugin
    • EntryPointPlugin.PLUGIN_TYPE
    • EntryPointPlugin.get_meta_description()
    • EntryPointPlugin.get_version()
    • EntryPointPlugin.load()
  • PluginMetaDescription
  • PyFilePlugin
    • PyFilePlugin.PLUGIN_TYPE
    • PyFilePlugin.get_meta_description()
    • PyFilePlugin.load()
    • PyFilePlugin.reload()
  • PyModulePlugin
    • PyModulePlugin.PLUGIN_TYPE
    • PyModulePlugin.configure()
    • PyModulePlugin.get_capability_requests()
    • PyModulePlugin.get_label()
    • PyModulePlugin.get_meta_description()
    • PyModulePlugin.get_version()
    • PyModulePlugin.has_configure()
    • PyModulePlugin.has_setup()
    • PyModulePlugin.has_shutdown()
    • PyModulePlugin.is_loaded()
    • PyModulePlugin.load()
    • PyModulePlugin.register()
    • PyModulePlugin.reload()
    • PyModulePlugin.setup()
    • PyModulePlugin.shutdown()
    • PyModulePlugin.unregister()
• sopel.plugins.jobs
  • Scheduler
    • Scheduler.clear_jobs()
    • Scheduler.register()
    • Scheduler.remove_callable_job()
    • Scheduler.unregister_plugin()
• sopel.plugins.rules
  • AbstractRule
    • AbstractRule.allow_bots()
    • AbstractRule.allow_echo()
    • AbstractRule.channel_rate_limit
    • AbstractRule.channel_rate_template
    • AbstractRule.execute()
    • AbstractRule.from_callable()
    • AbstractRule.get_channel_metrics()
    • AbstractRule.get_doc()
    • AbstractRule.get_global_metrics()
    • AbstractRule.get_output_prefix()
    • AbstractRule.get_plugin_name()
    • AbstractRule.get_priority()
    • AbstractRule.get_rule_label()
    • AbstractRule.get_test_parameters()
    • AbstractRule.get_usages()
    • AbstractRule.get_user_metrics()
    • AbstractRule.global_rate_limit
    • AbstractRule.global_rate_template
    • AbstractRule.is_channel_rate_limited()
    • AbstractRule.is_global_rate_limited()
    • AbstractRule.is_threaded()
    • AbstractRule.is_unblockable()
    • AbstractRule.is_user_rate_limited()
    • AbstractRule.match()
    • AbstractRule.match_ctcp()
    • AbstractRule.match_event()
    • AbstractRule.parse()
    • AbstractRule.priority_scale
    • AbstractRule.user_rate_limit
    • AbstractRule.user_rate_template
  • AbstractNamedRule
    • AbstractNamedRule.aliases
    • AbstractNamedRule.get_rule_label()
    • AbstractNamedRule.get_rule_regex()
    • AbstractNamedRule.has_alias()
    • AbstractNamedRule.name
  • TypedRule
  • RuleMetrics
    • RuleMetrics.end()
    • RuleMetrics.is_limited()
    • RuleMetrics.last_time
    • RuleMetrics.set_return_value()
    • RuleMetrics.start()
  • ActionCommand
    • ActionCommand.from_callable()
    • ActionCommand.get_rule_regex()
    • ActionCommand.match_ctcp()
  • Command
    • Command.from_callable()
    • Command.get_rule_regex()
    • Command.get_usages()
  • FindRule
    • FindRule.parse()
  • Manager
    • Manager.check_url_callback()
    • Manager.get_all_action_commands()
    • Manager.get_all_commands()
    • Manager.get_all_generic_rules()
    • Manager.get_all_nick_commands()
    • Manager.get_all_url_callbacks()
    • Manager.get_triggered_rules()
    • Manager.has_action_command()
    • Manager.has_command()
    • Manager.has_nick_command()
    • Manager.has_rule()
    • Manager.has_url_callback()
    • Manager.register()
    • Manager.register_action_command()
    • Manager.register_command()
    • Manager.register_nick_command()
    • Manager.register_url_callback()
    • Manager.unregister_plugin()
  • NickCommand
    • NickCommand.from_callable()
    • NickCommand.get_rule_regex()
    • NickCommand.get_usages()
  • Rule
    • Rule.allow_bots()
    • Rule.allow_echo()
    • Rule.channel_rate_limit
    • Rule.channel_rate_template
    • Rule.execute()
    • Rule.from_callable()
    • Rule.from_callable_lazy()
    • Rule.get_channel_metrics()
    • Rule.get_doc()
    • Rule.get_global_metrics()
    • Rule.get_output_prefix()
    • Rule.get_plugin_name()
    • Rule.get_priority()
    • Rule.get_rule_label()
    • Rule.get_test_parameters()
    • Rule.get_usages()
    • Rule.get_user_metrics()
    • Rule.global_rate_limit
    • Rule.global_rate_template
    • Rule.is_channel_rate_limited()
    • Rule.is_global_rate_limited()
    • Rule.is_threaded()
    • Rule.is_unblockable()
    • Rule.is_user_rate_limited()
    • Rule.kwargs_from_callable()
    • Rule.match()
    • Rule.match_ctcp()
    • Rule.match_event()
    • Rule.parse()
    • Rule.user_rate_limit
    • Rule.user_rate_template
  • SearchRule
    • SearchRule.parse()
  • URLCallback
    • URLCallback.from_callable()
    • URLCallback.from_callable_lazy()
    • URLCallback.match()
    • URLCallback.parse()