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