Skip to content

fix: raise ValueError when clear() called on metric without labels #1174

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kimjune01 wants to merge 2 commits into
base: master
Choose a base branch
from
+12 −0
Open

fix: raise ValueError when clear() called on metric without labels #1174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
83d3d78
fix: raise ValueError when clear() called on metric without labels (#…
kimjune01 May 9, 2026
24409dc
test: add remove() no-labels guard test per codex review
kimjune01 May 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions prometheus_client/metrics.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -254,6 +254,8 @@ def remove_by_labels(self, labels: dict[str, str]) -> None:

def clear(self) -> None:
"""Remove all labelsets from the metric"""
if not self._labelnames:
raise ValueError('No label names were set when constructing %s' % self)
if 'prometheus_multiproc_dir' in os.environ or 'PROMETHEUS_MULTIPROC_DIR' in os.environ:
warnings.warn(
"Clearing labels has not been implemented in multi-process mode yet",
Expand Down
10 changes: 10 additions & 0 deletions tests/test_core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -620,6 +620,16 @@ def test_clear(self):
self.assertEqual(None, self.registry.get_sample_value('c_total', {'l': 'x'}))
self.assertEqual(None, self.registry.get_sample_value('c_total', {'l': 'y'}))

def test_clear_no_labels_raises(self):
no_labels = Counter('c_no_labels', 'help', registry=self.registry)
no_labels.inc()
self.assertRaises(ValueError, no_labels.clear)

def test_remove_no_labels_raises(self):
no_labels = Counter('c_no_labels2', 'help', registry=self.registry)
no_labels.inc()
self.assertRaises(ValueError, no_labels.remove, 'x')

def test_incorrect_label_count_raises(self):
self.assertRaises(ValueError, self.counter.labels)
self.assertRaises(ValueError, self.counter.labels, 'a', 'b')
Expand Down