Format and test

- Add black / zimports formatting
- Add tox.ini

Change-Id: Ie529f3c28d683accb00700573dfdc80b41c8a1e6

Author: zzzeek

.pre-commit-config.yaml

@@ -0,0 +1,15 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+-   repo: https://github.com/python/black/
+    rev: 19.3b0
+    hooks:
+    -   id: black
+        args: [-l 79]
+
+-   repo: https://github.com/sqlalchemyorg/zimports/
+    rev: master
+    hooks:
+    -   id: zimports
+
+

setup.cfg

@@ -5,3 +5,17 @@ addopts= --tb native -v -r fxX --ignore=sqlalchemy
 python_files=sqlalchemy_collectd/*/test_*.py
 
 
+[flake8]
+enable-extensions = G
+# E203 is due to https://github.com/PyCQA/pycodestyle/issues/373
+ignore =
+    A003,
+    D,
+    E203,E305,E711,E712,E721,E722,E741,
+    N801,N802,N806,
+    RST304,RST303,RST299,RST399,
+    W503,W504
+exclude = .venv,.git,.tox,dist,doc,*egg,build
+import-order-style = google
+application-import-names = sqlalchemy_collectd
+

setup.py

@@ -1,28 +1,31 @@
-from setuptools import setup
-from setuptools import find_packages
-from setuptools.command.test import test as TestCommand  # noqa
 import os
 import re
 import sys
 
+from setuptools import find_packages
+from setuptools import setup
+from setuptools.command.test import test as TestCommand  # noqa
+
 
 with open(
     os.path.join(
-        os.path.dirname(__file__), 'sqlalchemy_collectd', '__init__.py')
+        os.path.dirname(__file__), "sqlalchemy_collectd", "__init__.py"
+    )
 ) as file_:
-    VERSION = re.compile(
-        r".*__version__ = '(.*?)'", re.S).match(file_.read()).group(1)
+    VERSION = (
+        re.compile(r".*__version__ = [\"'](.*?)[\"']", re.S)
+        .match(file_.read())
+        .group(1)
+    )
 
 
-readme = os.path.join(os.path.dirname(__file__), 'README.rst')
+readme = os.path.join(os.path.dirname(__file__), "README.rst")
 
-requires = [
-    'SQLAlchemy>=1.1',
-]
+requires = ["SQLAlchemy>=1.1"]
 
 
 class PyTest(TestCommand):
-    user_options = [('pytest-args=', 'a', "Arguments to pass to py.test")]
+    user_options = [("pytest-args=", "a", "Arguments to pass to py.test")]
 
     def initialize_options(self):
         TestCommand.initialize_options(self)
@@ -36,36 +39,37 @@ def finalize_options(self):
     def run_tests(self):
         # import here, cause outside the eggs aren't loaded
         import pytest
+
         errno = pytest.main(self.pytest_args)
         sys.exit(errno)
 
 
 setup(
-    name='sqlalchemy-collectd',
+    name="sqlalchemy-collectd",
     version=VERSION,
     description="Send database connection pool stats to collectd",
     long_description=open(readme).read(),
     classifiers=[
-        'Development Status :: 3 - Alpha',
-        'Intended Audience :: Developers',
-        'Programming Language :: Python',
-        'Programming Language :: Python :: 3',
-        'Topic :: Database :: Front-Ends',
+        "Development Status :: 3 - Alpha",
+        "Intended Audience :: Developers",
+        "Programming Language :: Python",
+        "Programming Language :: Python :: 3",
+        "Topic :: Database :: Front-Ends",
     ],
-    keywords='SQLAlchemy collectd',
-    author='Mike Bayer',
-    author_email='[email protected]',
-    url='https://github.com/sqlalchemy/sqlalchemy-collectd',
-    license='MIT',
+    keywords="SQLAlchemy collectd",
+    author="Mike Bayer",
+    author_email="[email protected]",
+    url="https://github.com/sqlalchemy/sqlalchemy-collectd",
+    license="MIT",
     packages=find_packages(".", exclude=["examples*", "*.tests"]),
     include_package_data=True,
-    tests_require=['pytest', 'mock'],
-    cmdclass={'test': PyTest},
+    tests_require=["pytest", "mock"],
+    cmdclass={"test": PyTest},
     zip_safe=False,
     install_requires=requires,
     entry_points={
-        'sqlalchemy.plugins': [
-            'collectd = sqlalchemy_collectd.client.plugin:Plugin'
+        "sqlalchemy.plugins": [
+            "collectd = sqlalchemy_collectd.client.plugin:Plugin"
         ]
-    }
+    },
 )

sqlalchemy_collectd/__init__.py

@@ -1 +1 @@
-__version__ = '0.0.4'
+__version__ = "0.0.4"

sqlalchemy_collectd/client/collector.py

@@ -1,7 +1,9 @@
-from sqlalchemy import event
+import logging
 import threading
 import weakref
-import logging
+
+from sqlalchemy import event
+
 from . import worker
 
 
@@ -56,10 +58,11 @@ def num_pools(self):
 
     @property
     def num_checkedout(self):
-        checkedout = self.connections.\
-            difference(self.detached).\
-            difference(self.invalidated).\
-            difference(self.checkedin)
+        checkedout = (
+            self.connections.difference(self.detached)
+            .difference(self.invalidated)
+            .difference(self.checkedin)
+        )
         return len(checkedout)
 
     @property
@@ -84,7 +87,6 @@ def num_transactions(self):
 
 
 class EngineCollector(object):
-
     def __init__(self, collection_target, engine):
         self.collection_target = collection_target
         self.engine = engine
@@ -157,7 +159,8 @@ def _close_evt(self, dbapi_conn, connection_rec):
     def _warn_missing_connection(self, dbapi_conn):
         self._warn(
             "connection %s was closed but not part of "
-            "total connections" % dbapi_conn)
+            "total connections" % dbapi_conn
+        )
 
     def _warn(self, msg):
         self.logger.warn(msg)
@@ -179,6 +182,3 @@ def _close_detached_evt(self, dbapi_conn):
             self.collection_target.total_disconnects += 1
         except KeyError:
             self._warn_missing_connection(dbapi_conn)
-
-
-

sqlalchemy_collectd/client/plugin.py

@@ -4,24 +4,28 @@
 
 from sqlalchemy.engine import CreateEnginePlugin
 
-from .. import protocol
+from . import collector
 from . import sender
 from . import worker
-from . import collector
+from .. import protocol
 
 
 class Plugin(CreateEnginePlugin):
     def __init__(self, url, kwargs):
         self.url = url
         self.config = {}
         self._get_argument(
-            "collectd_host", "collectd_host", self.config, url, kwargs)
+            "collectd_host", "collectd_host", self.config, url, kwargs
+        )
         self._get_argument(
-            "collectd_port", "collectd_port", self.config, url, kwargs)
+            "collectd_port", "collectd_port", self.config, url, kwargs
+        )
         self._get_argument(
-            "collectd_report_host", "hostname", self.config, url, kwargs)
+            "collectd_report_host", "hostname", self.config, url, kwargs
+        )
         self._get_argument(
-            "collectd_program_name", "progname", self.config, url, kwargs)
+            "collectd_program_name", "progname", self.config, url, kwargs
+        )
 
     def _get_argument(self, name, dest_name, dest, url, kwargs):
         # favor the URL but pop the name from both
@@ -48,8 +52,12 @@ def engine_created(self, engine):
 
 
 def start_plugin(
-        engine, hostname=None, progname=None,
-        collectd_host="localhost", collectd_port=25827):
+    engine,
+    hostname=None,
+    progname=None,
+    collectd_host="localhost",
+    collectd_port=25827,
+):
 
     if hostname is None:
         hostname = socket.gethostname()
@@ -59,13 +67,12 @@ def start_plugin(
 
     sender_ = sender.Sender(hostname, progname)
     collection_target = collector.CollectionTarget.collection_for_name(
-        progname)
+        progname
+    )
     collector.EngineCollector(collection_target, engine)
 
     connection = protocol.ClientConnection.for_host_port(
-        collectd_host, collectd_port)
+        collectd_host, collectd_port
+    )
 
-    worker.add_target(
-        connection,
-        collection_target,
-        sender_)
+    worker.add_target(connection, collection_target, sender_)

sqlalchemy_collectd/client/sender.py

@@ -1,5 +1,5 @@
-from .. import protocol
 from . import internal_types
+from .. import protocol
 
 
 senders = []
@@ -22,33 +22,39 @@ def __init__(self, hostname, stats_name, plugin="sqlalchemy"):
     def send(self, connection, collection_target, timestamp, interval, pid):
         for protocol_type, sender in senders:
             message_sender = protocol.MessageSender(
-                protocol_type, self.hostname, self.plugin,
-                plugin_instance=self.stats_name, type_instance=str(pid),
-                interval=interval
+                protocol_type,
+                self.hostname,
+                self.plugin,
+                plugin_instance=self.stats_name,
+                type_instance=str(pid),
+                interval=interval,
             )
             sender(message_sender, connection, collection_target, timestamp)
 
 
 @sends(internal_types.pool)
 def _send_pool(message_sender, connection, collection_target, timestamp):
     message_sender.send(
-        connection, timestamp,
+        connection,
+        timestamp,
         collection_target.num_pools,
         collection_target.num_checkedout,
         collection_target.num_checkedin,
         collection_target.num_detached,
         # collection_target.num_invalidated,
-        collection_target.num_connections
+        collection_target.num_connections,
     )
 
 
 @sends(internal_types.totals)
 def _send_connection_totals(
-        message_sender, connection, collection_target, timestamp):
+    message_sender, connection, collection_target, timestamp
+):
     message_sender.send(
-        connection, timestamp,
+        connection,
+        timestamp,
         collection_target.total_checkouts,
         collection_target.total_invalidated,
         collection_target.total_connects,
-        collection_target.total_disconnects
+        collection_target.total_disconnects,
     )

sqlalchemy_collectd/client/tests/test_plugin.py

@@ -1,40 +1,31 @@
-
-import mock
 import unittest
 
+import mock
 from sqlalchemy.engine import url as sqla_url
 
 from .. import plugin
 
 
 class PluginTest(unittest.TestCase):
-
     def test_start_no_args(self):
         with mock.patch.object(plugin, "start_plugin") as start_plugin:
-            url = sqla_url.URL(
-                "mysql+pymysql://scott:tiger@localhost/"
-            )
+            url = sqla_url.URL("mysql+pymysql://scott:tiger@localhost/")
             p = plugin.Plugin(url, {})
             engine = mock.Mock()
             p.engine_created(engine)
 
-        self.assertEqual(
-            [mock.call(engine)],
-            start_plugin.mock_calls
-        )
+        self.assertEqual([mock.call(engine)], start_plugin.mock_calls)
 
     def test_start_engine_args(self):
         with mock.patch.object(plugin, "start_plugin") as start_plugin:
-            url = sqla_url.URL(
-                "mysql+pymysql://scott:tiger@localhost/"
-            )
+            url = sqla_url.URL("mysql+pymysql://scott:tiger@localhost/")
             p = plugin.Plugin(url, {"collectd_host": "127.0.0.1"})
             engine = mock.Mock()
             p.engine_created(engine)
 
         self.assertEqual(
             [mock.call(engine, collectd_host="127.0.0.1")],
-            start_plugin.mock_calls
+            start_plugin.mock_calls,
         )
 
     def test_start_url_args(self):
@@ -50,7 +41,7 @@ def test_start_url_args(self):
 
         self.assertEqual(
             [mock.call(engine, collectd_host="127.0.0.1")],
-            start_plugin.mock_calls
+            start_plugin.mock_calls,
         )
         self.assertEqual({"somekey": "somevalue"}, url.query)
         self.assertEqual({"unrelated": "bar"}, kwargs)
@@ -69,7 +60,7 @@ def test_start_both_args(self):
         # argument is popped from both but favors url argument
         self.assertEqual(
             [mock.call(engine, collectd_host="127.0.0.1")],
-            start_plugin.mock_calls
+            start_plugin.mock_calls,
         )
         self.assertEqual({}, url.query)
         self.assertEqual({}, kwargs)