1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
|
#
# Copyright (C) 2016 Codethink Limited
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library. If not, see <http://www.gnu.org/licenses/>.
#
# Authors:
# Tristan Van Berkom <tristan.vanberkom@codethink.co.uk>
from . import _site
from ._plugincontext import PluginContext
from .element import Element
# A ElementFactory creates Element instances
# in the context of a given factory
#
# Args:
# plugin_base (PluginBase): The main PluginBase object to work with
# plugin_origins (list): Data used to search for external Element plugins
#
class ElementFactory(PluginContext):
def __init__(self, plugin_base, *, format_versions={}, plugin_origins=None):
super().__init__(
plugin_base,
Element,
[_site.element_plugins],
plugin_origins=plugin_origins,
format_versions=format_versions,
)
# create():
#
# Create an Element object, the pipeline uses this to create Element
# objects on demand for a given pipeline.
#
# Args:
# context (object): The Context object for processing
# project (object): The project object
# meta (object): The loaded MetaElement
#
# Returns: A newly created Element object of the appropriate kind
#
# Raises:
# PluginError (if the kind lookup failed)
# LoadError (if the element itself took issue with the config)
#
def create(self, context, project, meta):
element_type, default_config = self.lookup(meta.kind)
element = element_type(context, project, meta, default_config)
version = self._format_versions.get(meta.kind, 0)
self._assert_plugin_format(element, version)
return element
|
