Druidapi Jupyter client port

.gitignore

@@ -16,3 +16,4 @@ __pycache__
 env*
 venv
 Pipfile*
+.venv

pydruid/druidapi/__init__.py

@@ -0,0 +1,26 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You 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.
+
+from .druid import DruidClient
+
+def jupyter_client(endpoint, auth=None) -> DruidClient:
+    '''
+    Create a Druid client configured to display results as HTML withing a Jupyter notebook.
+    Waits for the cluster to become ready to avoid intermitent problems when using Druid.
+    '''
+    from .html_display import HtmlDisplayClient
+    druid = DruidClient(endpoint, HtmlDisplayClient(), auth=auth)
+    druid.status.wait_until_ready()
+    return druid

pydruid/druidapi/base_table.py

@@ -0,0 +1,143 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You 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.
+
+ALIGN_LEFT = 0
+ALIGN_CENTER = 1
+ALIGN_RIGHT = 2
+
+def padded(array, width, fill):
+    if array and len(array) >= width:
+        return array
+    if not array:
+        result = []
+    else:
+        result = array.copy()
+    return pad(result, width, fill)
+
+def pad(array, width, fill):
+    for _ in range(len(array), width):
+        array.append(fill)
+    return array
+
+def infer_keys(data):
+    if type(data) is list:
+        data = data[0]
+    keys = {}
+    for key in data.keys():
+        keys[key] = key
+    return keys
+
+class BaseTable:
+
+    def __init__(self):
+        self._headers = None
+        self._align = None
+        self._col_fmt = None
+        self.sample_size = 10
+        self._rows = None
+
+    def headers(self, headers):
+        self._headers = headers
+
+    def rows(self, rows):
+        self._rows = rows
+
+    def alignments(self, align):
+        self._align = align
+
+    def col_format(self, col_fmt):
+        self._col_fmt = col_fmt
+
+    def row_width(self, rows):
+        max_width = 0
+        min_width = None
+        if self._headers:
+            max_width = len(self._headers)
+            min_width = max_width
+        for row in rows:
+            max_width = max(max_width, len(row))
+            min_width = max_width if min_width is None else min(min_width, max_width)
+        min_width = max_width if min_width is None else min_width
+        return (min_width, max_width)
+
+    def find_alignments(self, rows, width):
+        align = padded(self._align, width, None)
+        unknown_count = 0
+        for v in align:
+            if v is None:
+                unknown_count += 1
+        if unknown_count == 0:
+            return align
+        for row in rows:
+            for i in range(len(row)):
+                if align[i] is not None:
+                    continue
+                v = row[i]
+                if v is None:
+                    continue
+                if type(v) is str:
+                    align[i] = ALIGN_LEFT
+                else:
+                    align[i] = ALIGN_RIGHT
+                unknown_count -= 1
+                if unknown_count == 0:
+                    return align
+        for i in range(width):
+            if align[i] is None:
+                align[i] = ALIGN_LEFT
+        return align
+
+    def pad_rows(self, rows, width):
+        new_rows = []
+        for row in rows:
+            new_rows.append(padded(row, width, None))
+        return new_rows
+
+    def pad_headers(self, width):
+        if not self._headers:
+            return None
+        if len(self._headers) == 0:
+            return None
+        has_none = False
+        for i in range(len(self._headers)):
+            if not self._headers[i]:
+                has_none = True
+                break
+        if len(self._headers) >= width and not has_none:
+            return self._headers
+        headers = self._headers.copy()
+        if has_none:
+            for i in range(len(headers)):
+                if not headers[i]:
+                    headers[i] = ''
+        return pad(headers, width, '')
+
+    def from_object_list(self, objects, cols=None):
+        cols = infer_keys(objects) if not cols else cols
+        self._rows = []
+        for obj in objects:
+            row = []
+            for key in cols.keys():
+                row.append(obj.get(key))
+            self._rows.append(row)
+        self.headers([head for head in cols.values()])
+        self.alignments(self.find_alignments(self._rows, len(self._rows)))
+
+    def from_object(self, obj, labels=None):
+        labels = infer_keys(obj) if not labels else labels
+        self._rows = []
+        for key, head in labels.items():
+            self._rows.append([head, obj.get(key)])
+        self.headers(['Key', 'Value'])