jaclang 0.7.22__py3-none-any.whl → 0.7.24__py3-none-any.whl

jaclang/plugin/spec.py

@@ -11,37 +11,233 @@ from typing import (
     Optional,
     ParamSpec,
     Sequence,
-    TYPE_CHECKING,
     Type,
     TypeVar,
     Union,
 )
+from uuid import UUID
 
-import jaclang.compiler.absyntree as ast
+from jaclang.compiler import absyntree as ast
+from jaclang.compiler.constant import EdgeDir
 from jaclang.compiler.passes.main.pyast_gen_pass import PyastGenPass
-
-if TYPE_CHECKING:
-    from jaclang.plugin.default import (
-        Architype,
-        EdgeDir,
-        WalkerArchitype,
-        Root,
-        DSFunc,
-    )
-    from jaclang.runtimelib.constructs import EdgeArchitype, NodeAnchor, NodeArchitype
-    from jaclang.runtimelib.context import ExecutionContext
+from jaclang.runtimelib.constructs import (
+    AccessLevel,
+    Anchor,
+    Architype,
+    DSFunc,
+    EdgeAnchor,
+    EdgeArchitype,
+    NodeAnchor,
+    NodeArchitype,
+    Root,
+    WalkerArchitype,
+)
+from jaclang.runtimelib.context import ExecutionContext
 
 import pluggy
 
 hookspec = pluggy.HookspecMarker("jac")
+plugin_manager = pluggy.PluginManager("jac")
 
 T = TypeVar("T")
 P = ParamSpec("P")
 
 
-class JacFeatureSpec:
+class JacAccessValidationSpec:
+    """Jac Access Validation Specs."""
+
+    @staticmethod
+    @hookspec(firstresult=True)
+    def allow_root(
+        architype: Architype, root_id: UUID, level: AccessLevel | int | str
+    ) -> None:
+        """Allow all access from target root graph to current Architype."""
+        raise NotImplementedError
+
+    @staticmethod
+    @hookspec(firstresult=True)
+    def disallow_root(
+        architype: Architype, root_id: UUID, level: AccessLevel | int | str
+    ) -> None:
+        """Disallow all access from target root graph to current Architype."""
+        raise NotImplementedError
+
+    @staticmethod
+    @hookspec(firstresult=True)
+    def unrestrict(architype: Architype, level: AccessLevel | int | str) -> None:
+        """Allow everyone to access current Architype."""
+        raise NotImplementedError
+
+    @staticmethod
+    @hookspec(firstresult=True)
+    def restrict(architype: Architype) -> None:
+        """Disallow others to access current Architype."""
+        raise NotImplementedError
+
+    @staticmethod
+    @hookspec(firstresult=True)
+    def check_read_access(to: Anchor) -> bool:
+        """Read Access Validation."""
+        raise NotImplementedError
+
+    @staticmethod
+    @hookspec(firstresult=True)
+    def check_connect_access(to: Anchor) -> bool:
+        """Write Access Validation."""
+        raise NotImplementedError
+
+    @staticmethod
+    @hookspec(firstresult=True)
+    def check_write_access(to: Anchor) -> bool:
+        """Write Access Validation."""
+        raise NotImplementedError
+
+    @staticmethod
+    @hookspec(firstresult=True)
+    def check_access_level(to: Anchor) -> AccessLevel:
+        """Access validation."""
+        raise NotImplementedError
+
+
+class JacNodeSpec:
+    """Jac Node Operations."""
+
+    @staticmethod
+    @hookspec(firstresult=True)
+    def node_dot(node: NodeArchitype, dot_file: Optional[str]) -> str:
+        """Generate Dot file for visualizing nodes and edges."""
+        raise NotImplementedError
+
+    @staticmethod
+    @hookspec(firstresult=True)
+    def get_edges(
+        node: NodeAnchor,
+        dir: EdgeDir,
+        filter_func: Optional[Callable[[list[EdgeArchitype]], list[EdgeArchitype]]],
+        target_obj: Optional[list[NodeArchitype]],
+    ) -> list[EdgeArchitype]:
+        """Get edges connected to this node."""
+        raise NotImplementedError
+
+    @staticmethod
+    @hookspec(firstresult=True)
+    def edges_to_nodes(
+        node: NodeAnchor,
+        dir: EdgeDir,
+        filter_func: Optional[Callable[[list[EdgeArchitype]], list[EdgeArchitype]]],
+        target_obj: Optional[list[NodeArchitype]],
+    ) -> list[NodeArchitype]:
+        """Get set of nodes connected to this node."""
+        raise NotImplementedError
+
+    @staticmethod
+    @hookspec(firstresult=True)
+    def remove_edge(node: NodeAnchor, edge: EdgeAnchor) -> None:
+        """Remove reference without checking sync status."""
+        raise NotImplementedError
+
+
+class JacEdgeSpec:
+    """Jac Edge Operations."""
+
+    @staticmethod
+    @hookspec(firstresult=True)
+    def detach(edge: EdgeAnchor) -> None:
+        """Detach edge from nodes."""
+        raise NotImplementedError
+
+
+class JacWalkerSpec:
+    """Jac Edge Operations."""
+
+    @staticmethod
+    @hookspec(firstresult=True)
+    def visit_node(
+        walker: WalkerArchitype,
+        expr: (
+            list[NodeArchitype | EdgeArchitype]
+            | list[NodeArchitype]
+            | list[EdgeArchitype]
+            | NodeArchitype
+            | EdgeArchitype
+        ),
+    ) -> bool:  # noqa: ANN401
+        """Jac's visit stmt feature."""
+        raise NotImplementedError
+
+    @staticmethod
+    @hookspec(firstresult=True)
+    def ignore(
+        walker: WalkerArchitype,
+        expr: (
+            list[NodeArchitype | EdgeArchitype]
+            | list[NodeArchitype]
+            | list[EdgeArchitype]
+            | NodeArchitype
+            | EdgeArchitype
+        ),
+    ) -> bool:
+        """Jac's ignore stmt feature."""
+        raise NotImplementedError
+
+    @staticmethod
+    @hookspec(firstresult=True)
+    def spawn_call(op1: Architype, op2: Architype) -> WalkerArchitype:
+        """Invoke data spatial call."""
+        raise NotImplementedError
+
+    @staticmethod
+    @hookspec(firstresult=True)
+    def disengage(walker: WalkerArchitype) -> bool:
+        """Jac's disengage stmt feature."""
+        raise NotImplementedError
+
+
+class JacBuiltinSpec:
+    """Jac Builtins."""
+
+    @staticmethod
+    @hookspec(firstresult=True)
+    def dotgen(
+        node: NodeArchitype,
+        depth: int,
+        traverse: bool,
+        edge_type: Optional[list[str]],
+        bfs: bool,
+        edge_limit: int,
+        node_limit: int,
+        dot_file: Optional[str],
+    ) -> str:
+        """Print the dot graph."""
+        raise NotImplementedError
+
+
+class JacCmdSpec:
+    """Jac CLI command."""
+
+    @staticmethod
+    @hookspec
+    def create_cmd() -> None:
+        """Create Jac CLI cmds."""
+        raise NotImplementedError
+
+
+class JacFeatureSpec(
+    JacAccessValidationSpec,
+    JacNodeSpec,
+    JacEdgeSpec,
+    JacWalkerSpec,
+    JacBuiltinSpec,
+    JacCmdSpec,
+):
     """Jac Feature."""
 
