pyVHDLModelTreesitter 0.3.1__tar.gz → 0.5.0__tar.gz

{pyvhdlmodeltreesitter-0.3.1 → pyvhdlmodeltreesitter-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyVHDLModelTreesitter
-Version: 0.3.1
+Version: 0.5.0
 Summary: An implementation of pyVHDLModel using treesitter
 Project-URL: Repository, https://gitlab.com/dawalters/pyVHDLModelTreesitter
 Author: Dominic Adam Walters
@@ -19,15 +19,23 @@ Requires-Dist: pyvhdlmodel>=0.32.0
 Requires-Dist: tree-sitter-vhdl>=1.2.5
 Requires-Dist: tree-sitter>=0.23.0
 Provides-Extra: dev
-Requires-Dist: coverage==7.13.5; extra == 'dev'
+Requires-Dist: coverage==7.14.0; extra == 'dev'
+Requires-Dist: cryptography==48.0.0; extra == 'dev'
 Requires-Dist: hatch==1.16.5; extra == 'dev'
-Requires-Dist: mypy==1.20.1; extra == 'dev'
-Requires-Dist: pre-commit==4.5.1; extra == 'dev'
+Requires-Dist: idna==3.16; extra == 'dev'
+Requires-Dist: jaraco-context==6.1.2; extra == 'dev'
+Requires-Dist: mypy==2.1.0; extra == 'dev'
+Requires-Dist: pre-commit==4.6.0; extra == 'dev'
+Requires-Dist: pygments==2.20.0; extra == 'dev'
 Requires-Dist: pytest-cov==7.1.0; extra == 'dev'
+Requires-Dist: pytest-order==1.4.0; extra == 'dev'
 Requires-Dist: pytest-sugar==1.1.1; extra == 'dev'
 Requires-Dist: pytest-xdist==3.8.0; extra == 'dev'
 Requires-Dist: pytest==9.0.3; extra == 'dev'
-Requires-Dist: ruff==0.15.10; extra == 'dev'
+Requires-Dist: rich==15.0.0; extra == 'dev'
+Requires-Dist: ruff==0.15.14; extra == 'dev'
+Requires-Dist: ty==0.0.39; extra == 'dev'
+Requires-Dist: uv==0.11.16; extra == 'dev'
 Description-Content-Type: text/markdown
 
 # pyVHDLModelTreesitter
@@ -44,10 +52,6 @@ Description-Content-Type: text/markdown
 > Disclaimer: This project is in early development and only implements a
               fraction of the features of [`pyVHDLModel`][pyVHDLModel-github].
 
-## Dependencies
-
-- Python 3.10 or newer.
-
 ## Installation
 
 ### `pip`
@@ -78,6 +82,29 @@ document = pyVHDLModelTreesitter.Document.from_file("path/to/file.vhd")
 
 Detailed documentation is currently unavailable.
 
+## Setup for Development
+
+### Dependencies
+
+Developers aiming to contribute to this repository need the following tools:
+
+- `make`
+- `uv`
+
+All other dependencies are automatically obtained.
+
+### Initial setup
+
+Simply:
+
+```bash
+source ./settings.sh
+```
+
+You can `make help` to see what actions are available.
+
+---
+
 [precommit-github]: https://github.com/pre-commit/pre-commit
 [pyVHDLModel-Document]: https://vhdl.github.io/pyVHDLModel/pyVHDLModel/pyVHDLModel.html#pyVHDLModel.Document
 [pyVHDLModel-github]: https://github.com/VHDL/pyVHDLModel

{pyvhdlmodeltreesitter-0.3.1 → pyvhdlmodeltreesitter-0.5.0}/README.md

@@ -12,10 +12,6 @@
 > Disclaimer: This project is in early development and only implements a
               fraction of the features of [`pyVHDLModel`][pyVHDLModel-github].
 
-## Dependencies
-
-- Python 3.10 or newer.
-
 ## Installation
 
 ### `pip`
@@ -46,6 +42,29 @@ document = pyVHDLModelTreesitter.Document.from_file("path/to/file.vhd")
 
 Detailed documentation is currently unavailable.
 
+## Setup for Development
+
+### Dependencies
+
+Developers aiming to contribute to this repository need the following tools:
+
+- `make`
+- `uv`
+
+All other dependencies are automatically obtained.
+
+### Initial setup
+
+Simply:
+
+```bash
+source ./settings.sh
+```
+
+You can `make help` to see what actions are available.
+
+---
+
 [precommit-github]: https://github.com/pre-commit/pre-commit
 [pyVHDLModel-Document]: https://vhdl.github.io/pyVHDLModel/pyVHDLModel/pyVHDLModel.html#pyVHDLModel.Document
 [pyVHDLModel-github]: https://github.com/VHDL/pyVHDLModel

{pyvhdlmodeltreesitter-0.3.1 → pyvhdlmodeltreesitter-0.5.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "pyVHDLModelTreesitter"
-version = "0.3.1"
+version = "0.5.0"
 description = "An implementation of pyVHDLModel using treesitter"
 readme = "README.md"
 requires-python = ">=3.11"
@@ -18,28 +18,35 @@ authors = [
 ]
 keywords = ["language", "model", "treesitter", "vhdl"]
 classifiers = [
-  "Development Status :: 3 - Alpha",
-  "License :: OSI Approved :: MIT License",
-  "Programming Language :: Python :: 3 :: Only",
-  "Programming Language :: Python :: 3.11",
-  "Programming Language :: Python :: 3.12",
-  "Programming Language :: Python :: 3.13",
-  "Programming Language :: Python :: 3.14",
-  "Intended Audience :: Developers",
+    "Development Status :: 3 - Alpha",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Intended Audience :: Developers",
 ]
 
 [project.optional-dependencies]
 dev = [
-    "coverage == 7.13.5",
+    "coverage == 7.14.0",
     "hatch == 1.16.5",
-    "mypy == 1.20.1",
-    "pre-commit == 4.5.1",
+        "cryptography == 48.0.0",  # forced to avoid CVE
+        "idna == 3.16",  # forced to avoid CVE
+        "jaraco-context == 6.1.2",  # forced to avoid CVE
+    "mypy == 2.1.0",
+    "pre-commit == 4.6.0",
     "pytest == 9.0.3",
     "pytest-cov == 7.1.0",
+    "pytest-order == 1.4.0",
     "pytest-sugar == 1.1.1",
     "pytest-xdist == 3.8.0",
-    "ruff == 0.15.10",
-    # "sphinx == 8.1.3",
+    "rich == 15.0.0",
+        "pygments == 2.20.0",  # forced to avoid CVE
+    "ruff == 0.15.14",
+    "ty == 0.0.39",
+    "uv == 0.11.16",
 ]
 
 [project.urls]
@@ -75,11 +82,7 @@ packages = ["src/pyVHDLModelTreesitter"]
 
 [tool.hatch.envs.hatch-test]
 dependencies = [
-    "coverage == 7.13.5",
-    "pytest == 9.0.3",
-    "pytest-cov == 7.1.0",
-    "pytest-sugar == 1.1.1",
-    "pytest-xdist == 3.8.0",
+    "pyVHDLModelTreesitter[dev]",
 ]
 
 [[tool.hatch.envs.hatch-test.matrix]]
@@ -92,6 +95,7 @@ implicit_reexport = true
 
 [tool.pytest.ini_options]
 addopts = "--capture=fd -n 0 --cov=pyVHDLModelTreesitter --cov-report html --cov-report xml --verbose --junitxml=.junit.xml -o junit_family=legacy"
+norecursedirs = "oss/*"
 testpaths = [
     "tests",
 ]
@@ -120,7 +124,16 @@ unfixable = [
 ]
 
 [tool.ruff.lint.flake8-self]
-ignore-names = ["_AddEntity"]
+ignore-names = [
+    "_AddArchitecture",
+    "_AddEntity",
+    "_AddPackage",
+    "_AddPackageBody",
+]
 
 [tool.ruff.lint.isort]
 required-imports = ["from __future__ import annotations"]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**/*.py" = ["S101"]
+"tests/examples/local/**/*.py" = ["D100", "D103", "INP001", "TID252"]

pyvhdlmodeltreesitter-0.5.0/src/pyVHDLModelTreesitter/Association.py

@@ -0,0 +1,97 @@
+"""Submodule mirroring modified aspects of pyVHDLModel.Association."""
+
+from __future__ import annotations
+
+__all__ = [
+    "AssociationItem",
+    "GenericAssociationItem",
+    "ParameterAssociationItem",
+    "PortAssociationItem",
+]
+
+from typing import TYPE_CHECKING, Self
+
+from pyVHDLModel.Association import AssociationItem as pyVHDLModel_AssociationItem
+from pyVHDLModel.Association import (
+    GenericAssociationItem as pyVHDLModel_GenericAssociationItem,
+)
+from pyVHDLModel.Association import (
+    ParameterAssociationItem as pyVHDLModel_ParameterAssociationItem,
+)
+from pyVHDLModel.Association import (
+    PortAssociationItem as pyVHDLModel_PortAssociationItem,
+)
+
+from pyVHDLModelTreesitter._parse import parse_conditional_expression
+from pyVHDLModelTreesitter.Name import selected_or_simple_name
+from pyVHDLModelTreesitter.Symbol import SimpleObjectOrFunctionCallSymbol
+from pyVHDLModelTreesitter.treesitter import (
+    TreesitterNodeMixin,
+    get_node,
+    get_node_text,
+)
+from pyVHDLModelTreesitter.treesitter.query import AssociationElement
+
+if TYPE_CHECKING:
+    import tree_sitter
+
+
+class AssociationItemMixin(TreesitterNodeMixin, pyVHDLModel_AssociationItem):
+    @classmethod
+    def from_treesitter_node(
+        cls,
+        node: tree_sitter.Node,
+    ) -> list[Self]:
+        """Create one or more AssociationItem from a treesitter node."""
+        captures = AssociationElement.capture_first_root(node)
+        formal_node = get_node(node, captures, "formal", optional=True)
+        formal = None
+        if formal_node is not None:
+            formal = SimpleObjectOrFunctionCallSymbol(
+                selected_or_simple_name(get_node_text(formal_node)),
+            )
+        actual_node = get_node(node, captures, "actual")
+        actual = parse_conditional_expression(actual_node)
+        if actual is None:
+            return []
+        return [cls(actual, formal, _treesitter_node=node)]
+
+    def __eq__(self, other: object) -> bool:
+        if not isinstance(other, self.__class__):
+            return False
+        return self._formal == other._formal and self._actual == other._actual
+
+    def __hash__(self) -> int:
+        return hash(
+            (
+                self._formal,
+                self._actual,
+            ),
+        )
+
+    def __repr__(self) -> str:
+        return (
+            f"{self.__class__.__name__}("
+            f"_formal={self._formal!r}, "
+            f"_actual={self._actual!r}, "
+            ")"
+        )
+
+
+class AssociationItem(AssociationItemMixin):  # noqa: D101
+    pass
+
+
+class GenericAssociationItem(AssociationItemMixin, pyVHDLModel_GenericAssociationItem):  # noqa: D101
+    pass
+
+
+class ParameterAssociationItem(  # noqa: D101
+    AssociationItemMixin,
+    pyVHDLModel_ParameterAssociationItem,
+):
+    pass
+
+
+class PortAssociationItem(AssociationItemMixin, pyVHDLModel_PortAssociationItem):  # noqa: D101
+    pass

{pyvhdlmodeltreesitter-0.3.1 → pyvhdlmodeltreesitter-0.5.0}/src/pyVHDLModelTreesitter/Base.py

@@ -6,7 +6,7 @@ __all__ = [
     "Range",
 ]
 
-from typing import TYPE_CHECKING, Self, cast
+from typing import TYPE_CHECKING, Self
 
 import pyVHDLModel
 
@@ -20,8 +20,8 @@ from pyVHDLModelTreesitter._errors import (
     NodeTextIsNoneError,
     NotImplementedWarning,
 )
-from pyVHDLModelTreesitter.Expression import parse_simple_expression
-from pyVHDLModelTreesitter.treesitter import BaseTreesitterNode
+from pyVHDLModelTreesitter._parse import parse_simple_expression
+from pyVHDLModelTreesitter.treesitter import TreesitterNodeMixin
 
 
 def parse_as_direction(string: str) -> pyVHDLModel.Base.Direction | None:
@@ -67,7 +67,7 @@ def parse_as_mode(string: str) -> pyVHDLModel.Base.Mode | None:
         return None
 
 
-class Range(BaseTreesitterNode, pyVHDLModel.Base.Range):  # noqa: D101
+class Range(TreesitterNodeMixin, pyVHDLModel.Base.Range):  # noqa: D101
     @classmethod
     def from_treesitter_node(  # noqa: C901, PLR0912
         cls,
@@ -98,7 +98,7 @@ class Range(BaseTreesitterNode, pyVHDLModel.Base.Range):  # noqa: D101
         if left is None:
             raise NodeMissingChildError(node, "first-child")
         if left.type != "simple_expression":
-            NotImplementedWarning.warn_child_type(left.type, "simple_range")
+            NotImplementedWarning.warn_child_type(left)
             return None
         if left.text is None or len(left.text) == 0:
             raise NodeTextIsNoneError(left)
@@ -106,7 +106,7 @@ class Range(BaseTreesitterNode, pyVHDLModel.Base.Range):  # noqa: D101
         if direction_node is None:
             raise NodeMissingChildError(node, "second-child")
         if len(direction_node.type) == 0:
-            NotImplementedWarning.warn_child_type(direction_node.type, "")
+            NotImplementedWarning.warn_child_type(direction_node)
             return None
         if direction_node.text is None or len(direction_node.text) == 0:
             raise NodeTextIsNoneError(direction_node)
@@ -115,7 +115,7 @@ class Range(BaseTreesitterNode, pyVHDLModel.Base.Range):  # noqa: D101
         if right is None:
             raise NodeMissingChildError(node, "third-child")
         if right.type != "simple_expression":
-            NotImplementedWarning.warn_child_type(right.type, "simple_range")
+            NotImplementedWarning.warn_child_type(right)
             return None
         if right.text is None or len(right.text) == 0:
             raise NodeTextIsNoneError(right)
@@ -134,10 +134,8 @@ class Range(BaseTreesitterNode, pyVHDLModel.Base.Range):  # noqa: D101
         return cls(left_expr, right_expr, direction, _treesitter_node=node)
 
     def __eq__(self, other: object) -> bool:  # noqa: D105
-        if not isinstance(other, Range):
+        if not isinstance(other, self.__class__):
             return False
-        # Required for LSP completions
-        other = cast("Range", other)  # type: ignore[redundant-cast]
         return (
             self._leftBound == other._leftBound
             and self._rightBound == other._rightBound

pyvhdlmodeltreesitter-0.5.0/src/pyVHDLModelTreesitter/Concurrent.py

@@ -0,0 +1,110 @@
+"""Submodule mirroring modified aspects of pyVHDLModel.Concurrent."""
+
+from __future__ import annotations
+
+__all__ = [
+    "EntityInstantiation",
+]
+
+from typing import TYPE_CHECKING, Self
+
+from pyVHDLModel.Concurrent import (
+    EntityInstantiation as pyVHDLModel_EntityInstantiation,
+)
+
+from pyVHDLModelTreesitter.Association import (
+    GenericAssociationItem,
+    PortAssociationItem,
+)
+from pyVHDLModelTreesitter.Name import selected_or_simple_name
+from pyVHDLModelTreesitter.Symbol import ArchitectureSymbol, EntityInstantiationSymbol
+from pyVHDLModelTreesitter.treesitter import (
+    TreesitterNodeMixin,
+    get_node,
+    get_node_text,
+    get_nodes,
+)
+from pyVHDLModelTreesitter.treesitter.query import ComponentInstantiationStatement
+
+if TYPE_CHECKING:
+    import tree_sitter
+
+
+class EntityInstantiation(TreesitterNodeMixin, pyVHDLModel_EntityInstantiation):  # noqa: D101
+    @classmethod
+    def from_treesitter_node(
+        cls,
+        node: tree_sitter.Node,
+    ) -> list[Self]:
+        """Create one or more `EntityInstantiation`s from a treesitter node."""
+        captures = ComponentInstantiationStatement.capture(node)
+        label_node = get_node(node, captures, "label")
+        label = get_node_text(label_node)
+        entity_str = ""
+        namespace_node = get_node(node, captures, "namespace", optional=True)
+        if namespace_node is not None:
+            entity_str = f"{get_node_text(namespace_node)}."
+        entity_node = get_node(node, captures, "entity")
+        entity_str += get_node_text(entity_node)
+        entity_symbol = EntityInstantiationSymbol(
+            selected_or_simple_name(entity_str),
+        )
+        architecture_node = get_node(node, captures, "architecture", optional=True)
+        architecture_symbol = None
+        if architecture_node is not None:
+            architecture_symbol = ArchitectureSymbol(
+                selected_or_simple_name(get_node_text(architecture_node)),
+            )
+        generic_associations = []
+        for association_node in get_nodes(node, captures, "generics", optional=True):
+            generic_associations.extend(
+                GenericAssociationItem.from_treesitter_node(association_node),
+            )
+        port_associations = []
+        for association_node in get_nodes(node, captures, "ports", optional=True):
+            port_associations.extend(
+                PortAssociationItem.from_treesitter_node(association_node),
+            )
+        return [
+            cls(
+                label=label,
+                entitySymbol=entity_symbol,
+                architectureSymbol=architecture_symbol,
+                genericAssociations=generic_associations,
+                portAssociations=port_associations,
+                _treesitter_node=node,
+            ),
+        ]
+
+    def __eq__(self, other: object) -> bool:  # noqa: D105
+        if not isinstance(other, self.__class__):
+            return False
+        return (
+            self._label == other._label
+            and self._entity == other._entity
+            and self._architecture == other._architecture
+            and self._genericAssociations == other._genericAssociations
+            and self._portAssociations == other._portAssociations
+        )
+
+    def __hash__(self) -> int:  # noqa: D105
+        return hash(
+            (
+                self._label,
+                self._entity,
+                self._architecture,
+                self._genericAssociations,
+                self._portAssociations,
+            ),
+        )
+
+    def __repr__(self) -> str:  # noqa: D105
+        return (
+            f"{self.__class__.__name__}("
+            f"_label={self._label!r}, "
+            f"_entity={self._entity!r}, "
+            f"_architecture={self._architecture!r}, "
+            f"_genericAssociations={self._genericAssociations!r}, "
+            f"_portAssociations={self._portAssociations!r}, "
+            ")"
+        )