pyVHDLModelTreesitter 0.2.1__tar.gz → 0.2.2__tar.gz

{pyvhdlmodeltreesitter-0.2.1 → pyvhdlmodeltreesitter-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyVHDLModelTreesitter
-Version: 0.2.1
+Version: 0.2.2
 Summary: An implementation of pyVHDLModel using treesitter
 Project-URL: Repository, https://gitlab.com/dawalters/pyVHDLModelTreesitter
 Author: Dominic Adam Walters

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

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "pyVHDLModelTreesitter"
-version = "0.2.1"
+version = "0.2.2"
 description = "An implementation of pyVHDLModel using treesitter"
 readme = "README.md"
 requires-python = ">=3.10"

{pyvhdlmodeltreesitter-0.2.1 → pyvhdlmodeltreesitter-0.2.2}/src/pyVHDLModelTreesitter/__init__.py

@@ -15,9 +15,10 @@ __all__: list[str] = [
     "Name",
     "NodeTextIsNoneError",
     "Symbol",
+    "treesitter",
 ]
 
-from . import DesignUnit, Expression, Interface, Name, Symbol
+from . import DesignUnit, Expression, Interface, Name, Symbol, treesitter
 from ._error import ExtraNodeError, MissingNodeError, NodeTextIsNoneError
 from ._root import Design, Document, Library
 from .DesignUnit import Entity

{pyvhdlmodeltreesitter-0.2.1 → pyvhdlmodeltreesitter-0.2.2}/src/pyVHDLModelTreesitter/treesitter/query.py

@@ -2,8 +2,9 @@
 
 from __future__ import annotations
 
+import re
 from pathlib import Path
-from typing import ClassVar
+from typing import Any, ClassVar, Protocol
 
 import tree_sitter
 import tree_sitter_vhdl
@@ -11,79 +12,82 @@ import tree_sitter_vhdl
 LANGUAGE = tree_sitter.Language(tree_sitter_vhdl.language())
 PARSER = tree_sitter.Parser(LANGUAGE)
 
+_FIND_END_OF_WORD = re.compile(r"(.)([A-Z][a-z]+)")
+_FIND_START_OF_WORD = re.compile(r"([a-z0-9])([A-Z])")
 
-class Query:
+
+def camel_case_to_lower_snake_case(name: str) -> str:
+    """Convert camel case to lower snake case."""
+    s1 = _FIND_END_OF_WORD.sub(r"\1_\2", name)
+    return _FIND_START_OF_WORD.sub(r"\1_\2", s1).lower()
+
+
+class Query(Protocol):
     """Base class for all queries."""
 
     FILE: ClassVar[Path]
     TEXT: ClassVar[str]
     QUERY: ClassVar[tree_sitter.Query]
 
+    def __init_subclass__(cls, **kwargs: Any) -> None:  # noqa: ANN401
+        """
+        Initialise subclass.
+
+        This requires `FILE` to be defined, and defines `TEXT` and `QUERY`.
+
+        Raises
+        ------
+        TypeError:
+            If `FILE` is not a defined `ClassVar` of the subclass.
+
+        """
+        super().__init_subclass__(**kwargs)
+        class_lower_snake_case = camel_case_to_lower_snake_case(cls.__name__)
+        cls.FILE = Path(__file__).parent / "queries" / f"{class_lower_snake_case}.scm"
+        if not cls.FILE.exists():
+            message = f"File '{cls.FILE}' does not exist"
+            raise TypeError(message)
+        cls.TEXT = cls.FILE.read_text()
+        cls.QUERY = tree_sitter.Query(LANGUAGE, cls.TEXT)
+
     @classmethod
     def capture(cls, node: tree_sitter.Node) -> dict[str, list[tree_sitter.Node]]:
         """Perform a capture on a given node."""
         return tree_sitter.QueryCursor(cls.QUERY).captures(node)
 
+    @classmethod
+    def get_file(cls, name: str) -> Path:
+        """Get the given query file."""
+        return Path(__file__).parent / "queries" / name
+
 
 class DesignUnits(Query):
     """Class defining the query to get all design units."""
 
-    FILE = Path(__file__).parent / "queries" / "design_units.scm"
-    TEXT = FILE.read_text()
-    QUERY = tree_sitter.Query(LANGUAGE, TEXT)
-
 
 class EntityDeclaration(Query):
     """Class defining the query to expand a single entity declaration."""
 
-    FILE = Path(__file__).parent / "queries" / "entity_declaration.scm"
-    TEXT = FILE.read_text()
-    QUERY = tree_sitter.Query(LANGUAGE, TEXT)
-
 
 class InterfaceDeclaration(Query):
     """Class defining the query to expand a single interface declaration."""
 
-    FILE = Path(__file__).parent / "queries" / "interface_declaration.scm"
-    TEXT = FILE.read_text()
-    QUERY = tree_sitter.Query(LANGUAGE, TEXT)
-
 
 class InterfaceDeclarations(Query):
     """Class defining the query to get all interface declarations."""
 
-    FILE = Path(__file__).parent / "queries" / "interface_declarations.scm"
-    TEXT = FILE.read_text()
-    QUERY = tree_sitter.Query(LANGUAGE, TEXT)
-
 
 class LibraryClauses(Query):
     """Class defining the query to get all library clauses."""
 
-    FILE = Path(__file__).parent / "queries" / "library_clauses.scm"
-    TEXT = FILE.read_text()
-    QUERY = tree_sitter.Query(LANGUAGE, TEXT)
-
 
 class LibraryNamespaces(Query):
     """Class defining the query to get all library namespaces."""
 
-    FILE = Path(__file__).parent / "queries" / "library_namespaces.scm"
-    TEXT = FILE.read_text()
-    QUERY = tree_sitter.Query(LANGUAGE, TEXT)
-
 
 class SelectedNames(Query):
     """Class defining the query to get all selected names in a list."""
 
-    FILE = Path(__file__).parent / "queries" / "selected-names.scm"
-    TEXT = FILE.read_text()
-    QUERY = tree_sitter.Query(LANGUAGE, TEXT)
-
 
 class UseClauses(Query):
     """Class defining the query to get all use clauses."""
-
-    FILE = Path(__file__).parent / "queries" / "use-clauses.scm"
-    TEXT = FILE.read_text()
-    QUERY = tree_sitter.Query(LANGUAGE, TEXT)