Add black code linter

Author: codingjoe

.fussyfox.yml

@@ -1,4 +1,5 @@
 - bandit
+- black
 - flake8
 - pydocstyle
 - isort

s3file/__init__.py

@@ -1 +1 @@
-default_app_config = 's3file.apps.S3FileConfig'
+default_app_config = "s3file.apps.S3FileConfig"

s3file/apps.py

@@ -5,8 +5,8 @@
 
 
 class S3FileConfig(AppConfig):
-    name = 's3file'
-    verbose_name = 'S3File'
+    name = "s3file"
+    verbose_name = "S3File"
 
     def ready(self):
         from django import forms
@@ -15,14 +15,18 @@ def ready(self):
 
         from .forms import S3FileInputMixin
 
-        if isinstance(default_storage, (S3Boto3Storage, FileSystemStorage)) and \
-                S3FileInputMixin not in forms.ClearableFileInput.__bases__:
-            forms.ClearableFileInput.__bases__ = \
-                (S3FileInputMixin,) + forms.ClearableFileInput.__bases__
+        if (
+            isinstance(default_storage, (S3Boto3Storage, FileSystemStorage))
+            and S3FileInputMixin not in forms.ClearableFileInput.__bases__
+        ):
+            forms.ClearableFileInput.__bases__ = (
+                S3FileInputMixin,
+            ) + forms.ClearableFileInput.__bases__
 
         elif S3FileInputMixin in forms.ClearableFileInput.__bases__:
             forms.ClearableFileInput.__bases__ = tuple(
-                cls for cls in forms.ClearableFileInput.__bases__
+                cls
+                for cls in forms.ClearableFileInput.__bases__
                 if cls is not S3FileInputMixin
             )
 

s3file/checks.py

@@ -6,9 +6,9 @@ def storage_check(app_configs, **kwargs):
     if isinstance(default_storage, FileSystemStorage):
         return [
             Error(
-                'FileSystemStorage should not be used in a production environment.',
-                hint='Please verify your DEFAULT_FILE_STORAGE setting.',
-                id='s3file.E001',
+                "FileSystemStorage should not be used in a production environment.",
+                hint="Please verify your DEFAULT_FILE_STORAGE setting.",
+                id="s3file.E001",
             )
         ]
     return []

s3file/forms.py

@@ -9,16 +9,16 @@
 
 from s3file.storages import storage
 
-logger = logging.getLogger('s3file')
+logger = logging.getLogger("s3file")
 
 
 class S3FileInputMixin:
     """FileInput that uses JavaScript to directly upload to Amazon S3."""
 
     needs_multipart_form = False
-    upload_path = str(getattr(
-        settings, 'S3FILE_UPLOAD_PATH', pathlib.PurePosixPath('tmp', 's3file')
-    ))
+    upload_path = str(
+        getattr(settings, "S3FILE_UPLOAD_PATH", pathlib.PurePosixPath("tmp", "s3file"))
+    )
     upload_path = safe_join(str(storage.location), upload_path)
     expires = settings.SESSION_COOKIE_AGE
 
@@ -33,25 +33,24 @@ def client(self):
     def build_attrs(self, *args, **kwargs):
         attrs = super().build_attrs(*args, **kwargs)
 
-        accept = attrs.get('accept')
+        accept = attrs.get("accept")
         response = self.client.generate_presigned_post(
             self.bucket_name,
-            str(pathlib.PurePosixPath(self.upload_folder, '${filename}')),
+            str(pathlib.PurePosixPath(self.upload_folder, "${filename}")),
             Conditions=self.get_conditions(accept),
             ExpiresIn=self.expires,
         )
 
         defaults = {
-            'data-fields-%s' % key: value
-            for key, value in response['fields'].items()
+            "data-fields-%s" % key: value for key, value in response["fields"].items()
         }
-        defaults['data-url'] = response['url']
+        defaults["data-url"] = response["url"]
         defaults.update(attrs)
 
         try:
-            defaults['class'] += ' s3file'
+            defaults["class"] += " s3file"
         except KeyError:
-            defaults['class'] = 's3file'
+            defaults["class"] = "s3file"
         return defaults
 
     def get_conditions(self, accept):
@@ -60,9 +59,9 @@ def get_conditions(self, accept):
             ["starts-with", "$key", str(self.upload_folder)],
             {"success_action_status": "201"},
         ]
-        if accept and ',' not in accept:
-            top_type, sub_type = accept.split('/', 1)
-            if sub_type == '*':
+        if accept and "," not in accept:
+            top_type, sub_type = accept.split("/", 1)
+            if sub_type == "*":
                 conditions.append(["starts-with", "$Content-Type", "%s/" % top_type])
             else:
                 conditions.append({"Content-Type": accept})
@@ -73,14 +72,14 @@ def get_conditions(self, accept):
 
     @cached_property
     def upload_folder(self):
