Resolve comments from code review by Brad and Itay.

Add docstring to client.trailing. Replace while …: pass in test_job.py with while …: sleep(1) to avoid wasting cycles.

Author: Frederick Ross

splunklib/client.py

@@ -114,6 +114,26 @@ class JobNotReadyException(Exception):
     pass
 
 def trailing(template, *targets):
+    """Substring of *template* following all *targets*.
+
+    Most easily explained by example::
+
+        template = "this is a test of the bunnies."
+        trailing(template, "is", "est", "the") == \
+            " bunnies"
+
+    Each target is matched successively in the string, and the string
+    remaining after the last target is returned. If one of the targets
+    fails to match, a ValueError is raised.
+
+    :param template: Template to extract a trailing string from.
+    :type template: string
+    :param targets: Strings to successively match in *template*.
+    :type targets: strings
+    :returns: Trailing string after all targets are matched.
+    :rtype: string
+    :raises ValueError: when one of the targets does not match.
+    """
     s = template
     for t in targets:
         n = s.find(t)

tests/test_job.py

@@ -173,7 +173,7 @@ def test_results(self):
         # here as a caution to future generations:
         # self.assertRaises(ValueError, job.results)
         while not job.isDone():
-            pass
+            sleep(1)
         reader = results.ResultsReader(job.results(timeout=60))
         job.refresh()
         self.assertEqual(job['isDone'], '1')
@@ -187,7 +187,7 @@ def test_results(self):
         # Repeat the same thing, but without the .is_preview reference.
         job = jobs.create("search index=_internal | head 1 | stats count")
         while not job.isDone():
-            pass
+            sleep(1)
         reader = results.ResultsReader(job.results(timeout=60))
         job.refresh()
         self.assertEqual(job['isDone'], '1')