+    @staticmethod
+    @hookspec(firstresult=True)
+    def setup() -> None:
+        """Set Class References."""
+        raise NotImplementedError
+
     @staticmethod
     @hookspec(firstresult=True)
     def get_context() -> ExecutionContext:
@@ -51,13 +247,13 @@ class JacFeatureSpec:
     @staticmethod
     @hookspec(firstresult=True)
     def get_object(id: str) -> Architype | None:
-        """Get object given id.."""
+        """Get object by id."""
         raise NotImplementedError
 
     @staticmethod
     @hookspec(firstresult=True)
     def object_ref(obj: Architype) -> str:
-        """Get object given id.."""
+        """Get object's id."""
         raise NotImplementedError
 
     @staticmethod
@@ -160,52 +356,10 @@ class JacFeatureSpec:
 
     @staticmethod
     @hookspec(firstresult=True)
-    def spawn_call(op1: Architype, op2: Architype) -> WalkerArchitype:
-        """Jac's spawn operator feature."""
-        raise NotImplementedError
-
-    @staticmethod
-    @hookspec(firstresult=True)
-    def report(expr: Any) -> Any:  # noqa: ANN401
+    def report(expr: Any, custom: bool) -> None:  # noqa: ANN401
         """Jac's report stmt feature."""
         raise NotImplementedError
 