-        return str(pathlib.PurePosixPath(
-            self.upload_path,
-            base64.urlsafe_b64encode(
-                uuid.uuid4().bytes
-            ).decode('utf-8').rstrip('=\n'),
-        ))  # S3 uses POSIX paths
+        return str(
+            pathlib.PurePosixPath(
+                self.upload_path,
+                base64.urlsafe_b64encode(uuid.uuid4().bytes)
+                .decode("utf-8")
+                .rstrip("=\n"),
+            )
+        )  # S3 uses POSIX paths
 
     class Media:
-        js = (
-            's3file/js/s3file.js' if settings.DEBUG else 's3file/js/s3file.min.js',
-        )
+        js = ("s3file/js/s3file.js" if settings.DEBUG else "s3file/js/s3file.min.js",)

s3file/middleware.py

@@ -6,21 +6,20 @@
 
 from . import views
 
-logger = logging.getLogger('s3file')
+logger = logging.getLogger("s3file")
 
 
 class S3FileMiddleware:
-
     def __init__(self, get_response):
         self.get_response = get_response
 
     def __call__(self, request):
-        file_fields = json.loads(request.POST.get('s3file', '[]'))
+        file_fields = json.loads(request.POST.get("s3file", "[]"))
         for field_name in file_fields:
-            paths = json.loads(request.POST.get(field_name, '[]'))
+            paths = json.loads(request.POST.get(field_name, "[]"))
             request.FILES.setlist(field_name, list(self.get_files_from_storage(paths)))
 
-        if local_dev and request.path == '/__s3_mock__/':
+        if local_dev and request.path == "/__s3_mock__/":
             return views.S3MockView.as_view()(request)
 
         return self.get_response(request)
@@ -30,7 +29,7 @@ def get_files_from_storage(paths):
         """Return S3 file where the name does not include the path."""
         for path in paths:
             if storage.location:
-                path = path.replace(os.path.dirname(storage.location) + '/', '', 1)
+                path = path.replace(os.path.dirname(storage.location) + "/", "", 1)
             try:
                 f = storage.open(path)
                 f.name = os.path.basename(path)

s3file/storages.py

@@ -12,7 +12,7 @@
 class S3MockStorage(FileSystemStorage):
     @property
     def location(self):
-        return getattr(settings, 'AWS_LOCATION', '')
+        return getattr(settings, "AWS_LOCATION", "")
 
     def path(self, name):
         return safe_join(os.path.abspath(self.base_location), self.location, name)
@@ -24,34 +24,32 @@ class client:
                 def generate_presigned_post(bucket_name, key, **policy):
                     policy = json.dumps(policy).encode()
                     policy_b64 = base64.b64encode(policy).decode()
-                    date = datetime.datetime.utcnow().strftime('%Y%m%dT%H%M%SZ')
+                    date = datetime.datetime.utcnow().strftime("%Y%m%dT%H%M%SZ")
                     aws_id = getattr(
-                        settings, 'AWS_ACCESS_KEY_ID',
-                        'AWS_ACCESS_KEY_ID',
+                        settings,
+                        "AWS_ACCESS_KEY_ID",
+                        "AWS_ACCESS_KEY_ID",
                     )
                     fields = {
-                        'x-amz-algorithm': 'AWS4-HMAC-SHA256',
-                        'x-amz-date': date,
-                        'x-amz-credential': aws_id,
-                        'policy': policy_b64,
-                        'key': key,
+                        "x-amz-algorithm": "AWS4-HMAC-SHA256",
+                        "x-amz-date": date,
+                        "x-amz-credential": aws_id,
+                        "policy": policy_b64,
+                        "key": key,
                     }
                     signature = hmac.new(
                         settings.SECRET_KEY.encode(),
                         policy + date.encode(),
-                        'sha256',
+                        "sha256",
                     ).digest()
                     signature = base64.b64encode(signature).decode()
                     return {
-                        'url': '/__s3_mock__/',
-                        'fields': {
-                            'x-amz-signature': signature,
-                            **fields
-                        },
+                        "url": "/__s3_mock__/",
+                        "fields": {"x-amz-signature": signature, **fields},
                     }
 
     class bucket:
-        name = 'test-bucket'
+        name = "test-bucket"
 
 
 local_dev = isinstance(default_storage, FileSystemStorage)

s3file/views.py

@@ -8,51 +8,48 @@
 from django.core.files.storage import default_storage
 from django.views import generic
 
-logger = logging.getLogger('s3file')
+logger = logging.getLogger("s3file")
 
 
 class S3MockView(generic.View):
-
     def post(self, request):
-        success_action_status = request.POST.get('success_action_status', 201)
+        success_action_status = request.POST.get("success_action_status", 201)
         try:
-            file = request.FILES['file']
-            key = request.POST['key']
-            date = request.POST['x-amz-date']
-            signature = request.POST['x-amz-signature']
-            policy = request.POST['policy']
+            file = request.FILES["file"]
+            key = request.POST["key"]
+            date = request.POST["x-amz-date"]
+            signature = request.POST["x-amz-signature"]
+            policy = request.POST["policy"]
         except KeyError:
