pyVHDLModelTreesitter 0.2.1__tar.gz → 0.3.0__tar.gz

pyvhdlmodeltreesitter-0.3.0/PKG-INFO

@@ -0,0 +1,93 @@
+Metadata-Version: 2.4
+Name: pyVHDLModelTreesitter
+Version: 0.3.0
+Summary: An implementation of pyVHDLModel using treesitter
+Project-URL: Repository, https://gitlab.com/dawalters/pyVHDLModelTreesitter
+Author: Dominic Adam Walters
+License-File: LICENSE
+Keywords: language,model,treesitter,vhdl
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.11
+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: 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: pytest-cov==7.1.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'
+Description-Content-Type: text/markdown
+
+# pyVHDLModelTreesitter
+[![Version][shield-version]][pyVHDLModelTreesitter-pypi]
+[![Releases][shield-releases]][pyVHDLModelTreesitter-releases]
+[![Gitlab][shield-pipeline]][pyVHDLModelTreesitter-pipeline]
+[![pre-commit][shield-precommit]][precommit-github]
+[![Codecov][shield-codecov]][pyVHDLModelTreesitter-codecov]
+[![Python Version][shield-python-version]][pyVHDLModelTreesitter-pypi]
+
+`pyVHDLModelTreesitter` is an implementation of the
+[`pyVHDLModel`][pyVHDLModel-github] API using `tree-sitter-vhdl`.
+
+> 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`
+
+You can install the latest release from [PyPI][pyVHDLModelTreesitter-pypi]:
+
+```bash
+pip install pyVHDLModelTreesitter
+```
+
+### Source tarball
+
+You can download source releases from the
+[Gitlab Releases page][pyVHDLModelTreesitter-releases].
+
+## Documentation
+
+In the simplest cases where you just want to parse a VHDL file:
+
+```python3
+import pyVHDLModelTreesitter
+
+document = pyVHDLModelTreesitter.Document.from_file("path/to/file.vhd")
+```
+
+`pyVHDLModelTreesitter.Document` is a subclass of
+[`pyVHDLModel.Document`][pyVHDLModel-Document].
+
+Detailed documentation is currently unavailable.
+
+[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-codecov]: https://codecov.io/gitlab/dawalters/pyVHDLModelTreesitter
+[pyVHDLModelTreesitter-pipeline]: https://gitlab.com/dawalters/pyVHDLModelTreesitter/-/pipelines?page=1&scope=all&ref=develop
+[pyVHDLModelTreesitter-pypi]: https://pypi.org/project/pyVHDLModelTreesitter
+[pyVHDLModelTreesitter-releases]: https://gitlab.com/dawalters/pyVHDLModelTreesitter/-/releases
+[shield-codecov]: https://codecov.io/gitlab/dawalters/pyVHDLModelTreesitter/branch/develop/graph/badge.svg
+[shield-pipeline]: https://gitlab.com/dawalters/pyVHDLModelTreesitter/badges/develop/pipeline.svg
+[shield-precommit]: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit
+[shield-python-version]: https://img.shields.io/pypi/pyversions/pyVHDLModelTreesitter
+[shield-releases]: https://gitlab.com/dawalters/pyVHDLModelTreesitter/-/badges/release.svg
+[shield-version]: https://img.shields.io/pypi/v/pyVHDLModelTreesitter

pyvhdlmodeltreesitter-0.3.0/README.md

@@ -0,0 +1,61 @@
+# pyVHDLModelTreesitter
+[![Version][shield-version]][pyVHDLModelTreesitter-pypi]
+[![Releases][shield-releases]][pyVHDLModelTreesitter-releases]
+[![Gitlab][shield-pipeline]][pyVHDLModelTreesitter-pipeline]
+[![pre-commit][shield-precommit]][precommit-github]
+[![Codecov][shield-codecov]][pyVHDLModelTreesitter-codecov]
+[![Python Version][shield-python-version]][pyVHDLModelTreesitter-pypi]
+
+`pyVHDLModelTreesitter` is an implementation of the
+[`pyVHDLModel`][pyVHDLModel-github] API using `tree-sitter-vhdl`.
+
+> 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`
+
+You can install the latest release from [PyPI][pyVHDLModelTreesitter-pypi]:
+
+```bash
+pip install pyVHDLModelTreesitter
+```
+
+### Source tarball
+
+You can download source releases from the
+[Gitlab Releases page][pyVHDLModelTreesitter-releases].
+
+## Documentation
+
+In the simplest cases where you just want to parse a VHDL file:
+
+```python3
+import pyVHDLModelTreesitter
+
+document = pyVHDLModelTreesitter.Document.from_file("path/to/file.vhd")
+```
+
+`pyVHDLModelTreesitter.Document` is a subclass of
+[`pyVHDLModel.Document`][pyVHDLModel-Document].
+
+Detailed documentation is currently unavailable.
+
+[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-codecov]: https://codecov.io/gitlab/dawalters/pyVHDLModelTreesitter
+[pyVHDLModelTreesitter-pipeline]: https://gitlab.com/dawalters/pyVHDLModelTreesitter/-/pipelines?page=1&scope=all&ref=develop
+[pyVHDLModelTreesitter-pypi]: https://pypi.org/project/pyVHDLModelTreesitter
+[pyVHDLModelTreesitter-releases]: https://gitlab.com/dawalters/pyVHDLModelTreesitter/-/releases
+[shield-codecov]: https://codecov.io/gitlab/dawalters/pyVHDLModelTreesitter/branch/develop/graph/badge.svg
+[shield-pipeline]: https://gitlab.com/dawalters/pyVHDLModelTreesitter/badges/develop/pipeline.svg
+[shield-precommit]: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit
+[shield-python-version]: https://img.shields.io/pypi/pyversions/pyVHDLModelTreesitter
+[shield-releases]: https://gitlab.com/dawalters/pyVHDLModelTreesitter/-/badges/release.svg
+[shield-version]: https://img.shields.io/pypi/v/pyVHDLModelTreesitter

