Rename labelvalues to _labelvalues (prometheus#660)

csmarchbanks · web-flow · commit 59025d0e4e68 · 2021-06-01T09:14:16.000-06:00
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 &lt;csmarchbanks@gmail.com&gt;
diff --git a/prometheus_client/metrics.py b/prometheus_client/metrics.py
@@ -95,11 +95,11 @@ def __init__(self,
                  subsystem='',
                  unit='',
                  registry=REGISTRY,
-                 labelvalues=None,
+                 _labelvalues=None,
                  ):
         self._name = _build_full_name(self._type, name, namespace, subsystem, unit)
         self._labelnames = _validate_labelnames(self, labelnames)
-        self._labelvalues = tuple(labelvalues or ())
+        self._labelvalues = tuple(_labelvalues or ())
         self._kwargs = {}
         self._documentation = documentation
         self._unit = unit
@@ -170,7 +170,7 @@ def labels(self, *labelvalues, **labelkwargs):
                     documentation=self._documentation,
                     labelnames=self._labelnames,
                     unit=self._unit,
-                    labelvalues=labelvalues,
+                    _labelvalues=labelvalues,
                     **self._kwargs
                 )
             return self._metrics[labelvalues]
@@ -327,7 +327,7 @@ def __init__(self,
                  subsystem='',
                  unit='',
                  registry=REGISTRY,
-                 labelvalues=None,
+                 _labelvalues=None,
                  multiprocess_mode='all',
                  ):
         self._multiprocess_mode = multiprocess_mode
@@ -341,7 +341,7 @@ def __init__(self,
             subsystem=subsystem,
             unit=unit,
             registry=registry,
-            labelvalues=labelvalues,
+            _labelvalues=_labelvalues,
         )
         self._kwargs['multiprocess_mode'] = self._multiprocess_mode
 
@@ -515,7 +515,7 @@ def __init__(self,
                  subsystem='',
                  unit='',
                  registry=REGISTRY,
-                 labelvalues=None,
+                 _labelvalues=None,
                  buckets=DEFAULT_BUCKETS,
                  ):
         self._prepare_buckets(buckets)
@@ -527,7 +527,7 @@ def __init__(self,
             subsystem=subsystem,
             unit=unit,
             registry=registry,
-            labelvalues=labelvalues,
+            _labelvalues=_labelvalues,
         )
         self._kwargs['buckets'] = buckets
 
@@ -652,7 +652,7 @@ def __init__(self,
                  subsystem='',
                  unit='',
                  registry=REGISTRY,
-                 labelvalues=None,
+                 _labelvalues=None,
                  states=None,
                  ):
         super(Enum, self).__init__(
@@ -663,7 +663,7 @@ def __init__(self,
             subsystem=subsystem,
             unit=unit,
             registry=registry,
-            labelvalues=labelvalues,
+            _labelvalues=_labelvalues,
         )
         if name in labelnames:
             raise ValueError('Overlapping labels for Enum metric: %s' % (name,))
