source.py: Add optional _get_local_path() method

1 files changed, 17 insertions, 0 deletions

diff --git a/buildstream/source.py b/buildstream/source.py
index f346fdf83..d6681b963 100644
--- a/buildstream/source.py
+++ b/buildstream/source.py
@@ -616,6 +616,23 @@ class Source(Plugin):
             yield tempdir
 
     #############################################################
+    #       Private Abstract Methods used in BuildStream        #
+    #############################################################
+
+    # Returns the local path to the source
+    #
+    # If the source is locally available, this method returns the absolute
+    # path. Otherwise, the return value is None.
+    #
+    # This is an optimization for local sources and optional to implement.
+    #
+    # Returns:
+    #    (str): The local absolute path, or None
+    #
+    def _get_local_path(self):
+        return None
+
+    #############################################################
     #            Private Methods used in BuildStream            #
     #############################################################