Merge pull request #44 from dabapps/linting-formatting

Linting and formatting

.github/workflows/ci.yml

@@ -28,8 +28,8 @@ jobs:
     - name: Install package
       run: pip install -e .
     - name: Install dependencies
-      run: pip install -U django==${{ matrix.django }} black djangorestframework pytz
+      run: pip install -r dev-requirements.txt
+    - name: Install Django
+      run: pip install -U django==${{ matrix.django }}
     - name: Run tests
-      run: python manage.py test
-    - name: Run black
-      run: black --check zen_queries
+      run: ./runtests

.isort.cfg

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

dev-requirements.txt

@@ -0,0 +1,4 @@
+black==22.6.0
+djangorestframework==3.13.1
+flake8==4.0.1
+isort==5.10.1

format

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+set -e
+
+black zen_queries
+isort zen_queries

runtests

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+set -e
+
+black --check zen_queries
+flake8 zen_queries
+isort --check --diff zen_queries
+python manage.py test --noinput $@

setup.cfg

@@ -0,0 +1,2 @@
+[flake8]
+extend_ignore=E128,E501,W503

zen_queries/__init__.py

@@ -1,11 +1,21 @@
 from zen_queries.decorators import (
-    queries_disabled,
     queries_dangerously_enabled,
+    queries_disabled,
     QueriesDisabledError,
 )
 from zen_queries.render import render
-from zen_queries.template_response import TemplateResponse, SimpleTemplateResponse
+from zen_queries.template_response import SimpleTemplateResponse, TemplateResponse
 from zen_queries.utils import fetch
 
-
 __version__ = "2.1.0"
+
+
+__all__ = [
+    "queries_disabled",
+    "queries_dangerously_enabled",
+    "QueriesDisabledError",
+    "render",
+    "TemplateResponse",
+    "SimpleTemplateResponse",
+    "fetch",
+]

zen_queries/rest_framework.py

@@ -1,6 +1,6 @@
+from django.db.models import QuerySet
 from zen_queries import queries_disabled
 from zen_queries.utils import fetch
-from django.db.models import QuerySet
 
 
 class QueriesDisabledSerializerMixin:

zen_queries/template_response.py

@@ -1,7 +1,7 @@
 from django.template.response import (
     SimpleTemplateResponse as DjangoSimpleTemplateResponse,
-    TemplateResponse as DjangoTemplateResponse,
 )
+from django.template.response import TemplateResponse as DjangoTemplateResponse
 from zen_queries import queries_disabled
 
 

zen_queries/templatetags/zen_queries.py

@@ -1,6 +1,6 @@
 from django.template import Library, Node
-import zen_queries
 
+import zen_queries
 
 register = Library()
 

zen_queries/tests/tests.py

@@ -1,9 +1,10 @@
 from django.shortcuts import render as django_render
 from django.test import TestCase
+from rest_framework import serializers
 from zen_queries import (
     fetch,
-    queries_disabled,
     queries_dangerously_enabled,
+    queries_disabled,
     QueriesDisabledError,
     render,
     SimpleTemplateResponse,
@@ -15,7 +16,6 @@
     QueriesDisabledViewMixin,
 )
 from zen_queries.tests.models import Widget
-from rest_framework import serializers
 
 
 class ContextManagerTestCase(TestCase):
@@ -90,7 +90,7 @@ class RenderShortcutTestCase(TestCase):
     def test_render(self):
         widgets = Widget.objects.all()
         with self.assertRaises(QueriesDisabledError):
-            response = render(None, "template.html", {"widgets": widgets})
+            render(None, "template.html", {"widgets": widgets})
 
 
 class TemplateResponseTestCase(TestCase):