summaryrefslogtreecommitdiff
path: root/src/buildstream/_sourcefactory.py
diff options
context:
space:
mode:
authorChandan Singh <csingh43@bloomberg.net>2019-04-24 22:53:19 +0100
committerChandan Singh <csingh43@bloomberg.net>2019-05-21 12:41:18 +0100
commit070d053e5cc47e572e9f9e647315082bd7a15c63 (patch)
tree7fb0fdff52f9b5f8a18ec8fe9c75b661f9e0839e /src/buildstream/_sourcefactory.py
parent6c59e7901a52be961c2a1b671cf2b30f90bc4d0a (diff)
downloadbuildstream-070d053e5cc47e572e9f9e647315082bd7a15c63.tar.gz
Move source from 'buildstream' to 'src/buildstream'
This was discussed in #1008. Fixes #1009.
Diffstat (limited to 'src/buildstream/_sourcefactory.py')
-rw-r--r--src/buildstream/_sourcefactory.py64
1 files changed, 64 insertions, 0 deletions
diff --git a/src/buildstream/_sourcefactory.py b/src/buildstream/_sourcefactory.py
new file mode 100644
index 000000000..1d959a140
--- /dev/null
+++ b/src/buildstream/_sourcefactory.py
@@ -0,0 +1,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 .source import Source
+
+
+# A SourceFactory creates Source 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 Source plugins
+#
+class SourceFactory(PluginContext):
+
+ def __init__(self, plugin_base, *,
+ format_versions={},
+ plugin_origins=None):
+
+ super().__init__(plugin_base, Source, [_site.source_plugins],
+ format_versions=format_versions,
+ plugin_origins=plugin_origins)
+
+ # create():
+ #
+ # Create a Source object, the pipeline uses this to create Source
+ # objects on demand for a given pipeline.
+ #
+ # Args:
+ # context (object): The Context object for processing
+ # project (object): The project object
+ # meta (object): The loaded MetaSource
+ #
+ # Returns:
+ # A newly created Source object of the appropriate kind
+ #
+ # Raises:
+ # PluginError (if the kind lookup failed)
+ # LoadError (if the source itself took issue with the config)
+ #
+ def create(self, context, project, meta):
+ source_type, _ = self.lookup(meta.kind)
+ source = source_type(context, project, meta)
+ version = self._format_versions.get(meta.kind, 0)
+ self._assert_plugin_format(source, version)
+ return source