Skip to content

Dead code

dead_code

DeadCodeTool — detect unreferenced symbols in a package.

DeadCodeTool

Bases: AXMTool

Detect dead (unreferenced) code symbols in a Python package.

Registered as ast_dead_code via axm.tools entry point.

Source code in packages/axm-ast/src/axm_ast/tools/dead_code.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
class DeadCodeTool(AXMTool):
    """Detect dead (unreferenced) code symbols in a Python package.

    Registered as ``ast_dead_code`` via axm.tools entry point.
    """

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

    def execute(
        self,
        *,
        path: str = ".",
        include_tests: bool = False,
        **kwargs: Any,
    ) -> ToolResult:
        """Find dead code in a Python package.

        Args:
            path: Path to package directory.
            include_tests: Include test fixtures in scan (default False).

        Returns:
            ToolResult with dead symbols list.
        """
        try:
            pkg_path = Path(path).resolve()
            if not pkg_path.is_dir():
                return ToolResult(success=False, error=f"Not a directory: {pkg_path}")

            from axm_ast.core.cache import get_package
            from axm_ast.core.dead_code import find_dead_code

            pkg = get_package(pkg_path)
            dead = find_dead_code(pkg, include_tests=include_tests)

            return ToolResult(
                success=True,
                data={
                    "dead_symbols": [
                        {
                            "name": d.name,
                            "module_path": d.module_path,
                            "line": d.line,
                            "kind": d.kind,
                        }
                        for d in dead
                    ],
                    "total": len(dead),
                },
                hint="Tip: Use ast_callers(symbol) to double-check before removal.",
            )
        except Exception as exc:
            return ToolResult(success=False, error=str(exc))
name property

Return tool name for registry lookup.

execute(*, path='.', include_tests=False, **kwargs)

Find dead code in a Python package.

Parameters:

Name Type Description Default
path str

Path to package directory.

 '.'
include_tests bool

Include test fixtures in scan (default False).

 False

Returns:

Type Description
ToolResult

ToolResult with dead symbols list.
Source code in packages/axm-ast/src/axm_ast/tools/dead_code.py 
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
def execute(
    self,
    *,
    path: str = ".",
    include_tests: bool = False,
    **kwargs: Any,
) -> ToolResult:
    """Find dead code in a Python package.

    Args:
        path: Path to package directory.
        include_tests: Include test fixtures in scan (default False).

    Returns:
        ToolResult with dead symbols list.
    """
    try:
        pkg_path = Path(path).resolve()
        if not pkg_path.is_dir():
            return ToolResult(success=False, error=f"Not a directory: {pkg_path}")

        from axm_ast.core.cache import get_package
        from axm_ast.core.dead_code import find_dead_code

        pkg = get_package(pkg_path)
        dead = find_dead_code(pkg, include_tests=include_tests)

        return ToolResult(
            success=True,
            data={
                "dead_symbols": [
                    {
                        "name": d.name,
                        "module_path": d.module_path,
                        "line": d.line,
                        "kind": d.kind,
                    }
                    for d in dead
                ],
                "total": len(dead),
            },
            hint="Tip: Use ast_callers(symbol) to double-check before removal.",
        )
    except Exception as exc:
        return ToolResult(success=False, error=str(exc))