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