Move registry to submodule (#30)

Author: ovv

docs/references.rst

@@ -17,7 +17,13 @@ SirBot
 Registry
 --------
 
-.. autoclass:: sirbot.core.RegistrySingleton
+.. autoclass:: sirbot.registry.RegistrySingleton
+   :members:
+
+.. autoexception:: sirbot.registry.RegistryError
+   :members:
+
+.. autoexception:: sirbot.registry.FrozenRegistryError
    :members:
 
 .. _references_plugin:
@@ -48,8 +54,3 @@ Exceptions
 .. autoexception:: sirbot.core.errors.SirBotError
    :members:
 
-.. autoexception:: sirbot.core.errors.RegistryError
-   :members:
-
-.. autoexception:: sirbot.core.errors.FrozenRegistryError
-   :members:

setup.cfg

@@ -7,6 +7,7 @@ addopts = --verbose --cov=sirbot/ tests/ --cov-report term-missing
 [build_sphinx]
 source-dir = docs/
 build-dir = docs/_build
+warning-is-error = 1
 
 [aliases]
 test=pytest

setup.py

@@ -65,12 +65,14 @@ def parse_readme():
         'sirbot.core',
         'sirbot.utils',
         'sirbot.cli',
+        'sirbot.registry'
     ],
     package_dir={
         'sirbot': 'sirbot',
         'sirbot.core': 'sirbot/core',
         'sirbot.utils': 'sirbot/utils',
         'sirbot.cli': 'sirbot/cli',
+        'sirbot.registry': 'sirbot/registry'
     },
     package_data={
         'sirbot.core': ['config.yml'],

sirbot/core/__init__.py

@@ -1,4 +1,5 @@
-from .core import SirBot, registry  # noQa
+from .core import SirBot  # noQa
 from .__meta__ import DATA as METADATA  # noQa
 from .hookimpl import hookimpl  # noQa
 from .plugin import Plugin  # noQa
+from ..registry import registry  # noQa

sirbot/core/core.py

@@ -14,16 +14,15 @@
 import pluggy
 import yaml
 
-from collections import defaultdict, MutableMapping
+from collections import defaultdict
 from aiohttp import web
 
 from sirbot.utils import merge_dict
+from sirbot.registry import registry
 
 from . import hookspecs
-from .errors import FrozenRegistryError
 
 logger = logging.getLogger(__name__)
-registry = None
 
 if sys.version_info[:2] == (3, 5):
     ModuleNotFoundError = ImportError
@@ -39,8 +38,6 @@ class SirBot:
         loop (asyncio.AbstractEventLoop): Event loop
     """
     def __init__(self, config=None, *, loop=None):
-        global registry
-        registry = RegistrySingleton()
         self.config = config or {}
         self._configure()
         logger.info('Initializing Sir Bot-a-lot')
@@ -259,51 +256,3 @@ def run(self, host: str = '0.0.0.0', port: int = 8080):
         """
         self._loop.run_until_complete(self._configure_plugins())
         web.run_app(self._app, host=host, port=port)  # pragma: no cover
-
-
-class RegistrySingleton(MutableMapping):
-    """
-    Class regrouping all available plugin factory.
-
-    The plugin factory is called each time the registry is queried.
-    It is good practice to keep interacting on the same factory result without
-    querying the registry each time.
-
-    Similar behaviour as a dictionary
-    """
-    def __init__(self):
-        super().__init__()
-        self._frozen = False
-        self._plugins = dict()
-
-    @property
-    def frozen(self):
-        return self._frozen
-
-    @frozen.setter
-    def frozen(self, _):
-        raise ValueError('Read only property')
-
-    def freeze(self):
-        self._frozen = True
-
-    def __getitem__(self, item):
-        return self._plugins[item]()
-
-    def __setitem__(self, key, value):
-        if not self._frozen:
-            self._plugins[key] = value
-        else:
-            raise FrozenRegistryError()
-
-    def __delitem__(self, key):
-        raise FrozenRegistryError()
-
-    def __iter__(self):
-        return iter(self._plugins)
-
-    def __len__(self):
-        return len(self._plugins)
-
-    def __contains__(self, item):
-        return item in self._plugins

sirbot/core/errors.py

@@ -2,15 +2,3 @@ class SirBotError(Exception):
     """
     Top level sirbot error
     """
-
-
-class RegistryError(SirBotError):
-    """
-    Class to compose all registry related errors
-    """
-
-
-class FrozenRegistryError(RegistryError):
-    """
-    Registry if frozen
-    """

sirbot/core/registry.py

@@ -0,0 +1,65 @@
+from collections import MutableMapping
+from sirbot.core.errors import SirBotError
+
+
+class RegistryError(SirBotError):
+    """
+    Class to compose all registry related errors
+    """
+
+
+class FrozenRegistryError(RegistryError):
+    """
+    Registry if frozen
+    """
+
+
+class RegistrySingleton(MutableMapping):
+    """
+    Class regrouping all available plugin factory.
+
+    The plugin factory is called each time the registry is queried.
+    It is good practice to keep interacting on the same factory result without
+    querying the registry each time.
+
+    Similar behaviour as a dictionary
+    """
+    def __init__(self):
+        super().__init__()
+        self._frozen = False
+        self._plugins = dict()
+
+    @property
+    def frozen(self):
+        return self._frozen
+
+    @frozen.setter
+    def frozen(self, _):
+        raise ValueError('Read only property')
+
+    def freeze(self):
+        self._frozen = True
+
+    def __getitem__(self, item):
+        return self._plugins[item]()
+
+    def __setitem__(self, key, value):
+        if not self._frozen:
+            self._plugins[key] = value
+        else:
+            raise FrozenRegistryError()
+
+    def __delitem__(self, key):
+        raise FrozenRegistryError()
+
+    def __iter__(self):
+        return iter(self._plugins)
+
+    def __len__(self):
+        return len(self._plugins)
+
+    def __contains__(self, item):
+        return item in self._plugins
+
+
+registry = RegistrySingleton()

sirbot/registry/__init__.py

@@ -23,6 +23,13 @@
 }
 
 
