Deprecate using supybot.dynamicScope without an import (#1535)

Author: jlu5

plugins/Aka/plugin.py

@@ -42,6 +42,7 @@
 import supybot.ircutils as ircutils
 import supybot.callbacks as callbacks
 import supybot.httpserver as httpserver
+from supybot.dynamicScope import dynamic
 from supybot.i18n import PluginInternationalization
 _ = PluginInternationalization('Aka')
 

plugins/Factoids/plugin.py

@@ -43,6 +43,7 @@
 import supybot.ircutils as ircutils
 import supybot.callbacks as callbacks
 import supybot.httpserver as httpserver
+from supybot.dynamicScope import dynamic
 from supybot.i18n import PluginInternationalization, internationalizeDocstring
 _ = PluginInternationalization('Factoids')
 

plugins/Google/plugin.py

@@ -41,6 +41,7 @@
 import supybot.ircmsgs as ircmsgs
 import supybot.ircutils as ircutils
 import supybot.callbacks as callbacks
+from supybot.dynamicScope import dynamic
 from supybot.i18n import PluginInternationalization, internationalizeDocstring
 _ = PluginInternationalization('Google')
 

plugins/Relay/plugin.py

@@ -41,6 +41,7 @@
 import supybot.ircutils as ircutils
 import supybot.callbacks as callbacks
 from supybot.utils.structures import MultiSet, TimeoutQueue
+from supybot.dynamicScope import dynamic
 from supybot.i18n import PluginInternationalization, internationalizeDocstring
 _ = PluginInternationalization('Relay')
 

plugins/Success/plugin.py

@@ -32,6 +32,7 @@
 from supybot.commands import *
 import supybot.plugins as plugins
 import supybot.ircutils as ircutils
+from supybot.dynamicScope import dynamic
 from supybot.i18n import PluginInternationalization, internationalizeDocstring
 _ = PluginInternationalization('Success')
 

src/callbacks.py

@@ -43,6 +43,7 @@
 import inspect
 import warnings
 
+from .dynamicScope import dynamic
 from . import (conf, ircdb, irclib, ircmsgs, ircutils, log, registry,
         utils, world)
 from .utils import minisix

src/commands.py

@@ -46,6 +46,7 @@
 
 from . import callbacks, conf, ircdb, ircmsgs, ircutils, log, \
         utils, world
+from .dynamicScope import dynamic
 from .utils import minisix
 from .i18n import PluginInternationalization, internationalizeDocstring
 _ = PluginInternationalization()

src/conf.py

@@ -39,6 +39,7 @@
 from .utils import minisix
 from .utils.net import isSocketAddress
 from .version import version
+from .dynamicScope import dynamic
 from .i18n import PluginInternationalization
 _ = PluginInternationalization()
 if minisix.PY2:

src/dynamicScope.py

@@ -29,6 +29,7 @@
 ###
 
 import sys
+import warnings
 
 class DynamicScope(object):
     def _getLocals(self, name):
@@ -48,6 +49,17 @@ def __getattr__(self, name):
     def __setattr__(self, name, value):
         self._getLocals(name)[name] = value
 
-(__builtins__ if isinstance(__builtins__, dict) else __builtins__.__dict__)['dynamic'] = DynamicScope()
+class _DynamicScopeBuiltinsWrapper(DynamicScope):
+    def __getattr__(self, name):
+        warnings.warn('Using DynamicScope without an explicit import is '
+                      'deprecated and will be removed in a future Limnoria '
+                      'version. Use instead: '
+                      'from supybot.dynamicScope import dynamic',
+                      stacklevel=2)
+        return super().__getattr__(name)
+
+dynamic = DynamicScope()
+(__builtins__ if isinstance(__builtins__, dict) else __builtins__.__dict__)['dynamic'] = \
+    _DynamicScopeBuiltinsWrapper()
 
 # vim:set shiftwidth=4 softtabstop=4 expandtab textwidth=79:

test/test_dynamicScope.py

@@ -29,6 +29,7 @@
 ###
 
 from supybot.test import *
+from supybot.dynamicScope import dynamic
 
 class TestDynamic(SupyTestCase):
     def test(self):