Appease the isort gods

Author: adamalton

cspreports/models.py

@@ -1,35 +1,37 @@
 # STANDARD LIB
 import json
 
+# Third party
+from django.apps import apps
 from django.core.exceptions import ValidationError, ImproperlyConfigured
 from django.db import models
 from django.utils.html import escape
 from django.utils.safestring import mark_safe
-from django.apps import apps
 
+# CSP Reports
 from cspreports.conf import app_settings
 
 DISPOSITIONS = (
-    ('enforce', 'enforce'),
-    ('report', 'report'),
+    ("enforce", "enforce"),
+    ("report", "report"),
 )
 
 # Map of required CSP report fields to model fields
 REQUIRED_FIELDS = (
-    ('document-uri', 'document_uri'),
-    ('referrer', 'referrer'),
-    ('blocked-uri', 'blocked_uri'),
-    ('violated-directive', 'violated_directive'),
-    ('original-policy', 'original_policy'),
+    ("document-uri", "document_uri"),
+    ("referrer", "referrer"),
+    ("blocked-uri", "blocked_uri"),
+    ("violated-directive", "violated_directive"),
+    ("original-policy", "original_policy"),
 )
 # Map of optional (CSP >= 2.0) CSP report fields to model fields
 OPTIONAL_FIELDS = (
-    ('disposition', 'disposition'),
-    ('effective-directive', 'effective_directive'),
-    ('source-file', 'source_file'),
-    ('status-code', 'status_code'),
-    ('line-number', 'line_number'),
-    ('column-number', 'column_number'),
+    ("disposition", "disposition"),
+    ("effective-directive", "effective_directive"),
+    ("source-file", "source_file"),
+    ("status-code", "status_code"),
+    ("line-number", "line_number"),
+    ("column-number", "column_number"),
 )
 
 
