documented Statistics interface

1 files changed, 47 insertions, 9 deletions

diff --git a/src/lib/Bcfg2/Statistics.py b/src/lib/Bcfg2/Statistics.py
index 140c2557e..a869b03cd 100644
--- a/src/lib/Bcfg2/Statistics.py
+++ b/src/lib/Bcfg2/Statistics.py
@@ -1,11 +1,20 @@
-""" module for tracking execution time statistics from the bcfg2
-server core """
+""" Module for tracking execution time statistics from the Bcfg2
+server core.  This data is exposed by
+:func:`Bcfg2.Server.Core.BaseCore.get_statistics`."""
 
 
 class Statistic(object):
-    """ a single named statistic, tracking minimum, maximum, and
-    average execution time, and number of invocations """
+    """ A single named statistic, tracking minimum, maximum, and
+    average execution time, and number of invocations. """
+
     def __init__(self, name, initial_value):
+        """
+        :param name: The name of this statistic
+        :type name: string
+        :param initial_value: The initial value to be added to this
+                              statistic
+        :type initial_value: int or float
+        """
         self.name = name
         self.min = float(initial_value)
         self.max = float(initial_value)
@@ -13,32 +22,61 @@ class Statistic(object):
         self.count = 1
 
     def add_value(self, value):
-        """ add a value to the statistic """
+        """ Add a value to the statistic, recalculating the various
+        metrics.
+
+        :param value: The value to add to this statistic
+        :type value: int or float
+        """
         self.min = min(self.min, value)
         self.max = max(self.max, value)
         self.ave = (((self.ave * (self.count - 1)) + value) / self.count)
         self.count += 1
 
     def get_value(self):
-        """ get a tuple of all the stats tracked on this named item """
+        """ Get a tuple of all the stats tracked on this named item.
+        The tuple is in the format::
+
+            (<name>, (min, max, average, number of values))
+
+        This makes it very easy to cast to a dict in
+        :func:`Statistics.display`.
+
+        :returns: tuple
+        """
         return (self.name, (self.min, self.max, self.ave, self.count))
 
 
 class Statistics(object):
-    """ A collection of named statistics """
+    """ A collection of named :class:`Statistic` objects. """
+
     def __init__(self):
         self.data = dict()
 
     def add_value(self, name, value):
-        """ add a value to the named statistic """
+        """ Add a value to the named :class:`Statistic`.  This just
+        proxies to :func:`Statistic.add_value` or the
+        :class:`Statistic` constructor as appropriate.
+
+        :param name: The name of the :class:`Statistic` to add the
+                     value to
+        :type name: string
+        :param value: The value to add to the Statistic
+        :type value: int or float
+        """
         if name not in self.data:
             self.data[name] = Statistic(name, value)
         else:
             self.data[name].add_value(value)
 
     def display(self):
-        """ return a dict of all statistics """
+        """ Return a dict of all :class:`Statistic` object values.
+        Keys are the statistic names, and values are tuples of the
+        statistic metrics as returned by
+        :func:`Statistic.get_value`. """
         return dict([value.get_value() for value in list(self.data.values())])
 
 
+#: A module-level :class:`Statistics` objects used to track all
+#: execution time metrics for the server.
 stats = Statistics()  # pylint: disable=C0103