Skip to content

Cli

cli

CLI entry point for axm-anvil.

move(from_file, to_file, symbols, *, dry_run=False, path='.', shared_helpers='duplicate', reexport=False, rename=None, check=False, insert_after=None, include_helpers=True, side_effect_decorators=None)

Move top-level symbols between Python files atomically.

Source code in packages/axm-anvil/src/axm_anvil/cli.py
Python
 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
108
109
110
111
112
113
114
115
@app.command
def move(  # noqa: PLR0913
    from_file: Annotated[
        str,
        cyclopts.Parameter(help="Source Python file path."),
    ],
    to_file: Annotated[
        str,
        cyclopts.Parameter(help="Target Python file path."),
    ],
    symbols: Annotated[
        str,
        cyclopts.Parameter(help="Comma-separated symbol names to move."),
    ],
    *,
    dry_run: Annotated[
        bool,
        cyclopts.Parameter(name=["--dry-run"], help="Preview without writing."),
    ] = False,
    path: Annotated[
        str,
        cyclopts.Parameter(name=["--path"], help="Workspace root."),
    ] = ".",
    shared_helpers: Annotated[
        Literal["duplicate", "error"],
        cyclopts.Parameter(
            name=["--shared-helpers"],
            help="Strategy for helpers used by both moved and remaining symbols.",
        ),
    ] = "duplicate",
    reexport: Annotated[
        bool,
        cyclopts.Parameter(
            name=["--reexport"],
            help="Leave callers untouched; inject a re-export in the source module.",
        ),
    ] = False,
    rename: Annotated[
        str | None,
        cyclopts.Parameter(
            name=["--rename"],
            help='JSON object mapping old to new names, e.g. \'{"Old": "New"}\'.',
        ),
    ] = None,
    check: Annotated[
        bool,
        cyclopts.Parameter(
            name=["--check"],
            help="Simulate the move (incl. cycle detection) without writing.",
        ),
    ] = False,
    insert_after: Annotated[
        str | None,
        cyclopts.Parameter(
            name=["--insert-after"],
            help="Place moved blocks after this target top-level symbol.",
        ),
    ] = None,
    include_helpers: Annotated[
        bool,
        cyclopts.Parameter(
            name=["--include-helpers"],
            help="Copy transitively-referenced local helpers/constants into "
            "the target (default). Use --no-include-helpers to skip them.",
        ),
    ] = True,
    side_effect_decorators: Annotated[
        str | None,
        cyclopts.Parameter(
            name=["--side-effect-decorators"],
            help="Comma-separated extra side-effect decorator dotted-names "
            "that extend the built-in whitelist (e.g. 'mylib.register').",
        ),
    ] = None,
) -> None:
    """Move top-level symbols between Python files atomically."""
    result = MoveTool().execute(
        path=path,
        symbols=symbols,
        from_file=from_file,
        to_file=to_file,
        dry_run=dry_run,
        shared_helpers=shared_helpers,
        reexport=reexport,
        rename=rename,
        check=check,
        insert_after=insert_after,
        include_helpers=include_helpers,
        side_effect_decorators=side_effect_decorators,
    )
    if not result.success:
        print(result.error or "move failed", file=sys.stderr)  # noqa: T201
        raise SystemExit(1)
    if result.text:
        print(result.text)  # noqa: T201