Set exit status to 0 for --help. Fixes #20

CHANGES.txt

@@ -12,6 +12,8 @@
 
 - ``httpok`` now has a ``--name`` option like ``memmon``.
 
+- All commands now return exit status 0 from ``--help``.
+
 0.12 (2016-09-03)
 -----------------
 

superlance/crashmail.py

@@ -65,15 +65,16 @@
 
 """
 
+import getopt
 import os
 import sys
 
 from supervisor import childutils
 
 
-def usage():
+def usage(exitstatus=255):
     print(doc)
-    sys.exit(255)
+    sys.exit(exitstatus)
 
 
 class CrashMail:
@@ -145,7 +146,6 @@ def mail(self, email, subject, msg):
 
 
 def main(argv=sys.argv):
-    import getopt
     short_args = "hp:ao:s:m:"
     long_args = [
         "help",
@@ -170,7 +170,7 @@ def main(argv=sys.argv):
     for option, value in opts:
 
         if option in ('-h', '--help'):
-            usage()
+            usage(exitstatus=0)
 
         if option in ('-p', '--program'):
             programs.append(value)

superlance/httpok.py

@@ -100,6 +100,7 @@
 
 """
 
+import getopt
 import os
 import socket
 import sys
@@ -113,9 +114,9 @@
 
 from superlance import timeoutconn
 
-def usage():
+def usage(exitstatus=255):
     print(doc)
-    sys.exit(255)
+    sys.exit(exitstatus)
 
 class HTTPOk:
     connclass = None
@@ -315,7 +316,6 @@ def restart(self, spec, write):
 
 
 def main(argv=sys.argv):
-    import getopt
     short_args="hp:at:c:b:s:m:g:d:eE"
     long_args=[
         "help",
@@ -337,6 +337,11 @@ def main(argv=sys.argv):
     except:
         usage()
 
+    # check for -h must be done before positional args check
+    for option, value in opts:
+        if option in ('-h', '--help'):
+            usage(exitstatus=0)
+
     if not args:
         usage()
     if len(args) > 1:
@@ -357,9 +362,6 @@ def main(argv=sys.argv):
 
     for option, value in opts:
 
-        if option in ('-h', '--help'):
-            usage()
-
         if option in ('-p', '--program'):
             programs.append(value)
 

superlance/memmon.py

@@ -80,6 +80,7 @@
 memmon.py -p program1=200MB -p theprog:thegroup=100MB -g thegroup=100MB -a 1GB -s "/usr/sbin/sendmail -t -i" -m [email protected] -n "Project 1"
 """
 
+import getopt
 import os
 import sys
 import time
@@ -90,9 +91,9 @@
 from supervisor import childutils
 from supervisor.datatypes import byte_size, SuffixMultiplier
 
-def usage():
+def usage(exitstatus=255):
     print(doc)
-    sys.exit(255)
+    sys.exit(exitstatus)
 
 def shell(cmd):
     with os.popen(cmd) as f:
@@ -333,8 +334,9 @@ def parse_seconds(option, value):
         usage()
     return seconds
 
+help_request = object()  # returned from memmon_from_args to indicate --help
+
 def memmon_from_args(arguments):
-    import getopt
     short_args = "hcp:g:a:s:m:n:u:"
     long_args = [
         "help",
@@ -367,7 +369,7 @@ def memmon_from_args(arguments):
     for option, value in opts:
 
         if option in ('-h', '--help'):
-            return None
+            return help_request
 
         if option in ('-c', '--cumulative'):
             cumulative = True
@@ -408,8 +410,9 @@ def memmon_from_args(arguments):
 
 def main():
     memmon = memmon_from_args(sys.argv[1:])
-    if memmon is None:
-        # something went wrong or -h has been given
+    if memmon is help_request:  # --help
+        usage(exitstatus=0)
+    elif memmon is None:  # something went wrong
         usage()
     memmon.rpc = childutils.getRPCInterface(os.environ)
     memmon.runforever()

superlance/process_state_email_monitor.py

@@ -12,10 +12,11 @@
 # FITNESS FOR A PARTICULAR PURPOSE
 #
 ##############################################################################
+import copy
+import optparse
 import os
-import sys
 import smtplib
-import copy
+import sys
 
 from email.mime.text import MIMEText
 from email.utils import formatdate, make_msgid
@@ -31,9 +32,7 @@ class ProcessStateEmailMonitor(ProcessStateMonitor):
 
     @classmethod
     def _get_opt_parser(cls):
-        from optparse import OptionParser
-
-        parser = OptionParser()
+        parser = optparse.OptionParser()
         parser.add_option("-i", "--interval", dest="interval", type="float", default=1.0,
                         help="batch interval in minutes (defaults to 1 minute)")
         parser.add_option("-t", "--toEmail", dest="to_emails",

superlance/tests/memmon_test.py

@@ -1,8 +1,11 @@
 import unittest
 from superlance.compat import StringIO
 from superlance.compat import maxint
-from superlance.memmon import memmon_from_args
-from superlance.memmon import seconds_size
+from superlance.memmon import (
+    help_request,
+    memmon_from_args,
+    seconds_size
+    )
 from superlance.tests.dummy import DummyRPCServer
 
 class MemmonTests(unittest.TestCase):
@@ -348,8 +351,9 @@ def test_argparser(self):
         # help
         arguments = ['-h', ]
         memmon = memmon_from_args(arguments)
-        self.assertTrue(memmon is None, '-h returns None to make main() script print usage')
-
+        self.assertTrue(memmon is help_request,
+            '-h returns help_request to make main() script print usage'
+            )
 
         #all arguments
         arguments = ['-c',