-    @staticmethod
-    @hookspec(firstresult=True)
-    def ignore(
-        walker: WalkerArchitype,
-        expr: (
-            list[NodeArchitype | EdgeArchitype]
-            | list[NodeArchitype]
-            | list[EdgeArchitype]
-            | NodeArchitype
-            | EdgeArchitype
-        ),
-    ) -> bool:
-        """Jac's ignore stmt feature."""
-        raise NotImplementedError
-
-    @staticmethod
-    @hookspec(firstresult=True)
-    def visit_node(
-        walker: WalkerArchitype,
-        expr: (
-            list[NodeArchitype | EdgeArchitype]
-            | list[NodeArchitype]
-            | list[EdgeArchitype]
-            | NodeArchitype
-            | EdgeArchitype
-        ),
-    ) -> bool:  # noqa: ANN401
-        """Jac's visit stmt feature."""
-        raise NotImplementedError
-
-    @staticmethod
-    @hookspec(firstresult=True)
-    def disengage(walker: WalkerArchitype) -> bool:  # noqa: ANN401
-        """Jac's disengage stmt feature."""
-        raise NotImplementedError
-
     @staticmethod
     @hookspec(firstresult=True)
     def edge_ref(
@@ -273,6 +427,22 @@ class JacFeatureSpec:
         """Jac's root getter."""
         raise NotImplementedError
 
+    @staticmethod
+    @hookspec(firstresult=True)
+    def save(
+        obj: Architype | Anchor,
+    ) -> None:
+        """Destroy object."""
+        raise NotImplementedError
+
+    @staticmethod
+    @hookspec(firstresult=True)
+    def destroy(
+        obj: Architype | Anchor,
+    ) -> None:
+        """Destroy object."""
+        raise NotImplementedError
+
     @staticmethod
     @hookspec(firstresult=True)
     def get_semstr_type(
@@ -288,6 +458,7 @@ class JacFeatureSpec:
         raise NotImplementedError
 
     @staticmethod
+    @hookspec(firstresult=True)
     def get_sem_type(file_loc: str, attr: str) -> tuple[str | None, str | None]:
         """Jac's get_semstr_type feature."""
         raise NotImplementedError
@@ -339,30 +510,4 @@ class JacFeatureSpec:
         raise NotImplementedError
 
 
-class JacBuiltin:
-    """Jac Builtins."""
-
-    @staticmethod
-    @hookspec(firstresult=True)
-    def dotgen(
-        node: NodeArchitype,
-        depth: int,
-        traverse: bool,
-        edge_type: list[str],
-        bfs: bool,
-        edge_limit: int,
-        node_limit: int,
-        dot_file: Optional[str],
-    ) -> str:
-        """Print the dot graph."""
-        raise NotImplementedError
-
-
-class JacCmdSpec:
-    """Jac CLI command."""
-
-    @staticmethod
-    @hookspec
-    def create_cmd() -> None:
-        """Create Jac CLI cmds."""
-        raise NotImplementedError
+plugin_manager.add_hookspecs(JacFeatureSpec)

jaclang/plugin/tests/fixtures/other_root_access.jac

@@ -36,7 +36,7 @@ walker create_node {
 walker create_other_root {
     can enter with `root entry {
         other_root = `root().__jac__;
-        other_root.save();
+        Jac.save(other_root);
         print(other_root.id);
     }
 }
@@ -46,17 +46,17 @@ walker allow_other_root_access {
 
     can enter_root with `root entry {
         if self.via_all {
-            here.__jac__.unrestrict(self.level);
+            Jac.unrestrict(here, self.level);
         } else {
-            here.__jac__.allow_root(UUID(self.root_id), self.level);
+            Jac.allow_root(here, UUID(self.root_id), self.level);
         }
     }
 
     can enter_nested with A entry {
         if self.via_all {
-            here.__jac__.unrestrict(self.level);
+            Jac.unrestrict(here, self.level);
         } else {
-            here.__jac__.allow_root(UUID(self.root_id), self.level);
+            Jac.allow_root(here, UUID(self.root_id), self.level);
         }
     }
 }
@@ -66,17 +66,17 @@ walker disallow_other_root_access {
 
     can enter_root with `root entry {
         if self.via_all {
-            here.__jac__.restrict();
+            Jac.restrict(here);
         } else {
-            here.__jac__.disallow_root(UUID(self.root_id));
+            Jac.disallow_root(here, UUID(self.root_id));
         }
     }
 
     can enter_nested with A entry {
         if self.via_all {
-            here.__jac__.restrict();
+            Jac.restrict(here);
         } else {
-            here.__jac__.disallow_root(UUID(self.root_id));
+            Jac.disallow_root(here, UUID(self.root_id));
         }
     }
 }

jaclang/plugin/tests/test_features.py

@@ -3,7 +3,7 @@
 import inspect
 from typing import List, Type
 
-from jaclang.plugin.default import JacFeatureDefaults
+from jaclang.plugin.default import JacFeatureImpl
 from jaclang.plugin.feature import JacFeature
 from jaclang.plugin.spec import JacFeatureSpec
 from jaclang.utils.test import TestCase
@@ -46,7 +46,7 @@ class TestFeatures(TestCase):
         """Test if JacFeature, JacFeatureDefaults, and JacFeatureSpec have synced methods."""
         # Get methods of each class
         jac_feature_methods = self.get_methods(JacFeature)
-        jac_feature_defaults_methods = self.get_methods(JacFeatureDefaults)
+        jac_feature_defaults_methods = self.get_methods(JacFeatureImpl)
         jac_feature_spec_methods = self.get_methods(JacFeatureSpec)
 
         # Check if all methods are the same in all classes