{pyvhdlmodeltreesitter-0.2.1 → pyvhdlmodeltreesitter-0.3.0}/pyproject.toml

@@ -4,15 +4,14 @@ build-backend = "hatchling.build"
 
 [project]
 name = "pyVHDLModelTreesitter"
-version = "0.2.1"
+version = "0.3.0"
 description = "An implementation of pyVHDLModel using treesitter"
 readme = "README.md"
-requires-python = ">=3.10"
+requires-python = ">=3.11"
 dependencies = [
-    "pyVHDLModel <= 0.31.3",
+    "pyVHDLModel >= 0.32.0",
     "tree-sitter >= 0.23.0",
     "tree-sitter-vhdl >= 1.2.5",
-    "typing-extensions >= 4.0.0; python_version < '3.11'",
 ]
 authors = [
     { name = "Dominic Adam Walters" },
@@ -22,7 +21,6 @@ classifiers = [
   "Development Status :: 3 - Alpha",
   "License :: OSI Approved :: MIT License",
   "Programming Language :: Python :: 3 :: Only",
-  "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12",
   "Programming Language :: Python :: 3.13",
@@ -85,7 +83,7 @@ dependencies = [
 ]
 
 [[tool.hatch.envs.hatch-test.matrix]]
-python = ["3.10", "3.11", "3.12", "3.13", "3.14"]
+python = ["3.11", "3.12", "3.13", "3.14"]
 
 [tool.mypy]
 strict = true

pyvhdlmodeltreesitter-0.3.0/src/pyVHDLModelTreesitter/Base.py

@@ -0,0 +1,163 @@
+"""Submodule mirroring modified aspects of pyVHDLModel.Base."""
+
+from __future__ import annotations
+
+__all__ = [
+    "Range",
+]
+
+from typing import TYPE_CHECKING, Self, cast
+
+import pyVHDLModel
+
+if TYPE_CHECKING:
+    from tree_sitter import Node
+
+from pyVHDLModelTreesitter._errors import (
+    NodeExtraChildError,
+    NodeMissingChildError,
+    NodeTextIsInvalidError,
+    NodeTextIsNoneError,
+    NotImplementedWarning,
+)
+from pyVHDLModelTreesitter.Expression import parse_simple_expression
+from pyVHDLModelTreesitter.treesitter import BaseTreesitterNode
+
+
+def parse_as_direction(string: str) -> pyVHDLModel.Base.Direction | None:
+    """
+    Parse a string as a direction.
+
+    This will accept any mix of the following:
+        - Incorrect capitalisation
+            - "tO"
+            - "To"
+        - Split words with whitespace
+            - "down to"
+    """
+    # TODO: make a PR on pyVHDLModel to add this
+    string = "".join(string.split()).lower().capitalize()
+    if string == "Downto":
+        string = "DownTo"
+    try:
+        return pyVHDLModel.Base.Direction[string]
+    except IndexError:
+        return None
+
+
+def parse_as_mode(string: str) -> pyVHDLModel.Base.Mode | None:
+    """
+    Parse a string as a mode.
+
+    This will accept any mix of the following:
+        - Incorrect capitalisation
+            - "IN"
+            - "iN"
+            - "in"
+        - Split words with whitespace
+            - "in out"
+    """
+    # TODO: make a PR on pyVHDLModel to add this
+    string = "".join(string.split()).lower().capitalize()
+    if string == "Inout":
+        string = "InOut"
+    try:
+        return pyVHDLModel.Base.Mode[string]
+    except IndexError:
+        return None
+
+
+class Range(BaseTreesitterNode, pyVHDLModel.Base.Range):  # noqa: D101
+    @classmethod
+    def from_treesitter_node(  # noqa: C901, PLR0912
+        cls,
+        node: Node,
+    ) -> Self | None:
+        """
+        Create a Range from a treesitter node.
+
+        Raises
+        ------
+        NodeExtraChildError:
+            If `node.children` does not have 2 elements.
+        NodeMissingChildError:
+            If `node.type` is not `simple_range`.
+        NodeTextIsInvalidError:
+            If the direction in `node` could not be parsed.
+        NodeTextIsNoneError:
+            If `node` or any relevant subnode doesn't define `text`.
+
+        """
+        if node.type != "simple_range":
+            raise NodeMissingChildError(node, "simple_range")
+        if node.text is None or len(node.text) == 0:
+            raise NodeTextIsNoneError(node)
+        if len(node.children) != 3:  # noqa: PLR2004
+            raise NodeExtraChildError(node, "all children", 3)
+        left = node.child(0)
+        if left is None:
+            raise NodeMissingChildError(node, "first-child")
+        if left.type != "simple_expression":
+            NotImplementedWarning.warn_child_type(left.type, "simple_range")
+            return None
+        if left.text is None or len(left.text) == 0:
+            raise NodeTextIsNoneError(left)
+        direction_node = node.child(1)
+        if direction_node is None:
+            raise NodeMissingChildError(node, "second-child")
+        if len(direction_node.type) == 0:
+            NotImplementedWarning.warn_child_type(direction_node.type, "")
+            return None
+        if direction_node.text is None or len(direction_node.text) == 0:
+            raise NodeTextIsNoneError(direction_node)
+        direction_str = direction_node.text.decode("utf-8")
+        right = node.child(2)
+        if right is None:
+            raise NodeMissingChildError(node, "third-child")
+        if right.type != "simple_expression":
+            NotImplementedWarning.warn_child_type(right.type, "simple_range")
+            return None
+        if right.text is None or len(right.text) == 0:
+            raise NodeTextIsNoneError(right)
+        left_expr = parse_simple_expression(left)
+        if left_expr is None:
+            return None
+        right_expr = parse_simple_expression(right)
+        if right_expr is None:
+            return None
+        direction = parse_as_direction(direction_str)
+        if direction is None:
+            raise NodeTextIsInvalidError(
+                node,
+                f"'{direction_str}' is not a valid VHDL direction",
+            )
+        return cls(left_expr, right_expr, direction, _treesitter_node=node)
+
+    def __eq__(self, other: object) -> bool:  # noqa: D105
+        if not isinstance(other, Range):
+            return False
+        # Required for LSP completions
+        other = cast("Range", other)  # type: ignore[redundant-cast]
+        return (
+            self._leftBound == other._leftBound
+            and self._rightBound == other._rightBound
+            and self._direction == other._direction
+        )
+
+    def __hash__(self) -> int:  # noqa: D105
+        return hash(
+            (
+                self._leftBound,
+                self._rightBound,
+                self._direction,
+            ),
+        )
+
+    def __repr__(self) -> str:  # noqa: D105
+        return (
+            f"{self.__class__.__name__}("
+            f"_leftBound={self._leftBound!r}, "
+            f"_rightBound={self._rightBound!r}, "
+            f"_direction={self._direction!r}, "
+            ")"
+        )

{pyvhdlmodeltreesitter-0.2.1 → pyvhdlmodeltreesitter-0.3.0}/src/pyVHDLModelTreesitter/DesignUnit.py

@@ -8,27 +8,25 @@ __all__ = [
     "UseClause",
 ]
 
-import sys
-from functools import cmp_to_key
-from typing import TYPE_CHECKING, cast
-
-if sys.version_info >= (3, 11):
-    from typing import Self
-else:
-    from typing_extensions import Self
+from typing import TYPE_CHECKING, Self, cast
 
 import pyVHDLModel
 from pyVHDLModel.DesignUnit import LibraryClause as BaseLibraryClause
 from pyVHDLModel.DesignUnit import UseClause as BaseUseClause
 
-from pyVHDLModelTreesitter._error import ExtraNodeError, NodeTextIsNoneError
+from pyVHDLModelTreesitter._errors import NodeExtraChildError, NodeTextIsNoneError
 from pyVHDLModelTreesitter.Interface import (
     GenericConstantInterfaceItem,
     PortSignalInterfaceItem,
 )
 from pyVHDLModelTreesitter.Name import SelectedName, SimpleName
 from pyVHDLModelTreesitter.Symbol import LibraryReferenceSymbol, PackageReferenceSymbol
-from pyVHDLModelTreesitter.treesitter import get_node_or_raise, get_nodes_or_raise
+from pyVHDLModelTreesitter.treesitter import (
+    BaseTreesitterNode,
+    get_node_or_raise,
+    get_nodes_or_raise,
+    sort_into_text_order,
+)
 from pyVHDLModelTreesitter.treesitter.query import (
     EntityDeclaration,
     InterfaceDeclarations,
@@ -44,7 +42,7 @@ if TYPE_CHECKING:
     import tree_sitter
 
 
-class LibraryClause(BaseLibraryClause):  # noqa: D101
+class LibraryClause(BaseTreesitterNode, BaseLibraryClause):  # noqa: D101
     @classmethod
     def from_treesitter_node(
         cls,
@@ -63,8 +61,7 @@ class LibraryClause(BaseLibraryClause):  # noqa: D101
         library_clause_nodes = get_nodes_or_raise(
             node,
             captures,
-            "library-clause",
-            LibraryClauses.TEXT,
+            "library_clause",
         )
         ret = []
         for library_clause_node in library_clause_nodes:
@@ -73,15 +70,14 @@ class LibraryClause(BaseLibraryClause):  # noqa: D101
                 node,
                 captures,
                 "library",
-                LibraryNamespaces.TEXT,
             )
             symbols = []
             for library_namespace_node in library_namespace_nodes:
                 if library_namespace_node.text is None:
-                    raise NodeTextIsNoneError(node, LibraryNamespaces.TEXT, "library")
+                    raise NodeTextIsNoneError(node)
                 library = library_namespace_node.text.decode()
                 symbols.append(LibraryReferenceSymbol(SimpleName(library)))
-            ret.append(cls(symbols))
+            ret.append(cls(symbols, _treesitter_node=library_clause_node))
         return ret
 
     def __eq__(self, other: object) -> bool:  # noqa: D105
@@ -100,7 +96,7 @@ class LibraryClause(BaseLibraryClause):  # noqa: D101
         return f"{self.__class__.__name__}(_symbols={self._symbols!r}, )"
 
 
-class UseClause(BaseUseClause):  # noqa: D101
+class UseClause(BaseTreesitterNode, BaseUseClause):  # noqa: D101
     @classmethod
     def from_treesitter_node(
         cls,
@@ -119,8 +115,7 @@ class UseClause(BaseUseClause):  # noqa: D101
         use_clause_nodes = get_nodes_or_raise(
             node,
             captures,
-            "use-clause",
-            UseClauses.TEXT,
+            "use_clause",
         )
         ret = []
         for use_clause_node in use_clause_nodes:
@@ -128,13 +123,12 @@ class UseClause(BaseUseClause):  # noqa: D101
             selected_name_nodes = get_nodes_or_raise(
                 node,
                 captures,
-                "selected-name",
-                SelectedNames.TEXT,
+                "selected_name",
             )
             symbols = []
             for selected_name_node in selected_name_nodes:
                 if selected_name_node.text is None:
-                    raise NodeTextIsNoneError(node, SelectedNames.TEXT, "selected-name")
+                    raise NodeTextIsNoneError(node)
                 selected_name = selected_name_node.text.decode()
                 selected_name_parts = selected_name.split(".")
                 selected_name_obj: SimpleName | SelectedName = SimpleName(
@@ -142,8 +136,11 @@ class UseClause(BaseUseClause):  # noqa: D101
                 )
                 for part in selected_name_parts[1:]:
                     selected_name_obj = SelectedName(part, selected_name_obj)
+                # TODO: should use:
+                #   PackageMemberReferenceSymbol
+                #   AllPackageMembersReferenceSymbol
                 symbols.append(PackageReferenceSymbol(selected_name_obj))
-            ret.append(cls(symbols))
+            ret.append(cls(symbols, _treesitter_node=selected_name_node))
         return ret
 
     def __eq__(self, other: object) -> bool:  # noqa: D105
@@ -162,20 +159,20 @@ class UseClause(BaseUseClause):  # noqa: D101
         return f"{self.__class__.__name__}(_symbols={self._symbols!r}, )"
 
 
-class Entity(pyVHDLModel.Entity):  # noqa: D101
+class Entity(BaseTreesitterNode, pyVHDLModel.Entity):  # noqa: D101
     @classmethod
     def from_treesitter_node(
         cls,
         node: tree_sitter.Node,
         *,
-        contextItems: Iterable[LibraryClause | UseClause] = [],  # noqa: N803
+        context_items: Iterable[LibraryClause | UseClause] = [],
     ) -> Self:
         """
         Create an Entity from a treesitter node.
 
         Raises
         ------
-        ExtraNodeError:
+        NodeExtraChildError:
             If there is more than one `generics` or `ports` capture.
         NodeTextIsNoneError:
             If the `name` capture has no text.
@@ -186,56 +183,40 @@ class Entity(pyVHDLModel.Entity):  # noqa: D101
             node,
             captures,
             "name",
-            EntityDeclaration.TEXT,
         )
         if name_node.text is None:
-            raise NodeTextIsNoneError(node, EntityDeclaration.TEXT, "name")
+            raise NodeTextIsNoneError(node)
         name_text = name_node.text.decode()
         generics_nodes = captures.get("generics", [])
         if len(generics_nodes) > 1:
-            raise ExtraNodeError(node, EntityDeclaration.TEXT, "generics")
+            raise NodeExtraChildError(node, "generic_clause", 1)
         ports_nodes = captures.get("ports", [])
         if len(ports_nodes) > 1:
-            raise ExtraNodeError(node, EntityDeclaration.TEXT, "generics")
+            raise NodeExtraChildError(node, "port_clause", 1)
         generic_items = None
         if len(generics_nodes) == 1:
             generics_node = generics_nodes[0]
             captures = InterfaceDeclarations.capture(generics_node)
-            generic_items_with_nodes = [
+            generic_items = sort_into_text_order(
                 (
-                    GenericConstantInterfaceItem.from_treesitter_node(interface_node),
-                    interface_node,
-                )
-                for interface_node in captures.get("interface", [])
-            ]
-            generic_items = [
-                obj
-                for obj, _ in sorted(
-                    generic_items_with_nodes,
-                    key=cmp_to_key(lambda l, r: l[1].start_byte - r[1].start_byte),  # type: ignore[index]  # noqa: E741
-                )
-            ]
+                    GenericConstantInterfaceItem.from_treesitter_node(interface_node)
+                    for interface_node in captures.get("interface", [])
+                ),
+            )
         port_items = None
         if len(ports_nodes) == 1:
             ports_node = ports_nodes[0]
             captures = InterfaceDeclarations.capture(ports_node)
-            port_items_with_nodes = [
+            port_items = sort_into_text_order(
                 (
-                    PortSignalInterfaceItem.from_treesitter_node(interface_node),
-                    interface_node,
-                )
-                for interface_node in captures.get("interface", [])
-            ]
-            port_items = [
-                obj
-                for obj, _ in sorted(
-                    port_items_with_nodes,
-                    key=cmp_to_key(lambda l, r: l[1].start_byte - r[1].start_byte),  # type: ignore[index]  # noqa: E741
-                )
-            ]
+                    PortSignalInterfaceItem.from_treesitter_node(interface_node)
+                    for interface_node in captures.get("interface", [])
+                ),
+            )
         return cls(
+            _treesitter_node=node,
             identifier=name_text,
-            contextItems=contextItems,
+            contextItems=context_items,
             genericItems=generic_items,
             portItems=port_items,
             declaredItems=None,  # TODO: implement