pyVHDLModelTreesitter 0.8.0__tar.gz → 0.9.0__tar.gz

{pyvhdlmodeltreesitter-0.8.0 → pyvhdlmodeltreesitter-0.9.0}/.gitignore

@@ -7,7 +7,8 @@
 /.venv
 /dist/
 
-__pycache__/
+.docker-login
 .mypy_cache/
 .pytest_cache/
 .ruff_cache/
+__pycache__/

{pyvhdlmodeltreesitter-0.8.0 → pyvhdlmodeltreesitter-0.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyVHDLModelTreesitter
-Version: 0.8.0
+Version: 0.9.0
 Summary: An implementation of pyVHDLModel using treesitter
 Project-URL: Repository, https://gitlab.com/dawalters/pyVHDLModelTreesitter
 Author: Dominic Adam Walters
@@ -47,7 +47,8 @@ Description-Content-Type: text/markdown
 [![Python Version][shield-python-version]][pyVHDLModelTreesitter-pypi]
 
 `pyVHDLModelTreesitter` is an implementation of the
-[`pyVHDLModel`][pyVHDLModel-github] API using `tree-sitter-vhdl`.
+[`pyVHDLModel`][pyVHDLModel-github] API using
+[`tree-sitter-vhdl`][tree-sitter-vhdl].
 
 > Disclaimer: This project is in early development and only implements a
               fraction of the features of [`pyVHDLModel`][pyVHDLModel-github].
@@ -69,9 +70,9 @@ You can download source releases from the
 
 ## Documentation
 
-In the simplest cases where you just want to parse a VHDL file:
+To parse a VHDL file:
 
-```python3
+```python
 import pyVHDLModelTreesitter
 
 document = pyVHDLModelTreesitter.Document.from_file("path/to/file.vhd")
@@ -80,7 +81,9 @@ document = pyVHDLModelTreesitter.Document.from_file("path/to/file.vhd")
 `pyVHDLModelTreesitter.Document` is a subclass of
 [`pyVHDLModel.Document`][pyVHDLModel-Document].
 
-Detailed documentation is currently unavailable.
+Detailed documentation is available for [`pyVHDLModel`][pyVHDLModel-documentation].
+
+A complete list of public API endpoints is in [DOCS.md](DOCS.md).
 
 ## Setup for Development
 
@@ -107,6 +110,7 @@ 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-documentation]: https://vhdl.github.io/pyVHDLModel
 [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
@@ -118,3 +122,4 @@ You can `make help` to see what actions are available.
 [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
+[tree-sitter-vhdl]: https://github.com/jpt13653903/tree-sitter-vhdl

{pyvhdlmodeltreesitter-0.8.0 → pyvhdlmodeltreesitter-0.9.0}/README.md

@@ -7,7 +7,8 @@
 [![Python Version][shield-python-version]][pyVHDLModelTreesitter-pypi]
 
 `pyVHDLModelTreesitter` is an implementation of the
-[`pyVHDLModel`][pyVHDLModel-github] API using `tree-sitter-vhdl`.
+[`pyVHDLModel`][pyVHDLModel-github] API using
+[`tree-sitter-vhdl`][tree-sitter-vhdl].
 
 > Disclaimer: This project is in early development and only implements a
               fraction of the features of [`pyVHDLModel`][pyVHDLModel-github].
@@ -29,9 +30,9 @@ You can download source releases from the
 
 ## Documentation
 
-In the simplest cases where you just want to parse a VHDL file:
+To parse a VHDL file:
 
-```python3
+```python
 import pyVHDLModelTreesitter
 
 document = pyVHDLModelTreesitter.Document.from_file("path/to/file.vhd")
@@ -40,7 +41,9 @@ document = pyVHDLModelTreesitter.Document.from_file("path/to/file.vhd")
 `pyVHDLModelTreesitter.Document` is a subclass of
 [`pyVHDLModel.Document`][pyVHDLModel-Document].
 
-Detailed documentation is currently unavailable.
+Detailed documentation is available for [`pyVHDLModel`][pyVHDLModel-documentation].
+
+A complete list of public API endpoints is in [DOCS.md](DOCS.md).
 
 ## Setup for Development
 
@@ -67,6 +70,7 @@ 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-documentation]: https://vhdl.github.io/pyVHDLModel
 [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
@@ -78,3 +82,4 @@ You can `make help` to see what actions are available.
 [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
+[tree-sitter-vhdl]: https://github.com/jpt13653903/tree-sitter-vhdl

{pyvhdlmodeltreesitter-0.8.0 → pyvhdlmodeltreesitter-0.9.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "pyVHDLModelTreesitter"
-version = "0.8.0"
+version = "0.9.0"
 description = "An implementation of pyVHDLModel using treesitter"
 readme = "README.md"
 requires-python = ">=3.11"
@@ -89,6 +89,7 @@ dependencies = [
 python = ["3.11", "3.12", "3.13", "3.14"]
 
 [tool.mypy]
+allow_redefinition = true
 implicit_reexport = true
 scripts_are_modules = true
 strict = true

{pyvhdlmodeltreesitter-0.8.0 → pyvhdlmodeltreesitter-0.9.0}/src/pyVHDLModelTreesitter/_Association.py

@@ -13,12 +13,12 @@ from pyVHDLModel.Name import OpenName
 from pyVHDLModel.Symbol import SignalSymbol
 
 from pyVHDLModelTreesitter._Name import parse_name
-from pyVHDLModelTreesitter.treesitter import (
+from pyVHDLModelTreesitter.queries import AssociationElement
+from pyVHDLModelTreesitter.queries._protocol import inject_node
+from pyVHDLModelTreesitter.queries._utils import (
     get_node,
     get_node_text,
-    inject_node,
 )
-from pyVHDLModelTreesitter.treesitter.query import AssociationElement
 
 if TYPE_CHECKING:
     import pyVHDLModel

{pyvhdlmodeltreesitter-0.8.0 → pyvhdlmodeltreesitter-0.9.0}/src/pyVHDLModelTreesitter/_Base.py

@@ -17,15 +17,15 @@ from pyVHDLModel.Base import SimpleRange, WaveformElement
 if TYPE_CHECKING:
     from tree_sitter import Node
 
-from pyVHDLModelTreesitter._errors import (
+from pyVHDLModelTreesitter._parse import parse_simple_expression
+from pyVHDLModelTreesitter.error import (
     NodeExtraChildError,
     NodeMissingChildError,
     NodeTextIsInvalidError,
     NodeTextIsNoneError,
     NotImplementedWarning,
 )
-from pyVHDLModelTreesitter._parse import parse_simple_expression
-from pyVHDLModelTreesitter.treesitter import inject_node
+from pyVHDLModelTreesitter.queries._protocol import inject_node
 
 
 def parse_direction(string: str) -> pyVHDLModel.Base.Direction | None:

{pyvhdlmodeltreesitter-0.8.0 → pyvhdlmodeltreesitter-0.9.0}/src/pyVHDLModelTreesitter/_Concurrent.py

@@ -7,6 +7,7 @@ __all__ = [
     "parse_concurrent_conditional_signal_assignment",
     "parse_concurrent_simple_signal_assignment",
     "parse_entity_instantiation",
+    "parse_process",
 ]
 
 from typing import TYPE_CHECKING
@@ -20,6 +21,7 @@ from pyVHDLModel.Concurrent import (
     ConcurrentConditionalSignalAssignment,
     ConcurrentSimpleSignalAssignment,
     EntityInstantiation,
+    ProcessStatement,
 )
 from pyVHDLModel.Symbol import (
     ArchitectureSymbol,
@@ -30,24 +32,31 @@ from pyVHDLModel.Symbol import (
 
 from pyVHDLModelTreesitter._Association import parse_association_item
 from pyVHDLModelTreesitter._Base import parse_waveform_element
-from pyVHDLModelTreesitter._errors import NotImplementedWarning
 from pyVHDLModelTreesitter._Name import parse_name
-from pyVHDLModelTreesitter.treesitter import (
-    get_node,
-    get_node_text,
-    get_nodes,
-    inject_node,
-    sort_into_text_order,
-)
-from pyVHDLModelTreesitter.treesitter.query import (
+from pyVHDLModelTreesitter._Object import parse_variable
+from pyVHDLModelTreesitter._Sequential import parse_sequential_block
+from pyVHDLModelTreesitter.error import NotImplementedWarning
+from pyVHDLModelTreesitter.queries import (
     ComponentInstantiationStatement,
 )
-from pyVHDLModelTreesitter.treesitter.query import (
+from pyVHDLModelTreesitter.queries import (
     ConcurrentConditionalSignalAssignment as ConcurrentConditionalSignalAssignmentQuery,
 )
-from pyVHDLModelTreesitter.treesitter.query import (
+from pyVHDLModelTreesitter.queries import (
     ConcurrentSimpleSignalAssignment as ConcurrentSimpleSignalAssignmentQuery,
 )
+from pyVHDLModelTreesitter.queries import (
+    ProcessStatement as ProcessStatementQuery,
+)
+from pyVHDLModelTreesitter.queries._protocol import (
+    inject_node,
+    sort_into_text_order,
+)
+from pyVHDLModelTreesitter.queries._utils import (
+    get_node,
+    get_node_text,
+    get_nodes,
+)
 
 if TYPE_CHECKING:
     import tree_sitter
@@ -190,3 +199,41 @@ def parse_entity_instantiation(
         ),
         node,
     )
+
+
+def parse_process(
+    node: tree_sitter.Node,
+) -> ProcessStatement | None:
+    """Create a `ProcessStatement` from a treesitter node."""
+    captures = ProcessStatementQuery.capture(node)
+    label_node = get_node(node, captures, "label", optional=True)
+    label = get_node_text(label_node) if label_node is not None else None
+    sensitivity_names = captures.get("sensitivity_name", [])
+    sensitivity_list = None
+    if sensitivity_names:
+        sensitivity_list = [
+            parse_name(get_node_text(name_node))
+            for name_node in sort_into_text_order(sensitivity_names)
+        ]
+    body_node = get_node(node, captures, "body")
+    statements = parse_sequential_block(body_node)
+    declared_items = None
+    head_node = get_node(node, captures, "head", optional=True)
+    if head_node is not None:
+        declared_items = [
+            v
+            for child in head_node.children
+            if child.type == "variable_declaration"
+            if (v := parse_variable(child)) is not None
+        ]
+    return inject_node(
+        ProcessStatement(
+            # TODO: label is incorrectly `str` rather than `Nullable[str]`
+            label=label,
+            declaredItems=declared_items,
+            statements=statements,
+            sensitivityList=sensitivity_list,
+            documentation="",
+        ),
+        node,
+    )

{pyvhdlmodeltreesitter-0.8.0 → pyvhdlmodeltreesitter-0.9.0}/src/pyVHDLModelTreesitter/_DesignUnit.py

@@ -18,7 +18,7 @@ from pyVHDLModel.DesignUnit import (
     UseClause,
 )
 from pyVHDLModel.Name import AllName, SimpleName
-from pyVHDLModel.Object import Constant, Signal
+from pyVHDLModel.Object import Constant, DeferredConstant, Signal
 from pyVHDLModel.Symbol import (
     AllPackageMembersReferenceSymbol,
     EntitySymbol,
@@ -27,16 +27,19 @@ from pyVHDLModel.Symbol import (
     PackageReferenceSymbol,
     PackageSymbol,
 )
+from pyVHDLModel.Type import (
+    EnumeratedType,
+    IntegerType,
+    RecordType,
+    Subtype,
+)
 
 from pyVHDLModelTreesitter._Concurrent import (
     parse_component_instantiation,
     parse_concurrent_conditional_signal_assignment,
     parse_concurrent_simple_signal_assignment,
     parse_entity_instantiation,
-)
-from pyVHDLModelTreesitter._errors import (
-    NodeExtraChildError,
-    NotImplementedWarning,
+    parse_process,
 )
 from pyVHDLModelTreesitter._Interface import (
     parse_generic_constant_interface_item,
@@ -44,14 +47,15 @@ from pyVHDLModelTreesitter._Interface import (
 )
 from pyVHDLModelTreesitter._Name import parse_name
 from pyVHDLModelTreesitter._Object import parse_constant, parse_signal
-from pyVHDLModelTreesitter.treesitter import (
-    get_node,
-    get_node_text,
-    get_nodes,
-    inject_node,
-    sort_into_text_order,
+from pyVHDLModelTreesitter._Type import (
+    parse_subtype_declaration,
+    parse_type_declaration,
+)
+from pyVHDLModelTreesitter.error import (
+    NodeExtraChildError,
+    NotImplementedWarning,
 )
-from pyVHDLModelTreesitter.treesitter.query import (
+from pyVHDLModelTreesitter.queries import (
     ArchitectureDefinition,
     EntityDeclaration,
     InterfaceDeclarations,
@@ -62,9 +66,18 @@ from pyVHDLModelTreesitter.treesitter.query import (
     SelectedNames,
     UseClauses,
 )
-from pyVHDLModelTreesitter.treesitter.query import (
+from pyVHDLModelTreesitter.queries import (
     ComponentDeclaration as ComponentDeclarationQuery,
 )
+from pyVHDLModelTreesitter.queries._protocol import (
+    inject_node,
+    sort_into_text_order,
+)
+from pyVHDLModelTreesitter.queries._utils import (
+    get_node,
+    get_node_text,
+    get_nodes,
+)
 
 if TYPE_CHECKING:
     from collections.abc import Iterable
@@ -180,10 +193,19 @@ def parse_use_clauses(node: tree_sitter.Node) -> list[UseClause]:
     return ret
 
 
-Declarations = Component | Constant | Signal
+Declarations = (
+    Component
+    | Constant
+    | DeferredConstant
+    | EnumeratedType
+    | IntegerType
+    | RecordType
+    | Signal
+    | Subtype
+)
 
 
-def parse_declarations(node: tree_sitter.Node) -> list[Declarations]:
+def parse_declarations(node: tree_sitter.Node) -> list[Declarations]:  # ruff: ignore[complex-structure, too-many-branches]
     ret: list[Declarations] = []
     for child in node.children:
         if child.type == "constant_declaration":
@@ -194,6 +216,14 @@ def parse_declarations(node: tree_sitter.Node) -> list[Declarations]:
             signal = parse_signal(child)
             if signal is not None:
                 ret.append(signal)
+        elif child.type == "subtype_declaration":
+            subtype = parse_subtype_declaration(child)
+            if subtype is not None:
+                ret.append(subtype)
+        elif child.type == "type_declaration":
+            td = parse_type_declaration(child)
+            if td is not None:
+                ret.append(td)
         elif child.type == "component_declaration":
             component = parse_component(child)
             if component is not None:
@@ -217,7 +247,7 @@ def _is_component_instantiation(node: tree_sitter.Node) -> bool:
     return False
 
 
-def parse_architecture(  # ruff: ignore[complex-structure]
+def parse_architecture(  # ruff: ignore[complex-structure, too-many-branches]
     node: tree_sitter.Node,
     *,
     context_items: Iterable[LibraryClause | UseClause] = [],
@@ -250,6 +280,10 @@ def parse_architecture(  # ruff: ignore[complex-structure]
             ccsa = parse_concurrent_conditional_signal_assignment(statement_node)
             if ccsa is not None:
                 statements.append(ccsa)
+        elif statement_node.type == "process_statement":
+            ps = parse_process(statement_node)
+            if ps is not None:
+                statements.append(ps)
         elif statement_node.type == "begin":
             continue
         else:

{pyvhdlmodeltreesitter-0.8.0 → pyvhdlmodeltreesitter-0.9.0}/src/pyVHDLModelTreesitter/_Document.py

@@ -19,9 +19,10 @@ from pyVHDLModelTreesitter._DesignUnit import (
     parse_package_body,
     parse_use_clauses,
 )
-from pyVHDLModelTreesitter._errors import NodeMissingChildError, NotImplementedWarning
-from pyVHDLModelTreesitter.treesitter._utils import pretty_sexpr
-from pyVHDLModelTreesitter.treesitter.query import PARSER, DesignUnits
+from pyVHDLModelTreesitter.error import NodeMissingChildError, NotImplementedWarning
+from pyVHDLModelTreesitter.queries import DesignUnits
+from pyVHDLModelTreesitter.queries._query import PARSER
+from pyVHDLModelTreesitter.queries._utils import pretty_sexpr
 
 
 def _design_unit_sort_key(du: DesignUnit) -> tuple[str, str]:

{pyvhdlmodeltreesitter-0.8.0 → pyvhdlmodeltreesitter-0.9.0}/src/pyVHDLModelTreesitter/_Interface.py

@@ -20,19 +20,19 @@ if TYPE_CHECKING:
     from pyVHDLModel.Symbol import SubtypeSymbol
 
 from pyVHDLModelTreesitter._Base import parse_mode
-from pyVHDLModelTreesitter._errors import (
+from pyVHDLModelTreesitter._parse import parse_simple_expression
+from pyVHDLModelTreesitter._subtype_indication import parse_subtype_indication
+from pyVHDLModelTreesitter.error import (
     NodeExtraChildError,
     NodeMissingChildError,
     NotImplementedWarning,
 )
-from pyVHDLModelTreesitter._parse import parse_simple_expression
-from pyVHDLModelTreesitter._subtype_indication import parse_subtype_indication
-from pyVHDLModelTreesitter.treesitter import (
+from pyVHDLModelTreesitter.queries import InterfaceDeclaration
+from pyVHDLModelTreesitter.queries._protocol import inject_node
+from pyVHDLModelTreesitter.queries._utils import (
     get_node,
     get_node_text,
-    inject_node,
 )
-from pyVHDLModelTreesitter.treesitter.query import InterfaceDeclaration
 
 if TYPE_CHECKING:
     from tree_sitter import Node

pyvhdlmodeltreesitter-0.9.0/src/pyVHDLModelTreesitter/_Object.py

@@ -0,0 +1,90 @@
+"""Submodule defining parsers for classes from pyVHDLModel.Object."""
+
+from __future__ import annotations
+
+__all__ = [
+    "parse_constant",
+    "parse_signal",
+    "parse_variable",
+]
+
+from typing import TYPE_CHECKING, Any, TypeVar
+
+from pyVHDLModel.Object import Constant, DeferredConstant, Signal, Variable
+
+if TYPE_CHECKING:
+    import tree_sitter
+
+from pyVHDLModelTreesitter._parse import parse_conditional_expression
+from pyVHDLModelTreesitter._subtype_indication import parse_subtype_indication
+from pyVHDLModelTreesitter.queries import (
+    ConstantDeclaration,
+    SignalDeclaration,
+    VariableDeclaration,
+)
+from pyVHDLModelTreesitter.queries._protocol import inject_node
+from pyVHDLModelTreesitter.queries._utils import (
+    get_node,
+    get_node_text,
+    get_nodes,
+)
+
+T = TypeVar("T", Constant, Signal, Variable)
+
+
+def _parse_object(
+    node: tree_sitter.Node,
+    cls: type[T],
+) -> T | None:
+    """Parse a constant, signal, or variable declaration."""
+    query: type[ConstantDeclaration | SignalDeclaration | VariableDeclaration]
+    if cls is Constant:
+        query = ConstantDeclaration
+    elif cls is Signal:
+        query = SignalDeclaration
+    else:
+        query = VariableDeclaration
+    captures = query.capture(node)
+    name_nodes = get_nodes(node, captures, "name")
+    identifiers = [get_node_text(name_node) for name_node in name_nodes]
+    subtype_node = get_node(node, captures, "type")
+    subtype = parse_subtype_indication(subtype_node)
+    if subtype is None:
+        return None
+    value_node = get_node(node, captures, "value", optional=True)
+    value: Any = None
+    if value_node is not None:
+        value = parse_conditional_expression(value_node)
+        if value is None:
+            return None
+    return inject_node(
+        cls(identifiers, subtype, value, documentation=""),
+        node,
+    )
+
+
+def parse_constant(node: tree_sitter.Node) -> Constant | DeferredConstant | None:
+    """Create a Constant or DeferredConstant from a treesitter node."""
+    result = _parse_object(node, Constant)
+    if result is None:
+        return None
+    if result._defaultExpression is None:  # ruff: ignore[private-member-access]
+        return inject_node(
+            DeferredConstant(
+                result._identifiers,  # ruff: ignore[private-member-access]
+                result._subtype,  # ruff: ignore[private-member-access]
+                documentation="",
+            ),
+            node,
+        )
+    return result
+
+
+def parse_signal(node: tree_sitter.Node) -> Signal | None:
+    """Create a Signal from a treesitter node."""
+    return _parse_object(node, Signal)
+
+
+def parse_variable(node: tree_sitter.Node) -> Variable | None:
+    """Create a Variable from a treesitter node."""
+    return _parse_object(node, Variable)