style: ruff format

Author: nedbat

django_coverage_plugin/plugin.py

@@ -17,6 +17,7 @@
 
 class DjangoTemplatePluginException(Exception):
     """Used for any errors from the plugin itself."""
+
     pass
 
 
@@ -42,6 +43,7 @@ def check_debug():
     # I _think_ this check is all that's needed and the 3 "hasattr" checks
     # below can be removed, but it's not clear how to verify that
     from django.apps import apps
+
     if not apps.ready:
         return False
 
@@ -58,13 +60,9 @@ def check_debug():
 
     for engine in django.template.engines.all():
         if not isinstance(engine, django.template.backends.django.DjangoTemplates):
-            raise DjangoTemplatePluginException(
-                "Can't use non-Django templates."
-            )
+            raise DjangoTemplatePluginException("Can't use non-Django templates.")
         if not engine.engine.debug:
-            raise DjangoTemplatePluginException(
-                "Template debugging must be enabled in settings."
-            )
+            raise DjangoTemplatePluginException("Template debugging must be enabled in settings.")
 
     return True
 
@@ -112,16 +110,15 @@ class DjangoTemplatePlugin(
     coverage.plugin.CoveragePlugin,
     coverage.plugin.FileTracer,
 ):
-
     def __init__(self, options):
         extensions = options.get("template_extensions", "html,htm,txt")
         self.extensions = [e.strip() for e in extensions.split(",")]
 
         self.debug_checked = False
 
-        self.django_template_dir = os.path.normcase(os.path.realpath(
-            os.path.dirname(django.template.__file__)
-        ))
+        self.django_template_dir = os.path.normcase(
+            os.path.realpath(os.path.dirname(django.template.__file__))
+        )
 
         self.source_map = {}
 
@@ -130,11 +127,10 @@ def __init__(self, options):
     def sys_info(self):
         return [
             ("django_template_dir", self.django_template_dir),
-            ("environment", sorted(
-                ("{} = {}".format(k, v))
-                for k, v in os.environ.items()
-                if "DJANGO" in k
-            )),
+            (
+                "environment",
+                sorted(("{} = {}".format(k, v)) for k, v in os.environ.items() if "DJANGO" in k),
+            ),
         ]
 
     def configure(self, config):
@@ -159,7 +155,7 @@ def find_executable_files(self, src_dir):
         # funny characters that probably mean they are editor junk.
         rx = r"^[^.#~!$@%^&*()+=,]+\.(" + "|".join(self.extensions) + r")$"
 
-        for (dirpath, dirnames, filenames) in os.walk(src_dir):
+        for dirpath, dirnames, filenames in os.walk(src_dir):
             if dirpath == self.html_report_dir:
                 # Don't confuse the HTML report with HTML templates.
                 continue
@@ -196,7 +192,7 @@ def line_number_range(self, frame):
         if 0:
             dump_frame(frame, label="line_number_range")
 
-        render_self = frame.f_locals['self']
+        render_self = frame.f_locals["self"]
         if isinstance(render_self, (NodeList, Template)):
             return -1, -1
 
@@ -226,13 +222,11 @@ def line_number_range(self, frame):
         filename = filename_for_frame(frame)
         line_map = self.get_line_map(filename)
         start = get_line_number(line_map, s_start)
-        end = get_line_number(line_map, s_end-1)
+        end = get_line_number(line_map, s_end - 1)
         if start < 0 or end < 0:
             start, end = -1, -1
         if SHOW_TRACING:
-            print("line_number_range({}) -> {}".format(
-                filename, (start, end)
-            ))
+            print("line_number_range({}) -> {}".format(filename, (start, end)))
         return start, end
 
     # --- FileTracer helpers
