Merge pull request #7 from docmarionum1/master

Fix for #6

Author: docmarionum1

geosupport/function_info.py

@@ -90,7 +90,7 @@ def list_functions():
     )
     return '\n'.join(s)
 
-def function_help(function):
+def function_help(function, return_as_string=False):
     function = FUNCTIONS[function]
 
     s = [
@@ -117,7 +117,10 @@ def function_help(function):
 
     s = "\n".join(s)
 
-    return s
+    if return_as_string:
+        return s
+    else:
+        print(s)
 
 def input_help():
     s = [

geosupport/geosupport.py

@@ -129,13 +129,18 @@ def __getattr__(self, name):
     def __getitem__(self, name):
         return self.__getattr__(name)
 
-    def help(self, name=None):
+    def help(self, name=None, return_as_string=False):
         if name:
             if name.upper() == 'INPUT':
-                return input_help()
+                return_val = input_help()
             try:
-                return function_help(name)
+                return_val = function_help(name, return_as_string)
             except KeyError:
-                return "Function '%s' does not exist." % name
+                return_val = "Function '%s' does not exist." % name
         else:
-            return list_functions()
+            return_val = list_functions()
+
+        if return_as_string:
+            return return_val
+        elif return_val:
+            print(return_val)

setup.py

@@ -16,7 +16,7 @@
 
 setup(
     name='python-geosupport',
-    version='1.0.2',
+    version='1.0.3',
     url='https://github.com/ishiland/python-geosupport',
     description='Python bindings for NYC Geosupport Desktop Edition',
     long_description=long_description,

tests/unit/test_help.py

@@ -1,15 +1,18 @@
+import io
+import sys
+
 from ..testcase import TestCase
 
 class TestHelp(TestCase):
 
     def test_get_function_list(self):
-        h = self.geosupport.help()
+        h = self.geosupport.help(return_as_string=True)
 
         self.assertTrue("1" in h)
         self.assertTrue("bbl" in h)
 
     def test_function_help(self):
-        h = self.geosupport.help("bbl")
+        h = self.geosupport.help("bbl", return_as_string=True)
 
         self.assertTrue("Function BL processes" in h)
         self.assertTrue("Input: Borough" in h)
@@ -18,6 +21,17 @@ def test_function_help(self):
         self.assertTrue("Mode Switch" in h)
 
     def test_invalid_function_help(self):
-        h = self.geosupport.help("fake")
+        h = self.geosupport.help("fake", return_as_string=True)
 
         self.assertEqual(h, "Function 'fake' does not exist.")
+
+    def test_print(self):
+        h = io.StringIO()
+        sys.stdout = h
+
+        o = self.geosupport.help()
+
+        sys.stdout = sys.__stdout__
+
+        self.assertTrue("bbl" in h.getvalue())
+        self.assertTrue(o is None)