[LNT] Add missing method docstrings in lnt.testing

[danilaml]

lnt/testing/__init__.py

47 ↗

(On Diff #213366)

Check that ...?

66 ↗

(On Diff #213366)

its parent?

[thopre]

Address review comments

lnt/trunk/lnt/testing/__init__.py

class Report:
     def __init__(self, machine, run, tests):
         self.machine = machine
         self.run = run
         self.tests = list(tests)
         self.report_version = '1'
         self.check()
 
     def check(self):
+        """Check that object members are adequate to generate an LNT
+        json report file when rendering that instance.
+        """
         assert isinstance(self.machine, Machine)
         assert isinstance(self.run, Run)
         for t in self.tests:
             assert isinstance(t, TestSamples)
 
     def update_report(self, new_samples):
-        """Add extra samples to this report, and update the end time."""
+        """Add extra samples to this report, and update the end time of
+        the run.
+        """
         self.check()
         self.tests.extend(new_samples)
         self.run.update_endtime()
         self.check()
 
     def render(self, indent=4):
+        """Return a LNT json report file format as a string, where each
+        object is indented by indent spaces compared to its parent.
+        """
         # Note that we specifically override the encoding to avoid the
         # possibility of encoding errors. Clients which care about the
         # text encoding should supply unicode string objects.
         return json.dumps({'Machine': self.machine.render(),
                            'Run': self.run.render(),
                            'Tests': [t.render() for t in self.tests]},
                           sort_keys=True, indent=indent, encoding='latin-1')
 
class Machine:
     entire contents of the info dictionary.
     """
     def __init__(self, name, info={}):
         self.name = str(name)
         self.info = dict((str(key), str(value))
                          for key, value in info.items())
 
     def render(self):
+        """Return info from this instance in a dictionary that respects
+        the LNT report format when printed as json.
+        """
         return {'Name': self.name,
                 'Info': self.info}
 
 
 class Run:
     """Information on the particular test run.
 
     The start and end time should always be supplied with the run.
def __init__(self, start_time, end_time, info={}):
             value = str(value)
             self.info[key] = value
         if '__report_version__' in self.info:
             raise ValueError("'__report_version__' key is reserved")
         # TODO: Convert to version 2
         self.info['__report_version__'] = '1'
 
     def update_endtime(self, end_time=None):
+        """Update the end time of this run."""
         if end_time is None:
             end_time = datetime.datetime.utcnow()
         self.end_time = normalize_time(end_time)
 
     def render(self):
+        """Return info from this instance in a dictionary that respects
+        the LNT report format when printed as json.
+        """
         return {'Start Time': self.start_time,
                 'End Time': self.end_time,
                 'Info': self.info}
 
 
 class TestSamples:
     """Test sample data.
 
class TestSamples:
     have the same test name but different info paramaters.
 
     The report may include an arbitrary number of samples for each test
     for situations where the same test is run multiple times to gather
     statistical data.
     """
 
     def __init__(self, name, data, info={}, conv_f=float):
+        """Create an instance representing the samples converted into
+        floating-point values using the conv_f function.
+        """
         self.name = str(name)
         self.info = dict((str(key), str(value))
                          for key, value in info.items())
         self.data = map(conv_f, data)
 
     def render(self):
+        """Return info from this instance in a dictionary that respects
+        the LNT report format when printed as json.
+        """
         return {'Name': self.name,
                 'Info': self.info,
                 'Data': self.data}
 
     def __repr__(self):
         # TODO remove this
         return "TestSample({}): {} - {}".format(self.name,
                                                 self.data,