Apply black formatting

alexchamberlain · alexchamberlain · commit 1a4590b42919 · 2019-06-07T17:19:17.000+01:00
Signed-off-by: Alex Chamberlain &lt;achamberlai9@bloomberg.net&gt;
diff --git a/.travis.yml b/.travis.yml
@@ -1,10 +1,17 @@
+dist: xenial
 language: python
 python:
   - "2.7"
   - "3.6"
+  - "3.7"
   - "pypy"
   - "pypy3"
 install:
   - pip install tox-travis
 script:
   - tox
+matrix:
+  include:
+    - python: "3.7"
+      script: black --line-length 120 --check github_webhook tests setup.py
+      install: pip install black
diff --git a/github_webhook/webhook.py b/github_webhook/webhook.py
@@ -16,17 +16,16 @@ class Webhook(object):
     :param secret: Optional secret, used to authenticate the hook comes from Github
     """
 
-    def __init__(self, app, endpoint='/postreceive', secret=None):
-        app.add_url_rule(rule=endpoint, endpoint=endpoint, view_func=self._postreceive,
-                         methods=['POST'])
+    def __init__(self, app, endpoint="/postreceive", secret=None):
+        app.add_url_rule(rule=endpoint, endpoint=endpoint, view_func=self._postreceive, methods=["POST"])
 
         self._hooks = collections.defaultdict(list)
-        self._logger = logging.getLogger('webhook')
+        self._logger = logging.getLogger("webhook")
         if secret is not None and not isinstance(secret, six.binary_type):
-            secret = secret.encode('utf-8')
+            secret = secret.encode("utf-8")
         self._secret = secret
 
-    def hook(self, event_type='push'):
+    def hook(self, event_type="push"):
         """
         Registers a function as a hook. Multiple hooks can be registered for a given type, but the
         order in which they are invoke is unspecified.
@@ -43,36 +42,33 @@ def decorator(func):
     def _get_digest(self):
         """Return message digest if a secret key was provided"""
 
-        return hmac.new(
-            self._secret, request.data, hashlib.sha1).hexdigest() if self._secret else None
+        return hmac.new(self._secret, request.data, hashlib.sha1).hexdigest() if self._secret else None
 
     def _postreceive(self):
         """Callback from Flask"""
 
         digest = self._get_digest()
 
         if digest is not None:
-            sig_parts = _get_header('X-Hub-Signature').split('=', 1)
+            sig_parts = _get_header("X-Hub-Signature").split("=", 1)
             if not isinstance(digest, six.text_type):
                 digest = six.text_type(digest)
 
-            if (len(sig_parts) < 2 or sig_parts[0] != 'sha1'
-                    or not hmac.compare_digest(sig_parts[1], digest)):
-                abort(400, 'Invalid signature')
+            if len(sig_parts) < 2 or sig_parts[0] != "sha1" or not hmac.compare_digest(sig_parts[1], digest):
+                abort(400, "Invalid signature")
 
-        event_type = _get_header('X-Github-Event')
+        event_type = _get_header("X-Github-Event")
         data = request.get_json()
 
         if data is None:
-            abort(400, 'Request body must contain json')
+            abort(400, "Request body must contain json")
 
-        self._logger.info(
-            '%s (%s)', _format_event(event_type, data), _get_header('X-Github-Delivery'))
+        self._logger.info("%s (%s)", _format_event(event_type, data), _get_header("X-Github-Delivery"))
 
         for hook in self._hooks.get(event_type, []):
             hook(data)
 
-        return '', 204
+        return "", 204
 
 
 def _get_header(key):
@@ -81,54 +77,41 @@ def _get_header(key):
     try:
         return request.headers[key]
     except KeyError:
-        abort(400, 'Missing header: ' + key)
+        abort(400, "Missing header: " + key)
 
 
 EVENT_DESCRIPTIONS = {
-    'commit_comment': '{comment[user][login]} commented on '
-                      '{comment[commit_id]} in {repository[full_name]}',
-    'create': '{sender[login]} created {ref_type} ({ref}) in '
-              '{repository[full_name]}',
-    'delete': '{sender[login]} deleted {ref_type} ({ref}) in '
-              '{repository[full_name]}',
-    'deployment': '{sender[login]} deployed {deployment[ref]} to '
-                  '{deployment[environment]} in {repository[full_name]}',
-    'deployment_status': 'deployment of {deployement[ref]} to '
-                         '{deployment[environment]} '
-                         '{deployment_status[state]} in '
-                         '{repository[full_name]}',
-    'fork': '{forkee[owner][login]} forked {forkee[name]}',
-    'gollum': '{sender[login]} edited wiki pages in {repository[full_name]}',
-    'issue_comment': '{sender[login]} commented on issue #{issue[number]} '
-                     'in {repository[full_name]}',
-    'issues': '{sender[login]} {action} issue #{issue[number]} in '
-              '{repository[full_name]}',
-    'member': '{sender[login]} {action} member {member[login]} in '
-              '{repository[full_name]}',
-    'membership': '{sender[login]} {action} member {member[login]} to team '
-                  '{team[name]} in {repository[full_name]}',
-    'page_build': '{sender[login]} built pages in {repository[full_name]}',
-    'ping': 'ping from {sender[login]}',
-    'public': '{sender[login]} publicized {repository[full_name]}',
-    'pull_request': '{sender[login]} {action} pull #{pull_request[number]} in '
-                    '{repository[full_name]}',
-    'pull_request_review': '{sender[login]} {action} {review[state]} '
-                           'review on pull #{pull_request[number]} in '
-                           '{repository[full_name]}',
-    'pull_request_review_comment': '{comment[user][login]} {action} comment '
-                                   'on pull #{pull_request[number]} in '
-                                   '{repository[full_name]}',
-    'push': '{pusher[name]} pushed {ref} in {repository[full_name]}',
-    'release': '{release[author][login]} {action} {release[tag_name]} in '
-               '{repository[full_name]}',
-    'repository': '{sender[login]} {action} repository '
-                  '{repository[full_name]}',
-    'status': '{sender[login]} set {sha} status to {state} in '
-              '{repository[full_name]}',
-    'team_add': '{sender[login]} added repository {repository[full_name]} to '
-                'team {team[name]}',
-    'watch': '{sender[login]} {action} watch in repository '
-             '{repository[full_name]}'
+    "commit_comment": "{comment[user][login]} commented on " "{comment[commit_id]} in {repository[full_name]}",
+    "create": "{sender[login]} created {ref_type} ({ref}) in " "{repository[full_name]}",
+    "delete": "{sender[login]} deleted {ref_type} ({ref}) in " "{repository[full_name]}",
+    "deployment": "{sender[login]} deployed {deployment[ref]} to "
+    "{deployment[environment]} in {repository[full_name]}",
+    "deployment_status": "deployment of {deployement[ref]} to "
+    "{deployment[environment]} "
+    "{deployment_status[state]} in "
+    "{repository[full_name]}",
+    "fork": "{forkee[owner][login]} forked {forkee[name]}",
+    "gollum": "{sender[login]} edited wiki pages in {repository[full_name]}",
+    "issue_comment": "{sender[login]} commented on issue #{issue[number]} " "in {repository[full_name]}",
+    "issues": "{sender[login]} {action} issue #{issue[number]} in " "{repository[full_name]}",
+    "member": "{sender[login]} {action} member {member[login]} in " "{repository[full_name]}",
+    "membership": "{sender[login]} {action} member {member[login]} to team " "{team[name]} in {repository[full_name]}",
+    "page_build": "{sender[login]} built pages in {repository[full_name]}",
+    "ping": "ping from {sender[login]}",
+    "public": "{sender[login]} publicized {repository[full_name]}",
+    "pull_request": "{sender[login]} {action} pull #{pull_request[number]} in " "{repository[full_name]}",
+    "pull_request_review": "{sender[login]} {action} {review[state]} "
+    "review on pull #{pull_request[number]} in "
+    "{repository[full_name]}",
+    "pull_request_review_comment": "{comment[user][login]} {action} comment "
+    "on pull #{pull_request[number]} in "
+    "{repository[full_name]}",
+    "push": "{pusher[name]} pushed {ref} in {repository[full_name]}",
+    "release": "{release[author][login]} {action} {release[tag_name]} in " "{repository[full_name]}",
+    "repository": "{sender[login]} {action} repository " "{repository[full_name]}",
+    "status": "{sender[login]} set {sha} status to {state} in " "{repository[full_name]}",
+    "team_add": "{sender[login]} added repository {repository[full_name]} to " "team {team[name]}",
+    "watch": "{sender[login]} {action} watch in repository " "{repository[full_name]}",
 }
 
 
@@ -138,6 +121,7 @@ def _format_event(event_type, data):
     except KeyError:
         return event_type
 