@@ -251,9 +245,9 @@ def get_line_map(self, filename):
         """
         if filename not in self.source_map:
             template_source = read_template_source(filename)
-            if 0:   # change to see the template text
+            if 0:  # change to see the template text
                 for i in range(0, len(template_source), 10):
-                    print("%3d: %r" % (i, template_source[i:i+10]))
+                    print("%3d: %r" % (i, template_source[i : i + 10]))
             self.source_map[filename] = make_line_map(template_source)
         return self.source_map[filename]
 
@@ -292,7 +286,8 @@ def lines(self):
         for token in tokens:
             if SHOW_PARSING:
                 print(
-                    "%10s %2d: %r" % (
+                    "%10s %2d: %r"
+                    % (
                         token.token_type.capitalize(),
                         token.lineno,
                         token.contents,
@@ -352,11 +347,9 @@ def lines(self):
                 # When a tag is not at the start of a line, the preceding
                 # TEXT token ends with whitespace and no newline.
                 # That partial line is not executable content.
-                if num_lines > 0 and (
-                    lines[-1].isspace() and not lines[-1].endswith(("\n", "\r"))
-                ):
+                if num_lines > 0 and (lines[-1].isspace() and not lines[-1].endswith(("\n", "\r"))):
                     num_lines -= 1
-                source_lines.update(range(lineno, lineno+num_lines))
+                source_lines.update(range(lineno, lineno + num_lines))
 
             if SHOW_PARSING:
                 print(f"\t\t\tNow source_lines is: {source_lines!r}")
@@ -388,19 +381,21 @@ def get_line_number(line_map, offset):
 def dump_frame(frame, label=""):
     """Dump interesting information about this frame."""
     locals = dict(frame.f_locals)
-    self = locals.get('self', None)
-    context = locals.get('context', None)
+    self = locals.get("self", None)
+    context = locals.get("context", None)
     if "__builtins__" in locals:
         del locals["__builtins__"]
 
     if label:
         label = " ( %s ) " % label
     print("-- frame --%s---------------------" % label)
-    print("{}:{}:{}".format(
-        os.path.basename(frame.f_code.co_filename),
-        frame.f_lineno,
-        type(self),
-        ))
+    print(
+        "{}:{}:{}".format(
+            os.path.basename(frame.f_code.co_filename),
+            frame.f_lineno,
+            type(self),
+        )
+    )
     print(locals)
     if self:
         print("self:", self.__dict__)

pyproject.toml

@@ -62,3 +62,7 @@ filterwarnings = [
 fragment_directory = "scriv.d"
 output_file = "README.rst"
 rst_header_chars = "-."
+
+[tool.ruff]
+target-version = "py310"  # Can't use [project]
+line-length = 100

tests/__init__.py

@@ -17,5 +17,5 @@ def index(request):
 
 
 urlpatterns = [
-    re_path(r'^home$', index, name='index'),
+    re_path(r"^home$", index, name="index"),
 ]

tests/conftest.py

@@ -28,7 +28,7 @@ def set_warnings():
         "ignore",
         category=UserWarning,
         message=r"Overriding setting DATABASES can lead to unexpected behavior.",
-        )
+    )
 
     # Django has warnings like RemovedInDjango40Warning.  We use features that are going to be
     # deprecated, so we don't need to see those warnings. But the specific warning classes change

tests/plugin_test.py

@@ -23,34 +23,36 @@
 def get_test_settings():
     """Create a dict full of default Django settings for the tests."""
     the_settings = {
-        'CACHES': {
-            'default': {
-                'BACKEND': 'django.core.cache.backends.locmem.LocMemCache',
+        "CACHES": {
+            "default": {
+                "BACKEND": "django.core.cache.backends.locmem.LocMemCache",
             },
         },
-        'DATABASES': {
-            'default': {
-                'ENGINE': 'django.db.backends.sqlite3',
-                'NAME': ':memory:',
+        "DATABASES": {
+            "default": {
+                "ENGINE": "django.db.backends.sqlite3",
+                "NAME": ":memory:",
             }
         },
-        'ROOT_URLCONF': 'tests',
+        "ROOT_URLCONF": "tests",
     }
 
-    the_settings.update({
-        'TEMPLATES': [
-            {
-                'BACKEND': 'django.template.backends.django.DjangoTemplates',
-                'DIRS': ['templates'],      # where the tests put things.
-                'OPTIONS': {
-                    'debug': True,
-                    'loaders': [
-                        'django.template.loaders.filesystem.Loader',
-                    ]
+    the_settings.update(
+        {
+            "TEMPLATES": [
+                {
+                    "BACKEND": "django.template.backends.django.DjangoTemplates",
+                    "DIRS": ["templates"],  # where the tests put things.
+                    "OPTIONS": {
+                        "debug": True,
+                        "loaders": [
+                            "django.template.loaders.filesystem.Loader",
+                        ],
+                    },
                 },
-            },
-        ],
-    })
+            ],
+        }
+    )
 
     return the_settings
 
@@ -85,9 +87,7 @@ def make_template(self, text, name=None):
         template_path = self._path(self.template_file)
         return os.path.abspath(self.make_file(template_path, text))
 
-    def run_django_coverage(
-        self, name=None, text=None, context=None, options=None, using=None
-    ):
+    def run_django_coverage(self, name=None, text=None, context=None, options=None, using=None):
         """Run a template under coverage.
 
         The data context is `context` if provided, else {}.
