1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
|
# ==================================================================================================================== #
# _____ ____ _ _ ____ __ _ #
# _ __ _ _| ____| _ \ / \ / \ / ___|___ _ __ / _(_) __ _ _ _ _ __ ___ #
# | '_ \| | | | _| | | | |/ _ \ / _ \ | | / _ \| '_ \| |_| |/ _` | | | | '__/ _ \ #
# | |_) | |_| | |___| |_| / ___ \ / ___ \ | |__| (_) | | | | _| | (_| | |_| | | | __/ #
# | .__/ \__, |_____|____/_/ \_\/_/ \_(_)____\___/|_| |_|_| |_|\__, |\__,_|_| \___| #
# |_| |___/ |___/ #
# ==================================================================================================================== #
# Authors: #
# Patrick Lehmann #
# #
# License: #
# ==================================================================================================================== #
# Copyright 2014-2022 Patrick Lehmann - Bötzingen, Germany #
# #
# Licensed under the Apache License, Version 2.0 (the "License"); #
# you may not use this file except in compliance with the License. #
# You may obtain a copy of the License at #
# #
# http://www.apache.org/licenses/LICENSE-2.0 #
# #
# Unless required by applicable law or agreed to in writing, software #
# distributed under the License is distributed on an "AS IS" BASIS, #
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. #
# See the License for the specific language governing permissions and #
# limitations under the License. #
# #
# SPDX-License-Identifier: Apache-2.0 #
# ==================================================================================================================== #
#
"""CLI application for standalone usage of pyEDAA.Configure and for testing."""
from argparse import RawDescriptionHelpFormatter
from platform import system as platform_system
from textwrap import dedent, wrap
from pyTooling.Decorators import export
from pyTooling.Exceptions import ExceptionBase
from pyTooling.MetaClasses import Singleton
from pyTooling.TerminalUI import LineTerminal, Severity
from pyAttributes.ArgParseAttributes import ArgParseMixin, CommonSwitchArgumentAttribute, DefaultAttribute, CommandAttribute, ArgumentAttribute
from pyEDAA.ToolSetup import __author__, __copyright__, __license__, __version__
@export
class Application(LineTerminal, ArgParseMixin):
HeadLine = "pyEDAA.ToolSetup - Test Application"
# load platform information (Windows, Linux, Darwin, ...)
__PLATFORM = platform_system()
def __init__(self, debug=False, verbose=False, quiet=False, sphinx=False):
super().__init__(verbose, debug, quiet)
# Initialize the Terminal class
# --------------------------------------------------------------------------
Singleton.Register(LineTerminal, self)
# Call the constructor of the ArgParseMixin
# --------------------------------------------------------------------------
textWidth = min(self.Width, 160)
description = dedent("""\
Test application to test pyEDAA.ToolSetup capabilities.
""")
epilog = "\n".join(wrap(dedent("""\
pyEDAA.ToolSetup is a layer in EDA² to find, configure and select installed EDA tools.
"""), textWidth, replace_whitespace=False))
class HelpFormatter(RawDescriptionHelpFormatter):
def __init__(self, *args, **kwargs):
kwargs['max_help_position'] = 30
kwargs['width'] = textWidth
super().__init__(*args, **kwargs)
ArgParseMixin.__init__(
self,
description=description,
epilog=epilog,
formatter_class=HelpFormatter,
add_help=False
)
# If executed in Sphinx to auto-document CLI arguments, exit now
# --------------------------------------------------------------------------
if sphinx:
return
# Change error and warning reporting
# --------------------------------------------------------------------------
self._LOG_MESSAGE_FORMAT__[Severity.Fatal] = "{DARK_RED}[FATAL] {message}{NOCOLOR}"
self._LOG_MESSAGE_FORMAT__[Severity.Error] = "{RED}[ERROR] {message}{NOCOLOR}"
self._LOG_MESSAGE_FORMAT__[Severity.Warning] = "{YELLOW}[WARNING] {message}{NOCOLOR}"
self._LOG_MESSAGE_FORMAT__[Severity.Normal] = "{GRAY}{message}{NOCOLOR}"
# class properties
# ============================================================================
@property
def Platform(self):
return self.__PLATFORM
def PrintHeadline(self):
self.WriteNormal(dedent("""\
{HEADLINE}{line}
{headline: ^80s}
{line}""").format(line="=" * 80, headline=self.HeadLine, **LineTerminal.Foreground))
# ============================================================================
# Common commands
# ============================================================================
# common arguments valid for all commands
# ----------------------------------------------------------------------------
@CommonSwitchArgumentAttribute("-d", "--debug", dest="debug", help="Enable debug mode.")
@CommonSwitchArgumentAttribute("-v", "--verbose", dest="verbose", help="Print out detailed messages.")
@CommonSwitchArgumentAttribute("-q", "--quiet", dest="quiet", help="Reduce messages to a minimum.")
def Run(self):
ArgParseMixin.Run(self)
@DefaultAttribute()
def HandleDefault(self, _):
self.PrintHeadline()
self.MainParser.print_help()
self.WriteNormal("")
self.exit()
# ----------------------------------------------------------------------------
# create the sub-parser for the "help" command
# ----------------------------------------------------------------------------
@CommandAttribute("help", help="Display help page(s) for the given command name.")
@ArgumentAttribute(metavar="Command", dest="Command", type=str, nargs="?", help="Print help page(s) for a command.")
def HandleHelp(self, args):
self.PrintHeadline()
if (args.Command is None):
self.MainParser.print_help()
elif (args.Command == "help"):
self.WriteError("This is a recursion ...")
else:
try:
self.SubParsers[args.Command].print_help()
except KeyError:
self.WriteError("Command {0} is unknown.".format(args.Command))
self.WriteNormal("")
self.exit()
# ----------------------------------------------------------------------------
# create the sub-parser for the "version" command
# ----------------------------------------------------------------------------
@CommandAttribute("version", help="Display tool and version information.")
def HandleInfo(self, args):
self.PrintHeadline()
copyrights = __copyright__.split("\n", 1)
self.WriteNormal("Copyright: {0}".format(copyrights[0]))
for copyright in copyrights[1:]:
self.WriteNormal(" {0}".format(copyright))
self.WriteNormal("License: {0}".format(__license__))
authors = __author__.split(", ")
self.WriteNormal("Authors: {0}".format(authors[0]))
for author in authors[1:]:
self.WriteNormal(" {0}".format(author))
self.WriteNormal("Version: {0}".format(__version__))
self.exit()
# main program
def main(): # mccabe:disable=MC0001
"""This is the entry point for pyVHDLParser written as a function.
1. It extracts common flags from the script's arguments list, before :py:class:`~argparse.ArgumentParser` is fully loaded.
2. It creates an instance of VHDLParser and hands over to a class based execution.
All is wrapped in a big ``try..except`` block to catch every unhandled exception.
3. Shutdown the script and return its exit code.
"""
from sys import argv as sys_argv
debug = "-d" in sys_argv
verbose = "-v" in sys_argv
quiet = "-q" in sys_argv
try:
# handover to a class instance
app = Application(debug, verbose, quiet)
app.Run()
app.exit()
# except (CommonException, ConfigurationException) as ex:
# print("{RED}ERROR:{NOCOLOR} {message}".format(message=ex.message, **Init.Foreground))
# cause = ex.__cause__
# if isinstance(cause, FileNotFoundError):
# print("{YELLOW} FileNotFound:{NOCOLOR} '{cause}'".format(cause=str(cause), **Init.Foreground))
# elif isinstance(cause, NotADirectoryError):
# print("{YELLOW} NotADirectory:{NOCOLOR} '{cause}'".format(cause=str(cause), **Init.Foreground))
# elif isinstance(cause, ParserException):
# print("{YELLOW} ParserException:{NOCOLOR} {cause}".format(cause=str(cause), **Init.Foreground))
# cause = cause.__cause__
# if (cause is not None):
# print("{YELLOW} {name}:{NOCOLOR} {cause}".format(name=cause.__class__.__name__, cause= str(cause), **Init.Foreground))
#
# if (not (verbose or debug)):
# print()
# print("{CYAN} Use '-v' for verbose or '-d' for debug to print out extended messages.{NOCOLOR}".format(**Init.Foreground))
# LineTerminal.exit(1)
except ExceptionBase as ex: LineTerminal.printExceptionBase(ex)
except NotImplementedError as ex: LineTerminal.printNotImplementedError(ex)
#except ImportError as ex: printImportError(ex)
except Exception as ex: LineTerminal.printException(ex)
# entry point
if __name__ == "__main__":
LineTerminal.versionCheck((3,6,0))
main()
|