black and isort

edoburu · Nov 16, 2021 · aa40748 · aa40748
1 parent b285fa3
commit aa40748
Show file tree

Hide file tree

Showing 7 changed files with 71 additions and 89 deletions.
diff --git a/debugtools/formatter.py b/debugtools/formatter.py
@@ -53,9 +53,7 @@
     RuntimeError,
 )
 
-RE_SQL_NL = re.compile(
-    r"\b(FROM|LEFT OUTER|RIGHT|LEFT|INNER|OUTER|WHERE|ORDER BY|GROUP BY)\b"
-)
+RE_SQL_NL = re.compile(r"\b(FROM|LEFT OUTER|RIGHT|LEFT|INNER|OUTER|WHERE|ORDER BY|GROUP BY)\b")
 RE_SQL = re.compile(
     r"\b(SELECT|UPDATE|DELETE"
     r"|COUNT|AVG|MAX|MIN|CASE"
@@ -171,9 +169,7 @@ def _style_text(text):
         r"\g<1><small>&lt;<var>generator, use 'for' to traverse it</var>&gt;</small>",
         text,
     )
-    text = RE_OBJECT_ADDRESS.sub(
-        r"\g<1><small>&lt;<var>\g<2> object</var>&gt;</small>", text
-    )
+    text = RE_OBJECT_ADDRESS.sub(r"\g<1><small>&lt;<var>\g<2> object</var>&gt;</small>", text)
     text = RE_MANAGER.sub(
         r"\g<1><small>&lt;<var>manager, use <kbd>.all</kbd> to traverse it</var>&gt;</small>",
         text,
@@ -254,13 +250,9 @@ def _format_object(object):
                 del attrs[name]
         elif hasattr(value, "__get__"):
             # fetched the descriptor, e.g. django.db.models.fields.related.ForeignRelatedObjectsDescriptor
-            attrs[name] = value = _try_call(
-                lambda: getattr(object, name), return_exceptions=True
-            )
+            attrs[name] = value = _try_call(lambda: getattr(object, name), return_exceptions=True)
             if isinstance(value, Manager):
-                attrs[name] = LiteralStr(
-                    f"<{value.__class__.__name__} manager>"
-                )
+                attrs[name] = LiteralStr(f"<{value.__class__.__name__} manager>")
             elif isinstance(value, AttributeError):
                 del attrs[name]  # e.g. Manager isn't accessible via Model instances.
             elif isinstance(value, HANDLED_EXCEPTIONS):
@@ -436,8 +428,6 @@ def _format(self, object, stream, indent, allowance, context, level):
         Recursive part of the formatting
         """
         try:
-            PrettyPrinter._format(
-                self, object, stream, indent, allowance, context, level
-            )
+            PrettyPrinter._format(self, object, stream, indent, allowance, context, level)
         except Exception as e:
             stream.write(_format_exception(e))
diff --git a/debugtools/middleware/xviewmiddleware.py b/debugtools/middleware/xviewmiddleware.py
@@ -1,10 +1,6 @@
 import django
 
-from debugtools.utils.xview import (
-    get_used_template,
-    get_used_view_name,
-    track_view_name,
-)
+from debugtools.utils.xview import get_used_template, get_used_view_name, track_view_name
 
 if django.VERSION >= (1, 10):
     from django.utils.deprecation import MiddlewareMixin

diff --git a/debugtools/panels/view.py b/debugtools/panels/view.py
@@ -1,10 +1,10 @@
+from debug_toolbar.panels import Panel
 from django.db.models import Model
 from django.forms import BaseForm
 from django.forms.models import BaseFormSet
 from django.utils.translation import gettext_lazy as _
 from django.views.generic import View
 
-from debug_toolbar.panels import Panel
 from debugtools.utils.xview import get_used_template, get_view_name
 
 
@@ -40,9 +40,7 @@ def process_response(self, request, response):
             {
                 "view_module": self.view_module,
                 "view_name": self.view_name,
-                "view_data": self._get_view_data(context_data)
-                if context_data
-                else None,
+                "view_data": self._get_view_data(context_data) if context_data else None,
                 "template": template,
                 "template_choices": choices,
             }

diff --git a/debugtools/templatetags/debugtools_tags.py b/debugtools/templatetags/debugtools_tags.py
@@ -33,7 +33,9 @@
 
 PRE_ALERT_STYLE = """clear: both; font-family: Menlo,Monaco,"Courier new",monospace; color: #C09853; background-color: #FCF8E3; border: 1px solid #FBEED5; border-radius: 4px 4px 4px 4px; font-size: 12.025px; text-align: left; line-height: 18px; margin-bottom: 18px; padding: 8px 35px 8px 14px; text-shadow: 0 1px 0 rgba(255, 255, 255, 0.5); white-space: pre-wrap; word-break: normal; word-wrap: normal;"""  # different word-wrap then Twitter Bootstrap
 
-CONTEXT_TITLE = '<h6 style="color: #999999; font-size: 11px; margin: 9px 0;">TEMPLATE CONTEXT SCOPE:</h6>\n'
+CONTEXT_TITLE = (
+    '<h6 style="color: #999999; font-size: 11px; margin: 9px 0;">TEMPLATE CONTEXT SCOPE:</h6>\n'
+)
 
 CONTEXT_BLOCK = (
     "<pre style='{style}; position: relative;'>"
@@ -45,9 +47,7 @@
 
 ERROR_TYPE_BLOCK = "<pre style='{style}'>{error}</pre>"
 
-OBJECT_TYPE_BLOCK = (
-    "<pre style='{style}'>{name} = <small>{type}</small>:\n{value}</pre>"
-)
+OBJECT_TYPE_BLOCK = "<pre style='{style}'>{name} = <small>{type}</small>:\n{value}</pre>"
 
 
 register = Library()
@@ -84,9 +84,7 @@ def print_context(self, context):
             if len(context_scope) <= 3 and dump1.count("<br />") > 20:
                 (dump1, dump2) = (dump2, dump1)
 
-            text.append(
-                CONTEXT_BLOCK.format(style=PRE_STYLE, num=i, dump1=dump1, dump2=dump2)
-            )
+            text.append(CONTEXT_BLOCK.format(style=PRE_STYLE, num=i, dump1=dump1, dump2=dump2))
         return "".join(text)
 
     def print_variables(self, context):
@@ -101,9 +99,7 @@ def print_variables(self, context):
                 if isinstance(expr.var, Variable):
                     data = expr.var.resolve(context)
                 else:
-                    data = expr.resolve(
-                        context
-                    )  # could return TEMPLATE_STRING_IF_INVALID
+                    data = expr.resolve(context)  # could return TEMPLATE_STRING_IF_INVALID
             except VariableDoesNotExist as e:
                 # Failed to resolve, display exception inline
                 keys = []
@@ -124,9 +120,7 @@ def print_variables(self, context):
 
             # At top level, prefix class name if it's a longer result
             if isinstance(data, SHORT_NAME_TYPES):
-                text.append(
-                    BASIC_TYPE_BLOCK.format(style=PRE_STYLE, name=name, value=textdata)
-                )
+                text.append(BASIC_TYPE_BLOCK.format(style=PRE_STYLE, name=name, value=textdata))
             else:
                 text.append(
                     OBJECT_TYPE_BLOCK.format(
@@ -158,6 +152,4 @@ def format_sql(sql):
 
 
 def _format_exception(exception):
-    return '<span style="color: #B94A48;">{}</span>'.format(
-        escape(f"<{exception}>")
-    )
+    return '<span style="color: #B94A48;">{}</span>'.format(escape(f"<{exception}>"))
diff --git a/debugtools/utils/xview.py b/debugtools/utils/xview.py
@@ -59,11 +59,7 @@ def get_used_template(response):
     else:
         # Template object.
         filename = _get_template_filename(template)
-        template_name = (
-            f"<template object from {filename}>"
-            if filename
-            else "<template object>"
-        )
+        template_name = f"<template object from {filename}>" if filename else "<template object>"
         return template_name, None
 
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,14 @@
+[tool.isort]
+profile = "black"
+line_length = 99
+
+[tool.black]
+line-length = 99
+exclude = '''
+/(
+    \.git
+  | \.venv
+  | \.tox
+  | dist
+)/
+'''
diff --git a/setup.py b/setup.py
@@ -1,15 +1,16 @@
 #!/usr/bin/env python
-from setuptools import setup, find_packages
-from os import path
 import codecs
 import os
 import re
 import sys
+from os import path
+
+from setuptools import find_packages, setup
 
 
 def read(*parts):
     file_path = path.join(path.dirname(__file__), *parts)
-    return codecs.open(file_path, encoding='utf-8').read()
+    return codecs.open(file_path, encoding="utf-8").read()
 
 
 def find_version(*parts):
@@ -21,48 +22,43 @@ def find_version(*parts):
 
 
 setup(
-    name='django-debugtools',
-    version=find_version('debugtools', '__init__.py'),
-    license='Apache 2.0',
-
-    description='A toolbox of small utilities to assist Django development',
-    long_description=read('README.rst'),
-
-    author='Diederik van der Boor',
-    author_email='[email protected]',
-
-    url='https://github.com/edoburu/django-debugtools',
-    download_url='https://github.com/edoburu/django-debugtools/zipball/master',
-
-    packages=find_packages(exclude=('example*',)),
+    name="django-debugtools",
+    version=find_version("debugtools", "__init__.py"),
+    license="Apache 2.0",
+    description="A toolbox of small utilities to assist Django development",
+    long_description=read("README.rst"),
+    author="Diederik van der Boor",
+    author_email="[email protected]",
+    url="https://github.com/edoburu/django-debugtools",
+    download_url="https://github.com/edoburu/django-debugtools/zipball/master",
+    packages=find_packages(exclude=("example*",)),
     include_package_data=True,
-
     zip_safe=False,
     classifiers=[
-        'Development Status :: 5 - Production/Stable',
-        'Environment :: Web Environment',
-        'Intended Audience :: Developers',
-        'License :: OSI Approved :: Apache Software License',
-        'Operating System :: OS Independent',
-        'Programming Language :: Python',
-        'Programming Language :: Python :: 2',
-        'Programming Language :: Python :: 2.6',
-        'Programming Language :: Python :: 2.7',
-        'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.3',
-        'Programming Language :: Python :: 3.4',
-        'Programming Language :: Python :: 3.5',
-        'Programming Language :: Python :: 3.6',
-        'Framework :: Django',
-        'Framework :: Django :: 1.4',
-        'Framework :: Django :: 1.5',
-        'Framework :: Django :: 1.6',
-        'Framework :: Django :: 1.7',
-        'Framework :: Django :: 1.8',
-        'Framework :: Django :: 1.9',
-        'Framework :: Django :: 1.10',
-        'Framework :: Django :: 1.11',
-        'Framework :: Django :: 2.0',
-        'Topic :: Software Development :: Debuggers',
-    ]
+        "Development Status :: 5 - Production/Stable",
+        "Environment :: Web Environment",
+        "Intended Audience :: Developers",
+        "License :: OSI Approved :: Apache Software License",
+        "Operating System :: OS Independent",
+        "Programming Language :: Python",
+        "Programming Language :: Python :: 2",
+        "Programming Language :: Python :: 2.6",
+        "Programming Language :: Python :: 2.7",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.3",
+        "Programming Language :: Python :: 3.4",
+        "Programming Language :: Python :: 3.5",
+        "Programming Language :: Python :: 3.6",
+        "Framework :: Django",
+        "Framework :: Django :: 1.4",
+        "Framework :: Django :: 1.5",
+        "Framework :: Django :: 1.6",
+        "Framework :: Django :: 1.7",
+        "Framework :: Django :: 1.8",
+        "Framework :: Django :: 1.9",
+        "Framework :: Django :: 1.10",
+        "Framework :: Django :: 1.11",
+        "Framework :: Django :: 2.0",
+        "Topic :: Software Development :: Debuggers",
+    ],
 )