pyEDAA.OSVVM 0.1.0__py3-none-any.whl

pyEDAA/OSVVM/Environment.py

@@ -0,0 +1,378 @@
+# ==================================================================================================================== #
+#              _____ ____    _        _      ___  ______     ____     ____  __                                         #
+#  _ __  _   _| ____|  _ \  / \      / \    / _ \/ ___\ \   / /\ \   / /  \/  |                                        #
+# | '_ \| | | |  _| | | | |/ _ \    / _ \  | | | \___ \\ \ / /  \ \ / /| |\/| |                                        #
+# | |_) | |_| | |___| |_| / ___ \  / ___ \ | |_| |___) |\ V /    \ V / | |  | |                                        #
+# | .__/ \__, |_____|____/_/   \_\/_/   \_(_)___/|____/  \_/      \_/  |_|  |_|                                        #
+# |_|    |___/                                                                                                         #
+# ==================================================================================================================== #
+# Authors:                                                                                                             #
+#   Patrick Lehmann                                                                                                    #
+#                                                                                                                      #
+# License:                                                                                                             #
+# ==================================================================================================================== #
+# Copyright 2025-2025 Patrick Lehmann - Boetzingen, 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                                                                                  #
+# ==================================================================================================================== #
+#
+from pathlib import Path
+from typing  import Optional as Nullable, List, Dict
+
+from pyTooling.Decorators  import readonly, export
+from pyTooling.MetaClasses import ExtendedType
+from pyVHDLModel           import VHDLVersion
+
+from pyEDAA.OSVVM          import OSVVMException
+
+
+__all__ = ["osvvmContext"]
+
+
+@export
+class Base(metaclass=ExtendedType):
+	pass
+
+
+@export
+class SourceFile(Base):
+	"""A base-class describing any source file (VHDL, Verilog, ...) supported by OSVVM Scripts."""
+
+	_path: Path
+
+	def __init__(self, path: Path) -> None:
+		self._path = path
+
+	@readonly
+	def Path(self) -> Path:
+		return self._path
+
+
+@export
+class VHDLSourceFile(SourceFile):
+	_vhdlVersion: VHDLVersion
+
+	def __init__(self, path: Path, vhdlVersion: Nullable[VHDLVersion] = None):
+		super().__init__(path)
+
+		self._vhdlVersion = vhdlVersion
+
+	@property
+	def VHDLVersion(self) -> VHDLVersion:
+		return self._vhdlVersion
+
+	@VHDLVersion.setter
+	def VHDLVersion(self, value: VHDLVersion) -> None:
+		self._vhdlVersion = value
+
+
+@export
+class Library(Base):
+	"""A VHDL library collecting multiple VHDL files containing VHDL design units."""
+
+	_name: str
+	_files: List[VHDLSourceFile]
+
+	def __init__(self, name: str) -> None:
+		self._name = name
+		self._files = []
+
+	@readonly
+	def Name(self) -> str:
+		return self._name
+
+	@readonly
+	def Files(self) -> List[SourceFile]:
+		return self._files
+
+	def AddFile(self, file: VHDLSourceFile) -> None:
+		self._files.append(file)
+
+	def __repr__(self) -> str:
+		return f"VHDLLibrary: {self._name}"
+
+
+@export
+class GenericValue(Base):
+	_name: str
+	_value: str
+
+	def __init__(self, name: str, value: str) -> None:
+		self._name = name
+		self._value = value
+
+	@readonly
+	def Name(self) -> str:
+		return self._name
+
+	@readonly
+	def Value(self) -> str:
+		return self._value
+
+	def __repr__(self) -> str:
+		return f"{self._name} = {self._value}"
+
+
+@export
+class Testcase(Base):
+	_name: str
+	_toplevelName: Nullable[str]
+	_generics: Dict[str, str]
+
+	def __init__(self, name: str) -> None:
+		self._name = name
+		self._toplevelName = None
+		self._generics = {}
+
+	@readonly
+	def Name(self) -> str:
+		return self._name
+
+	@readonly
+	def ToplevelName(self) -> str:
+		return self._toplevelName
+
+	@readonly
+	def Generics(self) -> Dict[str, str]:
+		return self._generics
+
+	def SetToplevel(self, toplevelName: str) -> None:
+		self._toplevelName = toplevelName
+
+	def AddGeneric(self, genericValue: GenericValue):
+		self._generics[genericValue._name] = genericValue._value
+
+	def __repr__(self) -> str:
+		return f"Testcase: {self._name} - [{', '.join([f'{n}={v}' for n,v in self._generics.items()])}]"
+
+
+@export
+class Testsuite(Base):
+	_name:      str
+	_testcases: Dict[str, Testcase]
+
+	def __init__(self, name: str) -> None:
+		self._name = name
+		self._testcases = {}
+
+	@readonly
+	def Name(self) -> str:
+		return self._name
+
+	@readonly
+	def Testcases(self) -> Dict[str, Testcase]:
+		return self._testcases
+
+	def AddTestcase(self, testcase: Testcase) -> None:
+		self._testcases[testcase._name] = testcase
+
+	def __repr__(self) -> str:
+		return f"Testsuite: {self._name}"
+
+
+@export
+class Context(Base):
+	# _tcl:              TclEnvironment
+
+	_lastException:    Exception
+
+	_workingDirectory: Path
+	_currentDirectory: Path
+	_includedFiles:    List[Path]
+
+	_vhdlversion:      VHDLVersion
+
+	_libraries:        Dict[str, Library]
+	_library:          Nullable[Library]
+
+	_testsuites:       Dict[str, Testsuite]
+	_testsuite:        Nullable[Testsuite]
+	_testcase:         Nullable[Testcase]
+	_options:          Dict[int, GenericValue]
+
+	def __init__(self) -> None:
+		self._processor =        None
+		self._lastException =    None
+
+		self._workingDirectory = Path.cwd()
+		self._currentDirectory = self._workingDirectory
+		self._includedFiles =    []
+
+		self._vhdlversion = VHDLVersion.VHDL2008
+
+		self._library =    None
+		self._libraries =  {}
+
+		self._testcase =   None
+		self._testsuite =  None
+		self._testsuites = {}
+		self._options =    {}
+
+	def Clear(self) -> None:
+		self._processor =        None
+		self._lastException =    None
+
+		self._workingDirectory = Path.cwd()
+		self._currentDirectory = self._workingDirectory
+		self._includedFiles =    []
+
+		self._vhdlversion = VHDLVersion.VHDL2008
+
+		self._library =    None
+		self._libraries =  {}
+
+		self._testcase =   None
+		self._testsuite =  None
+		self._testsuites = {}
+		self._options =    {}
+
+	@readonly
+	def Processor(self):  # -> "Tk":
+		return self._processor
+
+	@property
+	def LastException(self) -> Exception:
+		lastException = self._lastException
+		self._lastException = None
+		return lastException
+
+	@LastException.setter
+	def LastException(self, value: Exception) -> None:
+		self._lastException = value
+
+	@readonly
+	def WorkingDirectory(self) -> Path:
+		return self._workingDirectory
+
+	@readonly
+	def CurrentDirectory(self) -> Path:
+		return self._currentDirectory
+
+	@property
+	def VHDLVersion(self) -> VHDLVersion:
+		return self._vhdlversion
+
+	@VHDLVersion.setter
+	def VHDLVersion(self, value: VHDLVersion) -> None:
+		self._vhdlversion = value
+
+	@readonly
+	def IncludedFiles(self) -> List[Path]:
+		return self._includedFiles
+
+	@readonly
+	def Libraries(self) -> Dict[str, Library]:
+		return self._libraries
+
+	@readonly
+	def Library(self) -> Library:
+		return self._library
+
+	@readonly
+	def Testsuites(self) -> Dict[str, Testsuite]:
+		return self._testsuites
+
+	@readonly
+	def Testsuite(self) -> Testsuite:
+		return self._testsuite
+
+	@readonly
+	def TestCase(self) -> Testcase:
+		return self._testcase
+
+	def IncludeFile(self, proFileOrBuildDirectory: Path) -> Path:
+		if proFileOrBuildDirectory.is_absolute():
+			ex = OSVVMException(f"Absolute path '{proFileOrBuildDirectory}' not supported.")
+			self._lastException = ex
+			raise ex
+
+		path = (self._currentDirectory / proFileOrBuildDirectory).resolve()
+		if path.is_file():
+			if path.suffix == ".pro":
+				self._currentDirectory = path.parent.relative_to(self._workingDirectory, walk_up=True)
+				proFile = self._currentDirectory / path.name
+			else:
+				ex = OSVVMException(f"Path '{proFileOrBuildDirectory}' is not a *.pro file.")
+				self._lastException = ex
+				raise ex
+		elif path.is_dir():
+			self._currentDirectory = path
+			proFile = path / "build.pro"
+			if not proFile.exists():
+				proFile = path / f"{path.name}.pro"
+				if not proFile.exists():
+					ex = OSVVMException(f"Path '{proFileOrBuildDirectory}' is not a build directory.")
+					ex.__cause__ = FileNotFoundError(path / "build.pro")
+					self._lastException = ex
+					raise ex
+		else:
+			ex = OSVVMException(f"Path '{proFileOrBuildDirectory}' is not a *.pro file or build directory.")
+			self._lastException = ex
+			raise ex
+
+		self._includedFiles.append(proFile)
+		return proFile
+
+	def EvaluateFile(self, proFile: Path) -> None:
+		self._processor.EvaluateProFile(proFile)
+
+	def SetLibrary(self, name: str):
+		try:
+			self._library = self._libraries[name]
+		except KeyError:
+			self._library = Library(name)
+			self._libraries[name] = self._library
+
+	def AddVHDLFile(self, vhdlFile: VHDLSourceFile) -> None:
+		if self._library is None:
+			self.SetLibrary("default")
+
+		vhdlFile.VHDLVersion = self._vhdlversion
+		self._library.AddFile(vhdlFile)
+
+	def SetTestsuite(self, testsuiteName: str):
+		try:
+			self._testsuite = self._testsuites[testsuiteName]
+		except KeyError:
+			self._testsuite = Testsuite(testsuiteName)
+			self._testsuites[testsuiteName] = self._testsuite
+
+	def AddTestcase(self, testName: str) -> TestCase:
+		if self._testsuite is None:
+			self.SetTestsuite("default")
+
+		self._testcase = Testcase(testName)
+		self._testsuite._testcases[testName] = self._testcase
+
+		return self._testcase
+
+	def SetTestcaseToplevel(self, toplevel: str) -> TestCase:
+		if self._testcase is None:
+			ex = OSVVMException("Can't set testcase toplevel, because no testcase setup.")
+			self._lastException = ex
+			raise ex
+
+		self._testcase.SetToplevel(toplevel)
+
+		return self._testcase
+
+	def AddOption(self, genericValue: GenericValue):
+		optionID = id(genericValue)
+		self._options[optionID] = genericValue
+
+		return optionID
+
+
+osvvmContext: Context = Context()

