Merge pull request #149 from asherf/pytest

Avoid single letter variables.

Author: asherf

django_prometheus/tests/end2end/testapp/test_db.py

@@ -64,14 +64,18 @@ def testCounters(self):
         )
 
     def testExecuteMany(self):
-        r = self.saveRegistry()
+        registry = self.saveRegistry()
         cursor_db1 = connections["test_db_1"].cursor()
         cursor_db1.executemany(
             "INSERT INTO testapp_lawn(location) VALUES (?)",
             [("Paris",), ("New York",), ("Berlin",), ("San Francisco",)],
         )
         self.assertMetricDiff(
-            r, 4, "django_db_execute_many_total", alias="test_db_1", vendor="sqlite"
+            registry,
+            4,
+            "django_db_execute_many_total",
+            alias="test_db_1",
+            vendor="sqlite",
         )
 
 
@@ -89,14 +93,14 @@ class TestPostgresDbMetrics(BaseDbMetricTest):
     """
 
     def testCounters(self):
-        r = self.saveRegistry()
+        registry = self.saveRegistry()
         cursor = connections["postgresql"].cursor()
 
         for _ in range(20):
             cursor.execute("SELECT 1")
 
         self.assertMetricCompare(
-            r,
+            registry,
             lambda a, b: a + 20 <= b < a + 25,
             "django_db_execute_total",
             alias="postgresql",
@@ -116,14 +120,14 @@ class TestMysDbMetrics(BaseDbMetricTest):
     """
 
     def testCounters(self):