+@pytest.fixture
+def registry(monkeypatch):
+    new_registry = sirbot.registry.RegistrySingleton()
+    monkeypatch.setattr('sirbot.core.core.registry', new_registry)
+    monkeypatch.setattr('sirbot.registry.registry', new_registry)
+
+
 def test_bot_is_starting(loop, test_server):
     bot = sirbot.SirBot(loop=loop)
     loop.run_until_complete(test_server(bot._app))
@@ -39,7 +46,7 @@ def test_load_config(loop):
     assert bot.config == config
 
 
-def test_logging_config(loop):
+def test_logging_config(loop, registry):
     config = {
         'logging': {
             'version': 1,
@@ -61,7 +68,7 @@ def test_logging_config(loop):
     assert logging.getLogger('sirbot').level == 40
 
 
-def test_plugin_import(loop, test_server):
+def test_plugin_import(loop, test_server, registry):
     bot = sirbot.SirBot(loop=loop, config=CONFIG)
     loop.run_until_complete(test_server(bot._app))
     assert bot._pm.has_plugin('tests.core.test_plugin.sirbot')
@@ -76,33 +83,33 @@ def test_plugin_import_error(loop):
         bot._import_plugins()
 
 
-def test_initialize_plugins(loop):
+def test_initialize_plugins(loop, registry):
     bot = sirbot.SirBot(loop=loop, config=CONFIG)
     assert isinstance(bot._plugins['test']['plugin'], PluginTest)
 
 
-def test_plugin_configure(loop, test_server):
+def test_plugin_configure(loop, test_server, registry):
     bot = sirbot.SirBot(loop=loop, config=CONFIG)
     loop.run_until_complete(bot._configure_plugins())
 
     assert bot._plugins['test']['plugin'].config == CONFIG['test']
 
 
-def test_start_plugins(loop, test_server):
+def test_start_plugins(loop, test_server, registry):
     bot = sirbot.SirBot(loop=loop, config=CONFIG)
     loop.run_until_complete(test_server(bot._app))
     assert 'test' in bot._tasks
 
 
-def test_plugin_task_error(loop, test_server, capsys):
+def test_plugin_task_error(loop, test_server, registry):
     config = deepcopy(CONFIG)
     config['sirbot']['plugins'] = ['tests.core.test_plugin.sirbot_start_error']
     bot = sirbot.SirBot(loop=loop, config=config)
     with pytest.raises(ValueError):
         loop.run_until_complete(test_server(bot._app))
 
 
-def test_plugin_priority(loop, test_server):
+def test_plugin_priority(loop, registry):
     config = deepcopy(CONFIG)
     config['test']['priority'] = 80
     config['test-error'] = {'priority': 70}