pyEDAA/OSVVM/Procedures.py

@@ -0,0 +1,200 @@
+# ==================================================================================================================== #
+#              _____ ____    _        _      ___  ______     ____     ____  __                                         #
+#  _ __  _   _| ____|  _ \  / \      / \    / _ \/ ___\ \   / /\ \   / /  \/  |                                        #
+# | '_ \| | | |  _| | | | |/ _ \    / _ \  | | | \___ \\ \ / /  \ \ / /| |\/| |                                        #
+# | |_) | |_| | |___| |_| / ___ \  / ___ \ | |_| |___) |\ V /    \ V / | |  | |                                        #
+# | .__/ \__, |_____|____/_/   \_\/_/   \_(_)___/|____/  \_/      \_/  |_|  |_|                                        #
+# |_|    |___/                                                                                                         #
+# ==================================================================================================================== #
+# Authors:                                                                                                             #
+#   Patrick Lehmann                                                                                                    #
+#                                                                                                                      #
+# License:                                                                                                             #
+# ==================================================================================================================== #
+# Copyright 2025-2025 Patrick Lehmann - Boetzingen, 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                                                                                  #
+# ==================================================================================================================== #
+#
+from pathlib import Path
+from typing  import Optional as Nullable, Tuple
+
+from pyTooling.Decorators     import export
+
+from pyEDAA.OSVVM             import OSVVMException
+from pyEDAA.OSVVM.Environment import osvvmContext, VHDLSourceFile, GenericValue
+
+
+@export
+def build(file: str) -> None:
+	include(file)
+
+
+@export
+def include(file: str) -> None:
+	currentDirectory = osvvmContext._currentDirectory
+
+	includeFile = osvvmContext.IncludeFile(Path(file))
+	osvvmContext.EvaluateFile(includeFile)
+
+	osvvmContext._currentDirectory = currentDirectory
+
+
+@export
+def library(libraryName: str, libraryPath: Nullable[str] = None) -> None:
+	osvvmContext.SetLibrary(libraryName)
+
+
+@export
+def analyze(file: str) -> None:
+	file = Path(file)
+	fullPath = (osvvmContext._currentDirectory / file).resolve()
+
+	if not fullPath.exists():
+		print(f"[analyze] Path '{fullPath}' doesn't exist.")
+		ex = OSVVMException(f"Path '{fullPath}' can't be analyzed.")
+		ex.__cause__ = FileNotFoundError(fullPath)
+		osvvmContext.LastException = ex
+		raise ex
+
+	if fullPath.suffix in (".vhd", ".vhdl"):
+		vhdlFile = VHDLSourceFile(fullPath.relative_to(osvvmContext._workingDirectory, walk_up=True))
+		osvvmContext.AddVHDLFile(vhdlFile)
+	else:
+		print(f"[analyze] Unknown file type for '{fullPath}'.")
+		ex = OSVVMException(f"Path '{fullPath}' is no VHDL file.")
+		osvvmContext.LastException = ex
+		raise ex
+
+
+@export
+def simulate(toplevelName: str, *options: Tuple[int]) -> None:
+	testcase = osvvmContext.SetTestcaseToplevel(toplevelName)
+	for optionID in options:
+		try:
+			option = osvvmContext._options[int(optionID)]
+		except KeyError as ex2:
+			ex = OSVVMException(f"Option {optionID} not found in option dictionary.")
+			ex.__cause__ = ex2
+			osvvmContext.LastException = ex
+			raise ex
+
+		if isinstance(option, GenericValue):
+			testcase.AddGeneric(option)
+		else:
+			ex = OSVVMException(f"Option {optionID} is not a GenericValue.")
+			ex.__cause__ = TypeError()
+			osvvmContext.LastException = ex
+			raise ex
+
+	# osvvmContext._testcase = None
+
+
+@export
+def generic(name: str, value: str) -> GenericValue:
+	genericValue = GenericValue(name, value)
+	optionID = osvvmContext.AddOption(genericValue)
+
+	return optionID
+
+
+@export
+def TestSuite(name: str) -> None:
+	osvvmContext.SetTestsuite(name)
+
+
+@export
+def TestName(name: str) -> None:
+	osvvmContext.AddTestcase(name)
+
+
+@export
+def RunTest(file: str, *options: Tuple[int]) -> None:
+	file = Path(file)
+	vhdlFile = VHDLSourceFile(file)
+	testName = file.stem
+	testcase = osvvmContext.AddTestcase(testName)
+	osvvmContext.AddVHDLFile(vhdlFile)
+	testcase.SetToplevel(testName)
+	for optionID in options:
+		try:
+			option = osvvmContext._options[int(optionID)]
+		except KeyError as ex2:
+			ex = OSVVMException(f"Option {optionID} not found in option dictionary.")
+			ex.__cause__ = ex2
+			osvvmContext.LastException = ex
+			raise ex
+
+		if isinstance(option, GenericValue):
+			testcase.AddGeneric(option)
+		else:
+			ex = OSVVMException(f"Option {optionID} is not a GenericValue.")
+			ex.__cause__ = TypeError()
+			osvvmContext.LastException = ex
+			raise ex
+
+	# osvvmContext._testcase = None
+
+
+@export
+def LinkLibrary(libraryName: str, libraryPath: Nullable[str] = None):
+	print(f"[LinkLibrary] {libraryPath}")
+
+
+@export
+def LinkLibraryDirectory(libraryDirectory: str):
+	print(f"[LinkLibraryDirectory] {libraryDirectory}")
+
+
+@export
+def SetCoverageAnalyzeEnable(value: bool) -> None:
+	print(f"[SetCoverageAnalyzeEnable] {value}")
+
+
+@export
+def SetCoverageSimulateEnable(value: bool) -> None:
+	print(f"[SetCoverageSimulateEnable] {value}")
+
+
+@export
+def FileExists(file: str) -> bool:
+	return (osvvmContext._currentDirectory / file).is_file()
+
+
+@export
+def DirectoryExists(directory: str) -> bool:
+	return (osvvmContext._currentDirectory / directory).is_dir()
+
+
+@export
+def ChangeWorkingDirectory(directory: str) -> None:
+	osvvmContext._currentDirectory = (newDirectory := osvvmContext._currentDirectory / directory)
+	if not newDirectory.is_dir():
+		print(f"[ChangeWorkingDirectory] Directory {newDirectory} doesn't exist.")
+
+
+@export
+def FindOsvvmSettingsDirectory(*args):
+	pass
+
+
+@export
+def CreateOsvvmScriptSettingsPkg(*args):
+	pass
+
+
+@export
+def noop(*args):
+	pass