@@ -63,7 +65,7 @@ class CSPReportBase(models.Model):
     """
 
     class Meta:
-        ordering = ('-created',)
+        ordering = ("-created",)
         abstract = True
 
     created = models.DateTimeField(auto_now_add=True)
@@ -88,14 +90,14 @@ class Meta:
     def nice_report(self):
         """Return a nicely formatted original report."""
         if not self.json:
-            return '[no CSP report data]'
+            return "[no CSP report data]"
         try:
             data = json.loads(self.json)
         except ValueError:
             return "Invalid CSP report: '{}'".format(self.json)
-        if 'csp-report' not in data:
-            return 'Invalid CSP report: ' + json.dumps(data, indent=4, sort_keys=True, separators=(',', ': '))
-        return json.dumps(data['csp-report'], indent=4, sort_keys=True, separators=(',', ': '))
+        if "csp-report" not in data:
+            return "Invalid CSP report: " + json.dumps(data, indent=4, sort_keys=True, separators=(",", ": "))
+        return json.dumps(data["csp-report"], indent=4, sort_keys=True, separators=(",", ": "))
 
     def __str__(self):
         return self.nice_report
@@ -116,7 +118,7 @@ def from_message(cls, message):
             # Message is not a valid JSON. Return as invalid.
             return self
         try:
-            report_data = decoded_data['csp-report']
+            report_data = decoded_data["csp-report"]
         except KeyError:
             # Message is not a valid CSP report. Return as invalid.
             return self
@@ -159,15 +161,15 @@ def from_message(cls, message):
 
     @property
     def data(self):
-        """ Returns self.json loaded as a python object. """
+        """Returns self.json loaded as a python object."""
         try:
             data = self._data
         except AttributeError:
             data = self._data = json.loads(self.json)
         return data
 
     def json_as_html(self):
-        """ Print out self.json in a nice way. """
+        """Print out self.json in a nice way."""
 
         # To avoid circular import
         from cspreports import utils
@@ -185,11 +187,6 @@ def get_report_model():
     try:
         return apps.get_model(model_string, require_ready=False)
     except ValueError:
-        raise ImproperlyConfigured(
-            "CSP_REPORTS_MODEL must be of the form 'app_label.model_name'"
-        )
+        raise ImproperlyConfigured("CSP_REPORTS_MODEL must be of the form 'app_label.model_name'")
     except LookupError:
-        raise ImproperlyConfigured(
-            "CSP_REPORTS_MODEL refers to model '%s' that has not been installed"
-            % model_string
-        )
+        raise ImproperlyConfigured("CSP_REPORTS_MODEL refers to model '%s' that has not been installed" % model_string)

cspreports/summary.py

@@ -1,20 +1,20 @@
 """Collect summary of CSP reports."""
+
 from operator import attrgetter
 from urllib.parse import urlsplit, urlunsplit
 
 from django.template.loader import get_template
 
 from cspreports.models import get_report_model
 
-
 CSPReport = get_report_model()
 DEFAULT_TOP = 10
 
 
 def get_root_uri(uri):
     """Return root URI - strip query and fragment."""
     chunks = urlsplit(uri)
-    return urlunsplit((chunks.scheme, chunks.netloc, chunks.path, '', ''))
+    return urlunsplit((chunks.scheme, chunks.netloc, chunks.path, "", ""))
 
 
 class ViolationInfo:
@@ -72,7 +72,7 @@ def __init__(self, since, to, top=DEFAULT_TOP):
 
     def render(self):
         """Render the summary."""
-        template = get_template('cspreports/summary.txt')
+        template = get_template("cspreports/summary.txt")
         return template.render(self.__dict__)
 
 
@@ -95,15 +95,15 @@ def collect(since, to, top=DEFAULT_TOP):
         root_uri = get_root_uri(report.document_uri)
         info = sources.setdefault(root_uri, ViolationInfo(root_uri))
         info.append(report)
-    summary.sources = sorted(sources.values(), key=attrgetter('count'), reverse=True)[:top]
+    summary.sources = sorted(sources.values(), key=attrgetter("count"), reverse=True)[:top]
 
     # Collect blocks
     blocks = {}
     for report in valid_queryset:
         root_uri = get_root_uri(report.blocked_uri)
         info = blocks.setdefault(root_uri, ViolationInfo(root_uri))
         info.append(report)
-    summary.blocks = sorted(blocks.values(), key=attrgetter('count'), reverse=True)[:top]
+    summary.blocks = sorted(blocks.values(), key=attrgetter("count"), reverse=True)[:top]
 
     # Collect invalid reports
     summary.invalid_count = invalid_queryset.count()

cspreports/tests/test_custom_model.py

@@ -1,10 +1,9 @@
 from django.conf import settings
 from django.core.exceptions import ImproperlyConfigured
 from django.test import TestCase, override_settings
-from django.test.signals import setting_changed
 
-from cspreports.models import get_report_model
 from cspreports.conf import app_settings
+from cspreports.models import get_report_model
 from cspreports.tests.models import CustomCSPReport
 
 

cspreports/utils.py

@@ -8,16 +8,16 @@
 from django.utils.dateparse import parse_date
 from django.utils.timezone import localtime, make_aware, now
 
-from cspreports.models import get_report_model
 from cspreports.conf import app_settings
+from cspreports.models import get_report_model
 
 CSPReport = get_report_model()
 
 logger = logging.getLogger(app_settings.LOGGER_NAME)
 
 
 def process_report(request):
-    """ Given the HTTP request of a CSP violation report, log it in the required ways. """
+    """Given the HTTP request of a CSP violation report, log it in the required ways."""
     if not should_process_report(request):
         return
     if app_settings.EMAIL_ADMINS:
@@ -31,21 +31,21 @@ def process_report(request):
 
 
 def format_report(jsn):
-    """ Given a JSON report, return a nicely formatted (i.e. with indentation) string.
-        This should handle invalid JSON (as the JSON comes from the browser/user).
-        We trust that Python's json library is secure, but if the JSON is invalid then we still
-        want to be able to display it, rather than tripping up on a ValueError.
+    """Given a JSON report, return a nicely formatted (i.e. with indentation) string.
+    This should handle invalid JSON (as the JSON comes from the browser/user).
+    We trust that Python's json library is secure, but if the JSON is invalid then we still
+    want to be able to display it, rather than tripping up on a ValueError.
     """
     if isinstance(jsn, bytes):
-        jsn = jsn.decode('utf-8')
+        jsn = jsn.decode("utf-8")
     try:
-        return json.dumps(json.loads(jsn), indent=4, sort_keys=True, separators=(',', ': '))
+        return json.dumps(json.loads(jsn), indent=4, sort_keys=True, separators=(",", ": "))
     except ValueError:
         return "Invalid JSON. Raw dump is below.\n\n" + jsn
 
 
 def email_admins(request):
-    user_agent = request.META.get('HTTP_USER_AGENT', '')
+    user_agent = request.META.get("HTTP_USER_AGENT", "")
     report = format_report(request.body)
     message = "User agent:\n%s\n\nReport:\n%s" % (user_agent, report)
     mail_admins("CSP Violation Report", message)
@@ -62,7 +62,7 @@ def save_report(request):
         message = message.decode(request.encoding or settings.DEFAULT_CHARSET)
 
     report = CSPReport.from_message(message)
-    report.user_agent = request.META.get('HTTP_USER_AGENT', '')
+    report.user_agent = request.META.get("HTTP_USER_AGENT", "")
     report.save()
 
 
@@ -76,7 +76,7 @@ def run_additional_handlers(request):
 
 
 def get_additional_handlers():
-    """ Returns the actual functions from the dotted paths specified in ADDITIONAL_HANDLERS. """
+    """Returns the actual functions from the dotted paths specified in ADDITIONAL_HANDLERS."""
     global _additional_handlers
     if not isinstance(_additional_handlers, list):
         handlers = []
@@ -119,7 +119,7 @@ def get_midnight():
 
 
 def import_from_dotted_path(name):
-    module_name, function_name = name.rsplit('.', 1)
+    module_name, function_name = name.rsplit(".", 1)
     return getattr(import_module(module_name), function_name)