pyEDAA.OutputFilter 0.1.0__tar.gz → 0.2.0__tar.gz

{pyedaa_outputfilter-0.1.0 → pyedaa_outputfilter-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyEDAA.OutputFilter
-Version: 0.1.0
+Version: 0.2.0
 Summary: Post-processing of EDA Tool outputs (log files).
 Home-page: https://GitHub.com/edaa-org/pyEDAA.OutputFilter
 Author: Patrick Lehmann
@@ -27,45 +27,45 @@ Description-Content-Type: text/markdown
 License-File: LICENSE.md
 Requires-Dist: pyTooling[terminal]~=8.5
 Provides-Extra: doc
+Requires-Dist: sphinx_design~=0.6.1; extra == "doc"
+Requires-Dist: pyTooling[terminal]~=8.5; extra == "doc"
 Requires-Dist: docutils_stubs~=0.0.22; extra == "doc"
-Requires-Dist: sphinxcontrib-autoprogram~=0.1; extra == "doc"
-Requires-Dist: sphinxcontrib-mermaid~=1.0; extra == "doc"
-Requires-Dist: autoapi>=2.0.1; extra == "doc"
 Requires-Dist: sphinx_rtd_theme~=3.0; extra == "doc"
-Requires-Dist: docutils~=0.21; extra == "doc"
-Requires-Dist: pyTooling[terminal]~=8.5; extra == "doc"
+Requires-Dist: sphinxcontrib-mermaid~=1.0; extra == "doc"
 Requires-Dist: sphinx_autodoc_typehints~=3.2; extra == "doc"
-Requires-Dist: sphinx_design~=0.6.1; extra == "doc"
 Requires-Dist: sphinx-copybutton>=0.5.2; extra == "doc"
 Requires-Dist: sphinx~=8.2; extra == "doc"
 Requires-Dist: sphinx_reports~=0.9; extra == "doc"
+Requires-Dist: autoapi>=2.0.1; extra == "doc"
+Requires-Dist: docutils~=0.21; extra == "doc"
+Requires-Dist: sphinxcontrib-autoprogram~=0.1; extra == "doc"
 Provides-Extra: test
-Requires-Dist: typing_extensions~=4.13; extra == "test"
-Requires-Dist: mypy~=1.16; extra == "test"
-Requires-Dist: lxml~=5.4; extra == "test"
-Requires-Dist: pytest-cov~=6.2; extra == "test"
-Requires-Dist: Coverage~=7.9; extra == "test"
 Requires-Dist: pyTooling[terminal]~=8.5; extra == "test"
+Requires-Dist: typing_extensions~=4.14; extra == "test"
+Requires-Dist: pytest-cov~=6.2; extra == "test"
 Requires-Dist: pytest~=8.4; extra == "test"
+Requires-Dist: Coverage~=7.9; extra == "test"
+Requires-Dist: lxml~=5.4; extra == "test"
+Requires-Dist: mypy~=1.16; extra == "test"
 Provides-Extra: all
+Requires-Dist: sphinx_design~=0.6.1; extra == "all"
+Requires-Dist: pyTooling[terminal]~=8.5; extra == "all"
 Requires-Dist: docutils_stubs~=0.0.22; extra == "all"
-Requires-Dist: sphinxcontrib-autoprogram~=0.1; extra == "all"
-Requires-Dist: typing_extensions~=4.13; extra == "all"
-Requires-Dist: mypy~=1.16; extra == "all"
-Requires-Dist: lxml~=5.4; extra == "all"
 Requires-Dist: sphinxcontrib-mermaid~=1.0; extra == "all"
-Requires-Dist: pytest-cov~=6.2; extra == "all"
-Requires-Dist: autoapi>=2.0.1; extra == "all"
-Requires-Dist: Coverage~=7.9; extra == "all"
 Requires-Dist: sphinx_rtd_theme~=3.0; extra == "all"
-Requires-Dist: docutils~=0.21; extra == "all"
-Requires-Dist: pyTooling[terminal]~=8.5; extra == "all"
 Requires-Dist: sphinx_autodoc_typehints~=3.2; extra == "all"
-Requires-Dist: sphinx_design~=0.6.1; extra == "all"
 Requires-Dist: sphinx-copybutton>=0.5.2; extra == "all"
 Requires-Dist: sphinx~=8.2; extra == "all"
-Requires-Dist: pytest~=8.4; extra == "all"
+Requires-Dist: typing_extensions~=4.14; extra == "all"
 Requires-Dist: sphinx_reports~=0.9; extra == "all"
+Requires-Dist: pytest-cov~=6.2; extra == "all"
+Requires-Dist: pytest~=8.4; extra == "all"
+Requires-Dist: Coverage~=7.9; extra == "all"
+Requires-Dist: lxml~=5.4; extra == "all"
+Requires-Dist: autoapi>=2.0.1; extra == "all"
+Requires-Dist: docutils~=0.21; extra == "all"
+Requires-Dist: sphinxcontrib-autoprogram~=0.1; extra == "all"
+Requires-Dist: mypy~=1.16; extra == "all"
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -110,13 +110,18 @@ Dynamic: summary
 
 # Main Goals
 
-* Analyze text outputs from CLI of EDA tools.
-* Filter and categorize by severity (*info*, *warning*, *error*, *fatal*, ...).
-* Extract information from e.g. OSVVM logs, VUnit logs, ...
+* Live and offline parsing and classification of message lines from tool outputs.
+* Provide a data model for tool specific log files.
+* Extract values, lists and tables of embedded reports or summaries.
+* Implement checks and policies.
 
 # Use Cases
 
-* *tbd*
+* Write colorized logs to CI server logs or to shells based on classification.
+* Increase or decrease the severity level of message.
+* List messages of a certain kind (e.g. unused sequential elements).
+* Check for existence / non-existence of messages or outputs (e.g. latches).
+* Collect statistics and convert to datasets for a time series database (TSDB).
 
 # Examples
 

{pyedaa_outputfilter-0.1.0 → pyedaa_outputfilter-0.2.0}/README.md

@@ -27,13 +27,18 @@
 
 # Main Goals
 
-* Analyze text outputs from CLI of EDA tools.
-* Filter and categorize by severity (*info*, *warning*, *error*, *fatal*, ...).
-* Extract information from e.g. OSVVM logs, VUnit logs, ...
+* Live and offline parsing and classification of message lines from tool outputs.
+* Provide a data model for tool specific log files.
+* Extract values, lists and tables of embedded reports or summaries.
+* Implement checks and policies.
 
 # Use Cases
 
-* *tbd*
+* Write colorized logs to CI server logs or to shells based on classification.
+* Increase or decrease the severity level of message.
+* List messages of a certain kind (e.g. unused sequential elements).
+* Check for existence / non-existence of messages or outputs (e.g. latches).
+* Collect statistics and convert to datasets for a time series database (TSDB).
 
 # Examples
 

{pyedaa_outputfilter-0.1.0 → pyedaa_outputfilter-0.2.0}/pyEDAA/OutputFilter/CLI/Vivado.py

@@ -30,60 +30,23 @@
 #
 from argparse import Namespace
 from pathlib  import Path
-from sys      import stdin
-from typing   import NoReturn
+from typing   import NoReturn, Iterable
 
-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 pyTooling.Decorators                      import readonly
+from pyTooling.MetaClasses                     import ExtendedType
+from pyTooling.Attributes.ArgParse             import CommandHandler
+from pyTooling.Attributes.ArgParse.Flag        import LongFlag
+from pyTooling.Attributes.ArgParse.ValuedFlag  import LongValuedFlag
 
-from pyEDAA.OutputFilter.Xilinx.Synthesis import Processor, Preamble, WritingSynthesisReport
+from pyEDAA.OutputFilter.Xilinx                import Preamble, LineKind, Line
+from pyEDAA.OutputFilter.Xilinx.Synthesis      import WritingSynthesisReport, Processor, LoadingPart
 
 
-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):
+class VivadoHandlers(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("--colored", dest="colored", help="Render logfile with colored lines.")
+	@LongFlag("--summary", dest="summary", help="Print a summary.")
 	@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.")
@@ -110,6 +73,9 @@ class VivadoHandlers(Proto, metaclass=ExtendedType, mixin=True):
 		processor = Processor(logfile)
 		processor.Parse()
 
+		if args.colored:
+			self.ColoredOutput(processor._lines)
+
 		if args.info:
 			self.WriteNormal(f"INFO messages: {len(processor.InfoMessages)}")
 			for message in processor.InfoMessages:
@@ -150,18 +116,77 @@ class VivadoHandlers(Proto, metaclass=ExtendedType, mixin=True):
 
 			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)}")
