# ==================================================================================================================== #
# _____ ____ _ _ ___ _ _ _____ _ _ _ #
# _ __ _ _| ____| _ \ / \ / \ / _ \ _ _| |_ _ __ _ _| |_| ___(_) | |_ ___ _ __ #
# | '_ \| | | | _| | | | |/ _ \ / _ \ | | | | | | | __| '_ \| | | | __| |_ | | | __/ _ \ '__| #
# | |_) | |_| | |___| |_| / ___ \ / ___ \ | |_| | |_| | |_| |_) | |_| | |_| _| | | | || __/ | #
# | .__/ \__, |_____|____/_/ \_\/_/ \_(_)___/ \__,_|\__| .__/ \__,_|\__|_| |_|_|\__\___|_| #
# |_| |___/ |_| #
# ==================================================================================================================== #
# Authors: #
# Patrick Lehmann #
# #
# License: #
# ==================================================================================================================== #
# Copyright 2025-2026 Electronic Design Automation Abstraction (EDA²) #
# #
# 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 #
# ==================================================================================================================== #
#
"""
Tools to extract data from log files.
.. rubric:: Usage
.. code-block::
pyedaa-outputfilter vivado --file=toplevel.vds
"""
from typing import NoReturn, Optional as Nullable, ClassVar
from argparse import RawDescriptionHelpFormatter, Namespace
from textwrap import dedent
from pyTooling.Decorators import export
from pyTooling.Exceptions import ExceptionBase
from pyTooling.Attributes.ArgParse import ArgParseHelperMixin, DefaultHandler, CommandHandler
from pyTooling.Attributes.ArgParse.Flag import FlagArgument
from pyTooling.Attributes.ArgParse.Argument import StringArgument
from pyTooling.TerminalUI import TerminalApplication, Mode
from pyEDAA.OutputFilter import OutputFilterException
from pyEDAA.OutputFilter.CLI.Configuration import ConfigurationException
from pyEDAA.OutputFilter.CLI.Vivado import VivadoHandlers
[docs]
@export
class Application(TerminalApplication, VivadoHandlers, ArgParseHelperMixin):
"""Program class to implement the command line interface (CLI) using commands and options."""
programTitle: ClassVar[str] = "pyEDAA.OutputFilter Service Program"
[docs]
def __init__(self) -> None:
super().__init__(Mode.TextToStdOut_ErrorsToStdErr)
self.HeadLine = self.programTitle # TODO: needs improvement
# Call the constructor of the ArgParseMixin
textWidth = min(self.Width, 160)
class HelpFormatter(RawDescriptionHelpFormatter):
def __init__(self, *args, **kwargs):
kwargs['max_help_position'] = 30
kwargs['width'] = textWidth
super().__init__(*args, **kwargs)
ArgParseHelperMixin.__init__(
self,
prog="pyedaa-outputfilter",
description=dedent('''\
'pyEDAA.OutputFilter Service Program' to post-process log files from EDA tools.
'''),
# epilog=dedent("""\
# Currently the following inpu/output formats are supported:
# * JUnit XML (unit test reports - Java oriented format)
# * Cobertura XML (branch/statement coverage - Java oriented format)
# """),
formatter_class=HelpFormatter,
add_help=False
)
def Run(self) -> None:
ArgParseHelperMixin.Run(self)
[docs]
@DefaultHandler()
@FlagArgument("-q", "--quiet", dest="quiet", help="Reduce messages to a minimum.")
@FlagArgument("-v", "--verbose", dest="verbose", help="Print out detailed messages.")
@FlagArgument("-d", "--debug", dest="debug", help="Enable debug mode.")
def HandleDefault(self, _: Namespace) -> None:
"""Handle program calls without any command."""
self._PrintHeadline()
self._PrintHelp()
[docs]
@CommandHandler("help", help="Display help page(s) for the given command name.", description="Display help page(s) for the given command name.")
@StringArgument(dest="Command", metaName="Command", optional=True, help="Print help page(s) for a command.")
def HandleHelp(self, args: Namespace) -> None:
"""Handle program calls with command ``help``."""
self._PrintHeadline()
self._PrintHelp(args.Command)
[docs]
@CommandHandler("version", help="Display version information.", description="Display version information.")
def HandleVersion(self, _: Namespace) -> None:
"""Handle program calls with command ``version``."""
import pyEDAA.OutputFilter as DunderModule
self._PrintHeadline()
super()._PrintVersion(DunderModule, DunderModule.__name__)
[docs]
@export
def main() -> NoReturn:
"""
Entrypoint to start program execution.
This function should be called either from:
* :pycode:`if __name__ == "__main__":` or
* ``console_scripts`` entry point configured via ``setuptools`` in ``setup.py``.
This function creates an instance of :class:`Application` in a ``try ... except`` environment. Any exception caught is
formatted and printed before the program returns with a non-zero exit code.
"""
from sys import argv
program = Application()
program.Configure(
verbose=("-v" in argv or "--verbose" in argv),
debug=( "-d" in argv or "--debug" in argv),
silent=( "-q" in argv or "--quiet" in argv)
)
try:
program.Run()
except ConfigurationException as ex:
program.WriteLineToStdErr(f"{{RED}}[ERROR] {ex}{{NOCOLOR}}".format(**Application.Foreground))
if ex.__notes__ is not None:
for note in ex.__notes__:
program.WriteLineToStdErr(f"{{DARK_YELLOW}} [NOTE] {note}{{NOCOLOR}}".format(**Application.Foreground))
except OutputFilterException as ex:
program.WriteLineToStdErr(f"{{RED}}[ERROR] {ex}{{NOCOLOR}}".format(**Application.Foreground))
if ex.__cause__ is not None:
program.WriteLineToStdErr(f"{{DARK_YELLOW}}Because of: {ex.__cause__}{{NOCOLOR}}".format(**Application.Foreground))
except ExceptionBase as ex:
program.printExceptionBase(ex)
except NotImplementedError as ex:
program.PrintNotImplementedError(ex)
except Exception as ex:
program.PrintException(ex)
if __name__ == "__main__":
main()