fix MeterId class name references, for consistency (#77)

Author: copperlight

spectator/meter/meter_id.py

@@ -24,8 +24,8 @@ def _validate_tags(self, tags: Dict[str, str]) -> Dict[str, str]:
         valid_tags = validate_tags(tags)
 
         if valid_tags != tags:
-            msg = "Id(name=%s, tags=%s) is invalid due to tag keys or values which are not strings " \
-                  "or are zero-length strings; proceeding with truncated tags Id(name=%s, tags=%s)"
+            msg = "MeterId(name=%s, tags=%s) is invalid due to tag keys or values which are not strings " \
+                  "or are zero-length strings; proceeding with truncated tags MeterId(name=%s, tags=%s)"
             self._logger.warning(msg, self._name, tags, self._name, valid_tags)
 
         return valid_tags
@@ -70,4 +70,4 @@ def __eq__(self, other) -> bool:
         return False
 
     def __str__(self) -> str:
-        return f"Id(name={self._name}, tags={self._tags})"
+        return f"MeterId(name={self._name}, tags={self._tags})"

tests/meter/test_meter_id.py

@@ -30,21 +30,21 @@ def test_illegal_chars_are_replaced(self):
 
     def test_invalid_tags(self):
         expected_messages = [
-            "WARNING:spectator.meter.meter_id:Id(name=foo, tags={'k': ''}) is invalid due to tag keys or values which are not strings or are zero-length strings; proceeding with truncated tags Id(name=foo, tags={})",
-            "WARNING:spectator.meter.meter_id:Id(name=bar, tags={'k': 1}) is invalid due to tag keys or values which are not strings or are zero-length strings; proceeding with truncated tags Id(name=bar, tags={})",
-            "WARNING:spectator.meter.meter_id:Id(name=baz, tags={1: 'v'}) is invalid due to tag keys or values which are not strings or are zero-length strings; proceeding with truncated tags Id(name=baz, tags={})",
-            "WARNING:spectator.meter.meter_id:Id(name=quux, tags={'k': 'v', 1: 'v'}) is invalid due to tag keys or values which are not strings or are zero-length strings; proceeding with truncated tags Id(name=quux, tags={'k': 'v'})",
+            "WARNING:spectator.meter.meter_id:MeterId(name=foo, tags={'k': ''}) is invalid due to tag keys or values which are not strings or are zero-length strings; proceeding with truncated tags MeterId(name=foo, tags={})",
+            "WARNING:spectator.meter.meter_id:MeterId(name=bar, tags={'k': 1}) is invalid due to tag keys or values which are not strings or are zero-length strings; proceeding with truncated tags MeterId(name=bar, tags={})",
+            "WARNING:spectator.meter.meter_id:MeterId(name=baz, tags={1: 'v'}) is invalid due to tag keys or values which are not strings or are zero-length strings; proceeding with truncated tags MeterId(name=baz, tags={})",
+            "WARNING:spectator.meter.meter_id:MeterId(name=quux, tags={'k': 'v', 1: 'v'}) is invalid due to tag keys or values which are not strings or are zero-length strings; proceeding with truncated tags MeterId(name=quux, tags={'k': 'v'})",
         ]
 
         with self.assertLogs("spectator.meter.meter_id", level='INFO') as logs:
             id1 = MeterId("foo", {"k": ""})
-            self.assertEqual("Id(name=foo, tags={})", str(id1))
+            self.assertEqual("MeterId(name=foo, tags={})", str(id1))
             id2 = MeterId("bar", {"k": 1})
-            self.assertEqual("Id(name=bar, tags={})", str(id2))
+            self.assertEqual("MeterId(name=bar, tags={})", str(id2))
             id3 = MeterId("baz", {1: "v"})
-            self.assertEqual("Id(name=baz, tags={})", str(id3))
+            self.assertEqual("MeterId(name=baz, tags={})", str(id3))
             id4 = MeterId("quux", {"k": "v", 1: "v"})
-            self.assertEqual("Id(name=quux, tags={'k': 'v'})", str(id4))
+            self.assertEqual("MeterId(name=quux, tags={'k': 'v'})", str(id4))
 
         self.assertEqual(expected_messages, logs.output)
 
@@ -70,13 +70,13 @@ def test_spectatord_id(self):
 
     def test_str(self):
         id1 = MeterId("foo")
-        self.assertEqual("Id(name=foo, tags={})", str(id1))
+        self.assertEqual("MeterId(name=foo, tags={})", str(id1))
 
         id2 = MeterId("bar", {"a": "1"})
-        self.assertEqual("Id(name=bar, tags={'a': '1'})", str(id2))
+        self.assertEqual("MeterId(name=bar, tags={'a': '1'})", str(id2))
 
-        id3 = MeterId("bar", {"a": "1", "b": "2", "c": "3"})
-        self.assertEqual("Id(name=bar, tags={'a': '1', 'b': '2', 'c': '3'})", str(id3))
+        id3 = MeterId("baz", {"a": "1", "b": "2", "c": "3"})
+        self.assertEqual("MeterId(name=baz, tags={'a': '1', 'b': '2', 'c': '3'})", str(id3))
 
     def test_tags(self):
         id1 = MeterId("foo", {"a": "1"})

tests/test_registry.py

@@ -170,11 +170,11 @@ def test_monotonic_counter_with_id(self):
     def test_new_id(self):
         r1 = Registry(Config("memory"))
         id1 = r1.new_id("id")
-        self.assertEqual("Id(name=id, tags={})", str(id1))
+        self.assertEqual("MeterId(name=id, tags={})", str(id1))
 
         r2 = Registry(Config("memory", {"extra-tags": "foo"}))
         id2 = r2.new_id("id")
-        self.assertEqual("Id(name=id, tags={'extra-tags': 'foo'})", str(id2))
+        self.assertEqual("MeterId(name=id, tags={'extra-tags': 'foo'})", str(id2))
 
     def test_pct_distribution_summary(self):
         r = Registry(Config("memory"))