rename getMultiprocDir as private

Author: iostream96

prometheus_client/metrics.py

@@ -13,7 +13,7 @@
 from .metrics_core import Metric
 from .registry import Collector, CollectorRegistry, REGISTRY
 from .samples import Exemplar, Sample
-from .utils import floatToGoString, getMultiprocDir, INF
+from .utils import _getMultiprocDir, floatToGoString, INF
 from .validation import (
     _validate_exemplar, _validate_labelnames, _validate_metric_name,
 )
@@ -190,7 +190,7 @@ def labels(self: T, *labelvalues: Any, **labelkwargs: Any) -> T:
             return self._metrics[labelvalues]
 
     def remove(self, *labelvalues: Any) -> None:
-        if getMultiprocDir():
+        if _getMultiprocDir():
             warnings.warn(
                 "Removal of labels has not been implemented in  multi-process mode yet.",
                 UserWarning)
@@ -208,7 +208,7 @@ def remove(self, *labelvalues: Any) -> None:
 
     def clear(self) -> None:
         """Remove all labelsets from the metric"""
-        if getMultiprocDir():
+        if _getMultiprocDir():
             warnings.warn(
                 "Clearing labels has not been implemented in multi-process mode yet",
                 UserWarning)

prometheus_client/multiprocess.py

@@ -7,7 +7,7 @@
 from .metrics_core import Metric
 from .mmap_dict import MmapedDict
 from .samples import Sample
-from .utils import floatToGoString, getMultiprocDir
+from .utils import _getMultiprocDir, floatToGoString
 
 try:  # Python3
     FileNotFoundError
@@ -21,7 +21,7 @@ class MultiProcessCollector:
 
     def __init__(self, registry, path=None):
         if path is None:
-            path = getMultiprocDir()
+            path = _getMultiprocDir()
         if not path or not os.path.isdir(path):
             raise ValueError('env PROMETHEUS_MULTIPROC_DIR is not set or not a directory')
         self._path = path
@@ -160,7 +160,7 @@ def collect(self):
 def mark_process_dead(pid, path=None):
     """Do bookkeeping for when one process dies in a multi-process setup."""
     if path is None:
-        path = getMultiprocDir()
+        path = _getMultiprocDir()
     for mode in _LIVE_GAUGE_MULTIPROCESS_MODES:
         for f in glob.glob(os.path.join(path, f'gauge_{mode}_{pid}.db')):
             os.remove(f)

prometheus_client/utils.py

@@ -27,7 +27,7 @@ def floatToGoString(d):
 
 
 
-def getMultiprocDir() -> str:
+def _getMultiprocDir() -> str:
     if 'prometheus_multiproc_dir' in os.environ and 'PROMETHEUS_MULTIPROC_DIR' not in os.environ:
         os.environ['PROMETHEUS_MULTIPROC_DIR'] = os.environ['prometheus_multiproc_dir']
         warnings.warn("prometheus_multiproc_dir variable has been deprecated in favor of the upper case naming PROMETHEUS_MULTIPROC_DIR", DeprecationWarning)

prometheus_client/values.py

@@ -2,7 +2,7 @@
 from threading import Lock
 
 from .mmap_dict import mmap_key, MmapedDict
-from .utils import getMultiprocDir
+from .utils import _getMultiprocDir
 
 
 class MutexValue:
@@ -58,7 +58,7 @@ class MmapedValue:
         _multiprocess = True
 
         def __init__(self, typ, metric_name, name, labelnames, labelvalues, help_text, multiprocess_mode='', multiprocess_dir='', **kwargs):
-            self._params = typ, metric_name, name, labelnames, labelvalues, help_text, multiprocess_mode, multiprocess_dir or getMultiprocDir()
+            self._params = typ, metric_name, name, labelnames, labelvalues, help_text, multiprocess_mode, multiprocess_dir or _getMultiprocDir()
             with lock:
                 self.__check_for_pid_change()
                 self.__reset()
@@ -127,7 +127,7 @@ def get_value_class():
     # This needs to be chosen before the first metric is constructed,
     # and as that may be in some arbitrary library the user/admin has
     # no control over we use an environment variable.
-    if getMultiprocDir():
+    if _getMultiprocDir():
         return MultiProcessValue()
     else:
         return MutexValue