+		if args.summary:
+			self.WriteNormal("Summary:")
+			self.WriteNormal(f"  Tool version:        {processor[Preamble].ToolVersion}")
+			self.WriteNormal(f"  Started at:          {processor[Preamble].StartDatetime}")
+			self.WriteNormal(f"  Processing duration: {processor.Duration:.3f} s")
+			self.WriteNormal(f"  Info:                {len(processor.InfoMessages)}")
+			self.WriteNormal(f"  Warning:             {len(processor.WarningMessages)}")
+			self.WriteNormal(f"  Critical Warning:    {len(processor.CriticalWarningMessages)}")
+			self.WriteNormal(f"  Error:               {len(processor.ErrorMessages)}")
+			self.WriteNormal(f"  Part:                {processor[LoadingPart].Part}")
+
+			self.WriteNormal("Policies:")
+			self.WriteNormal(f"  Latches:             {'found' if processor.HasLatches else '----'}")
+			if processor.HasLatches:
+				for cellName in ("LD", ):
+					try:
+						self.WriteNormal(f"    {cellName}: {processor.Cells[cellName]}")
+					except KeyError:
+						pass
+				for latch in processor.Latches:
+					self.WriteNormal(f"    {latch}")
+			self.WriteNormal(f"  Blackboxes:          {'found' if processor.HasBlackboxes else '----'}")
+			if processor.HasBlackboxes:
+				for bbox in processor[WritingSynthesisReport].Blackboxes:
+					self.WriteNormal(f"    {bbox}")
+
+			self.WriteNormal(f"VHDL report statements ({len(processor.VHDLReportMessages)}):")
+			for message in processor.VHDLReportMessages:
+				self.WriteNormal(f"  {message}")
+			self.WriteNormal(f"VHDL assert statements ({len(processor.VHDLAssertMessages)}):")
+			for message in processor.VHDLAssertMessages:
+				self.WriteNormal(f"  {message}")
+
+			self.WriteNormal(f"Cells: {len(processor.Cells)}")
+			for cell, count in processor.Cells.items():
+				self.WriteNormal(f"  {cell}: {count}")
 
 		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()
