Skip to content

Commit ac8b74e

Browse files
author
Hazel
committed
Rename function name, and the parameter's name
Signed-off-by: Hazel <[email protected]>
1 parent edb0e7c commit ac8b74e

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

prometheus_client/metrics.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ def remove(self, *labelvalues: Any) -> None:
203203
if labelvalues in self._metrics:
204204
del self._metrics[labelvalues]
205205

206-
def remove_matching(self, partial: dict[str, str]) -> int:
206+
def remove_by_labels(self, labels: dict[str, str]) -> int:
207207
if 'prometheus_multiproc_dir' in os.environ or 'PROMETHEUS_MULTIPROC_DIR' in os.environ:
208208
warnings.warn(
209209
"Removal of labels has not been implemented in multi-process mode yet.",
@@ -213,19 +213,19 @@ def remove_matching(self, partial: dict[str, str]) -> int:
213213
if not self._labelnames:
214214
raise ValueError('No label names were set when constructing %s' % self)
215215

216-
if not isinstance(partial, dict):
217-
raise TypeError("partial must be a dict of {label_name: label_value}")
216+
if not isinstance(labels, dict):
217+
raise TypeError("labels must be a dict of {label_name: label_value}")
218218

219-
if not partial:
219+
if not labels:
220220
return 0
221221

222-
invalid = [k for k in partial.keys() if k not in self._labelnames]
222+
invalid = [k for k in labels.keys() if k not in self._labelnames]
223223
if invalid:
224224
raise ValueError(
225225
'Unknown label names: %s; expected %s' % (invalid, self._labelnames)
226226
)
227227

228-
pos_filter = {self._labelnames.index(k): str(v) for k, v in partial.items()}
228+
pos_filter = {self._labelnames.index(k): str(v) for k, v in labels.items()}
229229

230230
deleted = 0
231231
with self._lock:

tests/test_core.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -639,7 +639,7 @@ def test_remove_matching(self):
639639
c.labels('globex', '/').inc()
640640

641641

642-
deleted = c.remove_matching({'tenant': 'acme'})
642+
deleted = c.remove_by_labels({'tenant': 'acme'})
643643
self.assertEqual(2, deleted)
644644

645645
self.assertIsNone(self.registry.get_sample_value('c2_total', {'tenant': 'acme', 'endpoint': '/'}))
@@ -651,13 +651,13 @@ def test_remove_matching_invalid_label_name(self):
651651
c = Counter('c3', 'help', ['tenant', 'endpoint'], registry=self.registry)
652652
c.labels('acme', '/').inc()
653653
with self.assertRaises(ValueError):
654-
c.remove_matching({'badkey': 'x'})
654+
c.remove_by_labels({'badkey': 'x'})
655655

656656
def test_remove_matching_empty_is_noop(self):
657657
from prometheus_client import Counter
658658
c = Counter('c4', 'help', ['tenant', 'endpoint'], registry=self.registry)
659659
c.labels('acme', '/').inc()
660-
self.assertEqual(0, c.remove_matching({}))
660+
self.assertEqual(0, c.remove_by_labels({}))
661661
self.assertEqual(1, self.registry.get_sample_value('c4_total', {'tenant': 'acme', 'endpoint': '/'}))
662662

663663
def test_non_string_labels_raises(self):

0 commit comments

Comments
 (0)