pyEDAA.OutputFilter 0.1.0__py3-none-any.whl

pyEDAA/OutputFilter/CLI/Vivado.py

@@ -0,0 +1,167 @@
+# ==================================================================================================================== #
+#               _____ ____    _        _      ___        _               _   _____ _ _ _                               #
+#   _ __  _   _| ____|  _ \  / \      / \    / _ \ _   _| |_ _ __  _   _| |_|  ___(_) | |_ ___ _ __                    #
+#  | '_ \| | | |  _| | | | |/ _ \    / _ \  | | | | | | | __| '_ \| | | | __| |_  | | | __/ _ \ '__|                   #
+#  | |_) | |_| | |___| |_| / ___ \  / ___ \ | |_| | |_| | |_| |_) | |_| | |_|  _| | | | ||  __/ |                      #
+#  | .__/ \__, |_____|____/_/   \_\/_/   \_(_)___/ \__,_|\__| .__/ \__,_|\__|_|   |_|_|\__\___|_|                      #
+#  |_|    |___/                                             |_|                                                        #
+# ==================================================================================================================== #
+# Authors:                                                                                                             #
+#   Patrick Lehmann                                                                                                    #
+#                                                                                                                      #
+# License:                                                                                                             #
+# ==================================================================================================================== #
+# Copyright 2025-2025 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                                                                                  #
+# ==================================================================================================================== #
+#
+from argparse import Namespace
+from pathlib  import Path
+from sys      import stdin
+from typing   import NoReturn
+
+from pyTooling.Decorators                     import readonly
+from pyTooling.MetaClasses                    import ExtendedType
+from pyTooling.Common                         import count
+from pyTooling.Attributes.ArgParse            import CommandHandler
+from pyTooling.Attributes.ArgParse.Flag       import LongFlag
+from pyTooling.Attributes.ArgParse.ValuedFlag import LongValuedFlag
+from pyTooling.Stopwatch                      import Stopwatch
+
+from pyEDAA.OutputFilter.Xilinx.Synthesis import Processor, Preamble, WritingSynthesisReport
+
+
+class Proto(metaclass=ExtendedType, mixin=True):
+	@readonly
+	def Verbose(self) -> bool:
+		...
+
+	@readonly
+	def Width(self) -> int:
+		...
+
+	def _PrintHeadline(self):
+		...
+
+	def WriteDebug(self, a: str, appendLinebreak: bool = True):
+		...
+
+	def WriteVerbose(self, a: str, appendLinebreak: bool = True):
+		...
+
+	def WriteNormal(self, a: str, appendLinebreak: bool = True):
+		...
+
+	def WriteWarning(self, a: str, appendLinebreak: bool = True):
+		...
+
+	def WriteCritical(self, a: str, appendLinebreak: bool = True):
+		...
+
+	def WriteError(self, a: str, appendLinebreak: bool = True):
+		...
+
+	def WriteFatal(self, a: str, appendLinebreak: bool = True, immediateExit: bool = True):
+		...
+
+	def Exit(self, i: int = 0) -> NoReturn:
+		...
+
+
+class VivadoHandlers(Proto, metaclass=ExtendedType, mixin=True):
+	@CommandHandler("vivado-synth", help="Parse AMD/Xilinx Vivado Synthesis log files.", description="Parse AMD/Xilinx Vivado Synthesis log files.")
+	@LongValuedFlag("--file", dest="logfile", metaName='Synthesis Log', help="Synthesis log file (*.vds).")
+	@LongFlag("--info", dest="info", help="Print info messages.")
+	@LongFlag("--warning", dest="warning", help="Print warning messages.")
+	@LongFlag("--critical", dest="critical", help="Print critical warning messages.")
+	@LongFlag("--error", dest="error", help="Print error messages.")
+	@LongFlag("--influxdb", dest="influxdb", help="Write statistics as InfluxDB line protocol file (*.line).")
+	# @LongValuedFlag("--file", dest="logfile", metaName='Synthesis Log', help="Synthesis log file (*.vds).")
+	def HandleVivadoSynthesis(self, args: Namespace) -> None:
+		"""Handle program calls with command ``vivado-synth``."""
+		self._PrintHeadline()
+
+		returnCode = 0
+		if args.logfile is None:
+			self.WriteError(f"Option '--file=<VDS file>' is missing.")
+			returnCode = 3
+
+		logfile = Path(args.logfile)
+		if not logfile.exists():
+			self.WriteError(f"Vivado synthesis log file '{logfile}' doesn't exist.")
+			returnCode = 4
+
+		if returnCode != 0:
+			self.Exit(returnCode)
+
+		processor = Processor(logfile)
+		processor.Parse()
+
+		if args.info:
+			self.WriteNormal(f"INFO messages: {len(processor.InfoMessages)}")
+			for message in processor.InfoMessages:
+				self.WriteNormal(f"  {message}")
+		if args.warning:
+			self.WriteNormal(f"WARNING messages: {len(processor.WarningMessages)}")
+			for message in processor.WarningMessages:
+				self.WriteNormal(f"  {message}")
+		if args.critical:
+			self.WriteNormal(f"CRITICAL WARNING: messages {len(processor.CriticalWarningMessages)}")
+			for message in processor.CriticalWarningMessages:
+				self.WriteNormal(f"  {message}")
+		if args.error:
+			self.WriteNormal(f"ERROR messages: {len(processor.ErrorMessages)}")
+			for message in processor.ErrorMessages:
+				self.WriteNormal(f"  {message}")
+
+		if args.influxdb:
+			influxString  =  "vivado_synthesis_overview"
+			influxString += f",version={processor[Preamble].ToolVersion}"
+			influxString += f",branch=main"
+			influxString += f",design=Stopwatch"
+			influxString += " "
+			influxString += f"processing_duration={processor.Duration:.3f}"
+			influxString += f",synthesis_duration={processor[WritingSynthesisReport].Duration:.1f}"
+			influxString += f",info_count={len(processor.InfoMessages)}u"
+			influxString += f",warning_count={len(processor.WarningMessages)}u"
+			influxString += f",critical_count={len(processor.CriticalWarningMessages)}u"
+			influxString += f",error_count={len(processor.ErrorMessages)}u"
+			influxString += f",blackbox_count={len(processor[WritingSynthesisReport].Blackboxes)}u"
+			influxString +=  "\n"
+			influxString +=  "vivado_synthesis_cells"
+			influxString += f",version={processor[Preamble].ToolVersion}"
+			influxString += f",branch=main"
+			influxString += f",design=Stopwatch"
+			influxString += " "
+			influxString += ",".join(f"{cellName}={cellCount}" for cellName, cellCount in processor[WritingSynthesisReport].Cells.items() if not cellName.endswith("_bbox"))
+
+			self.WriteNormal(influxString)
+
+		self.WriteNormal("Summary:")
+		self.WriteNormal(f"  Processing duration: {processor.Duration:.3f} s")
+		self.WriteNormal(f"  Info: {len(processor.InfoMessages)}  Warning: {len(processor.WarningMessages)}  Critical Warning: {len(processor.CriticalWarningMessages)}  Error: {len(processor.ErrorMessages)}")
+
+		self.ExitOnPreviousErrors()
+
+	@CommandHandler("vivado-impl", help="Parse AMD/Xilinx Vivado Implementation log files.", description="Parse AMD/Xilinx Vivado Implementation log files.")
+	@LongValuedFlag("--file", dest="logfile", metaName='Implementation Log', help="Implementation log file (*.vdi).")
+	@LongFlag("--info", dest="info", help="Print info messages.")
+	@LongFlag("--warning", dest="warning", help="Print warning messages.")
+	@LongFlag("--critical", dest="critical", help="Print critical warning messages.")
+	@LongFlag("--error", dest="error", help="Print error messages.")
+	def HandleVivadoImplementation(self, args: Namespace) -> None:
+		"""Handle program calls with command ``vivado-impl``."""
+		self._PrintHeadline()