-        r = self.saveRegistry()
+        registry = self.saveRegistry()
         cursor = connections["mysql"].cursor()
 
         for _ in range(20):
             cursor.execute("SELECT 1")
 
         self.assertMetricCompare(
-            r,
+            registry,
             lambda a, b: a + 20 <= b < a + 25,
             "django_db_execute_total",
             alias="mysql",

django_prometheus/tests/end2end/testapp/test_middleware.py

@@ -30,35 +30,37 @@ class TestMiddlewareMetrics(PrometheusTestCaseMixin, SimpleTestCase):
     """
 
     def test_request_counters(self):
-        r = self.saveRegistry()
+        registry = self.saveRegistry()
         self.client.get("/")
         self.client.get("/")
         self.client.get("/help")
         self.client.post("/", {"test": "data"})
 
-        self.assertMetricDiff(r, 4, M("requests_before_middlewares_total"))
-        self.assertMetricDiff(r, 4, M("responses_before_middlewares_total"))
-        self.assertMetricDiff(r, 3, T("requests_total_by_method"), method="GET")
-        self.assertMetricDiff(r, 1, T("requests_total_by_method"), method="POST")
-        self.assertMetricDiff(r, 4, T("requests_total_by_transport"), transport="http")
+        self.assertMetricDiff(registry, 4, M("requests_before_middlewares_total"))
+        self.assertMetricDiff(registry, 4, M("responses_before_middlewares_total"))
+        self.assertMetricDiff(registry, 3, T("requests_total_by_method"), method="GET")
+        self.assertMetricDiff(registry, 1, T("requests_total_by_method"), method="POST")
         self.assertMetricDiff(
-            r,
+            registry, 4, T("requests_total_by_transport"), transport="http"
+        )
+        self.assertMetricDiff(
+            registry,
             2,
             T("requests_total_by_view_transport_method"),
             view="testapp.views.index",
             transport="http",
             method="GET",
         )
         self.assertMetricDiff(
-            r,
+            registry,
             1,
             T("requests_total_by_view_transport_method"),
             view="testapp.views.help",
             transport="http",
             method="GET",
         )
         self.assertMetricDiff(
-            r,
+            registry,
             1,
             T("requests_total_by_view_transport_method"),
             view="testapp.views.index",
@@ -68,42 +70,54 @@ def test_request_counters(self):
         # We have 3 requests with no post body, and one with a few
         # bytes, but buckets are cumulative so that is 4 requests with
         # <=128 bytes bodies.
-        self.assertMetricDiff(r, 3, M("requests_body_total_bytes_bucket"), le="0.0")
-        self.assertMetricDiff(r, 4, M("requests_body_total_bytes_bucket"), le="128.0")
+        self.assertMetricDiff(
+            registry, 3, M("requests_body_total_bytes_bucket"), le="0.0"
+        )
+        self.assertMetricDiff(
+            registry, 4, M("requests_body_total_bytes_bucket"), le="128.0"
+        )
         self.assertMetricEquals(
             None, M("responses_total_by_templatename"), templatename="help.html"
         )
         self.assertMetricDiff(
-            r, 3, T("responses_total_by_templatename"), templatename="index.html"
+            registry, 3, T("responses_total_by_templatename"), templatename="index.html"
+        )
+        self.assertMetricDiff(registry, 4, T("responses_total_by_status"), status="200")
+        self.assertMetricDiff(
+            registry, 0, M("responses_body_total_bytes_bucket"), le="0.0"
         )
-        self.assertMetricDiff(r, 4, T("responses_total_by_status"), status="200")
-        self.assertMetricDiff(r, 0, M("responses_body_total_bytes_bucket"), le="0.0")
-        self.assertMetricDiff(r, 3, M("responses_body_total_bytes_bucket"), le="128.0")
-        self.assertMetricDiff(r, 4, M("responses_body_total_bytes_bucket"), le="8192.0")
-        self.assertMetricDiff(r, 4, T("responses_total_by_charset"), charset="utf-8")
-        self.assertMetricDiff(r, 0, M("responses_streaming_total"))
+        self.assertMetricDiff(
+            registry, 3, M("responses_body_total_bytes_bucket"), le="128.0"
+        )
+        self.assertMetricDiff(
+            registry, 4, M("responses_body_total_bytes_bucket"), le="8192.0"
+        )
+        self.assertMetricDiff(
+            registry, 4, T("responses_total_by_charset"), charset="utf-8"
+        )
+        self.assertMetricDiff(registry, 0, M("responses_streaming_total"))
 
     def test_latency_histograms(self):
         # Caution: this test is timing-based. This is not ideal. It
         # runs slowly (each request to /slow takes at least .1 seconds
         # to complete) and it may be flaky when run on very slow
         # systems.
 
-        r = self.saveRegistry()
+        registry = self.saveRegistry()
 
         # This always takes more than .1 second, so checking the lower
         # buckets is fine.
         self.client.get("/slow")
         self.assertMetricDiff(
-            r,
+            registry,
             0,
             M("requests_latency_seconds_by_view_method_bucket"),
             le="0.05",
             view="slow",
             method="GET",
         )
         self.assertMetricDiff(
-            r,
+            registry,
             1,
             M("requests_latency_seconds_by_view_method_bucket"),
             le="5.0",
@@ -112,14 +126,14 @@ def test_latency_histograms(self):
         )
 
     def test_exception_latency_histograms(self):
-        r = self.saveRegistry()
+        registry = self.saveRegistry()
 
         try:
             self.client.get("/objection")
         except ObjectionException:
             pass
         self.assertMetricDiff(
-            r,
+            registry,
             2,
             M("requests_latency_seconds_by_view_method_bucket"),
             le="0.05",
@@ -128,8 +142,10 @@ def test_exception_latency_histograms(self):
         )
 
     def test_streaming_responses(self):
-        r = self.saveRegistry()
+        registry = self.saveRegistry()
         self.client.get("/")
         self.client.get("/file")
-        self.assertMetricDiff(r, 1, M("responses_streaming_total"))
-        self.assertMetricDiff(r, 1, M("responses_body_total_bytes_bucket"), le="+Inf")
+        self.assertMetricDiff(registry, 1, M("responses_streaming_total"))
+        self.assertMetricDiff(
+            registry, 1, M("responses_body_total_bytes_bucket"), le="+Inf"
+        )

django_prometheus/tests/end2end/testapp/test_models.py

@@ -18,35 +18,35 @@ class TestModelMetrics(PrometheusTestCaseMixin, TestCase):
     """Test django_prometheus.models."""
 
     def test_counters(self):
-        r = self.saveRegistry()
+        registry = self.saveRegistry()
         cool = Dog()
         cool.name = "Cool"
         cool.save()
-        self.assertMetricDiff(r, 1, M("inserts_total"), model="dog")
+        self.assertMetricDiff(registry, 1, M("inserts_total"), model="dog")
 
         elysees = Lawn()
         elysees.location = "Champs Elysees, Paris"
         elysees.save()
-        self.assertMetricDiff(r, 1, M("inserts_total"), model="lawn")
-        self.assertMetricDiff(r, 1, M("inserts_total"), model="dog")
+        self.assertMetricDiff(registry, 1, M("inserts_total"), model="lawn")
+        self.assertMetricDiff(registry, 1, M("inserts_total"), model="dog")
 
         galli = Dog()
         galli.name = "Galli"
         galli.save()
-        self.assertMetricDiff(r, 2, M("inserts_total"), model="dog")
+        self.assertMetricDiff(registry, 2, M("inserts_total"), model="dog")
 
         cool.breed = "Wolfhound"
-        self.assertMetricDiff(r, 2, M("inserts_total"), model="dog")
+        self.assertMetricDiff(registry, 2, M("inserts_total"), model="dog")
 
         cool.save()
-        self.assertMetricDiff(r, 2, M("inserts_total"), model="dog")
-        self.assertMetricDiff(r, 1, M("updates_total"), model="dog")
+        self.assertMetricDiff(registry, 2, M("inserts_total"), model="dog")
+        self.assertMetricDiff(registry, 1, M("updates_total"), model="dog")
 
         cool.age = 9
         cool.save()
-        self.assertMetricDiff(r, 2, M("updates_total"), model="dog")
+        self.assertMetricDiff(registry, 2, M("updates_total"), model="dog")
 
         cool.delete()  # :(
-        self.assertMetricDiff(r, 2, M("inserts_total"), model="dog")
-        self.assertMetricDiff(r, 2, M("updates_total"), model="dog")
-        self.assertMetricDiff(r, 1, M("deletes_total"), model="dog")
+        self.assertMetricDiff(registry, 2, M("inserts_total"), model="dog")
+        self.assertMetricDiff(registry, 2, M("updates_total"), model="dog")
+        self.assertMetricDiff(registry, 1, M("deletes_total"), model="dog")

django_prometheus/testutils.py

@@ -35,9 +35,9 @@ def saveRegistry(self, registry=REGISTRY):
         """Freezes a registry. This lets a user test changes to a metric
         instead of testing the absolute value. A typical use case looks like:
 
-          r = self.saveRegistry()
+          registry = self.saveRegistry()
           doStuff()
-          self.assertMetricDiff(r, 1, 'stuff_done_total')
+          self.assertMetricDiff(registry, 1, 'stuff_done_total')
         """
         return copy.deepcopy(list(registry.collect()))