+	def ColoredOutput(self, lines: Iterable[Line]) -> None:
+		for i, line in enumerate(lines, start=1):
+			if line.Kind is LineKind.Normal:
+				print(f"{i:4}: {line.Message}")
+			elif LineKind.Message in line.Kind:
+				if line.Kind is LineKind.InfoMessage:
+					print(f"{i:4}: {{BLUE}}{line}{{NOCOLOR}}".format(**self.Foreground))
+				elif line.Kind is LineKind.WarningMessage:
+					print(f"{i:4}: {{YELLOW}}{line}{{NOCOLOR}}".format(**self.Foreground))
+				elif line.Kind is LineKind.CriticalWarningMessage:
+					print(f"{i:4}: {{MAGENTA}}{line}{{NOCOLOR}}".format(**self.Foreground))
+				elif line.Kind is LineKind.ErrorMessage:
+					print(f"{i:4}: {{RED}}{line}{{NOCOLOR}}".format(**self.Foreground))
+			elif LineKind.Command in line.Kind:
+				print(f"{i:4}: {{CYAN}}{line}{{NOCOLOR}}".format(**self.Foreground))
+			elif (LineKind.Start in line.Kind) or (LineKind.End in line.Kind):
+				print(f"{i:4}: {{DARK_CYAN}}{line}{{NOCOLOR}}".format(**self.Foreground))
+			elif line.Kind is LineKind.ParagraphHeadline:
+				print(f"{i:4}: {{DARK_YELLOW}}{line}{{NOCOLOR}}".format(**self.Foreground))
+			elif LineKind.Table in line.Kind:
+				print(f"{i:4}: {{WHITE}}{line}{{NOCOLOR}}".format(**self.Foreground))
+			elif LineKind.Delimiter in line.Kind:
+				print(f"{i:4}: {{GRAY}}{line}{{NOCOLOR}}".format(**self.Foreground))
+			elif LineKind.Verbose in line.Kind:
+				print(f"{i:4}: {{DARK_GRAY}}{line}{{NOCOLOR}}".format(**self.Foreground))
+			elif line.Kind is LineKind.Empty:
+				print(f"{i:4}:")
+			elif line.Kind is LineKind.ProcessorError:
+				print(f"{i:4}: {{RED}}{line}{{NOCOLOR}}".format(**self.Foreground))
+			elif line.Kind is LineKind.Unprocessed:
+				print(f"{i:4}: {{DARK_RED}}{line}{{NOCOLOR}}".format(**self.Foreground))
+			else:
+				print(f"{i:4}: Unknown LineKind '{line._kind}' for line {line._lineNumber}.")
+				print(line)
+				raise Exception()