pyEDAA/OutputFilter/CLI/__init__.py

@@ -0,0 +1,183 @@
+# ==================================================================================================================== #
+#               _____ ____    _        _      ___        _               _   _____ _ _ _                               #
+#   _ __  _   _| ____|  _ \  / \      / \    / _ \ _   _| |_ _ __  _   _| |_|  ___(_) | |_ ___ _ __                    #
+#  | '_ \| | | |  _| | | | |/ _ \    / _ \  | | | | | | | __| '_ \| | | | __| |_  | | | __/ _ \ '__|                   #
+#  | |_) | |_| | |___| |_| / ___ \  / ___ \ | |_| | |_| | |_| |_) | |_| | |_|  _| | | | ||  __/ |                      #
+#  | .__/ \__, |_____|____/_/   \_\/_/   \_(_)___/ \__,_|\__| .__/ \__,_|\__|_|   |_|_|\__\___|_|                      #
+#  |_|    |___/                                             |_|                                                        #
+# ==================================================================================================================== #
+# Authors:                                                                                                             #
+#   Patrick Lehmann                                                                                                    #
+#                                                                                                                      #
+# License:                                                                                                             #
+# ==================================================================================================================== #
+# Copyright 2025-2025 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-synthesis --file=toplevel.vds \
+     --info     --info-file=info.log \
+     --warning  --warning-file=warning.log \
+     --critical --critical-file=critical.log \
+     --error    --error-file=error.log \
+     --influxdb-file synthesis.line
+"""
+from typing   import NoReturn, Optional as Nullable
+
+from argparse import RawDescriptionHelpFormatter, Namespace
+from textwrap import dedent
+
+from pyTooling.Decorators                     import export
+from pyTooling.Attributes.ArgParse            import ArgParseHelperMixin, DefaultHandler, CommandHandler
+from pyTooling.Attributes.ArgParse.Argument   import StringArgument
+from pyTooling.TerminalUI                     import TerminalApplication
+
+from pyEDAA.OutputFilter                      import __version__, __copyright__, __license__
+from pyEDAA.OutputFilter                      import OutputFilterException
+from pyEDAA.OutputFilter.CLI.Vivado           import VivadoHandlers
+
+
+# todo: merge into application
+# todo: printheadline, printversion (see pyVersioning)
+@export
+class ProgramBase(TerminalApplication):
+	"""Base-class for all program classes."""
+
+	programTitle: str
+
+	def _PrintHeadline(self) -> None:
+		"""Print the program's headline."""
+		print("{line}".format(line="=" * 120))
+		print("{headline: ^120s}".format(headline=self.programTitle))
+		print("{line}".format(line="=" * 120))
+
+
+@export
+class Application(ProgramBase, VivadoHandlers, ArgParseHelperMixin):
+	"""Program class to implement the command line interface (CLI) using commands and options."""
+
+	programTitle = "pyEDAA.OutputFilter Service Program"
+	ISSUE_TRACKER_URL = "https://github.com/edaa-org/pyEDAA.OutputFilter/issues"
+
+	def __init__(self) -> None:
+		super().__init__()
+
+		# Call the constructor of the ArgParseMixin
+		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=RawDescriptionHelpFormatter,
+		  add_help=False
+		)
+
+#	@CommonSwitchArgumentAttribute("-q", "--quiet",   dest="quiet",   help="Reduce messages to a minimum.")
+#	@CommonSwitchArgumentAttribute("-v", "--verbose", dest="verbose", help="Print out detailed messages.")
+#	@CommonSwitchArgumentAttribute("-d", "--debug",   dest="debug",   help="Enable debug mode.")
+	def Run(self) -> None:
+		ArgParseHelperMixin.Run(self)
+
+	@DefaultHandler()
+	def HandleDefault(self, _: Namespace) -> None:
+		"""Handle program calls without any command."""
+		self._PrintHeadline()
+		self._PrintHelp()
+
+	@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)
+
+	@CommandHandler("version", help="Display version information.", description="Display version information.")
+	def HandleVersion(self, _: Namespace) -> None:
+		"""Handle program calls with command ``version``."""
+		self._PrintHeadline()
+		self._PrintVersion()
+
+
+	def _PrintVersion(self) -> None:
+		"""Helper function to print the version information."""
+		print(dedent(f"""\
+			Copyright: {__copyright__}
+			License:   {__license__}
+			Version:   v{__version__}
+			""")
+		)
+
+	def _PrintHelp(self, command: Nullable[str] = None) -> None:
+		"""Helper function to print the command line parsers help page(s)."""
+		if command is None:
+			self.MainParser.print_help()
+		elif command == "help":
+			print("This is a recursion ...")
+		else:
+			try:
+				self.SubParsers[command].print_help()
+			except KeyError:
+				print(f"Command {command} is unknown.")
+
+
+@export
+def main() -> NoReturn:
+	"""
+	Entrypoint to start program execution.
+
+	This function should be called either from:
+	 * ``if __name__ == "__main__":`` or
+	 * ``console_scripts`` entry point configured via ``setuptools`` in ``setup.py``.
+
+	This function creates an instance of :class:`Program` 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),
+		quiet=("-q" in argv or "--quiet" in argv)
+	)
+	try:
+		program.Run()
+	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 NotImplementedError as ex:
+		program.PrintNotImplementedError(ex)
+	except Exception as ex:
+		program.PrintException(ex)
+
+
+if __name__ == "__main__":
+	main()