Prefix utility/library modules inside of Duct collections with '_'.

airbnb · Aug 20, 2018 · d44f7c5 · d44f7c5
1 parent cf90061
commit d44f7c5
Show file tree

Hide file tree

Showing 8 changed files with 13 additions and 13 deletions.
diff --git a/omniduct/databases/cursor_formatters.py → omniduct/databases/_cursor_formatters.py b/omniduct/databases/cursor_formatters.py → omniduct/databases/_cursor_formatters.py
diff --git a/omniduct/databases/schemas.py → omniduct/databases/_schemas.py b/omniduct/databases/schemas.py → omniduct/databases/_schemas.py
diff --git a/omniduct/databases/base.py b/omniduct/databases/base.py
@@ -18,7 +18,7 @@
 from omniduct.utils.magics import (MagicsProvider, process_line_arguments,
                                    process_line_cell_arguments)
 
-from . import cursor_formatters
+from . import _cursor_formatters
 
 logging.getLogger('requests').setLevel(logging.WARNING)
 
@@ -63,12 +63,12 @@ class DatabaseClient(Duct, MagicsProvider):
     DEFAULT_PORT = None
 
     CURSOR_FORMATTERS = {
-        'pandas': cursor_formatters.PandasCursorFormatter,
-        'hive': cursor_formatters.HiveCursorFormatter,
-        'csv': cursor_formatters.CsvCursorFormatter,
-        'tuple': cursor_formatters.TupleCursorFormatter,
-        'dict': cursor_formatters.DictCursorFormatter,
-        'raw': cursor_formatters.RawCursorFormatter,
+        'pandas': _cursor_formatters.PandasCursorFormatter,
+        'hive': _cursor_formatters.HiveCursorFormatter,
+        'csv': _cursor_formatters.CsvCursorFormatter,
+        'tuple': _cursor_formatters.TupleCursorFormatter,
+        'dict': _cursor_formatters.DictCursorFormatter,
+        'raw': _cursor_formatters.RawCursorFormatter,
     }
     DEFAULT_CURSOR_FORMATTER = 'pandas'
     SUPPORTS_SESSION_PROPERTIES = False
@@ -341,7 +341,7 @@ def stream(self, statement, format=None, format_opts={}, batch=None, **kwargs):
 
     def _get_formatter(self, formatter, cursor, **kwargs):
         formatter = formatter or self.DEFAULT_CURSOR_FORMATTER
-        if not (inspect.isclass(formatter) and issubclass(formatter, cursor_formatters.CursorFormatter)):
+        if not (inspect.isclass(formatter) and issubclass(formatter, _cursor_formatters.CursorFormatter)):
             assert formatter in self.CURSOR_FORMATTERS, "Invalid format '{}'. Choose from: {}".format(formatter, ','.join(self.CURSOR_FORMATTERS.keys()))
             formatter = self.CURSOR_FORMATTERS[formatter]
         return formatter(cursor, **kwargs)

diff --git a/omniduct/databases/hiveserver2.py b/omniduct/databases/hiveserver2.py
@@ -14,7 +14,7 @@
 from omniduct.utils.processes import Timeout, run_in_subprocess
 
 from .base import DatabaseClient
-from .schemas import SchemasMixin
+from ._schemas import SchemasMixin
 
 
 class HiveServer2Client(DatabaseClient, SchemasMixin):

diff --git a/omniduct/databases/presto.py b/omniduct/databases/presto.py
@@ -13,7 +13,7 @@
 from omniduct.utils.debug import logger
 
 from .base import DatabaseClient
-from .schemas import SchemasMixin
+from ._schemas import SchemasMixin
 
 
 class PrestoClient(DatabaseClient, SchemasMixin):

diff --git a/omniduct/databases/sqlalchemy.py b/omniduct/databases/sqlalchemy.py
@@ -1,7 +1,7 @@
 from __future__ import absolute_import
 
 from .base import DatabaseClient
-from .schemas import SchemasMixin
+from ._schemas import SchemasMixin
 
 
 class SQLAlchemyClient(DatabaseClient, SchemasMixin):

diff --git a/omniduct/filesystems/webhdfs_helpers.py → omniduct/filesystems/_webhdfs_helpers.py b/omniduct/filesystems/webhdfs_helpers.py → omniduct/filesystems/_webhdfs_helpers.py
diff --git a/omniduct/filesystems/webhdfs.py b/omniduct/filesystems/webhdfs.py
@@ -43,7 +43,7 @@ def _init(self, namenodes=None, auto_conf=False, auto_conf_cluster=None,
         self.namenodes = namenodes
 
         if auto_conf:
-            from .webhdfs_helpers import CdhHdfsConfParser
+            from ._webhdfs_helpers import CdhHdfsConfParser
 
             assert auto_conf_cluster is not None, "You must specify a cluster via `auto_conf_cluster` for auto-detection to work."
 
@@ -59,7 +59,7 @@ def get_host_and_set_namenodes(duct, cluster, conf_path):
         self.prepared_fields += ('namenodes',)
 
     def _connect(self):
-        from .webhdfs_helpers import OmniductPyWebHdfsClient
+        from ._webhdfs_helpers import OmniductPyWebHdfsClient
         self.__webhdfs = OmniductPyWebHdfsClient(
             host=self._host,
             port=self._port,