1#!/usr/bin/env python 2 3import sys 4import __builtin__ 5import os 6 7# python puts the program's directory path in sys.path[0]. In other words, 8# the user ordinarily has no way to override python's choice of a module from 9# its own dir. We want to have that ability in our environment. However, we 10# don't want to break any established python modules that depend on this 11# behavior. So, we'll save the value from sys.path[0], delete it, import our 12# modules and then restore sys.path to its original value. 13 14save_path_0 = sys.path[0] 15del sys.path[0] 16 17from gen_print import * 18from gen_arg import * 19from gen_plug_in import * 20 21# Restore sys.path[0]. 22sys.path.insert(0, save_path_0) 23 24 25# Create parser object to process command line parameters and args. 26 27# Create parser object. 28parser = argparse.ArgumentParser( 29 usage='%(prog)s [OPTIONS] [PLUG_IN_DIR_PATHS]', 30 description="%(prog)s will validate the plug-in packages passed to it." + 31 " It will also print a list of the absolute plug-in" + 32 " directory paths for use by the calling program.", 33 formatter_class=argparse.ArgumentDefaultsHelpFormatter, 34 prefix_chars='-+') 35 36# Create arguments. 37parser.add_argument( 38 'plug_in_dir_paths', 39 nargs='?', 40 default="", 41 help=plug_in_dir_paths_help_text + default_string) 42 43parser.add_argument( 44 '--mch_class', 45 default="obmc", 46 help=mch_class_help_text + default_string) 47 48# The stock_list will be passed to gen_get_options. We populate it with the 49# names of stock parm options we want. These stock parms are pre-defined by 50# gen_get_options. 51stock_list = [("test_mode", 0), ("quiet", 1), ("debug", 0)] 52 53 54def exit_function(signal_number=0, 55 frame=None): 56 57 r""" 58 Execute whenever the program ends normally or with the signals that we 59 catch (i.e. TERM, INT). 60 """ 61 62 dprint_executing() 63 dprint_var(signal_number) 64 65 qprint_pgm_footer() 66 67 68def signal_handler(signal_number, frame): 69 70 r""" 71 Handle signals. Without a function to catch a SIGTERM or SIGINT, our 72 program would terminate immediately with return code 143 and without 73 calling our exit_function. 74 """ 75 76 # Our convention is to set up exit_function with atexit.registr() so 77 # there is no need to explicitly call exit_function from here. 78 79 dprint_executing() 80 81 # Calling exit prevents us from returning to the code that was running 82 # when we received the signal. 83 exit(0) 84 85 86def validate_parms(): 87 88 r""" 89 Validate program parameters, etc. Return True or False accordingly. 90 """ 91 92 gen_post_validation(exit_function, signal_handler) 93 94 return True 95 96 97def main(): 98 99 r""" 100 This is the "main" function. The advantage of having this function vs 101 just doing this in the true mainline is that you can: 102 - Declare local variables 103 - Use "return" instead of "exit". 104 - Indent 4 chars like you would in any function. 105 This makes coding more consistent, i.e. it's easy to move code from here 106 into a function and vice versa. 107 """ 108 109 if not gen_get_options(parser, stock_list): 110 return False 111 112 if not validate_parms(): 113 return False 114 115 qprint_pgm_header() 116 117 # Access program parameter globals. 118 global plug_in_dir_paths 119 global mch_class 120 121 plug_in_packages_list = return_plug_in_packages_list(plug_in_dir_paths, 122 mch_class) 123 qpvar(plug_in_packages_list) 124 125 # As stated in the help text, this program must print the full paths of 126 # each selected plug in. 127 for plug_in_dir_path in plug_in_packages_list: 128 print(plug_in_dir_path) 129 130 return True 131 132 133# Main 134 135if not main(): 136 exit(1) 137