+
 # -----------------------------------------------------------------------------
 # Copyright 2015 Bloomberg Finance L.P.
 #
diff --git a/setup.py b/setup.py
@@ -1,28 +1,29 @@
 from setuptools import setup
 
-setup(name="github-webhook",
-      version="1.0.2",
-      description="Very simple, but powerful, microframework for writing Github webhooks in Python",
-      url="https://github.com/bloomberg/python-github-webhook",
-      author="Alex Chamberlain, Fred Phillips, Daniel Kiss, Daniel Beer",
-      author_email="achamberlai9@bloomberg.net, fphillips7@bloomberg.net, dkiss1@bloomberg.net, dbeer1@bloomberg.net",
-      license='Apache 2.0',
-      packages=["github_webhook"],
-      install_requires=['flask', 'six'],
-      tests_require=['mock', 'pytest'],
-
-      classifiers=[
-          'Development Status :: 4 - Beta',
-          'Framework :: Flask',
-          'Environment :: Web Environment',
-          'Intended Audience :: Developers',
-          'Intended Audience :: System Administrators',
-          'License :: OSI Approved :: Apache Software License',
-          'Operating System :: MacOS :: MacOS X',
-          'Operating System :: Microsoft :: Windows',
-          'Operating System :: POSIX',
-          'Programming Language :: Python :: 2',
-          'Programming Language :: Python :: 3',
-          'Topic :: Software Development :: Version Control'
-          ],
-      test_suite='nose.collector')
+setup(
+    name="github-webhook",
+    version="1.0.2",
+    description="Very simple, but powerful, microframework for writing Github webhooks in Python",
+    url="https://github.com/bloomberg/python-github-webhook",
+    author="Alex Chamberlain, Fred Phillips, Daniel Kiss, Daniel Beer",
+    author_email="achamberlai9@bloomberg.net, fphillips7@bloomberg.net, dkiss1@bloomberg.net, dbeer1@bloomberg.net",
+    license="Apache 2.0",
+    packages=["github_webhook"],
+    install_requires=["flask", "six"],
+    tests_require=["mock", "pytest"],
+    classifiers=[
+        "Development Status :: 4 - Beta",
+        "Framework :: Flask",
+        "Environment :: Web Environment",
+        "Intended Audience :: Developers",
+        "Intended Audience :: System Administrators",
+        "License :: OSI Approved :: Apache Software License",
+        "Operating System :: MacOS :: MacOS X",
+        "Operating System :: Microsoft :: Windows",
+        "Operating System :: POSIX",
+        "Programming Language :: Python :: 2",
+        "Programming Language :: Python :: 3",
+        "Topic :: Software Development :: Version Control",
+    ],
+    test_suite="nose.collector",
+)
diff --git a/tests/test_webhook.py b/tests/test_webhook.py
@@ -4,6 +4,7 @@
 
 import pytest
 import werkzeug
+
 try:
     from unittest import mock
 except ImportError:
@@ -15,9 +16,7 @@
 @pytest.fixture
 def mock_request():
     with mock.patch("github_webhook.webhook.request") as req:
-        req.headers = {
-            "X-Github-Delivery": ""
-        }
+        req.headers = {"X-Github-Delivery": ""}
         yield req
 
 
@@ -53,10 +52,8 @@ def test_constructor():
 
     # THEN
     app.add_url_rule.assert_called_once_with(
-        endpoint='/postreceive',
-        rule='/postreceive',
-        view_func=webhook._postreceive,
-        methods=['POST'])
+        endpoint="/postreceive", rule="/postreceive", view_func=webhook._postreceive, methods=["POST"]
+    )
 
 
 def test_run_push_hook(webhook, handler, push_request):
@@ -83,10 +80,7 @@ def test_can_handle_zero_events(webhook, push_request):
     webhook._postreceive()  # noop
 
 
-@pytest.mark.parametrize("secret", [
-    u"secret",
-    b"secret"
-])
+@pytest.mark.parametrize("secret", [u"secret", b"secret"])
 @mock.patch("github_webhook.webhook.hmac")
 def test_calls_if_signature_is_correct(mock_hmac, app, push_request, secret):
     # GIVEN
diff --git a/tox.ini b/tox.ini
@@ -1,5 +1,5 @@
 [tox]
-envlist = py27,py36,pypy,pypy3,flake8
+envlist = py27,py36,py37,pypy,pypy3,flake8
 
 [testenv]
 deps =