-            logger.exception('bad request')
+            logger.exception("bad request")
             return http.HttpResponseBadRequest()
 
         try:
             signature = base64.b64decode(signature.encode())
             policy = base64.b64decode(policy.encode())
 
             calc_sign = hmac.new(
-                settings.SECRET_KEY.encode(),
-                policy + date.encode(),
-                'sha256'
+                settings.SECRET_KEY.encode(), policy + date.encode(), "sha256"
             ).digest()
         except ValueError:
-            logger.exception('bad request')
+            logger.exception("bad request")
             return http.HttpResponseBadRequest()
 
         if not hmac.compare_digest(signature, calc_sign):
-            logger.warning('bad signature')
+            logger.warning("bad signature")
             return http.HttpResponseForbidden()
 
-        key = key.replace('${filename}', file.name)
+        key = key.replace("${filename}", file.name)
         etag = hashlib.md5(file.read()).hexdigest()  # nosec
         file.seek(0)
         key = default_storage.save(key, file)
         return http.HttpResponse(
-            "<?xml version=\"1.0\" encoding=\"UTF-8\"?>"
+            '<?xml version="1.0" encoding="UTF-8"?>'
             "<PostResponse>"
             f"<Location>{settings.MEDIA_URL}{key}</Location>"
             f"<Bucket>{getattr(settings, 'AWS_STORAGE_BUCKET_NAME')}</Bucket>"
             f"<Key>{key}</Key>"
-            f"<ETag>\"{etag}\"</ETag>"
+            f'<ETag>"{etag}"</ETag>'
             "</PostResponse>",
             status=success_action_status,
         )

setup.cfg

@@ -64,20 +64,10 @@ test = pytest
 addopts = --cov=s3file --cov-report xml --tb=short -rxs
 DJANGO_SETTINGS_MODULE=tests.testapp.settings
 
-[tox:tox]
-envlist = py{36,37}-dj{111,22,master}
-
-[testenv]
-deps=
-    dj111: https://github.com/django/django/archive/stable/1.11.x.tar.gz#egg=django
-    dj22: https://github.com/django/django/archive/stable/2.2.x.tar.gz#egg=django
-    djmaster: https://github.com/django/django/archive/master.tar.gz#egg=django
-commands=
-    python setup.py test
-
 [flake8]
 max-line-length=88
-exclude = venv,.tox,.eggs
+select = C,E,F,W,B,B950
+ignore = E203, E501, W503, E731
 
 [pydocstyle]
 add_ignore = D1

setup.py

@@ -1,4 +1,4 @@
 #!/usr/bin/env python
 from setuptools import setup
 
-setup(name='django-s3file', use_scm_version=True)
+setup(name="django-s3file", use_scm_version=True)

tests/conftest.py

@@ -8,7 +8,7 @@
 from selenium.common.exceptions import WebDriverException
 
 
-@pytest.yield_fixture(scope='session')
+@pytest.yield_fixture(scope="session")
 def driver():
     chrome_options = webdriver.ChromeOptions()
     chrome_options.headless = True
@@ -24,26 +24,26 @@ def driver():
 @pytest.fixture
 def upload_file(request):
     path = tempfile.mkdtemp()
-    file_name = os.path.join(path, '%s.txt' % request.node.name)
-    with open(file_name, 'w') as f:
+    file_name = os.path.join(path, "%s.txt" % request.node.name)
+    with open(file_name, "w") as f:
         f.write(request.node.name)
     return file_name
 
 
 @pytest.fixture
 def another_upload_file(request):
     path = tempfile.mkdtemp()
-    file_name = os.path.join(path, 'another_%s.txt' % request.node.name)
-    with open(file_name, 'w') as f:
+    file_name = os.path.join(path, "another_%s.txt" % request.node.name)
+    with open(file_name, "w") as f:
         f.write(request.node.name)
     return file_name
 
 
 @pytest.fixture
 def yet_another_upload_file(request):
     path = tempfile.mkdtemp()
-    file_name = os.path.join(path, 'yet_another_%s.txt' % request.node.name)
-    with open(file_name, 'w') as f:
+    file_name = os.path.join(path, "yet_another_%s.txt" % request.node.name)
+    with open(file_name, "w") as f:
         f.write(request.node.name)
     return file_name
 
@@ -53,5 +53,5 @@ def filemodel(request, db):
     from tests.testapp.models import FileModel
 
     return FileModel.objects.create(
-        file=ContentFile(request.node.name, '%s.txt' % request.node.name)
+        file=ContentFile(request.node.name, "%s.txt" % request.node.name)
     )

tests/test_apps.py

@@ -8,9 +8,9 @@
 
 class TestS3FileConfig:
     def test_ready(self, settings):
-        app = S3FileConfig('s3file', importlib.import_module('tests.testapp'))
+        app = S3FileConfig("s3file", importlib.import_module("tests.testapp"))
         app.ready()
         assert not isinstance(forms.ClearableFileInput(), S3FileInputMixin)
-        settings.DEFAULT_FILE_STORAGE = 'storages.backends.s3boto3.S3Boto3Storage'
+        settings.DEFAULT_FILE_STORAGE = "storages.backends.s3boto3.S3Boto3Storage"
         app.ready()
         assert isinstance(forms.ClearableFileInput(), S3FileInputMixin)