juergbi commented on code in PR #1903:
URL: https://github.com/apache/buildstream/pull/1903#discussion_r1539841014
##########
src/buildstream/_project.py:
##########
@@ -382,12 +402,18 @@ def alias_exists(self, alias, *, first_pass=False):
# get_alias_uris()
#
# Args:
- # alias (str): The alias.
- # first_pass (bool): Whether to use first pass configuration (for
junctions)
- # tracking (bool): Whether we want the aliases for tracking (otherwise
assume fetching)
+ # alias: The alias.
+ # first_pass: Whether to use first pass configuration (for junctions)
+ # tracking: Whether we want the aliases for tracking (otherwise assume
fetching)
+ #
+ # Returns:
+ # A list of (SourceMirror, string) tuples with each alias substitution
found along
+ # with the SourceMirror object which produced it.
Review Comment:
As far as I can tell, this returns a list with elements that can be strings
(alias substitution for the legacy/default implementation) or mirror objects,
not a list of tuples. These lists/values of imprecise type are passed through
various functions that expect a string (according to the parameter type). Is
this something you're still working on or am I misreading the code?
##########
src/buildstream/sourcemirror.py:
##########
@@ -0,0 +1,166 @@
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# Authors:
+# Tristan Van Berkom <[email protected]>
+"""
+SourceMirror - Base source mirror class
+=======================================
+The SourceMirror plugin allows one to customize how
+:func:`Source.translate_url() <buildstream.source.Source.translate_url>` will
+behave when looking up mirrors, allowing some additional flexibility in the
+implementation of source mirrors.
+
+
+.. _core_source_mirror_abstract_methods:
+
+Abstract Methods
+----------------
+For loading and configuration purposes, SourceMirrors may optionally implement
+the :func:`Plugin base class Plugin.configure() method
<buildstream.plugin.Plugin.configure>`
+in order to load any custom configuration in the `config` dictionary.
+
+The remaining :ref:`Plugin base class abstract methods
<core_plugin_abstract_methods>` are
+not relevant to the SourceMirror plugin object and need not be implemented.
+
+SourceMirrors expose the following abstract methods. Unless explicitly
mentioned,
+these methods are mandatory to implement.
+
+* :func:`SourceMirror.translate_url()
<buildstream.source.SourceMirror.translate_url>`
+
+ Produce an appropriate URL for the given URL and alias.
+
+
+Class Reference
+---------------
+"""
+
+from typing import Optional, Dict, List, Set, Any, TYPE_CHECKING
+
+from .node import MappingNode
+from .plugin import Plugin
+from ._exceptions import BstError, ImplError
+from .exceptions import ErrorDomain
+
+if TYPE_CHECKING:
+
+ # pylint: disable=cyclic-import
+ from ._context import Context
+ from ._project import Project
+
+ # pylint: enable=cyclic-import
+
+
+class SourceMirrorError(BstError):
+ """This exception should be raised by :class:`.SourceMirror`
implementations
+ to report errors to the user.
+
+ Args:
+ message: The breif error description to report to the user
+ detail: A possibly multiline, more detailed error message
+ reason: An optional machine readable reason string, used for test cases
+
+ *Since: 2.2*
+ """
+
+ def __init__(
+ self, message: str, *, detail: Optional[str] = None, reason:
Optional[str] = None, temporary: bool = False
+ ):
+ super().__init__(message, detail=detail, domain=ErrorDomain.SOURCE,
reason=reason)
+
+
+class SourceMirror(Plugin):
+ """SourceMirror()
+
+ Base SourceMirror class.
+
+ All SourceMirror plugins derive from this class, this interface defines how
+ the core will be interacting with SourceMirror plugins.
+
+ *Since: 2.2*
+ """
+
+ # The SourceMirror plugin type is only supported since BuildStream 2.2
+ BST_MIN_VERSION = "2.2"
+
+ COMMON_CONFIG_KEYS = ["name", "kind"]
+ """Common source config keys
+
+ SourceMirror config keys that must not be accessed in configure(), and
+ should be checked for using node.validate_keys().
+ """
+
+ def __init__(
+ self,
+ context: "Context",
+ project: "Project",
+ node: MappingNode,
+ ):
+ # Note: the MappingNode passed here is already expanded with
+ # the project level base variables, so there is no need
+ # to expand them redundantly here.
+ #
+
+ # Do local base class parsing first
+ name: str = node.get_str("name")
+
+ # Chain up to Plugin
+ super().__init__(name, context, project, node, "source-mirror")
+
+ self.__aliases: Set[str] = set()
+ # Plugin specific parsing
+ self._configure(node)
+
+ ##########################################################
+ # Internal API #
+ ##########################################################
+ def _get_alias_uris(self, alias: str) -> List:
+ assert self.__aliases is not None, "Didn't set aliases during
configuring time"
+ if alias in self.__aliases:
+ return [self]
+ return []
+
+ ##########################################################
+ # Public API #
+ ##########################################################
+
+ def set_supported_aliases(self, aliases: List[str]):
+ """Set the aliases for which `self` can translate urls."""
+ assert self._get_configuring(), "Trying to set aliases after configure
time"
+ self.__aliases.update(aliases)
+
+ def translate_url(
+ self,
+ *,
+ project_name: str,
+ alias: str,
+ alias_url: str,
+ alias_substitute_url: Optional[str],
+ source_url: str,
+ extra_data: Optional[Dict[str, Any]],
Review Comment:
You no longer intend to change this method signature as per the discussion
on the mailing list?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
