Added armor plating around running the examples.

Frederick Ross · Frederick Ross · commit bb3ff94e8836 · 2012-12-04T10:33:57.000-08:00
Try adding ../ to PYTHONPATH within the example so they will run when run from the examples directory.
Add an exception with a useful error message when run in a configuration where they cannot import utils.
Removed a few unused imports.
diff --git a/examples/analytics/input.py b/examples/analytics/input.py
@@ -17,7 +17,12 @@
 import urllib2, sys
 from datetime import datetime
 import splunklib.client as client
-import utils
+
+try:
+    import utils
+except ImportError:
+    raise Exception("Add the SDK repository to your PYTHONPATH to run the examples "
+                    "(e.g., export PYTHONPATH=~/splunk-sdk-python.")
 
 __all__ = [
     "AnalyticsTracker",
diff --git a/examples/analytics/output.py b/examples/analytics/output.py
@@ -17,7 +17,11 @@
 import urllib2, sys
 import splunklib.client as client
 import splunklib.results as results
-import utils
+try:
+    import utils
+except ImportError:
+    raise Exception("Add the SDK repository to your PYTHONPATH to run the examples "
+                    "(e.g., export PYTHONPATH=~/splunk-sdk-python.")
 
 __all__ = [
     "TimeRange",
diff --git a/examples/analytics/server.py b/examples/analytics/server.py
@@ -22,7 +22,11 @@
 
 from input import AnalyticsTracker
 from output import AnalyticsRetriever, TimeRange
-import utils
+try:
+    import utils
+except ImportError:
+    raise Exception("Add the SDK repository to your PYTHONPATH to run the examples "
+                    "(e.g., export PYTHONPATH=~/splunk-sdk-python.")
 
 splunk_opts = None
 retrievers = {}
diff --git a/examples/async/async.py b/examples/async/async.py
@@ -27,7 +27,12 @@
 
 import splunklib.binding as binding
 import splunklib.client as client
-from utils import parse, error
+try:
+    from utils import parse, error
+except ImportError:
+    raise Exception("Add the SDK repository to your PYTHONPATH to run the examples "
+                    "(e.g., export PYTHONPATH=~/splunk-sdk-python.")
+
 
 # Placeholder for a specific implementation of `urllib2`,
 # to be defined depending on whether or not we are running
diff --git a/examples/binding1.py b/examples/binding1.py
@@ -24,7 +24,12 @@
 
 from splunklib.binding import connect
 
-from utils import parse
+try:
+    from utils import parse
+except ImportError:
+    raise Exception("Add the SDK repository to your PYTHONPATH to run the examples "
+                    "(e.g., export PYTHONPATH=~/splunk-sdk-python.")
+
 
 class Service:
     def __init__(self, context):
diff --git a/examples/conf.py b/examples/conf.py
@@ -20,7 +20,12 @@
 sys.path.insert(0, '../')
 
 from splunklib.client import connect
-from utils import error, parse
+
+try:
+    from utils import error, parse
+except ImportError:
+    raise Exception("Add the SDK repository to your PYTHONPATH to run the examples "
+                    "(e.g., export PYTHONPATH=~/splunk-sdk-python.")
 
 class Program:
     """Break up operations into specific methods."""
diff --git a/examples/dashboard/feed.py b/examples/dashboard/feed.py
@@ -25,7 +25,12 @@
 
 import splunklib.client as client
 import splunklib.results as results
-from utils import parse, error
+try:
+    from utils import parse
+except ImportError:
+    raise Exception("Add the SDK repository to your PYTHONPATH to run the examples "
+                    "(e.g., export PYTHONPATH=~/splunk-sdk-python.")
+
 
 leftronic_access_key = ""
 
diff --git a/examples/event_types.py b/examples/event_types.py
@@ -21,7 +21,11 @@
 
 from splunklib.client import connect
 
-from utils import parse
+try:
+    from utils import parse
+except ImportError:
+    raise Exception("Add the SDK repository to your PYTHONPATH to run the examples "
+                    "(e.g., export PYTHONPATH=~/splunk-sdk-python.")
 
 def main():
     opts = parse(sys.argv[1:], {}, ".splunkrc")
diff --git a/examples/explorer/explorer.py b/examples/explorer/explorer.py
@@ -21,7 +21,11 @@
 
 sys.path.insert(0, '../../') # Use splunklib and utils without installing
 
-import utils
+try:
+    import utils
+except ImportError:
+    raise Exception("Add the SDK repository to your PYTHONPATH to run the examples "
+                    "(e.g., export PYTHONPATH=~/splunk-sdk-python.")
 import urllib
 
 PORT = 8080
diff --git a/examples/export/export.py b/examples/export/export.py
@@ -26,7 +26,11 @@
 
 # splunk support files
 from splunklib.binding import connect
-from utils import error, parse
+try:
+    from utils import error, parse
+except ImportError:
+    raise Exception("Add the SDK repository to your PYTHONPATH to run the examples "
+                    "(e.g., export PYTHONPATH=~/splunk-sdk-python.")
 
 # hidden file
 OUTPUT_FILE = "./export.out"
diff --git a/examples/fired_alerts.py b/examples/fired_alerts.py
@@ -21,7 +21,11 @@
 
 from splunklib.client import connect
 
-from utils import parse
+try:
+    from utils import parse
+except ImportError:
+    raise Exception("Add the SDK repository to your PYTHONPATH to run the examples "
+                    "(e.g., export PYTHONPATH=~/splunk-sdk-python.")
 
 def main():
     opts = parse(sys.argv[1:], {}, ".splunkrc")
diff --git a/examples/follow.py b/examples/follow.py
@@ -23,10 +23,13 @@
 import time
 
 import splunklib.client as client
-import splunklib.data as data
 import splunklib.results as results
 
-import utils
+try:
+    import utils
+except ImportError:
+    raise Exception("Add the SDK repository to your PYTHONPATH to run the examples "
+                    "(e.g., export PYTHONPATH=~/splunk-sdk-python.")
 
 def follow(job, count, items):
     offset = 0 # High-water mark
diff --git a/examples/genevents.py b/examples/genevents.py
@@ -18,10 +18,15 @@
 
 import socket
 import sys
+sys.path.insert(0, '..')
 import time
 import datetime
 from splunklib.client import connect
-from utils import parse
+try:
+    from utils import parse
+except ImportError:
+    raise Exception("Add the SDK repository to your PYTHONPATH to run the examples "
+                    "(e.g., export PYTHONPATH=~/splunk-sdk-python.")
 
 SPLUNK_HOST = "localhost"
 SPLUNK_PORT = 9002
diff --git a/examples/handlers/handler_certs.py b/examples/handlers/handler_certs.py
@@ -39,11 +39,14 @@
 import sys
 sys.path.insert(0, '../')
 import urllib
-import urlparse
 
 import splunklib.client as client
 
-import utils
+try:
+    import utils
+except ImportError:
+    raise Exception("Add the SDK repository to your PYTHONPATH to run the examples "
+                    "(e.g., export PYTHONPATH=~/splunk-sdk-python.")
 
 RULES = {
     "ca_file": {
diff --git a/examples/handlers/handler_debug.py b/examples/handlers/handler_debug.py
@@ -21,12 +21,15 @@
 from StringIO import StringIO
 import sys
 sys.path.insert(0, '../')
-import urllib2
 
 import splunklib.binding as binding
 import splunklib.client as client
 
-import utils
+try:
+    import utils
+except ImportError:
+    raise Exception("Add the SDK repository to your PYTHONPATH to run the examples "
+                    "(e.g., export PYTHONPATH=~/splunk-sdk-python.")
 
 def handler():
     default = binding.handler()
diff --git a/examples/handlers/handler_proxy.py b/examples/handlers/handler_proxy.py
@@ -34,7 +34,11 @@
 
 import splunklib.client as client
 
-import utils
+try:
+    import utils
+except ImportError:
+    raise Exception("Add the SDK repository to your PYTHONPATH to run the examples "
+                    "(e.g., export PYTHONPATH=~/splunk-sdk-python.")
 
 RULES = {
     "proxy": {
diff --git a/examples/handlers/handler_urllib2.py b/examples/handlers/handler_urllib2.py
@@ -24,7 +24,11 @@
 
 import splunklib.client as client
 
-import utils
+try:
+    import utils
+except ImportError:
+    raise Exception("Add the SDK repository to your PYTHONPATH to run the examples "
+                    "(e.g., export PYTHONPATH=~/splunk-sdk-python.")
 
 def request(url, message, **kwargs):
     method = message['method'].lower()
diff --git a/examples/index.py b/examples/index.py
@@ -21,7 +21,11 @@
 
 from splunklib.client import connect
 
-from utils import *
+try:
+    from utils import *
+except ImportError:
+    raise Exception("Add the SDK repository to your PYTHONPATH to run the examples "
+                    "(e.g., export PYTHONPATH=~/splunk-sdk-python.")
 
 HELP_EPILOG = """
 Commands:
diff --git a/examples/info.py b/examples/info.py
@@ -21,7 +21,11 @@
 
 import splunklib.client as client
 
-from utils import parse
+try:
+    from utils import parse
+except ImportError:
+    raise Exception("Add the SDK repository to your PYTHONPATH to run the examples "
+                "(e.g., export PYTHONPATH=~/splunk-sdk-python.")
 
 if __name__ == "__main__":
     opts = parse(sys.argv[1:], {}, ".splunkrc")
diff --git a/examples/inputs.py b/examples/inputs.py
@@ -21,7 +21,11 @@
 
 from splunklib.client import connect
 
-from utils import parse
+try:
+    from utils import parse
+except ImportError:
+    raise Exception("Add the SDK repository to your PYTHONPATH to run the examples "
+                    "(e.g., export PYTHONPATH=~/splunk-sdk-python.")
 
 def main():
     opts = parse(sys.argv[1:], {}, ".splunkrc")
diff --git a/examples/job.py b/examples/job.py
@@ -26,7 +26,11 @@
 sys.path.insert(0, '../')
 
 from splunklib.client import connect
-from utils import error, parse, cmdline
+try:
+    from utils import error, parse, cmdline
+except ImportError:
+    raise Exception("Add the SDK repository to your PYTHONPATH to run the examples "
+                    "(e.g., export PYTHONPATH=~/splunk-sdk-python.")
 
 HELP_EPILOG = """
 Commands:            
diff --git a/examples/loggers.py b/examples/loggers.py
@@ -22,7 +22,11 @@
 
 import splunklib.client as client
 
-from utils import error, parse
+try:
+    from utils import parse
+except ImportError:
+    raise Exception("Add the SDK repository to your PYTHONPATH to run the examples "
+                    "(e.g., export PYTHONPATH=~/splunk-sdk-python.")
 
 def main(argv):
     usage = "usage: %prog [options]"
diff --git a/examples/oneshot.py b/examples/oneshot.py
@@ -24,7 +24,11 @@
 from splunklib.client import connect
 import splunklib.results as results
 
-import utils
+try:
+    import utils
+except ImportError:
+    raise Exception("Add the SDK repository to your PYTHONPATH to run the examples "
+                    "(e.g., export PYTHONPATH=~/splunk-sdk-python.")
 
 def pretty(response):
     reader = results.ResultsReader(response)
diff --git a/examples/results.py b/examples/results.py
@@ -26,45 +26,8 @@
 
 def pretty():
     reader = results.ResultsReader(sys.stdin)
-    while True:
-        kind = reader.read()
-        if kind == None: break
-        if kind == results.RESULT:
-            event = reader.value
-            pprint(event)
-
-def summary():
-    reader = results.ResultsReader(sys.stdin)
-    last = None
-    count = 0 
-    while True:
-        kind = reader.read()
-        if kind == None: 
-            print
-            break
-        if kind == results.RESULTS:
-            if last == results.RESULT: print
-            print "# Results: preview = %s" % reader.value['preview']
-        elif kind == results.MESSAGE:
-            if last == results.RESULT: print
-            print "# Messasge: %s" % reader.value['message']
-        elif kind == results.RESULT:
-            count += 1
-            if last != results.RESULT or count % 1 == 0: 
-                sys.stdout.write(".")
-                sys.stdout.flush()
-        last = kind
-
-def timeit():
-    start = time.time()
-    reader = results.ResultsReader(sys.stdin)
-    count = 0
-    while True:
-        kind = reader.read()
-        if kind == None: break
-        if kind == results.RESULT: count += 1
-    delta = time.time() - start
-    print "%d results in %f secs = %f results/sec" % (count, delta, count/delta)
+    for event in reader:
+        pprint(event)
 
 if __name__ == "__main__":
     pretty()
diff --git a/examples/saved_search/saved_search.py b/examples/saved_search/saved_search.py
@@ -22,7 +22,11 @@
 
 import splunklib.binding as binding
 
-import utils
+try:
+    import utils
+except ImportError:
+    raise Exception("Add the SDK repository to your PYTHONPATH to run the examples "
+                    "(e.g., export PYTHONPATH=~/splunk-sdk-python.")
 
 # these 'rules' allow for setting parameters primarily for creating saved searches
 RULES = {
diff --git a/examples/saved_searches.py b/examples/saved_searches.py
@@ -21,7 +21,11 @@
 
 from splunklib.client import connect
 
-from utils import parse
+try:
+    from utils import parse
+except ImportError:
+    raise Exception("Add the SDK repository to your PYTHONPATH to run the examples "
+                    "(e.g., export PYTHONPATH=~/splunk-sdk-python.")
 
 def main():
     opts = parse(sys.argv[1:], {}, ".splunkrc")
diff --git a/examples/search.py b/examples/search.py
diff --git a/examples/spcmd.py b/examples/spcmd.py
diff --git a/examples/spurl.py b/examples/spurl.py
diff --git a/examples/stail.py b/examples/stail.py
diff --git a/examples/submit.py b/examples/submit.py
diff --git a/examples/upload.py b/examples/upload.py
diff --git a/tests/testlib.py b/tests/testlib.py