pyEDAA/OSVVM/Tcl.py

@@ -0,0 +1,202 @@
+# ==================================================================================================================== #
+#              _____ ____    _        _      ___  ______     ____     ____  __                                         #
+#  _ __  _   _| ____|  _ \  / \      / \    / _ \/ ___\ \   / /\ \   / /  \/  |                                        #
+# | '_ \| | | |  _| | | | |/ _ \    / _ \  | | | \___ \\ \ / /  \ \ / /| |\/| |                                        #
+# | |_) | |_| | |___| |_| / ___ \  / ___ \ | |_| |___) |\ V /    \ V / | |  | |                                        #
+# | .__/ \__, |_____|____/_/   \_\/_/   \_(_)___/|____/  \_/      \_/  |_|  |_|                                        #
+# |_|    |___/                                                                                                         #
+# ==================================================================================================================== #
+# Authors:                                                                                                             #
+#   Patrick Lehmann                                                                                                    #
+#                                                                                                                      #
+# License:                                                                                                             #
+# ==================================================================================================================== #
+# Copyright 2025-2025 Patrick Lehmann - Boetzingen, 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                                                                                  #
+# ==================================================================================================================== #
+#
+from pathlib  import Path
+from textwrap import dedent
+from tkinter  import Tk, Tcl, TclError
+from typing   import Any, Dict, Callable, Optional as Nullable
+
+from pyTooling.Decorators     import readonly, export
+
+from pyEDAA.OSVVM             import OSVVMException
+from pyEDAA.OSVVM.Environment import Context, osvvmContext
+from pyEDAA.OSVVM.Procedures  import noop, TestName
+from pyEDAA.OSVVM.Procedures  import FileExists, DirectoryExists, FindOsvvmSettingsDirectory
+from pyEDAA.OSVVM.Procedures  import build, include, library, analyze, simulate, generic
+from pyEDAA.OSVVM.Procedures  import TestSuite, TestName, RunTest
+from pyEDAA.OSVVM.Procedures  import ChangeWorkingDirectory, CreateOsvvmScriptSettingsPkg
+from pyEDAA.OSVVM.Procedures  import SetCoverageAnalyzeEnable, SetCoverageSimulateEnable
+
+
+@export
+class TclEnvironment:
+	_tcl: Tk
+	_procedures: Dict[str, Callable]
+	_context: Context
+
+	def __init__(self, context: Context) -> None:
+		self._context = context
+		context._processor = self
+
+		self._tcl = Tcl()
+		self._procedures = {}
+
+	@readonly
+	def TCL(self) -> Tk:
+		return self._tcl
+
+	@readonly
+	def Procedures(self) -> Dict[str, Callable]:
+		return self._procedures
+
+	@readonly
+	def Context(self) -> Context:
+		return self._context
+
+	def RegisterPythonFunctionAsTclProcedure(self, pythonFunction: Callable, tclProcedureName: Nullable[str] = None):
+		if tclProcedureName is None:
+			tclProcedureName = pythonFunction.__name__
+
+		self._tcl.createcommand(tclProcedureName, pythonFunction)
+		self._procedures[tclProcedureName] = pythonFunction
+
+	def LoadProFile(self, path: Path) -> None:
+		includeFile = self._context.IncludeFile(path)
+
+		self.EvaluateProFile(includeFile)
+
+	def EvaluateProFile(self, path: Path) -> None:
+		try:
+			self._tcl.evalfile(str(path))
+		except TclError as ex:
+			raise getException(ex, self._context)
+
+	def __setitem__(self, tclVariableName: str, value: Any) -> None:
+		self._tcl.setvar(tclVariableName, value)
+
+	def __getitem__(self, tclVariableName: str) -> None:
+		return self._tcl.getvar(tclVariableName)
+
+	def __delitem__(self, tclVariableName: str) -> None:
+		self._tcl.unsetvar(tclVariableName)
+
+
+@export
+class OsvvmVariables:
+	_toolVendor: str
+	_toolName: str
+	_toolNameVersion: str
+
+	def __init__(
+		self,
+		toolVendor: Nullable[str] = None,
+		toolName: Nullable[str] = None,
+		toolNameVersion: Nullable[str] = None
+	) -> None:
+		self._toolVendor =      toolVendor      if toolVendor      is not None else "EDA²"
+		self._toolName =        toolName        if toolName        is not None else "pyEDAA.ProjectModel"
+		self._toolNameVersion = toolNameVersion if toolNameVersion is not None else "0.1"
+
+	@readonly
+	def ToolVendor(self) -> str:
+		return self._toolVendor
+
+	@readonly
+	def ToolName(self) -> str:
+		return self._toolName
+
+	@readonly
+	def ToolNameVersion(self) -> str:
+		return self._toolNameVersion
+
+
+@export
+class OsvvmProFileProcessor(TclEnvironment):
+	def __init__(
+		self,
+		context: Nullable[Context] = None,
+		osvvmVariables: Nullable[OsvvmVariables] = None
+	) -> None:
+		if context is None:
+			context = osvvmContext
+
+		super().__init__(context)
+
+		if osvvmVariables is None:
+			osvvmVariables = OsvvmVariables()
+
+		self.LoadOsvvmDefaults(osvvmVariables)
+		self.OverwriteTclProcedures()
+		self.RegisterTclProcedures()
+
+	def LoadOsvvmDefaults(self, osvvmVariables: OsvvmVariables) -> None:
+		code = dedent(f"""\
+			namespace eval ::osvvm {{
+			  variable VhdlVersion     2019
+			  variable ToolVendor      "{osvvmVariables.ToolVendor}"
+			  variable ToolName        "{osvvmVariables.ToolName}"
+			  variable ToolNameVersion "{osvvmVariables.ToolNameVersion}"
+			  variable ToolSupportsDeferredConstants           1
+			  variable ToolSupportsGenericPackages             1
+			  variable FunctionalCoverageIntegratedInSimulator "default"
+			  variable Support2019FilePath                     1
+
+			  variable ClockResetVersion                       0
+			}}
+			""")
+
+		try:
+			self._tcl.eval(code)
+		except TclError as ex:
+			raise OSVVMException(f"TCL error occurred, when initializing OSVVM variables.") from ex
+
+	def OverwriteTclProcedures(self) -> None:
+		self.RegisterPythonFunctionAsTclProcedure(noop, "puts")
+
+	def RegisterTclProcedures(self) -> None:
+		self.RegisterPythonFunctionAsTclProcedure(build)
+		self.RegisterPythonFunctionAsTclProcedure(include)
+		self.RegisterPythonFunctionAsTclProcedure(library)
+		self.RegisterPythonFunctionAsTclProcedure(analyze)
+		self.RegisterPythonFunctionAsTclProcedure(simulate)
+		self.RegisterPythonFunctionAsTclProcedure(generic)
+
+		self.RegisterPythonFunctionAsTclProcedure(TestSuite)
+		self.RegisterPythonFunctionAsTclProcedure(TestName)
+		self.RegisterPythonFunctionAsTclProcedure(RunTest)
+
+		self.RegisterPythonFunctionAsTclProcedure(SetCoverageAnalyzeEnable)
+		self.RegisterPythonFunctionAsTclProcedure(SetCoverageSimulateEnable)
+
+		self.RegisterPythonFunctionAsTclProcedure(FileExists)
+		self.RegisterPythonFunctionAsTclProcedure(DirectoryExists)
+		self.RegisterPythonFunctionAsTclProcedure(ChangeWorkingDirectory)
+
+		self.RegisterPythonFunctionAsTclProcedure(FindOsvvmSettingsDirectory)
+		self.RegisterPythonFunctionAsTclProcedure(CreateOsvvmScriptSettingsPkg)
+
+
+@export
+def getException(ex: Exception, context: Context) -> Exception:
+	if str(ex) == "":
+		if (lastException := context.LastException) is not None:
+			return lastException
+
+	return ex