@@ -105,10 +105,11 @@ def run_django_coverage(
         use_real_context = False
 
         if options is None:
-            options = {'source': ["."]}
+            options = {"source": ["."]}
 
         if using:
             from django.template import engines
+
             engine = engines[using]
             if text is not None:
                 tem = engine.from_string(text)
@@ -134,7 +135,7 @@ def run_django_coverage(
         self.cov.stop()
         self.cov.save()
         # Warning! Accessing secret internals!
-        if hasattr(self.cov, 'plugins'):
+        if hasattr(self.cov, "plugins"):
             plugins = self.cov.plugins
         else:
             plugins = self.cov._plugins
@@ -191,14 +192,16 @@ def assert_analysis(self, executable, missing=None, name=None):
             executable,
             actual_executable,
             "Executable lines aren't as expected: {!r} != {!r}".format(
-                executable, actual_executable,
+                executable,
+                actual_executable,
             ),
         )
         self.assertEqual(
             missing or [],
             actual_missing,
             "Missing lines aren't as expected: {!r} != {!r}".format(
-                missing, actual_missing,
+                missing,
+                actual_missing,
             ),
         )
 
@@ -239,6 +242,7 @@ def assert_coverage_warnings(self, *msgs, min_cov=None):
             return
         elif coverage.version_info >= (6, 0):
             import coverage.exceptions as cov_exc
+
             ctxmgr = self.assertWarns(cov_exc.CoverageWarning)
         else:
             ctxmgr = contextlib.nullcontext()
@@ -280,4 +284,5 @@ def squashed(s):
 
 class PluginDisabled(Exception):
     """Raised if we find that our plugin has been disabled."""
+
     pass

tests/test_engines.py

@@ -13,40 +13,40 @@ def setUp(self):
         super().setUp()
 
         engine = {
-            'NAME': 'other',
-            'BACKEND': 'django.template.backends.django.DjangoTemplates',
-            'DIRS': ['templates2'],         # where the tests put things.
-            'OPTIONS': {
-                'debug': True,
+            "NAME": "other",
+            "BACKEND": "django.template.backends.django.DjangoTemplates",
+            "DIRS": ["templates2"],  # where the tests put things.
+            "OPTIONS": {
+                "debug": True,
             },
         }
-        modified_settings = modify_settings(TEMPLATES={'append': [engine]})
+        modified_settings = modify_settings(TEMPLATES={"append": [engine]})
         modified_settings.enable()
         self.addCleanup(modified_settings.disable)
 
-        self.template_directory = 'templates2'
+        self.template_directory = "templates2"
 
     def test_file_template(self):
-        self.make_template('Hello')
-        text = self.run_django_coverage(using='other')
-        self.assertEqual(text, 'Hello')
+        self.make_template("Hello")
+        text = self.run_django_coverage(using="other")
+        self.assertEqual(text, "Hello")
         self.assert_analysis([1])
 
     def test_string_template(self):
         with self.assert_no_data():
-            text = self.run_django_coverage(text='Hello', using='other')
-        self.assertEqual(text, 'Hello')
+            text = self.run_django_coverage(text="Hello", using="other")
+        self.assertEqual(text, "Hello")
 
     def test_third_engine_not_debug(self):
         engine3 = {
-            'NAME': 'notdebug',
-            'BACKEND': 'django.template.backends.django.DjangoTemplates',
-            'DIRS': ['templates3'],         # where the tests put things.
+            "NAME": "notdebug",
+            "BACKEND": "django.template.backends.django.DjangoTemplates",
+            "DIRS": ["templates3"],  # where the tests put things.
         }
-        modified_settings = modify_settings(TEMPLATES={'append': [engine3]})
+        modified_settings = modify_settings(TEMPLATES={"append": [engine3]})
         modified_settings.enable()
         self.addCleanup(modified_settings.disable)
 
-        self.make_template('Hello')
+        self.make_template("Hello")
         with self.assert_plugin_disabled("Template debugging must be enabled in settings."):
             self.run_django_coverage()