Skip to content

Graph

graph

GraphTool — import dependency graph.

GraphTool

Bases: AXMTool

Import dependency graph with text/mermaid/json output.

Registered as ast_graph via axm.tools entry point. Workspace-aware: if path is a uv workspace root, returns inter-package dependency graph.

Source code in packages/axm-ast/src/axm_ast/tools/graph.py 
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
class GraphTool(AXMTool):
    """Import dependency graph with text/mermaid/json output.

    Registered as ``ast_graph`` via axm.tools entry point.
    Workspace-aware: if path is a uv workspace root, returns
    inter-package dependency graph.
    """

    @property
    def name(self) -> str:
        """Return tool name for registry lookup."""
        return "ast_graph"

    def execute(
        self, *, path: str = ".", format: str = "json", **kwargs: Any
    ) -> ToolResult:
        """Generate import dependency graph.

        Args:
            path: Path to package or workspace directory.
            format: Output format — 'json', 'mermaid', or 'text'.

        Returns:
            ToolResult with graph data.
        """
        try:
            project_path = Path(path).resolve()
            if not project_path.is_dir():
                return ToolResult(
                    success=False, error=f"Not a directory: {project_path}"
                )

            from axm_ast.core.workspace import detect_workspace

            ws = detect_workspace(project_path)
            if ws is not None:
                from axm_ast.core.workspace import (
                    analyze_workspace,
                    build_workspace_dep_graph,
                    format_workspace_graph_mermaid,
                )

                ws = analyze_workspace(project_path)
                graph = build_workspace_dep_graph(ws)

                if format == "mermaid":
                    mermaid_str = format_workspace_graph_mermaid(ws)
                    return ToolResult(
                        success=True,
                        data={"mermaid": mermaid_str, "graph": graph},
                        hint=(
                            "Tip: Use ast_describe(modules=[...])"
                            " to explore specific modules."
                        ),
                    )

                return ToolResult(
                    success=True,
                    data={"graph": graph},
                    hint=(
                        "Tip: Use ast_describe(modules=[...])"
                        " to explore specific modules."
                    ),
                )

            from axm_ast.core.analyzer import build_import_graph
            from axm_ast.core.cache import get_package
            from axm_ast.formatters import format_mermaid

            pkg = get_package(project_path)
            graph = build_import_graph(pkg)

            if format == "mermaid":
                mermaid_str = format_mermaid(pkg)
                return ToolResult(
                    success=True,
                    data={"mermaid": mermaid_str, "graph": graph},
                    hint=(
                        "Tip: Use ast_describe(modules=[...])"
                        " to explore specific modules."
                    ),
                )

            return ToolResult(
                success=True,
                data={"graph": graph},
                hint=(
                    "Tip: Use ast_describe(modules=[...]) to explore specific modules."
                ),
            )
        except Exception as exc:
            return ToolResult(success=False, error=str(exc))
name property

Return tool name for registry lookup.

execute(*, path='.', format='json', **kwargs)

Generate import dependency graph.

Parameters:

Name Type Description Default
path str

Path to package or workspace directory.

 '.'
format str

Output format — 'json', 'mermaid', or 'text'.

 'json'

Returns:

Type Description
ToolResult

ToolResult with graph data.
Source code in packages/axm-ast/src/axm_ast/tools/graph.py 
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
def execute(
    self, *, path: str = ".", format: str = "json", **kwargs: Any
) -> ToolResult:
    """Generate import dependency graph.

    Args:
        path: Path to package or workspace directory.
        format: Output format — 'json', 'mermaid', or 'text'.

    Returns:
        ToolResult with graph data.
    """
    try:
        project_path = Path(path).resolve()
        if not project_path.is_dir():
            return ToolResult(
                success=False, error=f"Not a directory: {project_path}"
            )

        from axm_ast.core.workspace import detect_workspace

        ws = detect_workspace(project_path)
        if ws is not None:
            from axm_ast.core.workspace import (
                analyze_workspace,
                build_workspace_dep_graph,
                format_workspace_graph_mermaid,
            )

            ws = analyze_workspace(project_path)
            graph = build_workspace_dep_graph(ws)

            if format == "mermaid":
                mermaid_str = format_workspace_graph_mermaid(ws)
                return ToolResult(
                    success=True,
                    data={"mermaid": mermaid_str, "graph": graph},
                    hint=(
                        "Tip: Use ast_describe(modules=[...])"
                        " to explore specific modules."
                    ),
                )

            return ToolResult(
                success=True,
                data={"graph": graph},
                hint=(
                    "Tip: Use ast_describe(modules=[...])"
                    " to explore specific modules."
                ),
            )

        from axm_ast.core.analyzer import build_import_graph
        from axm_ast.core.cache import get_package
        from axm_ast.formatters import format_mermaid

        pkg = get_package(project_path)
        graph = build_import_graph(pkg)

        if format == "mermaid":
            mermaid_str = format_mermaid(pkg)
            return ToolResult(
                success=True,
                data={"mermaid": mermaid_str, "graph": graph},
                hint=(
                    "Tip: Use ast_describe(modules=[...])"
                    " to explore specific modules."
                ),
            )

        return ToolResult(
            success=True,
            data={"graph": graph},
            hint=(
                "Tip: Use ast_describe(modules=[...]) to explore specific modules."
            ),
        )
    except Exception as exc:
        return ToolResult(success=False, error=str(exc))