Add docstrings

Author: alvarolopez

caso/extract/base.py

@@ -99,6 +99,10 @@ def _get_keystone_users(self, ks_client):
         return {u.id: u.name for u in users}
 
     def vm_status(self, status):
+        """Return the status corresponding to the OpenStack status.
+
+        :param status: OpenStack status.
+        """
         return openstack_vm_statuses.get(status.lower(), 'unknown')
 
     @abc.abstractmethod

caso/extract/ceilometer.py

@@ -93,6 +93,16 @@ def _fill_net_metric(self, metric_name, net_samples, records):
                           unit_conv=lambda v: int(v / 2 ** 30))
 
     def extract_for_tenant(self, tenant, lastrun):
+        """Extract records for a tenant from given date.
+
+        This method will get information from nova, and will enhance it with
+        information from ceilometer.
+
+        :param tenant: Tenant to extract records for.
+        :param extract_from: datetime.datetime object indicating the date to
+                             extract records from
+        :returns: A dictionary of {"server_id": caso.record.Record"}
+        """
         records = super(CeilometerExtractor,
                         self).extract_for_tenant(tenant, lastrun)
         # Try and except here

caso/extract/manager.py

@@ -75,6 +75,13 @@ def _extract(self, extract_from):
             self.records.update(records)
 
     def get_records(self, lastrun="1970-01-01"):
+        """Get records from given date
+
+        :param lastrun: date to get records from (optional).
+
+        If CONF.extract_from is present, it will be used instead of the
+        lastrun parameter.
+        """
         extract_from = CONF.extract_from or lastrun
 
         if isinstance(extract_from, six.string_types):

caso/extract/nova.py

@@ -46,6 +46,15 @@ def _get_conn(self, tenant):
         return conn
 
     def extract_for_tenant(self, tenant, lastrun):
+        """Extract records for a tenant from given date querying nova.
+
+        This method will get information from nova.
+
+        :param tenant: Tenant to extract records for.
+        :param extract_from: datetime.datetime object indicating the date to
+                             extract records from
+        :returns: A dictionary of {"server_id": caso.record.Record"}
+        """
         # Some API calls do not expect a TZ, so we have to remove the timezone
         # from the dates. We assume that all dates coming from upstream are
         # in UTC TZ.