Black + various pre-commit hooks (#176)

Author: mistercrunch

.pre-commit-config.yaml

@@ -0,0 +1,22 @@
+repos:
+-   repo: https://github.com/ambv/black
+    rev: stable
+    hooks:
+    -   id: black
+        language_version: python3
+
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.2.3
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-docstring-first
+    -   id: check-json
+    -   id: check-added-large-files
+    -   id: check-yaml
+    -   id: debug-statements
+
+-   repo: https://gitlab.com/pycqa/flake8
+    rev: 3.7.1
+    hooks:
+    -   id: flake8

README.md

@@ -267,3 +267,12 @@ TABLES
 > BYE;
 GoodBye!
 ```
+
+# Contributing
+
+Contributions are welcomed of course. We like to use `black` and `flake8`.
+
+```bash
+pip install -r requirements-dev.txt  # installs useful dev deps
+pre-commit install  # installs useful commit hooks
+```

pydruid/async_client.py

@@ -24,7 +24,7 @@
     from tornado import gen
     from tornado.httpclient import AsyncHTTPClient, HTTPError
 except ImportError:
-    print('Warning: unable to import Tornado. The asynchronous client will not work.')
+    print("Warning: unable to import Tornado. The asynchronous client will not work.")
 
 
 class AsyncPyDruid(BaseDruidClient):
@@ -110,7 +110,8 @@ def _post(self, query):
         try:
             headers, querystr, url = self._prepare_url_headers_and_body(query)
             response = yield http_client.fetch(
-                url, method='POST', headers=headers, body=querystr)
+                url, method="POST", headers=headers, body=querystr
+            )
         except HTTPError as e:
             self.__handle_http_error(e, query)
         else:
@@ -127,9 +128,12 @@ def __handle_http_error(e, query):
             except ValueError:
                 pass
             else:
-                err = err.get('error', None)
-        raise IOError('{0} \n Druid Error: {1} \n Query is: {2}'.format(
-                e, err, json.dumps(query.query_dict, indent=4)))
+                err = err.get("error", None)
+        raise IOError(
+            "{0} \n Druid Error: {1} \n Query is: {2}".format(
+                e, err, json.dumps(query.query_dict, indent=4)
+            )
+        )
 
     @gen.coroutine
     def topn(self, **kwargs):

pydruid/client.py

@@ -26,7 +26,7 @@
 
 
 # extract error from the <PRE> tag inside the HTML response
-HTML_ERROR = re.compile('<pre>\s*(.*?)\s*</pre>', re.IGNORECASE)
+HTML_ERROR = re.compile("<pre>\\s*(.*?)\\s*</pre>", re.IGNORECASE)
 
 
 class BaseDruidClient(object):
@@ -49,16 +49,16 @@ def set_proxies(self, proxies):
         urllib.request.install_opener(opener)
 
     def _prepare_url_headers_and_body(self, query):
-        querystr = json.dumps(query.query_dict).encode('utf-8')
-        if self.url.endswith('/'):
+        querystr = json.dumps(query.query_dict).encode("utf-8")
+        if self.url.endswith("/"):
             url = self.url + self.endpoint
         else:
-            url = self.url + '/' + self.endpoint
-        headers = {'Content-Type': 'application/json'}
+            url = self.url + "/" + self.endpoint
+        headers = {"Content-Type": "application/json"}
         if (self.username is not None) and (self.password is not None):
-            authstring = '{}:{}'.format(self.username, self.password)
+            authstring = "{}:{}".format(self.username, self.password)
             b64string = b64encode(authstring.encode()).decode()
-            headers['Authorization'] = 'Basic {}'.format(b64string)
+            headers["Authorization"] = "Basic {}".format(b64string)
 
         return headers, querystr, url
 
@@ -449,7 +449,8 @@ def export_tsv(self, dest_path):
         """
         if self.query_builder.last_query is None:
             raise AttributeError(
-                "There was no query executed by this client yet. Can't export!")
+                "There was no query executed by this client yet. Can't export!"
+            )
         else:
             return self.query_builder.last_query.export_tsv(dest_path)
 
@@ -462,7 +463,8 @@ def export_pandas(self):
         """
         if self.query_builder.last_query is None:
             raise AttributeError(
-                "There was no query executed by this client yet. Can't export!")
+                "There was no query executed by this client yet. Can't export!"
+            )
         else:
             return self.query_builder.last_query.export_pandas()
 
@@ -539,6 +541,7 @@ class PyDruid(BaseDruidClient):
                 0      7  2013-10-04T00:00:00.000Z         user_1
                 1      6  2013-10-04T00:00:00.000Z         user_2
     """
+
     def __init__(self, url, endpoint):
         super(PyDruid, self).__init__(url, endpoint)
 
@@ -561,12 +564,18 @@ def _post(self, query):
                 except (ValueError, AttributeError, KeyError):
                     pass
 
-            raise IOError('{0} \n Druid Error: {1} \n Query is: {2}'.format(
-                    e, err, json.dumps(
+            raise IOError(
+                "{0} \n Druid Error: {1} \n Query is: {2}".format(
+                    e,
+                    err,
+                    json.dumps(
                         query.query_dict,
                         indent=4,
                         sort_keys=True,
-                        separators=(',', ': '))))
+                        separators=(",", ": "),
+                    ),
+                )
+            )
         else:
             query.parse(data)
             return query