[buildstream] 01/02: Make DownloadableFileSource publically accessible

[ro...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

root pushed a commit to branch jonathan/expose-downloadablefilesource
in repository https://gitbox.apache.org/repos/asf/buildstream.git

commit 7f8d0b9cac97b830b718b00ed3db9096c06d525c
Author: Jonathan Maw <jo...@codethink.co.uk>
AuthorDate: Tue Aug 28 14:12:37 2018 +0100

    Make DownloadableFileSource publically accessible
---
 buildstream/__init__.py                                             | 1 +
 .../_downloadablefilesource.py => downloadablefilesource.py}        | 6 +++++-
 buildstream/plugins/sources/remote.py                               | 3 +--
 buildstream/plugins/sources/tar.py                                  | 3 +--
 buildstream/plugins/sources/zip.py                                  | 3 +--
 5 files changed, 9 insertions(+), 7 deletions(-)

diff --git a/buildstream/__init__.py b/buildstream/__init__.py
index af2122e..5a6612e 100644
--- a/buildstream/__init__.py
+++ b/buildstream/__init__.py
@@ -34,3 +34,4 @@ if "_BST_COMPLETION" not in os.environ:
     from .element import Element, ElementError
     from .buildelement import BuildElement
     from .scriptelement import ScriptElement
+    from .downloadablefilesource import DownloadableFileSource
diff --git a/buildstream/plugins/sources/_downloadablefilesource.py b/buildstream/downloadablefilesource.py
similarity index 96%
rename from buildstream/plugins/sources/_downloadablefilesource.py
rename to buildstream/downloadablefilesource.py
index 7d1fc07..11981c4 100644
--- a/buildstream/plugins/sources/_downloadablefilesource.py
+++ b/buildstream/downloadablefilesource.py
@@ -1,4 +1,8 @@
-"""A base abstract class for source implementations which download a file"""
+"""
+DownloadableFileSource - Abstract class for downloading files
+=============================================================
+A base abstract class for source implementations which download a file.
+"""
 
 import os
 import urllib.request
diff --git a/buildstream/plugins/sources/remote.py b/buildstream/plugins/sources/remote.py
index a6b02fd..c296d31 100644
--- a/buildstream/plugins/sources/remote.py
+++ b/buildstream/plugins/sources/remote.py
@@ -52,8 +52,7 @@ details on common configuration options for sources.
    The ``remote`` plugin is available since :ref:`format version 10 <project_format_version>`
 """
 import os
-from buildstream import SourceError, utils
-from ._downloadablefilesource import DownloadableFileSource
+from buildstream import SourceError, utils, DownloadableFileSource
 
 
 class RemoteSource(DownloadableFileSource):
diff --git a/buildstream/plugins/sources/tar.py b/buildstream/plugins/sources/tar.py
index 195c059..75219dc 100644
--- a/buildstream/plugins/sources/tar.py
+++ b/buildstream/plugins/sources/tar.py
@@ -62,8 +62,7 @@ from tempfile import TemporaryFile
 
 from buildstream import SourceError
 from buildstream import utils
-
-from ._downloadablefilesource import DownloadableFileSource
+from buildstream import DownloadableFileSource
 
 
 class TarSource(DownloadableFileSource):
diff --git a/buildstream/plugins/sources/zip.py b/buildstream/plugins/sources/zip.py
index f5fac3a..dafd6f5 100644
--- a/buildstream/plugins/sources/zip.py
+++ b/buildstream/plugins/sources/zip.py
@@ -62,8 +62,7 @@ import stat
 
 from buildstream import SourceError
 from buildstream import utils
-
-from ._downloadablefilesource import DownloadableFileSource
+from buildstream import DownloadableFileSource
 
 
 class ZipSource(DownloadableFileSource):