Python starter script

From Noah.org
Revision as of 11:35, 2 August 2007 by Root (talk | contribs)
Jump to navigationJump to search


My starter template for a Python CLI script

This is my quintessential Python starter script. This is what I use to start most of my python scripts. This is geared toward a command-line script.

#!/usr/bin/env python

"""This describes how to use the script. 
This docstring will be printed by exit_with_usage() 
if there is a problem or if the user requests help (-?, --help, etc.).

$Id$
"""

import sys, os, traceback
import re
import getopt
import time
from pexpect import run, spawn

def exit_with_usage ():
    print globals()['__doc__']
    os._exit(1)

def parse_args (options='', long_options=[]):
    try:
        optlist, args = getopt.getopt(sys.argv[1:], options+'h?', long_options+['help','h','?'])
    except Exception, e:
        print str(e)
        exit_with_usage()
    options = dict(optlist)
    if [elem for elem in options if elem in ['-h','--h','-?','--?','--help']]:
        exit_with_usage()
    return (options, args)

def main ():
    (options, args) = parse_args('v')
    # if args<=0:
    #     exit_with_usage()
    if '-v' in options:
        verbose = True
    else:
        verbose = False
    # TODO: Do something

if __name__ == '__main__':
    try:
        start_time = time.time()
        print time.asctime()
        main()
        print time.asctime()
        print "TOTAL TIME IN MINUTES:",
        print (time.time() - start_time) / 60.0
        sys.exit(0)
    except SystemExit, e:
        raise e
    except Exception, e:
        print 'ERROR, UNEXPECTED EXCEPTION'
        print str(e)
        traceback.print_exc()
        os._exit(1)