pyEDAA/OSVVM/__init__.py

@@ -0,0 +1,45 @@
+# ==================================================================================================================== #
+#              _____ ____    _        _      ___  ______     ____     ____  __                                         #
+#  _ __  _   _| ____|  _ \  / \      / \    / _ \/ ___\ \   / /\ \   / /  \/  |                                        #
+# | '_ \| | | |  _| | | | |/ _ \    / _ \  | | | \___ \\ \ / /  \ \ / /| |\/| |                                        #
+# | |_) | |_| | |___| |_| / ___ \  / ___ \ | |_| |___) |\ V /    \ V / | |  | |                                        #
+# | .__/ \__, |_____|____/_/   \_\/_/   \_(_)___/|____/  \_/      \_/  |_|  |_|                                        #
+# |_|    |___/                                                                                                         #
+# ==================================================================================================================== #
+# Authors:                                                                                                             #
+#   Patrick Lehmann                                                                                                    #
+#                                                                                                                      #
+# License:                                                                                                             #
+# ==================================================================================================================== #
+# Copyright 2025-2025 Patrick Lehmann - Boetzingen, 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                                                                                  #
+# ==================================================================================================================== #
+#
+"""An abstract model of EDA tool projects."""
+__author__ =    "Patrick Lehmann"
+__email__ =     "Paebbels@gmail.com"
+__copyright__ = "2025-2025, Patrick Lehmann"
+__license__ =   "Apache License, Version 2.0"
+__version__ =   "0.1.0"
+__keywords__ =  ["eda project", "model", "abstract", "osvvm", "reports", "data format", "unit test", "test suite", "test bench", "test harness"]
+
+from pyTooling.Decorators import export
+from pyTooling.Exceptions import ExceptionBase
+
+
+@export
+class OSVVMException(ExceptionBase):
+	pass

