Fix linting and apply black and isort.

Author: jezdez

.isort.cfg

@@ -0,0 +1,6 @@
+[settings]
+multi_line_output=3
+include_trailing_comma=True
+force_grid_wrap=0
+use_parentheses=True
+line_length=88

MANIFEST.in

@@ -1,6 +1,6 @@
 recursive-include docs *
 recursive-include tests *
-include pytest.ini AUTHORS.rst LICENSE README.rst tox.ini .coveragerc
+include pytest.ini AUTHORS.rst CODE_OF_CONDUCT.md pyproject.toml LICENSE README.rst tox.ini .coveragerc
 prune docs/_build
 prune *.pyc
 prune __pycache__

docs/conf.py

@@ -18,6 +18,7 @@
 #
 import os
 import sys
+
 from pkg_resources import get_distribution
 
 sys.path.insert(0, os.path.abspath(".."))

pytest.ini

@@ -1,6 +1,6 @@
 [pytest]
 DJANGO_SETTINGS_MODULE = tests.settings
 norecursedirs = .git .*
-addopts = -rsxX --showlocals --tb=native --nomigrations --cov=dockerflow --cov-report xml --cov-report term --cov-report html
+addopts = -rsxX --showlocals --tb=native --nomigrations --cov=dockerflow --cov-report xml --cov-report term --cov-report html --black --isort
 django_find_project = false
 python_paths = .

setup.py

@@ -1,6 +1,7 @@
 import codecs
 import os
-from setuptools import setup, find_packages
+
+from setuptools import find_packages, setup
 
 
 def read(*parts):
@@ -17,6 +18,7 @@ def read(*parts):
     package_dir={"": "src"},
     description="Python tools and helpers for Mozilla's Dockerflow",
     long_description=read("README.rst"),
+    long_description_content_type="text/x-rst",
     author="Mozilla Foundation",
     author_email="[email protected]",
     url="https://github.com/mozilla-services/python-dockerflow",

src/dockerflow/checks/__init__.py

@@ -2,17 +2,17 @@
 # License, v. 2.0. If a copy of the MPL was not distributed with this
 # file, you can obtain one at http://mozilla.org/MPL/2.0/.
 from .messages import (  # noqa
+    CRITICAL,
     DEBUG,
-    INFO,
-    WARNING,
     ERROR,
-    CRITICAL,
+    INFO,
     STATUSES,
-    level_to_text,
+    WARNING,
     CheckMessage,
+    Critical,
     Debug,
+    Error,
     Info,
     Warning,
-    Error,
-    Critical,
+    level_to_text,
 )

src/dockerflow/django/middleware.py

@@ -5,12 +5,13 @@
 
 from django import VERSION
 
+from . import views
+
 try:
     from django.utils.deprecation import MiddlewareMixin
 except ImportError:  # pragma: no cover
     MiddlewareMixin = object
 
-from . import views
 
 # Computed once, reused in every request
 _less_than_django_1_10 = VERSION < (1, 10)

src/dockerflow/django/views.py

@@ -9,7 +9,6 @@
 from .checks import level_to_text
 from .signals import heartbeat_failed, heartbeat_passed
 
-
 version_callback = getattr(
     settings, "DOCKERFLOW_VERSION_CALLBACK", "dockerflow.version.get_version"
 )

src/dockerflow/flask/app.py

@@ -2,8 +2,8 @@
 # License, v. 2.0. If a copy of the MPL was not distributed with this
 # file, you can obtain one at http://mozilla.org/MPL/2.0/.
 import functools
-import os
 import logging
+import os
 import time
 import uuid
 from collections import OrderedDict
@@ -19,6 +19,10 @@
 )
 from werkzeug.exceptions import InternalServerError
 
+from .. import version
+from . import checks
+from .signals import heartbeat_failed, heartbeat_passed
+
 try:
     from flask_login import current_user
 except ImportError:  # pragma: nocover
@@ -34,11 +38,6 @@ class UserLoadingError(Exception):
         pass
 
 
-from .. import version
-from . import checks
-from .signals import heartbeat_passed, heartbeat_failed
-
-
 class HeartbeatFailure(InternalServerError):
     pass
 

