module: prevent new decorators to be available in sopel.module

Author: Exirel

sopel/module.py

@@ -8,4 +8,36 @@
 """
 from __future__ import absolute_import, division, print_function, unicode_literals
 
-from sopel.plugin import *  # noqa
+# Import everything from sopel.plugin at the time of replacement.
+# Everything new from this point on must *not* leak here.
+# Therefore, don't add anything to this import list. Ever.
+from sopel.plugin import (  # noqa
+    ADMIN,
+    action_commands,
+    commands,
+    echo,
+    event,
+    example,
+    HALFOP,
+    intent,
+    interval,
+    nickname_commands,
+    NOLIMIT,
+    OP,
+    OPER,
+    output_prefix,
+    OWNER,
+    priority,
+    rate,
+    require_account,
+    require_admin,
+    require_chanmsg,
+    require_owner,
+    require_privilege,
+    require_privmsg,
+    rule,
+    thread,
+    unblockable,
+    url,
+    VOICE,
+)

sopel/modules/reddit.py

@@ -20,7 +20,8 @@
 import requests
 
 from sopel.formatting import bold, color, colors
-from sopel.module import commands, example, find, NOLIMIT, OP, require_chanmsg, url
+from sopel.module import commands, example, NOLIMIT, OP, require_chanmsg, url
+from sopel.plugin import find
 from sopel.tools import time
 from sopel.tools.web import USER_AGENT
 

test/plugins/test_plugins_rules.py

@@ -6,7 +6,7 @@
 
 import pytest
 
-from sopel import bot, loader, module, trigger
+from sopel import bot, loader, module, plugin, trigger
 from sopel.plugins import rules
 from sopel.tests import rawlist
 
@@ -851,7 +851,7 @@ def handler(wrapped, trigger):
 def test_kwargs_from_callable_label(mockbot):
     # prepare callable
     @module.rule(r'hello', r'hi', r'hey', r'hello|hi')
-    @module.label('hello_rule')
+    @plugin.label('hello_rule')
     def handler(wrapped, trigger):
         wrapped.reply('Hi!')
 
@@ -2182,7 +2182,7 @@ def test_find_rule_parse_pattern():
 
 def test_find_rule_from_callable(mockbot):
     # prepare callable
-    @module.find(r'hello', r'hi', r'hey', r'hello|hi')
+    @plugin.find(r'hello', r'hi', r'hey', r'hello|hi')
     def handler(wrapped, trigger):
         wrapped.reply('Hi!')
 
@@ -2269,7 +2269,7 @@ def test_search_rule_parse_pattern():
 
 def test_search_rule_from_callable(mockbot):
     # prepare callable
-    @module.search(r'hello', r'hi', r'hey', r'hello|hi')
+    @plugin.search(r'hello', r'hi', r'hey', r'hello|hi')
     def handler(wrapped, trigger):
         wrapped.reply('Hi!')
 

test/test_bot.py

@@ -6,7 +6,7 @@
 
 import pytest
 
-from sopel import bot, loader, module, plugins, trigger
+from sopel import bot, loader, module, plugin, plugins, trigger
 from sopel.plugins import rules
 from sopel.tests import rawlist
 from sopel.tools import Identifier, SopelMemory
@@ -293,41 +293,41 @@ def test_register_unregister_plugin(tmpconfig, mockplugin):
 def test_remove_plugin_unknown_plugin(tmpconfig):
     sopel = bot.Sopel(tmpconfig, daemon=False)
 
-    plugin = plugins.handlers.PyModulePlugin('admin', 'sopel.modules')
+    handler = plugins.handlers.PyModulePlugin('admin', 'sopel.modules')
     with pytest.raises(plugins.exceptions.PluginNotRegistered):
-        sopel.remove_plugin(plugin, [], [], [], [])
+        sopel.remove_plugin(handler, [], [], [], [])
 
 
 def test_remove_plugin_unregistered_plugin(tmpconfig):
     sopel = bot.Sopel(tmpconfig, daemon=False)
 
     # register the plugin
-    plugin = plugins.handlers.PyModulePlugin('coretasks', 'sopel')
-    plugin.load()
-    plugin.register(sopel)
+    handler = plugins.handlers.PyModulePlugin('coretasks', 'sopel')
+    handler.load()
+    handler.register(sopel)
 
     # Unregister the plugin
-    plugin.unregister(sopel)
+    handler.unregister(sopel)
 
     # And now it must raise an exception
     with pytest.raises(plugins.exceptions.PluginNotRegistered):
-        sopel.remove_plugin(plugin, [], [], [], [])
+        sopel.remove_plugin(handler, [], [], [], [])
 
 
 def test_reload_plugin_unregistered_plugin(tmpconfig):
     sopel = bot.Sopel(tmpconfig, daemon=False)
 
     # register the plugin
-    plugin = plugins.handlers.PyModulePlugin('coretasks', 'sopel')
-    plugin.load()
-    plugin.register(sopel)
+    handler = plugins.handlers.PyModulePlugin('coretasks', 'sopel')
+    handler.load()
+    handler.register(sopel)
 
     # Unregister the plugin
-    plugin.unregister(sopel)
+    handler.unregister(sopel)
 
     # And now it must raise an exception
     with pytest.raises(plugins.exceptions.PluginNotRegistered):
-        sopel.reload_plugin(plugin.name)
+        sopel.reload_plugin(handler.name)
 
 
 # -----------------------------------------------------------------------------
@@ -340,11 +340,11 @@ def test_register_callables(tmpconfig):
     def rule_hello(bot, trigger):
         pass
 
-    @module.find(r'(hi|hello|hey|sup)')
+    @plugin.find(r'(hi|hello|hey|sup)')
     def rule_find_hello(bot, trigger):
         pass
 
-    @module.search(r'(hi|hello|hey|sup)')
+    @plugin.search(r'(hi|hello|hey|sup)')
     def rule_search_hello(bot, trigger):
         pass
 
@@ -382,7 +382,7 @@ def mixed_rule_command(bot, trigger):
         pass
 
     @module.event('JOIN')
-    @module.label('handle_join_event')
+    @plugin.label('handle_join_event')
     def on_join(bot, trigger):
         pass
 

test/test_module.py

@@ -1,5 +1,12 @@
 # coding=utf-8
-"""Tests for message formatting"""
+"""Tests for sopel.module decorators
+
+.. important::
+
+    These tests are kept here as a proof that ``sopel.module`` is backward
+    compatible up to Sopel 9, when it will be removed.
+
+"""
 from __future__ import absolute_import, division, print_function, unicode_literals
 
 import pytest
@@ -123,52 +130,6 @@ def mock(bot, trigger, match):
     assert mock.rule == [r'\w+', '.*', r'\d+']
 
 
-def test_find():
-    @module.find('.*')
-    def mock(bot, trigger, match):
-        return True
-    assert mock.find_rules == ['.*']
-
-
-def test_find_args():
-    @module.find('.*', r'\d+')
-    def mock(bot, trigger, match):
-        return True
-    assert mock.find_rules == ['.*', r'\d+']
-
-
-def test_find_multiple():
-    @module.find('.*', r'\d+')
-    @module.find('.*')
-    @module.find(r'\w+')
-    def mock(bot, trigger, match):
-        return True
-    assert mock.find_rules == [r'\w+', '.*', r'\d+']
-
-
-def test_search():
-    @module.search('.*')
-    def mock(bot, trigger, match):
-        return True
-    assert mock.search_rules == ['.*']
-
-
-def test_search_args():
-    @module.search('.*', r'\d+')
-    def mock(bot, trigger, match):
-        return True
-    assert mock.search_rules == ['.*', r'\d+']
-
-
-def test_search_multiple():
-    @module.search('.*', r'\d+')
-    @module.search('.*')
-    @module.search(r'\w+')
-    def mock(bot, trigger, match):
-        return True
-    assert mock.search_rules == [r'\w+', '.*', r'\d+']
-
-
 def test_thread():
     @module.thread(True)
     def mock(bot, trigger, match):
@@ -326,13 +287,6 @@ def mock(bot, trigger, match):
     assert not hasattr(mock, 'rule')
 
 
-def test_label():
-    @module.label('hello')
-    def mock(bot, trigger):
-        return True
-    assert mock.rule_label == 'hello'
-
-
 def test_priority():
     @module.priority('high')
     def mock(bot, trigger, match):

test/test_plugin.py

@@ -0,0 +1,58 @@
+# coding=utf-8
+"""Tests for sopel.plugin decorators"""
+from __future__ import absolute_import, division, print_function, unicode_literals
+
+from sopel import plugin
+
+
+def test_find():
+    @plugin.find('.*')
+    def mock(bot, trigger, match):
+        return True
+    assert mock.find_rules == ['.*']
+
+
+def test_find_args():
+    @plugin.find('.*', r'\d+')
+    def mock(bot, trigger, match):
+        return True
+    assert mock.find_rules == ['.*', r'\d+']
+
+
+def test_find_multiple():
+    @plugin.find('.*', r'\d+')
+    @plugin.find('.*')
+    @plugin.find(r'\w+')
+    def mock(bot, trigger, match):
+        return True
+    assert mock.find_rules == [r'\w+', '.*', r'\d+']
+
+
+def test_label():
+    @plugin.label('hello')
+    def mock(bot, trigger):
+        return True
+    assert mock.rule_label == 'hello'
+
+
+def test_search():
+    @plugin.search('.*')
+    def mock(bot, trigger, match):
+        return True
+    assert mock.search_rules == ['.*']
+
+
+def test_search_args():
+    @plugin.search('.*', r'\d+')
+    def mock(bot, trigger, match):
+        return True
+    assert mock.search_rules == ['.*', r'\d+']
+
+
+def test_search_multiple():
+    @plugin.search('.*', r'\d+')
+    @plugin.search('.*')
+    @plugin.search(r'\w+')
+    def mock(bot, trigger, match):
+        return True
+    assert mock.search_rules == [r'\w+', '.*', r'\d+']

test/tools/test_tools_jobs.py

@@ -6,7 +6,7 @@
 
 import pytest
 
-from sopel import loader, module
+from sopel import loader, module, plugin
 from sopel.tools import jobs
 
 
@@ -201,7 +201,7 @@ def test_job_next_many():
 
 def test_job_from_callable(mockconfig):
     @module.interval(5)
-    @module.label('testjob')
+    @plugin.label('testjob')
     def handler(manager):
         """The job's docstring."""
         return 'tested'