github/pelican
1
0
Fork 1
mirror of https://github.com/getpelican/pelican.git synced 2025-10-15 20:28:56 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

refactor: rework plugin name logic

Browse source
This commit is contained in:
Frederik Ring 2021-01-04 08:34:44 +01:00
commit f6954b35b7
6 changed files with 29 additions and 36 deletions
Download patch file Download diff file Expand all files Collapse all files

13
pelican/plugins/_utils.py
View file

@ -116,15 +116,10 @@ def get_plugin_name(plugin):
module objects cannot be pickled. To work around this, all plugins are
stringified post-initialization.
"""
if isinstance(plugin, str):
return plugin
if inspect.isclass(plugin):
return plugin.__qualname__
if inspect.ismodule(plugin):
return plugin.__name__
try:
return plugin.__class__.__qualname__
except AttributeError:
pass
return str(plugin)
return type(plugin).__qualname__

2
pelican/tests/dummy_plugins/normal_plugin/normal_plugin/__init__.py
View file

@ -1,7 +1,5 @@
from .submodule import noop # noqa: F401
NAME = 'normal plugin'
def register():
pass

3
pelican/tests/dummy_plugins/normal_plugin/normal_submodule_plugin/subpackage/subpackage.py
View file

@ -1,5 +1,2 @@
NAME = 'normal subpackage plugin'
def register():
pass

3
pelican/tests/dummy_plugins/normal_plugin/normal_submodule_plugin/subplugin.py
View file

@ -1,5 +1,2 @@
NAME = 'normal submodule plugin'
def register():
pass

5
pelican/tests/support.py
View file

@ -193,11 +193,6 @@ def get_context(settings=None, **kwargs):
return context
class NoopPlugin:
def register(self):
pass
class LogCountHandler(BufferingHandler):
"""Capturing and counting logged messages."""

39
pelican/tests/test_plugins.py
View file

@ -1,9 +1,10 @@
import os
from contextlib import contextmanager
import pelican.tests.dummy_plugins.normal_plugin.normal_plugin as normal_plugin
from pelican.plugins._utils import (get_namespace_plugins, get_plugin_name,
load_plugins)
from pelican.tests.support import NoopPlugin, unittest
from pelican.tests.support import unittest
@contextmanager
@ -82,9 +83,7 @@ class PluginTest(unittest.TestCase):
def test_load_plugins(self):
def get_plugin_names(plugins):
return {
plugin.NAME if hasattr(plugin, 'NAME') else plugin.__name__
for plugin in plugins}
return {get_plugin_name(p) for p in plugins}
# existing namespace plugins
existing_ns_plugins = load_plugins({})
@ -94,7 +93,7 @@ class PluginTest(unittest.TestCase):
plugins = load_plugins({})
self.assertEqual(len(plugins), len(existing_ns_plugins)+1, plugins)
self.assertEqual(
{'namespace plugin'} | get_plugin_names(existing_ns_plugins),
{'pelican.plugins.ns_plugin'} | get_plugin_names(existing_ns_plugins),
get_plugin_names(plugins))
# disable namespace plugins with `PLUGINS = []`
@ -114,7 +113,7 @@ class PluginTest(unittest.TestCase):
plugins = load_plugins(SETTINGS)
self.assertEqual(len(plugins), 1, plugins)
self.assertEqual(
{'normal plugin'},
{'normal_plugin'},
get_plugin_names(plugins))
# normal submodule/subpackage plugins
@ -128,8 +127,8 @@ class PluginTest(unittest.TestCase):
plugins = load_plugins(SETTINGS)
self.assertEqual(len(plugins), 2, plugins)
self.assertEqual(
{'normal submodule plugin',
'normal subpackage plugin'},
{'normal_submodule_plugin.subplugin',
'normal_submodule_plugin.subpackage.subpackage'},
get_plugin_names(plugins))
# ensure normal plugins are loaded only once
@ -150,7 +149,7 @@ class PluginTest(unittest.TestCase):
plugins = load_plugins(SETTINGS)
self.assertEqual(len(plugins), 1, plugins)
self.assertEqual(
{'namespace plugin'},
{'pelican.plugins.ns_plugin'},
get_plugin_names(plugins))
# namespace plugin long
@ -160,7 +159,7 @@ class PluginTest(unittest.TestCase):
plugins = load_plugins(SETTINGS)
self.assertEqual(len(plugins), 1, plugins)
self.assertEqual(
{'namespace plugin'},
{'pelican.plugins.ns_plugin'},
get_plugin_names(plugins))
# normal and namespace plugin
@ -171,10 +170,22 @@ class PluginTest(unittest.TestCase):
plugins = load_plugins(SETTINGS)
self.assertEqual(len(plugins), 2, plugins)
self.assertEqual(
{'normal plugin', 'namespace plugin'},
{'normal_plugin', 'pelican.plugins.ns_plugin'},
get_plugin_names(plugins))
def test_get_plugin_name(self):
self.assertEqual(get_plugin_name('string_plugin'), 'string_plugin')
self.assertEqual(get_plugin_name(NoopPlugin), 'NoopPlugin')
self.assertEqual(get_plugin_name(NoopPlugin()), 'NoopPlugin')
self.assertEqual(
get_plugin_name(normal_plugin),
'pelican.tests.dummy_plugins.normal_plugin.normal_plugin',
)
class NoopPlugin:
def register(self):
pass
self.assertEqual(
get_plugin_name(NoopPlugin),
'PluginTest.test_get_plugin_name.<locals>.NoopPlugin')
self.assertEqual(
get_plugin_name(NoopPlugin()),
'PluginTest.test_get_plugin_name.<locals>.NoopPlugin')