8000 Rename labelvalues to _labelvalues (#660) · ethervoid/client_python@59025d0 · GitHub
[go: up one dir, main page]

Skip to content

Commit 59025d0

Browse files
authored
Rename labelvalues to _labelvalues (prometheus#660)
Make it clear that labelvalues are for internal use only. Right now it is easy to assume that they provide a way of creating static labels on a counter, but that is not the case. Signed-off-by: Chris Marchbanks <csmarchbanks@gmail.com>
1 parent 269bbde commit 59025d0

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

prometheus_client/metrics.py

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -95,11 +95,11 @@ def __init__(self,
9595
subsystem='',
9696
unit='',
9797
registry=REGISTRY,
98-
labelvalues=None,
98+
_labelvalues=None,
9999
):
100100
self._name = _build_full_name(self._type, name, namespace, subsystem, unit)
101101
self._labelnames = _validate_labelnames(self, labelnames)
102-
self._labelvalues = tuple(labelvalues or ())
102+
self._labelvalues = tuple(_labelvalues or ())
103103
self._kwargs = {}
104104
self._documentation = documentation
105105
self._unit = unit
@@ -170,7 +170,7 @@ def labels(self, *labelvalues, **labelkwargs):
170170
documentation=self._documentation,
171171
labelnames=self._labelnames,
172172
unit=self._unit,
173-
labelvalues=labelvalues,
173+
_labelvalues=labelvalues,
174174
**self._kwargs
175175
)
176176
return self._metrics[labelvalues]
@@ -327,7 +327,7 @@ def __init__(self,
327327
subsystem='',
328328
unit='',
329329
registry=REGISTRY,
330-
labelvalues=None,
330+
_labelvalues=None,
331331
multiprocess_mode='all',
332332
):
333333
self._multiprocess_mode = multiprocess_mode
@@ -341,7 +341,7 @@ def __init__(self,
341341
subsystem=subsystem,
342342
unit=unit,
343343
registry=registry,
344-
labelvalues=labelvalues,
344+
_labelvalues=_labelvalues,
345345
)
346346
self._kwargs['multiprocess_mode'] = self._multiprocess_mode
347347

@@ -515,7 +515,7 @@ def __init__(self,
515515
subsystem='',
516516
unit='',
517517
registry=REGISTRY,
518-
labelvalues=None,
518+
_labelvalues=None,
519519
buckets=DEFAULT_BUCKETS,
520520
):
521521
self._prepare_buckets(buckets)
@@ -527,7 +527,7 @@ def __init__(self,
527527
subsystem=subsystem,
528528
unit=unit,
529529
registry=registry,
530-
labelvalues=labelvalues,
530+
_labelvalues=_labelvalues,
531531
)
532532
self._kwargs['buckets'] = buckets
533533

@@ -652,7 +652,7 @@ def __init__(self,
652652
subsystem='',
653653
unit='',
654654
registry=REGISTRY,
655-
labelvalues=None,
655+
_labelvalues=None,
656656
states=None,
657657
):
658658
super(Enum, self).__init__(
@@ -663,7 +663,7 @@ def __init__(self,
663663
subsystem=subsystem,
664664
unit=unit,
665665
registry=registry,
666-
labelvalues=labelvalues,
666+
_labelvalues=_labelvalues,
667667
)
668668
if name in labelnames:
669669
raise ValueError('Overlapping labels for Enum metric: %s' % (name,))

0 commit comments

Comments
 (0)
0