centersl/mkdocs
1
0
Fork 0
mirror of https://github.com/mkdocs/mkdocs.git synced 2026-03-27 09:58:31 +07:00
Code Issues Packages Projects Releases Wiki Activity

Uncomplexifies config_options.Plugins.load_plugin

Browse Source 
Also retains all errors of a plugin config.
This commit is contained in:
Frank Sachsenheim
2017-09-18 09:38:02 +02:00
committed by Waylan Limberg
parent 39c81b8a88
commit 34cb58c124
1 changed files with 19 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
mkdocs/config/config_options.py
View File

@@ -629,21 +629,23 @@ class Plugins(OptionallyRequired):
return plgins
def load_plugin(self, name, config):
if name in self.installed_plugins:
Plugin = self.installed_plugins[name].load()
if issubclass(Plugin, plugins.BasePlugin):
plugin = Plugin()
errors, warnings = plugin.load_config(config)
self.warnings.extend(warnings)
for cfg_name, error in errors:
# TODO: retain all errors if there are more than one
raise ValidationError("Plugin value: '%s'. Error: %s", cfg_name, error)
return plugin
else:
raise ValidationError('{0}.{1} must be a subclass of '
'{2}.{3}'.format(Plugin.__module__,
Plugin.__name__,
plugins.BasePlugin.__module__,
plugins.BasePlugin.__name__))
else:
if name not in self.installed_plugins:
raise ValidationError('The "{0}" plugin is not installed'.format(name))
Plugin = self.installed_plugins[name].load()
if not issubclass(Plugin, plugins.BasePlugin):
raise ValidationError('{0}.{1} must be a subclass of {2}.{3}'.format(
Plugin.__module__, Plugin.__name__, plugins.BasePlugin.__module__,
plugins.BasePlugin.__name__))
plugin = Plugin()
errors, warnings = plugin.load_config(config)
self.warnings.extend(warnings)
errors_message = '\n'.join(
"Plugin value: '{}'. Error: {}".format(x, y)
for x, y in errors
)
if errors_message:
raise ValidationError(errors_message)
return plugin