|
| 1 | +# -*- coding: utf-8 -*- |
| 2 | +# |
| 3 | +# Licensed under the terms of the BSD 3-Clause or the CeCILL-B License |
| 4 | +# (see plotpy/__init__.py for details) |
| 5 | + |
| 6 | +""" |
| 7 | +Plotpy environmnent utilities |
| 8 | +""" |
| 9 | + |
| 10 | +import argparse |
| 11 | +import enum |
| 12 | +import os |
| 13 | +import platform |
| 14 | +import pprint |
| 15 | +import sys |
| 16 | + |
| 17 | + |
| 18 | +class VerbosityLevels(enum.Enum): |
| 19 | + """Print verbosity levels (for testing purpose)""" |
| 20 | + |
| 21 | + QUIET = "quiet" |
| 22 | + MINIMAL = "minimal" |
| 23 | + NORMAL = "normal" |
| 24 | + |
| 25 | + |
| 26 | +class PlotpyExecEnv: |
| 27 | + """Object representing CodraFT test environment""" |
| 28 | + |
| 29 | + UNATTENDED_ARG = "unattended" |
| 30 | + VERBOSE_ARG = "verbose" |
| 31 | + SCREENSHOT_ARG = "screenshot" |
| 32 | + DELAY_ARG = "delay" |
| 33 | + UNATTENDED_ENV = "PLOTPY_UNATTENDED_TESTS" |
| 34 | + VERBOSE_ENV = "PLOTPY_VERBOSITY_LEVEL" |
| 35 | + SCREENSHOT_ENV = "PLOTPY_TAKE_SCREENSHOT" |
| 36 | + DELAY_ENV = "PLOTPY_DELAY_BEFORE_QUIT" |
| 37 | + |
| 38 | + def __init__(self): |
| 39 | + self.h5files = None |
| 40 | + self.h5browser_file = None |
| 41 | + self.demo_mode = False |
| 42 | + self.parse_args() |
| 43 | + |
| 44 | + def enable_demo_mode(self, delay: int): |
| 45 | + """Enable demo mode""" |
| 46 | + self.demo_mode = True |
| 47 | + self.unattended = True |
| 48 | + self.delay = delay |
| 49 | + |
| 50 | + @staticmethod |
| 51 | + def __get_mode(env): |
| 52 | + """Get mode value""" |
| 53 | + return os.environ.get(env) is not None |
| 54 | + |
| 55 | + @staticmethod |
| 56 | + def __set_mode(env, value): |
| 57 | + """Set mode value""" |
| 58 | + if env in os.environ: |
| 59 | + os.environ.pop(env) |
| 60 | + if value: |
| 61 | + os.environ[env] = "1" |
| 62 | + |
| 63 | + @property |
| 64 | + def unattended(self): |
| 65 | + """Get unattended value""" |
| 66 | + return self.__get_mode(self.UNATTENDED_ENV) |
| 67 | + |
| 68 | + @unattended.setter |
| 69 | + def unattended(self, value): |
| 70 | + """Set unattended value""" |
| 71 | + self.__set_mode(self.UNATTENDED_ENV, value) |
| 72 | + |
| 73 | + @property |
| 74 | + def screenshot(self): |
| 75 | + """Get screenshot value""" |
| 76 | + return self.__get_mode(self.SCREENSHOT_ENV) |
| 77 | + |
| 78 | + @screenshot.setter |
| 79 | + def screenshot(self, value): |
| 80 | + """Set screenshot value""" |
| 81 | + self.__set_mode(self.SCREENSHOT_ENV, value) |
| 82 | + if value: # pragma: no cover |
| 83 | + self.unattended = value |
| 84 | + |
| 85 | + @property |
| 86 | + def verbose(self): |
| 87 | + """Get verbosity level""" |
| 88 | + return os.environ.get(self.VERBOSE_ENV, VerbosityLevels.NORMAL.value) |
| 89 | + |
| 90 | + @verbose.setter |
| 91 | + def verbose(self, value): |
| 92 | + """Set verbosity level""" |
| 93 | + os.environ[self.VERBOSE_ENV] = value |
| 94 | + |
| 95 | + @property |
| 96 | + def delay(self): |
| 97 | + """Delay (seconds) before quitting application in unattended mode""" |
| 98 | + try: |
| 99 | + return int(os.environ.get(self.DELAY_ENV)) |
| 100 | + except (TypeError, ValueError): |
| 101 | + return 0 |
| 102 | + |
| 103 | + @delay.setter |
| 104 | + def delay(self, value: int): |
| 105 | + """Set delay (seconds) before quitting application in unattended mode""" |
| 106 | + os.environ[self.DELAY_ENV] = str(value) |
| 107 | + |
| 108 | + def parse_args(self): |
| 109 | + """Parse command line arguments""" |
| 110 | + parser = argparse.ArgumentParser(description="Run CodraFT") |
| 111 | + # parser.add_argument( |
| 112 | + # "h5", |
| 113 | + # nargs="?", |
| 114 | + # type=str, |
| 115 | + # help="HDF5 file names (separated by ';'), " |
| 116 | + # "optionally with dataset name (separated by ',')", |
| 117 | + # ) |
| 118 | + # parser.add_argument( |
| 119 | + # "-b", |
| 120 | + # "--h5browser", |
| 121 | + # required=False, |
| 122 | + # type=str, |
| 123 | + # metavar="path", |
| 124 | + # help="path to open with HDF5 browser", |
| 125 | + # ) |
| 126 | + # parser.add_argument( |
| 127 | + # "-v", "--version", action="store_true", help="show CodraFT version" |
| 128 | + # ) |
| 129 | + parser.add_argument( |
| 130 | + "--mode", |
| 131 | + choices=[self.UNATTENDED_ARG, self.SCREENSHOT_ARG], |
| 132 | + required=False, |
| 133 | + help="unattended: non-interactive test mode ; " |
| 134 | + "screenshot: unattended mode, with automatic screenshots", |
| 135 | + ) |
| 136 | + parser.add_argument( |
| 137 | + "--" + self.DELAY_ARG, |
| 138 | + type=int, |
| 139 | + default=0, |
| 140 | + help="delay (seconds) before quitting application in unattended mode", |
| 141 | + ) |
| 142 | + parser.add_argument( |
| 143 | + "--" + self.VERBOSE_ARG, |
| 144 | + choices=[lvl.value for lvl in VerbosityLevels], |
| 145 | + required=False, |
| 146 | + default=VerbosityLevels.NORMAL.value, |
| 147 | + help="verbosity level: for debugging/testing purpose", |
| 148 | + ) |
| 149 | + args, _unknown = parser.parse_known_args() |
| 150 | + # if args.h5: |
| 151 | + # self.h5files = args.h5.split(";") |
| 152 | + # if args.h5browser: |
| 153 | + # self.h5browser_file = args.h5browser |
| 154 | + # if args.version: |
| 155 | + # version = os.environ["CODRAFT_VERSION"] |
| 156 | + # print(f"CodraFT {version} on {platform.system()}") |
| 157 | + # sys.exit() |
| 158 | + self.set_env_from_args(args) |
| 159 | + |
| 160 | + def set_env_from_args(self, args): |
| 161 | + """Set appropriate environment variables""" |
| 162 | + if args.mode is not None: |
| 163 | + self.unattended = args.mode == self.UNATTENDED_ARG |
| 164 | + self.screenshot = args.mode == self.SCREENSHOT_ARG |
| 165 | + if args.verbose is not None: |
| 166 | + self.verbose = args.verbose |
| 167 | + self.delay = args.delay |
| 168 | + |
| 169 | + def print(self, *objects, sep=" ", end="\n", file=sys.stdout, flush=False): |
| 170 | + """Print in file, depending on verbosity level""" |
| 171 | + # print(f"unattended={self.unattended} ; verbose={self.verbose} ; ") |
| 172 | + # print(f"screenshot={self.screenshot}; delay={self.delay}") |
| 173 | + if (self.verbose != VerbosityLevels.QUIET.value) and ( |
| 174 | + self.verbose != VerbosityLevels.MINIMAL.value or file == sys.stderr |
| 175 | + ): |
| 176 | + print(*objects, sep=sep, end=end, file=file, flush=flush) |
| 177 | + # TODO: [P4] Eventually add logging here |
| 178 | + |
| 179 | + def pprint( |
| 180 | + self, |
| 181 | + obj, |
| 182 | + stream=None, |
| 183 | + indent=1, |
| 184 | + width=80, |
| 185 | + depth=None, |
| 186 | + compact=False, |
| 187 | + sort_dicts=True, |
| 188 | + ): |
| 189 | + """Pretty-print in stream, depending on verbosity level""" |
| 190 | + if (self.verbose != VerbosityLevels.QUIET.value) and ( |
| 191 | + self.verbose != VerbosityLevels.MINIMAL.value or stream == sys.stderr |
| 192 | + ): |
| 193 | + pprint.pprint( |
| 194 | + obj, |
| 195 | + stream=stream, |
| 196 | + indent=indent, |
| 197 | + width=width, |
| 198 | + depth=depth, |
| 199 | + compact=compact, |
| 200 | + sort_dicts=sort_dicts, |
| 201 | + ) |
| 202 | + |
| 203 | + |
| 204 | +execenv = PlotpyExecEnv() |
0 commit comments