pyVHDLModel 0.35.0__tar.gz → 0.36.0__tar.gz

{pyvhdlmodel-0.35.0 → pyvhdlmodel-0.36.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyVHDLModel
-Version: 0.35.0
+Version: 0.36.0
 Summary: An abstract VHDL language model.
 Home-page: https://GitHub.com/VHDL/pyVHDLModel
 Author: Patrick Lehmann
@@ -26,43 +26,43 @@ Classifier: Development Status :: 4 - Beta
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE.md
-Requires-Dist: pyTooling~=8.14
+Requires-Dist: pyTooling~=8.15
 Provides-Extra: doc
-Requires-Dist: sphinx_design~=0.7.0; extra == "doc"
-Requires-Dist: sphinx-copybutton>=0.5.2; extra == "doc"
-Requires-Dist: docutils_stubs~=0.0.22; extra == "doc"
+Requires-Dist: sphinx_autodoc_typehints~=3.11; extra == "doc"
 Requires-Dist: sphinx~=9.1; extra == "doc"
-Requires-Dist: autoapi>=2.0.1; extra == "doc"
+Requires-Dist: pyTooling~=8.15; extra == "doc"
+Requires-Dist: sphinx_design~=0.7.0; extra == "doc"
+Requires-Dist: sphinxcontrib-mermaid~=2.0; extra == "doc"
 Requires-Dist: sphinx_reports~=0.11.0; extra == "doc"
-Requires-Dist: sphinx_autodoc_typehints~=3.11; extra == "doc"
 Requires-Dist: sphinx_rtd_theme~=3.1; extra == "doc"
-Requires-Dist: sphinxcontrib-mermaid~=2.0; extra == "doc"
-Requires-Dist: pyTooling~=8.14; extra == "doc"
+Requires-Dist: docutils_stubs~=0.0.22; extra == "doc"
+Requires-Dist: autoapi>=2.0.1; extra == "doc"
+Requires-Dist: sphinx-copybutton>=0.5.2; extra == "doc"
 Provides-Extra: test
+Requires-Dist: lxml<7.0,>=6.1; extra == "test"
+Requires-Dist: mypy[reports]~=2.1; extra == "test"
 Requires-Dist: pytest~=9.0; extra == "test"
+Requires-Dist: pyTooling~=8.15; extra == "test"
 Requires-Dist: pytest-cov~=7.1; extra == "test"
-Requires-Dist: Coverage~=7.14; extra == "test"
 Requires-Dist: typing_extensions~=4.15; extra == "test"
-Requires-Dist: lxml<7.0,>=5.4; extra == "test"
-Requires-Dist: mypy[reports]~=1.19; extra == "test"
-Requires-Dist: pyTooling~=8.14; extra == "test"
+Requires-Dist: Coverage~=7.14; extra == "test"
 Provides-Extra: all
+Requires-Dist: lxml<7.0,>=6.1; extra == "all"
+Requires-Dist: sphinx_autodoc_typehints~=3.11; extra == "all"
+Requires-Dist: sphinx~=9.1; extra == "all"
+Requires-Dist: mypy[reports]~=2.1; extra == "all"
 Requires-Dist: pytest~=9.0; extra == "all"
+Requires-Dist: pyTooling~=8.15; extra == "all"
 Requires-Dist: sphinx_design~=0.7.0; extra == "all"
-Requires-Dist: sphinx-copybutton>=0.5.2; extra == "all"
-Requires-Dist: docutils_stubs~=0.0.22; extra == "all"
+Requires-Dist: sphinxcontrib-mermaid~=2.0; extra == "all"
+Requires-Dist: sphinx_reports~=0.11.0; extra == "all"
 Requires-Dist: pytest-cov~=7.1; extra == "all"
-Requires-Dist: Coverage~=7.14; extra == "all"
-Requires-Dist: sphinx~=9.1; extra == "all"
-Requires-Dist: mypy[reports]~=1.19; extra == "all"
+Requires-Dist: sphinx_rtd_theme~=3.1; extra == "all"
+Requires-Dist: docutils_stubs~=0.0.22; extra == "all"
 Requires-Dist: autoapi>=2.0.1; extra == "all"
 Requires-Dist: typing_extensions~=4.15; extra == "all"
-Requires-Dist: sphinx_reports~=0.11.0; extra == "all"
-Requires-Dist: lxml<7.0,>=5.4; extra == "all"
-Requires-Dist: sphinx_autodoc_typehints~=3.11; extra == "all"
-Requires-Dist: sphinx_rtd_theme~=3.1; extra == "all"
-Requires-Dist: sphinxcontrib-mermaid~=2.0; extra == "all"
-Requires-Dist: pyTooling~=8.14; extra == "all"
+Requires-Dist: sphinx-copybutton>=0.5.2; extra == "all"
+Requires-Dist: Coverage~=7.14; extra == "all"
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier

{pyvhdlmodel-0.35.0 → pyvhdlmodel-0.36.0}/pyVHDLModel/Instantiation.py

@@ -39,8 +39,9 @@ from typing import List, Optional as Nullable
 from pyTooling.Decorators    import export, readonly
 from pyTooling.MetaClasses   import ExtendedType
 
+from pyVHDLModel             import VHDLModelException
 from pyVHDLModel.Base        import ModelEntity
-from pyVHDLModel.DesignUnit  import PrimaryUnit
+from pyVHDLModel.DesignUnit  import Package
 from pyVHDLModel.Association import GenericAssociationItem
 from pyVHDLModel.Subprogram  import Procedure, Function, Subprogram
 from pyVHDLModel.Symbol      import PackageReferenceSymbol
@@ -78,12 +79,12 @@ class FunctionInstantiation(Function, SubprogramInstantiationMixin):
 
 
 @export
-class PackageInstantiation(PrimaryUnit, GenericInstantiationMixin):
+class PackageInstantiation(Package, GenericInstantiationMixin):  # TODO: maybe a PackageBase class is needed to share members.
 	_packageReference: PackageReferenceSymbol
 	_genericAssociations: List[GenericAssociationItem]
 
 	def __init__(self, identifier: str, uninstantiatedPackage: PackageReferenceSymbol, documentation: Nullable[str] = None, parent: Nullable[ModelEntity] = None) -> None:
-		super().__init__(identifier, documentation, parent)
+		super().__init__(identifier, documentation=documentation, parent=parent)
 		GenericEntityInstantiationMixin.__init__(self)
 
 		self._packageReference = uninstantiatedPackage
@@ -99,3 +100,14 @@ class PackageInstantiation(PrimaryUnit, GenericInstantiationMixin):
 	@readonly
 	def GenericAssociations(self) -> List[GenericAssociationItem]:
 		return self._genericAssociations
+
+	def Instantiate(self):
+		genericPackage: Package = self._packageReference.Package
+		if genericPackage is None:
+			raise VHDLModelException(f"PackageInstantiation '{self.Identifier}' isn't linked to the generic package '{self._packageReference.Name}'.")
+
+		# TODO: components might need to be copied and derived
+		for componentName, component in genericPackage._components.items():
+			self._components[componentName] = component
+
+		# FIXME: handle other package members

{pyvhdlmodel-0.35.0 → pyvhdlmodel-0.36.0}/pyVHDLModel/__init__.py

@@ -48,7 +48,7 @@ __author__ =    "Patrick Lehmann"
 __email__ =     "Paebbels@gmail.com"
 __copyright__ = "2016-2026, Patrick Lehmann"
 __license__ =   "Apache License, Version 2.0"
-__version__ =   "0.35.0"
+__version__ =   "0.36.0"
 
 
 from enum                      import unique, Enum, Flag, auto
@@ -426,6 +426,8 @@ class DependencyGraphEdgeKind(Flag):
 	ComponentInstantiation =     Component | Instantiation
 	ConfigurationInstantiation = Configuration | Instantiation
 
+	PackageInstantiation =       Package | Instantiation
+
 
 @export
 @unique
@@ -857,19 +859,21 @@ class Design(ModelEntity, AllowBlackboxMixin):
 		   |rarr| :meth:`LinkArchitectures`
 		7. Link all package bodies. |br|
 		   |rarr| :meth:`LinkPackageBodies`
-		8. Link all library references. |br|
+		8. Link all package instances. |br|
+		   |rarr| :meth:`LinkPackageInstances`
+		9. Link all library references. |br|
 		   |rarr| :meth:`LinkLibraryReferences`
-		9. Link all package references. |br|
-		   |rarr| :meth:`LinkPackageReferences`
-		10. Link all context references. |br|
+		10. Link all package references. |br|
+		    |rarr| :meth:`LinkPackageReferences`
+		11. Link all context references. |br|
 		    |rarr| :meth:`LinkContextReferences`
-		11. Link all components. |br|
+		12. Link all components. |br|
 		    |rarr| :meth:`LinkComponents`
-		12. Link all instantiations. |br|
+		13. Link all instantiations. |br|
 		    |rarr| :meth:`LinkInstantiations`
-		13. Create the hierarchy graph. |br|
+		14. Create the hierarchy graph. |br|
 		    |rarr| :meth:`CreateHierarchyGraph`
-		14. Compute the compile order. |br|
+		15. Compute the compile order. |br|
 		    |rarr| :meth:`ComputeCompileOrder`
 		"""
 		self.CreateDependencyGraph()
@@ -881,6 +885,7 @@ class Design(ModelEntity, AllowBlackboxMixin):
 		self.LinkContexts()
 		self.LinkArchitectures()
 		self.LinkPackageBodies()
+		self.LinkPackageInstances()
 		self.LinkLibraryReferences()
 		self.LinkPackageReferences()
 		self.LinkContextReferences()
@@ -1303,6 +1308,7 @@ class Design(ModelEntity, AllowBlackboxMixin):
 					except KeyError:
 						raise VHDLModelException(f"Package '{packageName._identifier}' not found in {'working ' if libraryName._normalizedIdentifier == 'work' else ''}library '{library._identifier}'.")
 
+					# FIXME: check if package isn't a generic package
 					symbol.Package = package
 
 					# TODO: warn duplicate package reference
@@ -1345,6 +1351,8 @@ class Design(ModelEntity, AllowBlackboxMixin):
 
 		   :meth:`LinkPackageBodies`
 		     Link all package bodies to corresponding packages in all libraries.
+		   :meth:`LinkPackageInstances`
+		     Link all package instances to corresponding generic packages in all libraries.
 		"""
 		for library in self._libraries.values():
 			library.LinkArchitectures()
@@ -1370,10 +1378,41 @@ class Design(ModelEntity, AllowBlackboxMixin):
 
 		   :meth:`LinkArchitectures`
 		     Link all architectures to corresponding entities in all libraries.
+		   :meth:`LinkPackageInstances`
+		     Link all package instances to corresponding generic packages in all libraries.
 		"""
 		for library in self._libraries.values():
 			library.LinkPackageBodies()
 
+	def LinkPackageInstances(self) -> None:
+		"""
+		Link all package instances to corresponding generic packages in all libraries.
+
+		.. rubric:: Algorithm
+
+		1. Iterate all libraries:
+
+		   1. Iterate all package instances.
+		      |rarr| :meth:`pyVHDLModel.Library.LinkPackageInstances`
+
+          .. todo::
+
+		         * Check if package instance's symbol's name exists as a generic package in this library.
+		         * Add generic package to package instance :attr:`pyVHDLModel.DesignUnit.Package._packageBody`.
+		         * Assign found package to package body's package symbol :attr:`pyVHDLModel.DesignUnit.PackageBody._package`
+		         * Set parent namespace of package body's namespace to the package's namespace.
+		         * Add an edge in the dependency graph from the package body's corresponding dependency vertex to the package's corresponding dependency vertex.
+
+		.. seealso::
+
+		   :meth:`LinkArchitectures`
+		     Link all architectures to corresponding entities in all libraries.
+		   :meth:`LinkPackageBodies`
+		     Link all package bodies to corresponding packages in all libraries.
+		"""
+		for library in self._libraries.values():
+			library.LinkPackageInstances()
+
 	def LinkLibraryReferences(self) -> None:
 		"""
 		Link all library references (library clause) to the matching VHDL library.
@@ -1628,6 +1667,7 @@ class Design(ModelEntity, AllowBlackboxMixin):
 						ex.add_note(f"Caused in design unit '{designUnit}' in file '{designUnit.Document}'.")
 						raise ex
 
+					# FIXME: check if package isn't a generic package
 					packageMemberSymbol.Package = package
 
 					# TODO: warn duplicate package reference
@@ -2286,6 +2326,8 @@ class Library(ModelEntity, NamedEntityMixin, AllowBlackboxMixin):
 
 		   :meth:`LinkPackageBodies`
 		     Link all package bodies to corresponding packages.
+		   :meth:`LinkPackageInstances`
+		     Link all package instances to corresponding generic packages.
 		"""
 		for entityName, architecturesPerEntity in self._architectures.items():
 			if entityName not in self._entities:
@@ -2328,6 +2370,8 @@ class Library(ModelEntity, NamedEntityMixin, AllowBlackboxMixin):
 
 		   :meth:`LinkArchitectures`
 		     Link all architectures to corresponding entities.
+		   :meth:`LinkPackageInstances`
+		     Link all package instances to corresponding generic packages.
 		"""
 		for packageBodyName, packageBody in self._packageBodies.items():
 			if packageBodyName not in self._packages:
@@ -2342,6 +2386,69 @@ class Library(ModelEntity, NamedEntityMixin, AllowBlackboxMixin):
 			dependency = packageBody._dependencyVertex.EdgeToVertex(package._dependencyVertex)
 			dependency["kind"] = DependencyGraphEdgeKind.PackageImplementation
 
+	def LinkPackageInstances(self) -> None:
+		"""
+		Link all package instances to corresponding generic packages.
+
+		.. rubric:: Algorithm
+
+		1. Iterate all package instances.
+
+		   .. todo::
+
+		      * Check if package body symbol's name exists as a package in this library.
+		      * Add package body to package :attr:`pyVHDLModel.DesignUnit.Package._packageBody`.
+		      * Assign found package to package body's package symbol :attr:`pyVHDLModel.DesignUnit.PackageBody._package`
+		      * Set parent namespace of package body's namespace to the package's namespace.
+		      * Add an edge in the dependency graph from the package body's corresponding dependency vertex to the package's corresponding dependency vertex.
+
+		:raises VHDLModelException: If generic package name doesn't exist.
+
+		.. seealso::
+
+		   :meth:`LinkArchitectures`
+		     Link all architectures to corresponding entities.
+		   :meth:`LinkPackageBodies`
+		     Link all package bodies to corresponding packages.
+		"""
+		for packageInstanceName, packageInstance in self._packages.items():
+			if isinstance(packageInstance, PackageInstantiation):
+				packageSymbol = packageInstance._packageReference
+				packageName = packageSymbol.Name
+				libraryName = packageName.Prefix
+
+				libraryIdentifier = libraryName.NormalizedIdentifier
+				packageIdentifier = packageName.NormalizedIdentifier
+
+				# In case work is used, resolve to the real library name.
+				if libraryIdentifier == "work":
+					library: Library = self
+					libraryIdentifier = library.NormalizedIdentifier
+				elif libraryIdentifier not in self._parent._libraries:
+					# TODO: This check doesn't trigger if it's the working library.
+					raise VHDLModelException(f"Package instantiation of '{packageInstanceName}' references library '{libraryName.Identifier}', which cannot be found in design.")
+				else:
+					library = self._parent._libraries[libraryIdentifier]
+
+				try:
+					package = library._packages[packageIdentifier]
+				except KeyError:
+					ex = VHDLModelException(
+						f"Package '{packageName.Identifier}' not found in {'working ' if libraryName.NormalizedIdentifier == 'work' else ''}library '{library.Identifier}'.")
+					ex.add_note(f"Caused in library '{self}' in file '{packageInstance.Document}'.")
+					raise ex
+
+				# FIXME: check if package is a generic package
+				if package.GenericCount == 0:
+					raise VHDLModelException(f"Package '{libraryName.Identifier}.{packageName.Identifier}' referenced by '{self._identifier}.{packageInstanceName}' is not a generic package.")
+
+				packageSymbol.Package = package
+
+				dependency = packageInstance._dependencyVertex.EdgeToVertex(package._dependencyVertex)  # , edgeValue=packageReference)
+				dependency["kind"] = DependencyGraphEdgeKind.PackageInstantiation
+
+				packageInstance.Instantiate()
+
 	def IndexPackages(self) -> None:
 		"""
 		Index declared items in all packages.
@@ -2365,8 +2472,6 @@ class Library(ModelEntity, NamedEntityMixin, AllowBlackboxMixin):
 		for package in self._packages.values():
 			if isinstance(package, Package):
 				package.IndexDeclaredItems()
-			elif isinstance(package, PackageInstantiation):
-				pass
 
 	def IndexPackageBodies(self) -> None:
 		"""

{pyvhdlmodel-0.35.0 → pyvhdlmodel-0.36.0}/pyVHDLModel.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyVHDLModel
-Version: 0.35.0
+Version: 0.36.0
 Summary: An abstract VHDL language model.
 Home-page: https://GitHub.com/VHDL/pyVHDLModel
 Author: Patrick Lehmann
@@ -26,43 +26,43 @@ Classifier: Development Status :: 4 - Beta
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE.md
-Requires-Dist: pyTooling~=8.14
+Requires-Dist: pyTooling~=8.15
 Provides-Extra: doc
-Requires-Dist: sphinx_design~=0.7.0; extra == "doc"
-Requires-Dist: sphinx-copybutton>=0.5.2; extra == "doc"
-Requires-Dist: docutils_stubs~=0.0.22; extra == "doc"
+Requires-Dist: sphinx_autodoc_typehints~=3.11; extra == "doc"
 Requires-Dist: sphinx~=9.1; extra == "doc"
-Requires-Dist: autoapi>=2.0.1; extra == "doc"
+Requires-Dist: pyTooling~=8.15; extra == "doc"
+Requires-Dist: sphinx_design~=0.7.0; extra == "doc"
+Requires-Dist: sphinxcontrib-mermaid~=2.0; extra == "doc"
 Requires-Dist: sphinx_reports~=0.11.0; extra == "doc"
-Requires-Dist: sphinx_autodoc_typehints~=3.11; extra == "doc"
 Requires-Dist: sphinx_rtd_theme~=3.1; extra == "doc"
-Requires-Dist: sphinxcontrib-mermaid~=2.0; extra == "doc"
-Requires-Dist: pyTooling~=8.14; extra == "doc"
+Requires-Dist: docutils_stubs~=0.0.22; extra == "doc"
+Requires-Dist: autoapi>=2.0.1; extra == "doc"
+Requires-Dist: sphinx-copybutton>=0.5.2; extra == "doc"
 Provides-Extra: test
+Requires-Dist: lxml<7.0,>=6.1; extra == "test"
+Requires-Dist: mypy[reports]~=2.1; extra == "test"
 Requires-Dist: pytest~=9.0; extra == "test"
+Requires-Dist: pyTooling~=8.15; extra == "test"
 Requires-Dist: pytest-cov~=7.1; extra == "test"
-Requires-Dist: Coverage~=7.14; extra == "test"
 Requires-Dist: typing_extensions~=4.15; extra == "test"
-Requires-Dist: lxml<7.0,>=5.4; extra == "test"
-Requires-Dist: mypy[reports]~=1.19; extra == "test"
-Requires-Dist: pyTooling~=8.14; extra == "test"
+Requires-Dist: Coverage~=7.14; extra == "test"
 Provides-Extra: all
+Requires-Dist: lxml<7.0,>=6.1; extra == "all"
+Requires-Dist: sphinx_autodoc_typehints~=3.11; extra == "all"
+Requires-Dist: sphinx~=9.1; extra == "all"
+Requires-Dist: mypy[reports]~=2.1; extra == "all"
 Requires-Dist: pytest~=9.0; extra == "all"
+Requires-Dist: pyTooling~=8.15; extra == "all"
 Requires-Dist: sphinx_design~=0.7.0; extra == "all"
-Requires-Dist: sphinx-copybutton>=0.5.2; extra == "all"
-Requires-Dist: docutils_stubs~=0.0.22; extra == "all"
+Requires-Dist: sphinxcontrib-mermaid~=2.0; extra == "all"
+Requires-Dist: sphinx_reports~=0.11.0; extra == "all"
 Requires-Dist: pytest-cov~=7.1; extra == "all"
-Requires-Dist: Coverage~=7.14; extra == "all"
-Requires-Dist: sphinx~=9.1; extra == "all"
-Requires-Dist: mypy[reports]~=1.19; extra == "all"
+Requires-Dist: sphinx_rtd_theme~=3.1; extra == "all"
+Requires-Dist: docutils_stubs~=0.0.22; extra == "all"
 Requires-Dist: autoapi>=2.0.1; extra == "all"
 Requires-Dist: typing_extensions~=4.15; extra == "all"
-Requires-Dist: sphinx_reports~=0.11.0; extra == "all"
-Requires-Dist: lxml<7.0,>=5.4; extra == "all"
-Requires-Dist: sphinx_autodoc_typehints~=3.11; extra == "all"
-Requires-Dist: sphinx_rtd_theme~=3.1; extra == "all"
-Requires-Dist: sphinxcontrib-mermaid~=2.0; extra == "all"
-Requires-Dist: pyTooling~=8.14; extra == "all"
+Requires-Dist: sphinx-copybutton>=0.5.2; extra == "all"
+Requires-Dist: Coverage~=7.14; extra == "all"
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier

{pyvhdlmodel-0.35.0 → pyvhdlmodel-0.36.0}/pyVHDLModel.egg-info/requires.txt

@@ -1,40 +1,40 @@
-pyTooling~=8.14
+pyTooling~=8.15
 
 [all]
+lxml<7.0,>=6.1
+sphinx_autodoc_typehints~=3.11
+sphinx~=9.1
+mypy[reports]~=2.1
 pytest~=9.0
+pyTooling~=8.15
 sphinx_design~=0.7.0
-sphinx-copybutton>=0.5.2
-docutils_stubs~=0.0.22
+sphinxcontrib-mermaid~=2.0
+sphinx_reports~=0.11.0
 pytest-cov~=7.1
-Coverage~=7.14
-sphinx~=9.1
-mypy[reports]~=1.19
+sphinx_rtd_theme~=3.1
+docutils_stubs~=0.0.22
 autoapi>=2.0.1
 typing_extensions~=4.15
-sphinx_reports~=0.11.0
-lxml<7.0,>=5.4
-sphinx_autodoc_typehints~=3.11
-sphinx_rtd_theme~=3.1
-sphinxcontrib-mermaid~=2.0
-pyTooling~=8.14
+sphinx-copybutton>=0.5.2
+Coverage~=7.14
 
 [doc]
-sphinx_design~=0.7.0
-sphinx-copybutton>=0.5.2
-docutils_stubs~=0.0.22
+sphinx_autodoc_typehints~=3.11
 sphinx~=9.1
-autoapi>=2.0.1
+pyTooling~=8.15
+sphinx_design~=0.7.0
+sphinxcontrib-mermaid~=2.0
 sphinx_reports~=0.11.0
-sphinx_autodoc_typehints~=3.11
 sphinx_rtd_theme~=3.1
-sphinxcontrib-mermaid~=2.0
-pyTooling~=8.14
+docutils_stubs~=0.0.22
+autoapi>=2.0.1
+sphinx-copybutton>=0.5.2
 
 [test]
+lxml<7.0,>=6.1
+mypy[reports]~=2.1
 pytest~=9.0
+pyTooling~=8.15
 pytest-cov~=7.1
-Coverage~=7.14
 typing_extensions~=4.15
-lxml<7.0,>=5.4
-mypy[reports]~=1.19
-pyTooling~=8.14
+Coverage~=7.14

{pyvhdlmodel-0.35.0 → pyvhdlmodel-0.36.0}/pyproject.toml

@@ -1,7 +1,7 @@
 [build-system]
 requires = [
   "setuptools >= 82.0",
-  "pyTooling ~= 8.14"
+  "pyTooling ~= 8.15"
 ]
 build-backend = "setuptools.build_meta"
 
@@ -25,7 +25,7 @@ variable-naming-style = "camelCase"
 
 [tool.mypy]
 packages = ["pyVHDLModel"]
-python_version = "3.13"
+python_version = "3.14"
 #ignore_missing_imports = true
 strict = true
 pretty = true