src/dockerflow/flask/checks/__init__.py

@@ -6,19 +6,19 @@
 """
 from ... import health
 from ...checks import (  # noqa
+    CRITICAL,
     DEBUG,
-    INFO,
-    WARNING,
     ERROR,
-    CRITICAL,
+    INFO,
     STATUSES,
-    level_to_text,
+    WARNING,
     CheckMessage,
+    Critical,
     Debug,
+    Error,
     Info,
     Warning,
-    Error,
-    Critical,
+    level_to_text,
 )
 
 

src/dockerflow/flask/checks/messages.py

@@ -5,9 +5,10 @@
 This exposes dockerflow.checks.messages as dockerflow.flask.checks.messages
 for backwards compatibility
 """
-from ...checks.messages import *  # noqa
 import warnings
 
+from ...checks.messages import *  # noqa
+
 warnings.warn(
     "dockerflow.flask.checks.messages has moved to dockerflow.checks.messages",
     PendingDeprecationWarning,

src/dockerflow/logging.py

@@ -2,6 +2,7 @@
 # License, v. 2.0. If a copy of the MPL was not distributed with this
 # file, you can obtain one at http://mozilla.org/MPL/2.0/.
 from __future__ import absolute_import
+
 import json
 import logging
 import socket
@@ -86,7 +87,7 @@ def is_value_jsonlike(self, value):
         """
         Return True if the value looks like JSON. Use only on strings.
         """
-        return value.startswith('{') and value.endswith('}')
+        return value.startswith("{") and value.endswith("}")
 
     def convert_record(self, record):
         """
@@ -97,15 +98,15 @@ def convert_record(self, record):
         * to - https://wiki.mozilla.org/Firefox/Services/Logging
         """
         out = {
-            'Timestamp': int(record.created * 1e9),
-            'Type': record.name,
-            'Logger': self.logger_name,
-            'Hostname': self.hostname,
-            'EnvVersion': self.LOGGING_FORMAT_VERSION,
-            'Severity': self.SYSLOG_LEVEL_MAP.get(
+            "Timestamp": int(record.created * 1e9),
+            "Type": record.name,
+            "Logger": self.logger_name,
+            "Hostname": self.hostname,
+            "EnvVersion": self.LOGGING_FORMAT_VERSION,
+            "Severity": self.SYSLOG_LEVEL_MAP.get(
                 record.levelno, self.DEFAULT_SYSLOG_LEVEL
             ),
-            'Pid': record.process,
+            "Pid": record.process,
         }
 
         # Include any custom attributes set on the record.

src/dockerflow/sanic/checks.py

@@ -6,19 +6,19 @@
 """
 from .. import health
 from ..checks import (  # noqa
+    CRITICAL,
     DEBUG,
-    INFO,
-    WARNING,
     ERROR,
-    CRITICAL,
+    INFO,
     STATUSES,
-    level_to_text,
+    WARNING,
     CheckMessage,
+    Critical,
     Debug,
+    Error,
     Info,
     Warning,
-    Error,
-    Critical,
+    level_to_text,
 )
 
 

tests/migrations/env.py

@@ -1,8 +1,11 @@
 from __future__ import with_statement
-from alembic import context
-from sqlalchemy import engine_from_config, pool
-from logging.config import fileConfig
+
 import logging
+from logging.config import fileConfig
+
+from alembic import context  # no:qa
+from flask import current_app  # noqa
+from sqlalchemy import engine_from_config, pool
 
 # this is the Alembic Config object, which provides
 # access to the values within the .ini file in use.
@@ -13,11 +16,6 @@
 fileConfig(config.config_file_name)
 logger = logging.getLogger("alembic.env")
 
-# add your model's MetaData object here
-# for 'autogenerate' support
-# from myapp import mymodel
-# target_metadata = mymodel.Base.metadata
-from flask import current_app  # noqa
 
 config.set_main_option(
     "sqlalchemy.url", current_app.config.get("SQLALCHEMY_DATABASE_URI")

tests/test_django.py

@@ -1,20 +1,20 @@
 # This Source Code Form is subject to the terms of the Mozilla Public
 # License, v. 2.0. If a copy of the MPL was not distributed with this
 # file, you can obtain one at http://mozilla.org/MPL/2.0/.
-import logging
 import json
+import logging
+
+import pytest
 import redis
 from django import VERSION as django_version
 from django.core.checks.registry import registry
 from django.core.exceptions import ImproperlyConfigured
 from django.db import connection
 from django.db.utils import OperationalError, ProgrammingError
 from django.test.utils import CaptureQueriesContext
-
 from dockerflow import health
 from dockerflow.django import checks
 from dockerflow.django.middleware import DockerflowMiddleware
-import pytest
 
 
 @pytest.fixture

tests/test_flask.py

@@ -1,21 +1,21 @@
 # This Source Code Form is subject to the terms of the Mozilla Public
 # License, v. 2.0. If a copy of the MPL was not distributed with this
 # file, you can obtain one at http://mozilla.org/MPL/2.0/.
-import logging
 import json
+import logging
 import os
-import redis
 
 import pytest
+import redis
+from dockerflow import health
+from dockerflow.flask import Dockerflow, checks
 from fakeredis import FakeStrictRedis
-from flask import Flask, g, request, Response, has_request_context
-from flask_migrate import Migrate
-from flask_login import LoginManager, login_user, current_user
+from flask import Flask, Response, g, has_request_context, request
+from flask_login import LoginManager, current_user, login_user
 from flask_login.mixins import UserMixin
+from flask_migrate import Migrate
 from flask_redis import FlaskRedis
 from flask_sqlalchemy import SQLAlchemy, get_debug_queries
-from dockerflow import health
-from dockerflow.flask import checks, Dockerflow
 from sqlalchemy.exc import DBAPIError, SQLAlchemyError
 
 
@@ -425,5 +425,7 @@ def test_check_redis_connected_ping_check(mocker, redis_store):
 
 
 def test_checks_imports():
-    from dockerflow.flask.checks import level_to_text
-    from dockerflow.flask.checks.messages import level_to_text
+    from dockerflow.flask.checks import level_to_text as a
+    from dockerflow.flask.checks.messages import level_to_text as b
+
+    assert a == b

tests/test_logging.py

@@ -8,7 +8,6 @@
 import textwrap
 
 import jsonschema
-
 from dockerflow.logging import JsonLogFormatter
 
 logger_name = "tests"

tests/test_sanic.py

@@ -5,15 +5,14 @@
 import logging
 import socket
 
-from sanic import Sanic, response
-from sanic_redis import SanicRedis
 import aioredis
 import pytest
 import sanic.testing
 import sanic_redis.core
-
 from dockerflow import health
 from dockerflow.sanic import Dockerflow, checks
+from sanic import Sanic, response
+from sanic_redis import SanicRedis
 
 
 class FakeRedis:
@@ -168,7 +167,6 @@ async def warning_check2():
 
     _, response = test_client.get("/__heartbeat__")
     assert response.status == 500
-    print (response.body)
     payload = response.json
     assert payload["status"] == "error"
     details = payload["details"]
@@ -181,7 +179,6 @@ def test_redis_check(dockerflow_redis, mocker, test_client):
     assert "check_redis_connected" in dockerflow_redis.checks
     mocker.patch.object(sanic_redis.core, "create_redis_pool", fake_redis)
     _, response = test_client.get("/__heartbeat__")
-    print (response)
     assert response.status == 200
     assert response.json["status"] == "ok"
 

tests/test_version.py

@@ -2,6 +2,7 @@
 # License, v. 2.0. If a copy of the MPL was not distributed with this
 # file, you can obtain one at http://mozilla.org/MPL/2.0/.
 import json
+
 from dockerflow.version import get_version
 
 

tox.ini

@@ -36,10 +36,12 @@ commands =
     tests: pytest {posargs:tests}
     docs: sphinx-build -b html -d {envtmpdir}/doctrees docs {envtmpdir}/html
 
-[testenv:lint]
+[testenv:py36-lint]
 basepython = python3.6
 deps =
     flake8
+    flake8-black
+    flake8-isort
     twine
     check-manifest
 commands =