Make types._SourceProvenance public

This is needed for plugins to provide their
source provenance info in their own way instead of
the top level source info that is used by default.

This is necessary for multi-source source plugins
to provide source info per source

Author: joshua-zivkovic

src/buildstream/element.py

@@ -90,7 +90,7 @@
 from .sandbox import _SandboxFlags, SandboxCommandError
 from .sandbox._config import SandboxConfig
 from .sandbox._sandboxremote import SandboxRemote
-from .types import _Scope, _CacheBuildTrees, _KeyStrength, OverlapAction, _DisplayKey, _SourceProvenance
+from .types import _Scope, _CacheBuildTrees, _KeyStrength, OverlapAction, _DisplayKey, SourceProvenance
 from ._artifact import Artifact
 from ._elementproxy import ElementProxy
 from ._elementsources import ElementSources
@@ -2639,7 +2639,7 @@ def __load_sources(self, load_element):
                 provenance = None
                 if provenance_node:
                     del source[Symbol.PROVENANCE]
-                    provenance = _SourceProvenance.new_from_node(provenance_node)
+                    provenance = SourceProvenance.new_from_node(provenance_node)
 
                 meta_source = MetaSource(
                     self.name,

src/buildstream/source.py

@@ -378,7 +378,7 @@
 from .node import MappingNode
 from .plugin import Plugin
 from .sourcemirror import SourceMirror
-from .types import SourceRef, CoreWarnings, FastEnum, _SourceProvenance
+from .types import SourceRef, CoreWarnings, FastEnum, SourceProvenance
 from ._exceptions import BstError, ImplError, PluginError
 from .exceptions import ErrorDomain
 from ._loader.metasource import MetaSource
@@ -825,8 +825,8 @@ def __init__(
         self._directory = meta.directory  # Staging relative directory
         self.__variables = variables  # The variables used to resolve the source's config
         self.__provenance: Optional[
-            _SourceProvenance
-        ] = meta.provenance  # The _SourceProvenance for general user provided SourceInfo
+            SourceProvenance
+        ] = meta.provenance # The SourceProvenance for general user provided SourceInfo
 
         self.__key = None  # Cache key for source
 
@@ -1367,7 +1367,7 @@ def create_source_info(
         version: str,
         *,
         version_guess: Optional[str] = None,
-        source_provenance_attrs: Optional[_SourceProvenance] = None,
+        source_provenance_attrs: Optional[SourceProvenance] = None,
         extra_data: Optional[Dict[str, str]] = None,
     ) -> SourceInfo:
         """Create a :class:`.SourceInfo` object

src/buildstream/types.py

@@ -164,6 +164,54 @@ class OverlapAction(FastEnum):
     """
 
 
+# SourceProvenance()
+#
+# A simple object describing user provided source provenance information
+#
+# Args:
+#    homepage: The source's homepage URL
+#    issue_tracker: The source's issue reporting URL
+#
+class SourceProvenance:
+    def __init__(
+        self,
+        homepage: Optional[str],
+        issue_tracker: Optional[str],
+    ):
+        self.homepage: Optional[str] = homepage
+        self.issue_tracker: Optional[str] = issue_tracker
+
+    # new_from_node():
+    #
+    # Creates a SourceProvenance() from a YAML loaded node.
+    #
+    # Args:
+    #    node: The configuration node describing the spec.
+    #
+    # Returns:
+    #    The described SourceProvenance instance.
+    #
+    # Raises:
+    #    LoadError: If the node is malformed.
+    #
+    @classmethod
+    def new_from_node(cls, node: MappingNode) -> "SourceProvenance":
+        node.validate_keys(
+            [
+                "homepage",
+                "issue-tracker",
+            ]
+        )
+
+        homepage: Optional[str] = node.get_str("homepage", None)
+        issue_tracker: Optional[str] = node.get_str("issue-tracker", None)
+
+        return cls(
+            homepage,
+            issue_tracker,
+        )
+
+
 # _Scope():
 #
 # Defines the scope of dependencies to include for a given element
@@ -324,7 +372,9 @@ def __str__(self):
 class _ProjectInformation:
     def __init__(self, project, provenance_node, duplicates, internal):
         self.project = project
-        self.provenance = provenance_node.get_provenance() if provenance_node else None
+        self.provenance = (
+            provenance_node.get_provenance() if provenance_node else None
+        )
         self.duplicates = duplicates
         self.internal = internal
 
@@ -390,42 +440,6 @@ def new_from_node(cls, node: MappingNode) -> "_SourceMirror":
         return cls(name, aliases)
 
 
-# _SourceProvenance()
-#
-# A simple object describing user provided source provenance information
-#
-# Args:
-#    homepage: The project homepage URL
-#    issue_tracker: The project issue reporting URL
-#
-class _SourceProvenance:
-    def __init__(self, homepage: Optional[str], issue_tracker: Optional[str]):
-        self.homepage: Optional[str] = homepage
-        self.issue_tracker: Optional[str] = issue_tracker
-
-    # new_from_node():
-    #
-    # Creates a _SourceProvenance() from a YAML loaded node.
-    #
-    # Args:
-    #    node: The configuration node describing the spec.
-    #
-    # Returns:
-    #    The described _SourceProvenance instance.
-    #
-    # Raises:
-    #    LoadError: If the node is malformed.
-    #
-    @classmethod
-    def new_from_node(cls, node: MappingNode) -> "_SourceProvenance":
-        node.validate_keys(["homepage", "issue-tracker"])
-
-        homepage: Optional[str] = node.get_str("homepage", None)
-        issue_tracker: Optional[str] = node.get_str("issue-tracker", None)
-
-        return cls(homepage, issue_tracker)
-
-
 ########################################
 #           Type aliases               #
 ########################################