8000 Remove the by-dict support for labels · pramodtoraskar/client_python@882d576 · GitHub
[go: up one dir, main page]
Skip to content

Commit 882d576

Browse files
alexalex
committed
Remove the by-dict support for labels
1 parent 0e5696b commit 882d576

File tree

3 files changed

+3
-30
lines changed

3 files changed

+3
-30
lines changed

‎README.md

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -194,15 +194,6 @@ c.labels(method='get', endpoint='/').inc()
194194
c.labels(method='post', endpoint='/submit').inc()
195195
```
196196

197-
Or as a dict:
198-
199-
```python
200-
from prometheus_client import Counter
201-
c = Counter('my_requests_total', 'HTTP Failures', ['method', 'endpoint'])
202-
c.labels({'method': 'get', 'endpoint': '/'}).inc()
203-
c.labels({'method': 'post', 'endpoint': '/submit'}).inc()
204-
```
205-
206197
### Process Collector
207198

208199
The Python client automatically exports metrics about process CPU usage, RAM,

‎prometheus_client/core.py

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -279,11 +279,7 @@ def labels(self, *labelvalues, **labelkwargs):
279279
if labelvalues and labelkwargs:
280280
raise ValueError("Can't pass both *args and **kwargs")
281281

282-
if len(labelvalues) == 1 and type(labelvalues[0]) == dict:
283-
if sorted(labelvalues[0].keys()) != sorted(self._labelnames):
284-
raise ValueError('Incorrect label names')
285-
labelvalues = tuple([unicode(labelvalues[0][l]) for l in self._labelnames])
286-
elif labelkwargs:
282+
if labelkwargs:
287283
if sorted(labelkwargs) != sorted(self._labelnames):
288284
raise ValueError('Incorrect label names')
289285
labelvalues = tuple([unicode(labelkwargs[l]) for l in self._labelnames])

‎tests/test_core.py

Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -249,7 +249,7 @@ def test_incorrect_label_count_raises(self):
249249

250250
def test_labels_coerced_to_string(self):
251251
self.counter.labels(None).inc()
252-
self.counter.labels({'l': None}).inc()
252+
self.counter.labels(l=None).inc()
253253
self.assertEqual(2, self.registry.get_sample_value('c', {'l': 'None'}))
254254

255255
self.counter.remove(None)
@@ -259,27 +259,13 @@ def test_non_string_labels_raises(self):
259259
class Test(object):
260260
__str__ = None
261261
self.assertRaises(TypeError, self.counter.labels, Test())
262-
self.assertRaises(TypeError, self.counter.labels, {'l': Test()})
262+
self.assertRaises(TypeError, self.counter.labels, l=Test())
263263

264264
def test_namespace_subsystem_concatenated(self):
265265
c = Counter('c', 'help', namespace='a', subsystem='b', registry=self.registry)
266266
c.inc()
267267
self.assertEqual(1, self.registry.get_sample_value('a_b_c'))
268268

269-
def test_labels_by_dict(self):
270-
self.counter.labels({'l': 'x'}).inc()
271-
self.assertEqual(1, self.registry.get_sample_value('c', {'l': 'x'}))
272-
self.assertRaises(ValueError, self.counter.labels, {'l': 'x', 'm': 'y'})
273-
self.assertRaises(ValueError, self.counter.labels, {'m': 'y'})
274-
self.assertRaises(ValueError, self.counter.labels, {})
275-
self.two_labels.labels({'a': 'x', 'b': 'y'}).inc()
276-
self.assertEqual(1, self.registry.get_sample_value('two', {'a': 'x', 'b': 'y'}))
277-
self.assertRaises(ValueError, self.two_labels.labels, {'a': 'x', 'b': 'y', 'c': 'z'})
278-
self.assertRaises(ValueError, self.two_labels.labels, {'a': 'x', 'c': 'z'})
279-
self.assertRaises(ValueError, self.two_labels.labels, {'b': 'y', 'c': 'z'})
280-
self.assertRaises(ValueError, self.two_labels.labels, {'c': 'z'})
281-
self.assertRaises(ValueError, self.two_labels.labels, {})
282-
283269
def test_labels_by_kwarg(self):
284270
self.counter.labels(l='x').inc()
285271
self.assertEqual(1, self.registry.get_sample_value('c', {'l': 'x'}))

0 commit comments

Comments
 (0)
0