pyedaa_osvvm-0.1.0.dist-info/LICENSE.md

@@ -0,0 +1,82 @@
+This is a local copy of the Apache License Version 2.0.  
+The original can be obtained here:  [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
+
+--------------------------------------------------------------------------------
+
+# Apache License
+
+Version 2.0, January 2004
+
+## TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+### 1. Definitions.
+
+*"License"* shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+
+*"Licensor"* shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+
+*"Legal Entity"* shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+*"You"* (or *"Your"*) shall mean an individual or Legal Entity exercising permissions granted by this License.
+
+*"Source"* form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
+
+*"Object"* form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
+
+*"Work"* shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
+
+*"Derivative Works"* shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+*"Contribution"* shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, *"submitted"* means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as *"Not a Contribution."*
+
+*"Contributor"* shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
+
+### 2. Grant of Copyright License.
+Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
+
+### 3. Grant of Patent License.
+Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
+
+### 4. Redistribution.
+You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
+
+ - You must give any other recipients of the Work or Derivative Works a copy of this License; and
+ - You must cause any modified files to carry prominent notices stating that You changed the files; and
+ - You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
+ - If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. 
+
+You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
+
+### 5. Submission of Contributions.
+Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
+
+### 6. Trademarks.
+This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
+
+### 7. Disclaimer of Warranty.
+Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
+
+### 8. Limitation of Liability.
+In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
+
+### 9. Accepting Warranty or Additional Liability.
+While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
+
+
+## Appendix: How to apply the Apache License to your work
+
+To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives.
+
+    Copyright [yyyy] [name of copyright owner]
+ 
+    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.

pyedaa_osvvm-0.1.0.dist-info/METADATA

@@ -0,0 +1,148 @@
+Metadata-Version: 2.2
+Name: pyEDAA.OSVVM
+Version: 0.1.0
+Summary: Parser and converter for OSVVM-specific data models and report formats.
+Home-page: https://GitHub.com/edaa-org/pyEDAA.OSVVM
+Author: Patrick Lehmann
+Author-email: Paebbels@gmail.com
+License: Apache-2.0
+Project-URL: Documentation, https://edaa-org.GitHub.io/pyEDAA.OSVVM
+Project-URL: Source Code, https://GitHub.com/edaa-org/pyEDAA.OSVVM
+Project-URL: Issue Tracker, https://GitHub.com/edaa-org/pyEDAA.OSVVM/issues
+Keywords: eda project,model,abstract,osvvm,reports,data format,unit test,test suite,test bench,test harness
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Utilities
+Classifier: Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Development Status :: 3 - Alpha
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: pyVHDLModel~=0.31
+Requires-Dist: pyTooling~=8.2
+Provides-Extra: doc
+Requires-Dist: sphinx_rtd_theme~=3.0; extra == "doc"
+Requires-Dist: sphinx~=8.2; extra == "doc"
+Requires-Dist: pyTooling~=8.2; extra == "doc"
+Requires-Dist: docutils~=0.21; extra == "doc"
+Requires-Dist: autoapi>=2.0.1; extra == "doc"
+Requires-Dist: sphinx-copybutton>=0.5.2; extra == "doc"
+Requires-Dist: sphinx_design~=0.6.1; extra == "doc"
+Requires-Dist: sphinx_autodoc_typehints~=3.1; extra == "doc"
+Requires-Dist: sphinxcontrib-mermaid~=1.0; extra == "doc"
+Requires-Dist: pyVHDLModel~=0.31; extra == "doc"
+Requires-Dist: docutils_stubs~=0.0.22; extra == "doc"
+Requires-Dist: sphinx_reports~=0.7; extra == "doc"
+Provides-Extra: test
+Requires-Dist: pytest-cov~=6.0; extra == "test"
+Requires-Dist: pytest~=8.3; extra == "test"
+Requires-Dist: Coverage~=7.6; extra == "test"
+Requires-Dist: mypy~=1.15; extra == "test"
+Requires-Dist: typing_extensions~=4.12; extra == "test"
+Requires-Dist: pyVHDLModel~=0.31; extra == "test"
+Requires-Dist: pyTooling~=8.2; extra == "test"
+Requires-Dist: lxml~=5.3; extra == "test"
+Provides-Extra: all
+Requires-Dist: sphinx_rtd_theme~=3.0; extra == "all"
+Requires-Dist: sphinx~=8.2; extra == "all"
+Requires-Dist: docutils~=0.21; extra == "all"
+Requires-Dist: autoapi>=2.0.1; extra == "all"
+Requires-Dist: sphinx-copybutton>=0.5.2; extra == "all"
+Requires-Dist: pytest-cov~=6.0; extra == "all"
+Requires-Dist: docutils_stubs~=0.0.22; extra == "all"
+Requires-Dist: pytest~=8.3; extra == "all"
+Requires-Dist: lxml~=5.3; extra == "all"
+Requires-Dist: sphinx_design~=0.6.1; extra == "all"
+Requires-Dist: sphinx_autodoc_typehints~=3.1; extra == "all"
+Requires-Dist: Coverage~=7.6; extra == "all"
+Requires-Dist: mypy~=1.15; extra == "all"
+Requires-Dist: sphinxcontrib-mermaid~=1.0; extra == "all"
+Requires-Dist: typing_extensions~=4.12; extra == "all"
+Requires-Dist: pyVHDLModel~=0.31; extra == "all"
+Requires-Dist: pyTooling~=8.2; extra == "all"
+Requires-Dist: sphinx_reports~=0.7; extra == "all"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: project-url
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# Main Goals
+
+This package provides OSVVM-specific data models and parsers. The data models can be used as is or converted to generic
+data models of the pyEDAA data model family. This includes parsing OSVVM's `*.pro`-files and translating them to a
+pyEDAA.ProjectModel instance as well as reading OSVVM's reports in YAML format like test results, alerts or functional
+coverage.
+
+Frameworks consuming these data models can build higher level features and services on top of these models, while
+using one parser that's aligned with OSVVM's data formats.
+
+# Data Models
+
+## Project Description via `*.pro`-Files
+
+
+## Testsuite Summary Reports
+
+
+## Testcase Summary Reports
+
+
+## Alert and Log Reports
+
+
+## Scoreboard Reports
+
+
+## Functional Coverage Reports
+
+
+## Requirement Reports
+
+
+
+
+# Features
+
+
+
+# Use Cases
+
+* Reading OSVVM's `*.pro` files.
+
+# Examples
+
+
+
+# Consumers
+
+
+# References
+
+* [OSVVM/OSVVM-Scripts: OSVVMProjectScripts.tcl](https://GitHub.com/OSVVM/OSVVM-Scripts/blob/master/OSVVMProjectScripts.tcl)
+
+
+# Contributors
+
+* [Patrick Lehmann](https://GitHub.com/Paebbels) (Maintainer)
+* [and more...](https://GitHub.com/edaa-org/pyEDAA.OSVVM/graphs/contributors)
+
+# License
+
+This Python package (source code) licensed under [Apache License 2.0](LICENSE.md).  
+The accompanying documentation is licensed under [Creative Commons - Attribution 4.0 (CC-BY 4.0)](doc/Doc-License.rst).
+
+-------------------------
+SPDX-License-Identifier: Apache-2.0

pyedaa_osvvm-0.1.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+pyEDAA/OSVVM/Environment.py,sha256=Cd36sRUaSPh7-w9rMlC4U3WeIEeOixJ_6HpJbbDqOiw,11539
+pyEDAA/OSVVM/Procedures.py,sha256=tClNMCdiRuhlZ8PTKX-d0fSPBq58IWP4FRt8hAjiHqE,7692
+pyEDAA/OSVVM/Tcl.py,sha256=6Vr2G3tzd_fsTfLPmyTfcUkUGV3CfzDfwZya6YlzGdk,8872
+pyEDAA/OSVVM/__init__.py,sha256=E4I3tt77GJfuMTkX8OKEtSeSBdyo6YKQrgKSynFKN8o,4029
+pyedaa_osvvm-0.1.0.dist-info/LICENSE.md,sha256=DF4r-Jbsz_ZASY4VjV0ZZVaaHYkH9a20BkVExpq8doE,10571
+pyedaa_osvvm-0.1.0.dist-info/METADATA,sha256=dAngy9zqLtJgJILQjNKsfmw8A7Z9S04ZfjX3TF2UWkQ,4873
+pyedaa_osvvm-0.1.0.dist-info/WHEEL,sha256=jB7zZ3N9hIM9adW7qlTAyycLYW9npaWKLRzaoVcLKcM,91
+pyedaa_osvvm-0.1.0.dist-info/top_level.txt,sha256=J--2xhNglJhlQP4zh2M9bH0LpnKvmezMIcug4ZVSc9A,7
+pyedaa_osvvm-0.1.0.dist-info/RECORD,,

pyedaa_osvvm-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (75.8.2)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

pyedaa_osvvm-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+pyEDAA